class.ilDBPdoManager.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Services\Database\PDO\FieldDefinition\ForeignKeyConstraints;

class ilDBPdoManager implements ilDBManager, ilDBPdoManagerInterface
{
    protected ?\ilQueryUtils $query_utils = null;

    public function __construct(protected \PDO $pdo, protected \ilDBPdo $db_instance)
    {
    }

    public function getQueryUtils(): \ilQueryUtils
    {
        if ($this->query_utils === null) {
            $this->query_utils = new ilMySQLQueryUtils($this->db_instance);
        }

        return $this->query_utils;
    }

    public function getDBInstance(): \ilDBPdo
    {
        return $this->db_instance;
    }

    public function listTables(?string $database = null): array
    {
        $str = 'SHOW TABLES ' . ($database ? ' IN ' . $database : '');
        $r = $this->pdo->query($str);
        $tables = [];

        $sequence_identifier = "_seq";
        while ($data = $r->fetchColumn()) {
            if (!preg_match("/$sequence_identifier$/um", $data)) {
                $tables[] = $data;
            }
        }

        return $tables;
    }

    protected function fixSequenceName(string $sqn, bool $check = false): string
    {
        $seq_pattern = '/^' . preg_replace('/%s/', '([a-z0-9_]+)', ilDBConstants::SEQUENCE_FORMAT) . '$/i';
        $seq_name = preg_replace($seq_pattern, '\\1', $sqn);
        if ($seq_name && !strcasecmp($sqn, $this->db_instance->getSequenceName($seq_name))) {
            return $seq_name;
        }

        return $sqn;
    }

    public function listSequences(?string $database = null): array
    {
        $query = "SHOW TABLES LIKE '%_seq'";
        if (!is_null($database)) {
            $query .= " FROM $database";
        }

        $res = $this->db_instance->query($query);

        $result = [];
        while ($table_name = $this->db_instance->fetchAssoc($res)) {
            $sqn = $this->fixSequenceName(reset($table_name), true);
            if ($sqn !== '' && $sqn !== '0') {
                $result[] = $sqn;
            }
        }
        if ($this->db_instance->options['portability'] ?? null) {
            return array_map(
                ($this->db_instance->options['field_case'] === CASE_LOWER ? 'strtolower' : 'strtoupper'),
                $result
            );
        }

        return $result;
    }

    public function createConstraint(string $table, string $name, array $definition): bool
    {
        $db = $this->db_instance;

        $table = $db->quoteIdentifier($table, true);
        $name = $db->quoteIdentifier($db->getIndexName($name), true);
        $query = "ALTER TABLE $table ADD CONSTRAINT $name";
        if (!empty($definition['primary'])) {
            $query .= ' PRIMARY KEY';
        } elseif (!empty($definition['unique'])) {
            $query .= ' UNIQUE';
        }
        $fields = [];
        foreach (array_keys($definition['fields']) as $field) {
            $fields[] = $db->quoteIdentifier($field, true);
        }
        $query .= ' (' . implode(', ', $fields) . ')';

        return (bool) $this->pdo->exec($query);
    }

    public function createSequence(string $seq_name, int $start = 1, array $options = []): bool
    {
        $sequence_name = $this->db_instance->quoteIdentifier($this->db_instance->getSequenceName($seq_name));
        $seqcol_name = $this->db_instance->quoteIdentifier(ilDBConstants::SEQUENCE_COLUMNS_NAME);

        $options_strings = [];

        if (!empty($options['comment'])) {
            $options_strings['comment'] = 'COMMENT = ' . $this->db_instance->quote($options['comment'], 'text');
        }

        if (!empty($options['charset'])) {
            $options_strings['charset'] = 'DEFAULT CHARACTER SET ' . $options['charset'];
            if (!empty($options['collate'])) {
                $options_strings['charset'] .= ' COLLATE ' . $options['collate'];
            }
        }

        $type = false;
        if (!empty($options['type'])) {
            $type = $options['type'];
        }
        if ($type) {
            $options_strings[] = "ENGINE = $type";
        }

        $query = "CREATE TABLE $sequence_name ($seqcol_name INT NOT NULL AUTO_INCREMENT, PRIMARY KEY ($seqcol_name))";

        if (!empty($options_strings)) {
            $query .= ' ' . implode(' ', $options_strings);
        }
        $this->pdo->exec($query);

        if ($start == 1) {
            return true;
        }

        $query = "INSERT INTO $sequence_name ($seqcol_name) VALUES (" . ($start - 1) . ')';
        $this->pdo->exec($query);

        return true;
    }

