Installation Update + Bugfixes

core/.gitignore

@@ -1 +1,2 @@
 TemplateCache
+External/cache

core/Api/Swagger.class.php

@@ -192,7 +192,7 @@ class Swagger extends Request {
       "definitions" => $definitions
     ];
 
-    return yaml_emit($yamlData);
+    return \yaml_emit($yamlData);
 
   }
 }

core/Documents/Install.class.php

@@ -74,10 +74,11 @@ namespace Documents\Install {
 
     // Step enum
     const CHECKING_REQUIREMENTS = 1;
-    const DATABASE_CONFIGURATION = 2;
+    const INSTALL_DEPENDENCIES = 2;
-    const CREATE_USER = 3;
+    const DATABASE_CONFIGURATION = 3;
-    const ADD_MAIL_SERVICE = 4;
+    const CREATE_USER = 4;
-    const FINISH_INSTALLATION = 5;
+    const ADD_MAIL_SERVICE = 5;
+    const FINISH_INSTALLATION = 6;
 
     //
     private string $errorString;
@@ -103,12 +104,56 @@ namespace Documents\Install {
       return NULL;
     }
 
+    private function composerUpdate(bool $dryRun = false): array {
+      $command = "composer update";
+      if ($dryRun) {
+        $command .= " --dry-run";
+      }
+
+      $fds = [
+        "1" => ["pipe", "w"],
+        "2" => ["pipe", "w"],
+      ];
+
+      $dir = $this->getExternalDirectory();
+      $env = null;
+      if (!getenv("HOME")) {
+        $env = ["COMPOSER_HOME" => $dir];
+      }
+
+      $proc = proc_open($command, $fds, $pipes, $dir, $env);
+      $output = stream_get_contents($pipes[1]) . stream_get_contents($pipes[2]);
+      $status = proc_close($proc);
+      return [$status, $output];
+    }
+
+    private function getExternalDirectory(): string {
+      return implode(DIRECTORY_SEPARATOR, [WEBROOT, "core", "External"]);;
+    }
+
     private function getCurrentStep(): int {
 
       if (!$this->checkRequirements()["success"]) {
         return self::CHECKING_REQUIREMENTS;
       }
 
+      $externalDir = $this->getExternalDirectory();
+      $vendorDir = $externalDir . DIRECTORY_SEPARATOR . "vendor";
+      if (!is_dir($vendorDir)) {
+        return self::INSTALL_DEPENDENCIES;
+      } else {
+        list ($status, $output) = $this->composerUpdate(true);
+        if ($status !== 0) {
+          $this->errorString = "Error executing 'composer update --dry-run'. Please verify that the command succeeds locally and then try again. Status Code: $status, Output: $output";
+          return self::CHECKING_REQUIREMENTS;
+        } else {
+          if (!contains($output, "Nothing to modify in lock file")
+            || !contains($output, "Nothing to install, update or remove")) {
+            return self::INSTALL_DEPENDENCIES;
+          }
+        }
+      }
+
       $user = $this->getDocument()->getUser();
       $config = $user->getConfiguration();
 
@@ -163,6 +208,11 @@ namespace Documents\Install {
       return $step;
     }
 
+    private function command_exist(string $cmd): bool {
+      $return = shell_exec(sprintf("which %s 2>/dev/null", escapeshellarg($cmd)));
+      return !empty($return);
+    }
+
     private function checkRequirements(): array {
 
       $msg = $this->errorString;
@@ -184,11 +234,21 @@ namespace Documents\Install {
         }
       }
 
+      if (!function_exists("yaml_emit")) {
+        $failedRequirements[] = "<b>YAML</b> extension is not installed.";
+        $success = false;
+      }
+
       if (version_compare(PHP_VERSION, '7.4', '<')) {
         $failedRequirements[] = "PHP Version <b>>= 7.4</b> is required. Got: <b>" . PHP_VERSION . "</b>";
         $success = false;
       }
 
+      if (!$this->command_exist("composer")) {
+        $failedRequirements[] = "<b>Composer</b> is not installed or cannot be found.";
+        $success = false;
+      }
+
       if (!$success) {
         $msg = "The following requirements failed the check:<br>" .
           $this->createUnorderedList($failedRequirements);
@@ -198,6 +258,11 @@ namespace Documents\Install {
       return array("success" => $success, "msg" => $msg);
     }
 
+    private function installDependencies(): array {
+      list ($status, $output) = $this->composerUpdate();
+      return ["success" => $status === 0, "msg" => $output];
+    }
+
     private function databaseConfiguration(): array {
 
       $host = $this->getParameter("host");
@@ -206,22 +271,21 @@ namespace Documents\Install {
       $password = $this->getParameter("password");
       $database = $this->getParameter("database");
       $type = $this->getParameter("type");
-      $encoding = $this->getParameter("encoding");
+      $encoding = $this->getParameter("encoding") ?? "UTF8";
-      $encoding = ($encoding ? $encoding : "UTF-8");
       $success = true;
 
       $missingInputs = array();
-      if (is_null($host) || empty($host)) {
+      if (empty($host)) {
         $success = false;
         $missingInputs[] = "Host";
       }
 
-      if (is_null($port) || empty($port)) {
+      if (empty($port)) {
         $success = false;
         $missingInputs[] = "Port";
       }
 
-      if (is_null($username) || empty($username)) {
+      if (empty($username)) {
         $success = false;
         $missingInputs[] = "Username";
       }
@@ -231,12 +295,12 @@ namespace Documents\Install {
         $missingInputs[] = "Password";
       }
 
-      if (is_null($database) || empty($database)) {
+      if (empty($database)) {
         $success = false;
         $missingInputs[] = "Database";
       }
 
-      if (is_null($type) || empty($type)) {
+      if (empty($type)) {
         $success = false;
         $missingInputs[] = "Type";
       }
@@ -323,17 +387,17 @@ namespace Documents\Install {
       $success = true;
       $missingInputs = array();
 
-      if (is_null($username) || empty($username)) {
+      if (empty($username)) {
         $success = false;
         $missingInputs[] = "Username";
       }
 
-      if (is_null($password) || empty($password)) {
+      if (empty($password)) {
         $success = false;
         $missingInputs[] = "Password";
       }
 
-      if (is_null($confirmPassword) || empty($confirmPassword)) {
+      if (empty($confirmPassword)) {
         $success = false;
         $missingInputs[] = "Confirm Password";
       }
@@ -465,6 +529,9 @@ namespace Documents\Install {
         case self::CHECKING_REQUIREMENTS:
           return $this->checkRequirements();
 
+        case self::INSTALL_DEPENDENCIES:
+          return $this->installDependencies();
+
         case self::DATABASE_CONFIGURATION:
           return $this->databaseConfiguration();
 
@@ -612,6 +679,10 @@ namespace Documents\Install {
           "title" => "Application Requirements",
           "progressText" => "Checking requirements, please wait a moment…"
         ),
+        self::INSTALL_DEPENDENCIES => array(
+          "title" => "Installing Dependencies",
+          "progressText" => "Please wait while required dependencies are being installed…",
+        ),
         self::DATABASE_CONFIGURATION => array(
           "title" => "Database configuration",
           "form" => array(
@@ -690,7 +761,9 @@ namespace Documents\Install {
 
       if (isset($currentView["progressText"])) {
         $progressText = $currentView["progressText"];
-        $html .= "<div id=\"progressText\" style=\"display:none\" class=\"my-3\">$progressText$spinnerIcon</i></div>";
+        $hidden = (!in_array($this->currentStep, [self::CHECKING_REQUIREMENTS, self::INSTALL_DEPENDENCIES]))
+          ? " hidden" : "";
+        $html .= "<div id=\"progressText\" class=\"my-3$hidden\">$progressText$spinnerIcon</i></div>";
       }
 
       if (isset($currentView["form"])) {
@@ -709,8 +782,7 @@ namespace Documents\Install {
           }
         }
 
-        $html .= "
+        $html .= "</form>";
-          </form>";
       }
 
       $buttons = array(
@@ -718,8 +790,8 @@ namespace Documents\Install {
       );
 
       if ($this->currentStep != self::FINISH_INSTALLATION) {
-        if ($this->currentStep == self::CHECKING_REQUIREMENTS) {
+        if (in_array($this->currentStep, [self::CHECKING_REQUIREMENTS, self::INSTALL_DEPENDENCIES])) {
-          $buttons[] = array("title" => "Retry", "type" => "success", "id" => "btnRetry", "float" => "right");
+          $buttons[] = array("title" => "Retry", "type" => "success", "id" => "btnRetry", "float" => "right", "hidden" => true);
         } else {
           $buttons[] = array("title" => "Submit", "type" => "success", "id" => "btnSubmit", "float" => "right");
         }
@@ -740,7 +812,8 @@ namespace Documents\Install {
         $id = $button["id"];
         $float = $button["float"];
         $disabled = (isset($button["disabled"]) && $button["disabled"]) ? " disabled" : "";
-        $button = "<button type=\"button\" id=\"$id\" class=\"btn btn-$type m-1\"$disabled>$title</button>";
+        $hidden = (isset($button["hidden"]) && $button["hidden"]) ? " hidden" : "";
+        $button = "<button type=\"button\" id=\"$id\" class=\"btn btn-$type m-1$hidden\"$disabled>$title</button>";
 
         if ($float === "left") {
           $buttonsLeft .= $button;
@@ -766,6 +839,10 @@ namespace Documents\Install {
           "title" => "Checking requirements",
           "status" => self::ERROR
         ),
+        self::INSTALL_DEPENDENCIES => array(
+          "title" => "Install dependencies",
+          "status" => self::NOT_STARTED
+        ),
         self::DATABASE_CONFIGURATION => array(
           "title" => "Database configuration",
           "status" => self::NOT_STARTED
@@ -797,7 +874,11 @@ namespace Documents\Install {
 
       // POST
       if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-        $response = $this->performStep();
+        if (!isset($_REQUEST['status'])) {
+          $response = $this->performStep();
+        } else {
+          $response = ["error" => $this->errorString];
+        }
         $response["step"] = $this->currentStep;
         die(json_encode($response));
       }

core/Driver/SQL/MySQL.class.php

@@ -86,7 +86,7 @@ class MySQL extends SQL {
     return $lastError;
   }
 
-  private function getPreparedParams($values) {
+  private function getPreparedParams($values): array {
     $sqlParams = array('');
     foreach($values as $value) {
       $paramType = Parameter::parseType($value);
@@ -138,48 +138,54 @@ class MySQL extends SQL {
 
     $resultRows = array();
     $this->lastError = "";
+    $stmt = null;
+    $res = null;
+    $success = false;
 
-    if (is_null($values) || empty($values)) {
+    try {
-      $res = mysqli_query($this->connection, $query);
+      if (empty($values)) {
-      $success = $res !== FALSE;
+        $res = mysqli_query($this->connection, $query);
-      if ($success && $returnValues) {
+        $success = $res !== FALSE;
-        while($row = $res->fetch_assoc()) {
+        if ($success && $returnValues) {
-          $resultRows[] = $row;
+          while ($row = $res->fetch_assoc()) {
+            $resultRows[] = $row;
+          }
         }
-        $res->close();
+      } else if ($stmt = $this->connection->prepare($query)) {
-      }
-    } else if($stmt = $this->connection->prepare($query)) {
 
-      $success = false;
+        $sqlParams = $this->getPreparedParams($values);
-      $sqlParams = $this->getPreparedParams($values);
+        if ($stmt->bind_param(...$sqlParams)) {
-      $tmp = array();
+          if ($stmt->execute()) {
-      foreach($sqlParams as $key => $value) $tmp[$key] = &$sqlParams[$key];
+            if ($returnValues) {
-      if(call_user_func_array(array($stmt, "bind_param"), $tmp)) {
+              $res = $stmt->get_result();
-        if($stmt->execute()) {
+              if ($res) {
-          if ($returnValues) {
+                while ($row = $res->fetch_assoc()) {
-            $res = $stmt->get_result();
+                  $resultRows[] = $row;
-            if($res) {
+                }
-              while($row = $res->fetch_assoc()) {
+                $success = true;
-                $resultRows[] = $row;
+              } else {
+                $this->lastError = "PreparedStatement::get_result failed: $stmt->error ($stmt->errno)";
               }
-              $res->close();
-              $success = true;
             } else {
-              $this->lastError = "PreparedStatement::get_result failed: $stmt->error ($stmt->errno)";
+              $success = true;
             }
           } else {
-            $success = true;
+            $this->lastError = "PreparedStatement::execute failed: $stmt->error ($stmt->errno)";
           }
         } else {
-          $this->lastError = "PreparedStatement::execute failed: $stmt->error ($stmt->errno)";
+          $this->lastError = "PreparedStatement::prepare failed: $stmt->error ($stmt->errno)";
         }
-      } else {
+      }
-        $this->lastError = "PreparedStatement::prepare failed: $stmt->error ($stmt->errno)";
+    } catch (\mysqli_sql_exception $exception) {
+      $this->lastError = "MySQL::execute failed: $stmt->error ($stmt->errno)";
+    } finally {
+      if ($res !== null && !is_bool($res)) {
+        $res->close();
       }
 
-      $stmt->close();
+      if ($stmt !== null && !is_bool($stmt)) {
-    } else {
+        $stmt->close();
-      $success = false;
+      }
     }
 
     return ($success && $returnValues) ? $resultRows : $success;
@@ -195,7 +201,7 @@ class MySQL extends SQL {
         if ($value instanceof Column) {
           $columnName = $this->columnName($value->getName());
           $updateValues[] = "$leftColumn=VALUES($columnName)";
-        } else if($value instanceof Add) {
+        } else if ($value instanceof Add) {
           $columnName = $this->columnName($value->getColumn());
           $operator = $value->getOperator();
           $value = $value->getValue();

core/External/.htaccess

@@ -0,0 +1 @@
+Deny from all

core/Templates/base.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="{{ user.lang }}">
-  <head>
-    <meta charset="utf-8" />
-    {% block head %}
-      <title>{{ site.title }}</title>
-    {% endblock %}
-  </head>
-  <body>
-    {% block body %}
-    {% endblock %}
-  </body>
-</html>

core/Templates/swagger.twig

@@ -41,13 +41,13 @@
                     SwaggerUIBundle.plugins.DownloadUrl
                 ],
                 layout: "StandaloneLayout",
-            {% if user.loggedIn %}
+                {% if user.loggedIn %}
                 requestInterceptor: request => {
                     request.headers['XSRF-Token'] = '{{ user.session.csrfToken }}';
                     return request;
                 }
+                {% endif %}
             });
-            {% endif %}
         };
     </script>
 </body>

core/core.php

@@ -1,8 +1,11 @@
 <?php
 
-require_once "External/vendor/autoload.php";
+$vendorDir = implode(DIRECTORY_SEPARATOR, [__DIR__, "External", "vendor"]);
+if (is_dir($vendorDir)) {
+  require_once $vendorDir . DIRECTORY_SEPARATOR .  "autoload.php";
+}
 
-define("WEBBASE_VERSION", "1.4.1");
+define("WEBBASE_VERSION", "1.4.2");
 
 spl_autoload_extensions(".php");
 spl_autoload_register(function($class) {

js/install.js

@@ -1,11 +1,14 @@
 const NOT_STARTED = 0;
 const PENDING = 1;
-const SUCCESFULL = 2;
+const SUCCESSFUL = 2;
 const ERROR = 3;
 
+let currentState = PENDING;
+
 function setState(state) {
   let li = $("#currentStep");
   let icon, color, text;
+  currentState = state;
 
   switch (state) {
     case PENDING:
@@ -14,7 +17,7 @@ function setState(state) {
       color = "muted";
       break;
 
-    case SUCCESFULL:
+    case SUCCESSFUL:
       icon  = 'fas fa-check-circle';
       text  = "Successfull";
       color = "success";
@@ -24,6 +27,7 @@ function setState(state) {
       icon  = 'fas fa-times-circle';
       text  = "Failed";
       color = "danger";
+      $("#btnRetry").show();
       break;
 
     default:
@@ -42,6 +46,14 @@ function getCurrentStep() {
   return $("#currentStep").index() + 1;
 }
 
+function requestCurrentStep(callback) {
+  $.post("/index.php?status", {}, function(data) {
+    callback(data.step ?? null);
+  }, "json").fail(function() {
+    callback(null);
+  });
+}
+
 function sendRequest(params, done) {
   setState(PENDING);
   let success = false;
@@ -55,13 +67,13 @@ function sendRequest(params, done) {
     } else {
       setState(ERROR);
       statusBox.addClass("alert-danger");
-      statusBox.html("An error occurred during intallation: " + data.msg);
+      statusBox.html("An error occurred during installation: " + data.msg);
       statusBox.show();
     }
   }, "json").fail(function() {
     setState(ERROR);
     statusBox.addClass("alert-danger");
-    statusBox.html("An error occurred during intallation. Try <a href=\"/index.php\">restarting the process</a>.");
+    statusBox.html("An error occurred during installation. Try <a href=\"/index.php\">restarting the process</a>.");
     statusBox.show();
   }).always(function() {
     if(done) done(success);
@@ -69,14 +81,34 @@ function sendRequest(params, done) {
 }
 
 function retry() {
+  let progressText = $("#progressText");
+  let wasHidden = progressText.hasClass("hidden");
   $("#btnRetry").hide();
-  $("#progressText").show();
+  progressText.removeClass("hidden");
   sendRequest({ }, function(success) {
-    $("#progressText").hide();
+    if (wasHidden) {
-    if(!success) $("#btnRetry").show();
+      $("#progressText").addClass("hidden");
+    }
+    if(!success) {
+      $("#btnRetry").show();
+    }
   });
 }
 
+function waitForStatusChange() {
+  setTimeout(() => {
+    requestCurrentStep((step) => {
+      if (currentState === PENDING) {
+        if (step !== 2 || step == null) {
+          document.location.reload();
+        } else {
+          waitForStatusChange();
+        }
+      }
+    })
+  }, 2500);
+}
+
 $(document).ready(function() {
 
   $("#btnSubmit").click(function() {
@@ -101,7 +133,7 @@ $(document).ready(function() {
           submitButton.prop("disabled",false);
           submitButton.text(textBefore);
         } else {
-          setState(SUCCESFULL);
+          setState(SUCCESSFUL);
         }
       });
     });
@@ -160,4 +192,11 @@ $(document).ready(function() {
   typeField.change(function() {
     updateDefaultPort();
   });
+
+  // INSTALL_DEPENDENCIES ?
+  if (getCurrentStep() === 2) {
+    sendRequest({}, () => {
+      waitForStatusChange();
+    });
+  }
 });