From 9db190c7e736ec8d063187d4241b59feaf7dc2d1 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 22 Jun 2011 11:28:20 +0200 Subject: update to MediaWiki 1.17.0 --- includes/parser/ParserOutput.php | 178 +++++++++++++++++++++++++++++++++------ 1 file changed, 152 insertions(+), 26 deletions(-) (limited to 'includes/parser/ParserOutput.php') diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index ea5840e6..1e4765db 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -1,34 +1,131 @@ mCacheTime; } + + function containsOldMagic() { return $this->mContainsOldMagic; } + function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); } + + /** + * setCacheTime() sets the timestamp expressing when the page has been rendered. + * This doesn not control expiry, see updateCacheExpiry() for that! + */ + function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime, $t ); } + + + /** + * Sets the number of seconds after which this object should expire. + * This value is used with the ParserCache. + * If called with a value greater than the value provided at any previous call, + * the new call has no effect. The value returned by getCacheExpiry is smaller + * or equal to the smallest number that was provided as an argument to + * updateCacheExpiry(). + */ + function updateCacheExpiry( $seconds ) { + $seconds = (int)$seconds; + + if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) + $this->mCacheExpiry = $seconds; + + // hack: set old-style marker for uncacheable entries. + if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 ) + $this->mCacheTime = -1; + } + + /** + * Returns the number of seconds after which this object should expire. + * This method is used by ParserCache to determine how long the ParserOutput can be cached. + * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime(). + * The value returned by getCacheExpiry is smaller or equal to the smallest number + * that was provided to a call of updateCacheExpiry(), and smaller or equal to the + * value of $wgParserCacheExpireTime. + */ + function getCacheExpiry() { + global $wgParserCacheExpireTime; + + if ( $this->mCacheTime < 0 ) return 0; // old-style marker for "not cachable" + + $expire = $this->mCacheExpiry; + + if ( $expire === null ) + $expire = $wgParserCacheExpireTime; + else + $expire = min( $expire, $wgParserCacheExpireTime ); + + if( $this->containsOldMagic() ) { //compatibility hack + $expire = min( $expire, 3600 ); # 1 hour + } + + if ( $expire <= 0 ) return 0; // not cachable + else return $expire; + } + + + function isCacheable() { + return $this->getCacheExpiry() > 0; + } + + /** + * Return true if this cached output object predates the global or + * per-article cache invalidation timestamps, or if it comes from + * an incompatible older version. + * + * @param $touched String: the affected article's last touched timestamp + * @return Boolean + */ + public function expired( $touched ) { + global $wgCacheEpoch; + return !$this->isCacheable() || // parser says it's uncacheable + $this->getCacheTime() < $touched || + $this->getCacheTime() <= $wgCacheEpoch || + $this->getCacheTime() < wfTimestamp( TS_MW, time() - $this->getCacheExpiry() ) || // expiry period has passed + !isset( $this->mVersion ) || + version_compare( $this->mVersion, Parser::VERSION, "lt" ); + } +} + +class ParserOutput extends CacheTime { var $mText, # The output text $mLanguageLinks, # List of the full text of language links, in the order they appear $mCategories, # Map of category names to sort keys - $mContainsOldMagic, # Boolean variable indicating if the input contained variables like {{CURRENTDAY}} $mTitleText, # title text of the chosen language variant - $mCacheTime = '', # Time when this object was generated, or -1 for uncacheable. Used in ParserCache. - $mVersion = Parser::VERSION, # Compatibility check $mLinks = array(), # 2-D map of NS/DBK to ID for the links in the document. ID=zero for broken. $mTemplates = array(), # 2-D map of NS/DBK to ID for the template references. ID=zero for broken. $mTemplateIds = array(), # 2-D map of NS/DBK to rev ID for the template references. ID=zero for broken. $mImages = array(), # DB keys of the images used, in the array key only $mExternalLinks = array(), # External link URLs, in the key only + $mInterwikiLinks = array(), # 2-D map of prefix/DBK (in keys only) for the inline interwiki links in the document. $mNewSection = false, # Show a new section link? $mHideNewSection = false, # Hide the new section link? $mNoGallery = false, # No gallery on category page? (__NOGALLERY__) $mHeadItems = array(), # Items to put in the section + $mModules = array(), # Modules to be loaded by the resource loader $mOutputHooks = array(), # Hook tags as per $wgParserOutputHooks $mWarnings = array(), # Warning text to be returned to the user. Wikitext formatted, in the key only $mSections = array(), # Table of contents $mProperties = array(), # Name/value pairs to be cached in the DB $mTOCHTML = ''; # HTML of the TOC private $mIndexPolicy = ''; # 'index' or 'noindex'? Any other value will result in no change. + private $mAccessedOptions = null; # List of ParserOptions (stored in the keys) - function ParserOutput( $text = '', $languageLinks = array(), $categoryLinks = array(), + function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(), $containsOldMagic = false, $titletext = '' ) { $this->mText = $text; @@ -40,9 +137,9 @@ class ParserOutput function getText() { return $this->mText; } function &getLanguageLinks() { return $this->mLanguageLinks; } + function getInterwikiLinks() { return $this->mInterwikiLinks; } function getCategoryLinks() { return array_keys( $this->mCategories ); } function &getCategories() { return $this->mCategories; } - function getCacheTime() { return $this->mCacheTime; } function getTitleText() { return $this->mTitleText; } function getSections() { return $this->mSections; } function &getLinks() { return $this->mLinks; } @@ -51,18 +148,17 @@ class ParserOutput function &getExternalLinks() { return $this->mExternalLinks; } function getNoGallery() { return $this->mNoGallery; } function getHeadItems() { return $this->mHeadItems; } + function getModules() { return $this->mModules; } function getSubtitle() { return $this->mSubtitle; } function getOutputHooks() { return (array)$this->mOutputHooks; } function getWarnings() { return array_keys( $this->mWarnings ); } function getIndexPolicy() { return $this->mIndexPolicy; } function getTOCHTML() { return $this->mTOCHTML; } - function containsOldMagic() { return $this->mContainsOldMagic; } function setText( $text ) { return wfSetVar( $this->mText, $text ); } function setLanguageLinks( $ll ) { return wfSetVar( $this->mLanguageLinks, $ll ); } function setCategoryLinks( $cl ) { return wfSetVar( $this->mCategories, $cl ); } - function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); } - function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime, $t ); } + function setTitleText( $t ) { return wfSetVar( $this->mTitleText, $t ); } function setSections( $toc ) { return wfSetVar( $this->mSections, $toc ); } function setIndexPolicy( $policy ) { return wfSetVar( $this->mIndexPolicy, $policy ); } @@ -96,9 +192,16 @@ class ParserOutput $this->mExternalLinks[$url] = 1; } + /** + * Record a local or interwiki inline link for saving in future link tables. + * + * @param $title Title object + * @param $id Mixed: optional known page_id so we can skip the lookup + */ function addLink( $title, $id = null ) { if ( $title->isExternal() ) { // Don't record interwikis in pagelinks + $this->addInterwikiLink( $title ); return; } $ns = $title->getNamespace(); @@ -139,23 +242,20 @@ class ParserOutput } $this->mTemplateIds[$ns][$dbk] = $rev_id; // For versioning } - + /** - * Return true if this cached output object predates the global or - * per-article cache invalidation timestamps, or if it comes from - * an incompatible older version. - * - * @param string $touched the affected article's last touched timestamp - * @return bool - * @public + * @param $title Title object, must be an interwiki link + * @throws MWException if given invalid input */ - function expired( $touched ) { - global $wgCacheEpoch; - return $this->getCacheTime() == -1 || // parser says it's uncacheable - $this->getCacheTime() < $touched || - $this->getCacheTime() <= $wgCacheEpoch || - !isset( $this->mVersion ) || - version_compare( $this->mVersion, Parser::VERSION, "lt" ); + function addInterwikiLink( $title ) { + $prefix = $title->getInterwiki(); + if( $prefix == '' ) { + throw new MWException( 'Non-interwiki link passed, internal parser error.' ); + } + if (!isset($this->mInterwikiLinks[$prefix])) { + $this->mInterwikiLinks[$prefix] = array(); + } + $this->mInterwikiLinks[$prefix][$title->getDBkey()] = 1; } /** @@ -170,22 +270,27 @@ class ParserOutput $this->mHeadItems[] = $section; } } + + function addModules( $modules ) { + $this->mModules = array_merge( $this->mModules, (array) $modules ); + } /** * Override the title to be used for display * -- this is assumed to have been validated * (check equal normalisation, etc.) * - * @param string $text Desired title text + * @param $text String: desired title text */ public function setDisplayTitle( $text ) { $this->setTitleText( $text ); + $this->setProperty( 'displaytitle', $text ); } /** * Get the title to be used for display * - * @return string + * @return String */ public function getDisplayTitle() { $t = $this->getTitleText( ); @@ -223,4 +328,25 @@ class ParserOutput } return $this->mProperties; } + + + /** + * Returns the options from its ParserOptions which have been taken + * into account to produce this output or false if not available. + * @return mixed Array/false + */ + public function getUsedOptions() { + if ( !isset( $this->mAccessedOptions ) ) { + return false; + } + return array_keys( $this->mAccessedOptions ); + } + + /** + * Callback passed by the Parser to the ParserOptions to keep track of which options are used. + * @access private + */ + function recordOption( $option ) { + $this->mAccessedOptions[$option] = true; + } } -- cgit v1.2.2