MyDb\Generic

Complexity

Total Complexity

66

Size/Duplication

Total Lines	371
Duplicated Lines	0 %

Test Coverage

Coverage

70.08%

Importance

Changes	9
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	toTimestamp()	0	3	1
A	haltmsg()	0	8	3
A	halt()	0	21	5
A	indexNames()	0	3	1
A	limitQuery()	0	16	4
A	addLog()	0	17	4
A	fromTimestamp()	0	15	6
A	dbAddslashes()	0	6	3
D	logBackTrace()	0	29	21
A	emailError()	0	20	2
A	queryId()	0	3	1
A	real_escape()	0	6	4
A	escape()	0	5	1
A	f()	0	6	4
A	log()	0	3	1
A	__construct()	0	10	2
A	linkId()	0	3	1
A	qr()	0	3	1
A	getLog()	0	3	1

<?php
/**
 * Generic SQL Driver Related Functionality
 * @author Joe Huss <detain@interserver.net>
 * @copyright 2019
 * @package MyAdmin
 * @category SQL
 */

namespace MyDb;

/**
 * Class Generic
 */
abstract class Generic
{
	/* public: connection parameters */
	public $host = 'localhost';
	public $database = '';
	public $user = '';
	public $password = '';

	/* public: configuration parameters */
	public $autoStripslashes = false;
	public $Debug = 0; // Set to 1 for debugging messages.
	public $haltOnError = 'yes'; // "yes" (halt with message), "no" (ignore errors quietly), "report" (ignore error, but spit a warning)

	public $maxConnectErrors = 30;
	public $connectionAttempt = 0;
	public $maxMatches = 10000000;

	/**
	 * @var int
	 */
	public $autoFree = 0; // Set to 1 for automatic mysql_free_result()

	/* public: result array and current row number */
	public $Record = [];
	public $Row;

	/* public: current error number and error text */
	public $Errno = 0;
	public $Error = '';

	/* public: this is an api revision, not a CVS revision. */
	public $type = 'generic';

	/**
	 * @var int|object
	 */
	public $linkId = 0;
	public $queryId = 0;

	public $characterSet = 'utf8mb4';
	public $collation = 'utf8mb4_unicode_ci';
	
	/**
	 * Logged queries.
	 * @var array
	 */
	protected $log = [];    

	/**
	 * Constructs the db handler, can optionally specify connection parameters
	 *
	 * @param string $database Optional The database name
	 * @param string $user Optional The username to connect with
	 * @param string $password Optional The password to use
	 * @param string $host Optional The hostname where the server is, or default to localhost
	 * @param string $query Optional query to perform immediately
	 */
	public function __construct($database = '', $user = '', $password = '', $host = 'localhost', $query = '')
	{
		$this->database = $database;
		$this->user = $user;
		$this->password = $password;
		$this->host = $host;
		if ($query != '') {
			$this->query($query);

The method query() does not exist on MyDb\Generic. Did you maybe mean queryId()?

		}
		$this->connection_atttempt = 0;

The property connection_atttempt does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

	}

	/**
	 * @param string $message
	 * @param string $line
	 * @param string $file
	 * @return void
	 */
	public function log($message, $line = '', $file = '', $level = 'info')

The parameter $line is not used and could be removed.

The parameter $file is not used and could be removed.

The parameter $level is not used and could be removed.

	{
		error_log($message);
	}

	/**
	 * @return int|object
	 */
	public function linkId()
	{
		return $this->linkId;
	}

	/**
	 * @return int|object
	 */
	public function queryId()
	{
		return $this->queryId;
	}

	/**
	 * @param $string
	 * @return string
	 */
	public function real_escape($string = '')
	{
		if ((!is_resource($this->linkId) || $this->linkId == 0) && !$this->connect()) {

The condition is_resource($this->linkId) is always false.

The method connect() does not exist on MyDb\Generic. Since it exists in all sub-types, consider adding an abstract or default implementation to MyDb\Generic.

			return $this->escape($string);
		}
		return mysqli_real_escape_string($this->linkId, $string);

It seems like $this->linkId can also be of type integer and resource; however, parameter $link of mysqli_real_escape_string() does only seem to accept mysqli, maybe add an additional type check?

	}

	/**
	 * @param $string
	 * @return string
	 */
	public function escape($string = '')
	{
		//if (function_exists('mysql_escape_string'))

75% of this comment could be valid code. Did you maybe forget this after debugging?

		//return mysql_escape_string($string);

72% of this comment could be valid code. Did you maybe forget this after debugging?

		return str_replace(array('\\', "\0", "\n", "\r", "'", '"', "\x1a"), array('\\\\', '\\0', '\\n', '\\r', "\\'", '\\"', '\\Z'), $string);
	}

