diff options
Diffstat (limited to 'includes/parser/ParserOutput.php')
| -rw-r--r-- | includes/parser/ParserOutput.php | 133 |
1 files changed, 108 insertions, 25 deletions
diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php index 1e4765db..403b6625 100644 --- a/includes/parser/ParserOutput.php +++ b/includes/parser/ParserOutput.php @@ -21,14 +21,15 @@ class CacheTime { function containsOldMagic() { return $this->mContainsOldMagic; } function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); } - - /** - * setCacheTime() sets the timestamp expressing when the page has been rendered. + + /** + * setCacheTime() sets the timestamp expressing when the page has been rendered. * This doesn not control expiry, see updateCacheExpiry() for that! + * @param $t string + * @return string */ - function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime, $t ); } + 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. @@ -36,16 +37,20 @@ class CacheTime { * 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(). + * + * @param $seconds number */ function updateCacheExpiry( $seconds ) { $seconds = (int)$seconds; - if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) - $this->mCacheExpiry = $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 ) + if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 ) { $this->mCacheTime = -1; + } } /** @@ -59,28 +64,36 @@ class CacheTime { function getCacheExpiry() { global $wgParserCacheExpireTime; - if ( $this->mCacheTime < 0 ) return 0; // old-style marker for "not cachable" + if ( $this->mCacheTime < 0 ) { + return 0; + } // old-style marker for "not cachable" $expire = $this->mCacheExpiry; - if ( $expire === null ) + if ( $expire === null ) { $expire = $wgParserCacheExpireTime; - else + } 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; + if ( $expire <= 0 ) { + return 0; // not cachable + } else { + return $expire; + } } - + /** + * @return bool + */ 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 @@ -100,8 +113,7 @@ class CacheTime { } } -class ParserOutput extends CacheTime -{ +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 @@ -110,6 +122,7 @@ class ParserOutput extends CacheTime $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 + $mImageTimeKeys = array(), # DB keys of the images used mapped to sha1 and MW timestamp $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? @@ -117,13 +130,19 @@ class ParserOutput extends CacheTime $mNoGallery = false, # No gallery on category page? (__NOGALLERY__) $mHeadItems = array(), # Items to put in the <head> section $mModules = array(), # Modules to be loaded by the resource loader + $mModuleScripts = array(), # Modules of which only the JS will be loaded by the resource loader + $mModuleStyles = array(), # Modules of which only the CSSS will be loaded by the resource loader + $mModuleMessages = array(), # Modules of which only the messages will 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 + $mEditSectionTokens = false, # prefix/suffix markers if edit sections were output as tokens $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) + private $mAccessedOptions = array(); # List of ParserOptions (stored in the keys) + + const EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#'; function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(), $containsOldMagic = false, $titletext = '' ) @@ -135,21 +154,55 @@ class ParserOutput extends CacheTime $this->mTitleText = $titletext; } - function getText() { return $this->mText; } + function getText() { + if ( $this->mEditSectionTokens ) { + return preg_replace_callback( ParserOutput::EDITSECTION_REGEX, + array( &$this, 'replaceEditSectionLinksCallback' ), $this->mText ); + } else { + return preg_replace( ParserOutput::EDITSECTION_REGEX, '', $this->mText ); + } + return $this->mText; + } + + /** + * callback used by getText to replace editsection tokens + * @private + */ + function replaceEditSectionLinksCallback( $m ) { + global $wgOut, $wgLang; + $args = array( + htmlspecialchars_decode($m[1]), + htmlspecialchars_decode($m[2]), + isset($m[4]) ? $m[3] : null, + ); + $args[0] = Title::newFromText( $args[0] ); + if ( !is_object($args[0]) ) { + throw new MWException("Bad parser output text."); + } + $args[] = $wgLang->getCode(); + $skin = $wgOut->getSkin(); + return call_user_func_array( array( $skin, 'doEditSectionLink' ), $args ); + } + function &getLanguageLinks() { return $this->mLanguageLinks; } function getInterwikiLinks() { return $this->mInterwikiLinks; } function getCategoryLinks() { return array_keys( $this->mCategories ); } function &getCategories() { return $this->mCategories; } function getTitleText() { return $this->mTitleText; } function getSections() { return $this->mSections; } + function getEditSectionTokens() { return $this->mEditSectionTokens; } function &getLinks() { return $this->mLinks; } function &getTemplates() { return $this->mTemplates; } + function &getTemplateIds() { return $this->mTemplateIds; } function &getImages() { return $this->mImages; } + function &getImageTimeKeys() { return $this->mImageTimeKeys; } 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 getModuleScripts() { return $this->mModuleScripts; } + function getModuleStyles() { return $this->mModuleStyles; } + function getModuleMessages() { return $this->mModuleMessages; } function getOutputHooks() { return (array)$this->mOutputHooks; } function getWarnings() { return array_keys( $this->mWarnings ); } function getIndexPolicy() { return $this->mIndexPolicy; } @@ -161,6 +214,7 @@ class ParserOutput extends CacheTime function setTitleText( $t ) { return wfSetVar( $this->mTitleText, $t ); } function setSections( $toc ) { return wfSetVar( $this->mSections, $toc ); } + function setEditSectionTokens( $t ) { return wfSetVar( $this->mEditSectionTokens, $t ); } function setIndexPolicy( $policy ) { return wfSetVar( $this->mIndexPolicy, $policy ); } function setTOCHTML( $tochtml ) { return wfSetVar( $this->mTOCHTML, $tochtml ); } @@ -226,10 +280,27 @@ class ParserOutput extends CacheTime $this->mLinks[$ns][$dbk] = $id; } - function addImage( $name ) { + /** + * Register a file dependency for this output + * @param $name string Title dbKey + * @param $timestamp string MW timestamp of file creation (or false if non-existing) + * @param $sha string base 36 SHA-1 of file (or false if non-existing) + * @return void + */ + function addImage( $name, $timestamp = null, $sha1 = null ) { $this->mImages[$name] = 1; + if ( $timestamp !== null && $sha1 !== null ) { + $this->mImageTimeKeys[$name] = array( 'time' => $timestamp, 'sha1' => $sha1 ); + } } + /** + * Register a template dependency for this output + * @param $title Title + * @param $page_id + * @param $rev_id + * @return void + */ function addTemplate( $title, $page_id, $rev_id ) { $ns = $title->getNamespace(); $dbk = $title->getDBkey(); @@ -271,10 +342,22 @@ class ParserOutput extends CacheTime } } - function addModules( $modules ) { + public function addModules( $modules ) { $this->mModules = array_merge( $this->mModules, (array) $modules ); } + public function addModuleScripts( $modules ) { + $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules ); + } + + public function addModuleStyles( $modules ) { + $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules ); + } + + public function addModuleMessages( $modules ) { + $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules ); + } + /** * Override the title to be used for display * -- this is assumed to have been validated @@ -293,7 +376,7 @@ class ParserOutput extends CacheTime * @return String */ public function getDisplayTitle() { - $t = $this->getTitleText( ); + $t = $this->getTitleText(); if( $t === '' ) { return false; } @@ -333,11 +416,11 @@ class ParserOutput extends CacheTime /** * 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 + * @return mixed Array */ public function getUsedOptions() { if ( !isset( $this->mAccessedOptions ) ) { - return false; + return array(); } return array_keys( $this->mAccessedOptions ); } |