nextcloud / server

lib/private/AppFramework/Http/Dispatcher.php

Indentation +137 added lines, -137 removed lines

@@ -43,142 +43,142 @@
  */
 class Dispatcher {
 
-	private $middlewareDispatcher;
-	private $protocol;
-	private $reflector;
-	private $request;
-
-	/**
-	 * @param Http $protocol the http protocol with contains all status headers
-	 * @param MiddlewareDispatcher $middlewareDispatcher the dispatcher which
-	 * runs the middleware
-	 * @param ControllerMethodReflector $reflector the reflector that is used to inject
-	 * the arguments for the controller
-	 * @param IRequest $request the incoming request
-	 */
-	public function __construct(Http $protocol,
-								MiddlewareDispatcher $middlewareDispatcher,
-								ControllerMethodReflector $reflector,
-								IRequest $request) {
-		$this->protocol = $protocol;
-		$this->middlewareDispatcher = $middlewareDispatcher;
-		$this->reflector = $reflector;
-		$this->request = $request;
-	}
-
-
-	/**
-	 * Handles a request and calls the dispatcher on the controller
-	 * @param Controller $controller the controller which will be called
-	 * @param string $methodName the method name which will be called on
-	 * the controller
-	 * @return array $array[0] contains a string with the http main header,
-	 * $array[1] contains headers in the form: $key => value, $array[2] contains
-	 * the response output
-	 * @throws \Exception
-	 */
-	public function dispatch(Controller $controller, $methodName) {
-		$out = array(null, array(), null);
-
-		try {
-			// prefill reflector with everything thats needed for the
-			// middlewares
-			$this->reflector->reflect($controller, $methodName);
-
-			$this->middlewareDispatcher->beforeController($controller,
-				$methodName);
-			$response = $this->executeController($controller, $methodName);
-
-			// if an exception appears, the middleware checks if it can handle the
-			// exception and creates a response. If no response is created, it is
-			// assumed that theres no middleware who can handle it and the error is
-			// thrown again
-		} catch(\Exception $exception){
-			$response = $this->middlewareDispatcher->afterException(
-				$controller, $methodName, $exception);
-			if (is_null($response)) {
-				throw $exception;
-			}
-		}
-
-		$response = $this->middlewareDispatcher->afterController(
-			$controller, $methodName, $response);
-
-		// depending on the cache object the headers need to be changed
-		$out[0] = $this->protocol->getStatusHeader($response->getStatus(),
-			$response->getLastModified(), $response->getETag());
-		$out[1] = array_merge($response->getHeaders());
-		$out[2] = $response->getCookies();
-		$out[3] = $this->middlewareDispatcher->beforeOutput(
-			$controller, $methodName, $response->render()
-		);
-		$out[4] = $response;
-
-		return $out;
-	}
-
-
-	/**
-	 * Uses the reflected parameters, types and request parameters to execute
-	 * the controller
-	 * @param Controller $controller the controller to be executed
-	 * @param string $methodName the method on the controller that should be executed
-	 * @return Response
-	 */
-	private function executeController($controller, $methodName) {
-		$arguments = array();
-
-		// valid types that will be casted
-		$types = array('int', 'integer', 'bool', 'boolean', 'float');
-
-		foreach($this->reflector->getParameters() as $param => $default) {
-
-			// try to get the parameter from the request object and cast
-			// it to the type annotated in the @param annotation
-			$value = $this->request->getParam($param, $default);
-			$type = $this->reflector->getType($param);
-
-			// if this is submitted using GET or a POST form, 'false' should be
-			// converted to false
-			if(($type === 'bool' || $type === 'boolean') &&
-				$value === 'false' &&
-				(
-					$this->request->method === 'GET' ||
-					strpos($this->request->getHeader('Content-Type'),
-						'application/x-www-form-urlencoded') !== false
-				)
-			) {
-				$value = false;
-
-			} elseif($value !== null && in_array($type, $types)) {
-				settype($value, $type);
-			}
-
-			$arguments[] = $value;
-		}
-
-		$response = call_user_func_array(array($controller, $methodName), $arguments);
-
-		// format response
-		if($response instanceof DataResponse || !($response instanceof Response)) {
-
-			// get format from the url format or request format parameter
-			$format = $this->request->getParam('format');
-
-			// if none is given try the first Accept header
-			if($format === null) {
-				$headers = $this->request->getHeader('Accept');
-				$format = $controller->getResponderByHTTPHeader($headers, null);
-			}
-
-			if ($format !== null) {
-				$response = $controller->buildResponse($response, $format);
-			} else {
-				$response = $controller->buildResponse($response);
-			}
-		}
-
-		return $response;
-	}
+    private $middlewareDispatcher;
+    private $protocol;
+    private $reflector;
+    private $request;
+
+    /**
+     * @param Http $protocol the http protocol with contains all status headers
+     * @param MiddlewareDispatcher $middlewareDispatcher the dispatcher which
+     * runs the middleware
+     * @param ControllerMethodReflector $reflector the reflector that is used to inject
+     * the arguments for the controller
+     * @param IRequest $request the incoming request
+     */
+    public function __construct(Http $protocol,
+                                MiddlewareDispatcher $middlewareDispatcher,
+                                ControllerMethodReflector $reflector,
+                                IRequest $request) {
+        $this->protocol = $protocol;
+        $this->middlewareDispatcher = $middlewareDispatcher;
+        $this->reflector = $reflector;
+        $this->request = $request;
+    }
+
+
+    /**
+     * Handles a request and calls the dispatcher on the controller
+     * @param Controller $controller the controller which will be called
+     * @param string $methodName the method name which will be called on
+     * the controller
+     * @return array $array[0] contains a string with the http main header,
+     * $array[1] contains headers in the form: $key => value, $array[2] contains
+     * the response output
+     * @throws \Exception
+     */
+    public function dispatch(Controller $controller, $methodName) {
+        $out = array(null, array(), null);
+
+        try {
+            // prefill reflector with everything thats needed for the
+            // middlewares
+            $this->reflector->reflect($controller, $methodName);
+
+            $this->middlewareDispatcher->beforeController($controller,
+                $methodName);
+            $response = $this->executeController($controller, $methodName);
+
+            // if an exception appears, the middleware checks if it can handle the
+            // exception and creates a response. If no response is created, it is
+            // assumed that theres no middleware who can handle it and the error is
+            // thrown again
+        } catch(\Exception $exception){
+            $response = $this->middlewareDispatcher->afterException(
+                $controller, $methodName, $exception);
+            if (is_null($response)) {
+                throw $exception;
+            }
+        }
+
+        $response = $this->middlewareDispatcher->afterController(
+            $controller, $methodName, $response);
+
+        // depending on the cache object the headers need to be changed
+        $out[0] = $this->protocol->getStatusHeader($response->getStatus(),
+            $response->getLastModified(), $response->getETag());
+        $out[1] = array_merge($response->getHeaders());
+        $out[2] = $response->getCookies();
+        $out[3] = $this->middlewareDispatcher->beforeOutput(
+            $controller, $methodName, $response->render()
+        );
+        $out[4] = $response;
+
+        return $out;
+    }
+
+
+    /**
+     * Uses the reflected parameters, types and request parameters to execute
+     * the controller
+     * @param Controller $controller the controller to be executed
+     * @param string $methodName the method on the controller that should be executed
+     * @return Response
+     */
+    private function executeController($controller, $methodName) {
+        $arguments = array();
+
+        // valid types that will be casted
+        $types = array('int', 'integer', 'bool', 'boolean', 'float');
+
+        foreach($this->reflector->getParameters() as $param => $default) {
+
+            // try to get the parameter from the request object and cast
+            // it to the type annotated in the @param annotation
+            $value = $this->request->getParam($param, $default);
+            $type = $this->reflector->getType($param);
+
+            // if this is submitted using GET or a POST form, 'false' should be
+            // converted to false
+            if(($type === 'bool' || $type === 'boolean') &&
+                $value === 'false' &&
+                (
+                    $this->request->method === 'GET' ||
+                    strpos($this->request->getHeader('Content-Type'),
+                        'application/x-www-form-urlencoded') !== false
+                )
+            ) {
+                $value = false;
+
+            } elseif($value !== null && in_array($type, $types)) {
+                settype($value, $type);
+            }
+
+            $arguments[] = $value;
+        }
+
+        $response = call_user_func_array(array($controller, $methodName), $arguments);
+
+        // format response
+        if($response instanceof DataResponse || !($response instanceof Response)) {
+
+            // get format from the url format or request format parameter
+            $format = $this->request->getParam('format');
+
+            // if none is given try the first Accept header
+            if($format === null) {
+                $headers = $this->request->getHeader('Accept');
+                $format = $controller->getResponderByHTTPHeader($headers, null);
+            }
+
+            if ($format !== null) {
+                $response = $controller->buildResponse($response, $format);
+            } else {
+                $response = $controller->buildResponse($response);
+            }
+        }
+
+        return $response;
+    }
 
 }

