7 if ( !class_exists( 'UtfNormal' ) ) {
8 require_once( dirname(__FILE__
) . '/normal/UtfNormal.php' );
11 define ( 'GAID_FOR_UPDATE', 1 );
15 * Constants for pr_cascade bitfield
17 define( 'CASCADE', 1 );
20 * Represents a title within MediaWiki.
21 * Optionally may contain an interwiki designation or namespace.
22 * @note This class can fetch various kinds of data from the database;
23 * however, it does so inefficiently.
26 /** @name Static cache variables */
28 static private $titleCache=array();
29 static private $interwikiCache=array();
33 * Title::newFromText maintains a cache to avoid expensive re-normalization of
34 * commonly used titles. On a batch operation this can become a memory leak
35 * if not bounded. After hitting this many titles reset the cache.
37 const CACHE_MAX
= 1000;
41 * @name Private member variables
42 * Please use the accessor functions instead.
47 var $mTextform = ''; ///< Text form (spaces not underscores) of the main part
48 var $mUrlform = ''; ///< URL-encoded form of the main part
49 var $mDbkeyform = ''; ///< Main part with underscores
50 var $mUserCaseDBKey; ///< DB key with the initial letter in the case specified by the user
51 var $mNamespace = NS_MAIN
; ///< Namespace index, i.e. one of the NS_xxxx constants
52 var $mInterwiki = ''; ///< Interwiki prefix (or null string)
53 var $mFragment; ///< Title fragment (i.e. the bit after the #)
54 var $mArticleID = -1; ///< Article ID, fetched from the link cache on demand
55 var $mLatestID = false; ///< ID of most recent revision
56 var $mRestrictions = array(); ///< Array of groups allowed to edit this article
57 var $mOldRestrictions = false;
58 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
59 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
60 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
61 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
62 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
63 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
64 # Don't change the following default, NS_MAIN is hardcoded in several
65 # places. See bug 696.
66 var $mDefaultNamespace = NS_MAIN
; ///< Namespace index when there is no namespace
67 # Zero except in {{transclusion}} tags
68 var $mWatched = null; ///< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
69 var $mLength = -1; ///< The page length, 0 for special pages
70 var $mRedirect = null; ///< Is the article at this title a redirect?
71 var $mNotificationTimestamp = array(); ///< Associative array of user ID -> timestamp/false
79 /* private */ function __construct() {}
82 * Create a new Title from a prefixed DB key
83 * @param $key \type{\string} The database key, which has underscores
84 * instead of spaces, possibly including namespace and
86 * @return \type{Title} the new object, or NULL on an error
88 public static function newFromDBkey( $key ) {
90 $t->mDbkeyform
= $key;
91 if( $t->secureAndSplit() )
98 * Create a new Title from text, such as what one would find in a link. De-
99 * codes any HTML entities in the text.
101 * @param $text string The link text; spaces, prefixes, and an
102 * initial ':' indicating the main namespace are accepted.
103 * @param $defaultNamespace int The namespace to use if none is speci-
104 * fied by a prefix. If you want to force a specific namespace even if
105 * $text might begin with a namespace prefix, use makeTitle() or
107 * @return Title The new object, or null on an error.
109 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
110 if( is_object( $text ) ) {
111 throw new MWException( 'Title::newFromText given an object' );
115 * Wiki pages often contain multiple links to the same page.
116 * Title normalization and parsing can become expensive on
117 * pages with many links, so we can save a little time by
120 * In theory these are value objects and won't get changed...
122 if( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
123 return Title
::$titleCache[$text];
127 * Convert things like é ā or 〗 into real text...
129 $filteredText = Sanitizer
::decodeCharReferences( $text );
132 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
133 $t->mDefaultNamespace
= $defaultNamespace;
135 static $cachedcount = 0 ;
136 if( $t->secureAndSplit() ) {
137 if( $defaultNamespace == NS_MAIN
) {
138 if( $cachedcount >= self
::CACHE_MAX
) {
139 # Avoid memory leaks on mass operations...
140 Title
::$titleCache = array();
144 Title
::$titleCache[$text] =& $t;
154 * Create a new Title from URL-encoded text. Ensures that
155 * the given title's length does not exceed the maximum.
156 * @param $url \type{\string} the title, as might be taken from a URL
157 * @return \type{Title} the new object, or NULL on an error
159 public static function newFromURL( $url ) {
160 global $wgLegalTitleChars;
163 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
164 # but some URLs used it as a space replacement and they still come
165 # from some external search tools.
166 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
167 $url = str_replace( '+', ' ', $url );
170 $t->mDbkeyform
= str_replace( ' ', '_', $url );
171 if( $t->secureAndSplit() ) {
179 * Create a new Title from an article ID
181 * @todo This is inefficiently implemented, the page row is requested
182 * but not used for anything else
184 * @param $id \type{\int} the page_id corresponding to the Title to create
185 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
186 * @return \type{Title} the new object, or NULL on an error
188 public static function newFromID( $id, $flags = 0 ) {
189 $fname = 'Title::newFromID';
190 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
191 $row = $db->selectRow( 'page', array( 'page_namespace', 'page_title' ),
192 array( 'page_id' => $id ), $fname );
193 if ( $row !== false ) {
194 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
202 * Make an array of titles from an array of IDs
203 * @param $ids \type{\arrayof{\int}} Array of IDs
204 * @return \type{\arrayof{Title}} Array of Titles
206 public static function newFromIDs( $ids ) {
207 if ( !count( $ids ) ) {
210 $dbr = wfGetDB( DB_SLAVE
);
211 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
212 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
215 foreach( $res as $row ) {
216 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
222 * Make a Title object from a DB row
223 * @param $row \type{Row} (needs at least page_title,page_namespace)
224 * @return \type{Title} corresponding Title
226 public static function newFromRow( $row ) {
227 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
229 $t->mArticleID
= isset($row->page_id
) ?
intval($row->page_id
) : -1;
230 $t->mLength
= isset($row->page_len
) ?
intval($row->page_len
) : -1;
231 $t->mRedirect
= isset($row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: NULL;
232 $t->mLatestID
= isset($row->page_latest
) ?
$row->page_latest
: false;
238 * Create a new Title from a namespace index and a DB key.
239 * It's assumed that $ns and $title are *valid*, for instance when
240 * they came directly from the database or a special page name.
241 * For convenience, spaces are converted to underscores so that
242 * eg user_text fields can be used directly.
244 * @param $ns \type{\int} the namespace of the article
245 * @param $title \type{\string} the unprefixed database key form
246 * @param $fragment \type{\string} The link fragment (after the "#")
247 * @return \type{Title} the new object
249 public static function &makeTitle( $ns, $title, $fragment = '' ) {
252 $t->mFragment
= $fragment;
253 $t->mNamespace
= $ns = intval( $ns );
254 $t->mDbkeyform
= str_replace( ' ', '_', $title );
255 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
256 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
257 $t->mTextform
= str_replace( '_', ' ', $title );
262 * Create a new Title from a namespace index and a DB key.
263 * The parameters will be checked for validity, which is a bit slower
264 * than makeTitle() but safer for user-provided data.
266 * @param $ns \type{\int} the namespace of the article
267 * @param $title \type{\string} the database key form
268 * @param $fragment \type{\string} The link fragment (after the "#")
269 * @return \type{Title} the new object, or NULL on an error
271 public static function makeTitleSafe( $ns, $title, $fragment = '' ) {
273 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment );
274 if( $t->secureAndSplit() ) {
282 * Create a new Title for the Main Page
283 * @return \type{Title} the new object
285 public static function newMainPage() {
286 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
287 // Don't give fatal errors if the message is broken
289 $title = Title
::newFromText( 'Main Page' );
295 * Extract a redirect destination from a string and return the
296 * Title, or null if the text doesn't contain a valid redirect
298 * @param $text \type{String} Text with possible redirect
299 * @return \type{Title} The corresponding Title
301 public static function newFromRedirect( $text ) {
302 $redir = MagicWord
::get( 'redirect' );
304 if( $redir->matchStartAndRemove( $text ) ) {
305 // Extract the first link and see if it's usable
306 // Ensure that it really does come directly after #REDIRECT
307 // Some older redirects included a colon, so don't freak about that!
309 if( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
310 // Strip preceding colon used to "escape" categories, etc.
311 // and URL-decode links
312 if( strpos( $m[1], '%' ) !== false ) {
313 // Match behavior of inline link parsing here;
314 // don't interpret + as " " most of the time!
315 // It might be safe to just use rawurldecode instead, though.
316 $m[1] = urldecode( ltrim( $m[1], ':' ) );
318 $title = Title
::newFromText( $m[1] );
319 // Redirects to some special pages are not permitted
320 if( $title instanceof Title
321 && !$title->isSpecial( 'Userlogout' )
322 && !$title->isSpecial( 'Filepath' ) )
331 #----------------------------------------------------------------------------
333 #----------------------------------------------------------------------------
336 * Get the prefixed DB key associated with an ID
337 * @param $id \type{\int} the page_id of the article
338 * @return \type{Title} an object representing the article, or NULL
339 * if no such article was found
341 public static function nameOf( $id ) {
342 $dbr = wfGetDB( DB_SLAVE
);
344 $s = $dbr->selectRow( 'page',
345 array( 'page_namespace','page_title' ),
346 array( 'page_id' => $id ),
348 if ( $s === false ) { return NULL; }
350 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
355 * Get a regex character class describing the legal characters in a link
356 * @return \type{\string} the list of characters, not delimited
358 public static function legalChars() {
359 global $wgLegalTitleChars;
360 return $wgLegalTitleChars;
364 * Get a string representation of a title suitable for
365 * including in a search index
367 * @param $ns \type{\int} a namespace index
368 * @param $title \type{\string} text-form main part
369 * @return \type{\string} a stripped-down title string ready for the
372 public static function indexTitle( $ns, $title ) {
375 $lc = SearchEngine
::legalSearchChars() . '&#;';
376 $t = $wgContLang->stripForSearch( $title );
377 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
378 $t = $wgContLang->lc( $t );
381 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
382 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
384 $t = preg_replace( "/\\s+/", ' ', $t );
386 if ( $ns == NS_FILE
) {
387 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
393 * Make a prefixed DB key from a DB key and a namespace index
394 * @param $ns \type{\int} numerical representation of the namespace
395 * @param $title \type{\string} the DB key form the title
396 * @param $fragment \type{\string} The link fragment (after the "#")
397 * @return \type{\string} the prefixed form of the title
399 public static function makeName( $ns, $title, $fragment = '' ) {
402 $namespace = $wgContLang->getNsText( $ns );
403 $name = $namespace == '' ?
$title : "$namespace:$title";
404 if ( strval( $fragment ) != '' ) {
405 $name .= '#' . $fragment;
411 * Returns the URL associated with an interwiki prefix
412 * @param $key \type{\string} the interwiki prefix (e.g. "MeatBall")
413 * @return \type{\string} the associated URL, containing "$1",
414 * which should be replaced by an article title
416 * @deprecated See Interwiki class
418 public function getInterwikiLink( $key ) {
419 return Interwiki
::fetch( $key )->getURL( );
423 * Determine whether the object refers to a page within
426 * @return \type{\bool} TRUE if this is an in-project interwiki link
427 * or a wikilink, FALSE otherwise
429 public function isLocal() {
430 if ( $this->mInterwiki
!= '' ) {
431 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
438 * Determine whether the object refers to a page within
439 * this project and is transcludable.
441 * @return \type{\bool} TRUE if this is transcludable
443 public function isTrans() {
444 if ($this->mInterwiki
== '')
447 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
451 * Escape a text fragment, say from a link, for a URL
453 static function escapeFragmentForURL( $fragment ) {
454 global $wgEnforceHtmlIds;
455 # Note that we don't urlencode the fragment. urlencoded Unicode
456 # fragments appear not to work in IE (at least up to 7) or in at least
457 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
458 # to care if they aren't encoded.
459 return Sanitizer
::escapeId( $fragment,
460 $wgEnforceHtmlIds ?
'noninitial' : 'xml' );
463 #----------------------------------------------------------------------------
465 #----------------------------------------------------------------------------
467 /** Simple accessors */
469 * Get the text form (spaces not underscores) of the main part
470 * @return \type{\string} Main part of the title
472 public function getText() { return $this->mTextform
; }
474 * Get the URL-encoded form of the main part
475 * @return \type{\string} Main part of the title, URL-encoded
477 public function getPartialURL() { return $this->mUrlform
; }
479 * Get the main part with underscores
480 * @return \type{\string} Main part of the title, with underscores
482 public function getDBkey() { return $this->mDbkeyform
; }
484 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
485 * @return \type{\int} Namespace index
487 public function getNamespace() { return $this->mNamespace
; }
489 * Get the namespace text
490 * @return \type{\string} Namespace text
492 public function getNsText() {
493 global $wgContLang, $wgCanonicalNamespaceNames;
495 if ( '' != $this->mInterwiki
) {
496 // This probably shouldn't even happen. ohh man, oh yuck.
497 // But for interwiki transclusion it sometimes does.
498 // Shit. Shit shit shit.
500 // Use the canonical namespaces if possible to try to
501 // resolve a foreign namespace.
502 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
503 return $wgCanonicalNamespaceNames[$this->mNamespace
];
506 return $wgContLang->getNsText( $this->mNamespace
);
509 * Get the DB key with the initial letter case as specified by the user
510 * @return \type{\string} DB key
512 function getUserCaseDBKey() {
513 return $this->mUserCaseDBKey
;
516 * Get the namespace text of the subject (rather than talk) page
517 * @return \type{\string} Namespace text
519 public function getSubjectNsText() {
521 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
524 * Get the namespace text of the talk page
525 * @return \type{\string} Namespace text
527 public function getTalkNsText() {
529 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
532 * Could this title have a corresponding talk page?
533 * @return \type{\bool} TRUE or FALSE
535 public function canTalk() {
536 return( MWNamespace
::canTalk( $this->mNamespace
) );
539 * Get the interwiki prefix (or null string)
540 * @return \type{\string} Interwiki prefix
542 public function getInterwiki() { return $this->mInterwiki
; }
544 * Get the Title fragment (i.e.\ the bit after the #) in text form
545 * @return \type{\string} Title fragment
547 public function getFragment() { return $this->mFragment
; }
549 * Get the fragment in URL form, including the "#" character if there is one
550 * @return \type{\string} Fragment in URL form
552 public function getFragmentForURL() {
553 if ( $this->mFragment
== '' ) {
556 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
560 * Get the default namespace index, for when there is no namespace
561 * @return \type{\int} Default namespace index
563 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
566 * Get title for search index
567 * @return \type{\string} a stripped-down title string ready for the
570 public function getIndexTitle() {
571 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
575 * Get the prefixed database key form
576 * @return \type{\string} the prefixed title, with underscores and
577 * any interwiki and namespace prefixes
579 public function getPrefixedDBkey() {
580 $s = $this->prefix( $this->mDbkeyform
);
581 $s = str_replace( ' ', '_', $s );
586 * Get the prefixed title with spaces.
587 * This is the form usually used for display
588 * @return \type{\string} the prefixed title, with spaces
590 public function getPrefixedText() {
591 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
592 $s = $this->prefix( $this->mTextform
);
593 $s = str_replace( '_', ' ', $s );
594 $this->mPrefixedText
= $s;
596 return $this->mPrefixedText
;
600 * Get the prefixed title with spaces, plus any fragment
601 * (part beginning with '#')
602 * @return \type{\string} the prefixed title, with spaces and
603 * the fragment, including '#'
605 public function getFullText() {
606 $text = $this->getPrefixedText();
607 if( '' != $this->mFragment
) {
608 $text .= '#' . $this->mFragment
;
614 * Get the base name, i.e. the leftmost parts before the /
615 * @return \type{\string} Base name
617 public function getBaseText() {
618 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
619 return $this->getText();
622 $parts = explode( '/', $this->getText() );
623 # Don't discard the real title if there's no subpage involved
624 if( count( $parts ) > 1 )
625 unset( $parts[ count( $parts ) - 1 ] );
626 return implode( '/', $parts );
630 * Get the lowest-level subpage name, i.e. the rightmost part after /
631 * @return \type{\string} Subpage name
633 public function getSubpageText() {
634 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
635 return( $this->mTextform
);
637 $parts = explode( '/', $this->mTextform
);
638 return( $parts[ count( $parts ) - 1 ] );
642 * Get a URL-encoded form of the subpage text
643 * @return \type{\string} URL-encoded subpage name
645 public function getSubpageUrlForm() {
646 $text = $this->getSubpageText();
647 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
652 * Get a URL-encoded title (not an actual URL) including interwiki
653 * @return \type{\string} the URL-encoded form
655 public function getPrefixedURL() {
656 $s = $this->prefix( $this->mDbkeyform
);
657 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
662 * Get a real URL referring to this title, with interwiki link and
665 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
666 * links. Can be specified as an associative array as well, e.g.,
667 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
668 * @param $variant \type{\string} language variant of url (for sr, zh..)
669 * @return \type{\string} the URL
671 public function getFullURL( $query = '', $variant = false ) {
672 global $wgContLang, $wgServer, $wgRequest;
674 if( is_array( $query ) ) {
675 $query = wfArrayToCGI( $query );
678 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
680 $url = $this->getLocalUrl( $query, $variant );
682 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
683 // Correct fix would be to move the prepending elsewhere.
684 if ($wgRequest->getVal('action') != 'render') {
685 $url = $wgServer . $url;
688 $baseUrl = $interwiki->getURL( );
690 $namespace = wfUrlencode( $this->getNsText() );
691 if ( '' != $namespace ) {
692 # Can this actually happen? Interwikis shouldn't be parsed.
693 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
696 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
697 $url = wfAppendQuery( $url, $query );
700 # Finally, add the fragment.
701 $url .= $this->getFragmentForURL();
703 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
708 * Get a URL with no fragment or server name. If this page is generated
709 * with action=render, $wgServer is prepended.
710 * @param mixed $query an optional query string; if not specified,
711 * $wgArticlePath will be used. Can be specified as an associative array
712 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
714 * @param $variant \type{\string} language variant of url (for sr, zh..)
715 * @return \type{\string} the URL
717 public function getLocalURL( $query = '', $variant = false ) {
718 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
719 global $wgVariantArticlePath, $wgContLang, $wgUser;
721 if( is_array( $query ) ) {
722 $query = wfArrayToCGI( $query );
725 // internal links should point to same variant as current page (only anonymous users)
726 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
727 $pref = $wgContLang->getPreferredVariant(false);
728 if($pref != $wgContLang->getCode())
732 if ( $this->isExternal() ) {
733 $url = $this->getFullURL();
735 // This is currently only used for edit section links in the
736 // context of interwiki transclusion. In theory we should
737 // append the query to the end of any existing query string,
738 // but interwiki transclusion is already broken in that case.
742 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
743 if ( $query == '' ) {
744 if( $variant != false && $wgContLang->hasVariants() ) {
745 if( $wgVariantArticlePath == false ) {
746 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
748 $variantArticlePath = $wgVariantArticlePath;
750 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
751 $url = str_replace( '$1', $dbkey, $url );
753 $url = str_replace( '$1', $dbkey, $wgArticlePath );
756 global $wgActionPaths;
759 if( !empty( $wgActionPaths ) &&
760 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
762 $action = urldecode( $matches[2] );
763 if( isset( $wgActionPaths[$action] ) ) {
764 $query = $matches[1];
765 if( isset( $matches[4] ) ) $query .= $matches[4];
766 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
768 $url = wfAppendQuery( $url, $query );
772 if ( $url === false ) {
773 if ( $query == '-' ) {
776 $url = "{$wgScript}?title={$dbkey}&{$query}";
780 // FIXME: this causes breakage in various places when we
781 // actually expected a local URL and end up with dupe prefixes.
782 if ($wgRequest->getVal('action') == 'render') {
783 $url = $wgServer . $url;
786 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
791 * Get a URL that's the simplest URL that will be valid to link, locally,
792 * to the current Title. It includes the fragment, but does not include
793 * the server unless action=render is used (or the link is external). If
794 * there's a fragment but the prefixed text is empty, we just return a link
797 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
798 * query string. Keys and values will be escaped.
799 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
800 * for external links. Default is "false" (same variant as current page,
801 * for anonymous users).
802 * @return \type{\string} the URL
804 public function getLinkUrl( $query = array(), $variant = false ) {
805 if( !is_array( $query ) ) {
806 throw new MWException( 'Title::getLinkUrl passed a non-array for '.
809 if( $this->isExternal() ) {
810 return $this->getFullURL( $query );
811 } elseif( $this->getPrefixedText() === ''
812 and $this->getFragment() !== '' ) {
813 return $this->getFragmentForURL();
815 return $this->getLocalURL( $query, $variant )
816 . $this->getFragmentForURL();
821 * Get an HTML-escaped version of the URL form, suitable for
822 * using in a link, without a server name or fragment
823 * @param $query \type{\string} an optional query string
824 * @return \type{\string} the URL
826 public function escapeLocalURL( $query = '' ) {
827 return htmlspecialchars( $this->getLocalURL( $query ) );
831 * Get an HTML-escaped version of the URL form, suitable for
832 * using in a link, including the server name and fragment
834 * @param $query \type{\string} an optional query string
835 * @return \type{\string} the URL
837 public function escapeFullURL( $query = '' ) {
838 return htmlspecialchars( $this->getFullURL( $query ) );
842 * Get the URL form for an internal link.
843 * - Used in various Squid-related code, in case we have a different
844 * internal hostname for the server from the exposed one.
846 * @param $query \type{\string} an optional query string
847 * @param $variant \type{\string} language variant of url (for sr, zh..)
848 * @return \type{\string} the URL
850 public function getInternalURL( $query = '', $variant = false ) {
851 global $wgInternalServer;
852 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
853 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
858 * Get the edit URL for this Title
859 * @return \type{\string} the URL, or a null string if this is an
862 public function getEditURL() {
863 if ( '' != $this->mInterwiki
) { return ''; }
864 $s = $this->getLocalURL( 'action=edit' );
870 * Get the HTML-escaped displayable text form.
871 * Used for the title field in <a> tags.
872 * @return \type{\string} the text, including any prefixes
874 public function getEscapedText() {
875 return htmlspecialchars( $this->getPrefixedText() );
879 * Is this Title interwiki?
880 * @return \type{\bool}
882 public function isExternal() { return ( '' != $this->mInterwiki
); }
885 * Is this page "semi-protected" - the *only* protection is autoconfirm?
887 * @param @action \type{\string} Action to check (default: edit)
888 * @return \type{\bool}
890 public function isSemiProtected( $action = 'edit' ) {
891 if( $this->exists() ) {
892 $restrictions = $this->getRestrictions( $action );
893 if( count( $restrictions ) > 0 ) {
894 foreach( $restrictions as $restriction ) {
895 if( strtolower( $restriction ) != 'autoconfirmed' )
904 # If it doesn't exist, it can't be protected
910 * Does the title correspond to a protected article?
911 * @param $what \type{\string} the action the page is protected from,
912 * by default checks move and edit
913 * @return \type{\bool}
915 public function isProtected( $action = '' ) {
916 global $wgRestrictionLevels, $wgRestrictionTypes;
918 # Special pages have inherent protection
919 if( $this->getNamespace() == NS_SPECIAL
)
922 # Check regular protection levels
923 foreach( $wgRestrictionTypes as $type ){
924 if( $action == $type ||
$action == '' ) {
925 $r = $this->getRestrictions( $type );
926 foreach( $wgRestrictionLevels as $level ) {
927 if( in_array( $level, $r ) && $level != '' ) {
938 * Is $wgUser watching this page?
939 * @return \type{\bool}
941 public function userIsWatching() {
944 if ( is_null( $this->mWatched
) ) {
945 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
946 $this->mWatched
= false;
948 $this->mWatched
= $wgUser->isWatched( $this );
951 return $this->mWatched
;
955 * Can $wgUser perform $action on this page?
956 * This skips potentially expensive cascading permission checks.
958 * Suitable for use for nonessential UI controls in common cases, but
959 * _not_ for functional access control.
961 * May provide false positives, but should never provide a false negative.
963 * @param $action \type{\string} action that permission needs to be checked for
964 * @return \type{\bool}
966 public function quickUserCan( $action ) {
967 return $this->userCan( $action, false );
971 * Determines if $wgUser is unable to edit this page because it has been protected
972 * by $wgNamespaceProtection.
974 * @return \type{\bool}
976 public function isNamespaceProtected() {
977 global $wgNamespaceProtection, $wgUser;
978 if( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
979 foreach( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
980 if( $right != '' && !$wgUser->isAllowed( $right ) )
988 * Can $wgUser perform $action on this page?
989 * @param $action \type{\string} action that permission needs to be checked for
990 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
991 * @return \type{\bool}
993 public function userCan( $action, $doExpensiveQueries = true ) {
995 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries ) === array());
999 * Can $user perform $action on this page?
1001 * FIXME: This *does not* check throttles (User::pingLimiter()).
1003 * @param $action \type{\string}action that permission needs to be checked for
1004 * @param $user \type{User} user to check
1005 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1006 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1007 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1009 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1010 if( !StubObject
::isRealObject( $user ) ) {
1011 //Since StubObject is always used on globals, we can unstub $wgUser here and set $user = $wgUser
1013 $wgUser->_unstub( '', 5 );
1016 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1020 global $wgEmailConfirmToEdit;
1022 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1023 $errors[] = array( 'confirmedittext' );
1026 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1027 if ( $user->isBlockedFrom( $this ) && $action != 'read' && $action != 'createaccount' ) {
1028 $block = $user->mBlock
;
1030 // This is from OutputPage::blockedPage
1031 // Copied at r23888 by werdna
1033 $id = $user->blockedBy();
1034 $reason = $user->blockedFor();
1035 if( $reason == '' ) {
1036 $reason = wfMsg( 'blockednoreason' );
1040 if ( is_numeric( $id ) ) {
1041 $name = User
::whoIs( $id );
1046 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1047 $blockid = $block->mId
;
1048 $blockExpiry = $user->mBlock
->mExpiry
;
1049 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1051 if ( $blockExpiry == 'infinity' ) {
1052 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1053 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1055 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1056 if ( strpos( $option, ':' ) == false )
1059 list ($show, $value) = explode( ":", $option );
1061 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1062 $blockExpiry = $show;
1067 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1070 $intended = $user->mBlock
->mAddress
;
1072 $errors[] = array( ($block->mAuto ?
'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name,
1073 $blockid, $blockExpiry, $intended, $blockTimestamp );
1076 // Remove the errors being ignored.
1078 foreach( $errors as $index => $error ) {
1079 $error_key = is_array($error) ?
$error[0] : $error;
1081 if (in_array( $error_key, $ignoreErrors )) {
1082 unset($errors[$index]);
1090 * Can $user perform $action on this page? This is an internal function,
1091 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1092 * checks on wfReadOnly() and blocks)
1094 * @param $action \type{\string} action that permission needs to be checked for
1095 * @param $user \type{User} user to check
1096 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1097 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1099 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1100 wfProfileIn( __METHOD__
);
1104 // Use getUserPermissionsErrors instead
1105 if( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1106 wfProfileOut( __METHOD__
);
1107 return $result ?
array() : array( array( 'badaccess-group0' ) );
1110 if( !wfRunHooks( 'getUserPermissionsErrors', array(&$this,&$user,$action,&$result) ) ) {
1111 if( is_array($result) && count($result) && !is_array($result[0]) )
1112 $errors[] = $result; # A single array representing an error
1113 else if( is_array($result) && is_array($result[0]) )
1114 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1115 else if( $result !== '' && is_string($result) )
1116 $errors[] = array($result); # A string representing a message-id
1117 else if( $result === false )
1118 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1120 if( $doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array(&$this,&$user,$action,&$result) ) ) {
1121 if( is_array($result) && count($result) && !is_array($result[0]) )
1122 $errors[] = $result; # A single array representing an error
1123 else if( is_array($result) && is_array($result[0]) )
1124 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1125 else if( $result !== '' && is_string($result) )
1126 $errors[] = array($result); # A string representing a message-id
1127 else if( $result === false )
1128 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1132 $specialOKActions = array( 'createaccount', 'execute' );
1133 if( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions) ) {
1134 $errors[] = array('ns-specialprotected');
1137 if( $this->isNamespaceProtected() ) {
1138 $ns = $this->getNamespace() == NS_MAIN ?
1139 wfMsg( 'nstab-main' ) : $this->getNsText();
1140 $errors[] = NS_MEDIAWIKI
== $this->mNamespace ?
1141 array('protectedinterface') : array( 'namespaceprotected', $ns );
1144 # protect css/js subpages of user pages
1145 # XXX: this might be better using restrictions
1146 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1147 if( $this->isCssJsSubpage() && !$user->isAllowed('editusercssjs')
1148 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform
) )
1150 $errors[] = array('customcssjsprotected');
1153 if( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1154 # We /could/ use the protection level on the source page, but it's fairly ugly
1155 # as we have to establish a precedence hierarchy for pages included by multiple
1156 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1157 # as they could remove the protection anyway.
1158 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1159 # Cascading protection depends on more than this page...
1160 # Several cascading protected pages may include this page...
1161 # Check each cascading level
1162 # This is only for protection restrictions, not for all actions
1163 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1164 foreach( $restrictions[$action] as $right ) {
1165 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1166 if( '' != $right && !$user->isAllowed( $right ) ) {
1168 foreach( $cascadingSources as $page )
1169 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1170 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1176 foreach( $this->getRestrictions($action) as $right ) {
1177 // Backwards compatibility, rewrite sysop -> protect
1178 if( $right == 'sysop' ) {
1181 if( '' != $right && !$user->isAllowed( $right ) ) {
1182 // Users with 'editprotected' permission can edit protected pages
1183 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1184 // Users with 'editprotected' permission cannot edit protected pages
1185 // with cascading option turned on.
1186 if( $this->mCascadeRestriction
) {
1187 $errors[] = array( 'protectedpagetext', $right );
1189 // Nothing, user can edit!
1192 $errors[] = array( 'protectedpagetext', $right );
1197 if( $action == 'protect' ) {
1198 if( $this->getUserPermissionsErrors('edit', $user) != array() ) {
1199 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1203 if( $action == 'create' ) {
1204 $title_protection = $this->getTitleProtection();
1205 if( is_array($title_protection) ) {
1206 extract($title_protection); // is this extract() really needed?
1208 if( $pt_create_perm == 'sysop' ) {
1209 $pt_create_perm = 'protect'; // B/C
1211 if( $pt_create_perm == '' ||
!$user->isAllowed($pt_create_perm) ) {
1212 $errors[] = array( 'titleprotected', User
::whoIs($pt_user), $pt_reason );
1216 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1217 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) )
1219 $errors[] = $user->isAnon() ?
array ('nocreatetext') : array ('nocreate-loggedin');
1221 } elseif( $action == 'move' ) {
1222 if( !$user->isAllowed( 'move' ) ) {
1223 // User can't move anything
1224 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1225 } elseif( !$user->isAllowed( 'move-rootuserpages' )
1226 && $this->getNamespace() == NS_USER
&& !$this->isSubpage() )
1228 // Show user page-specific message only if the user can move other pages
1229 $errors[] = array( 'cant-move-user-page' );
1231 // Check if user is allowed to move files if it's a file
1232 if( $this->getNamespace() == NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1233 $errors[] = array( 'movenotallowedfile' );
1235 // Check for immobile pages
1236 if( !MWNamespace
::isMovable( $this->getNamespace() ) ) {
1237 // Specific message for this case
1238 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1239 } elseif( !$this->isMovable() ) {
1240 // Less specific message for rarer cases
1241 $errors[] = array( 'immobile-page' );
1243 } elseif( $action == 'move-target' ) {
1244 if( !$user->isAllowed( 'move' ) ) {
1245 // User can't move anything
1246 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1247 } elseif( !$user->isAllowed( 'move-rootuserpages' )
1248 && $this->getNamespace() == NS_USER
&& !$this->isSubpage() )
1250 // Show user page-specific message only if the user can move other pages
1251 $errors[] = array( 'cant-move-to-user-page' );
1253 if( !MWNamespace
::isMovable( $this->getNamespace() ) ) {
1254 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1255 } elseif( !$this->isMovable() ) {
1256 $errors[] = array( 'immobile-target-page' );
1258 } elseif( !$user->isAllowed( $action ) ) {
1260 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1261 User
::getGroupsWithPermission( $action ) );
1263 $return = array( 'badaccess-groups',
1264 array( implode( ', ', $groups ), count( $groups ) ) );
1266 $return = array( "badaccess-group0" );
1268 $errors[] = $return;
1271 wfProfileOut( __METHOD__
);
1276 * Is this title subject to title protection?
1277 * @return \type{\mixed} An associative array representing any existent title
1278 * protection, or false if there's none.
1280 private function getTitleProtection() {
1281 // Can't protect pages in special namespaces
1282 if ( $this->getNamespace() < 0 ) {
1286 $dbr = wfGetDB( DB_SLAVE
);
1287 $res = $dbr->select( 'protected_titles', '*',
1288 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1291 if ($row = $dbr->fetchRow( $res )) {
1299 * Update the title protection status
1300 * @param $create_perm \type{\string} Permission required for creation
1301 * @param $reason \type{\string} Reason for protection
1302 * @param $expiry \type{\string} Expiry timestamp
1304 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1305 global $wgUser,$wgContLang;
1307 if ($create_perm == implode(',',$this->getRestrictions('create'))
1308 && $expiry == $this->mRestrictionsExpiry
['create']) {
1313 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1315 $dbw = wfGetDB( DB_MASTER
);
1317 $encodedExpiry = Block
::encodeExpiry($expiry, $dbw );
1319 $expiry_description = '';
1320 if ( $encodedExpiry != 'infinity' ) {
1321 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) , $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ).')';
1324 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ).')';
1327 # Update protection table
1328 if ($create_perm != '' ) {
1329 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1330 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1331 , 'pt_create_perm' => $create_perm
1332 , 'pt_timestamp' => Block
::encodeExpiry(wfTimestampNow(), $dbw)
1333 , 'pt_expiry' => $encodedExpiry
1334 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__
);
1336 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1337 'pt_title' => $title ), __METHOD__
);
1339 # Update the protection log
1340 $log = new LogPage( 'protect' );
1342 if( $create_perm ) {
1343 $params = array("[create=$create_perm] $expiry_description",'');
1344 $log->addEntry( $this->mRestrictions
['create'] ?
'modify' : 'protect', $this, trim( $reason ), $params );
1346 $log->addEntry( 'unprotect', $this, $reason );
1353 * Remove any title protection due to page existing
1355 public function deleteTitleProtection() {
1356 $dbw = wfGetDB( DB_MASTER
);
1358 $dbw->delete( 'protected_titles',
1359 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1364 * Can $wgUser edit this page?
1365 * @return \type{\bool} TRUE or FALSE
1366 * @deprecated use userCan('edit')
1368 public function userCanEdit( $doExpensiveQueries = true ) {
1369 return $this->userCan( 'edit', $doExpensiveQueries );
1373 * Can $wgUser create this page?
1374 * @return \type{\bool} TRUE or FALSE
1375 * @deprecated use userCan('create')
1377 public function userCanCreate( $doExpensiveQueries = true ) {
1378 return $this->userCan( 'create', $doExpensiveQueries );
1382 * Can $wgUser move this page?
1383 * @return \type{\bool} TRUE or FALSE
1384 * @deprecated use userCan('move')
1386 public function userCanMove( $doExpensiveQueries = true ) {
1387 return $this->userCan( 'move', $doExpensiveQueries );
1391 * Would anybody with sufficient privileges be able to move this page?
1392 * Some pages just aren't movable.
1394 * @return \type{\bool} TRUE or FALSE
1396 public function isMovable() {
1397 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1401 * Can $wgUser read this page?
1402 * @return \type{\bool} TRUE or FALSE
1403 * @todo fold these checks into userCan()
1405 public function userCanRead() {
1406 global $wgUser, $wgGroupPermissions;
1409 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1410 if ( $result !== null ) {
1414 # Shortcut for public wikis, allows skipping quite a bit of code
1415 if ($wgGroupPermissions['*']['read'])
1418 if( $wgUser->isAllowed( 'read' ) ) {
1421 global $wgWhitelistRead;
1424 * Always grant access to the login page.
1425 * Even anons need to be able to log in.
1427 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1432 * Bail out if there isn't whitelist
1434 if( !is_array($wgWhitelistRead) ) {
1439 * Check for explicit whitelisting
1441 $name = $this->getPrefixedText();
1442 $dbName = $this->getPrefixedDBKey();
1443 // Check with and without underscores
1444 if( in_array($name,$wgWhitelistRead,true) ||
in_array($dbName,$wgWhitelistRead,true) )
1448 * Old settings might have the title prefixed with
1449 * a colon for main-namespace pages
1451 if( $this->getNamespace() == NS_MAIN
) {
1452 if( in_array( ':' . $name, $wgWhitelistRead ) )
1457 * If it's a special page, ditch the subpage bit
1460 if( $this->getNamespace() == NS_SPECIAL
) {
1461 $name = $this->getDBkey();
1462 list( $name, /* $subpage */) = SpecialPage
::resolveAliasWithSubpage( $name );
1463 if ( $name === false ) {
1464 # Invalid special page, but we show standard login required message
1468 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1469 if( in_array( $pure, $wgWhitelistRead, true ) )
1478 * Is this a talk page of some sort?
1479 * @return \type{\bool} TRUE or FALSE
1481 public function isTalkPage() {
1482 return MWNamespace
::isTalk( $this->getNamespace() );
1486 * Is this a subpage?
1487 * @return \type{\bool} TRUE or FALSE
1489 public function isSubpage() {
1490 return MWNamespace
::hasSubpages( $this->mNamespace
)
1491 ?
strpos( $this->getText(), '/' ) !== false
1496 * Does this have subpages? (Warning, usually requires an extra DB query.)
1497 * @return \type{\bool} TRUE or FALSE
1499 public function hasSubpages() {
1500 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1505 # We dynamically add a member variable for the purpose of this method
1506 # alone to cache the result. There's no point in having it hanging
1507 # around uninitialized in every Title object; therefore we only add it
1508 # if needed and don't declare it statically.
1509 if( isset( $this->mHasSubpages
) ) {
1510 return $this->mHasSubpages
;
1513 $db = wfGetDB( DB_SLAVE
);
1514 return $this->mHasSubpages
= (bool)$db->selectField( 'page', '1',
1515 "page_namespace = {$this->mNamespace} AND page_title LIKE '"
1516 . $db->escapeLike( $this->mDbkeyform
) . "/%'",
1522 * Could this page contain custom CSS or JavaScript, based
1525 * @return \type{\bool} TRUE or FALSE
1527 public function isCssOrJsPage() {
1528 return $this->mNamespace
== NS_MEDIAWIKI
1529 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1533 * Is this a .css or .js subpage of a user page?
1534 * @return \type{\bool} TRUE or FALSE
1536 public function isCssJsSubpage() {
1537 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1540 * Is this a *valid* .css or .js subpage of a user page?
1541 * Check that the corresponding skin exists
1542 * @return \type{\bool} TRUE or FALSE
1544 public function isValidCssJsSubpage() {
1545 if ( $this->isCssJsSubpage() ) {
1546 $skinNames = Skin
::getSkinNames();
1547 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1553 * Trim down a .css or .js subpage title to get the corresponding skin name
1555 public function getSkinFromCssJsSubpage() {
1556 $subpage = explode( '/', $this->mTextform
);
1557 $subpage = $subpage[ count( $subpage ) - 1 ];
1558 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1561 * Is this a .css subpage of a user page?
1562 * @return \type{\bool} TRUE or FALSE
1564 public function isCssSubpage() {
1565 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1568 * Is this a .js subpage of a user page?
1569 * @return \type{\bool} TRUE or FALSE
1571 public function isJsSubpage() {
1572 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1575 * Protect css/js subpages of user pages: can $wgUser edit
1578 * @return \type{\bool} TRUE or FALSE
1579 * @todo XXX: this might be better using restrictions
1581 public function userCanEditCssJsSubpage() {
1583 return ( $wgUser->isAllowed('editusercssjs') ||
preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1587 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1589 * @return \type{\bool} If the page is subject to cascading restrictions.
1591 public function isCascadeProtected() {
1592 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1593 return ( $sources > 0 );
1597 * Cascading protection: Get the source of any cascading restrictions on this page.
1599 * @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from.
1600 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title objects of the pages from
1601 * which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1602 * The restriction array is an array of each type, each of which contains an array of unique groups.
1604 public function getCascadeProtectionSources( $get_pages = true ) {
1605 global $wgRestrictionTypes;
1607 # Define our dimension of restrictions types
1608 $pagerestrictions = array();
1609 foreach( $wgRestrictionTypes as $action )
1610 $pagerestrictions[$action] = array();
1612 if ( isset( $this->mCascadeSources
) && $get_pages ) {
1613 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1614 } else if ( isset( $this->mHasCascadingRestrictions
) && !$get_pages ) {
1615 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1618 wfProfileIn( __METHOD__
);
1620 $dbr = wfGetDB( DB_SLAVE
);
1622 if ( $this->getNamespace() == NS_FILE
) {
1623 $tables = array ('imagelinks', 'page_restrictions');
1624 $where_clauses = array(
1625 'il_to' => $this->getDBkey(),
1627 'pr_cascade' => 1 );
1629 $tables = array ('templatelinks', 'page_restrictions');
1630 $where_clauses = array(
1631 'tl_namespace' => $this->getNamespace(),
1632 'tl_title' => $this->getDBkey(),
1634 'pr_cascade' => 1 );
1638 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1639 $where_clauses[] = 'page_id=pr_page';
1642 $cols = array( 'pr_expiry' );
1645 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1647 $sources = $get_pages ?
array() : false;
1648 $now = wfTimestampNow();
1649 $purgeExpired = false;
1651 foreach( $res as $row ) {
1652 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1653 if( $expiry > $now ) {
1655 $page_id = $row->pr_page
;
1656 $page_ns = $row->page_namespace
;
1657 $page_title = $row->page_title
;
1658 $sources[$page_id] = Title
::makeTitle($page_ns, $page_title);
1659 # Add groups needed for each restriction type if its not already there
1660 # Make sure this restriction type still exists
1661 if ( isset($pagerestrictions[$row->pr_type
]) && !in_array($row->pr_level
, $pagerestrictions[$row->pr_type
]) ) {
1662 $pagerestrictions[$row->pr_type
][]=$row->pr_level
;
1668 // Trigger lazy purge of expired restrictions from the db
1669 $purgeExpired = true;
1672 if( $purgeExpired ) {
1673 Title
::purgeExpiredRestrictions();
1676 wfProfileOut( __METHOD__
);
1679 $this->mCascadeSources
= $sources;
1680 $this->mCascadingRestrictions
= $pagerestrictions;
1682 $this->mHasCascadingRestrictions
= $sources;
1684 return array( $sources, $pagerestrictions );
1687 function areRestrictionsCascading() {
1688 if (!$this->mRestrictionsLoaded
) {
1689 $this->loadRestrictions();
1692 return $this->mCascadeRestriction
;
1696 * Loads a string into mRestrictions array
1697 * @param $res \type{Resource} restrictions as an SQL result.
1699 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1700 global $wgRestrictionTypes;
1701 $dbr = wfGetDB( DB_SLAVE
);
1703 foreach( $wgRestrictionTypes as $type ){
1704 $this->mRestrictions
[$type] = array();
1705 $this->mRestrictionsExpiry
[$type] = Block
::decodeExpiry('');
1708 $this->mCascadeRestriction
= false;
1710 # Backwards-compatibility: also load the restrictions from the page record (old format).
1712 if ( $oldFashionedRestrictions === NULL ) {
1713 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
1714 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1717 if ($oldFashionedRestrictions != '') {
1719 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1720 $temp = explode( '=', trim( $restrict ) );
1721 if(count($temp) == 1) {
1722 // old old format should be treated as edit/move restriction
1723 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
1724 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
1726 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1730 $this->mOldRestrictions
= true;
1734 if( $dbr->numRows( $res ) ) {
1735 # Current system - load second to make them override.
1736 $now = wfTimestampNow();
1737 $purgeExpired = false;
1739 foreach( $res as $row ) {
1740 # Cycle through all the restrictions.
1742 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1743 if( !in_array( $row->pr_type
, $wgRestrictionTypes ) )
1746 // This code should be refactored, now that it's being used more generally,
1747 // But I don't really see any harm in leaving it in Block for now -werdna
1748 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1750 // Only apply the restrictions if they haven't expired!
1751 if ( !$expiry ||
$expiry > $now ) {
1752 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
1753 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1755 $this->mCascadeRestriction |
= $row->pr_cascade
;
1757 // Trigger a lazy purge of expired restrictions
1758 $purgeExpired = true;
1762 if( $purgeExpired ) {
1763 Title
::purgeExpiredRestrictions();
1767 $this->mRestrictionsLoaded
= true;
1771 * Load restrictions from the page_restrictions table
1773 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1774 if( !$this->mRestrictionsLoaded
) {
1775 if ($this->exists()) {
1776 $dbr = wfGetDB( DB_SLAVE
);
1778 $res = $dbr->select( 'page_restrictions', '*',
1779 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1781 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1783 $title_protection = $this->getTitleProtection();
1785 if (is_array($title_protection)) {
1786 extract($title_protection);
1788 $now = wfTimestampNow();
1789 $expiry = Block
::decodeExpiry($pt_expiry);
1791 if (!$expiry ||
$expiry > $now) {
1792 // Apply the restrictions
1793 $this->mRestrictionsExpiry
['create'] = $expiry;
1794 $this->mRestrictions
['create'] = explode(',', trim($pt_create_perm) );
1795 } else { // Get rid of the old restrictions
1796 Title
::purgeExpiredRestrictions();
1799 $this->mRestrictionsExpiry
['create'] = Block
::decodeExpiry('');
1801 $this->mRestrictionsLoaded
= true;
1807 * Purge expired restrictions from the page_restrictions table
1809 static function purgeExpiredRestrictions() {
1810 $dbw = wfGetDB( DB_MASTER
);
1811 $dbw->delete( 'page_restrictions',
1812 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1815 $dbw->delete( 'protected_titles',
1816 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1821 * Accessor/initialisation for mRestrictions
1823 * @param $action \type{\string} action that permission needs to be checked for
1824 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
1826 public function getRestrictions( $action ) {
1827 if( !$this->mRestrictionsLoaded
) {
1828 $this->loadRestrictions();
1830 return isset( $this->mRestrictions
[$action] )
1831 ?
$this->mRestrictions
[$action]
1836 * Get the expiry time for the restriction against a given action
1837 * @return 14-char timestamp, or 'infinity' if the page is protected forever
1838 * or not protected at all, or false if the action is not recognised.
1840 public function getRestrictionExpiry( $action ) {
1841 if( !$this->mRestrictionsLoaded
) {
1842 $this->loadRestrictions();
1844 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
1848 * Is there a version of this page in the deletion archive?
1849 * @return \type{\int} the number of archived revisions
1851 public function isDeleted() {
1852 $fname = 'Title::isDeleted';
1853 if ( $this->getNamespace() < 0 ) {
1856 $dbr = wfGetDB( DB_SLAVE
);
1857 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1858 'ar_title' => $this->getDBkey() ), $fname );
1859 if( $this->getNamespace() == NS_FILE
) {
1860 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1861 array( 'fa_name' => $this->getDBkey() ), $fname );
1868 * Get the article ID for this Title from the link cache,
1869 * adding it if necessary
1870 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
1872 * @return \type{\int} the ID
1874 public function getArticleID( $flags = 0 ) {
1875 if( $this->getNamespace() < 0 ) {
1876 return $this->mArticleID
= 0;
1878 $linkCache = LinkCache
::singleton();
1879 if( $flags & GAID_FOR_UPDATE
) {
1880 $oldUpdate = $linkCache->forUpdate( true );
1881 $linkCache->clearLink( $this );
1882 $this->mArticleID
= $linkCache->addLinkObj( $this );
1883 $linkCache->forUpdate( $oldUpdate );
1885 if( -1 == $this->mArticleID
) {
1886 $this->mArticleID
= $linkCache->addLinkObj( $this );
1889 return $this->mArticleID
;
1893 * Is this an article that is a redirect page?
1894 * Uses link cache, adding it if necessary
1895 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1896 * @return \type{\bool}
1898 public function isRedirect( $flags = 0 ) {
1899 if( !is_null($this->mRedirect
) )
1900 return $this->mRedirect
;
1901 # Calling getArticleID() loads the field from cache as needed
1902 if( !$this->getArticleID($flags) ) {
1903 return $this->mRedirect
= false;
1905 $linkCache = LinkCache
::singleton();
1906 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
1908 return $this->mRedirect
;
1912 * What is the length of this page?
1913 * Uses link cache, adding it if necessary
1914 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1915 * @return \type{\bool}
1917 public function getLength( $flags = 0 ) {
1918 if( $this->mLength
!= -1 )
1919 return $this->mLength
;
1920 # Calling getArticleID() loads the field from cache as needed
1921 if( !$this->getArticleID($flags) ) {
1922 return $this->mLength
= 0;
1924 $linkCache = LinkCache
::singleton();
1925 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
1927 return $this->mLength
;
1931 * What is the page_latest field for this page?
1932 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1933 * @return \type{\int}
1935 public function getLatestRevID( $flags = 0 ) {
1936 if( $this->mLatestID
!== false )
1937 return $this->mLatestID
;
1939 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
1940 $this->mLatestID
= $db->selectField( 'page', 'page_latest', $this->pageCond(), __METHOD__
);
1941 return $this->mLatestID
;
1945 * This clears some fields in this object, and clears any associated
1946 * keys in the "bad links" section of the link cache.
1948 * - This is called from Article::insertNewArticle() to allow
1949 * loading of the new page_id. It's also called from
1950 * Article::doDeleteArticle()
1952 * @param $newid \type{\int} the new Article ID
1954 public function resetArticleID( $newid ) {
1955 $linkCache = LinkCache
::singleton();
1956 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1958 if ( 0 == $newid ) { $this->mArticleID
= -1; }
1959 else { $this->mArticleID
= $newid; }
1960 $this->mRestrictionsLoaded
= false;
1961 $this->mRestrictions
= array();
1965 * Updates page_touched for this page; called from LinksUpdate.php
1966 * @return \type{\bool} true if the update succeded
1968 public function invalidateCache() {
1969 if( wfReadOnly() ) {
1972 $dbw = wfGetDB( DB_MASTER
);
1973 $success = $dbw->update( 'page',
1974 array( 'page_touched' => $dbw->timestamp() ),
1978 HTMLFileCache
::clearFileCache( $this );
1983 * Prefix some arbitrary text with the namespace or interwiki prefix
1986 * @param $name \type{\string} the text
1987 * @return \type{\string} the prefixed text
1990 /* private */ function prefix( $name ) {
1992 if ( '' != $this->mInterwiki
) {
1993 $p = $this->mInterwiki
. ':';
1995 if ( 0 != $this->mNamespace
) {
1996 $p .= $this->getNsText() . ':';
2002 * Secure and split - main initialisation function for this object
2004 * Assumes that mDbkeyform has been set, and is urldecoded
2005 * and uses underscores, but not otherwise munged. This function
2006 * removes illegal characters, splits off the interwiki and
2007 * namespace prefixes, sets the other forms, and canonicalizes
2009 * @return \type{\bool} true on success
2011 private function secureAndSplit() {
2012 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
2015 static $rxTc = false;
2017 # Matching titles will be held as illegal.
2019 # Any character not allowed is forbidden...
2020 '[^' . Title
::legalChars() . ']' .
2021 # URL percent encoding sequences interfere with the ability
2022 # to round-trip titles -- you can't link to them consistently.
2023 '|%[0-9A-Fa-f]{2}' .
2024 # XML/HTML character references produce similar issues.
2025 '|&[A-Za-z0-9\x80-\xff]+;' .
2027 '|&#x[0-9A-Fa-f]+;' .
2031 $this->mInterwiki
= $this->mFragment
= '';
2032 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2034 $dbkey = $this->mDbkeyform
;
2036 # Strip Unicode bidi override characters.
2037 # Sometimes they slip into cut-n-pasted page titles, where the
2038 # override chars get included in list displays.
2039 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2041 # Clean up whitespace
2043 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2044 $dbkey = trim( $dbkey, '_' );
2046 if ( '' == $dbkey ) {
2050 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2051 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2055 $this->mDbkeyform
= $dbkey;
2057 # Initial colon indicates main namespace rather than specified default
2058 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2059 if ( ':' == $dbkey{0} ) {
2060 $this->mNamespace
= NS_MAIN
;
2061 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2062 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2065 # Namespace or interwiki prefix
2067 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2070 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2072 if ( $ns = $wgContLang->getNsIndex( $p ) ) {
2073 # Ordinary namespace
2075 $this->mNamespace
= $ns;
2076 # For Talk:X pages, check if X has a "namespace" prefix
2077 if( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2078 if( $wgContLang->getNsIndex( $x[1] ) )
2079 return false; # Disallow Talk:File:x type titles...
2080 else if( Interwiki
::isValidInterwiki( $x[1] ) )
2081 return false; # Disallow Talk:Interwiki:x type titles...
2083 } elseif( Interwiki
::isValidInterwiki( $p ) ) {
2085 # Can't make a local interwiki link to an interwiki link.
2086 # That's just crazy!
2092 $this->mInterwiki
= $wgContLang->lc( $p );
2094 # Redundant interwiki prefix to the local wiki
2095 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2096 if( $dbkey == '' ) {
2097 # Can't have an empty self-link
2100 $this->mInterwiki
= '';
2102 # Do another namespace split...
2106 # If there's an initial colon after the interwiki, that also
2107 # resets the default namespace
2108 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2109 $this->mNamespace
= NS_MAIN
;
2110 $dbkey = substr( $dbkey, 1 );
2113 # If there's no recognized interwiki or namespace,
2114 # then let the colon expression be part of the title.
2119 # We already know that some pages won't be in the database!
2121 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2122 $this->mArticleID
= 0;
2124 $fragment = strstr( $dbkey, '#' );
2125 if ( false !== $fragment ) {
2126 $this->setFragment( $fragment );
2127 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2128 # remove whitespace again: prevents "Foo_bar_#"
2129 # becoming "Foo_bar_"
2130 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2133 # Reject illegal characters.
2135 if( preg_match( $rxTc, $dbkey ) ) {
2140 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2141 * reachable due to the way web browsers deal with 'relative' URLs.
2142 * Also, they conflict with subpage syntax. Forbid them explicitly.
2144 if ( strpos( $dbkey, '.' ) !== false &&
2145 ( $dbkey === '.' ||
$dbkey === '..' ||
2146 strpos( $dbkey, './' ) === 0 ||
2147 strpos( $dbkey, '../' ) === 0 ||
2148 strpos( $dbkey, '/./' ) !== false ||
2149 strpos( $dbkey, '/../' ) !== false ||
2150 substr( $dbkey, -2 ) == '/.' ||
2151 substr( $dbkey, -3 ) == '/..' ) )
2157 * Magic tilde sequences? Nu-uh!
2159 if( strpos( $dbkey, '~~~' ) !== false ) {
2164 * Limit the size of titles to 255 bytes.
2165 * This is typically the size of the underlying database field.
2166 * We make an exception for special pages, which don't need to be stored
2167 * in the database, and may edge over 255 bytes due to subpage syntax
2168 * for long titles, e.g. [[Special:Block/Long name]]
2170 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2171 strlen( $dbkey ) > 512 )
2177 * Normally, all wiki links are forced to have
2178 * an initial capital letter so [[foo]] and [[Foo]]
2179 * point to the same place.
2181 * Don't force it for interwikis, since the other
2182 * site might be case-sensitive.
2184 $this->mUserCaseDBKey
= $dbkey;
2185 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2186 $dbkey = $wgContLang->ucfirst( $dbkey );
2190 * Can't make a link to a namespace alone...
2191 * "empty" local links can only be self-links
2192 * with a fragment identifier.
2195 $this->mInterwiki
== '' &&
2196 $this->mNamespace
!= NS_MAIN
) {
2199 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2200 // IP names are not allowed for accounts, and can only be referring to
2201 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2202 // there are numerous ways to present the same IP. Having sp:contribs scan
2203 // them all is silly and having some show the edits and others not is
2204 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2205 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2206 IP
::sanitizeIP( $dbkey ) : $dbkey;
2207 // Any remaining initial :s are illegal.
2208 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2213 $this->mDbkeyform
= $dbkey;
2214 $this->mUrlform
= wfUrlencode( $dbkey );
2216 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2222 * Set the fragment for this title. Removes the first character from the
2223 * specified fragment before setting, so it assumes you're passing it with
2226 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2227 * Still in active use privately.
2229 * @param $fragment \type{\string} text
2231 public function setFragment( $fragment ) {
2232 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2236 * Get a Title object associated with the talk page of this article
2237 * @return \type{Title} the object for the talk page
2239 public function getTalkPage() {
2240 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2244 * Get a title object associated with the subject page of this
2247 * @return \type{Title} the object for the subject page
2249 public function getSubjectPage() {
2250 // Is this the same title?
2251 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2252 if( $this->getNamespace() == $subjectNS ) {
2255 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2259 * Get an array of Title objects linking to this Title
2260 * Also stores the IDs in the link cache.
2262 * WARNING: do not use this function on arbitrary user-supplied titles!
2263 * On heavily-used templates it will max out the memory.
2265 * @param $options \type{\string} may be FOR UPDATE
2266 * @return \type{\arrayof{Title}} the Title objects linking here
2268 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
2269 $linkCache = LinkCache
::singleton();
2272 $db = wfGetDB( DB_MASTER
);
2274 $db = wfGetDB( DB_SLAVE
);
2277 $res = $db->select( array( 'page', $table ),
2278 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2280 "{$prefix}_from=page_id",
2281 "{$prefix}_namespace" => $this->getNamespace(),
2282 "{$prefix}_title" => $this->getDBkey() ),
2287 if ( $db->numRows( $res ) ) {
2288 foreach( $res as $row ) {
2289 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2290 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2291 $retVal[] = $titleObj;
2295 $db->freeResult( $res );
2300 * Get an array of Title objects using this Title as a template
2301 * Also stores the IDs in the link cache.
2303 * WARNING: do not use this function on arbitrary user-supplied titles!
2304 * On heavily-used templates it will max out the memory.
2306 * @param $options \type{\string} may be FOR UPDATE
2307 * @return \type{\arrayof{Title}} the Title objects linking here
2309 public function getTemplateLinksTo( $options = '' ) {
2310 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2314 * Get an array of Title objects referring to non-existent articles linked from this page
2316 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2317 * @param $options \type{\string} may be FOR UPDATE
2318 * @return \type{\arrayof{Title}} the Title objects
2320 public function getBrokenLinksFrom( $options = '' ) {
2321 if ( $this->getArticleId() == 0 ) {
2322 # All links from article ID 0 are false positives
2327 $db = wfGetDB( DB_MASTER
);
2329 $db = wfGetDB( DB_SLAVE
);
2332 $res = $db->safeQuery(
2333 "SELECT pl_namespace, pl_title
2336 ON pl_namespace=page_namespace
2337 AND pl_title=page_title
2339 AND page_namespace IS NULL
2341 $db->tableName( 'pagelinks' ),
2342 $db->tableName( 'page' ),
2343 $this->getArticleId(),
2347 if ( $db->numRows( $res ) ) {
2348 foreach( $res as $row ) {
2349 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2352 $db->freeResult( $res );
2358 * Get a list of URLs to purge from the Squid cache when this
2361 * @return \type{\arrayof{\string}} the URLs
2363 public function getSquidURLs() {
2367 $this->getInternalURL(),
2368 $this->getInternalURL( 'action=history' )
2371 // purge variant urls as well
2372 if($wgContLang->hasVariants()){
2373 $variants = $wgContLang->getVariants();
2374 foreach($variants as $vCode){
2375 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2376 $urls[] = $this->getInternalURL('',$vCode);
2384 * Purge all applicable Squid URLs
2386 public function purgeSquid() {
2388 if ( $wgUseSquid ) {
2389 $urls = $this->getSquidURLs();
2390 $u = new SquidUpdate( $urls );
2396 * Move this page without authentication
2397 * @param &$nt \type{Title} the new page Title
2399 public function moveNoAuth( &$nt ) {
2400 return $this->moveTo( $nt, false );
2404 * Check whether a given move operation would be valid.
2405 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2406 * @param &$nt \type{Title} the new title
2407 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2409 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2410 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2412 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2417 // Normally we'd add this to $errors, but we'll get
2418 // lots of syntax errors if $nt is not an object
2419 return array(array('badtitletext'));
2421 if( $this->equals( $nt ) ) {
2422 $errors[] = array('selfmove');
2424 if( !$this->isMovable() ) {
2425 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2427 if ( $nt->getInterwiki() != '' ) {
2428 $errors[] = array( 'immobile-target-namespace-iw' );
2430 if ( !$nt->isMovable() ) {
2431 $errors[] = array('immobile-target-namespace', $nt->getNsText() );
2434 $oldid = $this->getArticleID();
2435 $newid = $nt->getArticleID();
2437 if ( strlen( $nt->getDBkey() ) < 1 ) {
2438 $errors[] = array('articleexists');
2440 if ( ( '' == $this->getDBkey() ) ||
2442 ( '' == $nt->getDBkey() ) ) {
2443 $errors[] = array('badarticleerror');
2446 // Image-specific checks
2447 if( $this->getNamespace() == NS_FILE
) {
2448 $file = wfLocalFile( $this );
2449 if( $file->exists() ) {
2450 if( $nt->getNamespace() != NS_FILE
) {
2451 $errors[] = array('imagenocrossnamespace');
2453 if( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2454 $errors[] = array('imageinvalidfilename');
2456 if( !File
::checkExtensionCompatibility( $file, $nt->getDBKey() ) ) {
2457 $errors[] = array('imagetypemismatch');
2463 $errors = wfMergeErrorArrays( $errors,
2464 $this->getUserPermissionsErrors('move', $wgUser),
2465 $this->getUserPermissionsErrors('edit', $wgUser),
2466 $nt->getUserPermissionsErrors('move-target', $wgUser),
2467 $nt->getUserPermissionsErrors('edit', $wgUser) );
2470 $match = EditPage
::matchSpamRegex( $reason );
2471 if( $match !== false ) {
2472 // This is kind of lame, won't display nice
2473 $errors[] = array('spamprotectiontext');
2477 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2478 $errors[] = array('hookaborted', $err);
2481 # The move is allowed only if (1) the target doesn't exist, or
2482 # (2) the target is a redirect to the source, and has no history
2483 # (so we can undo bad moves right after they're done).
2485 if ( 0 != $newid ) { # Target exists; check for validity
2486 if ( ! $this->isValidMoveTarget( $nt ) ) {
2487 $errors[] = array('articleexists');
2490 $tp = $nt->getTitleProtection();
2491 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2492 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2493 $errors[] = array('cantmove-titleprotected');
2502 * Move a title to a new location
2503 * @param &$nt \type{Title} the new title
2504 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2506 * @param $reason \type{\string} The reason for the move
2507 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2508 * Ignored if the user doesn't have the suppressredirect right.
2509 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2511 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2512 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2513 if( is_array( $err ) ) {
2517 $pageid = $this->getArticleID();
2518 $protected = $this->isProtected();
2519 if( $nt->exists() ) {
2520 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2521 $pageCountChange = ($createRedirect ?
0 : -1);
2522 } else { # Target didn't exist, do normal move.
2523 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2524 $pageCountChange = ($createRedirect ?
1 : 0);
2527 if( is_array( $err ) ) {
2530 $redirid = $this->getArticleID();
2532 // Category memberships include a sort key which may be customized.
2533 // If it's left as the default (the page title), we need to update
2534 // the sort key to match the new title.
2536 // Be careful to avoid resetting cl_timestamp, which may disturb
2537 // time-based lists on some sites.
2539 // Warning -- if the sort key is *explicitly* set to the old title,
2540 // we can't actually distinguish it from a default here, and it'll
2541 // be set to the new title even though it really shouldn't.
2542 // It'll get corrected on the next edit, but resetting cl_timestamp.
2543 $dbw = wfGetDB( DB_MASTER
);
2544 $dbw->update( 'categorylinks',
2546 'cl_sortkey' => $nt->getPrefixedText(),
2547 'cl_timestamp=cl_timestamp' ),
2549 'cl_from' => $pageid,
2550 'cl_sortkey' => $this->getPrefixedText() ),
2554 # Protect the redirect title as the title used to be...
2555 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
2557 'pr_page' => $redirid,
2558 'pr_type' => 'pr_type',
2559 'pr_level' => 'pr_level',
2560 'pr_cascade' => 'pr_cascade',
2561 'pr_user' => 'pr_user',
2562 'pr_expiry' => 'pr_expiry'
2564 array( 'pr_page' => $pageid ),
2568 # Update the protection log
2569 $log = new LogPage( 'protect' );
2570 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2571 if( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
2572 $log->addEntry( 'move_prot', $nt, $comment, array($this->getPrefixedText()) ); // FIXME: $params?
2576 $oldnamespace = $this->getNamespace() & ~
1;
2577 $newnamespace = $nt->getNamespace() & ~
1;
2578 $oldtitle = $this->getDBkey();
2579 $newtitle = $nt->getDBkey();
2581 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2582 WatchedItem
::duplicateEntries( $this, $nt );
2585 # Update search engine
2586 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2588 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2592 if( $this->isContentPage() && !$nt->isContentPage() ) {
2593 # No longer a content page
2594 # Not viewed, edited, removing
2595 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2596 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2597 # Now a content page
2598 # Not viewed, edited, adding
2599 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2600 } elseif( $pageCountChange ) {
2602 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2609 # Update message cache for interface messages
2610 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2611 global $wgMessageCache;
2612 $oldarticle = new Article( $this );
2613 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2614 $newarticle = new Article( $nt );
2615 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2619 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2624 * Move page to a title which is at present a redirect to the
2627 * @param &$nt \type{Title} the page to move to, which should currently
2629 * @param $reason \type{\string} The reason for the move
2630 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
2631 * Ignored if the user doesn't have the suppressredirect right
2633 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2634 global $wgUseSquid, $wgUser;
2635 $fname = 'Title::moveOverExistingRedirect';
2636 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2639 $comment .= ": $reason";
2642 $now = wfTimestampNow();
2643 $newid = $nt->getArticleID();
2644 $oldid = $this->getArticleID();
2645 $latest = $this->getLatestRevID();
2647 $dbw = wfGetDB( DB_MASTER
);
2649 # Delete the old redirect. We don't save it to history since
2650 # by definition if we've got here it's rather uninteresting.
2651 # We have to remove it so that the next step doesn't trigger
2652 # a conflict on the unique namespace+title index...
2653 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2654 if ( !$dbw->cascadingDeletes() ) {
2655 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2656 global $wgUseTrackbacks;
2657 if ($wgUseTrackbacks)
2658 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2659 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2660 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2661 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2662 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2663 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2664 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2665 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2668 # Save a null revision in the page's history notifying of the move
2669 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2670 $nullRevId = $nullRevision->insertOn( $dbw );
2672 $article = new Article( $this );
2673 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2675 # Change the name of the target page:
2676 $dbw->update( 'page',
2678 'page_touched' => $dbw->timestamp($now),
2679 'page_namespace' => $nt->getNamespace(),
2680 'page_title' => $nt->getDBkey(),
2681 'page_latest' => $nullRevId,
2683 /* WHERE */ array( 'page_id' => $oldid ),
2686 $nt->resetArticleID( $oldid );
2688 # Recreate the redirect, this time in the other direction.
2689 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2690 $mwRedir = MagicWord
::get( 'redirect' );
2691 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2692 $redirectArticle = new Article( $this );
2693 $newid = $redirectArticle->insertOn( $dbw );
2694 $redirectRevision = new Revision( array(
2696 'comment' => $comment,
2697 'text' => $redirectText ) );
2698 $redirectRevision->insertOn( $dbw );
2699 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2701 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2703 # Now, we record the link from the redirect to the new title.
2704 # It should have no other outgoing links...
2705 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2706 $dbw->insert( 'pagelinks',
2708 'pl_from' => $newid,
2709 'pl_namespace' => $nt->getNamespace(),
2710 'pl_title' => $nt->getDBkey() ),
2712 $redirectSuppressed = false;
2714 $this->resetArticleID( 0 );
2715 $redirectSuppressed = true;
2718 # Move an image if this is a file
2719 if( $this->getNamespace() == NS_FILE
) {
2720 $file = wfLocalFile( $this );
2721 if( $file->exists() ) {
2722 $status = $file->move( $nt );
2723 if( !$status->isOk() ) {
2725 return $status->getErrorsArray();
2731 $log = new LogPage( 'move' );
2732 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2735 if ( $wgUseSquid ) {
2736 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2737 $u = new SquidUpdate( $urls );
2744 * Move page to non-existing title.
2745 * @param &$nt \type{Title} the new Title
2746 * @param $reason \type{\string} The reason for the move
2747 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
2748 * Ignored if the user doesn't have the suppressredirect right
2750 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2751 global $wgUseSquid, $wgUser;
2752 $fname = 'MovePageForm::moveToNewTitle';
2753 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2755 $comment .= wfMsgExt( 'colon-separator',
2756 array( 'escapenoentities', 'content' ) );
2757 $comment .= $reason;
2760 $newid = $nt->getArticleID();
2761 $oldid = $this->getArticleID();
2762 $latest = $this->getLatestRevId();
2764 $dbw = wfGetDB( DB_MASTER
);
2765 $now = $dbw->timestamp();
2767 # Save a null revision in the page's history notifying of the move
2768 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2769 $nullRevId = $nullRevision->insertOn( $dbw );
2771 $article = new Article( $this );
2772 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2775 $dbw->update( 'page',
2777 'page_touched' => $now,
2778 'page_namespace' => $nt->getNamespace(),
2779 'page_title' => $nt->getDBkey(),
2780 'page_latest' => $nullRevId,
2782 /* WHERE */ array( 'page_id' => $oldid ),
2785 $nt->resetArticleID( $oldid );
2787 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2789 $mwRedir = MagicWord
::get( 'redirect' );
2790 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2791 $redirectArticle = new Article( $this );
2792 $newid = $redirectArticle->insertOn( $dbw );
2793 $redirectRevision = new Revision( array(
2795 'comment' => $comment,
2796 'text' => $redirectText ) );
2797 $redirectRevision->insertOn( $dbw );
2798 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2800 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2802 # Record the just-created redirect's linking to the page
2803 $dbw->insert( 'pagelinks',
2805 'pl_from' => $newid,
2806 'pl_namespace' => $nt->getNamespace(),
2807 'pl_title' => $nt->getDBkey() ),
2809 $redirectSuppressed = false;
2811 $this->resetArticleID( 0 );
2812 $redirectSuppressed = true;
2815 # Move an image if this is a file
2816 if( $this->getNamespace() == NS_FILE
) {
2817 $file = wfLocalFile( $this );
2818 if( $file->exists() ) {
2819 $status = $file->move( $nt );
2820 if( !$status->isOk() ) {
2822 return $status->getErrorsArray();
2828 $log = new LogPage( 'move' );
2829 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2831 # Purge caches as per article creation
2832 Article
::onArticleCreate( $nt );
2834 # Purge old title from squid
2835 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2836 $this->purgeSquid();
2841 * Checks if this page is just a one-rev redirect.
2842 * Adds lock, so don't use just for light purposes.
2844 * @return \type{\bool} TRUE or FALSE
2846 public function isSingleRevRedirect() {
2847 $dbw = wfGetDB( DB_MASTER
);
2849 $row = $dbw->selectRow( 'page',
2850 array( 'page_is_redirect', 'page_latest', 'page_id' ),
2855 # Cache some fields we may want
2856 $this->mArticleID
= $row ?
intval($row->page_id
) : 0;
2857 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
2858 $this->mLatestID
= $row ?
intval($row->page_latest
) : false;
2859 if( !$this->mRedirect
) {
2862 # Does the article have a history?
2863 $row = $dbw->selectField( array( 'page', 'revision'),
2865 array( 'page_namespace' => $this->getNamespace(),
2866 'page_title' => $this->getDBkey(),
2868 'page_latest != rev_id'
2873 # Return true if there was no history
2874 return ($row === false);
2878 * Checks if $this can be moved to a given Title
2879 * - Selects for update, so don't call it unless you mean business
2881 * @param &$nt \type{Title} the new title to check
2882 * @return \type{\bool} TRUE or FALSE
2884 public function isValidMoveTarget( $nt ) {
2885 $dbw = wfGetDB( DB_MASTER
);
2886 # Is it an existsing file?
2887 if( $nt->getNamespace() == NS_FILE
) {
2888 $file = wfLocalFile( $nt );
2889 if( $file->exists() ) {
2890 wfDebug( __METHOD__
. ": file exists\n" );
2894 # Is it a redirect with no history?
2895 if( !$nt->isSingleRevRedirect() ) {
2896 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
2899 # Get the article text
2900 $rev = Revision
::newFromTitle( $nt );
2901 $text = $rev->getText();
2902 # Does the redirect point to the source?
2903 # Or is it a broken self-redirect, usually caused by namespace collisions?
2905 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2906 $redirTitle = Title
::newFromText( $m[1] );
2907 if( !is_object( $redirTitle ) ||
2908 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2909 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2910 wfDebug( __METHOD__
. ": redirect points to other page\n" );
2915 wfDebug( __METHOD__
. ": failsafe\n" );
2922 * Can this title be added to a user's watchlist?
2924 * @return \type{\bool} TRUE or FALSE
2926 public function isWatchable() {
2927 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
2931 * Get categories to which this Title belongs and return an array of
2932 * categories' names.
2934 * @return \type{\array} array an array of parents in the form:
2935 * $parent => $currentarticle
2937 public function getParentCategories() {
2940 $titlekey = $this->getArticleId();
2941 $dbr = wfGetDB( DB_SLAVE
);
2942 $categorylinks = $dbr->tableName( 'categorylinks' );
2945 $sql = "SELECT * FROM $categorylinks"
2946 ." WHERE cl_from='$titlekey'"
2947 ." AND cl_from <> '0'"
2948 ." ORDER BY cl_sortkey";
2950 $res = $dbr->query( $sql );
2952 if( $dbr->numRows( $res ) > 0 ) {
2953 foreach( $res as $row )
2954 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
2955 $data[$wgContLang->getNSText( NS_CATEGORY
).':'.$row->cl_to
] = $this->getFullText();
2956 $dbr->freeResult( $res );
2964 * Get a tree of parent categories
2965 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
2966 * @return \type{\array} Tree of parent categories
2968 public function getParentCategoryTree( $children = array() ) {
2970 $parents = $this->getParentCategories();
2973 foreach( $parents as $parent => $current ) {
2974 if ( array_key_exists( $parent, $children ) ) {
2975 # Circular reference
2976 $stack[$parent] = array();
2978 $nt = Title
::newFromText($parent);
2980 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
2992 * Get an associative array for selecting this title from
2995 * @return \type{\array} Selection array
2997 public function pageCond() {
2998 if( $this->mArticleID
> 0 ) {
2999 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3000 return array( 'page_id' => $this->mArticleID
);
3002 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3007 * Get the revision ID of the previous revision
3009 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3010 * @param $flags \type{\int} GAID_FOR_UPDATE
3011 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3013 public function getPreviousRevisionID( $revId, $flags=0 ) {
3014 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3015 return $db->selectField( 'revision', 'rev_id',
3017 'rev_page' => $this->getArticleId($flags),
3018 'rev_id < ' . intval( $revId )
3021 array( 'ORDER BY' => 'rev_id DESC' )
3026 * Get the revision ID of the next revision
3028 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3029 * @param $flags \type{\int} GAID_FOR_UPDATE
3030 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3032 public function getNextRevisionID( $revId, $flags=0 ) {
3033 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3034 return $db->selectField( 'revision', 'rev_id',
3036 'rev_page' => $this->getArticleId($flags),
3037 'rev_id > ' . intval( $revId )
3040 array( 'ORDER BY' => 'rev_id' )
3045 * Get the first revision of the page
3047 * @param $flags \type{\int} GAID_FOR_UPDATE
3048 * @return Revision (or NULL if page doesn't exist)
3050 public function getFirstRevision( $flags=0 ) {
3051 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3052 $pageId = $this->getArticleId($flags);
3053 if( !$pageId ) return NULL;
3054 $row = $db->selectRow( 'revision', '*',
3055 array( 'rev_page' => $pageId ),
3057 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3062 return new Revision( $row );
3067 * Check if this is a new page
3071 public function isNewPage() {
3072 $dbr = wfGetDB( DB_SLAVE
);
3073 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3077 * Get the oldest revision timestamp of this page
3079 * @return string, MW timestamp
3081 public function getEarliestRevTime() {
3082 $dbr = wfGetDB( DB_SLAVE
);
3083 if( $this->exists() ) {
3084 $min = $dbr->selectField( 'revision',
3085 'MIN(rev_timestamp)',
3086 array( 'rev_page' => $this->getArticleId() ),
3088 return wfTimestampOrNull( TS_MW
, $min );
3094 * Get the number of revisions between the given revision IDs.
3095 * Used for diffs and other things that really need it.
3097 * @param $old \type{\int} Revision ID.
3098 * @param $new \type{\int} Revision ID.
3099 * @return \type{\int} Number of revisions between these IDs.
3101 public function countRevisionsBetween( $old, $new ) {
3102 $dbr = wfGetDB( DB_SLAVE
);
3103 return $dbr->selectField( 'revision', 'count(*)',
3104 'rev_page = ' . intval( $this->getArticleId() ) .
3105 ' AND rev_id > ' . intval( $old ) .
3106 ' AND rev_id < ' . intval( $new ),
3108 array( 'USE INDEX' => 'PRIMARY' ) );
3112 * Compare with another title.
3114 * @param \type{Title} $title
3115 * @return \type{\bool} TRUE or FALSE
3117 public function equals( Title
$title ) {
3118 // Note: === is necessary for proper matching of number-like titles.
3119 return $this->getInterwiki() === $title->getInterwiki()
3120 && $this->getNamespace() == $title->getNamespace()
3121 && $this->getDBkey() === $title->getDBkey();
3125 * Callback for usort() to do title sorts by (namespace, title)
3127 static function compare( $a, $b ) {
3128 if( $a->getNamespace() == $b->getNamespace() ) {
3129 return strcmp( $a->getText(), $b->getText() );
3131 return $a->getNamespace() - $b->getNamespace();
3136 * Return a string representation of this title
3138 * @return \type{\string} String representation of this title
3140 public function __toString() {
3141 return $this->getPrefixedText();
3145 * Check if page exists. For historical reasons, this function simply
3146 * checks for the existence of the title in the page table, and will
3147 * thus return false for interwiki links, special pages and the like.
3148 * If you want to know if a title can be meaningfully viewed, you should
3149 * probably call the isKnown() method instead.
3151 * @return \type{\bool} TRUE or FALSE
3153 public function exists() {
3154 return $this->getArticleId() != 0;
3158 * Should links to this title be shown as potentially viewable (i.e. as
3159 * "bluelinks"), even if there's no record by this title in the page
3162 * This function is semi-deprecated for public use, as well as somewhat
3163 * misleadingly named. You probably just want to call isKnown(), which
3164 * calls this function internally.
3166 * (ISSUE: Most of these checks are cheap, but the file existence check
3167 * can potentially be quite expensive. Including it here fixes a lot of
3168 * existing code, but we might want to add an optional parameter to skip
3169 * it and any other expensive checks.)
3171 * @return \type{\bool} TRUE or FALSE
3173 public function isAlwaysKnown() {
3174 if( $this->mInterwiki
!= '' ) {
3175 return true; // any interwiki link might be viewable, for all we know
3177 switch( $this->mNamespace
) {
3180 return wfFindFile( $this ); // file exists, possibly in a foreign repo
3182 return SpecialPage
::exists( $this->getDBKey() ); // valid special page
3184 return $this->mDbkeyform
== ''; // selflink, possibly with fragment
3186 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3187 // the full l10n of that language to be loaded. That takes much memory and
3188 // isn't needed. So we strip the language part away.
3189 // Also, extension messages which are not loaded, are shown as red, because
3190 // we don't call MessageCache::loadAllMessages.
3191 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3192 return wfMsgWeirdKey( $basename ); // known system message
3199 * Does this title refer to a page that can (or might) be meaningfully
3200 * viewed? In particular, this function may be used to determine if
3201 * links to the title should be rendered as "bluelinks" (as opposed to
3202 * "redlinks" to non-existent pages).
3204 * @return \type{\bool} TRUE or FALSE
3206 public function isKnown() {
3207 return $this->exists() ||
$this->isAlwaysKnown();
3211 * Is this in a namespace that allows actual pages?
3213 * @return \type{\bool} TRUE or FALSE
3215 public function canExist() {
3216 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3220 * Update page_touched timestamps and send squid purge messages for
3221 * pages linking to this title. May be sent to the job queue depending
3222 * on the number of links. Typically called on create and delete.
3224 public function touchLinks() {
3225 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3228 if ( $this->getNamespace() == NS_CATEGORY
) {
3229 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3235 * Get the last touched timestamp
3236 * @param Database $db, optional db
3237 * @return \type{\string} Last touched timestamp
3239 public function getTouched( $db = NULL ) {
3240 $db = isset($db) ?
$db : wfGetDB( DB_SLAVE
);
3241 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3246 * Get the timestamp when this page was updated since the user last saw it.
3248 * @return mixed string/NULL
3250 public function getNotificationTimestamp( $user = NULL ) {
3251 global $wgUser, $wgShowUpdatedMarker;
3252 // Assume current user if none given
3253 if( !$user ) $user = $wgUser;
3254 // Check cache first
3255 $uid = $user->getId();
3256 if( isset($this->mNotificationTimestamp
[$uid]) ) {
3257 return $this->mNotificationTimestamp
[$uid];
3259 if( !$uid ||
!$wgShowUpdatedMarker ) {
3260 return $this->mNotificationTimestamp
[$uid] = false;
3262 // Don't cache too much!
3263 if( count($this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3264 $this->mNotificationTimestamp
= array();
3266 $dbr = wfGetDB( DB_SLAVE
);
3267 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3268 'wl_notificationtimestamp',
3269 array( 'wl_namespace' => $this->getNamespace(),
3270 'wl_title' => $this->getDBkey(),
3271 'wl_user' => $user->getId()
3275 return $this->mNotificationTimestamp
[$uid];
3279 * Get the trackback URL for this page
3280 * @return \type{\string} Trackback URL
3282 public function trackbackURL() {
3283 global $wgScriptPath, $wgServer;
3285 return "$wgServer$wgScriptPath/trackback.php?article="
3286 . htmlspecialchars(urlencode($this->getPrefixedDBkey()));
3290 * Get the trackback RDF for this page
3291 * @return \type{\string} Trackback RDF
3293 public function trackbackRDF() {
3294 $url = htmlspecialchars($this->getFullURL());
3295 $title = htmlspecialchars($this->getText());
3296 $tburl = $this->trackbackURL();
3298 // Autodiscovery RDF is placed in comments so HTML validator
3299 // won't barf. This is a rather icky workaround, but seems
3300 // frequently used by this kind of RDF thingy.
3302 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3304 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3305 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3306 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3309 dc:identifier=\"$url\"
3311 trackback:ping=\"$tburl\" />
3317 * Generate strings used for xml 'id' names in monobook tabs
3318 * @return \type{\string} XML 'id' name
3320 public function getNamespaceKey() {
3322 switch ($this->getNamespace()) {
3325 return 'nstab-main';
3328 return 'nstab-user';
3330 return 'nstab-media';
3332 return 'nstab-special';
3334 case NS_PROJECT_TALK
:
3335 return 'nstab-project';
3338 return 'nstab-image';
3340 case NS_MEDIAWIKI_TALK
:
3341 return 'nstab-mediawiki';
3343 case NS_TEMPLATE_TALK
:
3344 return 'nstab-template';
3347 return 'nstab-help';
3349 case NS_CATEGORY_TALK
:
3350 return 'nstab-category';
3352 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3357 * Returns true if this title resolves to the named special page
3358 * @param $name \type{\string} The special page name
3360 public function isSpecial( $name ) {
3361 if ( $this->getNamespace() == NS_SPECIAL
) {
3362 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3363 if ( $name == $thisName ) {
3371 * If the Title refers to a special page alias which is not the local default,
3372 * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this.
3374 public function fixSpecialName() {
3375 if ( $this->getNamespace() == NS_SPECIAL
) {
3376 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3377 if ( $canonicalName ) {
3378 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3379 if ( $localName != $this->mDbkeyform
) {
3380 return Title
::makeTitle( NS_SPECIAL
, $localName );
3388 * Is this Title in a namespace which contains content?
3389 * In other words, is this a content page, for the purposes of calculating
3392 * @return \type{\bool} TRUE or FALSE
3394 public function isContentPage() {
3395 return MWNamespace
::isContent( $this->getNamespace() );
3399 * Get all extant redirects to this Title
3401 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3402 * NULL to consider all namespaces
3403 * @return \type{\arrayof{Title}} Redirects to this title
3405 public function getRedirectsHere( $ns = null ) {
3408 $dbr = wfGetDB( DB_SLAVE
);
3410 'rd_namespace' => $this->getNamespace(),
3411 'rd_title' => $this->getDBkey(),
3414 if ( !is_null($ns) ) $where['page_namespace'] = $ns;
3416 $res = $dbr->select(
3417 array( 'redirect', 'page' ),
3418 array( 'page_namespace', 'page_title' ),
3424 foreach( $res as $row ) {
3425 $redirs[] = self
::newFromRow( $row );