3 * Parser cache specific expiry check.
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.
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.
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
25 * Parser cache specific expiry check.
31 * @var string[] ParserOptions which have been taken into account to produce output.
36 * @var string|null Compatibility check
38 public $mVersion = Parser
::VERSION
;
41 * @var string|int TS_MW timestamp when this object was generated, or -1 for not cacheable. Used
44 public $mCacheTime = '';
47 * @var int|null Seconds after which the object should expire, use 0 for not cacheable. Used in
50 public $mCacheExpiry = null;
53 * @var int|null Revision ID that was parsed
55 public $mCacheRevisionId = null;
58 * @return string TS_MW timestamp
60 public function getCacheTime() {
61 // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
62 if ( $this->mCacheTime
=== '' ) {
63 $this->mCacheTime
= MWTimestamp
::now();
65 return $this->mCacheTime
;
69 * setCacheTime() sets the timestamp expressing when the page has been rendered.
70 * This does not control expiry, see updateCacheExpiry() for that!
71 * @param string $t TS_MW timestamp
74 public function setCacheTime( $t ) {
75 // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
76 if ( is_string( $t ) && $t !== '-1' ) {
77 $t = MWTimestamp
::convert( TS_MW
, $t );
80 return wfSetVar( $this->mCacheTime
, $t );
85 * @return int|null Revision id, if any was set
87 public function getCacheRevisionId() {
88 return $this->mCacheRevisionId
;
93 * @param int|null $id Revision ID
95 public function setCacheRevisionId( $id ) {
96 $this->mCacheRevisionId
= $id;
100 * Sets the number of seconds after which this object should expire.
102 * This value is used with the ParserCache.
103 * If called with a value greater than the value provided at any previous call,
104 * the new call has no effect. The value returned by getCacheExpiry is smaller
105 * or equal to the smallest number that was provided as an argument to
106 * updateCacheExpiry().
108 * Avoid using 0 if at all possible. Consider JavaScript for highly dynamic content.
110 * @param int $seconds
112 public function updateCacheExpiry( $seconds ) {
113 $seconds = (int)$seconds;
115 if ( $this->mCacheExpiry
=== null ||
$this->mCacheExpiry
> $seconds ) {
116 $this->mCacheExpiry
= $seconds;
121 * Returns the number of seconds after which this object should expire.
122 * This method is used by ParserCache to determine how long the ParserOutput can be cached.
123 * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
124 * The value returned by getCacheExpiry is smaller or equal to the smallest number
125 * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
126 * value of $wgParserCacheExpireTime.
129 public function getCacheExpiry() {
130 global $wgParserCacheExpireTime;
132 // NOTE: keep support for undocumented used of -1 to mean "not cacheable".
133 if ( $this->mCacheTime
< 0 ) {
137 $expire = $this->mCacheExpiry
;
139 if ( $expire === null ) {
140 $expire = $wgParserCacheExpireTime;
142 $expire = min( $expire, $wgParserCacheExpireTime );
145 if ( $expire <= 0 ) {
146 return 0; // not cacheable
155 public function isCacheable() {
156 return $this->getCacheExpiry() > 0;
160 * Return true if this cached output object predates the global or
161 * per-article cache invalidation timestamps, or if it comes from
162 * an incompatible older version.
164 * @param string $touched The affected article's last touched timestamp
167 public function expired( $touched ) {
168 global $wgCacheEpoch;
170 $expiry = MWTimestamp
::convert( TS_MW
, MWTimestamp
::time() - $this->getCacheExpiry() );
172 return !$this->isCacheable() // parser says it's not cacheable
173 ||
$this->getCacheTime() < $touched
174 ||
$this->getCacheTime() <= $wgCacheEpoch
175 ||
$this->getCacheTime() < $expiry // expiry period has passed
176 ||
!isset( $this->mVersion
)
177 ||
version_compare( $this->mVersion
, Parser
::VERSION
, "lt" );
181 * Return true if this cached output object is for a different revision of
184 * @todo We always return false if $this->getCacheRevisionId() is null;
185 * this prevents invalidating the whole parser cache when this change is
186 * deployed. Someday that should probably be changed.
189 * @param int $id The affected article's current revision id
192 public function isDifferentRevision( $id ) {
193 $cached = $this->getCacheRevisionId();
194 return $cached !== null && $id !== $cached;