fix: makes ical url publicly accessible if user has option enabled

config/packages/security.yaml

@@ -45,6 +45,7 @@ security:
     # Easy way to control access for large sections of your site
     # Note: Only the *first* access control that matches will be used
     access_control:
+        - { path: ^/monitors/ical.ics, roles: PUBLIC_ACCESS }
         - { path: ^/reset-password, roles: PUBLIC_ACCESS }
         - { path: ^/getting-started, roles: PUBLIC_ACCESS }
         - { path: ^/register, roles: PUBLIC_ACCESS }

src/Base/Framework/Command/SeedDatabaseCommand.php

@@ -135,6 +135,13 @@ class SeedDatabaseCommand extends Command
                 'enabled' => true,
                 'type' => 'download'
             ],
+            [
+                'id' => 'enable_ical_up_ep',
+                'name' => 'Enable a publicly available iCal calendar?',
+                'description' => 'Enable a publicly accessible iCal URL for your upcoming episodes.',
+                'enabled' => false,
+                'type' => 'calendar'
+            ],
         ];
     }
 }

src/Monitor/Dto/UpcomingEpisode.php

@@ -1,17 +0,0 @@
-<?php
-
-namespace App\Monitor\Dto;
-
-use Carbon\Carbon;
-
-class UpcomingEpisode
-{
-    public function __construct(
-        public string $title,
-        public string $airDate {
-            get => Carbon::parse($this->airDate)->format('m/d/Y');
-        },
-        public string $episodeTitle,
-        public int $episodeNumber,
-    ) {}
-}

src/Monitor/Framework/Controller/CalendarController.php

@@ -4,27 +4,35 @@ namespace App\Monitor\Framework\Controller;
 
 use Aimeos\Map;
 use App\Monitor\Framework\Repository\MonitorRepository;