	/**
	 * @param mixed $str
	 * @return string
	 */
	public function dbAddslashes($str = '')
	{
		if (!isset($str) || $str == '') {
			return '';
		}
		return addslashes($str);
	}

	/**
	 * Db::toTimestamp()
	 * @param mixed $epoch
	 * @return bool|string
	 */
	public function toTimestamp($epoch)
	{
		return date('Y-m-d H:i:s', $epoch);
	}

	/**
	 * Db::fromTimestamp()
	 * @param mixed $timestamp
	 * @return bool|int|mixed
	 */
	public function fromTimestamp($timestamp)
	{
		if (preg_match('/([0-9]{4})-([0-9]{2})-([0-9]{2}) ([0-9]{2}):([0-9]{2}):([0-9]{2})/', $timestamp, $parts)) {
			$time = mktime($parts[4], $parts[5], $parts[6], $parts[2], $parts[3], $parts[1]);
		} elseif (preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})([0-9]{2})([0-9]{2})([0-9]{2})/', $timestamp, $parts)) {
			$time = mktime($parts[4], $parts[5], $parts[6], $parts[2], $parts[3], $parts[1]);
		} elseif (preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})/', $timestamp, $parts)) {
			$time = mktime(1, 1, 1, $parts[2], $parts[3], $parts[1]);
		} elseif (is_numeric($timestamp) && $timestamp >= 943938000) {
			$time = $timestamp;
		} else {
			$this->log('Cannot Match Timestamp from '.$timestamp, __LINE__, __FILE__);
			$time = false;
		}
		return $time;
	}

	/**
	 * perform a query with limited result set
	 *
	 * @param string $queryString
	 * @param string|int $numRows
	 * @param int $offset
	 * @param string|int $line
	 * @param string $file
	 * @return mixed
	 */
	public function limitQuery($queryString, $numRows = '', $offset = 0, $line = '', $file = '')
	{
		if (!$numRows) {
			$numRows = $this->maxMatches;
		}
		if ($offset == 0) {
			$queryString .= ' LIMIT '.(int) $numRows;
		} else {
			$queryString .= ' LIMIT '.(int) $offset.','.(int) $numRows;
		}

		if ($this->Debug) {
			printf("Debug: limitQuery = %s<br>offset=%d, num_rows=%d<br>\n", $queryString, $offset, $numRows);
		}

		return $this->query($queryString, $line, $file);
	}

	/**
	 * db:qr()
	 *
	 *  alias of queryReturn()
	 *
	 * @param mixed $query SQL Query to be used
	 * @param string $line optionally pass __LINE__ calling the query for logging
	 * @param string $file optionally pass __FILE__ calling the query for logging
	 * @return mixed FALSE if no rows, if a single row it returns that, if multiple it returns an array of rows, associative responses only
	 */
	public function qr($query, $line = '', $file = '')
	{
		return $this->queryReturn($query, $line, $file);

The method queryReturn() does not exist on MyDb\Generic. It seems like you code against a sub-type of said class. However, the method does not exist in MyDb\Pdo\Db. Are you sure you never get one of those?

	}

	/**
	 * gets a field
	 *
	 * @param mixed  $name
	 * @param string $stripSlashes
	 * @return string
	 */
	public function f($name, $stripSlashes = '')
	{
		if ($stripSlashes || ($this->autoStripslashes && !$stripSlashes)) {
			return stripslashes($this->Record[$name]);
		} else {
			return $this->Record[$name];
		}
	}

	/**
	 * error handling
	 *
	 * @param mixed $msg
	 * @param string $line
	 * @param string $file
	 * @return void
	 */
	public function halt($msg, $line = '', $file = '')
	{
		$this->unlock(false);

The method unlock() does not exist on MyDb\Generic. Since it exists in all sub-types, consider adding an abstract or default implementation to MyDb\Generic.

		/* Just in case there is a table currently locked */

		//$this->Error = @$this->linkId->error;

54% of this comment could be valid code. Did you maybe forget this after debugging?

		//$this->Errno = @$this->linkId->errno;

54% of this comment could be valid code. Did you maybe forget this after debugging?

		if ($this->haltOnError == 'no') {
			return true;
		}
		if ($msg != '') {
			$this->haltmsg($msg, $line, $file);
		}
		if ($this->haltOnError != 'report') {
			echo '<p><b>Session halted.</b>';
			// FIXME! Add check for error levels
			if (isset($GLOBALS['tf'])) {
				$GLOBALS['tf']->terminate();
			}
		}
		return true;
	}

	/**
	 * @param mixed $msg
	 * @param string $line
	 * @param string $file
	 * @return mixed|void
	 */
	public function logBackTrace($msg, $line = '', $file = '')

