ReadOnlyMode.php

Go to the documentation of this file.

<?php
 
use Wikimedia\Rdbms\LoadBalancer;
 
class ReadOnlyMode {
    private $configuredReadOnly;
 
    private $loadBalancer;
 
    public function __construct( ConfiguredReadOnlyMode $cro, LoadBalancer $loadBalancer ) {
        $this->configuredReadOnly = $cro;
        $this->loadBalancer = $loadBalancer;
    }
 
    public function isReadOnly() {
        return $this->getReason() !== false;
    }
 
    public function getReason() {
        $reason = $this->configuredReadOnly->getReason();
        if ( $reason !== false ) {
            return $reason;
        }
        $reason = $this->loadBalancer->getReadOnlyReason();
        if ( $reason !== false && $reason !== null ) {
            return $reason;
        }
        return false;
    }
 
    public function setReason( $msg ) {
        $this->configuredReadOnly->setReason( $msg );
    }
 
    public function clearCache() {
        $this->configuredReadOnly->clearCache();
    }
}
 
class ConfiguredReadOnlyMode {
    private $config;
 
    private $fileReason;
 
    private $overrideReason;
 
    public function __construct( Config $config ) {
        $this->config = $config;
    }
 
    public function isReadOnly() {
        return $this->getReason() !== false;
    }
 
    public function getReason() {
        if ( $this->overrideReason !== null ) {
            return $this->overrideReason;
        }
        $confReason = $this->config->get( 'ReadOnly' );
        if ( $confReason !== null ) {
            return $confReason;
        }
        if ( $this->fileReason === null ) {
            // Cache for faster access next time
            $readOnlyFile = $this->config->get( 'ReadOnlyFile' );
            if ( is_file( $readOnlyFile ) && filesize( $readOnlyFile ) > 0 ) {
                $this->fileReason = file_get_contents( $readOnlyFile );
            } else {
                $this->fileReason = false;
            }
        }
        return $this->fileReason;
    }
 
    public function setReason( $msg ) {
        $this->overrideReason = $msg;
    }
 
    public function clearCache() {
        $this->fileReason = null;
    }
}