Merge pull request #41 from skipperbent/development

[TASK] Optimised cache method in Response class.

README.md

@@ -28,12 +28,12 @@ Add the latest version pf Simple PHP Router to your ```composer.json```
 - Namespaces.
 - Route prefixes.
 - CSRF protection.
+- Optional parameters
 
 ### Features currently "in-the-works"
 
 - Global Constraints
-- Sub-Domain Routing
-- Optional parameters
+- Sub-domain routing
 
 ## Initialising the router
 
@@ -72,10 +72,12 @@ use Pecee\SimpleRouter\SimpleRouter;
 
 SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\SomeMiddlewareClass'], function() {
 
-    SimpleRouter::group(['prefix' => 'services'], function() {
+    SimpleRouter::group(['prefix' => '/services', 'exceptionHandler' => '\MyProject\Handler\CustomExceptionHandler'], function() {
 
-        SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')
-        ->where(['id' => '[0-9]+');
+        SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')->where(['id' => '[0-9]+');
+        
+        // Optional parameter
+        SimpleRouter::get('/answers/{id?}', 'ControllerAnswers@show');
 
         /**
          * This example will route url when matching the regular expression to the method.
@@ -83,7 +85,7 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
          */
         SimpleRouter::all('/ajax', 'ControllerAjax@process')->match('ajax\\/([A-Za-z0-9\\/]+)');
 
-        // Resetful resource
+        // Restful resource
         SimpleRouter::resource('/rest', 'ControllerRessource');
 
         // Load the entire controller (where url matches method names - getIndex(), postIndex() etc)
@@ -129,47 +131,57 @@ The framework has it's own ```Router``` class which inherits from the ```SimpleR
 namespace MyProject;
 
 use Pecee\Handler\ExceptionHandler;
+use Pecee\SimpleRouter\RouterBase;
 use Pecee\SimpleRouter\SimpleRouter;
 
 class Router extends SimpleRouter {
 
-    protected static $exceptionHandlers = array();
+    protected static $defaultExceptionHandler;
 
-    public static function start() {
-
-        Debug::getInstance()->add('Router initialised.');
+    public static function start($defaultNamespace = null) {
 
         // Load routes.php
-        $file = $_ENV['basePath'] . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'routes.php';
+        $file = $_ENV['base_path'] . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'routes.php';
         if(file_exists($file)) {
             require_once $file;
         }
 
-        // Init locale settings
-        Locale::getInstance();
-
-        // Set default namespace for routes
-        $defaultNamespace = '\\'.Registry::getInstance()->get('AppName') . '\\Controller';
-        
-        // Add custom csrf verifier (must extend BaseCsrfVerifier)
-        parent::csrfVerifier('MyProject\Middleware\CustomCsrfVerifier');
+        // Set default namespace
+        $defaultNamespace = '\\'.$_ENV['app_name'] . '\\Controller';
 
         // Handle exceptions
         try {
             parent::start($defaultNamespace);
         } catch(\Exception $e) {
-            /* @var $handler ExceptionHandler */
-            foreach(self::$exceptionHandlers as $handler) {
-                $class = new $handler();
-                $class->handleError($e);
+
+            $route = RouterBase::getInstance()->getLoadedRoute();
+
+            $exceptionHandler = null;
+
+            // Load and use exception-handler defined on group
+            
+            if($route && $route->getGroup()) {
+                $exceptionHandler = $route->getGroup()->getExceptionHandler();
+                
+                if($exceptionHandler !== null) {
+                    $class = new $exceptionHandler();
+                    $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
+                }
+            }
+
+            // Otherwise use the fallback default exceptions handler
+           
+            if(self::$defaultExceptionHandler !== null) {
+                $class = new self::$defaultExceptionHandler();
+                $class->handleError(RouterBase::getInstance()->getRequest(), $route, $e);
             }
 
             throw $e;
         }
     }
 
-    public static function addExceptionHandler($handler) {
-        self::$exceptionHandlers[] = $handler;
+    public static function setDefaultExceptionHandler($handler) {
+        self::$defaultExceptionHandler = $handler;
     }
 
 }
@@ -251,7 +263,7 @@ The router can be easily extended to customize your needs.
 
 ## The MIT License (MIT)
 
-Copyright (c) 2015 Simon Sessing� / simple-php-router
+Copyright (c) 2015 Simon Sessingø / simple-php-router
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/Pecee/Http/Request.php

@@ -30,6 +30,10 @@ class Request {
         $this->headers = array_change_key_case(getallheaders(), CASE_LOWER);
     }
 
+    public function getIsSecure() {
+        return isset($_SERVER['HTTPS']) ? true : (isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] === 443);
+    }
+
     /**
      * @return string
      */

src/Pecee/Http/Response.php

@@ -42,12 +42,24 @@ class Response {
         return $this;
     }
 
-    public function cache($duration = 2592000) {
+    public function cache($eTag, $lastModified = 2592000) {
+
         $this->headers([
-            'Cache-Control: public,max-age='.$duration.',must-revalidate',
-            'Expires: '.gmdate('D, d M Y H:i:s',(time()+$duration)).' GMT',
-            'Last-modified: '.gmdate('D, d M Y H:i:s',time()).' GMT'
+            'Cache-Control: public',
+            'Last-Modified: ' . gmdate("D, d M Y H:i:s", $lastModified) . ' GMT',
+            'Etag: ' . $eTag
         ]);
+
+        if(isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) === $lastModified ||
+            isset($_SERVER['HTTP_IF_NONE_MATCH']) && $_SERVER['HTTP_IF_NONE_MATCH'] === $eTag) {
+
+            $this->headers([
+                'HTTP/1.1 304 Not Modified'
+            ]);
+
+            exit();
+        }
+
         return $this;
     }
 

src/Pecee/SimpleRouter/RouterBase.php

@@ -39,12 +39,16 @@ class RouterBase {
         }
     }
 
-    protected function processRoutes(array $routes, array $settings = array(), array $prefixes = array(), $backstack = false) {
+    protected function processRoutes(array $routes, array $settings = array(), array $prefixes = array(), $backstack = false, $group = null) {
         // Loop through each route-request
 
+        $activeGroup = null;
+
         /* @var $route RouterEntry */
         foreach($routes as $route) {
 
+            $route->setGroup($group);
+
             if($this->defaultNamespace && !$route->getNamespace()) {
                 $namespace = null;
                 if ($route->getNamespace()) {
@@ -75,6 +79,7 @@ class RouterBase {
             $this->currentRoute = $route;
             if($route instanceof RouterGroup && is_callable($route->getCallback())) {
                 $route->renderRoute($this->request);
+                $activeGroup = $route;
             }
             $this->currentRoute = null;
 
@@ -83,7 +88,7 @@ class RouterBase {
                 $this->backstack = array();
 
                 // Route any routes added to the backstack
-                $this->processRoutes($backstack, $mergedSettings, $newPrefixes, true);
+                $this->processRoutes($backstack, $mergedSettings, $newPrefixes, true, $activeGroup);
             }
         }
     }
@@ -224,7 +229,7 @@ class RouterBase {
                 $i = 0;
                 foreach($params as $param => $value) {
                     $value = (isset($parameters[$param])) ? $parameters[$param] : $value;
-                    $url = str_ireplace('{' . $param. '}', $value, $url);
+                    $url = str_ireplace(array('{' . $param. '}', '{' . $param. '?}'), $value, $url);
                     $i++;
                 }
             } else {

src/Pecee/SimpleRouter/RouterEntry.php

@@ -317,6 +317,15 @@ abstract class RouterEntry {
         return $this->settings['requestMethods'];
     }
 
+    public function getGroup() {
+        return $this->group;
+    }
+
+    public function setGroup($group) {
+        $this->group = $group;
+        return $this;
+    }
+
     abstract function matchRoute(Request $request);
 
 }

src/Pecee/SimpleRouter/RouterGroup.php

@@ -12,32 +12,34 @@ class RouterGroup extends RouterEntry {
 
     public function renderRoute(Request $request) {
         // Check if request method is allowed
+        $hasAccess = (!$this->method);
 
-        if(trim($this->prefix) === '' || 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($request->getMethod(), $this->getRequestMethods()));
-                } else {
-                    $hasAccess = strtolower($this->getRequestMethods()) == strtolower($request->getMethod());
-                }
+        if($this->method) {
+            if(is_array($this->method)) {
+                $hasAccess = (in_array($request->getMethod(), $this->getRequestMethods()));
+            } else {
+                $hasAccess = strtolower($this->getRequestMethods()) == strtolower($request->getMethod());
             }
-
-            if(!$hasAccess) {
-                throw new RouterException('Method not allowed');
-            }
-
-            return parent::renderRoute($request);
         }
 
-        // No match here, move on...
-        return null;
+        if(!$hasAccess) {
+            throw new RouterException('Method not allowed');
+        }
+
+        return parent::renderRoute($request);
     }
 
     public function matchRoute(Request $request) {
         return null;
     }
 
+    public function setExceptionHandler($class) {
+        $this->exceptionHandler = $class;
+        return $this;
+    }
+
+    public function getExceptionHandler() {
+        return $this->exceptionHandler;
+    }
+
 }

src/Pecee/SimpleRouter/RouterRoute.php

@@ -6,7 +6,7 @@ use Pecee\Http\Request;
 
 class RouterRoute extends RouterEntry {
 
-    const PARAMETERS_REGEX_MATCH = '{([A-Za-z\-\_]*?)}';
+    const PARAMETERS_REGEX_MATCH = '{([A-Za-z\-\_]*?)\?{0,1}}';
 
     protected $url;
 
@@ -18,95 +18,101 @@ class RouterRoute extends RouterEntry {
         $this->settings['aliases'] = array();
     }
 
-    protected function parseParameters($url, $multiple = false, $regex = self::PARAMETERS_REGEX_MATCH) {
-        $url = rtrim($url, '/');
-        $parameters = array();
-
-        if($multiple) {
-            preg_match_all('/'.$regex.'/is', $url, $parameters);
-        } else {
-            preg_match('/'.$regex.'/is', $url, $parameters);
-        }
-
-        if(isset($parameters[1]) && count($parameters[1]) > 0) {
-            return $parameters[1];
-        }
-
-        return null;
-    }
-
     public function matchRoute(Request $request) {
 
-        // Check if request method is allowed
-
         $url = parse_url($request->getUri());
-        $url = $url['path'];
+        $url = rtrim($url['path'], '/') . '/';
 
-        $route = $this->url;
-
-        $routeMatch = preg_replace('/'.self::PARAMETERS_REGEX_MATCH.'/is', '', $route);
-
-        // Check if url parameter count matches
-        if(stripos($url, $routeMatch) === 0) {
-
-            $matches = true;
-
-            if($this->regexMatch) {
-                $parameters = $this->parseParameters($url, true, $this->regexMatch);
-
-                // If regex doesn't match, make sure to return an array
-                if(!is_array($parameters)) {
-                    $parameters = array();
-                }
-
-            } else {
-
-                $matches = (count(explode('/', rtrim($url, '/'))) == count(explode('/', rtrim($route, '/'))));
-
-                $url = explode('/', $url);
-                $route = explode('/', rtrim($route, '/'));
-
-                $parameters = array();
-
-                // Check if url matches
-                foreach ($route as $i => $path) {
-                    $parameter = $this->parseParameters($path, false);
-
-                    // Check if parameter of path matches, otherwise quit..
-                    if (is_null($parameter) && strtolower($path) != strtolower($url[$i])) {
-                        $matches = false;
-                        break;
-                    }
-
-                    // Save parameter if we have one
-                    if ($parameter) {
-                        $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, if it doesn't exist - replace it with null value
-                        $parameters[$parameter] = ($parameterValue === '') ? null : $parameterValue;
-                    }
-                }
-            }
-
-            // This route matches
-            if($matches) {
-                $this->parameters = $parameters;
+        // Match on custom defined regular expression
+        if($this->regexMatch) {
+            $parameters = array();
+            if(preg_match('/('.$this->regexMatch.')/is', $url, $parameters)) {
+                $this->parameters = (!is_array($parameters[0]) ? array($parameters[0]) : $parameters[0]);
                 return $this;
             }
         }
 
-        // No match here, move on...
+        // Make regular expression based on route
+
+        $route = rtrim($this->url, '/') . '/';
+
+        $parameterNames = array();
+        $regex = '';
+        $lastCharacter = '';
+        $isParameter = false;
+        $parameter = '';
+
+        for($i = 0; $i < strlen($route); $i++) {
+
+            $character = $route[$i];
+
+            // Skip "/" if we are at the end of a parameter
+            if($lastCharacter === '}' && $character === '/') {
+                $lastCharacter = $character;
+                continue;
+            }
+
+            if($character === '{') {
+                // Remove "/" and "\" from regex
+                if(substr($regex, strlen($regex)-1) === '/') {
+                    $regex = substr($regex, 0, strlen($regex) - 2);
+                }
+
+                $isParameter = true;
+            } elseif($isParameter && $character === '}') {
+                $required = true;
+                // Check for optional parameter
+                if($lastCharacter === '?') {
+                    $parameter = substr($parameter, 0, strlen($parameter)-1);
+                    $regex .= '(?:(?:\/{0,1}(?P<'.$parameter.'>[a-z0-9]*?)){0,1}\\/)';
+                    $required = false;
+                } else {
+                    // Use custom parameter regex if it exists
+                    $parameterRegex = '[a-z0-9]*?';
+
+                    if(is_array($this->parametersRegex) && isset($this->parametersRegex[$parameter])) {
+                        $parameterRegex = $this->parametersRegex[$parameter];
+                    }
+
+                    $regex .= '(?:\\/{0,1}(?P<' . $parameter . '>'. $parameterRegex .')\\/)';
+                }
+                $parameterNames[] = array('name' => $parameter, 'required' => $required);
+                $parameter = '';
+                $isParameter = false;
+
+            } elseif($isParameter) {
+                $parameter .= $character;
+            } elseif($character === '/') {
+                $regex .= '\\' . $character;
+            } else {
+                $regex .= $character;
+            }
+
+            $lastCharacter = $character;
+        }
+
+        $parameterValues = array();
+
+        if(preg_match('/^'.$regex.'$/is', $url, $parameterValues)) {
+
+            $parameters = array();
+
+            if(count($parameterNames)) {
+                foreach($parameterNames as $name) {
+                    $parameterValue = (isset($parameterValues[$name['name']]) && !empty($parameterValues[$name['name']])) ? $parameterValues[$name['name']] : null;
+
+                    if($name['required'] && $parameterValue === null) {
+                        throw new RouterException('Missing required parameter ' . $name['name'], 404);
+                    }
+
+                    $parameters[$name['name']] = $parameterValue;
+                }
+            }
+
+            $this->parameters = $parameters;
+            return $this;
+        }
+
         return null;
     }
 
@@ -123,9 +129,14 @@ class RouterRoute extends RouterEntry {
      */
     public function setUrl($url) {
 
-        $parameters = $this->parseParameters($url, true);
+        $parameters = array();
+        $matches = array();
 
-        if($parameters !== null) {
+        if(preg_match_all('/'.self::PARAMETERS_REGEX_MATCH.'/is', $url, $matches)) {
+            $parameters = $matches[1];
+        }
+
+        if(count($parameters)) {
             foreach($parameters as $param) {
                 $this->parameters[$param] = '';
             }

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -4,7 +4,7 @@
  * ---------------------------
  * Router helper class
  * ---------------------------
- * This class is added so calls can be made staticly like Router::get() making the code look more pretty.
+ * This class is added so calls can be made statically like Router::get() making the code look more pretty.
  */
 
 namespace Pecee\SimpleRouter;