DbDumpTrait::dumpTable() - Code Metrics - Inspection of "New trait for db dump functions." - lagdo/jaxon-dbadmin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( acbf0f...7dd0c5 )

by Thierry

created 2021-12-23 06:23 UTC

DbDumpTrait::dumpTable() B

↳ Parent: DbDumpTrait

Complexity

Conditions	10
Paths	9

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	14
c	1
b	0
f	0
nc	9
nop	4
dl	0
loc	18
rs	7.6666

How to fix Complexity

<?php

namespace Lagdo\DbAdmin\DbAdmin\Traits;

use Lagdo\DbAdmin\Driver\Db\StatementInterface;
use Lagdo\DbAdmin\Driver\Entity\TableEntity;

use function strlen;
use function in_array;
use function preg_match;
use function str_replace;
use function implode;
use function is_numeric;
use function array_keys;
use function array_map;

trait DbDumpTrait
{
    /**
     * The dump options
     *
     * @var array
     */
    private $options;

    /**
     * The queries generated by the dump
     *
     * @var array
     */
    private $queries = [];

    // Temp vars for data dumps
    private $insert = '';
    private $buffer = '';
    private $suffix = '';
    private $views = [];
    private $fkeys = [];

    /**
     * Print CSV row
     *
     * @param array  $row
     *
     * @return void
     */
    private function dumpCsv(array $row)
    {
        // From functions.inc.php
        foreach ($row as $key => $val) {
            if (preg_match('~["\n,;\t]|^0|\.\d*0$~', $val) || $val === '') {
                $row[$key] = '"' . str_replace('"', '""', $val) . '"';
            }
        }
        $separator = $this->options['format'] == 'csv' ? ',' :
            ($this->options['format'] == 'tsv' ? "\t" : ';');
        $this->queries[] = implode($separator, $row);
    }

    /**
     * Convert a value to string
     *
     * @param mixed  $val
     * @param object $field
     *
     * @return string
     */
    private function convertToString($val, $field): string
    {
        // From functions.inc.php
        if ($val === null) {
            return 'NULL';
        }
        return $this->driver->unconvertField($field, preg_match($this->driver->numberRegex(), $field->type) &&
        !preg_match('~\[~', $field->fullType) && is_numeric($val) ?
            $val : $this->driver->quote(($val === false ? 0 : $val)));
    }

    /**
     * Export table structure
     *
     * @param string $table
     * @param string $style
     * @param int    $tableType       0 table, 1 view, 2 temporary view table
     *
     * @return null prints data
     */
    private function dumpTableOrView(string $table, string $style, int $tableType = 0)
    {
        // From adminer.inc.php
        if ($this->options['format'] != 'sql') {
            $this->queries[] = "\xef\xbb\xbf"; // UTF-8 byte order mark
            if ($style) {
                $this->dumpCsv(array_keys($this->driver->fields($table)));
            }
            return;
        }

        if ($tableType == 2) {
            $fields = [];
            foreach ($this->driver->fields($table) as $name => $field) {
                $fields[] = $this->driver->escapeId($name) . ' ' . $field->fullType;
            }
            $create = 'CREATE TABLE ' . $this->driver->table($table) . ' (' . implode(', ', $fields) . ')';
        } else {
            $create = $this->driver->sqlForCreateTable($table, $this->options['autoIncrement'], $style);
        }
        $this->driver->setUtf8mb4($create);
        if ($style && $create) {
            if ($style == 'DROP+CREATE' || $tableType == 1) {
                $this->queries[] = 'DROP ' . ($tableType == 2 ? 'VIEW' : 'TABLE') .
                    ' IF EXISTS ' . $this->driver->table($table) . ';';
            }
            if ($tableType == 1) {
                $create = $this->admin->removeDefiner($create);
            }
            $this->queries[] = $create . ';';
        }
    }

