summaryrefslogtreecommitdiffstats
path: root/apps/dav
diff options
context:
space:
mode:
authorThomas Müller <thomas.mueller@tmit.eu>2016-03-24 14:29:55 +0100
committerThomas Müller <thomas.mueller@tmit.eu>2016-03-24 19:02:16 +0100
commitc46f480031856408eed09ee638da10fa495c7dad (patch)
treeaa21a6e87bdd40ee9d851f8256f82261726254ea /apps/dav
parenta7e7f5e18098ff0f536e58a7e1e5dfdc825e9086 (diff)
downloadnextcloud-server-c46f480031856408eed09ee638da10fa495c7dad.tar.gz
nextcloud-server-c46f480031856408eed09ee638da10fa495c7dad.zip
In case of exception we return an html page in case the client is a browser
Diffstat (limited to 'apps/dav')
-rw-r--r--apps/dav/lib/connector/sabre/objecttree.php6
-rw-r--r--apps/dav/lib/connector/sabre/serverfactory.php5
-rw-r--r--apps/dav/lib/files/browsererrorpageplugin.php110
-rw-r--r--apps/dav/lib/server.php5
-rw-r--r--apps/dav/templates/exception.php30
-rw-r--r--apps/dav/tests/unit/dav/browsererrorpageplugintest.php57
6 files changed, 211 insertions, 2 deletions
diff --git a/apps/dav/lib/connector/sabre/objecttree.php b/apps/dav/lib/connector/sabre/objecttree.php
index 505a42d4746..f38dfe679c7 100644
--- a/apps/dav/lib/connector/sabre/objecttree.php
+++ b/apps/dav/lib/connector/sabre/objecttree.php
@@ -102,9 +102,11 @@ class ObjectTree extends \Sabre\DAV\Tree {
* Returns the INode object for the requested path
*
* @param string $path
- * @throws \Sabre\DAV\Exception\ServiceUnavailable
- * @throws \Sabre\DAV\Exception\NotFound
* @return \Sabre\DAV\INode
+ * @throws InvalidPath
+ * @throws \Sabre\DAV\Exception\Locked
+ * @throws \Sabre\DAV\Exception\NotFound
+ * @throws \Sabre\DAV\Exception\ServiceUnavailable
*/
public function getNodeForPath($path) {
if (!$this->fileView) {
diff --git a/apps/dav/lib/connector/sabre/serverfactory.php b/apps/dav/lib/connector/sabre/serverfactory.php
index 8158db3e92a..cab7a85d19f 100644
--- a/apps/dav/lib/connector/sabre/serverfactory.php
+++ b/apps/dav/lib/connector/sabre/serverfactory.php
@@ -26,6 +26,7 @@
namespace OCA\DAV\Connector\Sabre;
+use OCA\DAV\Files\BrowserErrorPagePlugin;
use OCP\Files\Mount\IMountManager;
use OCP\IConfig;
use OCP\IDBConnection;
@@ -115,6 +116,10 @@ class ServerFactory {
$server->addPlugin(new \OCA\DAV\Connector\Sabre\FakeLockerPlugin());
}
+ if (BrowserErrorPagePlugin::isBrowserRequest($this->request)) {
+ $server->addPlugin(new BrowserErrorPagePlugin());
+ }
+
// wait with registering these until auth is handled and the filesystem is setup
$server->on('beforeMethod', function () use ($server, $objectTree, $viewCallBack) {
// ensure the skeleton is copied
diff --git a/apps/dav/lib/files/browsererrorpageplugin.php b/apps/dav/lib/files/browsererrorpageplugin.php
new file mode 100644
index 00000000000..12910955847
--- /dev/null
+++ b/apps/dav/lib/files/browsererrorpageplugin.php
@@ -0,0 +1,110 @@
+<?php
+/**
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, 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 <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\DAV\Files;
+
+use OC\AppFramework\Http\Request;
+use OC_Template;
+use OCP\IRequest;
+use Sabre\DAV\Exception;
+use Sabre\DAV\Server;
+use Sabre\DAV\ServerPlugin;
+
+class BrowserErrorPagePlugin extends ServerPlugin {
+
+ /** @var 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 Server $server
+ * @return void
+ */
+ function initialize(Server $server) {
+ $this->server = $server;
+ $server->on('exception', array($this, 'logException'), 1000);
+ }
+
+ /**
+ * @param IRequest $request
+ * @return bool
+ */
+ public static function isBrowserRequest(IRequest $request) {
+ if ($request->getMethod() !== 'GET') {
+ return false;
+ }
+ return $request->isUserAgent([Request::USER_AGENT_IE_8]);
+ }
+
+ /**
+ * @param \Exception $ex
+ */
+ public function logException(\Exception $ex) {
+ if ($ex instanceof Exception) {
+ $httpCode = $ex->getHTTPCode();
+ $headers = $ex->getHTTPHeaders($this->server);
+ } else {
+ $httpCode = 500;
+ $headers = [];
+ }
+ $this->server->httpResponse->addHeaders($headers);
+ $this->server->httpResponse->setStatus($httpCode);
+ $body = $this->generateBody($ex);
+ $this->server->httpResponse->setBody($body);
+ $this->sendResponse();
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @param \Exception $ex
+ * @param int $httpCode
+ * @return bool|string
+ */
+ public function generateBody(\Exception $exception) {
+ $request = \OC::$server->getRequest();
+ $content = new OC_Template('dav', 'exception', 'guest');
+ $content->assign('title', $this->server->httpResponse->getStatusText());
+ $content->assign('message', $exception->getMessage());
+ $content->assign('errorClass', get_class($exception));
+ $content->assign('errorMsg', $exception->getMessage());
+ $content->assign('errorCode', $exception->getCode());
+ $content->assign('file', $exception->getFile());
+ $content->assign('line', $exception->getLine());
+ $content->assign('trace', $exception->getTraceAsString());
+ $content->assign('debugMode', \OC::$server->getSystemConfig()->getValue('debug', false));
+ $content->assign('remoteAddr', $request->getRemoteAddress());
+ $content->assign('requestID', $request->getId());
+ return $content->fetchPage();
+ }
+
+ /*
+ * @codeCoverageIgnore
+ */
+ public function sendResponse() {
+ $this->server->sapi->sendResponse($this->server->httpResponse);
+ }
+}
diff --git a/apps/dav/lib/server.php b/apps/dav/lib/server.php
index e74292282a7..5336c82dfb8 100644
--- a/apps/dav/lib/server.php
+++ b/apps/dav/lib/server.php
@@ -30,6 +30,7 @@ use OCA\DAV\Connector\Sabre\BlockLegacyClientPlugin;
use OCA\DAV\Connector\Sabre\DavAclPlugin;
use OCA\DAV\Connector\Sabre\DummyGetResponsePlugin;
use OCA\DAV\Connector\Sabre\FilesPlugin;
+use OCA\DAV\Files\BrowserErrorPagePlugin;
use OCA\DAV\Files\CustomPropertiesBackend;
use OCP\IRequest;
use OCP\SabrePluginEvent;
@@ -119,6 +120,10 @@ class Server {
$this->server->addPlugin(new \OCA\DAV\Connector\Sabre\FakeLockerPlugin());
}
+ if (BrowserErrorPagePlugin::isBrowserRequest($request)) {
+ $this->server->addPlugin(new BrowserErrorPagePlugin());
+ }
+
// wait with registering these until auth is handled and the filesystem is setup
$this->server->on('beforeMethod', function () {
// custom properties plugin must be the last one
diff --git a/apps/dav/templates/exception.php b/apps/dav/templates/exception.php
new file mode 100644
index 00000000000..01c4eea4b5a
--- /dev/null
+++ b/apps/dav/templates/exception.php
@@ -0,0 +1,30 @@
+<?php
+ /** @var array $_ */
+ /** @var OC_L10N $l */
+
+style('core', ['styles', 'header']);
+?>
+<span class="error error-wide">
+ <h2><strong><?php p($_['title']) ?></strong></h2>
+ <p><?php p($_['message']) ?></p>
+ <br>
+
+ <h2><strong><?php p($l->t('Technical details')) ?></strong></h2>
+ <ul>
+ <li><?php p($l->t('Remote Address: %s', $_['remoteAddr'])) ?></li>
+ <li><?php p($l->t('Request ID: %s', $_['requestID'])) ?></li>
+ <?php if($_['debugMode']): ?>
+ <li><?php p($l->t('Type: %s', $_['errorClass'])) ?></li>
+ <li><?php p($l->t('Code: %s', $_['errorCode'])) ?></li>
+ <li><?php p($l->t('Message: %s', $_['errorMsg'])) ?></li>
+ <li><?php p($l->t('File: %s', $_['file'])) ?></li>
+ <li><?php p($l->t('Line: %s', $_['line'])) ?></li>
+ <?php endif; ?>
+ </ul>
+
+ <?php if($_['debugMode']): ?>
+ <br />
+ <h2><strong><?php p($l->t('Trace')) ?></strong></h2>
+ <pre><?php p($_['trace']) ?></pre>
+ <?php endif; ?>
+</span>
diff --git a/apps/dav/tests/unit/dav/browsererrorpageplugintest.php b/apps/dav/tests/unit/dav/browsererrorpageplugintest.php
new file mode 100644
index 00000000000..aeae0e1b152
--- /dev/null
+++ b/apps/dav/tests/unit/dav/browsererrorpageplugintest.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, 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 <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OCA\DAV\Tests\Unit\DAV;
+
+use OCA\DAV\Files\BrowserErrorPagePlugin;
+use PHPUnit_Framework_MockObject_MockObject;
+use Sabre\DAV\Exception\NotFound;
+
+class BrowserErrorPagePluginTest extends \Test\TestCase {
+
+ /**
+ * @dataProvider providesExceptions
+ * @param $expectedCode
+ * @param $exception
+ */
+ public function test($expectedCode, $exception) {
+ /** @var BrowserErrorPagePlugin | PHPUnit_Framework_MockObject_MockObject $plugin */
+ $plugin = $this->getMockBuilder('OCA\DAV\Files\BrowserErrorPagePlugin')->setMethods(['sendResponse', 'generateBody'])->getMock();
+ $plugin->expects($this->once())->method('generateBody')->willReturn(':boom:');
+ $plugin->expects($this->once())->method('sendResponse');
+ /** @var \Sabre\DAV\Server | PHPUnit_Framework_MockObject_MockObject $server */
+ $server = $this->getMockBuilder('Sabre\DAV\Server')->disableOriginalConstructor()->getMock();
+ $server->expects($this->once())->method('on');
+ $httpResponse = $this->getMockBuilder('Sabre\HTTP\Response')->disableOriginalConstructor()->getMock();
+ $httpResponse->expects($this->once())->method('addHeaders');
+ $httpResponse->expects($this->once())->method('setStatus')->with($expectedCode);
+ $httpResponse->expects($this->once())->method('setBody')->with(':boom:');
+ $server->httpResponse = $httpResponse;
+ $plugin->initialize($server);
+ $plugin->logException($exception);
+ }
+
+ public function providesExceptions() {
+ return [
+ [ 404, new NotFound()],
+ [ 500, new \RuntimeException()],
+ ];
+ }
+}