4b46994799
MediaWikiServices::getFoo() is wrong. Right is: MediaWikiServices::getInstance()->getFoo() Change-Id: Ib6d844ddfe5bd6ccd72b887a63d9ad476c8d196f
73 lines
1.6 KiB
PHP
73 lines
1.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* A read-only mode service which does not depend on LoadBalancer.
|
|
* To obtain an instance, use MediaWikiServices::getInstance()->getConfiguredReadOnlyMode().
|
|
*
|
|
* @since 1.29
|
|
*/
|
|
class ConfiguredReadOnlyMode {
|
|
/** @var Config */
|
|
private $config;
|
|
|
|
/** @var string|bool|null */
|
|
private $fileReason;
|
|
|
|
/** @var string|null */
|
|
private $overrideReason;
|
|
|
|
public function __construct( Config $config ) {
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* Check whether the wiki is in read-only mode.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isReadOnly() {
|
|
return $this->getReason() !== false;
|
|
}
|
|
|
|
/**
|
|
* Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
|
|
*
|
|
* @return string|bool String when in read-only mode; false otherwise
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Set the read-only mode, which will apply for the remainder of the
|
|
* request or until a service reset.
|
|
*
|
|
* @param string|null $msg
|
|
*/
|
|
public function setReason( $msg ) {
|
|
$this->overrideReason = $msg;
|
|
}
|
|
|
|
/**
|
|
* Clear the cache of the read only file
|
|
*/
|
|
public function clearCache() {
|
|
$this->fileReason = null;
|
|
}
|
|
}
|