    public function alterTable(string $name, array $changes, bool $check): bool
    {
        $db = $this->db_instance;

        foreach (array_keys($changes) as $change_name) {
            switch ($change_name) {
                case 'add':
                case 'remove':
                case 'change':
                case 'rename':
                case 'name':
                    break;
                default:
                    throw new ilDatabaseException('change type "' . $change_name . '" not yet supported');
            }
        }

        if ($check) {
            return true;
        }

        $query = '';
        if (!empty($changes['name'])) {
            $change_name = $db->quoteIdentifier($changes['name']);
            $query .= 'RENAME TO ' . $change_name;
        }

        if (!empty($changes['add']) && is_array($changes['add'])) {
            foreach ($changes['add'] as $field_name => $field) {
                if ($query !== '') {
                    $query .= ', ';
                }
                $fd = $db->getFieldDefinition();
                if ($fd !== null) {
                    $query .= 'ADD ' . $fd->getDeclaration($field['type'], $field_name, $field);
                }
            }
        }

        if (!empty($changes['remove']) && is_array($changes['remove'])) {
            foreach (array_keys($changes['remove']) as $field_name) {
                if ($query !== '') {
                    $query .= ', ';
                }
                $field_name = $db->quoteIdentifier($field_name);
                $query .= 'DROP ' . $field_name;
            }
        }

        $rename = [];
        if (!empty($changes['rename']) && is_array($changes['rename'])) {
            foreach ($changes['rename'] as $field_name => $field) {
                $rename[$field['name']] = $field_name;
            }
        }

        if (!empty($changes['change']) && is_array($changes['change'])) {
            foreach ($changes['change'] as $field_name => $field) {
                if ($query !== '') {
                    $query .= ', ';
                }
                if (isset($rename[$field_name])) {
                    $old_field_name = $rename[$field_name];
                    unset($rename[$field_name]);
                } else {
                    $old_field_name = $field_name;
                }
                $old_field_name = $db->quoteIdentifier($old_field_name);
                $fd = $this->db_instance->getFieldDefinition();
                if ($fd !== null) {
                    $query .= "CHANGE $old_field_name " . $fd
                            ->getDeclaration(
                                $field['definition']['type'],
                                $field_name,
                                $field['definition']
                            );
                }
            }
        }

        if (!empty($rename) && is_array($rename)) {
            foreach ($rename as $renamed_field) {
                if ($query !== '') {
                    $query .= ', ';
                }
                $field = $changes['rename'][$renamed_field];
                $renamed_field = $db->quoteIdentifier($renamed_field);
                $fd = $this->db_instance->getFieldDefinition();
                if ($fd !== null) {
                    $query .= 'CHANGE ' . $renamed_field . ' ' . $fd
                            ->getDeclaration(
                                $field['definition']['type'],
                                $field['name'],
                                $field['definition']
                            );
                }
            }
        }

        if ($query === '') {
            return true;
        }

        $name = $db->quoteIdentifier($name, true);

        $statement = "ALTER TABLE $name $query";

        return (bool) $this->pdo->exec($statement);
    }

    public function createTable(string $name, array $fields, array $options = []): bool
    {
        $options['type'] = $this->db_instance->getStorageEngine();

        return (bool) $this->pdo->exec($this->getQueryUtils()->createTable($name, $fields, $options));
    }

