TimeTrex Community Edition v16.2.0
This commit is contained in:
239
classes/modules/core/RateLimit.class.php
Normal file
239
classes/modules/core/RateLimit.class.php
Normal file
@@ -0,0 +1,239 @@
|
||||
<?php
|
||||
/*********************************************************************************
|
||||
*
|
||||
* TimeTrex is a Workforce Management program developed by
|
||||
* TimeTrex Software Inc. Copyright (C) 2003 - 2021 TimeTrex Software Inc.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU Affero General Public License version 3 as published by
|
||||
* the Free Software Foundation with the addition of the following permission
|
||||
* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
|
||||
* WORK IN WHICH THE COPYRIGHT IS OWNED BY TIMETREX, TIMETREX DISCLAIMS THE
|
||||
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
||||
* details.
|
||||
*
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License along
|
||||
* with this program; if not, see http://www.gnu.org/licenses or write to the Free
|
||||
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||
* 02110-1301 USA.
|
||||
*
|
||||
*
|
||||
* You can contact TimeTrex headquarters at Unit 22 - 2475 Dobbin Rd. Suite
|
||||
* #292 West Kelowna, BC V4T 2E9, Canada or at email address info@timetrex.com.
|
||||
*
|
||||
*
|
||||
* The interactive user interfaces in modified source and object code versions
|
||||
* of this program must display Appropriate Legal Notices, as required under
|
||||
* Section 5 of the GNU Affero General Public License version 3.
|
||||
*
|
||||
*
|
||||
* In accordance with Section 7(b) of the GNU Affero General Public License
|
||||
* version 3, these Appropriate Legal Notices must retain the display of the
|
||||
* "Powered by TimeTrex" logo. If the display of the logo is not reasonably
|
||||
* feasible for technical reasons, the Appropriate Legal Notices must display
|
||||
* the words "Powered by TimeTrex".
|
||||
*
|
||||
********************************************************************************/
|
||||
|
||||
|
||||
/**
|
||||
* @package Core
|
||||
*/
|
||||
class RateLimit {
|
||||
protected $sleep = false; //When rate limit is reached, do we sleep or return FALSE?
|
||||
|
||||
protected $id = 1;
|
||||
protected $group = 'rate_limit';
|
||||
|
||||
protected $allowed_calls = 25;
|
||||
protected $time_frame = 60; //1 minute.
|
||||
|
||||
protected $memory = null;
|
||||
|
||||
/**
|
||||
* RateLimit constructor.
|
||||
*/
|
||||
function __construct() {
|
||||
try {
|
||||
$this->memory = new SharedMemory();
|
||||
|
||||
return true;
|
||||
} catch ( Exception $e ) {
|
||||
Debug::text( 'ERROR: Caught Exception: ' . $e->getMessage(), __FILE__, __LINE__, __METHOD__, 9 );
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
function getID() {
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $value
|
||||
* @return bool
|
||||
*/
|
||||
function setID( $value ) {
|
||||
if ( $value != '' ) {
|
||||
$this->id = $value;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Define the number of calls to check() allowed over a given time frame.
|
||||
* @return int
|
||||
*/
|
||||
function getAllowedCalls() {
|
||||
return $this->allowed_calls;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $value
|
||||
* @return bool
|
||||
*/
|
||||
function setAllowedCalls( $value ) {
|
||||
if ( $value != '' ) {
|
||||
$this->allowed_calls = $value;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
function getTimeFrame() {
|
||||
return $this->time_frame;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $value
|
||||
* @return bool
|
||||
*/
|
||||
function setTimeFrame( $value ) {
|
||||
if ( $value != '' ) {
|
||||
$this->time_frame = $value;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $data
|
||||
* @return bool
|
||||
*/
|
||||
function setRateData( $data ) {
|
||||
if ( is_object( $this->memory ) ) {
|
||||
try {
|
||||
return $this->memory->set( $this->group . $this->getID(), $data );
|
||||
} catch ( Exception $e ) {
|
||||
Debug::text( 'ERROR: Caught Exception: ' . $e->getMessage(), __FILE__, __LINE__, __METHOD__, 9 );
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
function getRateData() {
|
||||
if ( is_object( $this->memory ) ) {
|
||||
try {
|
||||
$retarr = $this->memory->get( $this->group . $this->getID() );
|
||||
|
||||
if ( is_object( $retarr ) ) { //Fail OPEN in cases where the user may have deleted the cache directory. This also prevents HTTP 500 errors on windows which are difficult to diagnose.
|
||||
Debug::Text( 'ERROR: Shared Memory Failed: ' . $retarr->message . ' Cache directory may not exist or has incorrect read/write permissions.', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
$retarr = false;
|
||||
}
|
||||
|
||||
return $retarr;
|
||||
} catch ( Exception $e ) {
|
||||
Debug::text( 'ERROR: Caught Exception: ' . $e->getMessage(), __FILE__, __LINE__, __METHOD__, 9 );
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
function getAttempts() {
|
||||
$rate_data = $this->getRateData();
|
||||
if ( isset( $rate_data['attempts'] ) ) {
|
||||
return $rate_data['attempts'];
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
function check() {
|
||||
if ( $this->getID() != '' ) {
|
||||
$rate_data = $this->getRateData();
|
||||
//Debug::Arr($rate_data, 'Failed Attempt Data: ', __FILE__, __LINE__, __METHOD__, 10);
|
||||
if ( !isset( $rate_data['attempts'] ) ) {
|
||||
$rate_data = [
|
||||
'attempts' => 0,
|
||||
'first_date' => microtime( true ),
|
||||
];
|
||||
} else if ( isset( $rate_data['attempts'] ) ) {
|
||||
if ( $rate_data['attempts'] > $this->getAllowedCalls() && $rate_data['first_date'] >= ( microtime( true ) - $this->getTimeFrame() ) ) {
|
||||
return false;
|
||||
} else if ( $rate_data['first_date'] < ( microtime( true ) - $this->getTimeFrame() ) ) {
|
||||
$rate_data['attempts'] = 0;
|
||||
$rate_data['first_date'] = microtime( true );
|
||||
}
|
||||
}
|
||||
|
||||
$rate_data['attempts']++;
|
||||
$this->setRateData( $rate_data );
|
||||
|
||||
return true; //Don't return result of setRateData() so if it can't write the data to shared memory it fails "OPEN".
|
||||
}
|
||||
|
||||
return true; //Return TRUE is no ID is specified, so it fails "OPEN".
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
function delete() {
|
||||
if ( is_object( $this->memory ) ) {
|
||||
try {
|
||||
return $this->memory->delete( $this->group . $this->getID() );
|
||||
} catch ( Exception $e ) {
|
||||
Debug::text( 'ERROR: Caught Exception: ' . $e->getMessage(), __FILE__, __LINE__, __METHOD__, 9 );
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user