OpenImporter\Database

Complexity

Total Complexity

49

Size/Duplication

Total Lines	359
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	3
A	sendError()	0	29	6
A	fetch_assoc()	0	3	1
A	insert_id()	0	3	1
A	indexExists()	0	16	6
A	getLastError()	0	3	1
A	calculateIndexName()	0	15	4
A	fetch_row()	0	3	1
B	add_index()	0	38	7
A	free_result()	0	3	1
A	buildActionUrl()	0	21	4
A	query()	0	12	3
A	num_rows()	0	3	1
A	determineIndexType()	0	18	5
A	list_indexes()	0	39	5

<?php
/**
 * @name      OpenImporter
 * @copyright OpenImporter contributors
 * @license   BSD https://opensource.org/licenses/BSD-3-Clause
 *
 * @version 1.0
 */

namespace OpenImporter;

/**
 * Class Database
 *
 * This class provides an easy wrapper around the common database
 * functions we work with.
 *
 * @class Database
 */
class Database
{
	/** @var \mysqli */
	protected $connect;

	/** @var bool Allows to run a query two times on certain errors. */
	protected $second_try = true;

	/**
	 * Database constructor.
	 *
	 * @param string $db_server
	 * @param string $db_user
	 * @param string $db_password
	 * @param bool|int $db_persist
	 */
	public function __construct($db_server, $db_user, $db_password, $db_persist)
	{
		$this->connect = mysqli_connect(($db_persist == 1 ? 'p:' : '') . $db_server, $db_user, $db_password);

The call to mysqli_connect() has too few arguments starting with database.

		if (mysqli_connect_error())
		{
			die('Database error: ' . mysqli_connect_error());

Using exit here is not recommended.

		}
	}

	/**
	 * Execute an SQL query.
	 *
	 * @param string $string
	 * @param bool $return_error
	 *
	 * @return \mysqli_result
	 */
	public function query($string, $return_error = false)
	{
		$result = @mysqli_query($this->connect, $string);

		if ($result !== false || $return_error)
		{
			$this->second_try = true;

			return $result;

The expression return $result also could return the type boolean which is incompatible with the documented return type mysqli_result.

		}

		return $this->sendError($string);
	}

	/**
	 * Returns the last MySQL error occurred with the current connection.
	 *
	 * @return string
	 */
	public function getLastError()
	{
		return mysqli_error($this->connect);
	}

