class.ilDatabaseServerIsConnectableObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup\Environment;
use ILIAS\Setup\UnachievableException;

class ilDatabaseServerIsConnectableObjective extends \ilDatabaseObjective
{
    public function getHash(): string
    {
        $pw = $this->config->getPassword();
        return hash("sha256", implode("-", [
            self::class,
            $this->config->getHost(),
            $this->config->getPort(),
            $this->config->getUser(),
            $pw !== null ? $pw->toString() : ""
        ]));
    }

    public function getLabel(): string
    {
        return "The database server is connectable with the supplied configuration.";
    }

    public function isNotable(): bool
    {
        return true;
    }

    public function getPreconditions(Environment $environment): array
    {
        return [];
    }

    public function achieve(Environment $environment): Environment
    {
        $db = \ilDBWrapperFactory::getWrapper($this->config->getType());
        $db->initFromIniFile($this->config->toMockIniFile());
        try {
            $connect = $db->connect();
        } catch (PDOException $e) {
            // 1049 is "unknown database", which is ok because we propably didn't
            // install the db yet,.
            if ($e->getCode() !== 1049) {
                throw $e;
            }

            $connect = true;
        }
        if (!$connect) {
            throw new UnachievableException(
                "Database cannot be reached. Please check the credentials."
            );
        }

        return $environment;
    }

    public function isApplicable(Environment $environment): bool
    {
        return true;
    }
}