wip: adds cache rich functionality

assets/controllers/clear_cache_controller.js

@@ -0,0 +1,30 @@
+import { Controller } from '@hotwired/stimulus';
+
+/*
+* The following line makes this controller "lazy": it won't be downloaded until needed
+* See https://symfony.com/bundles/StimulusBundle/current/index.html#lazy-stimulus-controllers
+*/
+
+/* stimulusFetch: 'lazy' */
+export default class extends Controller {
+    initialize() {}
+
+    connect() {}
+
+    disconnect() {}
+
+    async clearAll() {
+        let response = await fetch('/api/torrentio/cache', {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+            },
+            body: JSON.stringify({
+                type: 'torrentio',
+                mediaType: 'tvshows',
+            })
+        });
+        response = await response.json()
+    }
+}

assets/styles/app.css

@@ -25,6 +25,13 @@
     .alert-warning {
         @apply bg-yellow-500/70 hover:bg-yellow-600 border-yellow-400 text-black
     }
+
+    .primary-btn {
+        @apply px-1 py-1 rounded-md bg-orange-500 self-end text-white w-16 ml-2 hover:bg-orange-600
+    }
+    .secondary-btn {
+        @apply px-1 py-1 rounded-md self-end w-16 hover:bg-stone-100
+    }
 }
 
 /* Prevent scrolling while dialog is open */

config/packages/cache.yaml

@@ -15,5 +15,11 @@ framework:
         #app: cache.adapter.apcu
 
         # Namespaced pools use the above "app" backend by default
-        #pools:
-            #my.dedicated.cache: null
+        pools:
+            torrentio.cache:
+                adapter: cache.app
+            tmdb.cache:
+                adapter: cache.app
+                default_lifetime: 2592000
+            page.cache:
+                adapter: cache.app

config/routes.yaml

@@ -29,3 +29,12 @@ controllersMonitor:
     type: attribute
     defaults:
         schemes: ['https']
+
+controllersTorrentio:
+    resource:
+        path: ../src/Torrentio/Framework/Controller
+        namespace: App\Torrentio\Framework\Controller
+    type: attribute
+    defaults:
+        schemes: [ 'https' ]
+

src/Controller/TorrentioController.php

@@ -15,6 +15,7 @@ use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 final class TorrentioController extends AbstractController
 {
@@ -25,7 +26,7 @@ final class TorrentioController extends AbstractController
     ) {}
 
     #[Route('/torrentio/movies/{tmdbId}/{imdbId}', name: 'app_torrentio_movies')]
-    public function movieOptions(GetMovieOptionsInput $input, CacheInterface $cache): Response
+    public function movieOptions(GetMovieOptionsInput $input, TagAwareCacheInterface $pageCache): Response
     {
         $cacheId = sprintf(
             "page.torrentio.movies.%s.%s",
@@ -33,17 +34,29 @@ final class TorrentioController extends AbstractController
             $input->imdbId
         );
 
-        return $cache->get($cacheId, function (ItemInterface $item) use ($input) {
-            $item->expiresAt(Carbon::now()->addHour()->setMinute(0)->setSecond(0));
-            $results = $this->getMovieOptionsHandler->handle($input->toCommand());
-            return $this->render('torrentio/movies.html.twig', [
-                'results' => $results,
-            ]);
-        });
+        try {
+            return $pageCache->get($cacheId, function (ItemInterface $item) use ($input) {
+                $item->expiresAt(Carbon::now()->addHour()->setMinute(0)->setSecond(0));
+                $item->tag(['page', 'page.torrentio', 'page.torrentio.movies', "page.torrentio.movies.$input->tmdbId.$input->imdbId", 'torrentio', 'torrentio.movies', "torrentio.movies.$input->tmdbId.$input->imdbId"]);
+                $results = $this->getMovieOptionsHandler->handle($input->toCommand());
+                return $this->render('torrentio/movies.html.twig', [
+                    'results' => $results,
+                ]);
+            });
+        } catch (TorrentioRateLimitException $exception) {
+            $this->broadcaster->alert('Warning', 'Torrentio has rate limited your requests. Please wait a few minutes before trying again.', 'warning');
+            return $this->render('bare.html.twig',
+                [],
+                new Response('Too many requests',
+                    Response::HTTP_TOO_MANY_REQUESTS,
+                    ['Retry-After' => 4000]
+                )
+            );
+        }
     }
 
     #[Route('/torrentio/tvshows/{tmdbId}/{imdbId}/{season?}/{episode?}', name: 'app_torrentio_tvshows')]
