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?
78 /* private */ function __construct() {}
81 * Create a new Title from a prefixed DB key
82 * @param $key \type{\string} The database key, which has underscores
83 * instead of spaces, possibly including namespace and
85 * @return \type{Title} the new object, or NULL on an error
87 public static function newFromDBkey( $key ) {
89 $t->mDbkeyform
= $key;
90 if( $t->secureAndSplit() )
97 * Create a new Title from text, such as what one would
98 * find in a link. Decodes any HTML entities in the text.
100 * @param $text \type{\string} the link text; spaces, prefixes,
101 * and an initial ':' indicating the main namespace
103 * @param $defaultNamespace \type{\int} the namespace to use if
104 * none is specified by a prefix
105 * @return \type{Title} the new object, or NULL on an error
107 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
108 if( is_object( $text ) ) {
109 throw new MWException( 'Title::newFromText given an object' );
113 * Wiki pages often contain multiple links to the same page.
114 * Title normalization and parsing can become expensive on
115 * pages with many links, so we can save a little time by
118 * In theory these are value objects and won't get changed...
120 if( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
121 return Title
::$titleCache[$text];
125 * Convert things like é ā or 〗 into real text...
127 $filteredText = Sanitizer
::decodeCharReferences( $text );
130 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
131 $t->mDefaultNamespace
= $defaultNamespace;
133 static $cachedcount = 0 ;
134 if( $t->secureAndSplit() ) {
135 if( $defaultNamespace == NS_MAIN
) {
136 if( $cachedcount >= self
::CACHE_MAX
) {
137 # Avoid memory leaks on mass operations...
138 Title
::$titleCache = array();
142 Title
::$titleCache[$text] =& $t;
152 * Create a new Title from URL-encoded text. Ensures that
153 * the given title's length does not exceed the maximum.
154 * @param $url \type{\string} the title, as might be taken from a URL
155 * @return \type{Title} the new object, or NULL on an error
157 public static function newFromURL( $url ) {
158 global $wgLegalTitleChars;
161 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
162 # but some URLs used it as a space replacement and they still come
163 # from some external search tools.
164 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
165 $url = str_replace( '+', ' ', $url );
168 $t->mDbkeyform
= str_replace( ' ', '_', $url );
169 if( $t->secureAndSplit() ) {
177 * Create a new Title from an article ID
179 * @todo This is inefficiently implemented, the page row is requested
180 * but not used for anything else
182 * @param $id \type{\int} the page_id corresponding to the Title to create
183 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
184 * @return \type{Title} the new object, or NULL on an error
186 public static function newFromID( $id, $flags = 0 ) {
187 $fname = 'Title::newFromID';
188 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
189 $row = $db->selectRow( 'page', array( 'page_namespace', 'page_title' ),
190 array( 'page_id' => $id ), $fname );
191 if ( $row !== false ) {
192 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
200 * Make an array of titles from an array of IDs
201 * @param $ids \type{\arrayof{\int}} Array of IDs
202 * @return \type{\arrayof{Title}} Array of Titles
204 public static function newFromIDs( $ids ) {
205 if ( !count( $ids ) ) {
208 $dbr = wfGetDB( DB_SLAVE
);
209 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
210 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
213 foreach( $res as $row ) {
214 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
220 * Make a Title object from a DB row
221 * @param $row \type{Row} (needs at least page_title,page_namespace)
222 * @return \type{Title} corresponding Title
224 public static function newFromRow( $row ) {
225 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
227 $t->mArticleID
= isset($row->page_id
) ?
intval($row->page_id
) : -1;
228 $t->mLength
= isset($row->page_len
) ?
intval($row->page_len
) : -1;
229 $t->mRedirect
= isset($row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: NULL;
230 $t->mLatestID
= isset($row->page_latest
) ?
$row->page_latest
: false;
236 * Create a new Title from a namespace index and a DB key.
237 * It's assumed that $ns and $title are *valid*, for instance when
238 * they came directly from the database or a special page name.
239 * For convenience, spaces are converted to underscores so that
240 * eg user_text fields can be used directly.
242 * @param $ns \type{\int} the namespace of the article
243 * @param $title \type{\string} the unprefixed database key form
244 * @param $fragment \type{\string} The link fragment (after the "#")
245 * @return \type{Title} the new object
247 public static function &makeTitle( $ns, $title, $fragment = '' ) {
250 $t->mFragment
= $fragment;
251 $t->mNamespace
= $ns = intval( $ns );
252 $t->mDbkeyform
= str_replace( ' ', '_', $title );
253 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
254 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
255 $t->mTextform
= str_replace( '_', ' ', $title );
260 * Create a new Title from a namespace index and a DB key.
261 * The parameters will be checked for validity, which is a bit slower
262 * than makeTitle() but safer for user-provided data.
264 * @param $ns \type{\int} the namespace of the article
265 * @param $title \type{\string} the database key form
266 * @param $fragment \type{\string} The link fragment (after the "#")
267 * @return \type{Title} the new object, or NULL on an error
269 public static function makeTitleSafe( $ns, $title, $fragment = '' ) {
271 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment );
272 if( $t->secureAndSplit() ) {
280 * Create a new Title for the Main Page
281 * @return \type{Title} the new object
283 public static function newMainPage() {
284 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
285 // Don't give fatal errors if the message is broken
287 $title = Title
::newFromText( 'Main Page' );
293 * Extract a redirect destination from a string and return the
294 * Title, or null if the text doesn't contain a valid redirect
296 * @param $text \type{String} Text with possible redirect
297 * @return \type{Title} The corresponding Title
299 public static function newFromRedirect( $text ) {
300 $redir = MagicWord
::get( 'redirect' );
302 if( $redir->matchStartAndRemove( $text ) ) {
303 // Extract the first link and see if it's usable
304 // Ensure that it really does come directly after #REDIRECT
305 // Some older redirects included a colon, so don't freak about that!
307 if( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
308 // Strip preceding colon used to "escape" categories, etc.
309 // and URL-decode links
310 if( strpos( $m[1], '%' ) !== false ) {
311 // Match behavior of inline link parsing here;
312 // don't interpret + as " " most of the time!
313 // It might be safe to just use rawurldecode instead, though.
314 $m[1] = urldecode( ltrim( $m[1], ':' ) );
316 $title = Title
::newFromText( $m[1] );
317 // Redirects to Special:Userlogout are not permitted
318 if( $title instanceof Title
&& !$title->isSpecial( 'Userlogout' ) )
325 #----------------------------------------------------------------------------
327 #----------------------------------------------------------------------------
330 * Get the prefixed DB key associated with an ID
331 * @param $id \type{\int} the page_id of the article
332 * @return \type{Title} an object representing the article, or NULL
333 * if no such article was found
335 public static function nameOf( $id ) {
336 $dbr = wfGetDB( DB_SLAVE
);
338 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), __METHOD__
);
339 if ( $s === false ) { return NULL; }
341 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
346 * Get a regex character class describing the legal characters in a link
347 * @return \type{\string} the list of characters, not delimited
349 public static function legalChars() {
350 global $wgLegalTitleChars;
351 return $wgLegalTitleChars;
355 * Get a string representation of a title suitable for
356 * including in a search index
358 * @param $ns \type{\int} a namespace index
359 * @param $title \type{\string} text-form main part
360 * @return \type{\string} a stripped-down title string ready for the
363 public static function indexTitle( $ns, $title ) {
366 $lc = SearchEngine
::legalSearchChars() . '&#;';
367 $t = $wgContLang->stripForSearch( $title );
368 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
369 $t = $wgContLang->lc( $t );
372 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
373 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
375 $t = preg_replace( "/\\s+/", ' ', $t );
377 if ( $ns == NS_IMAGE
) {
378 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
384 * Make a prefixed DB key from a DB key and a namespace index
385 * @param $ns \type{\int} numerical representation of the namespace
386 * @param $title \type{\string} the DB key form the title
387 * @param $fragment \type{\string} The link fragment (after the "#")
388 * @return \type{\string} the prefixed form of the title
390 public static function makeName( $ns, $title, $fragment = '' ) {
393 $namespace = $wgContLang->getNsText( $ns );
394 $name = $namespace == '' ?
$title : "$namespace:$title";
395 if ( strval( $fragment ) != '' ) {
396 $name .= '#' . $fragment;
402 * Returns the URL associated with an interwiki prefix
403 * @param $key \type{\string} the interwiki prefix (e.g. "MeatBall")
404 * @return \type{\string} the associated URL, containing "$1",
405 * which should be replaced by an article title
408 public function getInterwikiLink( $key ) {
409 global $wgMemc, $wgInterwikiExpiry;
410 global $wgInterwikiCache, $wgContLang;
411 $fname = 'Title::getInterwikiLink';
413 if ( count( Title
::$interwikiCache ) >= self
::CACHE_MAX
) {
414 // Don't use infinite memory
415 reset( Title
::$interwikiCache );
416 unset( Title
::$interwikiCache[ key( Title
::$interwikiCache ) ] );
419 $key = $wgContLang->lc( $key );
421 $k = wfMemcKey( 'interwiki', $key );
422 if( array_key_exists( $k, Title
::$interwikiCache ) ) {
423 return Title
::$interwikiCache[$k]->iw_url
;
426 if ($wgInterwikiCache) {
427 return Title
::getInterwikiCached( $key );
430 $s = $wgMemc->get( $k );
431 # Ignore old keys with no iw_local
432 if( $s && isset( $s->iw_local
) && isset($s->iw_trans
)) {
433 Title
::$interwikiCache[$k] = $s;
437 $dbr = wfGetDB( DB_SLAVE
);
438 $res = $dbr->select( 'interwiki',
439 array( 'iw_url', 'iw_local', 'iw_trans' ),
440 array( 'iw_prefix' => $key ), $fname );
445 $s = $dbr->fetchObject( $res );
447 # Cache non-existence: create a blank object and save it to memcached
453 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
454 Title
::$interwikiCache[$k] = $s;
460 * Fetch interwiki prefix data from local cache in constant database.
462 * @note More logic is explained in DefaultSettings.
464 * @param $key \type{\string} Database key
465 * @return \type{\string} URL of interwiki site
467 public static function getInterwikiCached( $key ) {
468 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
472 $db=dba_open($wgInterwikiCache,'r','cdb');
473 /* Resolve site name */
474 if ($wgInterwikiScopes>=3 and !$site) {
475 $site = dba_fetch('__sites:' . wfWikiID(), $db);
477 $site = $wgInterwikiFallbackSite;
479 $value = dba_fetch( wfMemcKey( $key ), $db);
480 if ($value=='' and $wgInterwikiScopes>=3) {
482 $value = dba_fetch("_{$site}:{$key}", $db);
484 if ($value=='' and $wgInterwikiScopes>=2) {
486 $value = dba_fetch("__global:{$key}", $db);
495 list($local,$url)=explode(' ',$value,2);
497 $s->iw_local
=(int)$local;
499 Title
::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s;
504 * Determine whether the object refers to a page within
507 * @return \type{\bool} TRUE if this is an in-project interwiki link
508 * or a wikilink, FALSE otherwise
510 public function isLocal() {
511 if ( $this->mInterwiki
!= '' ) {
512 # Make sure key is loaded into cache
513 $this->getInterwikiLink( $this->mInterwiki
);
514 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
515 return (bool)(Title
::$interwikiCache[$k]->iw_local
);
522 * Determine whether the object refers to a page within
523 * this project and is transcludable.
525 * @return \type{\bool} TRUE if this is transcludable
527 public function isTrans() {
528 if ($this->mInterwiki
== '')
530 # Make sure key is loaded into cache
531 $this->getInterwikiLink( $this->mInterwiki
);
532 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
533 return (bool)(Title
::$interwikiCache[$k]->iw_trans
);
537 * Escape a text fragment, say from a link, for a URL
539 static function escapeFragmentForURL( $fragment ) {
540 $fragment = str_replace( ' ', '_', $fragment );
541 $fragment = urlencode( Sanitizer
::decodeCharReferences( $fragment ) );
542 $replaceArray = array(
546 return strtr( $fragment, $replaceArray );
549 #----------------------------------------------------------------------------
551 #----------------------------------------------------------------------------
553 /** Simple accessors */
555 * Get the text form (spaces not underscores) of the main part
556 * @return \type{\string} Main part of the title
558 public function getText() { return $this->mTextform
; }
560 * Get the URL-encoded form of the main part
561 * @return \type{\string} Main part of the title, URL-encoded
563 public function getPartialURL() { return $this->mUrlform
; }
565 * Get the main part with underscores
566 * @return \type{\string} Main part of the title, with underscores
568 public function getDBkey() { return $this->mDbkeyform
; }
570 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
571 * @return \type{\int} Namespace index
573 public function getNamespace() { return $this->mNamespace
; }
575 * Get the namespace text
576 * @return \type{\string} Namespace text
578 public function getNsText() {
579 global $wgContLang, $wgCanonicalNamespaceNames;
581 if ( '' != $this->mInterwiki
) {
582 // This probably shouldn't even happen. ohh man, oh yuck.
583 // But for interwiki transclusion it sometimes does.
584 // Shit. Shit shit shit.
586 // Use the canonical namespaces if possible to try to
587 // resolve a foreign namespace.
588 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
589 return $wgCanonicalNamespaceNames[$this->mNamespace
];
592 return $wgContLang->getNsText( $this->mNamespace
);
595 * Get the DB key with the initial letter case as specified by the user
596 * @return \type{\string} DB key
598 function getUserCaseDBKey() {
599 return $this->mUserCaseDBKey
;
602 * Get the namespace text of the subject (rather than talk) page
603 * @return \type{\string} Namespace text
605 public function getSubjectNsText() {
607 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
610 * Get the namespace text of the talk page
611 * @return \type{\string} Namespace text
613 public function getTalkNsText() {
615 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
618 * Could this title have a corresponding talk page?
619 * @return \type{\bool} TRUE or FALSE
621 public function canTalk() {
622 return( MWNamespace
::canTalk( $this->mNamespace
) );
625 * Get the interwiki prefix (or null string)
626 * @return \type{\string} Interwiki prefix
628 public function getInterwiki() { return $this->mInterwiki
; }
630 * Get the Title fragment (i.e.\ the bit after the #) in text form
631 * @return \type{\string} Title fragment
633 public function getFragment() { return $this->mFragment
; }
635 * Get the fragment in URL form, including the "#" character if there is one
636 * @return \type{\string} Fragment in URL form
638 public function getFragmentForURL() {
639 if ( $this->mFragment
== '' ) {
642 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
646 * Get the default namespace index, for when there is no namespace
647 * @return \type{\int} Default namespace index
649 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
652 * Get title for search index
653 * @return \type{\string} a stripped-down title string ready for the
656 public function getIndexTitle() {
657 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
661 * Get the prefixed database key form
662 * @return \type{\string} the prefixed title, with underscores and
663 * any interwiki and namespace prefixes
665 public function getPrefixedDBkey() {
666 $s = $this->prefix( $this->mDbkeyform
);
667 $s = str_replace( ' ', '_', $s );
672 * Get the prefixed title with spaces.
673 * This is the form usually used for display
674 * @return \type{\string} the prefixed title, with spaces
676 public function getPrefixedText() {
677 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
678 $s = $this->prefix( $this->mTextform
);
679 $s = str_replace( '_', ' ', $s );
680 $this->mPrefixedText
= $s;
682 return $this->mPrefixedText
;
686 * Get the prefixed title with spaces, plus any fragment
687 * (part beginning with '#')
688 * @return \type{\string} the prefixed title, with spaces and
689 * the fragment, including '#'
691 public function getFullText() {
692 $text = $this->getPrefixedText();
693 if( '' != $this->mFragment
) {
694 $text .= '#' . $this->mFragment
;
700 * Get the base name, i.e. the leftmost parts before the /
701 * @return \type{\string} Base name
703 public function getBaseText() {
704 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
705 return $this->getText();
708 $parts = explode( '/', $this->getText() );
709 # Don't discard the real title if there's no subpage involved
710 if( count( $parts ) > 1 )
711 unset( $parts[ count( $parts ) - 1 ] );
712 return implode( '/', $parts );
716 * Get the lowest-level subpage name, i.e. the rightmost part after /
717 * @return \type{\string} Subpage name
719 public function getSubpageText() {
720 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
721 return( $this->mTextform
);
723 $parts = explode( '/', $this->mTextform
);
724 return( $parts[ count( $parts ) - 1 ] );
728 * Get a URL-encoded form of the subpage text
729 * @return \type{\string} URL-encoded subpage name
731 public function getSubpageUrlForm() {
732 $text = $this->getSubpageText();
733 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
734 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
739 * Get a URL-encoded title (not an actual URL) including interwiki
740 * @return \type{\string} the URL-encoded form
742 public function getPrefixedURL() {
743 $s = $this->prefix( $this->mDbkeyform
);
744 $s = str_replace( ' ', '_', $s );
746 $s = wfUrlencode ( $s ) ;
748 # Cleaning up URL to make it look nice -- is this safe?
749 $s = str_replace( '%28', '(', $s );
750 $s = str_replace( '%29', ')', $s );
756 * Get a real URL referring to this title, with interwiki link and
759 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
760 * links. Can be specified as an associative array as well, e.g.,
761 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
762 * @param $variant \type{\string} language variant of url (for sr, zh..)
763 * @return \type{\string} the URL
765 public function getFullURL( $query = '', $variant = false ) {
766 global $wgContLang, $wgServer, $wgRequest;
768 if( is_array( $query ) ) {
769 $query = wfArrayToCGI( $query );
772 if ( '' == $this->mInterwiki
) {
773 $url = $this->getLocalUrl( $query, $variant );
775 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
776 // Correct fix would be to move the prepending elsewhere.
777 if ($wgRequest->getVal('action') != 'render') {
778 $url = $wgServer . $url;
781 $baseUrl = $this->getInterwikiLink( $this->mInterwiki
);
783 $namespace = wfUrlencode( $this->getNsText() );
784 if ( '' != $namespace ) {
785 # Can this actually happen? Interwikis shouldn't be parsed.
786 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
789 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
790 $url = wfAppendQuery( $url, $query );
793 # Finally, add the fragment.
794 $url .= $this->getFragmentForURL();
796 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
801 * Get a URL with no fragment or server name. If this page is generated
802 * with action=render, $wgServer is prepended.
803 * @param mixed $query an optional query string; if not specified,
804 * $wgArticlePath will be used. Can be specified as an associative array
805 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
807 * @param $variant \type{\string} language variant of url (for sr, zh..)
808 * @return \type{\string} the URL
810 public function getLocalURL( $query = '', $variant = false ) {
811 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
812 global $wgVariantArticlePath, $wgContLang, $wgUser;
814 if( is_array( $query ) ) {
815 $query = wfArrayToCGI( $query );
818 // internal links should point to same variant as current page (only anonymous users)
819 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
820 $pref = $wgContLang->getPreferredVariant(false);
821 if($pref != $wgContLang->getCode())
825 if ( $this->isExternal() ) {
826 $url = $this->getFullURL();
828 // This is currently only used for edit section links in the
829 // context of interwiki transclusion. In theory we should
830 // append the query to the end of any existing query string,
831 // but interwiki transclusion is already broken in that case.
835 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
836 if ( $query == '' ) {
837 if( $variant != false && $wgContLang->hasVariants() ) {
838 if( $wgVariantArticlePath == false ) {
839 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
841 $variantArticlePath = $wgVariantArticlePath;
843 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
844 $url = str_replace( '$1', $dbkey, $url );
846 $url = str_replace( '$1', $dbkey, $wgArticlePath );
849 global $wgActionPaths;
852 if( !empty( $wgActionPaths ) &&
853 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
855 $action = urldecode( $matches[2] );
856 if( isset( $wgActionPaths[$action] ) ) {
857 $query = $matches[1];
858 if( isset( $matches[4] ) ) $query .= $matches[4];
859 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
860 if( $query != '' ) $url .= '?' . $query;
863 if ( $url === false ) {
864 if ( $query == '-' ) {
867 $url = "{$wgScript}?title={$dbkey}&{$query}";
871 // FIXME: this causes breakage in various places when we
872 // actually expected a local URL and end up with dupe prefixes.
873 if ($wgRequest->getVal('action') == 'render') {
874 $url = $wgServer . $url;
877 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
882 * Get a URL that's the simplest URL that will be valid to link, locally,
883 * to the current Title. It includes the fragment, but does not include
884 * the server unless action=render is used (or the link is external). If
885 * there's a fragment but the prefixed text is empty, we just return a link
888 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
889 * query string. Keys and values will be escaped.
890 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
891 * for external links. Default is "false" (same variant as current page,
892 * for anonymous users).
893 * @return \type{\string} the URL
895 public function getLinkUrl( $query = array(), $variant = false ) {
896 if( !is_array( $query ) ) {
897 throw new MWException( 'Title::getLinkUrl passed a non-array for '.
900 if( $this->isExternal() ) {
901 return $this->getFullURL( $query );
902 } elseif( $this->getPrefixedText() === ''
903 and $this->getFragment() !== '' ) {
904 return $this->getFragmentForURL();
906 return $this->getLocalURL( $query, $variant )
907 . $this->getFragmentForURL();
912 * Get an HTML-escaped version of the URL form, suitable for
913 * using in a link, without a server name or fragment
914 * @param $query \type{\string} an optional query string
915 * @return \type{\string} the URL
917 public function escapeLocalURL( $query = '' ) {
918 return htmlspecialchars( $this->getLocalURL( $query ) );
922 * Get an HTML-escaped version of the URL form, suitable for
923 * using in a link, including the server name and fragment
925 * @param $query \type{\string} an optional query string
926 * @return \type{\string} the URL
928 public function escapeFullURL( $query = '' ) {
929 return htmlspecialchars( $this->getFullURL( $query ) );
933 * Get the URL form for an internal link.
934 * - Used in various Squid-related code, in case we have a different
935 * internal hostname for the server from the exposed one.
937 * @param $query \type{\string} an optional query string
938 * @param $variant \type{\string} language variant of url (for sr, zh..)
939 * @return \type{\string} the URL
941 public function getInternalURL( $query = '', $variant = false ) {
942 global $wgInternalServer;
943 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
944 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
949 * Get the edit URL for this Title
950 * @return \type{\string} the URL, or a null string if this is an
953 public function getEditURL() {
954 if ( '' != $this->mInterwiki
) { return ''; }
955 $s = $this->getLocalURL( 'action=edit' );
961 * Get the HTML-escaped displayable text form.
962 * Used for the title field in <a> tags.
963 * @return \type{\string} the text, including any prefixes
965 public function getEscapedText() {
966 return htmlspecialchars( $this->getPrefixedText() );
970 * Is this Title interwiki?
971 * @return \type{\bool}
973 public function isExternal() { return ( '' != $this->mInterwiki
); }
976 * Is this page "semi-protected" - the *only* protection is autoconfirm?
978 * @param @action \type{\string} Action to check (default: edit)
979 * @return \type{\bool}
981 public function isSemiProtected( $action = 'edit' ) {
982 if( $this->exists() ) {
983 $restrictions = $this->getRestrictions( $action );
984 if( count( $restrictions ) > 0 ) {
985 foreach( $restrictions as $restriction ) {
986 if( strtolower( $restriction ) != 'autoconfirmed' )
995 # If it doesn't exist, it can't be protected
1001 * Does the title correspond to a protected article?
1002 * @param $what \type{\string} the action the page is protected from,
1003 * by default checks move and edit
1004 * @return \type{\bool}
1006 public function isProtected( $action = '' ) {
1007 global $wgRestrictionLevels, $wgRestrictionTypes;
1009 # Special pages have inherent protection
1010 if( $this->getNamespace() == NS_SPECIAL
)
1013 # Check regular protection levels
1014 foreach( $wgRestrictionTypes as $type ){
1015 if( $action == $type ||
$action == '' ) {
1016 $r = $this->getRestrictions( $type );
1017 foreach( $wgRestrictionLevels as $level ) {
1018 if( in_array( $level, $r ) && $level != '' ) {
1029 * Is $wgUser watching this page?
1030 * @return \type{\bool}
1032 public function userIsWatching() {
1035 if ( is_null( $this->mWatched
) ) {
1036 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
1037 $this->mWatched
= false;
1039 $this->mWatched
= $wgUser->isWatched( $this );
1042 return $this->mWatched
;
1046 * Can $wgUser perform $action on this page?
1047 * This skips potentially expensive cascading permission checks.
1049 * Suitable for use for nonessential UI controls in common cases, but
1050 * _not_ for functional access control.
1052 * May provide false positives, but should never provide a false negative.
1054 * @param $action \type{\string} action that permission needs to be checked for
1055 * @return \type{\bool}
1057 public function quickUserCan( $action ) {
1058 return $this->userCan( $action, false );
1062 * Determines if $wgUser is unable to edit this page because it has been protected
1063 * by $wgNamespaceProtection.
1065 * @return \type{\bool}
1067 public function isNamespaceProtected() {
1068 global $wgNamespaceProtection, $wgUser;
1069 if( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
1070 foreach( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
1071 if( $right != '' && !$wgUser->isAllowed( $right ) )
1079 * Can $wgUser perform $action on this page?
1080 * @param $action \type{\string} action that permission needs to be checked for
1081 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1082 * @return \type{\bool}
1084 public function userCan( $action, $doExpensiveQueries = true ) {
1086 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries ) === array());
1090 * Can $user perform $action on this page?
1092 * FIXME: This *does not* check throttles (User::pingLimiter()).
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 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1098 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1100 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1101 if( !StubObject
::isRealObject( $user ) ) {
1102 //Since StubObject is always used on globals, we can unstub $wgUser here and set $user = $wgUser
1104 $wgUser->_unstub( '', 5 );
1107 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1111 global $wgEmailConfirmToEdit;
1113 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1114 $errors[] = array( 'confirmedittext' );
1117 if ( $user->isBlockedFrom( $this ) && $action != 'createaccount' ) {
1118 $block = $user->mBlock
;
1120 // This is from OutputPage::blockedPage
1121 // Copied at r23888 by werdna
1123 $id = $user->blockedBy();
1124 $reason = $user->blockedFor();
1125 if( $reason == '' ) {
1126 $reason = wfMsg( 'blockednoreason' );
1130 if ( is_numeric( $id ) ) {
1131 $name = User
::whoIs( $id );
1136 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1137 $blockid = $block->mId
;
1138 $blockExpiry = $user->mBlock
->mExpiry
;
1139 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1141 if ( $blockExpiry == 'infinity' ) {
1142 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1143 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1145 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1146 if ( strpos( $option, ':' ) == false )
1149 list ($show, $value) = explode( ":", $option );
1151 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1152 $blockExpiry = $show;
1157 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1160 $intended = $user->mBlock
->mAddress
;
1162 $errors[] = array( ($block->mAuto ?
'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name,
1163 $blockid, $blockExpiry, $intended, $blockTimestamp );
1166 // Remove the errors being ignored.
1168 foreach( $errors as $index => $error ) {
1169 $error_key = is_array($error) ?
$error[0] : $error;
1171 if (in_array( $error_key, $ignoreErrors )) {
1172 unset($errors[$index]);
1180 * Can $user perform $action on this page? This is an internal function,
1181 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1182 * checks on wfReadOnly() and blocks)
1184 * @param $action \type{\string} action that permission needs to be checked for
1185 * @param $user \type{User} user to check
1186 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1187 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1189 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1190 wfProfileIn( __METHOD__
);
1194 // Use getUserPermissionsErrors instead
1195 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1196 wfProfileOut( __METHOD__
);
1197 return $result ?
array() : array( array( 'badaccess-group0' ) );
1200 if (!wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1201 if ($result != array() && is_array($result) && !is_array($result[0]))
1202 $errors[] = $result; # A single array representing an error
1203 else if (is_array($result) && is_array($result[0]))
1204 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1205 else if ($result != '' && $result != null && $result !== true && $result !== false)
1206 $errors[] = array($result); # A string representing a message-id
1207 else if ($result === false )
1208 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1210 if ($doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1211 if ($result != array() && is_array($result) && !is_array($result[0]))
1212 $errors[] = $result; # A single array representing an error
1213 else if (is_array($result) && is_array($result[0]))
1214 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1215 else if ($result != '' && $result != null && $result !== true && $result !== false)
1216 $errors[] = array($result); # A string representing a message-id
1217 else if ($result === false )
1218 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1221 $specialOKActions = array( 'createaccount', 'execute' );
1222 if( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions) ) {
1223 $errors[] = array('ns-specialprotected');
1226 if ( $this->isNamespaceProtected() ) {
1227 $ns = $this->getNamespace() == NS_MAIN
1228 ?
wfMsg( 'nstab-main' )
1229 : $this->getNsText();
1230 $errors[] = (NS_MEDIAWIKI
== $this->mNamespace
1231 ?
array('protectedinterface')
1232 : array( 'namespaceprotected', $ns ) );
1235 if( $this->mDbkeyform
== '_' ) {
1236 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1237 $errors[] = array('badaccess-group0');
1240 # protect css/js subpages of user pages
1241 # XXX: this might be better using restrictions
1242 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1243 if( $this->isCssJsSubpage()
1244 && !$user->isAllowed('editusercssjs')
1245 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform
) ) {
1246 $errors[] = array('customcssjsprotected');
1249 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1250 # We /could/ use the protection level on the source page, but it's fairly ugly
1251 # as we have to establish a precedence hierarchy for pages included by multiple
1252 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1253 # as they could remove the protection anyway.
1254 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1255 # Cascading protection depends on more than this page...
1256 # Several cascading protected pages may include this page...
1257 # Check each cascading level
1258 # This is only for protection restrictions, not for all actions
1259 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1260 foreach( $restrictions[$action] as $right ) {
1261 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1262 if( '' != $right && !$user->isAllowed( $right ) ) {
1264 foreach( $cascadingSources as $page )
1265 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1266 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1272 foreach( $this->getRestrictions($action) as $right ) {
1273 // Backwards compatibility, rewrite sysop -> protect
1274 if ( $right == 'sysop' ) {
1277 if( '' != $right && !$user->isAllowed( $right ) ) {
1278 //Users with 'editprotected' permission can edit protected pages
1279 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1280 //Users with 'editprotected' permission cannot edit protected pages
1281 //with cascading option turned on.
1282 if($this->mCascadeRestriction
) {
1283 $errors[] = array( 'protectedpagetext', $right );
1285 //Nothing, user can edit!
1288 $errors[] = array( 'protectedpagetext', $right );
1293 if ($action == 'protect') {
1294 if ($this->getUserPermissionsErrors('edit', $user) != array()) {
1295 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1299 if ($action == 'create') {
1300 $title_protection = $this->getTitleProtection();
1302 if (is_array($title_protection)) {
1303 extract($title_protection);
1305 if ($pt_create_perm == 'sysop')
1306 $pt_create_perm = 'protect';
1308 if ($pt_create_perm == '' ||
!$user->isAllowed($pt_create_perm)) {
1309 $errors[] = array ( 'titleprotected', User
::whoIs($pt_user), $pt_reason );
1313 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1314 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1315 $errors[] = $user->isAnon() ?
array ('nocreatetext') : array ('nocreate-loggedin');
1317 } elseif( $action == 'move' && !( $this->isMovable() && $user->isAllowed( 'move' ) ) ) {
1318 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1319 } elseif ( !$user->isAllowed( $action ) ) {
1321 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1322 User
::getGroupsWithPermission( $action ) );
1324 $return = array( 'badaccess-groups',
1326 implode( ', ', $groups ),
1327 count( $groups ) ) );
1330 $return = array( "badaccess-group0" );
1332 $errors[] = $return;
1335 wfProfileOut( __METHOD__
);
1340 * Is this title subject to title protection?
1341 * @return \type{\mixed} An associative array representing any existent title
1342 * protection, or false if there's none.
1344 private function getTitleProtection() {
1345 // Can't protect pages in special namespaces
1346 if ( $this->getNamespace() < 0 ) {
1350 $dbr = wfGetDB( DB_SLAVE
);
1351 $res = $dbr->select( 'protected_titles', '*',
1352 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()) );
1354 if ($row = $dbr->fetchRow( $res )) {
1362 * Update the title protection status
1363 * @param $create_perm \type{\string} Permission required for creation
1364 * @param $reason \type{\string} Reason for protection
1365 * @param $expiry \type{\string} Expiry timestamp
1367 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1368 global $wgUser,$wgContLang;
1370 if ($create_perm == implode(',',$this->getRestrictions('create'))
1371 && $expiry == $this->mRestrictionsExpiry
['create']) {
1376 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1378 $dbw = wfGetDB( DB_MASTER
);
1380 $encodedExpiry = Block
::encodeExpiry($expiry, $dbw );
1382 $expiry_description = '';
1383 if ( $encodedExpiry != 'infinity' ) {
1384 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) ).')';
1387 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ).')';
1390 # Update protection table
1391 if ($create_perm != '' ) {
1392 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1393 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1394 , 'pt_create_perm' => $create_perm
1395 , 'pt_timestamp' => Block
::encodeExpiry(wfTimestampNow(), $dbw)
1396 , 'pt_expiry' => $encodedExpiry
1397 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__
);
1399 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1400 'pt_title' => $title ), __METHOD__
);
1402 # Update the protection log
1403 $log = new LogPage( 'protect' );
1405 if( $create_perm ) {
1406 $log->addEntry( $this->mRestrictions
['create'] ?
'modify' : 'protect', $this, trim( $reason . " [create=$create_perm] $expiry_description" ) );
1408 $log->addEntry( 'unprotect', $this, $reason );
1415 * Remove any title protection due to page existing
1417 public function deleteTitleProtection() {
1418 $dbw = wfGetDB( DB_MASTER
);
1420 $dbw->delete( 'protected_titles',
1421 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()), __METHOD__
);
1425 * Can $wgUser edit this page?
1426 * @return \type{\bool} TRUE or FALSE
1427 * @deprecated use userCan('edit')
1429 public function userCanEdit( $doExpensiveQueries = true ) {
1430 return $this->userCan( 'edit', $doExpensiveQueries );
1434 * Can $wgUser create this page?
1435 * @return \type{\bool} TRUE or FALSE
1436 * @deprecated use userCan('create')
1438 public function userCanCreate( $doExpensiveQueries = true ) {
1439 return $this->userCan( 'create', $doExpensiveQueries );
1443 * Can $wgUser move this page?
1444 * @return \type{\bool} TRUE or FALSE
1445 * @deprecated use userCan('move')
1447 public function userCanMove( $doExpensiveQueries = true ) {
1448 return $this->userCan( 'move', $doExpensiveQueries );
1452 * Would anybody with sufficient privileges be able to move this page?
1453 * Some pages just aren't movable.
1455 * @return \type{\bool} TRUE or FALSE
1457 public function isMovable() {
1458 return MWNamespace
::isMovable( $this->getNamespace() )
1459 && $this->getInterwiki() == '';
1463 * Can $wgUser read this page?
1464 * @return \type{\bool} TRUE or FALSE
1465 * @todo fold these checks into userCan()
1467 public function userCanRead() {
1468 global $wgUser, $wgGroupPermissions;
1471 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1472 if ( $result !== null ) {
1476 # Shortcut for public wikis, allows skipping quite a bit of code
1477 if ($wgGroupPermissions['*']['read'])
1480 if( $wgUser->isAllowed( 'read' ) ) {
1483 global $wgWhitelistRead;
1486 * Always grant access to the login page.
1487 * Even anons need to be able to log in.
1489 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1494 * Bail out if there isn't whitelist
1496 if( !is_array($wgWhitelistRead) ) {
1501 * Check for explicit whitelisting
1503 $name = $this->getPrefixedText();
1504 $dbName = $this->getPrefixedDBKey();
1505 // Check with and without underscores
1506 if( in_array($name,$wgWhitelistRead,true) ||
in_array($dbName,$wgWhitelistRead,true) )
1510 * Old settings might have the title prefixed with
1511 * a colon for main-namespace pages
1513 if( $this->getNamespace() == NS_MAIN
) {
1514 if( in_array( ':' . $name, $wgWhitelistRead ) )
1519 * If it's a special page, ditch the subpage bit
1522 if( $this->getNamespace() == NS_SPECIAL
) {
1523 $name = $this->getDBkey();
1524 list( $name, /* $subpage */) = SpecialPage
::resolveAliasWithSubpage( $name );
1525 if ( $name === false ) {
1526 # Invalid special page, but we show standard login required message
1530 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1531 if( in_array( $pure, $wgWhitelistRead, true ) )
1540 * Is this a talk page of some sort?
1541 * @return \type{\bool} TRUE or FALSE
1543 public function isTalkPage() {
1544 return MWNamespace
::isTalk( $this->getNamespace() );
1548 * Is this a subpage?
1549 * @return \type{\bool} TRUE or FALSE
1551 public function isSubpage() {
1552 return MWNamespace
::hasSubpages( $this->mNamespace
)
1553 ?
strpos( $this->getText(), '/' ) !== false
1558 * Does this have subpages? (Warning, usually requires an extra DB query.)
1559 * @return \type{\bool} TRUE or FALSE
1561 public function hasSubpages() {
1562 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1567 # We dynamically add a member variable for the purpose of this method
1568 # alone to cache the result. There's no point in having it hanging
1569 # around uninitialized in every Title object; therefore we only add it
1570 # if needed and don't declare it statically.
1571 if( isset( $this->mHasSubpages
) ) {
1572 return $this->mHasSubpages
;
1575 $db = wfGetDB( DB_SLAVE
);
1576 return $this->mHasSubpages
= (bool)$db->selectField( 'page', '1',
1577 "page_namespace = {$this->mNamespace} AND page_title LIKE '"
1578 . $db->escapeLike( $this->mDbkeyform
) . "/%'",
1584 * Could this page contain custom CSS or JavaScript, based
1587 * @return \type{\bool} TRUE or FALSE
1589 public function isCssOrJsPage() {
1590 return $this->mNamespace
== NS_MEDIAWIKI
1591 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1595 * Is this a .css or .js subpage of a user page?
1596 * @return \type{\bool} TRUE or FALSE
1598 public function isCssJsSubpage() {
1599 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1602 * Is this a *valid* .css or .js subpage of a user page?
1603 * Check that the corresponding skin exists
1604 * @return \type{\bool} TRUE or FALSE
1606 public function isValidCssJsSubpage() {
1607 if ( $this->isCssJsSubpage() ) {
1608 $skinNames = Skin
::getSkinNames();
1609 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1615 * Trim down a .css or .js subpage title to get the corresponding skin name
1617 public function getSkinFromCssJsSubpage() {
1618 $subpage = explode( '/', $this->mTextform
);
1619 $subpage = $subpage[ count( $subpage ) - 1 ];
1620 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1623 * Is this a .css subpage of a user page?
1624 * @return \type{\bool} TRUE or FALSE
1626 public function isCssSubpage() {
1627 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1630 * Is this a .js subpage of a user page?
1631 * @return \type{\bool} TRUE or FALSE
1633 public function isJsSubpage() {
1634 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1637 * Protect css/js subpages of user pages: can $wgUser edit
1640 * @return \type{\bool} TRUE or FALSE
1641 * @todo XXX: this might be better using restrictions
1643 public function userCanEditCssJsSubpage() {
1645 return ( $wgUser->isAllowed('editusercssjs') ||
preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1649 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1651 * @return \type{\bool} If the page is subject to cascading restrictions.
1653 public function isCascadeProtected() {
1654 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1655 return ( $sources > 0 );
1659 * Cascading protection: Get the source of any cascading restrictions on this page.
1661 * @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from.
1662 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title objects of the pages from
1663 * which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1664 * The restriction array is an array of each type, each of which contains an array of unique groups.
1666 public function getCascadeProtectionSources( $get_pages = true ) {
1667 global $wgRestrictionTypes;
1669 # Define our dimension of restrictions types
1670 $pagerestrictions = array();
1671 foreach( $wgRestrictionTypes as $action )
1672 $pagerestrictions[$action] = array();
1674 if ( isset( $this->mCascadeSources
) && $get_pages ) {
1675 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1676 } else if ( isset( $this->mHasCascadingRestrictions
) && !$get_pages ) {
1677 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1680 wfProfileIn( __METHOD__
);
1682 $dbr = wfGetDb( DB_SLAVE
);
1684 if ( $this->getNamespace() == NS_IMAGE
) {
1685 $tables = array ('imagelinks', 'page_restrictions');
1686 $where_clauses = array(
1687 'il_to' => $this->getDBkey(),
1689 'pr_cascade' => 1 );
1691 $tables = array ('templatelinks', 'page_restrictions');
1692 $where_clauses = array(
1693 'tl_namespace' => $this->getNamespace(),
1694 'tl_title' => $this->getDBkey(),
1696 'pr_cascade' => 1 );
1700 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1701 $where_clauses[] = 'page_id=pr_page';
1704 $cols = array( 'pr_expiry' );
1707 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1709 $sources = $get_pages ?
array() : false;
1710 $now = wfTimestampNow();
1711 $purgeExpired = false;
1713 foreach( $res as $row ) {
1714 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1715 if( $expiry > $now ) {
1717 $page_id = $row->pr_page
;
1718 $page_ns = $row->page_namespace
;
1719 $page_title = $row->page_title
;
1720 $sources[$page_id] = Title
::makeTitle($page_ns, $page_title);
1721 # Add groups needed for each restriction type if its not already there
1722 # Make sure this restriction type still exists
1723 if ( isset($pagerestrictions[$row->pr_type
]) && !in_array($row->pr_level
, $pagerestrictions[$row->pr_type
]) ) {
1724 $pagerestrictions[$row->pr_type
][]=$row->pr_level
;
1730 // Trigger lazy purge of expired restrictions from the db
1731 $purgeExpired = true;
1734 if( $purgeExpired ) {
1735 Title
::purgeExpiredRestrictions();
1738 wfProfileOut( __METHOD__
);
1741 $this->mCascadeSources
= $sources;
1742 $this->mCascadingRestrictions
= $pagerestrictions;
1744 $this->mHasCascadingRestrictions
= $sources;
1746 return array( $sources, $pagerestrictions );
1749 function areRestrictionsCascading() {
1750 if (!$this->mRestrictionsLoaded
) {
1751 $this->loadRestrictions();
1754 return $this->mCascadeRestriction
;
1758 * Loads a string into mRestrictions array
1759 * @param $res \type{Resource} restrictions as an SQL result.
1761 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1762 global $wgRestrictionTypes;
1763 $dbr = wfGetDB( DB_SLAVE
);
1765 foreach( $wgRestrictionTypes as $type ){
1766 $this->mRestrictions
[$type] = array();
1767 $this->mRestrictionsExpiry
[$type] = Block
::decodeExpiry('');
1770 $this->mCascadeRestriction
= false;
1772 # Backwards-compatibility: also load the restrictions from the page record (old format).
1774 if ( $oldFashionedRestrictions === NULL ) {
1775 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
1776 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1779 if ($oldFashionedRestrictions != '') {
1781 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1782 $temp = explode( '=', trim( $restrict ) );
1783 if(count($temp) == 1) {
1784 // old old format should be treated as edit/move restriction
1785 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
1786 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
1788 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1792 $this->mOldRestrictions
= true;
1796 if( $dbr->numRows( $res ) ) {
1797 # Current system - load second to make them override.
1798 $now = wfTimestampNow();
1799 $purgeExpired = false;
1801 foreach( $res as $row ) {
1802 # Cycle through all the restrictions.
1804 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1805 if( !in_array( $row->pr_type
, $wgRestrictionTypes ) )
1808 // This code should be refactored, now that it's being used more generally,
1809 // But I don't really see any harm in leaving it in Block for now -werdna
1810 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1812 // Only apply the restrictions if they haven't expired!
1813 if ( !$expiry ||
$expiry > $now ) {
1814 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
1815 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1817 $this->mCascadeRestriction |
= $row->pr_cascade
;
1819 // Trigger a lazy purge of expired restrictions
1820 $purgeExpired = true;
1824 if( $purgeExpired ) {
1825 Title
::purgeExpiredRestrictions();
1829 $this->mRestrictionsLoaded
= true;
1833 * Load restrictions from the page_restrictions table
1835 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1836 if( !$this->mRestrictionsLoaded
) {
1837 if ($this->exists()) {
1838 $dbr = wfGetDB( DB_SLAVE
);
1840 $res = $dbr->select( 'page_restrictions', '*',
1841 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1843 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1845 $title_protection = $this->getTitleProtection();
1847 if (is_array($title_protection)) {
1848 extract($title_protection);
1850 $now = wfTimestampNow();
1851 $expiry = Block
::decodeExpiry($pt_expiry);
1853 if (!$expiry ||
$expiry > $now) {
1854 // Apply the restrictions
1855 $this->mRestrictionsExpiry
['create'] = $expiry;
1856 $this->mRestrictions
['create'] = explode(',', trim($pt_create_perm) );
1857 } else { // Get rid of the old restrictions
1858 Title
::purgeExpiredRestrictions();
1861 $this->mRestrictionsExpiry
['create'] = Block
::decodeExpiry('');
1863 $this->mRestrictionsLoaded
= true;
1869 * Purge expired restrictions from the page_restrictions table
1871 static function purgeExpiredRestrictions() {
1872 $dbw = wfGetDB( DB_MASTER
);
1873 $dbw->delete( 'page_restrictions',
1874 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1877 $dbw->delete( 'protected_titles',
1878 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1883 * Accessor/initialisation for mRestrictions
1885 * @param $action \type{\string} action that permission needs to be checked for
1886 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
1888 public function getRestrictions( $action ) {
1889 if( !$this->mRestrictionsLoaded
) {
1890 $this->loadRestrictions();
1892 return isset( $this->mRestrictions
[$action] )
1893 ?
$this->mRestrictions
[$action]
1898 * Is there a version of this page in the deletion archive?
1899 * @return \type{\int} the number of archived revisions
1901 public function isDeleted() {
1902 $fname = 'Title::isDeleted';
1903 if ( $this->getNamespace() < 0 ) {
1906 $dbr = wfGetDB( DB_SLAVE
);
1907 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1908 'ar_title' => $this->getDBkey() ), $fname );
1909 if( $this->getNamespace() == NS_IMAGE
) {
1910 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1911 array( 'fa_name' => $this->getDBkey() ), $fname );
1918 * Get the article ID for this Title from the link cache,
1919 * adding it if necessary
1920 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
1922 * @return \type{\int} the ID
1924 public function getArticleID( $flags = 0 ) {
1925 $linkCache = LinkCache
::singleton();
1926 if( $flags & GAID_FOR_UPDATE
) {
1927 $oldUpdate = $linkCache->forUpdate( true );
1928 $linkCache->clearLink( $this );
1929 $this->mArticleID
= $linkCache->addLinkObj( $this );
1930 $linkCache->forUpdate( $oldUpdate );
1932 if( -1 == $this->mArticleID
) {
1933 $this->mArticleID
= $linkCache->addLinkObj( $this );
1936 return $this->mArticleID
;
1940 * Is this an article that is a redirect page?
1941 * Uses link cache, adding it if necessary
1942 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1943 * @return \type{\bool}
1945 public function isRedirect( $flags = 0 ) {
1946 if( !is_null($this->mRedirect
) )
1947 return $this->mRedirect
;
1948 # Zero for special pages.
1949 # Also, calling getArticleID() loads the field from cache!
1950 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1953 $linkCache = LinkCache
::singleton();
1954 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
1956 return $this->mRedirect
;
1960 * What is the length of this page?
1961 * Uses link cache, adding it if necessary
1962 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1963 * @return \type{\bool}
1965 public function getLength( $flags = 0 ) {
1966 if( $this->mLength
!= -1 )
1967 return $this->mLength
;
1968 # Zero for special pages.
1969 # Also, calling getArticleID() loads the field from cache!
1970 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1973 $linkCache = LinkCache
::singleton();
1974 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
1976 return $this->mLength
;
1980 * What is the page_latest field for this page?
1981 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1982 * @return \type{\int}
1984 public function getLatestRevID( $flags = 0 ) {
1985 if( $this->mLatestID
!== false )
1986 return $this->mLatestID
;
1988 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
1989 $this->mLatestID
= $db->selectField( 'page', 'page_latest',
1990 array( 'page_namespace' => $this->getNamespace(), 'page_title' => $this->getDBKey() ),
1992 return $this->mLatestID
;
1996 * This clears some fields in this object, and clears any associated
1997 * keys in the "bad links" section of the link cache.
1999 * - This is called from Article::insertNewArticle() to allow
2000 * loading of the new page_id. It's also called from
2001 * Article::doDeleteArticle()
2003 * @param $newid \type{\int} the new Article ID
2005 public function resetArticleID( $newid ) {
2006 $linkCache = LinkCache
::singleton();
2007 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2009 if ( 0 == $newid ) { $this->mArticleID
= -1; }
2010 else { $this->mArticleID
= $newid; }
2011 $this->mRestrictionsLoaded
= false;
2012 $this->mRestrictions
= array();
2016 * Updates page_touched for this page; called from LinksUpdate.php
2017 * @return \type{\bool} true if the update succeded
2019 public function invalidateCache() {
2020 global $wgUseFileCache;
2022 if ( wfReadOnly() ) {
2026 $dbw = wfGetDB( DB_MASTER
);
2027 $success = $dbw->update( 'page',
2029 'page_touched' => $dbw->timestamp()
2030 ), array( /* WHERE */
2031 'page_namespace' => $this->getNamespace() ,
2032 'page_title' => $this->getDBkey()
2033 ), 'Title::invalidateCache'
2036 if ($wgUseFileCache) {
2037 $cache = new HTMLFileCache($this);
2038 @unlink
($cache->fileCacheName());
2045 * Prefix some arbitrary text with the namespace or interwiki prefix
2048 * @param $name \type{\string} the text
2049 * @return \type{\string} the prefixed text
2052 /* private */ function prefix( $name ) {
2054 if ( '' != $this->mInterwiki
) {
2055 $p = $this->mInterwiki
. ':';
2057 if ( 0 != $this->mNamespace
) {
2058 $p .= $this->getNsText() . ':';
2064 * Secure and split - main initialisation function for this object
2066 * Assumes that mDbkeyform has been set, and is urldecoded
2067 * and uses underscores, but not otherwise munged. This function
2068 * removes illegal characters, splits off the interwiki and
2069 * namespace prefixes, sets the other forms, and canonicalizes
2071 * @return \type{\bool} true on success
2073 private function secureAndSplit() {
2074 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
2077 static $rxTc = false;
2079 # Matching titles will be held as illegal.
2081 # Any character not allowed is forbidden...
2082 '[^' . Title
::legalChars() . ']' .
2083 # URL percent encoding sequences interfere with the ability
2084 # to round-trip titles -- you can't link to them consistently.
2085 '|%[0-9A-Fa-f]{2}' .
2086 # XML/HTML character references produce similar issues.
2087 '|&[A-Za-z0-9\x80-\xff]+;' .
2089 '|&#x[0-9A-Fa-f]+;' .
2093 $this->mInterwiki
= $this->mFragment
= '';
2094 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2096 $dbkey = $this->mDbkeyform
;
2098 # Strip Unicode bidi override characters.
2099 # Sometimes they slip into cut-n-pasted page titles, where the
2100 # override chars get included in list displays.
2101 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
2102 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
2104 # Clean up whitespace
2106 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2107 $dbkey = trim( $dbkey, '_' );
2109 if ( '' == $dbkey ) {
2113 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2114 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2118 $this->mDbkeyform
= $dbkey;
2120 # Initial colon indicates main namespace rather than specified default
2121 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2122 if ( ':' == $dbkey{0} ) {
2123 $this->mNamespace
= NS_MAIN
;
2124 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2125 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2128 # Namespace or interwiki prefix
2132 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
2134 if ( $ns = $wgContLang->getNsIndex( $p )) {
2135 # Ordinary namespace
2137 $this->mNamespace
= $ns;
2138 } elseif( $this->getInterwikiLink( $p ) ) {
2140 # Can't make a local interwiki link to an interwiki link.
2141 # That's just crazy!
2147 $this->mInterwiki
= $wgContLang->lc( $p );
2149 # Redundant interwiki prefix to the local wiki
2150 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2151 if( $dbkey == '' ) {
2152 # Can't have an empty self-link
2155 $this->mInterwiki
= '';
2157 # Do another namespace split...
2161 # If there's an initial colon after the interwiki, that also
2162 # resets the default namespace
2163 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2164 $this->mNamespace
= NS_MAIN
;
2165 $dbkey = substr( $dbkey, 1 );
2168 # If there's no recognized interwiki or namespace,
2169 # then let the colon expression be part of the title.
2174 # We already know that some pages won't be in the database!
2176 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2177 $this->mArticleID
= 0;
2179 $fragment = strstr( $dbkey, '#' );
2180 if ( false !== $fragment ) {
2181 $this->setFragment( $fragment );
2182 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2183 # remove whitespace again: prevents "Foo_bar_#"
2184 # becoming "Foo_bar_"
2185 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2188 # Reject illegal characters.
2190 if( preg_match( $rxTc, $dbkey ) ) {
2195 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2196 * reachable due to the way web browsers deal with 'relative' URLs.
2197 * Also, they conflict with subpage syntax. Forbid them explicitly.
2199 if ( strpos( $dbkey, '.' ) !== false &&
2200 ( $dbkey === '.' ||
$dbkey === '..' ||
2201 strpos( $dbkey, './' ) === 0 ||
2202 strpos( $dbkey, '../' ) === 0 ||
2203 strpos( $dbkey, '/./' ) !== false ||
2204 strpos( $dbkey, '/../' ) !== false ||
2205 substr( $dbkey, -2 ) == '/.' ||
2206 substr( $dbkey, -3 ) == '/..' ) )
2212 * Magic tilde sequences? Nu-uh!
2214 if( strpos( $dbkey, '~~~' ) !== false ) {
2219 * Limit the size of titles to 255 bytes.
2220 * This is typically the size of the underlying database field.
2221 * We make an exception for special pages, which don't need to be stored
2222 * in the database, and may edge over 255 bytes due to subpage syntax
2223 * for long titles, e.g. [[Special:Block/Long name]]
2225 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2226 strlen( $dbkey ) > 512 )
2232 * Normally, all wiki links are forced to have
2233 * an initial capital letter so [[foo]] and [[Foo]]
2234 * point to the same place.
2236 * Don't force it for interwikis, since the other
2237 * site might be case-sensitive.
2239 $this->mUserCaseDBKey
= $dbkey;
2240 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2241 $dbkey = $wgContLang->ucfirst( $dbkey );
2245 * Can't make a link to a namespace alone...
2246 * "empty" local links can only be self-links
2247 * with a fragment identifier.
2250 $this->mInterwiki
== '' &&
2251 $this->mNamespace
!= NS_MAIN
) {
2254 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2255 // IP names are not allowed for accounts, and can only be referring to
2256 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2257 // there are numerous ways to present the same IP. Having sp:contribs scan
2258 // them all is silly and having some show the edits and others not is
2259 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2260 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2261 IP
::sanitizeIP( $dbkey ) : $dbkey;
2262 // Any remaining initial :s are illegal.
2263 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2268 $this->mDbkeyform
= $dbkey;
2269 $this->mUrlform
= wfUrlencode( $dbkey );
2271 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2277 * Set the fragment for this title. Removes the first character from the
2278 * specified fragment before setting, so it assumes you're passing it with
2281 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2282 * Still in active use privately.
2284 * @param $fragment \type{\string} text
2286 public function setFragment( $fragment ) {
2287 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2291 * Get a Title object associated with the talk page of this article
2292 * @return \type{Title} the object for the talk page
2294 public function getTalkPage() {
2295 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2299 * Get a title object associated with the subject page of this
2302 * @return \type{Title} the object for the subject page
2304 public function getSubjectPage() {
2305 return Title
::makeTitle( MWNamespace
::getSubject( $this->getNamespace() ), $this->getDBkey() );
2309 * Get an array of Title objects linking to this Title
2310 * Also stores the IDs in the link cache.
2312 * WARNING: do not use this function on arbitrary user-supplied titles!
2313 * On heavily-used templates it will max out the memory.
2315 * @param $options \type{\string} may be FOR UPDATE
2316 * @return \type{\arrayof{Title}} the Title objects linking here
2318 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
2319 $linkCache = LinkCache
::singleton();
2322 $db = wfGetDB( DB_MASTER
);
2324 $db = wfGetDB( DB_SLAVE
);
2327 $res = $db->select( array( 'page', $table ),
2328 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2330 "{$prefix}_from=page_id",
2331 "{$prefix}_namespace" => $this->getNamespace(),
2332 "{$prefix}_title" => $this->getDBkey() ),
2337 if ( $db->numRows( $res ) ) {
2338 foreach( $res as $row ) {
2339 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2340 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2341 $retVal[] = $titleObj;
2345 $db->freeResult( $res );
2350 * Get an array of Title objects using this Title as a template
2351 * Also stores the IDs in the link cache.
2353 * WARNING: do not use this function on arbitrary user-supplied titles!
2354 * On heavily-used templates it will max out the memory.
2356 * @param $options \type{\string} may be FOR UPDATE
2357 * @return \type{\arrayof{Title}} the Title objects linking here
2359 public function getTemplateLinksTo( $options = '' ) {
2360 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2364 * Get an array of Title objects referring to non-existent articles linked from this page
2366 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2367 * @param $options \type{\string} may be FOR UPDATE
2368 * @return \type{\arrayof{Title}} the Title objects
2370 public function getBrokenLinksFrom( $options = '' ) {
2371 if ( $this->getArticleId() == 0 ) {
2372 # All links from article ID 0 are false positives
2377 $db = wfGetDB( DB_MASTER
);
2379 $db = wfGetDB( DB_SLAVE
);
2382 $res = $db->safeQuery(
2383 "SELECT pl_namespace, pl_title
2386 ON pl_namespace=page_namespace
2387 AND pl_title=page_title
2389 AND page_namespace IS NULL
2391 $db->tableName( 'pagelinks' ),
2392 $db->tableName( 'page' ),
2393 $this->getArticleId(),
2397 if ( $db->numRows( $res ) ) {
2398 foreach( $res as $row ) {
2399 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2402 $db->freeResult( $res );
2408 * Get a list of URLs to purge from the Squid cache when this
2411 * @return \type{\arrayof{\string}} the URLs
2413 public function getSquidURLs() {
2417 $this->getInternalURL(),
2418 $this->getInternalURL( 'action=history' )
2421 // purge variant urls as well
2422 if($wgContLang->hasVariants()){
2423 $variants = $wgContLang->getVariants();
2424 foreach($variants as $vCode){
2425 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2426 $urls[] = $this->getInternalURL('',$vCode);
2434 * Purge all applicable Squid URLs
2436 public function purgeSquid() {
2438 if ( $wgUseSquid ) {
2439 $urls = $this->getSquidURLs();
2440 $u = new SquidUpdate( $urls );
2446 * Move this page without authentication
2447 * @param &$nt \type{Title} the new page Title
2449 public function moveNoAuth( &$nt ) {
2450 return $this->moveTo( $nt, false );
2454 * Check whether a given move operation would be valid.
2455 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2456 * @param &$nt \type{Title} the new title
2457 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2459 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2460 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2462 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2465 // Normally we'd add this to $errors, but we'll get
2466 // lots of syntax errors if $nt is not an object
2467 return array(array('badtitletext'));
2469 if( $this->equals( $nt ) ) {
2470 $errors[] = array('selfmove');
2472 if( !$this->isMovable() ||
!$nt->isMovable() ) {
2473 $errors[] = array('immobile_namespace');
2476 $oldid = $this->getArticleID();
2477 $newid = $nt->getArticleID();
2479 if ( strlen( $nt->getDBkey() ) < 1 ) {
2480 $errors[] = array('articleexists');
2482 if ( ( '' == $this->getDBkey() ) ||
2484 ( '' == $nt->getDBkey() ) ) {
2485 $errors[] = array('badarticleerror');
2488 // Image-specific checks
2489 if( $this->getNamespace() == NS_IMAGE
) {
2490 $file = wfLocalFile( $this );
2491 if( $file->exists() ) {
2492 if( $nt->getNamespace() != NS_IMAGE
) {
2493 $errors[] = array('imagenocrossnamespace');
2495 if( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2496 $errors[] = array('imageinvalidfilename');
2498 if( !File
::checkExtensionCompatibility( $file, $nt->getDbKey() ) ) {
2499 $errors[] = array('imagetypemismatch');
2506 $errors = wfArrayMerge($errors,
2507 $this->getUserPermissionsErrors('move', $wgUser),
2508 $this->getUserPermissionsErrors('edit', $wgUser),
2509 $nt->getUserPermissionsErrors('move', $wgUser),
2510 $nt->getUserPermissionsErrors('edit', $wgUser));
2513 $match = EditPage
::matchSpamRegex( $reason );
2514 if( $match !== false ) {
2515 // This is kind of lame, won't display nice
2516 $errors[] = array('spamprotectiontext');
2521 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2522 $errors[] = array('hookaborted', $err);
2525 # The move is allowed only if (1) the target doesn't exist, or
2526 # (2) the target is a redirect to the source, and has no history
2527 # (so we can undo bad moves right after they're done).
2529 if ( 0 != $newid ) { # Target exists; check for validity
2530 if ( ! $this->isValidMoveTarget( $nt ) ) {
2531 $errors[] = array('articleexists');
2534 $tp = $nt->getTitleProtection();
2535 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2536 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2537 $errors[] = array('cantmove-titleprotected');
2546 * Move a title to a new location
2547 * @param &$nt \type{Title} the new title
2548 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2550 * @param $reason \type{\string} The reason for the move
2551 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2552 * Ignored if the user doesn't have the suppressredirect right.
2553 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2555 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2556 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2557 if( is_array( $err ) ) {
2561 $pageid = $this->getArticleID();
2562 if( $nt->exists() ) {
2563 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2564 $pageCountChange = ($createRedirect ?
0 : -1);
2565 } else { # Target didn't exist, do normal move.
2566 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2567 $pageCountChange = ($createRedirect ?
1 : 0);
2570 if( is_array( $err ) ) {
2573 $redirid = $this->getArticleID();
2575 // Category memberships include a sort key which may be customized.
2576 // If it's left as the default (the page title), we need to update
2577 // the sort key to match the new title.
2579 // Be careful to avoid resetting cl_timestamp, which may disturb
2580 // time-based lists on some sites.
2582 // Warning -- if the sort key is *explicitly* set to the old title,
2583 // we can't actually distinguish it from a default here, and it'll
2584 // be set to the new title even though it really shouldn't.
2585 // It'll get corrected on the next edit, but resetting cl_timestamp.
2586 $dbw = wfGetDB( DB_MASTER
);
2587 $dbw->update( 'categorylinks',
2589 'cl_sortkey' => $nt->getPrefixedText(),
2590 'cl_timestamp=cl_timestamp' ),
2592 'cl_from' => $pageid,
2593 'cl_sortkey' => $this->getPrefixedText() ),
2598 $oldnamespace = $this->getNamespace() & ~
1;
2599 $newnamespace = $nt->getNamespace() & ~
1;
2600 $oldtitle = $this->getDBkey();
2601 $newtitle = $nt->getDBkey();
2603 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2604 WatchedItem
::duplicateEntries( $this, $nt );
2607 # Update search engine
2608 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2610 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2614 if( $this->isContentPage() && !$nt->isContentPage() ) {
2615 # No longer a content page
2616 # Not viewed, edited, removing
2617 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2618 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2619 # Now a content page
2620 # Not viewed, edited, adding
2621 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2622 } elseif( $pageCountChange ) {
2624 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2631 # Update message cache for interface messages
2632 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2633 global $wgMessageCache;
2634 $oldarticle = new Article( $this );
2635 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2636 $newarticle = new Article( $nt );
2637 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2641 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2646 * Move page to a title which is at present a redirect to the
2649 * @param &$nt \type{Title} the page to move to, which should currently
2651 * @param $reason \type{\string} The reason for the move
2652 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
2653 * Ignored if the user doesn't have the suppressredirect right
2655 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2656 global $wgUseSquid, $wgUser;
2657 $fname = 'Title::moveOverExistingRedirect';
2658 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2661 $comment .= ": $reason";
2664 $now = wfTimestampNow();
2665 $newid = $nt->getArticleID();
2666 $oldid = $this->getArticleID();
2667 $latest = $this->getLatestRevID();
2669 $dbw = wfGetDB( DB_MASTER
);
2672 # Delete the old redirect. We don't save it to history since
2673 # by definition if we've got here it's rather uninteresting.
2674 # We have to remove it so that the next step doesn't trigger
2675 # a conflict on the unique namespace+title index...
2676 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2677 if ( !$dbw->cascadingDeletes() ) {
2678 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2679 global $wgUseTrackbacks;
2680 if ($wgUseTrackbacks)
2681 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2682 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2683 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2684 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2685 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2686 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2687 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2688 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2691 # Save a null revision in the page's history notifying of the move
2692 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2693 $nullRevId = $nullRevision->insertOn( $dbw );
2695 $article = new Article( $this );
2696 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest) );
2698 # Change the name of the target page:
2699 $dbw->update( 'page',
2701 'page_touched' => $dbw->timestamp($now),
2702 'page_namespace' => $nt->getNamespace(),
2703 'page_title' => $nt->getDBkey(),
2704 'page_latest' => $nullRevId,
2706 /* WHERE */ array( 'page_id' => $oldid ),
2709 $nt->resetArticleID( $oldid );
2711 # Recreate the redirect, this time in the other direction.
2712 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2713 $mwRedir = MagicWord
::get( 'redirect' );
2714 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2715 $redirectArticle = new Article( $this );
2716 $newid = $redirectArticle->insertOn( $dbw );
2717 $redirectRevision = new Revision( array(
2719 'comment' => $comment,
2720 'text' => $redirectText ) );
2721 $redirectRevision->insertOn( $dbw );
2722 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2724 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false) );
2726 # Now, we record the link from the redirect to the new title.
2727 # It should have no other outgoing links...
2728 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2729 $dbw->insert( 'pagelinks',
2731 'pl_from' => $newid,
2732 'pl_namespace' => $nt->getNamespace(),
2733 'pl_title' => $nt->getDBkey() ),
2736 $this->resetArticleID( 0 );
2739 # Move an image if this is a file
2740 if( $this->getNamespace() == NS_IMAGE
) {
2741 $file = wfLocalFile( $this );
2742 if( $file->exists() ) {
2743 $status = $file->move( $nt );
2744 if( !$status->isOk() ) {
2746 return $status->getErrorsArray();
2753 $log = new LogPage( 'move' );
2754 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2757 if ( $wgUseSquid ) {
2758 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2759 $u = new SquidUpdate( $urls );
2766 * Move page to non-existing title.
2767 * @param &$nt \type{Title} the new Title
2768 * @param $reason \type{\string} The reason for the move
2769 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
2770 * Ignored if the user doesn't have the suppressredirect right
2772 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2773 global $wgUseSquid, $wgUser;
2774 $fname = 'MovePageForm::moveToNewTitle';
2775 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2777 $comment .= wfMsgExt( 'colon-separator',
2778 array( 'escapenoentities', 'content' ) );
2779 $comment .= $reason;
2782 $newid = $nt->getArticleID();
2783 $oldid = $this->getArticleID();
2784 $latest = $this->getLatestRevId();
2786 $dbw = wfGetDB( DB_MASTER
);
2788 $now = $dbw->timestamp();
2790 # Save a null revision in the page's history notifying of the move
2791 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2792 $nullRevId = $nullRevision->insertOn( $dbw );
2794 $article = new Article( $this );
2795 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest) );
2798 $dbw->update( 'page',
2800 'page_touched' => $now,
2801 'page_namespace' => $nt->getNamespace(),
2802 'page_title' => $nt->getDBkey(),
2803 'page_latest' => $nullRevId,
2805 /* WHERE */ array( 'page_id' => $oldid ),
2808 $nt->resetArticleID( $oldid );
2810 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2812 $mwRedir = MagicWord
::get( 'redirect' );
2813 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2814 $redirectArticle = new Article( $this );
2815 $newid = $redirectArticle->insertOn( $dbw );
2816 $redirectRevision = new Revision( array(
2818 'comment' => $comment,
2819 'text' => $redirectText ) );
2820 $redirectRevision->insertOn( $dbw );
2821 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2823 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false) );
2825 # Record the just-created redirect's linking to the page
2826 $dbw->insert( 'pagelinks',
2828 'pl_from' => $newid,
2829 'pl_namespace' => $nt->getNamespace(),
2830 'pl_title' => $nt->getDBkey() ),
2833 $this->resetArticleID( 0 );
2836 # Move an image if this is a file
2837 if( $this->getNamespace() == NS_IMAGE
) {
2838 $file = wfLocalFile( $this );
2839 if( $file->exists() ) {
2840 $status = $file->move( $nt );
2841 if( !$status->isOk() ) {
2843 return $status->getErrorsArray();
2850 $log = new LogPage( 'move' );
2851 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2853 # Purge caches as per article creation
2854 Article
::onArticleCreate( $nt );
2856 # Purge old title from squid
2857 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2858 $this->purgeSquid();
2863 * Checks if $this can be moved to a given Title
2864 * - Selects for update, so don't call it unless you mean business
2866 * @param &$nt \type{Title} the new title to check
2867 * @return \type{\bool} TRUE or FALSE
2869 public function isValidMoveTarget( $nt ) {
2871 $fname = 'Title::isValidMoveTarget';
2872 $dbw = wfGetDB( DB_MASTER
);
2874 # Is it an existsing file?
2875 if( $nt->getNamespace() == NS_IMAGE
) {
2876 $file = wfLocalFile( $nt );
2877 if( $file->exists() ) {
2878 wfDebug( __METHOD__
. ": file exists\n" );
2884 $id = $nt->getArticleID();
2885 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2886 array( 'page_is_redirect','old_text','old_flags' ),
2887 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2888 $fname, 'FOR UPDATE' );
2890 if ( !$obj ||
0 == $obj->page_is_redirect
) {
2892 wfDebug( __METHOD__
. ": not a redirect\n" );
2895 $text = Revision
::getRevisionText( $obj );
2897 # Does the redirect point to the source?
2898 # Or is it a broken self-redirect, usually caused by namespace collisions?
2900 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2901 $redirTitle = Title
::newFromText( $m[1] );
2902 if( !is_object( $redirTitle ) ||
2903 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2904 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2905 wfDebug( __METHOD__
. ": redirect points to other page\n" );
2910 wfDebug( __METHOD__
. ": failsafe\n" );
2914 # Does the article have a history?
2915 $row = $dbw->selectRow( array( 'page', 'revision'),
2917 array( 'page_namespace' => $nt->getNamespace(),
2918 'page_title' => $nt->getDBkey(),
2919 'page_id=rev_page AND page_latest != rev_id'
2920 ), $fname, 'FOR UPDATE'
2923 # Return true if there was no history
2924 return $row === false;
2928 * Can this title be added to a user's watchlist?
2930 * @return \type{\bool} TRUE or FALSE
2932 public function isWatchable() {
2933 return !$this->isExternal()
2934 && MWNamespace
::isWatchable( $this->getNamespace() );
2938 * Get categories to which this Title belongs and return an array of
2939 * categories' names.
2941 * @return \type{\array} array an array of parents in the form:
2942 * $parent => $currentarticle
2944 public function getParentCategories() {
2947 $titlekey = $this->getArticleId();
2948 $dbr = wfGetDB( DB_SLAVE
);
2949 $categorylinks = $dbr->tableName( 'categorylinks' );
2952 $sql = "SELECT * FROM $categorylinks"
2953 ." WHERE cl_from='$titlekey'"
2954 ." AND cl_from <> '0'"
2955 ." ORDER BY cl_sortkey";
2957 $res = $dbr->query( $sql );
2959 if( $dbr->numRows( $res ) > 0 ) {
2960 foreach( $res as $row )
2961 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
2962 $data[$wgContLang->getNSText( NS_CATEGORY
).':'.$row->cl_to
] = $this->getFullText();
2963 $dbr->freeResult( $res );
2971 * Get a tree of parent categories
2972 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
2973 * @return \type{\array} Tree of parent categories
2975 public function getParentCategoryTree( $children = array() ) {
2977 $parents = $this->getParentCategories();
2980 foreach( $parents as $parent => $current ) {
2981 if ( array_key_exists( $parent, $children ) ) {
2982 # Circular reference
2983 $stack[$parent] = array();
2985 $nt = Title
::newFromText($parent);
2987 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
2999 * Get an associative array for selecting this title from
3002 * @return \type{\array} Selection array
3004 public function pageCond() {
3005 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3009 * Get the revision ID of the previous revision
3011 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3012 * @param $flags \type{\int} GAID_FOR_UPDATE
3013 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3015 public function getPreviousRevisionID( $revId, $flags=0 ) {
3016 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3017 return $db->selectField( 'revision', 'rev_id',
3019 'rev_page' => $this->getArticleId($flags),
3020 'rev_id < ' . intval( $revId )
3023 array( 'ORDER BY' => 'rev_id DESC' )
3028 * Get the revision ID of the next revision
3030 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3031 * @param $flags \type{\int} GAID_FOR_UPDATE
3032 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3034 public function getNextRevisionID( $revId, $flags=0 ) {
3035 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3036 return $db->selectField( 'revision', 'rev_id',
3038 'rev_page' => $this->getArticleId($flags),
3039 'rev_id > ' . intval( $revId )
3042 array( 'ORDER BY' => 'rev_id' )
3047 * Get the number of revisions between the given revision IDs.
3048 * Used for diffs and other things that really need it.
3050 * @param $old \type{\int} Revision ID.
3051 * @param $new \type{\int} Revision ID.
3052 * @return \type{\int} Number of revisions between these IDs.
3054 public function countRevisionsBetween( $old, $new ) {
3055 $dbr = wfGetDB( DB_SLAVE
);
3056 return $dbr->selectField( 'revision', 'count(*)',
3057 'rev_page = ' . intval( $this->getArticleId() ) .
3058 ' AND rev_id > ' . intval( $old ) .
3059 ' AND rev_id < ' . intval( $new ),
3061 array( 'USE INDEX' => 'PRIMARY' ) );
3065 * Compare with another title.
3067 * @param \type{Title} $title
3068 * @return \type{\bool} TRUE or FALSE
3070 public function equals( Title
$title ) {
3071 // Note: === is necessary for proper matching of number-like titles.
3072 return $this->getInterwiki() === $title->getInterwiki()
3073 && $this->getNamespace() == $title->getNamespace()
3074 && $this->getDBkey() === $title->getDBkey();
3078 * Callback for usort() to do title sorts by (namespace, title)
3080 static function compare( $a, $b ) {
3081 if( $a->getNamespace() == $b->getNamespace() ) {
3082 return strcmp( $a->getText(), $b->getText() );
3084 return $a->getNamespace() - $b->getNamespace();
3089 * Return a string representation of this title
3091 * @return \type{\string} String representation of this title
3093 public function __toString() {
3094 return $this->getPrefixedText();
3098 * Check if page exists
3099 * @return \type{\bool} TRUE or FALSE
3101 public function exists() {
3102 return $this->getArticleId() != 0;
3106 * Do we know that this title definitely exists, or should we otherwise
3107 * consider that it exists?
3109 * @return \type{\bool} TRUE or FALSE
3111 public function isAlwaysKnown() {
3112 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3113 // the full l10n of that language to be loaded. That takes much memory and
3114 // isn't needed. So we strip the language part away.
3115 // Also, extension messages which are not loaded, are shown as red, because
3116 // we don't call MessageCache::loadAllMessages.
3117 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3118 return $this->isExternal()
3119 ||
( $this->mNamespace
== NS_MAIN
&& $this->mDbkeyform
== '' )
3120 ||
( $this->mNamespace
== NS_MEDIAWIKI
&& wfMsgWeirdKey( $basename ) );
3124 * Update page_touched timestamps and send squid purge messages for
3125 * pages linking to this title. May be sent to the job queue depending
3126 * on the number of links. Typically called on create and delete.
3128 public function touchLinks() {
3129 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3132 if ( $this->getNamespace() == NS_CATEGORY
) {
3133 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3139 * Get the last touched timestamp
3140 * @param Database $db, optional db
3141 * @return \type{\string} Last touched timestamp
3143 public function getTouched( $db = NULL ) {
3144 $db = isset($db) ?
$db : wfGetDB( DB_SLAVE
);
3145 $touched = $db->selectField( 'page', 'page_touched',
3147 'page_namespace' => $this->getNamespace(),
3148 'page_title' => $this->getDBkey()
3155 * Get the trackback URL for this page
3156 * @return \type{\string} Trackback URL
3158 public function trackbackURL() {
3159 global $wgScriptPath, $wgServer;
3161 return "$wgServer$wgScriptPath/trackback.php?article="
3162 . htmlspecialchars(urlencode($this->getPrefixedDBkey()));
3166 * Get the trackback RDF for this page
3167 * @return \type{\string} Trackback RDF
3169 public function trackbackRDF() {
3170 $url = htmlspecialchars($this->getFullURL());
3171 $title = htmlspecialchars($this->getText());
3172 $tburl = $this->trackbackURL();
3174 // Autodiscovery RDF is placed in comments so HTML validator
3175 // won't barf. This is a rather icky workaround, but seems
3176 // frequently used by this kind of RDF thingy.
3178 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3180 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3181 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3182 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3185 dc:identifier=\"$url\"
3187 trackback:ping=\"$tburl\" />
3193 * Generate strings used for xml 'id' names in monobook tabs
3194 * @return \type{\string} XML 'id' name
3196 public function getNamespaceKey() {
3198 switch ($this->getNamespace()) {
3201 return 'nstab-main';
3204 return 'nstab-user';
3206 return 'nstab-media';
3208 return 'nstab-special';
3210 case NS_PROJECT_TALK
:
3211 return 'nstab-project';
3214 return 'nstab-image';
3216 case NS_MEDIAWIKI_TALK
:
3217 return 'nstab-mediawiki';
3219 case NS_TEMPLATE_TALK
:
3220 return 'nstab-template';
3223 return 'nstab-help';
3225 case NS_CATEGORY_TALK
:
3226 return 'nstab-category';
3228 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3233 * Returns true if this title resolves to the named special page
3234 * @param $name \type{\string} The special page name
3236 public function isSpecial( $name ) {
3237 if ( $this->getNamespace() == NS_SPECIAL
) {
3238 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3239 if ( $name == $thisName ) {
3247 * If the Title refers to a special page alias which is not the local default,
3248 * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this.
3250 public function fixSpecialName() {
3251 if ( $this->getNamespace() == NS_SPECIAL
) {
3252 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3253 if ( $canonicalName ) {
3254 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3255 if ( $localName != $this->mDbkeyform
) {
3256 return Title
::makeTitle( NS_SPECIAL
, $localName );
3264 * Is this Title in a namespace which contains content?
3265 * In other words, is this a content page, for the purposes of calculating
3268 * @return \type{\bool} TRUE or FALSE
3270 public function isContentPage() {
3271 return MWNamespace
::isContent( $this->getNamespace() );
3275 * Get all extant redirects to this Title
3277 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3278 * NULL to consider all namespaces
3279 * @return \type{\arrayof{Title}} Redirects to this title
3281 public function getRedirectsHere( $ns = null ) {
3284 $dbr = wfGetDB( DB_SLAVE
);
3286 'rd_namespace' => $this->getNamespace(),
3287 'rd_title' => $this->getDBkey(),
3290 if ( !is_null($ns) ) $where['page_namespace'] = $ns;
3292 $res = $dbr->select(
3293 array( 'redirect', 'page' ),
3294 array( 'page_namespace', 'page_title' ),
3300 foreach( $res as $row ) {
3301 $redirs[] = self
::newFromRow( $row );