+use App\User\Framework\Entity\User;
 use Spatie\IcalendarGenerator\Components\Calendar;
 use Spatie\IcalendarGenerator\Components\Event;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
 
 class CalendarController extends AbstractController
 {
-    #[Route('/monitors/ical.ics', name: 'app.monitors.ical')]
-    public function icalAction(MonitorRepository $monitorRepository)
+    #[IsGranted('PUBLIC_ACCESS')]
+    #[Route('/monitors/ical/{email:user}/upcoming-episodes.ics', name: 'app.monitors.ical')]
+    public function icalAction(MonitorRepository $monitorRepository, User $user)
     {
-        $calendar = new Calendar();
+        if (false === $user->hasICalEnabled()) {
+            return new Response('Calendar not found.', 404);
+        }
+
+        $calendar = Calendar::create()
+             ->name('Upcoming Episodes')
+             ->refreshInterval(10);
+
         $monitors = $monitorRepository->whereAirDateNotNull();
-        $events = Map::from($monitors)->map(function ($monitor) {
+        $calendar->event(Map::from($monitors)->map(function ($monitor) {
             return new Event($monitor->getTitle())
                 ->startsAt($monitor->getAirDate())
-                ->withoutTimezone()
-                ->fullDay()
-                ;
-        });
-        $calendar->event($events->toArray());
+                ->fullDay();
+        })->toArray());
+
         return new Response($calendar->get(), 200, [
             'Content-Type' => 'text/calendar',
             'Content-Disposition' => 'attachment; filename="upcoming-episodes.ics"',

src/Twig/Components/UpcomingEpisodes.php

@@ -3,7 +3,7 @@
 namespace App\Twig\Components;
 
 use Aimeos\Map;
-use App\Monitor\Dto\UpcomingEpisode;
+use App\Monitor\Factory\UpcomingEpisodeDto;
 use App\Monitor\Framework\Entity\Monitor;
 use App\Tmdb\Tmdb;
 use Carbon\CarbonImmutable;
@@ -70,7 +70,7 @@ final class UpcomingEpisodes extends AbstractController
         }
 
         return $episodes->map(function (array $episode) use ($monitor) {
-            return new UpcomingEpisode(
+            return new UpcomingEpisodeDto(
                 $monitor->getTitle(),
                 $episode['air_date'],
                 $episode['name'],

src/User/Action/Command/SaveUserCalendarPreferencesCommand.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\User\Action\Command;
+
+use OneToMany\RichBundle\Contract\CommandInterface;
+
+/** @implements CommandInterface<SaveUserMediaPreferencesCommand> */
+class SaveUserCalendarPreferencesCommand implements CommandInterface
+{
+    public function __construct(
+        public string $enable_ical_up_ep,
+    ) {}
+}

src/User/Action/Handler/SaveUserCalendarPreferencesHandler.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace App\User\Action\Handler;
+
+use App\User\Action\Command\SaveUserMediaPreferencesCommand;
+use App\User\Action\Result\SaveUserDownloadPreferencesResult;
+use App\User\Action\Result\SaveUserMediaPreferencesResult;
+use App\User\Framework\Entity\User;
+use App\User\Framework\Entity\UserPreference;
+use App\User\Framework\Repository\PreferencesRepository;
+use Doctrine\ORM\EntityManagerInterface;
+use OneToMany\RichBundle\Contract\CommandInterface as C;
+use OneToMany\RichBundle\Contract\HandlerInterface;
+use OneToMany\RichBundle\Contract\ResultInterface as R;
+use Symfony\Bundle\SecurityBundle\Security;
+
+/** @implements HandlerInterface<SaveUserMediaPreferencesCommand> */
+class SaveUserCalendarPreferencesHandler implements HandlerInterface
+{
+    public function __construct(
+        private readonly EntityManagerInterface $entityManager,
+        private readonly PreferencesRepository $preferenceRepository,
+        private readonly Security $token,
+    ) {}
+
+    public function handle(C $command): R
+    {
+        /** @var User $user */
+        $user = $this->token->getUser();
+
+        foreach ($command as $preference => $value) {
+            if ($user->hasUserPreference($preference)) {
+                $user->updateUserPreference($preference, $value);
+                $this->entityManager->flush();
+                continue;
+            }
+
+            $preference = $this->preferenceRepository->find($preference);
+
+            $user->addUserPreference(
+                (new UserPreference())
+                    ->setUser($user)
+                    ->setPreference($preference)
+                    ->setPreferenceValue($value)
+            );
+        }
+
+        $this->entityManager->flush();
+
+        return new SaveUserDownloadPreferencesResult($user->getDownloadPreferences());
+    }
+}

src/User/Action/Input/SaveUserCalendarPreferencesInput.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\User\Action\Input;
+
+use App\User\Action\Command\SaveUserCalendarPreferencesCommand;
+use App\User\Action\Command\SaveUserDownloadPreferencesCommand;
+use OneToMany\RichBundle\Attribute\SourceRequest;
+use OneToMany\RichBundle\Attribute\SourceSecurity;
+use OneToMany\RichBundle\Contract\CommandInterface as C;
+use OneToMany\RichBundle\Contract\InputInterface;
+
+/** @implements InputInterface<SaveUserDownloadPreferencesInput, SaveUserDownloadPreferencesCommand> */
+class SaveUserCalendarPreferencesInput implements InputInterface
+{
+    public function __construct(
+        #[SourceSecurity]
+        public mixed $userId,
+
+        #[SourceRequest('enable_ical_up_ep', nullify: true)]
+        public bool $enableIcalUpcomingEpisodes,
+    ) {}
+
+    public function toCommand(): C
+    {
+        return new SaveUserCalendarPreferencesCommand(
+            $this->enableIcalUpcomingEpisodes,
+        );
+    }
+}

src/User/Framework/Controller/Web/PreferencesController.php

@@ -6,8 +6,10 @@ namespace App\User\Framework\Controller\Web;
 
 use App\Base\Service\Broadcaster;
 use App\User\Action\Command\SaveUserMediaPreferencesCommand;
+use App\User\Action\Handler\SaveUserCalendarPreferencesHandler;
 use App\User\Action\Handler\SaveUserDownloadPreferencesHandler;
 use App\User\Action\Handler\SaveUserMediaPreferencesHandler;
+use App\User\Action\Input\SaveUserCalendarPreferencesInput;
 use App\User\Action\Input\SaveUserDownloadPreferencesInput;
 use App\User\Action\Input\SaveUserMediaPreferencesInput;
 use App\User\Database\CountryLanguages;
@@ -33,15 +35,15 @@ class PreferencesController extends AbstractController
     public function mediaPreferences(): Response
     {
         $downloadPreferences = $this->getUser()->getDownloadPreferences();
+        $calendarPreferences = $this->getUser()->getCalendarPreferences();
         $formData = (array) UserPreferencesFactory::createFromUser($this->getUser());
         $form = $this->createForm(UserMediaPreferencesForm::class, $formData);
 
-//        dd($form);
-
         return $this->render(
             'user/preferences.html.twig',
             [
                 'downloadPreferences' => $downloadPreferences,
+                'calendarPreferences' => $calendarPreferences,
                 'preferences_form' => $form,
             ]
         );
@@ -54,8 +56,8 @@ class PreferencesController extends AbstractController
     ): Response
     {
         $downloadPreferences = $this->getUser()->getDownloadPreferences();
+        $calendarPreferences = $this->getUser()->getCalendarPreferences();
         $form = $this->createForm(UserMediaPreferencesForm::class);
-
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
@@ -69,6 +71,7 @@ class PreferencesController extends AbstractController
             'user/preferences.html.twig',
             [
                 'downloadPreferences' => $downloadPreferences,
+                'calendarPreferences' => $calendarPreferences,
                 'preferences_form' => $form,
             ]
         );
@@ -81,6 +84,7 @@ class PreferencesController extends AbstractController
     ): Response
     {
         $downloadPreferences = $this->getUser()->getDownloadPreferences();
+        $calendarPreferences = $this->getUser()->getCalendarPreferences();
         $formData = (array) UserPreferencesFactory::createFromUser($this->getUser());
         $form = $this->createForm(UserMediaPreferencesForm::class, $formData);
 
@@ -95,6 +99,34 @@ class PreferencesController extends AbstractController
             'user/preferences.html.twig',
             [
                 'downloadPreferences' => $downloadPreferences,
+                'calendarPreferences' => $calendarPreferences,
+                'preferences_form' => $form,
+            ]
+        );
+    }
+
+    #[Route('/user/preferences/calendar', 'app.save.calendar-preferences', methods: ['POST'])]
+    public function saveCalendarPreferences(
+        SaveUserCalendarPreferencesInput $input,
+        SaveUserCalendarPreferencesHandler $handler,
+    ): Response
+    {
+        $calendarPreferences = $this->getUser()->getCalendarPreferences();
+        $formData = (array) UserPreferencesFactory::createFromUser($this->getUser());
+        $form = $this->createForm(UserMediaPreferencesForm::class, $formData);
+
+        $handler->handle($input->toCommand());
+
+        $this->broadcaster->alert(
+            title: 'Success',
+            message: 'Your calendar preferences have been saved.'
+        );
+
+        return $this->render(
+            'user/preferences.html.twig',
+            [
+                'downloadPreferences' => $this->getUser()->getDownloadPreferences(),
+                'calendarPreferences' => $calendarPreferences,
                 'preferences_form' => $form,
             ]
         );

src/User/Framework/Entity/User.php

@@ -327,4 +327,19 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
         }
         return [];
     }
+
+    public function getCalendarPreferences(): array
+    {
+        return Map::from($this->userPreferences)
+            ->rekey(fn(UserPreference $userPreference) => $userPreference->getPreference()->getId())
+            ->filter(fn(UserPreference $userPreference) => $userPreference->getPreference()->getType() === 'calendar')
+            ->toArray()
+            ;
+    }
+
+    public function hasICalEnabled(): bool
+    {
+        return $this->hasUserPreference('enable_ical_up_ep') &&
+            (bool) $this->getUserPreference('enable_ical_up_ep')->getPreferenceValue() === true;
+    }
 }

templates/monitor/upcoming-episodes.html.twig

@@ -39,7 +39,10 @@
             const calendarEl = document.getElementById('calendar');
             const calendar = new FullCalendar.Calendar(calendarEl, {
                 initialView: getView(),
-                events: data['episodes'],
+                events: {
+                    url: '{{ path('app.monitors.ical') }}',
+                    format: 'ics'
+                },
                 windowResize: function(arg) {
                     this.changeView(getView());
                 }

templates/user/preferences.html.twig

@@ -36,4 +36,25 @@
         </form>
     </twig:Card>
 </div>
+
+<div class="p-4 flex flex-col md:flex-row gap-2">
+    <twig:Card title="Calendar Preferences" class="w-full">
+        <p class="text-gray-50 mb-4">Manage your Upcoming Episodes calendar.</p>
+        <form id="calendar_preferences" class="flex flex-col" name="calendar_preferences" method="post" action="{{ path('app.save.calendar-preferences') }}">
+            <div class="flex flex-col gap-2">
+                <div class="flex flex-row gap-2 mb-1">
+                    <input type="hidden" name="enable_ical_up_ep" id="enable_ical_up_ep_hidden" value="0" />
+                    <input type="checkbox" name="enable_ical_up_ep" id="enable_ical_up_ep" value="1" {{ calendarPreferences['enable_ical_up_ep'].getPreferenceValue() == true ? 'checked' }} />
+                    <label class="text-gray-50" for="enable_ical_up_ep">Enable a publicly available iCal calendar?</label>
+                </div>
+                <small class="text-gray-50 mb-4">Enabling the iCal calendar will allow you to subscribe from iCal
+                    supporting clients. This endpoint will be publicly available with no authentication required.
+                    Disabling this option will disable the calendar and public endpoint for your user.
+                    This will not affect the calendar within the app.
+                </small>
+            </div>
+            <button class="px-1.5 py-1 max-w-20 rounded-md bg-green-600 text-white" type="submit">Submit</button>
+        </form>
+    </twig:Card>
+</div>
 {% endblock %}