lib/private/AppFramework/Middleware/Security/CORSMiddleware.php

Indentation +102 added lines, -102 removed lines

@@ -45,116 +45,116 @@
  * https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS
  */
 class CORSMiddleware extends Middleware {
-	/** @var IRequest  */
-	private $request;
-	/** @var ControllerMethodReflector */
-	private $reflector;
-	/** @var Session */
-	private $session;
-	/** @var Throttler */
-	private $throttler;
+    /** @var IRequest  */
+    private $request;
+    /** @var ControllerMethodReflector */
+    private $reflector;
+    /** @var Session */
+    private $session;
+    /** @var Throttler */
+    private $throttler;
 
-	/**
-	 * @param IRequest $request
-	 * @param ControllerMethodReflector $reflector
-	 * @param Session $session
-	 * @param Throttler $throttler
-	 */
-	public function __construct(IRequest $request,
-								ControllerMethodReflector $reflector,
-								Session $session,
-								Throttler $throttler) {
-		$this->request = $request;
-		$this->reflector = $reflector;
-		$this->session = $session;
-		$this->throttler = $throttler;
-	}
+    /**
+     * @param IRequest $request
+     * @param ControllerMethodReflector $reflector
+     * @param Session $session
+     * @param Throttler $throttler
+     */
+    public function __construct(IRequest $request,
+                                ControllerMethodReflector $reflector,
+                                Session $session,
+                                Throttler $throttler) {
+        $this->request = $request;
+        $this->reflector = $reflector;
+        $this->session = $session;
+        $this->throttler = $throttler;
+    }
 
-	/**
-	 * 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
-	 * @throws SecurityException
-	 * @since 6.0.0
-	 */
-	public function beforeController($controller, $methodName){
-		// ensure that @CORS annotated API routes are not used in conjunction
-		// with session authentication since this enables CSRF attack vectors
-		if ($this->reflector->hasAnnotation('CORS') &&
-			!$this->reflector->hasAnnotation('PublicPage'))  {
-			$user = $this->request->server['PHP_AUTH_USER'];
-			$pass = $this->request->server['PHP_AUTH_PW'];
+    /**
+     * 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
+     * @throws SecurityException
+     * @since 6.0.0
+     */
+    public function beforeController($controller, $methodName){
+        // ensure that @CORS annotated API routes are not used in conjunction
+        // with session authentication since this enables CSRF attack vectors
+        if ($this->reflector->hasAnnotation('CORS') &&
+            !$this->reflector->hasAnnotation('PublicPage'))  {
+            $user = $this->request->server['PHP_AUTH_USER'];
+            $pass = $this->request->server['PHP_AUTH_PW'];
 
-			$this->session->logout();
-			try {
-				if (!$this->session->logClientIn($user, $pass, $this->request, $this->throttler)) {
-					throw new SecurityException('CORS requires basic auth', Http::STATUS_UNAUTHORIZED);
-				}
-			} catch (PasswordLoginForbiddenException $ex) {
-				throw new SecurityException('Password login forbidden, use token instead', Http::STATUS_UNAUTHORIZED);
-			}
-		}
-	}
+            $this->session->logout();
+            try {
+                if (!$this->session->logClientIn($user, $pass, $this->request, $this->throttler)) {
+                    throw new SecurityException('CORS requires basic auth', Http::STATUS_UNAUTHORIZED);
+                }
+            } catch (PasswordLoginForbiddenException $ex) {
+                throw new SecurityException('Password login forbidden, use token instead', Http::STATUS_UNAUTHORIZED);
+            }
+        }
+    }
 
-	/**
-	 * This is being run after a successful controllermethod 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
-	 * @throws SecurityException
-	 */
-	public function afterController($controller, $methodName, Response $response){
-		// only react if its a CORS request and if the request sends origin and
+    /**
+     * This is being run after a successful controllermethod 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
+     * @throws SecurityException
+     */
+    public function afterController($controller, $methodName, Response $response){
+        // only react if its a CORS request and if the request sends origin and
 
-		if(isset($this->request->server['HTTP_ORIGIN']) &&
-			$this->reflector->hasAnnotation('CORS')) {
+        if(isset($this->request->server['HTTP_ORIGIN']) &&
+            $this->reflector->hasAnnotation('CORS')) {
 
-			// allow credentials headers must not be true or CSRF is possible
-			// otherwise
-			foreach($response->getHeaders() as $header => $value) {
-				if(strtolower($header) === 'access-control-allow-credentials' &&
-				   strtolower(trim($value)) === 'true') {
-					$msg = 'Access-Control-Allow-Credentials must not be '.
-						   'set to true in order to prevent CSRF';
-					throw new SecurityException($msg);
-				}
-			}
+            // allow credentials headers must not be true or CSRF is possible
+            // otherwise
+            foreach($response->getHeaders() as $header => $value) {
+                if(strtolower($header) === 'access-control-allow-credentials' &&
+                   strtolower(trim($value)) === 'true') {
+                    $msg = 'Access-Control-Allow-Credentials must not be '.
+                            'set to true in order to prevent CSRF';
+                    throw new SecurityException($msg);
+                }
+            }
 
-			$origin = $this->request->server['HTTP_ORIGIN'];
-			$response->addHeader('Access-Control-Allow-Origin', $origin);
-		}
-		return $response;
-	}
+            $origin = $this->request->server['HTTP_ORIGIN'];
+            $response->addHeader('Access-Control-Allow-Origin', $origin);
+        }
+        return $response;
+    }
 
-	/**
-	 * If an SecurityException is being caught return a JSON error response
-	 *
-	 * @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 can't handle it
-	 * @return Response a Response object or null in case that the exception could not be handled
-	 */
-	public function afterException($controller, $methodName, \Exception $exception){
-		if($exception instanceof SecurityException){
-			$response =  new JSONResponse(['message' => $exception->getMessage()]);
-			if($exception->getCode() !== 0) {
-				$response->setStatus($exception->getCode());
-			} else {
-				$response->setStatus(Http::STATUS_INTERNAL_SERVER_ERROR);
-			}
-			return $response;
-		}
+    /**
+     * If an SecurityException is being caught return a JSON error response
+     *
+     * @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 can't handle it
+     * @return Response a Response object or null in case that the exception could not be handled
+     */
+    public function afterException($controller, $methodName, \Exception $exception){
+        if($exception instanceof SecurityException){
+            $response =  new JSONResponse(['message' => $exception->getMessage()]);
+            if($exception->getCode() !== 0) {
+                $response->setStatus($exception->getCode());
+            } else {
+                $response->setStatus(Http::STATUS_INTERNAL_SERVER_ERROR);
+            }
+            return $response;
+        }
 
-		throw $exception;
-	}
+        throw $exception;
+    }
 
 }

