|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* |
|
5
|
|
|
* (c) Yaroslav Honcharuk <[email protected]> |
|
6
|
|
|
* |
|
7
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
8
|
|
|
* file that was distributed with this source code. |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
namespace Yarhon\RouteGuardBundle\Cache\DataCollector; |
|
12
|
|
|
|
|
13
|
|
|
use Psr\Log\LoggerAwareInterface; |
|
14
|
|
|
use Psr\Log\LoggerAwareTrait; |
|
15
|
|
|
use Symfony\Component\Routing\RouteCollection; |
|
16
|
|
|
use Yarhon\RouteGuardBundle\Controller\ControllerNameResolverInterface; |
|
17
|
|
|
use Yarhon\RouteGuardBundle\Exception\ExceptionInterface; |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* @author Yaroslav Honcharuk <[email protected]> |
|
21
|
|
|
*/ |
|
22
|
|
|
class RouteCollectionDataCollector implements LoggerAwareInterface |
|
23
|
|
|
{ |
|
24
|
|
|
use LoggerAwareTrait; |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* @var RouteDataCollector |
|
28
|
|
|
*/ |
|
29
|
|
|
private $routeDataCollector; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* @var ControllerNameResolverInterface |
|
33
|
|
|
*/ |
|
34
|
|
|
private $controllerNameResolver; |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* @var array |
|
38
|
|
|
*/ |
|
39
|
|
|
private $options; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* @param RouteDataCollector $routeDataCollector |
|
43
|
|
|
* @param ControllerNameResolverInterface $controllerNameResolver |
|
44
|
|
|
* @param array $options |
|
45
|
|
|
*/ |
|
46
|
7 |
|
public function __construct(RouteDataCollector $routeDataCollector, ControllerNameResolverInterface $controllerNameResolver, $options = []) |
|
47
|
|
|
{ |
|
48
|
7 |
|
$this->routeDataCollector = $routeDataCollector; |
|
49
|
7 |
|
$this->controllerNameResolver = $controllerNameResolver; |
|
50
|
|
|
|
|
51
|
7 |
|
$this->options = array_merge([ |
|
52
|
7 |
|
'ignore_controllers' => [], |
|
53
|
|
|
'ignore_exceptions' => false, |
|
54
|
7 |
|
], $options); |
|
55
|
7 |
|
} |
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* @param RouteCollection $routeCollection |
|
59
|
|
|
* |
|
60
|
|
|
* @return array |
|
61
|
|
|
* |
|
62
|
|
|
* @throws ExceptionInterface |
|
63
|
|
|
*/ |
|
64
|
7 |
|
public function collect(RouteCollection $routeCollection) |
|
65
|
|
|
{ |
|
66
|
7 |
|
if ($this->logger) { |
|
67
|
3 |
|
$this->logger->info('Collect data for route collection', ['count' => count($routeCollection)]); |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
7 |
|
$ignoredRoutes = []; |
|
71
|
7 |
|
$catchExceptions = $this->options['ignore_exceptions'] && $this->logger; |
|
72
|
|
|
|
|
73
|
7 |
|
$data = []; |
|
74
|
|
|
|
|
75
|
7 |
|
foreach ($routeCollection as $routeName => $route) { |
|
76
|
|
|
try { |
|
77
|
7 |
|
$controller = $route->getDefault('_controller'); |
|
78
|
7 |
|
$controllerName = $this->controllerNameResolver->resolve($controller); |
|
79
|
|
|
|
|
80
|
6 |
|
if (null !== $controllerName && $this->isControllerIgnored($controllerName)) { |
|
81
|
1 |
|
$ignoredRoutes[] = $routeName; |
|
82
|
1 |
|
continue; |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
6 |
|
$data[$routeName] = $this->routeDataCollector->collect($routeName, $route, $controllerName); |
|
86
|
4 |
|
} catch (ExceptionInterface $e) { |
|
87
|
4 |
|
if (!$catchExceptions) { |
|
88
|
2 |
|
$this->addRouteNameToException($e, $routeName); |
|
89
|
2 |
|
throw $e; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
2 |
|
$this->logger->error(sprintf('Route "%s" would be ignored because of exception caught: %s', $routeName, $e->getMessage()), ['exception' => $e]); |
|
|
|
|
|
|
93
|
5 |
|
continue; |
|
94
|
|
|
} |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
// TODO: add exception routes to ignored log message? |
|
98
|
|
|
|
|
99
|
5 |
|
if ($this->logger && count($ignoredRoutes)) { |
|
100
|
|
|
$this->logger->info('Ignored routes', ['count' => count($ignoredRoutes), 'list' => $ignoredRoutes]); |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
5 |
|
return $data; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* @param string $controllerName |
|
108
|
|
|
* |
|
109
|
|
|
* @return bool |
|
110
|
|
|
*/ |
|
111
|
6 |
|
private function isControllerIgnored($controllerName) |
|
112
|
|
|
{ |
|
113
|
6 |
|
foreach ($this->options['ignore_controllers'] as $ignored) { |
|
114
|
2 |
|
if (0 === strpos($controllerName, $ignored)) { |
|
115
|
2 |
|
return true; |
|
116
|
|
|
} |
|
117
|
|
|
} |
|
118
|
|
|
|
|
119
|
6 |
|
return false; |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
2 |
|
private function addRouteNameToException(\Exception $e, $routeName) |
|
123
|
|
|
{ |
|
124
|
2 |
|
$message = sprintf('Route "%s": %s', $routeName, $e->getMessage()); |
|
125
|
|
|
|
|
126
|
2 |
|
$r = new \ReflectionProperty($e,'message'); |
|
127
|
2 |
|
$r->setAccessible(true); |
|
128
|
2 |
|
$r->setValue($e, $message); |
|
129
|
2 |
|
} |
|
130
|
|
|
} |
|
131
|
|
|
|
yarhon /
RouteGuardBundle
Loading history...