matomo
/
app
/
vendor
/
prefixed
/
symfony
/
http-foundation
/
RateLimiter
/
AbstractRequestRateLimiter.php
AbstractRequestRateLimiter.php
61 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace Matomo\Dependencies\Symfony\Component\HttpFoundation\RateLimiter; |
| 12 | |
| 13 | use Matomo\Dependencies\Symfony\Component\HttpFoundation\Request; |
| 14 | use Symfony\Component\RateLimiter\LimiterInterface; |
| 15 | use Symfony\Component\RateLimiter\Policy\NoLimiter; |
| 16 | use Symfony\Component\RateLimiter\RateLimit; |
| 17 | /** |
| 18 | * An implementation of RequestRateLimiterInterface that |
| 19 | * fits most use-cases. |
| 20 | * |
| 21 | * @author Wouter de Jong <wouter@wouterj.nl> |
| 22 | */ |
| 23 | abstract class AbstractRequestRateLimiter implements RequestRateLimiterInterface |
| 24 | { |
| 25 | public function consume(Request $request) : RateLimit |
| 26 | { |
| 27 | $limiters = $this->getLimiters($request); |
| 28 | if (0 === \count($limiters)) { |
| 29 | $limiters = [new NoLimiter()]; |
| 30 | } |
| 31 | $minimalRateLimit = null; |
| 32 | foreach ($limiters as $limiter) { |
| 33 | $rateLimit = $limiter->consume(1); |
| 34 | $minimalRateLimit = $minimalRateLimit ? self::getMinimalRateLimit($minimalRateLimit, $rateLimit) : $rateLimit; |
| 35 | } |
| 36 | return $minimalRateLimit; |
| 37 | } |
| 38 | public function reset(Request $request) : void |
| 39 | { |
| 40 | foreach ($this->getLimiters($request) as $limiter) { |
| 41 | $limiter->reset(); |
| 42 | } |
| 43 | } |
| 44 | /** |
| 45 | * @return LimiterInterface[] a set of limiters using keys extracted from the request |
| 46 | */ |
| 47 | protected abstract function getLimiters(Request $request) : array; |
| 48 | private static function getMinimalRateLimit(RateLimit $first, RateLimit $second) : RateLimit |
| 49 | { |
| 50 | if ($first->isAccepted() !== $second->isAccepted()) { |
| 51 | return $first->isAccepted() ? $second : $first; |
| 52 | } |
| 53 | $firstRemainingTokens = $first->getRemainingTokens(); |
| 54 | $secondRemainingTokens = $second->getRemainingTokens(); |
| 55 | if ($firstRemainingTokens === $secondRemainingTokens) { |
| 56 | return $first->getRetryAfter() < $second->getRetryAfter() ? $second : $first; |
| 57 | } |
| 58 | return $firstRemainingTokens > $secondRemainingTokens ? $second : $first; |
| 59 | } |
| 60 | } |
| 61 |