Source for file Route.php

Documentation is available at Route.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Application
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25: require_once dirname(__FILE__) . '/../Application/IRouter.php';
26:
27:
28:
29: /**
30: * The bidirectional route is responsible for mapping
31: * HTTP request to a PresenterRoute object for dispatch and vice-versa.
32: *
33: * @author David Grudl
34: * @copyright Copyright (c) 2004, 2009 David Grudl
35: * @package Nette\Application
36: */
37: class Route extends Object implements IRouter
38: {
39: const PRESENTER_KEY = 'presenter';
40: const MODULE_KEY = 'module';
41:
42: /** flag */
43: const CASE_SENSITIVE = 256;
44:
45: /**#@+ uri type */
46: const HOST = 1;
47: const PATH = 2;
48: const RELATIVE = 3;
49: /**#@-*/
50:
51: /**#@+ key used in {@link Route::$styles} */
52: const PATTERN = 'pattern';
53: const FILTER_IN = 'filterIn';
54: const FILTER_OUT = 'filterOut';
55: const FILTER_TABLE = 'filterTable';
56: /**#@-*/
57:
58: /**#@+ @ignore internal fixity types - how to handle 'default' value? {@link Route::$metadata} */
59: const OPTIONAL = 0;
60: const PATH_OPTIONAL = 1;
61: const CONSTANT = 2;
62: /**#@-*/
63:
64: /** @var bool */
65: public static $defaultFlags = 0;
66:
67: /** @var array */
68: public static $styles = array(
69: '#' => array( // default style for path parameters
70: self::PATTERN => '[^/]+',
71: self::FILTER_IN => 'rawurldecode',
72: self::FILTER_OUT => 'rawurlencode',
73: ),
74: '?#' => array( // default style for query parameters
75: ),
76: 'module' => array(
77: self::PATTERN => '[a-z][a-z0-9.-]*',
78: self::FILTER_IN => array(__CLASS__, 'path2presenter'),
79: self::FILTER_OUT => array(__CLASS__, 'presenter2path'),
80: ),
81: 'presenter' => array(
82: self::PATTERN => '[a-z][a-z0-9.-]*',
83: self::FILTER_IN => array(__CLASS__, 'path2presenter'),
84: self::FILTER_OUT => array(__CLASS__, 'presenter2path'),
85: ),
86: 'action' => array(
87: self::PATTERN => '[a-z][a-z0-9-]*',
88: self::FILTER_IN => array(__CLASS__, 'path2action'),
89: self::FILTER_OUT => array(__CLASS__, 'action2path'),
90: ),
91: '?module' => array(
92: ),
93: '?presenter' => array(
94: ),
95: '?action' => array(
96: ),
97: );
98:
99: /** @var string */
100: private $mask;
101:
102: /** @var array */
103: private $sequence;
104:
105: /** @var string regular expression pattern */
106: private $re;
107:
108: /** @var array of [default & fixity, filterIn, filterOut] */
109: protected $metadata = array();
110:
111: /** @var array */
112: protected $xlat;
113:
114: /** @var int HOST, PATH, RELATIVE */
115: protected $type;
116:
117: /** @var int */
118: protected $flags;
119:
120:
121:
122: /**
123: * @param string URL mask, e.g. '<presenter>/<action>/<id \d{1,3}>'
124: * @param array default values
125: * @param int flags
126: */
127: public function __construct($mask, array $defaults = array(), $flags = 0)
128: {
129: $this->flags = $flags | self::$defaultFlags;
130: $this->setMask($mask, $defaults);
131: }
132:
133:
134:
135: /**
136: * Maps HTTP request to a PresenterRequest object.
137: * @param IHttpRequest
138: * @return PresenterRequest|NULL
139: */
140: public function match(IHttpRequest $httpRequest)
141: {
142: // combine with precedence: mask (params in URL-path), fixity, query, (post,) defaults
143:
144: // 1) URL MASK
145: $uri = $httpRequest->getUri();
146:
147: if ($this->type === self::HOST) {
148: $path = '//' . $uri->host . $uri->path;
149:
150: } elseif ($this->type === self::RELATIVE) {
151: $basePath = $uri->basePath;
152: if (strncmp($uri->path, $basePath, strlen($basePath)) !== 0) {
153: return NULL;
154: }
155: $path = (string) substr($uri->path, strlen($basePath));
156:
157: } else {
158: $path = $uri->path;
159: }
160:
161: if ($path !== '') {
162: $path = rtrim($path, '/') . '/';
163: $path = String::fixEncoding($path);
164: }
165:
166: if (!preg_match($this->re, $path, $matches)) {
167: // stop, not matched
168: return NULL;
169: }
170:
171: // deletes numeric keys, restore '-' chars
172: $params = array();
173: foreach ($matches as $k => $v) {
174: if (is_string($k)) {
175: $params[str_replace('___', '-', $k)] = $v; // trick
176: }
177: }
178:
179:
180: // 2) CONSTANT FIXITY
181: foreach ($this->metadata as $name => $meta) {
182: if (isset($params[$name])) {
183: //$params[$name] = $this->flags & self::CASE_SENSITIVE === 0 ? strtolower($params[$name]) : */$params[$name]; // strtolower damages UTF-8
184:
185: } elseif (isset($meta['fixity']) && $meta['fixity'] !== self::OPTIONAL) {
186: $params[$name] = NULL; // cannot be overwriten in 3) and detected by isset() in 4)
187: }
188: }
189:
190:
191: // 3) QUERY
192: if ($this->xlat) {
193: $params += self::renameKeys($httpRequest->getQuery(), array_flip($this->xlat));
194: } else {
195: $params += $httpRequest->getQuery();
196: }
197:
198:
199: // 4) APPLY FILTERS & FIXITY
200: foreach ($this->metadata as $name => $meta) {
201: if (isset($params[$name])) {
202: if (isset($meta[self::FILTER_TABLE][$params[$name]])) { // applyies filterTable only to path parameters
203: $params[$name] = $meta[self::FILTER_TABLE][$params[$name]];
204:
205: } elseif (isset($meta[self::FILTER_IN])) { // applyies filterIn only to path parameters
206: $params[$name] = call_user_func($meta[self::FILTER_IN], $params[$name]);
207: }
208:
209: } elseif (isset($meta['fixity'])) {
210: $params[$name] = $meta['default'];
211: }
212: }
213:
214:
215: // 5) BUILD PresenterRequest
216: if (!isset($params[self::PRESENTER_KEY])) {
217: throw new InvalidStateException('Missing presenter in route definition.');
218: }
219: if (isset($this->metadata[self::MODULE_KEY])) {
220: if (!isset($params[self::MODULE_KEY])) {
221: throw new InvalidStateException('Missing module in route definition.');
222: }
223: $presenter = $params[self::MODULE_KEY] . ':' . $params[self::PRESENTER_KEY];
224: unset($params[self::MODULE_KEY], $params[self::PRESENTER_KEY]);
225:
226: } else {
227: $presenter = $params[self::PRESENTER_KEY];
228: unset($params[self::PRESENTER_KEY]);
229: }
230:
231: return new PresenterRequest(
232: $presenter,
233: $httpRequest->getMethod(),
234: $params,
235: $httpRequest->getPost(),
236: $httpRequest->getFiles(),
237: array('secured' => $httpRequest->isSecured())
238: );
239: }
240:
241:
242:
243: /**
244: * Constructs absolute URL from PresenterRequest object.
245: * @param IHttpRequest
246: * @param PresenterRequest
247: * @return string|NULL
248: */
249: public function constructUrl(PresenterRequest $appRequest, IHttpRequest $httpRequest)
250: {
251: if ($this->flags & self::ONE_WAY) {
252: return NULL;
253: }
254:
255: $params = $appRequest->getParams();
256: $metadata = $this->metadata;
257:
258: $presenter = $appRequest->getPresenterName();
259: if (isset($metadata[self::MODULE_KEY])) {
260: if (isset($metadata[self::MODULE_KEY]['fixity'])) {
261: $a = strlen($metadata[self::MODULE_KEY]['default']);
262: if (substr($presenter, $a, 1) !== ':') {
263: return NULL; // module not match
264: }
265: } else {
266: $a = strrpos($presenter, ':');
267: }
268: $params[self::MODULE_KEY] = substr($presenter, 0, $a);
269: $params[self::PRESENTER_KEY] = substr($presenter, $a + 1);
270: } else {
271: $params[self::PRESENTER_KEY] = $presenter;
272: }
273:
274: foreach ($metadata as $name => $meta) {
275: if (!isset($params[$name])) continue; // retains NULL values
276:
277: if (isset($meta['fixity'])) {
278: if (strcasecmp($params[$name], $meta['default']) === 0) { // intentionally ==
279: // remove default values; NULL values are retain
280: unset($params[$name]);
281: continue;
282:
283: } elseif ($meta['fixity'] === self::CONSTANT) {
284: return NULL; // missing or wrong parameter '$name'
285: }
286: }
287:
288: if (isset($meta['filterTable2'][$params[$name]])) {
289: $params[$name] = $meta['filterTable2'][$params[$name]];
290:
291: } elseif (isset($meta[self::FILTER_OUT])) {
292: $params[$name] = call_user_func($meta[self::FILTER_OUT], $params[$name]);
293: }
294:
295: if (isset($meta[self::PATTERN]) && !preg_match($meta[self::PATTERN], $params[$name])) {
296: return NULL; // pattern not match
297: }
298: }
299:
300: // compositing path
301: $sequence = $this->sequence;
302: $optional = TRUE;
303: $uri = '';
304: $i = count($sequence) - 1;
305: do {
306: $uri = $sequence[$i] . $uri;
307: if ($i === 0) break;
308: $i--;
309:
310: $name = $sequence[$i]; $i--; // parameter name
311:
312: if ($name[0] === '?') { // "foo" parameter
313: continue;
314:
315: } elseif (isset($params[$name]) && $params[$name] != '') { // intentionally ==
316: $optional = FALSE;
317: $uri = $params[$name] . $uri;
318: unset($params[$name]);
319:
320: } elseif (isset($metadata[$name]['fixity'])) { // has default value?
321: if ($optional) {
322: $uri = '';
323:
324: } elseif ($metadata[$name]['default'] == '') { // intentionally ==
325: if ($uri[0] === '/' && substr($sequence[$i], -1) === '/') {
326: return NULL; // default value is empty but is required
327: }
328:
329: } else {
330: $uri = $metadata[$name]['defOut'] . $uri;
331: }
332:
333: } else {
334: return NULL; // missing parameter '$name'
335: }
336: } while (TRUE);
337:
338:
339: // build query string
340: if ($this->xlat) {
341: $params = self::renameKeys($params, $this->xlat);
342: }
343:
344: $query = http_build_query($params, '', '&');
345: if ($query != '') $uri .= '?' . $query; // intentionally ==
346:
347: // absolutize path
348: if ($this->type === self::RELATIVE) {
349: $uri = '//' . $httpRequest->getUri()->authority . $httpRequest->getUri()->basePath . $uri;
350:
351: } elseif ($this->type === self::PATH) {
352: $uri = '//' . $httpRequest->getUri()->authority . $uri;
353: }
354:
355: $uri = ($this->flags & self::SECURED ? 'https:' : 'http:') . $uri;
356:
357: return $uri;
358: }
359:
360:
361:
362: /**
363: * Parse mask and array of default values; initializes object.
364: * @param string
365: * @param array
366: * @return void
367: */
368: private function setMask($mask, array $defaults)
369: {
370: $this->mask = $mask;
371:
372: // detect '//host/path' vs. '/abs. path' vs. 'relative path'
373: if (substr($mask, 0, 2) === '//') {
374: $this->type = self::HOST;
375:
376: } elseif (substr($mask, 0, 1) === '/') {
377: $this->type = self::PATH;
378:
379: } else {
380: $this->type = self::RELATIVE;
381: }
382:
383: $metadata = array();
384: foreach ($defaults as $name => $def) {
385: if ($name === 'view') $name = 'action'; // back compatibility
386: $metadata[$name] = array(
387: 'default' => $def,
388: 'fixity' => self::CONSTANT
389: );
390: }
391:
392:
393: // 1) PARSE QUERY PART OF MASK
394: $this->xlat = array();
395: $pos = strpos($mask, ' ? ');
396: if ($pos !== FALSE) {
397: preg_match_all(
398: '/(?:([a-zA-Z0-9_.-]+)=)?<([^># ]+) *([^>#]*)(#?[^>]*)>/', // name=<parameter-name [pattern][#class]>
399: substr($mask, $pos + 1),
400: $matches,
401: PREG_SET_ORDER
402: );
403: $mask = rtrim(substr($mask, 0, $pos));
404:
405: foreach ($matches as $match) {
406: list(, $param, $name, $pattern, $class) = $match; // $pattern is unsed
407: if ($name === 'view') $name = 'action'; // back compatibility
408:
409: if ($class !== '') {
410: if (!isset(self::$styles[$class])) {
411: throw new InvalidStateException("Parameter '$name' has '$class' flag, but Route::\$styles['$class'] is not set.");
412: }
413: $meta = self::$styles[$class];
414:
415: } elseif (isset(self::$styles['?' . $name])) {
416: $meta = self::$styles['?' . $name];
417:
418: } else {
419: $meta = self::$styles['?#'];
420: }
421:
422: if (isset($metadata[$name])) {
423: $meta = $meta + $metadata[$name];
424: }
425:
426: if (array_key_exists('default', $meta)) {
427: $meta['fixity'] = self::OPTIONAL;
428: }
429:
430: unset($meta['pattern']);
431: $meta['filterTable2'] = empty($meta[self::FILTER_TABLE]) ? NULL : array_flip($meta[self::FILTER_TABLE]);
432:
433: $metadata[$name] = $meta;
434: if ($param !== '') {
435: $this->xlat[$name] = $param;
436: }
437: }
438: }
439:
440:
441: // 2) PARSE URI-PATH PART OF MASK
442: $parts = preg_split(
443: '/<([^># ]+) *([^>#]*)(#?[^>]*)>/', // <parameter-name [pattern][#class]>
444: $mask,
445: -1,
446: PREG_SPLIT_DELIM_CAPTURE
447: );
448:
449: $optional = TRUE;
450: $sequence = array();
451: $i = count($parts) - 1;
452: $re = '';
453: do {
454: array_unshift($sequence, $parts[$i]);
455: $re = preg_quote($parts[$i], '#') . $re;
456: if ($i === 0) break;
457: $i--;
458:
459: $class = $parts[$i]; $i--; // validation class
460: $pattern = $parts[$i]; $i--; // validation condition (as regexp)
461: $name = $parts[$i]; $i--; // parameter name
462: if ($name === 'view') $name = 'action'; // back compatibility
463: array_unshift($sequence, $name);
464:
465: if ($name[0] === '?') { // "foo" parameter
466: $re = '(?:' . $pattern . ')' . $re;
467: $sequence[1] = substr($name, 1) . $sequence[1];
468: continue;
469: }
470:
471: // check name (limitation by regexp)
472: if (preg_match('#[^a-z0-9_-]#i', $name)) {
473: throw new InvalidArgumentException("Parameter name must be alphanumeric string due to limitations of PCRE, '$name' given.");
474: }
475:
476: // pattern, condition & metadata
477: if ($class !== '') {
478: if (!isset(self::$styles[$class])) {
479: throw new InvalidStateException("Parameter '$name' has '$class' flag, but Route::\$styles['$class'] is not set.");
480: }
481: $meta = self::$styles[$class];
482:
483: } elseif (isset(self::$styles[$name])) {
484: $meta = self::$styles[$name];
485:
486: } else {
487: $meta = self::$styles['#'];
488: }
489:
490: if (isset($metadata[$name])) {
491: $meta = $meta + $metadata[$name];
492: }
493:
494: if ($pattern == '' && isset($meta[self::PATTERN])) {
495: $pattern = $meta[self::PATTERN];
496: }
497:
498: $meta['filterTable2'] = empty($meta[self::FILTER_TABLE]) ? NULL : array_flip($meta[self::FILTER_TABLE]);
499: if (isset($meta['default'])) {
500: if (isset($meta['filterTable2'][$meta['default']])) {
501: $meta['defOut'] = $meta['filterTable2'][$meta['default']];
502:
503: } elseif (isset($meta[self::FILTER_OUT])) {
504: $meta['defOut'] = call_user_func($meta[self::FILTER_OUT], $meta['default']);
505:
506: } else {
507: $meta['defOut'] = $meta['default'];
508: }
509: }
510: $meta[self::PATTERN] = "#(?:$pattern)$#A" . ($this->flags & self::CASE_SENSITIVE ? '' : 'i');
511: $metadata[$name] = $meta;
512:
513: // include in expression
514: $tmp = str_replace('-', '___', $name); // dirty trick to enable '-' in parameter name
515: if (isset($meta['fixity'])) { // has default value?
516: if (!$optional) {
517: throw new InvalidArgumentException("Parameter '$name' must not be optional because parameters standing on the right side are not optional.");
518: }
519: $re = '(?:(?P<' . $tmp . '>' . $pattern . ')' . $re . ')?';
520: $metadata[$name]['fixity'] = self::PATH_OPTIONAL;
521:
522: } else {
523: $optional = FALSE;
524: $re = '(?P<' . $tmp . '>' . $pattern . ')' . $re;
525: }
526: } while (TRUE);
527:
528: $this->re = '#' . $re . '/?$#A' . ($this->flags & self::CASE_SENSITIVE ? '' : 'i');
529: $this->metadata = $metadata;
530: $this->sequence = $sequence;
531: }
532:
533:
534:
535: /**
536: * Returns mask.
537: * @return string
538: */
539: public function getMask()
540: {
541: return $this->mask;
542: }
543:
544:
545:
546: /**
547: * Returns default values.
548: * @return array
549: */
550: public function getDefaults()
551: {
552: $defaults = array();
553: foreach ($this->metadata as $name => $meta) {
554: if (isset($meta['fixity'])) {
555: $defaults[$name] = $meta['default'];
556: }
557: }
558: return $defaults;
559: }
560:
561:
562:
563: /********************* Utilities ****************d*g**/
564:
565:
566:
567: /**
568: * Proprietary cache aim.
569: * @return string|FALSE
570: */
571: public function getTargetPresenter()
572: {
573: if ($this->flags & self::ONE_WAY) {
574: return FALSE;
575: }
576:
577: $m = $this->metadata;
578: $module = '';
579:
580: if (isset($m[self::MODULE_KEY])) {
581: if (isset($m[self::MODULE_KEY]['fixity']) && $m[self::MODULE_KEY]['fixity'] === self::CONSTANT) {
582: $module = $m[self::MODULE_KEY]['default'] . ':';
583: } else {
584: return NULL;
585: }
586: }
587:
588: if (isset($m[self::PRESENTER_KEY]['fixity']) && $m[self::PRESENTER_KEY]['fixity'] === self::CONSTANT) {
589: return $module . $m[self::PRESENTER_KEY]['default'];
590: }
591: return NULL;
592: }
593:
594:
595:
596: /**
597: * Rename keys in array.
598: * @param array
599: * @param array
600: * @return array
601: */
602: private static function renameKeys($arr, $xlat)
603: {
604: if (empty($xlat)) return $arr;
605:
606: $res = array();
607: $occupied = array_flip($xlat);
608: foreach ($arr as $k => $v) {
609: if (isset($xlat[$k])) {
610: $res[$xlat[$k]] = $v;
611:
612: } elseif (!isset($occupied[$k])) {
613: $res[$k] = $v;
614: }
615: }
616: return $res;
617: }
618:
619:
620:
621: /********************* Inflectors ****************d*g**/
622:
623:
624:
625: /**
626: * camelCaseAction name -> dash-separated.
627: * @param string
628: * @return string
629: */
630: private static function action2path($s)
631: {
632: $s = preg_replace('#(.)(?=[A-Z])#', '$1-', $s);
633: $s = strtolower($s);
634: $s = rawurlencode($s);
635: return $s;
636: }
637:
638:
639:
640: /**
641: * dash-separated -> camelCaseAction name.
642: * @param string
643: * @return string
644: */
645: private static function path2action($s)
646: {
647: $s = strtolower($s);
648: $s = preg_replace('#-(?=[a-z])#', ' ', $s);
649: $s = substr(ucwords('x' . $s), 1);
650: //$s = lcfirst(ucwords($s));
651: $s = str_replace(' ', '', $s);
652: return $s;
653: }
654:
655:
656:
657: /**
658: * PascalCase:Presenter name -> dash-and-dot-separated.
659: * @param string
660: * @return string
661: */
662: private static function presenter2path($s)
663: {
664: $s = strtr($s, ':', '.');
665: $s = preg_replace('#([^.])(?=[A-Z])#', '$1-', $s);
666: $s = strtolower($s);
667: $s = rawurlencode($s);
668: return $s;
669: }
670:
671:
672:
673: /**
674: * dash-and-dot-separated -> PascalCase:Presenter name.
675: * @param string
676: * @return string
677: */
678: private static function path2presenter($s)
679: {
680: $s = strtolower($s);
681: $s = preg_replace('#([.-])(?=[a-z])#', '$1 ', $s);
682: $s = ucwords($s);
683: $s = str_replace('. ', ':', $s);
684: $s = str_replace('- ', '', $s);
685: return $s;
686: }
687:
688:
689:
690: /********************* Route::$styles manipulator ****************d*g**/
691:
692:
693:
694: /**
695: * Creates new style.
696: * @param string style name (#style, urlParameter, ?queryParameter)
697: * @param string optional parent style name
698: * @param void
699: */
700: public static function addStyle($style, $parent = '#')
701: {
702: if (isset(self::$styles[$style])) {
703: throw new InvalidArgumentException("Style '$style' already exists.");
704: }
705:
706: if ($parent !== NULL) {
707: if (!isset(self::$styles[$parent])) {
708: throw new InvalidArgumentException("Parent style '$parent' doesn't exist.");
709: }
710: self::$styles[$style] = self::$styles[$parent];
711:
712: } else {
713: self::$styles[$style] = array();
714: }
715: }
716:
717:
718:
719: /**
720: * Changes style property value.
721: * @param string style name (#style, urlParameter, ?queryParameter)
722: * @param string property name (Route::PATTERN, Route::FILTER_IN, Route::FILTER_OUT, Route::FILTER_TABLE)
723: * @param mixed property value
724: * @param void
725: */
726: public static function setStyleProperty($style, $key, $value)
727: {
728: if (!isset(self::$styles[$style])) {
729: throw new InvalidArgumentException("Style '$style' doesn't exist.");
730: }
731: self::$styles[$style][$key] = $value;
732: }
733:
734: }
735:
736:
737:
738: // back-compatibility
739: Route::$styles['view'] = & Route::$styles['action'];
740: Route::$styles['?view'] = & Route::$styles['?action'];

Source for file Route.php

Namespaces