From 516f7e8299c309ed909259c90c23cb0ce6a8e4f7 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 7 Jul 2015 17:30:26 +0200 Subject: Add unit tests and automatic quoting --- lib/private/appframework/db/db.php | 4 +- lib/private/db/compositeexpression.php | 92 -- lib/private/db/connection.php | 6 +- lib/private/db/expressionbuilder.php | 282 ------ lib/private/db/querybuilder.php | 865 ------------------ .../db/querybuilder/compositeexpression.php | 92 ++ lib/private/db/querybuilder/expressionbuilder.php | 312 +++++++ lib/private/db/querybuilder/literal.php | 40 + lib/private/db/querybuilder/parameter.php | 40 + lib/private/db/querybuilder/querybuilder.php | 983 +++++++++++++++++++++ lib/private/db/querybuilder/queryfunction.php | 40 + lib/private/db/querybuilder/quotehelper.php | 75 ++ lib/public/db/icompositeexpression.php | 64 -- lib/public/db/iexpressionbuilder.php | 252 ------ lib/public/db/iquerybuilder.php | 742 ---------------- .../db/querybuilder/icompositeexpression.php | 64 ++ lib/public/db/querybuilder/iexpressionbuilder.php | 252 ++++++ lib/public/db/querybuilder/iliteral.php | 29 + lib/public/db/querybuilder/iparameter.php | 29 + lib/public/db/querybuilder/iquerybuilder.php | 772 ++++++++++++++++ lib/public/db/querybuilder/iqueryfunction.php | 29 + lib/public/idbconnection.php | 4 +- .../lib/db/querybuilder/expressionbuildertest.php | 338 +++++++ tests/lib/db/querybuilder/querybuildertest.php | 941 ++++++++++++++++++++ tests/lib/db/querybuilder/quotehelpertest.php | 141 +++ tests/lib/share/share.php | 16 +- 26 files changed, 4193 insertions(+), 2311 deletions(-) delete mode 100644 lib/private/db/compositeexpression.php delete mode 100644 lib/private/db/expressionbuilder.php delete mode 100644 lib/private/db/querybuilder.php create mode 100644 lib/private/db/querybuilder/compositeexpression.php create mode 100644 lib/private/db/querybuilder/expressionbuilder.php create mode 100644 lib/private/db/querybuilder/literal.php create mode 100644 lib/private/db/querybuilder/parameter.php create mode 100644 lib/private/db/querybuilder/querybuilder.php create mode 100644 lib/private/db/querybuilder/queryfunction.php create mode 100644 lib/private/db/querybuilder/quotehelper.php delete mode 100644 lib/public/db/icompositeexpression.php delete mode 100644 lib/public/db/iexpressionbuilder.php delete mode 100644 lib/public/db/iquerybuilder.php create mode 100644 lib/public/db/querybuilder/icompositeexpression.php create mode 100644 lib/public/db/querybuilder/iexpressionbuilder.php create mode 100644 lib/public/db/querybuilder/iliteral.php create mode 100644 lib/public/db/querybuilder/iparameter.php create mode 100644 lib/public/db/querybuilder/iquerybuilder.php create mode 100644 lib/public/db/querybuilder/iqueryfunction.php create mode 100644 tests/lib/db/querybuilder/expressionbuildertest.php create mode 100644 tests/lib/db/querybuilder/querybuildertest.php create mode 100644 tests/lib/db/querybuilder/quotehelpertest.php diff --git a/lib/private/appframework/db/db.php b/lib/private/appframework/db/db.php index 529962002ac..6134d33b6c9 100644 --- a/lib/private/appframework/db/db.php +++ b/lib/private/appframework/db/db.php @@ -48,7 +48,7 @@ class Db implements IDb { /** * Gets the ExpressionBuilder for the connection. * - * @return \OCP\DB\IExpressionBuilder + * @return \OCP\DB\QueryBuilder\IExpressionBuilder */ public function getExpressionBuilder() { return $this->connection->getExpressionBuilder(); @@ -57,7 +57,7 @@ class Db implements IDb { /** * Gets the ExpressionBuilder for the connection. * - * @return \OCP\DB\IQueryBuilder + * @return \OCP\DB\QueryBuilder\IQueryBuilder */ public function getQueryBuilder() { return $this->connection->getQueryBuilder(); diff --git a/lib/private/db/compositeexpression.php b/lib/private/db/compositeexpression.php deleted file mode 100644 index cc57c524369..00000000000 --- a/lib/private/db/compositeexpression.php +++ /dev/null @@ -1,92 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OC\DB; - -use OCP\DB\ICompositeExpression; - -class CompositeExpression implements ICompositeExpression, \Countable { - /** @var \Doctrine\DBAL\Query\Expression\CompositeExpression */ - protected $compositeExpression; - - /** - * Constructor. - * - * @param \Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression - */ - public function __construct(\Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression) { - $this->compositeExpression = $compositeExpression; - } - - /** - * Adds multiple parts to composite expression. - * - * @param array $parts - * - * @return \OCP\DB\ICompositeExpression - */ - public function addMultiple(array $parts = array()) { - $this->compositeExpression->addMultiple($parts); - - return $this; - } - - /** - * Adds an expression to composite expression. - * - * @param mixed $part - * - * @return \OCP\DB\ICompositeExpression - */ - public function add($part) { - $this->compositeExpression->add($part); - - return $this; - } - - /** - * Retrieves the amount of expressions on composite expression. - * - * @return integer - */ - public function count() { - return $this->compositeExpression->count(); - } - - /** - * Returns the type of this composite expression (AND/OR). - * - * @return string - */ - public function getType() { - return $this->compositeExpression->getType(); - } - - /** - * Retrieves the string representation of this composite expression. - * - * @return string - */ - public function __toString() - { - return (string) $this->compositeExpression; - } -} diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php index 9bb54883bf4..ae5d22bf4d8 100644 --- a/lib/private/db/connection.php +++ b/lib/private/db/connection.php @@ -29,6 +29,8 @@ use Doctrine\DBAL\Driver; use Doctrine\DBAL\Configuration; use Doctrine\DBAL\Cache\QueryCacheProfile; use Doctrine\Common\EventManager; +use OC\DB\QueryBuilder\ExpressionBuilder; +use OC\DB\QueryBuilder\QueryBuilder; use OCP\IDBConnection; class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { @@ -54,7 +56,7 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { /** * Gets the ExpressionBuilder for the connection. * - * @return \OCP\DB\IExpressionBuilder + * @return \OCP\DB\QueryBuilder\IExpressionBuilder */ public function getExpressionBuilder() { return new ExpressionBuilder($this); @@ -63,7 +65,7 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { /** * Gets the QueryBuilder for the connection. * - * @return \OCP\DB\IQueryBuilder + * @return \OCP\DB\QueryBuilder\IQueryBuilder */ public function getQueryBuilder() { return new QueryBuilder($this); diff --git a/lib/private/db/expressionbuilder.php b/lib/private/db/expressionbuilder.php deleted file mode 100644 index f042664d960..00000000000 --- a/lib/private/db/expressionbuilder.php +++ /dev/null @@ -1,282 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OC\DB; - -use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder; -use OCP\DB\IExpressionBuilder; -use OCP\IDBConnection; - -class ExpressionBuilder implements IExpressionBuilder { - /** @var \Doctrine\DBAL\Query\Expression\ExpressionBuilder */ - private $expressionBuilder; - - /** - * Initializes a new ExpressionBuilder. - * - * @param \OCP\IDBConnection $connection - */ - public function __construct(IDBConnection $connection) { - $this->expressionBuilder = new DoctrineExpressionBuilder($connection); - } - - /** - * Creates a conjunction of the given boolean expressions. - * - * Example: - * - * [php] - * // (u.type = ?) AND (u.role = ?) - * $expr->andX('u.type = ?', 'u.role = ?')); - * - * @param mixed $x Optional clause. Defaults = null, but requires - * at least one defined when converting to string. - * - * @return \OCP\DB\ICompositeExpression - */ - public function andX($x = null) { - $compositeExpression = call_user_func_array([$this->expressionBuilder, 'andX'], func_get_args()); - return new CompositeExpression($compositeExpression); - } - - /** - * Creates a disjunction of the given boolean expressions. - * - * Example: - * - * [php] - * // (u.type = ?) OR (u.role = ?) - * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); - * - * @param mixed $x Optional clause. Defaults = null, but requires - * at least one defined when converting to string. - * - * @return \OCP\DB\ICompositeExpression - */ - public function orX($x = null) { - $compositeExpression = call_user_func_array([$this->expressionBuilder, 'orX'], func_get_args()); - return new CompositeExpression($compositeExpression); - } - - /** - * Creates a comparison expression. - * - * @param mixed $x The left expression. - * @param string $operator One of the ExpressionBuilder::* constants. - * @param mixed $y The right expression. - * - * @return string - */ - public function comparison($x, $operator, $y) { - return $this->expressionBuilder->comparison($x, $operator, $y); - } - - /** - * Creates an equality comparison expression with the given arguments. - * - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a = . Example: - * - * [php] - * // u.id = ? - * $expr->eq('u.id', '?'); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function eq($x, $y) { - return $this->expressionBuilder->eq($x, $y); - } - - /** - * Creates a non equality comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a <> . Example: - * - * [php] - * // u.id <> 1 - * $q->where($q->expr()->neq('u.id', '1')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function neq($x, $y) { - return $this->expressionBuilder->neq($x, $y); - } - - /** - * Creates a lower-than comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a < . Example: - * - * [php] - * // u.id < ? - * $q->where($q->expr()->lt('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function lt($x, $y) { - return $this->expressionBuilder->lt($x, $y); - } - - /** - * Creates a lower-than-equal comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a <= . Example: - * - * [php] - * // u.id <= ? - * $q->where($q->expr()->lte('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function lte($x, $y) { - return $this->expressionBuilder->lte($x, $y); - } - - /** - * Creates a greater-than comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a > . Example: - * - * [php] - * // u.id > ? - * $q->where($q->expr()->gt('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function gt($x, $y) { - return $this->expressionBuilder->gt($x, $y); - } - - /** - * Creates a greater-than-equal comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a >= . Example: - * - * [php] - * // u.id >= ? - * $q->where($q->expr()->gte('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - */ - public function gte($x, $y) { - return $this->expressionBuilder->gte($x, $y); - } - - /** - * Creates an IS NULL expression with the given arguments. - * - * @param string $x The field in string format to be restricted by IS NULL. - * - * @return string - */ - public function isNull($x) { - return $this->expressionBuilder->isNull($x); - } - - /** - * Creates an IS NOT NULL expression with the given arguments. - * - * @param string $x The field in string format to be restricted by IS NOT NULL. - * - * @return string - */ - public function isNotNull($x) { - return $this->expressionBuilder->isNotNull($x); - } - - /** - * Creates a LIKE() comparison expression with the given arguments. - * - * @param string $x Field in string format to be inspected by LIKE() comparison. - * @param mixed $y Argument to be used in LIKE() comparison. - * - * @return string - */ - public function like($x, $y) { - return $this->expressionBuilder->like($x, $y); - } - - /** - * Creates a NOT LIKE() comparison expression with the given arguments. - * - * @param string $x Field in string format to be inspected by NOT LIKE() comparison. - * @param mixed $y Argument to be used in NOT LIKE() comparison. - * - * @return string - */ - public function notLike($x, $y) { - return $this->expressionBuilder->notLike($x, $y); - } - - /** - * Creates a IN () comparison expression with the given arguments. - * - * @param string $x The field in string format to be inspected by IN() comparison. - * @param string|array $y The placeholder or the array of values to be used by IN() comparison. - * - * @return string - */ - public function in($x, $y) { - return $this->expressionBuilder->in($x, $y); - } - - /** - * Creates a NOT IN () comparison expression with the given arguments. - * - * @param string $x The field in string format to be inspected by NOT IN() comparison. - * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. - * - * @return string - */ - public function notIn($x, $y) { - return $this->expressionBuilder->notIn($x, $y); - } - - /** - * Quotes a given input parameter. - * - * @param mixed $input The parameter to be quoted. - * @param string|null $type The type of the parameter. - * - * @return string - */ - public function literal($input, $type = null) { - return $this->expressionBuilder->literal($input, $type); - } -} diff --git a/lib/private/db/querybuilder.php b/lib/private/db/querybuilder.php deleted file mode 100644 index 9ae07aeb0fd..00000000000 --- a/lib/private/db/querybuilder.php +++ /dev/null @@ -1,865 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OC\DB; - -use OCP\DB\IQueryBuilder; -use OCP\IDBConnection; - -class QueryBuilder implements IQueryBuilder { - - /** @var \OCP\IDBConnection */ - private $connection; - - /** @var \Doctrine\DBAL\Query\QueryBuilder */ - private $queryBuilder; - - /** - * Initializes a new QueryBuilder. - * - * @var \OCP\IDBConnection - */ - public function __construct(IDBConnection $connection) - { - $this->connection = $connection; - $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection); - } - - /** - * Gets an ExpressionBuilder used for object-oriented construction of query expressions. - * This producer method is intended for convenient inline usage. Example: - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where($qb->expr()->eq('u.id', 1)); - * - * - * For more complex expression construction, consider storing the expression - * builder object in a local variable. - * - * @return \OCP\DB\IExpressionBuilder - */ - public function expr() { - return $this->connection->getExpressionBuilder(); - } - - /** - * Gets the type of the currently built query. - * - * @return integer - */ - public function getType() { - return $this->queryBuilder->getType(); - } - - /** - * Gets the associated DBAL Connection for this query builder. - * - * @return \OCP\IDBConnection - */ - public function getConnection() { - return $this->connection; - } - - /** - * Gets the state of this query builder instance. - * - * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. - */ - public function getState() { - return $this->queryBuilder->getState(); - } - - /** - * Executes this query using the bound parameters and their types. - * - * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate} - * for insert, update and delete statements. - * - * @return \Doctrine\DBAL\Driver\Statement|int - */ - public function execute() { - return $this->queryBuilder->execute(); - } - - /** - * Gets the complete SQL string formed by the current specifications of this QueryBuilder. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('User', 'u') - * echo $qb->getSQL(); // SELECT u FROM User u - * - * - * @return string The SQL query string. - */ - public function getSQL() { - return $this->queryBuilder->getSQL(); - } - - /** - * Sets a query parameter for the query being constructed. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.id = :user_id') - * ->setParameter(':user_id', 1); - * - * - * @param string|integer $key The parameter position or name. - * @param mixed $value The parameter value. - * @param string|null $type One of the PDO::PARAM_* constants. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function setParameter($key, $value, $type = null) { - $this->queryBuilder->setParameter($key, $value, $type); - - return $this; - } - - /** - * Sets a collection of query parameters for the query being constructed. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.id = :user_id1 OR u.id = :user_id2') - * ->setParameters(array( - * ':user_id1' => 1, - * ':user_id2' => 2 - * )); - * - * - * @param array $params The query parameters to set. - * @param array $types The query parameters types to set. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function setParameters(array $params, array $types = array()) { - $this->queryBuilder->setParameters($params, $types); - - return $this; - } - - /** - * Gets all defined query parameters for the query being constructed indexed by parameter index or name. - * - * @return array The currently defined query parameters indexed by parameter index or name. - */ - public function getParameters() { - return $this->queryBuilder->getParameters(); - } - - /** - * Gets a (previously set) query parameter of the query being constructed. - * - * @param mixed $key The key (index or name) of the bound parameter. - * - * @return mixed The value of the bound parameter. - */ - public function getParameter($key) { - return $this->queryBuilder->getParameter($key); - } - - /** - * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. - * - * @return array The currently defined query parameter types indexed by parameter index or name. - */ - public function getParameterTypes() { - return $this->queryBuilder->getParameterTypes(); - } - - /** - * Gets a (previously set) query parameter type of the query being constructed. - * - * @param mixed $key The key (index or name) of the bound parameter type. - * - * @return mixed The value of the bound parameter type. - */ - public function getParameterType($key) { - return $this->queryBuilder->getParameterType($key); - } - - /** - * Sets the position of the first result to retrieve (the "offset"). - * - * @param integer $firstResult The first result to return. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function setFirstResult($firstResult) { - $this->queryBuilder->setFirstResult($firstResult); - - return $this; - } - - /** - * Gets the position of the first result the query object was set to retrieve (the "offset"). - * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder. - * - * @return integer The position of the first result. - */ - public function getFirstResult() { - return $this->queryBuilder->getFirstResult(); - } - - /** - * Sets the maximum number of results to retrieve (the "limit"). - * - * @param integer $maxResults The maximum number of results to retrieve. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function setMaxResults($maxResults) { - $this->queryBuilder->setMaxResults($maxResults); - - return $this; - } - - /** - * Gets the maximum number of results the query object was set to retrieve (the "limit"). - * Returns NULL if {@link setMaxResults} was not applied to this query builder. - * - * @return integer The maximum number of results. - */ - public function getMaxResults() { - return $this->queryBuilder->getMaxResults(); - } - - /** - * Either appends to or replaces a single, generic query part. - * - * The available parts are: 'select', 'from', 'set', 'where', - * 'groupBy', 'having' and 'orderBy'. - * - * @param string $sqlPartName - * @param string $sqlPart - * @param boolean $append - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function add($sqlPartName, $sqlPart, $append = false) { - $this->queryBuilder->add($sqlPartName, $sqlPart, $append); - - return $this; - } - - /** - * Specifies an item that is to be returned in the query result. - * Replaces any previously specified selections, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id', 'p.id') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); - * - * - * @param mixed $select The selection expressions. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function select($select = null) { - $this->queryBuilder->select($select); - - return $this; - } - - /** - * Adds an item that is to be returned in the query result. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id') - * ->addSelect('p.id') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); - * - * - * @param mixed $select The selection expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function addSelect($select = null) { - $this->queryBuilder->addSelect($select); - - return $this; - } - - /** - * Turns the query being built into a bulk delete query that ranges over - * a certain table. - * - * - * $qb = $conn->getQueryBuilder() - * ->delete('users', 'u') - * ->where('u.id = :user_id'); - * ->setParameter(':user_id', 1); - * - * - * @param string $delete The table whose rows are subject to the deletion. - * @param string $alias The table alias used in the constructed query. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function delete($delete = null, $alias = null) { - $this->queryBuilder->delete($delete, $alias); - - return $this; - } - - /** - * Turns the query being built into a bulk update query that ranges over - * a certain table - * - * - * $qb = $conn->getQueryBuilder() - * ->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where('u.id = ?'); - * - * - * @param string $update The table whose rows are subject to the update. - * @param string $alias The table alias used in the constructed query. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function update($update = null, $alias = null) { - $this->queryBuilder->update($update, $alias); - - return $this; - } - - /** - * Turns the query being built into an insert query that inserts into - * a certain table - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?', - * 'password' => '?' - * ) - * ); - * - * - * @param string $insert The table into which the rows should be inserted. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function insert($insert = null) { - $this->queryBuilder->insert($insert); - - return $this; - } - - /** - * Creates and adds a query root corresponding to the table identified by the - * given alias, forming a cartesian product with any existing query roots. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id') - * ->from('users', 'u') - * - * - * @param string $from The table. - * @param string|null $alias The alias of the table. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function from($from, $alias = null) { - $this->queryBuilder->from($from, $alias); - - return $this; - } - - /** - * Creates and adds a join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function join($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->join($fromAlias, $join, $alias, $condition); - - return $this; - } - - /** - * Creates and adds a join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function innerJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->innerJoin($fromAlias, $join, $alias, $condition); - - return $this; - } - - /** - * Creates and adds a left join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function leftJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->leftJoin($fromAlias, $join, $alias, $condition); - - return $this; - } - - /** - * Creates and adds a right join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function rightJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->rightJoin($fromAlias, $join, $alias, $condition); - - return $this; - } - - /** - * Sets a new value for a column in a bulk update query. - * - * - * $qb = $conn->getQueryBuilder() - * ->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where('u.id = ?'); - * - * - * @param string $key The column to set. - * @param string $value The value, expression, placeholder, etc. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function set($key, $value) { - $this->queryBuilder->set($key, $value); - - return $this; - } - - /** - * Specifies one or more restrictions to the query result. - * Replaces any previously specified restrictions, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->where('u.id = ?'); - * - * // You can optionally programatically build and/or expressions - * $qb = $conn->getQueryBuilder(); - * - * $or = $qb->expr()->orx(); - * $or->add($qb->expr()->eq('u.id', 1)); - * $or->add($qb->expr()->eq('u.id', 2)); - * - * $qb->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where($or); - * - * - * @param mixed $predicates The restriction predicates. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function where($predicates) { - call_user_func_array([$this->queryBuilder, 'where'], func_get_args()); - - return $this; - } - - /** - * Adds one or more restrictions to the query results, forming a logical - * conjunction with any previously specified restrictions. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.username LIKE ?') - * ->andWhere('u.is_active = 1'); - * - * - * @param mixed $where The query restrictions. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * - * @see where() - */ - public function andWhere($where) { - call_user_func_array([$this->queryBuilder, 'andWhere'], func_get_args()); - - return $this; - } - - /** - * Adds one or more restrictions to the query results, forming a logical - * disjunction with any previously specified restrictions. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->where('u.id = 1') - * ->orWhere('u.id = 2'); - * - * - * @param mixed $where The WHERE statement. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * - * @see where() - */ - public function orWhere($where) { - call_user_func_array([$this->queryBuilder, 'orWhere'], func_get_args()); - - return $this; - } - - /** - * Specifies a grouping over the results of the query. - * Replaces any previously specified groupings, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->groupBy('u.id'); - * - * - * @param mixed $groupBy The grouping expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function groupBy($groupBy) { - call_user_func_array([$this->queryBuilder, 'groupBy'], func_get_args()); - - return $this; - } - - /** - * Adds a grouping expression to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->groupBy('u.lastLogin'); - * ->addGroupBy('u.createdAt') - * - * - * @param mixed $groupBy The grouping expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function addGroupBy($groupBy) { - call_user_func_array([$this->queryBuilder, 'addGroupBy'], func_get_args()); - - return $this; - } - - /** - * Sets a value for a column in an insert query. - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?' - * ) - * ) - * ->setValue('password', '?'); - * - * - * @param string $column The column into which the value should be inserted. - * @param string $value The value that should be inserted into the column. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function setValue($column, $value) { - $this->queryBuilder->setValue($column, $value); - - return $this; - } - - /** - * Specifies values for an insert query indexed by column names. - * Replaces any previous values, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?', - * 'password' => '?' - * ) - * ); - * - * - * @param array $values The values to specify for the insert query indexed by column names. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function values(array $values) { - $this->queryBuilder->values($values); - - return $this; - } - - /** - * Specifies a restriction over the groups of the query. - * Replaces any previous having restrictions, if any. - * - * @param mixed $having The restriction over the groups. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function having($having) { - call_user_func_array([$this->queryBuilder, 'having'], func_get_args()); - - return $this; - } - - /** - * Adds a restriction over the groups of the query, forming a logical - * conjunction with any existing having restrictions. - * - * @param mixed $having The restriction to append. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function andHaving($having) { - call_user_func_array([$this->queryBuilder, 'andHaving'], func_get_args()); - - return $this; - } - - /** - * Adds a restriction over the groups of the query, forming a logical - * disjunction with any existing having restrictions. - * - * @param mixed $having The restriction to add. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function orHaving($having) { - call_user_func_array([$this->queryBuilder, 'orHaving'], func_get_args()); - - return $this; - } - - /** - * Specifies an ordering for the query results. - * Replaces any previously specified orderings, if any. - * - * @param string $sort The ordering expression. - * @param string $order The ordering direction. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function orderBy($sort, $order = null) { - $this->queryBuilder->orderBy($sort, $order); - - return $this; - } - - /** - * Adds an ordering to the query results. - * - * @param string $sort The ordering expression. - * @param string $order The ordering direction. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function addOrderBy($sort, $order = null) { - $this->queryBuilder->addOrderBy($sort, $order); - - return $this; - } - - /** - * Gets a query part by its name. - * - * @param string $queryPartName - * - * @return mixed - */ - public function getQueryPart($queryPartName) { - return $this->queryBuilder->getQueryPart($queryPartName); - } - - /** - * Gets all query parts. - * - * @return array - */ - public function getQueryParts() { - return $this->queryBuilder->getQueryParts(); - } - - /** - * Resets SQL parts. - * - * @param array|null $queryPartNames - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function resetQueryParts($queryPartNames = null) { - $this->queryBuilder->resetQueryParts($queryPartNames); - - return $this; - } - - /** - * Resets a single SQL part. - * - * @param string $queryPartName - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - */ - public function resetQueryPart($queryPartName) { - $this->queryBuilder->resetQueryPart($queryPartName); - - return $this; - } - - /** - * Creates a new named parameter and bind the value $value to it. - * - * This method provides a shortcut for PDOStatement::bindValue - * when using prepared statements. - * - * The parameter $value specifies the value that you want to bind. If - * $placeholder is not provided bindValue() will automatically create a - * placeholder for you. An automatic placeholder will be of the name - * ':dcValue1', ':dcValue2' etc. - * - * For more information see {@link http://php.net/pdostatement-bindparam} - * - * Example: - * - * $value = 2; - * $q->eq( 'id', $q->bindValue( $value ) ); - * $stmt = $q->executeQuery(); // executed with 'id = 2' - * - * - * @license New BSD License - * @link http://www.zetacomponents.org - * - * @param mixed $value - * @param mixed $type - * @param string $placeHolder The name to bind with. The string must start with a colon ':'. - * - * @return string the placeholder name used. - */ - public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null) { - return $this->queryBuilder->createNamedParameter($value, $type, $placeHolder); - } - - /** - * Creates a new positional parameter and bind the given value to it. - * - * Attention: If you are using positional parameters with the query builder you have - * to be very careful to bind all parameters in the order they appear in the SQL - * statement , otherwise they get bound in the wrong order which can lead to serious - * bugs in your code. - * - * Example: - * - * $qb = $conn->getQueryBuilder(); - * $qb->select('u.*') - * ->from('users', 'u') - * ->where('u.username = ' . $qb->createPositionalParameter('Foo', PDO::PARAM_STR)) - * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR)) - * - * - * @param mixed $value - * @param integer $type - * - * @return string - */ - public function createPositionalParameter($value, $type = \PDO::PARAM_STR) { - return $this->queryBuilder->createPositionalParameter($value, $type); - } -} diff --git a/lib/private/db/querybuilder/compositeexpression.php b/lib/private/db/querybuilder/compositeexpression.php new file mode 100644 index 00000000000..523f397e235 --- /dev/null +++ b/lib/private/db/querybuilder/compositeexpression.php @@ -0,0 +1,92 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\ICompositeExpression; + +class CompositeExpression implements ICompositeExpression, \Countable { + /** @var \Doctrine\DBAL\Query\Expression\CompositeExpression */ + protected $compositeExpression; + + /** + * Constructor. + * + * @param \Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression + */ + public function __construct(\Doctrine\DBAL\Query\Expression\CompositeExpression $compositeExpression) { + $this->compositeExpression = $compositeExpression; + } + + /** + * Adds multiple parts to composite expression. + * + * @param array $parts + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + */ + public function addMultiple(array $parts = array()) { + $this->compositeExpression->addMultiple($parts); + + return $this; + } + + /** + * Adds an expression to composite expression. + * + * @param mixed $part + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + */ + public function add($part) { + $this->compositeExpression->add($part); + + return $this; + } + + /** + * Retrieves the amount of expressions on composite expression. + * + * @return integer + */ + public function count() { + return $this->compositeExpression->count(); + } + + /** + * Returns the type of this composite expression (AND/OR). + * + * @return string + */ + public function getType() { + return $this->compositeExpression->getType(); + } + + /** + * Retrieves the string representation of this composite expression. + * + * @return string + */ + public function __toString() + { + return (string) $this->compositeExpression; + } +} diff --git a/lib/private/db/querybuilder/expressionbuilder.php b/lib/private/db/querybuilder/expressionbuilder.php new file mode 100644 index 00000000000..cd5b7fbfc54 --- /dev/null +++ b/lib/private/db/querybuilder/expressionbuilder.php @@ -0,0 +1,312 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder; +use OCP\DB\QueryBuilder\IExpressionBuilder; +use OCP\IDBConnection; + +class ExpressionBuilder implements IExpressionBuilder { + /** @var \Doctrine\DBAL\Query\Expression\ExpressionBuilder */ + private $expressionBuilder; + + /** @var QuoteHelper */ + private $helper; + + /** + * Initializes a new ExpressionBuilder. + * + * @param \OCP\IDBConnection $connection + */ + public function __construct(IDBConnection $connection) { + $this->helper = new QuoteHelper(); + $this->expressionBuilder = new DoctrineExpressionBuilder($connection); + } + + /** + * Creates a conjunction of the given boolean expressions. + * + * Example: + * + * [php] + * // (u.type = ?) AND (u.role = ?) + * $expr->andX('u.type = ?', 'u.role = ?')); + * + * @param mixed $x Optional clause. Defaults = null, but requires + * at least one defined when converting to string. + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + */ + public function andX($x = null) { + $arguments = func_get_args(); + $compositeExpression = call_user_func_array([$this->expressionBuilder, 'andX'], $arguments); + return new CompositeExpression($compositeExpression); + } + + /** + * Creates a disjunction of the given boolean expressions. + * + * Example: + * + * [php] + * // (u.type = ?) OR (u.role = ?) + * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); + * + * @param mixed $x Optional clause. Defaults = null, but requires + * at least one defined when converting to string. + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + */ + public function orX($x = null) { + $arguments = func_get_args(); + $compositeExpression = call_user_func_array([$this->expressionBuilder, 'orX'], $arguments); + return new CompositeExpression($compositeExpression); + } + + /** + * Creates a comparison expression. + * + * @param mixed $x The left expression. + * @param string $operator One of the ExpressionBuilder::* constants. + * @param mixed $y The right expression. + * + * @return string + */ + public function comparison($x, $operator, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->comparison($x, $operator, $y); + } + + /** + * Creates an equality comparison expression with the given arguments. + * + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a = . Example: + * + * [php] + * // u.id = ? + * $expr->eq('u.id', '?'); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function eq($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->eq($x, $y); + } + + /** + * Creates a non equality comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a <> . Example: + * + * [php] + * // u.id <> 1 + * $q->where($q->expr()->neq('u.id', '1')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function neq($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->neq($x, $y); + } + + /** + * Creates a lower-than comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a < . Example: + * + * [php] + * // u.id < ? + * $q->where($q->expr()->lt('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function lt($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->lt($x, $y); + } + + /** + * Creates a lower-than-equal comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a <= . Example: + * + * [php] + * // u.id <= ? + * $q->where($q->expr()->lte('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function lte($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->lte($x, $y); + } + + /** + * Creates a greater-than comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a > . Example: + * + * [php] + * // u.id > ? + * $q->where($q->expr()->gt('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function gt($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->gt($x, $y); + } + + /** + * Creates a greater-than-equal comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a >= . Example: + * + * [php] + * // u.id >= ? + * $q->where($q->expr()->gte('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + */ + public function gte($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->gte($x, $y); + } + + /** + * Creates an IS NULL expression with the given arguments. + * + * @param string $x The field in string format to be restricted by IS NULL. + * + * @return string + */ + public function isNull($x) { + $x = $this->helper->quoteColumnName($x); + return $this->expressionBuilder->isNull($x); + } + + /** + * Creates an IS NOT NULL expression with the given arguments. + * + * @param string $x The field in string format to be restricted by IS NOT NULL. + * + * @return string + */ + public function isNotNull($x) { + $x = $this->helper->quoteColumnName($x); + return $this->expressionBuilder->isNotNull($x); + } + + /** + * Creates a LIKE() comparison expression with the given arguments. + * + * @param string $x Field in string format to be inspected by LIKE() comparison. + * @param mixed $y Argument to be used in LIKE() comparison. + * + * @return string + */ + public function like($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->like($x, $y); + } + + /** + * Creates a NOT LIKE() comparison expression with the given arguments. + * + * @param string $x Field in string format to be inspected by NOT LIKE() comparison. + * @param mixed $y Argument to be used in NOT LIKE() comparison. + * + * @return string + */ + public function notLike($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); + return $this->expressionBuilder->notLike($x, $y); + } + + /** + * Creates a IN () comparison expression with the given arguments. + * + * @param string $x The field in string format to be inspected by IN() comparison. + * @param string|array $y The placeholder or the array of values to be used by IN() comparison. + * + * @return string + */ + public function in($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnNames($y); + return $this->expressionBuilder->in($x, $y); + } + + /** + * Creates a NOT IN () comparison expression with the given arguments. + * + * @param string $x The field in string format to be inspected by NOT IN() comparison. + * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. + * + * @return string + */ + public function notIn($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnNames($y); + return $this->expressionBuilder->notIn($x, $y); + } + + /** + * Quotes a given input parameter. + * + * @param mixed $input The parameter to be quoted. + * @param string|null $type The type of the parameter. + * + * @return Literal + */ + public function literal($input, $type = null) { + return new Literal($this->expressionBuilder->literal($input, $type)); + } +} diff --git a/lib/private/db/querybuilder/literal.php b/lib/private/db/querybuilder/literal.php new file mode 100644 index 00000000000..361b5ccf3b8 --- /dev/null +++ b/lib/private/db/querybuilder/literal.php @@ -0,0 +1,40 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\ILiteral; + +class Literal implements ILiteral{ + /** @var mixed */ + protected $literal; + + public function __construct($literal) { + $this->literal = $literal; + } + + /** + * @return string + */ + public function __toString() { + return (string) $this->literal; + } +} diff --git a/lib/private/db/querybuilder/parameter.php b/lib/private/db/querybuilder/parameter.php new file mode 100644 index 00000000000..c14b4e21925 --- /dev/null +++ b/lib/private/db/querybuilder/parameter.php @@ -0,0 +1,40 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\IParameter; + +class Parameter implements IParameter { + /** @var mixed */ + protected $name; + + public function __construct($name) { + $this->name = $name; + } + + /** + * @return string + */ + public function __toString() { + return (string) $this->name; + } +} diff --git a/lib/private/db/querybuilder/querybuilder.php b/lib/private/db/querybuilder/querybuilder.php new file mode 100644 index 00000000000..fbb2b07bade --- /dev/null +++ b/lib/private/db/querybuilder/querybuilder.php @@ -0,0 +1,983 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\IQueryBuilder; +use OCP\DB\QueryBuilder\IQueryFunction; +use OCP\DB\QueryBuilder\IParameter; +use OCP\IDBConnection; + +class QueryBuilder implements IQueryBuilder { + + /** @var \OCP\IDBConnection */ + private $connection; + + /** @var \Doctrine\DBAL\Query\QueryBuilder */ + private $queryBuilder; + + /** @var QuoteHelper */ + private $helper; + + /** + * Initializes a new QueryBuilder. + * + * @var \OCP\IDBConnection + */ + public function __construct(IDBConnection $connection) { + $this->connection = $connection; + $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection); + $this->helper = new QuoteHelper(); + } + + /** + * Gets an ExpressionBuilder used for object-oriented construction of query expressions. + * This producer method is intended for convenient inline usage. Example: + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where($qb->expr()->eq('u.id', 1)); + * + * + * For more complex expression construction, consider storing the expression + * builder object in a local variable. + * + * @return \OCP\DB\QueryBuilder\IExpressionBuilder + */ + public function expr() { + return $this->connection->getExpressionBuilder(); + } + + /** + * Gets the type of the currently built query. + * + * @return integer + */ + public function getType() { + return $this->queryBuilder->getType(); + } + + /** + * Gets the associated DBAL Connection for this query builder. + * + * @return \OCP\IDBConnection + */ + public function getConnection() { + return $this->connection; + } + + /** + * Gets the state of this query builder instance. + * + * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. + */ + public function getState() { + return $this->queryBuilder->getState(); + } + + /** + * Executes this query using the bound parameters and their types. + * + * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate} + * for insert, update and delete statements. + * + * @return \Doctrine\DBAL\Driver\Statement|int + */ + public function execute() { + return $this->queryBuilder->execute(); + } + + /** + * Gets the complete SQL string formed by the current specifications of this QueryBuilder. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('User', 'u') + * echo $qb->getSQL(); // SELECT u FROM User u + * + * + * @return string The SQL query string. + */ + public function getSQL() { + return $this->queryBuilder->getSQL(); + } + + /** + * Sets a query parameter for the query being constructed. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.id = :user_id') + * ->setParameter(':user_id', 1); + * + * + * @param string|integer $key The parameter position or name. + * @param mixed $value The parameter value. + * @param string|null $type One of the PDO::PARAM_* constants. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function setParameter($key, $value, $type = null) { + $this->queryBuilder->setParameter($key, $value, $type); + + return $this; + } + + /** + * Sets a collection of query parameters for the query being constructed. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.id = :user_id1 OR u.id = :user_id2') + * ->setParameters(array( + * ':user_id1' => 1, + * ':user_id2' => 2 + * )); + * + * + * @param array $params The query parameters to set. + * @param array $types The query parameters types to set. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function setParameters(array $params, array $types = array()) { + $this->queryBuilder->setParameters($params, $types); + + return $this; + } + + /** + * Gets all defined query parameters for the query being constructed indexed by parameter index or name. + * + * @return array The currently defined query parameters indexed by parameter index or name. + */ + public function getParameters() { + return $this->queryBuilder->getParameters(); + } + + /** + * Gets a (previously set) query parameter of the query being constructed. + * + * @param mixed $key The key (index or name) of the bound parameter. + * + * @return mixed The value of the bound parameter. + */ + public function getParameter($key) { + return $this->queryBuilder->getParameter($key); + } + + /** + * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. + * + * @return array The currently defined query parameter types indexed by parameter index or name. + */ + public function getParameterTypes() { + return $this->queryBuilder->getParameterTypes(); + } + + /** + * Gets a (previously set) query parameter type of the query being constructed. + * + * @param mixed $key The key (index or name) of the bound parameter type. + * + * @return mixed The value of the bound parameter type. + */ + public function getParameterType($key) { + return $this->queryBuilder->getParameterType($key); + } + + /** + * Sets the position of the first result to retrieve (the "offset"). + * + * @param integer $firstResult The first result to return. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function setFirstResult($firstResult) { + $this->queryBuilder->setFirstResult($firstResult); + + return $this; + } + + /** + * Gets the position of the first result the query object was set to retrieve (the "offset"). + * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder. + * + * @return integer The position of the first result. + */ + public function getFirstResult() { + return $this->queryBuilder->getFirstResult(); + } + + /** + * Sets the maximum number of results to retrieve (the "limit"). + * + * @param integer $maxResults The maximum number of results to retrieve. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function setMaxResults($maxResults) { + $this->queryBuilder->setMaxResults($maxResults); + + return $this; + } + + /** + * Gets the maximum number of results the query object was set to retrieve (the "limit"). + * Returns NULL if {@link setMaxResults} was not applied to this query builder. + * + * @return integer The maximum number of results. + */ + public function getMaxResults() { + return $this->queryBuilder->getMaxResults(); + } + + /** + * Specifies an item that is to be returned in the query result. + * Replaces any previously specified selections, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id', 'p.id') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); + * + * + * @param mixed $select The selection expressions. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function select($select = null) { + $selects = is_array($select) ? $select : func_get_args(); + + $this->queryBuilder->select( + $this->helper->quoteColumnNames($selects) + ); + + return $this; + } + + /** + * Adds an item that is to be returned in the query result. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id') + * ->addSelect('p.id') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); + * + * + * @param mixed $select The selection expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function addSelect($select = null) { + $selects = is_array($select) ? $select : func_get_args(); + + $this->queryBuilder->addSelect( + $this->helper->quoteColumnNames($selects) + ); + + return $this; + } + + /** + * Turns the query being built into a bulk delete query that ranges over + * a certain table. + * + * + * $qb = $conn->getQueryBuilder() + * ->delete('users', 'u') + * ->where('u.id = :user_id'); + * ->setParameter(':user_id', 1); + * + * + * @param string $delete The table whose rows are subject to the deletion. + * @param string $alias The table alias used in the constructed query. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function delete($delete = null, $alias = null) { + $this->queryBuilder->delete( + $this->helper->quoteColumnName($delete), + $alias + ); + + return $this; + } + + /** + * Turns the query being built into a bulk update query that ranges over + * a certain table + * + * + * $qb = $conn->getQueryBuilder() + * ->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where('u.id = ?'); + * + * + * @param string $update The table whose rows are subject to the update. + * @param string $alias The table alias used in the constructed query. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function update($update = null, $alias = null) { + $this->queryBuilder->update( + $this->helper->quoteColumnName($update), + $alias + ); + + return $this; + } + + /** + * Turns the query being built into an insert query that inserts into + * a certain table + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?', + * 'password' => '?' + * ) + * ); + * + * + * @param string $insert The table into which the rows should be inserted. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function insert($insert = null) { + $this->queryBuilder->insert( + $this->helper->quoteColumnName($insert) + ); + + return $this; + } + + /** + * Creates and adds a query root corresponding to the table identified by the + * given alias, forming a cartesian product with any existing query roots. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id') + * ->from('users', 'u') + * + * + * @param string $from The table. + * @param string|null $alias The alias of the table. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function from($from, $alias = null) { + $this->queryBuilder->from( + $this->helper->quoteColumnName($from), + $alias + ); + + return $this; + } + + /** + * Creates and adds a join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function join($fromAlias, $join, $alias, $condition = null) { + $this->queryBuilder->join( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); + + return $this; + } + + /** + * Creates and adds a join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function innerJoin($fromAlias, $join, $alias, $condition = null) { + $this->queryBuilder->innerJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); + + return $this; + } + + /** + * Creates and adds a left join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function leftJoin($fromAlias, $join, $alias, $condition = null) { + $this->queryBuilder->leftJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); + + return $this; + } + + /** + * Creates and adds a right join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function rightJoin($fromAlias, $join, $alias, $condition = null) { + $this->queryBuilder->rightJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); + + return $this; + } + + /** + * Sets a new value for a column in a bulk update query. + * + * + * $qb = $conn->getQueryBuilder() + * ->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where('u.id = ?'); + * + * + * @param string $key The column to set. + * @param string $value The value, expression, placeholder, etc. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function set($key, $value) { + $this->queryBuilder->set( + $this->helper->quoteColumnName($key), + $this->helper->quoteColumnName($value) + ); + + return $this; + } + + /** + * Specifies one or more restrictions to the query result. + * Replaces any previously specified restrictions, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->where('u.id = ?'); + * + * // You can optionally programatically build and/or expressions + * $qb = $conn->getQueryBuilder(); + * + * $or = $qb->expr()->orx(); + * $or->add($qb->expr()->eq('u.id', 1)); + * $or->add($qb->expr()->eq('u.id', 2)); + * + * $qb->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where($or); + * + * + * @param mixed $predicates The restriction predicates. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function where($predicates) { + call_user_func_array( + [$this->queryBuilder, 'where'], + func_get_args() + ); + + return $this; + } + + /** + * Adds one or more restrictions to the query results, forming a logical + * conjunction with any previously specified restrictions. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.username LIKE ?') + * ->andWhere('u.is_active = 1'); + * + * + * @param mixed $where The query restrictions. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * + * @see where() + */ + public function andWhere($where) { + call_user_func_array( + [$this->queryBuilder, 'andWhere'], + func_get_args() + ); + + return $this; + } + + /** + * Adds one or more restrictions to the query results, forming a logical + * disjunction with any previously specified restrictions. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->where('u.id = 1') + * ->orWhere('u.id = 2'); + * + * + * @param mixed $where The WHERE statement. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * + * @see where() + */ + public function orWhere($where) { + call_user_func_array( + [$this->queryBuilder, 'orWhere'], + func_get_args() + ); + + return $this; + } + + /** + * Specifies a grouping over the results of the query. + * Replaces any previously specified groupings, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->groupBy('u.id'); + * + * + * @param mixed $groupBy The grouping expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function groupBy($groupBy) { + $groupBys = is_array($groupBy) ? $groupBy : func_get_args(); + + call_user_func_array( + [$this->queryBuilder, 'groupBy'], + $this->helper->quoteColumnNames($groupBys) + ); + + return $this; + } + + /** + * Adds a grouping expression to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->groupBy('u.lastLogin'); + * ->addGroupBy('u.createdAt') + * + * + * @param mixed $groupBy The grouping expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function addGroupBy($groupBy) { + $groupBys = is_array($groupBy) ? $groupBy : func_get_args(); + + call_user_func_array( + [$this->queryBuilder, 'addGroupBy'], + $this->helper->quoteColumnNames($groupBys) + ); + + return $this; + } + + /** + * Sets a value for a column in an insert query. + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?' + * ) + * ) + * ->setValue('password', '?'); + * + * + * @param string $column The column into which the value should be inserted. + * @param string $value The value that should be inserted into the column. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function setValue($column, $value) { + $this->queryBuilder->setValue( + $this->helper->quoteColumnName($column), + $value + ); + + return $this; + } + + /** + * Specifies values for an insert query indexed by column names. + * Replaces any previous values, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?', + * 'password' => '?' + * ) + * ); + * + * + * @param array $values The values to specify for the insert query indexed by column names. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function values(array $values) { + $quotedValues = []; + foreach ($values as $key => $value) { + $quotedValues[$this->helper->quoteColumnName($key)] = $value; + } + + $this->queryBuilder->values($quotedValues); + + return $this; + } + + /** + * Specifies a restriction over the groups of the query. + * Replaces any previous having restrictions, if any. + * + * @param mixed $having The restriction over the groups. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function having($having) { + call_user_func_array( + [$this->queryBuilder, 'having'], + func_get_args() + ); + + return $this; + } + + /** + * Adds a restriction over the groups of the query, forming a logical + * conjunction with any existing having restrictions. + * + * @param mixed $having The restriction to append. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function andHaving($having) { + call_user_func_array( + [$this->queryBuilder, 'andHaving'], + func_get_args() + ); + + return $this; + } + + /** + * Adds a restriction over the groups of the query, forming a logical + * disjunction with any existing having restrictions. + * + * @param mixed $having The restriction to add. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function orHaving($having) { + call_user_func_array( + [$this->queryBuilder, 'orHaving'], + func_get_args() + ); + + return $this; + } + + /** + * Specifies an ordering for the query results. + * Replaces any previously specified orderings, if any. + * + * @param string $sort The ordering expression. + * @param string $order The ordering direction. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function orderBy($sort, $order = null) { + $this->queryBuilder->orderBy( + $this->helper->quoteColumnName($sort), + $order + ); + + return $this; + } + + /** + * Adds an ordering to the query results. + * + * @param string $sort The ordering expression. + * @param string $order The ordering direction. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function addOrderBy($sort, $order = null) { + $this->queryBuilder->addOrderBy( + $this->helper->quoteColumnName($sort), + $order + ); + + return $this; + } + + /** + * Gets a query part by its name. + * + * @param string $queryPartName + * + * @return mixed + */ + public function getQueryPart($queryPartName) { + return $this->queryBuilder->getQueryPart($queryPartName); + } + + /** + * Gets all query parts. + * + * @return array + */ + public function getQueryParts() { + return $this->queryBuilder->getQueryParts(); + } + + /** + * Resets SQL parts. + * + * @param array|null $queryPartNames + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function resetQueryParts($queryPartNames = null) { + $this->queryBuilder->resetQueryParts($queryPartNames); + + return $this; + } + + /** + * Resets a single SQL part. + * + * @param string $queryPartName + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + */ + public function resetQueryPart($queryPartName) { + $this->queryBuilder->resetQueryPart($queryPartName); + + return $this; + } + + /** + * Creates a new named parameter and bind the value $value to it. + * + * This method provides a shortcut for PDOStatement::bindValue + * when using prepared statements. + * + * The parameter $value specifies the value that you want to bind. If + * $placeholder is not provided bindValue() will automatically create a + * placeholder for you. An automatic placeholder will be of the name + * ':dcValue1', ':dcValue2' etc. + * + * For more information see {@link http://php.net/pdostatement-bindparam} + * + * Example: + * + * $value = 2; + * $q->eq( 'id', $q->bindValue( $value ) ); + * $stmt = $q->executeQuery(); // executed with 'id = 2' + * + * + * @license New BSD License + * @link http://www.zetacomponents.org + * + * @param mixed $value + * @param mixed $type + * @param string $placeHolder The name to bind with. The string must start with a colon ':'. + * + * @return IParameter the placeholder name used. + */ + public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null) { + return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder)); + } + + /** + * Creates a new positional parameter and bind the given value to it. + * + * Attention: If you are using positional parameters with the query builder you have + * to be very careful to bind all parameters in the order they appear in the SQL + * statement , otherwise they get bound in the wrong order which can lead to serious + * bugs in your code. + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select('u.*') + * ->from('users', 'u') + * ->where('u.username = ' . $qb->createPositionalParameter('Foo', PDO::PARAM_STR)) + * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR)) + * + * + * @param mixed $value + * @param integer $type + * + * @return IParameter + */ + public function createPositionalParameter($value, $type = \PDO::PARAM_STR) { + return new Parameter($this->queryBuilder->createPositionalParameter($value, $type)); + } + + /** + * Creates a new parameter + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select('u.*') + * ->from('users', 'u') + * ->where('u.username = ' . $qb->createParameter('name')) + * ->setParameter('name', 'Bar', PDO::PARAM_STR)) + * + * + * @param string $name + * + * @return IParameter + */ + public function createParameter($name) { + return new Parameter(':' . $name); + } + + /** + * Creates a new function + * + * Attention: Column names inside the call have to be quoted before hand + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select($qb->createFunction('COUNT(*)')) + * ->from('users', 'u') + * echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u + * + * + * $qb = $conn->getQueryBuilder(); + * $qb->select($qb->createFunction('COUNT(`column`)')) + * ->from('users', 'u') + * echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u + * + * + * @param string $call + * + * @return IQueryFunction + */ + public function createFunction($call) { + return new QueryFunction($call); + } +} diff --git a/lib/private/db/querybuilder/queryfunction.php b/lib/private/db/querybuilder/queryfunction.php new file mode 100644 index 00000000000..2a47d83b917 --- /dev/null +++ b/lib/private/db/querybuilder/queryfunction.php @@ -0,0 +1,40 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\IQueryFunction; + +class QueryFunction implements IQueryFunction { + /** @var string */ + protected $function; + + public function __construct($function) { + $this->function = $function; + } + + /** + * @return string + */ + public function __toString() { + return (string) $this->function; + } +} diff --git a/lib/private/db/querybuilder/quotehelper.php b/lib/private/db/querybuilder/quotehelper.php new file mode 100644 index 00000000000..0735f313abc --- /dev/null +++ b/lib/private/db/querybuilder/quotehelper.php @@ -0,0 +1,75 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\ILiteral; +use OCP\DB\QueryBuilder\IParameter; +use OCP\DB\QueryBuilder\IQueryFunction; + +class QuoteHelper { + /** + * @param array|string|ILiteral|IParameter|IQueryFunction $strings string, Literal or Parameter + * @return array|string + */ + public function quoteColumnNames($strings) { + if (!is_array($strings)) { + return $this->quoteColumnName($strings); + } + + $return = []; + foreach ($strings as $string) { + $return[] = $this->quoteColumnName($string); + } + + return $return; + } + + /** + * @param string|ILiteral|IParameter|IQueryFunction $string string, Literal or Parameter + * @return string + */ + public function quoteColumnName($string) { + if ($string instanceof IParameter || $string instanceof ILiteral || $string instanceof IQueryFunction) { + return (string) $string; + } + + if ($string === null || $string === '*') { + return $string; + } + + if (!is_string($string)) { + throw new \InvalidArgumentException('Only strings, Literals and Parameters are allowed'); + } + + if (substr_count($string, '.')) { + list($alias, $columnName) = explode('.', $string); + + if ($columnName === '*') { + return $string; + } + + return $alias . '.`' . $columnName . '`'; + } + + return '`' . $string . '`'; + } +} diff --git a/lib/public/db/icompositeexpression.php b/lib/public/db/icompositeexpression.php deleted file mode 100644 index 123e4ca7cc6..00000000000 --- a/lib/public/db/icompositeexpression.php +++ /dev/null @@ -1,64 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OCP\DB; - -/** - * This class provides a wrapper around Doctrine's CompositeExpression - * @since 8.2.0 - */ -interface ICompositeExpression { - /** - * Adds multiple parts to composite expression. - * - * @param array $parts - * - * @return \OCP\DB\ICompositeExpression - * @since 8.2.0 - */ - public function addMultiple(array $parts = array()); - - /** - * Adds an expression to composite expression. - * - * @param mixed $part - * - * @return \OCP\DB\ICompositeExpression - * @since 8.2.0 - */ - public function add($part); - - /** - * Retrieves the amount of expressions on composite expression. - * - * @return integer - * @since 8.2.0 - */ - public function count(); - - /** - * Returns the type of this composite expression (AND/OR). - * - * @return string - * @since 8.2.0 - */ - public function getType(); -} diff --git a/lib/public/db/iexpressionbuilder.php b/lib/public/db/iexpressionbuilder.php deleted file mode 100644 index 848a8a2f8f1..00000000000 --- a/lib/public/db/iexpressionbuilder.php +++ /dev/null @@ -1,252 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OCP\DB; - -/** - * This class provides a wrapper around Doctrine's ExpressionBuilder - * @since 8.2.0 - */ -interface IExpressionBuilder { - /** - * Creates a conjunction of the given boolean expressions. - * - * Example: - * - * [php] - * // (u.type = ?) AND (u.role = ?) - * $expr->andX('u.type = ?', 'u.role = ?')); - * - * @param mixed $x Optional clause. Defaults = null, but requires - * at least one defined when converting to string. - * - * @return \OCP\DB\ICompositeExpression - * @since 8.2.0 - */ - public function andX($x = null); - - /** - * Creates a disjunction of the given boolean expressions. - * - * Example: - * - * [php] - * // (u.type = ?) OR (u.role = ?) - * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); - * - * @param mixed $x Optional clause. Defaults = null, but requires - * at least one defined when converting to string. - * - * @return \OCP\DB\ICompositeExpression - * @since 8.2.0 - */ - public function orX($x = null); - - /** - * Creates a comparison expression. - * - * @param mixed $x The left expression. - * @param string $operator One of the ExpressionBuilder::* constants. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function comparison($x, $operator, $y); - - /** - * Creates an equality comparison expression with the given arguments. - * - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a = . Example: - * - * [php] - * // u.id = ? - * $expr->eq('u.id', '?'); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function eq($x, $y); - - /** - * Creates a non equality comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a <> . Example: - * - * [php] - * // u.id <> 1 - * $q->where($q->expr()->neq('u.id', '1')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function neq($x, $y); - - /** - * Creates a lower-than comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a < . Example: - * - * [php] - * // u.id < ? - * $q->where($q->expr()->lt('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function lt($x, $y); - - /** - * Creates a lower-than-equal comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a <= . Example: - * - * [php] - * // u.id <= ? - * $q->where($q->expr()->lte('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function lte($x, $y); - - /** - * Creates a greater-than comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a > . Example: - * - * [php] - * // u.id > ? - * $q->where($q->expr()->gt('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function gt($x, $y); - - /** - * Creates a greater-than-equal comparison expression with the given arguments. - * First argument is considered the left expression and the second is the right expression. - * When converted to string, it will generated a >= . Example: - * - * [php] - * // u.id >= ? - * $q->where($q->expr()->gte('u.id', '?')); - * - * @param mixed $x The left expression. - * @param mixed $y The right expression. - * - * @return string - * @since 8.2.0 - */ - public function gte($x, $y); - - /** - * Creates an IS NULL expression with the given arguments. - * - * @param string $x The field in string format to be restricted by IS NULL. - * - * @return string - * @since 8.2.0 - */ - public function isNull($x); - - /** - * Creates an IS NOT NULL expression with the given arguments. - * - * @param string $x The field in string format to be restricted by IS NOT NULL. - * - * @return string - * @since 8.2.0 - */ - public function isNotNull($x); - - /** - * Creates a LIKE() comparison expression with the given arguments. - * - * @param string $x Field in string format to be inspected by LIKE() comparison. - * @param mixed $y Argument to be used in LIKE() comparison. - * - * @return string - * @since 8.2.0 - */ - public function like($x, $y); - - /** - * Creates a NOT LIKE() comparison expression with the given arguments. - * - * @param string $x Field in string format to be inspected by NOT LIKE() comparison. - * @param mixed $y Argument to be used in NOT LIKE() comparison. - * - * @return string - * @since 8.2.0 - */ - public function notLike($x, $y); - - /** - * Creates a IN () comparison expression with the given arguments. - * - * @param string $x The field in string format to be inspected by IN() comparison. - * @param string|array $y The placeholder or the array of values to be used by IN() comparison. - * - * @return string - * @since 8.2.0 - */ - public function in($x, $y); - - /** - * Creates a NOT IN () comparison expression with the given arguments. - * - * @param string $x The field in string format to be inspected by NOT IN() comparison. - * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. - * - * @return string - * @since 8.2.0 - */ - public function notIn($x, $y); - - /** - * Quotes a given input parameter. - * - * @param mixed $input The parameter to be quoted. - * @param string|null $type The type of the parameter. - * - * @return string - * @since 8.2.0 - */ - public function literal($input, $type = null); -} diff --git a/lib/public/db/iquerybuilder.php b/lib/public/db/iquerybuilder.php deleted file mode 100644 index 24ca96c578d..00000000000 --- a/lib/public/db/iquerybuilder.php +++ /dev/null @@ -1,742 +0,0 @@ - - * - * @copyright Copyright (c) 2015, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code 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. - * - * 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, version 3, - * along with this program. If not, see - * - */ - -namespace OCP\DB; - -/** - * This class provides a wrapper around Doctrine's QueryBuilder - * @since 8.2.0 - */ -interface IQueryBuilder { - /** - * Gets an ExpressionBuilder used for object-oriented construction of query expressions. - * This producer method is intended for convenient inline usage. Example: - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where($qb->expr()->eq('u.id', 1)); - * - * - * For more complex expression construction, consider storing the expression - * builder object in a local variable. - * - * @return \OCP\DB\IExpressionBuilder - * @since 8.2.0 - */ - public function expr(); - - /** - * Gets the type of the currently built query. - * - * @return integer - * @since 8.2.0 - */ - public function getType(); - - /** - * Gets the associated DBAL Connection for this query builder. - * - * @return \OCP\IDBConnection - * @since 8.2.0 - */ - public function getConnection(); - - /** - * Gets the state of this query builder instance. - * - * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. - * @since 8.2.0 - */ - public function getState(); - - /** - * Executes this query using the bound parameters and their types. - * - * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate} - * for insert, update and delete statements. - * - * @return \Doctrine\DBAL\Driver\Statement|int - * @since 8.2.0 - */ - public function execute(); - - /** - * Gets the complete SQL string formed by the current specifications of this QueryBuilder. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('User', 'u') - * echo $qb->getSQL(); // SELECT u FROM User u - * - * - * @return string The SQL query string. - * @since 8.2.0 - */ - public function getSQL(); - - /** - * Sets a query parameter for the query being constructed. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.id = :user_id') - * ->setParameter(':user_id', 1); - * - * - * @param string|integer $key The parameter position or name. - * @param mixed $value The parameter value. - * @param string|null $type One of the PDO::PARAM_* constants. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function setParameter($key, $value, $type = null); - - /** - * Sets a collection of query parameters for the query being constructed. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.id = :user_id1 OR u.id = :user_id2') - * ->setParameters(array( - * ':user_id1' => 1, - * ':user_id2' => 2 - * )); - * - * - * @param array $params The query parameters to set. - * @param array $types The query parameters types to set. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function setParameters(array $params, array $types = array()); - - /** - * Gets all defined query parameters for the query being constructed indexed by parameter index or name. - * - * @return array The currently defined query parameters indexed by parameter index or name. - * @since 8.2.0 - */ - public function getParameters(); - - /** - * Gets a (previously set) query parameter of the query being constructed. - * - * @param mixed $key The key (index or name) of the bound parameter. - * - * @return mixed The value of the bound parameter. - * @since 8.2.0 - */ - public function getParameter($key); - - /** - * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. - * - * @return array The currently defined query parameter types indexed by parameter index or name. - * @since 8.2.0 - */ - public function getParameterTypes(); - - /** - * Gets a (previously set) query parameter type of the query being constructed. - * - * @param mixed $key The key (index or name) of the bound parameter type. - * - * @return mixed The value of the bound parameter type. - * @since 8.2.0 - */ - public function getParameterType($key); - - /** - * Sets the position of the first result to retrieve (the "offset"). - * - * @param integer $firstResult The first result to return. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function setFirstResult($firstResult); - - /** - * Gets the position of the first result the query object was set to retrieve (the "offset"). - * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder. - * - * @return integer The position of the first result. - * @since 8.2.0 - */ - public function getFirstResult(); - - /** - * Sets the maximum number of results to retrieve (the "limit"). - * - * @param integer $maxResults The maximum number of results to retrieve. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function setMaxResults($maxResults); - - /** - * Gets the maximum number of results the query object was set to retrieve (the "limit"). - * Returns NULL if {@link setMaxResults} was not applied to this query builder. - * - * @return integer The maximum number of results. - * @since 8.2.0 - */ - public function getMaxResults(); - - /** - * Either appends to or replaces a single, generic query part. - * - * The available parts are: 'select', 'from', 'set', 'where', - * 'groupBy', 'having' and 'orderBy'. - * - * @param string $sqlPartName - * @param string $sqlPart - * @param boolean $append - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function add($sqlPartName, $sqlPart, $append = false); - - /** - * Specifies an item that is to be returned in the query result. - * Replaces any previously specified selections, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id', 'p.id') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); - * - * - * @param mixed $select The selection expressions. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function select($select = null); - - /** - * Adds an item that is to be returned in the query result. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id') - * ->addSelect('p.id') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); - * - * - * @param mixed $select The selection expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function addSelect($select = null); - - /** - * Turns the query being built into a bulk delete query that ranges over - * a certain table. - * - * - * $qb = $conn->getQueryBuilder() - * ->delete('users', 'u') - * ->where('u.id = :user_id'); - * ->setParameter(':user_id', 1); - * - * - * @param string $delete The table whose rows are subject to the deletion. - * @param string $alias The table alias used in the constructed query. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function delete($delete = null, $alias = null); - - /** - * Turns the query being built into a bulk update query that ranges over - * a certain table - * - * - * $qb = $conn->getQueryBuilder() - * ->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where('u.id = ?'); - * - * - * @param string $update The table whose rows are subject to the update. - * @param string $alias The table alias used in the constructed query. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function update($update = null, $alias = null); - - /** - * Turns the query being built into an insert query that inserts into - * a certain table - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?', - * 'password' => '?' - * ) - * ); - * - * - * @param string $insert The table into which the rows should be inserted. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function insert($insert = null); - - /** - * Creates and adds a query root corresponding to the table identified by the - * given alias, forming a cartesian product with any existing query roots. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.id') - * ->from('users', 'u') - * - * - * @param string $from The table. - * @param string|null $alias The alias of the table. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function from($from, $alias = null); - - /** - * Creates and adds a join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function join($fromAlias, $join, $alias, $condition = null); - - /** - * Creates and adds a join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function innerJoin($fromAlias, $join, $alias, $condition = null); - - /** - * Creates and adds a left join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function leftJoin($fromAlias, $join, $alias, $condition = null); - - /** - * Creates and adds a right join to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); - * - * - * @param string $fromAlias The alias that points to a from clause. - * @param string $join The table name to join. - * @param string $alias The alias of the join table. - * @param string $condition The condition for the join. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function rightJoin($fromAlias, $join, $alias, $condition = null); - - /** - * Sets a new value for a column in a bulk update query. - * - * - * $qb = $conn->getQueryBuilder() - * ->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where('u.id = ?'); - * - * - * @param string $key The column to set. - * @param string $value The value, expression, placeholder, etc. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function set($key, $value); - - /** - * Specifies one or more restrictions to the query result. - * Replaces any previously specified restrictions, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->where('u.id = ?'); - * - * // You can optionally programatically build and/or expressions - * $qb = $conn->getQueryBuilder(); - * - * $or = $qb->expr()->orx(); - * $or->add($qb->expr()->eq('u.id', 1)); - * $or->add($qb->expr()->eq('u.id', 2)); - * - * $qb->update('users', 'u') - * ->set('u.password', md5('password')) - * ->where($or); - * - * - * @param mixed $predicates The restriction predicates. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function where($predicates); - - /** - * Adds one or more restrictions to the query results, forming a logical - * conjunction with any previously specified restrictions. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u') - * ->from('users', 'u') - * ->where('u.username LIKE ?') - * ->andWhere('u.is_active = 1'); - * - * - * @param mixed $where The query restrictions. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * - * @see where() - * @since 8.2.0 - */ - public function andWhere($where); - - /** - * Adds one or more restrictions to the query results, forming a logical - * disjunction with any previously specified restrictions. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->where('u.id = 1') - * ->orWhere('u.id = 2'); - * - * - * @param mixed $where The WHERE statement. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * - * @see where() - * @since 8.2.0 - */ - public function orWhere($where); - - /** - * Specifies a grouping over the results of the query. - * Replaces any previously specified groupings, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->groupBy('u.id'); - * - * - * @param mixed $groupBy The grouping expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function groupBy($groupBy); - - /** - * Adds a grouping expression to the query. - * - * - * $qb = $conn->getQueryBuilder() - * ->select('u.name') - * ->from('users', 'u') - * ->groupBy('u.lastLogin'); - * ->addGroupBy('u.createdAt') - * - * - * @param mixed $groupBy The grouping expression. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function addGroupBy($groupBy); - - /** - * Sets a value for a column in an insert query. - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?' - * ) - * ) - * ->setValue('password', '?'); - * - * - * @param string $column The column into which the value should be inserted. - * @param string $value The value that should be inserted into the column. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function setValue($column, $value); - - /** - * Specifies values for an insert query indexed by column names. - * Replaces any previous values, if any. - * - * - * $qb = $conn->getQueryBuilder() - * ->insert('users') - * ->values( - * array( - * 'name' => '?', - * 'password' => '?' - * ) - * ); - * - * - * @param array $values The values to specify for the insert query indexed by column names. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function values(array $values); - - /** - * Specifies a restriction over the groups of the query. - * Replaces any previous having restrictions, if any. - * - * @param mixed $having The restriction over the groups. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function having($having); - - /** - * Adds a restriction over the groups of the query, forming a logical - * conjunction with any existing having restrictions. - * - * @param mixed $having The restriction to append. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function andHaving($having); - - /** - * Adds a restriction over the groups of the query, forming a logical - * disjunction with any existing having restrictions. - * - * @param mixed $having The restriction to add. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function orHaving($having); - - /** - * Specifies an ordering for the query results. - * Replaces any previously specified orderings, if any. - * - * @param string $sort The ordering expression. - * @param string $order The ordering direction. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function orderBy($sort, $order = null); - - /** - * Adds an ordering to the query results. - * - * @param string $sort The ordering expression. - * @param string $order The ordering direction. - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function addOrderBy($sort, $order = null); - - /** - * Gets a query part by its name. - * - * @param string $queryPartName - * - * @return mixed - * @since 8.2.0 - */ - public function getQueryPart($queryPartName); - - /** - * Gets all query parts. - * - * @return array - * @since 8.2.0 - */ - public function getQueryParts(); - - /** - * Resets SQL parts. - * - * @param array|null $queryPartNames - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function resetQueryParts($queryPartNames = null); - - /** - * Resets a single SQL part. - * - * @param string $queryPartName - * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. - * @since 8.2.0 - */ - public function resetQueryPart($queryPartName); - - /** - * Creates a new named parameter and bind the value $value to it. - * - * This method provides a shortcut for PDOStatement::bindValue - * when using prepared statements. - * - * The parameter $value specifies the value that you want to bind. If - * $placeholder is not provided bindValue() will automatically create a - * placeholder for you. An automatic placeholder will be of the name - * ':dcValue1', ':dcValue2' etc. - * - * For more information see {@link http://php.net/pdostatement-bindparam} - * - * Example: - * - * $value = 2; - * $q->eq( 'id', $q->bindValue( $value ) ); - * $stmt = $q->executeQuery(); // executed with 'id = 2' - * - * - * @license New BSD License - * @link http://www.zetacomponents.org - * - * @param mixed $value - * @param mixed $type - * @param string $placeHolder The name to bind with. The string must start with a colon ':'. - * - * @return string the placeholder name used. - * @since 8.2.0 - */ - public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null); - - /** - * Creates a new positional parameter and bind the given value to it. - * - * Attention: If you are using positional parameters with the query builder you have - * to be very careful to bind all parameters in the order they appear in the SQL - * statement , otherwise they get bound in the wrong order which can lead to serious - * bugs in your code. - * - * Example: - * - * $qb = $conn->getQueryBuilder(); - * $qb->select('u.*') - * ->from('users', 'u') - * ->where('u.username = ' . $qb->createPositionalParameter('Foo', PDO::PARAM_STR)) - * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR)) - * - * - * @param mixed $value - * @param integer $type - * - * @return string - * @since 8.2.0 - */ - public function createPositionalParameter($value, $type = \PDO::PARAM_STR); -} diff --git a/lib/public/db/querybuilder/icompositeexpression.php b/lib/public/db/querybuilder/icompositeexpression.php new file mode 100644 index 00000000000..439c0ab20a8 --- /dev/null +++ b/lib/public/db/querybuilder/icompositeexpression.php @@ -0,0 +1,64 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OCP\DB\QueryBuilder; + +/** + * This class provides a wrapper around Doctrine's CompositeExpression + * @since 8.2.0 + */ +interface ICompositeExpression { + /** + * Adds multiple parts to composite expression. + * + * @param array $parts + * + * @return \OCP\DB\ICompositeExpression + * @since 8.2.0 + */ + public function addMultiple(array $parts = array()); + + /** + * Adds an expression to composite expression. + * + * @param mixed $part + * + * @return \OCP\DB\ICompositeExpression + * @since 8.2.0 + */ + public function add($part); + + /** + * Retrieves the amount of expressions on composite expression. + * + * @return integer + * @since 8.2.0 + */ + public function count(); + + /** + * Returns the type of this composite expression (AND/OR). + * + * @return string + * @since 8.2.0 + */ + public function getType(); +} diff --git a/lib/public/db/querybuilder/iexpressionbuilder.php b/lib/public/db/querybuilder/iexpressionbuilder.php new file mode 100644 index 00000000000..d719f07ebd4 --- /dev/null +++ b/lib/public/db/querybuilder/iexpressionbuilder.php @@ -0,0 +1,252 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OCP\DB\QueryBuilder; + +/** + * This class provides a wrapper around Doctrine's ExpressionBuilder + * @since 8.2.0 + */ +interface IExpressionBuilder { + /** + * Creates a conjunction of the given boolean expressions. + * + * Example: + * + * [php] + * // (u.type = ?) AND (u.role = ?) + * $expr->andX('u.type = ?', 'u.role = ?')); + * + * @param mixed $x Optional clause. Defaults = null, but requires + * at least one defined when converting to string. + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + * @since 8.2.0 + */ + public function andX($x = null); + + /** + * Creates a disjunction of the given boolean expressions. + * + * Example: + * + * [php] + * // (u.type = ?) OR (u.role = ?) + * $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?')); + * + * @param mixed $x Optional clause. Defaults = null, but requires + * at least one defined when converting to string. + * + * @return \OCP\DB\QueryBuilder\ICompositeExpression + * @since 8.2.0 + */ + public function orX($x = null); + + /** + * Creates a comparison expression. + * + * @param mixed $x The left expression. + * @param string $operator One of the ExpressionBuilder::* constants. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function comparison($x, $operator, $y); + + /** + * Creates an equality comparison expression with the given arguments. + * + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a = . Example: + * + * [php] + * // u.id = ? + * $expr->eq('u.id', '?'); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function eq($x, $y); + + /** + * Creates a non equality comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a <> . Example: + * + * [php] + * // u.id <> 1 + * $q->where($q->expr()->neq('u.id', '1')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function neq($x, $y); + + /** + * Creates a lower-than comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a < . Example: + * + * [php] + * // u.id < ? + * $q->where($q->expr()->lt('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function lt($x, $y); + + /** + * Creates a lower-than-equal comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a <= . Example: + * + * [php] + * // u.id <= ? + * $q->where($q->expr()->lte('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function lte($x, $y); + + /** + * Creates a greater-than comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a > . Example: + * + * [php] + * // u.id > ? + * $q->where($q->expr()->gt('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function gt($x, $y); + + /** + * Creates a greater-than-equal comparison expression with the given arguments. + * First argument is considered the left expression and the second is the right expression. + * When converted to string, it will generated a >= . Example: + * + * [php] + * // u.id >= ? + * $q->where($q->expr()->gte('u.id', '?')); + * + * @param mixed $x The left expression. + * @param mixed $y The right expression. + * + * @return string + * @since 8.2.0 + */ + public function gte($x, $y); + + /** + * Creates an IS NULL expression with the given arguments. + * + * @param string $x The field in string format to be restricted by IS NULL. + * + * @return string + * @since 8.2.0 + */ + public function isNull($x); + + /** + * Creates an IS NOT NULL expression with the given arguments. + * + * @param string $x The field in string format to be restricted by IS NOT NULL. + * + * @return string + * @since 8.2.0 + */ + public function isNotNull($x); + + /** + * Creates a LIKE() comparison expression with the given arguments. + * + * @param string $x Field in string format to be inspected by LIKE() comparison. + * @param mixed $y Argument to be used in LIKE() comparison. + * + * @return string + * @since 8.2.0 + */ + public function like($x, $y); + + /** + * Creates a NOT LIKE() comparison expression with the given arguments. + * + * @param string $x Field in string format to be inspected by NOT LIKE() comparison. + * @param mixed $y Argument to be used in NOT LIKE() comparison. + * + * @return string + * @since 8.2.0 + */ + public function notLike($x, $y); + + /** + * Creates a IN () comparison expression with the given arguments. + * + * @param string $x The field in string format to be inspected by IN() comparison. + * @param string|array $y The placeholder or the array of values to be used by IN() comparison. + * + * @return string + * @since 8.2.0 + */ + public function in($x, $y); + + /** + * Creates a NOT IN () comparison expression with the given arguments. + * + * @param string $x The field in string format to be inspected by NOT IN() comparison. + * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison. + * + * @return string + * @since 8.2.0 + */ + public function notIn($x, $y); + + /** + * Quotes a given input parameter. + * + * @param mixed $input The parameter to be quoted. + * @param string|null $type The type of the parameter. + * + * @return string + * @since 8.2.0 + */ + public function literal($input, $type = null); +} diff --git a/lib/public/db/querybuilder/iliteral.php b/lib/public/db/querybuilder/iliteral.php new file mode 100644 index 00000000000..a09b25bb2b9 --- /dev/null +++ b/lib/public/db/querybuilder/iliteral.php @@ -0,0 +1,29 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ +namespace OCP\DB\QueryBuilder; + +interface ILiteral { + /** + * @return string + * @since 8.2.0 + */ + public function __toString(); +} diff --git a/lib/public/db/querybuilder/iparameter.php b/lib/public/db/querybuilder/iparameter.php new file mode 100644 index 00000000000..0eb525b3522 --- /dev/null +++ b/lib/public/db/querybuilder/iparameter.php @@ -0,0 +1,29 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ +namespace OCP\DB\QueryBuilder; + +interface IParameter { + /** + * @return string + * @since 8.2.0 + */ + public function __toString(); +} diff --git a/lib/public/db/querybuilder/iquerybuilder.php b/lib/public/db/querybuilder/iquerybuilder.php new file mode 100644 index 00000000000..09d5d199bef --- /dev/null +++ b/lib/public/db/querybuilder/iquerybuilder.php @@ -0,0 +1,772 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace OCP\DB\QueryBuilder; + +/** + * This class provides a wrapper around Doctrine's QueryBuilder + * @since 8.2.0 + */ +interface IQueryBuilder { + /** + * Gets an ExpressionBuilder used for object-oriented construction of query expressions. + * This producer method is intended for convenient inline usage. Example: + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where($qb->expr()->eq('u.id', 1)); + * + * + * For more complex expression construction, consider storing the expression + * builder object in a local variable. + * + * @return \OCP\DB\QueryBuilder\IExpressionBuilder + * @since 8.2.0 + */ + public function expr(); + + /** + * Gets the type of the currently built query. + * + * @return integer + * @since 8.2.0 + */ + public function getType(); + + /** + * Gets the associated DBAL Connection for this query builder. + * + * @return \OCP\IDBConnection + * @since 8.2.0 + */ + public function getConnection(); + + /** + * Gets the state of this query builder instance. + * + * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. + * @since 8.2.0 + */ + public function getState(); + + /** + * Executes this query using the bound parameters and their types. + * + * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate} + * for insert, update and delete statements. + * + * @return \Doctrine\DBAL\Driver\Statement|int + * @since 8.2.0 + */ + public function execute(); + + /** + * Gets the complete SQL string formed by the current specifications of this QueryBuilder. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('User', 'u') + * echo $qb->getSQL(); // SELECT u FROM User u + * + * + * @return string The SQL query string. + * @since 8.2.0 + */ + public function getSQL(); + + /** + * Sets a query parameter for the query being constructed. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.id = :user_id') + * ->setParameter(':user_id', 1); + * + * + * @param string|integer $key The parameter position or name. + * @param mixed $value The parameter value. + * @param string|null $type One of the PDO::PARAM_* constants. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function setParameter($key, $value, $type = null); + + /** + * Sets a collection of query parameters for the query being constructed. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.id = :user_id1 OR u.id = :user_id2') + * ->setParameters(array( + * ':user_id1' => 1, + * ':user_id2' => 2 + * )); + * + * + * @param array $params The query parameters to set. + * @param array $types The query parameters types to set. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function setParameters(array $params, array $types = array()); + + /** + * Gets all defined query parameters for the query being constructed indexed by parameter index or name. + * + * @return array The currently defined query parameters indexed by parameter index or name. + * @since 8.2.0 + */ + public function getParameters(); + + /** + * Gets a (previously set) query parameter of the query being constructed. + * + * @param mixed $key The key (index or name) of the bound parameter. + * + * @return mixed The value of the bound parameter. + * @since 8.2.0 + */ + public function getParameter($key); + + /** + * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. + * + * @return array The currently defined query parameter types indexed by parameter index or name. + * @since 8.2.0 + */ + public function getParameterTypes(); + + /** + * Gets a (previously set) query parameter type of the query being constructed. + * + * @param mixed $key The key (index or name) of the bound parameter type. + * + * @return mixed The value of the bound parameter type. + * @since 8.2.0 + */ + public function getParameterType($key); + + /** + * Sets the position of the first result to retrieve (the "offset"). + * + * @param integer $firstResult The first result to return. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function setFirstResult($firstResult); + + /** + * Gets the position of the first result the query object was set to retrieve (the "offset"). + * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder. + * + * @return integer The position of the first result. + * @since 8.2.0 + */ + public function getFirstResult(); + + /** + * Sets the maximum number of results to retrieve (the "limit"). + * + * @param integer $maxResults The maximum number of results to retrieve. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function setMaxResults($maxResults); + + /** + * Gets the maximum number of results the query object was set to retrieve (the "limit"). + * Returns NULL if {@link setMaxResults} was not applied to this query builder. + * + * @return integer The maximum number of results. + * @since 8.2.0 + */ + public function getMaxResults(); + + /** + * Specifies an item that is to be returned in the query result. + * Replaces any previously specified selections, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id', 'p.id') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); + * + * + * @param mixed $select The selection expressions. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function select($select = null); + + /** + * Adds an item that is to be returned in the query result. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id') + * ->addSelect('p.id') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); + * + * + * @param mixed $select The selection expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function addSelect($select = null); + + /** + * Turns the query being built into a bulk delete query that ranges over + * a certain table. + * + * + * $qb = $conn->getQueryBuilder() + * ->delete('users', 'u') + * ->where('u.id = :user_id'); + * ->setParameter(':user_id', 1); + * + * + * @param string $delete The table whose rows are subject to the deletion. + * @param string $alias The table alias used in the constructed query. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function delete($delete = null, $alias = null); + + /** + * Turns the query being built into a bulk update query that ranges over + * a certain table + * + * + * $qb = $conn->getQueryBuilder() + * ->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where('u.id = ?'); + * + * + * @param string $update The table whose rows are subject to the update. + * @param string $alias The table alias used in the constructed query. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function update($update = null, $alias = null); + + /** + * Turns the query being built into an insert query that inserts into + * a certain table + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?', + * 'password' => '?' + * ) + * ); + * + * + * @param string $insert The table into which the rows should be inserted. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function insert($insert = null); + + /** + * Creates and adds a query root corresponding to the table identified by the + * given alias, forming a cartesian product with any existing query roots. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.id') + * ->from('users', 'u') + * + * + * @param string $from The table. + * @param string|null $alias The alias of the table. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function from($from, $alias = null); + + /** + * Creates and adds a join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function join($fromAlias, $join, $alias, $condition = null); + + /** + * Creates and adds a join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function innerJoin($fromAlias, $join, $alias, $condition = null); + + /** + * Creates and adds a left join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function leftJoin($fromAlias, $join, $alias, $condition = null); + + /** + * Creates and adds a right join to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); + * + * + * @param string $fromAlias The alias that points to a from clause. + * @param string $join The table name to join. + * @param string $alias The alias of the join table. + * @param string $condition The condition for the join. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function rightJoin($fromAlias, $join, $alias, $condition = null); + + /** + * Sets a new value for a column in a bulk update query. + * + * + * $qb = $conn->getQueryBuilder() + * ->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where('u.id = ?'); + * + * + * @param string $key The column to set. + * @param string $value The value, expression, placeholder, etc. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function set($key, $value); + + /** + * Specifies one or more restrictions to the query result. + * Replaces any previously specified restrictions, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->where('u.id = ?'); + * + * // You can optionally programatically build and/or expressions + * $qb = $conn->getQueryBuilder(); + * + * $or = $qb->expr()->orx(); + * $or->add($qb->expr()->eq('u.id', 1)); + * $or->add($qb->expr()->eq('u.id', 2)); + * + * $qb->update('users', 'u') + * ->set('u.password', md5('password')) + * ->where($or); + * + * + * @param mixed $predicates The restriction predicates. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function where($predicates); + + /** + * Adds one or more restrictions to the query results, forming a logical + * conjunction with any previously specified restrictions. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u') + * ->from('users', 'u') + * ->where('u.username LIKE ?') + * ->andWhere('u.is_active = 1'); + * + * + * @param mixed $where The query restrictions. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * + * @see where() + * @since 8.2.0 + */ + public function andWhere($where); + + /** + * Adds one or more restrictions to the query results, forming a logical + * disjunction with any previously specified restrictions. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->where('u.id = 1') + * ->orWhere('u.id = 2'); + * + * + * @param mixed $where The WHERE statement. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * + * @see where() + * @since 8.2.0 + */ + public function orWhere($where); + + /** + * Specifies a grouping over the results of the query. + * Replaces any previously specified groupings, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->groupBy('u.id'); + * + * + * @param mixed $groupBy The grouping expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function groupBy($groupBy); + + /** + * Adds a grouping expression to the query. + * + * + * $qb = $conn->getQueryBuilder() + * ->select('u.name') + * ->from('users', 'u') + * ->groupBy('u.lastLogin'); + * ->addGroupBy('u.createdAt') + * + * + * @param mixed $groupBy The grouping expression. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function addGroupBy($groupBy); + + /** + * Sets a value for a column in an insert query. + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?' + * ) + * ) + * ->setValue('password', '?'); + * + * + * @param string $column The column into which the value should be inserted. + * @param string $value The value that should be inserted into the column. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function setValue($column, $value); + + /** + * Specifies values for an insert query indexed by column names. + * Replaces any previous values, if any. + * + * + * $qb = $conn->getQueryBuilder() + * ->insert('users') + * ->values( + * array( + * 'name' => '?', + * 'password' => '?' + * ) + * ); + * + * + * @param array $values The values to specify for the insert query indexed by column names. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function values(array $values); + + /** + * Specifies a restriction over the groups of the query. + * Replaces any previous having restrictions, if any. + * + * @param mixed $having The restriction over the groups. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function having($having); + + /** + * Adds a restriction over the groups of the query, forming a logical + * conjunction with any existing having restrictions. + * + * @param mixed $having The restriction to append. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function andHaving($having); + + /** + * Adds a restriction over the groups of the query, forming a logical + * disjunction with any existing having restrictions. + * + * @param mixed $having The restriction to add. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function orHaving($having); + + /** + * Specifies an ordering for the query results. + * Replaces any previously specified orderings, if any. + * + * @param string $sort The ordering expression. + * @param string $order The ordering direction. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function orderBy($sort, $order = null); + + /** + * Adds an ordering to the query results. + * + * @param string $sort The ordering expression. + * @param string $order The ordering direction. + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function addOrderBy($sort, $order = null); + + /** + * Gets a query part by its name. + * + * @param string $queryPartName + * + * @return mixed + * @since 8.2.0 + */ + public function getQueryPart($queryPartName); + + /** + * Gets all query parts. + * + * @return array + * @since 8.2.0 + */ + public function getQueryParts(); + + /** + * Resets SQL parts. + * + * @param array|null $queryPartNames + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function resetQueryParts($queryPartNames = null); + + /** + * Resets a single SQL part. + * + * @param string $queryPartName + * + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. + * @since 8.2.0 + */ + public function resetQueryPart($queryPartName); + + /** + * Creates a new named parameter and bind the value $value to it. + * + * This method provides a shortcut for PDOStatement::bindValue + * when using prepared statements. + * + * The parameter $value specifies the value that you want to bind. If + * $placeholder is not provided bindValue() will automatically create a + * placeholder for you. An automatic placeholder will be of the name + * ':dcValue1', ':dcValue2' etc. + * + * For more information see {@link http://php.net/pdostatement-bindparam} + * + * Example: + * + * $value = 2; + * $q->eq( 'id', $q->bindValue( $value ) ); + * $stmt = $q->executeQuery(); // executed with 'id = 2' + * + * + * @license New BSD License + * @link http://www.zetacomponents.org + * + * @param mixed $value + * @param mixed $type + * @param string $placeHolder The name to bind with. The string must start with a colon ':'. + * + * @return IParameter + * @since 8.2.0 + */ + public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null); + + /** + * Creates a new positional parameter and bind the given value to it. + * + * Attention: If you are using positional parameters with the query builder you have + * to be very careful to bind all parameters in the order they appear in the SQL + * statement , otherwise they get bound in the wrong order which can lead to serious + * bugs in your code. + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select('u.*') + * ->from('users', 'u') + * ->where('u.username = ' . $qb->createPositionalParameter('Foo', PDO::PARAM_STR)) + * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', PDO::PARAM_STR)) + * + * + * @param mixed $value + * @param integer $type + * + * @return IParameter + * @since 8.2.0 + */ + public function createPositionalParameter($value, $type = \PDO::PARAM_STR); + + /** + * Creates a new parameter + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select('u.*') + * ->from('users', 'u') + * ->where('u.username = ' . $qb->createParameter('name')) + * ->setParameter('name', 'Bar', PDO::PARAM_STR)) + * + * + * @param string $name + * + * @return IParameter + * @since 8.2.0 + */ + public function createParameter($name); + + /** + * Creates a new function + * + * Attention: Column names inside the call have to be quoted before hand + * + * Example: + * + * $qb = $conn->getQueryBuilder(); + * $qb->select($qb->createFunction('COUNT(*)')) + * ->from('users', 'u') + * echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u + * + * + * $qb = $conn->getQueryBuilder(); + * $qb->select($qb->createFunction('COUNT(`column`)')) + * ->from('users', 'u') + * echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u + * + * + * @param string $call + * + * @return IQueryFunction + * @since 8.2.0 + */ + public function createFunction($call); +} diff --git a/lib/public/db/querybuilder/iqueryfunction.php b/lib/public/db/querybuilder/iqueryfunction.php new file mode 100644 index 00000000000..499b6e1efcc --- /dev/null +++ b/lib/public/db/querybuilder/iqueryfunction.php @@ -0,0 +1,29 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ +namespace OCP\DB\QueryBuilder; + +interface IQueryFunction { + /** + * @return string + * @since 8.2.0 + */ + public function __toString(); +} diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php index a4be3acd2e2..7c94611a684 100644 --- a/lib/public/idbconnection.php +++ b/lib/public/idbconnection.php @@ -43,7 +43,7 @@ interface IDBConnection { /** * Gets the ExpressionBuilder for the connection. * - * @return \OCP\DB\IExpressionBuilder + * @return \OCP\DB\QueryBuilder\IExpressionBuilder * @since 8.2.0 */ public function getExpressionBuilder(); @@ -51,7 +51,7 @@ interface IDBConnection { /** * Gets the QueryBuilder for the connection. * - * @return \OCP\DB\IQueryBuilder + * @return \OCP\DB\QueryBuilder\IQueryBuilder * @since 8.2.0 */ public function getQueryBuilder(); diff --git a/tests/lib/db/querybuilder/expressionbuildertest.php b/tests/lib/db/querybuilder/expressionbuildertest.php new file mode 100644 index 00000000000..b4159e49814 --- /dev/null +++ b/tests/lib/db/querybuilder/expressionbuildertest.php @@ -0,0 +1,338 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace Test\DB\QueryBuilder; + +use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder; +use OC\DB\QueryBuilder\ExpressionBuilder; + +class ExpressionBuilderTest extends \Test\TestCase { + /** @var ExpressionBuilder */ + protected $expressionBuilder; + + /** @var DoctrineExpressionBuilder */ + protected $doctrineExpressionBuilder; + + protected function setUp() { + parent::setUp(); + + $connection = \OC::$server->getDatabaseConnection(); + + $this->expressionBuilder = new ExpressionBuilder($connection); + + $this->doctrineExpressionBuilder = new DoctrineExpressionBuilder($connection); + } + + public function dataComparison() { + $valueSets = $this->dataComparisons(); + $comparisonOperators = ['=', '<>', '<', '>', '<=', '>=']; + + $testSets = []; + foreach ($comparisonOperators as $operator) { + foreach ($valueSets as $values) { + $testSets[] = array_merge([$operator], $values); + } + } + return $testSets; + } + + /** + * @dataProvider dataComparison + * + * @param string $comparison + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testComparison($comparison, $input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->comparison($doctrineInput1, $comparison, $doctrineInput2), + $this->expressionBuilder->comparison($ocInput1, $comparison, $ocInput2) + ); + } + + public function dataComparisons() { + return [ + ['value', false, 'value', false], + ['value', false, 'value', true], + ['value', true, 'value', false], + ['value', true, 'value', true], + ]; + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testEquals($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->eq($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->eq($ocInput1, $ocInput2) + ); + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testNotEquals($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->neq($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->neq($ocInput1, $ocInput2) + ); + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testLowerThan($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->lt($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->lt($ocInput1, $ocInput2) + ); + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testLowerThanEquals($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->lte($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->lte($ocInput1, $ocInput2) + ); + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testGreaterThan($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->gt($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->gt($ocInput1, $ocInput2) + ); + } + + /** + * @dataProvider dataComparisons + * + * @param mixed $input1 + * @param bool $isInput1Literal + * @param mixed $input2 + * @param bool $isInput2Literal + */ + public function testGreaterThanEquals($input1, $isInput1Literal, $input2, $isInput2Literal) { + list($doctrineInput1, $ocInput1) = $this->helpWithLiteral($input1, $isInput1Literal); + list($doctrineInput2, $ocInput2) = $this->helpWithLiteral($input2, $isInput2Literal); + + $this->assertEquals( + $this->doctrineExpressionBuilder->gte($doctrineInput1, $doctrineInput2), + $this->expressionBuilder->gte($ocInput1, $ocInput2) + ); + } + + public function testIsNull() { + $this->assertEquals( + $this->doctrineExpressionBuilder->isNull('`test`'), + $this->expressionBuilder->isNull('test') + ); + } + + public function testIsNotNull() { + $this->assertEquals( + $this->doctrineExpressionBuilder->isNotNull('`test`'), + $this->expressionBuilder->isNotNull('test') + ); + } + + public function dataLike() { + return [ + ['value', false], + ['value', true], + ]; + } + + /** + * @dataProvider dataLike + * + * @param mixed $input + * @param bool $isLiteral + */ + public function testLike($input, $isLiteral) { + list($doctrineInput, $ocInput) = $this->helpWithLiteral($input, $isLiteral); + + $this->assertEquals( + $this->doctrineExpressionBuilder->like('`test`', $doctrineInput), + $this->expressionBuilder->like('test', $ocInput) + ); + } + + /** + * @dataProvider dataLike + * + * @param mixed $input + * @param bool $isLiteral + */ + public function testNotLike($input, $isLiteral) { + list($doctrineInput, $ocInput) = $this->helpWithLiteral($input, $isLiteral); + + $this->assertEquals( + $this->doctrineExpressionBuilder->notLike('`test`', $doctrineInput), + $this->expressionBuilder->notLike('test', $ocInput) + ); + } + + public function dataIn() { + return [ + ['value', false], + ['value', true], + [['value'], false], + [['value'], true], + ]; + } + + /** + * @dataProvider dataIn + * + * @param mixed $input + * @param bool $isLiteral + */ + public function testIn($input, $isLiteral) { + list($doctrineInput, $ocInput) = $this->helpWithLiteral($input, $isLiteral); + + $this->assertEquals( + $this->doctrineExpressionBuilder->in('`test`', $doctrineInput), + $this->expressionBuilder->in('test', $ocInput) + ); + } + + /** + * @dataProvider dataIn + * + * @param mixed $input + * @param bool $isLiteral + */ + public function testNotIn($input, $isLiteral) { + list($doctrineInput, $ocInput) = $this->helpWithLiteral($input, $isLiteral); + + $this->assertEquals( + $this->doctrineExpressionBuilder->notIn('`test`', $doctrineInput), + $this->expressionBuilder->notIn('test', $ocInput) + ); + } + + protected function helpWithLiteral($input, $isLiteral) { + if ($isLiteral) { + if (is_array($input)) { + $doctrineInput = array_map(function ($ident) { + return $this->doctrineExpressionBuilder->literal($ident); + }, $input); + $ocInput = array_map(function ($ident) { + return $this->expressionBuilder->literal($ident); + }, $input); + } else { + $doctrineInput = $this->doctrineExpressionBuilder->literal($input); + $ocInput = $this->expressionBuilder->literal($input); + } + } else { + if (is_array($input)) { + $doctrineInput = array_map(function ($input) { + return '`' . $input . '`'; + }, $input); + $ocInput = $input; + } else { + $doctrineInput = '`' . $input . '`'; + $ocInput = $input; + } + } + + return [$doctrineInput, $ocInput]; + } + + public function dataLiteral() { + return [ + ['value', null], + ['1', null], + [1, null], + [1, 'string'], + [1, 'integer'], + [1, \PDO::PARAM_INT], + ]; + } + + /** + * @dataProvider dataLiteral + * + * @param mixed $input + * @param string|null $type + */ + public function testLiteral($input, $type) { + /** @var \OC\DB\QueryBuilder\Literal $actual */ + $actual = $this->expressionBuilder->literal($input, $type); + + $this->assertInstanceOf('\OC\DB\QueryBuilder\Literal', $actual); + $this->assertSame( + $this->doctrineExpressionBuilder->literal($input, $type), + $actual->__toString() + ); + } +} diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php new file mode 100644 index 00000000000..1b51b9a215f --- /dev/null +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -0,0 +1,941 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace Test\DB\QueryBuilder; + +use Doctrine\DBAL\Query\Expression\CompositeExpression; +use OC\DB\QueryBuilder\Literal; +use OC\DB\QueryBuilder\Parameter; +use OC\DB\QueryBuilder\QueryBuilder; + +class QueryBuilderTest extends \Test\TestCase { + /** @var QueryBuilder */ + protected $queryBuilder; + + protected function setUp() { + parent::setUp(); + + $connection = \OC::$server->getDatabaseConnection(); + + $this->queryBuilder = new QueryBuilder($connection); + } + + public function dataFirstResult() { + return [ + [null, ''], + [0, ' OFFSET 0'], + [1, ' OFFSET 1'], + [5, ' OFFSET 5'], + ]; + } + + /** + * @dataProvider dataFirstResult + * + * @param int $firstResult + * @param string $expectedOffset + */ + public function testFirstResult($firstResult, $expectedOffset) { + if ($firstResult !== null) { + $this->queryBuilder->setFirstResult($firstResult); + } + + $this->assertSame( + $firstResult, + $this->queryBuilder->getFirstResult() + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedOffset, + $this->queryBuilder->getSQL() + ); + } + + public function dataMaxResults() { + return [ + [null, ''], + [0, ' LIMIT 0'], + [1, ' LIMIT 1'], + [5, ' LIMIT 5'], + ]; + } + + /** + * @dataProvider dataMaxResults + * + * @param int $maxResult + * @param string $expectedLimit + */ + public function testMaxResults($maxResult, $expectedLimit) { + if ($maxResult !== null) { + $this->queryBuilder->setMaxResults($maxResult); + } + + $this->assertSame( + $maxResult, + $this->queryBuilder->getMaxResults() + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedLimit, + $this->queryBuilder->getSQL() + ); + } + + public function dataSelect() { + return [ + // select('column1') + [['column1'], ['`column1`'], '`column1`'], + + // select('column1', 'column2') + [['column1', 'column2'], ['`column1`', '`column2`'], '`column1`, `column2`'], + + // select(['column1', 'column2']) + [[['column1', 'column2']], ['`column1`', '`column2`'], '`column1`, `column2`'], + + // select(new Literal('column1')) + [[new Literal('column1')], ['column1'], 'column1'], + + // select('column1', 'column2') + [[new Literal('column1'), 'column2'], ['column1', '`column2`'], 'column1, `column2`'], + + // select(['column1', 'column2']) + [[[new Literal('column1'), 'column2']], ['column1', '`column2`'], 'column1, `column2`'], + ]; + } + + /** + * @dataProvider dataSelect + * + * @param array $selectArguments + * @param array $expectedQueryPart + * @param string $expectedSelect + */ + public function testSelect($selectArguments, $expectedQueryPart, $expectedSelect) { + call_user_func_array( + [$this->queryBuilder, 'select'], + $selectArguments + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('select') + ); + + $this->assertSame( + 'SELECT ' . $expectedSelect . ' FROM ', + $this->queryBuilder->getSQL() + ); + } + + public function dataAddSelect() { + return [ + // addSelect('column1') + [['column1'], ['`column`', '`column1`'], '`column`, `column1`'], + + // addSelect('column1', 'column2') + [['column1', 'column2'], ['`column`', '`column1`', '`column2`'], '`column`, `column1`, `column2`'], + + // addSelect(['column1', 'column2']) + [[['column1', 'column2']], ['`column`', '`column1`', '`column2`'], '`column`, `column1`, `column2`'], + + // select(new Literal('column1')) + [[new Literal('column1')], ['`column`', 'column1'], '`column`, column1'], + + // select('column1', 'column2') + [[new Literal('column1'), 'column2'], ['`column`', 'column1', '`column2`'], '`column`, column1, `column2`'], + + // select(['column1', 'column2']) + [[[new Literal('column1'), 'column2']], ['`column`', 'column1', '`column2`'], '`column`, column1, `column2`'], + ]; + } + + /** + * @dataProvider dataAddSelect + * + * @param array $selectArguments + * @param array $expectedQueryPart + * @param string $expectedSelect + */ + public function testAddSelect($selectArguments, $expectedQueryPart, $expectedSelect) { + $this->queryBuilder->select('column'); + call_user_func_array( + [$this->queryBuilder, 'addSelect'], + $selectArguments + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('select') + ); + + $this->assertSame( + 'SELECT ' . $expectedSelect . ' FROM ', + $this->queryBuilder->getSQL() + ); + } + + public function dataDelete() { + return [ + ['data', null, ['table' => '`data`', 'alias' => null], '`data`'], + ['data', 't', ['table' => '`data`', 'alias' => 't'], '`data` t'], + ]; + } + + /** + * @dataProvider dataDelete + * + * @param string $tableName + * @param string $tableAlias + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testDelete($tableName, $tableAlias, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->delete($tableName, $tableAlias); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('from') + ); + + $this->assertSame( + 'DELETE FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataUpdate() { + return [ + ['data', null, ['table' => '`data`', 'alias' => null], '`data`'], + ['data', 't', ['table' => '`data`', 'alias' => 't'], '`data` t'], + ]; + } + + /** + * @dataProvider dataUpdate + * + * @param string $tableName + * @param string $tableAlias + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testUpdate($tableName, $tableAlias, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->update($tableName, $tableAlias); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('from') + ); + + $this->assertSame( + 'UPDATE ' . $expectedQuery . ' SET ', + $this->queryBuilder->getSQL() + ); + } + + public function dataInsert() { + return [ + ['data', ['table' => '`data`'], '`data`'], + ]; + } + + /** + * @dataProvider dataInsert + * + * @param string $tableName + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testInsert($tableName, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->insert($tableName); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('from') + ); + + $this->assertSame( + 'INSERT INTO ' . $expectedQuery . ' () VALUES()', + $this->queryBuilder->getSQL() + ); + } + + public function dataFrom() { + return [ + ['data', null, null, null, [['table' => '`data`', 'alias' => null]], '`data`'], + ['data', 't', null, null, [['table' => '`data`', 'alias' => 't']], '`data` t'], + ['data1', null, 'data2', null, [ + ['table' => '`data1`', 'alias' => null], + ['table' => '`data2`', 'alias' => null] + ], '`data1`, `data2`'], + ['data', 't1', 'data', 't2', [ + ['table' => '`data`', 'alias' => 't1'], + ['table' => '`data`', 'alias' => 't2'] + ], '`data` t1, `data` t2'], + ]; + } + + /** + * @dataProvider dataFrom + * + * @param string $table1Name + * @param string $table1Alias + * @param string $table2Name + * @param string $table2Alias + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testFrom($table1Name, $table1Alias, $table2Name, $table2Alias, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->from($table1Name, $table1Alias); + if ($table2Name !== null) { + $this->queryBuilder->from($table2Name, $table2Alias); + } + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('from') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataJoin() { + return [ + [ + 'd1', 'data2', null, null, + ['d1' => [['joinType' => 'inner', 'joinTable' => '`data2`', 'joinAlias' => null, 'joinCondition' => null]]], + '`data1` d1 INNER JOIN `data2` ON ' + ], + [ + 'd1', 'data2', 'd2', null, + ['d1' => [['joinType' => 'inner', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => null]]], + '`data1` d1 INNER JOIN `data2` d2 ON ' + ], + [ + 'd1', 'data2', 'd2', 'd1.`field1` = d2.`field2`', + ['d1' => [['joinType' => 'inner', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => 'd1.`field1` = d2.`field2`']]], + '`data1` d1 INNER JOIN `data2` d2 ON d1.`field1` = d2.`field2`' + ], + + ]; + } + + /** + * @dataProvider dataJoin + * + * @param string $fromAlias + * @param string $tableName + * @param string $tableAlias + * @param string $condition + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testJoin($fromAlias, $tableName, $tableAlias, $condition, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->from('data1', 'd1'); + $this->queryBuilder->join( + $fromAlias, + $tableName, + $tableAlias, + $condition + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('join') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + /** + * @dataProvider dataJoin + * + * @param string $fromAlias + * @param string $tableName + * @param string $tableAlias + * @param string $condition + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testInnerJoin($fromAlias, $tableName, $tableAlias, $condition, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->from('data1', 'd1'); + $this->queryBuilder->innerJoin( + $fromAlias, + $tableName, + $tableAlias, + $condition + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('join') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataLeftJoin() { + return [ + [ + 'd1', 'data2', null, null, + ['d1' => [['joinType' => 'left', 'joinTable' => '`data2`', 'joinAlias' => null, 'joinCondition' => null]]], + '`data1` d1 LEFT JOIN `data2` ON ' + ], + [ + 'd1', 'data2', 'd2', null, + ['d1' => [['joinType' => 'left', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => null]]], + '`data1` d1 LEFT JOIN `data2` d2 ON ' + ], + [ + 'd1', 'data2', 'd2', 'd1.`field1` = d2.`field2`', + ['d1' => [['joinType' => 'left', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => 'd1.`field1` = d2.`field2`']]], + '`data1` d1 LEFT JOIN `data2` d2 ON d1.`field1` = d2.`field2`' + ], + ]; + } + + /** + * @dataProvider dataLeftJoin + * + * @param string $fromAlias + * @param string $tableName + * @param string $tableAlias + * @param string $condition + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testLeftJoin($fromAlias, $tableName, $tableAlias, $condition, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->from('data1', 'd1'); + $this->queryBuilder->leftJoin( + $fromAlias, + $tableName, + $tableAlias, + $condition + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('join') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataRightJoin() { + return [ + [ + 'd1', 'data2', null, null, + ['d1' => [['joinType' => 'right', 'joinTable' => '`data2`', 'joinAlias' => null, 'joinCondition' => null]]], + '`data1` d1 RIGHT JOIN `data2` ON ' + ], + [ + 'd1', 'data2', 'd2', null, + ['d1' => [['joinType' => 'right', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => null]]], + '`data1` d1 RIGHT JOIN `data2` d2 ON ' + ], + [ + 'd1', 'data2', 'd2', 'd1.`field1` = d2.`field2`', + ['d1' => [['joinType' => 'right', 'joinTable' => '`data2`', 'joinAlias' => 'd2', 'joinCondition' => 'd1.`field1` = d2.`field2`']]], + '`data1` d1 RIGHT JOIN `data2` d2 ON d1.`field1` = d2.`field2`' + ], + ]; + } + + /** + * @dataProvider dataRightJoin + * + * @param string $fromAlias + * @param string $tableName + * @param string $tableAlias + * @param string $condition + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testRightJoin($fromAlias, $tableName, $tableAlias, $condition, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->from('data1', 'd1'); + $this->queryBuilder->rightJoin( + $fromAlias, + $tableName, + $tableAlias, + $condition + ); + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('join') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataSet() { + return [ + ['column1', new Literal('value'), null, null, ['`column1` = value'], '`column1` = value'], + ['column1', new Parameter(':param'), null, null, ['`column1` = :param'], '`column1` = :param'], + ['column1', 'column2', null, null, ['`column1` = `column2`'], '`column1` = `column2`'], + ['column1', 'column2', 'column3', new Literal('value'), ['`column1` = `column2`', '`column3` = value'], '`column1` = `column2`, `column3` = value'], + ]; + } + + /** + * @dataProvider dataSet + * + * @param string $partOne1 + * @param string $partOne2 + * @param string $partTwo1 + * @param string $partTwo2 + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testSet($partOne1, $partOne2, $partTwo1, $partTwo2, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->update('data'); + $this->queryBuilder->set($partOne1, $partOne2); + if ($partTwo1 !== null) { + $this->queryBuilder->set($partTwo1, $partTwo2); + } + + $this->assertSame( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('set') + ); + + $this->assertSame( + 'UPDATE `data` SET ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataWhere() { + return [ + [['where1'], new CompositeExpression('AND', ['where1']), 'where1'], + [['where1', 'where2'], new CompositeExpression('AND', ['where1', 'where2']), '(where1) AND (where2)'], + ]; + } + + /** + * @dataProvider dataWhere + * + * @param array $whereArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testWhere($whereArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->select('column'); + call_user_func_array( + [$this->queryBuilder, 'where'], + $whereArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('where') + ); + + $this->assertSame( + 'SELECT `column` FROM WHERE ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + /** + * @dataProvider dataWhere + * + * @param array $whereArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testAndWhere($whereArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->select('column'); + call_user_func_array( + [$this->queryBuilder, 'andWhere'], + $whereArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('where') + ); + + $this->assertSame( + 'SELECT `column` FROM WHERE ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataOrWhere() { + return [ + [['where1'], new CompositeExpression('OR', ['where1']), 'where1'], + [['where1', 'where2'], new CompositeExpression('OR', ['where1', 'where2']), '(where1) OR (where2)'], + ]; + } + + /** + * @dataProvider dataOrWhere + * + * @param array $whereArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testOrWhere($whereArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->select('column'); + call_user_func_array( + [$this->queryBuilder, 'orWhere'], + $whereArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('where') + ); + + $this->assertSame( + 'SELECT `column` FROM WHERE ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataGroupBy() { + return [ + [['column1'], ['`column1`'], '`column1`'], + [['column1', 'column2'], ['`column1`', '`column2`'], '`column1`, `column2`'], + ]; + } + + /** + * @dataProvider dataGroupBy + * + * @param array $groupByArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testGroupBy($groupByArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->select('column'); + call_user_func_array( + [$this->queryBuilder, 'groupBy'], + $groupByArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('groupBy') + ); + + $this->assertSame( + 'SELECT `column` FROM GROUP BY ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataAddGroupBy() { + return [ + [['column2'], ['`column1`', '`column2`'], '`column1`, `column2`'], + [['column2', 'column3'], ['`column1`', '`column2`', '`column3`'], '`column1`, `column2`, `column3`'], + ]; + } + + /** + * @dataProvider dataAddGroupBy + * + * @param array $groupByArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testAddGroupBy($groupByArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->select('column'); + $this->queryBuilder->groupBy('column1'); + call_user_func_array( + [$this->queryBuilder, 'addGroupBy'], + $groupByArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('groupBy') + ); + + $this->assertSame( + 'SELECT `column` FROM GROUP BY ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataSetValue() { + return [ + ['column', 'value', ['`column`' => 'value'], '(`column`) VALUES(value)'], + ]; + } + + /** + * @dataProvider dataSetValue + * + * @param string $column + * @param string $value + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testSetValue($column, $value, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->insert('data'); + $this->queryBuilder->setValue($column, $value); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('values') + ); + + $this->assertSame( + 'INSERT INTO `data` ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + /** + * @dataProvider dataSetValue + * + * @param string $column + * @param string $value + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testValues($column, $value, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->insert('data'); + $this->queryBuilder->values([ + $column => $value, + ]); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('values') + ); + + $this->assertSame( + 'INSERT INTO `data` ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataHaving() { + return [ + [['condition1'], new CompositeExpression('AND', ['condition1']), 'HAVING condition1'], + [['condition1', 'condition2'], new CompositeExpression('AND', ['condition1', 'condition2']), 'HAVING (condition1) AND (condition2)'], + [ + [new CompositeExpression('OR', ['condition1', 'condition2'])], + new CompositeExpression('OR', ['condition1', 'condition2']), + 'HAVING (condition1) OR (condition2)' + ], + [ + [new CompositeExpression('AND', ['condition1', 'condition2'])], + new CompositeExpression('AND', ['condition1', 'condition2']), + 'HAVING (condition1) AND (condition2)' + ], + ]; + } + + /** + * @dataProvider dataHaving + * + * @param array $havingArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testHaving($havingArguments, $expectedQueryPart, $expectedQuery) { + call_user_func_array( + [$this->queryBuilder, 'having'], + $havingArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('having') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataAndHaving() { + return [ + [['condition2'], new CompositeExpression('AND', ['condition1', 'condition2']), 'HAVING (condition1) AND (condition2)'], + [['condition2', 'condition3'], new CompositeExpression('AND', ['condition1', 'condition2', 'condition3']), 'HAVING (condition1) AND (condition2) AND (condition3)'], + [ + [new CompositeExpression('OR', ['condition2', 'condition3'])], + new CompositeExpression('AND', ['condition1', new CompositeExpression('OR', ['condition2', 'condition3'])]), + 'HAVING (condition1) AND ((condition2) OR (condition3))' + ], + [ + [new CompositeExpression('AND', ['condition2', 'condition3'])], + new CompositeExpression('AND', ['condition1', new CompositeExpression('AND', ['condition2', 'condition3'])]), + 'HAVING (condition1) AND ((condition2) AND (condition3))' + ], + ]; + } + + /** + * @dataProvider dataAndHaving + * + * @param array $havingArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testAndHaving($havingArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->having('condition1'); + call_user_func_array( + [$this->queryBuilder, 'andHaving'], + $havingArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('having') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataOrHaving() { + return [ + [['condition2'], new CompositeExpression('OR', ['condition1', 'condition2']), 'HAVING (condition1) OR (condition2)'], + [['condition2', 'condition3'], new CompositeExpression('OR', ['condition1', 'condition2', 'condition3']), 'HAVING (condition1) OR (condition2) OR (condition3)'], + [ + [new CompositeExpression('OR', ['condition2', 'condition3'])], + new CompositeExpression('OR', ['condition1', new CompositeExpression('OR', ['condition2', 'condition3'])]), + 'HAVING (condition1) OR ((condition2) OR (condition3))' + ], + [ + [new CompositeExpression('AND', ['condition2', 'condition3'])], + new CompositeExpression('OR', ['condition1', new CompositeExpression('AND', ['condition2', 'condition3'])]), + 'HAVING (condition1) OR ((condition2) AND (condition3))' + ], + ]; + } + + /** + * @dataProvider dataOrHaving + * + * @param array $havingArguments + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testOrHaving($havingArguments, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->having('condition1'); + call_user_func_array( + [$this->queryBuilder, 'orHaving'], + $havingArguments + ); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('having') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataOrderBy() { + return [ + ['column', null, ['`column` ASC'], 'ORDER BY `column` ASC'], + ['column', 'ASC', ['`column` ASC'], 'ORDER BY `column` ASC'], + ['column', 'DESC', ['`column` DESC'], 'ORDER BY `column` DESC'], + ]; + } + + /** + * @dataProvider dataOrderBy + * + * @param string $sort + * @param string $order + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testOrderBy($sort, $order, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->orderBy($sort, $order); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('orderBy') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } + + public function dataAddOrderBy() { + return [ + ['column2', null, null, ['`column1` ASC', '`column2` ASC'], 'ORDER BY `column1` ASC, `column2` ASC'], + ['column2', null, 'ASC', ['`column1` ASC', '`column2` ASC'], 'ORDER BY `column1` ASC, `column2` ASC'], + ['column2', null, 'DESC', ['`column1` DESC', '`column2` ASC'], 'ORDER BY `column1` DESC, `column2` ASC'], + ['column2', 'ASC', null, ['`column1` ASC', '`column2` ASC'], 'ORDER BY `column1` ASC, `column2` ASC'], + ['column2', 'ASC', 'ASC', ['`column1` ASC', '`column2` ASC'], 'ORDER BY `column1` ASC, `column2` ASC'], + ['column2', 'ASC', 'DESC', ['`column1` DESC', '`column2` ASC'], 'ORDER BY `column1` DESC, `column2` ASC'], + ['column2', 'DESC', null, ['`column1` ASC', '`column2` DESC'], 'ORDER BY `column1` ASC, `column2` DESC'], + ['column2', 'DESC', 'ASC', ['`column1` ASC', '`column2` DESC'], 'ORDER BY `column1` ASC, `column2` DESC'], + ['column2', 'DESC', 'DESC', ['`column1` DESC', '`column2` DESC'], 'ORDER BY `column1` DESC, `column2` DESC'], + ]; + } + + /** + * @dataProvider dataAddOrderBy + * + * @param string $sort2 + * @param string $order2 + * @param string $order1 + * @param array $expectedQueryPart + * @param string $expectedQuery + */ + public function testAddOrderBy($sort2, $order2, $order1, $expectedQueryPart, $expectedQuery) { + $this->queryBuilder->orderBy('column1', $order1); + $this->queryBuilder->addOrderBy($sort2, $order2); + + $this->assertEquals( + $expectedQueryPart, + $this->queryBuilder->getQueryPart('orderBy') + ); + + $this->assertSame( + 'SELECT FROM ' . $expectedQuery, + $this->queryBuilder->getSQL() + ); + } +} diff --git a/tests/lib/db/querybuilder/quotehelpertest.php b/tests/lib/db/querybuilder/quotehelpertest.php new file mode 100644 index 00000000000..904b4c500db --- /dev/null +++ b/tests/lib/db/querybuilder/quotehelpertest.php @@ -0,0 +1,141 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code 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. + * + * 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, version 3, + * along with this program. If not, see + * + */ + +namespace Test\DB\QueryBuilder; + +use OC\DB\QueryBuilder\Literal; +use OC\DB\QueryBuilder\Parameter; +use OC\DB\QueryBuilder\QuoteHelper; +use OCP\DB\QueryBuilder\ILiteral; +use OCP\DB\QueryBuilder\IParameter; + +class QuoteHelperTest extends \Test\TestCase { + /** @var QuoteHelper */ + protected $helper; + + protected function setUp() { + parent::setUp(); + + $this->helper = new QuoteHelper(); + } + + public function dataQuoteColumnName() { + return [ + ['column', '`column`'], + [new Literal('literal'), 'literal'], + [new Literal(1), '1'], + [new Parameter(':param'), ':param'], + ]; + } + + /** + * @dataProvider dataQuoteColumnName + * @param mixed $input + * @param string $expected + */ + public function testQuoteColumnName($input, $expected) { + $this->assertSame( + $expected, + $this->helper->quoteColumnName($input) + ); + } + + public function dataQuoteColumnNames() { + return [ + // Single case + ['d.column', 'd.`column`'], + ['column', '`column`'], + [new Literal('literal'), 'literal'], + [new Literal(1), '1'], + [new Parameter(':param'), ':param'], + + // Array case + [['column'], ['`column`']], + [[new Literal('literal')], ['literal']], + [[new Literal(1)], ['1']], + [[new Parameter(':param')], [':param']], + + // Array mixed cases + [['column1', 'column2'], ['`column1`', '`column2`']], + [['column', new Literal('literal')], ['`column`', 'literal']], + [['column', new Literal(1)], ['`column`', '1']], + [['column', new Parameter(':param')], ['`column`', ':param']], + ]; + } + + /** + * @dataProvider dataQuoteColumnNames + * @param mixed $input + * @param string $expected + */ + public function testQuoteColumnNames($input, $expected) { + $this->assertSame( + $expected, + $this->helper->quoteColumnNames($input) + ); + } + + /** + * @param array|string|ILiteral|IParameter $strings string, Literal or Parameter + * @return array|string + */ + public function quoteColumnNames($strings) { + if (!is_array($strings)) { + return $this->quoteColumnName($strings); + } + + $return = []; + foreach ($strings as $string) { + $return[] = $this->quoteColumnName($string); + } + + return $return; + } + + /** + * @param string|ILiteral|IParameter $string string, Literal or Parameter + * @return string + */ + public function quoteColumnName($string) { + if ($string instanceof IParameter) { + return $string->getName(); + } + + if ($string instanceof ILiteral) { + return $string->getLiteral(); + } + + if ($string === null) { + return $string; + } + + if (!is_string($string)) { + throw new \InvalidArgumentException('Only strings, Literals and Parameters are allowed'); + } + + if (substr_count($string, '.')) { + list($alias, $columnName) = explode('.', $string); + return '`' . $alias . '`.`' . $columnName . '`'; + } + + return '`' . $string . '`'; + } +} diff --git a/tests/lib/share/share.php b/tests/lib/share/share.php index e57dd43f839..816070afd8b 100644 --- a/tests/lib/share/share.php +++ b/tests/lib/share/share.php @@ -1335,10 +1335,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\QueryBuilder\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1390,10 +1390,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\QueryBuilder\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1443,10 +1443,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\QueryBuilder\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1496,10 +1496,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\QueryBuilder\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); -- cgit v1.2.3