first commit

1 files changed, 68 insertions, 0 deletions

diff --git a/www/wiki/includes/ReadOnlyMode.php b/www/wiki/includes/ReadOnlyMode.php
new file mode 100644
index 00000000..547c2d5e
--- /dev/null
+++ b/www/wiki/includes/ReadOnlyMode.php
@@ -0,0 +1,68 @@
+<?php
+
+use Wikimedia\Rdbms\LoadBalancer;
+
+/**
+ * A service class for fetching the wiki's current read-only mode.
+ * To obtain an instance, use MediaWikiServices::getReadOnlyMode().
+ *
+ * @since 1.29
+ */
+class ReadOnlyMode {
+	/** @var ConfiguredReadOnlyMode */
+	private $configuredReadOnly;
+
+	/** @var LoadBalancer */
+	private $loadBalancer;
+
+	public function __construct( ConfiguredReadOnlyMode $cro, LoadBalancer $loadBalancer ) {
+		$this->configuredReadOnly = $cro;
+		$this->loadBalancer = $loadBalancer;
+	}
+
+	/**
+	 * Check whether the wiki is in read-only mode.
+	 *
+	 * @return bool
+	 */
+	public function isReadOnly() {
+		return $this->getReason() !== false;
+	}
+
+	/**
+	 * Check if the site is in read-only mode and return the message if so
+	 *
+	 * This checks the configuration and registered DB load balancers for
+	 * read-only mode. This may result in DB connection being made.
+	 *
+	 * @return string|bool String when in read-only mode; false otherwise
+	 */
+	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;
+	}
+
+	/**
+	 * 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->configuredReadOnly->setReason( $msg );
+	}
+
+	/**
+	 * Clear the cache of the read only file
+	 */
+	public function clearCache() {
+		$this->configuredReadOnly->clearCache();
+	}
+}