|
1
|
|
|
<?php |
|
2
|
|
|
namespace RazonYang\Yii2\RateLimiter; |
|
3
|
|
|
|
|
4
|
|
|
use yii\base\Action; |
|
5
|
|
|
use yii\filters\RateLimiter; |
|
6
|
|
|
use yii\web\IdentityInterface; |
|
7
|
|
|
use yii\web\Request; |
|
8
|
|
|
use yii\web\TooManyRequestsHttpException; |
|
9
|
|
|
use yii\web\User; |
|
10
|
|
|
use Psr\Log\LoggerInterface; |
|
11
|
|
|
use RazonYang\TokenBucket\ManagerInterface; |
|
12
|
|
|
use RazonYang\Yii2\Psr\Log\Logger; |
|
13
|
|
|
use Yii; |
|
14
|
|
|
|
|
15
|
|
|
abstract class BaseRateLimiter extends RateLimiter |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* @var User $user |
|
19
|
|
|
*/ |
|
20
|
|
|
public $user; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* @var int $capacity token bucket capacity. |
|
24
|
|
|
*/ |
|
25
|
|
|
public $capacity = 5000; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @var float $rate token rate. |
|
29
|
|
|
*/ |
|
30
|
|
|
public $rate = 0.72; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* @var \Closure $nameCallback bucket name callback. |
|
34
|
|
|
*/ |
|
35
|
|
|
public $nameCallback; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* @var int $limitPeriod calculates the maximum count of requests during the period. |
|
39
|
|
|
*/ |
|
40
|
|
|
public $limitPeriod = 3600; |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* @var ManagerInterface $manager |
|
44
|
|
|
*/ |
|
45
|
|
|
private $manager; |
|
46
|
|
|
|
|
47
|
10 |
|
public function init() |
|
48
|
|
|
{ |
|
49
|
10 |
|
parent::init(); |
|
50
|
|
|
|
|
51
|
10 |
|
if ($this->user === null) { |
|
52
|
10 |
|
$this->user = Yii::$app->getUser(); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
10 |
|
$this->manager = $this->initManager(); |
|
56
|
10 |
|
} |
|
57
|
|
|
|
|
58
|
|
|
abstract protected function initManager(): ManagerInterface; |
|
59
|
|
|
|
|
60
|
1 |
|
public function beforeAction($action) |
|
61
|
|
|
{ |
|
62
|
1 |
|
$limit = $this->manager->getLimit($this->limitPeriod); |
|
63
|
|
|
|
|
64
|
1 |
|
$name = $this->getName($this->user, $this->request, $action); |
|
65
|
1 |
|
$comsumed = $this->manager->consume($name, $remaining, $reset); |
|
66
|
1 |
|
$this->addRateLimitHeaders($this->response, $limit, $remaining, $reset); |
|
67
|
1 |
|
if (!$comsumed) { |
|
68
|
1 |
|
throw new TooManyRequestsHttpException($this->errorMessage); |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
1 |
|
return true; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* Returns the bucket name. |
|
76
|
|
|
* |
|
77
|
|
|
* @param User $user |
|
78
|
|
|
* @param Request $request |
|
79
|
|
|
* @param Action $action |
|
80
|
|
|
*/ |
|
81
|
3 |
|
public function getName(User $user, Request $request, Action $action): string |
|
82
|
|
|
{ |
|
83
|
3 |
|
if ($this->nameCallback !== null) { |
|
84
|
1 |
|
return call_user_func($this->nameCallback, $user, $request, $action); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
2 |
|
$route = $action->getUniqueId(); |
|
88
|
2 |
|
if (!$user->getIsGuest()) { |
|
89
|
1 |
|
return $user->getId() . ':' . $route; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
2 |
|
return $request->getUserIP() . ':' . $route; |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
/** |
|
96
|
|
|
* @var LoggerInterface |
|
97
|
|
|
*/ |
|
98
|
|
|
private $logger; |
|
99
|
|
|
|
|
100
|
10 |
|
protected function getLogger(): LoggerInterface |
|
101
|
|
|
{ |
|
102
|
10 |
|
if ($this->logger === null) { |
|
103
|
10 |
|
$this->logger = new Logger(); |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
10 |
|
return $this->logger; |
|
107
|
|
|
} |
|
108
|
|
|
} |
|
109
|
|
|
|
razonyang /
yii2-rate-limiter
