Merge pull request #686 from skipperbent/v5-development

Version 5.4.0.0

README.md

@@ -1036,6 +1036,17 @@ class CustomExceptionHandler implements IExceptionHandler
 			return;
 			
 		}
+		
+		/* Other error */
+		if($error instanceof MyCustomException) {
+
+			$request->setRewriteRoute(
+				// Add new route based on current url (minus query-string) and add custom parameters.
+				(new RouteUrl(url(null, null, []), 'PageController@error'))->setParameters(['exception' => $error])
+			);
+			return;
+			
+		}
 
 		throw $error;
 
@@ -1731,6 +1742,7 @@ SimpleRouter::setCustomClassLoader(new MyCustomClassLoader());
 php-di support was discontinued by version 4.3, however you can easily add it again by creating your own class-loader like the example below:
 
 ```php
+use Pecee\SimpleRouter\ClassLoader\IClassLoader;
 use Pecee\SimpleRouter\Exceptions\ClassNotFoundHttpException;
 
 class MyCustomClassLoader implements IClassLoader
@@ -1751,19 +1763,14 @@ class MyCustomClassLoader implements IClassLoader
      *
      * @param string $class
      * @return object
-     * @throws NotFoundHttpException
+     * @throws ClassNotFoundHttpException
      */
     public function loadClass(string $class)
     {
-        if (class_exists($class) === false) {
-            throw new NotFoundHttpException(sprintf('Class "%s" does not exist', $class), 404);
+        if ($this->container->has($class) === false) {
+            throw new ClassNotFoundHttpException($class, null, sprintf('Class "%s" does not exist', $class), 404, null);
         }
-
-		try {
-			return $this->container->get($class);
-		} catch (\Exception $e) {
-			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
-		}
+        return $this->container->get($class);
     }
     
     /**
@@ -1771,15 +1778,11 @@ class MyCustomClassLoader implements IClassLoader
      * @param object $class
      * @param string $method
      * @param array $parameters
-     * @return object
+     * @return string
      */
     public function loadClassMethod($class, string $method, array $parameters)
     {
-		try {
-			return $this->container->call([$class, $method], $parameters);
-		} catch (\Exception $e) {
-			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
-		}
+        return (string)$this->container->call([$class, $method], $parameters);
     }
 
     /**
@@ -1787,15 +1790,11 @@ class MyCustomClassLoader implements IClassLoader
      *
      * @param Callable $closure
      * @param array $parameters
-     * @return mixed
+     * @return string
      */
     public function loadClosure(callable $closure, array $parameters)
     {
-		try {
-			return $this->container->call($closure, $parameters);
-		} catch (\Exception $e) {
-			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
-		}
+        return (string)$this->container->call($closure, $parameters);
     }
 }
 ```

src/Pecee/Http/Input/InputHandler.php

@@ -82,6 +82,8 @@ class InputHandler
                 if ($post !== false) {
                     $this->originalPost += $post;
                 }
+            } else {
+                parse_str($contents, $this->originalPost);
             }
         }
 
