AdminerLoginServers.php

<?php


/**
 * Displays constant list of servers in login form.
 *
 * Configuration is similar to the original "login-servers" plugin but – the killer feature – each server can have
 * a different driver!
 *
 * @link https://github.com/pematon/adminer-plugins
 *
 * @author Jakub Vrana, https://www.vrana.cz/
 * @author Peter Knut
 * @copyright 2014-2018 Pematon, s.r.o. (http://www.pematon.com/)
 * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2 (one or other)
 */
class AdminerLoginServers
{
    /** @var array */
    private $servers;

    /** @var string */
    private $defaultDriver;

    /** @var array */
    private $loginParams;

    /**
     * Sets lists of supported database servers.
     *
     * Database server can be prefixed with driver name and can contain port and database name.
     * For example:
     * - mysql://localhost:3306 (server host and port)
     * - pgsql://localhost#database_name (server and database name)
     * - sqlite://database.db (relative path to database file, no authentication)
     * - sqlite://user:password@/var/www/database.db (authentication, absolute path to database file)
     *
     * Possible driver names are: `sqlite`, `sqlite2`, `pgsql`, `firebird`, `oracle`, `simpledb`, `elastic`, `mysql`,
     * `mongo`, `mssql`. Default driver is `mysql`.
     *
     * @param array $servers array(database-server) or array(database-server => description) or array(category => array())
     * @param string $defaultDriver Will be used if driver is not specified within server.
     */
    public function __construct(array $servers, $defaultDriver = "mysql")
    {
        $this->defaultDriver = $this->sanitizeDriver($defaultDriver);

        $this->servers = [];
        $this->loginParams = [];

        $this->parseServers($servers, $this->servers, $this->loginParams);
    }

    /**
     * @return array
     */
    public function credentials() {
        $params = $this->getLoginParams(Adminer\DRIVER, Adminer\SERVER, Adminer\DB);

        if ($params && $this->isSQLite($params["driver"])) {
            $password = "";
        } else {
            $password = Adminer\get_password();
        }

        return [Adminer\SERVER, $_GET["username"], $password];
    }

    /**
     * Checks whether current server is in a list of supported servers.
     * For SQLite database, verify also user name and password.
     *
     * @param string $username
     * @param string $password
     *
     * @return bool
     */
    public function login($username, $password)
    {
        $params = $this->getLoginParams(Adminer\DRIVER, Adminer\SERVER, Adminer\DB);
        if (!$params) {
            return false;
        }

        if ($this->isSQLite($params["driver"])) {
            return $username == $params["username"] && password_verify($password, $params["password"]);
        }

        return true;
    }

    /**
     * @param string $driver
     * @param string $server
     * @param string $database
     * @return array|null
     */
    private function getLoginParams($driver, $server, $database)
    {
        $serverKey = $this->getServerKey($driver, $server, $database);

        return isset($this->loginParams[$serverKey]) ? $this->loginParams[$serverKey] : null;
    }

    /**
     * @param array $servers
     * @param array $out
     * @param array $loginParams
     */
    private function parseServers(array $servers, array &$out, array &$loginParams)
    {
        foreach ($servers as $key => $value) {
            if (is_array($value)) {
                $out[$key] = [];
                $this->parseServers($value, $out[$key], $loginParams);
            } else {
                if (is_string($key)) {
                    $server = $key;
                    $name = $value;
                } else {
                    $server = $value;
                    $name = null;
                }

                $params = [];
                $this->parseServer($server, $params);

                $serverKey = $this->getServerKey($params["driver"], $params["server"], $params["database"]);
                if (!$name) {
                    $name = $this->getServerName($params);
                }

                $out[$serverKey] = "(" . $this->formatDriver($params["driver"]) . ") " . $name;

                $loginParams[$serverKey] = $params;
            }
        }
    }

    /**
     * @param string $server
     * @param array $params
     */
    private function parseServer($server, array &$params)
    {
        $matches = [];
        preg_match('~^(([^:]+)://)?(([^:@]+)(:([^@]+)?)?@)?([^#]+)(#(.*))?$~', $server, $matches);

        $driver = $matches[2];
        $username = $matches[4];
        $password = $matches[6];
        $server = $matches[7];
        $database = isset($matches[9]) ? $matches[9] : "";

        // Default driver is 'server'. It is used also for MySQL.
        $driver = $driver == "" ? $this->defaultDriver : $this->sanitizeDriver($driver);

        $sqlite = $this->isSQLite($driver);
        if ($sqlite && $database == "") {
            $database = $server;
            $server = "";
        }

        if (!$sqlite && $username != "") {
            throw new InvalidArgumentException("User name and password in server URI can be used only with 'sqlite' and 'sqlite2' drivers.");
        }

        $params = [
            "driver" => $driver,
            "username" => $username,
            "password" => password_hash($password, PASSWORD_DEFAULT),
            "server" => $server,
            "database" => $database,
        ];
    }

