[Feature] Admin Signup Notifications (#1242)

config/packages/doctrine.yaml

@@ -7,6 +7,7 @@ doctrine:
         mapping_types:
             user_type: string
             citext: citext
+            enumApplicationStatus: string
 
         # IMPORTANT: You MUST configure your server version,
         # either here or in the DATABASE_URL env var (see .env file)

migrations/Version20241124155724.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20241124155724 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add new_user_id to notification table and notify_on_user_signup to "user" table for the `NewSignupNotification`';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE notification ADD new_user_id INT DEFAULT NULL');
+        $this->addSql('ALTER TABLE notification ADD CONSTRAINT FK_BF5476CA7C2D807B FOREIGN KEY (new_user_id) REFERENCES "user" (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('CREATE INDEX IDX_BF5476CA7C2D807B ON notification (new_user_id)');
+        $this->addSql('ALTER TABLE "user" ADD notify_on_user_signup BOOLEAN DEFAULT TRUE');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE notification DROP CONSTRAINT FK_BF5476CA7C2D807B');
+        $this->addSql('DROP INDEX IDX_BF5476CA7C2D807B');
+        $this->addSql('ALTER TABLE notification DROP new_user_id');
+        $this->addSql('ALTER TABLE "user" DROP notify_on_user_signup');
+    }
+}

src/DTO/UserSettingsDto.php

@@ -29,7 +29,8 @@ public function __construct(
         #[OA\Property(type: 'array', items: new OA\Items(type: 'string'))]
         public ?array $preferredLanguages = null,
         public ?string $customCss = null,
-        public ?bool $ignoreMagazinesCustomCss = null
+        public ?bool $ignoreMagazinesCustomCss = null,
+        public ?bool $notifyOnUserSignup = null,
     ) {
     }
 
@@ -52,6 +53,7 @@ public function jsonSerialize(): mixed
             'preferredLanguages' => $this->preferredLanguages,
             'customCss' => $this->customCss,
             'ignoreMagazinesCustomCss' => $this->ignoreMagazinesCustomCss,
+            'notifyOnUserSignup' => $this->notifyOnUserSignup,
         ];
     }
 

src/Entity/NewSignupNotification.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity;
+
+use App\Payloads\PushNotification;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\JoinColumn;
+use Doctrine\ORM\Mapping\ManyToOne;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+#[Entity]
+class NewSignupNotification extends Notification
+{
+    #[ManyToOne(targetEntity: User::class, cascade: ['remove'])]
+    #[JoinColumn(nullable: true, onDelete: 'CASCADE')]
+    public ?User $newUser;
+
+    public function getType(): string
+    {
+        return 'new_signup';
+    }
+
+    public function getSubject(): ?User
+    {
+        return $this->newUser;
+    }
+
+    public function getMessage(TranslatorInterface $trans, string $locale, UrlGeneratorInterface $urlGenerator): PushNotification
+    {
+        $message = str_replace('%u%', $this->newUser->username, $trans->trans('notification_body_new_signup', locale: $locale));
+        $title = $trans->trans('notification_title_new_signup', locale: $locale);
+        $url = $urlGenerator->generate('user_overview', ['username' => $this->newUser->username]);
+        $slash = $this->newUser->avatar && !str_starts_with('/', $this->newUser->avatar->filePath) ? '/' : '';
+        $avatarUrl = $this->newUser->avatar ? '/media/cache/resolve/avatar_thumb'.$slash.$this->newUser->avatar->filePath : null;
+
+        return new PushNotification($message, $title, actionUrl: $url, avatarUrl: $avatarUrl);
+    }
+}

src/Entity/Notification.php

@@ -45,6 +45,7 @@
     'report_created' => 'ReportCreatedNotification',
     'report_approved' => 'ReportApprovedNotification',
     'report_rejected' => 'ReportRejectedNotification',
+    'new_signup' => 'NewSignupNotification',
 ])]
 abstract class Notification
 {

src/Entity/User.php

@@ -152,6 +152,8 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, Visibil
     public bool $notifyOnNewPostReply = true;
     #[Column(type: 'boolean', nullable: false)]
     public bool $notifyOnNewPostCommentReply = true;
+    #[Column(type: 'boolean', nullable: false, options: ['default' => true])]
+    public bool $notifyOnUserSignup = true;
     #[Column(type: 'boolean', nullable: false, options: ['default' => false])]
     public bool $addMentionsEntries = false;
     #[Column(type: 'boolean', nullable: false, options: ['default' => true])]

src/Form/UserSettingsType.php

@@ -7,6 +7,7 @@
 use App\DTO\UserSettingsDto;
 use App\Entity\User;
 use App\Form\DataTransformer\FeaturedMagazinesBarTransformer;
+use Symfony\Bundle\SecurityBundle\Security;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
@@ -19,8 +20,10 @@
 
 class UserSettingsType extends AbstractType
 {
-    public function __construct(private readonly TranslatorInterface $translator)
-    {
+    public function __construct(
+        private readonly TranslatorInterface $translator,
+        private readonly Security $security,
+    ) {
     }
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
@@ -109,6 +112,12 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             )
             ->add('submit', SubmitType::class);
 
+        /** @var User $user */
+        $user = $this->security->getUser();
+        if ($user->isAdmin()) {
+            $builder->add('notifyOnUserSignup', CheckboxType::class, ['required' => false]);
+        }
+
         $builder->get('featuredMagazines')->addModelTransformer(
             new FeaturedMagazinesBarTransformer()
         );

src/Message/Notification/SentNewSignupNotificationMessage.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Message\Notification;
+
+use App\Message\Contracts\AsyncMessageInterface;
+
+class SentNewSignupNotificationMessage implements AsyncMessageInterface
+{
+    public function __construct(public int $userId)
+    {
+    }
+}

src/MessageHandler/Notification/SentNewSignupNotificationHandler.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\MessageHandler\Notification;
+
+use App\Message\Contracts\MessageInterface;
+use App\Message\Notification\SentNewSignupNotificationMessage;
+use App\MessageHandler\MbinMessageHandler;
+use App\Repository\UserRepository;
+use App\Service\Notification\SignupNotificationManager;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
+
+#[AsMessageHandler]
+class SentNewSignupNotificationHandler extends MbinMessageHandler
+{
+    public function __construct(
+        readonly EntityManagerInterface $entityManager,
+        private readonly UserRepository $userRepository,
+        private readonly SignupNotificationManager $signupNotificationManager,
+    ) {
+        parent::__construct($entityManager);
+    }
+
+    public function __invoke(SentNewSignupNotificationMessage $message)
+    {
+        $this->workWrapper($message);
+    }
+
+    public function doWork(MessageInterface $message): void
+    {
+        if (!($message instanceof SentNewSignupNotificationMessage)) {
+            throw new \LogicException();
+        }
+        $user = $this->userRepository->findOneBy(['id' => $message->userId]);
+        if (!$user) {
+            throw new UnrecoverableMessageHandlingException('user not found');
+        }
+        $this->signupNotificationManager->sendNewSignupNotification($user);
+    }
+}

src/Service/Notification/SignupNotificationManager.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service\Notification;
+
+use App\Entity\NewSignupNotification;
+use App\Entity\User;
+use App\Event\NotificationCreatedEvent;
+use App\Repository\UserRepository;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+readonly class SignupNotificationManager
+{
+    public function __construct(
+        private EntityManagerInterface $entityManager,
+        private UserRepository $userRepository,
+        private EventDispatcherInterface $dispatcher,
+    ) {
+    }
+
+    public function sendNewSignupNotification(User $newUser): void
+    {
+        $receivers = $this->userRepository->findAllAdmins();
+        foreach ($receivers as $receiver) {
+            if (!$receiver->notifyOnUserSignup) {
+                continue;
+            }
+            $notification = new NewSignupNotification($receiver);
+            $notification->newUser = $newUser;
+            $this->entityManager->persist($notification);
+            $this->dispatcher->dispatch(new NotificationCreatedEvent($notification));
+        }
+        $this->entityManager->flush();
+    }
+}

src/Service/UserManager.php

@@ -19,6 +19,7 @@
 use App\Message\ClearDeletedUserMessage;
 use App\Message\DeleteImageMessage;
 use App\Message\DeleteUserMessage;
+use App\Message\Notification\SentNewSignupNotificationMessage;
 use App\Message\UserCreatedMessage;
 use App\Message\UserUpdatedMessage;
 use App\MessageHandler\ClearDeletedUserHandler;
@@ -173,10 +174,17 @@ public function create(UserDto $dto, bool $verifyUserEmail = true, $rateLimit =
         $this->entityManager->persist($user);
         $this->entityManager->flush();
 
+        if (!$dto->apId) {
+            try {
+                $this->bus->dispatch(new SentNewSignupNotificationMessage($user->getId()));
+            } catch (\Throwable $e) {
+            }
+        }
+
         if ($verifyUserEmail) {
             try {
                 $this->bus->dispatch(new UserCreatedMessage($user->getId()));
-            } catch (\Exception $e) {
+            } catch (\Throwable $e) {
             }
         }
 

src/Service/UserSettingsManager.php

@@ -32,7 +32,8 @@ public function createDto(User $user): UserSettingsDto
             $user->featuredMagazines,
             $user->preferredLanguages,
             $user->customCss,
-            $user->ignoreMagazinesCustomCss
+            $user->ignoreMagazinesCustomCss,
+            $user->notifyOnUserSignup,
         );
     }
 
@@ -55,6 +56,10 @@ public function update(User $user, UserSettingsDto $dto): void
         $user->customCss = $dto->customCss;
         $user->ignoreMagazinesCustomCss = $dto->ignoreMagazinesCustomCss;
 
+        if (null !== $dto->notifyOnUserSignup) {
+            $user->notifyOnUserSignup = $dto->notifyOnUserSignup;
+        }
+
         $this->entityManager->flush();
     }
 }