	/**
	 * Analyze and sends an error.
	 *
	 * @param string $string
	 *
	 * @throws DatabaseException If a SQL fails
	 *
	 * @return \mysqli_result
	 */
	protected function sendError($string)
	{
		$mysql_error = mysqli_error($this->connect);
		$mysql_errno = mysqli_errno($this->connect);

		// 1016: Can't open file '....MYI'
		// 2013: Lost connection to server during query.
		if ($this->second_try && in_array($mysql_errno, array(1016, 2013)))
		{
			$this->second_try = false;

			// Try to repair the table and run the query again.
			if ($mysql_errno === 1016 && preg_match('~(?:\'([^.\']+)~', $mysql_error, $match) !== 0 && !empty($match[1]))
			{
				mysqli_query($this->connect, "
					REPAIR TABLE $match[1]");
			}

			return $this->query($string, false);
		}

		$action_url = $this->buildActionUrl();

		throw new DatabaseException('
			<b>Unsuccessful!</b><br />
			This query:<blockquote>' . nl2br(htmlspecialchars(trim($string))) . ';</blockquote>
			Caused the error:<br />
			<blockquote>' . nl2br(htmlspecialchars($mysql_error)) . '</blockquote>
			<form action="' . $action_url . '" method="post">
				<input type="submit" value="Try again" />
			</form>
			</div>');
	}

	/**
	 * Puts together the url used in the DatabaseException of sendError to go
	 * back to the last step.
	 *
	 * @return string
	 */
	protected function buildActionUrl()
	{
		// @todo $_GET and $_REQUEST
		// Get the query string so we pass everything.
		if (isset($_REQUEST['start']))
		{
			$_GET['start'] = $_REQUEST['start'];
		}

		$query_string = '';
		foreach ($_GET as $k => $v)
		{
			$query_string .= '&' . $k . '=' . $v;
		}

		if (trim($query_string) !== '')
		{
			$query_string = '?' . strtr(substr($query_string, 1), array('&' => '&amp;'));
		}

		return $_SERVER['PHP_SELF'] . $query_string;
	}

	/**
	 * Wrapper for mysqli_free_result.
	 *
	 * @param \mysqli_result $result
	 */
	public function free_result($result)
	{
		mysqli_free_result($result);
	}

	/**
	 * Wrapper for mysqli_fetch_assoc.
	 *
	 * @param \mysqli_result $result
	 *
	 * @return array
	 */
	public function fetch_assoc($result)
	{
		return mysqli_fetch_assoc($result);
	}

	/**
	 * wrapper for mysqli_fetch_row
	 *
	 * @param \mysqli_result $result
	 *
	 * @return array
	 */
	public function fetch_row($result)
	{
		return mysqli_fetch_row($result);
	}

	/**
	 * wrapper for mysqli_num_rows
	 *
	 * @param \mysqli_result $result
	 *
	 * @return integer
	 */
	public function num_rows($result)
	{
		return mysqli_num_rows($result);

The expression return mysqli_num_rows($result) also could return the type string which is incompatible with the documented return type integer.

	}

	/**
	 * wrapper for mysqli_insert_id
	 *
	 * @return integer
	 */
	public function insert_id()
	{
		return mysqli_insert_id($this->connect);

The expression return mysqli_insert_id($this->connect) also could return the type string which is incompatible with the documented return type integer.

	}

	/**
	 * Add an index.
	 *
	 * @param string $table_name
	 * @param array $index_info
	 *
	 * @return bool
	 */
	public function add_index($table_name, $index_info)
	{
		// No columns = no index.
		if (empty($index_info['columns']))
		{
			return false;
		}

		$columns = implode(',', $index_info['columns']);

		$index_info['name'] = $this->calculateIndexName($index_info);

		if ($this->indexExists($table_name, $index_info))

$index_info of type array is incompatible with the type string expected by parameter $index_info of OpenImporter\Database::indexExists().

		{
			return false;
		}

		// If we're here we know we don't have the index - so just add it.
		if (!empty($index_info['type']) && $index_info['type'] === 'primary')
		{
			$this->query('
				ALTER TABLE ' . $table_name . '
				ADD PRIMARY KEY (' . $columns . ')');
		}
		else
		{
			if (!isset($index_info['type']) || !in_array($index_info['type'], array('unique', 'index', 'key')))
			{
				$type = 'INDEX';
			}
			else
			{
				$type = strtoupper($index_info['type']);
			}

			$this->query('
				ALTER TABLE ' . $table_name . '
				ADD ' . $type . ' ' . $index_info['name'] . ' (' . $columns . ')');
		}
	}

	/**
	 * Set a name for the index
	 *
	 * @param $index_info
	 *
	 * @return string
	 */
	protected function calculateIndexName($index_info)
	{
		// No name - make it up!
		if (empty($index_info['name']))
		{
			// No need for primary.
			if (isset($index_info['type']) && $index_info['type'] === 'primary')
			{
				return '';
			}

			return implode('_', $index_info['columns']);
		}

		return $index_info['name'];
	}

	/**
	 * Check if an index exists or not
	 *
	 * @param string $table_name
	 * @param string $index_info
	 *
	 * @return bool
	 */
	protected function indexExists($table_name, $index_info)
	{
		// Let's get all our indexes.
		$indexes = $this->list_indexes($table_name, true);

		// Do we already have it?
		foreach ($indexes as $index)
		{
			if ($index['name'] === $index_info['name']
				|| ($index['type'] === 'primary' && isset($index_info['type']) && $index_info['type'] === 'primary'))
			{
				return true;
			}
		}

		return false;
	}

	/**
	 * Get index information.
	 *
	 * @param string $table_name
	 * @param bool $detail
	 *
	 * @return array
	 */
	public function list_indexes($table_name, $detail = false)
	{
		$result = $this->query("
			SHOW KEYS
			FROM {$table_name}");

		$indexes = array();
		while ($row = $this->fetch_assoc($result))
		{
			if ($detail)
			{
				// This is the first column we've seen?
				if (empty($indexes[$row['Key_name']]))
				{
					$indexes[$row['Key_name']] = array(
						'name' => $row['Key_name'],
						'type' => $this->determineIndexType($row),
						'columns' => array(),
					);
				}

				// Is it a partial index?
				if (!empty($row['Sub_part']))
				{
					$indexes[$row['Key_name']]['columns'][] = $row['Column_name'] . '(' . $row['Sub_part'] . ')';
				}
				else
				{
					$indexes[$row['Key_name']]['columns'][] = $row['Column_name'];
				}
			}
			else
			{
				$indexes[] = $row['Key_name'];
			}
		}
		$this->free_result($result);

		return $indexes;
	}

	/**
	 * What is the index type?
	 *
	 * @param string[] $row
	 *
	 * @return string
	 */
	protected function determineIndexType($row)
	{
		if ($row['Key_name'] === 'PRIMARY')
		{
			return 'primary';
		}

		if (empty($row['Non_unique']))
		{
			return 'unique';
		}

		if (isset($row['Index_type']) && $row['Index_type'] === 'FULLTEXT')
		{
			return 'fulltext';
		}

		return 'index';
	}
}