123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196 |
- <?php
-
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
- namespace Symfony\Component\HttpFoundation;
-
- /**
- * RequestMatcher compares a pre-defined set of checks against a Request instance.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class RequestMatcher implements RequestMatcherInterface
- {
- /**
- * @var string|null
- */
- private $path;
-
- /**
- * @var string|null
- */
- private $host;
-
- /**
- * @var int|null
- */
- private $port;
-
- /**
- * @var string[]
- */
- private $methods = [];
-
- /**
- * @var string[]
- */
- private $ips = [];
-
- /**
- * @var array
- */
- private $attributes = [];
-
- /**
- * @var string[]
- */
- private $schemes = [];
-
- /**
- * @param string|string[]|null $methods
- * @param string|string[]|null $ips
- * @param string|string[]|null $schemes
- */
- public function __construct(?string $path = null, ?string $host = null, $methods = null, $ips = null, array $attributes = [], $schemes = null, ?int $port = null)
- {
- $this->matchPath($path);
- $this->matchHost($host);
- $this->matchMethod($methods);
- $this->matchIps($ips);
- $this->matchScheme($schemes);
- $this->matchPort($port);
-
- foreach ($attributes as $k => $v) {
- $this->matchAttribute($k, $v);
- }
- }
-
- /**
- * Adds a check for the HTTP scheme.
- *
- * @param string|string[]|null $scheme An HTTP scheme or an array of HTTP schemes
- */
- public function matchScheme($scheme)
- {
- $this->schemes = null !== $scheme ? array_map('strtolower', (array) $scheme) : [];
- }
-
- /**
- * Adds a check for the URL host name.
- */
- public function matchHost(?string $regexp)
- {
- $this->host = $regexp;
- }
-
- /**
- * Adds a check for the URL port.
- *
- * @param int|null $port The port number to connect to
- */
- public function matchPort(?int $port)
- {
- $this->port = $port;
- }
-
- /**
- * Adds a check for the URL path info.
- */
- public function matchPath(?string $regexp)
- {
- $this->path = $regexp;
- }
-
- /**
- * Adds a check for the client IP.
- *
- * @param string $ip A specific IP address or a range specified using IP/netmask like 192.168.1.0/24
- */
- public function matchIp(string $ip)
- {
- $this->matchIps($ip);
- }
-
- /**
- * Adds a check for the client IP.
- *
- * @param string|string[]|null $ips A specific IP address or a range specified using IP/netmask like 192.168.1.0/24
- */
- public function matchIps($ips)
- {
- $ips = null !== $ips ? (array) $ips : [];
-
- $this->ips = array_reduce($ips, static function (array $ips, string $ip) {
- return array_merge($ips, preg_split('/\s*,\s*/', $ip));
- }, []);
- }
-
- /**
- * Adds a check for the HTTP method.
- *
- * @param string|string[]|null $method An HTTP method or an array of HTTP methods
- */
- public function matchMethod($method)
- {
- $this->methods = null !== $method ? array_map('strtoupper', (array) $method) : [];
- }
-
- /**
- * Adds a check for request attribute.
- */
- public function matchAttribute(string $key, string $regexp)
- {
- $this->attributes[$key] = $regexp;
- }
-
- /**
- * {@inheritdoc}
- */
- public function matches(Request $request)
- {
- if ($this->schemes && !\in_array($request->getScheme(), $this->schemes, true)) {
- return false;
- }
-
- if ($this->methods && !\in_array($request->getMethod(), $this->methods, true)) {
- return false;
- }
-
- foreach ($this->attributes as $key => $pattern) {
- $requestAttribute = $request->attributes->get($key);
- if (!\is_string($requestAttribute)) {
- return false;
- }
- if (!preg_match('{'.$pattern.'}', $requestAttribute)) {
- return false;
- }
- }
-
- if (null !== $this->path && !preg_match('{'.$this->path.'}', rawurldecode($request->getPathInfo()))) {
- return false;
- }
-
- if (null !== $this->host && !preg_match('{'.$this->host.'}i', $request->getHost())) {
- return false;
- }
-
- if (null !== $this->port && 0 < $this->port && $request->getPort() !== $this->port) {
- return false;
- }
-
- if (IpUtils::checkIp($request->getClientIp() ?? '', $this->ips)) {
- return true;
- }
-
- // Note to future implementors: add additional checks above the
- // foreach above or else your check might not be run!
- return 0 === \count($this->ips);
- }
- }
|