Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
36.09% covered (danger)
36.09%
48 / 133
37.50% covered (danger)
37.50%
6 / 16
CRAP
0.00% covered (danger)
0.00%
0 / 1
ObjectCacheFactory
36.09% covered (danger)
36.09%
48 / 133
37.50% covered (danger)
37.50%
6 / 16
874.61
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 getDefaultKeyspace
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
3
 newFromId
58.33% covered (warning)
58.33%
7 / 12
0.00% covered (danger)
0.00%
0 / 1
8.60
 getInstance
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
 newFromParams
64.00% covered (warning)
64.00%
16 / 25
0.00% covered (danger)
0.00%
0 / 1
9.29
 prepareSqlBagOStuffFromParams
0.00% covered (danger)
0.00%
0 / 23
0.00% covered (danger)
0.00%
0 / 1
90
 prepareMemcachedBagOStuffFromParams
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
2
 prepareMultiWriteBagOStuffFromParams
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 prepareRESTBagOStuffFromParams
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getLocalServerInstance
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 clear
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getLocalServerCacheClass
25.00% covered (danger)
25.00%
2 / 8
0.00% covered (danger)
0.00%
0 / 1
21.19
 getAnythingId
0.00% covered (danger)
0.00%
0 / 19
0.00% covered (danger)
0.00%
0 / 1
72
 makeLocalServerCache
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 isDatabaseId
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
20
 getLocalClusterInstance
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21use MediaWiki\Config\ServiceOptions;
22use MediaWiki\Deferred\DeferredUpdates;
23use MediaWiki\Http\Telemetry;
24use MediaWiki\Logger\Spi;
25use MediaWiki\MainConfigNames;
26use MediaWiki\MediaWikiServices;
27use Wikimedia\ObjectCache\APCUBagOStuff;
28use Wikimedia\ObjectCache\BagOStuff;
29use Wikimedia\ObjectCache\EmptyBagOStuff;
30use Wikimedia\ObjectCache\HashBagOStuff;
31use Wikimedia\ObjectCache\MemcachedBagOStuff;
32use Wikimedia\ObjectCache\MultiWriteBagOStuff;
33use Wikimedia\ObjectCache\RESTBagOStuff;
34use Wikimedia\ObjectCache\WinCacheBagOStuff;
35use Wikimedia\Stats\StatsFactory;
36
37/**
38 * Factory for cache objects as configured in the ObjectCaches setting.
39 *
40 * The word "cache" has two main dictionary meanings, and both
41 * are used in this factory class. They are:
42 *
43 *    - a) Cache (the computer science definition).
44 *         A place to store copies or computations on existing data for
45 *         higher access speeds.
46 *    - b) Storage.
47 *         A place to store lightweight data that is not canonically
48 *         stored anywhere else (e.g. a "hoard" of objects).
49 *
50 *  Primary entry points:
51 *
52 *  - ObjectCacheFactory::getLocalServerInstance( $fallbackType )
53 *    Purpose: Memory cache for very hot keys.
54 *    Stored only on the individual web server (typically APC or APCu for web requests,
55 *    and EmptyBagOStuff in CLI mode).
56 *    Not replicated to the other servers.
57 *
58 * - ObjectCacheFactory::getLocalClusterInstance()
59 *    Purpose: Memory storage for per-cluster coordination and tracking.
60 *    A typical use case would be a rate limit counter or cache regeneration mutex.
61 *    Stored centrally within the local data-center. Not replicated to other DCs.
62 *    Configured by $wgMainCacheType.
63 *
64 *  - ObjectCacheFactory::getInstance( $cacheType )
65 *    Purpose: Special cases (like tiered memory/disk caches).
66 *    Get a specific cache type by key in $wgObjectCaches.
67 *
68 *  All the above BagOStuff cache instances have their makeKey()
69 *  method scoped to the *current* wiki ID. Use makeGlobalKey() to avoid this scoping
70 *  when using keys that need to be shared amongst wikis.
71 *
72 * @ingroup Cache
73 * @since 1.42
74 */
75class ObjectCacheFactory {
76    /**
77     * @internal For use by ServiceWiring.php
78     * @var array
79     */
80    public const CONSTRUCTOR_OPTIONS = [
81        MainConfigNames::SQLiteDataDir,
82        MainConfigNames::UpdateRowsPerQuery,
83        MainConfigNames::MemCachedServers,
84        MainConfigNames::MemCachedPersistent,
85        MainConfigNames::MemCachedTimeout,
86        MainConfigNames::CachePrefix,
87        MainConfigNames::ObjectCaches,
88        MainConfigNames::MainCacheType,
89        MainConfigNames::MessageCacheType,
90        MainConfigNames::ParserCacheType,
91    ];
92
93    private ServiceOptions $options;
94    private StatsFactory $stats;
95    private Spi $logger;
96    /** @var BagOStuff[] */
97    private $instances = [];
98    private string $domainId;
99    /** @var callable */
100    private $dbLoadBalancerFactory;
101    /**
102     * @internal ObjectCacheTest only
103     * @var string
104     */
105    public static $localServerCacheClass;
106
107    public function __construct(
108        ServiceOptions $options,
109        StatsFactory $stats,
110        Spi $loggerSpi,
111        callable $dbLoadBalancerFactory,
112        string $domainId
113    ) {
114        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
115        $this->options = $options;
116        $this->stats = $stats;
117        $this->logger = $loggerSpi;
118        $this->dbLoadBalancerFactory = $dbLoadBalancerFactory;
119        $this->domainId = $domainId;
120    }
121
122    /**
123     * Get the default keyspace for this wiki.
124     *
125     * This is either the value of the MainConfigNames::CachePrefix setting
126     * or (if the former is unset) the MainConfigNames::DBname setting, with
127     * MainConfigNames::DBprefix (if defined).
128     *
129     * @return string
130     */
131    private function getDefaultKeyspace(): string {
132        $cachePrefix = $this->options->get( MainConfigNames::CachePrefix );
133        if ( is_string( $cachePrefix ) && $cachePrefix !== '' ) {
134            return $cachePrefix;
135        }
136
137        return $this->domainId;
138    }
139
140    /**
141     * Create a new cache object of the specified type.
142     *
143     * @param string|int $id A key in $wgObjectCaches.
144     * @return BagOStuff
145     */
146    private function newFromId( $id ): BagOStuff {
147        if ( $id === CACHE_ANYTHING ) {
148            $id = $this->getAnythingId();
149        }
150
151        if ( !isset( $this->options->get( MainConfigNames::ObjectCaches )[$id] ) ) {
152            // Always recognize these
153            if ( $id === CACHE_NONE ) {
154                return new EmptyBagOStuff();
155            } elseif ( $id === CACHE_HASH ) {
156                return new HashBagOStuff();
157            } elseif ( $id === CACHE_ACCEL ) {
158                return self::makeLocalServerCache( $this->getDefaultKeyspace() );
159            }
160
161            throw new InvalidArgumentException( "Invalid object cache type \"$id\" requested. " .
162                "It is not present in \$wgObjectCaches." );
163        }
164
165        return $this->newFromParams( $this->options->get( MainConfigNames::ObjectCaches )[$id] );
166    }
167
168    /**
169     * Get a cached instance of the specified type of cache object.
170     *
171     * @param string|int $id A key in $wgObjectCaches.
172     * @return BagOStuff
173     */
174    public function getInstance( $id ): BagOStuff {
175        if ( !isset( $this->instances[$id] ) ) {
176            $this->instances[$id] = $this->newFromId( $id );
177        }
178
179        return $this->instances[$id];
180    }
181
182    /**
183     * Create a new cache object from parameters specification supplied.
184     *
185     * @internal Using this method directly outside of MediaWiki core
186     *   is discouraged. Use getInstance() instead and supply the ID
187     *   of the cache instance to be looked up.
188     *
189     * @param array $params Must have 'factory' or 'class' property.
190     *  - factory: Callback passed $params that returns BagOStuff.
191     *  - class: BagOStuff subclass constructed with $params.
192     *  - loggroup: Alias to set 'logger' key with LoggerFactory group.
193     *  - .. Other parameters passed to factory or class.
194     *
195     * @return BagOStuff
196     */
197    public function newFromParams( array $params ): BagOStuff {
198        $logger = $this->logger->getLogger( $params['loggroup'] ?? 'objectcache' );
199        // Apply default parameters and resolve the logger instance
200        $params += [
201            'logger' => $logger,
202            'keyspace' => $this->getDefaultKeyspace(),
203            'asyncHandler' => [ DeferredUpdates::class, 'addCallableUpdate' ],
204            'reportDupes' => true,
205            'stats' => $this->stats,
206        ];
207
208        if ( isset( $params['factory'] ) ) {
209            $args = $params['args'] ?? [ $params ];
210
211            return call_user_func( $params['factory'], ...$args );
212        }
213
214        if ( !isset( $params['class'] ) ) {
215            throw new InvalidArgumentException(
216                'No "factory" nor "class" provided; got "' . print_r( $params, true ) . '"'
217            );
218        }
219
220        $class = $params['class'];
221
222        // Normalization and DI for SqlBagOStuff
223        if ( is_a( $class, SqlBagOStuff::class, true ) ) {
224            $this->prepareSqlBagOStuffFromParams( $params );
225        }
226
227        // Normalization and DI for MemcachedBagOStuff
228        if ( is_subclass_of( $class, MemcachedBagOStuff::class ) ) {
229            $this->prepareMemcachedBagOStuffFromParams( $params );
230        }
231
232        // Normalization and DI for MultiWriteBagOStuff
233        if ( is_a( $class, MultiWriteBagOStuff::class, true ) ) {
234            $this->prepareMultiWriteBagOStuffFromParams( $params );
235        }
236        if ( is_a( $class, RESTBagOStuff::class, true ) ) {
237            $this->prepareRESTBagOStuffFromParams( $params );
238        }
239
240        return new $class( $params );
241    }
242
243    private function prepareSqlBagOStuffFromParams( array &$params ): void {
244        if ( isset( $params['globalKeyLB'] ) ) {
245            throw new InvalidArgumentException(
246                'globalKeyLB in $wgObjectCaches is no longer supported' );
247        }
248        if ( isset( $params['server'] ) && !isset( $params['servers'] ) ) {
249            $params['servers'] = [ $params['server'] ];
250            unset( $params['server'] );
251        }
252        if ( isset( $params['servers'] ) ) {
253            // In the past it was not required to set 'dbDirectory' in $wgObjectCaches
254            foreach ( $params['servers'] as &$server ) {
255                if ( $server['type'] === 'sqlite' && !isset( $server['dbDirectory'] ) ) {
256                    $server['dbDirectory'] = $this->options->get( MainConfigNames::SQLiteDataDir );
257                }
258            }
259        } elseif ( isset( $params['cluster'] ) ) {
260            $cluster = $params['cluster'];
261            $dbLbFactory = $this->dbLoadBalancerFactory;
262            $params['loadBalancerCallback'] = static function () use ( $cluster, $dbLbFactory ) {
263                return $dbLbFactory()->getExternalLB( $cluster );
264            };
265            $params += [ 'dbDomain' => false ];
266        } else {
267            $dbLbFactory = $this->dbLoadBalancerFactory;
268            $params['loadBalancerCallback'] = static function () use ( $dbLbFactory ) {
269                return $dbLbFactory()->getMainLb();
270            };
271            $params += [ 'dbDomain' => false ];
272        }
273        $params += [ 'writeBatchSize' => $this->options->get( MainConfigNames::UpdateRowsPerQuery ) ];
274    }
275
276    private function prepareMemcachedBagOStuffFromParams( array &$params ): void {
277        $params += [
278            'servers' => $this->options->get( MainConfigNames::MemCachedServers ),
279            'persistent' => $this->options->get( MainConfigNames::MemCachedPersistent ),
280            'timeout' => $this->options->get( MainConfigNames::MemCachedTimeout ),
281        ];
282    }
283
284    private function prepareMultiWriteBagOStuffFromParams( array &$params ): void {
285        // Phan warns about foreach with non-array because it
286        // thinks any key can be Closure|IBufferingStatsdDataFactory
287        '@phan-var array{caches:array[]} $params';
288        foreach ( $params['caches'] ?? [] as $i => $cacheInfo ) {
289            // Ensure logger, keyspace, asyncHandler, etc are injected just as if
290            // one of these was configured without MultiWriteBagOStuff.
291            $params['caches'][$i] = $this->newFromParams( $cacheInfo );
292        }
293    }
294
295    private function prepareRESTBagOStuffFromParams( array &$params ): void {
296        $params['telemetry'] = Telemetry::getInstance();
297    }
298
299    /**
300     * Factory function for CACHE_ACCEL (referenced from configuration)
301     *
302     * This will look for any APC or APCu style server-local cache.
303     * A fallback cache can be specified if none is found.
304     *
305     *     // Direct calls
306     *     ObjectCache::getLocalServerInstance( $fallbackType );
307     *
308     *     // From $wgObjectCaches via newFromParams()
309     *     ObjectCache::getLocalServerInstance( [ 'fallback' => $fallbackType ] );
310     *
311     * @param int|string|array $fallback Fallback cache or parameter map with 'fallback'
312     * @return BagOStuff
313     * @throws InvalidArgumentException
314     */
315    public function getLocalServerInstance( $fallback = CACHE_NONE ): BagOStuff {
316        $cache = $this->getInstance( CACHE_ACCEL );
317        if ( $cache instanceof EmptyBagOStuff ) {
318            if ( is_array( $fallback ) ) {
319                $fallback = $fallback['fallback'] ?? CACHE_NONE;
320            }
321            $cache = $this->getInstance( $fallback );
322        }
323
324        return $cache;
325    }
326
327    /**
328     * Clear all the cached instances.
329     */
330    public function clear(): void {
331        $this->instances = [];
332    }
333
334    /**
335     * Get the class which will be used for the local server cache
336     * @return string
337     */
338    private static function getLocalServerCacheClass() {
339        if ( self::$localServerCacheClass !== null ) {
340            return self::$localServerCacheClass;
341        }
342        if ( function_exists( 'apcu_fetch' ) ) {
343            // Make sure the APCu methods actually store anything
344            if ( PHP_SAPI !== 'cli' || ini_get( 'apc.enable_cli' ) ) {
345                return APCUBagOStuff::class;
346
347            }
348        } elseif ( function_exists( 'wincache_ucache_get' ) ) {
349            return WinCacheBagOStuff::class;
350        }
351
352        return EmptyBagOStuff::class;
353    }
354
355    /**
356     * Get the ID that will be used for CACHE_ANYTHING
357     *
358     * @internal
359     * @return string|int
360     */
361    public function getAnythingId() {
362        $candidates = [
363            $this->options->get( MainConfigNames::MainCacheType ),
364            $this->options->get( MainConfigNames::MessageCacheType ),
365            $this->options->get( MainConfigNames::ParserCacheType )
366        ];
367        foreach ( $candidates as $candidate ) {
368            if ( $candidate === CACHE_ACCEL ) {
369                // CACHE_ACCEL might default to nothing if no APCu
370                // See includes/ServiceWiring.php
371                $class = self::getLocalServerCacheClass();
372                if ( $class !== EmptyBagOStuff::class ) {
373                    return $candidate;
374                }
375            } elseif ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
376                return $candidate;
377            }
378        }
379
380        $services = MediaWikiServices::getInstance();
381
382        if ( $services->isServiceDisabled( 'DBLoadBalancer' ) ) {
383            // The DBLoadBalancer service is disabled, so we can't use the database!
384            $candidate = CACHE_NONE;
385        } elseif ( $services->isStorageDisabled() ) {
386            // Storage services are disabled because MediaWikiServices::disableStorage()
387            // was called. This is typically the case during installation.
388            $candidate = CACHE_NONE;
389        } else {
390            $candidate = CACHE_DB;
391        }
392        return $candidate;
393    }
394
395    /**
396     * Create a new BagOStuff instance for local-server caching.
397     *
398     * Only use this if you explicitly require the creation of
399     * a fresh instance. Whenever possible, use or inject the object
400     * from MediaWikiServices::getLocalServerObjectCache() instead.
401     *
402     * NOTE: This method is called very early via Setup.php by ExtensionRegistry,
403     * and thus must remain fairly standalone so as to not cause initialization
404     * of the MediaWikiServices singleton.
405     *
406     * @internal For use by ServiceWiring and ExtensionRegistry. There are use
407     *    cases whereby we want to build up local server cache without service
408     *    wiring available.
409     * @since 1.43, previously on ObjectCache.php since 1.35
410     *
411     * @param string $keyspace
412     * @return BagOStuff
413     */
414    public static function makeLocalServerCache( string $keyspace ) {
415        $params = [
416            'reportDupes' => false,
417            // Even simple caches must use a keyspace (T247562)
418            'keyspace' => $keyspace,
419        ];
420        $class = self::getLocalServerCacheClass();
421        return new $class( $params );
422    }
423
424    /**
425     * Determine whether a config ID would access the database
426     *
427     * @internal For use by ServiceWiring.php
428     * @param string|int $id A key in $wgObjectCaches
429     * @return bool
430     */
431    public function isDatabaseId( $id ) {
432        // NOTE: Sanity check if $id is set to CACHE_ANYTHING and
433        // everything is going through service wiring. CACHE_ANYTHING
434        // would default to CACHE_DB, let's handle that early for cases
435        // where all cache configs are set to CACHE_ANYTHING (T362686).
436        if ( $id === CACHE_ANYTHING ) {
437            $id = $this->getAnythingId();
438            return $this->isDatabaseId( $id );
439        }
440
441        if ( !isset( $this->options->get( MainConfigNames::ObjectCaches )[$id] ) ) {
442            return false;
443        }
444        $cache = $this->options->get( MainConfigNames::ObjectCaches )[$id];
445        if ( ( $cache['class'] ?? '' ) === SqlBagOStuff::class ) {
446            return true;
447        }
448
449        return false;
450    }
451
452    /**
453     * Get the main cluster-local cache object.
454     *
455     * @since 1.43, previously on ObjectCache.php since 1.27
456     * @return BagOStuff
457     */
458    public function getLocalClusterInstance() {
459        return $this->getInstance(
460            $this->options->get( MainConfigNames::MainCacheType )
461        );
462    }
463}