Db3v4l\Core\SqlExecutor\Forked\NativeClient

Complexity

Total Complexity

44

Size/Duplication

Total Lines	253
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getExecuteShellProcess()	0	3	1
A	getExecuteFileProcess()	0	3	1
A	getExecuteStatementProcess()	0	3	1
A	getDbClientType()	0	7	1
F	getProcess()	0	146	28
C	resultSetToArray()	0	51	12

<?php

Missing file doc comment

namespace Db3v4l\Core\SqlExecutor\Forked;

use Db3v4l\API\Interfaces\SqlExecutor\Forked\CommandExecutor;
use Db3v4l\API\Interfaces\SqlExecutor\Forked\FileExecutor;
use Db3v4l\API\Interfaces\SqlExecutor\Forked\ShellExecutor;
use Db3v4l\Util\Process;

/**

Missing short description in doc comment

 * @todo allow to inject path of db clients via setter/constructor
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class NativeClient extends ForkedExecutor implements CommandExecutor, FileExecutor, ShellExecutor
{
    const EXECUTION_STRATEGY = 'NativeClient';
    const EXECUTE_SHELL = 2;

    /**

Missing short description in doc comment

     * @param string $sql

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Process

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getExecuteStatementProcess($sql)
    {
        return $this->getProcess($sql, self::EXECUTE_COMMAND);
    }

    /**

Missing short description in doc comment

     * @param string $filename

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Process

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getExecuteFileProcess($filename)
    {
        return $this->getProcess($filename, self::EXECUTE_FILE);
    }

    public function getExecuteShellProcess()

Missing doc comment for function getExecuteShellProcess()

    {
        return $this->getProcess(null, self::EXECUTE_SHELL);
    }

    /**

Missing short description in doc comment

     * @param string $sqlOrFilename

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $action

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Process

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getProcess($sqlOrFilename, $action = self::EXECUTE_COMMAND)
    {
        $clientType = $this->getDbClientType($this->databaseConfiguration);

        // pass on _all_ env vars, including PATH. Not doing so is deprecated...
        $env = null;

        switch ($clientType) {
            case 'mysql':

Line indented incorrectly; expected 8 spaces, found 12

                $command = 'mysql';
                $options = [
                    '--host=' . $this->databaseConfiguration['host'],
                    '--port=' . $this->databaseConfiguration['port'] ?? '3306',
                    '--user=' . $this->databaseConfiguration['user'],
                    '-p' . $this->databaseConfiguration['password'],
                    '--binary-mode', // 'It also disables all mysql commands except charset and delimiter in non-interactive mode (for input piped to mysql or loaded using the source command)'
                    '-t',
                ];
                if (isset($this->databaseConfiguration['dbname'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = $this->databaseConfiguration['dbname'];
                }

Line indented incorrectly; expected 12 spaces, found 16

                if ($action == self::EXECUTE_COMMAND) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = '--execute=' . $sqlOrFilename;
                }

Line indented incorrectly; expected 12 spaces, found 16

               // $env = [
                    // problematic when wrapping the process in a call to `time`...
                    //'MYSQL_PWD' => $this->databaseConfiguration['password'],
                //];
                break;

            case 'psql':

Line indented incorrectly; expected 8 spaces, found 12

                $command = 'psql';
                $connectString = "postgresql://".$this->databaseConfiguration['user'].":".$this->databaseConfiguration['password'].
                    "@{$this->databaseConfiguration['host']}:".($this->databaseConfiguration['port'] ?? '5432').'/';
                if (isset($this->databaseConfiguration['dbname'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $connectString .= $this->databaseConfiguration['dbname'];
                }

Line indented incorrectly; expected 12 spaces, found 16

                $options = [
                    $connectString,
                    '-Pfooter=off'
                ];
                // NB: this triggers a different behaviour that piping multiple commands to stdin, namely
                // it wraps all of the commands in a transaction and allows either sql commands or a single meta-command
                if ($action == self::EXECUTE_COMMAND) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = '--command=' . $sqlOrFilename;
                }

Line indented incorrectly; expected 12 spaces, found 16

                //$env = [
                    // problematic when wrapping the process in a call to `time`...
                    //'PGPASSWORD' => $this->databaseConfiguration['password'],
                //];
                break;

            case 'sqlcmd':

Line indented incorrectly; expected 8 spaces, found 12

                $command = 'sqlcmd';
                $options = [
                    '-S' . $this->databaseConfiguration['host'] . ($this->databaseConfiguration['port'] != '' ?  ',' . $this->databaseConfiguration['port'] : ''),
                    '-U' . $this->databaseConfiguration['user'],
                    '-P' . $this->databaseConfiguration['password'],
                    '-r1',
                    '-b',
                ];
                if (isset($this->databaseConfiguration['dbname'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = '-d' . $this->databaseConfiguration['dbname'];
                }

Line indented incorrectly; expected 12 spaces, found 16

                if ($action == self::EXECUTE_FILE) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = '-i' . $sqlOrFilename;
                } elseif ($action == self::EXECUTE_COMMAND) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = '-Q' . $sqlOrFilename;
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;

            case 'sqlite':

Line indented incorrectly; expected 8 spaces, found 12

                $command = 'sqlite3';
                // 'path' is the full path to the 'master' db (for Doctrine compatibility).
                //  non-master dbs are supposed to reside in the same directory
                if (isset($this->databaseConfiguration['dbname'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = dirname($this->databaseConfiguration['path']) . '/' . $this->databaseConfiguration['dbname'] . '.sqlite';

$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = $this->databaseConfiguration['path'];
                }

Line indented incorrectly; expected 12 spaces, found 16

                if ($action == self::EXECUTE_COMMAND) {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = $sqlOrFilename;
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;

            case 'sqlplus':

Line indented incorrectly; expected 8 spaces, found 12

                /// @todo disable execution of dangerous (or all) SQLPLUS commands.
                ///       See the list at https://docs.oracle.com/en/database/oracle/oracle-database/18/sqpug/SQL-Plus-command-reference.html#GUID-177F24B7-D154-4F8B-A05B-7568079800C6
                $command = 'sqlplus';
                $connectionIdentifier = '//' . $this->databaseConfiguration['host'] .
                    ($this->databaseConfiguration['port'] != '' ?  ':' . $this->databaseConfiguration['port'] : '');
                // nb: for oracle, if we use pdbs to map 'databases', they get a new service name
                /// @todo allow support for _not_ doing that, and using schemas as 'databases'
                if (isset($this->databaseConfiguration['servicename'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $connectionIdentifier .= '/' . $this->databaseConfiguration['servicename'];
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    if ($this->databaseConfiguration['dbname'] != '') {

Line indented incorrectly; expected 16 spaces, found 20

                        $connectionIdentifier .= '/' . $this->databaseConfiguration['dbname'];
                    }

Line indented incorrectly; expected 16 spaces, found 20

                }

Line indented incorrectly; expected 12 spaces, found 16

                $options = [
                    '-L', // 'attempts to log in just once, instead of reprompting on error'
                    '-NOLOGINTIME',
                    '-S',
                    $this->databaseConfiguration['user'] . '/' . $this->databaseConfiguration['password'] . '@' . $connectionIdentifier,
                ];
                /// @todo make this optional somehow / allow SYSOPER as alternative
                if (strtolower($this->databaseConfiguration['user']) === 'sys') {

Line indented incorrectly; expected 12 spaces, found 16

                    $options[] = 'AS';
                    $options[] = 'SYSDBA';
                }

Line indented incorrectly; expected 12 spaces, found 16

                if ($action == self::EXECUTE_FILE) {

Line indented incorrectly; expected 12 spaces, found 16

                    /// @todo wouldn't it be better to create another temp file with prefixed the sqlplus commands?
                    //$options[] = '@' . $sqlOrFilename;
                    $sqlOrFilename = "WHENEVER OSERROR EXIT FAILURE;\nWHENEVER SQLERROR EXIT SQL.SQLCODE;\nSET PAGESIZE 50000;\nSET FEEDBACK OFF;\n" . file_get_contents($sqlOrFilename);
                    $action = self::EXECUTE_COMMAND;
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $sqlOrFilename = "WHENEVER OSERROR EXIT FAILURE;\nWHENEVER SQLERROR EXIT SQL.SQLCODE;\nSET PAGESIZE 50000;\nSET FEEDBACK OFF;\n" . $sqlOrFilename;
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;

                default:

Line indented incorrectly; expected 8 spaces, found 16

                throw new \OutOfBoundsException("Unsupported db client '$clientType'");

Case breaking statement indented incorrectly; expected 20 spaces, found 16

        }

        $commandLine = $this->buildCommandLine($command, $options);

        /// @todo investigate: for psql is this better done via --file ?
        if ($action == self::EXECUTE_FILE && $clientType != 'sqlsrv' && $clientType != 'sqlplus') {
            $commandLine .= ' < ' . escapeshellarg($sqlOrFilename);
        }

        if ($action == self::EXECUTE_COMMAND && $clientType == 'sqlplus') {
            $commandLine .= " << 'SQLEOF'\n" . $sqlOrFilename . "\nSQLEOF";
        }

        $process = Process::fromShellCommandline($commandLine, null, $env);

        if ($action == self::EXECUTE_COMMAND && $clientType == 'sqlplus') {
            // The way Symfony Process deals with sighchildEnabled breaks EOF handling. We disable it
            $process->forceSigchildEnabledIndividually(false);
        }

        return $process;
    }

    /**

Missing short description in doc comment

     * @see https://www.doctrine-project.org/projects/doctrine-dbal/en/2.10/reference/configuration.html for supported aliases

Tag @see cannot be grouped with parameter tags in a doc comment

Tag value for @see tag indented incorrectly; expected 4 spaces but found 1

     * @param array $connectionConfiguration

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getDbClientType(array $connectionConfiguration)
    {
        $vendor = $connectionConfiguration['vendor'];
        return str_replace(
            array('mariadb', 'mssql', 'oracle', 'percona', 'postgresql'),
            array('mysql', 'sqlcmd', 'sqlplus', 'mysql', 'psql'),
            $vendor
        );
    }

    /**
     * Transforms a resultSet string, formatted as per the default way of the db client, into an array
     * @todo tested on single-column SELECTs so far

There must be exactly one blank line before the tags in a doc comment

Tag @todo cannot be grouped with parameter tags in a doc comment

Tag value for @todo tag indented incorrectly; expected 3 spaces but found 1

     * @param $string

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string[]

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function resultSetToArray($string)
    {
        switch ($this->databaseConfiguration['vendor']) {
            case 'mariadb':

Line indented incorrectly; expected 8 spaces, found 12

            case 'mysql':

Line indented incorrectly; expected 8 spaces, found 12

            case 'percona':

Line indented incorrectly; expected 8 spaces, found 12

                // 'table format', triggered by using the -t option for the client
                // NB: both mariadb and mysql output no headers line when resultset has 0 rows
                $output = explode("\n", $string);
                array_shift($output); // '+--+'
                array_shift($output); // headers
                array_shift($output); // '+--+'
                array_pop($output); // '+--+'
                foreach($output as &$line) {

Line indented incorrectly; expected 12 spaces, found 16

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $line = trim($line, '|');
                    $line = trim($line);
                }

Line indented incorrectly; expected 12 spaces, found 16

                return $output;
            case 'oracle':

Line indented incorrectly; expected 8 spaces, found 12

                $output = explode("\n", $string);
                array_shift($output); // empty line
                array_shift($output); // headers
                array_shift($output); // '---'
                foreach($output as &$line) {

Line indented incorrectly; expected 12 spaces, found 16

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $line = trim($line);
                }

Line indented incorrectly; expected 12 spaces, found 16

                return $output;
            case 'postgresql':

Line indented incorrectly; expected 8 spaces, found 12

                $output = explode("\n", $string);
                array_shift($output); // headers
                array_shift($output); // '---'
                //array_pop($output); // '(N rows)'
                foreach($output as &$line) {

Line indented incorrectly; expected 12 spaces, found 16

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $line = trim($line);
                }

Line indented incorrectly; expected 12 spaces, found 16

                return $output;
            case 'sqlite':

Line indented incorrectly; expected 8 spaces, found 12

                $output = explode("\n", $string);
                return $output;
            case 'mssql':

Line indented incorrectly; expected 8 spaces, found 12

                $output = explode("\n", $string);
                array_shift($output);
                array_shift($output); // '---'
                array_pop($output); // blank line
                array_pop($output); // '(N rows affected)'
                foreach($output as &$line) {

Line indented incorrectly; expected 12 spaces, found 16

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $line = trim($line);
                }

Line indented incorrectly; expected 12 spaces, found 16

                return $output;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                throw new \OutOfBoundsException("Unsupported database type '{$this->databaseConfiguration['vendor']}'");
        }
    }
}