@@ -108,7 +110,7 @@ class InputHandler
         foreach ($files as $key => $value) {
 
             // Parse multi dept file array
-            if(isset($value['name']) === false && is_array($value) === true) {
+            if (isset($value['name']) === false && is_array($value) === true) {
                 $list[$key] = $this->parseFiles($value, $key);
                 continue;
             }
@@ -161,12 +163,12 @@ class InputHandler
                 try {
 
                     $file = InputFile::createFromArray([
-                        'index'    => ($key === '' && $originalIndex !== '') ? $originalIndex : $key,
-                        'name'     => $original['name'][$key],
-                        'error'    => $original['error'][$key],
+                        'index' => ($key === '' && $originalIndex !== '') ? $originalIndex : $key,
+                        'name' => $original['name'][$key],
+                        'error' => $original['error'][$key],
                         'tmp_name' => $original['tmp_name'][$key],
-                        'type'     => $original['type'][$key],
-                        'size'     => $original['size'][$key],
+                        'type' => $original['type'][$key],
+                        'size' => $original['size'][$key],
                     ]);
 
                     if (isset($output[$key]) === true) {
@@ -231,7 +233,7 @@ class InputHandler
     {
         $element = null;
 
-        if(count($methods) > 0) {
+        if (count($methods) > 0) {
             $methods = is_array(...$methods) ? array_values(...$methods) : $methods;
         }
 
@@ -303,9 +305,9 @@ class InputHandler
     public function exists($index, ...$methods): bool
     {
         // Check array
-        if(is_array($index) === true) {
-            foreach($index as $key) {
-                if($this->value($key, null, ...$methods) === null) {
+        if (is_array($index) === true) {
+            foreach ($index as $key) {
+                if ($this->value($key, null, ...$methods) === null) {
                     return false;
                 }
             }

src/Pecee/Http/Input/InputItem.php

@@ -89,6 +89,7 @@ class InputItem implements ArrayAccess, IInputItem, IteratorAggregate
         return isset($this->value[$offset]);
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset): ?self
     {
         if ($this->offsetExists($offset) === true) {

src/Pecee/Http/Middleware/BaseCsrfVerifier.php

@@ -17,13 +17,13 @@ class BaseCsrfVerifier implements IMiddleware
      * For example: /admin/*
      * @var array|null
      */
-    protected ?array $except = null;
+    protected array $except = [];
 
     /**
      * Urls to include. Can be used to include urls from a certain path.
      * @var array|null
      */
-    protected ?array $include = null;
+    protected array $include = [];
 
     /**
      * @var ITokenProvider
@@ -38,6 +38,23 @@ class BaseCsrfVerifier implements IMiddleware
         $this->tokenProvider = new CookieTokenProvider();
     }
 
+    protected function isIncluded(Request $request): bool
+    {
+        if (count($this->include) > 0) {
+            foreach ($this->include as $includeUrl) {
+                $includeUrl = rtrim($includeUrl, '/');
+                if ($includeUrl[strlen($includeUrl) - 1] === '*') {
+                    $includeUrl = rtrim($includeUrl, '*');
+                    return $request->getUrl()->contains($includeUrl);
+                }
+
+                return ($includeUrl === rtrim($request->getUrl()->getRelativeUrl(false), '/'));
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Check if the url matches the urls in the except property
      * @param Request $request
@@ -45,11 +62,11 @@ class BaseCsrfVerifier implements IMiddleware
      */
     protected function skip(Request $request): bool
     {
-        if ($this->except === null || count($this->except) === 0) {
+        if (count($this->except) === 0) {
             return false;
         }
 
-        foreach($this->except as $url) {
+        foreach ($this->except as $url) {
             $url = rtrim($url, '/');
             if ($url[strlen($url) - 1] === '*') {
                 $url = rtrim($url, '*');
@@ -60,20 +77,9 @@ class BaseCsrfVerifier implements IMiddleware
 
             if ($skip === true) {
 
-                if(is_array($this->include) === true && count($this->include) > 0) {
-                    foreach($this->include as $includeUrl) {
-                        $includeUrl = rtrim($includeUrl, '/');
-                        if ($includeUrl[strlen($includeUrl) - 1] === '*') {
-                            $includeUrl = rtrim($includeUrl, '*');
-                            $skip = !$request->getUrl()->contains($includeUrl);
-                            break;
-                        }
+                $skip = !$this->isIncluded($request);
 
-                        $skip = !($includeUrl === rtrim($request->getUrl()->getRelativeUrl(false), '/'));
-                    }
-                }
-
-                if($skip === false) {
+                if ($skip === false) {
                     continue;
                 }
 
@@ -92,12 +98,11 @@ class BaseCsrfVerifier implements IMiddleware
      */
     public function handle(Request $request): void
     {
-        if ($this->skip($request) === false && $request->isPostBack() === true) {
+        if ($this->skip($request) === false && ($request->isPostBack() === true || $this->isIncluded($request) === true)) {
 
             $token = $request->getInputHandler()->value(
                 static::POST_KEY,
                 $request->getHeader(static::HEADER_KEY),
-                Request::$requestTypesPost
             );
 
             if ($this->tokenProvider->validate((string)$token) === false) {

src/Pecee/Http/Response.php

@@ -32,6 +32,8 @@ class Response
      *
      * @param string $url
      * @param ?int $httpCode
+     *
+     * @return never
      */
     public function redirect(string $url, ?int $httpCode = null): void
     {
@@ -127,4 +129,4 @@ class Response
         return $this;
     }
 
-}
+}

src/Pecee/SimpleRouter/ClassLoader/ClassLoader.php

@@ -27,11 +27,11 @@ class ClassLoader implements IClassLoader
      * @param object $class
      * @param string $method
      * @param array $parameters
-     * @return mixed
+     * @return string
      */
-    public function loadClassMethod($class, string $method, array $parameters)
+    public function loadClassMethod($class, string $method, array $parameters): string
     {
-        return call_user_func_array([$class, $method], array_values($parameters));
+        return (string)call_user_func_array([$class, $method], array_values($parameters));
     }
 
     /**
@@ -39,11 +39,11 @@ class ClassLoader implements IClassLoader
      *
      * @param Callable $closure
      * @param array $parameters
-     * @return mixed
+     * @return string
      */
-    public function loadClosure(Callable $closure, array $parameters)
+    public function loadClosure(callable $closure, array $parameters): string
     {
-        return call_user_func_array($closure, array_values($parameters));
+        return (string)call_user_func_array($closure, array_values($parameters));
     }
 
 }

src/Pecee/SimpleRouter/Route/LoadableRoute.php

@@ -82,15 +82,18 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
     {
         $this->url = ($url === '/') ? '/' : '/' . trim($url, '/') . '/';
 
+        $parameters = [];
         if (strpos($this->url, $this->paramModifiers[0]) !== false) {
 
             $regex = sprintf(static::PARAMETERS_REGEX_FORMAT, $this->paramModifiers[0], $this->paramOptionalSymbol, $this->paramModifiers[1]);
 
             if ((bool)preg_match_all('/' . $regex . '/u', $this->url, $matches) !== false) {
-                $this->parameters = array_fill_keys($matches[1], null);
+                $parameters = array_fill_keys($matches[1], null);
             }
         }
 
+        $this->parameters = $parameters;
+
         return $this;
     }
 

src/Pecee/SimpleRouter/Route/RouteResource.php

@@ -7,22 +7,22 @@ use Pecee\Http\Request;
 class RouteResource extends LoadableRoute implements IControllerRoute
 {
     protected array $urls = [
-        'index'   => '',
-        'create'  => 'create',
-        'store'   => '',
-        'show'    => '',
-        'edit'    => 'edit',
-        'update'  => '',
+        'index' => '',
+        'create' => 'create',
+        'store' => '',
+        'show' => '',
+        'edit' => 'edit',
+        'update' => '',
         'destroy' => '',
     ];
 
     protected array $methodNames = [
-        'index'   => 'index',
-        'create'  => 'create',
-        'store'   => 'store',
-        'show'    => 'show',
-        'edit'    => 'edit',
-        'update'  => 'update',
+        'index' => 'index',
+        'create' => 'create',
+        'store' => 'store',
+        'show' => 'show',
+        'edit' => 'edit',
+        'update' => 'update',
         'destroy' => 'destroy',
     ];
 
@@ -69,11 +69,18 @@ class RouteResource extends LoadableRoute implements IControllerRoute
     public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string
     {
         $url = array_search($name, $this->names, true);
-        if ($url !== false) {
-            return rtrim($this->url . $this->urls[$url], '/') . '/';
+
+        $parametersUrl = '';
+
+        if ($parameters !== null && count($parameters) > 0) {
+            $parametersUrl = join('/', $parameters) . '/';
         }
 
-        return $this->url;
+        if ($url !== false) {
+            return rtrim($this->url . $parametersUrl . $this->urls[$url], '/') . '/';
+        }
+
+        return $this->url . $parametersUrl;
     }
 
     protected function call($method): bool
@@ -172,12 +179,12 @@ class RouteResource extends LoadableRoute implements IControllerRoute
         $this->name = $name;
 
         $this->names = [
-            'index'   => $this->name . '.index',
-            'create'  => $this->name . '.create',
-            'store'   => $this->name . '.store',
-            'show'    => $this->name . '.show',
-            'edit'    => $this->name . '.edit',
-            'update'  => $this->name . '.update',
+            'index' => $this->name . '.index',
+            'create' => $this->name . '.create',
+            'store' => $this->name . '.store',
+            'show' => $this->name . '.show',
+            'edit' => $this->name . '.edit',
+            'update' => $this->name . '.update',
             'destroy' => $this->name . '.destroy',
         ];
 

src/Pecee/SimpleRouter/Router.php

@@ -35,7 +35,7 @@ class Router
      * @var bool
      */
     protected bool $isProcessingRoute;
-    
+
     /**
      * Defines all data from current processing route.
      * @var ILoadableRoute
@@ -59,7 +59,7 @@ class Router
      * when a route is being processed.
      * @var array
      */
-    protected array$routeStack = [];
+    protected array $routeStack = [];
 
     /**
      * List of added bootmanagers
@@ -166,7 +166,7 @@ class Router
     public function addRoute(IRoute $route): IRoute
     {
         $this->fireEvents(EventHandler::EVENT_ADD_ROUTE, [
-            'route'      => $route,
+            'route' => $route,
             'isSubRoute' => $this->isProcessingRoute,
         ]);
 
@@ -307,7 +307,7 @@ class Router
             $this->debug('Rendering bootmanager "%s"', $className);
             $this->fireEvents(EventHandler::EVENT_RENDER_BOOTMANAGER, [
                 'bootmanagers' => $this->bootManagers,
-                'bootmanager'  => $manager,
+                'bootmanager' => $manager,
             ]);
 
             /* Render bootmanager */
@@ -345,8 +345,8 @@ class Router
             try {
                 /* Verify csrf token for request */
                 $this->csrfVerifier->handle($this->request);
-            } catch(Exception $e) {
-                $this->handleException($e);
+            } catch (Exception $e) {
+                return $this->handleException($e);
             }
         }
 
@@ -381,7 +381,7 @@ class Router
             foreach ($this->processedRoutes as $key => $route) {
 
                 $this->debug('Matching route "%s"', get_class($route));
-                
+
                 /* Add current processing route to constants */
                 $this->currentProcessingRoute = $route;
 
@@ -405,7 +405,7 @@ class Router
                     }
 
                     $this->fireEvents(EventHandler::EVENT_RENDER_MIDDLEWARES, [
-                        'route'       => $route,
+                        'route' => $route,
                         'middlewares' => $route->getMiddlewares(),
                     ]);
 
@@ -427,7 +427,7 @@ class Router
                     $routeOutput = $route->renderRoute($this->request, $this);
 
                     if ($this->renderMultipleRoutes === true) {
-                        if ($routeOutput !== null) {
+                        if ($routeOutput !== '') {
                             return $routeOutput;
                         }
 
@@ -444,12 +444,12 @@ class Router
             }
 
         } catch (Exception $e) {
-            $this->handleException($e);
+            return $this->handleException($e);
         }
 
         if ($methodNotAllowed === true) {
             $message = sprintf('Route "%s" or method "%s" not allowed.', $this->request->getUrl()->getPath(), $this->request->getMethod());
-            $this->handleException(new NotFoundHttpException($message, 403));
+            return $this->handleException(new NotFoundHttpException($message, 403));
         }
 
         if (count($this->request->getLoadedRoutes()) === 0) {
@@ -500,7 +500,7 @@ class Router
             $this->request->setHasPendingRewrite(false);
 
             $this->fireEvents(EventHandler::EVENT_REWRITE, [
-                'rewriteUrl'   => $this->request->getRewriteUrl(),
+                'rewriteUrl' => $this->request->getRewriteUrl(),
                 'rewriteRoute' => $this->request->getRewriteRoute(),
             ]);
 
@@ -521,7 +521,7 @@ class Router
         $this->debug('Starting exception handling for "%s"', get_class($e));
 
         $this->fireEvents(EventHandler::EVENT_LOAD_EXCEPTIONS, [
-            'exception'         => $e,
+            'exception' => $e,
             'exceptionHandlers' => $this->exceptionHandlers,
         ]);
 
@@ -533,8 +533,8 @@ class Router
             }
 
             $this->fireEvents(EventHandler::EVENT_RENDER_EXCEPTION, [
-                'exception'         => $e,
-                'exceptionHandler'  => $handler,
+                'exception' => $e,
+                'exceptionHandler' => $handler,
                 'exceptionHandlers' => $this->exceptionHandlers,
             ]);
 
@@ -556,12 +556,13 @@ class Router
                     $this->debug('Exception handler contains rewrite, reloading routes');
 
                     $this->fireEvents(EventHandler::EVENT_REWRITE, [
-                        'rewriteUrl'   => $this->request->getRewriteUrl(),
+                        'rewriteUrl' => $this->request->getRewriteUrl(),
                         'rewriteRoute' => $this->request->getRewriteRoute(),
                     ]);
 
                     if ($this->request->getRewriteRoute() !== null) {
                         $this->processedRoutes[] = $this->request->getRewriteRoute();
+                        $this->request->setHasPendingRewrite(false);
                     }
 
                     return $this->routeRequest();
@@ -667,9 +668,9 @@ class Router
         $this->debug('Finding url', func_get_args());
 
         $this->fireEvents(EventHandler::EVENT_GET_URL, [
-            'name'       => $name,
+            'name' => $name,
             'parameters' => $parameters,
-            'getParams'  => $getParams,
+            'getParams' => $getParams,
         ]);
 
         if ($name === '' && $parameters === '') {
@@ -913,8 +914,8 @@ class Router
         $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
         $this->debugList[] = [
             'message' => vsprintf($message, $args),
-            'time'    => number_format(microtime(true) - $this->debugStartTime, 10),
-            'trace'   => end($trace),
+            'time' => number_format(microtime(true) - $this->debugStartTime, 10),
+            'trace' => end($trace),
         ];
     }
 
@@ -940,7 +941,7 @@ class Router
     {
         return $this->debugList;
     }
-    
+
     /**
      * Get the current processing route details.
      *

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -41,9 +41,9 @@ class SimpleRouter
 
     /**
      * The response object
-     * @var Response
+     * @var Response|null
      */
-    protected static Response $response;
+    protected static ?Response $response = null;
 
     /**
      * Router instance

tests/Pecee/SimpleRouter/Dummy/CsrfVerifier/DummyCsrfVerifier.php

@@ -2,12 +2,12 @@
 
 class DummyCsrfVerifier extends \Pecee\Http\Middleware\BaseCsrfVerifier {
 
-    protected ?array $except = [
+    protected array $except = [
         '/exclude-page',
         '/exclude-all/*',
     ];
 
-    protected ?array $include = [
+    protected array $include = [
         '/exclude-all/include-page',
     ];
 

tests/Pecee/SimpleRouter/Dummy/Route/DummyLoadableRoute.php

@@ -0,0 +1,11 @@
+<?php
+
+use Pecee\Http\Request;
+
+class DummyLoadableRoute extends Pecee\SimpleRouter\Route\LoadableRoute {
+
+    public function matchRoute(string $url, Request $request): bool
+    {
+        return false;
+    }
+}

tests/Pecee/SimpleRouter/LoadableRouteTest.php

@@ -0,0 +1,27 @@
+<?php
+
+require_once 'Dummy/Route/DummyLoadableRoute.php';
+
+class LoadableRouteTest extends \PHPUnit\Framework\TestCase
+{
+    public function testSetUrlUpdatesParameters()
+    {
+        $route = new DummyLoadableRoute();
+        $this->assertEmpty($route->getParameters());
+
+        $route->setUrl('/');
+        $this->assertEmpty($route->getParameters());
+
+        $expected = ['param' => null, 'optionalParam' => null];
+        $route->setUrl('/{param}/{optionalParam?}');
+        $this->assertEquals($expected, $route->getParameters());
+
+        $expected = ['otherParam' => null];
+        $route->setUrl('/{otherParam}');
+        $this->assertEquals($expected, $route->getParameters());
+
+        $expected = [];
+        $route->setUrl('/');
+        $this->assertEquals($expected, $route->getParameters());
+    }
+}

tests/Pecee/SimpleRouter/RouterResourceTest.php

@@ -63,7 +63,22 @@ class RouterResourceTest extends \PHPUnit\Framework\TestCase
         $response = TestRouter::debugOutput('/resource/38', 'get');
 
         $this->assertEquals('show 38', $response);
+    }
 
+    public function testResourceUrls()
+    {
+        TestRouter::resource('/resource', 'ResourceController')->name('resource');
+
+        TestRouter::debugNoReset('/resource');
+
+        $this->assertEquals('/resource/3/create/', TestRouter::router()->getUrl('resource.create', ['id' => 3]));
+        $this->assertEquals('/resource/5/edit/', TestRouter::router()->getUrl('resource.edit', ['id' => 5]));
+        $this->assertEquals('/resource/6/', TestRouter::router()->getUrl('resource.update', ['id' => 6]));
+        $this->assertEquals('/resource/9/', TestRouter::router()->getUrl('resource.destroy', ['id' => 9]));
+        $this->assertEquals('/resource/12/', TestRouter::router()->getUrl('resource.delete', ['id' => 12]));
+        $this->assertEquals('/resource/', TestRouter::router()->getUrl('resource'));
+
+        TestRouter::router()->reset();
     }
 
 }

tests/Pecee/SimpleRouter/RouterUrlTest.php

@@ -184,7 +184,7 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
         // Should match /?jackdaniels=true&cola=yeah
         $this->assertEquals('/?jackdaniels=true&cola=yeah', TestRouter::getUrl('home', null, ['jackdaniels' => 'true', 'cola' => 'yeah']));
 
-        TestRouter::router()->reset();
+        TestRouter::reset();
 
     }
 

tests/TestRouter.php

@@ -8,6 +8,11 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
         static::request()->setHost('testhost.com');
     }
 
+    public static function reset(): void
+    {
+        static::$router = null;
+    }
+
     public static function debugNoReset(string $testUrl, string $testMethod = 'get'): void
     {
         $request = static::request();