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 uncacheable. Used
44 public $mCacheTime = '';
47 * @var int|null Seconds after which the object should expire, use 0 for uncacheable. 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 return wfTimestamp( TS_MW
, $this->mCacheTime
);
65 * setCacheTime() sets the timestamp expressing when the page has been rendered.
66 * This does not control expiry, see updateCacheExpiry() for that!
67 * @param string $t TS_MW timestamp
70 public function setCacheTime( $t ) {
71 return wfSetVar( $this->mCacheTime
, $t );
76 * @return int|null Revision id, if any was set
78 public function getCacheRevisionId() {
79 return $this->mCacheRevisionId
;
84 * @param int|null $id Revision ID
86 public function setCacheRevisionId( $id ) {
87 $this->mCacheRevisionId
= $id;
91 * Sets the number of seconds after which this object should expire.
93 * This value is used with the ParserCache.
94 * If called with a value greater than the value provided at any previous call,
95 * the new call has no effect. The value returned by getCacheExpiry is smaller
96 * or equal to the smallest number that was provided as an argument to
97 * updateCacheExpiry().
99 * Avoid using 0 if at all possible. Consider JavaScript for highly dynamic content.
101 * @param int $seconds
103 public function updateCacheExpiry( $seconds ) {
104 $seconds = (int)$seconds;
106 if ( $this->mCacheExpiry
=== null ||
$this->mCacheExpiry
> $seconds ) {
107 $this->mCacheExpiry
= $seconds;
112 * Returns the number of seconds after which this object should expire.
113 * This method is used by ParserCache to determine how long the ParserOutput can be cached.
114 * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
115 * The value returned by getCacheExpiry is smaller or equal to the smallest number
116 * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
117 * value of $wgParserCacheExpireTime.
120 public function getCacheExpiry() {
121 global $wgParserCacheExpireTime;
123 if ( $this->mCacheTime
< 0 ) {
125 } // old-style marker for "not cacheable"
127 $expire = $this->mCacheExpiry
;
129 if ( $expire === null ) {
130 $expire = $wgParserCacheExpireTime;
132 $expire = min( $expire, $wgParserCacheExpireTime );
135 if ( $expire <= 0 ) {
136 return 0; // not cacheable
145 public function isCacheable() {
146 return $this->getCacheExpiry() > 0;
150 * Return true if this cached output object predates the global or
151 * per-article cache invalidation timestamps, or if it comes from
152 * an incompatible older version.
154 * @param string $touched The affected article's last touched timestamp
157 public function expired( $touched ) {
158 global $wgCacheEpoch;
160 return !$this->isCacheable() // parser says it's uncacheable
161 ||
$this->getCacheTime() < $touched
162 ||
$this->getCacheTime() <= $wgCacheEpoch
163 ||
$this->getCacheTime() <
164 wfTimestamp( TS_MW
, time() - $this->getCacheExpiry() ) // expiry period has passed
165 ||
!isset( $this->mVersion
)
166 ||
version_compare( $this->mVersion
, Parser
::VERSION
, "lt" );
170 * Return true if this cached output object is for a different revision of
173 * @todo We always return false if $this->getCacheRevisionId() is null;
174 * this prevents invalidating the whole parser cache when this change is
175 * deployed. Someday that should probably be changed.
178 * @param int $id The affected article's current revision id
181 public function isDifferentRevision( $id ) {
182 $cached = $this->getCacheRevisionId();
183 return $cached !== null && $id !== $cached;