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

Added Ignoreid API endpoint.

Browse Source
This commit is contained in:
abdulmohsen
2024-04-28 14:01:08 +03:00
parent 748c85ae5d
commit 0ec860add2
5 changed files with 319 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
src/API/Backends/Ignore.php Normal file
View File

@@ -0,0 +1,157 @@
<?php
declare(strict_types=1);
namespace App\API\Backends;
use App\Libs\Attributes\Route\Delete;
use App\Libs\Attributes\Route\Get;
use App\Libs\Attributes\Route\Post;
use App\Libs\Config;
use App\Libs\ConfigFile;
use App\Libs\DataUtil;
use App\Libs\HTTP_STATUS;
use App\Libs\Traits\APITraits;
use Psr\Http\Message\ResponseInterface as iResponse;
use Psr\Http\Message\ServerRequestInterface as iRequest;
use Throwable;
final class Ignore
{
use APITraits;
private ConfigFile $file;
public function __construct()
{
$this->file = new ConfigFile(Config::get('path') . '/config/ignore.yaml', type: 'yaml', autoCreate: true);
}
#[Get(Index::URL . '/{name:backend}/ignore[/]', name: 'backends.backend.ignoredIds')]
public function ignoredIds(iRequest $request, array $args = []): iResponse
{
if (null === ($name = ag($args, 'name'))) {
return api_error('No backend was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$list = [];
foreach ($this->file->getAll() as $guid => $date) {
$urlParts = parse_url($guid);
$backend = ag($urlParts, 'host');
$type = ag($urlParts, 'scheme');
$db = ag($urlParts, 'user');
$id = ag($urlParts, 'pass');
$scope = ag($urlParts, 'query');
if ($name !== $backend) {
continue;
}
$rule = makeIgnoreId($guid);
$list[] = [
'rule' => (string)$rule,
'type' => ucfirst($type),
'backend' => $backend,
'db' => $db,
'id' => $id,
'scoped' => null === $scope ? 'No' : 'Yes',
'created' => makeDate($date)->format('Y-m-d H:i:s T'),
];
}
$apiUrl = $request->getUri()->withHost('')->withPort(0)->withScheme('');
$response = [
'ignore' => $list,
'links' => [
'self' => (string)$apiUrl,
'list' => (string)$apiUrl->withPath(parseConfigValue(Index::URL)),
],
];
return api_response(HTTP_STATUS::HTTP_OK, $response);
}
#[Delete(Index::URL . '/{name:backend}/ignore[/]', name: 'backends.backend.ignoredIds.delete')]
public function deleteRule(iRequest $request, array $args = []): iResponse
{
$params = DataUtil::fromRequest($request);
if (null === ($rule = $params->get('rule'))) {
return api_error('No rule was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
try {
checkIgnoreRule($rule);
} catch (Throwable $e) {
return api_error($e->getMessage(), HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (!$this->file->has($rule)) {
return api_error('Rule not found.', HTTP_STATUS::HTTP_NOT_FOUND);
}
$this->file->delete($rule)->persist();
return api_response(HTTP_STATUS::HTTP_OK);
}
#[Post(Index::URL . '/{name:backend}/ignore[/]', name: 'backends.backend.ignoredIds.add')]
public function addRule(iRequest $request, array $args = []): iResponse
{
if (null === ($name = ag($args, 'name'))) {
return api_error('No backend was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$data = $this->getBackends(name: $name);
if (empty($data)) {
return api_error(r("Backend '{name}' not found.", ['name' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$params = DataUtil::fromRequest($request);
if (null === ($rule = $params->get('rule'))) {
$partial = [
'type' => $params->get('type'),
'backend' => $name,
'db' => $params->get('db'),
'id' => $params->get('id'),
];
foreach ($partial as $k => $v) {
if (empty($v)) {
return api_error(r('No {key} was given.', ['key' => $k]), HTTP_STATUS::HTTP_BAD_REQUEST);
}
}
$partial['type'] = strtolower($partial['type']);
$rule = r('{type}://{db}:{id}@{backend}', $partial);
if (null !== ($scoped = $params->get('scoped'))) {
$rule .= '?id=' . $scoped;
}
}
try {
checkIgnoreRule($rule);
$id = makeIgnoreId($rule);
} catch (Throwable $e) {
return api_error($e->getMessage(), HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (true === $this->file->has((string)$id)) {
return api_error('Rule already exists.', HTTP_STATUS::HTTP_CONFLICT);
}
if (true === $this->file->has((string)$id->withQuery(''))) {
return api_error('Global rule already exists.', HTTP_STATUS::HTTP_CONFLICT);
}
$this->file->set((string)$id, time())->persist();
return api_response(HTTP_STATUS::HTTP_CREATED);
}
}

87
src/API/Backends/Library/Ignore.php Normal file
View File

@@ -0,0 +1,87 @@
<?php
declare(strict_types=1);
namespace App\API\Backends\Library;
use App\API\Backends\Index as BackendsIndex;
use App\Libs\Attributes\Route\Route;
use App\Libs\Config;
use App\Libs\ConfigFile;
use App\Libs\DataUtil;
use App\Libs\HTTP_STATUS;
use App\Libs\Options;
use App\Libs\Traits\APITraits;
use Psr\Http\Message\ResponseInterface as iResponse;
use Psr\Http\Message\ServerRequestInterface as iRequest;
final class Ignore
{
use APITraits;
#[Route(['POST', 'DELETE'], BackendsIndex::URL . '/{name:backend}/library[/]', name: 'backends.library.ignore')]
public function _invoke(iRequest $request, array $args = []): iResponse
{
if (null === ($name = ag($args, 'name'))) {
return api_error('No backend was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (null === ($id = DataUtil::fromRequest($request, true)->get('id', null))) {
return api_error('No library id was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$remove = 'DELETE' === $request->getMethod();
$config = ConfigFile::open(Config::get('backends_file'), 'yaml');
if (null === $config->get($name)) {
return api_error(r("Backend '{backend}' not found.", ['backend' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$ignoreIds = array_map(
fn($v) => trim($v),
explode(',', (string)$config->get("{$name}.options." . Options::IGNORE, ''))
);
$mode = !(true === $remove);
if ($mode === in_array($id, $ignoreIds)) {
return api_error(r("Library id '{id}' is {message} ignored.", [
'id' => $id,
'message' => $remove ? "not" : 'already',
]), $remove ? HTTP_STATUS::HTTP_NOT_FOUND : HTTP_STATUS::HTTP_CONFLICT);
}
$found = false;
$libraries = $this->getClient(name: $name)->listLibraries();
foreach ($libraries as &$library) {
if ((string)ag($library, 'id') === (string)$id) {
$ignoreIds[] = $id;
$library['ignored'] = !$remove;
$found = true;
break;
}
}
if (false === $found) {
return api_error(r("The library id '{id}' is incorrect.", ['id' => $name]), HTTP_STATUS::HTTP_NOT_FOUND, [
'possible_ids' => array_column($libraries, 'id'),
]);
}
if (true === $remove) {
$ignoreIds = array_diff($ignoreIds, [$id]);
}
$config->set("{$name}.options." . Options::IGNORE, implode(',', array_values($ignoreIds)))->persist();
return api_response(HTTP_STATUS::HTTP_OK, [
'type' => $config->get("{$name}.type"),
'libraries' => $libraries,
'links' => [
'self' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}/library"),
'backend' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}"),
],
]);
}
}

79
src/API/Backends/Library/Index.php
View File

@@ -5,15 +5,10 @@ declare(strict_types=1);
namespace App\API\Backends\Library;
use App\API\Backends\Index as BackendsIndex;
use App\Libs\Attributes\Route\Delete;
use App\Libs\Attributes\Route\Get;
use App\Libs\Attributes\Route\Post;
use App\Libs\Config;
use App\Libs\ConfigFile;
use App\Libs\DataUtil;
use App\Libs\Exceptions\RuntimeException;
use App\Libs\HTTP_STATUS;
use App\Libs\Options;
use App\Libs\Traits\APITraits;
use Psr\Http\Message\ResponseInterface as iResponse;
use Psr\Http\Message\ServerRequestInterface as iRequest;
@@ -39,83 +34,11 @@ final class Index
'type' => ag(array_flip(Config::get('supported')), $client::class),
'libraries' => $client->listLibraries(),
'links' => [
'self' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}/library"),
'self' => (string)$request->getUri()->withHost('')->withPort(0)->withScheme(''),
'backend' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}"),
],
];
return api_response(HTTP_STATUS::HTTP_OK, $response);
}
#[Post(BackendsIndex::URL . '/{name:backend}/library[/]', name: 'backends.library.ignore')]
public function ignoreLibrary(iRequest $request, array $args = []): iResponse
{
if (null === ($name = ag($args, 'name'))) {
return api_error('No backend was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
if (null === ($id = DataUtil::fromRequest($request)->get('id', null))) {
return api_error('No library id was given.', HTTP_STATUS::HTTP_BAD_REQUEST);
}
$remove = 'DELETE' === $request->getMethod();
$config = ConfigFile::open(Config::get('backends_file'), 'yaml');
if (null === $config->get($name)) {
return api_error(r("Backend '{backend}' not found.", ['backend' => $name]), HTTP_STATUS::HTTP_NOT_FOUND);
}
$ignoreIds = array_map(
fn($v) => trim($v),
explode(',', (string)$config->get("{$name}.options." . Options::IGNORE, ''))
);
$mode = !(true === $remove);
if ($mode === in_array($id, $ignoreIds)) {
return api_error(r("Library id '{id}' is {message} ignored.", [
'id' => $id,
'message' => $remove ? "not" : 'already',
]), $remove ? HTTP_STATUS::HTTP_NOT_FOUND : HTTP_STATUS::HTTP_CONFLICT);
}
$found = false;
$libraries = $this->getClient(name: $name)->listLibraries();
foreach ($libraries as &$library) {
if ((string)ag($library, 'id') === (string)$id) {
$ignoreIds[] = $id;
$library['ignored'] = !$remove;
$found = true;
break;
}
}
if (false === $found) {
return api_error(r("The library id '{id}' is incorrect.", ['id' => $name]), HTTP_STATUS::HTTP_NOT_FOUND, [
'possible_ids' => array_column($libraries, 'id'),
]);
}
if (true === $remove) {
$ignoreIds = array_diff($ignoreIds, [$id]);
}
$config->set("{$name}.options." . Options::IGNORE, implode(',', array_values($ignoreIds)))->persist();
return api_response(HTTP_STATUS::HTTP_OK, [
'type' => $config->get("{$name}.type"),
'libraries' => $libraries,
'links' => [
'self' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}/library"),
'backend' => (string)parseConfigValue(BackendsIndex::URL . "/{$name}"),
],
]);
}
#[Delete(BackendsIndex::URL . '/{name:backend}/library/{id}[/]', name: 'backends.library.ignore.delete')]
public function deleteIgnoreLibrary(iRequest $request, array $args = []): iResponse
{
return $this->ignoreLibrary($request->withParsedBody(['id' => ag($args, 'id')]), $args);
}
}

77
src/Commands/Backend/Ignore/ManageCommand.php
View File

@@ -9,7 +9,6 @@ use App\Libs\Attributes\Route\Cli;
use App\Libs\Config;
use App\Libs\Entity\StateInterface as iState;
use App\Libs\Exceptions\InvalidArgumentException;
use App\Libs\Exceptions\RuntimeException;
use App\Libs\Guid;
use App\Libs\Stream;
use Symfony\Component\Console\Input\InputArgument;
@@ -25,7 +24,7 @@ use Symfony\Component\Yaml\Yaml;
#[Cli(command: self::ROUTE)]
final class ManageCommand extends Command
{
public const ROUTE = 'backend:ignore:manage';
public const string ROUTE = 'backend:ignore:manage';
/**
* Configure the command.
@@ -135,21 +134,21 @@ final class ManageCommand extends Command
if ($input->getOption('remove')) {
if (false === ag_exists($list, $id)) {
$output->writeln(sprintf('<error>Error: id \'%s\' is not ignored.</error>', $id));
$output->writeln(sprintf("<error>Error: id '%s' is not ignored.</error>", $id));
return self::FAILURE;
}
$list = ag_delete($list, $id);
$output->writeln(sprintf('<info>Removed: id \'%s\' from ignore list.</info>', $id));
$output->writeln(sprintf("<info>Removed: id '%s' from ignore list.</info>", $id));
} else {
$this->checkGuid($id);
checkIgnoreRule($id);
$id = makeIgnoreId($id);
if (true === ag_exists($list, (string)$id)) {
$output->writeln(
r(
'<comment>ERROR: Cannot add [{id}] as it\'s already exists. added at [{date}].</comment>',
"<comment>ERROR: Cannot add [{id}] as it's already exists. added at [{date}].</comment>",
[
'id' => $id,
'date' => makeDate(ag($list, (string)$id))->format('Y-m-d H:i:s T'),
@@ -174,7 +173,7 @@ final class ManageCommand extends Command
}
$list = ag_set($list, (string)$id, time());
$output->writeln(sprintf('<info>Added: id \'%s\' to ignore list.</info>', $id));
$output->writeln(sprintf("<info>Added: id '%s' to ignore list.</info>", $id));
}
@copy($path, $path . '.bak');
@@ -185,68 +184,4 @@ final class ManageCommand extends Command
return self::SUCCESS;
}
/**
* Check if the given GUID is valid and meets the expected format.
*
* @param string $guid The GUID to check.
*
* @throws RuntimeException If any of the checks fail.
*/
private function checkGuid(string $guid): void
{
$urlParts = parse_url($guid);
if (null === ($db = ag($urlParts, 'user'))) {
throw new RuntimeException('No db source was given.');
}
$sources = array_keys(Guid::getSupported());
if (false === in_array('guid_' . $db, $sources)) {
throw new RuntimeException(
sprintf(
'Invalid db source name \'%s\' was given. Expected values are \'%s\'.',
$db,
implode(', ', array_map(fn($f) => after($f, 'guid_'), $sources))
)
);
}
if (null === ($id = ag($urlParts, 'pass'))) {
throw new RuntimeException('No external id was given.');
}
Guid::validate($db, $id);
if (null === ($type = ag($urlParts, 'scheme'))) {
throw new RuntimeException('No type was given.');
}
if (false === in_array($type, iState::TYPES_LIST)) {
throw new RuntimeException(
sprintf(
'Invalid type \'%s\' was given. Expected values are \'%s\'.',
$type,
implode(', ', iState::TYPES_LIST)
)
);
}
if (null === ($backend = ag($urlParts, 'host'))) {
throw new RuntimeException('No backend was given.');
}
$backends = array_keys(Config::get('servers', []));
if (false === in_array($backend, $backends)) {
throw new RuntimeException(
sprintf(
'Invalid backend name \'%s\' was given. Expected values are \'%s\'.',
$backend,
implode(', ', $backends)
)
);
}
}
}

74
src/Libs/helpers.php
View File

@@ -8,10 +8,11 @@ use App\Backends\Common\ClientInterface as iClient;
use App\Backends\Common\Context;
use App\Libs\Config;
use App\Libs\Container;
use App\Libs\Entity\StateInterface as iFace;
use App\Libs\Entity\StateInterface as iState;
use App\Libs\Exceptions\InvalidArgumentException;
use App\Libs\Exceptions\RuntimeException;
use App\Libs\Extends\Date;
use App\Libs\Guid;
use App\Libs\HTTP_STATUS;
use App\Libs\Options;
use App\Libs\Router;
@@ -303,11 +304,11 @@ if (!function_exists('saveWebhookPayload')) {
/**
* Save webhook payload to stream.
*
* @param iFace $entity Entity object.
* @param iState $entity Entity object.
* @param iRequest $request Request object.
* @param iStream|null $file When given a stream, it will be used to write payload.
*/
function saveWebhookPayload(iFace $entity, iRequest $request, iStream|null $file = null): void
function saveWebhookPayload(iState $entity, iRequest $request, iStream|null $file = null): void
{
$content = [
'request' => [
@@ -476,10 +477,10 @@ if (!function_exists('queuePush')) {
*
* This method adds the entity to the queue for further processing.
*
* @param iFace $entity The entity to push to the queue.
* @param iState $entity The entity to push to the queue.
* @param bool $remove (optional) Whether to remove the entity from the queue if it already exists (default is false).
*/
function queuePush(iFace $entity, bool $remove = false): void
function queuePush(iState $entity, bool $remove = false): void
{
if (!$entity->hasGuids() && !$entity->hasRelativeGuid()) {
return;
@@ -838,7 +839,7 @@ if (false === function_exists('isIgnoredId')) {
string|int $id,
string|int|null $backendId = null
): bool {
if (false === in_array($type, iFace::TYPES_LIST)) {
if (false === in_array($type, iState::TYPES_LIST)) {
throw new InvalidArgumentException(sprintf('Invalid context type \'%s\' was given.', $type));
}
@@ -1166,3 +1167,64 @@ if (!function_exists('tryCache')) {
return $data;
}
}
if (!function_exists('checkIgnoreRule')) {
/**
* Check if the given ignore rule is valid.
*
* @param string $guid The ignore rule to check.
*
* @return bool True if the ignore rule is valid, false otherwise.
* @throws RuntimeException Throws an exception if the ignore rule is invalid.
*/
function checkIgnoreRule(string $guid): bool
{
$urlParts = parse_url($guid);
if (null === ($db = ag($urlParts, 'user'))) {
throw new RuntimeException('No db source was given.');
}
$sources = array_keys(Guid::getSupported());
if (false === in_array('guid_' . $db, $sources)) {
throw new RuntimeException(r("Invalid db source name '{db}' was given. Expected values are '{dbs}'.", [
'db' => $db,
'dbs' => implode(', ', array_map(fn($f) => after($f, 'guid_'), $sources)),
]));
}
if (null === ($id = ag($urlParts, 'pass'))) {
throw new RuntimeException('No external id was given.');
}
Guid::validate($db, $id);
if (null === ($type = ag($urlParts, 'scheme'))) {
throw new RuntimeException('No type was given.');
}
if (false === in_array($type, iState::TYPES_LIST)) {
throw new RuntimeException(r("Invalid type '{type}' was given. Expected values are '{types}'.", [
'type' => $type,
'types' => implode(', ', iState::TYPES_LIST)
]));
}
if (null === ($backend = ag($urlParts, 'host'))) {
throw new RuntimeException('No backend was given.');
}
$backends = array_keys(Config::get('servers', []));
if (false === in_array($backend, $backends)) {
throw new RuntimeException(r("Invalid backend name '{backend}' was given. Expected values are '{list}'.", [
'backend' => $backend,
'list' => implode(', ', $backends),
]));
}
return true;
}
}