Add Plex OAuth

bootstrap.php

@@ -12,6 +12,8 @@
         \Movary\Service\ImageCacheService::class => DI\factory([Factory::class, 'createImageCacheService']),
         \Movary\JobQueue\JobQueueScheduler::class => DI\factory([Factory::class, 'createJobQueueScheduler']),
         \Movary\Api\Tmdb\TmdbClient::class => DI\factory([Factory::class, 'createTmdbApiClient']),
+        \Movary\Api\Plex\PlexLocalServerClient::class => DI\factory([Factory::class, 'createPlexLocalServerClient']),
+        \Movary\Api\Plex\PlexTvClient::class => DI\factory([Factory::class, 'createPlexTvClient']),
         \Movary\Service\UrlGenerator::class => DI\factory([Factory::class, 'createUrlGenerator']),
         \Movary\Service\Export\ExportService::class => DI\factory([Factory::class, 'createExportService']),
         \Movary\HttpController\CreateUserController::class => DI\factory([Factory::class, 'createCreateUserController']),

db/migrations/mysql/20230627162519_add_plex_columns.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+
+use Phinx\Migration\AbstractMigration;
+
+final class AddPlexColumns extends AbstractMigration
+{
+    public function down() : void
+    {
+        $this->execute(
+            <<<SQL
+            ALTER TABLE user DROP COLUMN plex_client_id;
+            ALTER TABLE user DROP COLUMN plex_client_temporary_code;
+            ALTER TABLE user DROP COLUMN plex_access_token;
+            ALTER TABLE user DROP COLUMN plex_account_id;
+            ALTER TABLE user DROP COLUMN plex_server_url;
+            SQL,
+        );
+    }
+
+    public function up() : void
+    {
+        $this->execute(
+            <<<SQL
+            ALTER TABLE user ADD COLUMN plex_client_id CHAR(64) DEFAULT NULL AFTER trakt_client_id;
+            ALTER TABLE user ADD COLUMN plex_client_temporary_code CHAR(64) DEFAULT NULL AFTER plex_client_id;
+            ALTER TABLE user ADD COLUMN plex_access_token CHAR(128) DEFAULT NULL AFTER plex_client_temporary_code;
+            ALTER TABLE user ADD COLUMN plex_account_id CHAR(64) DEFAULT NULL AFTER plex_access_token;
+            ALTER TABLE user ADD COLUMN plex_server_url CHAR(128) DEFAULT NULL AFTER plex_account_id;
+            SQL,
+        );
+    }
+}

db/migrations/sqlite/20230627162519_AddPlexColumns.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types=1);
+
+use Phinx\Migration\AbstractMigration;
+
+final class AddPlexColumns extends AbstractMigration
+{
+    public function down() : void
+    {
+        $this->execute(
+            <<<SQL
+            CREATE TABLE `tmp_user` (
+                `id` INTEGER,
+                `email` TEXT NOT NULL,
+                `name` TEXT NOT NULL,
+                `password` TEXT NOT NULL ,
+                `privacy_level` INTEGER DEFAULT 1,
+                `date_format_id` INTEGER DEFAULT 0,
+                `trakt_user_name` TEXT,
+                `plex_webhook_uuid` TEXT,
+                `jellyfin_webhook_uuid` TEXT,
+                `trakt_client_id` TEXT,
+                `jellyfin_scrobble_views` INTEGER DEFAULT 1,
+                `plex_scrobble_views` INTEGER DEFAULT 1,
+                `plex_scrobble_ratings` INTEGER DEFAULT 0,
+                `core_account_changes_disabled` INTEGER DEFAULT 0,
+                `created_at` TEXT NOT NULL,
+                PRIMARY KEY (`id`),
+                UNIQUE (`email`), 
+                UNIQUE (`name`) 
+            )
+            SQL,
+        );
+        $this->execute('INSERT INTO `tmp_user` (id, email, name, password, privacy_level, date_format_id, trakt_user_name, plex_webhook_uuid, jellyfin_webhook_uuid, trakt_client_id, jellyfin_scrobble_views, plex_scrobble_views, plex_scrobble_ratings, core_account_changes_disabled, created_at) SELECT `id`, `email`, `name`, `password`, `privacy_level`, `date_format_id`, `trakt_user_name`, `plex_webhook_uuid`, `jellyfin_webhook_uuid`, `trakt_client_id`, `jellyfin_scrobble_views`, `plex_scrobble_views`, `plex_scrobble_ratings`, `core_account_changes_disabled`, `created_at` FROM user');
+        $this->execute('DROP TABLE `user`');
+        $this->execute('ALTER TABLE `tmp_user` RENAME TO `user`');
+    }
+
+    public function up() : void
+    {
+        $this->execute(
+            <<<SQL
+            CREATE TABLE `tmp_user` (
+                `id` INTEGER,
+                `email` TEXT NOT NULL,
+                `name` TEXT NOT NULL,
+                `password` TEXT NOT NULL ,
+                `privacy_level` INTEGER DEFAULT 1,
+                `date_format_id` INTEGER DEFAULT 0,
+                `trakt_user_name` TEXT,
+                `plex_webhook_uuid` TEXT,
+                `jellyfin_webhook_uuid` TEXT,
+                `trakt_client_id` TEXT,
+                `jellyfin_scrobble_views` INTEGER DEFAULT 1,
+                `plex_scrobble_views` INTEGER DEFAULT 1,
+                `plex_scrobble_ratings` INTEGER DEFAULT 0,
+                `plex_client_id` TEXT DEFAULT NULL,
+                `plex_client_temporary_code` TEXT DEFAULT NULL,
+                `plex_access_token` TEXT DEFAULT NULL,
+                `plex_account_id` TEXT DEFAULT NULL,
+                `plex_server_url` TEXT DEFAULT NULL,
+                `core_account_changes_disabled` INTEGER DEFAULT 0,
+                `created_at` TEXT NOT NULL,
+                PRIMARY KEY (`id`),
+                UNIQUE (`email`), 
+                UNIQUE (`name`) 
+            )
+            SQL,
+        );
+        $this->execute('INSERT INTO `tmp_user` (id, email, name, password, privacy_level, date_format_id, trakt_user_name, plex_webhook_uuid, jellyfin_webhook_uuid, trakt_client_id, jellyfin_scrobble_views, plex_scrobble_views, plex_scrobble_ratings, core_account_changes_disabled, created_at) SELECT * FROM user');
+        $this->execute('DROP TABLE `user`');
+        $this->execute('ALTER TABLE `tmp_user` RENAME TO `user`');
+    }
+}

