first commit

administrator/components/com_akeebabackup/engine/Driver/Query/Element.php

@@ -0,0 +1,114 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+/**
+ * Query Element Class.
+ *
+ * Based on Joomla! Platform 11.3
+ */
+class Element
+{
+	/**
+	 * @var    string  The name of the element.
+	 */
+	protected $name = null;
+
+	/**
+	 * @var    array  An array of elements.
+	 */
+	protected $elements = null;
+
+	/**
+	 * @var    string  Glue piece.
+	 */
+	protected $glue = null;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param   string  $name      The name of the element.
+	 * @param   mixed   $elements  String or array.
+	 * @param   string  $glue      The glue for elements.
+	 */
+	public function __construct($name, $elements, $glue = ',')
+	{
+		$this->elements = [];
+		$this->name     = $name;
+		$this->glue     = $glue;
+
+		$this->append($elements);
+	}
+
+	/**
+	 * Magic function to convert the query element to a string.
+	 *
+	 * @return  string
+	 */
+	public function __toString()
+	{
+		if (substr($this->name, -2) == '()')
+		{
+			return PHP_EOL . substr($this->name, 0, -2) . '(' . implode($this->glue, $this->elements) . ')';
+		}
+		else
+		{
+			return PHP_EOL . $this->name . ' ' . implode($this->glue, $this->elements);
+		}
+	}
+
+	/**
+	 * Appends element parts to the internal list.
+	 *
+	 * @param   mixed  $elements  String or array.
+	 *
+	 * @return  void
+	 */
+	public function append($elements)
+	{
+		if (is_array($elements))
+		{
+			$this->elements = array_merge($this->elements, $elements);
+		}
+		else
+		{
+			$this->elements = array_merge($this->elements, [$elements]);
+		}
+	}
+
+	/**
+	 * Gets the elements of this element.
+	 *
+	 * @return  string
+	 */
+	public function getElements()
+	{
+		return $this->elements;
+	}
+
+	/**
+	 * Method to provide deep copy support to nested objects and arrays
+	 * when cloning.
+	 *
+	 * @return  void
+	 */
+	public function __clone()
+	{
+		foreach ($this as $k => $v)
+		{
+			if (is_object($v) || is_array($v))
+			{
+				$this->{$k} = unserialize(serialize($v));
+			}
+		}
+	}
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Limitable.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+use Akeeba\Engine\Driver\Query\Base as BaseQuery;
+
+/**
+ * Query Limitable Interface.
+ * Adds bind/unbind methods as well as a getBounded() method
+ * to retrieve the stored bounded variables on demand prior to
+ * query execution.
+ *
+ * Based on Joomla! Platform 11.2
+ */
+interface Limitable
+{
+	/**
+	 * Method to modify a query already in string format with the needed
+	 * additions to make the query limited to a particular number of
+	 * results, or start at a particular offset. This method is used
+	 * automatically by the __toString() method if it detects that the
+	 * query implements the Limitable interface.
+	 *
+	 * @param   string   $query   The query in string format
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return  string
+	 *
+	 * @since   12.1
+	 */
+	public function processLimit($query, $limit, $offset = 0);
+
+	/**
+	 * Sets the offset and limit for the result set, if the database driver supports it.
+	 *
+	 * Usage:
+	 * $query->setLimit(100, 0); (retrieve 100 rows, starting at first record)
+	 * $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th record)
+	 *
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return  BaseQuery  Returns this object to allow chaining.
+	 *
+	 * @since   12.1
+	 */
+	public function setLimit($limit = 0, $offset = 0);
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Mysql.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+/**
+ * Query Building Class.
+ *
+ * Based on Joomla! Platform 11.3
+ */
+class Mysql extends Mysqli
+{
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Mysqli.php

@@ -0,0 +1,100 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+use Akeeba\Engine\Driver\Query\Base as BaseQuery;
+
+/**
+ * Query Building Class.
+ *
+ * Based on Joomla! Platform 11.3
+ */
+class Mysqli extends Base implements Limitable
+{
+	/**
+	 * @var    integer  The offset for the result set.
+	 */
+	protected $offset;
+
+	/**
+	 * @var    integer  The limit for the result set.
+	 */
+	protected $limit;
+
+	/**
+	 * Method to modify a query already in string format with the needed
+	 * additions to make the query limited to a particular number of
+	 * results, or start at a particular offset.
+	 *
+	 * @param   string   $query   The query in string format
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return string
+	 */
+	public function processLimit($query, $limit, $offset = 0)
+	{
+		if ($limit > 0 || $offset > 0)
+		{
+			$query .= ' LIMIT ' . $offset . ', ' . $limit;
+		}
+
+		return $query;
+	}
+
+	/**
+	 * Sets the offset and limit for the result set, if the database driver supports it.
+	 *
+	 * Usage:
+	 * $query->setLimit(100, 0); (retrieve 100 rows, starting at first record)
+	 * $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th record)
+	 *
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return  BaseQuery  Returns this object to allow chaining.
+	 */
+	public function setLimit($limit = 0, $offset = 0)
+	{
+		$this->limit  = (int) $limit;
+		$this->offset = (int) $offset;
+
+		return $this;
+	}
+
+	/**
+	 * Concatenates an array of column names or values.
+	 *
+	 * @param   array   $values     An array of values to concatenate.
+	 * @param   string  $separator  As separator to place between each value.
+	 *
+	 * @return  string  The concatenated values.
+	 */
+	public function concatenate($values, $separator = null)
+	{
+		if ($separator)
+		{
+			$concat_string = 'CONCAT_WS(' . $this->quote($separator);
+
+			foreach ($values as $value)
+			{
+				$concat_string .= ', ' . $value;
+			}
+
+			return $concat_string . ')';
+		}
+		else
+		{
+			return 'CONCAT(' . implode(',', $values) . ')';
+		}
+	}
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Pdomysql.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+/**
+ * Query Building Class.
+ *
+ * Based on Joomla! Platform 11.3
+ */
+class Pdomysql extends Mysqli implements Limitable
+{
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Preparable.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+use PDO;
+
+/**
+ * Database Query Preparable Interface.
+ *
+ * Adds bind/unbind methods as well as a getBounded() method
+ * to retrieve the stored bounded variables on demand prior to
+ * query execution.
+ *
+ * @since  1.0
+ *
+ * @codeCoverageIgnore
+ */
+interface Preparable
+{
+	/**
+	 * Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also
+	 * removes a variable that has been bounded from the internal bounded array when the passed in value is null.
+	 *
+	 * @param   string|integer   $key            The key that will be used in your SQL query to reference the value. Usually of
+	 *                                           the form ':key', but can also be an integer.
+	 * @param   mixed           &$value          The value that will be bound. The value is passed by reference to support output
+	 *                                           parameters such as those possible with stored procedures.
+	 * @param   integer          $dataType       Constant corresponding to a SQL datatype.
+	 * @param   integer          $length         The length of the variable. Usually required for OUTPUT parameters.
+	 * @param   array            $driverOptions  Optional driver options to be used.
+	 *
+	 * @return  Preparable
+	 *
+	 * @since   1.0
+	 */
+	public function bind($key = null, &$value = null, $dataType = PDO::PARAM_STR, $length = 0, $driverOptions = []);
+
+	/**
+	 * Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is
+	 * returned.
+	 *
+	 * @param   mixed  $key  The bounded variable key to retrieve.
+	 *
+	 * @return  mixed
+	 *
+	 * @since   1.0
+	 */
+	public function &getBounded($key = null);
+}

administrator/components/com_akeebabackup/engine/Driver/Query/Sqlite.php

@@ -0,0 +1,236 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+use PDO;
+use stdClass;
+
+/**
+ * SQLite Query Building Class.
+ *
+ * @since  1.0
+ */
+class Sqlite extends Base implements Preparable, Limitable
+{
+	/**
+	 * The limit for the result set.
+	 *
+	 * @var    integer
+	 * @since  1.0
+	 */
+	protected $limit;
+
+	/**
+	 * The offset for the result set.
+	 *
+	 * @var    integer
+	 * @since  1.0
+	 */
+	protected $offset;
+
+	/**
+	 * Holds key / value pair of bound objects.
+	 *
+	 * @var    mixed
+	 * @since  1.0
+	 */
+	protected $bounded = [];
+
+	/**
+	 * Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also
+	 * removes a variable that has been bounded from the internal bounded array when the passed in value is null.
+	 *
+	 * @param   string|integer   $key            The key that will be used in your SQL query to reference the value. Usually of
+	 *                                           the form ':key', but can also be an integer.
+	 * @param   mixed           &$value          The value that will be bound. The value is passed by reference to support output
+	 *                                           parameters such as those possible with stored procedures.
+	 * @param   integer          $dataType       Constant corresponding to a SQL datatype.
+	 * @param   integer          $length         The length of the variable. Usually required for OUTPUT parameters.
+	 * @param   array            $driverOptions  Optional driver options to be used.
+	 *
+	 * @return  Sqlite  Returns this object to allow chaining.
+	 *
+	 * @since   1.0
+	 */
+	public function bind($key = null, &$value = null, $dataType = PDO::PARAM_STR, $length = 0, $driverOptions = [])
+	{
+		// Case 1: Empty Key (reset $bounded array)
+		if (empty($key))
+		{
+			$this->bounded = [];
+
+			return $this;
+		}
+
+		// Case 2: Key Provided, null value (unset key from $bounded array)
+		if (is_null($value))
+		{
+			if (isset($this->bounded[$key]))
+			{
+				unset($this->bounded[$key]);
+			}
+
+			return $this;
+		}
+
+		$obj = new stdClass;
+
+		$obj->value         = &$value;
+		$obj->dataType      = $dataType;
+		$obj->length        = $length;
+		$obj->driverOptions = $driverOptions;
+
+		// Case 3: Simply add the Key/Value into the bounded array
+		$this->bounded[$key] = $obj;
+
+		return $this;
+	}
+
+	/**
+	 * Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is
+	 * returned.
+	 *
+	 * @param   mixed  $key  The bounded variable key to retrieve.
+	 *
+	 * @return  mixed
+	 *
+	 * @since   1.0
+	 */
+	public function &getBounded($key = null)
+	{
+		if (empty($key))
+		{
+			return $this->bounded;
+		}
+		else
+		{
+			if (isset($this->bounded[$key]))
+			{
+				return $this->bounded[$key];
+			}
+		}
+	}
+
+	/**
+	 * Gets the number of characters in a string.
+	 *
+	 * Note, use 'length' to find the number of bytes in a string.
+	 *
+	 * Usage:
+	 * $query->select($query->charLength('a'));
+	 *
+	 * @param   string  $field      A value.
+	 * @param   string  $operator   Comparison operator between charLength integer value and $condition
+	 * @param   string  $condition  Integer value to compare charLength with.
+	 *
+	 * @return  string  The required char length call.
+	 *
+	 * @since   1.1.0
+	 */
+	public function charLength($field, $operator = null, $condition = null)
+	{
+		return 'length(' . $field . ')' . (isset($operator) && isset($condition) ? ' ' . $operator . ' ' . $condition : '');
+	}
+
+	/**
+	 * Clear data from the query or a specific clause of the query.
+	 *
+	 * @param   string  $clause  Optionally, the name of the clause to clear, or nothing to clear the whole query.
+	 *
+	 * @return  Sqlite  Returns this object to allow chaining.
+	 *
+	 * @since   1.0
+	 */
+	public function clear($clause = null)
+	{
+		switch ($clause)
+		{
+			case null:
+				$this->bounded = [];
+				break;
+		}
+
+		return parent::clear($clause);
+	}
+
+	/**
+	 * Concatenates an array of column names or values.
+	 *
+	 * Usage:
+	 * $query->select($query->concatenate(array('a', 'b')));
+	 *
+	 * @param   array   $values     An array of values to concatenate.
+	 * @param   string  $separator  As separator to place between each value.
+	 *
+	 * @return  string  The concatenated values.
+	 *
+	 * @since   1.1.0
+	 */
+	public function concatenate($values, $separator = null)
+	{
+		if ($separator)
+		{
+			return implode(' || ' . $this->quote($separator) . ' || ', $values);
+		}
+		else
+		{
+			return implode(' || ', $values);
+		}
+	}
+
+	/**
+	 * Method to modify a query already in string format with the needed
+	 * additions to make the query limited to a particular number of
+	 * results, or start at a particular offset. This method is used
+	 * automatically by the __toString() method if it detects that the
+	 * query implements the LimitableInterface.
+	 *
+	 * @param   string   $query   The query in string format
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return  string
+	 *
+	 * @since   1.0
+	 */
+	public function processLimit($query, $limit, $offset = 0)
+	{
+		if ($limit > 0 || $offset > 0)
+		{
+			$query .= ' LIMIT ' . $offset . ', ' . $limit;
+		}
+
+		return $query;
+	}
+
+	/**
+	 * Sets the offset and limit for the result set, if the database driver supports it.
+	 *
+	 * Usage:
+	 * $query->setLimit(100, 0); (retrieve 100 rows, starting at first record)
+	 * $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th record)
+	 *
+	 * @param   integer  $limit   The limit for the result set
+	 * @param   integer  $offset  The offset for the result set
+	 *
+	 * @return  Sqlite  Returns this object to allow chaining.
+	 *
+	 * @since   1.0
+	 */
+	public function setLimit($limit = 0, $offset = 0)
+	{
+		$this->limit  = (int) $limit;
+		$this->offset = (int) $offset;
+
+		return $this;
+	}
+}