    /**
     * @param string $driver
     * @param string $server
     * @param string $database
     * @return string
     */
    private function getServerKey($driver, $server, $database)
    {
        return $this->isSQLite($driver) ? $server . "#" . $database : $server;
    }

    /**
     * @param array $params
     *
     * @return string
     */
    private function getServerName(array $params)
    {
        $name = $params["server"];

        if ($params["server"] && $params["database"]) {
            $name .= " » ";
        }
        if ($params["database"]) {
            $name .= $params["database"];
        }

        return $name;
    }

    /**
     * @param string $driver
     * @return bool
     */
    private function isSQLite($driver)
    {
        return $driver == "sqlite" || $driver == "sqlite2";
    }

    /**
     * @param string $driver
     * @return string
     */
    private function sanitizeDriver($driver)
    {
        return $driver == "mysql" ? "server" : $driver;
    }

    /**
     * @param string $driver
     * @return string
     */
    private function formatDriver($driver)
    {
        static $drivers = [
            "server" => "MySQL",
            "sqlite" => "SQLite 3",
            "sqlite2" => "SQLite 2",
            "pgsql" => "PostgreSQL",
            "oracle" => "Oracle",
            "mssql" => "MS SQL",
            "firebird" => "Firebird",
            "simpledb" => "SimpleDB",
            "mongo" => "MongoDB",
            "elastic" => "Elasticsearch",
            "elastic7" => "Elasticsearch 7",
        ];

        return isset($drivers[$driver]) ? $drivers[$driver] : $driver;
    }

    /**
     * @return bool
     */
    public function loginForm()
    {
        ?>

        <table cellspacing="0">
            <tr>
                <th><?php echo Adminer\lang('Server'); ?></th>
                <td>
                    <select name="auth[serverDb]"><?php echo Adminer\optionlist($this->servers, $this->getServerKey(Adminer\DRIVER, Adminer\SERVER, Adminer\DB)); ?></select>
                </td>
            <tr>
                <th><?php echo Adminer\lang('Username'); ?></th>
                <td><input id="username" name="auth[username]" value="<?php echo Adminer\h($_GET["username"]); ?>"></td>
            </tr>
            <tr>
                <th><?php echo Adminer\lang('Password'); ?></th>
                <td><input type="password" name="auth[password]"></td>
            </tr>
        </table>

        <p><input type="submit" value="<?php echo Adminer\lang('Login'); ?>">

        <?php
        echo Adminer\checkbox("auth[permanent]", 1, $_COOKIE["adminer_permanent"], Adminer\lang('Permanent login')) . "\n";
        ?>

        <input type="hidden" name="auth[server]" value="">
        <input type="hidden" name="auth[driver]" value="">
        <input type="hidden" name="auth[db]" value="">

        <script <?php echo Adminer\nonce(); ?>>
            (function(document) {
                "use strict";

                var loginParams = {
                    <?php
                    $count = count($this->loginParams);
                    $i = 1;
                    foreach ($this->loginParams as $serverKey => $params) {
                        echo json_encode($serverKey) . ": { 'driver': " . json_encode($params["driver"]) .
                            ",  'server': " . json_encode($params["server"]) .
                            ", 'database': " . json_encode($params["database"]) . " }";

                        if ($i++ < $count) {
                            echo ",";
                        }
                    }
                    ?>
                };

                var serverDbSelect = document.querySelector("select[name='auth[serverDb]']");
                var driverInput = document.querySelector("input[name='auth[driver]']");
                var serverInput = document.querySelector("input[name='auth[server]']");
                var databaseInput = document.querySelector("input[name='auth[db]']");

                serverDbSelect.addEventListener("change", changeServer, false);
                changeServer();

                function changeServer() {
                    var serverKey = serverDbSelect.options[serverDbSelect.selectedIndex].value;

                    driverInput.value = loginParams[serverKey].driver;
                    serverInput.value = loginParams[serverKey].server;
                    databaseInput.value = loginParams[serverKey].database;
                }
            })(document);
        </script>

        <?php

        return true;
    }
}