ExpressionBuilderDBTest.php

<?php

/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace Test\DB\QueryBuilder;

use Doctrine\DBAL\Schema\SchemaException;
use OC\DB\QueryBuilder\Literal;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\DB\Types;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\Server;
use Test\TestCase;

#[\PHPUnit\Framework\Attributes\Group('DB')]
class ExpressionBuilderDBTest extends TestCase {
	/** @var \Doctrine\DBAL\Connection|IDBConnection */
	protected $connection;
	protected $schemaSetup = false;

	#[\Override]
	protected function setUp(): void {
		parent::setUp();

		$this->connection = Server::get(IDBConnection::class);
		$this->prepareTestingTable();
	}

	public static function likeProvider(): array {
		$connection = Server::get(IDBConnection::class);

		return [
			['foo', 'bar', false],
			['foo', 'foo', true],
			['foo', 'f%', true],
			['foo', '%o', true],
			['foo', '%', true],
			['foo', 'fo_', true],
			['foo', 'foo_', false],
			['foo', $connection->escapeLikeParameter('fo_'), false],
			['foo', $connection->escapeLikeParameter('f%'), false],
		];
	}

	/**
	 *
	 * @param string $param1
	 * @param string $param2
	 * @param boolean $match
	 */
	#[\PHPUnit\Framework\Attributes\DataProvider('likeProvider')]
	public function testLike($param1, $param2, $match): void {
		$query = $this->connection->getQueryBuilder();

		$query->select(new Literal('1'))
			->from('users')
			->where($query->expr()->like($query->createNamedParameter($param1), $query->createNamedParameter($param2)));

		$result = $query->executeQuery();
		$column = $result->fetchOne();
		$result->closeCursor();
		$this->assertEquals($match, $column);
	}

	public static function ilikeProvider(): array {
		$connection = Server::get(IDBConnection::class);

		return [
			['foo', 'bar', false],
			['foo', 'foo', true],
			['foo', 'Foo', true],
			['foo', 'f%', true],
			['foo', '%o', true],
			['foo', '%', true],
			['foo', 'fo_', true],
			['foo', 'foo_', false],
			['foo', $connection->escapeLikeParameter('fo_'), false],
			['foo', $connection->escapeLikeParameter('f%'), false],
		];
	}

	/**
	 *
	 * @param string $param1
	 * @param string $param2
	 * @param boolean $match
	 */
	#[\PHPUnit\Framework\Attributes\DataProvider('ilikeProvider')]
	public function testILike($param1, $param2, $match): void {
		$query = $this->connection->getQueryBuilder();

		$query->select(new Literal('1'))
			->from('users')
			->where($query->expr()->iLike($query->createNamedParameter($param1), $query->createNamedParameter($param2)));

		$result = $query->executeQuery();
		$column = $result->fetchOne();
		$result->closeCursor();
		$this->assertEquals($match, $column);
	}

	public static function notILikeProvider(): array {
		$connection = Server::get(IDBConnection::class);

		return [
			['foo', 'bar', true],
			['foo', 'foo', false],
			['foo', 'Foo', false],
			['foo', 'f%', false],
			['foo', '%o', false],
			['foo', '%', false],
			['foo', 'fo_', false],
			['foo', 'foo_', true],
			['foo', $connection->escapeLikeParameter('fo_'), true],
			['foo', $connection->escapeLikeParameter('f%'), true],
		];
	}

	/**
	 *
	 * @param string $param1
	 * @param string $param2
	 * @param boolean $match
	 */
	#[\PHPUnit\Framework\Attributes\DataProvider('notILikeProvider')]
	public function testNotILike($param1, $param2, $match): void {
		$query = $this->connection->getQueryBuilder();

		$query->select(new Literal('1'))
			->from('users')
			->where($query->expr()->notILike($query->createNamedParameter($param1), $query->createNamedParameter($param2)));

		$result = $query->executeQuery();
		$column = $result->fetchOne();
		$result->closeCursor();
		$this->assertEquals($match, $column);
	}

