1000 lines
		
	
	
		
			32 KiB
		
	
	
	
		
			PHP
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			1000 lines
		
	
	
		
			32 KiB
		
	
	
	
		
			PHP
		
	
	
		
			Executable File
		
	
	
	
	
| #!/usr/bin/php
 | |
| <?php
 | |
| 
 | |
| define('WEBROOT', realpath("."));
 | |
| 
 | |
| include_once 'Core/core.php';
 | |
| require_once 'Core/datetime.php';
 | |
| include_once 'Core/constants.php';
 | |
| 
 | |
| use Core\API\Request;
 | |
| use Core\Driver\SQL\Column\Column;
 | |
| use Core\Driver\SQL\Condition\Compare;
 | |
| use Core\Driver\SQL\Condition\CondIn;
 | |
| use Core\Driver\SQL\Expression\DateSub;
 | |
| use Core\Driver\SQL\SQL;
 | |
| use Core\Objects\Context;
 | |
| use Core\Objects\ConnectionData;
 | |
| 
 | |
| // TODO: is this available in all installations?
 | |
| use JetBrains\PhpStorm\NoReturn;
 | |
| 
 | |
| function printLine(string $line = ""): void {
 | |
|   echo $line . PHP_EOL;
 | |
| }
 | |
| 
 | |
| #[NoReturn]
 | |
| function _exit(string $line = ""): void {
 | |
|   printLine($line);
 | |
|   die();
 | |
| }
 | |
| 
 | |
| function getDatabaseConfig(): ConnectionData {
 | |
|   $configClass = "\\Site\\Configuration\\Database";
 | |
|   $file = getClassPath($configClass);
 | |
|   if (!file_exists($file) || !is_readable($file)) {
 | |
|     _exit("Database configuration does not exist or is not readable");
 | |
|   }
 | |
| 
 | |
|   include_once $file;
 | |
|   return new $configClass();
 | |
| }
 | |
| 
 | |
| $context = Context::instance();
 | |
| if (!$context->isCLI()) {
 | |
|   _exit("Can only be executed via CLI");
 | |
| }
 | |
| 
 | |
| $dockerYaml = null;
 | |
| $database = $context->getConfig()->getDatabase();
 | |
