Grammar::sqlForUseDatabase() - Code Metrics - Inspection of "Moved functions to traits." - lagdo/dbadmin-driver - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 3626c9...5c7dd3 )

by Thierry

created 2021-11-14 04:27 UTC

Grammar::sqlForUseDatabase() A

↳ Parent: Grammar

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Lagdo\DbAdmin\Driver\Db;

use Lagdo\DbAdmin\Driver\Entity\TableSelectEntity;
use Lagdo\DbAdmin\Driver\Entity\ForeignKeyEntity;
use Lagdo\DbAdmin\Driver\Entity\QueryEntity;

use Lagdo\DbAdmin\Driver\DriverInterface;
use Lagdo\DbAdmin\Driver\UtilInterface;
use Lagdo\DbAdmin\Driver\TranslatorInterface;

use function preg_match;
use function preg_quote;
use function substr;
use function strlen;
use function is_string;
use function trim;
use function rtrim;
use function intval;

abstract class Grammar implements GrammarInterface
{
    use GrammarTrait;

    /**
     * @var DriverInterface
     */
    protected $driver;

    /**
     * @var UtilInterface
     */
    protected $util;

    /**
     * @var TranslatorInterface
     */
    protected $trans;

    /**
     * @var ConnectionInterface
     */
    protected $connection;

    /**
     * The constructor
     *
     * @param DriverInterface $driver
     * @param UtilInterface $util
     * @param TranslatorInterface $trans
     * @param ConnectionInterface $connection
     */
    public function __construct(DriverInterface $driver, UtilInterface $util,
        TranslatorInterface $trans, ConnectionInterface $connection)
    {
        $this->driver = $driver;
        $this->util = $util;
        $this->trans = $trans;
        $this->connection = $connection;
    }

    /**
     * @inheritDoc
     */
    public function table(string $idf)
    {
        return $this->escapeId($idf);
    }

    /**
     * @inheritDoc
     */
    public function limit(string $query, string $where, int $limit, int $offset = 0)
    {
        $sql = " $query$where";
        if ($limit > 0) {
            $sql .= " LIMIT $limit";
            if ($offset > 0) {
                $sql .= " OFFSET $offset";
            }
        }
        return $sql;
    }

    /**
     * @inheritDoc
     */
    public function formatForeignKey(ForeignKeyEntity $foreignKey)
    {
        $database = $foreignKey->database;
        $schema = $foreignKey->schema;
        $onActions = $this->driver->actions();
        $sources = implode(', ', array_map(function ($idf) {
            return $this->escapeId($idf);
        }, $foreignKey->source));
        $targets = implode(', ', array_map(function ($idf) {
            return $this->escapeId($idf);
        }, $foreignKey->target));

        $query = " FOREIGN KEY ($sources) REFERENCES ";
        if ($database != '' && $database != $this->driver->database()) {
            $query .= $this->escapeId($database) . '.';
        }
        if ($schema != '' && $schema != $this->driver->schema()) {
            $query .= $this->escapeId($schema) . '.';
        }
        $query .= $this->table($foreignKey->table) . " ($targets)";
        if (preg_match("~^($onActions)\$~", $foreignKey->onDelete)) {
            $query .= " ON DELETE {$foreignKey->onDelete}";
        }
        if (preg_match("~^($onActions)\$~", $foreignKey->onUpdate)) {
            $query .= " ON UPDATE {$foreignKey->onUpdate}";
        }

        return $query;
    }

    /**
     * @inheritDoc
     */
    public function buildSelectQuery(TableSelectEntity $select)
    {
        $query = \implode(', ', $select->fields) . ' FROM ' . $this->table($select->table);
        $limit = +$select->limit;
        $offset = $select->page ? $limit * $select->page : 0;

        return 'SELECT' . $this->limit($query, $select->clauses, $limit, $offset);
    }

    /**
     * @inheritDoc
     */
    public function defaultValue($field)
    {
        $default = $field->default;
        return ($default === null ? '' : ' DEFAULT ' .
            (preg_match('~char|binary|text|enum|set~', $field->type) ||
            preg_match('~^(?![a-z])~i', $default) ? $this->connection->quote($default) : $default));
    }

    /**
     * @inheritDoc
     */
    public function convertFields(array $columns, array $fields, array $select = [])
    {
        $clause = '';
        foreach ($columns as $key => $val) {
            if (!empty($select) && !in_array($this->escapeId($key), $select)) {
                continue;
            }
            $as = $this->convertField($fields[$key]);
            if ($as) {
                $clause .= ', $as AS ' . $this->escapeId($key);
            }
        }
        return $clause;
    }

