File Routes.php | ICanBoogie/Routing v2.4.0

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Routing;

use ICanBoogie\HTTP\Request;
use ICanBoogie\Prototype\MethodNotDefined;

/**
 * A route collection.
 *
 * @method Routes any() any(string $pattern, $controller, array $options=[]) Add a route for any HTTP method.
 * @method Routes connect() connect(string $pattern, $controller, array $options=[]) Add a route for the HTTP method CONNECT.
 * @method Routes delete() delete(string $pattern, $controller, array $options=[]) Add a route for the HTTP method DELETE.
 * @method Routes get() get(string $pattern, $controller, array $options=[]) Add a route for the HTTP method GET.
 * @method Routes head() head(string $pattern, $controller, array $options=[]) Add a route for the HTTP method HEAD.
 * @method Routes options() options(string $pattern, $controller, array $options=[]) Add a route for the HTTP method OPTIONS.
 * @method Routes post() post(string $pattern, $controller, array $options=[]) Add a route for the HTTP method POST.
 * @method Routes put() put(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PUT.
 * @method Routes patch() patch(string $pattern, $controller, array $options=[]) Add a route for the HTTP method PATCH
 * @method Routes trace() trace(string $pattern, $controller, array $options=[]) Add a route for the HTTP method TRACE.
 */
class Routes implements \IteratorAggregate, \ArrayAccess
{
    const DEFAULT_ROUTE_CLASS = 'ICanBoogie\Routing\Route';

    static private $anonymous_id_count;

    static private function generate_anonymous_id()
    {
        return 'anonymous_route_' . ++self::$anonymous_id_count;
    }

    /**
     * Route definitions.
     *
     * @var array
     */
    protected $routes = [];

    /**
     * Route instances.
     *
     * @var Route[]
     */
    protected $instances = [];

    public function __construct(array $routes=[])
    {
        foreach ($routes as $route_id => $route)
        {
            if (is_numeric($route_id))
            {
                $route_id = null;
            }

            $this[$route_id] = $route;
        }
    }

    public function __call($method, array $arguments)
    {
        $method = strtoupper($method);

        if ($method === Request::METHOD_ANY || in_array($method, Request::$methods))
        {
            list($pattern, $controller, $options) = $arguments + [ 2 => [] ];

            $definition = [

                    'controller' => $controller,
                    'pattern' => $pattern

            ] + $options + [ 'via' => $method ];

            $this->add($definition);

            return $this;
        }

        throw new MethodNotDefined($method, $this);
    }

    protected function add(array $definition)
    {
        if (empty($definition['as']))
        {
            $definition['as'] = self::generate_anonymous_id();
        }

        $id = $definition['id'] = $definition['as'];

        unset($definition['as']);

        #

        if (empty($definition['pattern']))
        {
            throw new PatternNotDefined(\ICanBoogie\format("Route %id has no pattern. !route", [

                'id' => $id,
                'route' => $definition

            ]));
        }

        if (empty($definition['controller']) && empty($definition['location']))
        {
            throw new ControllerNotDefined(\ICanBoogie\format("Route %id has no controller. !route", [

                'id' => $id,
                'route' => $definition

            ]));
        }

        #
        # Separate controller class from its action.
        #

        if (isset($definition['controller']))
        {
            $controller = $definition['controller'];

            if (is_string($controller) && strpos($controller, '#'))
            {
                list($controller, $action) = explode('#', $controller);

                $definition['controller'] = $controller;
                $definition['action'] = $action;
            }
        }

        #

        $this->routes[$id] = $definition + [

            'via' => Request::METHOD_ANY

        ];

        $this->revoke_cache();

        return $this;
    }

    public function getIterator()
    {
        return new \ArrayIterator($this->routes);
    }

    public function offsetExists($offset)
    {
        return isset($this->routes[$offset]);
    }

    public function offsetGet($id)
    {
        if (isset($this->instances[$id]))
        {
            return $this->instances[$id];
        }

        if (!$this->offsetExists($id))
        {
            throw new RouteNotDefined($id);
        }

        $properties = $this->routes[$id];

        $class = static::DEFAULT_ROUTE_CLASS;

        if (isset($properties['class']))
        {
            $class = $properties['class'];
        }

        return $this->instances[$id] = new $class($this, $properties['pattern'], $properties);
    }

    /**
     * Define a route.
     *
     * @param string $id The identifier of the route.
     * @param array $route The route definition.
     */
    public function offsetSet($id, $route)
    {
        $this->add([ 'as' => $id ] + $route);
    }

