install.php

<?php

/*
The MIT License (MIT)

Copyright (c) 2018 Databases and Information Systems Research Group,
University of Basel, Switzerland

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */

/*
  check prerequisites:
  - write permissions
  - check for webroot (which one is the root web folder)
  - check if git is present
  - do clone etc
  - fill sql data
  - create initial user
  - create htaccess forward
*/

$messages = [];

//check permissions
if (!is_writable(".")) {
    $messages[] = "<p style='color: #FF0000;'>I need write permissions on current directory!</p>";
} else if (!`which git`) {
    $messages[] = "<p style='color: #FF0000;'>Cannot find Git.</p>";
} else if (isset($_POST['submit'])) {
    doInstallation();
}

// TODO: When the minimal PHP version of Chronos is increased to 7.4, change $cmd to an array (this gets rid of all the shellescapes)
//       See https://www.php.net/manual/en/function.proc-open.php
function runCommand(string $cmd, string &$stderr, string $cwd = null): int {
    $desc = array(
        0 => array("pipe", "r"),
        1 => array("pipe", "w"),
        2 => array("pipe", "w"),
    );
    $pipes = [];
    $resource = proc_open($cmd, $desc, $pipes, $cwd);
    if ($resource === false) {
        return false;
    }
    fclose($pipes[0]);
    stream_get_contents($pipes[1]); // mercurial aborts if stdout is closed.
    $stderr = stream_get_contents($pipes[2]);
    fclose($pipes[2]);
    return proc_close($resource);
}

