chore

Author: tchapi

migrations/Version20250421163214.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Add birthday calendar.
+ */
+final class Version20250421163214 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add birthday calendars';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $engine = $this->connection->getDatabasePlatform()->getName();
+
+        if ('mysql' === $engine) {
+            $this->addSql('ALTER TABLE addressbooks ADD included_in_birthday_calendar TINYINT(1) DEFAULT 0');
+        } elseif ('postgresql' === $engine) {
+            $this->addSql('ALTER TABLE addressbooks ADD COLUMN included_in_birthday_calendar BOOLEAN DEFAULT FALSE;');
+        } elseif ('sqlite' === $engine) {
+            $this->addSql('ALTER TABLE addressbooks ADD COLUMN included_in_birthday_calendar INTEGER DEFAULT 0;');
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        if ('mysql' === $this->connection->getDatabasePlatform()->getName()) {
+            $this->addSql('ALTER TABLE addressbooks DROP included_in_birthday_calendar');
+        } else {
+            $this->addSql('ALTER TABLE addressbooks DROP COLUMN included_in_birthday_calendar');
+        }
+    }
+}

src/Command/SyncBirthdayCalendars.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Command;
+
+use App\Entity\User;
+use App\Services\BirthdayService;
+use Doctrine\Persistence\ManagerRegistry;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class SyncBirthdayCalendars extends Command
+{
+    public function __construct(
+        private ManagerRegistry $doctrine,
+        private BirthdayService $birthdayService,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setName('dav:sync-birthday-calendar')
+            ->setDescription('Synchronizes the birthday calendar')
+            ->addArgument('username',
+                InputArgument::OPTIONAL,
+                'Username for whom the birthday calendar will be synchronized');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $username = $input->getArgument('username');
+
+        if (!is_null($username)) {
+            if (!$this->doctrine->getRepository(User::class)->findOneByUsername($username)) {
+                throw new \InvalidArgumentException("User <$username> is unknown.");
+            }
+
+            $output->writeln("Start birthday calendar sync for $username");
+            $this->birthdayService->syncUser($username);
+
+            return self::SUCCESS;
+        }
+
+        $output->writeln('Start birthday calendar sync for all users ...');
+        $p = new ProgressBar($output);
+        $p->start();
+
+        $users = $this->doctrine->getRepository(User::class)->findAll();
+
+        foreach ($users as $user) {
+            $p->advance();
+            $this->birthdayService->syncUser($user->getUsername());
+        }
+
+        $p->finish();
+        $output->writeln('');
+
+        return self::SUCCESS;
+    }
+}

src/Constants.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+class Constants
+{
+    public const BIRTHDAY_CALENDAR_URI = 'birthday-calendar';
+    public const BIRTHDAY_REMINDER_OFFSET = 'PT9H'; // 9am on the day of the event
+
+    public const MAX_DATE = '2038-01-01'; // Year 2038 bug — will be fixed by https://github.com/tchapi/davis/pull/186
+}

src/Controller/Admin/AddressBookController.php

@@ -5,6 +5,7 @@
 use App\Entity\AddressBook;
 use App\Entity\Principal;
 use App\Form\AddressBookType;
+use App\Services\BirthdayService;
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -30,7 +31,7 @@ public function addressBooks(ManagerRegistry $doctrine, string $username): Respo
 
     #[Route('/{username}/new', name: 'create')]
     #[Route('/{username}/edit/{id}', name: 'edit', requirements: ['id' => "\d+"])]