    /**
     * @inheritDoc
     */
    public function countRowsSql(string $table, array $where, bool $isGroup, array $groups)
    {
        $query = ' FROM ' . $this->table($table) . ($where ? ' WHERE ' . implode(' AND ', $where) : '');
        return ($isGroup && ($this->driver->jush() == 'sql' || count($groups) == 1)
            ? 'SELECT COUNT(DISTINCT ' . implode(', ', $groups) . ")$query"
            : 'SELECT COUNT(*)' . ($isGroup ? " FROM (SELECT 1$query GROUP BY " . implode(', ', $groups) . ') x' : $query)
        );
    }

    /**
     * @param QueryEntity $queryEntity
     *
     * @return bool
     */
    private function setDelimiter(QueryEntity $queryEntity)
    {
        $space = "(?:\\s|/\\*[\s\S]*?\\*/|(?:#|-- )[^\n]*\n?|--\r?\n)";
        if ($queryEntity->offset !== 0 ||
            !preg_match("~^$space*+DELIMITER\\s+(\\S+)~i", $queryEntity->queries, $match)) {
            return false;
        }
        $queryEntity->delimiter = $match[1];
        $queryEntity->queries = substr($queryEntity->queries, strlen($match[0]));
        return true;
    }

    /**
     * @param QueryEntity $queryEntity
     * @param string $found
     * @param array $match
     *
     * @return bool
     */
    private function notQuery(QueryEntity $queryEntity, string $found, array &$match)
    {
        return preg_match('(' . ($found == '/*' ? '\*/' : ($found == '[' ? ']' :
            (preg_match('~^-- |^#~', $found) ? "\n" : preg_quote($found) . "|\\\\."))) . '|$)s',
            $queryEntity->queries, $match, PREG_OFFSET_CAPTURE, $queryEntity->offset) > 0;
    }

    /**
     * Return the regular expression for queries
     *
     * @return string
     */
    abstract protected function queryRegex();
    // Original code from Adminer
    // {
    //     $parse = '[\'"' .
    //         ($this->driver->jush() == "sql" ? '`#' :
    //         ($this->driver->jush() == "sqlite" ? '`[' :
    //         ($this->driver->jush() == "mssql" ? '[' : ''))) . ']|/\*|-- |$' .
    //         ($this->driver->jush() == "pgsql" ? '|\$[^$]*\$' : '');
    //     return "\\s*|$parse";
    // }

    /**
     * @param QueryEntity $queryEntity
     *
     * @return int
     */
    private function nextQueryPos(QueryEntity $queryEntity)
    {
        // TODO: Move this to driver implementations
        $parse = $this->queryRegex();
        $delimiter = preg_quote($queryEntity->delimiter);
        // Should always match
        preg_match("($delimiter$parse)", $queryEntity->queries, $match,
            PREG_OFFSET_CAPTURE, $queryEntity->offset);
        [$found, $pos] = $match[0];
        if (!is_string($found) && $queryEntity->queries == '') {
            return -1;
        }
        $queryEntity->offset = $pos + strlen($found);
        if (empty($found) || rtrim($found) == $queryEntity->delimiter) {
            return intval($pos);
        }
        // Find matching quote or comment end
        $match = [];
        while ($this->notQuery($queryEntity, $found, $match)) {
            //! Respect sql_mode NO_BACKSLASH_ESCAPES
            $s = $match[0][0];
            $queryEntity->offset = $match[0][1] + strlen($s);
            if ($s[0] != "\\") {
                break;
            }
        }
        return 0;
    }

    /**
     * @inheritDoc
     */
    public function parseQueries(QueryEntity $queryEntity)
    {
        $queryEntity->queries = trim($queryEntity->queries);
        while ($queryEntity->queries !== '') {
            if ($this->setDelimiter($queryEntity)) {
                continue;
            }
            $pos = $this->nextQueryPos($queryEntity);
            if ($pos < 0) {
                return false;
            }
            if ($pos === 0) {
                continue;
            }
            // End of a query
            $queryEntity->query = substr($queryEntity->queries, 0, $pos);
            $queryEntity->queries = substr($queryEntity->queries, $queryEntity->offset);
            $queryEntity->offset = 0;
            return true;
        }
        return false;
    }
}


