From ccdaec62967d4870c85434f974914440bfb93027 Mon Sep 17 00:00:00 2001 From: Thomas Mueller Date: Wed, 9 Jan 2013 00:37:50 +0100 Subject: [PATCH] webdav returns "503 Service Unavailable" in case the ownCloud server is currently in maintenance mode. --- apps/files/appinfo/remote.php | 1 + lib/connector/sabre/ServiceUnavailable.php | 22 +++++++++ lib/connector/sabre/maintenanceplugin.php | 56 ++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 lib/connector/sabre/ServiceUnavailable.php create mode 100644 lib/connector/sabre/maintenanceplugin.php diff --git a/apps/files/appinfo/remote.php b/apps/files/appinfo/remote.php index 1713bcc22c..6a78a1e0d7 100644 --- a/apps/files/appinfo/remote.php +++ b/apps/files/appinfo/remote.php @@ -45,6 +45,7 @@ $server->addPlugin(new Sabre_DAV_Auth_Plugin($authBackend, 'ownCloud')); $server->addPlugin(new Sabre_DAV_Locks_Plugin($lockBackend)); $server->addPlugin(new Sabre_DAV_Browser_Plugin(false)); // Show something in the Browser, but no upload $server->addPlugin(new OC_Connector_Sabre_QuotaPlugin()); +$server->addPlugin(new OC_Connector_Sabre_MaintenancePlugin()); // And off we go! $server->exec(); diff --git a/lib/connector/sabre/ServiceUnavailable.php b/lib/connector/sabre/ServiceUnavailable.php new file mode 100644 index 0000000000..c1cc815c98 --- /dev/null +++ b/lib/connector/sabre/ServiceUnavailable.php @@ -0,0 +1,22 @@ + + * + * @license AGPL3 + */ + +class Sabre_DAV_Exception_ServiceUnavailable extends Sabre_DAV_Exception { + + /** + * Returns the HTTP statuscode for this exception + * + * @return int + */ + public function getHTTPCode() { + + return 503; + } +} diff --git a/lib/connector/sabre/maintenanceplugin.php b/lib/connector/sabre/maintenanceplugin.php new file mode 100644 index 0000000000..329fa4443a --- /dev/null +++ b/lib/connector/sabre/maintenanceplugin.php @@ -0,0 +1,56 @@ + + * + * @license AGPL3 + */ + +require 'ServiceUnavailable.php'; + +class OC_Connector_Sabre_MaintenancePlugin extends Sabre_DAV_ServerPlugin +{ + + /** + * Reference to main server object + * + * @var Sabre_DAV_Server + */ + private $server; + + /** + * This initializes the plugin. + * + * This function is called by Sabre_DAV_Server, after + * addPlugin is called. + * + * This method should set up the required event subscriptions. + * + * @param Sabre_DAV_Server $server + * @return void + */ + public function initialize(Sabre_DAV_Server $server) { + + $this->server = $server; + $this->server->subscribeEvent('beforeMethod', array($this, 'checkMaintenanceMode'), 10); + } + + /** + * This method is called before any HTTP method and returns http status code 503 + * in case the system is in maintenance mode. + * + * @throws Sabre_DAV_Exception_ServiceUnavailable + * @internal param string $method + * @return bool + */ + public function checkMaintenanceMode() { + if (OC_Config::getValue('maintenance', false)) { + throw new Sabre_DAV_Exception_ServiceUnavailable(); + } + + return true; + } +}