public/js/settings-integration-plex.js

@@ -91,3 +91,129 @@ async function updateScrobbleOptions() {
         addAlert('alertWebhookOptionsDiv', 'Could not update scrobble options', 'danger')
     });
 }
+
+async function authenticateWithPlex() {
+    const response = await fetch(
+        '/settings/plex/authentication-url',
+        {signal: AbortSignal.timeout(4000)}
+    ).catch(function (error) {
+        document.getElementById('alertPlexServerUrlLoadingSpinner').classList.add('d-none')
+
+        console.log(error)
+        addAlert('alertPlexServerUrlDiv', 'Authentication did not work', 'danger')
+    });
+
+    if (!response.ok) {
+        addAlert('alertPlexAuthenticationDiv', 'Authentication did not work', 'danger')
+
+        return
+    }
+
+    const data = await response.json()
+
+    location.href = data.authenticationUrl;
+}
+
+async function removePlexAuthentication() {
+    const response = await fetch(
+        '/settings/plex/logout',
+        {signal: AbortSignal.timeout(4000)}
+    ).catch(function (error) {
+        console.log(error)
+
+        addAlert('alertPlexAuthenticationDiv', 'Could not remove authentication', 'danger')
+    });
+
+    if (!response.ok) {
+        addAlert('alertPlexAuthenticationDiv', 'Could not remove authentication', 'danger')
+
+        return
+    }
+
+    document.getElementById('plexServerUrlInput').disabled = true
+    document.getElementById('plexServerUrlInput').value = ''
+    document.getElementById('saveServerUrlButton').disabled = true
+    document.getElementById('verifyServerUrlButton').disabled = true
+
+    document.getElementById('authenticateWithPlexDiv').classList.remove('d-none')
+    document.getElementById('removeAuthenticationWithPlexDiv').classList.add('d-none')
+
+    addAlert('alertPlexAuthenticationDiv', 'Plex authentication was removed', 'success')
+}
+
+async function savePlexServerUrl() {
+    const response = await fetch('/settings/plex/server-url-save', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+            'plexServerUrl': document.getElementById('plexServerUrlInput').value,
+        })
+    }).then(async function (response) {
+        return {'status': response.status, 'message': await response.text()};
+    }).then(function (data) {
+        if (data.status === 200) {
+            addAlert('alertPlexServerUrlDiv', 'Server URL was updated', 'success')
+
+            return
+        }
+
+        if (data.status === 400) {
+            addAlert('alertPlexServerUrlDiv', data.message, 'danger')
+
+            return
+        }
+
+        addAlert('alertPlexServerUrlDiv', 'Server URL could not be updated', 'danger')
+    }).catch(function (error) {
+        document.getElementById('alertPlexServerUrlLoadingSpinner').classList.add('d-none')
+
+        console.log(error)
+        addAlert('alertPlexServerUrlDiv', 'Server URL could not be updated', 'danger')
+    });
+}
+
+async function verifyPlexServerUrl() {
+    document.getElementById('alertPlexServerUrlLoadingSpinner').classList.remove('d-none')
+    removeAlert('alertPlexServerUrlDiv')
+
+    const response = await fetch('/settings/plex/server-url-verify', {
+        signal: AbortSignal.timeout(4000),
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+            'plexServerUrl': document.getElementById('plexServerUrlInput').value,
+        })
+    }).then(async function (response) {
+        document.getElementById('alertPlexServerUrlLoadingSpinner').classList.add('d-none')
+
+        return {'status': response.status, 'message': await response.json()};
+    }).then(function (data) {
+        if (data.status === 200 && data.message === true) {
+            addAlert('alertPlexServerUrlDiv', 'Connection test successful', 'success')
+
+            return
+        }
+
+        if (data.status === 400) {
+            addAlert('alertPlexServerUrlDiv', data.message, 'danger')
+
+            return
+        }
+
+        addAlert('alertPlexServerUrlDiv', 'Connection test failed', 'danger')
+    }).catch(function (error) {
+        document.getElementById('alertPlexServerUrlLoadingSpinner').classList.add('d-none')
+
+        console.log(error)
+        addAlert('alertPlexServerUrlDiv', 'Connection test failed', 'danger')
+    });
+}
+
+document.getElementById('verifyServerUrlButton').disabled = document.getElementById('plexServerUrlInput').value === ''
+document.getElementById('plexServerUrlInput').addEventListener('input', function (e) {
+    document.getElementById('verifyServerUrlButton').disabled = e.target.value === ''
+});