lib/private/AppFramework/Middleware/Security/Exceptions/NotConfirmedException.php

Indentation +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@
  * @package OC\AppFramework\Middleware\Security\Exceptions
  */
 class NotConfirmedException extends SecurityException {
-	public function __construct() {
-		parent::__construct('Password confirmation is required', Http::STATUS_FORBIDDEN);
-	}
+    public function __construct() {
+        parent::__construct('Password confirmation is required', Http::STATUS_FORBIDDEN);
+    }
 }

lib/private/AppFramework/Middleware/Security/Exceptions/CrossSiteRequestForgeryException.php

Indentation +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@
  * @package OC\AppFramework\Middleware\Security\Exceptions
  */
 class CrossSiteRequestForgeryException extends SecurityException {
-	public function __construct() {
-		parent::__construct('CSRF check failed', Http::STATUS_PRECONDITION_FAILED);
-	}
+    public function __construct() {
+        parent::__construct('CSRF check failed', Http::STATUS_PRECONDITION_FAILED);
+    }
 }

lib/private/AppFramework/Middleware/Security/Exceptions/AppNotEnabledException.php

Indentation +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@
  * @package OC\AppFramework\Middleware\Security\Exceptions
  */
 class AppNotEnabledException extends SecurityException {
-	public function __construct() {
-		parent::__construct('App is not enabled', Http::STATUS_PRECONDITION_FAILED);
-	}
+    public function __construct() {
+        parent::__construct('App is not enabled', Http::STATUS_PRECONDITION_FAILED);
+    }
 }

