ObjectCache.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class ObjectCache {
    public static $instances = [];
 
    public static $localServerCacheClass;
 
    public static function getInstance( $id ) {
        return MediaWikiServices::getInstance()->getObjectCacheFactory()->getInstance( $id );
    }
 
    public static function newFromParams( array $params ) {
        return MediaWikiServices::getInstance()->getObjectCacheFactory()
            ->newFromParams( $params );
    }
 
    public static function newAnything() {
        return MediaWikiServices::getInstance()->getObjectCacheFactory()
            ->getInstance( self::getAnythingId() );
    }
 
    public static function getAnythingId() {
        global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
        $candidates = [ $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType ];
        foreach ( $candidates as $candidate ) {
            if ( $candidate === CACHE_ACCEL ) {
                // CACHE_ACCEL might default to nothing if no APCu
                // See includes/ServiceWiring.php
                $class = self::getLocalServerCacheClass();
                if ( $class !== EmptyBagOStuff::class ) {
                    return $candidate;
                }
            } elseif ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
                return $candidate;
            }
        }
 
        $services = MediaWikiServices::getInstance();
 
        if ( $services->isServiceDisabled( 'DBLoadBalancer' ) ) {
            // The DBLoadBalancer service is disabled, so we can't use the database!
            $candidate = CACHE_NONE;
        } elseif ( $services->isStorageDisabled() ) {
            // Storage services are disabled because MediaWikiServices::disableStorage()
            // was called. This is typically the case during installation.
            $candidate = CACHE_NONE;
        } else {
            $candidate = CACHE_DB;
        }
        return $candidate;
    }
 
    public static function getLocalServerInstance( $fallback = CACHE_NONE ) {
        return MediaWikiServices::getInstance()->getObjectCacheFactory()
            ->getLocalServerInstance( $fallback );
    }
 
    public static function getLocalClusterInstance() {
        return MediaWikiServices::getInstance()->get( '_LocalClusterCache' );
    }
 
    public static function isDatabaseId( $id ) {
        global $wgObjectCaches;
 
        // NOTE: Sanity check if $id is set to CACHE_ANYTHING and
        // everything is going through service wiring. CACHE_ANYTHING
        // would default to CACHE_DB, let's handle that early for cases
        // where all cache configs are set to CACHE_ANYTHING (T362686).
        if ( $id === CACHE_ANYTHING ) {
            $id = self::getAnythingId();
            return self::isDatabaseId( $id );
        }
 
        if ( !isset( $wgObjectCaches[$id] ) ) {
            return false;
        }
        $cache = $wgObjectCaches[$id];
        if ( ( $cache['class'] ?? '' ) === SqlBagOStuff::class ) {
            return true;
        }
 
        return false;
    }
 
    public static function clear() {
        MediaWikiServices::getInstance()->getObjectCacheFactory()->clear();
    }
 
    public static function makeLocalServerCache( $keyspace ): BagOStuff {
        $params = [
            'reportDupes' => false,
            // Even simple caches must use a keyspace (T247562)
            'keyspace' => $keyspace,
        ];
        $class = self::getLocalServerCacheClass();
        return new $class( $params );
    }
 
    private static function getLocalServerCacheClass() {
        if ( self::$localServerCacheClass !== null ) {
            return self::$localServerCacheClass;
        }
        if ( function_exists( 'apcu_fetch' ) ) {
            // Make sure the APCu methods actually store anything
            if ( PHP_SAPI !== 'cli' || ini_get( 'apc.enable_cli' ) ) {
                return APCUBagOStuff::class;
 
            }
        } elseif ( function_exists( 'wincache_ucache_get' ) ) {
            return WinCacheBagOStuff::class;
        }
 
        return EmptyBagOStuff::class;
    }
}