The parameter $msg is not used and could be removed.

	{
		$backtrace = (function_exists('debug_backtrace') ? debug_backtrace() : []);
		$this->log(
			('' !== getenv('REQUEST_URI') ? ' '.getenv('REQUEST_URI') : '').
			((isset($_POST) && count($_POST)) ? ' POST='.json_encode($_POST) : '').
			((isset($_GET) && count($_GET)) ? ' GET='.json_encode($_GET) : '').
			((isset($_FILES) && count($_FILES)) ? ' FILES='.json_encode($_FILES) : '').
			('' !== getenv('HTTP_USER_AGENT') ? ' AGENT="'.getenv('HTTP_USER_AGENT').'"' : '').
			(isset($_SERVER['REQUEST_METHOD']) ? ' METHOD="'.$_SERVER['REQUEST_METHOD'].'"'.
				($_SERVER['REQUEST_METHOD'] === 'POST' ? ' POST="'.json_encode($_POST).'"' : '') : ''),
			$line,
			$file,
			'error'
		);
		for ($level = 1, $levelMax = count($backtrace); $level < $levelMax; $level++) {
			$message = (isset($backtrace[$level]['file']) ? 'File: '.$backtrace[$level]['file'] : '').
				(isset($backtrace[$level]['line']) ? ' Line: '.$backtrace[$level]['line'] : '').
				' Function: '.(isset($backtrace[$level] ['class']) ? '(class '.$backtrace[$level] ['class'].') ' : '').
				(isset($backtrace[$level] ['type']) ? $backtrace[$level] ['type'].' ' : '').
				$backtrace[$level] ['function'].'(';
			if (isset($backtrace[$level] ['args'])) {
				for ($argument = 0, $argumentMax = count($backtrace[$level]['args']); $argument < $argumentMax; $argument++) {
					$message .= ($argument > 0 ? ', ' : '').
						(is_object($backtrace[$level]['args'][$argument]) ? 'class '.get_class($backtrace[$level]['args'][$argument]) : json_encode($backtrace[$level]['args'][$argument]));
				}
			}
			$message .= ')';
			$this->log($message, $line, $file, 'error');
		}
	}

	public function emailError($queryString, $error, $line, $file)
	{
		$subject = php_uname('n').' MySQLi Error';
		$smarty = new \TFSmarty();

The type TFSmarty was not found. Maybe you did not declare it correctly or list all dependencies?

		$smarty->assign([
			'type' => $this->type,
			'queryString' => $queryString,
			'error' => $error,
			'line' => $line,
			'file' => $file,
			'request' => $_REQUEST,
			'server' => $_SERVER,
		]);
		if (isset($GLOBALS['tf'])) {
			$smarty->assign('account_id', $GLOBALS['tf']->session->account_id);
		}
		$email = $smarty->fetch('email/admin/sql_error.tpl');
		(new \MyAdmin\Mail())->adminMail($subject, $email, 'john@interserver.net', 'admin/sql_error.tpl');

The type MyAdmin\Mail was not found. Maybe you did not declare it correctly or list all dependencies?

		(new \MyAdmin\Mail())->adminMail($subject, $email, 'detain@interserver.net', 'admin/sql_error.tpl');
		$this->haltmsg('Invalid SQL: '.$queryString, $line, $file);
	}
	
	/**
	 * @param mixed $msg
	 * @param string $line
	 * @param string $file
	 * @return mixed|void
	 */
	public function haltmsg($msg, $line = '', $file = '')
	{
		$this->log("Database error: $msg", $line, $file, 'error');
		if ($this->Errno != '0' || !in_array($this->Error, ['', '()'])) {
			$sqlstate = mysqli_sqlstate($this->linkId);

It seems like $this->linkId can also be of type integer; however, parameter $link of mysqli_sqlstate() does only seem to accept mysqli, maybe add an additional type check?

			$this->log("MySQLi SQLState: {$sqlstate}. Error: ".$this->Errno.' ('.$this->Error.')', $line, $file, 'error');
		}
		$this->logBackTrace($msg, $line, $file);
	}

	/**
	 * @return array
	 */
	public function indexNames()
	{
		return [];
	}
	

	/**
	 * Add query to logged queries.
	 * @param string $statement
	 * @param float $time Elapsed seconds with microseconds
	 * @param string|int $line Line Number
	 * @param string $file File Name
	 */
	public function addLog($statement, $time, $line = '', $file = '')
	{
		$query = [
			'statement' => $statement,
			'time' => $time * 1000
		];
		if ($line != '') {
			$query['line'] = $line;
		}
		if ($file != '') {
			$query['file'] = $file;
		}
		if (!isset($GLOBALS['db_queries'])) {
			$GLOBALS['db_queries'] = array();
		}
		$GLOBALS['db_queries'][] = $query;
		array_push($this->log, $query);
	}

	/**
	 * Return logged queries.
	 * @return array Logged queries
	 */
	public function getLog()
	{
		return $this->log;
	}    
}