First Local Commit - After Clean up.
Signed-off-by: Rick Hays <rhays@haysgang.com>
This commit is contained in:
213
system/Throttle/Throttler.php
Normal file
213
system/Throttle/Throttler.php
Normal file
@@ -0,0 +1,213 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* CodeIgniter
|
||||
*
|
||||
* An open source application development framework for PHP
|
||||
*
|
||||
* This content is released under the MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
||||
* Copyright (c) 2019 CodeIgniter Foundation
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* @package CodeIgniter
|
||||
* @author CodeIgniter Dev Team
|
||||
* @copyright 2019 CodeIgniter Foundation
|
||||
* @license https://opensource.org/licenses/MIT MIT License
|
||||
* @link https://codeigniter.com
|
||||
* @since Version 4.0.0
|
||||
* @filesource
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Throttle;
|
||||
|
||||
use CodeIgniter\Cache\CacheInterface;
|
||||
|
||||
/**
|
||||
* Class Throttler
|
||||
*
|
||||
* Uses an implementation of the Token Bucket algorithm to implement a
|
||||
* "rolling window" type of throttling that can be used for rate limiting
|
||||
* an API or any other request.
|
||||
*
|
||||
* Each "token" in the "bucket" is equivalent to a single request
|
||||
* for the purposes of this implementation.
|
||||
*
|
||||
* @see https://en.wikipedia.org/wiki/Token_bucket
|
||||
*
|
||||
* @package CodeIgniter\Throttle
|
||||
*/
|
||||
class Throttler implements ThrottlerInterface
|
||||
{
|
||||
|
||||
/**
|
||||
* Container for throttle counters.
|
||||
*
|
||||
* @var \CodeIgniter\Cache\CacheInterface
|
||||
*/
|
||||
protected $cache;
|
||||
|
||||
/**
|
||||
* The number of seconds until the next token is available.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $tokenTime = 0;
|
||||
|
||||
/**
|
||||
* The prefix applied to all keys to
|
||||
* minimize potential conflicts.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $prefix = 'throttler_';
|
||||
|
||||
/**
|
||||
* Timestamp to use (during testing)
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $testTime;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param type $cache
|
||||
* @throws type
|
||||
*/
|
||||
public function __construct(CacheInterface $cache)
|
||||
{
|
||||
$this->cache = $cache;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the number of seconds until the next available token will
|
||||
* be released for usage.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getTokenTime(): int
|
||||
{
|
||||
return $this->tokenTime;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Restricts the number of requests made by a single IP address within
|
||||
* a set number of seconds.
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* if (! $throttler->check($request->ipAddress(), 60, MINUTE))
|
||||
* {
|
||||
* die('You submitted over 60 requests within a minute.');
|
||||
* }
|
||||
*
|
||||
* @param string $key The name to use as the "bucket" name.
|
||||
* @param integer $capacity The number of requests the "bucket" can hold
|
||||
* @param integer $seconds The time it takes the "bucket" to completely refill
|
||||
* @param integer $cost The number of tokens this action uses.
|
||||
*
|
||||
* @return boolean
|
||||
* @internal param int $maxRequests
|
||||
*/
|
||||
public function check(string $key, int $capacity, int $seconds, int $cost = 1): bool
|
||||
{
|
||||
$tokenName = $this->prefix . $key;
|
||||
|
||||
// Check to see if the bucket has even been created yet.
|
||||
if (($tokens = $this->cache->get($tokenName)) === null)
|
||||
{
|
||||
// If it hasn't been created, then we'll set it to the maximum
|
||||
// capacity - 1, and save it to the cache.
|
||||
$this->cache->save($tokenName, $capacity - $cost, $seconds);
|
||||
$this->cache->save($tokenName . 'Time', time(), $seconds);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// If $tokens > 0, then we need to replenish the bucket
|
||||
// based on how long it's been since the last update.
|
||||
$throttleTime = $this->cache->get($tokenName . 'Time');
|
||||
$elapsed = $this->time() - $throttleTime;
|
||||
|
||||
// Number of tokens to add back per second
|
||||
$rate = $capacity / $seconds;
|
||||
|
||||
// How many seconds till a new token is available.
|
||||
// We must have a minimum wait of 1 second for a new token.
|
||||
// Primarily stored to allow devs to report back to users.
|
||||
$newTokenAvailable = (1 / $rate) - $elapsed;
|
||||
$this->tokenTime = max(1, $newTokenAvailable);
|
||||
|
||||
// Add tokens based up on number per second that
|
||||
// should be refilled, then checked against capacity
|
||||
// to be sure the bucket didn't overflow.
|
||||
$tokens += $rate * $elapsed;
|
||||
$tokens = $tokens > $capacity ? $capacity : $tokens;
|
||||
|
||||
// If $tokens > 0, then we are safe to perform the action, but
|
||||
// we need to decrement the number of available tokens.
|
||||
if ($tokens > 0)
|
||||
{
|
||||
$this->cache->save($tokenName, $tokens - $cost, $seconds);
|
||||
$this->cache->save($tokenName . 'Time', time(), $seconds);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Used during testing to set the current timestamp to use.
|
||||
*
|
||||
* @param integer $time
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function setTestTime(int $time)
|
||||
{
|
||||
$this->testTime = $time;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Return the test time, defaulting to current.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function time(): int
|
||||
{
|
||||
return $this->testTime ?? time();
|
||||
}
|
||||
|
||||
}
|
||||
76
system/Throttle/ThrottlerInterface.php
Normal file
76
system/Throttle/ThrottlerInterface.php
Normal file
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
/**
|
||||
* CodeIgniter
|
||||
*
|
||||
* An open source application development framework for PHP
|
||||
*
|
||||
* This content is released under the MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
||||
* Copyright (c) 2019 CodeIgniter Foundation
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* @package CodeIgniter
|
||||
* @author CodeIgniter Dev Team
|
||||
* @copyright 2019 CodeIgniter Foundation
|
||||
* @license https://opensource.org/licenses/MIT MIT License
|
||||
* @link https://codeigniter.com
|
||||
* @since Version 4.0.0
|
||||
* @filesource
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Throttle;
|
||||
|
||||
/**
|
||||
* Expected behavior of a Throttler
|
||||
*/
|
||||
interface ThrottlerInterface
|
||||
{
|
||||
|
||||
/**
|
||||
* Restricts the number of requests made by a single key within
|
||||
* a set number of seconds.
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* if (! $throttler->checkIPAddress($request->ipAddress(), 60, MINUTE))
|
||||
* {
|
||||
* die('You submitted over 60 requests within a minute.');
|
||||
* }
|
||||
*
|
||||
* @param string $key The name to use as the "bucket" name.
|
||||
* @param integer $capacity The number of requests the "bucket" can hold
|
||||
* @param integer $seconds The time it takes the "bucket" to completely refill
|
||||
* @param integer $cost The number of tokens this action uses.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function check(string $key, int $capacity, int $seconds, int $cost);
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the number of seconds until the next available token will
|
||||
* be released for usage.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getTokenTime(): int;
|
||||
}
|
||||
Reference in New Issue
Block a user