+
-
+
-
- There are no client links configured. You can add new links by clicking on the
+
+ There are no client GUID links configured. You can add new links by clicking on the
button.
-
-
-
-
-
-
-
-
-
+
+
+
+ - Using this feature allows you to extend
WatchState to support more less known or regional
+ specific metadata databases. We cannot add support directly to all databases, so this feature instead
+ allow you to manually do it yourself.
+
+ -
+ Adding Custom guid without a client/s links is useless as the parsing engine will not know what to do with
+ it. So, make sure to add a client GUID link referencing the custom GUID.
+
+ - The guid names are unique. Therefore, you cannot reuse existing ones.
+ - You cannot add link from the same client GUID twice. For example you cannot add
jellyfin:foobar ->
+ WatchState:guid_foobar and another for jellyfin:foobar -> guid_imdb.
+
+ - Editing the
guid.yaml file directly is unsupported and might lead to unexpected behavior.
+ Please use the WebUI to manage the GUIDs. as we expose the entire functionality via the WebUI. with
+ safeguards to prevent you from doing something that might break the system.
+
+ - If you added or removed Custom GUID, you should run
+
+
+ system:index --force-reindex
+
+ command to rebuild the database indexes. While not required, it is recommended to ensure the database is
+ up to date. and the indexing is correct and for speedy database operations.
+
+ - The links are global for each client, not the backend itself. So, For example, if you have NN jellyfin
+ backends and you add new GUID link for jellyfin, it will be applied to all jellyfin backends. The backends
+ themselves don't need to report it, however the support will be available for all backends.
+
+ - For more information please read the content in the
FAQ.md page, or directly via
+
+
+ this link
+
+
+
+
+
@@ -174,20 +208,27 @@
diff --git a/src/API/System/Guids.php b/src/API/System/Guids.php
index 73a6c9ed..3a4e56b5 100644
--- a/src/API/System/Guids.php
+++ b/src/API/System/Guids.php
@@ -56,20 +56,20 @@ final class Guids
$params = DataUtil::fromRequest($request);
$requiredFields = [
- 'name',
- 'type',
- 'description',
- 'validator.pattern',
- 'validator.example',
- 'validator.tests.valid',
- 'validator.tests.invalid'
+ 'name' => 'string',
+ 'type' => join('|', array_keys(Config::get('supported'))),
+ 'description' => 'string',
+ 'validator.pattern' => 'string',
+ 'validator.example' => 'string',
+ 'validator.tests.valid' => ['string'],
+ 'validator.tests.invalid' => ['string'],
];
- foreach ($requiredFields as $field) {
+ foreach ($requiredFields as $field => $type) {
if (!$params->get($field)) {
return api_error(r("Field '{field}' is required. And is missing from request.", [
'field' => $field
- ]), Status::BAD_REQUEST);
+ ]), httpCode: Status::BAD_REQUEST, body: ['requiredFields' => $requiredFields]);
}
}
@@ -146,13 +146,15 @@ final class Guids
]
];
- $file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoCreate: true, autoBackup: true);
+ $file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoSave: false, autoCreate: true, autoBackup: true);
if (false === $file->has('guids') || false === is_array($file->get('guids'))) {
$file->set('guids', []);
}
- $file->set('guids.' . count($file->get('guids', [])), $data)->persist();
+ $guids = array_values($file->get('guids', []));
+ $guids[] = $data;
+ $file->set('guids', null)->set('guids', $guids)->persist();
return api_response(Status::OK, $data);
}
@@ -160,16 +162,15 @@ final class Guids
#[Delete(self::URL . '/custom/{id:uuid}[/]', name: 'system.guids.custom.guid.remove')]
public function custom_guid_remove(string $id): iResponse
{
- $guids = ag($this->getData(), 'guids', []);
-
$file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoCreate: true, autoBackup: true);
$data = [];
$found = false;
- foreach ($guids as $index => $guid) {
+
+ foreach ($file->get('guids', []) as $index => $guid) {
if ($guid['id'] === $id) {
$data = $guid;
- $file->delete('guids.' . $index)->persist();
+ $file->delete('guids.' . $index);
$found = true;
break;
}
@@ -179,6 +180,22 @@ final class Guids
return api_error(r("The GUID '{id}' is not found.", ['id' => $id]), Status::NOT_FOUND);
}
+ $guids = $file->get('guids', []);
+ $file->set('guids', null)->set('guids', array_values($guids))->persist();
+
+ $linkRemoved = false;
+ foreach ($file->get('links', []) as $index => $link) {
+ if (ag($link, 'map.to') === ag($data, 'name')) {
+ $file->delete('links.' . $index);
+ $linkRemoved = true;
+ }
+ }
+
+ if (true === $linkRemoved) {
+ $links = $file->get('links', []);
+ $file->set('links', null)->set('links', array_values($links));
+ }
+
$file->persist();
return api_response(Status::OK, $data);
@@ -197,8 +214,8 @@ final class Guids
);
}
- #[Put(self::URL . '/custom/{client:word}[/]', name: 'system.guids.custom.client.add')]
- public function custom_client_guid_add(iRequest $request, string $client): iResponse
+ #[Put(self::URL . '/custom/{client:word}[/]', name: 'system.guids.custom.client.link.add')]
+ public function custom_client_link_add(iRequest $request, string $client): iResponse
{
$params = DataUtil::fromRequest($request);
@@ -251,7 +268,7 @@ final class Guids
'type' => $client,
'map' => [
'from' => $params->get('map.from'),
- 'to' => $params->get('map.to'),
+ 'to' => $mapTo,
],
];
@@ -268,21 +285,51 @@ final class Guids
}
}
- $file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoCreate: true, autoBackup: true);
+ $file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoSave: false, autoCreate: true, autoBackup: true);
if (false === $file->has('links') || false === is_array($file->get('links'))) {
$file->set('links', []);
}
- $file->set('links.' . count($file->get('links', [])), $link)->persist();
+ $links = array_values($file->get('links', []));
+ $links[] = $link;
+
+ $file->set('links', null)->set('links', $links)->persist();
return api_response(Status::OK, $link);
}
- #[Delete(self::URL . '/custom/{client:word}/{index:number}[/]', name: 'system.guids.custom.client.remove')]
- public function custom_client_guid_remove(iRequest $request): iResponse
+ #[Delete(self::URL . '/custom/{client:word}/{id:uuid}[/]', name: 'system.guids.custom.client.remove')]
+ public function custom_client_guid_remove(string $client, string $id): iResponse
{
- return api_response(Status::OK, $request->getParsedBody());
+ $file = ConfigFile::open(Config::get('guid.file'), 'yaml', autoCreate: true, autoBackup: true);
+ $refIndex = $refData = null;
+
+ foreach ($file->get('links', []) as $i => $link) {
+ if (ag($link, 'type') !== $client || ag($link, 'id') !== $id) {
+ continue;
+ }
+
+ $refIndex = $i;
+ $refData = $link;
+ break;
+ }
+
+ if (null === $refIndex) {
+ return api_error(r("The client '{client}' link id '{id}' is not found.", [
+ 'client' => $client,
+ 'id' => $id
+ ]), Status::NOT_FOUND);
+ }
+
+ $file->delete('links.' . $refIndex);
+
+ $links = $file->get('links', []);
+ $file->set('links', null)
+ ->set('links', array_values($links))
+ ->persist();
+
+ return api_response(Status::OK, $refData);
}
#[Get(self::URL . '/custom/{client:word}/{index:number}[/]', name: 'system.guids.custom.client.guid.view')]
@@ -325,18 +372,22 @@ final class Guids
private function validateName(string $name): void
{
- $name = after($name, 'guid_');
+ $guidName = after($name, 'guid_');
- if (false === preg_match('/^[a-z0-9_]+$/i', $name)) {
+ if (false === preg_match('/^[a-z0-9_]+$/i', $guidName)) {
throw new InvalidArgumentException('Name must be alphanumeric and underscores only.');
}
- if (strtolower($name) !== $name) {
+ if (strtolower($guidName) !== $guidName) {
throw new InvalidArgumentException('Name must be lowercase.');
}
- if (str_contains($name, ' ')) {
+ if (str_contains($guidName, ' ')) {
throw new InvalidArgumentException('Name must not contain spaces.');
}
+
+ if (true === array_key_exists($name, Guid::getSupported())) {
+ throw new InvalidArgumentException(r("GUID name '{name}' is already in use.", ['name' => $name]));
+ }
}
}
diff --git a/src/Backends/Plex/PlexGuid.php b/src/Backends/Plex/PlexGuid.php
index bd8b9a3f..c81d3278 100644
--- a/src/Backends/Plex/PlexGuid.php
+++ b/src/Backends/Plex/PlexGuid.php
@@ -174,10 +174,10 @@ final class PlexGuid implements iGuid
continue;
}
- if (null !== ($replace = ag($map, 'replace', null))) {
+ if (null !== ($replace = ag($map, 'options.replace', null))) {
if (false === is_array($replace)) {
$this->logger->warning(
- "Ignoring 'links.{key}'. replace value must be an object. '{given}' is given.",
+ "Ignoring 'links.{key}'. options.replace value must be an object. '{given}' is given.",
[
'key' => $key,
'given' => get_debug_type($replace),
@@ -190,14 +190,17 @@ final class PlexGuid implements iGuid
$to = ag($replace, 'to', null);
if (empty($from) || false === is_string($from)) {
- $this->logger->warning("Ignoring 'links.{key}'. replace.from field is empty or not a string.", [
- 'key' => $key,
- ]);
+ $this->logger->warning(
+ "Ignoring 'links.{key}'. options.replace.from field is empty or not a string.",
+ [
+ 'key' => $key,
+ ]
+ );
continue;
}
if (false === is_string($to)) {
- $this->logger->warning("Ignoring 'links.{key}'. replacer.to field is not a string.", [
+ $this->logger->warning("Ignoring 'links.{key}'. options.replace.to field is not a string.", [
'key' => $key,
]);
continue;
diff --git a/src/Commands/System/IndexCommand.php b/src/Commands/System/IndexCommand.php
index 02a5e7d4..4a705423 100644
--- a/src/Commands/System/IndexCommand.php
+++ b/src/Commands/System/IndexCommand.php
@@ -86,6 +86,10 @@ final class IndexCommand extends Command
'force-reindex' => (bool)$input->getOption('force-reindex'),
]);
+ if ($input->getOption('force-reindex')) {
+ $output->writeln('
Indexes have been recreated successfully.');
+ }
+
return self::SUCCESS;
}
}
diff --git a/tests/Backends/Plex/PlexGuidTest.php b/tests/Backends/Plex/PlexGuidTest.php
index 03384016..4534181e 100644
--- a/tests/Backends/Plex/PlexGuidTest.php
+++ b/tests/Backends/Plex/PlexGuidTest.php
@@ -206,10 +206,10 @@ class PlexGuidTest extends TestCase
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertTrue(
$this->logged(Level::Warning, 'Value must be an object.', true),
- 'Assert replace key is an object.'
+ 'Assert link value is an object.'
);
- $yaml = ag_set($yaml, 'links.0.replace', 'foo');
+ $yaml = ag_set($yaml, 'links.0.options.replace', 'foo');
file_put_contents($tmpFile, Yaml::dump($yaml));
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertTrue(
@@ -217,23 +217,23 @@ class PlexGuidTest extends TestCase
'Assert replace key is an object.'
);
- $yaml = ag_set($yaml, 'links.0.replace', []);
+ $yaml = ag_set($yaml, 'links.0.options.replace', []);
file_put_contents($tmpFile, Yaml::dump($yaml));
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertTrue(
- $this->logged(Level::Warning, 'replace.from field is empty or not a string.', true),
+ $this->logged(Level::Warning, 'options.replace.from field is empty or not a string.', true),
'Assert to field is a string.'
);
- $yaml = ag_set($yaml, 'links.0.replace.from', 'foo');
+ $yaml = ag_set($yaml, 'links.0.options.replace.from', 'foo');
file_put_contents($tmpFile, Yaml::dump($yaml));
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertTrue(
- $this->logged(Level::Warning, 'replacer.to field is not a string.', true),
+ $this->logged(Level::Warning, 'options.replace.to field is not a string.', true),
'Assert to field is a string.'
);
- $yaml = ag_set($yaml, 'links.0.replace.to', 'bar');
+ $yaml = ag_set($yaml, 'links.0.options.replace.to', 'bar');
file_put_contents($tmpFile, Yaml::dump($yaml));
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertCount(0, $this->handler->getRecords(), "There should be no error messages logged.");
@@ -252,7 +252,7 @@ class PlexGuidTest extends TestCase
$this->getClass()->parseGUIDFile($tmpFile);
$this->assertTrue(
$this->logged(Level::Warning, 'map value must be an object.', true),
- 'Assert replace key is an object.'
+ 'Assert map key is an object.'
);
$yaml = ag_set($yaml, 'links.0.map', []);