    public function getIndexName(string $idx): string
    {
        return $this->db_instance->getIndexName($idx);
    }

    public function getSequenceName(string $sqn): string
    {
        return $this->db_instance->getSequenceName($sqn);
    }

    public function listTableFields(string $table): array
    {
        $table = $this->db_instance->quoteIdentifier($table);
        $query = "SHOW COLUMNS FROM $table";
        $result = $this->db_instance->query($query);
        $return = [];
        while ($data = $this->db_instance->fetchObject($result)) {
            $return[] = $data->Field;
        }

        return $return;
    }

    public function listTableConstraints(string $table): array
    {
        $key_name = 'Key_name';
        $non_unique = 'Non_unique';

        $db = $this->getDBInstance();
        if ($db->options['portability'] ?? null) {
            if ($db->options['field_case'] == CASE_LOWER) {
                $key_name = strtolower($key_name);
                $non_unique = strtolower($non_unique);
            } else {
                $key_name = strtoupper($key_name);
                $non_unique = strtoupper($non_unique);
            }
        }

        $table = $this->db_instance->quoteIdentifier($table);
        $query = "SHOW INDEX FROM $table";
        $result_set = $this->db_instance->query($query);

        $result = [];
        while ($index_data = $this->db_instance->fetchAssoc($result_set)) {
            if (!$index_data[$non_unique]) {
                $index = $index_data[$key_name] !== 'PRIMARY' ? $this->fixIndexName($index_data[$key_name]) : 'PRIMARY';
                if (!empty($index)) {
                    $index = strtolower($index);
                    $result[$index] = true;
                }
            }
        }

        if ($this->db_instance->options['portability'] ?? null) {
            $result = array_change_key_case($result, $this->db_instance->options['field_case']);
        }

        return array_keys($result);
    }

    public function listTableIndexes(string $table): array
    {
        $key_name = 'Key_name';
        $non_unique = 'Non_unique';
        if ($this->db_instance->options['portability'] ?? null) {
            if ($this->db_instance->options['field_case'] == CASE_LOWER) {
                $key_name = strtolower($key_name);
                $non_unique = strtolower($non_unique);
            } else {
                $key_name = strtoupper($key_name);
                $non_unique = strtoupper($non_unique);
            }
        }

        $table = $this->db_instance->quoteIdentifier($table);
        $query = "SHOW INDEX FROM $table";
        $result_set = $this->db_instance->query($query);
        $indexes = [];
        while ($index_data = $this->db_instance->fetchAssoc($result_set)) {
            $indexes[] = $index_data;
        }
        $result = [];
        foreach ($indexes as $index_data) {
            if ($index_data[$non_unique] && ($index = $this->fixIndexName($index_data[$key_name]))) {
                $result[$index] = true;
            }
        }

        if ($this->db_instance->options['portability'] ?? null) {
            $result = array_change_key_case($result, $this->db_instance->options['field_case']);
        }

        return array_keys($result);
    }

    protected function fixIndexName(string $idx): string
    {
        $idx_pattern = '/^' . preg_replace('/%s/', '([a-z0-9_]+)', ilDBPdoFieldDefinition::INDEX_FORMAT) . '$/i';
        $idx_name = preg_replace($idx_pattern, '\\1', $idx);
        if ($idx_name && !strcasecmp($idx, $this->db_instance->getIndexName($idx_name))) {
            return $idx_name;
        }

        return $idx;
    }

    public function createIndex(string $table, string $name, array $definition): bool
    {
        $table = $this->db_instance->quoteIdentifier($table, true);
        $name = $this->db_instance->quoteIdentifier($this->db_instance->getIndexName($name), true);
        $query = "CREATE INDEX $name ON $table";
        $fields = [];
        foreach ($definition['fields'] as $field => $fieldinfo) {
            if (!empty($fieldinfo['length'])) {
                $fields[] = $this->db_instance->quoteIdentifier($field, true) . '(' . $fieldinfo['length'] . ')';
            } else {
                $fields[] = $this->db_instance->quoteIdentifier($field, true);
            }
        }
        $query .= ' (' . implode(', ', $fields) . ')';

        return (bool) $this->pdo->exec($query);
    }

