12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391 |
- <?php
- namespace OC\DB\QueryBuilder;
- use Doctrine\DBAL\Query\QueryException;
- use OC\DB\ConnectionAdapter;
- use OC\DB\Exceptions\DbalException;
- use OC\DB\QueryBuilder\ExpressionBuilder\MySqlExpressionBuilder;
- use OC\DB\QueryBuilder\ExpressionBuilder\OCIExpressionBuilder;
- use OC\DB\QueryBuilder\ExpressionBuilder\PgSqlExpressionBuilder;
- use OC\DB\QueryBuilder\ExpressionBuilder\SqliteExpressionBuilder;
- use OC\DB\QueryBuilder\FunctionBuilder\FunctionBuilder;
- use OC\DB\QueryBuilder\FunctionBuilder\OCIFunctionBuilder;
- use OC\DB\QueryBuilder\FunctionBuilder\PgSqlFunctionBuilder;
- use OC\DB\QueryBuilder\FunctionBuilder\SqliteFunctionBuilder;
- use OC\SystemConfig;
- use OCP\DB\IResult;
- use OCP\DB\QueryBuilder\ICompositeExpression;
- use OCP\DB\QueryBuilder\ILiteral;
- use OCP\DB\QueryBuilder\IParameter;
- use OCP\DB\QueryBuilder\IQueryBuilder;
- use OCP\DB\QueryBuilder\IQueryFunction;
- use OCP\IDBConnection;
- use Psr\Log\LoggerInterface;
- class QueryBuilder implements IQueryBuilder {
-
- private $connection;
-
- private $systemConfig;
- private LoggerInterface $logger;
-
- private $queryBuilder;
-
- private $helper;
-
- private $automaticTablePrefix = true;
- private bool $nonEmptyWhere = false;
-
- protected $lastInsertedTable;
- private array $selectedColumns = [];
-
- public function __construct(ConnectionAdapter $connection, SystemConfig $systemConfig, LoggerInterface $logger) {
- $this->connection = $connection;
- $this->systemConfig = $systemConfig;
- $this->logger = $logger;
- $this->queryBuilder = new \Doctrine\DBAL\Query\QueryBuilder($this->connection->getInner());
- $this->helper = new QuoteHelper();
- }
-
- public function automaticTablePrefix($enabled) {
- $this->automaticTablePrefix = (bool) $enabled;
- }
-
- public function expr() {
- return match($this->connection->getDatabaseProvider()) {
- IDBConnection::PLATFORM_ORACLE => new OCIExpressionBuilder($this->connection, $this, $this->logger),
- IDBConnection::PLATFORM_POSTGRES => new PgSqlExpressionBuilder($this->connection, $this, $this->logger),
- IDBConnection::PLATFORM_MYSQL => new MySqlExpressionBuilder($this->connection, $this, $this->logger),
- IDBConnection::PLATFORM_SQLITE => new SqliteExpressionBuilder($this->connection, $this, $this->logger),
- };
- }
-
- public function func() {
- return match($this->connection->getDatabaseProvider()) {
- IDBConnection::PLATFORM_ORACLE => new OCIFunctionBuilder($this->connection, $this, $this->helper),
- IDBConnection::PLATFORM_POSTGRES => new PgSqlFunctionBuilder($this->connection, $this, $this->helper),
- IDBConnection::PLATFORM_MYSQL => new FunctionBuilder($this->connection, $this, $this->helper),
- IDBConnection::PLATFORM_SQLITE => new SqliteFunctionBuilder($this->connection, $this, $this->helper),
- };
- }
-
- public function getType() {
- return $this->queryBuilder->getType();
- }
-
- public function getConnection() {
- return $this->connection;
- }
-
- public function getState() {
- $this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
- return $this->queryBuilder->getState();
- }
- private function prepareForExecute() {
- if ($this->systemConfig->getValue('log_query', false)) {
- try {
- $params = [];
- foreach ($this->getParameters() as $placeholder => $value) {
- if ($value instanceof \DateTime) {
- $params[] = $placeholder . ' => DateTime:\'' . $value->format('c') . '\'';
- } elseif (is_array($value)) {
- $params[] = $placeholder . ' => (\'' . implode('\', \'', $value) . '\')';
- } else {
- $params[] = $placeholder . ' => \'' . $value . '\'';
- }
- }
- if (empty($params)) {
- $this->logger->debug('DB QueryBuilder: \'{query}\'', [
- 'query' => $this->getSQL(),
- 'app' => 'core',
- ]);
- } else {
- $this->logger->debug('DB QueryBuilder: \'{query}\' with parameters: {params}', [
- 'query' => $this->getSQL(),
- 'params' => implode(', ', $params),
- 'app' => 'core',
- ]);
- }
- } catch (\Error $e) {
-
- $this->logger->error('DB QueryBuilder: error trying to log SQL query', ['exception' => $e]);
- }
- }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $tooLongOutputColumns = [];
- foreach ($this->getOutputColumns() as $column) {
- if (strlen($column) > 30) {
- $tooLongOutputColumns[] = $column;
- }
- }
- if (!empty($tooLongOutputColumns)) {
- $exception = new QueryException('More than 30 characters for an output column name are not allowed on Oracle.');
- $this->logger->error($exception->getMessage(), [
- 'query' => $this->getSQL(),
- 'columns' => $tooLongOutputColumns,
- 'app' => 'core',
- 'exception' => $exception,
- ]);
- }
- $numberOfParameters = 0;
- $hasTooLargeArrayParameter = false;
- foreach ($this->getParameters() as $parameter) {
- if (is_array($parameter)) {
- $count = count($parameter);
- $numberOfParameters += $count;
- $hasTooLargeArrayParameter = $hasTooLargeArrayParameter || ($count > 1000);
- }
- }
- if ($hasTooLargeArrayParameter) {
- $exception = new QueryException('More than 1000 expressions in a list are not allowed on Oracle.');
- $this->logger->error($exception->getMessage(), [
- 'query' => $this->getSQL(),
- 'app' => 'core',
- 'exception' => $exception,
- ]);
- }
- if ($numberOfParameters > 65535) {
- $exception = new QueryException('The number of parameters must not exceed 65535. Restriction by PostgreSQL.');
- $this->logger->error($exception->getMessage(), [
- 'query' => $this->getSQL(),
- 'app' => 'core',
- 'exception' => $exception,
- ]);
- }
- }
-
- public function execute(?IDBConnection $connection = null) {
- try {
- if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
- return $this->executeQuery($connection);
- } else {
- return $this->executeStatement($connection);
- }
- } catch (DBALException $e) {
-
-
- $previous = $e->getPrevious();
- throw $previous;
- }
- }
- public function executeQuery(?IDBConnection $connection = null): IResult {
- if ($this->getType() !== \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
- throw new \RuntimeException('Invalid query type, expected SELECT query');
- }
- $this->prepareForExecute();
- if (!$connection) {
- $connection = $this->connection;
- }
- return $connection->executeQuery(
- $this->getSQL(),
- $this->getParameters(),
- $this->getParameterTypes(),
- );
- }
- public function executeStatement(?IDBConnection $connection = null): int {
- if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::SELECT) {
- throw new \RuntimeException('Invalid query type, expected INSERT, DELETE or UPDATE statement');
- }
- $this->prepareForExecute();
- if (!$connection) {
- $connection = $this->connection;
- }
- return $connection->executeStatement(
- $this->getSQL(),
- $this->getParameters(),
- $this->getParameterTypes(),
- );
- }
-
- public function getSQL() {
- return $this->queryBuilder->getSQL();
- }
-
- public function setParameter($key, $value, $type = null) {
- $this->queryBuilder->setParameter($key, $value, $type);
- return $this;
- }
-
- public function setParameters(array $params, array $types = []) {
- $this->queryBuilder->setParameters($params, $types);
- return $this;
- }
-
- public function getParameters() {
- return $this->queryBuilder->getParameters();
- }
-
- public function getParameter($key) {
- return $this->queryBuilder->getParameter($key);
- }
-
- public function getParameterTypes() {
- return $this->queryBuilder->getParameterTypes();
- }
-
- public function getParameterType($key) {
- return $this->queryBuilder->getParameterType($key);
- }
-
- public function setFirstResult($firstResult) {
- $this->queryBuilder->setFirstResult((int) $firstResult);
- return $this;
- }
-
- public function getFirstResult() {
- return $this->queryBuilder->getFirstResult();
- }
-
- public function setMaxResults($maxResults) {
- if ($maxResults === null) {
- $this->queryBuilder->setMaxResults($maxResults);
- } else {
- $this->queryBuilder->setMaxResults((int) $maxResults);
- }
- return $this;
- }
-
- public function getMaxResults() {
- return $this->queryBuilder->getMaxResults();
- }
-
- public function select(...$selects) {
- if (count($selects) === 1 && is_array($selects[0])) {
- $selects = $selects[0];
- }
- $this->addOutputColumns($selects);
- $this->queryBuilder->select(
- $this->helper->quoteColumnNames($selects)
- );
- return $this;
- }
-
- public function selectAlias($select, $alias) {
- $this->queryBuilder->addSelect(
- $this->helper->quoteColumnName($select) . ' AS ' . $this->helper->quoteColumnName($alias)
- );
- $this->addOutputColumns([$alias]);
- return $this;
- }
-
- public function selectDistinct($select) {
- if (!is_array($select)) {
- $select = [$select];
- }
- $this->addOutputColumns($select);
- $quotedSelect = $this->helper->quoteColumnNames($select);
- $this->queryBuilder->addSelect(
- 'DISTINCT ' . implode(', ', $quotedSelect)
- );
- return $this;
- }
-
- public function addSelect(...$selects) {
- if (count($selects) === 1 && is_array($selects[0])) {
- $selects = $selects[0];
- }
- $this->addOutputColumns($selects);
- $this->queryBuilder->addSelect(
- $this->helper->quoteColumnNames($selects)
- );
- return $this;
- }
- private function addOutputColumns(array $columns): void {
- foreach ($columns as $column) {
- if (is_array($column)) {
- $this->addOutputColumns($column);
- } elseif (is_string($column) && !str_contains($column, '*')) {
- if (str_contains(strtolower($column), ' as ')) {
- [, $column] = preg_split('/ as /i', $column);
- }
- if (str_contains($column, '.')) {
- [, $column] = explode('.', $column);
- }
- $this->selectedColumns[] = $column;
- }
- }
- }
- public function getOutputColumns(): array {
- return array_unique($this->selectedColumns);
- }
-
- public function delete($delete = null, $alias = null) {
- if ($alias !== null) {
- $this->logger->debug('DELETE queries with alias are no longer supported and the provided alias is ignored', ['exception' => new \InvalidArgumentException('Table alias provided for DELETE query')]);
- }
- $this->queryBuilder->delete(
- $this->getTableName($delete),
- $alias
- );
- return $this;
- }
-
- public function update($update = null, $alias = null) {
- if ($alias !== null) {
- $this->logger->debug('UPDATE queries with alias are no longer supported and the provided alias is ignored', ['exception' => new \InvalidArgumentException('Table alias provided for UPDATE query')]);
- }
- $this->queryBuilder->update(
- $this->getTableName($update),
- $alias
- );
- return $this;
- }
-
- public function insert($insert = null) {
- $this->queryBuilder->insert(
- $this->getTableName($insert)
- );
- $this->lastInsertedTable = $insert;
- return $this;
- }
-
- public function from($from, $alias = null) {
- $this->queryBuilder->from(
- $this->getTableName($from),
- $this->quoteAlias($alias)
- );
- return $this;
- }
-
- public function join($fromAlias, $join, $alias, $condition = null) {
- $this->queryBuilder->join(
- $this->quoteAlias($fromAlias),
- $this->getTableName($join),
- $this->quoteAlias($alias),
- $condition
- );
- return $this;
- }
-
- public function innerJoin($fromAlias, $join, $alias, $condition = null) {
- $this->queryBuilder->innerJoin(
- $this->quoteAlias($fromAlias),
- $this->getTableName($join),
- $this->quoteAlias($alias),
- $condition
- );
- return $this;
- }
-
- public function leftJoin($fromAlias, $join, $alias, $condition = null) {
- $this->queryBuilder->leftJoin(
- $this->quoteAlias($fromAlias),
- $this->getTableName($join),
- $this->quoteAlias($alias),
- $condition
- );
- return $this;
- }
-
- public function rightJoin($fromAlias, $join, $alias, $condition = null) {
- $this->queryBuilder->rightJoin(
- $this->quoteAlias($fromAlias),
- $this->getTableName($join),
- $this->quoteAlias($alias),
- $condition
- );
- return $this;
- }
-
- public function set($key, $value) {
- $this->queryBuilder->set(
- $this->helper->quoteColumnName($key),
- $this->helper->quoteColumnName($value)
- );
- return $this;
- }
-
- public function where(...$predicates) {
- if ($this->nonEmptyWhere && $this->systemConfig->getValue('debug', false)) {
-
- $e = new QueryException('Using where() on non-empty WHERE part, please verify it is intentional to not call andWhere() or orWhere() instead. Otherwise consider creating a new query builder object or call resetQueryPart(\'where\') first.');
- $this->logger->warning($e->getMessage(), ['exception' => $e]);
- }
- $this->nonEmptyWhere = true;
- call_user_func_array(
- [$this->queryBuilder, 'where'],
- $predicates
- );
- return $this;
- }
-
- public function andWhere(...$where) {
- $this->nonEmptyWhere = true;
- call_user_func_array(
- [$this->queryBuilder, 'andWhere'],
- $where
- );
- return $this;
- }
-
- public function orWhere(...$where) {
- $this->nonEmptyWhere = true;
- call_user_func_array(
- [$this->queryBuilder, 'orWhere'],
- $where
- );
- return $this;
- }
-
- public function groupBy(...$groupBys) {
- if (count($groupBys) === 1 && is_array($groupBys[0])) {
- $groupBys = $groupBys[0];
- }
- call_user_func_array(
- [$this->queryBuilder, 'groupBy'],
- $this->helper->quoteColumnNames($groupBys)
- );
- return $this;
- }
-
- public function addGroupBy(...$groupBy) {
- call_user_func_array(
- [$this->queryBuilder, 'addGroupBy'],
- $this->helper->quoteColumnNames($groupBy)
- );
- return $this;
- }
-
- public function setValue($column, $value) {
- $this->queryBuilder->setValue(
- $this->helper->quoteColumnName($column),
- (string) $value
- );
- return $this;
- }
-
- public function values(array $values) {
- $quotedValues = [];
- foreach ($values as $key => $value) {
- $quotedValues[$this->helper->quoteColumnName($key)] = $value;
- }
- $this->queryBuilder->values($quotedValues);
- return $this;
- }
-
- public function having(...$having) {
- call_user_func_array(
- [$this->queryBuilder, 'having'],
- $having
- );
- return $this;
- }
-
- public function andHaving(...$having) {
- call_user_func_array(
- [$this->queryBuilder, 'andHaving'],
- $having
- );
- return $this;
- }
-
- public function orHaving(...$having) {
- call_user_func_array(
- [$this->queryBuilder, 'orHaving'],
- $having
- );
- return $this;
- }
-
- public function orderBy($sort, $order = null) {
- $this->queryBuilder->orderBy(
- $this->helper->quoteColumnName($sort),
- $order
- );
- return $this;
- }
-
- public function addOrderBy($sort, $order = null) {
- $this->queryBuilder->addOrderBy(
- $this->helper->quoteColumnName($sort),
- $order
- );
- return $this;
- }
-
- public function getQueryPart($queryPartName) {
- $this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
- return $this->queryBuilder->getQueryPart($queryPartName);
- }
-
- public function getQueryParts() {
- $this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
- return $this->queryBuilder->getQueryParts();
- }
-
- public function resetQueryParts($queryPartNames = null) {
- $this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
- $this->queryBuilder->resetQueryParts($queryPartNames);
- return $this;
- }
-
- public function resetQueryPart($queryPartName) {
- $this->logger->debug(IQueryBuilder::class . '::' . __FUNCTION__ . ' is deprecated and will be removed soon.', ['exception' => new \Exception('Deprecated call to ' . __METHOD__)]);
- $this->queryBuilder->resetQueryPart($queryPartName);
- return $this;
- }
-
- public function createNamedParameter($value, $type = IQueryBuilder::PARAM_STR, $placeHolder = null) {
- return new Parameter($this->queryBuilder->createNamedParameter($value, $type, $placeHolder));
- }
-
- public function createPositionalParameter($value, $type = IQueryBuilder::PARAM_STR) {
- return new Parameter($this->queryBuilder->createPositionalParameter($value, $type));
- }
-
- public function createParameter($name) {
- return new Parameter(':' . $name);
- }
-
- public function createFunction($call) {
- return new QueryFunction($call);
- }
-
- public function getLastInsertId(): int {
- if ($this->getType() === \Doctrine\DBAL\Query\QueryBuilder::INSERT && $this->lastInsertedTable) {
-
- $table = $this->prefixTableName($this->lastInsertedTable);
- return $this->connection->lastInsertId($table);
- }
- throw new \BadMethodCallException('Invalid call to getLastInsertId without using insert() before.');
- }
-
- public function getTableName($table) {
- if ($table instanceof IQueryFunction) {
- return (string) $table;
- }
- $table = $this->prefixTableName($table);
- return $this->helper->quoteColumnName($table);
- }
-
- public function prefixTableName(string $table): string {
- if ($this->automaticTablePrefix === false || str_starts_with($table, '*PREFIX*')) {
- return $table;
- }
- return '*PREFIX*' . $table;
- }
-
- public function getColumnName($column, $tableAlias = '') {
- if ($tableAlias !== '') {
- $tableAlias .= '.';
- }
- return $this->helper->quoteColumnName($tableAlias . $column);
- }
-
- public function quoteAlias($alias) {
- if ($alias === '' || $alias === null) {
- return $alias;
- }
- return $this->helper->quoteColumnName($alias);
- }
- public function hintShardKey(string $column, mixed $value, bool $overwrite = false): self {
- return $this;
- }
- public function runAcrossAllShards(): self {
-
- return $this;
- }
- }
|