    /**
     * @param array $row
     * @param StatementInterface $statement
     *
     * @return array
     */
    private function getDataRowKeys(array $row, StatementInterface $statement): array
    {
        $values = [];
        $keys = [];
        foreach ($row as $val) {
            $field = $statement->fetchField();
            $keys[] = $field->name();
            $key = $this->driver->escapeId($field->name());
            $values[] = "$key = VALUES($key)";
        }
        $this->suffix = ";\n";
        if ($this->options['data_style'] == 'INSERT+UPDATE') {
            $this->suffix = "\nON DUPLICATE KEY UPDATE " . implode(', ', $values) . ";\n";
        }
        return $keys;
    }

    /**
     * @param string $table
     * @param array $fields
     * @param array $row
     * @param array $keys
     *
     * @return void
     */
    private function dumpDataRow(string $table, array $fields, array $row, array $keys)
    {
        if ($this->options['format'] != 'sql') {
            if ($this->options['data_style'] == 'table') {
                $this->dumpCsv($keys);
                $this->options['data_style'] = 'INSERT';
            }
            $this->dumpCsv($row);
        } else {
            if (!$this->insert) {
                $this->insert = 'INSERT INTO ' . $this->driver->table($table) . ' (' .
                    implode(', ', array_map(function ($key) {
                        return $this->driver->escapeId($key);
                    }, $keys)) . ') VALUES';
            }
            foreach ($row as $key => $val) {
                $field = $fields[$key];
                $row[$key] = $this->convertToString($val, $field);
            }
            $max_packet = ($this->driver->jush() == 'sqlite' ? 0 : 1048576); // default, minimum is 1024
            $s = ($max_packet ? "\n" : ' ') . '(' . implode(",\t", $row) . ')';
            if (!$this->buffer) {
                $this->buffer = $this->insert . $s;
            } elseif (strlen($this->buffer) + 4 + strlen($s) + strlen($this->suffix) < $max_packet) { // 4 - length specification
                $this->buffer .= ",$s";
            } else {
                $this->queries[] = $this->buffer . $this->suffix;
                $this->buffer = $this->insert . $s;
            }
        }
    }

    /** Export table data
     *
     * @param string $table
     * @param string $query
     *
     * @return null prints data
     */
    private function dumpData(string $table, string $query)
    {
        $fields = [];
        if ($this->options['data_style']) {
            if ($this->options['format'] == 'sql') {
                if ($this->options['data_style'] == 'TRUNCATE+INSERT') {
                    $this->queries[] = $this->driver->sqlForTruncateTable($table) . ";\n";
                }
                $fields = $this->driver->fields($table);
            }
            $statement = $this->driver->query($query); // 1 - MYSQLI_USE_RESULT //! enum and set as numbers
            if ($statement) {
                $this->insert = '';
                $this->buffer = '';
                $this->suffix = '';
                $keys = [];
                $fetch_function = ($table != '' ? 'fetchAssoc' : 'fetchRow');
                while ($row = $statement->$fetch_function()) {
                    if (empty($keys)) {
                        $keys = $this->getDataRowKeys($row, $statement);
                    }
                    $this->dumpDataRow($table, $fields, $row, $keys);
                }
                if ($this->buffer) {
                    $this->queries[] = $this->buffer . $this->suffix;
                }
            } elseif ($this->options['format'] == 'sql') {
                $this->queries[] = '-- ' . str_replace("\n", ' ', $this->driver->error()) . "\n";
            }
        }
    }

    /**
     * @param string $table
     * @param TableEntity $tableStatus
     * @param bool $dumpTable
     * @param bool $dumpData
     *
     * @return void
     */
    private function dumpTable(string $table, TableEntity $tableStatus, bool $dumpTable, bool $dumpData)
    {
        if ($dumpTable || $dumpData) {
            $this->dumpTableOrView($table, ($dumpTable ? $this->options['table_style'] : ''));
            if ($dumpData) {
                $fields = $this->driver->fields($table);
                $query = 'SELECT *' . $this->driver->convertFields($fields, $fields) .
                    ' FROM ' . $this->driver->table($table);
                $this->dumpData($table, $query);
            }
            if ($this->options['is_sql'] && $this->options['triggers'] && $dumpTable &&
                ($triggers = $this->driver->sqlForCreateTrigger($table))) {
                $this->queries[] = 'DELIMITER ;';
                $this->queries[] = $triggers;
                $this->queries[] = 'DELIMITER ;';
            }
            if ($this->options['is_sql']) {
                $this->queries[] = '';
            }
        }
    }