    public function dropIndex(string $table, string $name): bool
    {
        $table = $this->db_instance->quoteIdentifier($table, true);
        $name = $this->db_instance->quoteIdentifier($this->db_instance->getIndexName($name), true);

        return (bool) $this->pdo->exec("DROP INDEX $name ON $table");
    }

    public function dropSequence(string $seq_name): bool
    {
        $sequence_name = $this->db_instance->quoteIdentifier($this->db_instance->getSequenceName($seq_name));

        return (bool) $this->pdo->exec("DROP TABLE $sequence_name");
    }

    public function getTableCreationQuery(string $name, array $fields, array $options = []): string
    {
        return $this->getQueryUtils()->createTable($name, $fields, $options);
    }

    public function dropConstraint(string $table, string $name, bool $primary = false): bool
    {
        $db = $this->getDBInstance();
        $table = $db->quoteIdentifier($table, true);
        if ($primary || strtolower($name) === 'primary') {
            $query = "ALTER TABLE $table DROP PRIMARY KEY";
        } else {
            $name = $db->quoteIdentifier($db->getIndexName($name), true);
            $query = "ALTER TABLE $table DROP INDEX $name";
        }

        return (bool) $this->pdo->exec($query);
    }

    public function dropTable(string $name): bool
    {
        $db = $this->getDBInstance();
        $name = $db->quoteIdentifier($name, true);

        return (bool) $this->pdo->exec("DROP TABLE $name");
    }

    public function addForeignKey(
        string $foreign_key_name,
        array $field_names,
        string $table_name,
        array $reference_field_names,
        string $reference_table,
        ?ForeignKeyConstraints $on_update = null,
        ?ForeignKeyConstraints $on_delete = null
    ): bool {
        $table = $this->db_instance->quoteIdentifier($table_name, true);
        $reference_table = $this->db_instance->quoteIdentifier($reference_table, true);
        $field_names = implode(",", $field_names);
        $field_names = $this->db_instance->quoteIdentifier($field_names, true);
        $reference_field_names = implode(",", $reference_field_names);
        $reference_field_names = $this->db_instance->quoteIdentifier($reference_field_names, true);
        $foreign_key_name = $this->db_instance->quoteIdentifier($foreign_key_name, true);
        $update = '';
        if ($on_update !== null) {
            $on_update = $on_update->value;
            $update = "ON UPDATE $on_update";
        }
        $delete = '';
        if ($on_delete !== null) {
            $on_delete = $on_delete->value;
            $delete = "ON DELETE $on_delete";
        }
        $query = "ALTER TABLE
                    $table ADD CONSTRAINT
                    $foreign_key_name FOREIGN KEY ($field_names)
                    REFERENCES $reference_table ($reference_field_names)
                    $update
                    $delete
                    ";

        return (bool) $this->pdo->exec($query);
    }

    public function dropForeignKey(string $foreign_key_name, string $table_name): bool
    {
        $table = $this->db_instance->quoteIdentifier($table_name, true);
        $name = $this->db_instance->quoteIdentifier($foreign_key_name, true);
        $query = "ALTER TABLE $table DROP FOREIGN KEY $name;";

        return (bool) $this->pdo->exec($query);
    }

    public function foreignKeyExists(string $foreign_key_name, string $table_name): bool
    {
        $query = "SELECT * FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE CONSTRAINT_TYPE='FOREIGN KEY';";
        $result_set = $this->db_instance->query($query);
        while ($foreign_data = $this->db_instance->fetchAssoc($result_set)) {
            if (array_key_exists(
                'CONSTRAINT_NAME',
                $foreign_data
            ) && $foreign_data['CONSTRAINT_NAME'] === $foreign_key_name) {
                return true;
            }
        }
        return false;
    }
}