class.ilDbSetup.php

Go to the documentation of this file.

<?php
require_once('./Services/Database/classes/class.ilDBWrapperFactory.php');
require_once('./Services/Database/classes/class.ilDBConstants.php');

class ilDbSetup
{
    const STATUS_OK = 1;
    const STATUS_FAILURE = 2;
    protected $client;
    protected $status = self::STATUS_FAILURE;
    protected static $instances = array();
    protected $ilDBInterface;
    protected $sql_dump_file = './setup/sql/ilias3.sql';


    protected function __construct(\ilClient $client)
    {
        $this->client = $client;
        $this->ilDBInterface = ilDBWrapperFactory::getWrapper($client->getDbType());
        $this->ilDBInterface->initFromIniFile($this->client->ini);
    }


    public static function getInstanceForClient(\ilClient $client)
    {
        if (empty(self::$instances[$client->getId()])) {
            self::$instances[$client->getId()] = new self($client);
        }

        return self::$instances[$client->getId()];
    }

    public static function getNewInstanceForClient(\ilClient $client) : \ilDbSetup
    {
        return new self($client);
    }

    public static function getInstanceForNewClient($client_name, $dbname, $host = 'localhost', $username = 'root', $password = '', $type = ilDBConstants::TYPE_PDO_MYSQL_INNODB)
    {
        require_once('./setup/classes/class.ilClient.php');
        require_once('./Services/Init/classes/class.ilIniFile.php');
        require_once('./setup/classes/class.ilDBConnections.php');

        $ilClient = new ilClient($client_name, new ilDBConnections());
        $ilClient->init();
        $ilClient->setDbHost($host);
        $ilClient->setDbName($dbname);
        $ilClient->setDbUser($username);
        $ilClient->setDbPass($password);
        $ilClient->setDbType($type);
        $ilClient->writeIni();

        return self::getInstanceForClient($ilClient);
    }


    public function createDatabase($a_collation)
    {
        if ($this->isConnectable()) {
            switch ($this->ilDBInterface->getDBType()) {
                case ilDBConstants::TYPE_PDO_MYSQL_MYISAM:
                case ilDBConstants::TYPE_PDO_MYSQL_INNODB:
                case ilDBConstants::TYPE_MYSQL:
                case ilDBConstants::TYPE_GALERA:
                case ilDBConstants::TYPE_INNODB:
                case ilDBConstants::TYPE_PDO_POSTGRE:
                    $clientIniFile = $this->client->ini;

                    if (!$this->ilDBInterface->createDatabase($clientIniFile->readVariable("db", "name"), 'utf8', $a_collation)) {
                        return false;
                    }
                    $this->ilDBInterface->initFromIniFile($this->getClient()->ini);

                    return $this->ilDBInterface->connect();
                    break;
            }
        }

        return false;
    }


    public function provideGlobalDB()
    {
        global $DIC;

        if ($DIC->offsetExists('ilDB')) {
            $DIC->offsetUnset('ilDB');
        }

        $GLOBALS["ilDB"] = $this->ilDBInterface;
        $DIC["ilDB"] = $this->ilDBInterface;
        $this->client->db = $this->ilDBInterface; // TODO ugly and dirty, but ilClient requires it
    }


    public function revokeGlobalDB()
    {
        $GLOBALS["ilDB"] = null;
        $this->client->db = null; // TODO ugly and dirty, but ilClient requires it
    }


    protected function getline($fp, $delim)
    {
        $result = "";
        while (!feof($fp)) {
            $tmp = fgetc($fp);
            if ($tmp == $delim) {
                return $result;
            }
            $result .= $tmp;
        }

        return $result;
    }


    protected function readDump()
    {
        $fp = fopen($this->getSqlDumpFile(), 'r');
        $q = '';
        while (!feof($fp)) {
            $line = trim($this->getline($fp, "\n"));

            if ($line != "" && substr($line, 0, 1) != "#" && substr($line, 0, 1) != "-") {
                if (substr($line, -1) == ";") {
                    //query is complete
                    $q .= " " . substr($line, 0, -1);
                    try {
                        $r = $this->ilDBInterface->query($q);
                    } catch (ilDatabaseException $e) {
                        return false;
                    }

                    unset($q);
                    unset($line);
                } else {
                    $q .= " " . $line;
                }
            }
        }

        fclose($fp);
    }