	public function testCastColumn(): void {
		$appId = $this->getUniqueID('testing');
		$this->createConfig($appId, '1', '4');

		$query = $this->connection->getQueryBuilder();
		$query->update('appconfig')
			->set('configvalue',
				$query->expr()->castColumn(
					$query->createFunction(
						'(' . $query->expr()->castColumn('configvalue', IQueryBuilder::PARAM_INT)
						. ' + 1)'
					), IQueryBuilder::PARAM_STR
				)
			)
			->where($query->expr()->eq('appid', $query->createNamedParameter($appId)))
			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('1')));

		$result = $query->executeStatement();
		$this->assertEquals(1, $result);
	}

	public function testLongText(): void {
		$appId = $this->getUniqueID('testing');
		$this->createConfig($appId, 'mykey', 'myvalue');

		$query = $this->connection->getQueryBuilder();
		$query->select('*')
			->from('appconfig')
			->where($query->expr()->eq('appid', $query->createNamedParameter($appId)))
			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('mykey')))
			->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('myvalue', IQueryBuilder::PARAM_STR), IQueryBuilder::PARAM_STR));

		$result = $query->executeQuery();
		$entries = $result->fetchAllAssociative();
		$result->closeCursor();
		self::assertCount(1, $entries);
		self::assertEquals('myvalue', $entries[0]['configvalue']);
	}

	public function testJson(): void {
		$appId = $this->getUniqueID('testing');
		$query = $this->connection->getQueryBuilder();
		$query->insert('share')
			->values([
				'uid_owner' => $query->createNamedParameter('uid_owner'),
				'item_type' => $query->createNamedParameter('item_type'),
				'permissions' => $query->createNamedParameter(0),
				'stime' => $query->createNamedParameter(0),
				'accepted' => $query->createNamedParameter(0),
				'mail_send' => $query->createNamedParameter(0),
				'share_type' => $query->createNamedParameter(0),
				'share_with' => $query->createNamedParameter($appId),
				'attributes' => $query->createNamedParameter('[["permissions","before"]]'),
			])
			->executeStatement();

		$query = $this->connection->getQueryBuilder();
		$query->update('share')
			->set('attributes', $query->createNamedParameter('[["permissions","after"]]'));
		if ($this->connection->getDatabaseProvider(true) === IDBConnection::PLATFORM_MYSQL) {
			$query->where($query->expr()->eq('attributes', $query->createFunction("JSON_ARRAY(JSON_ARRAY('permissions','before'))"), IQueryBuilder::PARAM_JSON));
		} else {
			$query->where($query->expr()->eq('attributes', $query->createNamedParameter('[["permissions","before"]]'), IQueryBuilder::PARAM_JSON));
		}
		$query->executeStatement();

		$query = $this->connection->getQueryBuilder();
		$query->select('attributes')
			->from('share')
			->where($query->expr()->eq('share_with', $query->createNamedParameter($appId)));

		$result = $query->executeQuery();
		$entries = $result->fetchAll();
		$result->closeCursor();
		self::assertCount(1, $entries);
		self::assertEquals([['permissions','after']], json_decode($entries[0]['attributes'], true));
	}

	public function testDateTimeEquals(): void {
		$dateTime = new \DateTime('2023-01-01');
		$insert = $this->connection->getQueryBuilder();
		$insert->insert('testing')
			->values(['datetime' => $insert->createNamedParameter($dateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE)])
			->executeStatement();

		$query = $this->connection->getQueryBuilder();
		$result = $query->select('*')
			->from('testing')
			->where($query->expr()->eq('datetime', $query->createNamedParameter($dateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE)))
			->executeQuery();
		$entries = $result->fetchAllAssociative();
		$result->closeCursor();
		self::assertCount(1, $entries);
	}

	public function testDateTimeLess(): void {
		$dateTime = new \DateTime('2022-01-01');
		$dateTimeCompare = new \DateTime('2022-01-02');
		$insert = $this->connection->getQueryBuilder();
		$insert->insert('testing')
			->values(['datetime' => $insert->createNamedParameter($dateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE)])
			->executeStatement();

		$query = $this->connection->getQueryBuilder();
		$result = $query->select('*')
			->from('testing')
			->where($query->expr()->lt('datetime', $query->createNamedParameter($dateTimeCompare, IQueryBuilder::PARAM_DATETIME_MUTABLE)))
			->executeQuery();
		$entries = $result->fetchAllAssociative();
		$result->closeCursor();
		self::assertCount(1, $entries);
	}

	public function testDateTimeGreater(): void {
		$dateTime = new \DateTime('2023-01-02');
		$dateTimeCompare = new \DateTime('2023-01-01');
		$insert = $this->connection->getQueryBuilder();
		$insert->insert('testing')
			->values(['datetime' => $insert->createNamedParameter($dateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE)])
			->executeStatement();

		$query = $this->connection->getQueryBuilder();
		$result = $query->select('*')
			->from('testing')
			->where($query->expr()->gt('datetime', $query->createNamedParameter($dateTimeCompare, IQueryBuilder::PARAM_DATETIME_MUTABLE)))
			->executeQuery();
		$entries = $result->fetchAllAssociative();
		$result->closeCursor();
		self::assertCount(1, $entries);
	}

	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),
			])
			->executeStatement();
	}

	protected function prepareTestingTable(): void {
		if ($this->schemaSetup) {
			$this->connection->getQueryBuilder()->delete('testing')->executeStatement();
		}

		$prefix = Server::get(IConfig::class)->getSystemValueString('dbtableprefix', 'oc_');
		$schema = $this->connection->createSchema();
		try {
			$schema->getTable($prefix . 'testing');
			$this->connection->getQueryBuilder()->delete('testing')->executeStatement();
		} catch (SchemaException $e) {
			$this->schemaSetup = true;
			$table = $schema->createTable($prefix . 'testing');
			$table->addColumn('id', Types::BIGINT, [
				'autoincrement' => true,
				'notnull' => true,
			]);

			$table->addColumn('datetime', Types::DATETIME, [
				'notnull' => false,
			]);

			$table->setPrimaryKey(['id']);
			$this->connection->migrateToSchema($schema);
		}
	}
}