LockManagerGroup.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Logger\LoggerFactory;
 
class LockManagerGroup {
    protected static $instances = [];
 
    protected $domain; // string; domain (usually wiki ID)
 
    protected $managers = [];
 
    protected function __construct( $domain ) {
        $this->domain = $domain;
    }
 
    public static function singleton( $domain = false ) {
        if ( $domain === false ) {
            $domain = WikiMap::getCurrentWikiDbDomain()->getId();
        }
 
        if ( !isset( self::$instances[$domain] ) ) {
            self::$instances[$domain] = new self( $domain );
            self::$instances[$domain]->initFromGlobals();
        }
 
        return self::$instances[$domain];
    }
 
    public static function destroySingletons() {
        self::$instances = [];
    }
 
    protected function initFromGlobals() {
        global $wgLockManagers;
 
        $this->register( $wgLockManagers );
    }
 
    protected function register( array $configs ) {
        foreach ( $configs as $config ) {
            $config['domain'] = $this->domain;
            if ( !isset( $config['name'] ) ) {
                throw new Exception( "Cannot register a lock manager with no name." );
            }
            $name = $config['name'];
            if ( !isset( $config['class'] ) ) {
                throw new Exception( "Cannot register lock manager `{$name}` with no class." );
            }
            $class = $config['class'];
            unset( $config['class'] ); // lock manager won't need this
            $this->managers[$name] = [
                'class' => $class,
                'config' => $config,
                'instance' => null
            ];
        }
    }
 
    public function get( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new Exception( "No lock manager defined with the name `$name`." );
        }
        // Lazy-load the actual lock manager instance
        if ( !isset( $this->managers[$name]['instance'] ) ) {
            $class = $this->managers[$name]['class'];
            $config = $this->managers[$name]['config'];
            if ( $class === DBLockManager::class ) {
                $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
                $lb = $lbFactory->newMainLB( $config['domain'] );
                $dbw = $lb->getLazyConnectionRef( DB_MASTER, [], $config['domain'] );
 
                $config['dbServers']['localDBMaster'] = $dbw;
                $config['srvCache'] = ObjectCache::getLocalServerInstance( 'hash' );
            }
            $config['logger'] = LoggerFactory::getInstance( 'LockManager' );
 
            // @phan-suppress-next-line PhanTypeInstantiateAbstract
            $this->managers[$name]['instance'] = new $class( $config );
        }
 
        return $this->managers[$name]['instance'];
    }
 
    public function config( $name ) {
        if ( !isset( $this->managers[$name] ) ) {
            throw new Exception( "No lock manager defined with the name `$name`." );
        }
        $class = $this->managers[$name]['class'];
 
        return [ 'class' => $class ] + $this->managers[$name]['config'];
    }
 
    public function getDefault() {
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : new NullLockManager( [] );
    }
 
    public function getAny() {
        return isset( $this->managers['default'] )
            ? $this->get( 'default' )
            : $this->get( 'fsLockManager' );
    }
}