    protected function readDumpSmall()
    {
        $sql = file_get_contents($this->getSqlDumpFile());
        $lines = explode(';', $sql);
        foreach ($lines as $line) {
            if (strlen($line) > 0) {
                $this->ilDBInterface->manipulate($line);
            }
        }

        return true;
    }


    protected function readDumpUltraSmall()
    {
        $sql = file_get_contents($this->getSqlDumpFile());
        $re = $this->ilDBInterface->prepareManip($sql);
        $this->ilDBInterface->execute($re);

        return true;
    }


    public function installDatabase()
    {
        if ($this->canDatabaseBeInstalled()) {
            $this->provideGlobalDB();
            switch ($this->ilDBInterface->getDBType()) {
                case ilDBConstants::TYPE_PDO_MYSQL_MYISAM:
                case ilDBConstants::TYPE_MYSQL:
                    $this->ilDBInterface->connect();
                    //$this->dropTables();
                    //$this->readDump();
                    $this->readDumpUltraSmall();
                    $this->getClient()->db_installed = true;

                    return true;

                    break;
                case ilDBConstants::TYPE_PDO_MYSQL_INNODB:
                case ilDBConstants::TYPE_INNODB:
                case ilDBConstants::TYPE_GALERA:
                case ilDBConstants::TYPE_PDO_POSTGRE:
                case ilDBConstants::TYPE_POSTGRES:
                    include_once("./setup/sql/ilDBTemplate.php");
                    setupILIASDatabase();

                    return true;
                    break;
            }
        }

        return false;
    }


    public function isDatabaseExisting()
    {
        if (!$this->isConnectable()) {
            return false;
        }
        if (!$this->isDatabaseConnectable()) {
            return false;
        }

        return true;
    }


    public function isConnectable($keep_connection = false)
    {
        switch ($this->ilDBInterface->getDBType()) {
            default:
                try {
                    $connect = $this->ilDBInterface->connect();
                } catch (PDOException $e) {
                    $connect = ($e->getCode() == 1049);
                }
                break;
        }
        if ($keep_connection && $connect) {
            $this->provideGlobalDB();
        }

        if (!$connect) {
            $this->client->setError('Database can\'t be reached. Please check the credentials and if database exists');
        }

        return $connect;
    }


    public function isDatabaseConnectable()
    {
        if (!$this->isConnectable()) {
            return false;
        }

        return $this->ilDBInterface->connect(true);
    }


    public function isDatabaseInstalled()
    {
        if (!$this->isDatabaseExisting()) {
            return false;
        }

        $target = array( 'usr_data', 'object_data', 'object_reference' );

        return count(array_intersect($this->ilDBInterface->listTables(), $target)) == count($target);
    }


    protected function canDatabaseBeInstalled()
    {
        $connectable = $this->isDatabaseConnectable();
        $installed = $this->isDatabaseInstalled();

        return ($connectable && !$installed);
    }


    public function getClient()
    {
        return $this->client;
    }


    public function setClient($client)
    {
        $this->client = $client;
    }


    public function getStatus()
    {
        return $this->status;
    }


    public function setStatus($status)
    {
        $this->status = $status;
    }


    public function getSqlDumpFile()
    {
        return $this->sql_dump_file;
    }


    public function setSqlDumpFile($sql_dump_file)
    {
        $this->sql_dump_file = $sql_dump_file;
    }


    public function dropTables()
    {
        foreach ($this->ilDBInterface->listTables() as $table) {
            $this->ilDBInterface->manipulate('DROP TABLE ' . $table);
        }
    }


    public function getIlDBInterface()
    {
        return $this->ilDBInterface;
    }


    public function setIlDBInterface($ilDBInterface)
    {
        $this->ilDBInterface = $ilDBInterface;
    }
}