-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Upgrade styles config, remove unnesessary packages * Add RateLimiter module Use php 7.2 for a memcached driver * UNdisable cache by default * Close connection after sending a response * Add comments * Update README.md * Remove always_populate_raw_post_data for php7 * add echo before die * Small fixes * Fix codestyle
- Loading branch information
Showing
15 changed files
with
344 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| <?php | ||
|
|
||
| use Cache\Cache; | ||
|
|
||
| /** | ||
| * @singleton | ||
| * | ||
| * Simple rate limiter module powered by Memcache | ||
| * | ||
| * @example | ||
| * if (RateLimiter::instance()->isEnabled()) { | ||
| * if (! RateLimiter::instance()->check($key)) { | ||
| * // ...reject request | ||
| * } | ||
| * } | ||
| */ | ||
| class RateLimiter | ||
| { | ||
| /** | ||
| * Is RateLimiter enabled and Cache works correctly | ||
| * @var bool | ||
| */ | ||
| private $isEnabled; | ||
|
|
||
| /** | ||
| * Number of images allowed to be uploaded for time interval (cycle) | ||
| * | ||
| * @var integer | ||
| */ | ||
| private $QUOTA; | ||
|
|
||
| /** | ||
| * Time interval defined as rate limiter cycle | ||
| * | ||
| * @var integer | ||
| */ | ||
| private $CYCLE; | ||
|
|
||
| /** | ||
| * @var RateLimiter | ||
| */ | ||
| private static $_instance = null; | ||
|
|
||
| public static function instance() | ||
| { | ||
| if (is_null(self::$_instance)) { | ||
| self::$_instance = new self(); | ||
| } | ||
|
|
||
| return self::$_instance; | ||
| } | ||
|
|
||
| /** | ||
| * Private variable and public method to prevent variable outer changes | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function isEnabled() | ||
| { | ||
| return $this->isEnabled; | ||
| } | ||
|
|
||
| /** | ||
| * Number of images allowed to be uploaded for time interval (cycle) | ||
| * Private variable and public method to prevent variable outer changes | ||
| * | ||
| * @return int | ||
| */ | ||
| public function QUOTA() | ||
| { | ||
| return $this->QUOTA; | ||
| } | ||
|
|
||
| /** | ||
| * Time interval defined as rate limiter cycle | ||
| * Private variable and public method to prevent variable outer changes | ||
| * | ||
| * @return int | ||
| */ | ||
| public function CYCLE() | ||
| { | ||
| return $this->CYCLE; | ||
| } | ||
|
|
||
| /** | ||
| * Check if client allowed to do an action | ||
| * | ||
| * @param string $key - client identifier | ||
| * @param int|null $quota - max number of images | ||
| * @param int|null $cycle - time interval | ||
| * @return bool|null - if request is allowed | ||
| */ | ||
| public function check($key, $quota = null, $cycle = null) | ||
| { | ||
| if (!$this->isEnabled) { | ||
| return null; | ||
| } | ||
|
|
||
| $quota = $quota ?: $this->QUOTA; | ||
| $cycle = $cycle ?: $this->CYCLE; | ||
|
|
||
| $defaultValue = 1; | ||
|
|
||
| $requestAllowed = true; | ||
|
|
||
| /** Try to get key */ | ||
| $isCached = Cache::instance()->get($key); | ||
|
|
||
| if (is_null($isCached)) { | ||
| Cache::instance()->set($key, $defaultValue, $cycle); | ||
| return $requestAllowed; | ||
| } | ||
|
|
||
| if (intval($isCached) < $quota) { | ||
| Cache::instance()->increment($key); | ||
| return $requestAllowed; | ||
| } | ||
|
|
||
| return ! $requestAllowed; | ||
| } | ||
|
|
||
| /** | ||
| * Get error message with filled env params for quota and cycle | ||
| * | ||
| * @param int|null $quota - max number of images | ||
| * @param int|null $cycle - time interval | ||
| * | ||
| * @return string | ||
| */ | ||
| public function errorMessage($quota = null, $cycle = null) | ||
| { | ||
| $quota = $quota ?: $this->QUOTA; | ||
| $cycle = $cycle ?: $this->CYCLE; | ||
|
|
||
| $words = [ | ||
| 'image' => Methods::getNumEnding($quota, 'image', 'images', 'images'), | ||
| 'second' => Methods::getNumEnding($cycle, 'second', 'seconds', 'seconds') | ||
| ]; | ||
|
|
||
| return "Sorry, you cannot upload more than ${quota} ${words['image']} per ${cycle} ${words['second']}."; | ||
| } | ||
|
|
||
| /** | ||
| * RateLimiter constructor | ||
| */ | ||
| private function __construct() | ||
| { | ||
| /** If rate limiter was disabled in .env */ | ||
| if (Env::getBool('DISABLE_RATE_LIMITER')) { | ||
| return; | ||
| } | ||
|
|
||
| /** | ||
| * Define vars from env file | ||
| */ | ||
| $this->QUOTA = Env::getInt('RATE_LIMITER_QUOTA'); | ||
| $this->CYCLE = Env::getInt('RATE_LIMITER_CYCLE'); | ||
|
|
||
| if (!$this->QUOTA || !$this->CYCLE) { | ||
| throw new Exception('Rate limiter requires defined \'quota\' and \'cycle\' params. Check env file.'); | ||
| } | ||
|
|
||
| /** Check if Cache module set up correctly */ | ||
| $cache = \Cache\Cache::instance(); | ||
| if (!$cache->isAlive()) { | ||
| throw new Exception('Rate limiter requires enabled cache. Check Memcache connection.'); | ||
| } | ||
|
|
||
| /** RateLimiter is ready to work */ | ||
| $this->isEnabled = true; | ||
| } | ||
|
|
||
| /** | ||
| * Prevent cloning of instance | ||
| */ | ||
| private function __clone() | ||
| { | ||
| } | ||
|
|
||
| private function __sleep() | ||
| { | ||
| } | ||
|
|
||
| private function __wakeup() | ||
| { | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.