includes/parser/ParserOutput.php

   1 <?php
   2 /**
   3  * Output of the PHP parser
   4  *
   5  * @file
   6  * @ingroup Parser
   7  */
   8
   9 /**
  10  * @todo document
  11  * @ingroup Parser
  12  */
  13
  14 class CacheTime {
  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}}
  19
  20         function getCacheTime()              { return $this->mCacheTime; }
  21
  22         function containsOldMagic()          { return $this->mContainsOldMagic; }
  23         function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); }
  24
  25         /**
  26          * setCacheTime() sets the timestamp expressing when the page has been rendered.
  27          * This doesn not control expiry, see updateCacheExpiry() for that!
  28          */
  29         function setCacheTime( $t )          { return wfSetVar( $this->mCacheTime, $t ); }
  30
  31
  32         /**
  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().
  39          */
  40         function updateCacheExpiry( $seconds ) {
  41                 $seconds = (int)$seconds;
  42
  43                 if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds )
  44                         $this->mCacheExpiry = $seconds;
  45
  46                 // hack: set old-style marker for uncacheable entries.
  47                 if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 )
  48                         $this->mCacheTime = -1;
  49         }
  50
  51         /**
  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.
  58          */
  59         function getCacheExpiry() {
  60                 global $wgParserCacheExpireTime;
  61
  62                 if ( $this->mCacheTime < 0 ) return 0; // old-style marker for "not cachable"
  63
  64                 $expire = $this->mCacheExpiry;
  65
  66                 if ( $expire === null )
  67                         $expire = $wgParserCacheExpireTime;
  68                 else
  69                         $expire = min( $expire, $wgParserCacheExpireTime );
  70
  71                 if( $this->containsOldMagic() ) { //compatibility hack
  72                         $expire = min( $expire, 3600 ); # 1 hour
  73                 }
  74
  75                 if ( $expire <= 0 ) return 0; // not cachable
  76                 else return $expire;
  77         }
  78
  79
  80         function isCacheable() {
  81                 return $this->getCacheExpiry() > 0;
  82         }
  83
  84         /**
  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.
  88          *
  89          * @param $touched String: the affected article's last touched timestamp
  90          * @return Boolean
  91          */
  92         public function expired( $touched ) {
  93                 global $wgCacheEpoch;
  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" );
 100         }
 101 }
 102
 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)
 127
 128         const EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#';
 129
 130         function __construct( $text = '', $languageLinks = array(), $categoryLinks = array(),
 131                 $containsOldMagic = false, $titletext = '' )
 132         {
 133                 $this->mText = $text;
 134                 $this->mLanguageLinks = $languageLinks;
 135                 $this->mCategories = $categoryLinks;
 136                 $this->mContainsOldMagic = $containsOldMagic;
 137                 $this->mTitleText = $titletext;
 138         }
 139
 140         function getText() {
 141                 if ( $this->mEditSectionTokens ) {
 142                         return preg_replace_callback( ParserOutput::EDITSECTION_REGEX,
 143                                 array( &$this, 'replaceEditSectionLinksCallback' ), $this->mText );
 144                 }
 145                 return $this->mText;
 146         }
 147
 148         /**
 149          * callback used by getText to replace editsection tokens
 150          * @private
 151          */
 152         function replaceEditSectionLinksCallback( $m ) {
 153                 global $wgUser, $wgLang;
 154                 $args = array(
 155                         htmlspecialchars_decode($m[1]),
 156                         htmlspecialchars_decode($m[2]),
 157                         isset($m[4]) ? $m[3] : null,
 158                 );
 159                 $args[0] = Title::newFromText( $args[0] );
 160                 if ( !is_object($args[0]) ) {
 161                         throw new MWException("Bad parser output text.");
 162                 }
 163                 $args[] = $wgLang->getCode();
 164                 $skin = $wgUser->getSkin();
 165                 return call_user_func_array( array( $skin, 'doEditSectionLink' ), $args );
 166         }
 167
 168         function &getLanguageLinks()         { return $this->mLanguageLinks; }
 169         function getInterwikiLinks()         { return $this->mInterwikiLinks; }
 170         function getCategoryLinks()          { return array_keys( $this->mCategories ); }
 171         function &getCategories()            { return $this->mCategories; }
 172         function getTitleText()              { return $this->mTitleText; }
 173         function getSections()               { return $this->mSections; }
 174         function getEditSectionTokens()      { return $this->mEditSectionTokens; }
 175         function &getLinks()                 { return $this->mLinks; }
 176         function &getTemplates()             { return $this->mTemplates; }
 177         function &getImages()                { return $this->mImages; }
 178         function &getExternalLinks()         { return $this->mExternalLinks; }
 179         function getNoGallery()              { return $this->mNoGallery; }
 180         function getHeadItems()              { return $this->mHeadItems; }
 181         function getModules()                { return $this->mModules; }
 182         function getOutputHooks()            { return (array)$this->mOutputHooks; }
 183         function getWarnings()               { return array_keys( $this->mWarnings ); }
 184         function getIndexPolicy()            { return $this->mIndexPolicy; }
 185         function getTOCHTML()                { return $this->mTOCHTML; }
 186
 187         function setText( $text )            { return wfSetVar( $this->mText, $text ); }
 188         function setLanguageLinks( $ll )     { return wfSetVar( $this->mLanguageLinks, $ll ); }
 189         function setCategoryLinks( $cl )     { return wfSetVar( $this->mCategories, $cl ); }
 190
 191         function setTitleText( $t )          { return wfSetVar( $this->mTitleText, $t ); }
 192         function setSections( $toc )         { return wfSetVar( $this->mSections, $toc ); }
 193         function setEditSectionTokens( $t )  { return wfSetVar( $this->mEditSectionTokens, $t ); }
 194         function setIndexPolicy( $policy )   { return wfSetVar( $this->mIndexPolicy, $policy ); }
 195         function setTOCHTML( $tochtml )      { return wfSetVar( $this->mTOCHTML, $tochtml ); }
 196
 197         function addCategory( $c, $sort )    { $this->mCategories[$c] = $sort; }
 198         function addLanguageLink( $t )       { $this->mLanguageLinks[] = $t; }
 199         function addWarning( $s )            { $this->mWarnings[$s] = 1; }
 200
 201         function addOutputHook( $hook, $data = false ) {
 202                 $this->mOutputHooks[] = array( $hook, $data );
 203         }
 204
 205         function setNewSection( $value ) {
 206                 $this->mNewSection = (bool)$value;
 207         }
 208         function hideNewSection ( $value ) {
 209                 $this->mHideNewSection = (bool)$value;
 210         }
 211         function getHideNewSection () {
 212                 return (bool)$this->mHideNewSection;
 213         }
 214         function getNewSection() {
 215                 return (bool)$this->mNewSection;
 216         }
 217
 218         function addExternalLink( $url ) {
 219                 # We don't register links pointing to our own server, unless... :-)
 220                 global $wgServer, $wgRegisterInternalExternals;
 221                 if( $wgRegisterInternalExternals or stripos($url,$wgServer.'/')!==0)
 222                         $this->mExternalLinks[$url] = 1;
 223         }
 224
 225         /**
 226          * Record a local or interwiki inline link for saving in future link tables.
 227          *
 228          * @param $title Title object
 229          * @param $id Mixed: optional known page_id so we can skip the lookup
 230          */
 231         function addLink( $title, $id = null ) {
 232                 if ( $title->isExternal() ) {
 233                         // Don't record interwikis in pagelinks
 234                         $this->addInterwikiLink( $title );
 235                         return;
 236                 }
 237                 $ns = $title->getNamespace();
 238                 $dbk = $title->getDBkey();
 239                 if ( $ns == NS_MEDIA ) {
 240                         // Normalize this pseudo-alias if it makes it down here...
 241                         $ns = NS_FILE;
 242                 } elseif( $ns == NS_SPECIAL ) {
 243                         // We don't record Special: links currently
 244                         // It might actually be wise to, but we'd need to do some normalization.
 245                         return;
 246                 } elseif( $dbk === '' ) {
 247                         // Don't record self links -  [[#Foo]]
 248                         return;
 249                 }
 250                 if ( !isset( $this->mLinks[$ns] ) ) {
 251                         $this->mLinks[$ns] = array();
 252                 }
 253                 if ( is_null( $id ) ) {
 254                         $id = $title->getArticleID();
 255                 }
 256                 $this->mLinks[$ns][$dbk] = $id;
 257         }
 258
 259         function addImage( $name ) {
 260                 $this->mImages[$name] = 1;
 261         }
 262
 263         function addTemplate( $title, $page_id, $rev_id ) {
 264                 $ns = $title->getNamespace();
 265                 $dbk = $title->getDBkey();
 266                 if ( !isset( $this->mTemplates[$ns] ) ) {
 267                         $this->mTemplates[$ns] = array();
 268                 }
 269                 $this->mTemplates[$ns][$dbk] = $page_id;
 270                 if ( !isset( $this->mTemplateIds[$ns] ) ) {
 271                         $this->mTemplateIds[$ns] = array();
 272                 }
 273                 $this->mTemplateIds[$ns][$dbk] = $rev_id; // For versioning
 274         }
 275
 276         /**
 277          * @param $title Title object, must be an interwiki link
 278          * @throws MWException if given invalid input
 279          */
 280         function addInterwikiLink( $title ) {
 281                 $prefix = $title->getInterwiki();
 282                 if( $prefix == '' ) {
 283                         throw new MWException( 'Non-interwiki link passed, internal parser error.' );
 284                 }
 285                 if (!isset($this->mInterwikiLinks[$prefix])) {
 286                         $this->mInterwikiLinks[$prefix] = array();
 287                 }
 288                 $this->mInterwikiLinks[$prefix][$title->getDBkey()] = 1;
 289         }
 290
 291         /**
 292          * Add some text to the <head>.
 293          * If $tag is set, the section with that tag will only be included once
 294          * in a given page.
 295          */
 296         function addHeadItem( $section, $tag = false ) {
 297                 if ( $tag !== false ) {
 298                         $this->mHeadItems[$tag] = $section;
 299                 } else {
 300                         $this->mHeadItems[] = $section;
 301                 }
 302         }
 303
 304         function addModules( $modules ) {
 305                 $this->mModules = array_merge( $this->mModules, (array) $modules );
 306         }
 307
 308         /**
 309          * Override the title to be used for display
 310          * -- this is assumed to have been validated
 311          * (check equal normalisation, etc.)
 312          *
 313          * @param $text String: desired title text
 314          */
 315         public function setDisplayTitle( $text ) {
 316                 $this->setTitleText( $text );
 317                 $this->setProperty( 'displaytitle', $text );
 318         }
 319
 320         /**
 321          * Get the title to be used for display
 322          *
 323          * @return String
 324          */
 325         public function getDisplayTitle() {
 326                 $t = $this->getTitleText();
 327                 if( $t === '' ) {
 328                         return false;
 329                 }
 330                 return $t;
 331         }
 332
 333         /**
 334          * Fairly generic flag setter thingy.
 335          */
 336         public function setFlag( $flag ) {
 337                 $this->mFlags[$flag] = true;
 338         }
 339
 340         public function getFlag( $flag ) {
 341                 return isset( $this->mFlags[$flag] );
 342         }
 343
 344         /**
 345          * Set a property to be cached in the DB
 346          */
 347         public function setProperty( $name, $value ) {
 348                 $this->mProperties[$name] = $value;
 349         }
 350
 351         public function getProperty( $name ){
 352                 return isset( $this->mProperties[$name] ) ? $this->mProperties[$name] : false;
 353         }
 354
 355         public function getProperties() {
 356                 if ( !isset( $this->mProperties ) ) {
 357                         $this->mProperties = array();
 358                 }
 359                 return $this->mProperties;
 360         }
 361
 362
 363         /**
 364          * Returns the options from its ParserOptions which have been taken
 365          * into account to produce this output or false if not available.
 366          * @return mixed Array/false
 367          */
 368          public function getUsedOptions() {
 369                 if ( !isset( $this->mAccessedOptions ) ) {
 370                         return false;
 371                 }
 372                 return array_keys( $this->mAccessedOptions );
 373          }
 374
 375          /**
 376           * Callback passed by the Parser to the ParserOptions to keep track of which options are used.
 377           * @access private
 378           */
 379          function recordOption( $option ) {
 380                  $this->mAccessedOptions[$option] = true;
 381          }
 382 }