introduce SessionMiddleWare to control session handling via an annotation

diff --git a/lib/private/appframework/dependencyinjection/dicontainer.php b/lib/private/appframework/dependencyinjection/dicontainer.php
index e7efa3fa219a73ce64aaba5676716141014a54b7..f7fee347215cf6f92b2288699eb4cf5acb2c595c 100644 (file)
--- a/lib/private/appframework/dependencyinjection/dicontainer.php
+++ b/lib/private/appframework/dependencyinjection/dicontainer.php
@@ -31,6 +31,7 @@ use OC\AppFramework\Core\API;
 use OC\AppFramework\Middleware\MiddlewareDispatcher;
 use OC\AppFramework\Middleware\Security\SecurityMiddleware;
 use OC\AppFramework\Middleware\Security\CORSMiddleware;
+use OC\AppFramework\Middleware\SessionMiddleware;
 use OC\AppFramework\Utility\SimpleContainer;
 use OC\AppFramework\Utility\TimeFactory;
 use OC\AppFramework\Utility\ControllerMethodReflector;
@@ -67,9 +68,10 @@ class DIContainer extends SimpleContainer implements IAppContainer{
                 */
                $this['Request'] = $this->share(function($c) {
                        /** @var $c SimpleContainer */
-                       /** @var $server IServerContainer */
+                       /** @var $server SimpleContainer */
                        $server = $c->query('ServerContainer');
                        $server->registerParameter('urlParams', $c['urlParams']);
+                       /** @var $server IServerContainer */
                        return $server->getRequest();
                });
 
@@ -115,6 +117,14 @@ class DIContainer extends SimpleContainer implements IAppContainer{
                        );
                });
 
+               $this['SessionMiddleware'] = $this->share(function($c) use ($app) {
+                       return new SessionMiddleware(
+                               $c['Request'],
+                               $c['ControllerMethodReflector'],
+                               $app->getServer()->getSession()
+                       );
+               });
+
                $middleWares = &$this->middleWares;
                $this['MiddlewareDispatcher'] = $this->share(function($c) use (&$middleWares) {
                        $dispatcher = new MiddlewareDispatcher();
@@ -125,6 +135,7 @@ class DIContainer extends SimpleContainer implements IAppContainer{
                                $dispatcher->registerMiddleware($c[$middleWare]);
                        }
 
+                       $dispatcher->registerMiddleware($c['SessionMiddleware']);
                        return $dispatcher;
                });
 

diff --git a/lib/private/appframework/middleware/sessionmiddleware.php b/lib/private/appframework/middleware/sessionmiddleware.php
new file mode 100644 (file)
index 0000000..d50880f
--- /dev/null
+++ b/lib/private/appframework/middleware/sessionmiddleware.php
@@ -0,0 +1,70 @@
+<?php
+/**
+ * ownCloud - App Framework
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Thomas Müller <deepdiver@owncloud.com>
+ * @copyright Thomas Müller 2014
+ */
+
+namespace OC\AppFramework\Middleware;
+
+use OC\AppFramework\Utility\ControllerMethodReflector;
+use OCP\IRequest;
+use OCP\AppFramework\Http\Response;
+use OCP\AppFramework\Middleware;
+use OCP\ISession;
+
+class SessionMiddleware extends Middleware {
+
+       /**
+        * @var IRequest
+        */
+       private $request;
+
+       /**
+        * @var ControllerMethodReflector
+        */
+       private $reflector;
+
+       /**
+        * @param IRequest $request
+        * @param ControllerMethodReflector $reflector
+        */
+       public function __construct(IRequest $request,
+                                                               ControllerMethodReflector $reflector,
+                                                               ISession $session
+) {
+               $this->request = $request;
+               $this->reflector = $reflector;
+               $this->session = $session;
+       }
+
+       /**
+        * @param \OCP\AppFramework\Controller $controller
+        * @param string $methodName
+        */
+       public function beforeController($controller, $methodName) {
+               $useSession = $this->reflector->hasAnnotation('UseSession');
+               if (!$useSession) {
+                       $this->session->close();
+               }
+       }
+
+       /**
+        * @param \OCP\AppFramework\Controller $controller
+        * @param string $methodName
+        * @param Response $response
+        * @return Response
+        */
+       public function afterController($controller, $methodName, Response $response){
+               $useSession = $this->reflector->hasAnnotation('UseSession');
+               if ($useSession) {
+                       $this->session->close();
+               }
+               return $response;
+       }
+
+}

diff --git a/tests/lib/appframework/middleware/sessionmiddlewaretest.php b/tests/lib/appframework/middleware/sessionmiddlewaretest.php
new file mode 100644 (file)
index 0000000..13e558b
--- /dev/null
+++ b/tests/lib/appframework/middleware/sessionmiddlewaretest.php
@@ -0,0 +1,89 @@
+<?php
+/**
+ * ownCloud - App Framework
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Thomas Müller <deepdiver@owncloud.com>
+ * @copyright Thomas Müller 2014
+ */
+
+
+namespace OC\AppFramework\Middleware\Security;
+
+use OC\AppFramework\Http\Request;
+use OC\AppFramework\Middleware\SessionMiddleware;
+use OC\AppFramework\Utility\ControllerMethodReflector;
+use OCP\AppFramework\Http\Response;
+
+
+class SessionMiddlewareTest extends \PHPUnit_Framework_TestCase {
+
+       /**
+        * @var ControllerMethodReflector
+        */
+       private $reflector;
+
+       /**
+        * @var Request
+        */
+       private $request;
+
+       protected function setUp() {
+               $this->request = new Request();
+               $this->reflector = new ControllerMethodReflector();
+       }
+
+       /**
+        * @UseSession
+        */
+       public function testSessionNotClosedOnBeforeController() {
+               $session = $this->getSessionMock(0);
+
+               $this->reflector->reflect($this, __FUNCTION__);
+               $middleware = new SessionMiddleware($this->request, $this->reflector, $session);
+               $middleware->beforeController($this, __FUNCTION__);
+       }
+
+       /**
+        * @UseSession
+        */
+       public function testSessionClosedOnAfterController() {
+               $session = $this->getSessionMock(1);
+
+               $this->reflector->reflect($this, __FUNCTION__);
+               $middleware = new SessionMiddleware($this->request, $this->reflector, $session);
+               $middleware->afterController($this, __FUNCTION__, new Response());
+       }
+
+       public function testSessionClosedOnBeforeController() {
+               $session = $this->getSessionMock(1);
+
+               $this->reflector->reflect($this, __FUNCTION__);
+               $middleware = new SessionMiddleware($this->request, $this->reflector, $session);
+               $middleware->beforeController($this, __FUNCTION__);
+       }
+
+       public function testSessionNotClosedOnAfterController() {
+               $session = $this->getSessionMock(0);
+
+               $this->reflector->reflect($this, __FUNCTION__);
+               $middleware = new SessionMiddleware($this->request, $this->reflector, $session);
+               $middleware->afterController($this, __FUNCTION__, new Response());
+       }
+
+       /**
+        * @return mixed
+        */
+       private function getSessionMock($expectedCloseCount) {
+               $session = $this->getMockBuilder('\OC\Session\Memory')
+                       ->disableOriginalConstructor()
+                       ->getMock();
+
+               $session->expects($this->exactly($expectedCloseCount))
+                       ->method('close');
+               return $session;
+       }
+
+}