From 1493e86deafb19f3f98ecee35389119daf2911a4 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 22 Sep 2015 11:43:40 +0200 Subject: Allow listeners to set status code and message --- lib/private/connector/sabre/listenerplugin.php | 12 ++++- lib/public/sabrepluginevent.php | 72 ++++++++++++++++++++++++++ lib/public/sabrepluginexception.php | 37 +++++++++++++ 3 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 lib/public/sabrepluginevent.php create mode 100644 lib/public/sabrepluginexception.php (limited to 'lib') diff --git a/lib/private/connector/sabre/listenerplugin.php b/lib/private/connector/sabre/listenerplugin.php index d0d40f4dc86..ec628add28b 100644 --- a/lib/private/connector/sabre/listenerplugin.php +++ b/lib/private/connector/sabre/listenerplugin.php @@ -21,6 +21,9 @@ namespace OC\Connector\Sabre; +use OCP\AppFramework\Http; +use OCP\SabrePluginEvent; +use OCP\SabrePluginException; use Sabre\DAV\ServerPlugin; use Symfony\Component\EventDispatcher\EventDispatcherInterface; @@ -49,9 +52,16 @@ class ListenerPlugin extends ServerPlugin { * in case the system is in maintenance mode. * * @return bool + * @throws \Exception */ public function emitListener() { - $this->dispatcher->dispatch('OC\Connector\Sabre::beforeMethod'); + $event = new SabrePluginEvent(); + + $this->dispatcher->dispatch('OC\Connector\Sabre::beforeMethod', $event); + + if ($event->getStatusCode() !== Http::STATUS_OK) { + throw new SabrePluginException($event->getMessage(), $event->getStatusCode()); + } return true; } diff --git a/lib/public/sabrepluginevent.php b/lib/public/sabrepluginevent.php new file mode 100644 index 00000000000..581113a42ea --- /dev/null +++ b/lib/public/sabrepluginevent.php @@ -0,0 +1,72 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see + * + */ + +namespace OCP; + + +use OCP\AppFramework\Http; +use Symfony\Component\EventDispatcher\Event; + +class SabrePluginEvent extends Event { + + /** @var int */ + protected $statusCode; + + /** @var string */ + protected $message; + + public function __construct() { + $this->message = ''; + $this->statusCode = Http::STATUS_OK; + } + + /** + * @param int $statusCode + * @return self + */ + public function setStatusCode($statusCode) { + $this->statusCode = (int) $statusCode; + return $this; + } + + /** + * @param string $message + * @return self + */ + public function setMessage($message) { + $this->message = (string) $message; + return $this; + } + + /** + * @return int + */ + public function getStatusCode() { + return $this->statusCode; + } + + /** + * @return string + */ + public function getMessage() { + return $this->message; + } +} diff --git a/lib/public/sabrepluginexception.php b/lib/public/sabrepluginexception.php new file mode 100644 index 00000000000..2aa4c688802 --- /dev/null +++ b/lib/public/sabrepluginexception.php @@ -0,0 +1,37 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see + * + */ + +namespace OCP; + + +use Sabre\DAV\Exception; + +class SabrePluginException extends Exception { + + /** + * Returns the HTTP statuscode for this exception + * + * @return int + */ + public function getHTTPCode() { + return $this->code; + } +} -- cgit v1.2.3 From 2c00587b5d2930f867cd74b6d9c0c7d696f1d61a Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Wed, 23 Sep 2015 16:15:56 +0200 Subject: Add since-tag --- lib/public/sabrepluginevent.php | 10 ++++++++++ lib/public/sabrepluginexception.php | 4 ++++ 2 files changed, 14 insertions(+) (limited to 'lib') diff --git a/lib/public/sabrepluginevent.php b/lib/public/sabrepluginevent.php index 581113a42ea..fed3237166d 100644 --- a/lib/public/sabrepluginevent.php +++ b/lib/public/sabrepluginevent.php @@ -25,6 +25,9 @@ namespace OCP; use OCP\AppFramework\Http; use Symfony\Component\EventDispatcher\Event; +/** + * @since 8.2.0 + */ class SabrePluginEvent extends Event { /** @var int */ @@ -33,6 +36,9 @@ class SabrePluginEvent extends Event { /** @var string */ protected $message; + /** + * @since 8.2.0 + */ public function __construct() { $this->message = ''; $this->statusCode = Http::STATUS_OK; @@ -41,6 +47,7 @@ class SabrePluginEvent extends Event { /** * @param int $statusCode * @return self + * @since 8.2.0 */ public function setStatusCode($statusCode) { $this->statusCode = (int) $statusCode; @@ -50,6 +57,7 @@ class SabrePluginEvent extends Event { /** * @param string $message * @return self + * @since 8.2.0 */ public function setMessage($message) { $this->message = (string) $message; @@ -58,6 +66,7 @@ class SabrePluginEvent extends Event { /** * @return int + * @since 8.2.0 */ public function getStatusCode() { return $this->statusCode; @@ -65,6 +74,7 @@ class SabrePluginEvent extends Event { /** * @return string + * @since 8.2.0 */ public function getMessage() { return $this->message; diff --git a/lib/public/sabrepluginexception.php b/lib/public/sabrepluginexception.php index 2aa4c688802..5dba3b90a02 100644 --- a/lib/public/sabrepluginexception.php +++ b/lib/public/sabrepluginexception.php @@ -24,12 +24,16 @@ namespace OCP; use Sabre\DAV\Exception; +/** + * @since 8.2.0 + */ class SabrePluginException extends Exception { /** * Returns the HTTP statuscode for this exception * * @return int + * @since 8.2.0 */ public function getHTTPCode() { return $this->code; -- cgit v1.2.3