3 * Representation of 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.
30 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
31 * and does not rely on global state or the database.
33 * @internal documentation reviewed 15 Mar 2010
36 /** @var MapCacheLRU */
37 static private $titleCache = null;
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 string Text form (spaces not underscores) of the main part */
60 public $mTextform = '';
62 /** @var string URL-encoded form of the main part */
63 public $mUrlform = '';
65 /** @var string Main part with underscores */
66 public $mDbkeyform = '';
68 /** @var string Database key with the initial letter in the case specified by the user */
69 protected $mUserCaseDBKey;
71 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
72 public $mNamespace = NS_MAIN
;
74 /** @var string Interwiki prefix */
75 public $mInterwiki = '';
77 /** @var bool Was this Title created from a string with a local interwiki prefix? */
78 private $mLocalInterwiki = false;
80 /** @var string Title fragment (i.e. the bit after the #) */
81 public $mFragment = '';
83 /** @var int Article ID, fetched from the link cache on demand */
84 public $mArticleID = -1;
86 /** @var bool|int ID of most recent revision */
87 protected $mLatestID = false;
90 * @var bool|string ID of the page's content model, i.e. one of the
91 * CONTENT_MODEL_XXX constants
93 public $mContentModel = false;
95 /** @var int Estimated number of revisions; null of not loaded */
96 private $mEstimateRevisions;
98 /** @var array Array of groups allowed to edit this article */
99 public $mRestrictions = array();
102 protected $mOldRestrictions = false;
104 /** @var bool Cascade restrictions on this page to included templates and images? */
105 public $mCascadeRestriction;
107 /** Caching the results of getCascadeProtectionSources */
108 public $mCascadingRestrictions;
110 /** @var array When do the restrictions on this page expire? */
111 protected $mRestrictionsExpiry = array();
113 /** @var bool Are cascading restrictions in effect on this page? */
114 protected $mHasCascadingRestrictions;
116 /** @var array Where are the cascading restrictions coming from on this page? */
117 public $mCascadeSources;
119 /** @var bool Boolean for initialisation on demand */
120 public $mRestrictionsLoaded = false;
122 /** @var string Text form including namespace/interwiki, initialised on demand */
123 protected $mPrefixedText = null;
125 /** @var mixed Cached value for getTitleProtection (create protection) */
126 public $mTitleProtection;
129 * @var int Namespace index when there is no namespace. Don't change the
130 * following default, NS_MAIN is hardcoded in several places. See bug 696.
131 * Zero except in {{transclusion}} tags.
133 public $mDefaultNamespace = NS_MAIN
;
136 * @var bool Is $wgUser watching this page? null if unfilled, accessed
137 * through userIsWatching()
139 protected $mWatched = null;
141 /** @var int The page length, 0 for special pages */
142 protected $mLength = -1;
144 /** @var null Is the article at this title a redirect? */
145 public $mRedirect = null;
147 /** @var array Associative array of user ID -> timestamp/false */
148 private $mNotificationTimestamp = array();
150 /** @var bool Whether a page has any subpages */
151 private $mHasSubpages;
153 /** @var bool The (string) language code of the page's language and content code. */
154 private $mPageLanguage = false;
156 /** @var string The page language code from the database */
157 private $mDbPageLanguage = null;
159 /** @var TitleValue A corresponding TitleValue object */
160 private $mTitleValue = null;
162 /** @var bool Would deleting this page be a big deletion? */
163 private $mIsBigDeletion = null;
167 * B/C kludge: provide a TitleParser for use by Title.
168 * Ideally, Title would have no methods that need this.
169 * Avoid usage of this singleton by using TitleValue
170 * and the associated services when possible.
172 * @return TitleParser
174 private static function getTitleParser() {
175 global $wgContLang, $wgLocalInterwikis;
177 static $titleCodec = null;
178 static $titleCodecFingerprint = null;
180 // $wgContLang and $wgLocalInterwikis may change (especially while testing),
181 // make sure we are using the right one. To detect changes over the course
182 // of a request, we remember a fingerprint of the config used to create the
183 // codec singleton, and re-create it if the fingerprint doesn't match.
184 $fingerprint = spl_object_hash( $wgContLang ) . '|' . join( '+', $wgLocalInterwikis );
186 if ( $fingerprint !== $titleCodecFingerprint ) {
190 if ( !$titleCodec ) {
191 $titleCodec = new MediaWikiTitleCodec(
193 GenderCache
::singleton(),
196 $titleCodecFingerprint = $fingerprint;
203 * B/C kludge: provide a TitleParser for use by Title.
204 * Ideally, Title would have no methods that need this.
205 * Avoid usage of this singleton by using TitleValue
206 * and the associated services when possible.
208 * @return TitleFormatter
210 private static function getTitleFormatter() {
211 //NOTE: we know that getTitleParser() returns a MediaWikiTitleCodec,
212 // which implements TitleFormatter.
213 return self
::getTitleParser();
216 function __construct() {
220 * Create a new Title from a prefixed DB key
222 * @param string $key The database key, which has underscores
223 * instead of spaces, possibly including namespace and
225 * @return Title|null Title, or null on an error
227 public static function newFromDBkey( $key ) {
229 $t->mDbkeyform
= $key;
230 if ( $t->secureAndSplit() ) {
238 * Create a new Title from a TitleValue
240 * @param TitleValue $titleValue Assumed to be safe.
244 public static function newFromTitleValue( TitleValue
$titleValue ) {
245 return self
::makeTitle(
246 $titleValue->getNamespace(),
247 $titleValue->getText(),
248 $titleValue->getFragment() );
252 * Create a new Title from text, such as what one would find in a link. De-
253 * codes any HTML entities in the text.
255 * @param string $text The link text; spaces, prefixes, and an
256 * initial ':' indicating the main namespace are accepted.
257 * @param int $defaultNamespace The namespace to use if none is specified
258 * by a prefix. If you want to force a specific namespace even if
259 * $text might begin with a namespace prefix, use makeTitle() or
261 * @throws MWException
262 * @return Title|null Title or null on an error.
264 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
265 if ( is_object( $text ) ) {
266 throw new MWException( 'Title::newFromText given an object' );
269 $cache = self
::getTitleCache();
272 * Wiki pages often contain multiple links to the same page.
273 * Title normalization and parsing can become expensive on
274 * pages with many links, so we can save a little time by
277 * In theory these are value objects and won't get changed...
279 if ( $defaultNamespace == NS_MAIN
&& $cache->has( $text ) ) {
280 return $cache->get( $text );
283 # Convert things like é ā or 〗 into normalized (bug 14952) text
284 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
287 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
288 $t->mDefaultNamespace
= intval( $defaultNamespace );
290 if ( $t->secureAndSplit() ) {
291 if ( $defaultNamespace == NS_MAIN
) {
292 $cache->set( $text, $t );
301 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
303 * Example of wrong and broken code:
304 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
306 * Example of right code:
307 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
309 * Create a new Title from URL-encoded text. Ensures that
310 * the given title's length does not exceed the maximum.
312 * @param string $url The title, as might be taken from a URL
313 * @return Title|null The new object, or null on an error
315 public static function newFromURL( $url ) {
318 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
319 # but some URLs used it as a space replacement and they still come
320 # from some external search tools.
321 if ( strpos( self
::legalChars(), '+' ) === false ) {
322 $url = str_replace( '+', ' ', $url );
325 $t->mDbkeyform
= str_replace( ' ', '_', $url );
326 if ( $t->secureAndSplit() ) {
334 * @return MapCacheLRU
336 private static function getTitleCache() {
337 if ( self
::$titleCache == null ) {
338 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
340 return self
::$titleCache;
344 * Returns a list of fields that are to be selected for initializing Title
345 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
346 * whether to include page_content_model.
350 protected static function getSelectFields() {
351 global $wgContentHandlerUseDB;
354 'page_namespace', 'page_title', 'page_id',
355 'page_len', 'page_is_redirect', 'page_latest',
358 if ( $wgContentHandlerUseDB ) {
359 $fields[] = 'page_content_model';
366 * Create a new Title from an article ID
368 * @param int $id The page_id corresponding to the Title to create
369 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
370 * @return Title|null The new object, or null on an error
372 public static function newFromID( $id, $flags = 0 ) {
373 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
374 $row = $db->selectRow(
376 self
::getSelectFields(),
377 array( 'page_id' => $id ),
380 if ( $row !== false ) {
381 $title = Title
::newFromRow( $row );
389 * Make an array of titles from an array of IDs
391 * @param int[] $ids Array of IDs
392 * @return Title[] Array of Titles
394 public static function newFromIDs( $ids ) {
395 if ( !count( $ids ) ) {
398 $dbr = wfGetDB( DB_SLAVE
);
402 self
::getSelectFields(),
403 array( 'page_id' => $ids ),
408 foreach ( $res as $row ) {
409 $titles[] = Title
::newFromRow( $row );
415 * Make a Title object from a DB row
417 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
418 * @return Title Corresponding Title
420 public static function newFromRow( $row ) {
421 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
422 $t->loadFromRow( $row );
427 * Load Title object fields from a DB row.
428 * If false is given, the title will be treated as non-existing.
430 * @param stdClass|bool $row Database row
432 public function loadFromRow( $row ) {
433 if ( $row ) { // page found
434 if ( isset( $row->page_id
) ) {
435 $this->mArticleID
= (int)$row->page_id
;
437 if ( isset( $row->page_len
) ) {
438 $this->mLength
= (int)$row->page_len
;
440 if ( isset( $row->page_is_redirect
) ) {
441 $this->mRedirect
= (bool)$row->page_is_redirect
;
443 if ( isset( $row->page_latest
) ) {
444 $this->mLatestID
= (int)$row->page_latest
;
446 if ( isset( $row->page_content_model
) ) {
447 $this->mContentModel
= strval( $row->page_content_model
);
449 $this->mContentModel
= false; # initialized lazily in getContentModel()
451 if ( isset( $row->page_lang
) ) {
452 $this->mDbPageLanguage
= (string)$row->page_lang
;
454 } else { // page not found
455 $this->mArticleID
= 0;
457 $this->mRedirect
= false;
458 $this->mLatestID
= 0;
459 $this->mContentModel
= false; # initialized lazily in getContentModel()
464 * Create a new Title from a namespace index and a DB key.
465 * It's assumed that $ns and $title are *valid*, for instance when
466 * they came directly from the database or a special page name.
467 * For convenience, spaces are converted to underscores so that
468 * eg user_text fields can be used directly.
470 * @param int $ns The namespace of the article
471 * @param string $title The unprefixed database key form
472 * @param string $fragment The link fragment (after the "#")
473 * @param string $interwiki The interwiki prefix
474 * @return Title The new object
476 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
478 $t->mInterwiki
= $interwiki;
479 $t->mFragment
= $fragment;
480 $t->mNamespace
= $ns = intval( $ns );
481 $t->mDbkeyform
= str_replace( ' ', '_', $title );
482 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
483 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
484 $t->mTextform
= str_replace( '_', ' ', $title );
485 $t->mContentModel
= false; # initialized lazily in getContentModel()
490 * Create a new Title from a namespace index and a DB key.
491 * The parameters will be checked for validity, which is a bit slower
492 * than makeTitle() but safer for user-provided data.
494 * @param int $ns The namespace of the article
495 * @param string $title Database key form
496 * @param string $fragment The link fragment (after the "#")
497 * @param string $interwiki Interwiki prefix
498 * @return Title The new object, or null on an error
500 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
501 if ( !MWNamespace
::exists( $ns ) ) {
506 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
507 if ( $t->secureAndSplit() ) {
515 * Create a new Title for the Main Page
517 * @return Title The new object
519 public static function newMainPage() {
520 $title = Title
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
521 // Don't give fatal errors if the message is broken
523 $title = Title
::newFromText( 'Main Page' );
529 * Extract a redirect destination from a string and return the
530 * Title, or null if the text doesn't contain a valid redirect
531 * This will only return the very next target, useful for
532 * the redirect table and other checks that don't need full recursion
534 * @param string $text Text with possible redirect
535 * @return Title The corresponding Title
536 * @deprecated since 1.21, use Content::getRedirectTarget instead.
538 public static function newFromRedirect( $text ) {
539 ContentHandler
::deprecated( __METHOD__
, '1.21' );
541 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
542 return $content->getRedirectTarget();
546 * Extract a redirect destination from a string and return the
547 * Title, or null if the text doesn't contain a valid redirect
548 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
549 * in order to provide (hopefully) the Title of the final destination instead of another redirect
551 * @param string $text Text with possible redirect
553 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
555 public static function newFromRedirectRecurse( $text ) {
556 ContentHandler
::deprecated( __METHOD__
, '1.21' );
558 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
559 return $content->getUltimateRedirectTarget();
563 * Extract a redirect destination from a string and return an
564 * array of Titles, or null if the text doesn't contain a valid redirect
565 * The last element in the array is the final destination after all redirects
566 * have been resolved (up to $wgMaxRedirects times)
568 * @param string $text Text with possible redirect
569 * @return Title[] Array of Titles, with the destination last
570 * @deprecated since 1.21, use Content::getRedirectChain instead.
572 public static function newFromRedirectArray( $text ) {
573 ContentHandler
::deprecated( __METHOD__
, '1.21' );
575 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
576 return $content->getRedirectChain();
580 * Get the prefixed DB key associated with an ID
582 * @param int $id The page_id of the article
583 * @return Title|null An object representing the article, or null if no such article was found
585 public static function nameOf( $id ) {
586 $dbr = wfGetDB( DB_SLAVE
);
588 $s = $dbr->selectRow(
590 array( 'page_namespace', 'page_title' ),
591 array( 'page_id' => $id ),
594 if ( $s === false ) {
598 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
603 * Get a regex character class describing the legal characters in a link
605 * @return string The list of characters, not delimited
607 public static function legalChars() {
608 global $wgLegalTitleChars;
609 return $wgLegalTitleChars;
613 * Returns a simple regex that will match on characters and sequences invalid in titles.
614 * Note that this doesn't pick up many things that could be wrong with titles, but that
615 * replacing this regex with something valid will make many titles valid.
617 * @todo move this into MediaWikiTitleCodec
619 * @return string Regex string
621 static function getTitleInvalidRegex() {
622 static $rxTc = false;
624 # Matching titles will be held as illegal.
626 # Any character not allowed is forbidden...
627 '[^' . self
::legalChars() . ']' .
628 # URL percent encoding sequences interfere with the ability
629 # to round-trip titles -- you can't link to them consistently.
631 # XML/HTML character references produce similar issues.
632 '|&[A-Za-z0-9\x80-\xff]+;' .
634 '|&#x[0-9A-Fa-f]+;' .
642 * Utility method for converting a character sequence from bytes to Unicode.
644 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
645 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
647 * @param string $byteClass
650 public static function convertByteClassToUnicodeClass( $byteClass ) {
651 $length = strlen( $byteClass );
653 $x0 = $x1 = $x2 = '';
655 $d0 = $d1 = $d2 = '';
656 // Decoded integer codepoints
657 $ord0 = $ord1 = $ord2 = 0;
659 $r0 = $r1 = $r2 = '';
663 $allowUnicode = false;
664 for ( $pos = 0; $pos < $length; $pos++
) {
665 // Shift the queues down
674 // Load the current input token and decoded values
675 $inChar = $byteClass[$pos];
676 if ( $inChar == '\\' ) {
677 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
678 $x0 = $inChar . $m[0];
679 $d0 = chr( hexdec( $m[1] ) );
680 $pos +
= strlen( $m[0] );
681 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
682 $x0 = $inChar . $m[0];
683 $d0 = chr( octdec( $m[0] ) );
684 $pos +
= strlen( $m[0] );
685 } elseif ( $pos +
1 >= $length ) {
688 $d0 = $byteClass[$pos +
1];
696 // Load the current re-encoded value
697 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
698 $r0 = sprintf( '\x%02x', $ord0 );
699 } elseif ( $ord0 >= 0x80 ) {
700 // Allow unicode if a single high-bit character appears
701 $r0 = sprintf( '\x%02x', $ord0 );
702 $allowUnicode = true;
703 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
709 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
711 if ( $ord2 > $ord0 ) {
713 } elseif ( $ord0 >= 0x80 ) {
715 $allowUnicode = true;
716 if ( $ord2 < 0x80 ) {
717 // Keep the non-unicode section of the range
724 // Reset state to the initial value
725 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
726 } elseif ( $ord2 < 0x80 ) {
731 if ( $ord1 < 0x80 ) {
734 if ( $ord0 < 0x80 ) {
737 if ( $allowUnicode ) {
738 $out .= '\u0080-\uFFFF';
744 * Make a prefixed DB key from a DB key and a namespace index
746 * @param int $ns Numerical representation of the namespace
747 * @param string $title The DB key form the title
748 * @param string $fragment The link fragment (after the "#")
749 * @param string $interwiki The interwiki prefix
750 * @return string The prefixed form of the title
752 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
755 $namespace = $wgContLang->getNsText( $ns );
756 $name = $namespace == '' ?
$title : "$namespace:$title";
757 if ( strval( $interwiki ) != '' ) {
758 $name = "$interwiki:$name";
760 if ( strval( $fragment ) != '' ) {
761 $name .= '#' . $fragment;
767 * Escape a text fragment, say from a link, for a URL
769 * @param string $fragment Containing a URL or link fragment (after the "#")
770 * @return string Escaped string
772 static function escapeFragmentForURL( $fragment ) {
773 # Note that we don't urlencode the fragment. urlencoded Unicode
774 # fragments appear not to work in IE (at least up to 7) or in at least
775 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
776 # to care if they aren't encoded.
777 return Sanitizer
::escapeId( $fragment, 'noninitial' );
781 * Callback for usort() to do title sorts by (namespace, title)
786 * @return int Result of string comparison, or namespace comparison
788 public static function compare( $a, $b ) {
789 if ( $a->getNamespace() == $b->getNamespace() ) {
790 return strcmp( $a->getText(), $b->getText() );
792 return $a->getNamespace() - $b->getNamespace();
797 * Determine whether the object refers to a page within
800 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
802 public function isLocal() {
803 if ( $this->isExternal() ) {
804 $iw = Interwiki
::fetch( $this->mInterwiki
);
806 return $iw->isLocal();
813 * Is this Title interwiki?
817 public function isExternal() {
818 return $this->mInterwiki
!== '';
822 * Get the interwiki prefix
824 * Use Title::isExternal to check if a interwiki is set
826 * @return string Interwiki prefix
828 public function getInterwiki() {
829 return $this->mInterwiki
;
833 * Was this a local interwiki link?
837 public function wasLocalInterwiki() {
838 return $this->mLocalInterwiki
;
842 * Determine whether the object refers to a page within
843 * this project and is transcludable.
845 * @return bool True if this is transcludable
847 public function isTrans() {
848 if ( !$this->isExternal() ) {
852 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
856 * Returns the DB name of the distant wiki which owns the object.
858 * @return string The DB name
860 public function getTransWikiID() {
861 if ( !$this->isExternal() ) {
865 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
869 * Get a TitleValue object representing this Title.
871 * @note Not all valid Titles have a corresponding valid TitleValue
872 * (e.g. TitleValues cannot represent page-local links that have a
873 * fragment but no title text).
875 * @return TitleValue|null
877 public function getTitleValue() {
878 if ( $this->mTitleValue
=== null ) {
880 $this->mTitleValue
= new TitleValue(
881 $this->getNamespace(),
883 $this->getFragment() );
884 } catch ( InvalidArgumentException
$ex ) {
885 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
886 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
890 return $this->mTitleValue
;
894 * Get the text form (spaces not underscores) of the main part
896 * @return string Main part of the title
898 public function getText() {
899 return $this->mTextform
;
903 * Get the URL-encoded form of the main part
905 * @return string Main part of the title, URL-encoded
907 public function getPartialURL() {
908 return $this->mUrlform
;
912 * Get the main part with underscores
914 * @return string Main part of the title, with underscores
916 public function getDBkey() {
917 return $this->mDbkeyform
;
921 * Get the DB key with the initial letter case as specified by the user
923 * @return string DB key
925 function getUserCaseDBKey() {
926 if ( !is_null( $this->mUserCaseDBKey
) ) {
927 return $this->mUserCaseDBKey
;
929 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
930 return $this->mDbkeyform
;
935 * Get the namespace index, i.e. one of the NS_xxxx constants.
937 * @return int Namespace index
939 public function getNamespace() {
940 return $this->mNamespace
;
944 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
946 * @throws MWException
947 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
948 * @return string Content model id
950 public function getContentModel( $flags = 0 ) {
951 # Calling getArticleID() loads the field from cache as needed
952 if ( !$this->mContentModel
&& $this->getArticleID( $flags ) ) {
953 $linkCache = LinkCache
::singleton();
954 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
957 if ( !$this->mContentModel
) {
958 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
961 if ( !$this->mContentModel
) {
962 throw new MWException( 'Failed to determine content model!' );
965 return $this->mContentModel
;
969 * Convenience method for checking a title's content model name
971 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
972 * @return bool True if $this->getContentModel() == $id
974 public function hasContentModel( $id ) {
975 return $this->getContentModel() == $id;
979 * Get the namespace text
981 * @return string Namespace text
983 public function getNsText() {
984 if ( $this->isExternal() ) {
985 // This probably shouldn't even happen. ohh man, oh yuck.
986 // But for interwiki transclusion it sometimes does.
987 // Shit. Shit shit shit.
989 // Use the canonical namespaces if possible to try to
990 // resolve a foreign namespace.
991 if ( MWNamespace
::exists( $this->mNamespace
) ) {
992 return MWNamespace
::getCanonicalName( $this->mNamespace
);
997 $formatter = self
::getTitleFormatter();
998 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
999 } catch ( InvalidArgumentException
$ex ) {
1000 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1006 * Get the namespace text of the subject (rather than talk) page
1008 * @return string Namespace text
1010 public function getSubjectNsText() {
1012 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1016 * Get the namespace text of the talk page
1018 * @return string Namespace text
1020 public function getTalkNsText() {
1022 return $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1026 * Could this title have a corresponding talk page?
1030 public function canTalk() {
1031 return MWNamespace
::canTalk( $this->mNamespace
);
1035 * Is this in a namespace that allows actual pages?
1038 * @internal note -- uses hardcoded namespace index instead of constants
1040 public function canExist() {
1041 return $this->mNamespace
>= NS_MAIN
;
1045 * Can this title be added to a user's watchlist?
1049 public function isWatchable() {
1050 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
1054 * Returns true if this is a special page.
1058 public function isSpecialPage() {
1059 return $this->getNamespace() == NS_SPECIAL
;
1063 * Returns true if this title resolves to the named special page
1065 * @param string $name The special page name
1068 public function isSpecial( $name ) {
1069 if ( $this->isSpecialPage() ) {
1070 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
1071 if ( $name == $thisName ) {
1079 * If the Title refers to a special page alias which is not the local default, resolve
1080 * the alias, and localise the name as necessary. Otherwise, return $this
1084 public function fixSpecialName() {
1085 if ( $this->isSpecialPage() ) {
1086 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
1087 if ( $canonicalName ) {
1088 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
1089 if ( $localName != $this->mDbkeyform
) {
1090 return Title
::makeTitle( NS_SPECIAL
, $localName );
1098 * Returns true if the title is inside the specified namespace.
1100 * Please make use of this instead of comparing to getNamespace()
1101 * This function is much more resistant to changes we may make
1102 * to namespaces than code that makes direct comparisons.
1103 * @param int $ns The namespace
1107 public function inNamespace( $ns ) {
1108 return MWNamespace
::equals( $this->getNamespace(), $ns );
1112 * Returns true if the title is inside one of the specified namespaces.
1114 * @param int $namespaces,... The namespaces to check for
1118 public function inNamespaces( /* ... */ ) {
1119 $namespaces = func_get_args();
1120 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1121 $namespaces = $namespaces[0];
1124 foreach ( $namespaces as $ns ) {
1125 if ( $this->inNamespace( $ns ) ) {
1134 * Returns true if the title has the same subject namespace as the
1135 * namespace specified.
1136 * For example this method will take NS_USER and return true if namespace
1137 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1138 * as their subject namespace.
1140 * This is MUCH simpler than individually testing for equivalence
1141 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1146 public function hasSubjectNamespace( $ns ) {
1147 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
1151 * Is this Title in a namespace which contains content?
1152 * In other words, is this a content page, for the purposes of calculating
1157 public function isContentPage() {
1158 return MWNamespace
::isContent( $this->getNamespace() );
1162 * Would anybody with sufficient privileges be able to move this page?
1163 * Some pages just aren't movable.
1167 public function isMovable() {
1168 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->isExternal() ) {
1169 // Interwiki title or immovable namespace. Hooks don't get to override here
1174 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
1179 * Is this the mainpage?
1180 * @note Title::newFromText seems to be sufficiently optimized by the title
1181 * cache that we don't need to over-optimize by doing direct comparisons and
1182 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1183 * ends up reporting something differently than $title->isMainPage();
1188 public function isMainPage() {
1189 return $this->equals( Title
::newMainPage() );
1193 * Is this a subpage?
1197 public function isSubpage() {
1198 return MWNamespace
::hasSubpages( $this->mNamespace
)
1199 ?
strpos( $this->getText(), '/' ) !== false
1204 * Is this a conversion table for the LanguageConverter?
1208 public function isConversionTable() {
1209 // @todo ConversionTable should become a separate content model.
1211 return $this->getNamespace() == NS_MEDIAWIKI
&&
1212 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1216 * Does that page contain wikitext, or it is JS, CSS or whatever?
1220 public function isWikitextPage() {
1221 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1225 * Could this page contain custom CSS or JavaScript for the global UI.
1226 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1227 * or CONTENT_MODEL_JAVASCRIPT.
1229 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1232 * Note that this method should not return true for pages that contain and
1233 * show "inactive" CSS or JS.
1237 public function isCssOrJsPage() {
1238 $isCssOrJsPage = NS_MEDIAWIKI
== $this->mNamespace
1239 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1240 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1242 # @note This hook is also called in ContentHandler::getDefaultModel.
1243 # It's called here again to make sure hook functions can force this
1244 # method to return true even outside the mediawiki namespace.
1246 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
1248 return $isCssOrJsPage;
1252 * Is this a .css or .js subpage of a user page?
1255 public function isCssJsSubpage() {
1256 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1257 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1258 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1262 * Trim down a .css or .js subpage title to get the corresponding skin name
1264 * @return string Containing skin name from .css or .js subpage title
1266 public function getSkinFromCssJsSubpage() {
1267 $subpage = explode( '/', $this->mTextform
);
1268 $subpage = $subpage[count( $subpage ) - 1];
1269 $lastdot = strrpos( $subpage, '.' );
1270 if ( $lastdot === false ) {
1271 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1273 return substr( $subpage, 0, $lastdot );
1277 * Is this a .css subpage of a user page?
1281 public function isCssSubpage() {
1282 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1283 && $this->hasContentModel( CONTENT_MODEL_CSS
) );
1287 * Is this a .js subpage of a user page?
1291 public function isJsSubpage() {
1292 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1293 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1297 * Is this a talk page of some sort?
1301 public function isTalkPage() {
1302 return MWNamespace
::isTalk( $this->getNamespace() );
1306 * Get a Title object associated with the talk page of this article
1308 * @return Title The object for the talk page
1310 public function getTalkPage() {
1311 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1315 * Get a title object associated with the subject page of this
1318 * @return Title The object for the subject page
1320 public function getSubjectPage() {
1321 // Is this the same title?
1322 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1323 if ( $this->getNamespace() == $subjectNS ) {
1326 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1330 * Get the default namespace index, for when there is no namespace
1332 * @return int Default namespace index
1334 public function getDefaultNamespace() {
1335 return $this->mDefaultNamespace
;
1339 * Get the Title fragment (i.e.\ the bit after the #) in text form
1341 * Use Title::hasFragment to check for a fragment
1343 * @return string Title fragment
1345 public function getFragment() {
1346 return $this->mFragment
;
1350 * Check if a Title fragment is set
1355 public function hasFragment() {
1356 return $this->mFragment
!== '';
1360 * Get the fragment in URL form, including the "#" character if there is one
1361 * @return string Fragment in URL form
1363 public function getFragmentForURL() {
1364 if ( !$this->hasFragment() ) {
1367 return '#' . Title
::escapeFragmentForURL( $this->getFragment() );
1372 * Set the fragment for this title. Removes the first character from the
1373 * specified fragment before setting, so it assumes you're passing it with
1376 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1377 * Still in active use privately.
1379 * @param string $fragment Text
1381 public function setFragment( $fragment ) {
1382 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1386 * Prefix some arbitrary text with the namespace or interwiki prefix
1389 * @param string $name The text
1390 * @return string The prefixed text
1392 private function prefix( $name ) {
1394 if ( $this->isExternal() ) {
1395 $p = $this->mInterwiki
. ':';
1398 if ( 0 != $this->mNamespace
) {
1399 $p .= $this->getNsText() . ':';
1405 * Get the prefixed database key form
1407 * @return string The prefixed title, with underscores and
1408 * any interwiki and namespace prefixes
1410 public function getPrefixedDBkey() {
1411 $s = $this->prefix( $this->mDbkeyform
);
1412 $s = str_replace( ' ', '_', $s );
1417 * Get the prefixed title with spaces.
1418 * This is the form usually used for display
1420 * @return string The prefixed title, with spaces
1422 public function getPrefixedText() {
1423 if ( $this->mPrefixedText
=== null ) {
1424 $s = $this->prefix( $this->mTextform
);
1425 $s = str_replace( '_', ' ', $s );
1426 $this->mPrefixedText
= $s;
1428 return $this->mPrefixedText
;
1432 * Return a string representation of this title
1434 * @return string Representation of this title
1436 public function __toString() {
1437 return $this->getPrefixedText();
1441 * Get the prefixed title with spaces, plus any fragment
1442 * (part beginning with '#')
1444 * @return string The prefixed title, with spaces and the fragment, including '#'
1446 public function getFullText() {
1447 $text = $this->getPrefixedText();
1448 if ( $this->hasFragment() ) {
1449 $text .= '#' . $this->getFragment();
1455 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1459 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1463 * @return string Root name
1466 public function getRootText() {
1467 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1468 return $this->getText();
1471 return strtok( $this->getText(), '/' );
1475 * Get the root page name title, i.e. the leftmost part before any slashes
1479 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1480 * # returns: Title{User:Foo}
1483 * @return Title Root title
1486 public function getRootTitle() {
1487 return Title
::makeTitle( $this->getNamespace(), $this->getRootText() );
1491 * Get the base page name without a namespace, i.e. the part before the subpage name
1495 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1496 * # returns: 'Foo/Bar'
1499 * @return string Base name
1501 public function getBaseText() {
1502 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1503 return $this->getText();
1506 $parts = explode( '/', $this->getText() );
1507 # Don't discard the real title if there's no subpage involved
1508 if ( count( $parts ) > 1 ) {
1509 unset( $parts[count( $parts ) - 1] );
1511 return implode( '/', $parts );
1515 * Get the base page name title, i.e. the part before the subpage name
1519 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1520 * # returns: Title{User:Foo/Bar}
1523 * @return Title Base title
1526 public function getBaseTitle() {
1527 return Title
::makeTitle( $this->getNamespace(), $this->getBaseText() );
1531 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1535 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1539 * @return string Subpage name
1541 public function getSubpageText() {
1542 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1543 return $this->mTextform
;
1545 $parts = explode( '/', $this->mTextform
);
1546 return $parts[count( $parts ) - 1];
1550 * Get the title for a subpage of the current page
1554 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1555 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1558 * @param string $text The subpage name to add to the title
1559 * @return Title Subpage title
1562 public function getSubpage( $text ) {
1563 return Title
::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1567 * Get a URL-encoded form of the subpage text
1569 * @return string URL-encoded subpage name
1571 public function getSubpageUrlForm() {
1572 $text = $this->getSubpageText();
1573 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1578 * Get a URL-encoded title (not an actual URL) including interwiki
1580 * @return string The URL-encoded form
1582 public function getPrefixedURL() {
1583 $s = $this->prefix( $this->mDbkeyform
);
1584 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1589 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1590 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1591 * second argument named variant. This was deprecated in favor
1592 * of passing an array of option with a "variant" key
1593 * Once $query2 is removed for good, this helper can be dropped
1594 * and the wfArrayToCgi moved to getLocalURL();
1596 * @since 1.19 (r105919)
1597 * @param array|string $query
1598 * @param bool $query2
1601 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1602 if ( $query2 !== false ) {
1603 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1604 "method called with a second parameter is deprecated. Add your " .
1605 "parameter to an array passed as the first parameter.", "1.19" );
1607 if ( is_array( $query ) ) {
1608 $query = wfArrayToCgi( $query );
1611 if ( is_string( $query2 ) ) {
1612 // $query2 is a string, we will consider this to be
1613 // a deprecated $variant argument and add it to the query
1614 $query2 = wfArrayToCgi( array( 'variant' => $query2 ) );
1616 $query2 = wfArrayToCgi( $query2 );
1618 // If we have $query content add a & to it first
1622 // Now append the queries together
1629 * Get a real URL referring to this title, with interwiki link and
1632 * @see self::getLocalURL for the arguments.
1634 * @param array|string $query
1635 * @param bool $query2
1636 * @param string $proto Protocol type to use in URL
1637 * @return string The URL
1639 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1640 $query = self
::fixUrlQueryArgs( $query, $query2 );
1642 # Hand off all the decisions on urls to getLocalURL
1643 $url = $this->getLocalURL( $query );
1645 # Expand the url to make it a full url. Note that getLocalURL has the
1646 # potential to output full urls for a variety of reasons, so we use
1647 # wfExpandUrl instead of simply prepending $wgServer
1648 $url = wfExpandUrl( $url, $proto );
1650 # Finally, add the fragment.
1651 $url .= $this->getFragmentForURL();
1653 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1658 * Get a URL with no fragment or server name (relative URL) from a Title object.
1659 * If this page is generated with action=render, however,
1660 * $wgServer is prepended to make an absolute URL.
1662 * @see self::getFullURL to always get an absolute URL.
1663 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1664 * valid to link, locally, to the current Title.
1665 * @see self::newFromText to produce a Title object.
1667 * @param string|array $query An optional query string,
1668 * not used for interwiki links. Can be specified as an associative array as well,
1669 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1670 * Some query patterns will trigger various shorturl path replacements.
1671 * @param array $query2 An optional secondary query array. This one MUST
1672 * be an array. If a string is passed it will be interpreted as a deprecated
1673 * variant argument and urlencoded into a variant= argument.
1674 * This second query argument will be added to the $query
1675 * The second parameter is deprecated since 1.19. Pass it as a key,value
1676 * pair in the first parameter array instead.
1678 * @return string String of the URL.
1680 public function getLocalURL( $query = '', $query2 = false ) {
1681 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1683 $query = self
::fixUrlQueryArgs( $query, $query2 );
1685 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1687 $namespace = $this->getNsText();
1688 if ( $namespace != '' ) {
1689 # Can this actually happen? Interwikis shouldn't be parsed.
1690 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1693 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1694 $url = wfAppendQuery( $url, $query );
1696 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1697 if ( $query == '' ) {
1698 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1699 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1701 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1705 if ( !empty( $wgActionPaths )
1706 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1708 $action = urldecode( $matches[2] );
1709 if ( isset( $wgActionPaths[$action] ) ) {
1710 $query = $matches[1];
1711 if ( isset( $matches[4] ) ) {
1712 $query .= $matches[4];
1714 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1715 if ( $query != '' ) {
1716 $url = wfAppendQuery( $url, $query );
1722 && $wgVariantArticlePath
1723 && $wgContLang->getCode() === $this->getPageLanguage()->getCode()
1724 && $this->getPageLanguage()->hasVariants()
1725 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1727 $variant = urldecode( $matches[1] );
1728 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1729 // Only do the variant replacement if the given variant is a valid
1730 // variant for the page's language.
1731 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1732 $url = str_replace( '$1', $dbkey, $url );
1736 if ( $url === false ) {
1737 if ( $query == '-' ) {
1740 $url = "{$wgScript}?title={$dbkey}&{$query}";
1744 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1746 // @todo FIXME: This causes breakage in various places when we
1747 // actually expected a local URL and end up with dupe prefixes.
1748 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1749 $url = $wgServer . $url;
1752 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1757 * Get a URL that's the simplest URL that will be valid to link, locally,
1758 * to the current Title. It includes the fragment, but does not include
1759 * the server unless action=render is used (or the link is external). If
1760 * there's a fragment but the prefixed text is empty, we just return a link
1763 * The result obviously should not be URL-escaped, but does need to be
1764 * HTML-escaped if it's being output in HTML.
1766 * @param array $query
1767 * @param bool $query2
1768 * @param string $proto Protocol to use; setting this will cause a full URL to be used
1769 * @see self::getLocalURL for the arguments.
1770 * @return string The URL
1772 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1773 wfProfileIn( __METHOD__
);
1774 if ( $this->isExternal() ||
$proto !== PROTO_RELATIVE
) {
1775 $ret = $this->getFullURL( $query, $query2, $proto );
1776 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1777 $ret = $this->getFragmentForURL();
1779 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1781 wfProfileOut( __METHOD__
);
1786 * Get the URL form for an internal link.
1787 * - Used in various Squid-related code, in case we have a different
1788 * internal hostname for the server from the exposed one.
1790 * This uses $wgInternalServer to qualify the path, or $wgServer
1791 * if $wgInternalServer is not set. If the server variable used is
1792 * protocol-relative, the URL will be expanded to http://
1794 * @see self::getLocalURL for the arguments.
1795 * @return string The URL
1797 public function getInternalURL( $query = '', $query2 = false ) {
1798 global $wgInternalServer, $wgServer;
1799 $query = self
::fixUrlQueryArgs( $query, $query2 );
1800 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1801 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1802 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1807 * Get the URL for a canonical link, for use in things like IRC and
1808 * e-mail notifications. Uses $wgCanonicalServer and the
1809 * GetCanonicalURL hook.
1811 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1813 * @see self::getLocalURL for the arguments.
1814 * @return string The URL
1817 public function getCanonicalURL( $query = '', $query2 = false ) {
1818 $query = self
::fixUrlQueryArgs( $query, $query2 );
1819 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1820 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1825 * Get the edit URL for this Title
1827 * @return string The URL, or a null string if this is an interwiki link
1829 public function getEditURL() {
1830 if ( $this->isExternal() ) {
1833 $s = $this->getLocalURL( 'action=edit' );
1839 * Is $wgUser watching this page?
1841 * @deprecated since 1.20; use User::isWatched() instead.
1844 public function userIsWatching() {
1847 if ( is_null( $this->mWatched
) ) {
1848 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1849 $this->mWatched
= false;
1851 $this->mWatched
= $wgUser->isWatched( $this );
1854 return $this->mWatched
;
1858 * Can $user perform $action on this page?
1859 * This skips potentially expensive cascading permission checks
1860 * as well as avoids expensive error formatting
1862 * Suitable for use for nonessential UI controls in common cases, but
1863 * _not_ for functional access control.
1865 * May provide false positives, but should never provide a false negative.
1867 * @param string $action Action that permission needs to be checked for
1868 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1871 public function quickUserCan( $action, $user = null ) {
1872 return $this->userCan( $action, $user, false );
1876 * Can $user perform $action on this page?
1878 * @param string $action Action that permission needs to be checked for
1879 * @param User $user User to check (since 1.19); $wgUser will be used if not
1881 * @param bool $doExpensiveQueries Set this to false to avoid doing
1882 * unnecessary queries.
1885 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1886 if ( !$user instanceof User
) {
1891 return !count( $this->getUserPermissionsErrorsInternal(
1892 $action, $user, $doExpensiveQueries, true ) );
1896 * Can $user perform $action on this page?
1898 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1900 * @param string $action Action that permission needs to be checked for
1901 * @param User $user User to check
1902 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary
1903 * queries by skipping checks for cascading protections and user blocks.
1904 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
1905 * whose corresponding errors may be ignored.
1906 * @return array Array of arguments to wfMessage to explain permissions problems.
1908 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true,
1909 $ignoreErrors = array()
1911 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1913 // Remove the errors being ignored.
1914 foreach ( $errors as $index => $error ) {
1915 $error_key = is_array( $error ) ?
$error[0] : $error;
1917 if ( in_array( $error_key, $ignoreErrors ) ) {
1918 unset( $errors[$index] );
1926 * Permissions checks that fail most often, and which are easiest to test.
1928 * @param string $action The action to check
1929 * @param User $user User to check
1930 * @param array $errors List of current errors
1931 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
1932 * @param bool $short Short circuit on first error
1934 * @return array List of errors
1936 private function checkQuickPermissions( $action, $user, $errors,
1937 $doExpensiveQueries, $short
1939 if ( !wfRunHooks( 'TitleQuickPermissions',
1940 array( $this, $user, $action, &$errors, $doExpensiveQueries, $short ) )
1945 if ( $action == 'create' ) {
1947 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1948 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1950 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1952 } elseif ( $action == 'move' ) {
1953 if ( !$user->isAllowed( 'move-rootuserpages' )
1954 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1955 // Show user page-specific message only if the user can move other pages
1956 $errors[] = array( 'cant-move-user-page' );
1959 // Check if user is allowed to move files if it's a file
1960 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1961 $errors[] = array( 'movenotallowedfile' );
1964 // Check if user is allowed to move category pages if it's a category page
1965 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
1966 $errors[] = array( 'cant-move-category-page' );
1969 if ( !$user->isAllowed( 'move' ) ) {
1970 // User can't move anything
1971 $userCanMove = User
::groupHasPermission( 'user', 'move' );
1972 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
1973 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1974 // custom message if logged-in users without any special rights can move
1975 $errors[] = array( 'movenologintext' );
1977 $errors[] = array( 'movenotallowed' );
1980 } elseif ( $action == 'move-target' ) {
1981 if ( !$user->isAllowed( 'move' ) ) {
1982 // User can't move anything
1983 $errors[] = array( 'movenotallowed' );
1984 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1985 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1986 // Show user page-specific message only if the user can move other pages
1987 $errors[] = array( 'cant-move-to-user-page' );
1988 } elseif ( !$user->isAllowed( 'move-categorypages' )
1989 && $this->mNamespace
== NS_CATEGORY
) {
1990 // Show category page-specific message only if the user can move other pages
1991 $errors[] = array( 'cant-move-to-category-page' );
1993 } elseif ( !$user->isAllowed( $action ) ) {
1994 $errors[] = $this->missingPermissionError( $action, $short );
2001 * Add the resulting error code to the errors array
2003 * @param array $errors List of current errors
2004 * @param array $result Result of errors
2006 * @return array List of errors
2008 private function resultToError( $errors, $result ) {
2009 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2010 // A single array representing an error
2011 $errors[] = $result;
2012 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2013 // A nested array representing multiple errors
2014 $errors = array_merge( $errors, $result );
2015 } elseif ( $result !== '' && is_string( $result ) ) {
2016 // A string representing a message-id
2017 $errors[] = array( $result );
2018 } elseif ( $result === false ) {
2019 // a generic "We don't want them to do that"
2020 $errors[] = array( 'badaccess-group0' );
2026 * Check various permission hooks
2028 * @param string $action The action to check
2029 * @param User $user User to check
2030 * @param array $errors List of current errors
2031 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2032 * @param bool $short Short circuit on first error
2034 * @return array List of errors
2036 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
2037 // Use getUserPermissionsErrors instead
2039 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
2040 return $result ?
array() : array( array( 'badaccess-group0' ) );
2042 // Check getUserPermissionsErrors hook
2043 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
2044 $errors = $this->resultToError( $errors, $result );
2046 // Check getUserPermissionsErrorsExpensive hook
2049 && !( $short && count( $errors ) > 0 )
2050 && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
2052 $errors = $this->resultToError( $errors, $result );
2059 * Check permissions on special pages & namespaces
2061 * @param string $action The action to check
2062 * @param User $user User to check
2063 * @param array $errors List of current errors
2064 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2065 * @param bool $short Short circuit on first error
2067 * @return array List of errors
2069 private function checkSpecialsAndNSPermissions( $action, $user, $errors,
2070 $doExpensiveQueries, $short
2072 # Only 'createaccount' can be performed on special pages,
2073 # which don't actually exist in the DB.
2074 if ( NS_SPECIAL
== $this->mNamespace
&& $action !== 'createaccount' ) {
2075 $errors[] = array( 'ns-specialprotected' );
2078 # Check $wgNamespaceProtection for restricted namespaces
2079 if ( $this->isNamespaceProtected( $user ) ) {
2080 $ns = $this->mNamespace
== NS_MAIN ?
2081 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2082 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2083 array( 'protectedinterface', $action ) : array( 'namespaceprotected', $ns, $action );
2090 * Check CSS/JS sub-page permissions
2092 * @param string $action The action to check
2093 * @param User $user User to check
2094 * @param array $errors List of current errors
2095 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2096 * @param bool $short Short circuit on first error
2098 * @return array List of errors
2100 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2101 # Protect css/js subpages of user pages
2102 # XXX: this might be better using restrictions
2103 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2104 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2105 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2106 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2107 $errors[] = array( 'mycustomcssprotected', $action );
2108 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2109 $errors[] = array( 'mycustomjsprotected', $action );
2112 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2113 $errors[] = array( 'customcssprotected', $action );
2114 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2115 $errors[] = array( 'customjsprotected', $action );
2124 * Check against page_restrictions table requirements on this
2125 * page. The user must possess all required rights for this
2128 * @param string $action The action to check
2129 * @param User $user User to check
2130 * @param array $errors List of current errors
2131 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2132 * @param bool $short Short circuit on first error
2134 * @return array List of errors
2136 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2137 foreach ( $this->getRestrictions( $action ) as $right ) {
2138 // Backwards compatibility, rewrite sysop -> editprotected
2139 if ( $right == 'sysop' ) {
2140 $right = 'editprotected';
2142 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2143 if ( $right == 'autoconfirmed' ) {
2144 $right = 'editsemiprotected';
2146 if ( $right == '' ) {
2149 if ( !$user->isAllowed( $right ) ) {
2150 $errors[] = array( 'protectedpagetext', $right, $action );
2151 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2152 $errors[] = array( 'protectedpagetext', 'protect', $action );
2160 * Check restrictions on cascading pages.
2162 * @param string $action The action to check
2163 * @param User $user User to check
2164 * @param array $errors List of current errors
2165 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2166 * @param bool $short Short circuit on first error
2168 * @return array List of errors
2170 private function checkCascadingSourcesRestrictions( $action, $user, $errors,
2171 $doExpensiveQueries, $short
2173 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
2174 # We /could/ use the protection level on the source page, but it's
2175 # fairly ugly as we have to establish a precedence hierarchy for pages
2176 # included by multiple cascade-protected pages. So just restrict
2177 # it to people with 'protect' permission, as they could remove the
2178 # protection anyway.
2179 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2180 # Cascading protection depends on more than this page...
2181 # Several cascading protected pages may include this page...
2182 # Check each cascading level
2183 # This is only for protection restrictions, not for all actions
2184 if ( isset( $restrictions[$action] ) ) {
2185 foreach ( $restrictions[$action] as $right ) {
2186 // Backwards compatibility, rewrite sysop -> editprotected
2187 if ( $right == 'sysop' ) {
2188 $right = 'editprotected';
2190 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2191 if ( $right == 'autoconfirmed' ) {
2192 $right = 'editsemiprotected';
2194 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2196 foreach ( $cascadingSources as $page ) {
2197 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2199 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages, $action );
2209 * Check action permissions not already checked in checkQuickPermissions
2211 * @param string $action The action to check
2212 * @param User $user User to check
2213 * @param array $errors List of current errors
2214 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2215 * @param bool $short Short circuit on first error
2217 * @return array List of errors
2219 private function checkActionPermissions( $action, $user, $errors,
2220 $doExpensiveQueries, $short
2222 global $wgDeleteRevisionsLimit, $wgLang;
2224 if ( $action == 'protect' ) {
2225 if ( count( $this->getUserPermissionsErrorsInternal( 'edit',
2226 $user, $doExpensiveQueries, true ) )
2228 // If they can't edit, they shouldn't protect.
2229 $errors[] = array( 'protect-cantedit' );
2231 } elseif ( $action == 'create' ) {
2232 $title_protection = $this->getTitleProtection();
2233 if ( $title_protection ) {
2234 if ( $title_protection['pt_create_perm'] == 'sysop' ) {
2235 $title_protection['pt_create_perm'] = 'editprotected'; // B/C
2237 if ( $title_protection['pt_create_perm'] == 'autoconfirmed' ) {
2238 $title_protection['pt_create_perm'] = 'editsemiprotected'; // B/C
2240 if ( $title_protection['pt_create_perm'] == ''
2241 ||
!$user->isAllowed( $title_protection['pt_create_perm'] )
2245 User
::whoIs( $title_protection['pt_user'] ),
2246 $title_protection['pt_reason']
2250 } elseif ( $action == 'move' ) {
2251 // Check for immobile pages
2252 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2253 // Specific message for this case
2254 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2255 } elseif ( !$this->isMovable() ) {
2256 // Less specific message for rarer cases
2257 $errors[] = array( 'immobile-source-page' );
2259 } elseif ( $action == 'move-target' ) {
2260 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2261 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2262 } elseif ( !$this->isMovable() ) {
2263 $errors[] = array( 'immobile-target-page' );
2265 } elseif ( $action == 'delete' ) {
2266 $tempErrors = $this->checkPageRestrictions( 'edit',
2267 $user, array(), $doExpensiveQueries, true );
2268 if ( !$tempErrors ) {
2269 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2270 $user, $tempErrors, $doExpensiveQueries, true );
2272 if ( $tempErrors ) {
2273 // If protection keeps them from editing, they shouldn't be able to delete.
2274 $errors[] = array( 'deleteprotected' );
2276 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2277 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2279 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2286 * Check that the user isn't blocked from editing.
2288 * @param string $action The action to check
2289 * @param User $user User to check
2290 * @param array $errors List of current errors
2291 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2292 * @param bool $short Short circuit on first error
2294 * @return array List of errors
2296 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2297 // Account creation blocks handled at userlogin.
2298 // Unblocking handled in SpecialUnblock
2299 if ( !$doExpensiveQueries ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2303 global $wgEmailConfirmToEdit;
2305 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2306 $errors[] = array( 'confirmedittext' );
2309 if ( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2310 // Don't block the user from editing their own talk page unless they've been
2311 // explicitly blocked from that too.
2312 } elseif ( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
2313 // @todo FIXME: Pass the relevant context into this function.
2314 $errors[] = $user->getBlock()->getPermissionsError( RequestContext
::getMain() );
2321 * Check that the user is allowed to read this page.
2323 * @param string $action The action to check
2324 * @param User $user User to check
2325 * @param array $errors List of current errors
2326 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2327 * @param bool $short Short circuit on first error
2329 * @return array List of errors
2331 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2332 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2334 $whitelisted = false;
2335 if ( User
::isEveryoneAllowed( 'read' ) ) {
2336 # Shortcut for public wikis, allows skipping quite a bit of code
2337 $whitelisted = true;
2338 } elseif ( $user->isAllowed( 'read' ) ) {
2339 # If the user is allowed to read pages, he is allowed to read all pages
2340 $whitelisted = true;
2341 } elseif ( $this->isSpecial( 'Userlogin' )
2342 ||
$this->isSpecial( 'ChangePassword' )
2343 ||
$this->isSpecial( 'PasswordReset' )
2345 # Always grant access to the login page.
2346 # Even anons need to be able to log in.
2347 $whitelisted = true;
2348 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2349 # Time to check the whitelist
2350 # Only do these checks is there's something to check against
2351 $name = $this->getPrefixedText();
2352 $dbName = $this->getPrefixedDBkey();
2354 // Check for explicit whitelisting with and without underscores
2355 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2356 $whitelisted = true;
2357 } elseif ( $this->getNamespace() == NS_MAIN
) {
2358 # Old settings might have the title prefixed with
2359 # a colon for main-namespace pages
2360 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2361 $whitelisted = true;
2363 } elseif ( $this->isSpecialPage() ) {
2364 # If it's a special page, ditch the subpage bit and check again
2365 $name = $this->getDBkey();
2366 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2368 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2369 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2370 $whitelisted = true;
2376 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2377 $name = $this->getPrefixedText();
2378 // Check for regex whitelisting
2379 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2380 if ( preg_match( $listItem, $name ) ) {
2381 $whitelisted = true;
2387 if ( !$whitelisted ) {
2388 # If the title is not whitelisted, give extensions a chance to do so...
2389 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2390 if ( !$whitelisted ) {
2391 $errors[] = $this->missingPermissionError( $action, $short );
2399 * Get a description array when the user doesn't have the right to perform
2400 * $action (i.e. when User::isAllowed() returns false)
2402 * @param string $action The action to check
2403 * @param bool $short Short circuit on first error
2404 * @return array List of errors
2406 private function missingPermissionError( $action, $short ) {
2407 // We avoid expensive display logic for quickUserCan's and such
2409 return array( 'badaccess-group0' );
2412 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2413 User
::getGroupsWithPermission( $action ) );
2415 if ( count( $groups ) ) {
2419 $wgLang->commaList( $groups ),
2423 return array( 'badaccess-group0' );
2428 * Can $user perform $action on this page? This is an internal function,
2429 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2430 * checks on wfReadOnly() and blocks)
2432 * @param string $action Action that permission needs to be checked for
2433 * @param User $user User to check
2434 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
2435 * @param bool $short Set this to true to stop after the first permission error.
2436 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2438 protected function getUserPermissionsErrorsInternal( $action, $user,
2439 $doExpensiveQueries = true, $short = false
2441 wfProfileIn( __METHOD__
);
2443 # Read has special handling
2444 if ( $action == 'read' ) {
2446 'checkPermissionHooks',
2447 'checkReadPermissions',
2449 # Don't call checkSpecialsAndNSPermissions or checkCSSandJSPermissions
2450 # here as it will lead to duplicate error messages. This is okay to do
2451 # since anywhere that checks for create will also check for edit, and
2452 # those checks are called for edit.
2453 } elseif ( $action == 'create' ) {
2455 'checkQuickPermissions',
2456 'checkPermissionHooks',
2457 'checkPageRestrictions',
2458 'checkCascadingSourcesRestrictions',
2459 'checkActionPermissions',
2464 'checkQuickPermissions',
2465 'checkPermissionHooks',
2466 'checkSpecialsAndNSPermissions',
2467 'checkCSSandJSPermissions',
2468 'checkPageRestrictions',
2469 'checkCascadingSourcesRestrictions',
2470 'checkActionPermissions',
2476 while ( count( $checks ) > 0 &&
2477 !( $short && count( $errors ) > 0 ) ) {
2478 $method = array_shift( $checks );
2479 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2482 wfProfileOut( __METHOD__
);
2487 * Get a filtered list of all restriction types supported by this wiki.
2488 * @param bool $exists True to get all restriction types that apply to
2489 * titles that do exist, False for all restriction types that apply to
2490 * titles that do not exist
2493 public static function getFilteredRestrictionTypes( $exists = true ) {
2494 global $wgRestrictionTypes;
2495 $types = $wgRestrictionTypes;
2497 # Remove the create restriction for existing titles
2498 $types = array_diff( $types, array( 'create' ) );
2500 # Only the create and upload restrictions apply to non-existing titles
2501 $types = array_intersect( $types, array( 'create', 'upload' ) );
2507 * Returns restriction types for the current Title
2509 * @return array Applicable restriction types
2511 public function getRestrictionTypes() {
2512 if ( $this->isSpecialPage() ) {
2516 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2518 if ( $this->getNamespace() != NS_FILE
) {
2519 # Remove the upload restriction for non-file titles
2520 $types = array_diff( $types, array( 'upload' ) );
2523 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2525 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2526 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2532 * Is this title subject to title protection?
2533 * Title protection is the one applied against creation of such title.
2535 * @return array|bool An associative array representing any existent title
2536 * protection, or false if there's none.
2538 private function getTitleProtection() {
2539 // Can't protect pages in special namespaces
2540 if ( $this->getNamespace() < 0 ) {
2544 // Can't protect pages that exist.
2545 if ( $this->exists() ) {
2549 if ( $this->mTitleProtection
=== null ) {
2550 $dbr = wfGetDB( DB_SLAVE
);
2551 $res = $dbr->select(
2553 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2554 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2558 // fetchRow returns false if there are no rows.
2559 $this->mTitleProtection
= $dbr->fetchRow( $res );
2561 return $this->mTitleProtection
;
2565 * Remove any title protection due to page existing
2567 public function deleteTitleProtection() {
2568 $dbw = wfGetDB( DB_MASTER
);
2572 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2575 $this->mTitleProtection
= false;
2579 * Is this page "semi-protected" - the *only* protection levels are listed
2580 * in $wgSemiprotectedRestrictionLevels?
2582 * @param string $action Action to check (default: edit)
2585 public function isSemiProtected( $action = 'edit' ) {
2586 global $wgSemiprotectedRestrictionLevels;
2588 $restrictions = $this->getRestrictions( $action );
2589 $semi = $wgSemiprotectedRestrictionLevels;
2590 if ( !$restrictions ||
!$semi ) {
2591 // Not protected, or all protection is full protection
2595 // Remap autoconfirmed to editsemiprotected for BC
2596 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2597 $semi[$key] = 'editsemiprotected';
2599 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2600 $restrictions[$key] = 'editsemiprotected';
2603 return !array_diff( $restrictions, $semi );
2607 * Does the title correspond to a protected article?
2609 * @param string $action The action the page is protected from,
2610 * by default checks all actions.
2613 public function isProtected( $action = '' ) {
2614 global $wgRestrictionLevels;
2616 $restrictionTypes = $this->getRestrictionTypes();
2618 # Special pages have inherent protection
2619 if ( $this->isSpecialPage() ) {
2623 # Check regular protection levels
2624 foreach ( $restrictionTypes as $type ) {
2625 if ( $action == $type ||
$action == '' ) {
2626 $r = $this->getRestrictions( $type );
2627 foreach ( $wgRestrictionLevels as $level ) {
2628 if ( in_array( $level, $r ) && $level != '' ) {
2639 * Determines if $user is unable to edit this page because it has been protected
2640 * by $wgNamespaceProtection.
2642 * @param User $user User object to check permissions
2645 public function isNamespaceProtected( User
$user ) {
2646 global $wgNamespaceProtection;
2648 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2649 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2650 if ( $right != '' && !$user->isAllowed( $right ) ) {
2659 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2661 * @return bool If the page is subject to cascading restrictions.
2663 public function isCascadeProtected() {
2664 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2665 return ( $sources > 0 );
2669 * Determines whether cascading protection sources have already been loaded from
2672 * @param bool $getPages True to check if the pages are loaded, or false to check
2673 * if the status is loaded.
2674 * @return bool Whether or not the specified information has been loaded
2677 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2678 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2682 * Cascading protection: Get the source of any cascading restrictions on this page.
2684 * @param bool $getPages Whether or not to retrieve the actual pages
2685 * that the restrictions have come from and the actual restrictions
2687 * @return array Two elements: First is an array of Title objects of the
2688 * pages from which cascading restrictions have come, false for
2689 * none, or true if such restrictions exist but $getPages was not
2690 * set. Second is an array like that returned by
2691 * Title::getAllRestrictions(), or an empty array if $getPages is
2694 public function getCascadeProtectionSources( $getPages = true ) {
2696 $pagerestrictions = array();
2698 if ( $this->mCascadeSources
!== null && $getPages ) {
2699 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2700 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2701 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2704 wfProfileIn( __METHOD__
);
2706 $dbr = wfGetDB( DB_SLAVE
);
2708 if ( $this->getNamespace() == NS_FILE
) {
2709 $tables = array( 'imagelinks', 'page_restrictions' );
2710 $where_clauses = array(
2711 'il_to' => $this->getDBkey(),
2716 $tables = array( 'templatelinks', 'page_restrictions' );
2717 $where_clauses = array(
2718 'tl_namespace' => $this->getNamespace(),
2719 'tl_title' => $this->getDBkey(),
2726 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2727 'pr_expiry', 'pr_type', 'pr_level' );
2728 $where_clauses[] = 'page_id=pr_page';
2731 $cols = array( 'pr_expiry' );
2734 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2736 $sources = $getPages ?
array() : false;
2737 $now = wfTimestampNow();
2738 $purgeExpired = false;
2740 foreach ( $res as $row ) {
2741 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2742 if ( $expiry > $now ) {
2744 $page_id = $row->pr_page
;
2745 $page_ns = $row->page_namespace
;
2746 $page_title = $row->page_title
;
2747 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2748 # Add groups needed for each restriction type if its not already there
2749 # Make sure this restriction type still exists
2751 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2752 $pagerestrictions[$row->pr_type
] = array();
2756 isset( $pagerestrictions[$row->pr_type
] )
2757 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2759 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2765 // Trigger lazy purge of expired restrictions from the db
2766 $purgeExpired = true;
2769 if ( $purgeExpired ) {
2770 Title
::purgeExpiredRestrictions();
2774 $this->mCascadeSources
= $sources;
2775 $this->mCascadingRestrictions
= $pagerestrictions;
2777 $this->mHasCascadingRestrictions
= $sources;
2780 wfProfileOut( __METHOD__
);
2781 return array( $sources, $pagerestrictions );
2785 * Accessor for mRestrictionsLoaded
2787 * @return bool Whether or not the page's restrictions have already been
2788 * loaded from the database
2791 public function areRestrictionsLoaded() {
2792 return $this->mRestrictionsLoaded
;
2796 * Accessor/initialisation for mRestrictions
2798 * @param string $action Action that permission needs to be checked for
2799 * @return array Restriction levels needed to take the action. All levels
2802 public function getRestrictions( $action ) {
2803 if ( !$this->mRestrictionsLoaded
) {
2804 $this->loadRestrictions();
2806 return isset( $this->mRestrictions
[$action] )
2807 ?
$this->mRestrictions
[$action]
2812 * Accessor/initialisation for mRestrictions
2814 * @return array Keys are actions, values are arrays as returned by
2815 * Title::getRestrictions()
2818 public function getAllRestrictions() {
2819 if ( !$this->mRestrictionsLoaded
) {
2820 $this->loadRestrictions();
2822 return $this->mRestrictions
;
2826 * Get the expiry time for the restriction against a given action
2828 * @param string $action
2829 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2830 * or not protected at all, or false if the action is not recognised.
2832 public function getRestrictionExpiry( $action ) {
2833 if ( !$this->mRestrictionsLoaded
) {
2834 $this->loadRestrictions();
2836 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2840 * Returns cascading restrictions for the current article
2844 function areRestrictionsCascading() {
2845 if ( !$this->mRestrictionsLoaded
) {
2846 $this->loadRestrictions();
2849 return $this->mCascadeRestriction
;
2853 * Loads a string into mRestrictions array
2855 * @param ResultWrapper $res Resource restrictions as an SQL result.
2856 * @param string $oldFashionedRestrictions Comma-separated list of page
2857 * restrictions from page table (pre 1.10)
2859 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2862 foreach ( $res as $row ) {
2866 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2870 * Compiles list of active page restrictions from both page table (pre 1.10)
2871 * and page_restrictions table for this existing page.
2872 * Public for usage by LiquidThreads.
2874 * @param array $rows Array of db result objects
2875 * @param string $oldFashionedRestrictions Comma-separated list of page
2876 * restrictions from page table (pre 1.10)
2878 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2880 $dbr = wfGetDB( DB_SLAVE
);
2882 $restrictionTypes = $this->getRestrictionTypes();
2884 foreach ( $restrictionTypes as $type ) {
2885 $this->mRestrictions
[$type] = array();
2886 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2889 $this->mCascadeRestriction
= false;
2891 # Backwards-compatibility: also load the restrictions from the page record (old format).
2893 if ( $oldFashionedRestrictions === null ) {
2894 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2895 array( 'page_id' => $this->getArticleID() ), __METHOD__
);
2898 if ( $oldFashionedRestrictions != '' ) {
2900 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2901 $temp = explode( '=', trim( $restrict ) );
2902 if ( count( $temp ) == 1 ) {
2903 // old old format should be treated as edit/move restriction
2904 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2905 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2907 $restriction = trim( $temp[1] );
2908 if ( $restriction != '' ) { //some old entries are empty
2909 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2914 $this->mOldRestrictions
= true;
2918 if ( count( $rows ) ) {
2919 # Current system - load second to make them override.
2920 $now = wfTimestampNow();
2921 $purgeExpired = false;
2923 # Cycle through all the restrictions.
2924 foreach ( $rows as $row ) {
2926 // Don't take care of restrictions types that aren't allowed
2927 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2931 // This code should be refactored, now that it's being used more generally,
2932 // But I don't really see any harm in leaving it in Block for now -werdna
2933 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2935 // Only apply the restrictions if they haven't expired!
2936 if ( !$expiry ||
$expiry > $now ) {
2937 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2938 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2940 $this->mCascadeRestriction |
= $row->pr_cascade
;
2942 // Trigger a lazy purge of expired restrictions
2943 $purgeExpired = true;
2947 if ( $purgeExpired ) {
2948 Title
::purgeExpiredRestrictions();
2952 $this->mRestrictionsLoaded
= true;
2956 * Load restrictions from the page_restrictions table
2958 * @param string $oldFashionedRestrictions Comma-separated list of page
2959 * restrictions from page table (pre 1.10)
2961 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2963 if ( !$this->mRestrictionsLoaded
) {
2964 if ( $this->exists() ) {
2965 $dbr = wfGetDB( DB_SLAVE
);
2967 $res = $dbr->select(
2968 'page_restrictions',
2969 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2970 array( 'pr_page' => $this->getArticleID() ),
2974 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2976 $title_protection = $this->getTitleProtection();
2978 if ( $title_protection ) {
2979 $now = wfTimestampNow();
2980 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2982 if ( !$expiry ||
$expiry > $now ) {
2983 // Apply the restrictions
2984 $this->mRestrictionsExpiry
['create'] = $expiry;
2985 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2986 } else { // Get rid of the old restrictions
2987 Title
::purgeExpiredRestrictions();
2988 $this->mTitleProtection
= false;
2991 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2993 $this->mRestrictionsLoaded
= true;
2999 * Flush the protection cache in this object and force reload from the database.
3000 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3002 public function flushRestrictions() {
3003 $this->mRestrictionsLoaded
= false;
3004 $this->mTitleProtection
= null;
3008 * Purge expired restrictions from the page_restrictions table
3010 static function purgeExpiredRestrictions() {
3011 if ( wfReadOnly() ) {
3015 $method = __METHOD__
;
3016 $dbw = wfGetDB( DB_MASTER
);
3017 $dbw->onTransactionIdle( function () use ( $dbw, $method ) {
3019 'page_restrictions',
3020 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3025 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3032 * Does this have subpages? (Warning, usually requires an extra DB query.)
3036 public function hasSubpages() {
3037 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3042 # We dynamically add a member variable for the purpose of this method
3043 # alone to cache the result. There's no point in having it hanging
3044 # around uninitialized in every Title object; therefore we only add it
3045 # if needed and don't declare it statically.
3046 if ( $this->mHasSubpages
=== null ) {
3047 $this->mHasSubpages
= false;
3048 $subpages = $this->getSubpages( 1 );
3049 if ( $subpages instanceof TitleArray
) {
3050 $this->mHasSubpages
= (bool)$subpages->count();
3054 return $this->mHasSubpages
;
3058 * Get all subpages of this page.
3060 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3061 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3062 * doesn't allow subpages
3064 public function getSubpages( $limit = -1 ) {
3065 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3069 $dbr = wfGetDB( DB_SLAVE
);
3070 $conds['page_namespace'] = $this->getNamespace();
3071 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3073 if ( $limit > -1 ) {
3074 $options['LIMIT'] = $limit;
3076 $this->mSubpages
= TitleArray
::newFromResult(
3077 $dbr->select( 'page',
3078 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
3084 return $this->mSubpages
;
3088 * Is there a version of this page in the deletion archive?
3090 * @return int The number of archived revisions
3092 public function isDeleted() {
3093 if ( $this->getNamespace() < 0 ) {
3096 $dbr = wfGetDB( DB_SLAVE
);
3098 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3099 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3102 if ( $this->getNamespace() == NS_FILE
) {
3103 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3104 array( 'fa_name' => $this->getDBkey() ),
3113 * Is there a version of this page in the deletion archive?
3117 public function isDeletedQuick() {
3118 if ( $this->getNamespace() < 0 ) {
3121 $dbr = wfGetDB( DB_SLAVE
);
3122 $deleted = (bool)$dbr->selectField( 'archive', '1',
3123 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3126 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
3127 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3128 array( 'fa_name' => $this->getDBkey() ),
3136 * Get the article ID for this Title from the link cache,
3137 * adding it if necessary
3139 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3141 * @return int The ID
3143 public function getArticleID( $flags = 0 ) {
3144 if ( $this->getNamespace() < 0 ) {
3145 $this->mArticleID
= 0;
3146 return $this->mArticleID
;
3148 $linkCache = LinkCache
::singleton();
3149 if ( $flags & self
::GAID_FOR_UPDATE
) {
3150 $oldUpdate = $linkCache->forUpdate( true );
3151 $linkCache->clearLink( $this );
3152 $this->mArticleID
= $linkCache->addLinkObj( $this );
3153 $linkCache->forUpdate( $oldUpdate );
3155 if ( -1 == $this->mArticleID
) {
3156 $this->mArticleID
= $linkCache->addLinkObj( $this );
3159 return $this->mArticleID
;
3163 * Is this an article that is a redirect page?
3164 * Uses link cache, adding it if necessary
3166 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3169 public function isRedirect( $flags = 0 ) {
3170 if ( !is_null( $this->mRedirect
) ) {
3171 return $this->mRedirect
;
3173 # Calling getArticleID() loads the field from cache as needed
3174 if ( !$this->getArticleID( $flags ) ) {
3175 $this->mRedirect
= false;
3176 return $this->mRedirect
;
3179 $linkCache = LinkCache
::singleton();
3180 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3181 if ( $cached === null ) {
3182 # Trust LinkCache's state over our own
3183 # LinkCache is telling us that the page doesn't exist, despite there being cached
3184 # data relating to an existing page in $this->mArticleID. Updaters should clear
3185 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3186 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3187 # LinkCache to refresh its data from the master.
3188 $this->mRedirect
= false;
3189 return $this->mRedirect
;
3192 $this->mRedirect
= (bool)$cached;
3194 return $this->mRedirect
;
3198 * What is the length of this page?
3199 * Uses link cache, adding it if necessary
3201 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3204 public function getLength( $flags = 0 ) {
3205 if ( $this->mLength
!= -1 ) {
3206 return $this->mLength
;
3208 # Calling getArticleID() loads the field from cache as needed
3209 if ( !$this->getArticleID( $flags ) ) {
3211 return $this->mLength
;
3213 $linkCache = LinkCache
::singleton();
3214 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3215 if ( $cached === null ) {
3216 # Trust LinkCache's state over our own, as for isRedirect()
3218 return $this->mLength
;
3221 $this->mLength
= intval( $cached );
3223 return $this->mLength
;
3227 * What is the page_latest field for this page?
3229 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3230 * @return int Int or 0 if the page doesn't exist
3232 public function getLatestRevID( $flags = 0 ) {
3233 if ( !( $flags & Title
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3234 return intval( $this->mLatestID
);
3236 # Calling getArticleID() loads the field from cache as needed
3237 if ( !$this->getArticleID( $flags ) ) {
3238 $this->mLatestID
= 0;
3239 return $this->mLatestID
;
3241 $linkCache = LinkCache
::singleton();
3242 $linkCache->addLinkObj( $this );
3243 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3244 if ( $cached === null ) {
3245 # Trust LinkCache's state over our own, as for isRedirect()
3246 $this->mLatestID
= 0;
3247 return $this->mLatestID
;
3250 $this->mLatestID
= intval( $cached );
3252 return $this->mLatestID
;
3256 * This clears some fields in this object, and clears any associated
3257 * keys in the "bad links" section of the link cache.
3259 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3260 * loading of the new page_id. It's also called from
3261 * WikiPage::doDeleteArticleReal()
3263 * @param int $newid The new Article ID
3265 public function resetArticleID( $newid ) {
3266 $linkCache = LinkCache
::singleton();
3267 $linkCache->clearLink( $this );
3269 if ( $newid === false ) {
3270 $this->mArticleID
= -1;
3272 $this->mArticleID
= intval( $newid );
3274 $this->mRestrictionsLoaded
= false;
3275 $this->mRestrictions
= array();
3276 $this->mRedirect
= null;
3277 $this->mLength
= -1;
3278 $this->mLatestID
= false;
3279 $this->mContentModel
= false;
3280 $this->mEstimateRevisions
= null;
3281 $this->mPageLanguage
= false;
3282 $this->mDbPageLanguage
= null;
3283 $this->mIsBigDeletion
= null;
3287 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3289 * @param string $text Containing title to capitalize
3290 * @param int $ns Namespace index, defaults to NS_MAIN
3291 * @return string Containing capitalized title
3293 public static function capitalize( $text, $ns = NS_MAIN
) {
3296 if ( MWNamespace
::isCapitalized( $ns ) ) {
3297 return $wgContLang->ucfirst( $text );
3304 * Secure and split - main initialisation function for this object
3306 * Assumes that mDbkeyform has been set, and is urldecoded
3307 * and uses underscores, but not otherwise munged. This function
3308 * removes illegal characters, splits off the interwiki and
3309 * namespace prefixes, sets the other forms, and canonicalizes
3312 * @return bool True on success
3314 private function secureAndSplit() {
3316 $this->mInterwiki
= '';
3317 $this->mFragment
= '';
3318 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
3320 $dbkey = $this->mDbkeyform
;
3323 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3324 // the parsing code with Title, while avoiding massive refactoring.
3325 // @todo: get rid of secureAndSplit, refactor parsing code.
3326 $titleParser = self
::getTitleParser();
3327 $parts = $titleParser->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3328 } catch ( MalformedTitleException
$ex ) {
3333 $this->setFragment( '#' . $parts['fragment'] );
3334 $this->mInterwiki
= $parts['interwiki'];
3335 $this->mLocalInterwiki
= $parts['local_interwiki'];
3336 $this->mNamespace
= $parts['namespace'];
3337 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3339 $this->mDbkeyform
= $parts['dbkey'];
3340 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3341 $this->mTextform
= str_replace( '_', ' ', $this->mDbkeyform
);
3343 # We already know that some pages won't be in the database!
3344 if ( $this->isExternal() ||
$this->mNamespace
== NS_SPECIAL
) {
3345 $this->mArticleID
= 0;
3352 * Get an array of Title objects linking to this Title
3353 * Also stores the IDs in the link cache.
3355 * WARNING: do not use this function on arbitrary user-supplied titles!
3356 * On heavily-used templates it will max out the memory.
3358 * @param array $options May be FOR UPDATE
3359 * @param string $table Table name
3360 * @param string $prefix Fields prefix
3361 * @return Title[] Array of Title objects linking here
3363 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3364 if ( count( $options ) > 0 ) {
3365 $db = wfGetDB( DB_MASTER
);
3367 $db = wfGetDB( DB_SLAVE
);
3371 array( 'page', $table ),
3372 self
::getSelectFields(),
3374 "{$prefix}_from=page_id",
3375 "{$prefix}_namespace" => $this->getNamespace(),
3376 "{$prefix}_title" => $this->getDBkey() ),
3382 if ( $res->numRows() ) {
3383 $linkCache = LinkCache
::singleton();
3384 foreach ( $res as $row ) {
3385 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3387 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3388 $retVal[] = $titleObj;
3396 * Get an array of Title objects using this Title as a template
3397 * Also stores the IDs in the link cache.
3399 * WARNING: do not use this function on arbitrary user-supplied titles!
3400 * On heavily-used templates it will max out the memory.
3402 * @param array $options May be FOR UPDATE
3403 * @return Title[] Array of Title the Title objects linking here
3405 public function getTemplateLinksTo( $options = array() ) {
3406 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3410 * Get an array of Title objects linked from this Title
3411 * Also stores the IDs in the link cache.
3413 * WARNING: do not use this function on arbitrary user-supplied titles!
3414 * On heavily-used templates it will max out the memory.
3416 * @param array $options May be FOR UPDATE
3417 * @param string $table Table name
3418 * @param string $prefix Fields prefix
3419 * @return array Array of Title objects linking here
3421 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3422 global $wgContentHandlerUseDB;
3424 $id = $this->getArticleID();
3426 # If the page doesn't exist; there can't be any link from this page
3431 if ( count( $options ) > 0 ) {
3432 $db = wfGetDB( DB_MASTER
);
3434 $db = wfGetDB( DB_SLAVE
);
3437 $namespaceFiled = "{$prefix}_namespace";
3438 $titleField = "{$prefix}_title";
3449 if ( $wgContentHandlerUseDB ) {
3450 $fields[] = 'page_content_model';
3454 array( $table, 'page' ),
3456 array( "{$prefix}_from" => $id ),
3459 array( 'page' => array(
3461 array( "page_namespace=$namespaceFiled", "page_title=$titleField" )
3466 if ( $res->numRows() ) {
3467 $linkCache = LinkCache
::singleton();
3468 foreach ( $res as $row ) {
3469 $titleObj = Title
::makeTitle( $row->$namespaceFiled, $row->$titleField );
3471 if ( $row->page_id
) {
3472 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3474 $linkCache->addBadLinkObj( $titleObj );
3476 $retVal[] = $titleObj;
3484 * Get an array of Title objects used on this Title as a template
3485 * Also stores the IDs in the link cache.
3487 * WARNING: do not use this function on arbitrary user-supplied titles!
3488 * On heavily-used templates it will max out the memory.
3490 * @param array $options May be FOR UPDATE
3491 * @return Title[] Array of Title the Title objects used here
3493 public function getTemplateLinksFrom( $options = array() ) {
3494 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3498 * Get an array of Title objects referring to non-existent articles linked
3501 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3502 * should use redirect table in this case).
3503 * @return Title[] Array of Title the Title objects
3505 public function getBrokenLinksFrom() {
3506 if ( $this->getArticleID() == 0 ) {
3507 # All links from article ID 0 are false positives
3511 $dbr = wfGetDB( DB_SLAVE
);
3512 $res = $dbr->select(
3513 array( 'page', 'pagelinks' ),
3514 array( 'pl_namespace', 'pl_title' ),
3516 'pl_from' => $this->getArticleID(),
3517 'page_namespace IS NULL'
3519 __METHOD__
, array(),
3523 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3529 foreach ( $res as $row ) {
3530 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3536 * Get a list of URLs to purge from the Squid cache when this
3539 * @return string[] Array of String the URLs
3541 public function getSquidURLs() {
3543 $this->getInternalURL(),
3544 $this->getInternalURL( 'action=history' )
3547 $pageLang = $this->getPageLanguage();
3548 if ( $pageLang->hasVariants() ) {
3549 $variants = $pageLang->getVariants();
3550 foreach ( $variants as $vCode ) {
3551 $urls[] = $this->getInternalURL( '', $vCode );
3555 // If we are looking at a css/js user subpage, purge the action=raw.
3556 if ( $this->isJsSubpage() ) {
3557 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/javascript' );
3558 } elseif ( $this->isCssSubpage() ) {
3559 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/css' );
3562 wfRunHooks( 'TitleSquidURLs', array( $this, &$urls ) );
3567 * Purge all applicable Squid URLs
3569 public function purgeSquid() {
3571 if ( $wgUseSquid ) {
3572 $urls = $this->getSquidURLs();
3573 $u = new SquidUpdate( $urls );
3579 * Move this page without authentication
3581 * @param Title $nt The new page Title
3582 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3584 public function moveNoAuth( &$nt ) {
3585 return $this->moveTo( $nt, false );
3589 * Check whether a given move operation would be valid.
3590 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3592 * @todo finish moving this into MovePage
3593 * @param Title $nt The new title
3594 * @param bool $auth Indicates whether $wgUser's permissions
3596 * @param string $reason Is the log summary of the move, used for spam checking
3597 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3599 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3602 if ( !( $nt instanceof Title
) ) {
3603 // Normally we'd add this to $errors, but we'll get
3604 // lots of syntax errors if $nt is not an object
3605 return array( array( 'badtitletext' ) );
3608 $mp = new MovePage( $this, $nt );
3609 $errors = $mp->isValidMove()->getErrorsArray();
3611 $newid = $nt->getArticleID();
3614 $errors = wfMergeErrorArrays( $errors,
3615 $this->getUserPermissionsErrors( 'move', $wgUser ),
3616 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3617 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3618 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3621 $match = EditPage
::matchSummarySpamRegex( $reason );
3622 if ( $match !== false ) {
3623 // This is kind of lame, won't display nice
3624 $errors[] = array( 'spamprotectiontext' );
3628 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3629 $errors[] = array( 'hookaborted', $err );
3632 # The move is allowed only if (1) the target doesn't exist, or
3633 # (2) the target is a redirect to the source, and has no history
3634 # (so we can undo bad moves right after they're done).
3636 if ( 0 != $newid ) { # Target exists; check for validity
3637 if ( !$this->isValidMoveTarget( $nt ) ) {
3638 $errors[] = array( 'articleexists' );
3641 $tp = $nt->getTitleProtection();
3642 $right = $tp['pt_create_perm'];
3643 if ( $right == 'sysop' ) {
3644 $right = 'editprotected'; // B/C
3646 if ( $right == 'autoconfirmed' ) {
3647 $right = 'editsemiprotected'; // B/C
3649 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3650 $errors[] = array( 'cantmove-titleprotected' );
3653 if ( empty( $errors ) ) {
3660 * Check if the requested move target is a valid file move target
3661 * @todo move this to MovePage
3662 * @param Title $nt Target title
3663 * @return array List of errors
3665 protected function validateFileMoveOperation( $nt ) {
3670 $destFile = wfLocalFile( $nt );
3671 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3672 $errors[] = array( 'file-exists-sharedrepo' );
3679 * Move a title to a new location
3681 * @todo Deprecate this in favor of MovePage
3682 * @param Title $nt The new title
3683 * @param bool $auth Indicates whether $wgUser's permissions
3685 * @param string $reason The reason for the move
3686 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3687 * Ignored if the user doesn't have the suppressredirect right.
3688 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3690 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3692 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3693 if ( is_array( $err ) ) {
3694 // Auto-block user's IP if the account was "hard" blocked
3695 $wgUser->spreadAnyEditBlock();
3698 // Check suppressredirect permission
3699 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3700 $createRedirect = true;
3703 wfRunHooks( 'TitleMove', array( $this, $nt, $wgUser ) );
3705 $mp = new MovePage( $this, $nt );
3706 $status = $mp->move( $wgUser, $reason, $createRedirect );
3707 if ( $status->isOK() ) {
3710 return $status->getErrorsArray();
3715 * Move this page's subpages to be subpages of $nt
3717 * @param Title $nt Move target
3718 * @param bool $auth Whether $wgUser's permissions should be checked
3719 * @param string $reason The reason for the move
3720 * @param bool $createRedirect Whether to create redirects from the old subpages to
3721 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3722 * @return array Array with old page titles as keys, and strings (new page titles) or
3723 * arrays (errors) as values, or an error array with numeric indices if no pages
3726 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3727 global $wgMaximumMovedPages;
3728 // Check permissions
3729 if ( !$this->userCan( 'move-subpages' ) ) {
3730 return array( 'cant-move-subpages' );
3732 // Do the source and target namespaces support subpages?
3733 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3734 return array( 'namespace-nosubpages',
3735 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3737 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3738 return array( 'namespace-nosubpages',
3739 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3742 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3745 foreach ( $subpages as $oldSubpage ) {
3747 if ( $count > $wgMaximumMovedPages ) {
3748 $retval[$oldSubpage->getPrefixedText()] =
3749 array( 'movepage-max-pages',
3750 $wgMaximumMovedPages );
3754 // We don't know whether this function was called before
3755 // or after moving the root page, so check both
3757 if ( $oldSubpage->getArticleID() == $this->getArticleID()
3758 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
3760 // When moving a page to a subpage of itself,
3761 // don't move it twice
3764 $newPageName = preg_replace(
3765 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3766 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3767 $oldSubpage->getDBkey() );
3768 if ( $oldSubpage->isTalkPage() ) {
3769 $newNs = $nt->getTalkPage()->getNamespace();
3771 $newNs = $nt->getSubjectPage()->getNamespace();
3773 # Bug 14385: we need makeTitleSafe because the new page names may
3774 # be longer than 255 characters.
3775 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3777 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3778 if ( $success === true ) {
3779 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3781 $retval[$oldSubpage->getPrefixedText()] = $success;
3788 * Checks if this page is just a one-rev redirect.
3789 * Adds lock, so don't use just for light purposes.
3793 public function isSingleRevRedirect() {
3794 global $wgContentHandlerUseDB;
3796 $dbw = wfGetDB( DB_MASTER
);
3799 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3800 if ( $wgContentHandlerUseDB ) {
3801 $fields[] = 'page_content_model';
3804 $row = $dbw->selectRow( 'page',
3808 array( 'FOR UPDATE' )
3810 # Cache some fields we may want
3811 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3812 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3813 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3814 $this->mContentModel
= $row && isset( $row->page_content_model
)
3815 ?
strval( $row->page_content_model
)
3818 if ( !$this->mRedirect
) {
3821 # Does the article have a history?
3822 $row = $dbw->selectField( array( 'page', 'revision' ),
3824 array( 'page_namespace' => $this->getNamespace(),
3825 'page_title' => $this->getDBkey(),
3827 'page_latest != rev_id'
3830 array( 'FOR UPDATE' )
3832 # Return true if there was no history
3833 return ( $row === false );
3837 * Checks if $this can be moved to a given Title
3838 * - Selects for update, so don't call it unless you mean business
3840 * @todo move to MovePage
3841 * @param Title $nt The new title to check
3844 public function isValidMoveTarget( $nt ) {
3845 # Is it an existing file?
3846 if ( $nt->getNamespace() == NS_FILE
) {
3847 $file = wfLocalFile( $nt );
3848 if ( $file->exists() ) {
3849 wfDebug( __METHOD__
. ": file exists\n" );
3853 # Is it a redirect with no history?
3854 if ( !$nt->isSingleRevRedirect() ) {
3855 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3858 # Get the article text
3859 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3860 if ( !is_object( $rev ) ) {
3863 $content = $rev->getContent();
3864 # Does the redirect point to the source?
3865 # Or is it a broken self-redirect, usually caused by namespace collisions?
3866 $redirTitle = $content ?
$content->getRedirectTarget() : null;
3868 if ( $redirTitle ) {
3869 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3870 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3871 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3877 # Fail safe (not a redirect after all. strange.)
3878 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3879 " is a redirect, but it doesn't contain a valid redirect.\n" );
3885 * Get categories to which this Title belongs and return an array of
3886 * categories' names.
3888 * @return array Array of parents in the form:
3889 * $parent => $currentarticle
3891 public function getParentCategories() {
3896 $titleKey = $this->getArticleID();
3898 if ( $titleKey === 0 ) {
3902 $dbr = wfGetDB( DB_SLAVE
);
3904 $res = $dbr->select(
3907 array( 'cl_from' => $titleKey ),
3911 if ( $res->numRows() > 0 ) {
3912 foreach ( $res as $row ) {
3913 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3914 $data[$wgContLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3921 * Get a tree of parent categories
3923 * @param array $children Array with the children in the keys, to check for circular refs
3924 * @return array Tree of parent categories
3926 public function getParentCategoryTree( $children = array() ) {
3928 $parents = $this->getParentCategories();
3931 foreach ( $parents as $parent => $current ) {
3932 if ( array_key_exists( $parent, $children ) ) {
3933 # Circular reference
3934 $stack[$parent] = array();
3936 $nt = Title
::newFromText( $parent );
3938 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3948 * Get an associative array for selecting this title from
3951 * @return array Array suitable for the $where parameter of DB::select()
3953 public function pageCond() {
3954 if ( $this->mArticleID
> 0 ) {
3955 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3956 return array( 'page_id' => $this->mArticleID
);
3958 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3963 * Get the revision ID of the previous revision
3965 * @param int $revId Revision ID. Get the revision that was before this one.
3966 * @param int $flags Title::GAID_FOR_UPDATE
3967 * @return int|bool Old revision ID, or false if none exists
3969 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3970 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3971 $revId = $db->selectField( 'revision', 'rev_id',
3973 'rev_page' => $this->getArticleID( $flags ),
3974 'rev_id < ' . intval( $revId )
3977 array( 'ORDER BY' => 'rev_id DESC' )
3980 if ( $revId === false ) {
3983 return intval( $revId );
3988 * Get the revision ID of the next revision
3990 * @param int $revId Revision ID. Get the revision that was after this one.
3991 * @param int $flags Title::GAID_FOR_UPDATE
3992 * @return int|bool Next revision ID, or false if none exists
3994 public function getNextRevisionID( $revId, $flags = 0 ) {
3995 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3996 $revId = $db->selectField( 'revision', 'rev_id',
3998 'rev_page' => $this->getArticleID( $flags ),
3999 'rev_id > ' . intval( $revId )
4002 array( 'ORDER BY' => 'rev_id' )
4005 if ( $revId === false ) {
4008 return intval( $revId );
4013 * Get the first revision of the page
4015 * @param int $flags Title::GAID_FOR_UPDATE
4016 * @return Revision|null If page doesn't exist
4018 public function getFirstRevision( $flags = 0 ) {
4019 $pageId = $this->getArticleID( $flags );
4021 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4022 $row = $db->selectRow( 'revision', Revision
::selectFields(),
4023 array( 'rev_page' => $pageId ),
4025 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4028 return new Revision( $row );
4035 * Get the oldest revision timestamp of this page
4037 * @param int $flags Title::GAID_FOR_UPDATE
4038 * @return string MW timestamp
4040 public function getEarliestRevTime( $flags = 0 ) {
4041 $rev = $this->getFirstRevision( $flags );
4042 return $rev ?
$rev->getTimestamp() : null;
4046 * Check if this is a new page
4050 public function isNewPage() {
4051 $dbr = wfGetDB( DB_SLAVE
);
4052 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4056 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4060 public function isBigDeletion() {
4061 global $wgDeleteRevisionsLimit;
4063 if ( !$wgDeleteRevisionsLimit ) {
4067 if ( $this->mIsBigDeletion
=== null ) {
4068 $dbr = wfGetDB( DB_SLAVE
);
4070 $innerQuery = $dbr->selectSQLText(
4073 array( 'rev_page' => $this->getArticleID() ),
4075 array( 'LIMIT' => $wgDeleteRevisionsLimit +
1 )
4078 $revCount = $dbr->query(
4079 'SELECT COUNT(*) FROM (' . $innerQuery . ') AS innerQuery',
4082 $revCount = $revCount->fetchRow();
4083 $revCount = $revCount['COUNT(*)'];
4085 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4088 return $this->mIsBigDeletion
;
4092 * Get the approximate revision count of this page.
4096 public function estimateRevisionCount() {
4097 if ( !$this->exists() ) {
4101 if ( $this->mEstimateRevisions
=== null ) {
4102 $dbr = wfGetDB( DB_SLAVE
);
4103 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4104 array( 'rev_page' => $this->getArticleID() ), __METHOD__
);
4107 return $this->mEstimateRevisions
;
4111 * Get the number of revisions between the given revision.
4112 * Used for diffs and other things that really need it.
4114 * @param int|Revision $old Old revision or rev ID (first before range)
4115 * @param int|Revision $new New revision or rev ID (first after range)
4116 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4117 * @return int Number of revisions between these revisions.
4119 public function countRevisionsBetween( $old, $new, $max = null ) {
4120 if ( !( $old instanceof Revision
) ) {
4121 $old = Revision
::newFromTitle( $this, (int)$old );
4123 if ( !( $new instanceof Revision
) ) {
4124 $new = Revision
::newFromTitle( $this, (int)$new );
4126 if ( !$old ||
!$new ) {
4127 return 0; // nothing to compare
4129 $dbr = wfGetDB( DB_SLAVE
);
4131 'rev_page' => $this->getArticleID(),
4132 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4133 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4135 if ( $max !== null ) {
4136 $res = $dbr->select( 'revision', '1',
4139 array( 'LIMIT' => $max +
1 ) // extra to detect truncation
4141 return $res->numRows();
4143 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4148 * Get the authors between the given revisions or revision IDs.
4149 * Used for diffs and other things that really need it.
4153 * @param int|Revision $old Old revision or rev ID (first before range by default)
4154 * @param int|Revision $new New revision or rev ID (first after range by default)
4155 * @param int $limit Maximum number of authors
4156 * @param string|array $options (Optional): Single option, or an array of options:
4157 * 'include_old' Include $old in the range; $new is excluded.
4158 * 'include_new' Include $new in the range; $old is excluded.
4159 * 'include_both' Include both $old and $new in the range.
4160 * Unknown option values are ignored.
4161 * @return array|null Names of revision authors in the range; null if not both revisions exist
4163 public function getAuthorsBetween( $old, $new, $limit, $options = array() ) {
4164 if ( !( $old instanceof Revision
) ) {
4165 $old = Revision
::newFromTitle( $this, (int)$old );
4167 if ( !( $new instanceof Revision
) ) {
4168 $new = Revision
::newFromTitle( $this, (int)$new );
4170 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4171 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4172 // in the sanity check below?
4173 if ( !$old ||
!$new ) {
4174 return null; // nothing to compare
4179 $options = (array)$options;
4180 if ( in_array( 'include_old', $options ) ) {
4183 if ( in_array( 'include_new', $options ) ) {
4186 if ( in_array( 'include_both', $options ) ) {
4190 // No DB query needed if $old and $new are the same or successive revisions:
4191 if ( $old->getId() === $new->getId() ) {
4192 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
array() : array( $old->getRawUserText() );
4193 } elseif ( $old->getId() === $new->getParentId() ) {
4194 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4195 $authors[] = $old->getRawUserText();
4196 if ( $old->getRawUserText() != $new->getRawUserText() ) {
4197 $authors[] = $new->getRawUserText();
4199 } elseif ( $old_cmp === '>=' ) {
4200 $authors[] = $old->getRawUserText();
4201 } elseif ( $new_cmp === '<=' ) {
4202 $authors[] = $new->getRawUserText();
4206 $dbr = wfGetDB( DB_SLAVE
);
4207 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4209 'rev_page' => $this->getArticleID(),
4210 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4211 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4213 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4215 foreach ( $res as $row ) {
4216 $authors[] = $row->rev_user_text
;
4222 * Get the number of authors between the given revisions or revision IDs.
4223 * Used for diffs and other things that really need it.
4225 * @param int|Revision $old Old revision or rev ID (first before range by default)
4226 * @param int|Revision $new New revision or rev ID (first after range by default)
4227 * @param int $limit Maximum number of authors
4228 * @param string|array $options (Optional): Single option, or an array of options:
4229 * 'include_old' Include $old in the range; $new is excluded.
4230 * 'include_new' Include $new in the range; $old is excluded.
4231 * 'include_both' Include both $old and $new in the range.
4232 * Unknown option values are ignored.
4233 * @return int Number of revision authors in the range; zero if not both revisions exist
4235 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4236 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4237 return $authors ?
count( $authors ) : 0;
4241 * Compare with another title.
4243 * @param Title $title
4246 public function equals( Title
$title ) {
4247 // Note: === is necessary for proper matching of number-like titles.
4248 return $this->getInterwiki() === $title->getInterwiki()
4249 && $this->getNamespace() == $title->getNamespace()
4250 && $this->getDBkey() === $title->getDBkey();
4254 * Check if this title is a subpage of another title
4256 * @param Title $title
4259 public function isSubpageOf( Title
$title ) {
4260 return $this->getInterwiki() === $title->getInterwiki()
4261 && $this->getNamespace() == $title->getNamespace()
4262 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4266 * Check if page exists. For historical reasons, this function simply
4267 * checks for the existence of the title in the page table, and will
4268 * thus return false for interwiki links, special pages and the like.
4269 * If you want to know if a title can be meaningfully viewed, you should
4270 * probably call the isKnown() method instead.
4274 public function exists() {
4275 $exists = $this->getArticleID() != 0;
4276 wfRunHooks( 'TitleExists', array( $this, &$exists ) );
4281 * Should links to this title be shown as potentially viewable (i.e. as
4282 * "bluelinks"), even if there's no record by this title in the page
4285 * This function is semi-deprecated for public use, as well as somewhat
4286 * misleadingly named. You probably just want to call isKnown(), which
4287 * calls this function internally.
4289 * (ISSUE: Most of these checks are cheap, but the file existence check
4290 * can potentially be quite expensive. Including it here fixes a lot of
4291 * existing code, but we might want to add an optional parameter to skip
4292 * it and any other expensive checks.)
4296 public function isAlwaysKnown() {
4300 * Allows overriding default behavior for determining if a page exists.
4301 * If $isKnown is kept as null, regular checks happen. If it's
4302 * a boolean, this value is returned by the isKnown method.
4306 * @param Title $title
4307 * @param bool|null $isKnown
4309 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4311 if ( !is_null( $isKnown ) ) {
4315 if ( $this->isExternal() ) {
4316 return true; // any interwiki link might be viewable, for all we know
4319 switch ( $this->mNamespace
) {
4322 // file exists, possibly in a foreign repo
4323 return (bool)wfFindFile( $this );
4325 // valid special page
4326 return SpecialPageFactory
::exists( $this->getDBkey() );
4328 // selflink, possibly with fragment
4329 return $this->mDbkeyform
== '';
4331 // known system message
4332 return $this->hasSourceText() !== false;
4339 * Does this title refer to a page that can (or might) be meaningfully
4340 * viewed? In particular, this function may be used to determine if
4341 * links to the title should be rendered as "bluelinks" (as opposed to
4342 * "redlinks" to non-existent pages).
4343 * Adding something else to this function will cause inconsistency
4344 * since LinkHolderArray calls isAlwaysKnown() and does its own
4345 * page existence check.
4349 public function isKnown() {
4350 return $this->isAlwaysKnown() ||
$this->exists();
4354 * Does this page have source text?
4358 public function hasSourceText() {
4359 if ( $this->exists() ) {
4363 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4364 // If the page doesn't exist but is a known system message, default
4365 // message content will be displayed, same for language subpages-
4366 // Use always content language to avoid loading hundreds of languages
4367 // to get the link color.
4369 list( $name, ) = MessageCache
::singleton()->figureMessage(
4370 $wgContLang->lcfirst( $this->getText() )
4372 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4373 return $message->exists();
4380 * Get the default message text or false if the message doesn't exist
4382 * @return string|bool
4384 public function getDefaultMessageText() {
4387 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4391 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4392 $wgContLang->lcfirst( $this->getText() )
4394 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4396 if ( $message->exists() ) {
4397 return $message->plain();
4404 * Updates page_touched for this page; called from LinksUpdate.php
4406 * @return bool True if the update succeeded
4408 public function invalidateCache() {
4409 if ( wfReadOnly() ) {
4413 if ( $this->mArticleID
=== 0 ) {
4414 return true; // avoid gap locking if we know it's not there
4417 $method = __METHOD__
;
4418 $dbw = wfGetDB( DB_MASTER
);
4419 $conds = $this->pageCond();
4420 $dbw->onTransactionIdle( function () use ( $dbw, $conds, $method ) {
4423 array( 'page_touched' => $dbw->timestamp() ),
4433 * Update page_touched timestamps and send squid purge messages for
4434 * pages linking to this title. May be sent to the job queue depending
4435 * on the number of links. Typically called on create and delete.
4437 public function touchLinks() {
4438 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4441 if ( $this->getNamespace() == NS_CATEGORY
) {
4442 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4448 * Get the last touched timestamp
4450 * @param DatabaseBase $db Optional db
4451 * @return string Last-touched timestamp
4453 public function getTouched( $db = null ) {
4454 if ( $db === null ) {
4455 $db = wfGetDB( DB_SLAVE
);
4457 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4462 * Get the timestamp when this page was updated since the user last saw it.
4465 * @return string|null
4467 public function getNotificationTimestamp( $user = null ) {
4468 global $wgUser, $wgShowUpdatedMarker;
4469 // Assume current user if none given
4473 // Check cache first
4474 $uid = $user->getId();
4475 // avoid isset here, as it'll return false for null entries
4476 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4477 return $this->mNotificationTimestamp
[$uid];
4479 if ( !$uid ||
!$wgShowUpdatedMarker ||
!$user->isAllowed( 'viewmywatchlist' ) ) {
4480 $this->mNotificationTimestamp
[$uid] = false;
4481 return $this->mNotificationTimestamp
[$uid];
4483 // Don't cache too much!
4484 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4485 $this->mNotificationTimestamp
= array();
4487 $dbr = wfGetDB( DB_SLAVE
);
4488 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4489 'wl_notificationtimestamp',
4491 'wl_user' => $user->getId(),
4492 'wl_namespace' => $this->getNamespace(),
4493 'wl_title' => $this->getDBkey(),
4497 return $this->mNotificationTimestamp
[$uid];
4501 * Generate strings used for xml 'id' names in monobook tabs
4503 * @param string $prepend Defaults to 'nstab-'
4504 * @return string XML 'id' name
4506 public function getNamespaceKey( $prepend = 'nstab-' ) {
4508 // Gets the subject namespace if this title
4509 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4510 // Checks if canonical namespace name exists for namespace
4511 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4512 // Uses canonical namespace name
4513 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4515 // Uses text of namespace
4516 $namespaceKey = $this->getSubjectNsText();
4518 // Makes namespace key lowercase
4519 $namespaceKey = $wgContLang->lc( $namespaceKey );
4521 if ( $namespaceKey == '' ) {
4522 $namespaceKey = 'main';
4524 // Changes file to image for backwards compatibility
4525 if ( $namespaceKey == 'file' ) {
4526 $namespaceKey = 'image';
4528 return $prepend . $namespaceKey;
4532 * Get all extant redirects to this Title
4534 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4535 * @return Title[] Array of Title redirects to this title
4537 public function getRedirectsHere( $ns = null ) {
4540 $dbr = wfGetDB( DB_SLAVE
);
4542 'rd_namespace' => $this->getNamespace(),
4543 'rd_title' => $this->getDBkey(),
4546 if ( $this->isExternal() ) {
4547 $where['rd_interwiki'] = $this->getInterwiki();
4549 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4551 if ( !is_null( $ns ) ) {
4552 $where['page_namespace'] = $ns;
4555 $res = $dbr->select(
4556 array( 'redirect', 'page' ),
4557 array( 'page_namespace', 'page_title' ),
4562 foreach ( $res as $row ) {
4563 $redirs[] = self
::newFromRow( $row );
4569 * Check if this Title is a valid redirect target
4573 public function isValidRedirectTarget() {
4574 global $wgInvalidRedirectTargets;
4576 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4577 if ( $this->isSpecial( 'Userlogout' ) ) {
4581 foreach ( $wgInvalidRedirectTargets as $target ) {
4582 if ( $this->isSpecial( $target ) ) {
4591 * Get a backlink cache object
4593 * @return BacklinkCache
4595 public function getBacklinkCache() {
4596 return BacklinkCache
::get( $this );
4600 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4604 public function canUseNoindex() {
4605 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4607 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4608 ?
$wgContentNamespaces
4609 : $wgExemptFromUserRobotsControl;
4611 return !in_array( $this->mNamespace
, $bannedNamespaces );
4616 * Returns the raw sort key to be used for categories, with the specified
4617 * prefix. This will be fed to Collation::getSortKey() to get a
4618 * binary sortkey that can be used for actual sorting.
4620 * @param string $prefix The prefix to be used, specified using
4621 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4625 public function getCategorySortkey( $prefix = '' ) {
4626 $unprefixed = $this->getText();
4628 // Anything that uses this hook should only depend
4629 // on the Title object passed in, and should probably
4630 // tell the users to run updateCollations.php --force
4631 // in order to re-sort existing category relations.
4632 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4633 if ( $prefix !== '' ) {
4634 # Separate with a line feed, so the unprefixed part is only used as
4635 # a tiebreaker when two pages have the exact same prefix.
4636 # In UCA, tab is the only character that can sort above LF
4637 # so we strip both of them from the original prefix.
4638 $prefix = strtr( $prefix, "\n\t", ' ' );
4639 return "$prefix\n$unprefixed";
4645 * Get the language in which the content of this page is written in
4646 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4647 * e.g. $wgLang (such as special pages, which are in the user language).
4652 public function getPageLanguage() {
4653 global $wgLang, $wgLanguageCode;
4654 wfProfileIn( __METHOD__
);
4655 if ( $this->isSpecialPage() ) {
4656 // special pages are in the user language
4657 wfProfileOut( __METHOD__
);
4661 // Checking if DB language is set
4662 if ( $this->mDbPageLanguage
) {
4663 wfProfileOut( __METHOD__
);
4664 return wfGetLangObj( $this->mDbPageLanguage
);
4667 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4668 // Note that this may depend on user settings, so the cache should
4669 // be only per-request.
4670 // NOTE: ContentHandler::getPageLanguage() may need to load the
4671 // content to determine the page language!
4672 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4674 $contentHandler = ContentHandler
::getForTitle( $this );
4675 $langObj = wfGetLangObj( $contentHandler->getPageLanguage( $this ) );
4676 $this->mPageLanguage
= array( $langObj->getCode(), $wgLanguageCode );
4678 $langObj = wfGetLangObj( $this->mPageLanguage
[0] );
4681 wfProfileOut( __METHOD__
);
4686 * Get the language in which the content of this page is written when
4687 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4688 * e.g. $wgLang (such as special pages, which are in the user language).
4693 public function getPageViewLanguage() {
4696 if ( $this->isSpecialPage() ) {
4697 // If the user chooses a variant, the content is actually
4698 // in a language whose code is the variant code.
4699 $variant = $wgLang->getPreferredVariant();
4700 if ( $wgLang->getCode() !== $variant ) {
4701 return Language
::factory( $variant );
4707 // @note Can't be cached persistently, depends on user settings.
4708 // @note ContentHandler::getPageViewLanguage() may need to load the
4709 // content to determine the page language!
4710 $contentHandler = ContentHandler
::getForTitle( $this );
4711 $pageLang = $contentHandler->getPageViewLanguage( $this );
4716 * Get a list of rendered edit notices for this page.
4718 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4719 * they will already be wrapped in paragraphs.
4722 * @param int $oldid Revision ID that's being edited
4725 public function getEditNotices( $oldid = 0 ) {
4728 # Optional notices on a per-namespace and per-page basis
4729 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4730 $editnotice_ns_message = wfMessage( $editnotice_ns );
4731 if ( $editnotice_ns_message->exists() ) {
4732 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4734 if ( MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
4735 $parts = explode( '/', $this->getDBkey() );
4736 $editnotice_base = $editnotice_ns;
4737 while ( count( $parts ) > 0 ) {
4738 $editnotice_base .= '-' . array_shift( $parts );
4739 $editnotice_base_msg = wfMessage( $editnotice_base );
4740 if ( $editnotice_base_msg->exists() ) {
4741 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
4745 # Even if there are no subpages in namespace, we still don't want / in MW ns.
4746 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
4747 $editnoticeMsg = wfMessage( $editnoticeText );
4748 if ( $editnoticeMsg->exists() ) {
4749 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
4753 wfRunHooks( 'TitleGetEditNotices', array( $this, $oldid, &$notices ) );