5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Represents a title within MediaWiki.
25 * Optionally may contain an interwiki designation or namespace.
26 * @note This class can fetch various kinds of data from the database;
27 * however, it does so inefficiently.
29 * @internal documentation reviewed 15 Mar 2010
32 /** @name Static cache variables */
34 static private $titleCache = array();
38 * Title::newFromText maintains a cache to avoid expensive re-normalization of
39 * commonly used titles. On a batch operation this can become a memory leak
40 * if not bounded. After hitting this many titles reset the cache.
42 const CACHE_MAX
= 1000;
45 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
46 * to use the master DB
48 const GAID_FOR_UPDATE
= 1;
52 * @name Private member variables
53 * Please use the accessor functions instead.
58 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
59 var $mUrlform = ''; // /< URL-encoded form of the main part
60 var $mDbkeyform = ''; // /< Main part with underscores
61 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
62 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
63 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
64 var $mFragment; // /< Title fragment (i.e. the bit after the #)
65 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
66 var $mLatestID = false; // /< ID of most recent revision
67 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
68 var $mOldRestrictions = false;
69 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
70 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
71 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
72 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
73 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
74 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
75 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
76 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
77 # Don't change the following default, NS_MAIN is hardcoded in several
78 # places. See bug 696.
79 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
80 # Zero except in {{transclusion}} tags
81 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
82 var $mLength = -1; // /< The page length, 0 for special pages
83 var $mRedirect = null; // /< Is the article at this title a redirect?
84 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
85 var $mBacklinkCache = null; // /< Cache of links to this title
92 /*protected*/ function __construct() { }
95 * Create a new Title from a prefixed DB key
97 * @param $key String the database key, which has underscores
98 * instead of spaces, possibly including namespace and
100 * @return Title, or NULL on an error
102 public static function newFromDBkey( $key ) {
104 $t->mDbkeyform
= $key;
105 if ( $t->secureAndSplit() ) {
113 * Create a new Title from text, such as what one would find in a link. De-
114 * codes any HTML entities in the text.
116 * @param $text String the link text; spaces, prefixes, and an
117 * initial ':' indicating the main namespace are accepted.
118 * @param $defaultNamespace Int the namespace to use if none is speci-
119 * fied by a prefix. If you want to force a specific namespace even if
120 * $text might begin with a namespace prefix, use makeTitle() or
122 * @return Title, or null on an error.
124 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
125 if ( is_object( $text ) ) {
126 throw new MWException( 'Title::newFromText given an object' );
130 * Wiki pages often contain multiple links to the same page.
131 * Title normalization and parsing can become expensive on
132 * pages with many links, so we can save a little time by
135 * In theory these are value objects and won't get changed...
137 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
138 return Title
::$titleCache[$text];
141 # Convert things like é ā or 〗 into normalized (bug 14952) text
142 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
145 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
146 $t->mDefaultNamespace
= $defaultNamespace;
148 static $cachedcount = 0 ;
149 if ( $t->secureAndSplit() ) {
150 if ( $defaultNamespace == NS_MAIN
) {
151 if ( $cachedcount >= self
::CACHE_MAX
) {
152 # Avoid memory leaks on mass operations...
153 Title
::$titleCache = array();
157 Title
::$titleCache[$text] =& $t;
167 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
169 * Example of wrong and broken code:
170 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
172 * Example of right code:
173 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
175 * Create a new Title from URL-encoded text. Ensures that
176 * the given title's length does not exceed the maximum.
178 * @param $url String the title, as might be taken from a URL
179 * @return Title the new object, or NULL on an error
181 public static function newFromURL( $url ) {
182 global $wgLegalTitleChars;
185 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
186 # but some URLs used it as a space replacement and they still come
187 # from some external search tools.
188 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
189 $url = str_replace( '+', ' ', $url );
192 $t->mDbkeyform
= str_replace( ' ', '_', $url );
193 if ( $t->secureAndSplit() ) {
201 * Create a new Title from an article ID
203 * @param $id Int the page_id corresponding to the Title to create
204 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
205 * @return Title the new object, or NULL on an error
207 public static function newFromID( $id, $flags = 0 ) {
208 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
209 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
210 if ( $row !== false ) {
211 $title = Title
::newFromRow( $row );
219 * Make an array of titles from an array of IDs
221 * @param $ids Array of Int Array of IDs
222 * @return Array of Titles
224 public static function newFromIDs( $ids ) {
225 if ( !count( $ids ) ) {
228 $dbr = wfGetDB( DB_SLAVE
);
233 'page_namespace', 'page_title', 'page_id',
234 'page_len', 'page_is_redirect', 'page_latest',
236 array( 'page_id' => $ids ),
241 foreach ( $res as $row ) {
242 $titles[] = Title
::newFromRow( $row );
248 * Make a Title object from a DB row
250 * @param $row Object database row (needs at least page_title,page_namespace)
251 * @return Title corresponding Title
253 public static function newFromRow( $row ) {
254 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
255 $t->loadFromRow( $row );
260 * Load Title object fields from a DB row.
261 * If false is given, the title will be treated as non-existing.
263 * @param $row Object|false database row
266 public function loadFromRow( $row ) {
267 if ( $row ) { // page found
268 if ( isset( $row->page_id
) )
269 $this->mArticleID
= (int)$row->page_id
;
270 if ( isset( $row->page_len
) )
271 $this->mLength
= (int)$row->page_len
;
272 if ( isset( $row->page_is_redirect
) )
273 $this->mRedirect
= (bool)$row->page_is_redirect
;
274 if ( isset( $row->page_latest
) )
275 $this->mLatestID
= (int)$row->page_latest
;
276 } else { // page not found
277 $this->mArticleID
= 0;
279 $this->mRedirect
= false;
280 $this->mLatestID
= 0;
285 * Create a new Title from a namespace index and a DB key.
286 * It's assumed that $ns and $title are *valid*, for instance when
287 * they came directly from the database or a special page name.
288 * For convenience, spaces are converted to underscores so that
289 * eg user_text fields can be used directly.
291 * @param $ns Int the namespace of the article
292 * @param $title String the unprefixed database key form
293 * @param $fragment String the link fragment (after the "#")
294 * @param $interwiki String the interwiki prefix
295 * @return Title the new object
297 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
299 $t->mInterwiki
= $interwiki;
300 $t->mFragment
= $fragment;
301 $t->mNamespace
= $ns = intval( $ns );
302 $t->mDbkeyform
= str_replace( ' ', '_', $title );
303 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
304 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
305 $t->mTextform
= str_replace( '_', ' ', $title );
310 * Create a new Title from a namespace index and a DB key.
311 * The parameters will be checked for validity, which is a bit slower
312 * than makeTitle() but safer for user-provided data.
314 * @param $ns Int the namespace of the article
315 * @param $title String database key form
316 * @param $fragment String the link fragment (after the "#")
317 * @param $interwiki String interwiki prefix
318 * @return Title the new object, or NULL on an error
320 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
322 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
323 if ( $t->secureAndSplit() ) {
331 * Create a new Title for the Main Page
333 * @return Title the new object
335 public static function newMainPage() {
336 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
337 // Don't give fatal errors if the message is broken
339 $title = Title
::newFromText( 'Main Page' );
345 * Extract a redirect destination from a string and return the
346 * Title, or null if the text doesn't contain a valid redirect
347 * This will only return the very next target, useful for
348 * the redirect table and other checks that don't need full recursion
350 * @param $text String: Text with possible redirect
351 * @return Title: The corresponding Title
353 public static function newFromRedirect( $text ) {
354 return self
::newFromRedirectInternal( $text );
358 * Extract a redirect destination from a string and return the
359 * Title, or null if the text doesn't contain a valid redirect
360 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
361 * in order to provide (hopefully) the Title of the final destination instead of another redirect
363 * @param $text String Text with possible redirect
366 public static function newFromRedirectRecurse( $text ) {
367 $titles = self
::newFromRedirectArray( $text );
368 return $titles ?
array_pop( $titles ) : null;
372 * Extract a redirect destination from a string and return an
373 * array of Titles, or null if the text doesn't contain a valid redirect
374 * The last element in the array is the final destination after all redirects
375 * have been resolved (up to $wgMaxRedirects times)
377 * @param $text String Text with possible redirect
378 * @return Array of Titles, with the destination last
380 public static function newFromRedirectArray( $text ) {
381 global $wgMaxRedirects;
382 $title = self
::newFromRedirectInternal( $text );
383 if ( is_null( $title ) ) {
386 // recursive check to follow double redirects
387 $recurse = $wgMaxRedirects;
388 $titles = array( $title );
389 while ( --$recurse > 0 ) {
390 if ( $title->isRedirect() ) {
391 $article = new Article( $title, 0 );
392 $newtitle = $article->getRedirectTarget();
396 // Redirects to some special pages are not permitted
397 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
398 // the new title passes the checks, so make that our current title so that further recursion can be checked
400 $titles[] = $newtitle;
409 * Really extract the redirect destination
410 * Do not call this function directly, use one of the newFromRedirect* functions above
412 * @param $text String Text with possible redirect
415 protected static function newFromRedirectInternal( $text ) {
416 global $wgMaxRedirects;
417 if ( $wgMaxRedirects < 1 ) {
418 //redirects are disabled, so quit early
421 $redir = MagicWord
::get( 'redirect' );
422 $text = trim( $text );
423 if ( $redir->matchStartAndRemove( $text ) ) {
424 // Extract the first link and see if it's usable
425 // Ensure that it really does come directly after #REDIRECT
426 // Some older redirects included a colon, so don't freak about that!
428 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
429 // Strip preceding colon used to "escape" categories, etc.
430 // and URL-decode links
431 if ( strpos( $m[1], '%' ) !== false ) {
432 // Match behavior of inline link parsing here;
433 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
435 $title = Title
::newFromText( $m[1] );
436 // If the title is a redirect to bad special pages or is invalid, return null
437 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
446 # ----------------------------------------------------------------------------
448 # ----------------------------------------------------------------------------
451 * Get the prefixed DB key associated with an ID
453 * @param $id Int the page_id of the article
454 * @return Title an object representing the article, or NULL if no such article was found
456 public static function nameOf( $id ) {
457 $dbr = wfGetDB( DB_SLAVE
);
459 $s = $dbr->selectRow(
461 array( 'page_namespace', 'page_title' ),
462 array( 'page_id' => $id ),
465 if ( $s === false ) {
469 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
474 * Get a regex character class describing the legal characters in a link
476 * @return String the list of characters, not delimited
478 public static function legalChars() {
479 global $wgLegalTitleChars;
480 return $wgLegalTitleChars;
484 * Get a string representation of a title suitable for
485 * including in a search index
487 * @param $ns Int a namespace index
488 * @param $title String text-form main part
489 * @return String a stripped-down title string ready for the search index
491 public static function indexTitle( $ns, $title ) {
494 $lc = SearchEngine
::legalSearchChars() . '&#;';
495 $t = $wgContLang->normalizeForSearch( $title );
496 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
497 $t = $wgContLang->lc( $t );
500 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
501 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
503 $t = preg_replace( "/\\s+/", ' ', $t );
505 if ( $ns == NS_FILE
) {
506 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
512 * Make a prefixed DB key from a DB key and a namespace index
514 * @param $ns Int numerical representation of the namespace
515 * @param $title String the DB key form the title
516 * @param $fragment String The link fragment (after the "#")
517 * @param $interwiki String The interwiki prefix
518 * @return String the prefixed form of the title
520 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
523 $namespace = $wgContLang->getNsText( $ns );
524 $name = $namespace == '' ?
$title : "$namespace:$title";
525 if ( strval( $interwiki ) != '' ) {
526 $name = "$interwiki:$name";
528 if ( strval( $fragment ) != '' ) {
529 $name .= '#' . $fragment;
535 * Determine whether the object refers to a page within
538 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
540 public function isLocal() {
541 if ( $this->mInterwiki
!= '' ) {
542 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
549 * Determine whether the object refers to a page within
550 * this project and is transcludable.
552 * @return Bool TRUE if this is transcludable
554 public function isTrans() {
555 if ( $this->mInterwiki
== '' ) {
559 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
563 * Returns the DB name of the distant wiki which owns the object.
565 * @return String the DB name
567 public function getTransWikiID() {
568 if ( $this->mInterwiki
== '' ) {
572 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
576 * Escape a text fragment, say from a link, for a URL
578 * @param $fragment string containing a URL or link fragment (after the "#")
579 * @return String: escaped string
581 static function escapeFragmentForURL( $fragment ) {
582 # Note that we don't urlencode the fragment. urlencoded Unicode
583 # fragments appear not to work in IE (at least up to 7) or in at least
584 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
585 # to care if they aren't encoded.
586 return Sanitizer
::escapeId( $fragment, 'noninitial' );
589 # ----------------------------------------------------------------------------
591 # ----------------------------------------------------------------------------
593 /** Simple accessors */
595 * Get the text form (spaces not underscores) of the main part
597 * @return String Main part of the title
599 public function getText() { return $this->mTextform
; }
602 * Get the URL-encoded form of the main part
604 * @return String Main part of the title, URL-encoded
606 public function getPartialURL() { return $this->mUrlform
; }
609 * Get the main part with underscores
611 * @return String: Main part of the title, with underscores
613 public function getDBkey() { return $this->mDbkeyform
; }
616 * Get the namespace index, i.e. one of the NS_xxxx constants.
618 * @return Integer: Namespace index
620 public function getNamespace() { return $this->mNamespace
; }
623 * Get the namespace text
625 * @return String: Namespace text
627 public function getNsText() {
630 if ( $this->mInterwiki
!= '' ) {
631 // This probably shouldn't even happen. ohh man, oh yuck.
632 // But for interwiki transclusion it sometimes does.
633 // Shit. Shit shit shit.
635 // Use the canonical namespaces if possible to try to
636 // resolve a foreign namespace.
637 if ( MWNamespace
::exists( $this->mNamespace
) ) {
638 return MWNamespace
::getCanonicalName( $this->mNamespace
);
642 if ( $wgContLang->needsGenderDistinction() &&
643 MWNamespace
::hasGenderDistinction( $this->mNamespace
) ) {
644 $gender = GenderCache
::singleton()->getGenderOf( $this->getText(), __METHOD__
);
645 return $wgContLang->getGenderNsText( $this->mNamespace
, $gender );
648 return $wgContLang->getNsText( $this->mNamespace
);
652 * Get the DB key with the initial letter case as specified by the user
654 * @return String DB key
656 function getUserCaseDBKey() {
657 return $this->mUserCaseDBKey
;
661 * Get the namespace text of the subject (rather than talk) page
663 * @return String Namespace text
665 public function getSubjectNsText() {
667 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
671 * Get the namespace text of the talk page
673 * @return String Namespace text
675 public function getTalkNsText() {
677 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
681 * Could this title have a corresponding talk page?
683 * @return Bool TRUE or FALSE
685 public function canTalk() {
686 return( MWNamespace
::canTalk( $this->mNamespace
) );
690 * Get the interwiki prefix (or null string)
692 * @return String Interwiki prefix
694 public function getInterwiki() { return $this->mInterwiki
; }
697 * Get the Title fragment (i.e.\ the bit after the #) in text form
699 * @return String Title fragment
701 public function getFragment() { return $this->mFragment
; }
704 * Get the fragment in URL form, including the "#" character if there is one
705 * @return String Fragment in URL form
707 public function getFragmentForURL() {
708 if ( $this->mFragment
== '' ) {
711 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
716 * Get the default namespace index, for when there is no namespace
718 * @return Int Default namespace index
720 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
723 * Get title for search index
725 * @return String a stripped-down title string ready for the
728 public function getIndexTitle() {
729 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
733 * Get the prefixed database key form
735 * @return String the prefixed title, with underscores and
736 * any interwiki and namespace prefixes
738 public function getPrefixedDBkey() {
739 $s = $this->prefix( $this->mDbkeyform
);
740 $s = str_replace( ' ', '_', $s );
745 * Get the prefixed title with spaces.
746 * This is the form usually used for display
748 * @return String the prefixed title, with spaces
750 public function getPrefixedText() {
751 // @todo FIXME: Bad usage of empty() ?
752 if ( empty( $this->mPrefixedText
) ) {
753 $s = $this->prefix( $this->mTextform
);
754 $s = str_replace( '_', ' ', $s );
755 $this->mPrefixedText
= $s;
757 return $this->mPrefixedText
;
761 * Return the prefixed title with spaces _without_ the interwiki prefix
763 * @return \type{\string} the title, prefixed by the namespace but not by the interwiki prefix, with spaces
765 public function getSemiPrefixedText() {
766 if ( !isset( $this->mSemiPrefixedText
) ){
767 $s = ( $this->mNamespace
=== NS_MAIN ?
'' : $this->getNsText() . ':' ) . $this->mTextform
;
768 $s = str_replace( '_', ' ', $s );
769 $this->mSemiPrefixedText
= $s;
771 return $this->mSemiPrefixedText
;
775 * Get the prefixed title with spaces, plus any fragment
776 * (part beginning with '#')
778 * @return String the prefixed title, with spaces and the fragment, including '#'
780 public function getFullText() {
781 $text = $this->getPrefixedText();
782 if ( $this->mFragment
!= '' ) {
783 $text .= '#' . $this->mFragment
;
789 * Get the base page name, i.e. the leftmost part before any slashes
791 * @return String Base name
793 public function getBaseText() {
794 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
795 return $this->getText();
798 $parts = explode( '/', $this->getText() );
799 # Don't discard the real title if there's no subpage involved
800 if ( count( $parts ) > 1 ) {
801 unset( $parts[count( $parts ) - 1] );
803 return implode( '/', $parts );
807 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
809 * @return String Subpage name
811 public function getSubpageText() {
812 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
813 return( $this->mTextform
);
815 $parts = explode( '/', $this->mTextform
);
816 return( $parts[count( $parts ) - 1] );
820 * Get a URL-encoded form of the subpage text
822 * @return String URL-encoded subpage name
824 public function getSubpageUrlForm() {
825 $text = $this->getSubpageText();
826 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
831 * Get a URL-encoded title (not an actual URL) including interwiki
833 * @return String the URL-encoded form
835 public function getPrefixedURL() {
836 $s = $this->prefix( $this->mDbkeyform
);
837 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
842 * Get a real URL referring to this title, with interwiki link and
845 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
846 * links. Can be specified as an associative array as well, e.g.,
847 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
848 * @param $variant String language variant of url (for sr, zh..)
849 * @return String the URL
851 public function getFullURL( $query = '', $variant = false ) {
852 global $wgServer, $wgRequest;
854 # Hand off all the decisions on urls to getLocalURL
855 $url = $this->getLocalURL( $query, $variant );
857 # Expand the url to make it a full url. Note that getLocalURL has the
858 # potential to output full urls for a variety of reasons, so we use
859 # wfExpandUrl instead of simply prepending $wgServer
860 $url = wfExpandUrl( $url, PROTO_RELATIVE
);
862 # Finally, add the fragment.
863 $url .= $this->getFragmentForURL();
865 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
870 * Get a URL with no fragment or server name. If this page is generated
871 * with action=render, $wgServer is prepended.
873 * @param $query Mixed: an optional query string; if not specified,
874 * $wgArticlePath will be used. Can be specified as an associative array
875 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
877 * @param $variant String language variant of url (for sr, zh..)
878 * @return String the URL
880 public function getLocalURL( $query = '', $variant = false ) {
881 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
882 global $wgVariantArticlePath, $wgContLang;
884 if ( is_array( $query ) ) {
885 $query = wfArrayToCGI( $query );
888 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
890 $namespace = $this->getNsText();
891 if ( $namespace != '' ) {
892 # Can this actually happen? Interwikis shouldn't be parsed.
893 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
896 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
897 $url = wfAppendQuery( $url, $query );
899 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
900 if ( $query == '' ) {
901 if ( $variant != false && $wgContLang->hasVariants() ) {
902 if ( !$wgVariantArticlePath ) {
903 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
905 $variantArticlePath = $wgVariantArticlePath;
907 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
908 $url = str_replace( '$1', $dbkey, $url );
910 $url = str_replace( '$1', $dbkey, $wgArticlePath );
911 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
914 global $wgActionPaths;
917 if ( !empty( $wgActionPaths ) &&
918 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
920 $action = urldecode( $matches[2] );
921 if ( isset( $wgActionPaths[$action] ) ) {
922 $query = $matches[1];
923 if ( isset( $matches[4] ) ) {
924 $query .= $matches[4];
926 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
927 if ( $query != '' ) {
928 $url = wfAppendQuery( $url, $query );
933 if ( $url === false ) {
934 if ( $query == '-' ) {
937 $url = "{$wgScript}?title={$dbkey}&{$query}";
941 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query, $variant ) );
943 // @todo FIXME: This causes breakage in various places when we
944 // actually expected a local URL and end up with dupe prefixes.
945 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
946 $url = $wgServer . $url;
949 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query, $variant ) );
954 * Get a URL that's the simplest URL that will be valid to link, locally,
955 * to the current Title. It includes the fragment, but does not include
956 * the server unless action=render is used (or the link is external). If
957 * there's a fragment but the prefixed text is empty, we just return a link
960 * The result obviously should not be URL-escaped, but does need to be
961 * HTML-escaped if it's being output in HTML.
963 * @param $query Array of Strings An associative array of key => value pairs for the
964 * query string. Keys and values will be escaped.
965 * @param $variant String language variant of URL (for sr, zh..). Ignored
966 * for external links. Default is "false" (same variant as current page,
967 * for anonymous users).
968 * @return String the URL
970 public function getLinkUrl( $query = array(), $variant = false ) {
971 wfProfileIn( __METHOD__
);
972 if ( $this->isExternal() ) {
973 $ret = $this->getFullURL( $query );
974 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
975 $ret = $this->getFragmentForURL();
977 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
979 wfProfileOut( __METHOD__
);
984 * Get an HTML-escaped version of the URL form, suitable for
985 * using in a link, without a server name or fragment
987 * @param $query String an optional query string
988 * @return String the URL
990 public function escapeLocalURL( $query = '' ) {
991 return htmlspecialchars( $this->getLocalURL( $query ) );
995 * Get an HTML-escaped version of the URL form, suitable for
996 * using in a link, including the server name and fragment
998 * @param $query String an optional query string
999 * @return String the URL
1001 public function escapeFullURL( $query = '' ) {
1002 return htmlspecialchars( $this->getFullURL( $query ) );
1006 * HTML-escaped version of getCanonicalURL()
1008 public function escapeCanonicalURL( $query = '', $variant = false ) {
1009 return htmlspecialchars( $this->getCanonicalURL( $query, $variant ) );
1013 * Get the URL form for an internal link.
1014 * - Used in various Squid-related code, in case we have a different
1015 * internal hostname for the server from the exposed one.
1017 * This uses $wgInternalServer to qualify the path, or $wgServer
1018 * if $wgInternalServer is not set. If the server variable used is
1019 * protocol-relative, the URL will be expanded to http://
1021 * @param $query String an optional query string
1022 * @param $variant String language variant of url (for sr, zh..)
1023 * @return String the URL
1025 public function getInternalURL( $query = '', $variant = false ) {
1026 if ( $this->isExternal( ) ) {
1029 global $wgInternalServer, $wgServer;
1030 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1032 $url = wfExpandUrl( $server . $this->getLocalURL( $query, $variant ), PROTO_HTTP
);
1033 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1038 * Get the URL for a canonical link, for use in things like IRC and
1039 * e-mail notifications. Uses $wgCanonicalServer and the
1040 * GetCanonicalURL hook.
1042 * @param $query string An optional query string
1043 * @param $variant string Language variant of URL (for sr, zh, ...)
1044 * @return string The URL
1046 public function getCanonicalURL( $query = '', $variant = false ) {
1047 global $wgCanonicalServer;
1048 $url = $wgCanonicalServer . $this->getLocalURL( $query, $variant );
1049 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1054 * Get the edit URL for this Title
1056 * @return String the URL, or a null string if this is an
1059 public function getEditURL() {
1060 if ( $this->mInterwiki
!= '' ) {
1063 $s = $this->getLocalURL( 'action=edit' );
1069 * Get the HTML-escaped displayable text form.
1070 * Used for the title field in <a> tags.
1072 * @return String the text, including any prefixes
1074 public function getEscapedText() {
1075 return htmlspecialchars( $this->getPrefixedText() );
1079 * Is this Title interwiki?
1083 public function isExternal() {
1084 return ( $this->mInterwiki
!= '' );
1088 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1090 * @param $action String Action to check (default: edit)
1093 public function isSemiProtected( $action = 'edit' ) {
1094 if ( $this->exists() ) {
1095 $restrictions = $this->getRestrictions( $action );
1096 if ( count( $restrictions ) > 0 ) {
1097 foreach ( $restrictions as $restriction ) {
1098 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
1108 # If it doesn't exist, it can't be protected
1114 * Does the title correspond to a protected article?
1116 * @param $action String the action the page is protected from,
1117 * by default checks all actions.
1120 public function isProtected( $action = '' ) {
1121 global $wgRestrictionLevels;
1123 $restrictionTypes = $this->getRestrictionTypes();
1125 # Special pages have inherent protection
1126 if( $this->getNamespace() == NS_SPECIAL
) {
1130 # Check regular protection levels
1131 foreach ( $restrictionTypes as $type ) {
1132 if ( $action == $type ||
$action == '' ) {
1133 $r = $this->getRestrictions( $type );
1134 foreach ( $wgRestrictionLevels as $level ) {
1135 if ( in_array( $level, $r ) && $level != '' ) {
1146 * Is this a conversion table for the LanguageConverter?
1150 public function isConversionTable() {
1152 $this->getNamespace() == NS_MEDIAWIKI
&&
1153 strpos( $this->getText(), 'Conversiontable' ) !== false
1163 * Is $wgUser watching this page?
1167 public function userIsWatching() {
1170 if ( is_null( $this->mWatched
) ) {
1171 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1172 $this->mWatched
= false;
1174 $this->mWatched
= $wgUser->isWatched( $this );
1177 return $this->mWatched
;
1181 * Can $wgUser perform $action on this page?
1182 * This skips potentially expensive cascading permission checks
1183 * as well as avoids expensive error formatting
1185 * Suitable for use for nonessential UI controls in common cases, but
1186 * _not_ for functional access control.
1188 * May provide false positives, but should never provide a false negative.
1190 * @param $action String action that permission needs to be checked for
1193 public function quickUserCan( $action ) {
1194 return $this->userCan( $action, false );
1198 * Determines if $user is unable to edit this page because it has been protected
1199 * by $wgNamespaceProtection.
1201 * @param $user User object to check permissions
1204 public function isNamespaceProtected( User
$user ) {
1205 global $wgNamespaceProtection;
1207 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
1208 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
1209 if ( $right != '' && !$user->isAllowed( $right ) ) {
1218 * Can $wgUser perform $action on this page?
1220 * @param $action String action that permission needs to be checked for
1221 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1224 public function userCan( $action, $doExpensiveQueries = true ) {
1226 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1230 * Can $user perform $action on this page?
1232 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1234 * @param $action String action that permission needs to be checked for
1235 * @param $user User to check
1236 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries by
1237 * skipping checks for cascading protections and user blocks.
1238 * @param $ignoreErrors Array of Strings Set this to a list of message keys whose corresponding errors may be ignored.
1239 * @return Array of arguments to wfMsg to explain permissions problems.
1241 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1242 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1244 // Remove the errors being ignored.
1245 foreach ( $errors as $index => $error ) {
1246 $error_key = is_array( $error ) ?
$error[0] : $error;
1248 if ( in_array( $error_key, $ignoreErrors ) ) {
1249 unset( $errors[$index] );
1257 * Permissions checks that fail most often, and which are easiest to test.
1259 * @param $action String the action to check
1260 * @param $user User user to check
1261 * @param $errors Array list of current errors
1262 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1263 * @param $short Boolean short circuit on first error
1265 * @return Array list of errors
1267 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1268 $ns = $this->getNamespace();
1270 if ( $action == 'create' ) {
1271 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk', $ns ) ) ||
1272 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage', $ns ) ) ) {
1273 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1275 } elseif ( $action == 'move' ) {
1276 if ( !$user->isAllowed( 'move-rootuserpages', $ns )
1277 && $ns == NS_USER
&& !$this->isSubpage() ) {
1278 // Show user page-specific message only if the user can move other pages
1279 $errors[] = array( 'cant-move-user-page' );
1282 // Check if user is allowed to move files if it's a file
1283 if ( $ns == NS_FILE
&& !$user->isAllowed( 'movefile', $ns ) ) {
1284 $errors[] = array( 'movenotallowedfile' );
1287 if ( !$user->isAllowed( 'move', $ns) ) {
1288 // User can't move anything
1290 $userCanMove = in_array( 'move', User
::getGroupPermissions(
1291 array( 'user' ), $ns ), true );
1292 $autoconfirmedCanMove = in_array( 'move', User
::getGroupPermissions(
1293 array( 'autoconfirmed' ), $ns ), true );
1295 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1296 // custom message if logged-in users without any special rights can move
1297 $errors[] = array( 'movenologintext' );
1299 $errors[] = array( 'movenotallowed' );
1302 } elseif ( $action == 'move-target' ) {
1303 if ( !$user->isAllowed( 'move', $ns ) ) {
1304 // User can't move anything
1305 $errors[] = array( 'movenotallowed' );
1306 } elseif ( !$user->isAllowed( 'move-rootuserpages', $ns )
1307 && $ns == NS_USER
&& !$this->isSubpage() ) {
1308 // Show user page-specific message only if the user can move other pages
1309 $errors[] = array( 'cant-move-to-user-page' );
1311 } elseif ( !$user->isAllowed( $action, $ns ) ) {
1312 // We avoid expensive display logic for quickUserCan's and such
1315 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1316 User
::getGroupsWithPermission( $action, $ns ) );
1323 $wgLang->commaList( $groups ),
1327 $return = array( 'badaccess-group0' );
1329 $errors[] = $return;
1336 * Add the resulting error code to the errors array
1338 * @param $errors Array list of current errors
1339 * @param $result Mixed result of errors
1341 * @return Array list of errors
1343 private function resultToError( $errors, $result ) {
1344 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1345 // A single array representing an error
1346 $errors[] = $result;
1347 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1348 // A nested array representing multiple errors
1349 $errors = array_merge( $errors, $result );
1350 } elseif ( $result !== '' && is_string( $result ) ) {
1351 // A string representing a message-id
1352 $errors[] = array( $result );
1353 } elseif ( $result === false ) {
1354 // a generic "We don't want them to do that"
1355 $errors[] = array( 'badaccess-group0' );
1361 * Check various permission hooks
1363 * @param $action String the action to check
1364 * @param $user User user to check
1365 * @param $errors Array list of current errors
1366 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1367 * @param $short Boolean short circuit on first error
1369 * @return Array list of errors
1371 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1372 // Use getUserPermissionsErrors instead
1374 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1375 return $result ?
array() : array( array( 'badaccess-group0' ) );
1377 // Check getUserPermissionsErrors hook
1378 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1379 $errors = $this->resultToError( $errors, $result );
1381 // Check getUserPermissionsErrorsExpensive hook
1382 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1383 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1384 $errors = $this->resultToError( $errors, $result );
1391 * Check permissions on special pages & namespaces
1393 * @param $action String the action to check
1394 * @param $user User user to check
1395 * @param $errors Array list of current errors
1396 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1397 * @param $short Boolean short circuit on first error
1399 * @return Array list of errors
1401 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1402 # Only 'createaccount' and 'execute' can be performed on
1403 # special pages, which don't actually exist in the DB.
1404 $specialOKActions = array( 'createaccount', 'execute' );
1405 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1406 $errors[] = array( 'ns-specialprotected' );
1409 # Check $wgNamespaceProtection for restricted namespaces
1410 if ( $this->isNamespaceProtected( $user ) ) {
1411 $ns = $this->mNamespace
== NS_MAIN ?
1412 wfMsg( 'nstab-main' ) : $this->getNsText();
1413 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1414 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1421 * Check CSS/JS sub-page permissions
1423 * @param $action String the action to check
1424 * @param $user User user to check
1425 * @param $errors Array list of current errors
1426 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1427 * @param $short Boolean short circuit on first error
1429 * @return Array list of errors
1431 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1432 # Protect css/js subpages of user pages
1433 # XXX: this might be better using restrictions
1434 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1435 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1436 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1437 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1438 $errors[] = array( 'customcssprotected' );
1439 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1440 $errors[] = array( 'customjsprotected' );
1448 * Check against page_restrictions table requirements on this
1449 * page. The user must possess all required rights for this
1452 * @param $action String the action to check
1453 * @param $user User user to check
1454 * @param $errors Array list of current errors
1455 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1456 * @param $short Boolean short circuit on first error
1458 * @return Array list of errors
1460 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1461 foreach ( $this->getRestrictions( $action ) as $right ) {
1462 // Backwards compatibility, rewrite sysop -> protect
1463 if ( $right == 'sysop' ) {
1466 if ( $right != '' && !$user->isAllowed( $right, $this->mNamespace
) ) {
1467 // Users with 'editprotected' permission can edit protected pages
1468 if ( $action == 'edit' && $user->isAllowed( 'editprotected', $this->mNamespace
) ) {
1469 // Users with 'editprotected' permission cannot edit protected pages
1470 // with cascading option turned on.
1471 if ( $this->mCascadeRestriction
) {
1472 $errors[] = array( 'protectedpagetext', $right );
1475 $errors[] = array( 'protectedpagetext', $right );
1484 * Check restrictions on cascading pages.
1486 * @param $action String the action to check
1487 * @param $user User to check
1488 * @param $errors Array list of current errors
1489 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1490 * @param $short Boolean short circuit on first error
1492 * @return Array list of errors
1494 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1495 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1496 # We /could/ use the protection level on the source page, but it's
1497 # fairly ugly as we have to establish a precedence hierarchy for pages
1498 # included by multiple cascade-protected pages. So just restrict
1499 # it to people with 'protect' permission, as they could remove the
1500 # protection anyway.
1501 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1502 # Cascading protection depends on more than this page...
1503 # Several cascading protected pages may include this page...
1504 # Check each cascading level
1505 # This is only for protection restrictions, not for all actions
1506 if ( isset( $restrictions[$action] ) ) {
1507 foreach ( $restrictions[$action] as $right ) {
1508 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1509 if ( $right != '' && !$user->isAllowed( $right, $this->mNamespace
) ) {
1511 foreach ( $cascadingSources as $page )
1512 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1513 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1523 * Check action permissions not already checked in checkQuickPermissions
1525 * @param $action String the action to check
1526 * @param $user User to check
1527 * @param $errors Array list of current errors
1528 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1529 * @param $short Boolean short circuit on first error
1531 * @return Array list of errors
1533 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1534 if ( $action == 'protect' ) {
1535 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1536 // If they can't edit, they shouldn't protect.
1537 $errors[] = array( 'protect-cantedit' );
1539 } elseif ( $action == 'create' ) {
1540 $title_protection = $this->getTitleProtection();
1541 if( $title_protection ) {
1542 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1543 $title_protection['pt_create_perm'] = 'protect'; // B/C
1545 if( $title_protection['pt_create_perm'] == '' ||
1546 !$user->isAllowed( $title_protection['pt_create_perm'],
1547 $this->mNamespace
) ) {
1548 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1551 } elseif ( $action == 'move' ) {
1552 // Check for immobile pages
1553 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1554 // Specific message for this case
1555 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1556 } elseif ( !$this->isMovable() ) {
1557 // Less specific message for rarer cases
1558 $errors[] = array( 'immobile-page' );
1560 } elseif ( $action == 'move-target' ) {
1561 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1562 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1563 } elseif ( !$this->isMovable() ) {
1564 $errors[] = array( 'immobile-target-page' );
1571 * Check that the user isn't blocked from editting.
1573 * @param $action String the action to check
1574 * @param $user User to check
1575 * @param $errors Array list of current errors
1576 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1577 * @param $short Boolean short circuit on first error
1579 * @return Array list of errors
1581 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1582 if( !$doExpensiveQueries ) {
1586 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1588 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1589 $errors[] = array( 'confirmedittext' );
1592 if ( in_array( $action, array( 'read', 'createaccount', 'unblock' ) ) ){
1593 // Edit blocks should not affect reading.
1594 // Account creation blocks handled at userlogin.
1595 // Unblocking handled in SpecialUnblock
1596 } elseif( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ){
1597 // Don't block the user from editing their own talk page unless they've been
1598 // explicitly blocked from that too.
1599 } elseif( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
1600 $block = $user->mBlock
;
1602 // This is from OutputPage::blockedPage
1603 // Copied at r23888 by werdna
1605 $id = $user->blockedBy();
1606 $reason = $user->blockedFor();
1607 if ( $reason == '' ) {
1608 $reason = wfMsg( 'blockednoreason' );
1610 $ip = $user->getRequest()->getIP();
1612 if ( is_numeric( $id ) ) {
1613 $name = User
::whoIs( $id );
1618 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1619 $blockid = $block->getId();
1620 $blockExpiry = $user->mBlock
->mExpiry
;
1621 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1622 if ( $blockExpiry == 'infinity' ) {
1623 $blockExpiry = wfMessage( 'infiniteblock' )->text();
1625 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1628 $intended = strval( $user->mBlock
->getTarget() );
1630 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1631 $blockid, $blockExpiry, $intended, $blockTimestamp );
1638 * Can $user perform $action on this page? This is an internal function,
1639 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1640 * checks on wfReadOnly() and blocks)
1642 * @param $action String action that permission needs to be checked for
1643 * @param $user User to check
1644 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1645 * @param $short Bool Set this to true to stop after the first permission error.
1646 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
1648 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1649 wfProfileIn( __METHOD__
);
1653 'checkQuickPermissions',
1654 'checkPermissionHooks',
1655 'checkSpecialsAndNSPermissions',
1656 'checkCSSandJSPermissions',
1657 'checkPageRestrictions',
1658 'checkCascadingSourcesRestrictions',
1659 'checkActionPermissions',
1663 while( count( $checks ) > 0 &&
1664 !( $short && count( $errors ) > 0 ) ) {
1665 $method = array_shift( $checks );
1666 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1669 wfProfileOut( __METHOD__
);
1674 * Is this title subject to title protection?
1675 * Title protection is the one applied against creation of such title.
1677 * @return Mixed An associative array representing any existent title
1678 * protection, or false if there's none.
1680 private function getTitleProtection() {
1681 // Can't protect pages in special namespaces
1682 if ( $this->getNamespace() < 0 ) {
1686 // Can't protect pages that exist.
1687 if ( $this->exists() ) {
1691 if ( !isset( $this->mTitleProtection
) ) {
1692 $dbr = wfGetDB( DB_SLAVE
);
1693 $res = $dbr->select( 'protected_titles', '*',
1694 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1697 // fetchRow returns false if there are no rows.
1698 $this->mTitleProtection
= $dbr->fetchRow( $res );
1700 return $this->mTitleProtection
;
1704 * Update the title protection status
1706 * @param $create_perm String Permission required for creation
1707 * @param $reason String Reason for protection
1708 * @param $expiry String Expiry timestamp
1709 * @return boolean true
1711 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1712 global $wgUser, $wgContLang;
1714 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1715 && $expiry == $this->mRestrictionsExpiry
['create'] ) {
1720 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1722 $dbw = wfGetDB( DB_MASTER
);
1724 $encodedExpiry = $dbw->encodeExpiry( $expiry );
1726 $expiry_description = '';
1727 if ( $encodedExpiry != $dbw->getInfinity() ) {
1728 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1729 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1731 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1734 # Update protection table
1735 if ( $create_perm != '' ) {
1736 $this->mTitleProtection
= array(
1737 'pt_namespace' => $namespace,
1738 'pt_title' => $title,
1739 'pt_create_perm' => $create_perm,
1740 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
1741 'pt_expiry' => $encodedExpiry,
1742 'pt_user' => $wgUser->getId(),
1743 'pt_reason' => $reason,
1745 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1746 $this->mTitleProtection
, __METHOD__
);
1748 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1749 'pt_title' => $title ), __METHOD__
);
1750 $this->mTitleProtection
= false;
1753 # Update the protection log
1754 if ( $dbw->affectedRows() ) {
1755 $log = new LogPage( 'protect' );
1757 if ( $create_perm ) {
1758 $params = array( "[create=$create_perm] $expiry_description", '' );
1759 $log->addEntry( ( isset( $this->mRestrictions
['create'] ) && $this->mRestrictions
['create'] ) ?
'modify' : 'protect', $this, trim( $reason ), $params );
1761 $log->addEntry( 'unprotect', $this, $reason );
1769 * Remove any title protection due to page existing
1771 public function deleteTitleProtection() {
1772 $dbw = wfGetDB( DB_MASTER
);
1776 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1779 $this->mTitleProtection
= false;
1783 * Would anybody with sufficient privileges be able to move this page?
1784 * Some pages just aren't movable.
1786 * @return Bool TRUE or FALSE
1788 public function isMovable() {
1789 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1793 * Can $wgUser read this page?
1796 * @todo fold these checks into userCan()
1798 public function userCanRead() {
1799 global $wgUser, $wgGroupPermissions;
1801 static $useShortcut = null;
1803 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1804 if ( is_null( $useShortcut ) ) {
1805 global $wgRevokePermissions;
1806 $useShortcut = true;
1807 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1808 # Not a public wiki, so no shortcut
1809 $useShortcut = false;
1810 } elseif ( !empty( $wgRevokePermissions ) ) {
1812 * Iterate through each group with permissions being revoked (key not included since we don't care
1813 * what the group name is), then check if the read permission is being revoked. If it is, then
1814 * we don't use the shortcut below since the user might not be able to read, even though anon
1815 * reading is allowed.
1817 foreach ( $wgRevokePermissions as $perms ) {
1818 if ( !empty( $perms['read'] ) ) {
1819 # We might be removing the read right from the user, so no shortcut
1820 $useShortcut = false;
1828 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1829 if ( $result !== null ) {
1833 # Shortcut for public wikis, allows skipping quite a bit of code
1834 if ( $useShortcut ) {
1838 if ( $wgUser->isAllowed( 'read' ) ) {
1841 global $wgWhitelistRead;
1843 # Always grant access to the login page.
1844 # Even anons need to be able to log in.
1845 if ( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'ChangePassword' ) ) {
1849 # Bail out if there isn't whitelist
1850 if ( !is_array( $wgWhitelistRead ) ) {
1854 # Check for explicit whitelisting
1855 $name = $this->getPrefixedText();
1856 $dbName = $this->getPrefixedDBKey();
1857 // Check with and without underscores
1858 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) )
1861 # Old settings might have the title prefixed with
1862 # a colon for main-namespace pages
1863 if ( $this->getNamespace() == NS_MAIN
) {
1864 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
1869 # If it's a special page, ditch the subpage bit and check again
1870 if ( $this->getNamespace() == NS_SPECIAL
) {
1871 $name = $this->getDBkey();
1872 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
1873 if ( $name === false ) {
1874 # Invalid special page, but we show standard login required message
1878 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1879 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
1889 * Is this the mainpage?
1890 * @note Title::newFromText seams to be sufficiently optimized by the title
1891 * cache that we don't need to over-optimize by doing direct comparisons and
1892 * acidentally creating new bugs where $title->equals( Title::newFromText() )
1893 * ends up reporting something differently than $title->isMainPage();
1897 public function isMainPage() {
1898 return $this->equals( Title
::newMainPage() );
1902 * Is this a talk page of some sort?
1906 public function isTalkPage() {
1907 return MWNamespace
::isTalk( $this->getNamespace() );
1911 * Is this a subpage?
1915 public function isSubpage() {
1916 return MWNamespace
::hasSubpages( $this->mNamespace
)
1917 ?
strpos( $this->getText(), '/' ) !== false
1922 * Does this have subpages? (Warning, usually requires an extra DB query.)
1926 public function hasSubpages() {
1927 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1932 # We dynamically add a member variable for the purpose of this method
1933 # alone to cache the result. There's no point in having it hanging
1934 # around uninitialized in every Title object; therefore we only add it
1935 # if needed and don't declare it statically.
1936 if ( isset( $this->mHasSubpages
) ) {
1937 return $this->mHasSubpages
;
1940 $subpages = $this->getSubpages( 1 );
1941 if ( $subpages instanceof TitleArray
) {
1942 return $this->mHasSubpages
= (bool)$subpages->count();
1944 return $this->mHasSubpages
= false;
1948 * Get all subpages of this page.
1950 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
1951 * @return mixed TitleArray, or empty array if this page's namespace
1952 * doesn't allow subpages
1954 public function getSubpages( $limit = -1 ) {
1955 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
1959 $dbr = wfGetDB( DB_SLAVE
);
1960 $conds['page_namespace'] = $this->getNamespace();
1961 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
1963 if ( $limit > -1 ) {
1964 $options['LIMIT'] = $limit;
1966 return $this->mSubpages
= TitleArray
::newFromResult(
1967 $dbr->select( 'page',
1968 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1977 * Does that page contain wikitext, or it is JS, CSS or whatever?
1981 public function isWikitextPage() {
1982 $retval = !$this->isCssOrJsPage() && !$this->isCssJsSubpage();
1983 wfRunHooks( 'TitleIsWikitextPage', array( $this, &$retval ) );
1988 * Could this page contain custom CSS or JavaScript, based
1993 public function isCssOrJsPage() {
1994 $retval = $this->mNamespace
== NS_MEDIAWIKI
1995 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1996 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$retval ) );
2001 * Is this a .css or .js subpage of a user page?
2004 public function isCssJsSubpage() {
2005 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
2009 * Is this a *valid* .css or .js subpage of a user page?
2012 * @deprecated since 1.17
2014 public function isValidCssJsSubpage() {
2015 return $this->isCssJsSubpage();
2019 * Trim down a .css or .js subpage title to get the corresponding skin name
2021 * @return string containing skin name from .css or .js subpage title
2023 public function getSkinFromCssJsSubpage() {
2024 $subpage = explode( '/', $this->mTextform
);
2025 $subpage = $subpage[ count( $subpage ) - 1 ];
2026 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
2030 * Is this a .css subpage of a user page?
2034 public function isCssSubpage() {
2035 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
2039 * Is this a .js subpage of a user page?
2043 public function isJsSubpage() {
2044 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
2048 * Protect css subpages of user pages: can $wgUser edit
2051 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2054 public function userCanEditCssSubpage() {
2056 wfDeprecated( __METHOD__
);
2057 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2058 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2062 * Protect js subpages of user pages: can $wgUser edit
2065 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2068 public function userCanEditJsSubpage() {
2070 wfDeprecated( __METHOD__
);
2071 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2072 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2076 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2078 * @return Bool If the page is subject to cascading restrictions.
2080 public function isCascadeProtected() {
2081 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2082 return ( $sources > 0 );
2086 * Cascading protection: Get the source of any cascading restrictions on this page.
2088 * @param $getPages Bool Whether or not to retrieve the actual pages
2089 * that the restrictions have come from.
2090 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2091 * have come, false for none, or true if such restrictions exist, but $getPages
2092 * was not set. The restriction array is an array of each type, each of which
2093 * contains a array of unique groups.
2095 public function getCascadeProtectionSources( $getPages = true ) {
2097 $pagerestrictions = array();
2099 if ( isset( $this->mCascadeSources
) && $getPages ) {
2100 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2101 } elseif ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2102 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2105 wfProfileIn( __METHOD__
);
2107 $dbr = wfGetDB( DB_SLAVE
);
2109 if ( $this->getNamespace() == NS_FILE
) {
2110 $tables = array( 'imagelinks', 'page_restrictions' );
2111 $where_clauses = array(
2112 'il_to' => $this->getDBkey(),
2117 $tables = array( 'templatelinks', 'page_restrictions' );
2118 $where_clauses = array(
2119 'tl_namespace' => $this->getNamespace(),
2120 'tl_title' => $this->getDBkey(),
2127 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2128 'pr_expiry', 'pr_type', 'pr_level' );
2129 $where_clauses[] = 'page_id=pr_page';
2132 $cols = array( 'pr_expiry' );
2135 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2137 $sources = $getPages ?
array() : false;
2138 $now = wfTimestampNow();
2139 $purgeExpired = false;
2141 foreach ( $res as $row ) {
2142 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2143 if ( $expiry > $now ) {
2145 $page_id = $row->pr_page
;
2146 $page_ns = $row->page_namespace
;
2147 $page_title = $row->page_title
;
2148 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2149 # Add groups needed for each restriction type if its not already there
2150 # Make sure this restriction type still exists
2152 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2153 $pagerestrictions[$row->pr_type
] = array();
2156 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2157 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2158 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2164 // Trigger lazy purge of expired restrictions from the db
2165 $purgeExpired = true;
2168 if ( $purgeExpired ) {
2169 Title
::purgeExpiredRestrictions();
2173 $this->mCascadeSources
= $sources;
2174 $this->mCascadingRestrictions
= $pagerestrictions;
2176 $this->mHasCascadingRestrictions
= $sources;
2179 wfProfileOut( __METHOD__
);
2180 return array( $sources, $pagerestrictions );
2184 * Returns cascading restrictions for the current article
2188 function areRestrictionsCascading() {
2189 if ( !$this->mRestrictionsLoaded
) {
2190 $this->loadRestrictions();
2193 return $this->mCascadeRestriction
;
2197 * Loads a string into mRestrictions array
2199 * @param $res Resource restrictions as an SQL result.
2200 * @param $oldFashionedRestrictions String comma-separated list of page
2201 * restrictions from page table (pre 1.10)
2203 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2206 foreach ( $res as $row ) {
2210 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2214 * Compiles list of active page restrictions from both page table (pre 1.10)
2215 * and page_restrictions table for this existing page.
2216 * Public for usage by LiquidThreads.
2218 * @param $rows array of db result objects
2219 * @param $oldFashionedRestrictions string comma-separated list of page
2220 * restrictions from page table (pre 1.10)
2222 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2224 $dbr = wfGetDB( DB_SLAVE
);
2226 $restrictionTypes = $this->getRestrictionTypes();
2228 foreach ( $restrictionTypes as $type ) {
2229 $this->mRestrictions
[$type] = array();
2230 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2233 $this->mCascadeRestriction
= false;
2235 # Backwards-compatibility: also load the restrictions from the page record (old format).
2237 if ( $oldFashionedRestrictions === null ) {
2238 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2239 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
2242 if ( $oldFashionedRestrictions != '' ) {
2244 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2245 $temp = explode( '=', trim( $restrict ) );
2246 if ( count( $temp ) == 1 ) {
2247 // old old format should be treated as edit/move restriction
2248 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2249 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2251 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
2255 $this->mOldRestrictions
= true;
2259 if ( count( $rows ) ) {
2260 # Current system - load second to make them override.
2261 $now = wfTimestampNow();
2262 $purgeExpired = false;
2264 # Cycle through all the restrictions.
2265 foreach ( $rows as $row ) {
2267 // Don't take care of restrictions types that aren't allowed
2268 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2271 // This code should be refactored, now that it's being used more generally,
2272 // But I don't really see any harm in leaving it in Block for now -werdna
2273 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2275 // Only apply the restrictions if they haven't expired!
2276 if ( !$expiry ||
$expiry > $now ) {
2277 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2278 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2280 $this->mCascadeRestriction |
= $row->pr_cascade
;
2282 // Trigger a lazy purge of expired restrictions
2283 $purgeExpired = true;
2287 if ( $purgeExpired ) {
2288 Title
::purgeExpiredRestrictions();
2292 $this->mRestrictionsLoaded
= true;
2296 * Load restrictions from the page_restrictions table
2298 * @param $oldFashionedRestrictions String comma-separated list of page
2299 * restrictions from page table (pre 1.10)
2301 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2303 if ( !$this->mRestrictionsLoaded
) {
2304 if ( $this->exists() ) {
2305 $dbr = wfGetDB( DB_SLAVE
);
2307 $res = $dbr->select(
2308 'page_restrictions',
2310 array( 'pr_page' => $this->getArticleId() ),
2314 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2316 $title_protection = $this->getTitleProtection();
2318 if ( $title_protection ) {
2319 $now = wfTimestampNow();
2320 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2322 if ( !$expiry ||
$expiry > $now ) {
2323 // Apply the restrictions
2324 $this->mRestrictionsExpiry
['create'] = $expiry;
2325 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2326 } else { // Get rid of the old restrictions
2327 Title
::purgeExpiredRestrictions();
2328 $this->mTitleProtection
= false;
2331 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2333 $this->mRestrictionsLoaded
= true;
2339 * Purge expired restrictions from the page_restrictions table
2341 static function purgeExpiredRestrictions() {
2342 $dbw = wfGetDB( DB_MASTER
);
2344 'page_restrictions',
2345 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2351 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2357 * Accessor/initialisation for mRestrictions
2359 * @param $action String action that permission needs to be checked for
2360 * @return Array of Strings the array of groups allowed to edit this article
2362 public function getRestrictions( $action ) {
2363 if ( !$this->mRestrictionsLoaded
) {
2364 $this->loadRestrictions();
2366 return isset( $this->mRestrictions
[$action] )
2367 ?
$this->mRestrictions
[$action]
2372 * Get the expiry time for the restriction against a given action
2374 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2375 * or not protected at all, or false if the action is not recognised.
2377 public function getRestrictionExpiry( $action ) {
2378 if ( !$this->mRestrictionsLoaded
) {
2379 $this->loadRestrictions();
2381 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2385 * Is there a version of this page in the deletion archive?
2387 * @param $includeSuppressed Boolean Include suppressed revisions?
2388 * @return Int the number of archived revisions
2390 public function isDeleted( $includeSuppressed = false ) {
2391 if ( $this->getNamespace() < 0 ) {
2394 $dbr = wfGetDB( DB_SLAVE
);
2395 $conditions = array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() );
2397 if( !$includeSuppressed ) {
2398 $suppressedTextBits = Revision
::DELETED_TEXT | Revision
::DELETED_RESTRICTED
;
2399 $conditions[] = $dbr->bitAnd('ar_deleted', $suppressedTextBits ) .
2400 ' != ' . $suppressedTextBits;
2403 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2407 if ( $this->getNamespace() == NS_FILE
) {
2408 $fconditions = array( 'fa_name' => $this->getDBkey() );
2409 if( !$includeSuppressed ) {
2410 $suppressedTextBits = File
::DELETED_FILE | File
::DELETED_RESTRICTED
;
2411 $fconditions[] = $dbr->bitAnd('fa_deleted', $suppressedTextBits ) .
2412 ' != ' . $suppressedTextBits;
2415 $n +
= $dbr->selectField( 'filearchive',
2426 * Is there a version of this page in the deletion archive?
2430 public function isDeletedQuick() {
2431 if ( $this->getNamespace() < 0 ) {
2434 $dbr = wfGetDB( DB_SLAVE
);
2435 $deleted = (bool)$dbr->selectField( 'archive', '1',
2436 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2439 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2440 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2441 array( 'fa_name' => $this->getDBkey() ),
2449 * Get the article ID for this Title from the link cache,
2450 * adding it if necessary
2452 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2454 * @return Int the ID
2456 public function getArticleID( $flags = 0 ) {
2457 if ( $this->getNamespace() < 0 ) {
2458 return $this->mArticleID
= 0;
2460 $linkCache = LinkCache
::singleton();
2461 if ( $flags & self
::GAID_FOR_UPDATE
) {
2462 $oldUpdate = $linkCache->forUpdate( true );
2463 $linkCache->clearLink( $this );
2464 $this->mArticleID
= $linkCache->addLinkObj( $this );
2465 $linkCache->forUpdate( $oldUpdate );
2467 if ( -1 == $this->mArticleID
) {
2468 $this->mArticleID
= $linkCache->addLinkObj( $this );
2471 return $this->mArticleID
;
2475 * Is this an article that is a redirect page?
2476 * Uses link cache, adding it if necessary
2478 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2481 public function isRedirect( $flags = 0 ) {
2482 if ( !is_null( $this->mRedirect
) ) {
2483 return $this->mRedirect
;
2485 # Calling getArticleID() loads the field from cache as needed
2486 if ( !$this->getArticleID( $flags ) ) {
2487 return $this->mRedirect
= false;
2489 $linkCache = LinkCache
::singleton();
2490 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2492 return $this->mRedirect
;
2496 * What is the length of this page?
2497 * Uses link cache, adding it if necessary
2499 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2502 public function getLength( $flags = 0 ) {
2503 if ( $this->mLength
!= -1 ) {
2504 return $this->mLength
;
2506 # Calling getArticleID() loads the field from cache as needed
2507 if ( !$this->getArticleID( $flags ) ) {
2508 return $this->mLength
= 0;
2510 $linkCache = LinkCache
::singleton();
2511 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2513 return $this->mLength
;
2517 * What is the page_latest field for this page?
2519 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2520 * @return Int or 0 if the page doesn't exist
2522 public function getLatestRevID( $flags = 0 ) {
2523 if ( $this->mLatestID
!== false ) {
2524 return intval( $this->mLatestID
);
2526 # Calling getArticleID() loads the field from cache as needed
2527 if ( !$this->getArticleID( $flags ) ) {
2528 return $this->mLatestID
= 0;
2530 $linkCache = LinkCache
::singleton();
2531 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2533 return $this->mLatestID
;
2537 * This clears some fields in this object, and clears any associated
2538 * keys in the "bad links" section of the link cache.
2540 * - This is called from Article::doEdit() and Article::insertOn() to allow
2541 * loading of the new page_id. It's also called from
2542 * Article::doDeleteArticle()
2544 * @param $newid Int the new Article ID
2546 public function resetArticleID( $newid ) {
2547 $linkCache = LinkCache
::singleton();
2548 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2550 if ( $newid === false ) {
2551 $this->mArticleID
= -1;
2553 $this->mArticleID
= intval( $newid );
2555 $this->mRestrictionsLoaded
= false;
2556 $this->mRestrictions
= array();
2557 $this->mRedirect
= null;
2558 $this->mLength
= -1;
2559 $this->mLatestID
= false;
2563 * Updates page_touched for this page; called from LinksUpdate.php
2565 * @return Bool true if the update succeded
2567 public function invalidateCache() {
2568 if ( wfReadOnly() ) {
2571 $dbw = wfGetDB( DB_MASTER
);
2572 $success = $dbw->update(
2574 array( 'page_touched' => $dbw->timestamp() ),
2578 HTMLFileCache
::clearFileCache( $this );
2583 * Prefix some arbitrary text with the namespace or interwiki prefix
2586 * @param $name String the text
2587 * @return String the prefixed text
2590 private function prefix( $name ) {
2592 if ( $this->mInterwiki
!= '' ) {
2593 $p = $this->mInterwiki
. ':';
2596 if ( 0 != $this->mNamespace
) {
2597 $p .= $this->getNsText() . ':';
2603 * Returns a simple regex that will match on characters and sequences invalid in titles.
2604 * Note that this doesn't pick up many things that could be wrong with titles, but that
2605 * replacing this regex with something valid will make many titles valid.
2607 * @return String regex string
2609 static function getTitleInvalidRegex() {
2610 static $rxTc = false;
2612 # Matching titles will be held as illegal.
2614 # Any character not allowed is forbidden...
2615 '[^' . Title
::legalChars() . ']' .
2616 # URL percent encoding sequences interfere with the ability
2617 # to round-trip titles -- you can't link to them consistently.
2618 '|%[0-9A-Fa-f]{2}' .
2619 # XML/HTML character references produce similar issues.
2620 '|&[A-Za-z0-9\x80-\xff]+;' .
2622 '|&#x[0-9A-Fa-f]+;' .
2630 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2632 * @param $text String containing title to capitalize
2633 * @param $ns int namespace index, defaults to NS_MAIN
2634 * @return String containing capitalized title
2636 public static function capitalize( $text, $ns = NS_MAIN
) {
2639 if ( MWNamespace
::isCapitalized( $ns ) ) {
2640 return $wgContLang->ucfirst( $text );
2647 * Secure and split - main initialisation function for this object
2649 * Assumes that mDbkeyform has been set, and is urldecoded
2650 * and uses underscores, but not otherwise munged. This function
2651 * removes illegal characters, splits off the interwiki and
2652 * namespace prefixes, sets the other forms, and canonicalizes
2655 * @return Bool true on success
2657 private function secureAndSplit() {
2658 global $wgContLang, $wgLocalInterwiki;
2661 $this->mInterwiki
= $this->mFragment
= '';
2662 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2664 $dbkey = $this->mDbkeyform
;
2666 # Strip Unicode bidi override characters.
2667 # Sometimes they slip into cut-n-pasted page titles, where the
2668 # override chars get included in list displays.
2669 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2671 # Clean up whitespace
2672 # Note: use of the /u option on preg_replace here will cause
2673 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2674 # conveniently disabling them.
2675 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2676 $dbkey = trim( $dbkey, '_' );
2678 if ( $dbkey == '' ) {
2682 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2683 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2687 $this->mDbkeyform
= $dbkey;
2689 # Initial colon indicates main namespace rather than specified default
2690 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2691 if ( ':' == $dbkey[0] ) {
2692 $this->mNamespace
= NS_MAIN
;
2693 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2694 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2697 # Namespace or interwiki prefix
2699 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2702 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2704 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2705 # Ordinary namespace
2707 $this->mNamespace
= $ns;
2708 # For Talk:X pages, check if X has a "namespace" prefix
2709 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2710 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2711 # Disallow Talk:File:x type titles...
2713 } elseif ( Interwiki
::isValidInterwiki( $x[1] ) ) {
2714 # Disallow Talk:Interwiki:x type titles...
2718 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2719 if ( !$firstPass ) {
2720 # Can't make a local interwiki link to an interwiki link.
2721 # That's just crazy!
2727 $this->mInterwiki
= $wgContLang->lc( $p );
2729 # Redundant interwiki prefix to the local wiki
2730 if ( $wgLocalInterwiki !== false
2731 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
2733 if ( $dbkey == '' ) {
2734 # Can't have an empty self-link
2737 $this->mInterwiki
= '';
2739 # Do another namespace split...
2743 # If there's an initial colon after the interwiki, that also
2744 # resets the default namespace
2745 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2746 $this->mNamespace
= NS_MAIN
;
2747 $dbkey = substr( $dbkey, 1 );
2750 # If there's no recognized interwiki or namespace,
2751 # then let the colon expression be part of the title.
2756 # We already know that some pages won't be in the database!
2757 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
2758 $this->mArticleID
= 0;
2760 $fragment = strstr( $dbkey, '#' );
2761 if ( false !== $fragment ) {
2762 $this->setFragment( $fragment );
2763 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2764 # remove whitespace again: prevents "Foo_bar_#"
2765 # becoming "Foo_bar_"
2766 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2769 # Reject illegal characters.
2770 $rxTc = self
::getTitleInvalidRegex();
2771 if ( preg_match( $rxTc, $dbkey ) ) {
2775 # Pages with "/./" or "/../" appearing in the URLs will often be un-
2776 # reachable due to the way web browsers deal with 'relative' URLs.
2777 # Also, they conflict with subpage syntax. Forbid them explicitly.
2778 if ( strpos( $dbkey, '.' ) !== false &&
2779 ( $dbkey === '.' ||
$dbkey === '..' ||
2780 strpos( $dbkey, './' ) === 0 ||
2781 strpos( $dbkey, '../' ) === 0 ||
2782 strpos( $dbkey, '/./' ) !== false ||
2783 strpos( $dbkey, '/../' ) !== false ||
2784 substr( $dbkey, -2 ) == '/.' ||
2785 substr( $dbkey, -3 ) == '/..' ) )
2790 # Magic tilde sequences? Nu-uh!
2791 if ( strpos( $dbkey, '~~~' ) !== false ) {
2795 # Limit the size of titles to 255 bytes. This is typically the size of the
2796 # underlying database field. We make an exception for special pages, which
2797 # don't need to be stored in the database, and may edge over 255 bytes due
2798 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
2799 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2800 strlen( $dbkey ) > 512 )
2805 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
2806 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
2807 # other site might be case-sensitive.
2808 $this->mUserCaseDBKey
= $dbkey;
2809 if ( $this->mInterwiki
== '' ) {
2810 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
2813 # Can't make a link to a namespace alone... "empty" local links can only be
2814 # self-links with a fragment identifier.
2815 if ( $dbkey == '' && $this->mInterwiki
== '' && $this->mNamespace
!= NS_MAIN
) {
2819 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2820 // IP names are not allowed for accounts, and can only be referring to
2821 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2822 // there are numerous ways to present the same IP. Having sp:contribs scan
2823 // them all is silly and having some show the edits and others not is
2824 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2825 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
)
2826 ? IP
::sanitizeIP( $dbkey )
2829 // Any remaining initial :s are illegal.
2830 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2835 $this->mDbkeyform
= $dbkey;
2836 $this->mUrlform
= wfUrlencode( $dbkey );
2838 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2844 * Set the fragment for this title. Removes the first character from the
2845 * specified fragment before setting, so it assumes you're passing it with
2848 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2849 * Still in active use privately.
2851 * @param $fragment String text
2853 public function setFragment( $fragment ) {
2854 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2857 public function setInterwiki( $interwiki ) {
2858 $this->mInterwiki
= $interwiki;
2862 * Get a Title object associated with the talk page of this article
2864 * @return Title the object for the talk page
2866 public function getTalkPage() {
2867 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2871 * Get a title object associated with the subject page of this
2874 * @return Title the object for the subject page
2876 public function getSubjectPage() {
2877 // Is this the same title?
2878 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2879 if ( $this->getNamespace() == $subjectNS ) {
2882 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2886 * Get an array of Title objects linking to this Title
2887 * Also stores the IDs in the link cache.
2889 * WARNING: do not use this function on arbitrary user-supplied titles!
2890 * On heavily-used templates it will max out the memory.
2892 * @param $options Array: may be FOR UPDATE
2893 * @param $table String: table name
2894 * @param $prefix String: fields prefix
2895 * @return Array of Title objects linking here
2897 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2898 $linkCache = LinkCache
::singleton();
2900 if ( count( $options ) > 0 ) {
2901 $db = wfGetDB( DB_MASTER
);
2903 $db = wfGetDB( DB_SLAVE
);
2907 array( 'page', $table ),
2908 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2910 "{$prefix}_from=page_id",
2911 "{$prefix}_namespace" => $this->getNamespace(),
2912 "{$prefix}_title" => $this->getDBkey() ),
2918 if ( $db->numRows( $res ) ) {
2919 foreach ( $res as $row ) {
2920 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
2922 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
, $row->page_latest
);
2923 $retVal[] = $titleObj;
2931 * Get an array of Title objects using this Title as a template
2932 * Also stores the IDs in the link cache.
2934 * WARNING: do not use this function on arbitrary user-supplied titles!
2935 * On heavily-used templates it will max out the memory.
2937 * @param $options Array: may be FOR UPDATE
2938 * @return Array of Title the Title objects linking here
2940 public function getTemplateLinksTo( $options = array() ) {
2941 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2945 * Get an array of Title objects referring to non-existent articles linked from this page
2947 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2948 * @return Array of Title the Title objects
2950 public function getBrokenLinksFrom() {
2951 if ( $this->getArticleId() == 0 ) {
2952 # All links from article ID 0 are false positives
2956 $dbr = wfGetDB( DB_SLAVE
);
2957 $res = $dbr->select(
2958 array( 'page', 'pagelinks' ),
2959 array( 'pl_namespace', 'pl_title' ),
2961 'pl_from' => $this->getArticleId(),
2962 'page_namespace IS NULL'
2964 __METHOD__
, array(),
2968 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2974 foreach ( $res as $row ) {
2975 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2982 * Get a list of URLs to purge from the Squid cache when this
2985 * @return Array of String the URLs
2987 public function getSquidURLs() {
2991 $this->getInternalURL(),
2992 $this->getInternalURL( 'action=history' )
2995 // purge variant urls as well
2996 if ( $wgContLang->hasVariants() ) {
2997 $variants = $wgContLang->getVariants();
2998 foreach ( $variants as $vCode ) {
2999 $urls[] = $this->getInternalURL( '', $vCode );
3007 * Purge all applicable Squid URLs
3009 public function purgeSquid() {
3011 if ( $wgUseSquid ) {
3012 $urls = $this->getSquidURLs();
3013 $u = new SquidUpdate( $urls );
3019 * Move this page without authentication
3021 * @param $nt Title the new page Title
3022 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3024 public function moveNoAuth( &$nt ) {
3025 return $this->moveTo( $nt, false );
3029 * Check whether a given move operation would be valid.
3030 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3032 * @param $nt Title the new title
3033 * @param $auth Bool indicates whether $wgUser's permissions
3035 * @param $reason String is the log summary of the move, used for spam checking
3036 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3038 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3043 // Normally we'd add this to $errors, but we'll get
3044 // lots of syntax errors if $nt is not an object
3045 return array( array( 'badtitletext' ) );
3047 if ( $this->equals( $nt ) ) {
3048 $errors[] = array( 'selfmove' );
3050 if ( !$this->isMovable() ) {
3051 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3053 if ( $nt->getInterwiki() != '' ) {
3054 $errors[] = array( 'immobile-target-namespace-iw' );
3056 if ( !$nt->isMovable() ) {
3057 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3060 $oldid = $this->getArticleID();
3061 $newid = $nt->getArticleID();
3063 if ( strlen( $nt->getDBkey() ) < 1 ) {
3064 $errors[] = array( 'articleexists' );
3066 if ( ( $this->getDBkey() == '' ) ||
3068 ( $nt->getDBkey() == '' ) ) {
3069 $errors[] = array( 'badarticleerror' );
3072 // Image-specific checks
3073 if ( $this->getNamespace() == NS_FILE
) {
3074 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3077 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3078 $errors[] = array( 'nonfile-cannot-move-to-file' );
3082 $errors = wfMergeErrorArrays( $errors,
3083 $this->getUserPermissionsErrors( 'move', $wgUser ),
3084 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3085 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3086 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3089 $match = EditPage
::matchSummarySpamRegex( $reason );
3090 if ( $match !== false ) {
3091 // This is kind of lame, won't display nice
3092 $errors[] = array( 'spamprotectiontext' );
3096 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3097 $errors[] = array( 'hookaborted', $err );
3100 # The move is allowed only if (1) the target doesn't exist, or
3101 # (2) the target is a redirect to the source, and has no history
3102 # (so we can undo bad moves right after they're done).
3104 if ( 0 != $newid ) { # Target exists; check for validity
3105 if ( !$this->isValidMoveTarget( $nt ) ) {
3106 $errors[] = array( 'articleexists' );
3109 $tp = $nt->getTitleProtection();
3110 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3111 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3112 $errors[] = array( 'cantmove-titleprotected' );
3115 if ( empty( $errors ) ) {
3122 * Check if the requested move target is a valid file move target
3123 * @param Title $nt Target title
3124 * @return array List of errors
3126 protected function validateFileMoveOperation( $nt ) {
3131 if ( $nt->getNamespace() != NS_FILE
) {
3132 $errors[] = array( 'imagenocrossnamespace' );
3135 $file = wfLocalFile( $this );
3136 if ( $file->exists() ) {
3137 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3138 $errors[] = array( 'imageinvalidfilename' );
3140 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3141 $errors[] = array( 'imagetypemismatch' );
3145 $destFile = wfLocalFile( $nt );
3146 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3147 $errors[] = array( 'file-exists-sharedrepo' );
3154 * Move a title to a new location
3156 * @param $nt Title the new title
3157 * @param $auth Bool indicates whether $wgUser's permissions
3159 * @param $reason String the reason for the move
3160 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3161 * Ignored if the user doesn't have the suppressredirect right.
3162 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3164 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3165 global $wgContLang, $wgEnableInterwikiTemplatesTracking, $wgGlobalDatabase;
3167 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3168 if ( is_array( $err ) ) {
3172 // If it is a file, move it first. It is done before all other moving stuff is
3173 // done because it's hard to revert
3174 $dbw = wfGetDB( DB_MASTER
);
3175 if ( $this->getNamespace() == NS_FILE
) {
3176 $file = wfLocalFile( $this );
3177 if ( $file->exists() ) {
3178 $status = $file->move( $nt );
3179 if ( !$status->isOk() ) {
3180 return $status->getErrorsArray();
3185 $dbw->begin(); # If $file was a LocalFile, its transaction would have closed our own.
3186 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3187 $protected = $this->isProtected();
3188 $pageCountChange = ( $createRedirect ?
1 : 0 ) - ( $nt->exists() ?
1 : 0 );
3190 // Do the actual move
3191 $err = $this->moveToInternal( $nt, $reason, $createRedirect );
3192 if ( is_array( $err ) ) {
3193 # @todo FIXME: What about the File we have already moved?
3198 $redirid = $this->getArticleID();
3200 // Refresh the sortkey for this row. Be careful to avoid resetting
3201 // cl_timestamp, which may disturb time-based lists on some sites.
3202 $prefixes = $dbw->select(
3204 array( 'cl_sortkey_prefix', 'cl_to' ),
3205 array( 'cl_from' => $pageid ),
3208 foreach ( $prefixes as $prefixRow ) {
3209 $prefix = $prefixRow->cl_sortkey_prefix
;
3210 $catTo = $prefixRow->cl_to
;
3211 $dbw->update( 'categorylinks',
3213 'cl_sortkey' => Collation
::singleton()->getSortKey(
3214 $nt->getCategorySortkey( $prefix ) ),
3215 'cl_timestamp=cl_timestamp' ),
3217 'cl_from' => $pageid,
3218 'cl_to' => $catTo ),
3223 if ( $wgEnableInterwikiTemplatesTracking && $wgGlobalDatabase ) {
3224 $dbw2 = wfGetDB( DB_MASTER
, array(), $wgGlobalDatabase );
3225 $dbw2->update( 'globaltemplatelinks',
3226 array( 'gtl_from_namespace' => $nt->getNamespace(),
3227 'gtl_from_title' => $nt->getText() ),
3228 array ( 'gtl_from_page' => $pageid ),
3233 # Protect the redirect title as the title used to be...
3234 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3236 'pr_page' => $redirid,
3237 'pr_type' => 'pr_type',
3238 'pr_level' => 'pr_level',
3239 'pr_cascade' => 'pr_cascade',
3240 'pr_user' => 'pr_user',
3241 'pr_expiry' => 'pr_expiry'
3243 array( 'pr_page' => $pageid ),
3247 # Update the protection log
3248 $log = new LogPage( 'protect' );
3249 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3251 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3253 // @todo FIXME: $params?
3254 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3258 $oldnamespace = $this->getNamespace() & ~
1;
3259 $newnamespace = $nt->getNamespace() & ~
1;
3260 $oldtitle = $this->getDBkey();
3261 $newtitle = $nt->getDBkey();
3263 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3264 WatchedItem
::duplicateEntries( $this, $nt );
3267 # Update search engine
3268 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3270 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3276 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3277 # No longer a content page
3278 # Not viewed, edited, removing
3279 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3280 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3281 # Now a content page
3282 # Not viewed, edited, adding
3283 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
3284 } elseif ( $pageCountChange ) {
3286 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3295 # Update message cache for interface messages
3296 if ( $this->getNamespace() == NS_MEDIAWIKI
) {
3297 # @bug 17860: old article can be deleted, if this the case,
3298 # delete it from message cache
3299 if ( $this->getArticleID() === 0 ) {
3300 MessageCache
::singleton()->replace( $this->getDBkey(), false );
3302 $oldarticle = new Article( $this );
3303 MessageCache
::singleton()->replace( $this->getDBkey(), $oldarticle->getContent() );
3306 if ( $nt->getNamespace() == NS_MEDIAWIKI
) {
3307 $newarticle = new Article( $nt );
3308 MessageCache
::singleton()->replace( $nt->getDBkey(), $newarticle->getContent() );
3312 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3317 * Move page to a title which is either a redirect to the
3318 * source page or nonexistent
3320 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3321 * @param $reason String The reason for the move
3322 * @param $createRedirect Bool Whether to leave a redirect at the old title. Ignored
3323 * if the user doesn't have the suppressredirect right
3325 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
3326 global $wgUseSquid, $wgUser, $wgContLang, $wgEnableInterwikiTemplatesTracking, $wgGlobalDatabase;
3328 $moveOverRedirect = $nt->exists();
3330 $commentMsg = ( $moveOverRedirect ?
'1movedto2_redir' : '1movedto2' );
3331 $comment = wfMsgForContent( $commentMsg, $this->getPrefixedText(), $nt->getPrefixedText() );
3334 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3336 # Truncate for whole multibyte characters.
3337 $comment = $wgContLang->truncate( $comment, 255 );
3339 $oldid = $this->getArticleID();
3340 $latest = $this->getLatestRevID();
3342 $dbw = wfGetDB( DB_MASTER
);
3344 if ( $moveOverRedirect ) {
3345 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3347 $newid = $nt->getArticleID();
3348 $newns = $nt->getNamespace();
3349 $newdbk = $nt->getDBkey();
3351 # Delete the old redirect. We don't save it to history since
3352 # by definition if we've got here it's rather uninteresting.
3353 # We have to remove it so that the next step doesn't trigger
3354 # a conflict on the unique namespace+title index...
3355 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3356 if ( !$dbw->cascadingDeletes() ) {
3357 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
3358 global $wgUseTrackbacks;
3359 if ( $wgUseTrackbacks ) {
3360 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
3362 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3363 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
3364 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
3365 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
3366 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
3367 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
3368 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
3369 $dbw->delete( 'page_props', array( 'pp_page' => $newid ), __METHOD__
);
3371 // If the target page was recently created, it may have an entry in recentchanges still
3372 $dbw->delete( 'recentchanges',
3373 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3377 if ( $wgEnableInterwikiTemplatesTracking && $wgGlobalDatabase ) {
3378 $dbw2 = wfGetDB( DB_MASTER
, array(), $wgGlobalDatabase );
3379 $dbw2->delete( 'globaltemplatelinks',
3380 array( 'gtl_from_wiki' => wfGetID(),
3381 'gtl_from_page' => $newid ),
3386 # Save a null revision in the page's history notifying of the move
3387 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3388 if ( !is_object( $nullRevision ) ) {
3389 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3391 $nullRevId = $nullRevision->insertOn( $dbw );
3393 $now = wfTimestampNow();
3394 # Change the name of the target page:
3395 $dbw->update( 'page',
3397 'page_touched' => $dbw->timestamp( $now ),
3398 'page_namespace' => $nt->getNamespace(),
3399 'page_title' => $nt->getDBkey(),
3400 'page_latest' => $nullRevId,
3402 /* WHERE */ array( 'page_id' => $oldid ),
3405 $nt->resetArticleID( $oldid );
3407 $article = new Article( $nt );
3408 wfRunHooks( 'NewRevisionFromEditComplete',
3409 array( $article, $nullRevision, $latest, $wgUser ) );
3410 $article->setCachedLastEditTime( $now );
3412 # Recreate the redirect, this time in the other direction.
3413 if ( $createRedirect ||
!$wgUser->isAllowed( 'suppressredirect' ) ) {
3414 $mwRedir = MagicWord
::get( 'redirect' );
3415 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3416 $redirectArticle = new Article( $this );
3417 $newid = $redirectArticle->insertOn( $dbw );
3418 if ( $newid ) { // sanity
3419 $redirectRevision = new Revision( array(
3421 'comment' => $comment,
3422 'text' => $redirectText ) );
3423 $redirectRevision->insertOn( $dbw );
3424 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3426 wfRunHooks( 'NewRevisionFromEditComplete',
3427 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3429 # Now, we record the link from the redirect to the new title.
3430 # It should have no other outgoing links...
3431 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3432 $dbw->insert( 'pagelinks',
3434 'pl_from' => $newid,
3435 'pl_namespace' => $nt->getNamespace(),
3436 'pl_title' => $nt->getDBkey() ),
3439 $redirectSuppressed = false;
3441 $this->resetArticleID( 0 );
3442 $redirectSuppressed = true;
3446 $log = new LogPage( 'move' );
3447 $logType = ( $moveOverRedirect ?
'move_redir' : 'move' );
3448 $log->addEntry( $logType, $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3450 # Purge caches for old and new titles
3451 if ( $moveOverRedirect ) {
3452 # A simple purge is enough when moving over a redirect
3455 # Purge caches as per article creation, including any pages that link to this title
3456 Article
::onArticleCreate( $nt );
3458 $this->purgeSquid();
3462 * Move this page's subpages to be subpages of $nt
3464 * @param $nt Title Move target
3465 * @param $auth bool Whether $wgUser's permissions should be checked
3466 * @param $reason string The reason for the move
3467 * @param $createRedirect bool Whether to create redirects from the old subpages to
3468 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3469 * @return mixed array with old page titles as keys, and strings (new page titles) or
3470 * arrays (errors) as values, or an error array with numeric indices if no pages
3473 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3474 global $wgMaximumMovedPages;
3475 // Check permissions
3476 if ( !$this->userCan( 'move-subpages' ) ) {
3477 return array( 'cant-move-subpages' );
3479 // Do the source and target namespaces support subpages?
3480 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3481 return array( 'namespace-nosubpages',
3482 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3484 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3485 return array( 'namespace-nosubpages',
3486 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3489 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3492 foreach ( $subpages as $oldSubpage ) {
3494 if ( $count > $wgMaximumMovedPages ) {
3495 $retval[$oldSubpage->getPrefixedTitle()] =
3496 array( 'movepage-max-pages',
3497 $wgMaximumMovedPages );
3501 // We don't know whether this function was called before
3502 // or after moving the root page, so check both
3504 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3505 $oldSubpage->getArticleID() == $nt->getArticleId() )
3507 // When moving a page to a subpage of itself,
3508 // don't move it twice
3511 $newPageName = preg_replace(
3512 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3513 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3514 $oldSubpage->getDBkey() );
3515 if ( $oldSubpage->isTalkPage() ) {
3516 $newNs = $nt->getTalkPage()->getNamespace();
3518 $newNs = $nt->getSubjectPage()->getNamespace();
3520 # Bug 14385: we need makeTitleSafe because the new page names may
3521 # be longer than 255 characters.
3522 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3524 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3525 if ( $success === true ) {
3526 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3528 $retval[$oldSubpage->getPrefixedText()] = $success;
3535 * Checks if this page is just a one-rev redirect.
3536 * Adds lock, so don't use just for light purposes.
3540 public function isSingleRevRedirect() {
3541 $dbw = wfGetDB( DB_MASTER
);
3543 $row = $dbw->selectRow( 'page',
3544 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3547 array( 'FOR UPDATE' )
3549 # Cache some fields we may want
3550 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3551 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3552 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3553 if ( !$this->mRedirect
) {
3556 # Does the article have a history?
3557 $row = $dbw->selectField( array( 'page', 'revision' ),
3559 array( 'page_namespace' => $this->getNamespace(),
3560 'page_title' => $this->getDBkey(),
3562 'page_latest != rev_id'
3565 array( 'FOR UPDATE' )
3567 # Return true if there was no history
3568 return ( $row === false );
3572 * Checks if $this can be moved to a given Title
3573 * - Selects for update, so don't call it unless you mean business
3575 * @param $nt Title the new title to check
3578 public function isValidMoveTarget( $nt ) {
3579 # Is it an existing file?
3580 if ( $nt->getNamespace() == NS_FILE
) {
3581 $file = wfLocalFile( $nt );
3582 if ( $file->exists() ) {
3583 wfDebug( __METHOD__
. ": file exists\n" );
3587 # Is it a redirect with no history?
3588 if ( !$nt->isSingleRevRedirect() ) {
3589 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3592 # Get the article text
3593 $rev = Revision
::newFromTitle( $nt );
3594 $text = $rev->getText();
3595 # Does the redirect point to the source?
3596 # Or is it a broken self-redirect, usually caused by namespace collisions?
3598 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3599 $redirTitle = Title
::newFromText( $m[1] );
3600 if ( !is_object( $redirTitle ) ||
3601 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3602 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3603 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3608 wfDebug( __METHOD__
. ": failsafe\n" );
3615 * Can this title be added to a user's watchlist?
3617 * @return Bool TRUE or FALSE
3619 public function isWatchable() {
3620 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3624 * Get categories to which this Title belongs and return an array of
3625 * categories' names.
3627 * @return Array of parents in the form:
3628 * $parent => $currentarticle
3630 public function getParentCategories() {
3635 $titleKey = $this->getArticleId();
3637 if ( $titleKey === 0 ) {
3641 $dbr = wfGetDB( DB_SLAVE
);
3643 $res = $dbr->select( 'categorylinks', '*',
3645 'cl_from' => $titleKey,
3651 if ( $dbr->numRows( $res ) > 0 ) {
3652 foreach ( $res as $row ) {
3653 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3654 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3661 * Get a tree of parent categories
3663 * @param $children Array with the children in the keys, to check for circular refs
3664 * @return Array Tree of parent categories
3666 public function getParentCategoryTree( $children = array() ) {
3668 $parents = $this->getParentCategories();
3671 foreach ( $parents as $parent => $current ) {
3672 if ( array_key_exists( $parent, $children ) ) {
3673 # Circular reference
3674 $stack[$parent] = array();
3676 $nt = Title
::newFromText( $parent );
3678 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3688 * Get an associative array for selecting this title from
3691 * @return Array suitable for the $where parameter of DB::select()
3693 public function pageCond() {
3694 if ( $this->mArticleID
> 0 ) {
3695 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3696 return array( 'page_id' => $this->mArticleID
);
3698 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3703 * Get the revision ID of the previous revision
3705 * @param $revId Int Revision ID. Get the revision that was before this one.
3706 * @param $flags Int Title::GAID_FOR_UPDATE
3707 * @return Int|Bool Old revision ID, or FALSE if none exists
3709 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3710 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3711 return $db->selectField( 'revision', 'rev_id',
3713 'rev_page' => $this->getArticleId( $flags ),
3714 'rev_id < ' . intval( $revId )
3717 array( 'ORDER BY' => 'rev_id DESC' )
3722 * Get the revision ID of the next revision
3724 * @param $revId Int Revision ID. Get the revision that was after this one.
3725 * @param $flags Int Title::GAID_FOR_UPDATE
3726 * @return Int|Bool Next revision ID, or FALSE if none exists
3728 public function getNextRevisionID( $revId, $flags = 0 ) {
3729 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3730 return $db->selectField( 'revision', 'rev_id',
3732 'rev_page' => $this->getArticleId( $flags ),
3733 'rev_id > ' . intval( $revId )
3736 array( 'ORDER BY' => 'rev_id' )
3741 * Get the first revision of the page
3743 * @param $flags Int Title::GAID_FOR_UPDATE
3744 * @return Revision|Null if page doesn't exist
3746 public function getFirstRevision( $flags = 0 ) {
3747 $pageId = $this->getArticleId( $flags );
3749 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3750 $row = $db->selectRow( 'revision', '*',
3751 array( 'rev_page' => $pageId ),
3753 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3756 return new Revision( $row );
3763 * Get the oldest revision timestamp of this page
3765 * @param $flags Int Title::GAID_FOR_UPDATE
3766 * @return String: MW timestamp
3768 public function getEarliestRevTime( $flags = 0 ) {
3769 $rev = $this->getFirstRevision( $flags );
3770 return $rev ?
$rev->getTimestamp() : null;
3774 * Check if this is a new page
3778 public function isNewPage() {
3779 $dbr = wfGetDB( DB_SLAVE
);
3780 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3784 * Get the number of revisions between the given revision.
3785 * Used for diffs and other things that really need it.
3787 * @param $old int|Revision Old revision or rev ID (first before range)
3788 * @param $new int|Revision New revision or rev ID (first after range)
3789 * @return Int Number of revisions between these revisions.
3791 public function countRevisionsBetween( $old, $new ) {
3792 if ( !( $old instanceof Revision
) ) {
3793 $old = Revision
::newFromTitle( $this, (int)$old );
3795 if ( !( $new instanceof Revision
) ) {
3796 $new = Revision
::newFromTitle( $this, (int)$new );
3798 if ( !$old ||
!$new ) {
3799 return 0; // nothing to compare
3801 $dbr = wfGetDB( DB_SLAVE
);
3802 return (int)$dbr->selectField( 'revision', 'count(*)',
3804 'rev_page' => $this->getArticleId(),
3805 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3806 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3813 * Get the number of authors between the given revision IDs.
3814 * Used for diffs and other things that really need it.
3816 * @param $old int|Revision Old revision or rev ID (first before range)
3817 * @param $new int|Revision New revision or rev ID (first after range)
3818 * @param $limit Int Maximum number of authors
3819 * @return Int Number of revision authors between these revisions.
3821 public function countAuthorsBetween( $old, $new, $limit ) {
3822 if ( !( $old instanceof Revision
) ) {
3823 $old = Revision
::newFromTitle( $this, (int)$old );
3825 if ( !( $new instanceof Revision
) ) {
3826 $new = Revision
::newFromTitle( $this, (int)$new );
3828 if ( !$old ||
!$new ) {
3829 return 0; // nothing to compare
3831 $dbr = wfGetDB( DB_SLAVE
);
3832 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
3834 'rev_page' => $this->getArticleID(),
3835 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3836 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3838 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
3840 return (int)$dbr->numRows( $res );
3844 * Compare with another title.
3846 * @param $title Title
3849 public function equals( Title
$title ) {
3850 // Note: === is necessary for proper matching of number-like titles.
3851 return $this->getInterwiki() === $title->getInterwiki()
3852 && $this->getNamespace() == $title->getNamespace()
3853 && $this->getDBkey() === $title->getDBkey();
3857 * Callback for usort() to do title sorts by (namespace, title)
3862 * @return Integer: result of string comparison, or namespace comparison
3864 public static function compare( $a, $b ) {
3865 if ( $a->getNamespace() == $b->getNamespace() ) {
3866 return strcmp( $a->getText(), $b->getText() );
3868 return $a->getNamespace() - $b->getNamespace();
3873 * Return a string representation of this title
3875 * @return String representation of this title
3877 public function __toString() {
3878 return $this->getPrefixedText();
3882 * Check if page exists. For historical reasons, this function simply
3883 * checks for the existence of the title in the page table, and will
3884 * thus return false for interwiki links, special pages and the like.
3885 * If you want to know if a title can be meaningfully viewed, you should
3886 * probably call the isKnown() method instead.
3890 public function exists() {
3891 return $this->getArticleId() != 0;
3895 * Should links to this title be shown as potentially viewable (i.e. as
3896 * "bluelinks"), even if there's no record by this title in the page
3899 * This function is semi-deprecated for public use, as well as somewhat
3900 * misleadingly named. You probably just want to call isKnown(), which
3901 * calls this function internally.
3903 * (ISSUE: Most of these checks are cheap, but the file existence check
3904 * can potentially be quite expensive. Including it here fixes a lot of
3905 * existing code, but we might want to add an optional parameter to skip
3906 * it and any other expensive checks.)
3910 public function isAlwaysKnown() {
3911 if ( $this->mInterwiki
!= '' ) {
3912 return true; // any interwiki link might be viewable, for all we know
3914 switch( $this->mNamespace
) {
3917 // file exists, possibly in a foreign repo
3918 return (bool)wfFindFile( $this );
3920 // valid special page
3921 return SpecialPageFactory
::exists( $this->getDBkey() );
3923 // selflink, possibly with fragment
3924 return $this->mDbkeyform
== '';
3926 // known system message
3927 return $this->getDefaultMessageText() !== false;
3934 * Does this title refer to a page that can (or might) be meaningfully
3935 * viewed? In particular, this function may be used to determine if
3936 * links to the title should be rendered as "bluelinks" (as opposed to
3937 * "redlinks" to non-existent pages).
3941 public function isKnown() {
3942 return $this->isAlwaysKnown() ||
$this->exists();
3946 * Does this page have source text?
3950 public function hasSourceText() {
3951 if ( $this->exists() ) {
3955 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
3956 // If the page doesn't exist but is a known system message, default
3957 // message content will be displayed, same for language subpages
3958 return $this->getDefaultMessageText() !== false;
3965 * Get the default message text or false if the message doesn't exist
3967 * @return String or false
3969 public function getDefaultMessageText() {
3972 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
3976 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
3977 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
3979 if ( $message->exists() ) {
3980 return $message->plain();
3987 * Is this in a namespace that allows actual pages?
3990 * @internal note -- uses hardcoded namespace index instead of constants
3992 public function canExist() {
3993 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3997 * Update page_touched timestamps and send squid purge messages for
3998 * pages linking to this title. May be sent to the job queue depending
3999 * on the number of links. Typically called on create and delete.
4001 public function touchLinks() {
4002 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4005 if ( $this->getNamespace() == NS_CATEGORY
) {
4006 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4012 * Get the last touched timestamp
4014 * @param $db DatabaseBase: optional db
4015 * @return String last-touched timestamp
4017 public function getTouched( $db = null ) {
4018 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
4019 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4024 * Get the timestamp when this page was updated since the user last saw it.
4027 * @return String|Null
4029 public function getNotificationTimestamp( $user = null ) {
4030 global $wgUser, $wgShowUpdatedMarker;
4031 // Assume current user if none given
4035 // Check cache first
4036 $uid = $user->getId();
4037 // avoid isset here, as it'll return false for null entries
4038 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4039 return $this->mNotificationTimestamp
[$uid];
4041 if ( !$uid ||
!$wgShowUpdatedMarker ) {
4042 return $this->mNotificationTimestamp
[$uid] = false;
4044 // Don't cache too much!
4045 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4046 $this->mNotificationTimestamp
= array();
4048 $dbr = wfGetDB( DB_SLAVE
);
4049 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4050 'wl_notificationtimestamp',
4051 array( 'wl_namespace' => $this->getNamespace(),
4052 'wl_title' => $this->getDBkey(),
4053 'wl_user' => $user->getId()
4057 return $this->mNotificationTimestamp
[$uid];
4061 * Get the trackback URL for this page
4063 * @return String Trackback URL
4065 public function trackbackURL() {
4066 global $wgScriptPath, $wgServer, $wgScriptExtension;
4068 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
4069 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
4073 * Get the trackback RDF for this page
4075 * @return String Trackback RDF
4077 public function trackbackRDF() {
4078 $url = htmlspecialchars( $this->getFullURL() );
4079 $title = htmlspecialchars( $this->getText() );
4080 $tburl = $this->trackbackURL();
4082 // Autodiscovery RDF is placed in comments so HTML validator
4083 // won't barf. This is a rather icky workaround, but seems
4084 // frequently used by this kind of RDF thingy.
4086 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
4088 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
4089 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
4090 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
4093 dc:identifier=\"$url\"
4095 trackback:ping=\"$tburl\" />
4101 * Generate strings used for xml 'id' names in monobook tabs
4103 * @param $prepend string defaults to 'nstab-'
4104 * @return String XML 'id' name
4106 public function getNamespaceKey( $prepend = 'nstab-' ) {
4108 // Gets the subject namespace if this title
4109 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4110 // Checks if cononical namespace name exists for namespace
4111 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4112 // Uses canonical namespace name
4113 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4115 // Uses text of namespace
4116 $namespaceKey = $this->getSubjectNsText();
4118 // Makes namespace key lowercase
4119 $namespaceKey = $wgContLang->lc( $namespaceKey );
4121 if ( $namespaceKey == '' ) {
4122 $namespaceKey = 'main';
4124 // Changes file to image for backwards compatibility
4125 if ( $namespaceKey == 'file' ) {
4126 $namespaceKey = 'image';
4128 return $prepend . $namespaceKey;
4132 * Returns true if this is a special page.
4136 public function isSpecialPage() {
4137 return $this->getNamespace() == NS_SPECIAL
;
4141 * Returns true if this title resolves to the named special page
4143 * @param $name String The special page name
4146 public function isSpecial( $name ) {
4147 if ( $this->getNamespace() == NS_SPECIAL
) {
4148 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
4149 if ( $name == $thisName ) {
4157 * If the Title refers to a special page alias which is not the local default, resolve
4158 * the alias, and localise the name as necessary. Otherwise, return $this
4162 public function fixSpecialName() {
4163 if ( $this->getNamespace() == NS_SPECIAL
) {
4164 list( $canonicalName, /*...*/ ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
4165 if ( $canonicalName ) {
4166 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName );
4167 if ( $localName != $this->mDbkeyform
) {
4168 return Title
::makeTitle( NS_SPECIAL
, $localName );
4176 * Is this Title in a namespace which contains content?
4177 * In other words, is this a content page, for the purposes of calculating
4182 public function isContentPage() {
4183 return MWNamespace
::isContent( $this->getNamespace() );
4187 * Get all extant redirects to this Title
4189 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4190 * @return Array of Title redirects to this title
4192 public function getRedirectsHere( $ns = null ) {
4195 $dbr = wfGetDB( DB_SLAVE
);
4197 'rd_namespace' => $this->getNamespace(),
4198 'rd_title' => $this->getDBkey(),
4201 if ( !is_null( $ns ) ) {
4202 $where['page_namespace'] = $ns;
4205 $res = $dbr->select(
4206 array( 'redirect', 'page' ),
4207 array( 'page_namespace', 'page_title' ),
4212 foreach ( $res as $row ) {
4213 $redirs[] = self
::newFromRow( $row );
4219 * Check if this Title is a valid redirect target
4223 public function isValidRedirectTarget() {
4224 global $wgInvalidRedirectTargets;
4226 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4227 if ( $this->isSpecial( 'Userlogout' ) ) {
4231 foreach ( $wgInvalidRedirectTargets as $target ) {
4232 if ( $this->isSpecial( $target ) ) {
4241 * Get a backlink cache object
4243 * @return object BacklinkCache
4245 function getBacklinkCache() {
4246 if ( is_null( $this->mBacklinkCache
) ) {
4247 $this->mBacklinkCache
= new BacklinkCache( $this );
4249 return $this->mBacklinkCache
;
4253 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4257 public function canUseNoindex() {
4258 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4260 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4261 ?
$wgContentNamespaces
4262 : $wgExemptFromUserRobotsControl;
4264 return !in_array( $this->mNamespace
, $bannedNamespaces );
4269 * Returns restriction types for the current Title
4271 * @return array applicable restriction types
4273 public function getRestrictionTypes() {
4274 if ( $this->getNamespace() == NS_SPECIAL
) {
4278 $types = self
::getFilteredRestrictionTypes( $this->exists() );
4280 if ( $this->getNamespace() != NS_FILE
) {
4281 # Remove the upload restriction for non-file titles
4282 $types = array_diff( $types, array( 'upload' ) );
4285 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
4287 wfDebug( __METHOD__
. ': applicable restriction types for ' .
4288 $this->getPrefixedText() . ' are ' . implode( ',', $types ) . "\n" );
4293 * Get a filtered list of all restriction types supported by this wiki.
4294 * @param bool $exists True to get all restriction types that apply to
4295 * titles that do exist, False for all restriction types that apply to
4296 * titles that do not exist
4299 public static function getFilteredRestrictionTypes( $exists = true ) {
4300 global $wgRestrictionTypes;
4301 $types = $wgRestrictionTypes;
4303 # Remove the create restriction for existing titles
4304 $types = array_diff( $types, array( 'create' ) );
4306 # Only the create and upload restrictions apply to non-existing titles
4307 $types = array_intersect( $types, array( 'create', 'upload' ) );
4313 * Returns the raw sort key to be used for categories, with the specified
4314 * prefix. This will be fed to Collation::getSortKey() to get a
4315 * binary sortkey that can be used for actual sorting.
4317 * @param $prefix string The prefix to be used, specified using
4318 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4322 public function getCategorySortkey( $prefix = '' ) {
4323 $unprefixed = $this->getText();
4325 // Anything that uses this hook should only depend
4326 // on the Title object passed in, and should probably
4327 // tell the users to run updateCollations.php --force
4328 // in order to re-sort existing category relations.
4329 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4330 if ( $prefix !== '' ) {
4331 # Separate with a line feed, so the unprefixed part is only used as
4332 # a tiebreaker when two pages have the exact same prefix.
4333 # In UCA, tab is the only character that can sort above LF
4334 # so we strip both of them from the original prefix.
4335 $prefix = strtr( $prefix, "\n\t", ' ' );
4336 return "$prefix\n$unprefixed";
4342 * Get the language in which the content of this page is written.
4343 * Defaults to $wgContLang, but in certain cases it can be e.g.
4344 * $wgLang (such as special pages, which are in the user language).
4347 * @return object Language
4349 public function getPageLanguage() {
4351 if ( $this->getNamespace() == NS_SPECIAL
) {
4352 // special pages are in the user language
4354 } elseif ( $this->isRedirect() ) {
4355 // the arrow on a redirect page is aligned according to the user language
4357 } elseif ( $this->isCssOrJsPage() ) {
4358 // css/js should always be LTR and is, in fact, English
4359 return wfGetLangObj( 'en' );
4360 } elseif ( $this->getNamespace() == NS_MEDIAWIKI
) {
4361 // Parse mediawiki messages with correct target language
4362 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $this->getText() );
4363 return wfGetLangObj( $lang );
4366 // If nothing special, it should be in the wiki content language
4367 $pageLang = $wgContLang;
4368 // Hook at the end because we don't want to override the above stuff
4369 wfRunHooks( 'PageContentLanguage', array( $this, &$pageLang, $wgLang ) );
4370 return wfGetLangObj( $pageLang );
4375 * A BadTitle is generated in MediaWiki::parseTitle() if the title is invalid; the
4376 * software uses this to display an error page. Internally it's basically a Title
4377 * for an empty special page
4379 class BadTitle
extends Title
{
4380 public function __construct(){
4381 $this->mTextform
= '';
4382 $this->mUrlform
= '';
4383 $this->mDbkeyform
= '';
4384 $this->mNamespace
= NS_SPECIAL
; // Stops talk page link, etc, being shown
4387 public function exists(){
4391 public function getPrefixedText(){
4395 public function getText(){
4399 public function getPrefixedURL(){
4403 public function getPrefixedDBKey(){