    /**
     * Dump tables
     *
     * @param string $database      The database name
     *
     * @return void
     */
    private function dumpTables(string $database)
    {
        $dbDumpTable = $this->tables['list'] === '*' && in_array($database, $this->databases['list']);
        $dbDumpData = in_array($database, $this->databases['data']);
        $this->views = []; // View names
        $this->fkeys = []; // Table names for foreign keys
        $dbTables = $this->driver->tableStatuses(true);
        foreach ($dbTables as $table => $tableStatus) {
            $isView = $this->driver->isView($tableStatus);
            if ($isView) {
                // The views will be dumped after the tables
                $this->views[] = $table;
                continue;
            }
            $this->fkeys[] = $table;
            $dumpTable = $dbDumpTable || in_array($table, $this->tables['list']);
            $dumpData = $dbDumpData || in_array($table, $this->tables['data']);
            $this->dumpTable($table, $tableStatus, $dumpTable, $dumpData);
        }
    }

    /**
     * @return void
     */
    private function dumpViewsAndFKeys()
    {
        // Add FKs after creating tables (except in MySQL which uses SET FOREIGN_KEY_CHECKS=0)
        if ($this->driver->support('fkeys_sql')) {
            foreach ($this->fkeys as $table) {
                $this->queries[] = $this->driver->sqlForForeignKeys($table);
            }
        }
        // Dump the views after all the tables
        foreach ($this->views as $view) {
            $this->dumpTableOrView($view, $this->options['table_style'], 1);
        }
    }
}


