Merge pull request #5144 from owncloud/public_middleware

Make abstract Middleware class public

lib/private/appframework/middleware/middlewaredispatcher.php

@@ -26,7 +26,7 @@ namespace OC\AppFramework\Middleware;
 
 use OC\AppFramework\Controller\Controller;
 use OCP\AppFramework\Http\Response;
-
+use OCP\AppFramework\MiddleWare;
 
 /**
  * This class is used to store and run all the middleware in correct order

lib/private/appframework/middleware/security/securitymiddleware.php

@@ -29,8 +29,8 @@ use OC\AppFramework\Http\Http;
 use OC\AppFramework\Http\Request;
 use OC\AppFramework\Http\RedirectResponse;
 use OC\AppFramework\Utility\MethodAnnotationReader;
-use OC\AppFramework\Middleware\Middleware;
 use OC\AppFramework\Core\API;
+use OCP\AppFramework\Middleware;
 use OCP\AppFramework\Http\Response;
 use OCP\AppFramework\Http\JSONResponse;
 

lib/public/appframework/imiddleware.php

@@ -1,88 +0,0 @@
-<?php
-
-/**
- * ownCloud - App Framework
- *
- * @author Bernhard Posselt
- * @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or any later version.
- *
- * This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-
-namespace OCP\AppFramework;
-use OCP\AppFramework\Http\Response;
-
-
-/**
- * Middleware is used to provide hooks before or after controller methods and
- * deal with possible exceptions raised in the controller methods.
- * They're modeled after Django's middleware system:
- * https://docs.djangoproject.com/en/dev/topics/http/middleware/
- */
-interface IMiddleWare {
-
-
-	/**
-	 * This is being run in normal order before the controller is being
-	 * called which allows several modifications and checks
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 */
-	function beforeController($controller, $methodName);
-
-
-	/**
-	 * This is being run when either the beforeController method or the
-	 * controller method itself is throwing an exception. The middleware is
-	 * asked in reverse order to handle the exception and to return a response.
-	 * If the response is null, it is assumed that the exception could not be
-	 * handled and the error will be thrown again
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param \Exception $exception the thrown exception
-	 * @throws \Exception the passed in exception if it cant handle it
-	 * @return Response a Response object in case that the exception was handled
-	 */
-	function afterException($controller, $methodName, \Exception $exception);
-
-	/**
-	 * This is being run after a successful controller method call and allows
-	 * the manipulation of a Response object. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param Response $response the generated response from the controller
-	 * @return Response a Response object
-	 */
-	function afterController($controller, $methodName, Response $response);
-
-	/**
-	 * This is being run after the response object has been rendered and
-	 * allows the manipulation of the output. The middleware is run in reverse order
-	 *
-	 * @param Controller $controller the controller that is being called
-	 * @param string $methodName the name of the method that will be called on
-	 *                           the controller
-	 * @param string $output the generated output from a response
-	 * @return string the output that should be printed
-	 */
-	function beforeOutput($controller, $methodName, $output);
-}

lib/public/appframework/middleware.php

@@ -22,7 +22,7 @@
  */
 
 
-namespace OC\AppFramework\Middleware;
+namespace OCP\AppFramework;
 
 use OCP\AppFramework\Http\Response;
 

tests/lib/appframework/middleware/MiddlewareDispatcherTest.php

@@ -25,8 +25,8 @@
 namespace OC\AppFramework;
 
 use OC\AppFramework\Http\Request;
-use OC\AppFramework\Middleware\Middleware;
 use OC\AppFramework\Middleware\MiddlewareDispatcher;
+use OCP\AppFramework\Middleware;
 use OCP\AppFramework\Http\Response;
 
 
@@ -142,12 +142,12 @@ class MiddlewareDispatcherTest extends \PHPUnit_Framework_TestCase {
 
 	public function testAfterExceptionShouldReturnResponseOfMiddleware(){
 		$response = new Response();
-		$m1 = $this->getMock('\OC\AppFramework\Middleware\Middleware',
+		$m1 = $this->getMock('\OCP\AppFramework\Middleware',
 				array('afterException', 'beforeController'));
 		$m1->expects($this->never())
 				->method('afterException');
 
-		$m2 = $this->getMock('OC\AppFramework\Middleware\Middleware',
+		$m2 = $this->getMock('OCP\AppFramework\Middleware',
 				array('afterException', 'beforeController'));
 		$m2->expects($this->once())
 				->method('afterException')
@@ -267,7 +267,7 @@ class MiddlewareDispatcherTest extends \PHPUnit_Framework_TestCase {
 	public function testExceptionShouldRunAfterExceptionOfOnlyPreviouslyExecutedMiddlewares(){
 		$m1 = $this->getMiddleware();
 		$m2 = $this->getMiddleware(true);
-		$m3 = $this->getMock('\OC\AppFramework\Middleware\Middleware');
+		$m3 = $this->getMock('\OCP\AppFramework\Middleware');
 		$m3->expects($this->never())
 				->method('afterException');
 		$m3->expects($this->never())

tests/lib/appframework/middleware/MiddlewareTest.php

@@ -25,7 +25,7 @@
 namespace OC\AppFramework;
 
 use OC\AppFramework\Http\Request;
-use OC\AppFramework\Middleware\Middleware;
+use OCP\AppFramework\Middleware;
 
 
 class ChildMiddleware extends Middleware {};