diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php index 6c4f518dfb..82b52bbc9d 100644 --- a/lib/private/db/connection.php +++ b/lib/private/db/connection.php @@ -29,8 +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\DB\QueryBuilder\IQueryBuilder; use OCP\IDBConnection; use OCP\PreconditionNotMetException; @@ -244,11 +244,11 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { private function getType($value) { if (is_bool($value)) { - return \PDO::PARAM_BOOL; + return IQueryBuilder::PARAM_BOOL; } else if (is_int($value)) { - return \PDO::PARAM_INT; + return IQueryBuilder::PARAM_INT; } else { - return \PDO::PARAM_STR; + return IQueryBuilder::PARAM_STR; } } @@ -278,7 +278,7 @@ class Connection extends \Doctrine\DBAL\Connection implements IDBConnection { $updateQb = $this->getQueryBuilder(); $updateQb->update($table); foreach ($values as $name => $value) { - $updateQb->set($name, $updateQb->createNamedParameter($value), $this->getType($value)); + $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value))); } $where = $updateQb->expr()->andx(); $whereValues = array_merge($keys, $updatePreconditionValues); diff --git a/lib/private/db/querybuilder/expressionbuilder.php b/lib/private/db/querybuilder/expressionbuilder.php index 1e86db5a08..b688ebfabb 100644 --- a/lib/private/db/querybuilder/expressionbuilder.php +++ b/lib/private/db/querybuilder/expressionbuilder.php @@ -86,12 +86,14 @@ class ExpressionBuilder implements IExpressionBuilder { * Creates a comparison expression. * * @param mixed $x The left expression. - * @param string $operator One of the ExpressionBuilder::* constants. + * @param string $operator One of the IExpressionBuilder::* constants. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function comparison($x, $operator, $y) { + public function comparison($x, $operator, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->comparison($x, $operator, $y); @@ -109,7 +111,7 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. - * @param int|null $type one of the \PDO::PARAM_* constants + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants * required when comparing text fields for oci compatibility * * @return string @@ -131,10 +133,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function neq($x, $y) { + public function neq($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->neq($x, $y); @@ -151,10 +155,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function lt($x, $y) { + public function lt($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->lt($x, $y); @@ -171,10 +177,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function lte($x, $y) { + public function lte($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->lte($x, $y); @@ -191,10 +199,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function gt($x, $y) { + public function gt($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->gt($x, $y); @@ -211,10 +221,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function gte($x, $y) { + public function gte($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->gte($x, $y); @@ -249,10 +261,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @param string $x Field in string format to be inspected by LIKE() comparison. * @param mixed $y Argument to be used in LIKE() comparison. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function like($x, $y) { + public function like($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->like($x, $y); @@ -263,10 +277,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function notLike($x, $y) { + public function notLike($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnName($y); return $this->expressionBuilder->notLike($x, $y); @@ -277,10 +293,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function in($x, $y) { + public function in($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnNames($y); return $this->expressionBuilder->in($x, $y); @@ -291,10 +309,12 @@ class ExpressionBuilder implements IExpressionBuilder { * * @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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string */ - public function notIn($x, $y) { + public function notIn($x, $y, $type = null) { $x = $this->helper->quoteColumnName($x); $y = $this->helper->quoteColumnNames($y); return $this->expressionBuilder->notIn($x, $y); @@ -304,7 +324,7 @@ class ExpressionBuilder implements IExpressionBuilder { * Quotes a given input parameter. * * @param mixed $input The parameter to be quoted. - * @param string|null $type The type of the parameter. + * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants * * @return Literal */ diff --git a/lib/private/db/querybuilder/ociexpressionbuilder.php b/lib/private/db/querybuilder/ociexpressionbuilder.php index 742611bf71..4c127bd752 100644 --- a/lib/private/db/querybuilder/ociexpressionbuilder.php +++ b/lib/private/db/querybuilder/ociexpressionbuilder.php @@ -21,13 +21,115 @@ namespace OC\DB\QueryBuilder; + +use OCP\DB\QueryBuilder\ILiteral; +use OCP\DB\QueryBuilder\IParameter; +use OCP\DB\QueryBuilder\IQueryBuilder; + class OCIExpressionBuilder extends ExpressionBuilder { - public function eq($x, $y, $type = null) { - $x = $this->helper->quoteColumnName($x); - $y = $this->helper->quoteColumnName($y); - if ($type === \PDO::PARAM_STR) { - $x = new QueryFunction('to_char(' . $x . ')'); + + /** + * @param mixed $column + * @param mixed|null $type + * @return array|QueryFunction|string + */ + protected function prepareColumn($column, $type) { + if ($type === IQueryBuilder::PARAM_STR && !is_array($column) && !($column instanceof IParameter) && !($column instanceof ILiteral)) { + $column = $this->helper->quoteColumnName($column); + $column = new QueryFunction('to_char(' . $column . ')'); + } else { + $column = $this->helper->quoteColumnNames($column); } + return $column; + } + + /** + * @inheritdoc + */ + public function comparison($x, $operator, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->comparison($x, $operator, $y); + } + + /** + * @inheritdoc + */ + public function eq($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + return $this->expressionBuilder->eq($x, $y); } + + /** + * @inheritdoc + */ + public function neq($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->neq($x, $y); + } + + /** + * @inheritdoc + */ + public function lt($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->lt($x, $y); + } + + /** + * @inheritdoc + */ + public function lte($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->lte($x, $y); + } + + /** + * @inheritdoc + */ + public function gt($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->gt($x, $y); + } + + /** + * @inheritdoc + */ + public function gte($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->gte($x, $y); + } + + /** + * @inheritdoc + */ + public function in($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->in($x, $y); + } + + /** + * @inheritdoc + */ + public function notIn($x, $y, $type = null) { + $x = $this->prepareColumn($x, $type); + $y = $this->prepareColumn($y, $type); + + return $this->expressionBuilder->notIn($x, $y); + } } diff --git a/lib/public/db/querybuilder/iexpressionbuilder.php b/lib/public/db/querybuilder/iexpressionbuilder.php index 0549d3f012..a53ae3846c 100644 --- a/lib/public/db/querybuilder/iexpressionbuilder.php +++ b/lib/public/db/querybuilder/iexpressionbuilder.php @@ -21,11 +21,39 @@ namespace OCP\DB\QueryBuilder; + +use Doctrine\DBAL\Query\Expression\ExpressionBuilder; + /** * This class provides a wrapper around Doctrine's ExpressionBuilder * @since 8.2.0 */ interface IExpressionBuilder { + /** + * @since 9.0.0 + */ + const EQ = ExpressionBuilder::EQ; + /** + * @since 9.0.0 + */ + const NEQ = ExpressionBuilder::NEQ; + /** + * @since 9.0.0 + */ + const LT = ExpressionBuilder::LT; + /** + * @since 9.0.0 + */ + const LTE = ExpressionBuilder::LTE; + /** + * @since 9.0.0 + */ + const GT = ExpressionBuilder::GT; + /** + * @since 9.0.0 + */ + const GTE = ExpressionBuilder::GTE; + /** * Creates a conjunction of the given boolean expressions. * @@ -64,13 +92,15 @@ interface IExpressionBuilder { * Creates a comparison expression. * * @param mixed $x The left expression. - * @param string $operator One of the ExpressionBuilder::* constants. + * @param string $operator One of the IExpressionBuilder::* constants. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function comparison($x, $operator, $y); + public function comparison($x, $operator, $y, $type = null); /** * Creates an equality comparison expression with the given arguments. @@ -84,11 +114,11 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. - * @param int|null $type @since 9.0.0 one of the \PDO::PARAM_* constants - * required when comparing text fields for oci compatibility. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ public function eq($x, $y, $type = null); @@ -103,11 +133,13 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function neq($x, $y); + public function neq($x, $y, $type = null); /** * Creates a lower-than comparison expression with the given arguments. @@ -120,11 +152,13 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function lt($x, $y); + public function lt($x, $y, $type = null); /** * Creates a lower-than-equal comparison expression with the given arguments. @@ -137,11 +171,13 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function lte($x, $y); + public function lte($x, $y, $type = null); /** * Creates a greater-than comparison expression with the given arguments. @@ -154,11 +190,13 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function gt($x, $y); + public function gt($x, $y, $type = null); /** * Creates a greater-than-equal comparison expression with the given arguments. @@ -171,11 +209,13 @@ interface IExpressionBuilder { * * @param mixed $x The left expression. * @param mixed $y The right expression. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function gte($x, $y); + public function gte($x, $y, $type = null); /** * Creates an IS NULL expression with the given arguments. @@ -202,50 +242,58 @@ interface IExpressionBuilder { * * @param string $x Field in string format to be inspected by LIKE() comparison. * @param mixed $y Argument to be used in LIKE() comparison. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function like($x, $y); + public function like($x, $y, $type = null); /** * 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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function notLike($x, $y); + public function notLike($x, $y, $type = null); /** * 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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function in($x, $y); + public function in($x, $y, $type = null); /** * 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. + * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants + * required when comparing text fields for oci compatibility * * @return string - * @since 8.2.0 + * @since 8.2.0 - Parameter $type was added in 9.0.0 */ - public function notIn($x, $y); + public function notIn($x, $y, $type = null); /** * Quotes a given input parameter. * * @param mixed $input The parameter to be quoted. - * @param string|null $type The type of the parameter. + * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants * * @return string * @since 8.2.0 diff --git a/tests/lib/db/querybuilder/expressionbuildertest.php b/tests/lib/db/querybuilder/expressionbuildertest.php index 0563ff9233..8310c4adf6 100644 --- a/tests/lib/db/querybuilder/expressionbuildertest.php +++ b/tests/lib/db/querybuilder/expressionbuildertest.php @@ -23,6 +23,8 @@ namespace Test\DB\QueryBuilder; use Doctrine\DBAL\Query\Expression\ExpressionBuilder as DoctrineExpressionBuilder; use OC\DB\QueryBuilder\ExpressionBuilder; +use OCP\DB\QueryBuilder\IQueryBuilder; +use Test\TestCase; /** * Class ExpressionBuilderTest @@ -31,21 +33,24 @@ use OC\DB\QueryBuilder\ExpressionBuilder; * * @package Test\DB\QueryBuilder */ -class ExpressionBuilderTest extends \Test\TestCase { +class ExpressionBuilderTest extends TestCase { /** @var ExpressionBuilder */ protected $expressionBuilder; /** @var DoctrineExpressionBuilder */ protected $doctrineExpressionBuilder; + /** @var \Doctrine\DBAL\Connection|\OCP\IDBConnection */ + protected $connection; + protected function setUp() { parent::setUp(); - $connection = \OC::$server->getDatabaseConnection(); + $this->connection = \OC::$server->getDatabaseConnection(); - $this->expressionBuilder = new ExpressionBuilder($connection); + $this->expressionBuilder = new ExpressionBuilder($this->connection); - $this->doctrineExpressionBuilder = new DoctrineExpressionBuilder($connection); + $this->doctrineExpressionBuilder = new DoctrineExpressionBuilder($this->connection); } public function dataComparison() { @@ -342,4 +347,81 @@ class ExpressionBuilderTest extends \Test\TestCase { $actual->__toString() ); } + + public function dataClobComparisons() { + return [ + ['eq', '5', IQueryBuilder::PARAM_STR, false, 3], + ['eq', '5', IQueryBuilder::PARAM_STR, true, 1], + ['neq', '5', IQueryBuilder::PARAM_STR, false, 6], + ['neq', '5', IQueryBuilder::PARAM_STR, true, 4], + ['lt', '5', IQueryBuilder::PARAM_STR, false, 3], + ['lt', '5', IQueryBuilder::PARAM_STR, true, 1], + ['lte', '5', IQueryBuilder::PARAM_STR, false, 6], + ['lte', '5', IQueryBuilder::PARAM_STR, true, 4], + ['gt', '5', IQueryBuilder::PARAM_STR, false, 3], + ['gt', '5', IQueryBuilder::PARAM_STR, true, 1], + ['gte', '5', IQueryBuilder::PARAM_STR, false, 6], + ['gte', '5', IQueryBuilder::PARAM_STR, true, 4], + ['like', '%5%', IQueryBuilder::PARAM_STR, false, 3], + ['like', '%5%', IQueryBuilder::PARAM_STR, true, 1], + ['notLike', '%5%', IQueryBuilder::PARAM_STR, false, 6], + ['notLike', '%5%', IQueryBuilder::PARAM_STR, true, 4], + ['in', ['5'], IQueryBuilder::PARAM_STR_ARRAY, false, 3], + ['in', ['5'], IQueryBuilder::PARAM_STR_ARRAY, true, 1], + ['notIn', ['5'], IQueryBuilder::PARAM_STR_ARRAY, false, 6], + ['notIn', ['5'], IQueryBuilder::PARAM_STR_ARRAY, true, 4], + ]; + } + + /** + * @dataProvider dataClobComparisons + * @param string $function + * @param mixed $value + * @param mixed $type + * @param bool $compareKeyToValue + * @param int $expected + */ + public function testClobComparisons($function, $value, $type, $compareKeyToValue, $expected) { + $appId = $this->getUniqueID('testing'); + $this->createConfig($appId, 1, 4); + $this->createConfig($appId, 2, 5); + $this->createConfig($appId, 3, 6); + $this->createConfig($appId, 4, 4); + $this->createConfig($appId, 5, 5); + $this->createConfig($appId, 6, 6); + $this->createConfig($appId, 7, 4); + $this->createConfig($appId, 8, 5); + $this->createConfig($appId, 9, 6); + + $query = $this->connection->getQueryBuilder(); + $query->select($query->createFunction('COUNT(*) AS `count`')) + ->from('appconfig') + ->where($query->expr()->eq('appid', $query->createNamedParameter($appId))) + ->andWhere(call_user_func([$query->expr(), $function], 'configvalue', $query->createNamedParameter($value, $type), IQueryBuilder::PARAM_STR)); + + if ($compareKeyToValue) { + $query->andWhere(call_user_func([$query->expr(), $function], 'configkey', 'configvalue', IQueryBuilder::PARAM_STR)); + } + + $result = $query->execute(); + + $this->assertEquals(['count' => $expected], $result->fetch()); + $result->closeCursor(); + + $query = $this->connection->getQueryBuilder(); + $query->delete('appconfig') + ->where($query->expr()->eq('appid', $query->createNamedParameter($appId))) + ->execute(); + } + + protected function createConfig($appId, $key, $value) { + $query = $this->connection->getQueryBuilder(); + $query->insert('appconfig') + ->values([ + 'appid' => $query->createNamedParameter($appId), + 'configkey' => $query->createNamedParameter((string) $key), + 'configvalue' => $query->createNamedParameter((string) $value), + ]) + ->execute(); + } }