diff options
author | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
---|---|---|
committer | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
commit | fc7369835258467bf97eb64f184b93691f9a9fd5 (patch) | |
tree | daabd60089d2dd76d9f5fb416b005fbe159c799d /www/wiki/includes/ConfiguredReadOnlyMode.php |
first commit
Diffstat (limited to 'www/wiki/includes/ConfiguredReadOnlyMode.php')
-rw-r--r-- | www/wiki/includes/ConfiguredReadOnlyMode.php | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/www/wiki/includes/ConfiguredReadOnlyMode.php b/www/wiki/includes/ConfiguredReadOnlyMode.php new file mode 100644 index 00000000..af7c7cbd --- /dev/null +++ b/www/wiki/includes/ConfiguredReadOnlyMode.php @@ -0,0 +1,73 @@ +<?php + +/** + * A read-only mode service which does not depend on LoadBalancer. + * To obtain an instance, use MediaWikiServices::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; + } +} |