| if ($database !== null) {
 | |
|   if ($database->getProperty("isDocker", false) && !is_file("/.dockerenv")) {
 | |
|     if (function_exists("yaml_parse")) {
 | |
|       $dockerYaml = yaml_parse(file_get_contents("./docker-compose.yml"));
 | |
|     } else {
 | |
|       _exit("yaml_parse not found but required for docker file parsing.");
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| function connectSQL(): ?SQL {
 | |
|   global $context;
 | |
|   $sql = $context->initSQL();
 | |
|   if (!$sql || !$sql->isConnected()) {
 | |
|     printLine("Could not establish database connection");
 | |
|     return null;
 | |
|   }
 | |
| 
 | |
|   return $sql;
 | |
| }
 | |
| 
 | |
| function printHelp(array $argv): void {
 | |
|   global $registeredCommands;
 | |
|   printLine("=== WebBase CLI tool ===");
 | |
|   printLine("Usage: " . $argv[0] . " [action] <args>");
 | |
|   foreach ($registeredCommands as $command => $data) {
 | |
|     $description = $data["description"] ?? "";
 | |
|     printLine(" - $command: $description");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function applyPatch(SQL $sql, string $patchFile): bool {
 | |
|   $queries = [];
 | |
|   @include_once $patchFile;
 | |
|   foreach ($queries as $query) {
 | |
|     if (!$query->execute($sql)) {
 | |
|       printLine($sql->getLastError());
 | |
|       return false;
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   return true;
 | |
| }
 | |
| 
 | |
| function handleDatabase(array $argv): void {
 | |
|   global $dockerYaml;
 | |
|   $action = $argv[2] ?? "";
 | |
| 
 | |
|   if ($action === "migrate") {
 | |
|     $sql = connectSQL() or die();
 | |
|     _exit("Not implemented: migrate");
 | |
|   } else if (in_array($action, ["export", "import", "shell"])) {
 | |
| 
 | |
|     // database config
 | |
|     $config = getDatabaseConfig();
 | |
|     $dbType = $config->getProperty("type") ?? null;
 | |
|     $user = $config->getLogin();
 | |
|     $password = $config->getPassword();
 | |
|     $database = $config->getProperty("database");
 | |
|     $host = $config->getHost();
 | |
|     $port = $config->getPort();
 | |
| 
 | |
|     // subprocess config
 | |
|     $env = [];
 | |
|     $options = array_slice($argv, 3);
 | |
|     $dataOnly = in_array("--data-only", $options) || in_array("-d", $options);
 | |
|     $descriptorSpec = [STDIN, STDOUT, STDOUT];
 | |
|     $inputData = null;
 | |
| 
 | |
|     // argument config
 | |
|     if ($action === "import") {
 | |
|       $file = $argv[3] ?? null;
 | |
|       if (!$file) {
 | |
|         _exit("Usage: cli.php db import <path>");
 | |
|       }
 | |
| 
 | |
|       if (!file_exists($file) || !is_readable($file)) {
 | |
|         _exit("File not found or not readable");
 | |
|       }
 | |
| 
 | |
|       $inputData = file_get_contents($file);
 | |
|     }
 | |
| 
 | |
|     if ($dbType === "mysql") {
 | |
|       $command_args = ["-u", $user, '-h', $host, '-P', $port, "--password=$password"];
 | |
|       if ($action === "export") {
 | |
|         $command_bin = "mysqldump";
 | |
|         if ($dataOnly) {
 | |
|           $command_args[] = "--skip-triggers";
 | |
|           $command_args[] = "--compact";
 | |
|           $command_args[] = "--no-create-info";
 | |
|         }
 | |
|       } else if ($action === "import") {
 | |
|         $command_bin = "mysql";
 | |
|         $descriptorSpec[0] = ["pipe", "r"];
 | |
|       } else if ($action === "shell") {
 | |
|         $command_bin = "mysql";
 | |
|         $descriptorSpec = [];
 | |
|       }
 | |
|     } else if ($dbType === "postgres") {
 | |
| 
 | |
|       $env["PGPASSWORD"] = $password;
 | |
|       $command_args = ["-U", $user, '-h', $host, '-p', $port];
 | |
| 
 | |
|       if ($action === "export") {
 | |
|         $command_bin = "/usr/bin/pg_dump";
 | |
|         if ($dataOnly) {
 | |
|           $command_args[] = "--data-only";
 | |
|         }
 | |
|       } else if ($action === "import") {
 | |
|         $command_bin = "/usr/bin/psql";
 | |
|         $descriptorSpec[0] = ["pipe", "r"];
 | |
|       } else if ($action === "shell") {
 | |
|         $command_bin = "/usr/bin/psql";
 | |
|         $descriptorSpec = [];
 | |
|       }
 | |
| 
 | |
|     } else {
 | |
|       _exit("Unsupported database type");
 | |
|     }
 | |
| 
 | |
|     if ($database) {
 | |
|       $command_args[] = $database;
 | |
|     }
 | |
| 
 | |
|     $command = array_merge([$command_bin], $command_args);
 | |
|     if ($config->getProperty("isDocker", false)) {
 | |
|       $containerName = $dockerYaml["services"]["db"]["container_name"];
 | |
|       $command = array_merge(["docker", "exec", "-it", $containerName], $command);
 | |
|     }
 | |
| 
 | |
|     $process = proc_open($command, $descriptorSpec, $pipes, null, $env);
 | |
| 
 | |
|     if (is_resource($process)) {
 | |
|       if ($action === "import" && $inputData && count($pipes) > 0) {
 | |
|         fwrite($pipes[0], $inputData);
 | |
|         fclose($pipes[0]);
 | |
|       }
 | |
| 
 | |
|       proc_close($process);
 | |
|     }
 | |
|   } else if ($action === "clean") {
 | |
|     $sql = connectSQL() or die();
 | |
|     printLine("Deleting user related data older than 90 days...");
 | |
| 
 | |
|     // 1st: Select all related tables and entities
 | |
|     $tables = [];
 | |
|     $res = $sql->select("entityId", "tableName")
 | |
|       ->from("EntityLog")
 | |
|       ->where(new Compare("modified", new DateSub($sql->now(), new Column("lifetime"), "DAY"), "<="))
 | |
|       ->dump()
 | |
|       ->execute();
 | |
| 
 | |
|     $success = ($res !== false);
 | |
|     if (!$success) {
 | |
|       _exit("Error querying data: " .  $sql->getLastError());
 | |
|     }
 | |
| 
 | |
|     foreach ($res as $row) {
 | |
|       $tableName = $row["tableName"];
 | |
|       $uid = $row["entityId"];
 | |
|       if (!isset($tables[$tableName])) {
 | |
|         $tables[$tableName] = [];
 | |
|       }
 | |
|       $tables[$tableName][] = $uid;
 | |
|     }
 | |
| 
 | |
|     // 2nd: delete!
 | |
|     foreach ($tables as $table => $ids) {
 | |
|       $success = $sql->delete($table)
 | |
|         ->where(new CondIn(new Column("id"), $ids))
 | |
|         ->execute();
 | |
| 
 | |
|       if (!$success) {
 | |
|         printLine("Error deleting data: " .  $sql->getLastError());
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     printLine("Done!");
 | |
|   } else {
 | |
|     _exit("Usage: cli.php db <migrate|import|export|shell> [options...]");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function findPullBranch(array $output): ?string {
 | |
|   foreach ($output as $line) {
 | |
|     $parts = preg_split('/\s+/', $line);
 | |
|     if (count($parts) >= 3 && $parts[2] === '(fetch)') {
 | |
|       $remoteName = $parts[0];
 | |
|       $url = $parts[1];
 | |
|       if (endsWith($url, "@github.com:rhergenreder/web-base.git") ||
 | |
|           endsWith($url, "@romanh.de:Projekte/web-base.git") ||
 | |
|           $url === 'https://github.com/rhergenreder/web-base.git' ||
 | |
|           $url === 'https://git.romanh.de/Projekte/web-base.git') {
 | |
|         return "$remoteName/master";
 | |
|       }
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   return null;
 | |
| }
 | |
| 
 | |
| function onMaintenance(array $argv): void {
 | |
|   $action = $argv[2] ?? "status";
 | |
|   $maintenanceFile = "MAINTENANCE";
 | |
|   $isMaintenanceEnabled = file_exists($maintenanceFile);
 | |
|   $sql = connectSQL();
 | |
|   $logger = new \Core\Driver\Logger\Logger("CLI", $sql);
 | |
| 
 | |
|   if ($action === "status") {
 | |
|     _exit("Maintenance: " . ($isMaintenanceEnabled ? "on" : "off"));
 | |
|   } else if ($action === "on") {
 | |
|     $file = fopen($maintenanceFile, 'w') or _exit("Unable to create maintenance file");
 | |
|     fclose($file);
 | |
|     $logger->info("Maintenance mode enabled");
 | |
|     _exit("Maintenance enabled");
 | |
|   } else if ($action === "off") {
 | |
|     if (file_exists($maintenanceFile)) {
 | |
|       if (!unlink($maintenanceFile)) {
 | |
|         _exit("Unable to delete maintenance file");
 | |
|       }
 | |
|     }
 | |
|     $logger->info("Maintenance mode disabled");
 | |
|     _exit("Maintenance disabled");
 | |
|   } else if ($action === "update") {
 | |
|     $logger->info("Update started");
 | |
|     $oldPatchFiles = array_merge(
 | |
|       glob('Core/Configuration/Patch/*.php'),
 | |
|       glob('Site/Configuration/Patch/*.php')
 | |
|     );
 | |
|     printLine("$ git remote -v");
 | |
|     exec("git remote -v", $gitRemote, $ret);
 | |
|     if ($ret !== 0) {
 | |
|       $logger->warning("Update stopped. git remote returned:\n" . implode("\n", $gitRemote));
 | |
|       die();
 | |
|     }
 | |
| 
 | |
|     $pullBranch = findPullBranch($gitRemote);
 | |
|     if ($pullBranch === null) {
 | |
|       $pullBranch = 'origin/master';
 | |
|       printLine("Unable to find remote update branch. Make sure, you are still in a git repository, and one of the remote branches " .
 | |
|                       "have the original fetch url");
 | |
|       printLine("Trying to continue with '$pullBranch'");
 | |
|     } else {
 | |
|       printLine("Using remote update branch: $pullBranch");
 | |
|     }
 | |
| 
 | |
|     printLine("$ git fetch " . str_replace("/", " ", $pullBranch));
 | |
|     exec("git fetch " . str_replace("/", " ", $pullBranch), $gitFetch, $ret);
 | |
|     if ($ret !== 0) {
 | |
|       $logger->warning("Update stopped. git fetch returned:\n" . implode("\n", $gitFetch));
 | |
|       die();
 | |
|     }
 | |
| 
 | |
|     printLine("$ git log HEAD..$pullBranch --oneline");
 | |
|     exec("git log HEAD..$pullBranch --oneline 2>&1", $gitLog, $ret);
 | |
|     if ($ret !== 0) {
 | |
|       $logger->warning("Update stopped. git log returned:\n" . implode("\n", $gitLog));
 | |
|       die();
 | |
|     } else if (count($gitLog) === 0) {
 | |
|       _exit("Already up to date.");
 | |
|     }
 | |
| 
 | |
|     printLine("Found updates, checking repository state");
 | |
|     printLine("$ git diff-index --quiet HEAD --"); // check for any uncommitted changes
 | |
|     exec("git diff-index --quiet HEAD -- 2>&1", $gitDiff, $ret);
 | |
|     if ($ret !== 0) {
 | |
|       $logger->warning("Update stopped due to uncommitted changes");
 | |
|       _exit("You have uncommitted changes. Please commit them before updating.");
 | |
|     }
 | |
| 
 | |
|     // enable maintenance mode if it wasn't turned on before
 | |
|     if (!$isMaintenanceEnabled) {
 | |
|       printLine("Turning on maintenance mode");
 | |
|       $logger->info("Maintenance mode enabled");
 | |
|       $file = fopen($maintenanceFile, 'w') or _exit("Unable to create maintenance file");
 | |
|       fclose($file);
 | |
|     }
 | |
| 
 | |
|     printLine("Ready to update, pulling and merging");
 | |
|     printLine("$ git pull " . str_replace("/", " ", $pullBranch) . " --no-ff");
 | |
|     exec("git pull " . str_replace("/", " ", $pullBranch) . " --no-ff 2>&1", $gitPull, $ret);
 | |
|     if ($ret !== 0) {
 | |
|       printLine();
 | |
|       printLine("Update could not be applied, check the git output.");
 | |
|       printLine("Follow the instructions and afterwards turn off the maintenance mode again using:");
 | |
|       printLine("cli.php maintenance off");
 | |
|       printLine("Also don't forget to apply new database patches using: cli.php db migrate");
 | |
|       $logger->error("Update stopped. git pull returned:\n" . implode("\n", $gitPull));
 | |
|       die();
 | |
|     }
 | |
| 
 | |
|     // TODO: how to handle modified database entities?
 | |
|     $newPatchFiles = array_merge(
 | |
|         glob('Core/Configuration/Patch/*.php'),
 | |
|         glob('Site/Configuration/Patch/*.php')
 | |
|     );
 | |
|     $newPatchFiles = array_diff($newPatchFiles, $oldPatchFiles);
 | |
|     if (count($newPatchFiles) > 0) {
 | |
|       if ($sql) {
 | |
|         printLine("Applying new database patches");
 | |
|         sort($newPatchFiles);
 | |
|         foreach ($newPatchFiles as $patchFile) {
 | |
|           if (preg_match("/(Core|Site)\/Configuration\/Patch\/(.*)\.php/", $patchFile, $match)) {
 | |
|             applyPatch($sql, $patchFile);
 | |
|           }
 | |
|         }
 | |
|       } else {
 | |
|         printLine("Cannot apply database patches, since the database connection failed.");
 | |
|         $logger->warning("Cannot apply database patches, since the database connection failed.");
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     // disable maintenance mode again
 | |
|     if (!$isMaintenanceEnabled) {
 | |
|       printLine("Turning off maintenance mode");
 | |
|       if (file_exists($maintenanceFile)) {
 | |
|         if (!unlink($maintenanceFile)) {
 | |
|           _exit("Unable to delete maintenance file");
 | |
|         } else {
 | |
|           $logger->info("Maintenance mode disabled");
 | |
|         }
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     $logger->info("Update completed.");
 | |
|   } else {
 | |
|     _exit("Usage: cli.php maintenance <status|on|off|update>");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function getConsoleWidth(): int {
 | |
|   $width = getenv('COLUMNS');
 | |
|   if (!$width) {
 | |
|     $width = exec('tput cols');
 | |
|     if (!$width) {
 | |
|       $width = 80; // default gnome-terminal column count
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   return intval($width);
 | |
| }
 | |
| 
 | |
| function printTable(array $head, array $body): void {
 | |
| 
 | |
|   $columns = [];
 | |
|   foreach ($head as $key) {
 | |
|     $columns[$key] = strlen($key);
 | |
|   }
 | |
| 
 | |
|   $maxWidth = getConsoleWidth();
 | |
|   foreach ($body as $row) {
 | |
|     foreach ($head as $key) {
 | |
|       $value = $row[$key] ?? "";
 | |
|       $length = strlen($value);
 | |
|       $columns[$key] = max($columns[$key], $length);
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   // print table
 | |
|   foreach ($head as $key) {
 | |
|     echo str_pad($key, $columns[$key]) . '   ';
 | |
|   }
 | |
|   printLine();
 | |
| 
 | |
|   foreach ($body as $row) {
 | |
|     $line = 0;
 | |
|     foreach ($head as $key) {
 | |
|       $width = min(max($maxWidth - $line, 0), $columns[$key]);
 | |
|       $line += $width;
 | |
|       echo str_pad($row[$key] ?? "", $width) . '   ';
 | |
|     }
 | |
|     printLine();
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onSettings(array $argv): void {
 | |
|   global $context;
 | |
|   connectSQL() or die();
 | |
|   $action = $argv[2] ?? "list";
 | |
| 
 | |
|   if ($action === "list" || $action === "get") {
 | |
|     $key = (($action === "list" || count($argv) < 4) ? null : $argv[3]);
 | |
|     $req = new \Core\API\Settings\Get($context);
 | |
|     $success = $req->execute(["key" => $key]);
 | |
|     if (!$success) {
 | |
|       _exit("Error listings settings: " . $req->getLastError());
 | |
|     } else {
 | |
|       $settings = [];
 | |
|       foreach ($req->getResult()["settings"] as $key => $value) {
 | |
|         $settings[] = ["key" => $key, "value" => $value];
 | |
|       }
 | |
|       printTable(["key", "value"], $settings);
 | |
|     }
 | |
|   } else if ($action === "set" || $action === "update") {
 | |
|     if (count($argv) < 5) {
 | |
|       _exit("Usage: $argv[0] settings $argv[2] <key> <value>");
 | |
|     } else {
 | |
|       $key = $argv[3];
 | |
|       $value = $argv[4];
 | |
|       $req = new \Core\API\Settings\Set($context);
 | |
|       $success = $req->execute(["settings" => [$key => $value]]);
 | |
|       if (!$success) {
 | |
|         _exit("Error updating settings: " . $req->getLastError());
 | |
|       }
 | |
|     }
 | |
|   } else if ($action === "unset" || $action === "delete") {
 | |
|     if (count($argv) < 4) {
 | |
|       _exit("Usage: $argv[0] settings $argv[2] <key>");
 | |
|     } else {
 | |
|       $key = $argv[3];
 | |
|       $req = new \Core\API\Settings\Set($context);
 | |
|       $success = $req->execute(["settings" => [$key => null]]);
 | |
|       if (!$success) {
 | |
|         _exit("Error updating settings: " . $req->getLastError());
 | |
|       }
 | |
|     }
 | |
|   } else {
 | |
|     _exit("Usage: $argv[0] settings <get|set|unset>");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onRoutes(array $argv): void {
 | |
|   global $context;
 | |
|   connectSQL() or die();
 | |
|   $action = $argv[2] ?? "list";
 | |
| 
 | |
|   if ($action === "list") {
 | |
|     $sql = $context->getSQL();
 | |
|     $routes = \Core\Objects\DatabaseEntity\Route::findAll($sql);
 | |
|     if ($routes === false || $routes === null) {
 | |
|       _exit("Error fetching routes: " . $sql->getLastError());
 | |
|     } else {
 | |
|       $head = ["id", "pattern", "type", "target", "extra", "active", "exact"];
 | |
| 
 | |
|       // strict boolean
 | |
|       $tableRows = [];
 | |
|       foreach ($routes as $route) {
 | |
|         $jsonData = $route->jsonSerialize(["id", "pattern", "type", "target", "extra", "active", "exact"]);
 | |
|         // strict bool conversion
 | |
|         $jsonData["active"] = $jsonData["active"] ? "true" : "false";
 | |
|         $jsonData["exact"] = $jsonData["exact"] ? "true" : "false";
 | |
|         $tableRows[] = $jsonData;
 | |
|       }
 | |
| 
 | |
|       printTable($head, $tableRows);
 | |
|     }
 | |
|   } else if ($action === "generate_cache") {
 | |
|     $req = new \Core\API\Routes\GenerateCache($context);
 | |
|     $success = $req->execute();
 | |
|     if (!$success) {
 | |
|       _exit("Error generating cache: " . $req->getLastError());
 | |
|     }
 | |
|   } else if ($action === "add") {
 | |
|     if (count($argv) < 7) {
 | |
|       _exit("Usage: cli.php routes add <pattern> <type> <target> <exact> [extra]");
 | |
|     }
 | |
| 
 | |
|     $params = array(
 | |
|       "pattern" => $argv[3],
 | |
|       "type" => $argv[4],
 | |
|       "target" => $argv[5],
 | |
|       "exact" => $argv[6],
 | |
|       "extra" => $argv[7] ?? "",
 | |
|     );
 | |
| 
 | |
|     $req  = new \Core\API\Routes\Add($context);
 | |
|     $success = $req->execute($params);
 | |
|     if (!$success) {
 | |
|       _exit($req->getLastError());
 | |
|     } else {
 | |
|       _exit("Route added successfully");
 | |
|     }
 | |
|   } else if (in_array($action, ["remove","modify","enable","disable"])) {
 | |
|     $routeId = $argv[3] ?? null;
 | |
|     if ($routeId === null || ($action === "modify" && count($argv) < 8)) {
 | |
|       if ($action === "modify") {
 | |
|         _exit("Usage: cli.php routes $action <id> <pattern> <type> <target> <exact> [extra]");
 | |
|       } else {
 | |
|         _exit("Usage: cli.php routes $action <id>");
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     $params = ["id" => $routeId];
 | |
|     if ($action === "remove") {
 | |
|       $input = null;
 | |
|       do {
 | |
|         if ($input === "n") {
 | |
|           die();
 | |
|         }
 | |
|         echo "Remove route #$routeId? (y|n): ";
 | |
|       } while(($input = trim(fgets(STDIN))) !== "y");
 | |
| 
 | |
|       $req = new \Core\API\Routes\Remove($context);
 | |
|     } else if ($action === "enable") {
 | |
|       $req = new \Core\API\Routes\Enable($context);
 | |
|     } else if ($action === "disable") {
 | |
|       $req = new \Core\API\Routes\Disable($context);
 | |
|     } else if ($action === "modify") {
 | |
|       $req = new \Core\API\Routes\Update($context);
 | |
|       $params["pattern"] = $argv[4];
 | |
|       $params["type"] = $argv[5];
 | |
|       $params["target"] = $argv[6];
 | |
|       $params["exact"] = $argv[7];
 | |
|       $params["extra"] = $argv[8] ?? "";
 | |
|     } else {
 | |
|       _exit("Unsupported action");
 | |
|     }
 | |
| 
 | |
|     $success = $req->execute($params);
 | |
|     if (!$success) {
 | |
|       _exit($req->getLastError());
 | |
|     } else {
 | |
|       _exit("Route updated successfully");
 | |
|     }
 | |
|   } else {
 | |
|     _exit("Usage: cli.php routes <list|enable|disable|add|remove|modify|generate_cache> [options...]");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onTest($argv): void {
 | |
|   $files = glob(WEBROOT . '/test/*.test.php');
 | |
|   $requestedTests = array_filter(array_slice($argv, 2), function ($t) {
 | |
|     return !startsWith($t, "-");
 | |
|   });
 | |
|   $verbose = in_array("-v", $argv);
 | |
| 
 | |
|   foreach ($files as $file) {
 | |
|     include_once $file;
 | |
|     $baseName = substr(basename($file), 0, - strlen(".test.php"));
 | |
|     if (!empty($requestedTests) && !in_array($baseName, $requestedTests)) {
 | |
|       continue;
 | |
|     }
 | |
| 
 | |
|     $className =  $baseName . "Test";
 | |
|     if (class_exists($className)) {
 | |
|       printLine("=== Running $className ===");
 | |
|       $testClass = new \PHPUnit\Framework\TestSuite();
 | |
|       $testClass->addTestSuite($className);
 | |
|       $result = $testClass->run();
 | |
|       printLine("Done after " . $result->time() . "s");
 | |
|       $stats = [
 | |
|         "total" => $result->count(),
 | |
|         "skipped" => $result->skippedCount(),
 | |
|         "error" => $result->errorCount(),
 | |
|         "failure" => $result->failureCount(),
 | |
|         "warning" => $result->warningCount(),
 | |
|       ];
 | |
| 
 | |
|       // Summary
 | |
|       printLine(
 | |
|         implode(", ", array_map(function ($key) use ($stats) {
 | |
|           return "$key: " . $stats[$key];
 | |
|         }, array_keys($stats)))
 | |
|       );
 | |
| 
 | |
|       $reports = array_merge($result->errors(), $result->failures());
 | |
|       foreach ($reports as $error) {
 | |
|         $exception = $error->thrownException();
 | |
|         echo $error->toString();
 | |
|         if ($verbose) {
 | |
|           printLine(". Stacktrace:");
 | |
|           printLine($exception->getTraceAsString());
 | |
|         } else {
 | |
|           $location = array_filter($exception->getTrace(), function ($t) use ($file) {
 | |
|             return isset($t["file"]) && $t["file"] === $file;
 | |
|           });
 | |
|           $location = array_reverse($location);
 | |
|           $location = array_pop($location);
 | |
|           if ($location)  {
 | |
|             printLine(" in " . substr($location["file"], strlen(WEBROOT)) . "#" . $location["line"]);
 | |
|           } else {
 | |
|             printLine();
 | |
|           }
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onMail($argv): void {
 | |
|   global $context;
 | |
|   $action = $argv[2] ?? null;
 | |
|   if ($action === "send_queue") {
 | |
|     connectSQL() or die();
 | |
|     $req = new \Core\API\Mail\SendQueue($context);
 | |
|     $debug = in_array("debug", $argv);
 | |
|     if (!$req->execute(["debug" => $debug])) {
 | |
|       _exit("Error processing mail queue: " . $req->getLastError());
 | |
|     }
 | |
|   } else if ($action === "test") {
 | |
|     $recipient = $argv[3] ?? null;
 | |
|     $gpgFingerprint = $argv[4] ?? null;
 | |
|     if (!$recipient) {
 | |
|       _exit("Usage: cli.php mail test <recipient> [gpg-fingerprint]");
 | |
|     }
 | |
| 
 | |
|     connectSQL() or die();
 | |
|     $req = new \Core\API\Mail\Test($context);
 | |
|     $success = $req->execute([
 | |
|         "receiver" => $recipient,
 | |
|         "gpgFingerprint" => $gpgFingerprint,
 | |
|     ]);
 | |
| 
 | |
|     $result = $req->getResult();
 | |
|     if ($success) {
 | |
|       printLine("Test email sent successfully");
 | |
|     } else {
 | |
|       printLine("Test email failed to sent: " . $req->getLastError());
 | |
|     }
 | |
| 
 | |
|     if (array_key_exists("output", $result)) {
 | |
|       printLine();
 | |
|       printLine($result["output"]);
 | |
|     }
 | |
|   } else {
 | |
|     _exit("Usage: cli.php mail <send_queue|test> [options...]");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onImpersonate($argv): void {
 | |
|   global $context;
 | |
| 
 | |
|   if (count($argv) < 3) {
 | |
|     _exit("Usage: cli.php impersonate <user_id|user_name>");
 | |
|   }
 | |
| 
 | |
|   $sql = connectSQL() or die();
 | |
|   $userId = $argv[2];
 | |
|   if (!is_numeric($userId)) {
 | |
|     $res = $sql->select("id")
 | |
|       ->from("User")
 | |
|       ->whereEq("name", $userId)
 | |
|       ->execute();
 | |
|     if ($res === false) {
 | |
|       _exit("SQL error: " . $sql->getLastError());
 | |
|     } else {
 | |
|       $userId = $res[0]["id"];
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   $user = new \Core\Objects\DatabaseEntity\User($userId);
 | |
|   $session = new \Core\Objects\DatabaseEntity\Session($context, $user);
 | |
|   $session->setData(["2faAuthenticated" => true]);
 | |
|   $session->update();
 | |
|   echo "Cookie: session=" . $session->getUUID() . PHP_EOL .
 | |
|        "CSRF-Token: " . $session->getCsrfToken() . PHP_EOL;
 | |
| }
 | |
| 
 | |
| function onFrontend(array $argv): void {
 | |
|   if (count($argv) < 3) {
 | |
|     _exit("Usage: cli.php frontend <build|add|rm|ls> [options...]");
 | |
|   }
 | |
| 
 | |
|   $reactRoot = realpath(WEBROOT . "/react/");
 | |
|   if (!$reactRoot) {
 | |
|     _exit("React root directory not found!");
 | |
|   }
 | |
| 
 | |
|   $action = $argv[2] ?? null;
 | |
|   if ($action === "build") {
 | |
|     $proc = proc_open(["yarn", "run", "build"], [1 => STDOUT, 2 => STDERR], $pipes, $reactRoot);
 | |
|     exit(proc_close($proc));
 | |
|   } else if ($action === "add") {
 | |
|     if (count($argv) < 4) {
 | |
|       _exit("Usage: cli.php frontend add <module-name>");
 | |
|     }
 | |
| 
 | |
|     $moduleName = strtolower($argv[3]);
 | |
|     if (!preg_match("/[a-z0-9_-]/", $moduleName)) {
 | |
|       _exit("Module name should only be [a-zA-Z0-9_-]");
 | |
|     } else if (in_array($moduleName, ["_tmpl", "dist", "shared"])) {
 | |
|       _exit("Invalid module name");
 | |
|     }
 | |
| 
 | |
|     $templatePath = implode(DIRECTORY_SEPARATOR, [$reactRoot, "_tmpl"]);
 | |
|     $modulePath = implode(DIRECTORY_SEPARATOR, [$reactRoot, $moduleName]);
 | |
|     if (file_exists($modulePath)) {
 | |
|       _exit("File or module does already exist: " . $modulePath);
 | |
|     }
 | |
| 
 | |
|     $rootPackageJsonPath = implode(DIRECTORY_SEPARATOR, [$reactRoot, "package.json"]);
 | |
|     $rootPackageJson = @json_decode(@file_get_contents($rootPackageJsonPath), true);
 | |
|     if (!$rootPackageJson) {
 | |
|       _exit("Unable to read root package.json");
 | |
|     }
 | |
| 
 | |
|     $reactVersion = $rootPackageJson["dependencies"]["react"];
 | |
|     if (!array_key_exists($moduleName, $rootPackageJson["targets"])) {
 | |
|       $rootPackageJson["targets"][$moduleName] = [
 | |
|         "source" => "./$moduleName/src/index.js",
 | |
|         "distDir" => "./dist/$moduleName"
 | |
|       ];
 | |
|       file_put_contents($rootPackageJsonPath, json_encode($rootPackageJson, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
 | |
|     }
 | |
| 
 | |
|     mkdir($modulePath, 0775, true);
 | |
|     $placeHolders = [
 | |
|       "MODULE_NAME" => $moduleName,
 | |
|       "REACT_VERSION" => $reactVersion
 | |
|     ];
 | |
| 
 | |
|     $it = new RecursiveDirectoryIterator($templatePath);
 | |
|     foreach (new RecursiveIteratorIterator($it) as $file) {
 | |
|       $fileName = $file->getFilename();
 | |
|       $relDir = substr($file->getPath(), strlen($templatePath) + 1);
 | |
|       $targetFile = implode(DIRECTORY_SEPARATOR, [$modulePath, $relDir, $fileName]);
 | |
|       if ($file->isFile()) {
 | |
|         $contents = file_get_contents($file);
 | |
|         foreach ($placeHolders as $key => $value) {
 | |
|           $contents = str_replace("{{{$key}}}", $value, $contents);
 | |
|         }
 | |
|         $directory = dirname($targetFile);
 | |
|         if (!is_dir($directory)) {
 | |
|           mkdir($directory, 0775, true);
 | |
|         }
 | |
| 
 | |
|         file_put_contents($targetFile, $contents);
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     printLine("Successfully added react module: $moduleName");
 | |
|     printLine("Run `php cli.php frontend build` to create a production build or");
 | |
|     printLine("run `php cli.php frontend dev $moduleName` to start a dev-server with your module");
 | |
|   } else if ($action === "dev") {
 | |
|     if (count($argv) < 4) {
 | |
|       _exit("Usage: cli.php frontend add <module-name>");
 | |
|     }
 | |
| 
 | |
|     $moduleName = strtolower($argv[3]);
 | |
|     $proc = proc_open(["yarn", "workspace", $moduleName, "run", "dev"], [1 => STDOUT, 2 => STDERR], $pipes, $reactRoot);
 | |
|     exit(proc_close($proc));
 | |
|   } else if ($action === "rm") {
 | |
|     if (count($argv) < 4) {
 | |
|       _exit("Usage: cli.php frontend add <module-name>");
 | |
|     }
 | |
| 
 | |
|     $moduleName = strtolower($argv[3]);
 | |
|     if (!preg_match("/[a-z0-9_-]/", $moduleName)) {
 | |
|       _exit("Module name should only be [a-zA-Z0-9_-]");
 | |
|     } else if (in_array($moduleName, ["_tmpl", "dist", "shared"])) {
 | |
|       _exit("This module cannot be removed");
 | |
|     }
 | |
| 
 | |
|     $modulePath = implode(DIRECTORY_SEPARATOR, [$reactRoot, $moduleName]);
 | |
|     if (!is_dir($modulePath)) {
 | |
|       _exit("Module not found: $modulePath");
 | |
|     }
 | |
| 
 | |
|     $rootPackageJsonPath = implode(DIRECTORY_SEPARATOR, [$reactRoot, "package.json"]);
 | |
|     $rootPackageJson = @json_decode(@file_get_contents($rootPackageJsonPath), true);
 | |
|     if (!$rootPackageJson) {
 | |
|       _exit("Unable to read root package.json");
 | |
|     }
 | |
| 
 | |
|     if (array_key_exists($moduleName, $rootPackageJson["targets"])) {
 | |
|       unset($rootPackageJson["targets"][$moduleName]);
 | |
|       file_put_contents($rootPackageJsonPath, json_encode($rootPackageJson, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
 | |
|     }
 | |
| 
 | |
|     $input = strtolower(trim(readline("Do you want to disable the module only and keep the files? [Y|n]: ")));
 | |
|     if ($input === "n") {
 | |
|       rrmdir($modulePath);
 | |
|       printLine("Disabled and deleted module: $moduleName");
 | |
|     } else {
 | |
|       printLine("Disabled module: $moduleName");
 | |
|     }
 | |
|   } else if ($action === "ls") {
 | |
|     printLine("Current available modules:");
 | |
|     foreach (glob(implode(DIRECTORY_SEPARATOR, [$reactRoot, "*"]), GLOB_ONLYDIR) as $directory) {
 | |
|       if (basename($directory) === "_tmpl") {
 | |
|         continue;
 | |
|       }
 | |
| 
 | |
|       $packageJson = realpath(implode(DIRECTORY_SEPARATOR, [$directory, "package.json"]));
 | |
|       if ($packageJson) {
 | |
|         $packageJsonContents = @json_decode(@file_get_contents($packageJson), true);
 | |
|         if (!$packageJsonContents) {
 | |
|           printLine("$directory: Unable to read package.json");
 | |
|         } else {
 | |
|           $packageName = $packageJsonContents["name"];
 | |
|           $packageVersion = $packageJsonContents["version"];
 | |
|           printLine("- $packageName version: $packageVersion");
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   } else {
 | |
|     _exit("Usage: cli.php frontend <build|ls|add|rm|dev> [options...]");
 | |
|   }
 | |
| }
 | |
| 
 | |
| function onAPI(array $argv): void {
 | |
|   if (count($argv) < 3) {
 | |
|     _exit("Usage: cli.php api <ls|add> [options...]");
 | |
|   }
 | |
| 
 | |
|   $action = $argv[2] ?? null;
 | |
|   if ($action === "ls") {
 | |
|     $endpoints = Request::getApiEndpoints();
 | |
|     foreach ($endpoints as $endpoint => $class) {
 | |
|       $className = $class->getName();
 | |
|       printLine(" - $className: $endpoint");
 | |
|     }
 | |
|     // var_dump($endpoints);
 | |
|   } else if ($action === "add") {
 | |
|     echo "API-Name: ";
 | |
|     $methodNames = [];
 | |
|     $apiName = ucfirst(trim(fgets(STDIN)));
 | |
|     if (!preg_match("/[a-zA-Z_-]/", $apiName)) {
 | |
|       _exit("Invalid API-Name, should be [a-zA-Z_-]");
 | |
|     }
 | |
| 
 | |
|     printLine("Do you want to add nested methods? Leave blank to skip.");
 | |
|     while (true) {
 | |
|       echo "Method name: ";
 | |
|       $methodName = ucfirst(trim(fgets(STDIN)));
 | |
|       if ($methodName) {
 | |
|         if (!preg_match("/[a-zA-Z_-]/", $methodName)) {
 | |
|           printLine("Invalid method name, should be [a-zA-Z_-]");
 | |
|         } else if (in_array($methodName, $methodNames)) {
 | |
|           printLine("You already added this method.");
 | |
|         } else {
 | |
|           $methodNames[] = $methodName;
 | |
|         }
 | |
|       } else {
 | |
|         break;
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     if (!empty($methodNames)) {
 | |
|       $fileName = "{$apiName}API.class.php";
 | |
|       $methods = implode("\n\n", array_map(function ($methodName) use ($apiName) {
 | |
|         return "  class $methodName extends {$apiName}API {
 | |
| 
 | |
|     public function __construct(Context \$context, bool \$externalCall = false) {
 | |
|       parent::__construct(\$context, \$externalCall, []);
 | |
|       // TODO: auto-generated method stub
 | |
|     }
 | |
|    
 | |
|     protected function _execute(): bool {
 | |
|       // TODO: auto-generated method stub
 | |
|       return \$this->success;
 | |
|     }
 | |
| 
 | |
|     public static function getDescription(): string {
 | |
|       // TODO: auto generated endpoint description
 | |
|       return \"Short description, what users are able to do with this endpoint.\";
 | |
|     }
 | |
|   }";
 | |
|       }, $methodNames));
 | |
|       $content = "<?php
 | |
|       
 | |
| namespace Site\API {
 | |
|   
 | |
|   use Core\API\Request;
 | |
|   use Core\Objects\Context;
 | |
|   
 | |
|   abstract class {$apiName}API extends Request {
 | |
|     public function __construct(Context \$context, bool \$externalCall = false, array \$params = []) {
 | |
|       parent::__construct(\$context, \$externalCall, \$params);
 | |
|       // TODO: auto-generated method stub
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| namespace Site\API\\$apiName {
 | |
| 
 | |
|   use Core\Objects\Context;
 | |
|   use Site\API\TestAPI;
 | |
|   
 | |
| $methods
 | |
| }";
 | |
|     } else {
 | |
|       $fileName = "$apiName.class.php";
 | |
|       $content = "<?php
 | |
|       
 | |
| namespace Site\API;
 | |
| 
 | |
| use Core\API\Request;
 | |
| use Core\Objects\Context;
 | |
| 
 | |
| class $apiName extends Request {
 | |
| 
 | |
|   public function __construct(Context \$context, bool \$externalCall = false) {
 | |
|     parent::__construct(\$context, \$externalCall, []);
 | |
|     // TODO: auto-generated method stub
 | |
|   }
 | |
|    
 | |
|   protected function _execute(): bool {
 | |
|     // TODO: auto-generated method stub
 | |
|     return \$this->success;
 | |
|   }
 | |
| 
 | |
|   public static function getDescription(): string {
 | |
|     // TODO: auto generated endpoint description
 | |
|     return \"Short description, what users are able to do with this endpoint.\";
 | |
|   }
 | |
| }
 | |
| ";
 | |
|     }
 | |
| 
 | |
|     $path = implode(DIRECTORY_SEPARATOR, [WEBROOT, "Site", "API", $fileName]);
 | |
|     file_put_contents($path, $content);
 | |
|     printLine("Successfully created API-template: $path");
 | |
|   } else {
 | |
|     _exit("Usage: cli.php api <ls|add> [options...]");
 | |
|   }
 | |
| }
 | |
| 
 | |
| $argv = $_SERVER['argv'];
 | |
| $registeredCommands = [
 | |
|   "help" => ["handler" => "printHelp", "description" => "prints this help page"],
 | |
|   "db" => ["handler" => "handleDatabase", "description" => "database actions like importing, exporting and shell"],
 | |
|   "routes" => ["handler" => "onRoutes", "description" => "view and modify routes", "requiresDocker" => true],
 | |
|   "maintenance" => ["handler" => "onMaintenance", "description" => "toggle maintenance mode", "requiresDocker" => true],
 | |
|   "test" => ["handler" => "onTest", "description" => "run unit and integration tests", "requiresDocker" => true],
 | |
|   "mail" => ["handler" => "onMail", "description" => "send mails and process the pipeline", "requiresDocker" => true],
 | |
|   "settings" => ["handler" => "onSettings", "description" => "change and view settings"],
 | |
|   "impersonate" => ["handler" => "onImpersonate", "description" => "create a session and print cookies and csrf tokens", "requiresDocker" => true],
 | |
|   "frontend" => ["handler" => "onFrontend", "description" => "build and manage frontend modules"],
 | |
|   "api" => ["handler" => "onAPI", "description" => "view and create API endpoints"],
 | |
| ];
 | |
| 
 | |
| 
 | |
| if (count($argv) < 2) {
 | |
|   _exit("Usage: cli.php <" . implode("|", array_keys($registeredCommands)) . "> [options...]");
 | |
| } else {
 | |
|   $command = $argv[1];
 | |
|   if (array_key_exists($command, $registeredCommands)) {
 | |
| 
 | |
|     if ($database !== null && $database->getProperty("isDocker", false) && !is_file("/.dockerenv")) {
 | |
|       $requiresDockerArgs = $registeredCommands[$command]["requiresDocker"] ?? [];
 | |
|       $requiresDocker = $requiresDockerArgs === true || in_array($argv[2] ?? null, $requiresDockerArgs);
 | |
|       if ($requiresDocker) {
 | |
|         $containerName = $dockerYaml["services"]["php"]["container_name"];
 | |
|         printLine("Detected docker environment in config, running docker exec for container: $containerName");
 | |
|         $command = array_merge(["docker", "exec", "-it", $containerName, "php"], $argv);
 | |
|         $proc = proc_open($command, [1 => STDOUT, 2 => STDERR], $pipes);
 | |
|         exit(proc_close($proc));
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     call_user_func($registeredCommands[$command]["handler"], $argv);
 | |
|   } else {
 | |
|     printLine("Unknown command '$command'");
 | |
|     printLine();
 | |
|     printHelp($argv);
 | |
|     exit;
 | |
|   }
 | |
| }
 |