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 * Get the prefixed title with spaces, plus any fragment
762 * (part beginning with '#')
764 * @return String the prefixed title, with spaces and the fragment, including '#'
766 public function getFullText() {
767 $text = $this->getPrefixedText();
768 if ( $this->mFragment
!= '' ) {
769 $text .= '#' . $this->mFragment
;
775 * Get the base page name, i.e. the leftmost part before any slashes
777 * @return String Base name
779 public function getBaseText() {
780 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
781 return $this->getText();
784 $parts = explode( '/', $this->getText() );
785 # Don't discard the real title if there's no subpage involved
786 if ( count( $parts ) > 1 ) {
787 unset( $parts[count( $parts ) - 1] );
789 return implode( '/', $parts );
793 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
795 * @return String Subpage name
797 public function getSubpageText() {
798 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
799 return( $this->mTextform
);
801 $parts = explode( '/', $this->mTextform
);
802 return( $parts[count( $parts ) - 1] );
806 * Get a URL-encoded form of the subpage text
808 * @return String URL-encoded subpage name
810 public function getSubpageUrlForm() {
811 $text = $this->getSubpageText();
812 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
817 * Get a URL-encoded title (not an actual URL) including interwiki
819 * @return String the URL-encoded form
821 public function getPrefixedURL() {
822 $s = $this->prefix( $this->mDbkeyform
);
823 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
828 * Get a real URL referring to this title, with interwiki link and
831 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
832 * links. Can be specified as an associative array as well, e.g.,
833 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
834 * @param $variant String language variant of url (for sr, zh..)
835 * @return String the URL
837 public function getFullURL( $query = '', $variant = false ) {
838 global $wgServer, $wgRequest;
840 if ( is_array( $query ) ) {
841 $query = wfArrayToCGI( $query );
844 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
846 $url = $this->getLocalURL( $query, $variant );
848 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
849 // Correct fix would be to move the prepending elsewhere.
850 if ( $wgRequest->getVal( 'action' ) != 'render' ) {
851 $url = $wgServer . $url;
854 $namespace = $this->getNsText();
855 if ( $namespace != '' ) {
856 # Can this actually happen? Interwikis shouldn't be parsed.
857 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
860 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
861 $url = wfAppendQuery( $url, $query );
864 # Finally, add the fragment.
865 $url .= $this->getFragmentForURL();
867 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
872 * Get a URL with no fragment or server name. If this page is generated
873 * with action=render, $wgServer is prepended.
875 * @param $query Mixed: an optional query string; if not specified,
876 * $wgArticlePath will be used. Can be specified as an associative array
877 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
879 * @param $variant String language variant of url (for sr, zh..)
880 * @return String the URL
882 public function getLocalURL( $query = '', $variant = false ) {
883 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
884 global $wgVariantArticlePath, $wgContLang;
886 if ( is_array( $query ) ) {
887 $query = wfArrayToCGI( $query );
890 if ( $this->isExternal() ) {
891 $url = $this->getFullURL();
893 // This is currently only used for edit section links in the
894 // context of interwiki transclusion. In theory we should
895 // append the query to the end of any existing query string,
896 // but interwiki transclusion is already broken in that case.
900 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
901 if ( $query == '' ) {
902 if ( $variant != false && $wgContLang->hasVariants() ) {
903 if ( !$wgVariantArticlePath ) {
904 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
906 $variantArticlePath = $wgVariantArticlePath;
908 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
909 $url = str_replace( '$1', $dbkey, $url );
911 $url = str_replace( '$1', $dbkey, $wgArticlePath );
912 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
915 global $wgActionPaths;
918 if ( !empty( $wgActionPaths ) &&
919 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
921 $action = urldecode( $matches[2] );
922 if ( isset( $wgActionPaths[$action] ) ) {
923 $query = $matches[1];
924 if ( isset( $matches[4] ) ) {
925 $query .= $matches[4];
927 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
928 if ( $query != '' ) {
929 $url = wfAppendQuery( $url, $query );
934 if ( $url === false ) {
935 if ( $query == '-' ) {
938 $url = "{$wgScript}?title={$dbkey}&{$query}";
942 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query, $variant ) );
944 // @todo FIXME: This causes breakage in various places when we
945 // actually expected a local URL and end up with dupe prefixes.
946 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
947 $url = $wgServer . $url;
950 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query, $variant ) );
955 * Get a URL that's the simplest URL that will be valid to link, locally,
956 * to the current Title. It includes the fragment, but does not include
957 * the server unless action=render is used (or the link is external). If
958 * there's a fragment but the prefixed text is empty, we just return a link
961 * The result obviously should not be URL-escaped, but does need to be
962 * HTML-escaped if it's being output in HTML.
964 * @param $query Array of Strings An associative array of key => value pairs for the
965 * query string. Keys and values will be escaped.
966 * @param $variant String language variant of URL (for sr, zh..). Ignored
967 * for external links. Default is "false" (same variant as current page,
968 * for anonymous users).
969 * @return String the URL
971 public function getLinkUrl( $query = array(), $variant = false ) {
972 wfProfileIn( __METHOD__
);
973 if ( $this->isExternal() ) {
974 $ret = $this->getFullURL( $query );
975 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
976 $ret = $this->getFragmentForURL();
978 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
980 wfProfileOut( __METHOD__
);
985 * Get an HTML-escaped version of the URL form, suitable for
986 * using in a link, without a server name or fragment
988 * @param $query String an optional query string
989 * @return String the URL
991 public function escapeLocalURL( $query = '' ) {
992 return htmlspecialchars( $this->getLocalURL( $query ) );
996 * Get an HTML-escaped version of the URL form, suitable for
997 * using in a link, including the server name and fragment
999 * @param $query String an optional query string
1000 * @return String the URL
1002 public function escapeFullURL( $query = '' ) {
1003 return htmlspecialchars( $this->getFullURL( $query ) );
1007 * Get the URL form for an internal link.
1008 * - Used in various Squid-related code, in case we have a different
1009 * internal hostname for the server from the exposed one.
1011 * @param $query String an optional query string
1012 * @param $variant String language variant of url (for sr, zh..)
1013 * @return String the URL
1015 public function getInternalURL( $query = '', $variant = false ) {
1016 global $wgInternalServer, $wgServer;
1017 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1018 $url = $server . $this->getLocalURL( $query, $variant );
1019 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1024 * Get the edit URL for this Title
1026 * @return String the URL, or a null string if this is an
1029 public function getEditURL() {
1030 if ( $this->mInterwiki
!= '' ) {
1033 $s = $this->getLocalURL( 'action=edit' );
1039 * Get the HTML-escaped displayable text form.
1040 * Used for the title field in <a> tags.
1042 * @return String the text, including any prefixes
1044 public function getEscapedText() {
1045 return htmlspecialchars( $this->getPrefixedText() );
1049 * Is this Title interwiki?
1053 public function isExternal() {
1054 return ( $this->mInterwiki
!= '' );
1058 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1060 * @param $action String Action to check (default: edit)
1063 public function isSemiProtected( $action = 'edit' ) {
1064 if ( $this->exists() ) {
1065 $restrictions = $this->getRestrictions( $action );
1066 if ( count( $restrictions ) > 0 ) {
1067 foreach ( $restrictions as $restriction ) {
1068 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
1078 # If it doesn't exist, it can't be protected
1084 * Does the title correspond to a protected article?
1086 * @param $action String the action the page is protected from,
1087 * by default checks all actions.
1090 public function isProtected( $action = '' ) {
1091 global $wgRestrictionLevels;
1093 $restrictionTypes = $this->getRestrictionTypes();
1095 # Special pages have inherent protection
1096 if( $this->getNamespace() == NS_SPECIAL
) {
1100 # Check regular protection levels
1101 foreach ( $restrictionTypes as $type ) {
1102 if ( $action == $type ||
$action == '' ) {
1103 $r = $this->getRestrictions( $type );
1104 foreach ( $wgRestrictionLevels as $level ) {
1105 if ( in_array( $level, $r ) && $level != '' ) {
1116 * Is this a conversion table for the LanguageConverter?
1120 public function isConversionTable() {
1122 $this->getNamespace() == NS_MEDIAWIKI
&&
1123 strpos( $this->getText(), 'Conversiontable' ) !== false
1133 * Is $wgUser watching this page?
1137 public function userIsWatching() {
1140 if ( is_null( $this->mWatched
) ) {
1141 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1142 $this->mWatched
= false;
1144 $this->mWatched
= $wgUser->isWatched( $this );
1147 return $this->mWatched
;
1151 * Can $wgUser perform $action on this page?
1152 * This skips potentially expensive cascading permission checks
1153 * as well as avoids expensive error formatting
1155 * Suitable for use for nonessential UI controls in common cases, but
1156 * _not_ for functional access control.
1158 * May provide false positives, but should never provide a false negative.
1160 * @param $action String action that permission needs to be checked for
1163 public function quickUserCan( $action ) {
1164 return $this->userCan( $action, false );
1168 * Determines if $user is unable to edit this page because it has been protected
1169 * by $wgNamespaceProtection.
1171 * @param $user User object to check permissions
1174 public function isNamespaceProtected( User
$user ) {
1175 global $wgNamespaceProtection;
1177 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
1178 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
1179 if ( $right != '' && !$user->isAllowed( $right ) ) {
1188 * Can $wgUser perform $action on this page?
1190 * @param $action String action that permission needs to be checked for
1191 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1194 public function userCan( $action, $doExpensiveQueries = true ) {
1196 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1200 * Can $user perform $action on this page?
1202 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1204 * @param $action String action that permission needs to be checked for
1205 * @param $user User to check
1206 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries by
1207 * skipping checks for cascading protections and user blocks.
1208 * @param $ignoreErrors Array of Strings Set this to a list of message keys whose corresponding errors may be ignored.
1209 * @return Array of arguments to wfMsg to explain permissions problems.
1211 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1212 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1214 // Remove the errors being ignored.
1215 foreach ( $errors as $index => $error ) {
1216 $error_key = is_array( $error ) ?
$error[0] : $error;
1218 if ( in_array( $error_key, $ignoreErrors ) ) {
1219 unset( $errors[$index] );
1227 * Permissions checks that fail most often, and which are easiest to test.
1229 * @param $action String the action to check
1230 * @param $user User user to check
1231 * @param $errors Array list of current errors
1232 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1233 * @param $short Boolean short circuit on first error
1235 * @return Array list of errors
1237 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1238 $ns = $this->getNamespace();
1240 if ( $action == 'create' ) {
1241 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk', $ns ) ) ||
1242 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage', $ns ) ) ) {
1243 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1245 } elseif ( $action == 'move' ) {
1246 if ( !$user->isAllowed( 'move-rootuserpages', $ns )
1247 && $ns == NS_USER
&& !$this->isSubpage() ) {
1248 // Show user page-specific message only if the user can move other pages
1249 $errors[] = array( 'cant-move-user-page' );
1252 // Check if user is allowed to move files if it's a file
1253 if ( $ns == NS_FILE
&& !$user->isAllowed( 'movefile', $ns ) ) {
1254 $errors[] = array( 'movenotallowedfile' );
1257 if ( !$user->isAllowed( 'move', $ns) ) {
1258 // User can't move anything
1260 $userCanMove = in_array( 'move', User
::getGroupPermissions(
1261 array( 'user' ), $ns ), true );
1262 $autoconfirmedCanMove = in_array( 'move', User
::getGroupPermissions(
1263 array( 'autoconfirmed' ), $ns ), true );
1265 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1266 // custom message if logged-in users without any special rights can move
1267 $errors[] = array( 'movenologintext' );
1269 $errors[] = array( 'movenotallowed' );
1272 } elseif ( $action == 'move-target' ) {
1273 if ( !$user->isAllowed( 'move', $ns ) ) {
1274 // User can't move anything
1275 $errors[] = array( 'movenotallowed' );
1276 } elseif ( !$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-to-user-page' );
1281 } elseif ( !$user->isAllowed( $action, $ns ) ) {
1282 // We avoid expensive display logic for quickUserCan's and such
1285 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1286 User
::getGroupsWithPermission( $action, $ns ) );
1293 $wgLang->commaList( $groups ),
1297 $return = array( 'badaccess-group0' );
1299 $errors[] = $return;
1306 * Add the resulting error code to the errors array
1308 * @param $errors Array list of current errors
1309 * @param $result Mixed result of errors
1311 * @return Array list of errors
1313 private function resultToError( $errors, $result ) {
1314 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1315 // A single array representing an error
1316 $errors[] = $result;
1317 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1318 // A nested array representing multiple errors
1319 $errors = array_merge( $errors, $result );
1320 } elseif ( $result !== '' && is_string( $result ) ) {
1321 // A string representing a message-id
1322 $errors[] = array( $result );
1323 } elseif ( $result === false ) {
1324 // a generic "We don't want them to do that"
1325 $errors[] = array( 'badaccess-group0' );
1331 * Check various permission hooks
1333 * @param $action String the action to check
1334 * @param $user User user to check
1335 * @param $errors Array list of current errors
1336 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1337 * @param $short Boolean short circuit on first error
1339 * @return Array list of errors
1341 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1342 // Use getUserPermissionsErrors instead
1344 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1345 return $result ?
array() : array( array( 'badaccess-group0' ) );
1347 // Check getUserPermissionsErrors hook
1348 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1349 $errors = $this->resultToError( $errors, $result );
1351 // Check getUserPermissionsErrorsExpensive hook
1352 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1353 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1354 $errors = $this->resultToError( $errors, $result );
1361 * Check permissions on special pages & namespaces
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 checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1372 # Only 'createaccount' and 'execute' can be performed on
1373 # special pages, which don't actually exist in the DB.
1374 $specialOKActions = array( 'createaccount', 'execute' );
1375 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1376 $errors[] = array( 'ns-specialprotected' );
1379 # Check $wgNamespaceProtection for restricted namespaces
1380 if ( $this->isNamespaceProtected( $user ) ) {
1381 $ns = $this->mNamespace
== NS_MAIN ?
1382 wfMsg( 'nstab-main' ) : $this->getNsText();
1383 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1384 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1391 * Check CSS/JS sub-page permissions
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 checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1402 # Protect css/js subpages of user pages
1403 # XXX: this might be better using restrictions
1404 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1405 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1406 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1407 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1408 $errors[] = array( 'customcssprotected' );
1409 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1410 $errors[] = array( 'customjsprotected' );
1418 * Check against page_restrictions table requirements on this
1419 * page. The user must possess all required rights for this
1422 * @param $action String the action to check
1423 * @param $user User user to check
1424 * @param $errors Array list of current errors
1425 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1426 * @param $short Boolean short circuit on first error
1428 * @return Array list of errors
1430 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1431 foreach ( $this->getRestrictions( $action ) as $right ) {
1432 // Backwards compatibility, rewrite sysop -> protect
1433 if ( $right == 'sysop' ) {
1436 if ( $right != '' && !$user->isAllowed( $right, $this->mNamespace
) ) {
1437 // Users with 'editprotected' permission can edit protected pages
1438 if ( $action == 'edit' && $user->isAllowed( 'editprotected', $this->mNamespace
) ) {
1439 // Users with 'editprotected' permission cannot edit protected pages
1440 // with cascading option turned on.
1441 if ( $this->mCascadeRestriction
) {
1442 $errors[] = array( 'protectedpagetext', $right );
1445 $errors[] = array( 'protectedpagetext', $right );
1454 * Check restrictions on cascading pages.
1456 * @param $action String the action to check
1457 * @param $user User to check
1458 * @param $errors Array list of current errors
1459 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1460 * @param $short Boolean short circuit on first error
1462 * @return Array list of errors
1464 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1465 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1466 # We /could/ use the protection level on the source page, but it's
1467 # fairly ugly as we have to establish a precedence hierarchy for pages
1468 # included by multiple cascade-protected pages. So just restrict
1469 # it to people with 'protect' permission, as they could remove the
1470 # protection anyway.
1471 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1472 # Cascading protection depends on more than this page...
1473 # Several cascading protected pages may include this page...
1474 # Check each cascading level
1475 # This is only for protection restrictions, not for all actions
1476 if ( isset( $restrictions[$action] ) ) {
1477 foreach ( $restrictions[$action] as $right ) {
1478 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1479 if ( $right != '' && !$user->isAllowed( $right, $this->mNamespace
) ) {
1481 foreach ( $cascadingSources as $page )
1482 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1483 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1493 * Check action permissions not already checked in checkQuickPermissions
1495 * @param $action String the action to check
1496 * @param $user User to check
1497 * @param $errors Array list of current errors
1498 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1499 * @param $short Boolean short circuit on first error
1501 * @return Array list of errors
1503 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1504 if ( $action == 'protect' ) {
1505 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1506 // If they can't edit, they shouldn't protect.
1507 $errors[] = array( 'protect-cantedit' );
1509 } elseif ( $action == 'create' ) {
1510 $title_protection = $this->getTitleProtection();
1511 if( $title_protection ) {
1512 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1513 $title_protection['pt_create_perm'] = 'protect'; // B/C
1515 if( $title_protection['pt_create_perm'] == '' ||
1516 !$user->isAllowed( $title_protection['pt_create_perm'],
1517 $this->mNamespace
) ) {
1518 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1521 } elseif ( $action == 'move' ) {
1522 // Check for immobile pages
1523 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1524 // Specific message for this case
1525 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1526 } elseif ( !$this->isMovable() ) {
1527 // Less specific message for rarer cases
1528 $errors[] = array( 'immobile-page' );
1530 } elseif ( $action == 'move-target' ) {
1531 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1532 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1533 } elseif ( !$this->isMovable() ) {
1534 $errors[] = array( 'immobile-target-page' );
1541 * Check that the user isn't blocked from editting.
1543 * @param $action String the action to check
1544 * @param $user User to check
1545 * @param $errors Array list of current errors
1546 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1547 * @param $short Boolean short circuit on first error
1549 * @return Array list of errors
1551 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1552 if( !$doExpensiveQueries ) {
1556 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1558 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1559 $errors[] = array( 'confirmedittext' );
1562 if ( in_array( $action, array( 'read', 'createaccount', 'unblock' ) ) ){
1563 // Edit blocks should not affect reading.
1564 // Account creation blocks handled at userlogin.
1565 // Unblocking handled in SpecialUnblock
1566 } elseif( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ){
1567 // Don't block the user from editing their own talk page unless they've been
1568 // explicitly blocked from that too.
1569 } elseif( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
1570 $block = $user->mBlock
;
1572 // This is from OutputPage::blockedPage
1573 // Copied at r23888 by werdna
1575 $id = $user->blockedBy();
1576 $reason = $user->blockedFor();
1577 if ( $reason == '' ) {
1578 $reason = wfMsg( 'blockednoreason' );
1582 if ( is_numeric( $id ) ) {
1583 $name = User
::whoIs( $id );
1588 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1589 $blockid = $block->getId();
1590 $blockExpiry = $user->mBlock
->mExpiry
;
1591 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1592 if ( $blockExpiry == 'infinity' ) {
1593 $blockExpiry = wfMessage( 'infiniteblock' )->text();
1595 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1598 $intended = strval( $user->mBlock
->getTarget() );
1600 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1601 $blockid, $blockExpiry, $intended, $blockTimestamp );
1608 * Can $user perform $action on this page? This is an internal function,
1609 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1610 * checks on wfReadOnly() and blocks)
1612 * @param $action String action that permission needs to be checked for
1613 * @param $user User to check
1614 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1615 * @param $short Bool Set this to true to stop after the first permission error.
1616 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
1618 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1619 wfProfileIn( __METHOD__
);
1623 'checkQuickPermissions',
1624 'checkPermissionHooks',
1625 'checkSpecialsAndNSPermissions',
1626 'checkCSSandJSPermissions',
1627 'checkPageRestrictions',
1628 'checkCascadingSourcesRestrictions',
1629 'checkActionPermissions',
1633 while( count( $checks ) > 0 &&
1634 !( $short && count( $errors ) > 0 ) ) {
1635 $method = array_shift( $checks );
1636 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1639 wfProfileOut( __METHOD__
);
1644 * Is this title subject to title protection?
1645 * Title protection is the one applied against creation of such title.
1647 * @return Mixed An associative array representing any existent title
1648 * protection, or false if there's none.
1650 private function getTitleProtection() {
1651 // Can't protect pages in special namespaces
1652 if ( $this->getNamespace() < 0 ) {
1656 // Can't protect pages that exist.
1657 if ( $this->exists() ) {
1661 if ( !isset( $this->mTitleProtection
) ) {
1662 $dbr = wfGetDB( DB_SLAVE
);
1663 $res = $dbr->select( 'protected_titles', '*',
1664 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1667 // fetchRow returns false if there are no rows.
1668 $this->mTitleProtection
= $dbr->fetchRow( $res );
1670 return $this->mTitleProtection
;
1674 * Update the title protection status
1676 * @param $create_perm String Permission required for creation
1677 * @param $reason String Reason for protection
1678 * @param $expiry String Expiry timestamp
1679 * @return boolean true
1681 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1682 global $wgUser, $wgContLang;
1684 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1685 && $expiry == $this->mRestrictionsExpiry
['create'] ) {
1690 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1692 $dbw = wfGetDB( DB_MASTER
);
1694 $encodedExpiry = $dbw->encodeExpiry( $expiry );
1696 $expiry_description = '';
1697 if ( $encodedExpiry != $dbw->getInfinity() ) {
1698 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1699 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1701 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1704 # Update protection table
1705 if ( $create_perm != '' ) {
1706 $this->mTitleProtection
= array(
1707 'pt_namespace' => $namespace,
1708 'pt_title' => $title,
1709 'pt_create_perm' => $create_perm,
1710 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
1711 'pt_expiry' => $encodedExpiry,
1712 'pt_user' => $wgUser->getId(),
1713 'pt_reason' => $reason,
1715 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1716 $this->mTitleProtection
, __METHOD__
);
1718 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1719 'pt_title' => $title ), __METHOD__
);
1720 $this->mTitleProtection
= false;
1723 # Update the protection log
1724 if ( $dbw->affectedRows() ) {
1725 $log = new LogPage( 'protect' );
1727 if ( $create_perm ) {
1728 $params = array( "[create=$create_perm] $expiry_description", '' );
1729 $log->addEntry( ( isset( $this->mRestrictions
['create'] ) && $this->mRestrictions
['create'] ) ?
'modify' : 'protect', $this, trim( $reason ), $params );
1731 $log->addEntry( 'unprotect', $this, $reason );
1739 * Remove any title protection due to page existing
1741 public function deleteTitleProtection() {
1742 $dbw = wfGetDB( DB_MASTER
);
1746 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1749 $this->mTitleProtection
= false;
1753 * Would anybody with sufficient privileges be able to move this page?
1754 * Some pages just aren't movable.
1756 * @return Bool TRUE or FALSE
1758 public function isMovable() {
1759 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1763 * Can $wgUser read this page?
1766 * @todo fold these checks into userCan()
1768 public function userCanRead() {
1769 global $wgUser, $wgGroupPermissions;
1771 static $useShortcut = null;
1773 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1774 if ( is_null( $useShortcut ) ) {
1775 global $wgRevokePermissions;
1776 $useShortcut = true;
1777 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1778 # Not a public wiki, so no shortcut
1779 $useShortcut = false;
1780 } elseif ( !empty( $wgRevokePermissions ) ) {
1782 * Iterate through each group with permissions being revoked (key not included since we don't care
1783 * what the group name is), then check if the read permission is being revoked. If it is, then
1784 * we don't use the shortcut below since the user might not be able to read, even though anon
1785 * reading is allowed.
1787 foreach ( $wgRevokePermissions as $perms ) {
1788 if ( !empty( $perms['read'] ) ) {
1789 # We might be removing the read right from the user, so no shortcut
1790 $useShortcut = false;
1798 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1799 if ( $result !== null ) {
1803 # Shortcut for public wikis, allows skipping quite a bit of code
1804 if ( $useShortcut ) {
1808 if ( $wgUser->isAllowed( 'read' ) ) {
1811 global $wgWhitelistRead;
1813 # Always grant access to the login page.
1814 # Even anons need to be able to log in.
1815 if ( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'ChangePassword' ) ) {
1819 # Bail out if there isn't whitelist
1820 if ( !is_array( $wgWhitelistRead ) ) {
1824 # Check for explicit whitelisting
1825 $name = $this->getPrefixedText();
1826 $dbName = $this->getPrefixedDBKey();
1827 // Check with and without underscores
1828 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) )
1831 # Old settings might have the title prefixed with
1832 # a colon for main-namespace pages
1833 if ( $this->getNamespace() == NS_MAIN
) {
1834 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
1839 # If it's a special page, ditch the subpage bit and check again
1840 if ( $this->getNamespace() == NS_SPECIAL
) {
1841 $name = $this->getDBkey();
1842 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
1843 if ( $name === false ) {
1844 # Invalid special page, but we show standard login required message
1848 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1849 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
1859 * Is this the mainpage?
1860 * @note Title::newFromText seams to be sufficiently optimized by the title
1861 * cache that we don't need to over-optimize by doing direct comparisons and
1862 * acidentally creating new bugs where $title->equals( Title::newFromText() )
1863 * ends up reporting something differently than $title->isMainPage();
1867 public function isMainPage() {
1868 return $this->equals( Title
::newMainPage() );
1872 * Is this a talk page of some sort?
1876 public function isTalkPage() {
1877 return MWNamespace
::isTalk( $this->getNamespace() );
1881 * Is this a subpage?
1885 public function isSubpage() {
1886 return MWNamespace
::hasSubpages( $this->mNamespace
)
1887 ?
strpos( $this->getText(), '/' ) !== false
1892 * Does this have subpages? (Warning, usually requires an extra DB query.)
1896 public function hasSubpages() {
1897 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1902 # We dynamically add a member variable for the purpose of this method
1903 # alone to cache the result. There's no point in having it hanging
1904 # around uninitialized in every Title object; therefore we only add it
1905 # if needed and don't declare it statically.
1906 if ( isset( $this->mHasSubpages
) ) {
1907 return $this->mHasSubpages
;
1910 $subpages = $this->getSubpages( 1 );
1911 if ( $subpages instanceof TitleArray
) {
1912 return $this->mHasSubpages
= (bool)$subpages->count();
1914 return $this->mHasSubpages
= false;
1918 * Get all subpages of this page.
1920 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
1921 * @return mixed TitleArray, or empty array if this page's namespace
1922 * doesn't allow subpages
1924 public function getSubpages( $limit = -1 ) {
1925 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
1929 $dbr = wfGetDB( DB_SLAVE
);
1930 $conds['page_namespace'] = $this->getNamespace();
1931 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
1933 if ( $limit > -1 ) {
1934 $options['LIMIT'] = $limit;
1936 return $this->mSubpages
= TitleArray
::newFromResult(
1937 $dbr->select( 'page',
1938 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1947 * Does that page contain wikitext, or it is JS, CSS or whatever?
1951 public function isWikitextPage() {
1952 $retval = !$this->isCssOrJsPage() && !$this->isCssJsSubpage();
1953 wfRunHooks( 'TitleIsWikitextPage', array( $this, &$retval ) );
1958 * Could this page contain custom CSS or JavaScript, based
1963 public function isCssOrJsPage() {
1964 $retval = $this->mNamespace
== NS_MEDIAWIKI
1965 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1966 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$retval ) );
1971 * Is this a .css or .js subpage of a user page?
1974 public function isCssJsSubpage() {
1975 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1979 * Is this a *valid* .css or .js subpage of a user page?
1982 * @deprecated since 1.17
1984 public function isValidCssJsSubpage() {
1985 return $this->isCssJsSubpage();
1989 * Trim down a .css or .js subpage title to get the corresponding skin name
1991 * @return string containing skin name from .css or .js subpage title
1993 public function getSkinFromCssJsSubpage() {
1994 $subpage = explode( '/', $this->mTextform
);
1995 $subpage = $subpage[ count( $subpage ) - 1 ];
1996 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
2000 * Is this a .css subpage of a user page?
2004 public function isCssSubpage() {
2005 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
2009 * Is this a .js subpage of a user page?
2013 public function isJsSubpage() {
2014 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
2018 * Protect css subpages of user pages: can $wgUser edit
2021 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2024 public function userCanEditCssSubpage() {
2026 wfDeprecated( __METHOD__
);
2027 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2028 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2032 * Protect js subpages of user pages: can $wgUser edit
2035 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2038 public function userCanEditJsSubpage() {
2040 wfDeprecated( __METHOD__
);
2041 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2042 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2046 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2048 * @return Bool If the page is subject to cascading restrictions.
2050 public function isCascadeProtected() {
2051 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2052 return ( $sources > 0 );
2056 * Cascading protection: Get the source of any cascading restrictions on this page.
2058 * @param $getPages Bool Whether or not to retrieve the actual pages
2059 * that the restrictions have come from.
2060 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2061 * have come, false for none, or true if such restrictions exist, but $getPages
2062 * was not set. The restriction array is an array of each type, each of which
2063 * contains a array of unique groups.
2065 public function getCascadeProtectionSources( $getPages = true ) {
2067 $pagerestrictions = array();
2069 if ( isset( $this->mCascadeSources
) && $getPages ) {
2070 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2071 } elseif ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2072 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2075 wfProfileIn( __METHOD__
);
2077 $dbr = wfGetDB( DB_SLAVE
);
2079 if ( $this->getNamespace() == NS_FILE
) {
2080 $tables = array( 'imagelinks', 'page_restrictions' );
2081 $where_clauses = array(
2082 'il_to' => $this->getDBkey(),
2087 $tables = array( 'templatelinks', 'page_restrictions' );
2088 $where_clauses = array(
2089 'tl_namespace' => $this->getNamespace(),
2090 'tl_title' => $this->getDBkey(),
2097 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2098 'pr_expiry', 'pr_type', 'pr_level' );
2099 $where_clauses[] = 'page_id=pr_page';
2102 $cols = array( 'pr_expiry' );
2105 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2107 $sources = $getPages ?
array() : false;
2108 $now = wfTimestampNow();
2109 $purgeExpired = false;
2111 foreach ( $res as $row ) {
2112 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2113 if ( $expiry > $now ) {
2115 $page_id = $row->pr_page
;
2116 $page_ns = $row->page_namespace
;
2117 $page_title = $row->page_title
;
2118 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2119 # Add groups needed for each restriction type if its not already there
2120 # Make sure this restriction type still exists
2122 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2123 $pagerestrictions[$row->pr_type
] = array();
2126 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2127 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2128 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2134 // Trigger lazy purge of expired restrictions from the db
2135 $purgeExpired = true;
2138 if ( $purgeExpired ) {
2139 Title
::purgeExpiredRestrictions();
2143 $this->mCascadeSources
= $sources;
2144 $this->mCascadingRestrictions
= $pagerestrictions;
2146 $this->mHasCascadingRestrictions
= $sources;
2149 wfProfileOut( __METHOD__
);
2150 return array( $sources, $pagerestrictions );
2154 * Returns cascading restrictions for the current article
2158 function areRestrictionsCascading() {
2159 if ( !$this->mRestrictionsLoaded
) {
2160 $this->loadRestrictions();
2163 return $this->mCascadeRestriction
;
2167 * Loads a string into mRestrictions array
2169 * @param $res Resource restrictions as an SQL result.
2170 * @param $oldFashionedRestrictions String comma-separated list of page
2171 * restrictions from page table (pre 1.10)
2173 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2176 foreach ( $res as $row ) {
2180 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2184 * Compiles list of active page restrictions from both page table (pre 1.10)
2185 * and page_restrictions table for this existing page.
2186 * Public for usage by LiquidThreads.
2188 * @param $rows array of db result objects
2189 * @param $oldFashionedRestrictions string comma-separated list of page
2190 * restrictions from page table (pre 1.10)
2192 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2194 $dbr = wfGetDB( DB_SLAVE
);
2196 $restrictionTypes = $this->getRestrictionTypes();
2198 foreach ( $restrictionTypes as $type ) {
2199 $this->mRestrictions
[$type] = array();
2200 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2203 $this->mCascadeRestriction
= false;
2205 # Backwards-compatibility: also load the restrictions from the page record (old format).
2207 if ( $oldFashionedRestrictions === null ) {
2208 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2209 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
2212 if ( $oldFashionedRestrictions != '' ) {
2214 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2215 $temp = explode( '=', trim( $restrict ) );
2216 if ( count( $temp ) == 1 ) {
2217 // old old format should be treated as edit/move restriction
2218 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2219 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2221 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
2225 $this->mOldRestrictions
= true;
2229 if ( count( $rows ) ) {
2230 # Current system - load second to make them override.
2231 $now = wfTimestampNow();
2232 $purgeExpired = false;
2234 # Cycle through all the restrictions.
2235 foreach ( $rows as $row ) {
2237 // Don't take care of restrictions types that aren't allowed
2238 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2241 // This code should be refactored, now that it's being used more generally,
2242 // But I don't really see any harm in leaving it in Block for now -werdna
2243 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2245 // Only apply the restrictions if they haven't expired!
2246 if ( !$expiry ||
$expiry > $now ) {
2247 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2248 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2250 $this->mCascadeRestriction |
= $row->pr_cascade
;
2252 // Trigger a lazy purge of expired restrictions
2253 $purgeExpired = true;
2257 if ( $purgeExpired ) {
2258 Title
::purgeExpiredRestrictions();
2262 $this->mRestrictionsLoaded
= true;
2266 * Load restrictions from the page_restrictions table
2268 * @param $oldFashionedRestrictions String comma-separated list of page
2269 * restrictions from page table (pre 1.10)
2271 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2273 if ( !$this->mRestrictionsLoaded
) {
2274 if ( $this->exists() ) {
2275 $dbr = wfGetDB( DB_SLAVE
);
2277 $res = $dbr->select(
2278 'page_restrictions',
2280 array( 'pr_page' => $this->getArticleId() ),
2284 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2286 $title_protection = $this->getTitleProtection();
2288 if ( $title_protection ) {
2289 $now = wfTimestampNow();
2290 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2292 if ( !$expiry ||
$expiry > $now ) {
2293 // Apply the restrictions
2294 $this->mRestrictionsExpiry
['create'] = $expiry;
2295 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2296 } else { // Get rid of the old restrictions
2297 Title
::purgeExpiredRestrictions();
2298 $this->mTitleProtection
= false;
2301 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2303 $this->mRestrictionsLoaded
= true;
2309 * Purge expired restrictions from the page_restrictions table
2311 static function purgeExpiredRestrictions() {
2312 $dbw = wfGetDB( DB_MASTER
);
2314 'page_restrictions',
2315 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2321 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2327 * Accessor/initialisation for mRestrictions
2329 * @param $action String action that permission needs to be checked for
2330 * @return Array of Strings the array of groups allowed to edit this article
2332 public function getRestrictions( $action ) {
2333 if ( !$this->mRestrictionsLoaded
) {
2334 $this->loadRestrictions();
2336 return isset( $this->mRestrictions
[$action] )
2337 ?
$this->mRestrictions
[$action]
2342 * Get the expiry time for the restriction against a given action
2344 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2345 * or not protected at all, or false if the action is not recognised.
2347 public function getRestrictionExpiry( $action ) {
2348 if ( !$this->mRestrictionsLoaded
) {
2349 $this->loadRestrictions();
2351 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2355 * Is there a version of this page in the deletion archive?
2357 * @param $includeSuppressed Boolean Include suppressed revisions?
2358 * @return Int the number of archived revisions
2360 public function isDeleted( $includeSuppressed = false ) {
2361 if ( $this->getNamespace() < 0 ) {
2364 $dbr = wfGetDB( DB_SLAVE
);
2365 $conditions = array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() );
2367 if( !$includeSuppressed ) {
2368 $suppressedTextBits = Revision
::DELETED_TEXT | Revision
::DELETED_RESTRICTED
;
2369 $conditions[] = $dbr->bitAnd('ar_deleted', $suppressedTextBits ) .
2370 ' != ' . $suppressedTextBits;
2373 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2377 if ( $this->getNamespace() == NS_FILE
) {
2378 $fconditions = array( 'fa_name' => $this->getDBkey() );
2379 if( !$includeSuppressed ) {
2380 $suppressedTextBits = File
::DELETED_FILE | File
::DELETED_RESTRICTED
;
2381 $fconditions[] = $dbr->bitAnd('fa_deleted', $suppressedTextBits ) .
2382 ' != ' . $suppressedTextBits;
2385 $n +
= $dbr->selectField( 'filearchive',
2396 * Is there a version of this page in the deletion archive?
2400 public function isDeletedQuick() {
2401 if ( $this->getNamespace() < 0 ) {
2404 $dbr = wfGetDB( DB_SLAVE
);
2405 $deleted = (bool)$dbr->selectField( 'archive', '1',
2406 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2409 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2410 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2411 array( 'fa_name' => $this->getDBkey() ),
2419 * Get the article ID for this Title from the link cache,
2420 * adding it if necessary
2422 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2424 * @return Int the ID
2426 public function getArticleID( $flags = 0 ) {
2427 if ( $this->getNamespace() < 0 ) {
2428 return $this->mArticleID
= 0;
2430 $linkCache = LinkCache
::singleton();
2431 if ( $flags & self
::GAID_FOR_UPDATE
) {
2432 $oldUpdate = $linkCache->forUpdate( true );
2433 $linkCache->clearLink( $this );
2434 $this->mArticleID
= $linkCache->addLinkObj( $this );
2435 $linkCache->forUpdate( $oldUpdate );
2437 if ( -1 == $this->mArticleID
) {
2438 $this->mArticleID
= $linkCache->addLinkObj( $this );
2441 return $this->mArticleID
;
2445 * Is this an article that is a redirect page?
2446 * Uses link cache, adding it if necessary
2448 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2451 public function isRedirect( $flags = 0 ) {
2452 if ( !is_null( $this->mRedirect
) ) {
2453 return $this->mRedirect
;
2455 # Calling getArticleID() loads the field from cache as needed
2456 if ( !$this->getArticleID( $flags ) ) {
2457 return $this->mRedirect
= false;
2459 $linkCache = LinkCache
::singleton();
2460 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2462 return $this->mRedirect
;
2466 * What is the length of this page?
2467 * Uses link cache, adding it if necessary
2469 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2472 public function getLength( $flags = 0 ) {
2473 if ( $this->mLength
!= -1 ) {
2474 return $this->mLength
;
2476 # Calling getArticleID() loads the field from cache as needed
2477 if ( !$this->getArticleID( $flags ) ) {
2478 return $this->mLength
= 0;
2480 $linkCache = LinkCache
::singleton();
2481 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2483 return $this->mLength
;
2487 * What is the page_latest field for this page?
2489 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2490 * @return Int or 0 if the page doesn't exist
2492 public function getLatestRevID( $flags = 0 ) {
2493 if ( $this->mLatestID
!== false ) {
2494 return intval( $this->mLatestID
);
2496 # Calling getArticleID() loads the field from cache as needed
2497 if ( !$this->getArticleID( $flags ) ) {
2498 return $this->mLatestID
= 0;
2500 $linkCache = LinkCache
::singleton();
2501 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2503 return $this->mLatestID
;
2507 * This clears some fields in this object, and clears any associated
2508 * keys in the "bad links" section of the link cache.
2510 * - This is called from Article::doEdit() and Article::insertOn() to allow
2511 * loading of the new page_id. It's also called from
2512 * Article::doDeleteArticle()
2514 * @param $newid Int the new Article ID
2516 public function resetArticleID( $newid ) {
2517 $linkCache = LinkCache
::singleton();
2518 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2520 if ( $newid === false ) {
2521 $this->mArticleID
= -1;
2523 $this->mArticleID
= intval( $newid );
2525 $this->mRestrictionsLoaded
= false;
2526 $this->mRestrictions
= array();
2527 $this->mRedirect
= null;
2528 $this->mLength
= -1;
2529 $this->mLatestID
= false;
2533 * Updates page_touched for this page; called from LinksUpdate.php
2535 * @return Bool true if the update succeded
2537 public function invalidateCache() {
2538 if ( wfReadOnly() ) {
2541 $dbw = wfGetDB( DB_MASTER
);
2542 $success = $dbw->update(
2544 array( 'page_touched' => $dbw->timestamp() ),
2548 HTMLFileCache
::clearFileCache( $this );
2553 * Prefix some arbitrary text with the namespace or interwiki prefix
2556 * @param $name String the text
2557 * @return String the prefixed text
2560 private function prefix( $name ) {
2562 if ( $this->mInterwiki
!= '' ) {
2563 $p = $this->mInterwiki
. ':';
2566 if ( 0 != $this->mNamespace
) {
2567 $p .= $this->getNsText() . ':';
2573 * Returns a simple regex that will match on characters and sequences invalid in titles.
2574 * Note that this doesn't pick up many things that could be wrong with titles, but that
2575 * replacing this regex with something valid will make many titles valid.
2577 * @return String regex string
2579 static function getTitleInvalidRegex() {
2580 static $rxTc = false;
2582 # Matching titles will be held as illegal.
2584 # Any character not allowed is forbidden...
2585 '[^' . Title
::legalChars() . ']' .
2586 # URL percent encoding sequences interfere with the ability
2587 # to round-trip titles -- you can't link to them consistently.
2588 '|%[0-9A-Fa-f]{2}' .
2589 # XML/HTML character references produce similar issues.
2590 '|&[A-Za-z0-9\x80-\xff]+;' .
2592 '|&#x[0-9A-Fa-f]+;' .
2600 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2602 * @param $text String containing title to capitalize
2603 * @param $ns int namespace index, defaults to NS_MAIN
2604 * @return String containing capitalized title
2606 public static function capitalize( $text, $ns = NS_MAIN
) {
2609 if ( MWNamespace
::isCapitalized( $ns ) ) {
2610 return $wgContLang->ucfirst( $text );
2617 * Secure and split - main initialisation function for this object
2619 * Assumes that mDbkeyform has been set, and is urldecoded
2620 * and uses underscores, but not otherwise munged. This function
2621 * removes illegal characters, splits off the interwiki and
2622 * namespace prefixes, sets the other forms, and canonicalizes
2625 * @return Bool true on success
2627 private function secureAndSplit() {
2628 global $wgContLang, $wgLocalInterwiki;
2631 $this->mInterwiki
= $this->mFragment
= '';
2632 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2634 $dbkey = $this->mDbkeyform
;
2636 # Strip Unicode bidi override characters.
2637 # Sometimes they slip into cut-n-pasted page titles, where the
2638 # override chars get included in list displays.
2639 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2641 # Clean up whitespace
2642 # Note: use of the /u option on preg_replace here will cause
2643 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2644 # conveniently disabling them.
2645 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2646 $dbkey = trim( $dbkey, '_' );
2648 if ( $dbkey == '' ) {
2652 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2653 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2657 $this->mDbkeyform
= $dbkey;
2659 # Initial colon indicates main namespace rather than specified default
2660 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2661 if ( ':' == $dbkey[0] ) {
2662 $this->mNamespace
= NS_MAIN
;
2663 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2664 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2667 # Namespace or interwiki prefix
2669 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2672 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2674 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2675 # Ordinary namespace
2677 $this->mNamespace
= $ns;
2678 # For Talk:X pages, check if X has a "namespace" prefix
2679 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2680 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2681 # Disallow Talk:File:x type titles...
2683 } elseif ( Interwiki
::isValidInterwiki( $x[1] ) ) {
2684 # Disallow Talk:Interwiki:x type titles...
2688 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2689 if ( !$firstPass ) {
2690 # Can't make a local interwiki link to an interwiki link.
2691 # That's just crazy!
2697 $this->mInterwiki
= $wgContLang->lc( $p );
2699 # Redundant interwiki prefix to the local wiki
2700 if ( $wgLocalInterwiki !== false
2701 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
2703 if ( $dbkey == '' ) {
2704 # Can't have an empty self-link
2707 $this->mInterwiki
= '';
2709 # Do another namespace split...
2713 # If there's an initial colon after the interwiki, that also
2714 # resets the default namespace
2715 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2716 $this->mNamespace
= NS_MAIN
;
2717 $dbkey = substr( $dbkey, 1 );
2720 # If there's no recognized interwiki or namespace,
2721 # then let the colon expression be part of the title.
2726 # We already know that some pages won't be in the database!
2727 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
2728 $this->mArticleID
= 0;
2730 $fragment = strstr( $dbkey, '#' );
2731 if ( false !== $fragment ) {
2732 $this->setFragment( $fragment );
2733 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2734 # remove whitespace again: prevents "Foo_bar_#"
2735 # becoming "Foo_bar_"
2736 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2739 # Reject illegal characters.
2740 $rxTc = self
::getTitleInvalidRegex();
2741 if ( preg_match( $rxTc, $dbkey ) ) {
2745 # Pages with "/./" or "/../" appearing in the URLs will often be un-
2746 # reachable due to the way web browsers deal with 'relative' URLs.
2747 # Also, they conflict with subpage syntax. Forbid them explicitly.
2748 if ( strpos( $dbkey, '.' ) !== false &&
2749 ( $dbkey === '.' ||
$dbkey === '..' ||
2750 strpos( $dbkey, './' ) === 0 ||
2751 strpos( $dbkey, '../' ) === 0 ||
2752 strpos( $dbkey, '/./' ) !== false ||
2753 strpos( $dbkey, '/../' ) !== false ||
2754 substr( $dbkey, -2 ) == '/.' ||
2755 substr( $dbkey, -3 ) == '/..' ) )
2760 # Magic tilde sequences? Nu-uh!
2761 if ( strpos( $dbkey, '~~~' ) !== false ) {
2765 # Limit the size of titles to 255 bytes. This is typically the size of the
2766 # underlying database field. We make an exception for special pages, which
2767 # don't need to be stored in the database, and may edge over 255 bytes due
2768 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
2769 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2770 strlen( $dbkey ) > 512 )
2775 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
2776 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
2777 # other site might be case-sensitive.
2778 $this->mUserCaseDBKey
= $dbkey;
2779 if ( $this->mInterwiki
== '' ) {
2780 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
2783 # Can't make a link to a namespace alone... "empty" local links can only be
2784 # self-links with a fragment identifier.
2785 if ( $dbkey == '' && $this->mInterwiki
== '' && $this->mNamespace
!= NS_MAIN
) {
2789 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2790 // IP names are not allowed for accounts, and can only be referring to
2791 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2792 // there are numerous ways to present the same IP. Having sp:contribs scan
2793 // them all is silly and having some show the edits and others not is
2794 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2795 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
)
2796 ? IP
::sanitizeIP( $dbkey )
2799 // Any remaining initial :s are illegal.
2800 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2805 $this->mDbkeyform
= $dbkey;
2806 $this->mUrlform
= wfUrlencode( $dbkey );
2808 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2814 * Set the fragment for this title. Removes the first character from the
2815 * specified fragment before setting, so it assumes you're passing it with
2818 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2819 * Still in active use privately.
2821 * @param $fragment String text
2823 public function setFragment( $fragment ) {
2824 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2828 * Get a Title object associated with the talk page of this article
2830 * @return Title the object for the talk page
2832 public function getTalkPage() {
2833 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2837 * Get a title object associated with the subject page of this
2840 * @return Title the object for the subject page
2842 public function getSubjectPage() {
2843 // Is this the same title?
2844 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2845 if ( $this->getNamespace() == $subjectNS ) {
2848 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2852 * Get an array of Title objects linking to this Title
2853 * Also stores the IDs in the link cache.
2855 * WARNING: do not use this function on arbitrary user-supplied titles!
2856 * On heavily-used templates it will max out the memory.
2858 * @param $options Array: may be FOR UPDATE
2859 * @param $table String: table name
2860 * @param $prefix String: fields prefix
2861 * @return Array of Title objects linking here
2863 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2864 $linkCache = LinkCache
::singleton();
2866 if ( count( $options ) > 0 ) {
2867 $db = wfGetDB( DB_MASTER
);
2869 $db = wfGetDB( DB_SLAVE
);
2873 array( 'page', $table ),
2874 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2876 "{$prefix}_from=page_id",
2877 "{$prefix}_namespace" => $this->getNamespace(),
2878 "{$prefix}_title" => $this->getDBkey() ),
2884 if ( $db->numRows( $res ) ) {
2885 foreach ( $res as $row ) {
2886 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
2888 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
, $row->page_latest
);
2889 $retVal[] = $titleObj;
2897 * Get an array of Title objects using this Title as a template
2898 * Also stores the IDs in the link cache.
2900 * WARNING: do not use this function on arbitrary user-supplied titles!
2901 * On heavily-used templates it will max out the memory.
2903 * @param $options Array: may be FOR UPDATE
2904 * @return Array of Title the Title objects linking here
2906 public function getTemplateLinksTo( $options = array() ) {
2907 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2911 * Get an array of Title objects referring to non-existent articles linked from this page
2913 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2914 * @return Array of Title the Title objects
2916 public function getBrokenLinksFrom() {
2917 if ( $this->getArticleId() == 0 ) {
2918 # All links from article ID 0 are false positives
2922 $dbr = wfGetDB( DB_SLAVE
);
2923 $res = $dbr->select(
2924 array( 'page', 'pagelinks' ),
2925 array( 'pl_namespace', 'pl_title' ),
2927 'pl_from' => $this->getArticleId(),
2928 'page_namespace IS NULL'
2930 __METHOD__
, array(),
2934 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2940 foreach ( $res as $row ) {
2941 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2948 * Get a list of URLs to purge from the Squid cache when this
2951 * @return Array of String the URLs
2953 public function getSquidURLs() {
2957 $this->getInternalURL(),
2958 $this->getInternalURL( 'action=history' )
2961 // purge variant urls as well
2962 if ( $wgContLang->hasVariants() ) {
2963 $variants = $wgContLang->getVariants();
2964 foreach ( $variants as $vCode ) {
2965 $urls[] = $this->getInternalURL( '', $vCode );
2973 * Purge all applicable Squid URLs
2975 public function purgeSquid() {
2977 if ( $wgUseSquid ) {
2978 $urls = $this->getSquidURLs();
2979 $u = new SquidUpdate( $urls );
2985 * Move this page without authentication
2987 * @param $nt Title the new page Title
2988 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
2990 public function moveNoAuth( &$nt ) {
2991 return $this->moveTo( $nt, false );
2995 * Check whether a given move operation would be valid.
2996 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2998 * @param $nt Title the new title
2999 * @param $auth Bool indicates whether $wgUser's permissions
3001 * @param $reason String is the log summary of the move, used for spam checking
3002 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3004 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3009 // Normally we'd add this to $errors, but we'll get
3010 // lots of syntax errors if $nt is not an object
3011 return array( array( 'badtitletext' ) );
3013 if ( $this->equals( $nt ) ) {
3014 $errors[] = array( 'selfmove' );
3016 if ( !$this->isMovable() ) {
3017 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3019 if ( $nt->getInterwiki() != '' ) {
3020 $errors[] = array( 'immobile-target-namespace-iw' );
3022 if ( !$nt->isMovable() ) {
3023 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3026 $oldid = $this->getArticleID();
3027 $newid = $nt->getArticleID();
3029 if ( strlen( $nt->getDBkey() ) < 1 ) {
3030 $errors[] = array( 'articleexists' );
3032 if ( ( $this->getDBkey() == '' ) ||
3034 ( $nt->getDBkey() == '' ) ) {
3035 $errors[] = array( 'badarticleerror' );
3038 // Image-specific checks
3039 if ( $this->getNamespace() == NS_FILE
) {
3040 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3043 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3044 $errors[] = array( 'nonfile-cannot-move-to-file' );
3048 $errors = wfMergeErrorArrays( $errors,
3049 $this->getUserPermissionsErrors( 'move', $wgUser ),
3050 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3051 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3052 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3055 $match = EditPage
::matchSummarySpamRegex( $reason );
3056 if ( $match !== false ) {
3057 // This is kind of lame, won't display nice
3058 $errors[] = array( 'spamprotectiontext' );
3062 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3063 $errors[] = array( 'hookaborted', $err );
3066 # The move is allowed only if (1) the target doesn't exist, or
3067 # (2) the target is a redirect to the source, and has no history
3068 # (so we can undo bad moves right after they're done).
3070 if ( 0 != $newid ) { # Target exists; check for validity
3071 if ( !$this->isValidMoveTarget( $nt ) ) {
3072 $errors[] = array( 'articleexists' );
3075 $tp = $nt->getTitleProtection();
3076 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3077 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3078 $errors[] = array( 'cantmove-titleprotected' );
3081 if ( empty( $errors ) ) {
3088 * Check if the requested move target is a valid file move target
3089 * @param Title $nt Target title
3090 * @return array List of errors
3092 protected function validateFileMoveOperation( $nt ) {
3097 if ( $nt->getNamespace() != NS_FILE
) {
3098 $errors[] = array( 'imagenocrossnamespace' );
3101 $file = wfLocalFile( $this );
3102 if ( $file->exists() ) {
3103 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3104 $errors[] = array( 'imageinvalidfilename' );
3106 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3107 $errors[] = array( 'imagetypemismatch' );
3111 $destFile = wfLocalFile( $nt );
3112 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3113 $errors[] = array( 'file-exists-sharedrepo' );
3120 * Move a title to a new location
3122 * @param $nt Title the new title
3123 * @param $auth Bool indicates whether $wgUser's permissions
3125 * @param $reason String the reason for the move
3126 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3127 * Ignored if the user doesn't have the suppressredirect right.
3128 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3130 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3131 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3132 if ( is_array( $err ) ) {
3136 // If it is a file, move it first. It is done before all other moving stuff is
3137 // done because it's hard to revert
3138 $dbw = wfGetDB( DB_MASTER
);
3139 if ( $this->getNamespace() == NS_FILE
) {
3140 $file = wfLocalFile( $this );
3141 if ( $file->exists() ) {
3142 $status = $file->move( $nt );
3143 if ( !$status->isOk() ) {
3144 return $status->getErrorsArray();
3149 $dbw->begin(); # If $file was a LocalFile, its transaction would have closed our own.
3150 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3151 $protected = $this->isProtected();
3152 $pageCountChange = ( $createRedirect ?
1 : 0 ) - ( $nt->exists() ?
1 : 0 );
3154 // Do the actual move
3155 $err = $this->moveToInternal( $nt, $reason, $createRedirect );
3156 if ( is_array( $err ) ) {
3157 # @todo FIXME: What about the File we have already moved?
3162 $redirid = $this->getArticleID();
3164 // Refresh the sortkey for this row. Be careful to avoid resetting
3165 // cl_timestamp, which may disturb time-based lists on some sites.
3166 $prefixes = $dbw->select(
3168 array( 'cl_sortkey_prefix', 'cl_to' ),
3169 array( 'cl_from' => $pageid ),
3172 foreach ( $prefixes as $prefixRow ) {
3173 $prefix = $prefixRow->cl_sortkey_prefix
;
3174 $catTo = $prefixRow->cl_to
;
3175 $dbw->update( 'categorylinks',
3177 'cl_sortkey' => Collation
::singleton()->getSortKey(
3178 $nt->getCategorySortkey( $prefix ) ),
3179 'cl_timestamp=cl_timestamp' ),
3181 'cl_from' => $pageid,
3182 'cl_to' => $catTo ),
3188 # Protect the redirect title as the title used to be...
3189 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3191 'pr_page' => $redirid,
3192 'pr_type' => 'pr_type',
3193 'pr_level' => 'pr_level',
3194 'pr_cascade' => 'pr_cascade',
3195 'pr_user' => 'pr_user',
3196 'pr_expiry' => 'pr_expiry'
3198 array( 'pr_page' => $pageid ),
3202 # Update the protection log
3203 $log = new LogPage( 'protect' );
3204 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3206 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3208 // @todo FIXME: $params?
3209 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3213 $oldnamespace = $this->getNamespace() & ~
1;
3214 $newnamespace = $nt->getNamespace() & ~
1;
3215 $oldtitle = $this->getDBkey();
3216 $newtitle = $nt->getDBkey();
3218 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3219 WatchedItem
::duplicateEntries( $this, $nt );
3222 # Update search engine
3223 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3225 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3231 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3232 # No longer a content page
3233 # Not viewed, edited, removing
3234 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3235 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3236 # Now a content page
3237 # Not viewed, edited, adding
3238 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
3239 } elseif ( $pageCountChange ) {
3241 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3250 # Update message cache for interface messages
3251 if ( $this->getNamespace() == NS_MEDIAWIKI
) {
3252 # @bug 17860: old article can be deleted, if this the case,
3253 # delete it from message cache
3254 if ( $this->getArticleID() === 0 ) {
3255 MessageCache
::singleton()->replace( $this->getDBkey(), false );
3257 $oldarticle = new Article( $this );
3258 MessageCache
::singleton()->replace( $this->getDBkey(), $oldarticle->getContent() );
3261 if ( $nt->getNamespace() == NS_MEDIAWIKI
) {
3262 $newarticle = new Article( $nt );
3263 MessageCache
::singleton()->replace( $nt->getDBkey(), $newarticle->getContent() );
3267 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3272 * Move page to a title which is either a redirect to the
3273 * source page or nonexistent
3275 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3276 * @param $reason String The reason for the move
3277 * @param $createRedirect Bool Whether to leave a redirect at the old title. Ignored
3278 * if the user doesn't have the suppressredirect right
3280 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3281 global $wgUser, $wgContLang;
3283 $moveOverRedirect = $nt->exists();
3285 $commentMsg = ( $moveOverRedirect ?
'1movedto2_redir' : '1movedto2' );
3286 $comment = wfMsgForContent( $commentMsg, $this->getPrefixedText(), $nt->getPrefixedText() );
3289 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3291 # Truncate for whole multibyte characters.
3292 $comment = $wgContLang->truncate( $comment, 255 );
3294 $oldid = $this->getArticleID();
3295 $latest = $this->getLatestRevID();
3297 $dbw = wfGetDB( DB_MASTER
);
3299 if ( $moveOverRedirect ) {
3300 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3302 $newid = $nt->getArticleID();
3303 $newns = $nt->getNamespace();
3304 $newdbk = $nt->getDBkey();
3306 # Delete the old redirect. We don't save it to history since
3307 # by definition if we've got here it's rather uninteresting.
3308 # We have to remove it so that the next step doesn't trigger
3309 # a conflict on the unique namespace+title index...
3310 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3311 if ( !$dbw->cascadingDeletes() ) {
3312 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
3313 global $wgUseTrackbacks;
3314 if ( $wgUseTrackbacks ) {
3315 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
3317 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3318 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
3319 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
3320 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
3321 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
3322 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
3323 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
3325 // If the target page was recently created, it may have an entry in recentchanges still
3326 $dbw->delete( 'recentchanges',
3327 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3332 # Save a null revision in the page's history notifying of the move
3333 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3334 if ( !is_object( $nullRevision ) ) {
3335 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3337 $nullRevId = $nullRevision->insertOn( $dbw );
3339 $now = wfTimestampNow();
3340 # Change the name of the target page:
3341 $dbw->update( 'page',
3343 'page_touched' => $dbw->timestamp( $now ),
3344 'page_namespace' => $nt->getNamespace(),
3345 'page_title' => $nt->getDBkey(),
3346 'page_latest' => $nullRevId,
3348 /* WHERE */ array( 'page_id' => $oldid ),
3351 $nt->resetArticleID( $oldid );
3353 $article = new Article( $nt );
3354 wfRunHooks( 'NewRevisionFromEditComplete',
3355 array( $article, $nullRevision, $latest, $wgUser ) );
3356 $article->setCachedLastEditTime( $now );
3358 # Recreate the redirect, this time in the other direction.
3359 if ( $createRedirect ||
!$wgUser->isAllowed( 'suppressredirect' ) ) {
3360 $mwRedir = MagicWord
::get( 'redirect' );
3361 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3362 $redirectArticle = new Article( $this );
3363 $newid = $redirectArticle->insertOn( $dbw );
3364 if ( $newid ) { // sanity
3365 $redirectRevision = new Revision( array(
3367 'comment' => $comment,
3368 'text' => $redirectText ) );
3369 $redirectRevision->insertOn( $dbw );
3370 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3372 wfRunHooks( 'NewRevisionFromEditComplete',
3373 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3375 # Now, we record the link from the redirect to the new title.
3376 # It should have no other outgoing links...
3377 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3378 $dbw->insert( 'pagelinks',
3380 'pl_from' => $newid,
3381 'pl_namespace' => $nt->getNamespace(),
3382 'pl_title' => $nt->getDBkey() ),
3385 $redirectSuppressed = false;
3387 $this->resetArticleID( 0 );
3388 $redirectSuppressed = true;
3392 $log = new LogPage( 'move' );
3393 $logType = ( $moveOverRedirect ?
'move_redir' : 'move' );
3394 $log->addEntry( $logType, $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3396 # Purge caches for old and new titles
3397 if ( $moveOverRedirect ) {
3398 # A simple purge is enough when moving over a redirect
3401 # Purge caches as per article creation, including any pages that link to this title
3402 Article
::onArticleCreate( $nt );
3404 $this->purgeSquid();
3408 * Move this page's subpages to be subpages of $nt
3410 * @param $nt Title Move target
3411 * @param $auth bool Whether $wgUser's permissions should be checked
3412 * @param $reason string The reason for the move
3413 * @param $createRedirect bool Whether to create redirects from the old subpages to
3414 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3415 * @return mixed array with old page titles as keys, and strings (new page titles) or
3416 * arrays (errors) as values, or an error array with numeric indices if no pages
3419 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3420 global $wgMaximumMovedPages;
3421 // Check permissions
3422 if ( !$this->userCan( 'move-subpages' ) ) {
3423 return array( 'cant-move-subpages' );
3425 // Do the source and target namespaces support subpages?
3426 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3427 return array( 'namespace-nosubpages',
3428 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3430 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3431 return array( 'namespace-nosubpages',
3432 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3435 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3438 foreach ( $subpages as $oldSubpage ) {
3440 if ( $count > $wgMaximumMovedPages ) {
3441 $retval[$oldSubpage->getPrefixedTitle()] =
3442 array( 'movepage-max-pages',
3443 $wgMaximumMovedPages );
3447 // We don't know whether this function was called before
3448 // or after moving the root page, so check both
3450 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3451 $oldSubpage->getArticleID() == $nt->getArticleId() )
3453 // When moving a page to a subpage of itself,
3454 // don't move it twice
3457 $newPageName = preg_replace(
3458 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3459 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3460 $oldSubpage->getDBkey() );
3461 if ( $oldSubpage->isTalkPage() ) {
3462 $newNs = $nt->getTalkPage()->getNamespace();
3464 $newNs = $nt->getSubjectPage()->getNamespace();
3466 # Bug 14385: we need makeTitleSafe because the new page names may
3467 # be longer than 255 characters.
3468 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3470 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3471 if ( $success === true ) {
3472 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3474 $retval[$oldSubpage->getPrefixedText()] = $success;
3481 * Checks if this page is just a one-rev redirect.
3482 * Adds lock, so don't use just for light purposes.
3486 public function isSingleRevRedirect() {
3487 $dbw = wfGetDB( DB_MASTER
);
3489 $row = $dbw->selectRow( 'page',
3490 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3493 array( 'FOR UPDATE' )
3495 # Cache some fields we may want
3496 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3497 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3498 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3499 if ( !$this->mRedirect
) {
3502 # Does the article have a history?
3503 $row = $dbw->selectField( array( 'page', 'revision' ),
3505 array( 'page_namespace' => $this->getNamespace(),
3506 'page_title' => $this->getDBkey(),
3508 'page_latest != rev_id'
3511 array( 'FOR UPDATE' )
3513 # Return true if there was no history
3514 return ( $row === false );
3518 * Checks if $this can be moved to a given Title
3519 * - Selects for update, so don't call it unless you mean business
3521 * @param $nt Title the new title to check
3524 public function isValidMoveTarget( $nt ) {
3525 # Is it an existing file?
3526 if ( $nt->getNamespace() == NS_FILE
) {
3527 $file = wfLocalFile( $nt );
3528 if ( $file->exists() ) {
3529 wfDebug( __METHOD__
. ": file exists\n" );
3533 # Is it a redirect with no history?
3534 if ( !$nt->isSingleRevRedirect() ) {
3535 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3538 # Get the article text
3539 $rev = Revision
::newFromTitle( $nt );
3540 $text = $rev->getText();
3541 # Does the redirect point to the source?
3542 # Or is it a broken self-redirect, usually caused by namespace collisions?
3544 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3545 $redirTitle = Title
::newFromText( $m[1] );
3546 if ( !is_object( $redirTitle ) ||
3547 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3548 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3549 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3554 wfDebug( __METHOD__
. ": failsafe\n" );
3561 * Can this title be added to a user's watchlist?
3563 * @return Bool TRUE or FALSE
3565 public function isWatchable() {
3566 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3570 * Get categories to which this Title belongs and return an array of
3571 * categories' names.
3573 * @return Array of parents in the form:
3574 * $parent => $currentarticle
3576 public function getParentCategories() {
3581 $titleKey = $this->getArticleId();
3583 if ( $titleKey === 0 ) {
3587 $dbr = wfGetDB( DB_SLAVE
);
3589 $res = $dbr->select( 'categorylinks', '*',
3591 'cl_from' => $titleKey,
3597 if ( $dbr->numRows( $res ) > 0 ) {
3598 foreach ( $res as $row ) {
3599 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3600 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3607 * Get a tree of parent categories
3609 * @param $children Array with the children in the keys, to check for circular refs
3610 * @return Array Tree of parent categories
3612 public function getParentCategoryTree( $children = array() ) {
3614 $parents = $this->getParentCategories();
3617 foreach ( $parents as $parent => $current ) {
3618 if ( array_key_exists( $parent, $children ) ) {
3619 # Circular reference
3620 $stack[$parent] = array();
3622 $nt = Title
::newFromText( $parent );
3624 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3634 * Get an associative array for selecting this title from
3637 * @return Array suitable for the $where parameter of DB::select()
3639 public function pageCond() {
3640 if ( $this->mArticleID
> 0 ) {
3641 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3642 return array( 'page_id' => $this->mArticleID
);
3644 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3649 * Get the revision ID of the previous revision
3651 * @param $revId Int Revision ID. Get the revision that was before this one.
3652 * @param $flags Int Title::GAID_FOR_UPDATE
3653 * @return Int|Bool Old revision ID, or FALSE if none exists
3655 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3656 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3657 return $db->selectField( 'revision', 'rev_id',
3659 'rev_page' => $this->getArticleId( $flags ),
3660 'rev_id < ' . intval( $revId )
3663 array( 'ORDER BY' => 'rev_id DESC' )
3668 * Get the revision ID of the next revision
3670 * @param $revId Int Revision ID. Get the revision that was after this one.
3671 * @param $flags Int Title::GAID_FOR_UPDATE
3672 * @return Int|Bool Next revision ID, or FALSE if none exists
3674 public function getNextRevisionID( $revId, $flags = 0 ) {
3675 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3676 return $db->selectField( 'revision', 'rev_id',
3678 'rev_page' => $this->getArticleId( $flags ),
3679 'rev_id > ' . intval( $revId )
3682 array( 'ORDER BY' => 'rev_id' )
3687 * Get the first revision of the page
3689 * @param $flags Int Title::GAID_FOR_UPDATE
3690 * @return Revision|Null if page doesn't exist
3692 public function getFirstRevision( $flags = 0 ) {
3693 $pageId = $this->getArticleId( $flags );
3695 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3696 $row = $db->selectRow( 'revision', '*',
3697 array( 'rev_page' => $pageId ),
3699 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3702 return new Revision( $row );
3709 * Get the oldest revision timestamp of this page
3711 * @param $flags Int Title::GAID_FOR_UPDATE
3712 * @return String: MW timestamp
3714 public function getEarliestRevTime( $flags = 0 ) {
3715 $rev = $this->getFirstRevision( $flags );
3716 return $rev ?
$rev->getTimestamp() : null;
3720 * Check if this is a new page
3724 public function isNewPage() {
3725 $dbr = wfGetDB( DB_SLAVE
);
3726 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3730 * Get the number of revisions between the given revision.
3731 * Used for diffs and other things that really need it.
3733 * @param $old int|Revision Old revision or rev ID (first before range)
3734 * @param $new int|Revision New revision or rev ID (first after range)
3735 * @return Int Number of revisions between these revisions.
3737 public function countRevisionsBetween( $old, $new ) {
3738 if ( !( $old instanceof Revision
) ) {
3739 $old = Revision
::newFromTitle( $this, (int)$old );
3741 if ( !( $new instanceof Revision
) ) {
3742 $new = Revision
::newFromTitle( $this, (int)$new );
3744 if ( !$old ||
!$new ) {
3745 return 0; // nothing to compare
3747 $dbr = wfGetDB( DB_SLAVE
);
3748 return (int)$dbr->selectField( 'revision', 'count(*)',
3750 'rev_page' => $this->getArticleId(),
3751 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3752 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3759 * Get the number of authors between the given revision IDs.
3760 * Used for diffs and other things that really need it.
3762 * @param $old int|Revision Old revision or rev ID (first before range)
3763 * @param $new int|Revision New revision or rev ID (first after range)
3764 * @param $limit Int Maximum number of authors
3765 * @return Int Number of revision authors between these revisions.
3767 public function countAuthorsBetween( $old, $new, $limit ) {
3768 if ( !( $old instanceof Revision
) ) {
3769 $old = Revision
::newFromTitle( $this, (int)$old );
3771 if ( !( $new instanceof Revision
) ) {
3772 $new = Revision
::newFromTitle( $this, (int)$new );
3774 if ( !$old ||
!$new ) {
3775 return 0; // nothing to compare
3777 $dbr = wfGetDB( DB_SLAVE
);
3778 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
3780 'rev_page' => $this->getArticleID(),
3781 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3782 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3784 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
3786 return (int)$dbr->numRows( $res );
3790 * Compare with another title.
3792 * @param $title Title
3795 public function equals( Title
$title ) {
3796 // Note: === is necessary for proper matching of number-like titles.
3797 return $this->getInterwiki() === $title->getInterwiki()
3798 && $this->getNamespace() == $title->getNamespace()
3799 && $this->getDBkey() === $title->getDBkey();
3803 * Callback for usort() to do title sorts by (namespace, title)
3808 * @return Integer: result of string comparison, or namespace comparison
3810 public static function compare( $a, $b ) {
3811 if ( $a->getNamespace() == $b->getNamespace() ) {
3812 return strcmp( $a->getText(), $b->getText() );
3814 return $a->getNamespace() - $b->getNamespace();
3819 * Return a string representation of this title
3821 * @return String representation of this title
3823 public function __toString() {
3824 return $this->getPrefixedText();
3828 * Check if page exists. For historical reasons, this function simply
3829 * checks for the existence of the title in the page table, and will
3830 * thus return false for interwiki links, special pages and the like.
3831 * If you want to know if a title can be meaningfully viewed, you should
3832 * probably call the isKnown() method instead.
3836 public function exists() {
3837 return $this->getArticleId() != 0;
3841 * Should links to this title be shown as potentially viewable (i.e. as
3842 * "bluelinks"), even if there's no record by this title in the page
3845 * This function is semi-deprecated for public use, as well as somewhat
3846 * misleadingly named. You probably just want to call isKnown(), which
3847 * calls this function internally.
3849 * (ISSUE: Most of these checks are cheap, but the file existence check
3850 * can potentially be quite expensive. Including it here fixes a lot of
3851 * existing code, but we might want to add an optional parameter to skip
3852 * it and any other expensive checks.)
3856 public function isAlwaysKnown() {
3857 if ( $this->mInterwiki
!= '' ) {
3858 return true; // any interwiki link might be viewable, for all we know
3860 switch( $this->mNamespace
) {
3863 // file exists, possibly in a foreign repo
3864 return (bool)wfFindFile( $this );
3866 // valid special page
3867 return SpecialPageFactory
::exists( $this->getDBkey() );
3869 // selflink, possibly with fragment
3870 return $this->mDbkeyform
== '';
3872 // known system message
3873 return $this->getDefaultMessageText() !== false;
3880 * Does this title refer to a page that can (or might) be meaningfully
3881 * viewed? In particular, this function may be used to determine if
3882 * links to the title should be rendered as "bluelinks" (as opposed to
3883 * "redlinks" to non-existent pages).
3887 public function isKnown() {
3888 return $this->isAlwaysKnown() ||
$this->exists();
3892 * Does this page have source text?
3896 public function hasSourceText() {
3897 if ( $this->exists() ) {
3901 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
3902 // If the page doesn't exist but is a known system message, default
3903 // message content will be displayed, same for language subpages
3904 return $this->getDefaultMessageText() !== false;
3911 * Get the default message text or false if the message doesn't exist
3913 * @return String or false
3915 public function getDefaultMessageText() {
3918 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
3922 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
3923 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
3925 if ( $message->exists() ) {
3926 return $message->plain();
3933 * Is this in a namespace that allows actual pages?
3936 * @internal note -- uses hardcoded namespace index instead of constants
3938 public function canExist() {
3939 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3943 * Update page_touched timestamps and send squid purge messages for
3944 * pages linking to this title. May be sent to the job queue depending
3945 * on the number of links. Typically called on create and delete.
3947 public function touchLinks() {
3948 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3951 if ( $this->getNamespace() == NS_CATEGORY
) {
3952 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3958 * Get the last touched timestamp
3960 * @param $db DatabaseBase: optional db
3961 * @return String last-touched timestamp
3963 public function getTouched( $db = null ) {
3964 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
3965 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3970 * Get the timestamp when this page was updated since the user last saw it.
3973 * @return String|Null
3975 public function getNotificationTimestamp( $user = null ) {
3976 global $wgUser, $wgShowUpdatedMarker;
3977 // Assume current user if none given
3981 // Check cache first
3982 $uid = $user->getId();
3983 // avoid isset here, as it'll return false for null entries
3984 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
3985 return $this->mNotificationTimestamp
[$uid];
3987 if ( !$uid ||
!$wgShowUpdatedMarker ) {
3988 return $this->mNotificationTimestamp
[$uid] = false;
3990 // Don't cache too much!
3991 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3992 $this->mNotificationTimestamp
= array();
3994 $dbr = wfGetDB( DB_SLAVE
);
3995 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3996 'wl_notificationtimestamp',
3997 array( 'wl_namespace' => $this->getNamespace(),
3998 'wl_title' => $this->getDBkey(),
3999 'wl_user' => $user->getId()
4003 return $this->mNotificationTimestamp
[$uid];
4007 * Get the trackback URL for this page
4009 * @return String Trackback URL
4011 public function trackbackURL() {
4012 global $wgScriptPath, $wgServer, $wgScriptExtension;
4014 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
4015 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
4019 * Get the trackback RDF for this page
4021 * @return String Trackback RDF
4023 public function trackbackRDF() {
4024 $url = htmlspecialchars( $this->getFullURL() );
4025 $title = htmlspecialchars( $this->getText() );
4026 $tburl = $this->trackbackURL();
4028 // Autodiscovery RDF is placed in comments so HTML validator
4029 // won't barf. This is a rather icky workaround, but seems
4030 // frequently used by this kind of RDF thingy.
4032 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
4034 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
4035 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
4036 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
4039 dc:identifier=\"$url\"
4041 trackback:ping=\"$tburl\" />
4047 * Generate strings used for xml 'id' names in monobook tabs
4049 * @param $prepend string defaults to 'nstab-'
4050 * @return String XML 'id' name
4052 public function getNamespaceKey( $prepend = 'nstab-' ) {
4054 // Gets the subject namespace if this title
4055 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4056 // Checks if cononical namespace name exists for namespace
4057 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4058 // Uses canonical namespace name
4059 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4061 // Uses text of namespace
4062 $namespaceKey = $this->getSubjectNsText();
4064 // Makes namespace key lowercase
4065 $namespaceKey = $wgContLang->lc( $namespaceKey );
4067 if ( $namespaceKey == '' ) {
4068 $namespaceKey = 'main';
4070 // Changes file to image for backwards compatibility
4071 if ( $namespaceKey == 'file' ) {
4072 $namespaceKey = 'image';
4074 return $prepend . $namespaceKey;
4078 * Returns true if this is a special page.
4082 public function isSpecialPage() {
4083 return $this->getNamespace() == NS_SPECIAL
;
4087 * Returns true if this title resolves to the named special page
4089 * @param $name String The special page name
4092 public function isSpecial( $name ) {
4093 if ( $this->getNamespace() == NS_SPECIAL
) {
4094 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
4095 if ( $name == $thisName ) {
4103 * If the Title refers to a special page alias which is not the local default, resolve
4104 * the alias, and localise the name as necessary. Otherwise, return $this
4108 public function fixSpecialName() {
4109 if ( $this->getNamespace() == NS_SPECIAL
) {
4110 list( $canonicalName, /*...*/ ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
4111 if ( $canonicalName ) {
4112 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName );
4113 if ( $localName != $this->mDbkeyform
) {
4114 return Title
::makeTitle( NS_SPECIAL
, $localName );
4122 * Is this Title in a namespace which contains content?
4123 * In other words, is this a content page, for the purposes of calculating
4128 public function isContentPage() {
4129 return MWNamespace
::isContent( $this->getNamespace() );
4133 * Get all extant redirects to this Title
4135 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4136 * @return Array of Title redirects to this title
4138 public function getRedirectsHere( $ns = null ) {
4141 $dbr = wfGetDB( DB_SLAVE
);
4143 'rd_namespace' => $this->getNamespace(),
4144 'rd_title' => $this->getDBkey(),
4147 if ( !is_null( $ns ) ) {
4148 $where['page_namespace'] = $ns;
4151 $res = $dbr->select(
4152 array( 'redirect', 'page' ),
4153 array( 'page_namespace', 'page_title' ),
4158 foreach ( $res as $row ) {
4159 $redirs[] = self
::newFromRow( $row );
4165 * Check if this Title is a valid redirect target
4169 public function isValidRedirectTarget() {
4170 global $wgInvalidRedirectTargets;
4172 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4173 if ( $this->isSpecial( 'Userlogout' ) ) {
4177 foreach ( $wgInvalidRedirectTargets as $target ) {
4178 if ( $this->isSpecial( $target ) ) {
4187 * Get a backlink cache object
4189 * @return object BacklinkCache
4191 function getBacklinkCache() {
4192 if ( is_null( $this->mBacklinkCache
) ) {
4193 $this->mBacklinkCache
= new BacklinkCache( $this );
4195 return $this->mBacklinkCache
;
4199 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4203 public function canUseNoindex() {
4204 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4206 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4207 ?
$wgContentNamespaces
4208 : $wgExemptFromUserRobotsControl;
4210 return !in_array( $this->mNamespace
, $bannedNamespaces );
4215 * Returns restriction types for the current Title
4217 * @return array applicable restriction types
4219 public function getRestrictionTypes() {
4220 if ( $this->getNamespace() == NS_SPECIAL
) {
4224 $types = self
::getFilteredRestrictionTypes( $this->exists() );
4226 if ( $this->getNamespace() != NS_FILE
) {
4227 # Remove the upload restriction for non-file titles
4228 $types = array_diff( $types, array( 'upload' ) );
4231 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
4233 wfDebug( __METHOD__
. ': applicable restriction types for ' .
4234 $this->getPrefixedText() . ' are ' . implode( ',', $types ) . "\n" );
4239 * Get a filtered list of all restriction types supported by this wiki.
4240 * @param bool $exists True to get all restriction types that apply to
4241 * titles that do exist, False for all restriction types that apply to
4242 * titles that do not exist
4245 public static function getFilteredRestrictionTypes( $exists = true ) {
4246 global $wgRestrictionTypes;
4247 $types = $wgRestrictionTypes;
4249 # Remove the create restriction for existing titles
4250 $types = array_diff( $types, array( 'create' ) );
4252 # Only the create and upload restrictions apply to non-existing titles
4253 $types = array_intersect( $types, array( 'create', 'upload' ) );
4259 * Returns the raw sort key to be used for categories, with the specified
4260 * prefix. This will be fed to Collation::getSortKey() to get a
4261 * binary sortkey that can be used for actual sorting.
4263 * @param $prefix string The prefix to be used, specified using
4264 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4268 public function getCategorySortkey( $prefix = '' ) {
4269 $unprefixed = $this->getText();
4271 // Anything that uses this hook should only depend
4272 // on the Title object passed in, and should probably
4273 // tell the users to run updateCollations.php --force
4274 // in order to re-sort existing category relations.
4275 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4276 if ( $prefix !== '' ) {
4277 # Separate with a line feed, so the unprefixed part is only used as
4278 # a tiebreaker when two pages have the exact same prefix.
4279 # In UCA, tab is the only character that can sort above LF
4280 # so we strip both of them from the original prefix.
4281 $prefix = strtr( $prefix, "\n\t", ' ' );
4282 return "$prefix\n$unprefixed";
4288 * Get the language in which the content of this page is written.
4289 * Defaults to $wgContLang, but in certain cases it can be e.g.
4290 * $wgLang (such as special pages, which are in the user language).
4293 * @return object Language
4295 public function getPageLanguage() {
4297 if ( $this->getNamespace() == NS_SPECIAL
) {
4298 // special pages are in the user language
4300 } elseif ( $this->isRedirect() ) {
4301 // the arrow on a redirect page is aligned according to the user language
4303 } elseif ( $this->isCssOrJsPage() ) {
4304 // css/js should always be LTR and is, in fact, English
4305 return wfGetLangObj( 'en' );
4306 } elseif ( $this->getNamespace() == NS_MEDIAWIKI
) {
4307 // Parse mediawiki messages with correct target language
4308 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $this->getText() );
4309 return wfGetLangObj( $lang );
4312 // If nothing special, it should be in the wiki content language
4313 $pageLang = $wgContLang;
4314 // Hook at the end because we don't want to override the above stuff
4315 wfRunHooks( 'PageContentLanguage', array( $this, &$pageLang, $wgLang ) );
4316 return wfGetLangObj( $pageLang );
4321 * A BadTitle is generated in MediaWiki::parseTitle() if the title is invalid; the
4322 * software uses this to display an error page. Internally it's basically a Title
4323 * for an empty special page
4325 class BadTitle
extends Title
{
4326 public function __construct(){
4327 $this->mTextform
= '';
4328 $this->mUrlform
= '';
4329 $this->mDbkeyform
= '';
4330 $this->mNamespace
= NS_SPECIAL
; // Stops talk page link, etc, being shown
4333 public function exists(){
4337 public function getPrefixedText(){
4341 public function getText(){
4345 public function getPrefixedURL(){
4349 public function getPrefixedDBKey(){