From 1bfb944d515c88f915739c3b920d39d6da200d29 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 6 Jul 2015 12:00:01 +0200 Subject: [PATCH 01/10] Add QueryBuilder, ExpressionBuilder and CompositeExpression wrappers --- lib/private/appframework/db/db.php | 18 + lib/private/db/compositeexpression.php | 92 +++ lib/private/db/connection.php | 18 + lib/private/db/expressionbuilder.php | 282 ++++++++ lib/private/db/querybuilder.php | 865 +++++++++++++++++++++++++ lib/public/db/icompositeexpression.php | 64 ++ lib/public/db/iexpressionbuilder.php | 252 +++++++ lib/public/db/iquerybuilder.php | 742 +++++++++++++++++++++ lib/public/idbconnection.php | 16 + 9 files changed, 2349 insertions(+) create mode 100644 lib/private/db/compositeexpression.php create mode 100644 lib/private/db/expressionbuilder.php create mode 100644 lib/private/db/querybuilder.php create mode 100644 lib/public/db/icompositeexpression.php create mode 100644 lib/public/db/iexpressionbuilder.php create mode 100644 lib/public/db/iquerybuilder.php diff --git a/lib/private/appframework/db/db.php b/lib/private/appframework/db/db.php index d05cd44b54c..529962002ac 100644 --- a/lib/private/appframework/db/db.php +++ b/lib/private/appframework/db/db.php @@ -45,6 +45,24 @@ class Db implements IDb { $this->connection = $connection; } + /** + * Gets the ExpressionBuilder for the connection. + * + * @return \OCP\DB\IExpressionBuilder + */ + public function getExpressionBuilder() { + return $this->connection->getExpressionBuilder(); + } + + /** + * Gets the ExpressionBuilder for the connection. + * + * @return \OCP\DB\IQueryBuilder + */ + public function getQueryBuilder() { + return $this->connection->getQueryBuilder(); + } + /** * Used to abstract the ownCloud database access away * diff --git a/lib/private/db/compositeexpression.php b/lib/private/db/compositeexpression.php new file mode 100644 index 00000000000..cc57c524369 --- /dev/null +++ b/lib/private/db/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; + +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 a36bd2649df..9bb54883bf4 100644 --- a/lib/private/db/connection.php +++ b/lib/private/db/connection.php @@ -51,6 +51,24 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { } } + /** + * Gets the ExpressionBuilder for the connection. + * + * @return \OCP\DB\IExpressionBuilder + */ + public function getExpressionBuilder() { + return new ExpressionBuilder($this); + } + + /** + * Gets the QueryBuilder for the connection. + * + * @return \OCP\DB\IQueryBuilder + */ + public function getQueryBuilder() { + return new QueryBuilder($this); + } + /** * @return string */ diff --git a/lib/private/db/expressionbuilder.php b/lib/private/db/expressionbuilder.php new file mode 100644 index 00000000000..f042664d960 --- /dev/null +++ b/lib/private/db/expressionbuilder.php @@ -0,0 +1,282 @@ + + * + * @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 new file mode 100644 index 00000000000..9ae07aeb0fd --- /dev/null +++ b/lib/private/db/querybuilder.php @@ -0,0 +1,865 @@ + + * + * @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/public/db/icompositeexpression.php b/lib/public/db/icompositeexpression.php new file mode 100644 index 00000000000..123e4ca7cc6 --- /dev/null +++ b/lib/public/db/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; + +/** + * 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 new file mode 100644 index 00000000000..848a8a2f8f1 --- /dev/null +++ b/lib/public/db/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; + +/** + * 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 new file mode 100644 index 00000000000..24ca96c578d --- /dev/null +++ b/lib/public/db/iquerybuilder.php @@ -0,0 +1,742 @@ + + * + * @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/idbconnection.php b/lib/public/idbconnection.php index ebad3c1f693..a4be3acd2e2 100644 --- a/lib/public/idbconnection.php +++ b/lib/public/idbconnection.php @@ -40,6 +40,22 @@ namespace OCP; * @since 6.0.0 */ interface IDBConnection { + /** + * Gets the ExpressionBuilder for the connection. + * + * @return \OCP\DB\IExpressionBuilder + * @since 8.2.0 + */ + public function getExpressionBuilder(); + + /** + * Gets the QueryBuilder for the connection. + * + * @return \OCP\DB\IQueryBuilder + * @since 8.2.0 + */ + public function getQueryBuilder(); + /** * Used to abstract the ownCloud database access away * @param string $sql the sql query with ? placeholder for params From de348180ae257017a9a2af05dac72286bf262bed Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 6 Jul 2015 12:34:19 +0200 Subject: [PATCH 02/10] Use the public interface and our method instead of the doctrine thing --- apps/encryption/lib/migration.php | 14 +++++----- apps/encryption/tests/lib/MigrationTest.php | 24 ++++++++-------- apps/files_trashbin/command/cleanup.php | 4 +-- .../tests/command/cleanuptest.php | 8 +++--- lib/private/repair.php | 10 +++---- lib/private/share/share.php | 16 +++++------ lib/repair/cleantags.php | 10 +++---- lib/repair/dropoldtables.php | 8 +++--- lib/repair/filletags.php | 7 ++--- tests/lib/repair/cleantags.php | 14 +++++----- tests/lib/share/share.php | 28 +++++++++---------- 11 files changed, 71 insertions(+), 72 deletions(-) diff --git a/apps/encryption/lib/migration.php b/apps/encryption/lib/migration.php index e6887e8cc07..a4da05d7f06 100644 --- a/apps/encryption/lib/migration.php +++ b/apps/encryption/lib/migration.php @@ -23,9 +23,9 @@ namespace OCA\Encryption; -use OC\DB\Connection; use OC\Files\View; use OCP\IConfig; +use OCP\IDBConnection; use OCP\ILogger; class Migration { @@ -33,7 +33,7 @@ class Migration { private $moduleId; /** @var \OC\Files\View */ private $view; - /** @var \OC\DB\Connection */ + /** @var \OCP\IDBConnection */ private $connection; /** @var IConfig */ private $config; @@ -44,10 +44,10 @@ class Migration { /** * @param IConfig $config * @param View $view - * @param Connection $connection + * @param IDBConnection $connection * @param ILogger $logger */ - public function __construct(IConfig $config, View $view, Connection $connection, ILogger $logger) { + public function __construct(IConfig $config, View $view, IDBConnection $connection, ILogger $logger) { $this->view = $view; $this->view->getUpdater()->disable(); $this->connection = $connection; @@ -66,7 +66,7 @@ class Migration { * update file cache, copy unencrypted_size to the 'size' column */ private function updateFileCache() { - $query = $this->connection->createQueryBuilder(); + $query = $this->connection->getQueryBuilder(); $query->update('`*PREFIX*filecache`') ->set('`size`', '`unencrypted_size`') ->where($query->expr()->eq('`encrypted`', ':encrypted')) @@ -149,7 +149,7 @@ class Migration { $this->config->deleteAppValue('files_encryption', 'types'); $this->config->deleteAppValue('files_encryption', 'enabled'); - $oldAppValues = $this->connection->createQueryBuilder(); + $oldAppValues = $this->connection->getQueryBuilder(); $oldAppValues->select('*') ->from('`*PREFIX*appconfig`') ->where($oldAppValues->expr()->eq('`appid`', ':appid')) @@ -164,7 +164,7 @@ class Migration { } } - $oldPreferences = $this->connection->createQueryBuilder(); + $oldPreferences = $this->connection->getQueryBuilder(); $oldPreferences->select('*') ->from('`*PREFIX*preferences`') ->where($oldPreferences->expr()->eq('`appid`', ':appid')) diff --git a/apps/encryption/tests/lib/MigrationTest.php b/apps/encryption/tests/lib/MigrationTest.php index 6742de574bf..c0d8f081342 100644 --- a/apps/encryption/tests/lib/MigrationTest.php +++ b/apps/encryption/tests/lib/MigrationTest.php @@ -288,14 +288,14 @@ class MigrationTest extends \Test\TestCase { // delete default values set by the encryption app during initialization - /** @var \OC\DB\Connection $connection */ + /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->delete('`*PREFIX*appconfig`') ->where($query->expr()->eq('`appid`', ':appid')) ->setParameter('appid', 'encryption'); $query->execute(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->delete('`*PREFIX*preferences`') ->where($query->expr()->eq('`appid`', ':appid')) ->setParameter('appid', 'encryption'); @@ -368,9 +368,9 @@ class MigrationTest extends \Test\TestCase { } public function verifyDB($table, $appid, $expected) { - /** @var \OC\DB\Connection $connection */ + /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->select('`appid`') ->from($table) ->where($query->expr()->eq('`appid`', ':appid')) @@ -392,9 +392,9 @@ class MigrationTest extends \Test\TestCase { // check results - /** @var \OC\DB\Connection $connection */ + /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->select('*') ->from('`*PREFIX*filecache`'); $result = $query->execute(); @@ -411,17 +411,17 @@ class MigrationTest extends \Test\TestCase { } public function prepareFileCache() { - /** @var \OC\DB\Connection $connection */ + /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->delete('`*PREFIX*filecache`'); $query->execute(); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $result = $query->select('`fileid`') ->from('`*PREFIX*filecache`') ->setMaxResults(1)->execute()->fetchAll(); $this->assertEmpty($result); - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $query->insert('`*PREFIX*filecache`') ->values( array( @@ -442,7 +442,7 @@ class MigrationTest extends \Test\TestCase { $query->execute() ); } - $query = $connection->createQueryBuilder(); + $query = $connection->getQueryBuilder(); $result = $query->select('`fileid`') ->from('`*PREFIX*filecache`') ->execute()->fetchAll(); diff --git a/apps/files_trashbin/command/cleanup.php b/apps/files_trashbin/command/cleanup.php index 961f72763ea..de17020ea5c 100644 --- a/apps/files_trashbin/command/cleanup.php +++ b/apps/files_trashbin/command/cleanup.php @@ -38,7 +38,7 @@ class CleanUp extends Command { /** @var IRootFolder */ protected $rootFolder; - /** @var \OC\DB\Connection */ + /** @var \OCP\IDBConnection */ protected $dbConnection; /** @@ -107,7 +107,7 @@ class CleanUp extends Command { \OC_Util::setupFS($uid); if ($this->rootFolder->nodeExists('/' . $uid . '/files_trashbin')) { $this->rootFolder->get('/' . $uid . '/files_trashbin')->delete(); - $query = $this->dbConnection->createQueryBuilder(); + $query = $this->dbConnection->getQueryBuilder(); $query->delete('`*PREFIX*files_trash`') ->where($query->expr()->eq('`user`', ':uid')) ->setParameter('uid', $uid); diff --git a/apps/files_trashbin/tests/command/cleanuptest.php b/apps/files_trashbin/tests/command/cleanuptest.php index 6e2f78093e0..ecbaab98bf2 100644 --- a/apps/files_trashbin/tests/command/cleanuptest.php +++ b/apps/files_trashbin/tests/command/cleanuptest.php @@ -64,7 +64,7 @@ class CleanUpTest extends TestCase { * populate files_trash table with 10 dummy values */ public function initTable() { - $query = $this->dbConnection->createQueryBuilder(); + $query = $this->dbConnection->getQueryBuilder(); $query->delete($this->trashTable)->execute(); for ($i = 0; $i < 10; $i++) { $query->insert($this->trashTable) @@ -75,7 +75,7 @@ class CleanUpTest extends TestCase { '`user`' => $query->expr()->literal('user'.$i%2) ))->execute(); } - $getAllQuery = $this->dbConnection->createQueryBuilder(); + $getAllQuery = $this->dbConnection->getQueryBuilder(); $result = $getAllQuery->select('`id`')->from($this->trashTable)->execute()->fetchAll(); $this->assertSame(10, count($result)); } @@ -106,7 +106,7 @@ class CleanUpTest extends TestCase { if ($nodeExists) { // if the delete operation was execute only files from user1 // should be left. - $query = $this->dbConnection->createQueryBuilder(); + $query = $this->dbConnection->getQueryBuilder(); $result = $query->select('`user`') ->from($this->trashTable) ->execute()->fetchAll(); @@ -117,7 +117,7 @@ class CleanUpTest extends TestCase { } else { // if no delete operation was execute we should still have all 10 // database entries - $getAllQuery = $this->dbConnection->createQueryBuilder(); + $getAllQuery = $this->dbConnection->getQueryBuilder(); $result = $getAllQuery->select('`id`')->from($this->trashTable)->execute()->fetchAll(); $this->assertSame(10, count($result)); } diff --git a/lib/private/repair.php b/lib/private/repair.php index 166efd3eb8f..bf385af2c2b 100644 --- a/lib/private/repair.php +++ b/lib/private/repair.php @@ -103,14 +103,14 @@ class Repair extends BasicEmitter { public static function getRepairSteps() { return array( new RepairMimeTypes(), - new RepairLegacyStorages(\OC::$server->getConfig(), \OC_DB::getConnection()), + new RepairLegacyStorages(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()), new RepairConfig(), new AssetCache(), - new FillETags(\OC_DB::getConnection()), - new CleanTags(\OC_DB::getConnection()), - new DropOldTables(\OC_DB::getConnection()), + new FillETags(\OC::$server->getDatabaseConnection()), + new CleanTags(\OC::$server->getDatabaseConnection()), + new DropOldTables(\OC::$server->getDatabaseConnection()), new DropOldJobs(\OC::$server->getJobList()), - new RemoveGetETagEntries(\OC_DB::getConnection()), + new RemoveGetETagEntries(\OC::$server->getDatabaseConnection()), ); } diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 7fcbb695c68..e3364e0de0b 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -38,7 +38,7 @@ namespace OC\Share; use OCP\IUserSession; -use OC\DB\Connection; +use OCP\IDBConnection; use OCP\IConfig; /** @@ -1195,13 +1195,13 @@ class Share extends Constants { /** * Retrieve the owner of a connection * - * @param Connection $connection + * @param IDBConnection $connection * @param int $shareId * @throws \Exception * @return string uid of share owner */ - private static function getShareOwner(Connection $connection, $shareId) { - $qb = $connection->createQueryBuilder(); + private static function getShareOwner(IDBConnection $connection, $shareId) { + $qb = $connection->getQueryBuilder(); $qb->select('`uid_owner`') ->from('`*PREFIX*share`') @@ -1221,15 +1221,15 @@ class Share extends Constants { * Set expiration date for a share * * @param IUserSession $userSession - * @param Connection $connection + * @param IDBConnection $connection * @param IConfig $config * @param int $shareId * @param string $password * @throws \Exception * @return boolean */ - public static function setPassword(IUserSession $userSession, - Connection $connection, + public static function setPassword(IUserSession $userSession, + IDBConnection $connection, IConfig $config, $shareId, $password) { $user = $userSession->getUser(); @@ -1252,7 +1252,7 @@ class Share extends Constants { throw new \Exception('Cannot remove password'); } - $qb = $connection->createQueryBuilder(); + $qb = $connection->getQueryBuilder(); $qb->update('`*PREFIX*share`') ->set('`share_with`', ':pass') ->where('`id` = :shareId') diff --git a/lib/repair/cleantags.php b/lib/repair/cleantags.php index 7d2002427f8..ddd1a483016 100644 --- a/lib/repair/cleantags.php +++ b/lib/repair/cleantags.php @@ -22,9 +22,9 @@ namespace OC\Repair; -use OC\DB\Connection; use OC\Hooks\BasicEmitter; use OC\RepairStep; +use OCP\IDBConnection; /** * Class RepairConfig @@ -33,13 +33,13 @@ use OC\RepairStep; */ class CleanTags extends BasicEmitter implements RepairStep { - /** @var Connection */ + /** @var IDBConnection */ protected $connection; /** - * @param Connection $connection + * @param IDBConnection $connection */ - public function __construct(Connection $connection) { + public function __construct(IDBConnection $connection) { $this->connection = $connection; } @@ -108,7 +108,7 @@ class CleanTags extends BasicEmitter implements RepairStep { * the entry is deleted in the $deleteTable */ protected function deleteOrphanEntries($repairInfo, $deleteTable, $deleteId, $sourceTable, $sourceId, $sourceNullColumn) { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $qb->select('d.`' . $deleteId . '`') ->from('`' . $deleteTable . '`', 'd') diff --git a/lib/repair/dropoldtables.php b/lib/repair/dropoldtables.php index 9afd9698e04..cfe0df6cb5b 100644 --- a/lib/repair/dropoldtables.php +++ b/lib/repair/dropoldtables.php @@ -22,19 +22,19 @@ namespace OC\Repair; -use OC\DB\Connection; use OC\Hooks\BasicEmitter; use OC\RepairStep; +use OCP\IDBConnection; class DropOldTables extends BasicEmitter implements RepairStep { - /** @var Connection */ + /** @var IDBConnection */ protected $connection; /** - * @param Connection $connection + * @param IDBConnection $connection */ - public function __construct(Connection $connection) { + public function __construct(IDBConnection $connection) { $this->connection = $connection; } diff --git a/lib/repair/filletags.php b/lib/repair/filletags.php index 501a18d0b4a..a46c951efaf 100644 --- a/lib/repair/filletags.php +++ b/lib/repair/filletags.php @@ -22,16 +22,15 @@ namespace OC\Repair; -use Doctrine\DBAL\Query\QueryBuilder; use OC\Hooks\BasicEmitter; class FillETags extends BasicEmitter implements \OC\RepairStep { - /** @var \OC\DB\Connection */ + /** @var \OCP\IDBConnection */ protected $connection; /** - * @param \OC\DB\Connection $connection + * @param \OCP\IDBConnection $connection */ public function __construct($connection) { $this->connection = $connection; @@ -42,7 +41,7 @@ class FillETags extends BasicEmitter implements \OC\RepairStep { } public function run() { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $qb->update('`*PREFIX*filecache`') ->set('`etag`', $qb->expr()->literal('xxx')) ->where($qb->expr()->eq('`etag`', $qb->expr()->literal(''))) diff --git a/tests/lib/repair/cleantags.php b/tests/lib/repair/cleantags.php index b455aa870fb..fc9b21d4636 100644 --- a/tests/lib/repair/cleantags.php +++ b/tests/lib/repair/cleantags.php @@ -18,7 +18,7 @@ class CleanTags extends \Test\TestCase { /** @var \OC\RepairStep */ protected $repair; - /** @var \Doctrine\DBAL\Connection */ + /** @var \OCP\IDBConnection */ protected $connection; /** @var int */ @@ -39,7 +39,7 @@ class CleanTags extends \Test\TestCase { } protected function cleanUpTables() { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $qb->delete('`*PREFIX*vcategory`') ->execute(); @@ -83,7 +83,7 @@ class CleanTags extends \Test\TestCase { * @param string $message */ protected function assertEntryCount($tableName, $expected, $message = '') { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $result = $qb->select('COUNT(*)') ->from('`' . $tableName . '`') ->execute(); @@ -99,7 +99,7 @@ class CleanTags extends \Test\TestCase { * @return int */ protected function addTagCategory($category, $type) { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $qb->insert('`*PREFIX*vcategory`') ->values([ '`uid`' => $qb->createNamedParameter('TestRepairCleanTags'), @@ -118,7 +118,7 @@ class CleanTags extends \Test\TestCase { * @param string $type */ protected function addTagEntry($objectId, $category, $type) { - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $qb->insert('`*PREFIX*vcategory_to_object`') ->values([ '`objid`' => $qb->createNamedParameter($objectId, \PDO::PARAM_INT), @@ -137,7 +137,7 @@ class CleanTags extends \Test\TestCase { return $this->createdFile; } - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); // We create a new file entry and delete it after the test again $fileName = $this->getUniqueID('TestRepairCleanTags', 12); @@ -174,7 +174,7 @@ class CleanTags extends \Test\TestCase { // FIXME INSTEAD HELP FIXING DOCTRINE // FIXME https://github.com/owncloud/core/issues/13303 // FIXME ALSO FIX https://github.com/owncloud/core/commit/2dd85ec984c12d3be401518f22c90d2327bec07a - $qb = $this->connection->createQueryBuilder(); + $qb = $this->connection->getQueryBuilder(); $result = $qb->select("MAX($idName)") ->from($tableName) ->execute(); diff --git a/tests/lib/share/share.php b/tests/lib/share/share.php index e225f2a4002..e57dd43f839 100644 --- a/tests/lib/share/share.php +++ b/tests/lib/share/share.php @@ -1286,7 +1286,7 @@ class Test_Share extends \Test\TestCase { ->getMock(); // Find the share ID in the db - $qb = $connection->createQueryBuilder(); + $qb = $connection->getQueryBuilder(); $qb->select('`id`') ->from('`*PREFIX*share`') ->where('`item_type` = :type') @@ -1307,7 +1307,7 @@ class Test_Share extends \Test\TestCase { $this->assertTrue($res); // Fetch the hash from the database - $qb = $connection->createQueryBuilder(); + $qb = $connection->getQueryBuilder(); $qb->select('`share_with`') ->from('`*PREFIX*share`') ->where('`id` = :id') @@ -1335,10 +1335,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\Doctrine\DBAL\Query\Expression\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\Doctrine\DBAL\Query\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1360,7 +1360,7 @@ class Test_Share extends \Test\TestCase { $connection = $this->getMockBuilder('\OC\DB\Connection') ->disableOriginalConstructor() ->getMock(); - $connection->method('createQueryBuilder')->willReturn($qb); + $connection->method('getQueryBuilder')->willReturn($qb); $config = $this->getMockBuilder('\OCP\IConfig') ->disableOriginalConstructor() @@ -1390,10 +1390,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\Doctrine\DBAL\Query\Expression\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\Doctrine\DBAL\Query\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1415,7 +1415,7 @@ class Test_Share extends \Test\TestCase { $connection = $this->getMockBuilder('\OC\DB\Connection') ->disableOriginalConstructor() ->getMock(); - $connection->method('createQueryBuilder')->willReturn($qb); + $connection->method('getQueryBuilder')->willReturn($qb); $config = $this->getMockBuilder('\OCP\IConfig') ->disableOriginalConstructor() @@ -1443,10 +1443,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\Doctrine\DBAL\Query\Expression\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\Doctrine\DBAL\Query\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1468,7 +1468,7 @@ class Test_Share extends \Test\TestCase { $connection = $this->getMockBuilder('\OC\DB\Connection') ->disableOriginalConstructor() ->getMock(); - $connection->method('createQueryBuilder')->willReturn($qb); + $connection->method('getQueryBuilder')->willReturn($qb); $config = $this->getMockBuilder('\OCP\IConfig') ->disableOriginalConstructor() @@ -1496,10 +1496,10 @@ class Test_Share extends \Test\TestCase { $userSession->method('getUser')->willReturn($user); - $ex = $this->getMockBuilder('\Doctrine\DBAL\Query\Expression\ExpressionBuilder') + $ex = $this->getMockBuilder('\OC\DB\ExpressionBuilder') ->disableOriginalConstructor() ->getMock(); - $qb = $this->getMockBuilder('\Doctrine\DBAL\Query\QueryBuilder') + $qb = $this->getMockBuilder('\OC\DB\QueryBuilder') ->disableOriginalConstructor() ->getMock(); $qb->method('update')->will($this->returnSelf()); @@ -1521,7 +1521,7 @@ class Test_Share extends \Test\TestCase { $connection = $this->getMockBuilder('\OC\DB\Connection') ->disableOriginalConstructor() ->getMock(); - $connection->method('createQueryBuilder')->willReturn($qb); + $connection->method('getQueryBuilder')->willReturn($qb); $config = $this->getMockBuilder('\OCP\IConfig') ->disableOriginalConstructor() From 516f7e8299c309ed909259c90c23cb0ce6a8e4f7 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 7 Jul 2015 17:30:26 +0200 Subject: [PATCH 03/10] Add unit tests and automatic quoting --- lib/private/appframework/db/db.php | 4 +- lib/private/db/connection.php | 6 +- .../compositeexpression.php | 8 +- .../{ => querybuilder}/expressionbuilder.php | 46 +- lib/private/db/querybuilder/literal.php | 40 + lib/private/db/querybuilder/parameter.php | 40 + .../db/{ => querybuilder}/querybuilder.php | 276 +++-- lib/private/db/querybuilder/queryfunction.php | 40 + lib/private/db/querybuilder/quotehelper.php | 75 ++ .../icompositeexpression.php | 2 +- .../{ => querybuilder}/iexpressionbuilder.php | 6 +- lib/public/db/querybuilder/iliteral.php | 29 + lib/public/db/querybuilder/iparameter.php | 29 + .../db/{ => querybuilder}/iquerybuilder.php | 126 ++- lib/public/db/querybuilder/iqueryfunction.php | 29 + lib/public/idbconnection.php | 4 +- .../db/querybuilder/expressionbuildertest.php | 338 +++++++ .../lib/db/querybuilder/querybuildertest.php | 941 ++++++++++++++++++ tests/lib/db/querybuilder/quotehelpertest.php | 141 +++ tests/lib/share/share.php | 16 +- 20 files changed, 2039 insertions(+), 157 deletions(-) rename lib/private/db/{ => querybuilder}/compositeexpression.php (92%) rename lib/private/db/{ => querybuilder}/expressionbuilder.php (84%) create mode 100644 lib/private/db/querybuilder/literal.php create mode 100644 lib/private/db/querybuilder/parameter.php rename lib/private/db/{ => querybuilder}/querybuilder.php (75%) create mode 100644 lib/private/db/querybuilder/queryfunction.php create mode 100644 lib/private/db/querybuilder/quotehelper.php rename lib/public/db/{ => querybuilder}/icompositeexpression.php (98%) rename lib/public/db/{ => querybuilder}/iexpressionbuilder.php (98%) create mode 100644 lib/public/db/querybuilder/iliteral.php create mode 100644 lib/public/db/querybuilder/iparameter.php rename lib/public/db/{ => querybuilder}/iquerybuilder.php (84%) 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/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/compositeexpression.php b/lib/private/db/querybuilder/compositeexpression.php similarity index 92% rename from lib/private/db/compositeexpression.php rename to lib/private/db/querybuilder/compositeexpression.php index cc57c524369..523f397e235 100644 --- a/lib/private/db/compositeexpression.php +++ b/lib/private/db/querybuilder/compositeexpression.php @@ -19,9 +19,9 @@ * */ -namespace OC\DB; +namespace OC\DB\QueryBuilder; -use OCP\DB\ICompositeExpression; +use OCP\DB\QueryBuilder\ICompositeExpression; class CompositeExpression implements ICompositeExpression, \Countable { /** @var \Doctrine\DBAL\Query\Expression\CompositeExpression */ @@ -41,7 +41,7 @@ class CompositeExpression implements ICompositeExpression, \Countable { * * @param array $parts * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression */ public function addMultiple(array $parts = array()) { $this->compositeExpression->addMultiple($parts); @@ -54,7 +54,7 @@ class CompositeExpression implements ICompositeExpression, \Countable { * * @param mixed $part * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression */ public function add($part) { $this->compositeExpression->add($part); diff --git a/lib/private/db/expressionbuilder.php b/lib/private/db/querybuilder/expressionbuilder.php similarity index 84% rename from lib/private/db/expressionbuilder.php rename to lib/private/db/querybuilder/expressionbuilder.php index f042664d960..cd5b7fbfc54 100644 --- a/lib/private/db/expressionbuilder.php +++ b/lib/private/db/querybuilder/expressionbuilder.php @@ -19,22 +19,26 @@ * */ -namespace OC\DB; +namespace OC\DB\QueryBuilder; use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder; -use OCP\DB\IExpressionBuilder; +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); } @@ -50,10 +54,11 @@ class ExpressionBuilder implements IExpressionBuilder { * @param mixed $x Optional clause. Defaults = null, but requires * at least one defined when converting to string. * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression */ public function andX($x = null) { - $compositeExpression = call_user_func_array([$this->expressionBuilder, 'andX'], func_get_args()); + $arguments = func_get_args(); + $compositeExpression = call_user_func_array([$this->expressionBuilder, 'andX'], $arguments); return new CompositeExpression($compositeExpression); } @@ -69,10 +74,11 @@ class ExpressionBuilder implements IExpressionBuilder { * @param mixed $x Optional clause. Defaults = null, but requires * at least one defined when converting to string. * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression */ public function orX($x = null) { - $compositeExpression = call_user_func_array([$this->expressionBuilder, 'orX'], func_get_args()); + $arguments = func_get_args(); + $compositeExpression = call_user_func_array([$this->expressionBuilder, 'orX'], $arguments); return new CompositeExpression($compositeExpression); } @@ -86,6 +92,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @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); } @@ -105,6 +113,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function eq($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->eq($x, $y); } @@ -123,6 +133,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function neq($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->neq($x, $y); } @@ -141,6 +153,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function lt($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->lt($x, $y); } @@ -159,6 +173,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function lte($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->lte($x, $y); } @@ -177,6 +193,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function gt($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->gt($x, $y); } @@ -195,6 +213,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function gte($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->gte($x, $y); } @@ -206,6 +226,7 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function isNull($x) { + $x = $this->helper->quoteColumnName($x); return $this->expressionBuilder->isNull($x); } @@ -217,6 +238,7 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function isNotNull($x) { + $x = $this->helper->quoteColumnName($x); return $this->expressionBuilder->isNotNull($x); } @@ -229,6 +251,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function like($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->like($x, $y); } @@ -241,6 +265,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function notLike($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->notLike($x, $y); } @@ -253,6 +279,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function in($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnNames($y); return $this->expressionBuilder->in($x, $y); } @@ -265,6 +293,8 @@ class ExpressionBuilder implements IExpressionBuilder { * @return string */ public function notIn($x, $y) { + $x = $this->helper->quoteColumnName($x); + $y = $this->helper->quoteColumnNames($y); return $this->expressionBuilder->notIn($x, $y); } @@ -274,9 +304,9 @@ class ExpressionBuilder implements IExpressionBuilder { * @param mixed $input The parameter to be quoted. * @param string|null $type The type of the parameter. * - * @return string + * @return Literal */ public function literal($input, $type = null) { - return $this->expressionBuilder->literal($input, $type); + 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.php b/lib/private/db/querybuilder/querybuilder.php similarity index 75% rename from lib/private/db/querybuilder.php rename to lib/private/db/querybuilder/querybuilder.php index 9ae07aeb0fd..fbb2b07bade 100644 --- a/lib/private/db/querybuilder.php +++ b/lib/private/db/querybuilder/querybuilder.php @@ -19,9 +19,11 @@ * */ -namespace OC\DB; +namespace OC\DB\QueryBuilder; -use OCP\DB\IQueryBuilder; +use OCP\DB\QueryBuilder\IQueryBuilder; +use OCP\DB\QueryBuilder\IQueryFunction; +use OCP\DB\QueryBuilder\IParameter; use OCP\IDBConnection; class QueryBuilder implements IQueryBuilder { @@ -32,15 +34,18 @@ class QueryBuilder implements IQueryBuilder { /** @var \Doctrine\DBAL\Query\QueryBuilder */ private $queryBuilder; + /** @var QuoteHelper */ + private $helper; + /** * Initializes a new QueryBuilder. * * @var \OCP\IDBConnection */ - public function __construct(IDBConnection $connection) - { + public function __construct(IDBConnection $connection) { $this->connection = $connection; $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection); + $this->helper = new QuoteHelper(); } /** @@ -57,7 +62,7 @@ class QueryBuilder implements IQueryBuilder { * For more complex expression construction, consider storing the expression * builder object in a local variable. * - * @return \OCP\DB\IExpressionBuilder + * @return \OCP\DB\QueryBuilder\IExpressionBuilder */ public function expr() { return $this->connection->getExpressionBuilder(); @@ -133,7 +138,7 @@ class QueryBuilder implements IQueryBuilder { * @param mixed $value The parameter value. * @param string|null $type One of the PDO::PARAM_* constants. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function setParameter($key, $value, $type = null) { $this->queryBuilder->setParameter($key, $value, $type); @@ -158,7 +163,7 @@ class QueryBuilder implements IQueryBuilder { * @param array $params The query parameters to set. * @param array $types The query parameters types to set. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function setParameters(array $params, array $types = array()) { $this->queryBuilder->setParameters($params, $types); @@ -211,7 +216,7 @@ class QueryBuilder implements IQueryBuilder { * * @param integer $firstResult The first result to return. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function setFirstResult($firstResult) { $this->queryBuilder->setFirstResult($firstResult); @@ -234,7 +239,7 @@ class QueryBuilder implements IQueryBuilder { * * @param integer $maxResults The maximum number of results to retrieve. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function setMaxResults($maxResults) { $this->queryBuilder->setMaxResults($maxResults); @@ -252,24 +257,6 @@ class QueryBuilder implements IQueryBuilder { 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. @@ -283,10 +270,14 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $select The selection expressions. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function select($select = null) { - $this->queryBuilder->select($select); + $selects = is_array($select) ? $select : func_get_args(); + + $this->queryBuilder->select( + $this->helper->quoteColumnNames($selects) + ); return $this; } @@ -304,10 +295,14 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $select The selection expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function addSelect($select = null) { - $this->queryBuilder->addSelect($select); + $selects = is_array($select) ? $select : func_get_args(); + + $this->queryBuilder->addSelect( + $this->helper->quoteColumnNames($selects) + ); return $this; } @@ -326,10 +321,13 @@ class QueryBuilder implements IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function delete($delete = null, $alias = null) { - $this->queryBuilder->delete($delete, $alias); + $this->queryBuilder->delete( + $this->helper->quoteColumnName($delete), + $alias + ); return $this; } @@ -348,10 +346,13 @@ class QueryBuilder implements IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function update($update = null, $alias = null) { - $this->queryBuilder->update($update, $alias); + $this->queryBuilder->update( + $this->helper->quoteColumnName($update), + $alias + ); return $this; } @@ -373,10 +374,12 @@ class QueryBuilder implements IQueryBuilder { * * @param string $insert The table into which the rows should be inserted. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function insert($insert = null) { - $this->queryBuilder->insert($insert); + $this->queryBuilder->insert( + $this->helper->quoteColumnName($insert) + ); return $this; } @@ -394,10 +397,13 @@ class QueryBuilder implements IQueryBuilder { * @param string $from The table. * @param string|null $alias The alias of the table. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function from($from, $alias = null) { - $this->queryBuilder->from($from, $alias); + $this->queryBuilder->from( + $this->helper->quoteColumnName($from), + $alias + ); return $this; } @@ -417,10 +423,15 @@ class QueryBuilder implements IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function join($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->join($fromAlias, $join, $alias, $condition); + $this->queryBuilder->join( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); return $this; } @@ -440,10 +451,15 @@ class QueryBuilder implements IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function innerJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->innerJoin($fromAlias, $join, $alias, $condition); + $this->queryBuilder->innerJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); return $this; } @@ -463,10 +479,15 @@ class QueryBuilder implements IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function leftJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->leftJoin($fromAlias, $join, $alias, $condition); + $this->queryBuilder->leftJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); return $this; } @@ -486,10 +507,15 @@ class QueryBuilder implements IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function rightJoin($fromAlias, $join, $alias, $condition = null) { - $this->queryBuilder->rightJoin($fromAlias, $join, $alias, $condition); + $this->queryBuilder->rightJoin( + $fromAlias, + $this->helper->quoteColumnName($join), + $alias, + $condition + ); return $this; } @@ -507,10 +533,13 @@ class QueryBuilder implements IQueryBuilder { * @param string $key The column to set. * @param string $value The value, expression, placeholder, etc. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function set($key, $value) { - $this->queryBuilder->set($key, $value); + $this->queryBuilder->set( + $this->helper->quoteColumnName($key), + $this->helper->quoteColumnName($value) + ); return $this; } @@ -539,10 +568,13 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $predicates The restriction predicates. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function where($predicates) { - call_user_func_array([$this->queryBuilder, 'where'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'where'], + func_get_args() + ); return $this; } @@ -561,12 +593,15 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $where The query restrictions. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * * @see where() */ public function andWhere($where) { - call_user_func_array([$this->queryBuilder, 'andWhere'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'andWhere'], + func_get_args() + ); return $this; } @@ -585,12 +620,15 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $where The WHERE statement. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * * @see where() */ public function orWhere($where) { - call_user_func_array([$this->queryBuilder, 'orWhere'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'orWhere'], + func_get_args() + ); return $this; } @@ -608,10 +646,15 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $groupBy The grouping expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function groupBy($groupBy) { - call_user_func_array([$this->queryBuilder, 'groupBy'], func_get_args()); + $groupBys = is_array($groupBy) ? $groupBy : func_get_args(); + + call_user_func_array( + [$this->queryBuilder, 'groupBy'], + $this->helper->quoteColumnNames($groupBys) + ); return $this; } @@ -629,10 +672,15 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $groupBy The grouping expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function addGroupBy($groupBy) { - call_user_func_array([$this->queryBuilder, 'addGroupBy'], func_get_args()); + $groupBys = is_array($groupBy) ? $groupBy : func_get_args(); + + call_user_func_array( + [$this->queryBuilder, 'addGroupBy'], + $this->helper->quoteColumnNames($groupBys) + ); return $this; } @@ -654,10 +702,13 @@ class QueryBuilder implements IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function setValue($column, $value) { - $this->queryBuilder->setValue($column, $value); + $this->queryBuilder->setValue( + $this->helper->quoteColumnName($column), + $value + ); return $this; } @@ -679,10 +730,15 @@ class QueryBuilder implements IQueryBuilder { * * @param array $values The values to specify for the insert query indexed by column names. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function values(array $values) { - $this->queryBuilder->values($values); + $quotedValues = []; + foreach ($values as $key => $value) { + $quotedValues[$this->helper->quoteColumnName($key)] = $value; + } + + $this->queryBuilder->values($quotedValues); return $this; } @@ -693,10 +749,13 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $having The restriction over the groups. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function having($having) { - call_user_func_array([$this->queryBuilder, 'having'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'having'], + func_get_args() + ); return $this; } @@ -707,10 +766,13 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $having The restriction to append. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function andHaving($having) { - call_user_func_array([$this->queryBuilder, 'andHaving'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'andHaving'], + func_get_args() + ); return $this; } @@ -721,10 +783,13 @@ class QueryBuilder implements IQueryBuilder { * * @param mixed $having The restriction to add. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function orHaving($having) { - call_user_func_array([$this->queryBuilder, 'orHaving'], func_get_args()); + call_user_func_array( + [$this->queryBuilder, 'orHaving'], + func_get_args() + ); return $this; } @@ -736,10 +801,13 @@ class QueryBuilder implements IQueryBuilder { * @param string $sort The ordering expression. * @param string $order The ordering direction. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function orderBy($sort, $order = null) { - $this->queryBuilder->orderBy($sort, $order); + $this->queryBuilder->orderBy( + $this->helper->quoteColumnName($sort), + $order + ); return $this; } @@ -750,10 +818,13 @@ class QueryBuilder implements IQueryBuilder { * @param string $sort The ordering expression. * @param string $order The ordering direction. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function addOrderBy($sort, $order = null) { - $this->queryBuilder->addOrderBy($sort, $order); + $this->queryBuilder->addOrderBy( + $this->helper->quoteColumnName($sort), + $order + ); return $this; } @@ -783,7 +854,7 @@ class QueryBuilder implements IQueryBuilder { * * @param array|null $queryPartNames * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function resetQueryParts($queryPartNames = null) { $this->queryBuilder->resetQueryParts($queryPartNames); @@ -796,7 +867,7 @@ class QueryBuilder implements IQueryBuilder { * * @param string $queryPartName * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. */ public function resetQueryPart($queryPartName) { $this->queryBuilder->resetQueryPart($queryPartName); @@ -831,10 +902,10 @@ class QueryBuilder implements IQueryBuilder { * @param mixed $type * @param string $placeHolder The name to bind with. The string must start with a colon ':'. * - * @return string the placeholder name used. + * @return IParameter the placeholder name used. */ public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null) { - return $this->queryBuilder->createNamedParameter($value, $type, $placeHolder); + return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder)); } /** @@ -857,9 +928,56 @@ class QueryBuilder implements IQueryBuilder { * @param mixed $value * @param integer $type * - * @return string + * @return IParameter */ public function createPositionalParameter($value, $type = \PDO::PARAM_STR) { - return $this->queryBuilder->createPositionalParameter($value, $type); + 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/querybuilder/icompositeexpression.php similarity index 98% rename from lib/public/db/icompositeexpression.php rename to lib/public/db/querybuilder/icompositeexpression.php index 123e4ca7cc6..439c0ab20a8 100644 --- a/lib/public/db/icompositeexpression.php +++ b/lib/public/db/querybuilder/icompositeexpression.php @@ -19,7 +19,7 @@ * */ -namespace OCP\DB; +namespace OCP\DB\QueryBuilder; /** * This class provides a wrapper around Doctrine's CompositeExpression diff --git a/lib/public/db/iexpressionbuilder.php b/lib/public/db/querybuilder/iexpressionbuilder.php similarity index 98% rename from lib/public/db/iexpressionbuilder.php rename to lib/public/db/querybuilder/iexpressionbuilder.php index 848a8a2f8f1..d719f07ebd4 100644 --- a/lib/public/db/iexpressionbuilder.php +++ b/lib/public/db/querybuilder/iexpressionbuilder.php @@ -19,7 +19,7 @@ * */ -namespace OCP\DB; +namespace OCP\DB\QueryBuilder; /** * This class provides a wrapper around Doctrine's ExpressionBuilder @@ -38,7 +38,7 @@ interface IExpressionBuilder { * @param mixed $x Optional clause. Defaults = null, but requires * at least one defined when converting to string. * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression * @since 8.2.0 */ public function andX($x = null); @@ -55,7 +55,7 @@ interface IExpressionBuilder { * @param mixed $x Optional clause. Defaults = null, but requires * at least one defined when converting to string. * - * @return \OCP\DB\ICompositeExpression + * @return \OCP\DB\QueryBuilder\ICompositeExpression * @since 8.2.0 */ public function orX($x = 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/iquerybuilder.php b/lib/public/db/querybuilder/iquerybuilder.php similarity index 84% rename from lib/public/db/iquerybuilder.php rename to lib/public/db/querybuilder/iquerybuilder.php index 24ca96c578d..09d5d199bef 100644 --- a/lib/public/db/iquerybuilder.php +++ b/lib/public/db/querybuilder/iquerybuilder.php @@ -19,7 +19,7 @@ * */ -namespace OCP\DB; +namespace OCP\DB\QueryBuilder; /** * This class provides a wrapper around Doctrine's QueryBuilder @@ -40,7 +40,7 @@ interface IQueryBuilder { * For more complex expression construction, consider storing the expression * builder object in a local variable. * - * @return \OCP\DB\IExpressionBuilder + * @return \OCP\DB\QueryBuilder\IExpressionBuilder * @since 8.2.0 */ public function expr(); @@ -110,7 +110,7 @@ interface IQueryBuilder { * @param mixed $value The parameter value. * @param string|null $type One of the PDO::PARAM_* constants. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function setParameter($key, $value, $type = null); @@ -132,7 +132,7 @@ interface IQueryBuilder { * @param array $params The query parameters to set. * @param array $types The query parameters types to set. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function setParameters(array $params, array $types = array()); @@ -178,7 +178,7 @@ interface IQueryBuilder { * * @param integer $firstResult The first result to return. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function setFirstResult($firstResult); @@ -197,7 +197,7 @@ interface IQueryBuilder { * * @param integer $maxResults The maximum number of results to retrieve. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function setMaxResults($maxResults); @@ -211,21 +211,6 @@ interface IQueryBuilder { */ 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. @@ -239,7 +224,7 @@ interface IQueryBuilder { * * @param mixed $select The selection expressions. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function select($select = null); @@ -257,7 +242,7 @@ interface IQueryBuilder { * * @param mixed $select The selection expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function addSelect($select = null); @@ -276,7 +261,7 @@ interface IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function delete($delete = null, $alias = null); @@ -295,7 +280,7 @@ interface IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function update($update = null, $alias = null); @@ -317,7 +302,7 @@ interface IQueryBuilder { * * @param string $insert The table into which the rows should be inserted. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function insert($insert = null); @@ -335,7 +320,7 @@ interface IQueryBuilder { * @param string $from The table. * @param string|null $alias The alias of the table. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function from($from, $alias = null); @@ -355,7 +340,7 @@ interface IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function join($fromAlias, $join, $alias, $condition = null); @@ -375,7 +360,7 @@ interface IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function innerJoin($fromAlias, $join, $alias, $condition = null); @@ -395,7 +380,7 @@ interface IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function leftJoin($fromAlias, $join, $alias, $condition = null); @@ -415,7 +400,7 @@ interface IQueryBuilder { * @param string $alias The alias of the join table. * @param string $condition The condition for the join. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function rightJoin($fromAlias, $join, $alias, $condition = null); @@ -433,7 +418,7 @@ interface IQueryBuilder { * @param string $key The column to set. * @param string $value The value, expression, placeholder, etc. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function set($key, $value); @@ -462,7 +447,7 @@ interface IQueryBuilder { * * @param mixed $predicates The restriction predicates. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function where($predicates); @@ -481,7 +466,7 @@ interface IQueryBuilder { * * @param mixed $where The query restrictions. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * * @see where() * @since 8.2.0 @@ -502,7 +487,7 @@ interface IQueryBuilder { * * @param mixed $where The WHERE statement. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * * @see where() * @since 8.2.0 @@ -522,7 +507,7 @@ interface IQueryBuilder { * * @param mixed $groupBy The grouping expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function groupBy($groupBy); @@ -540,7 +525,7 @@ interface IQueryBuilder { * * @param mixed $groupBy The grouping expression. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function addGroupBy($groupBy); @@ -562,7 +547,7 @@ interface IQueryBuilder { * @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. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function setValue($column, $value); @@ -584,7 +569,7 @@ interface IQueryBuilder { * * @param array $values The values to specify for the insert query indexed by column names. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function values(array $values); @@ -595,7 +580,7 @@ interface IQueryBuilder { * * @param mixed $having The restriction over the groups. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function having($having); @@ -606,7 +591,7 @@ interface IQueryBuilder { * * @param mixed $having The restriction to append. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function andHaving($having); @@ -617,7 +602,7 @@ interface IQueryBuilder { * * @param mixed $having The restriction to add. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function orHaving($having); @@ -629,7 +614,7 @@ interface IQueryBuilder { * @param string $sort The ordering expression. * @param string $order The ordering direction. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function orderBy($sort, $order = null); @@ -640,7 +625,7 @@ interface IQueryBuilder { * @param string $sort The ordering expression. * @param string $order The ordering direction. * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function addOrderBy($sort, $order = null); @@ -668,7 +653,7 @@ interface IQueryBuilder { * * @param array|null $queryPartNames * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function resetQueryParts($queryPartNames = null); @@ -678,7 +663,7 @@ interface IQueryBuilder { * * @param string $queryPartName * - * @return \OCP\DB\IQueryBuilder This QueryBuilder instance. + * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. * @since 8.2.0 */ public function resetQueryPart($queryPartName); @@ -710,7 +695,7 @@ interface IQueryBuilder { * @param mixed $type * @param string $placeHolder The name to bind with. The string must start with a colon ':'. * - * @return string the placeholder name used. + * @return IParameter * @since 8.2.0 */ public function createNamedParameter($value, $type = \PDO::PARAM_STR, $placeHolder = null); @@ -735,8 +720,53 @@ interface IQueryBuilder { * @param mixed $value * @param integer $type * - * @return string + * @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()); From f77e5f411dda91a7c4fc70c090825a036b7b1135 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 7 Jul 2015 22:08:21 +0200 Subject: [PATCH 04/10] Fix existing usages by removing the quotes --- apps/encryption/lib/migration.php | 14 ++-- apps/encryption/tests/lib/MigrationTest.php | 74 +++++++++---------- apps/files_trashbin/command/cleanup.php | 4 +- .../tests/command/cleanuptest.php | 22 ++++-- lib/private/share/share.php | 12 +-- lib/repair/cleantags.php | 16 ++-- lib/repair/filletags.php | 8 +- tests/lib/repair/cleantags.php | 44 +++++------ tests/lib/share/share.php | 18 ++--- 9 files changed, 109 insertions(+), 103 deletions(-) diff --git a/apps/encryption/lib/migration.php b/apps/encryption/lib/migration.php index a4da05d7f06..789f5f77757 100644 --- a/apps/encryption/lib/migration.php +++ b/apps/encryption/lib/migration.php @@ -67,9 +67,9 @@ class Migration { */ private function updateFileCache() { $query = $this->connection->getQueryBuilder(); - $query->update('`*PREFIX*filecache`') - ->set('`size`', '`unencrypted_size`') - ->where($query->expr()->eq('`encrypted`', ':encrypted')) + $query->update('*PREFIX*filecache') + ->set('size', 'unencrypted_size') + ->where($query->expr()->eq('encrypted', $query->createParameter('encrypted'))) ->setParameter('encrypted', 1); $query->execute(); } @@ -151,8 +151,8 @@ class Migration { $oldAppValues = $this->connection->getQueryBuilder(); $oldAppValues->select('*') - ->from('`*PREFIX*appconfig`') - ->where($oldAppValues->expr()->eq('`appid`', ':appid')) + ->from('*PREFIX*appconfig') + ->where($oldAppValues->expr()->eq('appid', $oldAppValues->createParameter('appid'))) ->setParameter('appid', 'files_encryption'); $appSettings = $oldAppValues->execute(); @@ -166,8 +166,8 @@ class Migration { $oldPreferences = $this->connection->getQueryBuilder(); $oldPreferences->select('*') - ->from('`*PREFIX*preferences`') - ->where($oldPreferences->expr()->eq('`appid`', ':appid')) + ->from('*PREFIX*preferences') + ->where($oldPreferences->expr()->eq('appid', $oldPreferences->createParameter('appid'))) ->setParameter('appid', 'files_encryption'); $preferenceSettings = $oldPreferences->execute(); diff --git a/apps/encryption/tests/lib/MigrationTest.php b/apps/encryption/tests/lib/MigrationTest.php index c0d8f081342..a05418c5f26 100644 --- a/apps/encryption/tests/lib/MigrationTest.php +++ b/apps/encryption/tests/lib/MigrationTest.php @@ -291,13 +291,13 @@ class MigrationTest extends \Test\TestCase { /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); $query = $connection->getQueryBuilder(); - $query->delete('`*PREFIX*appconfig`') - ->where($query->expr()->eq('`appid`', ':appid')) + $query->delete('*PREFIX*appconfig') + ->where($query->expr()->eq('appid', $query->createParameter('appid'))) ->setParameter('appid', 'encryption'); $query->execute(); $query = $connection->getQueryBuilder(); - $query->delete('`*PREFIX*preferences`') - ->where($query->expr()->eq('`appid`', ':appid')) + $query->delete('*PREFIX*preferences') + ->where($query->expr()->eq('appid', $query->createParameter('appid'))) ->setParameter('appid', 'encryption'); $query->execute(); } @@ -308,10 +308,10 @@ class MigrationTest extends \Test\TestCase { $m = new Migration(\OC::$server->getConfig(), new \OC\Files\View(), \OC::$server->getDatabaseConnection(), $this->logger); $m->updateDB(); - $this->verifyDB('`*PREFIX*appconfig`', 'files_encryption', 0); - $this->verifyDB('`*PREFIX*preferences`', 'files_encryption', 0); - $this->verifyDB('`*PREFIX*appconfig`', 'encryption', 3); - $this->verifyDB('`*PREFIX*preferences`', 'encryption', 1); + $this->verifyDB('*PREFIX*appconfig', 'files_encryption', 0); + $this->verifyDB('*PREFIX*preferences', 'files_encryption', 0); + $this->verifyDB('*PREFIX*appconfig', 'encryption', 3); + $this->verifyDB('*PREFIX*preferences', 'encryption', 1); } @@ -327,20 +327,20 @@ class MigrationTest extends \Test\TestCase { $m = new Migration(\OC::$server->getConfig(), new \OC\Files\View(), \OC::$server->getDatabaseConnection(), $this->logger); $m->updateDB(); - $this->verifyDB('`*PREFIX*appconfig`', 'files_encryption', 0); - $this->verifyDB('`*PREFIX*preferences`', 'files_encryption', 0); - $this->verifyDB('`*PREFIX*appconfig`', 'encryption', 3); - $this->verifyDB('`*PREFIX*preferences`', 'encryption', 1); + $this->verifyDB('*PREFIX*appconfig', 'files_encryption', 0); + $this->verifyDB('*PREFIX*preferences', 'files_encryption', 0); + $this->verifyDB('*PREFIX*appconfig', 'encryption', 3); + $this->verifyDB('*PREFIX*preferences', 'encryption', 1); // check if the existing values where overwritten correctly /** @var \OC\DB\Connection $connection */ $connection = \OC::$server->getDatabaseConnection(); - $query = $connection->createQueryBuilder(); - $query->select('`configvalue`') - ->from('`*PREFIX*appconfig`') + $query = $connection->getQueryBuilder(); + $query->select('configvalue') + ->from('*PREFIX*appconfig') ->where($query->expr()->andX( - $query->expr()->eq('`appid`', ':appid'), - $query->expr()->eq('`configkey`', ':configkey') + $query->expr()->eq('appid', $query->createParameter('appid')), + $query->expr()->eq('configkey', $query->createParameter('configkey')) )) ->setParameter('appid', 'encryption') ->setParameter('configkey', 'publicShareKeyId'); @@ -349,13 +349,13 @@ class MigrationTest extends \Test\TestCase { $this->assertTrue(isset($value['configvalue'])); $this->assertSame('share_id', $value['configvalue']); - $query = $connection->createQueryBuilder(); - $query->select('`configvalue`') - ->from('`*PREFIX*preferences`') + $query = $connection->getQueryBuilder(); + $query->select('configvalue') + ->from('*PREFIX*preferences') ->where($query->expr()->andX( - $query->expr()->eq('`appid`', ':appid'), - $query->expr()->eq('`configkey`', ':configkey'), - $query->expr()->eq('`userid`', ':userid') + $query->expr()->eq('appid', $query->createParameter('appid')), + $query->expr()->eq('configkey', $query->createParameter('configkey')), + $query->expr()->eq('userid', $query->createParameter('userid')) )) ->setParameter('appid', 'encryption') ->setParameter('configkey', 'recoverKeyEnabled') @@ -371,9 +371,9 @@ class MigrationTest extends \Test\TestCase { /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); $query = $connection->getQueryBuilder(); - $query->select('`appid`') + $query->select('appid') ->from($table) - ->where($query->expr()->eq('`appid`', ':appid')) + ->where($query->expr()->eq('appid', $query->createParameter('appid'))) ->setParameter('appid', $appid); $result = $query->execute(); $values = $result->fetchAll(); @@ -396,7 +396,7 @@ class MigrationTest extends \Test\TestCase { $connection = \OC::$server->getDatabaseConnection(); $query = $connection->getQueryBuilder(); $query->select('*') - ->from('`*PREFIX*filecache`'); + ->from('*PREFIX*filecache'); $result = $query->execute(); $entries = $result->fetchAll(); foreach($entries as $entry) { @@ -414,22 +414,22 @@ class MigrationTest extends \Test\TestCase { /** @var \OCP\IDBConnection $connection */ $connection = \OC::$server->getDatabaseConnection(); $query = $connection->getQueryBuilder(); - $query->delete('`*PREFIX*filecache`'); + $query->delete('*PREFIX*filecache'); $query->execute(); $query = $connection->getQueryBuilder(); - $result = $query->select('`fileid`') - ->from('`*PREFIX*filecache`') + $result = $query->select('fileid') + ->from('*PREFIX*filecache') ->setMaxResults(1)->execute()->fetchAll(); $this->assertEmpty($result); $query = $connection->getQueryBuilder(); - $query->insert('`*PREFIX*filecache`') + $query->insert('*PREFIX*filecache') ->values( array( - '`storage`' => ':storage', - '`path_hash`' => ':path_hash', - '`encrypted`' => ':encrypted', - '`size`' => ':size', - '`unencrypted_size`' => ':unencrypted_size' + 'storage' => $query->createParameter('storage'), + 'path_hash' => $query->createParameter('path_hash'), + 'encrypted' => $query->createParameter('encrypted'), + 'size' => $query->createParameter('size'), + 'unencrypted_size' => $query->createParameter('unencrypted_size'), ) ); for ($i = 1; $i < 20; $i++) { @@ -443,8 +443,8 @@ class MigrationTest extends \Test\TestCase { ); } $query = $connection->getQueryBuilder(); - $result = $query->select('`fileid`') - ->from('`*PREFIX*filecache`') + $result = $query->select('fileid') + ->from('*PREFIX*filecache') ->execute()->fetchAll(); $this->assertSame(19, count($result)); } diff --git a/apps/files_trashbin/command/cleanup.php b/apps/files_trashbin/command/cleanup.php index de17020ea5c..0cc94912339 100644 --- a/apps/files_trashbin/command/cleanup.php +++ b/apps/files_trashbin/command/cleanup.php @@ -108,8 +108,8 @@ class CleanUp extends Command { if ($this->rootFolder->nodeExists('/' . $uid . '/files_trashbin')) { $this->rootFolder->get('/' . $uid . '/files_trashbin')->delete(); $query = $this->dbConnection->getQueryBuilder(); - $query->delete('`*PREFIX*files_trash`') - ->where($query->expr()->eq('`user`', ':uid')) + $query->delete('*PREFIX*files_trash') + ->where($query->expr()->eq('user', $query->createParameter('uid'))) ->setParameter('uid', $uid); $query->execute(); } diff --git a/apps/files_trashbin/tests/command/cleanuptest.php b/apps/files_trashbin/tests/command/cleanuptest.php index ecbaab98bf2..a7400e901fa 100644 --- a/apps/files_trashbin/tests/command/cleanuptest.php +++ b/apps/files_trashbin/tests/command/cleanuptest.php @@ -43,7 +43,7 @@ class CleanUpTest extends TestCase { protected $dbConnection; /** @var string */ - protected $trashTable = '`*PREFIX*files_trash`'; + protected $trashTable = '*PREFIX*files_trash'; /** @var string */ protected $user0 = 'user0'; @@ -69,14 +69,17 @@ class CleanUpTest extends TestCase { for ($i = 0; $i < 10; $i++) { $query->insert($this->trashTable) ->values(array( - '`id`' => $query->expr()->literal('file'.$i), - '`timestamp`' => $query->expr()->literal($i), - '`location`' => $query->expr()->literal('.'), - '`user`' => $query->expr()->literal('user'.$i%2) + 'id' => $query->expr()->literal('file'.$i), + 'timestamp' => $query->expr()->literal($i), + 'location' => $query->expr()->literal('.'), + 'user' => $query->expr()->literal('user'.$i%2) ))->execute(); } $getAllQuery = $this->dbConnection->getQueryBuilder(); - $result = $getAllQuery->select('`id`')->from($this->trashTable)->execute()->fetchAll(); + $result = $getAllQuery->select('id') + ->from($this->trashTable) + ->execute() + ->fetchAll(); $this->assertSame(10, count($result)); } @@ -107,7 +110,7 @@ class CleanUpTest extends TestCase { // if the delete operation was execute only files from user1 // should be left. $query = $this->dbConnection->getQueryBuilder(); - $result = $query->select('`user`') + $result = $query->select('user') ->from($this->trashTable) ->execute()->fetchAll(); $this->assertSame(5, count($result)); @@ -118,7 +121,10 @@ class CleanUpTest extends TestCase { // if no delete operation was execute we should still have all 10 // database entries $getAllQuery = $this->dbConnection->getQueryBuilder(); - $result = $getAllQuery->select('`id`')->from($this->trashTable)->execute()->fetchAll(); + $result = $getAllQuery->select('id') + ->from($this->trashTable) + ->execute() + ->fetchAll(); $this->assertSame(10, count($result)); } diff --git a/lib/private/share/share.php b/lib/private/share/share.php index e3364e0de0b..41b60ecc638 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -1203,9 +1203,9 @@ class Share extends Constants { private static function getShareOwner(IDBConnection $connection, $shareId) { $qb = $connection->getQueryBuilder(); - $qb->select('`uid_owner`') - ->from('`*PREFIX*share`') - ->where('`id` = :shareId') + $qb->select('uid_owner') + ->from('*PREFIX*share') + ->where($qb->expr()->eq('id', $qb->createParameter('shareId'))) ->setParameter(':shareId', $shareId); $result = $qb->execute(); $result = $result->fetch(); @@ -1253,9 +1253,9 @@ class Share extends Constants { } $qb = $connection->getQueryBuilder(); - $qb->update('`*PREFIX*share`') - ->set('`share_with`', ':pass') - ->where('`id` = :shareId') + $qb->update('*PREFIX*share') + ->set('share_with', $qb->createParameter('pass')) + ->where($qb->expr()->eq('id', $qb->createParameter('shareId'))) ->setParameter(':pass', is_null($password) ? null : \OC::$server->getHasher()->hash($password)) ->setParameter(':shareId', $shareId); diff --git a/lib/repair/cleantags.php b/lib/repair/cleantags.php index ddd1a483016..2bda1047081 100644 --- a/lib/repair/cleantags.php +++ b/lib/repair/cleantags.php @@ -110,14 +110,14 @@ class CleanTags extends BasicEmitter implements RepairStep { protected function deleteOrphanEntries($repairInfo, $deleteTable, $deleteId, $sourceTable, $sourceId, $sourceNullColumn) { $qb = $this->connection->getQueryBuilder(); - $qb->select('d.`' . $deleteId . '`') - ->from('`' . $deleteTable . '`', 'd') - ->leftJoin('d', '`' . $sourceTable . '`', 's', 'd.`' . $deleteId . '` = s.`' . $sourceId . '`') + $qb->select('d.' . $deleteId) + ->from($deleteTable, 'd') + ->leftJoin('d', $sourceTable, 's', $qb->expr()->eq('d.' . $deleteId, ' s.' . $sourceId)) ->where( - 'd.`type` = ' . $qb->expr()->literal('files') + $qb->expr()->eq('d.type', $qb->expr()->literal('files')) ) ->andWhere( - $qb->expr()->isNull('s.`' . $sourceNullColumn . '`') + $qb->expr()->isNull('s.' . $sourceNullColumn) ); $result = $qb->execute(); @@ -129,11 +129,11 @@ class CleanTags extends BasicEmitter implements RepairStep { if (!empty($orphanItems)) { $orphanItemsBatch = array_chunk($orphanItems, 200); foreach ($orphanItemsBatch as $items) { - $qb->delete('`' . $deleteTable . '`') + $qb->delete($deleteTable) ->where( - '`type` = ' . $qb->expr()->literal('files') + $qb->expr()->eq('type', $qb->expr()->literal('files')) ) - ->andWhere($qb->expr()->in('`' . $deleteId . '`', ':ids')); + ->andWhere($qb->expr()->in($deleteId, $qb->createParameter('ids'))); $qb->setParameter('ids', $items, \Doctrine\DBAL\Connection::PARAM_INT_ARRAY); $qb->execute(); } diff --git a/lib/repair/filletags.php b/lib/repair/filletags.php index a46c951efaf..f1bb2c896c4 100644 --- a/lib/repair/filletags.php +++ b/lib/repair/filletags.php @@ -42,10 +42,10 @@ class FillETags extends BasicEmitter implements \OC\RepairStep { public function run() { $qb = $this->connection->getQueryBuilder(); - $qb->update('`*PREFIX*filecache`') - ->set('`etag`', $qb->expr()->literal('xxx')) - ->where($qb->expr()->eq('`etag`', $qb->expr()->literal(''))) - ->orWhere($qb->expr()->isNull('`etag`')); + $qb->update('*PREFIX*filecache') + ->set('etag', $qb->expr()->literal('xxx')) + ->where($qb->expr()->eq('etag', $qb->expr()->literal(''))) + ->orWhere($qb->expr()->isNull('etag')); $result = $qb->execute(); $this->emit('\OC\Repair', 'info', array("ETags have been fixed for $result files/folders.")); diff --git a/tests/lib/repair/cleantags.php b/tests/lib/repair/cleantags.php index fc9b21d4636..2f6d0879642 100644 --- a/tests/lib/repair/cleantags.php +++ b/tests/lib/repair/cleantags.php @@ -40,13 +40,13 @@ class CleanTags extends \Test\TestCase { protected function cleanUpTables() { $qb = $this->connection->getQueryBuilder(); - $qb->delete('`*PREFIX*vcategory`') + $qb->delete('*PREFIX*vcategory') ->execute(); - $qb->delete('`*PREFIX*vcategory_to_object`') + $qb->delete('*PREFIX*vcategory_to_object') ->execute(); - $qb->delete('`*PREFIX*filecache`') + $qb->delete('*PREFIX*filecache') ->execute(); } @@ -84,8 +84,8 @@ class CleanTags extends \Test\TestCase { */ protected function assertEntryCount($tableName, $expected, $message = '') { $qb = $this->connection->getQueryBuilder(); - $result = $qb->select('COUNT(*)') - ->from('`' . $tableName . '`') + $result = $qb->select($qb->createFunction('COUNT(*)')) + ->from($tableName) ->execute(); $this->assertEquals($expected, $result->fetchColumn(), $message); @@ -100,15 +100,15 @@ class CleanTags extends \Test\TestCase { */ protected function addTagCategory($category, $type) { $qb = $this->connection->getQueryBuilder(); - $qb->insert('`*PREFIX*vcategory`') + $qb->insert('*PREFIX*vcategory') ->values([ - '`uid`' => $qb->createNamedParameter('TestRepairCleanTags'), - '`category`' => $qb->createNamedParameter($category), - '`type`' => $qb->createNamedParameter($type), + 'uid' => $qb->createNamedParameter('TestRepairCleanTags'), + 'category' => $qb->createNamedParameter($category), + 'type' => $qb->createNamedParameter($type), ]) ->execute(); - return (int) $this->getLastInsertID('`*PREFIX*vcategory`', '`id`'); + return (int) $this->getLastInsertID('*PREFIX*vcategory', 'id'); } /** @@ -119,11 +119,11 @@ class CleanTags extends \Test\TestCase { */ protected function addTagEntry($objectId, $category, $type) { $qb = $this->connection->getQueryBuilder(); - $qb->insert('`*PREFIX*vcategory_to_object`') + $qb->insert('*PREFIX*vcategory_to_object') ->values([ - '`objid`' => $qb->createNamedParameter($objectId, \PDO::PARAM_INT), - '`categoryid`' => $qb->createNamedParameter($category, \PDO::PARAM_INT), - '`type`' => $qb->createNamedParameter($type), + 'objid' => $qb->createNamedParameter($objectId, \PDO::PARAM_INT), + 'categoryid' => $qb->createNamedParameter($category, \PDO::PARAM_INT), + 'type' => $qb->createNamedParameter($type), ]) ->execute(); } @@ -141,21 +141,21 @@ class CleanTags extends \Test\TestCase { // We create a new file entry and delete it after the test again $fileName = $this->getUniqueID('TestRepairCleanTags', 12); - $qb->insert('`*PREFIX*filecache`') + $qb->insert('*PREFIX*filecache') ->values([ - '`path`' => $qb->createNamedParameter($fileName), - '`path_hash`' => $qb->createNamedParameter(md5($fileName)), + 'path' => $qb->createNamedParameter($fileName), + 'path_hash' => $qb->createNamedParameter(md5($fileName)), ]) ->execute(); $fileName = $this->getUniqueID('TestRepairCleanTags', 12); - $qb->insert('`*PREFIX*filecache`') + $qb->insert('*PREFIX*filecache') ->values([ - '`path`' => $qb->createNamedParameter($fileName), - '`path_hash`' => $qb->createNamedParameter(md5($fileName)), + 'path' => $qb->createNamedParameter($fileName), + 'path_hash' => $qb->createNamedParameter(md5($fileName)), ]) ->execute(); - $this->createdFile = (int) $this->getLastInsertID('`*PREFIX*filecache`', '`fileid`'); + $this->createdFile = (int) $this->getLastInsertID('*PREFIX*filecache', 'fileid'); return $this->createdFile; } @@ -175,7 +175,7 @@ class CleanTags extends \Test\TestCase { // FIXME https://github.com/owncloud/core/issues/13303 // FIXME ALSO FIX https://github.com/owncloud/core/commit/2dd85ec984c12d3be401518f22c90d2327bec07a $qb = $this->connection->getQueryBuilder(); - $result = $qb->select("MAX($idName)") + $result = $qb->select($qb->createFunction('MAX(`' . $idName . '`)')) ->from($tableName) ->execute(); diff --git a/tests/lib/share/share.php b/tests/lib/share/share.php index 816070afd8b..52511810efa 100644 --- a/tests/lib/share/share.php +++ b/tests/lib/share/share.php @@ -1287,12 +1287,12 @@ class Test_Share extends \Test\TestCase { // Find the share ID in the db $qb = $connection->getQueryBuilder(); - $qb->select('`id`') - ->from('`*PREFIX*share`') - ->where('`item_type` = :type') - ->andWhere('`item_source` = :source') - ->andWhere('`uid_owner` = :owner') - ->andWhere('`share_type` = :share_type') + $qb->select('id') + ->from('*PREFIX*share') + ->where($qb->expr()->eq('item_type', $qb->createParameter('type'))) + ->andWhere($qb->expr()->eq('item_source', $qb->createParameter('source'))) + ->andWhere($qb->expr()->eq('uid_owner', $qb->createParameter('owner'))) + ->andWhere($qb->expr()->eq('share_type', $qb->createParameter('share_type'))) ->setParameter('type', 'test') ->setParameter('source', 'test.txt') ->setParameter('owner', $this->user1) @@ -1308,9 +1308,9 @@ class Test_Share extends \Test\TestCase { // Fetch the hash from the database $qb = $connection->getQueryBuilder(); - $qb->select('`share_with`') - ->from('`*PREFIX*share`') - ->where('`id` = :id') + $qb->select('share_with') + ->from('*PREFIX*share') + ->where($qb->expr()->eq('id', $qb->createParameter('id'))) ->setParameter('id', $id); $hash = $qb->execute()->fetch()['share_with']; From 577a7c92e18d598389cbce97dcf80ebe00811a6b Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Wed, 15 Jul 2015 15:21:02 +0200 Subject: [PATCH 05/10] Can not test the string, thanks oracle.... --- .../lib/db/querybuilder/querybuildertest.php | 42 ++++++++++++++----- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php index 1b51b9a215f..4ee44bb8dd7 100644 --- a/tests/lib/db/querybuilder/querybuildertest.php +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -40,10 +40,10 @@ class QueryBuilderTest extends \Test\TestCase { public function dataFirstResult() { return [ - [null, ''], - [0, ' OFFSET 0'], - [1, ' OFFSET 1'], - [5, ' OFFSET 5'], + [null, [['configvalue' => 99], ['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], + [0, [['configvalue' => 99], ['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], + [1, [['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], + [5, [['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], ]; } @@ -51,9 +51,22 @@ class QueryBuilderTest extends \Test\TestCase { * @dataProvider dataFirstResult * * @param int $firstResult - * @param string $expectedOffset + * @param array $expectedSet */ - public function testFirstResult($firstResult, $expectedOffset) { + public function testFirstResult($firstResult, $expectedSet) { + $eB = $this->queryBuilder->expr(); + + for ($i = 1; $i < 10; $i++) { + $this->queryBuilder->insert('*PREFIX*appconfig') + ->values([ + 'appid' => $eB->literal('testFirstResult'), + 'configkey' => $eB->literal('testing' . $i), + 'configvalue' => $eB->literal(100 - $i), + ]); + $this->queryBuilder->execute(); + } + $this->queryBuilder->resetQueryParts(); + if ($firstResult !== null) { $this->queryBuilder->setFirstResult($firstResult); } @@ -63,10 +76,19 @@ class QueryBuilderTest extends \Test\TestCase { $this->queryBuilder->getFirstResult() ); - $this->assertSame( - 'SELECT FROM ' . $expectedOffset, - $this->queryBuilder->getSQL() - ); + $this->queryBuilder->select('configvalue') + ->from('*PREFIX*appconfig') + ->where($eB->eq('appid', $eB->literal('testFirstResult'))) + ->orderBy('configkey', 'ASC'); + + $query = $this->queryBuilder->execute(); + $this->assertSame(sizeof($expectedSet), $query->rowCount()); + $this->assertEquals($expectedSet, $query->fetchAll()); + + $this->queryBuilder->delete('*PREFIX*appconfig') + ->where($eB->eq('appid', $eB->literal('testFirstResult'))); + + $query = $this->queryBuilder->execute(); } public function dataMaxResults() { From 32cb30cb8400032d334873a3205e68bea7f909f5 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 16 Jul 2015 10:38:12 +0200 Subject: [PATCH 06/10] Correctly count the number of items (rowCount is Update/Insert/Delete only) --- .../lib/db/querybuilder/querybuildertest.php | 35 ++++++++++++------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php index 4ee44bb8dd7..8be0c5d17e7 100644 --- a/tests/lib/db/querybuilder/querybuildertest.php +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -25,17 +25,20 @@ use Doctrine\DBAL\Query\Expression\CompositeExpression; use OC\DB\QueryBuilder\Literal; use OC\DB\QueryBuilder\Parameter; use OC\DB\QueryBuilder\QueryBuilder; +use OCP\IDBConnection; class QueryBuilderTest extends \Test\TestCase { /** @var QueryBuilder */ protected $queryBuilder; + /** @var IDBConnection */ + protected $connection; + protected function setUp() { parent::setUp(); - $connection = \OC::$server->getDatabaseConnection(); - - $this->queryBuilder = new QueryBuilder($connection); + $this->connection = \OC::$server->getDatabaseConnection(); + $this->queryBuilder = new QueryBuilder($this->connection); } public function dataFirstResult() { @@ -54,18 +57,18 @@ class QueryBuilderTest extends \Test\TestCase { * @param array $expectedSet */ public function testFirstResult($firstResult, $expectedSet) { - $eB = $this->queryBuilder->expr(); + $qB = $this->connection->getQueryBuilder(); + $eB = $qB->expr(); for ($i = 1; $i < 10; $i++) { - $this->queryBuilder->insert('*PREFIX*appconfig') + $qB->insert('*PREFIX*appconfig') ->values([ 'appid' => $eB->literal('testFirstResult'), 'configkey' => $eB->literal('testing' . $i), 'configvalue' => $eB->literal(100 - $i), - ]); - $this->queryBuilder->execute(); + ]) + ->execute(); } - $this->queryBuilder->resetQueryParts(); if ($firstResult !== null) { $this->queryBuilder->setFirstResult($firstResult); @@ -82,13 +85,19 @@ class QueryBuilderTest extends \Test\TestCase { ->orderBy('configkey', 'ASC'); $query = $this->queryBuilder->execute(); - $this->assertSame(sizeof($expectedSet), $query->rowCount()); - $this->assertEquals($expectedSet, $query->fetchAll()); + $rows = []; + while ($row = $query->fetch()) { + $rows[] = $row; + } + $query->closeCursor(); - $this->queryBuilder->delete('*PREFIX*appconfig') - ->where($eB->eq('appid', $eB->literal('testFirstResult'))); + $this->assertCount(sizeof($expectedSet), $rows); + $this->assertEquals($expectedSet, $rows); - $query = $this->queryBuilder->execute(); + $qB = $this->connection->getQueryBuilder(); + $qB->delete('*PREFIX*appconfig') + ->where($eB->eq('appid', $eB->literal('testFirstResult'))) + ->execute(); } public function dataMaxResults() { From 22849238fb38b932b4336202284c8b58180e0f18 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 16 Jul 2015 10:39:11 +0200 Subject: [PATCH 07/10] Set a limit until doctrine released a version that fixes Sqlite See https://github.com/doctrine/dbal/pull/782 for more info --- tests/lib/db/querybuilder/querybuildertest.php | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php index 8be0c5d17e7..03ed8801177 100644 --- a/tests/lib/db/querybuilder/querybuildertest.php +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -72,6 +72,10 @@ class QueryBuilderTest extends \Test\TestCase { if ($firstResult !== null) { $this->queryBuilder->setFirstResult($firstResult); + + // FIXME Remove this once Doctrine/DBAL is >2.5.1: + // FIXME See https://github.com/doctrine/dbal/pull/782 + $this->queryBuilder->setMaxResults(100); } $this->assertSame( From c9564503c2b6635e3e0b9262867f3c2b6e3149cb Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 20 Jul 2015 17:09:27 +0200 Subject: [PATCH 08/10] Fix tests for setFirstResult and setMaxResults on oracle --- lib/private/db/querybuilder/querybuilder.php | 4 +- .../db/querybuilder/expressionbuildertest.php | 2 +- .../lib/db/querybuilder/querybuildertest.php | 104 +++++++++++------- 3 files changed, 66 insertions(+), 44 deletions(-) diff --git a/lib/private/db/querybuilder/querybuilder.php b/lib/private/db/querybuilder/querybuilder.php index fbb2b07bade..4f7182aff66 100644 --- a/lib/private/db/querybuilder/querybuilder.php +++ b/lib/private/db/querybuilder/querybuilder.php @@ -38,9 +38,9 @@ class QueryBuilder implements IQueryBuilder { private $helper; /** - * Initializes a new QueryBuilder. + * Initializes a new QueryBuilder. * - * @var \OCP\IDBConnection + * @param \OCP\IDBConnection $connection */ public function __construct(IDBConnection $connection) { $this->connection = $connection; diff --git a/tests/lib/db/querybuilder/expressionbuildertest.php b/tests/lib/db/querybuilder/expressionbuildertest.php index b4159e49814..f041df01019 100644 --- a/tests/lib/db/querybuilder/expressionbuildertest.php +++ b/tests/lib/db/querybuilder/expressionbuildertest.php @@ -330,7 +330,7 @@ class ExpressionBuilderTest extends \Test\TestCase { $actual = $this->expressionBuilder->literal($input, $type); $this->assertInstanceOf('\OC\DB\QueryBuilder\Literal', $actual); - $this->assertSame( + $this->assertEquals( $this->doctrineExpressionBuilder->literal($input, $type), $actual->__toString() ); diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php index 03ed8801177..5810f2c5a20 100644 --- a/tests/lib/db/querybuilder/querybuildertest.php +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -41,12 +41,52 @@ class QueryBuilderTest extends \Test\TestCase { $this->queryBuilder = new QueryBuilder($this->connection); } + protected function createTestingRows() { + $qB = $this->connection->getQueryBuilder(); + for ($i = 1; $i < 10; $i++) { + $qB->insert('*PREFIX*appconfig') + ->values([ + 'appid' => $qB->expr()->literal('testFirstResult'), + 'configkey' => $qB->expr()->literal('testing' . $i), + 'configvalue' => $qB->expr()->literal(100 - $i), + ]) + ->execute(); + } + } + + protected function getTestingRows(QueryBuilder $queryBuilder) { + $queryBuilder->select('configvalue') + ->from('*PREFIX*appconfig') + ->where($queryBuilder->expr()->eq( + 'appid', + $queryBuilder->expr()->literal('testFirstResult') + )) + ->orderBy('configkey', 'ASC'); + + $query = $queryBuilder->execute(); + $rows = []; + while ($row = $query->fetch()) { + $rows[] = $row['configvalue']; + } + $query->closeCursor(); + + return $rows; + } + + protected function deleteTestingRows() { + $qB = $this->connection->getQueryBuilder(); + + $qB->delete('*PREFIX*appconfig') + ->where($qB->expr()->eq('appid', $qB->expr()->literal('testFirstResult'))) + ->execute(); + } + public function dataFirstResult() { return [ - [null, [['configvalue' => 99], ['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], - [0, [['configvalue' => 99], ['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], - [1, [['configvalue' => 98], ['configvalue' => 97], ['configvalue' => 96], ['configvalue' => 95], ['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], - [5, [['configvalue' => 94], ['configvalue' => 93], ['configvalue' => 92], ['configvalue' => 91]]], + [null, [99, 98, 97, 96, 95, 94, 93, 92, 91]], + [0, [99, 98, 97, 96, 95, 94, 93, 92, 91]], + [1, [98, 97, 96, 95, 94, 93, 92, 91]], + [5, [94, 93, 92, 91]], ]; } @@ -57,18 +97,8 @@ class QueryBuilderTest extends \Test\TestCase { * @param array $expectedSet */ public function testFirstResult($firstResult, $expectedSet) { - $qB = $this->connection->getQueryBuilder(); - $eB = $qB->expr(); - - for ($i = 1; $i < 10; $i++) { - $qB->insert('*PREFIX*appconfig') - ->values([ - 'appid' => $eB->literal('testFirstResult'), - 'configkey' => $eB->literal('testing' . $i), - 'configvalue' => $eB->literal(100 - $i), - ]) - ->execute(); - } + $this->deleteTestingRows(); + $this->createTestingRows(); if ($firstResult !== null) { $this->queryBuilder->setFirstResult($firstResult); @@ -83,33 +113,20 @@ class QueryBuilderTest extends \Test\TestCase { $this->queryBuilder->getFirstResult() ); - $this->queryBuilder->select('configvalue') - ->from('*PREFIX*appconfig') - ->where($eB->eq('appid', $eB->literal('testFirstResult'))) - ->orderBy('configkey', 'ASC'); - - $query = $this->queryBuilder->execute(); - $rows = []; - while ($row = $query->fetch()) { - $rows[] = $row; - } - $query->closeCursor(); + $rows = $this->getTestingRows($this->queryBuilder); $this->assertCount(sizeof($expectedSet), $rows); $this->assertEquals($expectedSet, $rows); - $qB = $this->connection->getQueryBuilder(); - $qB->delete('*PREFIX*appconfig') - ->where($eB->eq('appid', $eB->literal('testFirstResult'))) - ->execute(); + $this->deleteTestingRows(); } public function dataMaxResults() { return [ - [null, ''], - [0, ' LIMIT 0'], - [1, ' LIMIT 1'], - [5, ' LIMIT 5'], + [null, [99, 98, 97, 96, 95, 94, 93, 92, 91]], + [0, []], + [1, [99]], + [5, [99, 98, 97, 96, 95]], ]; } @@ -117,9 +134,12 @@ class QueryBuilderTest extends \Test\TestCase { * @dataProvider dataMaxResults * * @param int $maxResult - * @param string $expectedLimit + * @param array $expectedSet */ - public function testMaxResults($maxResult, $expectedLimit) { + public function testMaxResults($maxResult, $expectedSet) { + $this->deleteTestingRows(); + $this->createTestingRows(); + if ($maxResult !== null) { $this->queryBuilder->setMaxResults($maxResult); } @@ -129,10 +149,12 @@ class QueryBuilderTest extends \Test\TestCase { $this->queryBuilder->getMaxResults() ); - $this->assertSame( - 'SELECT FROM ' . $expectedLimit, - $this->queryBuilder->getSQL() - ); + $rows = $this->getTestingRows($this->queryBuilder); + + $this->assertCount(sizeof($expectedSet), $rows); + $this->assertEquals($expectedSet, $rows); + + $this->deleteTestingRows(); } public function dataSelect() { From f9071ed5b7449c5f0dfa99a7715a744742281cf1 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 21 Jul 2015 09:56:08 +0200 Subject: [PATCH 09/10] Comment out LIMIT 0 case because of the mixed results --- lib/private/db/querybuilder/querybuilder.php | 4 ++++ tests/lib/db/querybuilder/querybuildertest.php | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/private/db/querybuilder/querybuilder.php b/lib/private/db/querybuilder/querybuilder.php index 4f7182aff66..38c3966d9a0 100644 --- a/lib/private/db/querybuilder/querybuilder.php +++ b/lib/private/db/querybuilder/querybuilder.php @@ -237,6 +237,10 @@ class QueryBuilder implements IQueryBuilder { /** * Sets the maximum number of results to retrieve (the "limit"). * + * NOTE: Setting max results to "0" will cause mixed behaviour. While most + * of the databases will just return an empty result set, Oracle will return + * all entries. + * * @param integer $maxResults The maximum number of results to retrieve. * * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance. diff --git a/tests/lib/db/querybuilder/querybuildertest.php b/tests/lib/db/querybuilder/querybuildertest.php index 5810f2c5a20..02e516b7386 100644 --- a/tests/lib/db/querybuilder/querybuildertest.php +++ b/tests/lib/db/querybuilder/querybuildertest.php @@ -124,7 +124,8 @@ class QueryBuilderTest extends \Test\TestCase { public function dataMaxResults() { return [ [null, [99, 98, 97, 96, 95, 94, 93, 92, 91]], - [0, []], + // Limit 0 gives mixed results: either all entries or none is returned + //[0, []], [1, [99]], [5, [99, 98, 97, 96, 95]], ]; From 20cd0ae55b3e56e0fbe34033a023f6a5f1c2b7d6 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 21 Jul 2015 14:17:47 +0200 Subject: [PATCH 10/10] Add a log message when the Doctrine Query Builder is retrieved --- lib/private/appframework/db/db.php | 9 ---- lib/private/db/connection.php | 52 ++++++++++++++++---- lib/private/db/querybuilder/querybuilder.php | 2 +- lib/public/idbconnection.php | 8 --- 4 files changed, 43 insertions(+), 28 deletions(-) diff --git a/lib/private/appframework/db/db.php b/lib/private/appframework/db/db.php index 6134d33b6c9..cde85831687 100644 --- a/lib/private/appframework/db/db.php +++ b/lib/private/appframework/db/db.php @@ -45,15 +45,6 @@ class Db implements IDb { $this->connection = $connection; } - /** - * Gets the ExpressionBuilder for the connection. - * - * @return \OCP\DB\QueryBuilder\IExpressionBuilder - */ - public function getExpressionBuilder() { - return $this->connection->getExpressionBuilder(); - } - /** * Gets the ExpressionBuilder for the connection. * diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php index ae5d22bf4d8..def3f2fd120 100644 --- a/lib/private/db/connection.php +++ b/lib/private/db/connection.php @@ -54,16 +54,7 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { } /** - * Gets the ExpressionBuilder for the connection. - * - * @return \OCP\DB\QueryBuilder\IExpressionBuilder - */ - public function getExpressionBuilder() { - return new ExpressionBuilder($this); - } - - /** - * Gets the QueryBuilder for the connection. + * Returns a QueryBuilder for the connection. * * @return \OCP\DB\QueryBuilder\IQueryBuilder */ @@ -71,6 +62,47 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { return new QueryBuilder($this); } + /** + * Gets the QueryBuilder for the connection. + * + * @return \Doctrine\DBAL\Query\QueryBuilder + * @deprecated please use $this->getQueryBuilder() instead + */ + public function createQueryBuilder() { + $backtrace = $this->getCallerBacktrace(); + \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]); + return parent::createQueryBuilder(); + } + + /** + * Gets the ExpressionBuilder for the connection. + * + * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder + * @deprecated please use $this->getQueryBuilder()->expr() instead + */ + public function getExpressionBuilder() { + $backtrace = $this->getCallerBacktrace(); + \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]); + return parent::getExpressionBuilder(); + } + + /** + * Get the file and line that called the method where `getCallerBacktrace()` was used + * + * @return string + */ + protected function getCallerBacktrace() { + $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2); + + // 0 is the method where we use `getCallerBacktrace` + // 1 is the target method which uses the method we want to log + if (isset($traces[1])) { + return $traces[1]['file'] . ':' . $traces[1]['line']; + } + + return ''; + } + /** * @return string */ diff --git a/lib/private/db/querybuilder/querybuilder.php b/lib/private/db/querybuilder/querybuilder.php index 38c3966d9a0..1a1408876f1 100644 --- a/lib/private/db/querybuilder/querybuilder.php +++ b/lib/private/db/querybuilder/querybuilder.php @@ -65,7 +65,7 @@ class QueryBuilder implements IQueryBuilder { * @return \OCP\DB\QueryBuilder\IExpressionBuilder */ public function expr() { - return $this->connection->getExpressionBuilder(); + return new ExpressionBuilder($this->connection); } /** diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php index 7c94611a684..0d04c43d73e 100644 --- a/lib/public/idbconnection.php +++ b/lib/public/idbconnection.php @@ -40,14 +40,6 @@ namespace OCP; * @since 6.0.0 */ interface IDBConnection { - /** - * Gets the ExpressionBuilder for the connection. - * - * @return \OCP\DB\QueryBuilder\IExpressionBuilder - * @since 8.2.0 - */ - public function getExpressionBuilder(); - /** * Gets the QueryBuilder for the connection. *