Db3v4l\Core\DatabaseManager\Oracle

Complexity

Total Complexity

11

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getRetrieveVersionInfoSqlAction()	0	7	1
A	getDropDatabaseSqlAction()	0	12	3
A	getCreateDatabaseSqlAction()	0	18	3
A	getListCollationsSqlAction()	0	7	1
A	getListDatabasesSqlAction()	0	7	1
A	getDropUserSqlAction()	0	6	1
A	getListUsersSqlAction()	0	8	1

<?php

Missing file doc comment

namespace Db3v4l\Core\DatabaseManager;

use Db3v4l\API\Interfaces\DatabaseManager;
use Db3v4l\API\Interfaces\SqlExecutor\Executor;
use Db3v4l\Core\SqlAction\Command;

/**
 * This DBManager uses schemas as 'database'.
 * NB: if used with Oracle >= 12, usernames have to be prefixed with c## to be 'common' (ie. in the CDB), so you might
 *     want to run everything inside a pdb...
 */

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 Oracle extends BaseManager implements DatabaseManager
{
    /**
     * Returns the sql 'action' used to list all available databases
     * @return Command

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

     * @todo for each database, retrieve the charset/collation

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

     */
    public function getListDatabasesSqlAction()
    {
        return new Command(
            "SELECT username AS Database FROM all_users WHERE oracle_maintained != 'Y' ORDER BY username;",
            function ($output, $executor) {
                /** @var Executor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $executor->resultSetToArray($output);
            }
        );
    }

    /**
     * Returns the sql 'action' used to create a new db and accompanying user
     * @param string $dbName

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

Missing parameter comment

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

     * @param string $userName

Missing parameter comment

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

     * @param string $password

Missing parameter comment

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

     * @param string $charset charset/collation name

Expected 2 spaces after parameter name; 1 found

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

     * @return Command

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

     * @throws \Exception

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

     * @todo prevent sql injection!

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

     */
    public function getCreateDatabaseSqlAction($dbName, $userName, $password, $charset = null)
    {
        //$collation = $this->getCollationName($charset);

        /// @todo throw if $charset is not the same as the db one

        if ($userName != '' && $userName != $dbName) {
            throw new \Exception("Can not create a database (schema) on Oracle with a different accompanying user");
        }

        // NB: if we use a quoted identifier for the username, logging in becomes more difficult, as it will require quotes too...
        $statements = [
            "CREATE USER $dbName IDENTIFIED BY \"$password\";",
            "GRANT CONNECT, RESOURCE TO $dbName;",
            "GRANT UNLIMITED TABLESPACE TO $dbName;",
        ];

        return new Command($statements);
    }

    /**
     * Returns the sql 'action' used to drop a db and associated user account
     * @param string $dbName

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

Missing parameter comment

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

     * @param string $userName

Missing parameter comment

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

     * @return Command

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

     * @param bool $ifExists

Tags must be grouped together in a doc comment

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @bug $ifExists = true not supported

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

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

     * @throws \Exception

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

     * @todo prevent sql injection!

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

     */
    public function getDropDatabaseSqlAction($dbName, $userName, $ifExists = false)
    {
        if ($userName != '' && $userName != $dbName) {
            throw new \Exception("Can not drop a database (schema) on Oracle with a different accompanying user");
        }

        /// @todo check support for IF EXISTS
        $statements = [
            "DROP USER $dbName CASCADE;",
        ];

        return new Command($statements);
    }

    /**
     * Returns the sql 'action' used to list all existing db users
     * @return Command

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

     */
    public function getListUsersSqlAction()
    {
        return new Command(
            // NB: we filter out 'system' users, as there are many...
            "SELECT username FROM sys.all_users WHERE oracle_maintained != 'Y' ORDER BY username;",
            function ($output, $executor) {
                /** @var Executor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $executor->resultSetToArray($output);
            }
        );
    }

    /**

Missing short description in doc comment

     * @param string $userName

Missing parameter comment

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

     * @param bool $ifExists

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @return Command

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

     * @bug $ifExists = true not supported

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

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

     * @todo prevent sql injection!

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

     * @todo we should somehow warn users that this destroys the schema too

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

     */
    public function getDropUserSqlAction($userName, $ifExists = false)
    {
        /// @todo check support for IF EXISTS

        return new Command([

The opening parenthesis of a multi-line function call should be the last content on the line.

            "DROP USER $userName CASCADE;",
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Returns the sql 'action' used to list all available collations
     * @return Command

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

     */
    public function getListCollationsSqlAction()
    {
        return new Command(
            "SELECT value AS Collation FROM v\$nls_valid_values WHERE parameter = 'CHARACTERSET' ORDER BY value;",
            function ($output, $executor) {
                /** @var Executor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $executor->resultSetToArray($output);
            }
        );
    }

    /**
     * Returns the sql 'action' used to retrieve the db instance version info
     * @return Command

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

     */
    public function getRetrieveVersionInfoSqlAction()
    {
        return new Command(
            "SELECT version_full || ' (' || banner || ')' AS version FROM  v\$version, v\$instance;",
            function ($output, $executor) {
                /** @var Executor $executor */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                return $executor->resultSetToArray($output)[0];
            }
        );
    }

    /**
     * Transform collation name into a supported one
     * @param null|string $charset so far only 'utf8' is supported...

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

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

     * @return null|string

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

     * @todo what shall we accept as valid input, ie. 'generic' charset names ? maybe do 2 passes: known-db-charset => generic => specific for each db ?

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

     *       see: https://www.iana.org/assignments/character-sets/character-sets.xhtml for IANA names
     */
    /*protected function getCollationName($charset)
    {
        if ($charset == null) {
            return null;
        }

        $charset = trim(strtolower($charset));

        // accept official iana charset name, but most dbs prefer 'utf8'...
        if ($charset == 'utf-8') {
            $charset = 'utf8';
        }

        if ($charset == 'utf8') {
            $charset = 'AL32UTF8';
        }

        return $charset;
    }*/
}