-    public function tvShowOptions(GetTvShowOptionsInput $input, CacheInterface $cache): Response
+    public function tvShowOptions(GetTvShowOptionsInput $input, TagAwareCacheInterface $pageCache): Response
     {
         $cacheId = sprintf(
             "page.torrentio.tvshows.%s.%s.%s.%s",
@@ -54,8 +67,9 @@ final class TorrentioController extends AbstractController
         );
 
         try {
-            return $cache->get($cacheId, function (ItemInterface $item) use ($input) {
+            return $pageCache->get($cacheId, function (ItemInterface $item) use ($input) {
                 $item->expiresAt(Carbon::now()->addHour()->setMinute(0)->setSecond(0));
+                $item->tag(['page', 'page.torrentio', 'page.torrentio.tvshows', "page.torrentio.tvshows.$input->tmdbId.$input->imdbId", "page.torrentio.tvshows.$input->tmdbId.$input->imdbId.$input->season", "page.torrentio.tvshows.$input->tmdbId.$input->imdbId.$input->season.$input->episode", 'torrentio', 'torrentio.tvshows', "torrentio.tvshows.$input->tmdbId.$input->imdbId", "torrentio.tvshows.$input->tmdbId.$input->imdbId.$input->season", "torrentio.tvshows.$input->tmdbId.$input->imdbId.$input->season.$input->episode", $input->imdbId, $input->tmdbId]);
                 $results = $this->getTvShowOptionsHandler->handle($input->toCommand());
                 return $this->render('torrentio/tvshows.html.twig', [
                     'results' => $results,

src/Tmdb/Tmdb.php

@@ -44,7 +44,7 @@ class Tmdb
     const POSTER_IMG_PATH = "https://image.tmdb.org/t/p/w500";
 
     public function __construct(
-        private readonly CacheItemPoolInterface $cache,
+        private readonly CacheItemPoolInterface $tmdbCache,
         private readonly EventDispatcherInterface $eventDispatcher,
         #[Autowire(env: 'TMDB_API')] string $apiKey,
     ) {
@@ -78,7 +78,7 @@ class Tmdb
         $requestListener = new Psr6CachedRequestListener(
             $this->client->getHttpClient(),
             $this->eventDispatcher,
-            $cache,
+            $tmdbCache,
             $this->client->getHttpClient()->getPsr17StreamFactory(),
             []
         );
@@ -325,7 +325,7 @@ class Tmdb
 
     public function getImdbId(string $tmdbId, $mediaType)
     {
-        $externalIds = $this->cache->get("tmdb.externalIds.{$tmdbId}",
+        $externalIds = $this->tmdbCache->get("tmdb.externalIds.{$tmdbId}",
             function (ItemInterface $item) use ($tmdbId, $mediaType) {
                 switch (MediaType::tryFrom($mediaType)->value) {
                     case MediaType::Movie->value:
@@ -346,7 +346,7 @@ class Tmdb
 
     public function getImages($tmdbId, $mediaType)
     {
-        return $this->cache->get("tmdb.images.{$tmdbId}",
+        return $this->tmdbCache->get("tmdb.images.{$tmdbId}",
             function (ItemInterface $item) use ($tmdbId, $mediaType) {
                 switch (MediaType::tryFrom($mediaType)->value) {
                     case MediaType::Movie->value:

src/Torrentio/Action/Command/DeleteCacheCommand.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Torrentio\Action\Command;
+
+use OneToMany\RichBundle\Contract\CommandInterface;
+
+class DeleteCacheCommand implements CommandInterface
+{
+    public function __construct(
+        public ?string $type = null,
+        public ?string $mediaType = null,
+        public ?string $tmdbId = null,
+        public ?string $imdbId = null,
+        public ?int $season = null,
+        public ?int $episode = null,
+        public ?array $tags = null,
+    ) {}
+}

src/Torrentio/Action/Handler/DeleteCacheHandler.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Torrentio\Action\Handler;
+
+use Aimeos\Map;
+use App\Torrentio\Action\Command\DeleteCacheCommand;
+use App\Torrentio\Action\Result\DeleteCacheResult;
+use OneToMany\RichBundle\Contract\CommandInterface;
+use OneToMany\RichBundle\Contract\HandlerInterface;
+use OneToMany\RichBundle\Contract\ResultInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+
+/** @implements HandlerInterface<DeleteCacheCommand, DeleteCacheResult> */
+class DeleteCacheHandler implements HandlerInterface
+{
+    public function __construct(
+        private readonly TagAwareCacheInterface $torrentioCache
+    ) {}
+
+    public function handle(CommandInterface $command): ResultInterface
+    {
+        $input = Map::from((array) $command)
+            ->filter(fn ($value, $key) => null !== $value && "" !== $value)
+            ;
+
+        $cacheKey = null;
+        if ($input->has('type')) {
+            $cacheKey = $input->get('type');
+
+            if ($input->has('mediaType')) {
+                $cacheKey .= ".".$input->get('mediaType');
+
+                if ($input->has('tmdbId')) {
+                    $cacheKey .= ".".$input->get('tmdbId');
+
+                    if ($input->has('imdbId')) {
+                        $cacheKey .= ".".$input->get('imdbId');
+
+                        if ($input->has('season')) {
+                            $cacheKey .= ".".$input->get('season');
+
+                            if ($input->has('episode')) {
+                                $cacheKey .= ".".$input->get('episode');
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+        if ($cacheKey !== null) {
+            $this->torrentioCache->invalidateTags([$cacheKey]);
+        }
+
+        if ($input->has('tags')) {
+            $this->torrentioCache->invalidateTags($input->get('tags'));
+        }
+
+        return new DeleteCacheResult($input, $cacheKey, $command->tags);
+    }
+}

src/Torrentio/Action/Input/DeleteCacheInput.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Torrentio\Action\Input;
+
+use App\Torrentio\Action\Command\DeleteCacheCommand;
+use OneToMany\RichBundle\Attribute\SourceRequest;
+use OneToMany\RichBundle\Contract\CommandInterface;
+use OneToMany\RichBundle\Contract\InputInterface;
+
+/**
+ * @implements DeleteCacheInput<DeleteCacheCommand>
+ */
+class DeleteCacheInput implements InputInterface
+{
+    public function __construct(
+        #[SourceRequest('type', nullify: true)]
+        public ?string $type,
+
+        #[SourceRequest('mediaType', nullify: true)]
+        public ?string $mediaType,
+
+        #[SourceRequest('tmdbId', nullify: true)]
+        public ?string $tmdbId,
+
+        #[SourceRequest('imdbId', nullify: true)]
+        public ?string $imdbId,
+
+        #[SourceRequest('season', nullify: true)]
+        public ?int $season,
+
+        #[SourceRequest('episode', nullify: true)]
+        public ?int $episode,
+
+        #[SourceRequest('tags', nullify: true)]
+        public ?array $tags,
+    ) {}
+
+    public function toCommand(): CommandInterface
+    {
+        return new DeleteCacheCommand(
+            type: $this->type,
+            mediaType:  $this->mediaType,
+            tmdbId: $this->tmdbId,
+            imdbId: $this->imdbId,
+            season: $this->season,
+            episode: $this->episode
+        );
+    }
+}

src/Torrentio/Action/Result/DeleteCacheResult.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Torrentio\Action\Result;
+
+use Aimeos\Map;
+use OneToMany\RichBundle\Contract\ResultInterface;
+
+class DeleteCacheResult implements ResultInterface
+{
+    public function __construct(
+        public Map $result,
+        public ?string $cacheKey = null,
+        public ?array $tags = null,
+    ) {}
+}

src/Torrentio/Client/Torrentio.php

@@ -10,8 +10,8 @@ use App\Torrentio\Exception\TorrentioRateLimitException;
 use GuzzleHttp\Client;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
-use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 class Torrentio
 {
@@ -23,7 +23,7 @@ class Torrentio
 
     public function __construct(
         #[Autowire(env: 'REAL_DEBRID_KEY')] private string $realDebridKey,
-        private CacheInterface $cache,
+        private TagAwareCacheInterface $torrentioCache,
         private LoggerInterface $logger,
     ) {
         $this->searchUrl = str_replace('{realDebridKey}', $this->realDebridKey, $this->baseUrl);
@@ -36,8 +36,9 @@ class Torrentio
     {
         $cacheKey = "torrentio.{$imdbCode}";
 
-        $results = $this->cache->get($cacheKey, function (ItemInterface $item) use ($imdbCode) {
+        $results = $this->torrentioCache->get($cacheKey, function (ItemInterface $item) use ($imdbCode, $type) {
             $item->expiresAt(Carbon::now()->addHour()->setMinute(0)->setSecond(0));
+            $item->tag(['torrentio', $type, $imdbCode]);
             try {
                 $response = $this->client->get("$this->searchUrl/$imdbCode.json");
                 return json_decode(
@@ -61,8 +62,9 @@ class Torrentio
     public function fetchEpisodeResults(string $imdbId, int $season, int $episode): array
     {
         $cacheKey = "torrentio.$imdbId.$season.$episode";
-        $results = $this->cache->get($cacheKey, function (ItemInterface $item) use ($imdbId, $season, $episode) {
+        $results = $this->torrentioCache->get($cacheKey, function (ItemInterface $item) use ($imdbId, $season, $episode) {
             $item->expiresAt(Carbon::now()->addHour()->setMinute(0)->setSecond(0));
+            $item->tag(['torrentio', 'tvshows', 'torrentio.tvshows', $imdbId, "torrentio.$imdbId", "$imdbId.$season", "torrentio.$imdbId.$season", "$imdbId.$season.$episode", "torrentio.$imdbId.$season.$episode"]);
             try {
                 $response = $this->client->get("$this->searchUrl/$imdbId:$season:$episode.json");
                 return json_decode(

src/Torrentio/Framework/Controller/ApiController.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Torrentio\Framework\Controller;
+
+use App\Torrentio\Action\Handler\DeleteCacheHandler;
+use App\Torrentio\Action\Input\DeleteCacheInput;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+class ApiController extends AbstractController
+{
+    #[Route('/api/torrentio/cache', name: 'api.torrentio.cache', methods: ['POST'])]
+    public function deleteCache(
+        DeleteCacheInput $deleteCacheInput,
+        DeleteCacheHandler $deleteCacheHandler,
+    ): Response {
+        $result = $deleteCacheHandler->handle($deleteCacheInput->toCommand());
+        return $this->json($result, Response::HTTP_OK);
+    }
+}

templates/base.html.twig

@@ -19,7 +19,12 @@
             </div>
             <div class="col-span-5 h-screen overflow-y-scroll">
                 <twig:Header />
-                <h2 class="px-4 my-2 text-3xl font-bold text-gray-50">{% block h2 %}{% endblock %}</h2>
+                <div class="px-4 mt-3 flex flex-row justify-between">
+                    <h2 class="m-2 text-3xl font-bold text-gray-50">{% block h2 %}{% endblock %}</h2>
+                    <div class="flex flex-row gap-1 align-end justify-end items-end">
+                        {% block action_buttons %}{% endblock %}
+                    </div>
+                </div>
                 {% block body %}{% endblock %}
             </div>
         </div>

templates/components/Modal.html.twig

@@ -9,12 +9,12 @@
         {% if show_cancel is defined or show_submit is defined %}
             <div class="flex justify-end">
             {% if show_cancel is defined %}
-                <button type="button" data-action="dialog#close" class="px-1 py-1 rounded-md self-end w-16 hover:bg-stone-100" autofocus>
+                <button type="button" data-action="dialog#close" class="secondary-btn" autofocus>
                     {{ cancel_text|default('Cancel') }}
                 </button>
             {% endif %}
             {% if show_submit is defined %}
-                <button type="button" {{ submit_action|raw }} class="px-1 py-1 rounded-md bg-orange-500 self-end text-white w-16 ml-2 hover:bg-orange-600" autofocus>
+                <button type="button" {{ submit_action|raw }} class="primary-btn" autofocus>
                     {{ submit_text|default('Submit') }}
                 </button>
             {% endif %}
@@ -22,5 +22,5 @@
         {% endif %}
     </dialog>
 
-    <button type="button" data-action="dialog#open">{{ button_text|raw }}</button>
+    <button type="button" data-action="dialog#open" class="{{ button_class|default('') }}">{{ button_text|raw }}</button>
 </div>

templates/downloads/index.html.twig

@@ -9,7 +9,6 @@
             <twig:DownloadList type="active" :isWidget="false" :perPage="10"></twig:DownloadList>
         </twig:Card>
     </div>
-
     <div class="p-4">
         <twig:Card title="Recent Downloads">
             <twig:DownloadList type="complete" :isWidget="false" :perPage="10"></twig:DownloadList>

templates/index/index.html.twig

@@ -1,10 +1,10 @@
 {% extends 'base.html.twig' %}
 
 {% block title %}Dashboard — Torsearch{% endblock %}
+{% block h2 %}Dashboard{% endblock %}
 
 {% block body %}
     <div class="p-4 flex flex-col grow gap-4 z-30">
-        <h2 class="mb-2 text-3xl font-bold text-gray-50">Dashboard</h2>
         <div class="flex flex-row gap-4">
             <twig:Card title="Active Downloads" class="w-full">
                 <twig:DownloadList :type="'active'" />

templates/monitor/index.html.twig

@@ -4,16 +4,14 @@
 {% block h2 %}Monitors{% endblock %}
 
 {% block body %}
-    <div class="flex flex-row">
-
-        <div class="p-2 flex flex-col gap-4">
-            <twig:Card title="Active Monitors">
-                <twig:MonitorList :type="'active'" :isWidget="false" :perPage="10"></twig:MonitorList>
-            </twig:Card>
-            <twig:Card title="Complete Monitors">
-                <twig:MonitorList :type="'complete'" :isWidget="false" :perPage="10"></twig:MonitorList>
-            </twig:Card>
-        </div>
-
+    <div class="p-4">
+        <twig:Card title="Active Monitors" class="w-full">
+            <twig:MonitorList :type="'active'" :isWidget="false" :perPage="10"></twig:MonitorList>
+        </twig:Card>
+    </div>
+    <div class="p-4">
+        <twig:Card title="Complete Monitors" class="w-full">
+            <twig:MonitorList :type="'complete'" :isWidget="false" :perPage="10"></twig:MonitorList>
+        </twig:Card>
     </div>
 {% endblock %}

templates/user/preferences.html.twig

@@ -2,6 +2,18 @@
 {% block title %}Preferences{% endblock %}
 {% block h2 %}Preferences{% endblock %}
 
+{% block action_buttons %}
+    <div {{ stimulus_controller('clear_cache') }}>
+        <twig:Modal heading="Hold on a sec!" button_text="Clear Cache" cancel_text="Nope" submit_text="Yep" show_cancel show_submit
+                    button_class="px-1.5 py-1 my-2 text-white text-sm bg-blue-950 hover:bg-black/80 border-2 border-blue-500/90 rounded-md inline-block"
+                    submit_action="{{ stimulus_action('clear_cache', 'clearAll', 'click') }}"
+        >
+            This will clear the TMDB, Torrentio, and application cache. Clearing the cache is safe, but may lead to
+            slower page loads and rate limits by Torrentio. Would you like to proceed?
+        </twig:Modal>
+    </div>
+{% endblock %}
+
 {% block body %}
 <div class="p-4 flex flex-row gap-2">
     <twig:Card title="Media Preferences" class="w-full">