templates/notifications/_blocks.html.twig

@@ -156,3 +156,8 @@
         <a href="{{ path('magazine_panel_reports', { 'name': notification.report.magazine.name, 'status': 'approved' }) }}#report-id-{{ notification.report.id }}">{{ 'open_report'|trans }}</a>
     {% endif %}
 {% endblock report_approved_notification %}
+
+{% block new_signup %}
+    {{ 'notification_title_new_signup'|trans }}<br />
+    {{ component('user_inline', { user: notification.newUser } ) }}
+{% endblock %}

templates/user/settings/general.html.twig

@@ -41,6 +41,9 @@
             {{ form_row(form.notifyOnNewPostCommentReply, {label: 'notify_on_new_post_comment_reply', row_attr: {class: 'checkbox'}}) }}
             {{ form_row(form.notifyOnNewEntry, {label: 'notify_on_new_entry', row_attr: {class: 'checkbox'}}) }}
             {{ form_row(form.notifyOnNewPost, {label: 'notify_on_new_posts', row_attr: {class: 'checkbox'}}) }}
+            {% if app.user.admin %}
+                {{ form_row(form.notifyOnUserSignup, {label: 'notify_on_user_signup', row_attr: {class: 'checkbox'}}) }}
+            {% endif %}
             <div class="row actions">
                 {{ form_row(form.submit, {label: 'save', attr: {class: 'btn btn__primary'}}) }}
             </div>

translations/messages.en.yaml

@@ -214,6 +214,7 @@ notify_on_new_post_comment_reply: Replies to my comments on any posts
 notify_on_new_entry: New threads (links or articles) in any magazine to which I'm
   subscribed
 notify_on_new_posts: New posts in any magazine to which I'm subscribed
+notify_on_user_signup: New signups
 save: Save
 about: About
 old_email: Current email
@@ -875,6 +876,9 @@ notification_title_message: New direct message
 notification_title_new_post: New Post
 notification_title_removed_post: A post was removed
 notification_title_edited_post: A post was edited
+notification_title_new_signup: A new user registered
+notification_body_new_signup: The user %u% registered.
+notification_body2_new_signup_approval: You need to approve the request before they can log in
 show_related_magazines: Show random magazines
 show_related_entries: Show random threads
 show_related_posts: Show random posts