3 * Output of the PHP parser
15 var $mVersion = Parser
::VERSION
, # Compatibility check
16 $mCacheTime = '', # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
17 $mCacheExpiry = null, # Seconds after which the object should expire, use 0 for uncachable. Used in ParserCache.
18 $mContainsOldMagic; # Boolean variable indicating if the input contained variables like {{CURRENTDAY}}
20 function getCacheTime() { return $this->mCacheTime
; }
22 function containsOldMagic() { return $this->mContainsOldMagic
; }
23 function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic
, $com ); }
26 * setCacheTime() sets the timestamp expressing when the page has been rendered.
27 * This doesn not control expiry, see updateCacheExpiry() for that!
29 function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime
, $t ); }
33 * Sets the number of seconds after which this object should expire.
34 * This value is used with the ParserCache.
35 * If called with a value greater than the value provided at any previous call,
36 * the new call has no effect. The value returned by getCacheExpiry is smaller
37 * or equal to the smallest number that was provided as an argument to
38 * updateCacheExpiry().
40 function updateCacheExpiry( $seconds ) {
41 $seconds = (int)$seconds;
43 if ( $this->mCacheExpiry
=== null ||
$this->mCacheExpiry
> $seconds )
44 $this->mCacheExpiry
= $seconds;
46 // hack: set old-style marker for uncacheable entries.
47 if ( $this->mCacheExpiry
!== null && $this->mCacheExpiry
<= 0 )
48 $this->mCacheTime
= -1;
52 * Returns the number of seconds after which this object should expire.
53 * This method is used by ParserCache to determine how long the ParserOutput can be cached.
54 * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
55 * The value returned by getCacheExpiry is smaller or equal to the smallest number
56 * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
57 * value of $wgParserCacheExpireTime.
59 function getCacheExpiry() {
60 global $wgParserCacheExpireTime;
62 if ( $this->mCacheTime
< 0 ) return 0; // old-style marker for "not cachable"
64 $expire = $this->mCacheExpiry
;
66 if ( $expire === null )
67 $expire = $wgParserCacheExpireTime;
69 $expire = min( $expire, $wgParserCacheExpireTime );
71 if( $this->containsOldMagic() ) { //compatibility hack
72 $expire = min( $expire, 3600 ); # 1 hour
75 if ( $expire <= 0 ) return 0; // not cachable
80 function isCacheable() {
81 return $this->getCacheExpiry() > 0;
85 * Return true if this cached output object predates the global or
86 * per-article cache invalidation timestamps, or if it comes from
87 * an incompatible older version.
89 * @param $touched String: the affected article's last touched timestamp
92 public function expired( $touched ) {
94 return !$this->isCacheable() ||
// parser says it's uncacheable
95 $this->getCacheTime() < $touched ||
96 $this->getCacheTime() <= $wgCacheEpoch ||
97 $this->getCacheTime() < wfTimestamp( TS_MW
, time() - $this->getCacheExpiry() ) ||
// expiry period has passed
98 !isset( $this->mVersion
) ||
99 version_compare( $this->mVersion
, Parser
::VERSION
, "lt" );
103 class ParserOutput
extends CacheTime
{
104 var $mText, # The output text
105 $mLanguageLinks, # List of the full text of language links, in the order they appear
106 $mCategories, # Map of category names to sort keys
107 $mTitleText, # title text of the chosen language variant
108 $mLinks = array(), # 2-D map of NS/DBK to ID for the links in the document. ID=zero for broken.
109 $mTemplates = array(), # 2-D map of NS/DBK to ID for the template references. ID=zero for broken.
110 $mTemplateIds = array(), # 2-D map of NS/DBK to rev ID for the template references. ID=zero for broken.
111 $mImages = array(), # DB keys of the images used, in the array key only
112 $mExternalLinks = array(), # External link URLs, in the key only
113 $mInterwikiLinks = array(), # 2-D map of prefix/DBK (in keys only) for the inline interwiki links in the document.
114 $mNewSection = false, # Show a new section link?
115 $mHideNewSection = false, # Hide the new section link?
116 $mNoGallery = false, # No gallery on category page? (__NOGALLERY__)
117 $mHeadItems = array(), # Items to put in the <head> section
118 $mModules = array(), # Modules to be loaded by the resource loader
119 $mOutputHooks = array(), # Hook tags as per $wgParserOutputHooks
120 $mWarnings = array(), # Warning text to be returned to the user. Wikitext formatted, in the key only
121 $mSections = array(), # Table of contents
122 $mEditSectionTokens = false, # prefix/suffix markers if edit sections were output as tokens
123 $mProperties = array(), # Name/value pairs to be cached in the DB
124 $mTOCHTML = ''; # HTML of the TOC
125 private $mIndexPolicy = ''; # 'index' or 'noindex'? Any other value will result in no change.
126 private $mAccessedOptions = null; # List of ParserOptions (stored in the keys)
128 function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(),
129 $containsOldMagic = false, $titletext = '' )
131 $this->mText
= $text;
132 $this->mLanguageLinks
= $languageLinks;
133 $this->mCategories
= $categoryLinks;
134 $this->mContainsOldMagic
= $containsOldMagic;
135 $this->mTitleText
= $titletext;
139 if ( $this->mEditSectionTokens
) {
140 return preg_replace_callback( '#<editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</editsection>))#', array( &$this, 'replaceEditSectionLinksCallback' ), $this->mText
);
146 * callback used by getText to replace editsection tokens
149 function replaceEditSectionLinksCallback( $m ) {
150 global $wgUser, $wgLang;
152 htmlspecialchars_decode($m[1]),
153 htmlspecialchars_decode($m[2]),
154 isset($m[4]) ?
$m[3] : null,
156 $args[0] = Title
::newFromText( $args[0] );
157 if ( !is_object($args[0]) ) {
158 throw new MWException("Bad parser output text.");
160 $args[] = $wgLang->getCode();
161 $skin = $wgUser->getSkin();
162 return call_user_func_array( array( $skin, 'doEditSectionLink' ), $args );
165 function &getLanguageLinks() { return $this->mLanguageLinks
; }
166 function getInterwikiLinks() { return $this->mInterwikiLinks
; }
167 function getCategoryLinks() { return array_keys( $this->mCategories
); }
168 function &getCategories() { return $this->mCategories
; }
169 function getTitleText() { return $this->mTitleText
; }
170 function getSections() { return $this->mSections
; }
171 function getEditSectionTokens() { return $this->mEditSectionTokens
; }
172 function &getLinks() { return $this->mLinks
; }
173 function &getTemplates() { return $this->mTemplates
; }
174 function &getImages() { return $this->mImages
; }
175 function &getExternalLinks() { return $this->mExternalLinks
; }
176 function getNoGallery() { return $this->mNoGallery
; }
177 function getHeadItems() { return $this->mHeadItems
; }
178 function getModules() { return $this->mModules
; }
179 function getOutputHooks() { return (array)$this->mOutputHooks
; }
180 function getWarnings() { return array_keys( $this->mWarnings
); }
181 function getIndexPolicy() { return $this->mIndexPolicy
; }
182 function getTOCHTML() { return $this->mTOCHTML
; }
184 function setText( $text ) { return wfSetVar( $this->mText
, $text ); }
185 function setLanguageLinks( $ll ) { return wfSetVar( $this->mLanguageLinks
, $ll ); }
186 function setCategoryLinks( $cl ) { return wfSetVar( $this->mCategories
, $cl ); }
188 function setTitleText( $t ) { return wfSetVar( $this->mTitleText
, $t ); }
189 function setSections( $toc ) { return wfSetVar( $this->mSections
, $toc ); }
190 function setEditSectionTokens( $t ) { return wfSetVar( $this->mEditSectionTokens
, $t ); }
191 function setIndexPolicy( $policy ) { return wfSetVar( $this->mIndexPolicy
, $policy ); }
192 function setTOCHTML( $tochtml ) { return wfSetVar( $this->mTOCHTML
, $tochtml ); }
194 function addCategory( $c, $sort ) { $this->mCategories
[$c] = $sort; }
195 function addLanguageLink( $t ) { $this->mLanguageLinks
[] = $t; }
196 function addWarning( $s ) { $this->mWarnings
[$s] = 1; }
198 function addOutputHook( $hook, $data = false ) {
199 $this->mOutputHooks
[] = array( $hook, $data );
202 function setNewSection( $value ) {
203 $this->mNewSection
= (bool)$value;
205 function hideNewSection ( $value ) {
206 $this->mHideNewSection
= (bool)$value;
208 function getHideNewSection () {
209 return (bool)$this->mHideNewSection
;
211 function getNewSection() {
212 return (bool)$this->mNewSection
;
215 function addExternalLink( $url ) {
216 # We don't register links pointing to our own server, unless... :-)
217 global $wgServer, $wgRegisterInternalExternals;
218 if( $wgRegisterInternalExternals or stripos($url,$wgServer.'/')!==0)
219 $this->mExternalLinks
[$url] = 1;
223 * Record a local or interwiki inline link for saving in future link tables.
225 * @param $title Title object
226 * @param $id Mixed: optional known page_id so we can skip the lookup
228 function addLink( $title, $id = null ) {
229 if ( $title->isExternal() ) {
230 // Don't record interwikis in pagelinks
231 $this->addInterwikiLink( $title );
234 $ns = $title->getNamespace();
235 $dbk = $title->getDBkey();
236 if ( $ns == NS_MEDIA
) {
237 // Normalize this pseudo-alias if it makes it down here...
239 } elseif( $ns == NS_SPECIAL
) {
240 // We don't record Special: links currently
241 // It might actually be wise to, but we'd need to do some normalization.
243 } elseif( $dbk === '' ) {
244 // Don't record self links - [[#Foo]]
247 if ( !isset( $this->mLinks
[$ns] ) ) {
248 $this->mLinks
[$ns] = array();
250 if ( is_null( $id ) ) {
251 $id = $title->getArticleID();
253 $this->mLinks
[$ns][$dbk] = $id;
256 function addImage( $name ) {
257 $this->mImages
[$name] = 1;
260 function addTemplate( $title, $page_id, $rev_id ) {
261 $ns = $title->getNamespace();
262 $dbk = $title->getDBkey();
263 if ( !isset( $this->mTemplates
[$ns] ) ) {
264 $this->mTemplates
[$ns] = array();
266 $this->mTemplates
[$ns][$dbk] = $page_id;
267 if ( !isset( $this->mTemplateIds
[$ns] ) ) {
268 $this->mTemplateIds
[$ns] = array();
270 $this->mTemplateIds
[$ns][$dbk] = $rev_id; // For versioning
274 * @param $title Title object, must be an interwiki link
275 * @throws MWException if given invalid input
277 function addInterwikiLink( $title ) {
278 $prefix = $title->getInterwiki();
279 if( $prefix == '' ) {
280 throw new MWException( 'Non-interwiki link passed, internal parser error.' );
282 if (!isset($this->mInterwikiLinks
[$prefix])) {
283 $this->mInterwikiLinks
[$prefix] = array();
285 $this->mInterwikiLinks
[$prefix][$title->getDBkey()] = 1;
289 * Add some text to the <head>.
290 * If $tag is set, the section with that tag will only be included once
293 function addHeadItem( $section, $tag = false ) {
294 if ( $tag !== false ) {
295 $this->mHeadItems
[$tag] = $section;
297 $this->mHeadItems
[] = $section;
301 function addModules( $modules ) {
302 $this->mModules
= array_merge( $this->mModules
, (array) $modules );
306 * Override the title to be used for display
307 * -- this is assumed to have been validated
308 * (check equal normalisation, etc.)
310 * @param $text String: desired title text
312 public function setDisplayTitle( $text ) {
313 $this->setTitleText( $text );
314 $this->setProperty( 'displaytitle', $text );
318 * Get the title to be used for display
322 public function getDisplayTitle() {
323 $t = $this->getTitleText();
331 * Fairly generic flag setter thingy.
333 public function setFlag( $flag ) {
334 $this->mFlags
[$flag] = true;
337 public function getFlag( $flag ) {
338 return isset( $this->mFlags
[$flag] );
342 * Set a property to be cached in the DB
344 public function setProperty( $name, $value ) {
345 $this->mProperties
[$name] = $value;
348 public function getProperty( $name ){
349 return isset( $this->mProperties
[$name] ) ?
$this->mProperties
[$name] : false;
352 public function getProperties() {
353 if ( !isset( $this->mProperties
) ) {
354 $this->mProperties
= array();
356 return $this->mProperties
;
361 * Returns the options from its ParserOptions which have been taken
362 * into account to produce this output or false if not available.
363 * @return mixed Array/false
365 public function getUsedOptions() {
366 if ( !isset( $this->mAccessedOptions
) ) {
369 return array_keys( $this->mAccessedOptions
);
373 * Callback passed by the Parser to the ParserOptions to keep track of which options are used.
376 function recordOption( $option ) {
377 $this->mAccessedOptions
[$option] = true;