lib/private/AppFramework/Middleware/Security/Exceptions/NotAdminException.php

Indentation +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@
  * @package OC\AppFramework\Middleware\Security\Exceptions
  */
 class NotAdminException extends SecurityException {
-	public function __construct($message = 'Logged in user must be an admin') {
-		parent::__construct($message, Http::STATUS_FORBIDDEN);
-	}
+    public function __construct($message = 'Logged in user must be an admin') {
+        parent::__construct($message, Http::STATUS_FORBIDDEN);
+    }
 }

lib/private/AppFramework/Middleware/Security/Exceptions/NotLoggedInException.php

Indentation +3 added lines, -3 removed lines

@@ -34,7 +34,7 @@
  * @package OC\AppFramework\Middleware\Security\Exceptions
  */
 class NotLoggedInException extends SecurityException {
-	public function __construct() {
-		parent::__construct('Current user is not logged in', Http::STATUS_UNAUTHORIZED);
-	}
+    public function __construct() {
+        parent::__construct('Current user is not logged in', Http::STATUS_UNAUTHORIZED);
+    }
 }

lib/private/AppFramework/Middleware/MiddlewareDispatcher.php

Indentation +123 added lines, -123 removed lines

@@ -37,128 +37,128 @@
  */
 class MiddlewareDispatcher {
 
-	/**
-	 * @var array array containing all the middlewares
-	 */
-	private $middlewares;
-
-	/**
-	 * @var int counter which tells us what middlware was executed once an
-	 *                  exception occurs
-	 */
-	private $middlewareCounter;
-
-
-	/**
-	 * Constructor
-	 */
-	public function __construct(){
-		$this->middlewares = array();
-		$this->middlewareCounter = 0;
-	}
-
-
-	/**
-	 * Adds a new middleware
-	 * @param Middleware $middleWare the middleware which will be added
-	 */
-	public function registerMiddleware(Middleware $middleWare){
-		array_push($this->middlewares, $middleWare);
-	}
-
-
-	/**
-	 * returns an array with all middleware elements
-	 * @return array the middlewares
-	 */
-	public function getMiddlewares(){
-		return $this->middlewares;
-	}
-
-
-	/**
-	 * 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
-	 */
-	public function beforeController(Controller $controller, $methodName){
-		// we need to count so that we know which middlewares we have to ask in
-		// case there is an exception
-		$middlewareCount = count($this->middlewares);
-		for($i = 0; $i < $middlewareCount; $i++){
-			$this->middlewareCounter++;
-			$middleware = $this->middlewares[$i];
-			$middleware->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
-	 * @return Response a Response object if the middleware can handle the
-	 * exception
-	 * @throws \Exception the passed in exception if it can't handle it
-	 */
-	public function afterException(Controller $controller, $methodName, \Exception $exception){
-		for($i=$this->middlewareCounter-1; $i>=0; $i--){
-			$middleware = $this->middlewares[$i];
-			try {
-				return $middleware->afterException($controller, $methodName, $exception);
-			} catch(\Exception $exception){
-				continue;
-			}
-		}
-		throw $exception;
-	}
-
-
-	/**
-	 * This is being run after a successful controllermethod 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
-	 */
-	public function afterController(Controller $controller, $methodName, Response $response){
-		for($i=count($this->middlewares)-1; $i>=0; $i--){
-			$middleware = $this->middlewares[$i];
-			$response = $middleware->afterController($controller, $methodName, $response);
-		}
-		return $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
-	 */
-	public function beforeOutput(Controller $controller, $methodName, $output){
-		for($i=count($this->middlewares)-1; $i>=0; $i--){
-			$middleware = $this->middlewares[$i];
-			$output = $middleware->beforeOutput($controller, $methodName, $output);
-		}
-		return $output;
-	}
+    /**
+     * @var array array containing all the middlewares
+     */
+    private $middlewares;
+
+    /**
+     * @var int counter which tells us what middlware was executed once an
+     *                  exception occurs
+     */
+    private $middlewareCounter;
+
+
+    /**
+     * Constructor
+     */
+    public function __construct(){
+        $this->middlewares = array();
+        $this->middlewareCounter = 0;
+    }
+
+
+    /**
+     * Adds a new middleware
+     * @param Middleware $middleWare the middleware which will be added
+     */
+    public function registerMiddleware(Middleware $middleWare){
+        array_push($this->middlewares, $middleWare);
+    }
+
+
+    /**
+     * returns an array with all middleware elements
+     * @return array the middlewares
+     */
+    public function getMiddlewares(){
+        return $this->middlewares;
+    }
+
+
+    /**
+     * 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
+     */
+    public function beforeController(Controller $controller, $methodName){
+        // we need to count so that we know which middlewares we have to ask in
+        // case there is an exception
+        $middlewareCount = count($this->middlewares);
+        for($i = 0; $i < $middlewareCount; $i++){
+            $this->middlewareCounter++;
+            $middleware = $this->middlewares[$i];
+            $middleware->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
+     * @return Response a Response object if the middleware can handle the
+     * exception
+     * @throws \Exception the passed in exception if it can't handle it
+     */
+    public function afterException(Controller $controller, $methodName, \Exception $exception){
+        for($i=$this->middlewareCounter-1; $i>=0; $i--){
+            $middleware = $this->middlewares[$i];
+            try {
+                return $middleware->afterException($controller, $methodName, $exception);
+            } catch(\Exception $exception){
+                continue;
+            }
+        }
+        throw $exception;
+    }
+
+
+    /**
+     * This is being run after a successful controllermethod 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
+     */
+    public function afterController(Controller $controller, $methodName, Response $response){
+        for($i=count($this->middlewares)-1; $i>=0; $i--){
+            $middleware = $this->middlewares[$i];
+            $response = $middleware->afterController($controller, $methodName, $response);
+        }
+        return $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
+     */
+    public function beforeOutput(Controller $controller, $methodName, $output){
+        for($i=count($this->middlewares)-1; $i>=0; $i--){
+            $middleware = $this->middlewares[$i];
+            $output = $middleware->beforeOutput($controller, $methodName, $output);
+        }
+        return $output;
+    }
 
 }

lib/private/AppFramework/OCS/BaseResponse.php

Indentation +56 added lines, -56 removed lines

@@ -27,70 +27,70 @@
 use OCP\AppFramework\Http\Response;
 
 abstract class BaseResponse extends Response   {
-	/** @var array */
-	protected $data;
+    /** @var array */
+    protected $data;
 
-	/** @var string */
-	protected $format;
+    /** @var string */
+    protected $format;
 
-	/** @var string */
-	protected $statusMessage;
+    /** @var string */
+    protected $statusMessage;
 
-	/** @var int */
-	protected $itemsCount;
+    /** @var int */
+    protected $itemsCount;
 
-	/** @var int */
-	protected $itemsPerPage;
+    /** @var int */
+    protected $itemsPerPage;
 
-	/**
-	 * BaseResponse constructor.
-	 *
-	 * @param DataResponse|null $dataResponse
-	 * @param string $format
-	 * @param string|null $statusMessage
-	 * @param int|null $itemsCount
-	 * @param int|null $itemsPerPage
-	 */
-	public function __construct(DataResponse $dataResponse,
-								$format = 'xml',
-								$statusMessage = null,
-								$itemsCount = null,
-								$itemsPerPage = null) {
-		$this->format = $format;
-		$this->statusMessage = $statusMessage;
-		$this->itemsCount = $itemsCount;
-		$this->itemsPerPage = $itemsPerPage;
+    /**
+     * BaseResponse constructor.
+     *
+     * @param DataResponse|null $dataResponse
+     * @param string $format
+     * @param string|null $statusMessage
+     * @param int|null $itemsCount
+     * @param int|null $itemsPerPage
+     */
+    public function __construct(DataResponse $dataResponse,
+                                $format = 'xml',
+                                $statusMessage = null,
+                                $itemsCount = null,
+                                $itemsPerPage = null) {
+        $this->format = $format;
+        $this->statusMessage = $statusMessage;
+        $this->itemsCount = $itemsCount;
+        $this->itemsPerPage = $itemsPerPage;
 
-		$this->data = $dataResponse->getData();
+        $this->data = $dataResponse->getData();
 
-		$this->setHeaders($dataResponse->getHeaders());
-		$this->setStatus($dataResponse->getStatus());
-		$this->setETag($dataResponse->getETag());
-		$this->setLastModified($dataResponse->getLastModified());
-		$this->setCookies($dataResponse->getCookies());
-		$this->setContentSecurityPolicy(new EmptyContentSecurityPolicy());
+        $this->setHeaders($dataResponse->getHeaders());
+        $this->setStatus($dataResponse->getStatus());
+        $this->setETag($dataResponse->getETag());
+        $this->setLastModified($dataResponse->getLastModified());
+        $this->setCookies($dataResponse->getCookies());
+        $this->setContentSecurityPolicy(new EmptyContentSecurityPolicy());
 
-		if ($format === 'json') {
-			$this->addHeader(
-				'Content-Type', 'application/json; charset=utf-8'
-			);
-		} else {
-			$this->addHeader(
-				'Content-Type', 'application/xml; charset=utf-8'
-			);
-		}
-	}
+        if ($format === 'json') {
+            $this->addHeader(
+                'Content-Type', 'application/json; charset=utf-8'
+            );
+        } else {
+            $this->addHeader(
+                'Content-Type', 'application/xml; charset=utf-8'
+            );
+        }
+    }
 
-	/**
-	 * @param string[] $meta
-	 * @return string
-	 */
-	protected function renderResult($meta) {
-		// TODO rewrite functions
-		return \OC_API::renderResult($this->format, $meta, $this->data);
-	}
+    /**
+     * @param string[] $meta
+     * @return string
+     */
+    protected function renderResult($meta) {
+        // TODO rewrite functions
+        return \OC_API::renderResult($this->format, $meta, $this->data);
+    }
 
-	public function getOCSStatus() {
-		return parent::getStatus();
-	}
+    public function getOCSStatus() {
+        return parent::getStatus();
+    }
 }