[BUGFIX] Improvements

- Fixed errors with getRoute method.
- Added Response and Request classes.
- Added CSRF stuff.
- Cleanup and bugfixes.

README.md

@@ -1,8 +1,6 @@
 # Simple PHP router
 Simple, fast PHP router that is easy to get integrated and in almost any project. Heavily inspired by the Laravel router.
 
-**Please note: this project has just been added and is still a work in progress. Please use with caution until a stable release version is available :)**
-
 ## Installation
 Add the latest version pf Simple PHP Router to your ```composer.json```
 
@@ -17,6 +15,16 @@ Add the latest version pf Simple PHP Router to your ```composer.json```
 }
 ```
 
+## Notes
+
+### Features currently "in-the-works"
+
+- Global Constraints
+- Named Routes
+- Sub-Domain Routing
+- CSRF Protection
+- Optinal/required parameters
+
 ## Initialising the router
 
 In your ```index.php``` require your ```routes.php``` and call the ```routeRequest()``` method when all your custom routes has been loaded. This will trigger and do the actual routing of the requests.
@@ -56,7 +64,8 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
 
     SimpleRouter::group(['prefix' => 'services'], function() {
 
-        SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show');
+        SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')
+        ->where(['id' => '[0-9]+');
         
         // Resetful ressource
         SimpleRouter::ressource('/rest', 'ControllerRessource');

src/Pecee/CsrfToken.php

@@ -0,0 +1,74 @@
+<?php
+namespace Pecee;
+
+class CsrfToken {
+
+    const CSRF_KEY = 'csrf_token';
+
+    protected static $instance;
+
+    protected $lastToken;
+    protected $currentToken;
+
+    public static function getInstance() {
+        if(self::$instance === null) {
+            self::$instance = new static();
+        }
+        return self::$instance;
+    }
+
+    public function __construct() {
+        $this->lastToken = isset($_SESSION[self::CSRF_KEY]) ? $_SESSION[self::CSRF_KEY] : null;
+        $this->currentToken = $this->generate();
+
+        // Initialise session, if it hasn't been initialised.
+        if(!isset($_SESSION)) {
+            session_start();
+        }
+
+        $_SESSION['csrf_token'] = $this->currentToken;
+    }
+
+    /**
+     * Generate random identifier for CSRF token
+     * @return string
+     */
+    public static function generate() {
+        if (function_exists('mcrypt_create_iv')) {
+            return bin2hex(mcrypt_create_iv(32, MCRYPT_DEV_URANDOM));
+        }
+        return bin2hex(openssl_random_pseudo_bytes(32));
+    }
+
+    /**
+     * Validate valid CSRF token
+     *
+     * @param string $token
+     * @return bool
+     */
+    public function validate($token) {
+        return hash_equals($token, $_SESSION[self::CSRF_KEY]);
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getLastToken(){
+        return $this->lastToken;
+    }
+
+    /**
+     * @param string|null $lastToken
+     */
+    public function setLastToken($lastToken){
+        $this->lastToken = $lastToken;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCurrentToken(){
+        return $this->currentToken;
+    }
+
+}

src/Pecee/Http/Middleware/Middleware.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Pecee\Http\Middleware;
+
+use Pecee\Http\Request;
+use Pecee\SimpleRouter\RouterEntry;
+
+abstract class Middleware
+{
+    public function handle(Request $request) {
+        return true;
+    }
+}

src/Pecee/Http/Middleware/VerifyCsrfToken.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Pecee\Http\Middleware;
+
+class VerifyCsrfToken extends Middleware {
+
+
+
+}

src/Pecee/Http/Request.php

@@ -0,0 +1,46 @@
+<?php
+namespace Pecee\Http;
+
+class Request {
+
+    protected $uri;
+    protected $host;
+    protected $method;
+
+    public function __construct() {
+        $this->host = $_SERVER['HTTP_HOST'];
+        $this->uri = rtrim($_SERVER['REQUEST_URI'], '/') . '/';
+        $this->method = (isset($_POST['_method'])) ? strtolower($_POST['_method']) : strtolower($_SERVER['REQUEST_METHOD']);
+    }
+
+    /**
+     * @return string
+     */
+    public function getUri() {
+        return $this->uri;
+    }
+
+    /**
+     * @return string
+     */
+    public function getHost() {
+        return $this->host;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMethod() {
+        return $this->method;
+    }
+
+    /**
+     * Get http basic auth user
+     * @return string|null
+     */
+    public function getUser() {
+        $data = http_digest_parse($_SERVER['PHP_AUTH_DIGEST']);
+        return (isset($data['username'])) ? $data['username'] : null;
+    }
+
+}

src/Pecee/Http/Response.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Pecee\Http;
+
+class Response {
+
+    /**
+     * Set the http status code
+     *
+     * @param int $code
+     * @return self $this
+     */
+    public function httpCode($code) {
+        http_response_code($code);
+        return $this;
+    }
+
+    /**
+     * Redirect the response
+     *
+     * @param string $url
+     */
+    public function redirect($url) {
+        header('location: ' . $url);
+    }
+
+}

src/Pecee/SimpleRouter/IRouteEntry.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Pecee\SimpleRouter;
+
+interface IRouteEntry {
+
+}

src/Pecee/SimpleRouter/RouterBase.php

@@ -1,19 +1,19 @@
 <?php
 namespace Pecee\SimpleRouter;
 
+use Pecee\Http\Request;
 use Pecee\Url;
 
 class RouterBase {
 
     protected static $instance;
 
+    protected $request;
     protected $currentRoute;
     protected $routes;
     protected $processedRoutes;
     protected $controllerUrlMap;
     protected $backstack;
-    protected $requestUri;
-    protected $requestMethod;
     protected $loadedRoute;
     protected $defaultNamespace;
 
@@ -24,8 +24,7 @@ class RouterBase {
         $this->routes = array();
         $this->backstack = array();
         $this->controllerUrlMap = array();
-        $this->requestUri = $_SERVER['REQUEST_URI'];
-        $this->requestMethod = (isset($_POST['_method'])) ? strtolower($_POST['_method']) : strtolower($_SERVER['REQUEST_METHOD']);
+        $this->request = new Request();
     }
 
     public function addRoute(RouterEntry $route) {
@@ -42,9 +41,8 @@ class RouterBase {
         /* @var $route RouterEntry */
         foreach($routes as $route) {
 
-            if($this->defaultNamespace) {
+            if($this->defaultNamespace && !$route->getNamespace()) {
                 $namespace = null;
-
                 if ($route->getNamespace()) {
                     $namespace = $this->defaultNamespace . '\\' . $route->getNamespace();
                 } else {
@@ -71,7 +69,7 @@ class RouterBase {
 
             $this->currentRoute = $route;
             if($route instanceof RouterGroup && is_callable($route->getCallback())) {
-                $route->renderRoute($this->requestMethod);
+                $route->renderRoute($this->request);
             }
             $this->currentRoute = null;
 
@@ -96,17 +94,17 @@ class RouterBase {
         });
 
         foreach($this->controllerUrlMap as $route) {
-            $routeMatch = $route->matchRoute($this->requestMethod, rtrim($this->requestUri, '/') . '/');
+            $routeMatch = $route->matchRoute($this->request);
 
             if($routeMatch && !($routeMatch instanceof RouterGroup)) {
                 $this->loadedRoute = $routeMatch;
-                $routeMatch->renderRoute($this->requestMethod);
+                $routeMatch->renderRoute($this->request);
                 break;
             }
         }
 
         if(!$this->loadedRoute) {
-            throw new RouterException(sprintf('Route not found: %s', $this->requestUri), 404);
+            throw new RouterException(sprintf('Route not found: %s', $this->request->getUri()), 404);
         }
     }
 
@@ -134,20 +132,6 @@ class RouterBase {
         return null;
     }
 
-    /**
-     * @return string
-     */
-    public function getRequestMethod() {
-        return $this->requestMethod;
-    }
-
-    /**
-     * @return string
-     */
-    public function getRequestUri() {
-        return $this->requestUri;
-    }
-
     /**
      * @return array
      */
@@ -169,10 +153,20 @@ class RouterBase {
         return $this->routes;
     }
 
+    /**
+     * Get current request
+     *
+     * @return Request
+     */
+    public function getRequest() {
+        return $this->request;
+    }
+
     protected function processUrl($route, $method = null, $parameters = null, $getParams = null) {
+
         $url = rtrim($route->getUrl(), '/') . '/';
 
-        if($method !== null) {
+        if(($route instanceof RouterController || $route instanceof RouterRessource) && $method !== null) {
             $url .= $method . '/';
         }
 
@@ -226,24 +220,16 @@ class RouterBase {
             }
 
             if($c === $controller || strpos($c, $controller) === 0) {
-                if(stripos($c, '@') !== false) {
-                    $tmp = explode('@', $route->getCallback());
-                    $method = strtolower($tmp[1]);
-                }
-                return $this->processUrl($route, $method, $parameters, $getParams);
+                return $this->processUrl($route, $route->getMethod(), $parameters, $getParams);
             }
         }
 
+        $c = '';
+
         // No match has yet been found, let's try to guess what url that should be returned
         foreach($this->controllerUrlMap as $route) {
             if($route instanceof RouterRoute && !is_callable($route->getCallback()) && stripos($route->getCallback(), '@') !== false) {
-                $c = $route->getCallback();
-
-                if(stripos($controller, '@') !== false) {
-                    $tmp = explode('@', $controller);
-                    $c = $tmp[0];
-                }
-
+                $c = $route->getClass();
             } else if($route instanceof RouterController || $route instanceof RouterRessource) {
                 $c = $route->getController();
             }
@@ -254,7 +240,7 @@ class RouterBase {
                 $method = $tmp[1];
             }
 
-            if($controller == $c) {
+            if($controller === $c) {
                 return $this->processUrl($route, $method, $parameters, $getParams);
             }
         }

src/Pecee/SimpleRouter/RouterController.php

@@ -1,6 +1,8 @@
 <?php
 namespace Pecee\SimpleRouter;
 
+use Pecee\Http\Request;
+
 class RouterController extends RouterEntry {
 
     const DEFAULT_METHOD = 'index';
@@ -15,10 +17,9 @@ class RouterController extends RouterEntry {
         $this->controller = $controller;
     }
 
-    public function matchRoute($requestMethod, $url) {
-
-        $url = parse_url($url);
-        $url = $url['path'];
+    public function matchRoute(Request $request) {
+        $url = parse_url($request->getUri());
+        $url = rtrim($url['path'], '/') . '/';
 
         if(strtolower($url) == strtolower($this->url) || stripos($url, $this->url) === 0) {
 

src/Pecee/SimpleRouter/RouterEntry.php

@@ -2,6 +2,9 @@
 
 namespace Pecee\SimpleRouter;
 
+use Pecee\Http\Middleware\Middleware;
+use Pecee\Http\Request;
+
 abstract class RouterEntry {
 
     const REQUEST_TYPE_POST = 'post';
@@ -19,18 +22,12 @@ abstract class RouterEntry {
     protected $settings;
     protected $callback;
     protected $parameters;
+    protected $parametersRegex;
 
     public function __construct() {
         $this->settings = array();
         $this->parameters = array();
-    }
-
-    protected function loadClass($name) {
-        if(!class_exists($name)) {
-            throw new RouterException(sprintf('Class %s does not exist', $name));
-        }
-
-        return new $name();
+        $this->parametersRegex = array();
     }
 
     /**
@@ -63,20 +60,20 @@ abstract class RouterEntry {
         return $this->callback;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getParameters(){
-        return $this->parameters;
+    public function getMethod() {
+        if(strpos($this->callback, '@') !== false) {
+            $tmp = explode('@', $this->callback);
+            return $tmp[1];
+        }
+        return null;
     }
 
-    /**
-     * @param mixed $parameters
-     * @return self
-     */
-    public function setParameters($parameters) {
-        $this->parameters = $parameters;
-        return $this;
+    public function getClass() {
+        if(strpos($this->callback, '@') !== false) {
+            $tmp = explode('@', $this->callback);
+            return $tmp[0];
+        }
+        return null;
     }
 
     /**
@@ -134,6 +131,33 @@ abstract class RouterEntry {
         return $this->settings;
     }
 
+    /**
+     * @return mixed
+     */
+    public function getParameters(){
+        return $this->parameters;
+    }
+
+    /**
+     * @param mixed $parameters
+     * @return self
+     */
+    public function setParameters($parameters) {
+        $this->parameters = $parameters;
+        return $this;
+    }
+
+    /**
+     * Add regular expression parameter match
+     *
+     * @param array $options
+     * @return self
+     */
+    public function where(array $options) {
+        $this->parametersRegex = array_merge($this->parametersRegex, $options);
+        return $this;
+    }
+
     /**
      * Get settings that are allowed to be inherited by child routes.
      *
@@ -158,7 +182,7 @@ abstract class RouterEntry {
      * @return self
      */
     public function addSettings(array $settings) {
-        array_merge($this->settings, $settings);
+        $this->settings = array_merge($this->settings, $settings);
         return $this;
     }
 
@@ -196,12 +220,30 @@ abstract class RouterEntry {
         $this->settings[$name] = $value;
     }
 
-    public function renderRoute($requestMethod) {
-        // Load middleware
-        if($this->getMiddleware()) {
-            $this->loadClass($this->getMiddleware());
+    protected function loadClass($name) {
+        if(!class_exists($name)) {
+            throw new RouterException(sprintf('Class %s does not exist', $name));
         }
 
+        return new $name();
+    }
+
+    protected function loadMiddleware(Request $request) {
+        if($this->getMiddleware()) {
+            if (!($this->getMiddleware() instanceof Middleware)) {
+                throw new RouterException($this->getMiddleware() . ' must be instance of Middleware');
+            }
+
+            /* @var $class Middleware */
+            $class = $this->loadClass($this->getMiddleware());
+            $class->handle($request);
+        }
+    }
+
+    public function renderRoute(Request $request) {
+        // Load middleware
+        $this->loadMiddleware($request);
+
         if(is_object($this->getCallback()) && is_callable($this->getCallback())) {
 
             // When the callback is a function
@@ -210,8 +252,9 @@ abstract class RouterEntry {
             // When the callback is a method
             $controller = explode('@', $this->getCallback());
             $className = $this->getNamespace() . '\\' . $controller[0];
+
             $class = $this->loadClass($className);
-            $method = $requestMethod . ucfirst($controller[1]);
+            $method = $request->getMethod() . ucfirst($controller[1]);
 
             if (!method_exists($class, $method)) {
                 throw new RouterException(sprintf('Method %s does not exist in class %s', $method, $className), 404);
@@ -225,6 +268,6 @@ abstract class RouterEntry {
         return null;
     }
 
-    abstract function matchRoute($requestMethod, $url);
+    abstract function matchRoute(Request $request);
 
 }

src/Pecee/SimpleRouter/RouterGroup.php

@@ -2,24 +2,26 @@
 
 namespace Pecee\SimpleRouter;
 
+use Pecee\Http\Request;
+
 class RouterGroup extends RouterEntry {
 
     public function __construct() {
         parent::__construct();
     }
 
-    public function matchRoute($requestMethod, $url) {
+    public function matchRoute(Request $request) {
         // Check if request method is allowed
 
-        if(strtolower($url) == strtolower($this->prefix) || stripos($url, $this->prefix) === 0) {
+        if(strtolower($request->getUri()) == strtolower($this->prefix) || stripos($request->getUri(), $this->prefix) === 0) {
 
             $hasAccess = (!$this->method);
 
             if($this->method) {
                 if(is_array($this->method)) {
-                    $hasAccess = (in_array($requestMethod, $this->method));
+                    $hasAccess = (in_array($request->getMethod(), $this->method));
                 } else {
-                    $hasAccess = strtolower($this->method) == strtolower($requestMethod);
+                    $hasAccess = strtolower($this->method) == strtolower($request->getMethod());
                 }
             }
 

src/Pecee/SimpleRouter/RouterRessource.php

@@ -1,6 +1,8 @@
 <?php
 namespace Pecee\SimpleRouter;
 
+use Pecee\Http\Request;
+
 class RouterRessource extends RouterEntry {
 
     const DEFAULT_METHOD = 'index';
@@ -17,11 +19,9 @@ class RouterRessource extends RouterEntry {
         $this->postMethod = strtolower(($_SERVER['REQUEST_METHOD'] != 'GET') ? 'post' : 'get');
     }
 
-    public function renderRoute($requestMethod) {
+    public function renderRoute(Request $request) {
         // Load middleware
-        if($this->getMiddleware()) {
-            $this->loadClass($this->getMiddleware());
-        }
+        $this->loadMiddleware($request);
 
         if(is_object($this->getCallback()) && is_callable($this->getCallback())) {
             // When the callback is a function
@@ -51,9 +51,9 @@ class RouterRessource extends RouterEntry {
         return $this;
     }
 
-    public function matchRoute($requestMethod, $url) {
-        $url = parse_url($url);
-        $url = $url['path'];
+    public function matchRoute(Request $request) {
+        $url = parse_url($request->getUri());
+        $url = rtrim($url['path'], '/') . '/';
 
         if(strtolower($url) == strtolower($this->url) || stripos($url, $this->url) === 0) {
             $url = rtrim($url, '/');
@@ -72,12 +72,12 @@ class RouterRessource extends RouterEntry {
             if (count($path)) {
 
                 // Delete
-                if($requestMethod === self::REQUEST_TYPE_DELETE && $this->postMethod === self::REQUEST_TYPE_POST) {
+                if($request->getMethod() === self::REQUEST_TYPE_DELETE && $this->postMethod === self::REQUEST_TYPE_POST) {
                     return $this->call('destroy', $args);
                 }
 
                 // Update
-                if(in_array($requestMethod, array('put', 'patch')) && $this->postMethod === self::REQUEST_TYPE_POST) {
+                if(in_array($request->getMethod(), array('put', 'patch')) && $this->postMethod === self::REQUEST_TYPE_POST) {
                     return $this->call('update', array_merge(array($action), $args));
                 }
 
@@ -87,7 +87,7 @@ class RouterRessource extends RouterEntry {
                 }
 
                 // Create
-                if(strtolower($action) === 'create' && $requestMethod === self::REQUEST_TYPE_GET) {
+                if(strtolower($action) === 'create' && $request->getMethod() === self::REQUEST_TYPE_GET) {
                     return $this->call('create', $args);
                 }
 

src/Pecee/SimpleRouter/RouterRoute.php

@@ -2,8 +2,7 @@
 
 namespace Pecee\SimpleRouter;
 
-use Pecee\Registry;
-use Pecee\Router;
+use Pecee\Http\Request;
 
 class RouterRoute extends RouterEntry {
 
@@ -19,10 +18,14 @@ class RouterRoute extends RouterEntry {
         $this->requestTypes = array();
     }
 
-    protected function parseParameters($url) {
+    protected function parseParameters($url, $multiple = false) {
         $parameters = array();
 
-        preg_match_all('/{([A-Za-z\-\_]*?)}/is', $url, $parameters);
+        if($multiple) {
+            preg_match_all('/{([A-Za-z\-\_]*?)}/is', $url, $parameters);
+        } else {
+            preg_match('/{([A-Za-z\-\_]*?)}/is', $url, $parameters);
+        }
 
         if(isset($parameters[1]) && count($parameters[1]) > 0) {
             return $parameters[1];
@@ -31,24 +34,12 @@ class RouterRoute extends RouterEntry {
         return null;
     }
 
-    protected function parseParameter($path) {
-        $parameters = array();
-
-        preg_match('/{([A-Za-z\-\_]*?)}/is', $path, $parameters);
-
-        if(isset($parameters[1]) && count($parameters[1]) > 0) {
-            return $parameters[1];
-        }
-
-        return null;
-    }
-
-    public function matchRoute($requestMethod, $url) {
+    public function matchRoute(Request $request) {
 
         // Check if request method is allowed
-        if(count($this->requestTypes) === 0 || in_array($requestMethod, $this->requestTypes)) {
+        if(count($this->requestTypes) === 0 || in_array($request->getMethod(), $this->requestTypes)) {
 
-            $url = parse_url($url);
+            $url = parse_url($request->getUri());
             $url = $url['path'];
 
             $url = explode('/', trim($url, '/'));
@@ -63,7 +54,7 @@ class RouterRoute extends RouterEntry {
 
                 // Check if url matches
                 foreach($route as $i => $path) {
-                    $parameter = $this->parseParameter($path);
+                    $parameter = $this->parseParameters($path);
 
                     // Check if parameter of path matches, otherwise quit..
                     if(is_null($parameter) && strtolower($path) != strtolower($url[$i])) {
@@ -73,7 +64,21 @@ class RouterRoute extends RouterEntry {
 
                     // Save parameter if we have one
                     if($parameter) {
-                        $parameters[$parameter] = $url[$i];
+                        $parameterValue = $url[$i];
+                        $regex = (isset($this->parametersRegex[$parameter]) ? $this->parametersRegex[$parameter] : null);
+
+                        if($regex !== null) {
+                            // Use the regular expression rule provided to filter the value
+                            $matches = array();
+                            preg_match('/'.$regex.'/is', $url[$i], $matches);
+
+                            if(count($matches)) {
+                                $parameterValue = $matches[0];
+                            }
+                        }
+
+                        // Add parameter value
+                        $parameters[$parameter] = $parameterValue;
                     }
                 }
 
@@ -82,7 +87,6 @@ class RouterRoute extends RouterEntry {
                     $this->parameters = $parameters;
                     return $this;
                 }
-
             }
         }
 
@@ -103,7 +107,7 @@ class RouterRoute extends RouterEntry {
      */
     public function setUrl($url) {
 
-        $parameters = $this->parseParameters($url);
+        $parameters = $this->parseParameters($url, true);
 
         if($parameters !== null) {
             foreach($parameters as $param) {
@@ -131,7 +135,9 @@ class RouterRoute extends RouterEntry {
      * @return self
      */
     public function addAlias($alias) {
-        $this->aliases[] = $alias;
+        $arr = $this->aliases;
+        $arr[] = $alias;
+        $this->aliases = $arr;
         return $this;
     }