-    public function addressbookCreate(ManagerRegistry $doctrine, Request $request, string $username, ?int $id, TranslatorInterface $trans): Response
+    public function addressbookCreate(ManagerRegistry $doctrine, Request $request, string $username, ?int $id, TranslatorInterface $trans, BirthdayService $birthdayService): Response
     {
         $principal = $doctrine->getRepository(Principal::class)->findOneByUri(Principal::PREFIX.$username);
 
@@ -61,6 +62,9 @@ public function addressbookCreate(ManagerRegistry $doctrine, Request $request, s
 
             $this->addFlash('success', $trans->trans('addressbooks.saved'));
 
+            // Let's sync the user birthday calendar if needed
+            $birthdayService->syncUser($username);
+
             return $this->redirectToRoute('addressbook_index', ['username' => $username]);
         }
 
@@ -73,7 +77,7 @@ public function addressbookCreate(ManagerRegistry $doctrine, Request $request, s
     }
 
     #[Route('/{username}/delete/{id}', name: 'delete', requirements: ['id' => "\d+"])]
-    public function addressbookDelete(ManagerRegistry $doctrine, string $username, string $id, TranslatorInterface $trans): Response
+    public function addressbookDelete(ManagerRegistry $doctrine, string $username, string $id, TranslatorInterface $trans, BirthdayService $birthdayService): Response
     {
         $addressbook = $doctrine->getRepository(AddressBook::class)->findOneById($id);
         if (!$addressbook) {
@@ -93,6 +97,9 @@ public function addressbookDelete(ManagerRegistry $doctrine, string $username, s
         $entityManager->flush();
         $this->addFlash('success', $trans->trans('addressbooks.deleted'));
 
+        // Let's sync the user birthday calendar if needed
+        $birthdayService->syncUser($username);
+
         return $this->redirectToRoute('addressbook_index', ['username' => $username]);
     }
 }

src/Controller/Admin/CalendarController.php

@@ -32,8 +32,14 @@ public function calendars(ManagerRegistry $doctrine, UrlGeneratorInterface $rout
         // Separate shared calendars
         $calendars = [];
         $shared = [];
+        $auto = [];
         foreach ($allCalendars as $calendar) {
-            if (!$calendar->isShared()) {
+            if ($calendar->isAutomaticallyGenerated()) {
+                $auto[] = [
+                    'entity' => $calendar,
+                    'uri' => $router->generate('dav', ['path' => 'calendars/'.$username.'/'.$calendar->getUri()], UrlGeneratorInterface::ABSOLUTE_URL),
+                ];
+            } elseif (!$calendar->isShared()) {
                 $calendars[] = [
                     'entity' => $calendar,
                     'uri' => $router->generate('dav', ['path' => 'calendars/'.$username.'/'.$calendar->getUri()], UrlGeneratorInterface::ABSOLUTE_URL),
@@ -53,6 +59,7 @@ public function calendars(ManagerRegistry $doctrine, UrlGeneratorInterface $rout
             'calendars' => $calendars,
             'subscriptions' => $subscriptions,
             'shared' => $shared,
+            'auto' => $auto,
             'principal' => $principal,
             'username' => $username,
             'allPrincipals' => $allPrincipalsExcept,

src/Entity/AddressBook.php

@@ -34,6 +34,9 @@ class AddressBook
     #[ORM\Column(type: 'string', length: 255)]
     private $synctoken;
 
+    #[ORM\Column(type: 'boolean', nullable: true, options: ['default' => false])]
+    private $includedInBirthdayCalendar;
+
     #[ORM\OneToMany(targetEntity: "App\Entity\Card", mappedBy: 'addressBook')]
     private $cards;
 
@@ -43,6 +46,7 @@ class AddressBook
     public function __construct()
     {
         $this->synctoken = 1;
+        $this->includedInBirthdayCalendar = false;
         $this->cards = new ArrayCollection();
         $this->changes = new ArrayCollection();
     }
@@ -76,6 +80,18 @@ public function setDisplayName(string $displayName): self
         return $this;
     }
 
+    public function isIncludedInBirthdayCalendar(): ?bool
+    {
+        return $this->includedInBirthdayCalendar;
+    }
+
+    public function setIncludedInBirthdayCalendar(bool $includedInBirthdayCalendar): self
+    {
+        $this->includedInBirthdayCalendar = $includedInBirthdayCalendar;
+
+        return $this;
+    }
+
     public function getUri(): ?string
     {
         return $this->uri;

src/Entity/CalendarInstance.php

@@ -2,6 +2,7 @@
 
 namespace App\Entity;
 
+use App\Constants;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -141,6 +142,11 @@ public function isPublic(): bool
         return self::ACCESS_PUBLIC === $this->access;
     }
 
+    public function isAutomaticallyGenerated(): bool
+    {
+        return in_array($this->uri, [Constants::BIRTHDAY_CALENDAR_URI]);
+    }
+
     public function getDisplayName(): ?string
     {
         return $this->displayName;

src/Form/AddressBookType.php

@@ -4,6 +4,7 @@
 
 use App\Entity\AddressBook;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
@@ -28,6 +29,12 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'form.displayName',
                 'help' => 'form.name.help.carddav',
             ])
+            ->add('includedInBirthdayCalendar', ChoiceType::class, [
+                'label' => 'form.includedInBirthdayCalendar',
+                'help' => 'form.includedInBirthdayCalendar.help',
+                'required' => true,
+                'choices' => ['yes' => true, 'no' => false],
+            ])
             ->add('description', TextareaType::class, [
                 'label' => 'form.description',
                 'required' => false,