CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add DB/IO max loop override

Browse Source 
The max query call loop checker can be set to any number, or overridden
with -1

call dbSetMaxQueryCall

on set with -1 will throw warning, if not larger than 0 will throw error

if called with null or empty, it will reset to default value

get current set value with dbGetMaxQueryCall
This commit is contained in:
Clemens Schwaighofer
2020-04-08 17:30:40 +09:00
parent b2c0a57924
commit d4e5f92277
1 changed files with 53 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
www/lib/CoreLibs/DB/IO.php
View File

@@ -288,6 +288,7 @@ class IO extends \CoreLibs\Basic
// endless loop protection // endless loop protection
private $MAX_QUERY_CALL; private $MAX_QUERY_CALL;
private $DEFAULT_MAX_QUERY_CALL = 20; // default
private $query_called = array(); private $query_called = array();
// error string // error string
protected $error_string = array(); protected $error_string = array();
@@ -357,6 +358,8 @@ class IO extends \CoreLibs\Basic
$this->error_string['40'] = 'Query async call failed.'; $this->error_string['40'] = 'Query async call failed.';
$this->error_string['41'] = 'Connection is busy with a different query. Cannot execute.'; $this->error_string['41'] = 'Connection is busy with a different query. Cannot execute.';
$this->error_string['42'] = 'Cannot check for async query, none has been started yet.'; $this->error_string['42'] = 'Cannot check for async query, none has been started yet.';
$this->error_string['50'] = 'Setting max query call to -1 will disable loop protection for all subsequent runs';
$this->error_string['51'] = 'Max query call needs to be set to at least 1';
// set debug, either via global var, or debug var during call // set debug, either via global var, or debug var during call
$this->db_debug = false; $this->db_debug = false;
@@ -731,7 +734,10 @@ class IO extends \CoreLibs\Basic
$this->query_called[$md5] = 0; $this->query_called[$md5] = 0;
} }
// count up the run, if this is run more than the max_run then exit with error // count up the run, if this is run more than the max_run then exit with error
if ($this->query_called[$md5] > $this->MAX_QUERY_CALL) { // if set to -1, then ignore it
if ($this->MAX_QUERY_CALL != -1 &&
$this->query_called[$md5] > $this->MAX_QUERY_CALL
) {
$this->error_id = 30; $this->error_id = 30;
$this->__dbError(); $this->__dbError();
$this->__dbDebug('db', $this->query, 'dbExec', 'Q[nc]'); $this->__dbDebug('db', $this->query, 'dbExec', 'Q[nc]');
@@ -857,6 +863,52 @@ class IO extends \CoreLibs\Basic
return $this->db_debug; return $this->db_debug;
} }
/**
* set max query calls, set to --1 to disable loop
* protection. this will generate a warning
* empty call (null) will reset to default
* @param int|null $max_calls Set the max loops allowed
* @return bool True for succesfull set
*/
public function dbSetMaxQueryCall(?int $max_calls = null): bool
{
$success = false;
// if null then reset to default
if ($max_calls === null) {
$max_calls = $this->DEFAULT_MAX_QUERY_CALL;
}
// if -1 then disable loop check
// DANGEROUS, WARN USER
if ($max_calls == -1) {
$this->warning_id = 50;
$this->__dbError();
}
// negative or 0
if ($max_calls < -1 || $max_calls == 0) {
$this->error_id = 51;
$this->__dbError();
// early abort
return false;
}
// ok entry, set
if ($max_calls == -1 ||
$max_calls > 0
) {
$this->MAX_QUERY_CALL = $max_calls;
$succes = true;
}
return $success;
}
/**
* returns current set max query calls for loop avoidance
* @return int Integer number, if -1 the loop check is disabled
*/
public function dbGetMaxQueryCall(): int
{
return $this->MAX_QUERY_CALL;
}
/** /**
* resets the call times for the max query called to 0 * resets the call times for the max query called to 0
* USE CAREFULLY: rather make the query prepare -> execute * USE CAREFULLY: rather make the query prepare -> execute