Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 74
0.00% covered (danger)
0.00%
0 / 16
CRAP
0.00% covered (danger)
0.00%
0 / 1
FileCacheBase
0.00% covered (danger)
0.00%
0 / 73
0.00% covered (danger)
0.00%
0 / 16
930
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
2
 baseCacheDirectory
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 cacheDirectory
n/a
0 / 0
n/a
0 / 0
0
 cachePath
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
12
 isCached
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 cacheTimestamp
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 isCacheGood
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
12
 useGzip
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 fetchText
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 saveText
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
12
 clearCache
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 checkCacheDirs
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 typeSubdirectory
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 hashSubdirectory
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
12
 incrMissesRecent
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 1
30
 getMissesRecent
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 cacheMissKey
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2/**
3 * Data storage in the file system.
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 Cache
22 */
23
24namespace MediaWiki\Cache;
25
26use MediaWiki\Config\ServiceOptions;
27use MediaWiki\MainConfigNames;
28use MediaWiki\MediaWikiServices;
29use MediaWiki\Request\WebRequest;
30use Wikimedia\AtEase\AtEase;
31use Wikimedia\IPUtils;
32use Wikimedia\ObjectCache\BagOStuff;
33
34/**
35 * Base class for data storage in the file system.
36 *
37 * @ingroup Cache
38 */
39abstract class FileCacheBase {
40    /** @var string[] */
41    private const CONSTRUCTOR_OPTIONS = [
42        MainConfigNames::CacheEpoch,
43        MainConfigNames::FileCacheDepth,
44        MainConfigNames::FileCacheDirectory,
45        MainConfigNames::MimeType,
46        MainConfigNames::UseGzip,
47    ];
48
49    protected $mKey;
50    protected $mType = 'object';
51    protected $mExt = 'cache';
52    protected $mFilePath;
53    protected $mUseGzip;
54    /** @var bool|null lazy loaded */
55    protected $mCached;
56    /** @var ServiceOptions */
57    protected $options;
58
59    /* @todo configurable? */
60    private const MISS_FACTOR = 15; // log 1 every MISS_FACTOR cache misses
61    private const MISS_TTL_SEC = 3600; // how many seconds ago is "recent"
62
63    protected function __construct() {
64        $this->options = new ServiceOptions(
65            self::CONSTRUCTOR_OPTIONS,
66            MediaWikiServices::getInstance()->getMainConfig()
67        );
68        $this->mUseGzip = (bool)$this->options->get( MainConfigNames::UseGzip );
69    }
70
71    /**
72     * Get the base file cache directory
73     * @return string
74     */
75    final protected function baseCacheDirectory() {
76        return $this->options->get( MainConfigNames::FileCacheDirectory );
77    }
78
79    /**
80     * Get the base cache directory (not specific to this file)
81     * @return string
82     */
83    abstract protected function cacheDirectory();
84
85    /**
86     * Get the path to the cache file
87     * @return string
88     */
89    protected function cachePath() {
90        if ( $this->mFilePath !== null ) {
91            return $this->mFilePath;
92        }
93
94        $dir = $this->cacheDirectory();
95        # Build directories (methods include the trailing "/")
96        $subDirs = $this->typeSubdirectory() . $this->hashSubdirectory();
97        # Avoid extension confusion
98        $key = str_replace( '.', '%2E', urlencode( $this->mKey ) );
99        # Build the full file path
100        $this->mFilePath = "{$dir}/{$subDirs}{$key}.{$this->mExt}";
101        if ( $this->useGzip() ) {
102            $this->mFilePath .= '.gz';
103        }
104
105        return $this->mFilePath;
106    }
107
108    /**
109     * Check if the cache file exists
110     * @return bool
111     */
112    public function isCached() {
113        $this->mCached ??= is_file( $this->cachePath() );
114
115        return $this->mCached;
116    }
117
118    /**
119     * Get the last-modified timestamp of the cache file
120     * @return string|bool TS_MW timestamp
121     */
122    public function cacheTimestamp() {
123        $timestamp = filemtime( $this->cachePath() );
124
125        return ( $timestamp !== false )
126            ? wfTimestamp( TS_MW, $timestamp )
127            : false;
128    }
129
130    /**
131     * Check if up to date cache file exists
132     * @param string $timestamp MW_TS timestamp
133     *
134     * @return bool
135     */
136    public function isCacheGood( $timestamp = '' ) {
137        $cacheEpoch = $this->options->get( MainConfigNames::CacheEpoch );
138
139        if ( !$this->isCached() ) {
140            return false;
141        }
142
143        $cachetime = $this->cacheTimestamp();
144        $good = ( $timestamp <= $cachetime && $cacheEpoch <= $cachetime );
145        wfDebug( __METHOD__ .
146            ": cachetime $cachetime, touched '{$timestamp}' epoch {$cacheEpoch}, good " . wfBoolToStr( $good ) );
147
148        return $good;
149    }
150
151    /**
152     * Check if the cache is gzipped
153     * @return bool
154     */
155    protected function useGzip() {
156        return $this->mUseGzip;
157    }
158
159    /**
160     * Get the uncompressed text from the cache
161     * @return string
162     */
163    public function fetchText() {
164        if ( $this->useGzip() ) {
165            $fh = gzopen( $this->cachePath(), 'rb' );
166
167            return stream_get_contents( $fh );
168        } else {
169            return file_get_contents( $this->cachePath() );
170        }
171    }
172
173    /**
174     * Save and compress text to the cache
175     * @param string $text
176     * @return string|false Compressed text
177     */
178    public function saveText( $text ) {
179        if ( $this->useGzip() ) {
180            $text = gzencode( $text );
181        }
182
183        $this->checkCacheDirs(); // build parent dir
184        if ( !file_put_contents( $this->cachePath(), $text, LOCK_EX ) ) {
185            wfDebug( __METHOD__ . "() failed saving " . $this->cachePath() );
186            $this->mCached = null;
187
188            return false;
189        }
190
191        $this->mCached = true;
192
193        return $text;
194    }
195
196    /**
197     * Clear the cache for this page
198     * @return void
199     */
200    public function clearCache() {
201        AtEase::suppressWarnings();
202        unlink( $this->cachePath() );
203        AtEase::restoreWarnings();
204        $this->mCached = false;
205    }
206
207    /**
208     * Create parent directors of $this->cachePath()
209     * @return void
210     */
211    protected function checkCacheDirs() {
212        wfMkdirParents( dirname( $this->cachePath() ), null, __METHOD__ );
213    }
214
215    /**
216     * Get the cache type subdirectory (with trailing slash)
217     * An extending class could use that method to alter the type -> directory
218     * mapping. @see HTMLFileCache::typeSubdirectory() for an example.
219     *
220     * @return string
221     */
222    protected function typeSubdirectory() {
223        return $this->mType . '/';
224    }
225
226    /**
227     * Return relative multi-level hash subdirectory (with trailing slash)
228     * or the empty string if not $wgFileCacheDepth
229     * @return string
230     */
231    protected function hashSubdirectory() {
232        $fileCacheDepth = $this->options->get( MainConfigNames::FileCacheDepth );
233
234        $subdir = '';
235        if ( $fileCacheDepth > 0 ) {
236            $hash = md5( $this->mKey );
237            for ( $i = 1; $i <= $fileCacheDepth; $i++ ) {
238                $subdir .= substr( $hash, 0, $i ) . '/';
239            }
240        }
241
242        return $subdir;
243    }
244
245    /**
246     * Roughly increments the cache misses in the last hour by unique visitors
247     * @param WebRequest $request
248     * @return void
249     */
250    public function incrMissesRecent( WebRequest $request ) {
251        if ( mt_rand( 0, self::MISS_FACTOR - 1 ) == 0 ) {
252            # Get a large IP range that should include the user  even if that
253            # person's IP address changes
254            $ip = $request->getIP();
255            if ( !IPUtils::isValid( $ip ) ) {
256                return;
257            }
258
259            $ip = IPUtils::isIPv6( $ip )
260                ? IPUtils::sanitizeRange( "$ip/32" )
261                : IPUtils::sanitizeRange( "$ip/16" );
262
263            # Bail out if a request already came from this range...
264            $cache = MediaWikiServices::getInstance()->getObjectCacheFactory()
265                ->getLocalClusterInstance();
266            $key = $cache->makeKey( static::class, 'attempt', $this->mType, $this->mKey, $ip );
267            if ( !$cache->add( $key, 1, self::MISS_TTL_SEC ) ) {
268                return; // possibly the same user
269            }
270
271            # Increment the number of cache misses...
272            $cache->incrWithInit( $this->cacheMissKey( $cache ), self::MISS_TTL_SEC );
273        }
274    }
275
276    /**
277     * Roughly gets the cache misses in the last hour by unique visitors
278     * @return int
279     */
280    public function getMissesRecent() {
281        $cache = MediaWikiServices::getInstance()->getObjectCacheFactory()
282            ->getLocalClusterInstance();
283
284        return self::MISS_FACTOR * $cache->get( $this->cacheMissKey( $cache ) );
285    }
286
287    /**
288     * @param BagOStuff $cache Instance that the key will be used with
289     * @return string
290     */
291    protected function cacheMissKey( BagOStuff $cache ) {
292        return $cache->makeKey( static::class, 'misses', $this->mType, $this->mKey );
293    }
294}
295
296/** @deprecated class alias since 1.42 */
297class_alias( FileCacheBase::class, 'FileCacheBase' );