Stack compatible now. Can acts like middleware and apply middlewares as filter

Author: stas-dovgodko

lib/Exception/ExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php
+namespace wmlib\controller\Exception;
+
+class NotFoundException extends \Exception
+{
+}

lib/Exception/NotFoundException.php

@@ -0,0 +1,6 @@
+<?php
+namespace wmlib\controller\Exception;
+
+class RouteNotFoundException extends NotFoundException
+{
+}

lib/Exception/RouteNotFoundException.php

@@ -1,19 +1,92 @@
 <?php
 namespace wmlib\controller\Filter;
 
+use Symfony\Component\HttpKernel\HttpKernelInterface;
 use wmlib\controller\Filter;
 
+use wmlib\controller\Request;
 use wmlib\controller\Response;
 use wmlib\controller\Route;
 
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
+use wmlib\controller\Stream\String;
+
 /**
  * Middlewares support.
  * Filter can reuse any Symfony HttpKernelInterface middleware
  *
  */
 class Middleware extends Filter
 {
-    public function __construct(HttpKernelInterface $middleware){
+    /**
+     * @var HttpKernelInterface
+     */
+    private $middleware;
+
+    private $exclusive;
+
+    /**
+     * @param HttpKernelInterface $middleware
+     * @param bool $exclusive True is filter should use middleware response in ex way and pass all next's filters and route
+     */
+    public function __construct(HttpKernelInterface $middleware, $exclusive = true)
+    {
+        $this->middleware = $middleware;
+        $this->exclusive = $exclusive;
+    }
+
+    /**
+     * Pre filter method
+     *
+     * For process the rest of filter chain this code should be call inside:
+     * <code>
+     * $filterChain->doPreFilter ();
+     * </code>
+     *
+     * @param Request $request
+     * @param Response $response
+     * @param Chain $filterChain
+     * @return Response|null
+     */
+    public function doPreFilter(Request $request, Response $response, Chain $filterChain)
+    {
+        $symphony_response = $this->middleware->handle($this->decorateRequest($request), HttpKernelInterface::MASTER_REQUEST, false);
+
+        $response = $this->mergeResponse($response, $symphony_response);
+
+        if ($this->exclusive) {
+            return $response;
+        }
+        return $filterChain->doPreFilter($request, $response);
+    }
+
+    /**
+     * Decorate lib request to symfony request
+     *
+     * @param Request $request
+     * @return SymfonyRequest
+     */
+    private function decorateRequest(Request $request)
+    {
+        $symfony_request = new SymfonyRequest($request->getQueryParams(), $request->getBodyParams(), $request->getAttributes(), $request->getCookies());
+
+        return $symfony_request;
+    }
 
+    /**
+     * Merge symfony response to lib response
+     *
+     * @param Response $response
+     * @param SymfonyResponse $symfonyResponse
+     * @return Response
+     */
+    private function mergeResponse(Response $response, SymfonyResponse $symfonyResponse)
+    {
+        foreach($symfonyResponse->headers as $header => $line) {
+            $response = $response->withHeader($header, $line);
+        }
+        $response = $response->withBody(new String($symfonyResponse->getContent()));
+        return $response;
     }
 }

lib/Filter/Middleware.php

@@ -0,0 +1,73 @@
+<?php
+namespace wmlib\controller;
+
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
+use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use wmlib\controller\Exception\RouteNotFoundException;
+
+
+/**
+ * This StackPHP middleware creates a middleware from a root router.
+ * If no request is found, control is passed to the next middleware.
+ *
+ */
+class Middleware implements HttpKernelInterface
+{
+    /**
+     * @var HttpKernelInterface
+     */
+    private $next;
+
+    /**
+     * @var Router
+     */
+    private $router;
+
+    /**
+     *
+     * @param HttpKernelInterface $next The next application the request will be forwarded to if not handled by this
+     * @param Router $router Router to handle
+     */
+    public function __construct(HttpKernelInterface $next, Router $router) {
+        $this->next = $next;
+        $this->router = $router;
+    }
+
+
+    /**
+     * Handles a Request to convert it to a Response.
+     *
+     * When $catch is true, the implementation must catch all exceptions
+     * and do its best to convert them to a Response instance.
+     *
+     * @param SymfonyRequest $symfonyRequest A Request instance
+     * @param int $type The type of the request
+     *                         (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
+     * @param bool $catch Whether to catch exceptions or not
+     *
+     * @return SymfonyResponse A Response instance
+     *
+     * @throws \Exception When an Exception occurs during processing
+     *
+     * @api
+     */
+    public function handle(SymfonyRequest $symfonyRequest, $type = self::MASTER_REQUEST, $catch = true)
+    {
+        // create lib request from Symfony request
+        $request = new Request(new Url($symfonyRequest->getBaseUrl()), new Url($symfonyRequest->getRequestUri()), $symfonyRequest->getMethod());
+        $response = new Response($request);
+        try {
+            $response = $this->router->dispatch($request, $response);
+
+            return new SymfonyResponse($response->getBody()->getContents(), $response->getStatusCode(), $response->getHeaders());
+
+        } catch (RouteNotFoundException $e) {
+            return $this->next->handle($symfonyRequest, $type, $catch);
+        } catch (\Exception $e) {
+            if ($catch) {
+                // handle exception to response
+            } else throw $e;
+        }
+    }
+}

lib/Middleware.php

@@ -2,6 +2,8 @@
 namespace wmlib\controller;
 
 
+use wmlib\controller\Exception\RouteNotFoundException;
+
 class Router extends Route
 {
     const URI_DELIMITER = '/';
@@ -476,7 +478,7 @@ public function url($uri)
      * @param Request $request
      * @param Response $response
      * @return Response
-     * @throws \Exception
+     * @throws RouteNotFoundException
      */
     protected function dispatchHome(Request $request, Response $response)
     {
@@ -491,7 +493,7 @@ protected function dispatchHome(Request $request, Response $response)
             }
         }
 
-        throw new \Exception(sprintf('No matched route found for %s app[%s], "%s" existed', $look_for, get_class($this),
+        throw new RouteNotFoundException(sprintf('No matched route found for %s app[%s], "%s" existed', $look_for, get_class($this),
             implode(', ', $patterns)));
 
         return $response;