1			<?php
2
3			namespace Lagdo\DbAdmin\Driver\Db;
4
5			use Lagdo\DbAdmin\Driver\Entity\TableSelectEntity;
6			use Lagdo\DbAdmin\Driver\Entity\ForeignKeyEntity;
7			use Lagdo\DbAdmin\Driver\Entity\QueryEntity;
8
9			use Lagdo\DbAdmin\Driver\DriverInterface;
10			use Lagdo\DbAdmin\Driver\UtilInterface;
11			use Lagdo\DbAdmin\Driver\TranslatorInterface;
12
13			use function preg_match;
14			use function preg_quote;
15			use function substr;
16			use function strlen;
17			use function is_string;
18			use function trim;
19			use function rtrim;
20			use function intval;
21
22			abstract class Grammar implements GrammarInterface
23			{
24			use GrammarTrait;
25
26			/**
27			* @var DriverInterface
28			*/
29			protected $driver;
30
31			/**
32			* @var UtilInterface
33			*/
34			protected $util;
35
36			/**
37			* @var TranslatorInterface
38			*/
39			protected $trans;
40
41			/**
42			* @var ConnectionInterface
43			*/
44			protected $connection;
45
46			/**
47			* The constructor
48			*
49			* @param DriverInterface $driver
50			* @param UtilInterface $util
51			* @param TranslatorInterface $trans
52			* @param ConnectionInterface $connection
53			*/
54			public function __construct(DriverInterface $driver, UtilInterface $util,
55			TranslatorInterface $trans, ConnectionInterface $connection)
56			{
57			$this->driver = $driver;
58			$this->util = $util;
59			$this->trans = $trans;
60			$this->connection = $connection;
61			}
62
63			/**
64			* @inheritDoc
65			*/
66			public function table(string $idf)
67			{
68			return $this->escapeId($idf);
69			}
70
71			/**
72			* @inheritDoc
73			*/
74			public function limit(string $query, string $where, int $limit, int $offset = 0)
75			{
76			$sql = " $query$where";
77			if ($limit > 0) {
78			$sql .= " LIMIT $limit";
79			if ($offset > 0) {
80			$sql .= " OFFSET $offset";
81			}
82			}
83			return $sql;
84			}
85
86			/**
87			* @inheritDoc
88			*/
89			public function formatForeignKey(ForeignKeyEntity $foreignKey)
90			{
91			$database = $foreignKey->database;
92			$schema = $foreignKey->schema;
93			$onActions = $this->driver->actions();
94			$sources = implode(', ', array_map(function ($idf) {
95			return $this->escapeId($idf);
96			}, $foreignKey->source));
97			$targets = implode(', ', array_map(function ($idf) {
98			return $this->escapeId($idf);
99			}, $foreignKey->target));
100
101			$query = " FOREIGN KEY ($sources) REFERENCES ";
102			if ($database != '' && $database != $this->driver->database()) {
103			$query .= $this->escapeId($database) . '.';
104			}
105			if ($schema != '' && $schema != $this->driver->schema()) {
106			$query .= $this->escapeId($schema) . '.';
107			}
108			$query .= $this->table($foreignKey->table) . " ($targets)";
109			if (preg_match("~^($onActions)\$~", $foreignKey->onDelete)) {
110			$query .= " ON DELETE {$foreignKey->onDelete}";
111			}
112			if (preg_match("~^($onActions)\$~", $foreignKey->onUpdate)) {
113			$query .= " ON UPDATE {$foreignKey->onUpdate}";
114			}
115
116			return $query;
117			}
118
119			/**
120			* @inheritDoc
121			*/
122			public function buildSelectQuery(TableSelectEntity $select)
123			{
124			$query = \implode(', ', $select->fields) . ' FROM ' . $this->table($select->table);
125			$limit = +$select->limit;
126			$offset = $select->page ? $limit * $select->page : 0;
127
128			return 'SELECT' . $this->limit($query, $select->clauses, $limit, $offset);
129			}
130
131			/**
132			* @inheritDoc
133			*/
134			public function defaultValue($field)
135			{
136			$default = $field->default;
137			return ($default === null ? '' : ' DEFAULT ' .
138			(preg_match('~char\|binary\|text\|enum\|set~', $field->type) \|\|
139			preg_match('~^(?![a-z])~i', $default) ? $this->connection->quote($default) : $default));
140			}
141
142			/**
143			* @inheritDoc
144			*/
145			public function convertFields(array $columns, array $fields, array $select = [])
146			{
147			$clause = '';
148			foreach ($columns as $key => $val) {
149			if (!empty($select) && !in_array($this->escapeId($key), $select)) {
150			continue;
151			}
152			$as = $this->convertField($fields[$key]);
153			if ($as) {
154			$clause .= ', $as AS ' . $this->escapeId($key);
155			}
156			}
157			return $clause;
158			}
159
160			/**
161			* @inheritDoc
162			*/
163			public function countRowsSql(string $table, array $where, bool $isGroup, array $groups)
164			{
165			$query = ' FROM ' . $this->table($table) . ($where ? ' WHERE ' . implode(' AND ', $where) : '');
166			return ($isGroup && ($this->driver->jush() == 'sql' \|\| count($groups) == 1)
167			? 'SELECT COUNT(DISTINCT ' . implode(', ', $groups) . ")$query"
168			: 'SELECT COUNT(*)' . ($isGroup ? " FROM (SELECT 1$query GROUP BY " . implode(', ', $groups) . ') x' : $query)
169			);
170			}
171
172			/**
173			* @param QueryEntity $queryEntity
174			*
175			* @return bool
176			*/
177			private function setDelimiter(QueryEntity $queryEntity)
178			{
179			$space = "(?:\\s\|/\\[\s\S]?\\/\|(?:#\|-- )[^\n]\n?\|--\r?\n)";
180			if ($queryEntity->offset !== 0 \|\|
181			!preg_match("~^$space*+DELIMITER\\s+(\\S+)~i", $queryEntity->queries, $match)) {
182			return false;
183			}
184			$queryEntity->delimiter = $match[1];
185			$queryEntity->queries = substr($queryEntity->queries, strlen($match[0]));
186			return true;
187			}
188
189			/**
190			* @param QueryEntity $queryEntity
191			* @param string $found
192			* @param array $match
193			*
194			* @return bool
195			*/
196			private function notQuery(QueryEntity $queryEntity, string $found, array &$match)
197			{
198			return preg_match('(' . ($found == '/' ? '\/' : ($found == '[' ? ']' :
199			(preg_match('~^-- \|^#~', $found) ? "\n" : preg_quote($found) . "\|\\\\."))) . '\|$)s',
200			$queryEntity->queries, $match, PREG_OFFSET_CAPTURE, $queryEntity->offset) > 0;
201			}
202
203			/**
204			* Return the regular expression for queries
205			*
206			* @return string
207			*/
208			abstract protected function queryRegex();
209			// Original code from Adminer
210			// {
211			// $parse = '[\'"' .
212			// ($this->driver->jush() == "sql" ? '`#' :
213			// ($this->driver->jush() == "sqlite" ? '`[' :
214			// ($this->driver->jush() == "mssql" ? '[' : ''))) . ']\|/\*\|-- \|$' .
215			// ($this->driver->jush() == "pgsql" ? '\|\$[^$]*\$' : '');
216			// return "\\s*\|$parse";
217			// }
218
219			/**
220			* @param QueryEntity $queryEntity
221			*
222			* @return int
223			*/
224			private function nextQueryPos(QueryEntity $queryEntity)
225			{
226			// TODO: Move this to driver implementations
227			$parse = $this->queryRegex();
228			$delimiter = preg_quote($queryEntity->delimiter);
229			// Should always match
230			preg_match("($delimiter$parse)", $queryEntity->queries, $match,
231			PREG_OFFSET_CAPTURE, $queryEntity->offset);
232			[$found, $pos] = $match[0];
233			if (!is_string($found) && $queryEntity->queries == '') {
234			return -1;
235			}
236			$queryEntity->offset = $pos + strlen($found);
237			if (empty($found) \|\| rtrim($found) == $queryEntity->delimiter) {
238			return intval($pos);
239			}
240			// Find matching quote or comment end
241			$match = [];
242			while ($this->notQuery($queryEntity, $found, $match)) {
243			//! Respect sql_mode NO_BACKSLASH_ESCAPES
244			$s = $match[0][0];
245			$queryEntity->offset = $match[0][1] + strlen($s);
246			if ($s[0] != "\\") {
247			break;
248			}
249			}
250			return 0;
251			}
252
253			/**
254			* @inheritDoc
255			*/
256			public function parseQueries(QueryEntity $queryEntity)
257			{
258			$queryEntity->queries = trim($queryEntity->queries);
259			while ($queryEntity->queries !== '') {
260			if ($this->setDelimiter($queryEntity)) {
261			continue;
262			}
263			$pos = $this->nextQueryPos($queryEntity);
264			if ($pos < 0) {
265			return false;
266			}
267			if ($pos === 0) {
268			continue;
269			}
270			// End of a query
271			$queryEntity->query = substr($queryEntity->queries, 0, $pos);
272			$queryEntity->queries = substr($queryEntity->queries, $queryEntity->offset);
273			$queryEntity->offset = 0;
274			return true;
275			}
276			return false;
277			}
278			}
279

lagdo / dbadmin-driver

Push — main ( 3626c9...5c7dd3 )

Grammar::sqlForUseDatabase() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like