cphipps/watchstate
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Added better constraints checks with more to follow.

Browse Source
This commit is contained in:
Abdulmhsen B. A. A
2024-05-17 22:48:34 +03:00
parent dafeb49465
commit 126b0600d1
8 changed files with 195 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
src/API/Backend/Option.php
View File

@@ -31,26 +31,39 @@ final class Option
return api_error('Invalid value for option path parameter.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (false === str_starts_with($option, 'options.')) {
return api_error(
"Invalid option. Option path parameter keys must start with 'options.'",
HTTP_STATUS::HTTP_BAD_REQUEST
);
}
$spec = getServerColumnSpec($option);
if (empty($spec)) {
return api_error(r("Invalid option '{key}'.", ['key' => $option]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = ConfigFile::open(Config::get('backends_file'), 'yaml', autoCreate: true);
if (false === $list->has($name)) {
return api_error(r("Backend '{name}' not found.", ['name' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$key = $name . '.options.' . $option;
if (false === $list->has($key)) {
return api_error(r("Option '{option}' not found in backend '{name}'.", [
if (false === $list->has($name . '.' . $option)) {
return api_error(r("Option '{option}' not found in backend '{name}' config.", [
'option' => $option,
'name' => $name
]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$value = $list->get($key);
$value = $list->get($name . '.' . $option);
settype($value, ag($spec, 'type', 'string'));
return api_response(HTTP_STATUS::HTTP_OK, [
'key' => $option,
'key' => $spec['key'],
'value' => $value,
'type' => get_debug_type($value),
'type' => ag($spec, 'type', 'string'),
'description' => ag($spec, 'description', ''),
]);
}
@@ -70,31 +83,38 @@ final class Option
$data = DataUtil::fromRequest($request);
if (null === ($option = $data->get('key'))) {
return api_error('Invalid value for key.', HTTP_STATUS::HTTP_BAD_REQUEST);
return api_error('No option key was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$spec = require __DIR__ . '/../../../config/backend.spec.php';
$found = false;
foreach ($spec as $supportedKey => $_) {
if (str_ends_with($supportedKey, 'options.' . $option)) {
$found = true;
break;
}
if (false === str_starts_with($option, 'options.')) {
return api_error(
"Invalid option key was given. Option keys must start with 'options.'",
HTTP_STATUS::HTTP_BAD_REQUEST
);
}
if (false === $found) {
return api_error(r("Option '{key}' is not supported.", ['key' => $option]), HTTP_STATUS::HTTP_BAD_REQUEST);
$spec = getServerColumnSpec($option);
if (empty($spec)) {
return api_error(r("Invalid option '{key}'.", ['key' => $option]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
if ($list->has($name . '.' . $option)) {
return api_error(r("Option '{option}' already exists in backend '{name}'.", [
'option' => $option,
'name' => $name
]), HTTP_STATUS::HTTP_CONFLICT);
}
$value = $data->get('value');
settype($value, ag($spec, 'type', 'string'));
$list->set($name . '.options.' . $option, $value)->persist();
$list->set($name . '.' . $option, $value)->persist();
return api_response(HTTP_STATUS::HTTP_OK, [
'key' => $option,
'value' => $value,
'type' => get_debug_type($value),
'type' => ag($spec, 'type', 'string'),
'description' => ag($spec, 'description', ''),
]);
}
@@ -109,34 +129,60 @@ final class Option
return api_error('Invalid value for option parameter.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = ConfigFile::open(Config::get('backends_file'), 'yaml', autoCreate: true);
if (false === str_starts_with($option, 'options.')) {
return api_error(
"Invalid option key was given. Option keys must start with 'options.'",
HTTP_STATUS::HTTP_BAD_REQUEST
);
}
$spec = getServerColumnSpec($option);
if (empty($spec)) {
return api_error(r("Invalid option '{key}'.", ['key' => $option]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = ConfigFile::open(Config::get('backends_file'), 'yaml', autoCreate: true);
if (false === $list->has($name)) {
return api_error(r("Backend '{name}' not found.", ['name' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$key = $name . '.options.' . $option;
if (false === $list->has($key)) {
return api_error(r("Option '{option}' not found in backend '{name}'.", [
if (false === $list->has($name . '.' . $option)) {
return api_error(r("Option '{option}' not found in backend '{name}' config.", [
'option' => $option,
'name' => $name
]), HTTP_STATUS::HTTP_NOT_FOUND);
}
if (true === (bool)ag($spec, 'immutable', false)) {
return api_error(r("Option '{option}' is immutable.", [
'option' => $option,
]), HTTP_STATUS::HTTP_CONFLICT);
}
$data = DataUtil::fromRequest($request);
if (null === ($value = $data->get('value'))) {
return api_error(r("No value was provided for '{key}'.", [
'key' => $key,
'key' => $option,
]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list->set($key, $value)->persist();
settype($value, ag($spec, 'type', 'string'));
$oldValue = $list->get($name . '.' . $option);
if (null !== $oldValue) {
settype($oldValue, ag($spec, 'type', 'string'));
}
if ($oldValue !== $value) {
$list->set($name . '.' . $option, $value)->persist();
}
return api_response(HTTP_STATUS::HTTP_OK, [
'key' => $option,
'value' => $value,
'type' => get_debug_type($value),
'type' => ag($spec, 'type', 'string'),
'description' => ag($spec, 'description', ''),
]);
}
@@ -151,21 +197,40 @@ final class Option
return api_error('Invalid value for option option parameter.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = ConfigFile::open(Config::get('backends_file'), 'yaml', autoCreate: true);
if (false === str_starts_with($option, 'options.')) {
return api_error(
"Invalid option key was given. Option keys must start with 'options.'",
HTTP_STATUS::HTTP_BAD_REQUEST
);
}
$spec = getServerColumnSpec($option);
if (empty($spec)) {
return api_error(r("Invalid option '{key}'.", ['key' => $option]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = ConfigFile::open(Config::get('backends_file'), 'yaml', autoCreate: true);
if (false === $list->has($name)) {
return api_error(r("Backend '{name}' not found.", ['name' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$key = $name . '.options.' . $option;
if (false === $list->has($name . '.' . $option)) {
return api_error(r("Option '{option}' not found in backend '{name}' config.", [
'option' => $option,
'name' => $name
]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$value = $list->get($key);
$list->delete($key)->persist();
$value = $list->get($name . '.' . $option);
settype($value, ag($spec, 'type', 'string'));
$list->delete($option)->persist();
return api_response(HTTP_STATUS::HTTP_OK, [
'key' => $option,
'value' => $value,
'type' => get_debug_type($value),
'type' => ag($spec, 'type', 'string'),
'description' => ag($spec, 'description', ''),
]);
}
}

32
src/API/Backend/Update.php
View File

@@ -20,6 +20,16 @@ final class Update
{
use APITraits;
private const array IMMUTABLE_KEYS = [
'name',
'type',
'options',
'webhook',
'webhook.match',
'import',
'export',
];
private ConfigFile $backendFile;
public function __construct()
@@ -72,20 +82,23 @@ final class Update
HTTP_STATUS::HTTP_BAD_REQUEST);
}
$spec = array_keys(require __DIR__ . '/../../../config/backend.spec.php');
foreach ($data as $update) {
$key = ag($update, 'key');
$value = ag($update, 'value');
if (null === $key) {
if (null === ($key = ag($update, 'key'))) {
return api_error('No key to update was present.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (false === in_array($key, $spec, true)) {
$spec = getServerColumnSpec($key);
if (empty($spec)) {
return api_error(r('Invalid key to update: {key}', ['key' => $key]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (in_array($key, self::IMMUTABLE_KEYS, true)) {
return api_error(r('Key {key} is immutable.', ['key' => $key]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
$this->backendFile->set("{$name}.{$key}", $value);
}
@@ -125,14 +138,15 @@ final class Update
],
];
$spec = require __DIR__ . '/../../../config/backend.spec.php';
foreach ($data->get('options', []) as $key => $value) {
if (false === ag_exists($spec, "options.{$key}") || null === $value) {
$key = "options.{$key}";
$spec = getServerColumnSpec($key);
if (empty($spec) || null === $value) {
continue;
}
$newData = ag_set($newData, "options.{$key}", $value);
$newData = ag_set($newData, $key, $value);
}
return deepArrayMerge([$config, $client->fromRequest($newData, $request)]);

9
src/API/Backends/Add.php
View File

@@ -148,14 +148,15 @@ final class Add
'options' => [],
];
$spec = require __DIR__ . '/../../../config/backend.spec.php';
foreach ($data->get('options', []) as $key => $value) {
if (false === ag_exists($spec, "options.{$key}") || null === $value) {
$key = "options.{$key}";
$spec = getServerColumnSpec($key);
if (empty($spec) || null === $value) {
continue;
}
$config = ag_set($config, "options.{$key}", $value);
$config = ag_set($config, $key, $value);
}
return $client->fromRequest($config, $request);