includes/parser/CacheTime.php

   1 <?php
   2 /**
   3  * Parser cache specific expiry check.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * Parser cache specific expiry check.
  26  *
  27  * @ingroup Parser
  28  */
  29 class CacheTime {
  30         /** @var array|bool ParserOptions which have been taken into account to
  31          * produce output or false if not available.
  32          */
  33         public $mUsedOptions;
  34
  35         # Compatibility check
  36         public $mVersion = Parser::VERSION;
  37
  38         # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
  39         public $mCacheTime = '';
  40
  41         # Seconds after which the object should expire, use 0 for uncacheable. Used in ParserCache.
  42         public $mCacheExpiry = null;
  43
  44         # Revision ID that was parsed
  45         public $mCacheRevisionId = null;
  46
  47         /**
  48          * @return string TS_MW timestamp
  49          */
  50         public function getCacheTime() {
  51                 return wfTimestamp( TS_MW, $this->mCacheTime );
  52         }
  53
  54         /**
  55          * setCacheTime() sets the timestamp expressing when the page has been rendered.
  56          * This does not control expiry, see updateCacheExpiry() for that!
  57          * @param string $t TS_MW timestamp
  58          * @return string
  59          */
  60         public function setCacheTime( $t ) {
  61                 return wfSetVar( $this->mCacheTime, $t );
  62         }
  63
  64         /**
  65          * @since 1.23
  66          * @return int|null Revision id, if any was set
  67          */
  68         public function getCacheRevisionId() {
  69                 return $this->mCacheRevisionId;
  70         }
  71
  72         /**
  73          * @since 1.23
  74          * @param int $id Revision id
  75          */
  76         public function setCacheRevisionId( $id ) {
  77                 $this->mCacheRevisionId = $id;
  78         }
  79
  80         /**
  81          * Sets the number of seconds after which this object should expire.
  82          * This value is used with the ParserCache.
  83          * If called with a value greater than the value provided at any previous call,
  84          * the new call has no effect. The value returned by getCacheExpiry is smaller
  85          * or equal to the smallest number that was provided as an argument to
  86          * updateCacheExpiry().
  87          *
  88          * @param int $seconds
  89          */
  90         public function updateCacheExpiry( $seconds ) {
  91                 $seconds = (int)$seconds;
  92
  93                 if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) {
  94                         $this->mCacheExpiry = $seconds;
  95                 }
  96         }
  97
  98         /**
  99          * Returns the number of seconds after which this object should expire.
 100          * This method is used by ParserCache to determine how long the ParserOutput can be cached.
 101          * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
 102          * The value returned by getCacheExpiry is smaller or equal to the smallest number
 103          * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
 104          * value of $wgParserCacheExpireTime.
 105          * @return int|mixed|null
 106          */
 107         public function getCacheExpiry() {
 108                 global $wgParserCacheExpireTime;
 109
 110                 if ( $this->mCacheTime < 0 ) {
 111                         return 0;
 112                 } // old-style marker for "not cacheable"
 113
 114                 $expire = $this->mCacheExpiry;
 115
 116                 if ( $expire === null ) {
 117                         $expire = $wgParserCacheExpireTime;
 118                 } else {
 119                         $expire = min( $expire, $wgParserCacheExpireTime );
 120                 }
 121
 122                 if ( $expire <= 0 ) {
 123                         return 0; // not cacheable
 124                 } else {
 125                         return $expire;
 126                 }
 127         }
 128
 129         /**
 130          * @return bool
 131          */
 132         public function isCacheable() {
 133                 return $this->getCacheExpiry() > 0;
 134         }
 135
 136         /**
 137          * Return true if this cached output object predates the global or
 138          * per-article cache invalidation timestamps, or if it comes from
 139          * an incompatible older version.
 140          *
 141          * @param string $touched The affected article's last touched timestamp
 142          * @return bool
 143          */
 144         public function expired( $touched ) {
 145                 global $wgCacheEpoch;
 146
 147                 return !$this->isCacheable() // parser says it's uncacheable
 148                         || $this->getCacheTime() < $touched
 149                         || $this->getCacheTime() <= $wgCacheEpoch
 150                         || $this->getCacheTime() <
 151                                 wfTimestamp( TS_MW, time() - $this->getCacheExpiry() ) // expiry period has passed
 152                         || !isset( $this->mVersion )
 153                         || version_compare( $this->mVersion, Parser::VERSION, "lt" );
 154         }
 155
 156         /**
 157          * Return true if this cached output object is for a different revision of
 158          * the page.
 159          *
 160          * @todo We always return false if $this->getCacheRevisionId() is null;
 161          * this prevents invalidating the whole parser cache when this change is
 162          * deployed. Someday that should probably be changed.
 163          *
 164          * @since 1.23
 165          * @param int $id The affected article's current revision id
 166          * @return bool
 167          */
 168         public function isDifferentRevision( $id ) {
 169                 $cached = $this->getCacheRevisionId();
 170                 return $cached !== null && $id !== $cached;
 171         }
 172 }