1: <?php
2:
3: 4: 5: 6:
7:
8: namespace Nette\Application\Routers;
9:
10: use Nette;
11: use Nette\Application;
12: use Nette\Utils\Strings;
13:
14:
15: 16: 17: 18:
19: class Route implements Application\IRouter
20: {
21: use Nette\SmartObject;
22:
23: const PRESENTER_KEY = 'presenter';
24: const MODULE_KEY = 'module';
25:
26:
27: const HOST = 1,
28: PATH = 2,
29: RELATIVE = 3;
30:
31:
32: const VALUE = 'value';
33: const PATTERN = 'pattern';
34: const FILTER_IN = 'filterIn';
35: const FILTER_OUT = 'filterOut';
36: const FILTER_TABLE = 'filterTable';
37: const FILTER_STRICT = 'filterStrict';
38:
39:
40: const OPTIONAL = 0,
41: PATH_OPTIONAL = 1,
42: CONSTANT = 2;
43:
44:
45: public static $defaultFlags = 0;
46:
47:
48: public static $styles = [
49: '#' => [
50: self::PATTERN => '[^/]+',
51: self::FILTER_OUT => [__CLASS__, 'param2path'],
52: ],
53: '?#' => [
54: ],
55: 'module' => [
56: self::PATTERN => '[a-z][a-z0-9.-]*',
57: self::FILTER_IN => [__CLASS__, 'path2presenter'],
58: self::FILTER_OUT => [__CLASS__, 'presenter2path'],
59: ],
60: 'presenter' => [
61: self::PATTERN => '[a-z][a-z0-9.-]*',
62: self::FILTER_IN => [__CLASS__, 'path2presenter'],
63: self::FILTER_OUT => [__CLASS__, 'presenter2path'],
64: ],
65: 'action' => [
66: self::PATTERN => '[a-z][a-z0-9-]*',
67: self::FILTER_IN => [__CLASS__, 'path2action'],
68: self::FILTER_OUT => [__CLASS__, 'action2path'],
69: ],
70: '?module' => [
71: ],
72: '?presenter' => [
73: ],
74: '?action' => [
75: ],
76: ];
77:
78:
79: private $mask;
80:
81:
82: private $sequence;
83:
84:
85: private $re;
86:
87:
88: private $aliases;
89:
90:
91: private $metadata = [];
92:
93:
94: private $xlat;
95:
96:
97: private $type;
98:
99:
100: private $scheme;
101:
102:
103: private $flags;
104:
105:
106: private $lastRefUrl;
107:
108:
109: private $lastBaseUrl;
110:
111:
112: 113: 114: 115: 116:
117: public function __construct($mask, $metadata = [], $flags = 0)
118: {
119: if (is_string($metadata)) {
120: list($presenter, $action) = Nette\Application\Helpers::splitName($metadata);
121: if (!$presenter) {
122: throw new Nette\InvalidArgumentException("Second argument must be array or string in format Presenter:action, '$metadata' given.");
123: }
124: $metadata = [self::PRESENTER_KEY => $presenter];
125: if ($action !== '') {
126: $metadata['action'] = $action;
127: }
128: } elseif ($metadata instanceof \Closure || $metadata instanceof Nette\Callback) {
129: if ($metadata instanceof Nette\Callback) {
130: trigger_error('Nette\Callback is deprecated, use Nette\Utils\Callback::closure().', E_USER_DEPRECATED);
131: }
132: $metadata = [
133: self::PRESENTER_KEY => 'Nette:Micro',
134: 'callback' => $metadata,
135: ];
136: }
137:
138: $this->flags = $flags | static::$defaultFlags;
139: $this->setMask($mask, $metadata);
140: if (static::$defaultFlags) {
141: trigger_error('Route::$defaultFlags is deprecated, router by default keeps the used protocol.', E_USER_DEPRECATED);
142: } elseif ($flags & self::SECURED) {
143: trigger_error('Router::SECURED is deprecated, specify scheme in mask.', E_USER_DEPRECATED);
144: $this->scheme = 'https';
145: }
146: }
147:
148:
149: 150: 151: 152:
153: public function match(Nette\Http\IRequest $httpRequest)
154: {
155:
156:
157:
158: $url = $httpRequest->getUrl();
159: $re = $this->re;
160:
161: if ($this->type === self::HOST) {
162: $host = $url->getHost();
163: $path = '//' . $host . $url->getPath();
164: $parts = ip2long($host) ? [$host] : array_reverse(explode('.', $host));
165: $re = strtr($re, [
166: '/%basePath%/' => preg_quote($url->getBasePath(), '#'),
167: '%tld%' => preg_quote($parts[0], '#'),
168: '%domain%' => preg_quote(isset($parts[1]) ? "$parts[1].$parts[0]" : $parts[0], '#'),
169: '%sld%' => preg_quote(isset($parts[1]) ? $parts[1] : '', '#'),
170: '%host%' => preg_quote($host, '#'),
171: ]);
172:
173: } elseif ($this->type === self::RELATIVE) {
174: $basePath = $url->getBasePath();
175: if (strncmp($url->getPath(), $basePath, strlen($basePath)) !== 0) {
176: return null;
177: }
178: $path = (string) substr($url->getPath(), strlen($basePath));
179:
180: } else {
181: $path = $url->getPath();
182: }
183:
184: if ($path !== '') {
185: $path = rtrim(rawurldecode($path), '/') . '/';
186: }
187:
188: if (!$matches = Strings::match($path, $re)) {
189:
190: return null;
191: }
192:
193:
194: $params = [];
195: foreach ($matches as $k => $v) {
196: if (is_string($k) && $v !== '') {
197: $params[$this->aliases[$k]] = $v;
198: }
199: }
200:
201:
202:
203: foreach ($this->metadata as $name => $meta) {
204: if (!isset($params[$name]) && isset($meta['fixity']) && $meta['fixity'] !== self::OPTIONAL) {
205: $params[$name] = null;
206: }
207: }
208:
209:
210:
211: if ($this->xlat) {
212: $params += self::renameKeys($httpRequest->getQuery(), array_flip($this->xlat));
213: } else {
214: $params += $httpRequest->getQuery();
215: }
216:
217:
218:
219: foreach ($this->metadata as $name => $meta) {
220: if (isset($params[$name])) {
221: if (!is_scalar($params[$name])) {
222:
223: } elseif (isset($meta[self::FILTER_TABLE][$params[$name]])) {
224: $params[$name] = $meta[self::FILTER_TABLE][$params[$name]];
225:
226: } elseif (isset($meta[self::FILTER_TABLE]) && !empty($meta[self::FILTER_STRICT])) {
227: return null;
228:
229: } elseif (isset($meta[self::FILTER_IN])) {
230: $params[$name] = call_user_func($meta[self::FILTER_IN], (string) $params[$name]);
231: if ($params[$name] === null && !isset($meta['fixity'])) {
232: return null;
233: }
234: }
235:
236: } elseif (isset($meta['fixity'])) {
237: $params[$name] = $meta[self::VALUE];
238: }
239: }
240:
241: if (isset($this->metadata[null][self::FILTER_IN])) {
242: $params = call_user_func($this->metadata[null][self::FILTER_IN], $params);
243: if ($params === null) {
244: return null;
245: }
246: }
247:
248:
249: if (!isset($params[self::PRESENTER_KEY])) {
250: throw new Nette\InvalidStateException('Missing presenter in route definition.');
251: } elseif (!is_string($params[self::PRESENTER_KEY])) {
252: return null;
253: }
254: $presenter = $params[self::PRESENTER_KEY];
255: unset($params[self::PRESENTER_KEY]);
256:
257: if (isset($this->metadata[self::MODULE_KEY])) {
258: $presenter = (isset($params[self::MODULE_KEY]) ? $params[self::MODULE_KEY] . ':' : '') . $presenter;
259: unset($params[self::MODULE_KEY]);
260: }
261:
262: return new Application\Request(
263: $presenter,
264: $httpRequest->getMethod(),
265: $params,
266: $httpRequest->getPost(),
267: $httpRequest->getFiles(),
268: [Application\Request::SECURED => $httpRequest->isSecured()]
269: );
270: }
271:
272:
273: 274: 275: 276:
277: public function constructUrl(Application\Request $appRequest, Nette\Http\Url $refUrl)
278: {
279: if ($this->flags & self::ONE_WAY) {
280: return null;
281: }
282:
283: $params = $appRequest->getParameters();
284: $metadata = $this->metadata;
285:
286: $presenter = $appRequest->getPresenterName();
287: $params[self::PRESENTER_KEY] = $presenter;
288:
289: if (isset($metadata[self::MODULE_KEY])) {
290: $module = $metadata[self::MODULE_KEY];
291: if (isset($module['fixity']) && strncmp($presenter, $module[self::VALUE] . ':', strlen($module[self::VALUE]) + 1) === 0) {
292: $a = strlen($module[self::VALUE]);
293: } else {
294: $a = strrpos($presenter, ':');
295: }
296: if ($a === false) {
297: $params[self::MODULE_KEY] = isset($module[self::VALUE]) ? '' : null;
298: } else {
299: $params[self::MODULE_KEY] = substr($presenter, 0, $a);
300: $params[self::PRESENTER_KEY] = substr($presenter, $a + 1);
301: }
302: }
303:
304: if (isset($metadata[null][self::FILTER_OUT])) {
305: $params = call_user_func($metadata[null][self::FILTER_OUT], $params);
306: if ($params === null) {
307: return null;
308: }
309: }
310:
311: foreach ($metadata as $name => $meta) {
312: if (!isset($params[$name])) {
313: continue;
314: }
315:
316: if (is_scalar($params[$name])) {
317: $params[$name] = $params[$name] === false ? '0' : (string) $params[$name];
318: }
319:
320: if (isset($meta['fixity'])) {
321: if ($params[$name] === $meta[self::VALUE]) {
322: unset($params[$name]);
323: continue;
324:
325: } elseif ($meta['fixity'] === self::CONSTANT) {
326: return null;
327: }
328: }
329:
330: if (is_scalar($params[$name]) && isset($meta['filterTable2'][$params[$name]])) {
331: $params[$name] = $meta['filterTable2'][$params[$name]];
332:
333: } elseif (isset($meta['filterTable2']) && !empty($meta[self::FILTER_STRICT])) {
334: return null;
335:
336: } elseif (isset($meta[self::FILTER_OUT])) {
337: $params[$name] = call_user_func($meta[self::FILTER_OUT], $params[$name]);
338: }
339:
340: if (isset($meta[self::PATTERN]) && !preg_match($meta[self::PATTERN], rawurldecode($params[$name]))) {
341: return null;
342: }
343: }
344:
345:
346: $sequence = $this->sequence;
347: $brackets = [];
348: $required = null;
349: $url = '';
350: $i = count($sequence) - 1;
351: do {
352: $url = $sequence[$i] . $url;
353: if ($i === 0) {
354: break;
355: }
356: $i--;
357:
358: $name = $sequence[$i--];
359:
360: if ($name === ']') {
361: $brackets[] = $url;
362:
363: } elseif ($name[0] === '[') {
364: $tmp = array_pop($brackets);
365: if ($required < count($brackets) + 1) {
366: if ($name !== '[!') {
367: $url = $tmp;
368: }
369: } else {
370: $required = count($brackets);
371: }
372:
373: } elseif ($name[0] === '?') {
374: continue;
375:
376: } elseif (isset($params[$name]) && $params[$name] != '') {
377: $required = count($brackets);
378: $url = $params[$name] . $url;
379: unset($params[$name]);
380:
381: } elseif (isset($metadata[$name]['fixity'])) {
382: if ($required === null && !$brackets) {
383: $url = '';
384: } else {
385: $url = $metadata[$name]['defOut'] . $url;
386: }
387:
388: } else {
389: return null;
390: }
391: } while (true);
392:
393: $scheme = $this->scheme ?: $refUrl->getScheme();
394:
395: if ($this->type === self::HOST) {
396: $host = $refUrl->getHost();
397: $parts = ip2long($host) ? [$host] : array_reverse(explode('.', $host));
398: $url = strtr($url, [
399: '/%basePath%/' => $refUrl->getBasePath(),
400: '%tld%' => $parts[0],
401: '%domain%' => isset($parts[1]) ? "$parts[1].$parts[0]" : $parts[0],
402: '%sld%' => isset($parts[1]) ? $parts[1] : '',
403: '%host%' => $host,
404: ]);
405: $url = $scheme . ':' . $url;
406: } else {
407: if ($this->lastRefUrl !== $refUrl) {
408: $basePath = ($this->type === self::RELATIVE ? $refUrl->getBasePath() : '');
409: $this->lastBaseUrl = $scheme . '://' . $refUrl->getAuthority() . $basePath;
410: $this->lastRefUrl = $refUrl;
411: }
412: $url = $this->lastBaseUrl . $url;
413: }
414:
415: if (strpos($url, '//', strlen($scheme) + 3) !== false) {
416: return null;
417: }
418:
419:
420: if ($this->xlat) {
421: $params = self::renameKeys($params, $this->xlat);
422: }
423:
424: $sep = ini_get('arg_separator.input');
425: $query = http_build_query($params, '', $sep ? $sep[0] : '&');
426: if ($query != '') {
427: $url .= '?' . $query;
428: }
429:
430: return $url;
431: }
432:
433:
434: 435: 436: 437: 438: 439:
440: private function setMask($mask, array $metadata)
441: {
442: $this->mask = $mask;
443:
444:
445: if (preg_match('#(?:(https?):)?(//.*)#A', $mask, $m)) {
446: $this->type = self::HOST;
447: list(, $this->scheme, $mask) = $m;
448:
449: } elseif (substr($mask, 0, 1) === '/') {
450: $this->type = self::PATH;
451:
452: } else {
453: $this->type = self::RELATIVE;
454: }
455:
456: foreach ($metadata as $name => $meta) {
457: if (!is_array($meta)) {
458: $metadata[$name] = $meta = [self::VALUE => $meta];
459: }
460:
461: if (array_key_exists(self::VALUE, $meta)) {
462: if (is_scalar($meta[self::VALUE])) {
463: $metadata[$name][self::VALUE] = $meta[self::VALUE] === false ? '0' : (string) $meta[self::VALUE];
464: }
465: $metadata[$name]['fixity'] = self::CONSTANT;
466: }
467: }
468:
469: if (strpbrk($mask, '?<>[]') === false) {
470: $this->re = '#' . preg_quote($mask, '#') . '/?\z#A';
471: $this->sequence = [$mask];
472: $this->metadata = $metadata;
473: return;
474: }
475:
476:
477:
478: $parts = Strings::split($mask, '/<([^<>= ]+)(=[^<> ]*)? *([^<>]*)>|(\[!?|\]|\s*\?.*)/');
479:
480: $this->xlat = [];
481: $i = count($parts) - 1;
482:
483:
484: if (isset($parts[$i - 1]) && substr(ltrim($parts[$i - 1]), 0, 1) === '?') {
485:
486: $matches = Strings::matchAll($parts[$i - 1], '/(?:([a-zA-Z0-9_.-]+)=)?<([^> ]+) *([^>]*)>/');
487:
488: foreach ($matches as list(, $param, $name, $pattern)) {
489: if (isset(static::$styles['?' . $name])) {
490: $meta = static::$styles['?' . $name];
491: } else {
492: $meta = static::$styles['?#'];
493: }
494:
495: if (isset($metadata[$name])) {
496: $meta = $metadata[$name] + $meta;
497: }
498:
499: if (array_key_exists(self::VALUE, $meta)) {
500: $meta['fixity'] = self::OPTIONAL;
501: }
502:
503: unset($meta['pattern']);
504: $meta['filterTable2'] = empty($meta[self::FILTER_TABLE]) ? null : array_flip($meta[self::FILTER_TABLE]);
505:
506: $metadata[$name] = $meta;
507: if ($param !== '') {
508: $this->xlat[$name] = $param;
509: }
510: }
511: $i -= 5;
512: }
513:
514:
515: $brackets = 0;
516: $re = '';
517: $sequence = [];
518: $autoOptional = true;
519: $aliases = [];
520: do {
521: $part = $parts[$i];
522: if (strpbrk($part, '<>') !== false) {
523: throw new Nette\InvalidArgumentException("Unexpected '$part' in mask '$mask'.");
524: }
525: array_unshift($sequence, $part);
526: $re = preg_quote($part, '#') . $re;
527: if ($i === 0) {
528: break;
529: }
530: $i--;
531:
532: $part = $parts[$i];
533: if ($part === '[' || $part === ']' || $part === '[!') {
534: $brackets += $part[0] === '[' ? -1 : 1;
535: if ($brackets < 0) {
536: throw new Nette\InvalidArgumentException("Unexpected '$part' in mask '$mask'.");
537: }
538: array_unshift($sequence, $part);
539: $re = ($part[0] === '[' ? '(?:' : ')?') . $re;
540: $i -= 4;
541: continue;
542: }
543:
544: $pattern = trim($parts[$i--]);
545: $default = $parts[$i--];
546: $name = $parts[$i--];
547: array_unshift($sequence, $name);
548:
549: if ($name[0] === '?') {
550: $name = substr($name, 1);
551: $re = $pattern ? '(?:' . preg_quote($name, '#') . "|$pattern)$re" : preg_quote($name, '#') . $re;
552: $sequence[1] = $name . $sequence[1];
553: continue;
554: }
555:
556:
557: if (isset(static::$styles[$name])) {
558: $meta = static::$styles[$name];
559: } else {
560: $meta = static::$styles['#'];
561: }
562:
563: if (isset($metadata[$name])) {
564: $meta = $metadata[$name] + $meta;
565: }
566:
567: if ($pattern == '' && isset($meta[self::PATTERN])) {
568: $pattern = $meta[self::PATTERN];
569: }
570:
571: if ($default !== '') {
572: $meta[self::VALUE] = (string) substr($default, 1);
573: $meta['fixity'] = self::PATH_OPTIONAL;
574: }
575:
576: $meta['filterTable2'] = empty($meta[self::FILTER_TABLE]) ? null : array_flip($meta[self::FILTER_TABLE]);
577: if (array_key_exists(self::VALUE, $meta)) {
578: if (isset($meta['filterTable2'][$meta[self::VALUE]])) {
579: $meta['defOut'] = $meta['filterTable2'][$meta[self::VALUE]];
580:
581: } elseif (isset($meta[self::FILTER_OUT])) {
582: $meta['defOut'] = call_user_func($meta[self::FILTER_OUT], $meta[self::VALUE]);
583:
584: } else {
585: $meta['defOut'] = $meta[self::VALUE];
586: }
587: }
588: $meta[self::PATTERN] = "#(?:$pattern)\\z#A";
589:
590:
591: $aliases['p' . $i] = $name;
592: $re = '(?P<p' . $i . '>(?U)' . $pattern . ')' . $re;
593: if ($brackets) {
594: if (!isset($meta[self::VALUE])) {
595: $meta[self::VALUE] = $meta['defOut'] = null;
596: }
597: $meta['fixity'] = self::PATH_OPTIONAL;
598:
599: } elseif (isset($meta['fixity'])) {
600: if ($autoOptional) {
601: $re = '(?:' . $re . ')?';
602: }
603: $meta['fixity'] = self::PATH_OPTIONAL;
604:
605: } else {
606: $autoOptional = false;
607: }
608:
609: $metadata[$name] = $meta;
610: } while (true);
611:
612: if ($brackets) {
613: throw new Nette\InvalidArgumentException("Missing '[' in mask '$mask'.");
614: }
615:
616: $this->aliases = $aliases;
617: $this->re = '#' . $re . '/?\z#A';
618: $this->metadata = $metadata;
619: $this->sequence = $sequence;
620: }
621:
622:
623: 624: 625: 626:
627: public function getMask()
628: {
629: return $this->mask;
630: }
631:
632:
633: 634: 635: 636:
637: public function getDefaults()
638: {
639: $defaults = [];
640: foreach ($this->metadata as $name => $meta) {
641: if (isset($meta['fixity'])) {
642: $defaults[$name] = $meta[self::VALUE];
643: }
644: }
645: return $defaults;
646: }
647:
648:
649: 650: 651: 652:
653: public function getFlags()
654: {
655: return $this->flags;
656: }
657:
658:
659:
660:
661:
662: 663: 664: 665: 666:
667: public function getTargetPresenters()
668: {
669: if ($this->flags & self::ONE_WAY) {
670: return [];
671: }
672:
673: $m = $this->metadata;
674: $module = '';
675:
676: if (isset($m[self::MODULE_KEY])) {
677: if (isset($m[self::MODULE_KEY]['fixity']) && $m[self::MODULE_KEY]['fixity'] === self::CONSTANT) {
678: $module = $m[self::MODULE_KEY][self::VALUE] . ':';
679: } else {
680: return null;
681: }
682: }
683:
684: if (isset($m[self::PRESENTER_KEY]['fixity']) && $m[self::PRESENTER_KEY]['fixity'] === self::CONSTANT) {
685: return [$module . $m[self::PRESENTER_KEY][self::VALUE]];
686: }
687: return null;
688: }
689:
690:
691: 692: 693: 694: 695: 696:
697: private static function renameKeys($arr, $xlat)
698: {
699: if (empty($xlat)) {
700: return $arr;
701: }
702:
703: $res = [];
704: $occupied = array_flip($xlat);
705: foreach ($arr as $k => $v) {
706: if (isset($xlat[$k])) {
707: $res[$xlat[$k]] = $v;
708:
709: } elseif (!isset($occupied[$k])) {
710: $res[$k] = $v;
711: }
712: }
713: return $res;
714: }
715:
716:
717:
718:
719:
720: 721: 722: 723: 724:
725: private static function action2path($s)
726: {
727: $s = preg_replace('#(.)(?=[A-Z])#', '$1-', $s);
728: $s = strtolower($s);
729: $s = rawurlencode($s);
730: return $s;
731: }
732:
733:
734: 735: 736: 737: 738:
739: private static function path2action($s)
740: {
741: $s = preg_replace('#-(?=[a-z])#', ' ', $s);
742: $s = lcfirst(ucwords($s));
743: $s = str_replace(' ', '', $s);
744: return $s;
745: }
746:
747:
748: 749: 750: 751: 752:
753: private static function presenter2path($s)
754: {
755: $s = strtr($s, ':', '.');
756: $s = preg_replace('#([^.])(?=[A-Z])#', '$1-', $s);
757: $s = strtolower($s);
758: $s = rawurlencode($s);
759: return $s;
760: }
761:
762:
763: 764: 765: 766: 767:
768: private static function path2presenter($s)
769: {
770: $s = preg_replace('#([.-])(?=[a-z])#', '$1 ', $s);
771: $s = ucwords($s);
772: $s = str_replace('. ', ':', $s);
773: $s = str_replace('- ', '', $s);
774: return $s;
775: }
776:
777:
778: 779: 780: 781: 782:
783: private static function param2path($s)
784: {
785: return str_replace('%2F', '/', rawurlencode($s));
786: }
787: }
788: