feat: Email Event, admin and preview page

Author: pan93412

migrations/Version20241202060920.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241202060920 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Email Event';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql(<<<'SQL'
+                CREATE TABLE email_event (
+                  id UUID NOT NULL,
+                  to_user_id INT DEFAULT NULL,
+                  created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+                  to_address VARCHAR(512) NOT NULL,
+                  subject VARCHAR(4096) NOT NULL,
+                  content TEXT NOT NULL,
+                  PRIMARY KEY(id)
+                )
+            SQL);
+        $this->addSql(<<<'SQL'
+                CREATE INDEX IDX_A6E34B2829F6EE60 ON email_event (to_user_id)
+            SQL);
+        $this->addSql(<<<'SQL'
+                COMMENT ON COLUMN email_event.id IS '(DC2Type:ulid)'
+            SQL);
+        $this->addSql(<<<'SQL'
+                COMMENT ON COLUMN email_event.created_at IS '(DC2Type:datetime_immutable)'
+            SQL);
+        $this->addSql(<<<'SQL'
+                ALTER TABLE
+                  email_event
+                ADD
+                  CONSTRAINT FK_A6E34B2829F6EE60 FOREIGN KEY (to_user_id) REFERENCES "user" (id) NOT DEFERRABLE INITIALLY IMMEDIATE
+            SQL);
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql(<<<'SQL'
+                ALTER TABLE email_event DROP CONSTRAINT FK_A6E34B2829F6EE60
+            SQL);
+        $this->addSql(<<<'SQL'
+                DROP TABLE email_event
+            SQL);
+    }
+}

src/Controller/Admin/DashboardController.php

@@ -7,6 +7,7 @@
 use App\Entity\Announcement;
 use App\Entity\Comment;
 use App\Entity\CommentLikeEvent;
+use App\Entity\EmailEvent;
 use App\Entity\Feedback;
 use App\Entity\Group;
 use App\Entity\HintOpenEvent;
@@ -68,6 +69,7 @@ public function configureMenuItems(): iterable
         yield MenuItem::linkToCrud('SolutionVideoEvent', 'fa fa-video', SolutionVideoEvent::class);
         yield MenuItem::linkToCrud('HintOpenEvent', 'fa fa-lightbulb', HintOpenEvent::class);
         yield MenuItem::linkToCrud('LoginEvent', 'fa fa-right-to-bracket', LoginEvent::class);
+        yield MenuItem::linkToCrud('EmailEvent', 'fa fa-envelope', EmailEvent::class);
 
         yield MenuItem::section('Feedback');
         yield MenuItem::linkToCrud('Feedback', 'fa fa-comments', Feedback::class);

src/Controller/Admin/EmailEventCrudController.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Admin;
+
+use App\Entity\EmailEvent;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Filters;
+use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;
+use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\IdField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\TextEditorField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
+
+class EmailEventCrudController extends AbstractCrudController
+{
+    public static function getEntityFqcn(): string
+    {
+        return EmailEvent::class;
+    }
+
+    public function configureFields(string $pageName): iterable
+    {
+        return [
+            IdField::new('id')->hideOnIndex()->setDisabled(),
+            AssociationField::new('toUser'),
+            TextField::new('toAddress')->hideOnIndex(),
+            TextField::new('subject'),
+            TextEditorField::new('content'),
+            DateTimeField::new('createdAt', 'Created at')->setDisabled(),
+        ];
+    }
+
+    public function configureFilters(Filters $filters): Filters
+    {
+        return $filters
+            ->add('toUser')
+        ;
+    }
+
+    public function configureActions(Actions $actions): Actions
+    {
+        $previewAction = Action::new('preview', 'Preview', 'fa fa-eye')
+            ->linkToUrl(fn (EmailEvent $entity) => $this->generateUrl(
+                'app_email_preview',
+                ['id' => $entity->getId()]
+            ));
+
+        return $actions
+            ->disable(Action::DELETE, Action::EDIT, Action::NEW)
+            ->add(Crud::PAGE_INDEX, Action::DETAIL)
+            ->add(Crud::PAGE_INDEX, $previewAction)
+            ->add(Crud::PAGE_DETAIL, $previewAction);
+    }
+
+    public function configureCrud(Crud $crud): Crud
+    {
+        return $crud->setDefaultSort(['createdAt' => 'DESC']);
+    }
+}

src/Controller/EmailController.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Entity\EmailEvent;
+use App\Entity\User;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\CurrentUser;
+
+class EmailController extends AbstractController
+{
+    #[Route('/email/{id}', name: 'app_email_preview')]
+    public function details(#[CurrentUser] User $user, EmailEvent $emailEvent): Response
+    {
+        // if this email is not owned by the current user and the user is not an admin,
+        // we deny the access.
+        if ($emailEvent->getToUser() !== $user && !$this->isGranted('ROLE_ADMIN')) {
+            throw $this->createAccessDeniedException('You are not authorized to access this email.');
+        }
+
+        return $this->render('email/preview.html.twig', [
+            'email' => $emailEvent,
+        ]);
+    }
+}

src/Entity/EmailEvent.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity;
+
+use App\Repository\EmailEventRepository;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints\Email;
+use Symfony\Component\Validator\Constraints\NotBlank;
+
+#[ORM\Entity(repositoryClass: EmailEventRepository::class)]
+class EmailEvent extends BaseEvent
+{
+    #[ORM\ManyToOne(inversedBy: 'emailEvents')]
+    private ?User $toUser = null;
+
+    #[ORM\Column(type: Types::STRING, length: 512)]
+    #[Email]
+    private string $toAddress = '';
+
+    #[ORM\Column(type: Types::STRING, length: 4096)]
+    #[NotBlank]
+    private string $subject = '';
+
+    #[ORM\Column(type: Types::TEXT)]
+    #[NotBlank]
+    private string $content = '';
+
+    public function getToUser(): ?User
+    {
+        return $this->toUser;
+    }
+
+    public function setToUser(?User $toUser): static
+    {
+        $this->toUser = $toUser;
+
+        return $this;
+    }
+
+    public function getToAddress(): ?string
+    {
+        return $this->toAddress;
+    }
+
+    public function setToAddress(string $toAddress): static
+    {
+        $this->toAddress = $toAddress;
+
+        return $this;
+    }
+
+    public function getSubject(): ?string
+    {
+        return $this->subject;
+    }
+
+    public function setSubject(string $subject): static
+    {
+        $this->subject = $subject;
+
+        return $this;
+    }
+
+    public function getContent(): ?string
+    {
+        return $this->content;
+    }
+
+    public function setContent(string $content): static
+    {
+        $this->content = $content;
+
+        return $this;
+    }
+}

src/Entity/User.php

@@ -90,6 +90,12 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     #[ORM\OneToMany(targetEntity: Feedback::class, mappedBy: 'sender')]
     private Collection $feedback;
 
+    /**
+     * @var Collection<int, EmailEvent>
+     */
+    #[ORM\OneToMany(targetEntity: EmailEvent::class, mappedBy: 'toUser')]
+    private Collection $emailEvents;
+
     public function __construct()
     {
         $this->solutionEvents = new ArrayCollection();
@@ -99,6 +105,7 @@ public function __construct()
         $this->hintOpenEvents = new ArrayCollection();
         $this->loginEvents = new ArrayCollection();
         $this->feedback = new ArrayCollection();
+        $this->emailEvents = new ArrayCollection();
     }
 
     public function getId(): ?int
@@ -419,4 +426,34 @@ public function removeFeedback(Feedback $feedback): static
 
         return $this;
     }
+
+    /**
+     * @return Collection<int, EmailEvent>
+     */
+    public function getEmailEvents(): Collection
+    {
+        return $this->emailEvents;
+    }
+
+    public function addEmailEvent(EmailEvent $emailEvent): static
+    {
+        if (!$this->emailEvents->contains($emailEvent)) {
+            $this->emailEvents->add($emailEvent);
+            $emailEvent->setToUser($this);
+        }
+
+        return $this;
+    }
+
+    public function removeEmailEvent(EmailEvent $emailEvent): static
+    {
+        if ($this->emailEvents->removeElement($emailEvent)) {
+            // set the owning side to null (unless already changed)
+            if ($emailEvent->getToUser() === $this) {
+                $emailEvent->setToUser(null);
+            }
+        }
+
+        return $this;
+    }
 }

src/Repository/EmailEventRepository.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Repository;
+
+use App\Entity\EmailEvent;
+use App\Entity\User;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+
+/**
+ * @extends ServiceEntityRepository<EmailEvent>
+ */
+class EmailEventRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, EmailEvent::class);
+    }
+
+    /**
+     * Find the email target to the user.
+     *
+     * @param User $user The user to find the email target
+     *
+     * @return list<EmailEvent>
+     */
+    public function findBySendTarget(User $user): array
+    {
+        return $this->findBy([
+            'toUser' => $user,
+        ], orderBy: [
+            'createdAt' => 'DESC',
+        ]);
+    }
+}

templates/email/preview.html.twig

@@ -0,0 +1,38 @@
+{% extends 'app.html.twig' %}
+
+{% block nav %}<twig:Navbar active="" hasUserInfo="false"/>{% endblock %}
+{% block title %}信件預覽{% endblock %}
+
+{% block app %}
+    <main class="app-email-preview">
+        <div class="row">
+            <article class="app-email-preview__rendered col-9">
+                <h2 class="app-email-preview__title mb-4">
+                    <small><i class="bi bi-envelope-fill"></i></small>
+                    {{ email.subject }}
+                </h2>
+
+                <hr>
+
+                <section class="app-email-preview__content">
+                    {{ email.content|raw }}
+                </section>
+            </article>
+
+            <aside class="app-email-preview__meta col-3">
+                <ul class="app-email-preview__meta__list list-group">
+                    <li class="list-group-item">
+                        <i class="bi bi-envelope-arrow-up-fill"></i>
+                        <span>收件人：</span>
+                        <span>{{ email.toAddress }}</span>
+                    </li>
+                    <li class="list-group-item">
+                        <i class="bi bi-calendar-fill"></i>
+                        <span>發件日期：</span>
+                        <span>{{ email.createdAt|date('Y-m-d H:i:s') }}</span>
+                    </li>
+                </ul>
+            </aside>
+        </div>
+    </main>
+{% endblock %}

translations/messages.zh_TW.yaml

@@ -59,6 +59,11 @@ System Management: 系統管理
 Announcement: 公告
 URL: 網址
 Published: 發布
+Preview: 預覽
+To User: 收件使用者
+To Address: 收件信箱
+Subject: 主旨
+EmailEvent: 信件事件
 
 result_presenter.tabs.result: 執行結果
 result_presenter.tabs.answer: 正確答案