1			<?php
2
3			namespace Lagdo\DbAdmin\DbAdmin\Traits;
4
5			use Lagdo\DbAdmin\Driver\Db\StatementInterface;
6			use Lagdo\DbAdmin\Driver\Entity\TableEntity;
7
8			use function strlen;
9			use function in_array;
10			use function preg_match;
11			use function str_replace;
12			use function implode;
13			use function is_numeric;
14			use function array_keys;
15			use function array_map;
16
17			trait DbDumpTrait
18			{
19			/**
20			* The dump options
21			*
22			* @var array
23			*/
24			private $options;
25
26			/**
27			* The queries generated by the dump
28			*
29			* @var array
30			*/
31			private $queries = [];
32
33			// Temp vars for data dumps
34			private $insert = '';
35			private $buffer = '';
36			private $suffix = '';
37			private $views = [];
38			private $fkeys = [];
39
40			/**
41			* Print CSV row
42			*
43			* @param array $row
44			*
45			* @return void
46			*/
47			private function dumpCsv(array $row)
48			{
49			// From functions.inc.php
50			foreach ($row as $key => $val) {
51			if (preg_match('~["\n,;\t]\|^0\|\.\d*0$~', $val) \|\| $val === '') {
52			$row[$key] = '"' . str_replace('"', '""', $val) . '"';
53			}
54			}
55			$separator = $this->options['format'] == 'csv' ? ',' :
56			($this->options['format'] == 'tsv' ? "\t" : ';');
57			$this->queries[] = implode($separator, $row);
58			}
59
60			/**
61			* Convert a value to string
62			*
63			* @param mixed $val
64			* @param object $field
65			*
66			* @return string
67			*/
68			private function convertToString($val, $field): string
69			{
70			// From functions.inc.php
71			if ($val === null) {
72			return 'NULL';
73			}
74			return $this->driver->unconvertField($field, preg_match($this->driver->numberRegex(), $field->type) &&
75			!preg_match('~\[~', $field->fullType) && is_numeric($val) ?
76			$val : $this->driver->quote(($val === false ? 0 : $val)));
77			}
78
79			/**
80			* Export table structure
81			*
82			* @param string $table
83			* @param string $style
84			* @param int $tableType 0 table, 1 view, 2 temporary view table
85			*
86			* @return null prints data
87			*/
88			private function dumpTableOrView(string $table, string $style, int $tableType = 0)
89			{
90			// From adminer.inc.php
91			if ($this->options['format'] != 'sql') {
92			$this->queries[] = "\xef\xbb\xbf"; // UTF-8 byte order mark
93			if ($style) {
94			$this->dumpCsv(array_keys($this->driver->fields($table)));
95			}
96			return;
97			}
98
99			if ($tableType == 2) {
100			$fields = [];
101			foreach ($this->driver->fields($table) as $name => $field) {
102			$fields[] = $this->driver->escapeId($name) . ' ' . $field->fullType;
103			}
104			$create = 'CREATE TABLE ' . $this->driver->table($table) . ' (' . implode(', ', $fields) . ')';
105			} else {
106			$create = $this->driver->sqlForCreateTable($table, $this->options['autoIncrement'], $style);
107			}
108			$this->driver->setUtf8mb4($create);
109			if ($style && $create) {
110			if ($style == 'DROP+CREATE' \|\| $tableType == 1) {
111			$this->queries[] = 'DROP ' . ($tableType == 2 ? 'VIEW' : 'TABLE') .
112			' IF EXISTS ' . $this->driver->table($table) . ';';
113			}
114			if ($tableType == 1) {
115			$create = $this->admin->removeDefiner($create);
116			}
117			$this->queries[] = $create . ';';
118			}
119			}
120
121			/**
122			* @param array $row
123			* @param StatementInterface $statement
124			*
125			* @return array
126			*/
127			private function getDataRowKeys(array $row, StatementInterface $statement): array
128			{
129			$values = [];
130			$keys = [];
131			foreach ($row as $val) {
132			$field = $statement->fetchField();
133			$keys[] = $field->name();
134			$key = $this->driver->escapeId($field->name());
135			$values[] = "$key = VALUES($key)";
136			}
137			$this->suffix = ";\n";
138			if ($this->options['data_style'] == 'INSERT+UPDATE') {
139			$this->suffix = "\nON DUPLICATE KEY UPDATE " . implode(', ', $values) . ";\n";
140			}
141			return $keys;
142			}
143
144			/**
145			* @param string $table
146			* @param array $fields
147			* @param array $row
148			* @param array $keys
149			*
150			* @return void
151			*/
152			private function dumpDataRow(string $table, array $fields, array $row, array $keys)
153			{
154			if ($this->options['format'] != 'sql') {
155			if ($this->options['data_style'] == 'table') {
156			$this->dumpCsv($keys);
157			$this->options['data_style'] = 'INSERT';
158			}
159			$this->dumpCsv($row);
160			} else {
161			if (!$this->insert) {
162			$this->insert = 'INSERT INTO ' . $this->driver->table($table) . ' (' .
163			implode(', ', array_map(function ($key) {
164			return $this->driver->escapeId($key);
165			}, $keys)) . ') VALUES';
166			}
167			foreach ($row as $key => $val) {
168			$field = $fields[$key];
169			$row[$key] = $this->convertToString($val, $field);
170			}
171			$max_packet = ($this->driver->jush() == 'sqlite' ? 0 : 1048576); // default, minimum is 1024
172			$s = ($max_packet ? "\n" : ' ') . '(' . implode(",\t", $row) . ')';
173			if (!$this->buffer) {
174			$this->buffer = $this->insert . $s;
175			} elseif (strlen($this->buffer) + 4 + strlen($s) + strlen($this->suffix) < $max_packet) { // 4 - length specification
176			$this->buffer .= ",$s";
177			} else {
178			$this->queries[] = $this->buffer . $this->suffix;
179			$this->buffer = $this->insert . $s;
180			}
181			}
182			}
183
184			/** Export table data
185			*
186			* @param string $table
187			* @param string $query
188			*
189			* @return null prints data
190			*/
191			private function dumpData(string $table, string $query)
192			{
193			$fields = [];
194			if ($this->options['data_style']) {
195			if ($this->options['format'] == 'sql') {
196			if ($this->options['data_style'] == 'TRUNCATE+INSERT') {
197			$this->queries[] = $this->driver->sqlForTruncateTable($table) . ";\n";
198			}
199			$fields = $this->driver->fields($table);
200			}
201			$statement = $this->driver->query($query); // 1 - MYSQLI_USE_RESULT //! enum and set as numbers
202			if ($statement) {
203			$this->insert = '';
204			$this->buffer = '';
205			$this->suffix = '';
206			$keys = [];
207			$fetch_function = ($table != '' ? 'fetchAssoc' : 'fetchRow');
208			while ($row = $statement->$fetch_function()) {
209			if (empty($keys)) {
210			$keys = $this->getDataRowKeys($row, $statement);
211			}
212			$this->dumpDataRow($table, $fields, $row, $keys);
213			}
214			if ($this->buffer) {
215			$this->queries[] = $this->buffer . $this->suffix;
216			}
217			} elseif ($this->options['format'] == 'sql') {
218			$this->queries[] = '-- ' . str_replace("\n", ' ', $this->driver->error()) . "\n";
219			}
220			}
221			}
222
223			/**
224			* @param string $table
225			* @param TableEntity $tableStatus
226			* @param bool $dumpTable
227			* @param bool $dumpData
228			*
229			* @return void
230			*/
231			private function dumpTable(string $table, TableEntity $tableStatus, bool $dumpTable, bool $dumpData)
232			{
233			if ($dumpTable \|\| $dumpData) {
234			$this->dumpTableOrView($table, ($dumpTable ? $this->options['table_style'] : ''));
235			if ($dumpData) {
236			$fields = $this->driver->fields($table);
237			$query = 'SELECT *' . $this->driver->convertFields($fields, $fields) .
238			' FROM ' . $this->driver->table($table);
239			$this->dumpData($table, $query);
240			}
241			if ($this->options['is_sql'] && $this->options['triggers'] && $dumpTable &&
242			($triggers = $this->driver->sqlForCreateTrigger($table))) {
243			$this->queries[] = 'DELIMITER ;';
244			$this->queries[] = $triggers;
245			$this->queries[] = 'DELIMITER ;';
246			}
247			if ($this->options['is_sql']) {
248			$this->queries[] = '';
249			}
250			}
251			}
252
253			/**
254			* Dump tables
255			*
256			* @param string $database The database name
257			*
258			* @return void
259			*/
260			private function dumpTables(string $database)
261			{
262			$dbDumpTable = $this->tables['list'] === '*' && in_array($database, $this->databases['list']);
263			$dbDumpData = in_array($database, $this->databases['data']);
264			$this->views = []; // View names
265			$this->fkeys = []; // Table names for foreign keys
266			$dbTables = $this->driver->tableStatuses(true);
267			foreach ($dbTables as $table => $tableStatus) {
268			$isView = $this->driver->isView($tableStatus);
269			if ($isView) {
270			// The views will be dumped after the tables
271			$this->views[] = $table;
272			continue;
273			}
274			$this->fkeys[] = $table;
275			$dumpTable = $dbDumpTable \|\| in_array($table, $this->tables['list']);
276			$dumpData = $dbDumpData \|\| in_array($table, $this->tables['data']);
277			$this->dumpTable($table, $tableStatus, $dumpTable, $dumpData);
278			}
279			}
280
281			/**
282			* @return void
283			*/
284			private function dumpViewsAndFKeys()
285			{
286			// Add FKs after creating tables (except in MySQL which uses SET FOREIGN_KEY_CHECKS=0)
287			if ($this->driver->support('fkeys_sql')) {
288			foreach ($this->fkeys as $table) {
289			$this->queries[] = $this->driver->sqlForForeignKeys($table);
290			}
291			}
292			// Dump the views after all the tables
293			foreach ($this->views as $view) {
294			$this->dumpTableOrView($view, $this->options['table_style'], 1);
295			}
296			}
297			}
298

lagdo / jaxon-dbadmin

Push — main ( acbf0f...7dd0c5 )

DbDumpTrait::dumpTable() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like