-
-
@@ -359,6 +381,10 @@ const getHelp = key => {
let text = `${data[0].description}`
+ if (data[0]?.danger) {
+ text = `
${text}`
+ }
+
if (data[0]?.type) {
text += ` Expects:
${data[0].type}`
}
diff --git a/frontend/pages/tasks.vue b/frontend/pages/tasks.vue
index 0272b051..7d703396 100644
--- a/frontend/pages/tasks.vue
+++ b/frontend/pages/tasks.vue
@@ -55,15 +55,13 @@
Timer:
-
+
{{ task.timer }}
Args:
-
+
{{ task.args }}
diff --git a/src/API/System/AutoConfig.php b/src/API/System/AutoConfig.php
new file mode 100644
index 00000000..1d5072c7
--- /dev/null
+++ b/src/API/System/AutoConfig.php
@@ -0,0 +1,33 @@
+ $data->get('origin', ag($_SERVER, 'HTTP_ORIGIN', 'localhost')),
+ 'path' => Config::get('api.prefix'),
+ 'token' => Config::get('api.key'),
+ ]);
+ }
+}
diff --git a/src/API/System/Env.php b/src/API/System/Env.php
index e46ce4bf..1fb02035 100644
--- a/src/API/System/Env.php
+++ b/src/API/System/Env.php
@@ -127,14 +127,6 @@ public function envUpdate(iRequest $request, array $args = []): iResponse
try {
$value = $this->setType($spec, $value);
- if (true === is_string($value)) {
- // -- check if the string contains space but not quoted.
- // symfony/dotenv throws an exception if the value contains a space but not quoted.
- if (str_contains($value, ' ') && (!str_starts_with($value, '"') || !str_ends_with($value, '"'))) {
- throw new ValidationException('The value must be "quoted string", as it contains a space.');
- }
- }
-
if (true === ag_exists($spec, 'validate')) {
$value = $spec['validate']($value, $spec);
}
diff --git a/src/Commands/System/EnvCommand.php b/src/Commands/System/EnvCommand.php
index b7608762..ce2701d0 100644
--- a/src/Commands/System/EnvCommand.php
+++ b/src/Commands/System/EnvCommand.php
@@ -29,13 +29,6 @@ protected function configure(): void
{
$this->setName(self::ROUTE)
->setDescription('Show/edit environment variables.')
- ->addOption(
- 'envfile',
- null,
- InputOption::VALUE_REQUIRED,
- 'Environment file.',
- Config::get('path') . '/config/.env'
- )
->addOption('key', 'k', InputOption::VALUE_REQUIRED, 'Key to update.')
->addOption('set', 'e', InputOption::VALUE_REQUIRED, 'Value to set.')
->addOption('delete', 'd', InputOption::VALUE_NONE, 'Delete key.')
@@ -51,10 +44,11 @@ protected function configure(): void
[ Environment variables rules ]
-------------------------------
- * the key MUST be in CAPITAL LETTERS. For example [
WS_CRON_IMPORT].
- * the key MUST start with [
WS_]. For example [
WS_CRON_EXPORT].
- * the value is usually simple type, usually string unless otherwise stated.
- * the key SHOULD attempt to mirror the key path in default config, If not applicable or otherwise impossible it
+ * The key MUST be in CAPITAL LETTERS. For example [
WS_CRON_IMPORT].
+ * The key MUST start with [
WS_]. For example [
WS_CRON_EXPORT].
+ * The value is simple string. No complex data types are allowed. or shell expansion variables.
+ * The value MUST be in one line. No multi-line values are allowed.
+ * The key SHOULD attempt to mirror the key path in default config, If not applicable or otherwise impossible it
should then use an approximate path.
-------
@@ -63,13 +57,17 @@ protected function configure(): void
# How to load environment variables?
- You can load environment variables in many ways. However, the recommended methods are:
+ For
WatchState specific environment variables, we recommend using the
WebUI,
+ to manage the environment variables. However, you can also use this command to manage the environment variables.
-
(1) Via Docker compose file
+ We use this file to load your environment variables:
- You can load environment variables via [compose.yaml] file by adding them under the [environment] key.
- For example, to enable import task, do the following:
+ - {path}/.env
+ To load container specific variables i,e, the keys that does not start with WS_ prefix,
+ you can use the compose.yaml file.
+
+ For example,
-------------------------------
services:
watchstate:
@@ -77,22 +75,48 @@ protected function configure(): void
restart: unless-stopped
container_name: watchstate
environment:
- - WS_CRON_IMPORT=1
+ - HTTP_PORT=8080
+ - DISABLE_CACHE=1
+ .......
-------------------------------
- (2) Via .env file
+ # How to set environment variables?
- We automatically look for [.env] in this path [{path}]. The file usually
- does not exist unless you have created it.
+ To set an environment variable, you can use the following command:
- The file format is simple key=value per line. For example, to enable import task, edit the [.env] and add
+ {cmd} {route} -k ENV_NAME -e ENV_VALUE
- -------------------------------
- WS_CRON_IMPORT=1
- -------------------------------
+ Note: if you are using a space within the value you need to use the long form --set, for example:
+
+ {cmd} {route} -k ENV_NAME --set="ENV VALUE"
+
+ As you can notice the spaced value is wrapped with double "" quotes.
+
+ # How to see all possible environment variables?
+
+ {cmd} {route} --list
+
+ # How to delete environment variable?
+
+ {cmd} {route} -d -k ENV_NAME
+
+ # How to get specific environment variable value?
+
+ {cmd} {route} -k ENV_NAME
+
+ This will show the hidden value if the environment variable marked as sensitive.
+
+ # How to expose the hidden values for secret environment variables?
+
+ You can use the --expose flag to expose the hidden values. for both --list
+ or just the normal table display. For example:
+
+ {cmd} {route} --expose
HELP,
[
+ 'cmd' => trim(commandContext()),
+ 'route' => self::ROUTE,
'path' => after(Config::get('path') . '/config', ROOT_PATH),
]
)
diff --git a/src/Libs/EnvFile.php b/src/Libs/EnvFile.php
index c332ca38..9e6f88f3 100644
--- a/src/Libs/EnvFile.php
+++ b/src/Libs/EnvFile.php
@@ -25,18 +25,7 @@ public function __construct(public readonly string $file, bool $create = false)
}
}
- if (false === ($data = @file($this->file, FILE_IGNORE_NEW_LINES))) {
- $data = [];
- }
-
- foreach ($data as $line) {
- $line = trim($line);
- if (empty($line) || str_starts_with($line, '#')) {
- continue;
- }
- [$key, $value] = explode('=', $line, 2);
- $this->data[$key] = $value;
- }
+ $this->data = parseEnvFile($this->file);
}
/**
diff --git a/src/Libs/Initializer.php b/src/Libs/Initializer.php
index 4698d178..5adbbe6f 100644
--- a/src/Libs/Initializer.php
+++ b/src/Libs/Initializer.php
@@ -27,7 +27,6 @@
use Psr\Log\LoggerInterface;
use Psr\SimpleCache\CacheInterface;
use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
-use Symfony\Component\Dotenv\Dotenv;
use Symfony\Component\Yaml\Yaml;
use Throwable;
@@ -58,13 +57,13 @@ public function __construct()
(function () {
// -- This env file should only be used during development or direct installation.
if (file_exists(__DIR__ . '/../../.env')) {
- (new Dotenv())->usePutenv(true)->overload(__DIR__ . '/../../.env');
+ loadEnvFile(file: __DIR__ . '/../../.env', usePutEnv: true, override: true);
}
// -- This is the official place where users are supposed to store .env file.
$dataPath = env('WS_DATA_PATH', fn() => inContainer() ? '/config' : __DIR__ . '/../../var');
if (file_exists($dataPath . '/config/.env')) {
- (new Dotenv())->usePutenv(true)->overload($dataPath . '/config/.env');
+ loadEnvFile(file: $dataPath . '/config/.env', usePutEnv: true, override: true);
}
})();
diff --git a/src/Libs/Middlewares/APIKeyRequiredMiddleware.php b/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
index 876c7300..ea6b1852 100644
--- a/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
+++ b/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
@@ -4,6 +4,7 @@
namespace App\Libs\Middlewares;
+use App\API\System\AutoConfig;
use App\API\System\HealthCheck;
use App\Libs\Config;
use App\Libs\HTTP_STATUS;
@@ -22,6 +23,7 @@ final class APIKeyRequiredMiddleware implements MiddlewareInterface
*/
private const array PUBLIC_ROUTES = [
HealthCheck::URL,
+ AutoConfig::URL,
];
/**
diff --git a/src/Libs/helpers.php b/src/Libs/helpers.php
index e649cbee..1b27923b 100644
--- a/src/Libs/helpers.php
+++ b/src/Libs/helpers.php
@@ -1506,3 +1506,89 @@ function getEnvSpec(string $env): array
return [];
}
}
+
+
+if (!function_exists('parseEnvFile')) {
+ /**
+ * Parse the environment file, and returns key/value pairs.
+ *
+ * @param string $file The file to load.
+ *
+ * @return array The environment variables.
+ * @throws InvalidArgumentException Throws an exception if the file does not exist.
+ */
+ function parseEnvFile(string $file): array
+ {
+ $env = [];
+
+ if (false === file_exists($file)) {
+ throw new InvalidArgumentException(r("The file '{file}' does not exist.", ['file' => $file]));
+ }
+
+ foreach (file($file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) as $line) {
+ if (empty($line)) {
+ continue;
+ }
+
+ if (true === str_starts_with($line, '#') || false === str_contains($line, '=')) {
+ continue;
+ }
+
+ [$name, $value] = explode('=', $line, 2);
+
+ // -- check if value is quoted.
+ if ((true === str_starts_with($value, '"') && true === str_ends_with($value, '"')) ||
+ (true === str_starts_with($value, "'") && true === str_ends_with($value, "'"))) {
+ $value = substr($value, 1, -1);
+ }
+
+ $value = trim($value);
+ if ('' === $value) {
+ continue;
+ }
+ $env[$name] = $value;
+ }
+
+ return $env;
+ }
+}
+
+if (!function_exists('loadEnvFile')) {
+ /**
+ * Load the environment file.
+ *
+ * @param string $file The file to load.
+ * @param bool $usePutEnv (Optional) Whether to use putenv.
+ * @param bool $override (Optional) Whether to override existing values.
+ *
+ * @return void
+ */
+ function loadEnvFile(string $file, bool $usePutEnv = false, bool $override = true): void
+ {
+ try {
+ $env = parseEnvFile($file);
+
+ if (count($env) < 1) {
+ return;
+ }
+ } catch (InvalidArgumentException) {
+ return;
+ }
+
+ foreach ($env as $name => $value) {
+ if (false === $override && true === array_key_exists($name, $_ENV)) {
+ continue;
+ }
+
+ if (true === $usePutEnv) {
+ putenv("{$name}={$value}");
+ }
+
+ $_ENV[$name] = $value;
+
+ if (!str_starts_with($name, 'HTTP_')) {
+ $_SERVER[$name] = $value;
+ }
+ }
+ }
+}
diff --git a/tests/Fixtures/test_env_vars b/tests/Fixtures/test_env_vars
new file mode 100644
index 00000000..2c485be6
--- /dev/null
+++ b/tests/Fixtures/test_env_vars
@@ -0,0 +1,12 @@
+WS_TZ=Asia/Kuwait
+WS_CRON_IMPORT=1
+WS_CRON_EXPORT=0
+WS_FOO_BAR=" "
+WS_CRON_IMPORT_AT=16 */1 * * *
+WS_CRON_EXPORT_AT="30 */3 * * *"
+WS_CRON_PUSH_AT='*/10 * * * *'
+# Commit_line=foo
+# Next is empty line
+
+# Intentionally left "=" from the string
+FOOBAR_KAZ
diff --git a/tests/Libs/HelpersTest.php b/tests/Libs/HelpersTest.php
index e49e4cdf..1605e7f4 100644
--- a/tests/Libs/HelpersTest.php
+++ b/tests/Libs/HelpersTest.php
@@ -6,6 +6,7 @@
use App\Libs\Config;
use App\Libs\Entity\StateEntity;
+use App\Libs\Exceptions\InvalidArgumentException;
use App\Libs\Exceptions\RuntimeException;
use App\Libs\HTTP_STATUS;
use App\Libs\TestCase;
@@ -705,4 +706,57 @@ public function test_isValidURL(): void
);
$this->assertFalse(isValidURL('example.com'), 'When invalid url is passed, false is returned.');
}
+
+ public function test_parseEnvFile(): void
+ {
+ $envFile = __DIR__ . '/../Fixtures/test_env_vars';
+
+ $parsed = parseEnvFile($envFile);
+ $correctData = [
+ "WS_TZ" => "Asia/Kuwait",
+ "WS_CRON_IMPORT" => "1",
+ "WS_CRON_EXPORT" => "0",
+ "WS_CRON_IMPORT_AT" => "16 */1 * * *",
+ "WS_CRON_EXPORT_AT" => "30 */3 * * *",
+ "WS_CRON_PUSH_AT" => "*/10 * * * *",
+ ];
+
+ $this->assertCount(count($correctData), $parsed, 'When parsing env file, filter out garbage data.');
+
+ foreach ($correctData as $key => $value) {
+ $this->assertSame($value, $parsed[$key], 'Make sure correct values are returned when parsing env file.');
+ }
+
+ $this->expectException(InvalidArgumentException::class);
+ parseEnvFile(__DIR__ . '/../Fixtures/non_existing_file');
+ }
+
+ public function test_loadEnvFile(): void
+ {
+ $envFile = __DIR__ . '/../Fixtures/test_env_vars';
+ $correctData = [
+ "WS_TZ" => "Asia/Kuwait",
+ "WS_CRON_IMPORT" => "1",
+ "WS_CRON_EXPORT" => "0",
+ "WS_CRON_IMPORT_AT" => "16 */1 * * *",
+ "WS_CRON_EXPORT_AT" => "30 */3 * * *",
+ "WS_CRON_PUSH_AT" => "*/10 * * * *",
+ ];
+
+ $_ENV['WS_TZ'] = 'Asia/Kuwait';
+ putenv('WS_TZ=Asia/Kuwait');
+
+ loadEnvFile($envFile, usePutEnv: true, override: false);
+
+ foreach ($correctData as $key => $value) {
+ $this->assertSame($value, env($key), 'Make sure correct values are returned when parsing env file.');
+ }
+
+ // -- if given invalid file. it should not throw exception.
+ try {
+ loadEnvFile(__DIR__ . '/../Fixtures/non_existing_file');
+ } catch (\Throwable) {
+ $this->fail('This function shouldn\'t throw exception when invalid file is given.');
+ }
+ }
}