function doInstallation() {
    global $messages;

    // handle input
    $repoUrl = $_POST['repoUrl'];
    $repoPassword = $_POST['repoPassword'];
    $repoBranch = $_POST['repoBranch'];
    $repoUsername = $_POST['repoUsername'];

    $dbServer = $_POST['dbServer'];
    $dbUsername = $_POST['dbUsername'];
    $dbPassword = $_POST['dbPassword'];
    $dbDatabase = $_POST['dbDatabase'];

    if (is_dir("chronos")) {
        // delete chronos folder if it already exists
        shell_exec("rm -r chronos");
    }

    // clone repository
    $result = false;
    $stderr = "";

    $split = explode("//", $repoUrl);
    $protocol = $split[0];
    unset($split[0]);
    $url = implode("//", $split);
    $result = runCommand("git clone -b " . escapeshellarg($repoBranch) . " '" . escapeshellarg($protocol) . "//" . escapeshellarg($repoUsername) . ":" . escapeshellarg($repoPassword) . "@" . escapeshellarg($url) . "' chronos", $stderr);

    if ($result === false or $result != 0) {
        $messages[] = "<p style='color: #FF0000;'>Clone failed: <pre>" . htmlentities($stderr) . "</pre></p>";
        return;
    }

    // load initial sql
    if (!file_exists(dirname(__FILE__) . "/chronos/chronos.sql")) {
        $messages[] = "<p style='color: #FF0000;'>Initial SQL file not found!</p>";
        return;
    }
    $sql = file_get_contents(dirname(__FILE__) . "/chronos/chronos.sql");

    // connect to db and set up
    try {
        $db = new PDO('mysql:host=' . $dbServer . ';dbname=' . $dbDatabase . ';charset=utf8mb4', $dbUsername, $dbPassword);
        $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        $db->query($sql);
    } catch (PDOException $e) {
        $messages[] = "<p style='color: #FF0000;'>SQL Setup failed: " . htmlentities($e->getMessage()) . "</p>";
        return;
    }

    // TODO: read this from input form (password, email, username, lastname, firstname)
    $password = "password";
    $hash = password_hash($password, PASSWORD_BCRYPT);
    $email = "jane.doe@example.org";
    try {
        $db->beginTransaction();
        $db->query("INSERT INTO User (`gender`, `lastname`, `firstname`, `username`, `password`, `email`, `alive`, `activated`, `created`, `lastEdit`, `role`)
                              VALUES (1, 'Smith', 'Debbie', 'admin', '$hash', '$email', 1, 1, '" . date('Y-m-d H:i:s') . "', '" . date('Y-m-d H:i:s') . "', 2);"
        );
        $db->query("INSERT INTO Setting (`settingId`, `section`, `item`, `value`, `systemId`) VALUES
                                (NULL, 'vcs', 'repoType', 'git', 0),
                                (NULL, 'vcs', 'repoUrl', '$repoUrl', 0),
                                (NULL, 'vcs', 'repoUsername', '$repoUsername', 0),
                                (NULL, 'vcs', 'repoPassword', '$repoPassword', 0),
                                (NULL, 'vcs', 'repoBranch', '$repoBranch', 0),
                                (NULL, 'ftp', 'ftpServer', '', 0),
                                (NULL, 'ftp', 'ftpPort', '21', 0),
                                (NULL, 'ftp', 'ftpUsername', '', 0),
                                (NULL, 'ftp', 'ftpPassword', '', 0),
                                (NULL, 'ftp', 'localNetworkCIDR', '', 0),
                                (NULL, 'ftp', 'useFtpUploadForLocalClients', '0', 0),
                                (NULL, 'other', 'rowsPerPage', '20', 0),
                                (NULL, 'other', 'maxJobsPerEvaluation', '1000', 0),
                                (NULL, 'other', 'uploadedDataHostname', 'https://chronos.example.org', 0),
                                (NULL, 'cem', 'minVersion', '0', 0),
                                (NULL, 'cem', 'nodeMissingTimeout', '600', 0),
                                (NULL, 'cem', 'environments', '{[]}', 0);
        ");
        $db->commit();
    } catch (PDOException $e) {
        $messages[] = "<p style='color: #FF0000;'>Insert of user failed: " . htmlentities($e->getMessage()) . "</p>";
        return;
    }

    $config = file_get_contents(dirname(__FILE__) . "/chronos/config.template.php");
    $config = str_replace("__DB_HOST__", $dbServer, $config);
    $config = str_replace("__DB_USER__", $dbUsername, $config);
    $config = str_replace("__DB_PASS__", $dbPassword, $config);
    $config = str_replace("__DB_NAME__", $dbDatabase, $config);
    file_put_contents(dirname(__FILE__) . "/chronos/config.php", $config);

    $access = file_get_contents(dirname(__FILE__) . "/chronos/.htaccess");
    $access = str_replace("webroot/", "chronos/webroot/", $access);
    file_put_contents(dirname(__FILE__) . "/.htaccess", $access);
    $messages[] = "<p style='color: #1da845;'>Setup successful! Click <a href='index.php'>here</a> to continue.</p>";
    header('Location: /index.php', true, 301);
}

function getOrDefault(string $name, string $default = ""): string {
    if (isset($_POST[$name]) and !empty($_POST[$name])) {
        return htmlentities($_POST[$name]);
    }
    return $default;
}

?>
<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>Chronos Installation</title>
  <style type="text/css">
    input, select {
      width: 585px;
      margin: 0 0 10px 0;
      padding: 5px;
    }
  </style>
</head>
<body>
<div style='width: 600px; margin: 30px auto; padding: 10px; background-color: #DDDDDD;'>
  <h1>Chronos Installation</h1>
  <p>
    Welcome to the Chronos installation procedure!
  </p>
    <?php
    foreach ($messages as $message) {
        echo $message;
    }
    ?>
  <hr>
  <form action="install.php" method="post">
    <p>Installation Source</p>
    <input type="text" name="repoUrl" value="<?php echo getOrDefault("repoUrl", "https://github.com/Chronos-EaaS/Chronos-Control.git"); ?>" placeholder="Repository URL"
           required><br>
    <input type="text" name="repoUsername" placeholder="Repository Username (Optional)" value="<?php echo getOrDefault("repoUsername"); ?>" ><br>
    <input type="password" name="repoPassword" placeholder="Repository Password (Optional)"><br>
    <input type="text" name="repoBranch" value="<?php echo getOrDefault("repoBranch", "master"); ?>" placeholder="Repository Branch" required><br>

    <hr>
    <p>Database Configuration</p>
    <input type="text" name="dbServer" placeholder="Server Host" value="<?php echo getOrDefault("dbServer"); ?>" required><br>
    <input type="text" name="dbDatabase" placeholder="Database Name" value="<?php echo getOrDefault("dbDatabase"); ?>" required><br>
    <input type="text" name="dbUsername" placeholder="Username" value="<?php echo getOrDefault("dbUsername"); ?>" required><br>
    <input type="password" name="dbPassword" placeholder="Password" required><br><br>
    <input type="submit" name="submit" value="Set up">
  </form>
</div>
</body>
</html>