settings/routes.php

@@ -218,6 +218,31 @@
         '/settings/integrations/plex',
         [\Movary\HttpController\SettingsController::class, 'renderPlexPage'],
     );
+    $routeCollector->addRoute(
+        'GET',
+        '/settings/plex/logout',
+        [\Movary\HttpController\PlexController::class, 'removePlexAccessTokens'],
+    );
+    $routeCollector->addRoute(
+        'POST',
+        '/settings/plex/server-url-save',
+        [\Movary\HttpController\PlexController::class, 'savePlexServerUrl'],
+    );
+    $routeCollector->addRoute(
+        'POST',
+        '/settings/plex/server-url-verify',
+        [\Movary\HttpController\PlexController::class, 'verifyPlexServerUrl'],
+    );
+    $routeCollector->addRoute(
+        'GET',
+        '/settings/plex/authentication-url',
+        [\Movary\HttpController\PlexController::class, 'generatePlexAuthenticationUrl'],
+    );
+    $routeCollector->addRoute(
+        'GET',
+        '/settings/plex/callback',
+        [\Movary\HttpController\PlexController::class, 'processPlexCallback'],
+    );
     $routeCollector->addRoute(
         'POST',
         '/settings/plex',

src/Api/Plex/Dto/PlexAccessToken.php

@@ -0,0 +1,21 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Dto;
+
+class PlexAccessToken
+{
+    public function __construct(
+        private readonly string $plexAccessToken,
+    ) {
+    }
+
+    public static function createPlexAccessToken(string $plexAccessToken) : self
+    {
+        return new self($plexAccessToken);
+    }
+
+    public function getPlexAccessTokenAsString() : string
+    {
+        return $this->plexAccessToken;
+    }
+}

src/Api/Plex/Dto/PlexAccount.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Dto;
+
+class PlexAccount
+{
+    public function __construct(
+        private readonly int $plexId,
+        private readonly string $username,
+    ) {
+    }
+
+    public static function createPlexAccount(int $plexId, string $username) : self
+    {
+        return new self($plexId, $username);
+    }
+
+    public function getPlexId() : int
+    {
+        return $this->plexId;
+    }
+
+    public function getPlexUsername() : string
+    {
+        return $this->username;
+    }
+}

src/Api/Plex/Exception/MovaryApplicationUrlNotSet.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Exception;
+
+class MovaryApplicationUrlNotSet extends \RuntimeException
+{
+    public static function create() : self
+    {
+        return new self('Movary application url is not set');
+    }
+}

src/Api/Plex/Exception/PlexAuthenticationError.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Exception;
+
+use RuntimeException;
+
+class PlexAuthenticationError extends RuntimeException
+{
+    public static function create() : self
+    {
+        return new self('The access token is invalid.');
+    }
+}

src/Api/Plex/Exception/PlexNoClientIdentifier.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Exception;
+
+use RuntimeException;
+
+class PlexNoClientIdentifier extends RuntimeException
+{
+    public static function create() : self
+    {
+        return new self('No client identifier has been found. Please add it in the environment variables before using the Plex API');
+    }
+}

src/Api/Plex/Exception/PlexNoLibrariesAvailable.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Exception;
+
+use RuntimeException;
+
+class PlexNoLibrariesAvailable extends RuntimeException
+{
+    public static function create(int $userId) : self
+    {
+        return new self('No libraries have been found for the user with id ' . $userId);
+    }
+}

src/Api/Plex/Exception/PlexNotFoundError.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Api\Plex\Exception;
+
+use Movary\ValueObject\Url;
+use RuntimeException;
+
+class PlexNotFoundError extends RuntimeException
+{
+    public static function create(Url $requestUri) : self
+    {
+        return new self('The requested URI does not exist: ' . $requestUri);
+    }
+}