    /**
     * Removes a route.
     *
     * @param string $offset The identifier of the route.
     */
    public function offsetUnset($offset)
    {
        unset($this->routes[$offset]);

        $this->revoke_cache();
    }

    /**
     * Search for a route matching the specified pathname and method.
     *
     * @param string $uri The URI to match. If the URI includes a query string it is removed
     * before searching for a matching route.
     * @param array|null $captured The parameters captured from the URI. If the URI included a
     * query string, its parsed params are stored under the `__query__` key.
     * @param string $method One of HTTP\Request::METHOD_* methods.
     * @param string $namespace Namespace restriction.
     *
     * @return Route|false|null
     */
    public function find($uri, &$captured = null, $method = Request::METHOD_ANY, $namespace = null)
    {
        $captured = [];

        if ($namespace)
        {
            $namespace = '/' . $namespace . '/';
        }

        $parsed = (array) parse_url($uri) + [ 'path' => null, 'query' => null ];
        $path = $parsed['path'];

        if (!$path)
        {
            return false;
        }

        #
        # Determine if a route matches prerequisites.
        #
        $matchable = function($pattern, $via) use($method, $namespace) {

            # namespace

            if ($namespace && strpos($pattern, $namespace) !== 0)
            {
                return false;
            }

            # via

            if ($method != Request::METHOD_ANY)
            {
                if (is_array($via))
                {
                    if (!in_array($method, $via))
                    {
                        return false;
                    }
                }
                else if ($via !== Request::METHOD_ANY && $via !== $method)
                {
                    return false;
                }
            }

            return true;
        };

        #
        # Search for a matching static route.
        #
        $map_static = function($routes) use($path, &$matchable) {

            foreach ($routes as $id => $route)
            {
                $pattern = $route['pattern'];
                $via = $route['via'];

                if (!$matchable($pattern, $via) || $pattern != $path)
                {
                    continue;
                }

                return $id;
            }

            return null;
        };

        #
        # Search for a matching dynamic route.
        #
        $map_dynamic = function($routes) use($path, &$matchable, &$captured) {

            foreach ($routes as $id => $route)
            {
                $pattern = $route['pattern'];
                $via = $route['via'];

                if (!$matchable($pattern, $via) || !Pattern::from($pattern)->match($path, $captured))
                {
                    continue;
                }

                return $id;
            }

            return null;
        };

        list($static, $dynamic) = $this->sort_routes();

        $id = null;

        if ($static)
        {
            $id = $map_static($static);
        }

        if (!$id && $dynamic)
        {
            $id = $map_dynamic($dynamic);
        }

        if (!$id)
        {
            return null;
        }

        $query = $parsed['query'];

        if ($query)
        {
            parse_str($query, $parsed_query_string);

            $captured['__query__'] = $parsed_query_string;
        }

        return $this[$id];
    }

    private $static;
    private $dynamic;

    /**
     * Revoke the cache used by the {@link sort_routes} method.
     */
    private function revoke_cache()
    {
        $this->static = null;
        $this->dynamic = null;
    }

    /**
     * Sort routes according to their type and computed weight.
     *
     * Routes and grouped in two groups: static routes and dynamic routes. The difference between
     * static and dynamic routes is that dynamic routes capture parameters from the path and thus
     * require a regex to compute the match, whereas static routes only require is simple string
     * comparison.
     *
     * Dynamic routes are ordered according to their weight, which is computed from the number
     * of static parts before the first capture. The more static parts, the lighter the route is.
     *
     * @return array An array with the static routes and dynamic routes.
     */
    private function sort_routes()
    {
        if ($this->static !== null)
        {
            return [ $this->static, $this->dynamic ];
        }

        $static = [];
        $dynamic = [];
        $weights = [];

        foreach ($this->routes as $id => $definition)
        {
            $pattern = $definition['pattern'];
            $first_capture_position = strpos($pattern, ':') ?: strpos($pattern, '<');

            if ($first_capture_position === false)
            {
                $static[$id] = $definition;
            }
            else
            {
                $dynamic[$id] = $definition;
                $weights[$id] = substr_count($pattern, '/', 0, $first_capture_position);
            }
        }

        \ICanBoogie\stable_sort($dynamic, function($v, $k) use($weights) {

            return -$weights[$k];

        });

        $this->static = $static;
        $this->dynamic = $dynamic;

        return [ $static, $dynamic ];
    }
}

Namespaces

Classes

Interfaces

Exceptions

Functions