Admin: Migrate email tester to Symfony form and controller structure

Author: AngelFQC

public/main/admin/email_tester.php

@@ -13,9 +13,11 @@
 use Chamilo\CoreBundle\Entity\ResourceLink;
 use Chamilo\CoreBundle\Entity\ResourceNode;
 use Chamilo\CoreBundle\Entity\ResourceType;
+use Chamilo\CoreBundle\Form\TestEmailType;
 use Chamilo\CoreBundle\Framework\Container;
 use Chamilo\CoreBundle\Helpers\AccessUrlHelper;
 use Chamilo\CoreBundle\Helpers\CidReqHelper;
+use Chamilo\CoreBundle\Helpers\MailHelper;
 use Chamilo\CoreBundle\Helpers\QueryCacheHelper;
 use Chamilo\CoreBundle\Helpers\TempUploadHelper;
 use Chamilo\CoreBundle\Helpers\UserHelper;
@@ -27,13 +29,16 @@
 use Chamilo\CourseBundle\Entity\CDocument;
 use Doctrine\DBAL\Connection;
 use Doctrine\ORM\EntityManagerInterface;
+use MessageManager;
 use RuntimeException;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use Throwable;
+use UserManager;
 
 #[Route('/admin')]
 class AdminController extends BaseController
@@ -727,6 +732,50 @@ public function runCleanupTempUploads(
  return $this->redirectToRoute('admin_cleanup_temp_uploads', [], Response::HTTP_SEE_OTHER);
  }
 
+ #[IsGranted('ROLE_ADMIN')]
+ #[Route('/email_tester', name: 'admin_email_tester')]
+ public function testEmail(
+ Request $request,
+ MailHelper $mailHelper,
+ TranslatorInterface $translator,
+ SettingsManager $settingsManager,
+ UserHelper $userHelper,
+ ): Response {
+ $errorsInfo = MessageManager::failedSentMailErrors();
+
+ $form = $this->createForm(TestEmailType::class);
+ $form->handleRequest($request);
+
+ if ($form->isSubmitted() && $form->isValid()) {
+ $data = $form->getData();
+
+ $mailHelper->send(
+ $translator->trans('User testing of e-mail configuration'),
+ $data['destination'],
+ $data['subject'],
+ $data['content'],
+ UserManager::formatUserFullName($userHelper->getCurrent()),
+ $settingsManager->getSetting('mail.mailer_from_email')
+ );
+
+ $this->addFlash(
+ 'success',
+ $translator->trans('E-mail sent. This procedure works in all aspects similarly to the normal e-mail sending of Chamilo, but allows for more flexibility in terms of destination e-mail and message body.')
+ );
+
+ return $this->redirectToRoute('admin_email_tester');
+ }
+
+ return $this->render(
+ '@ChamiloCore/Admin/email_tester.html.twig',
+ [
+ 'mailer_dsn' => $settingsManager->getSetting('mail.mailer_dsn'),
+ 'form' => $form,
+ 'errors' => $errorsInfo,
+ ]
+ );
+ }
+
  /**
  * Create a visible CDocument in a course from an existing ResourceFile.
  */

public/main/template/default/admin/email_tester.html.twig

@@ -613,7 +613,7 @@ private function getItemsSettings(): array
  if (is_dir(api_get_path(SYS_TEST_PATH))) {
  $items[] = [
  'class' => 'item-email-tester',
- 'url' => '/main/admin/email_tester.php',
+ 'url' => '/admin/email_tester',
  'label' => $this->translator->trans('E-mail tester'),
  ];
  }

src/CoreBundle/Controller/Admin/AdminController.php

@@ -0,0 +1,58 @@
+<?php
+
+/* For licensing terms, see /license.txt */
+
+namespace Chamilo\CoreBundle\Form;
+
+use Chamilo\CoreBundle\Settings\SettingsManager;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\EmailType;
+use Symfony\Component\Form\Extension\Core\Type\TextareaType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class TestEmailType extends AbstractType
+{
+ public function __construct(
+ private readonly TranslatorInterface $translator,
+ ) {}
+
+ public function buildForm(FormBuilderInterface $builder, array $options): void
+ {
+ $builder
+ ->add(
+ 'destination',
+ EmailType::class,
+ [
+ 'label' => $this->translator->trans('Destination'),
+ ]
+ )
+ ->add(
+ 'subject',
+ TextType::class,
+ [
+ 'label' => $this->translator->trans('Subject'),
+ ]
+ )
+ ->add(
+ 'content',
+ TextareaType::class,
+ [
+ 'label' => $this->translator->trans('Message'),
+ 'attr' => [
+ 'rows' => 20,
+ ],
+ ]
+ )
+ ;
+ }
+
+ public function configureOptions(OptionsResolver $resolver): void
+ {
+ $resolver->setDefaults([
+ // Configure your form options here
+ ]);
+ }
+}

src/CoreBundle/Controller/Admin/IndexBlocksController.php

@@ -0,0 +1,34 @@
+{% extends "@ChamiloCore/Layout/layout_one_col.html.twig" %}
+
+{% block content %}
+ <div class="row">
+ <div class="col-md-6">
+ <p>
+ <strong>{{ 'Mailer DSN'|trans }}</strong><br>
+ <code>{{ mailer_dsn }}</code>
+ </p>
+ <br>
+
+ {{ form_start(form) }}
+ {{ form_row(form.destination) }}
+ {{ form_row(form.subject) }}
+ {{ form_row(form.content) }}
+
+ <button class="btn btn--primary">{{ 'Send test email'|trans }}</button>
+ {{ form_end(form) }}
+ </div>
+ <div class="col-md-6">
+ {% if errors is not empty %}
+ <h4 class="page-header">{{ 'Errors'|get_lang }}</h4>
+ <ul>
+ {% for error in errors %}
+ <li>
+ {{ 'Email: %s. %s ago'|format(error.mail, error.time) }}
+ <pre>{{ error.reason|replace({'\n': '<br>'}) }}</pre>
+ </li>
+ {% endfor %}
+ </ul>
+ {% endif %}
+ </div>
+ </div>
+{% endblock %}