Adding a check for the mailer service

Author: weaverryan

DependencyInjection/Compiler/CheckForMailerPass.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the FOSUserBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\UserBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Flex\Recipe;
+
+/**
+ * Checks to see if the mailer service exists.
+ *
+ * @author Ryan Weaver <ryan@knpuniversity.com>
+ */
+class CheckForMailerPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        // if the mailer isn't needed, then no error needed
+        if (!$container->has('fos_user.mailer')) {
+            return;
+        }
+
+        if ($container->findDefinition('fos_user.mailer')->hasTag('fos_user.requires_swift')) {
+            $message = 'A feature you activated in FOSUserBundle requires the "mailer" service to be available.';
+
+            if (class_exists(Recipe::class)) {
+                $message .= ' Run "composer require swiftmailer-bundle" to install SwiftMailer or configure a different mailer in "config/packages/fos_user.yaml".';
+            }
+
+            throw new \LogicException($message);
+        }
+
+    }
+}

DependencyInjection/FOSUserExtension.php

@@ -40,6 +40,8 @@ class FOSUserExtension extends Extension
         ),
     );
 
+    private $mailerNeeded = false;
+
     /**
      * {@inheritdoc}
      */
@@ -67,7 +69,7 @@ public function load(array $configs, ContainerBuilder $container)
             $definition->setFactory(array(new Reference('fos_user.doctrine_registry'), 'getManager'));
         }
 
-        foreach (array('validator', 'security', 'util', 'mailer', 'listeners', 'commands') as $basename) {
+        foreach (array('validator', 'security', 'util', 'listeners', 'commands') as $basename) {
             $loader->load(sprintf('%s.xml', $basename));
         }
 
@@ -79,7 +81,6 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('flash_notifications.xml');
         }
 
-        $container->setAlias('fos_user.mailer', $config['service']['mailer']);
         $container->setAlias('fos_user.util.email_canonicalizer', $config['service']['email_canonicalizer']);
         $container->setAlias('fos_user.util.username_canonicalizer', $config['service']['username_canonicalizer']);
         $container->setAlias('fos_user.util.token_generator', $config['service']['token_generator']);
@@ -126,6 +127,11 @@ public function load(array $configs, ContainerBuilder $container)
         if (!empty($config['group'])) {
             $this->loadGroups($config['group'], $container, $loader, $config['db_driver']);
         }
+
+        if ($this->mailerNeeded) {
+            $loader->load('mailer.xml');
+            $container->setAlias('fos_user.mailer', $config['service']['mailer']);
+        }
     }
 
     /**
@@ -163,6 +169,7 @@ private function loadRegistration(array $config, ContainerBuilder $container, Xm
         $loader->load('registration.xml');
 
         if ($config['confirmation']['enabled']) {
+            $this->mailerNeeded = true;
             $loader->load('email_confirmation.xml');
         }
 
@@ -201,6 +208,7 @@ private function loadChangePassword(array $config, ContainerBuilder $container,
      */
     private function loadResetting(array $config, ContainerBuilder $container, XmlFileLoader $loader, array $fromEmail)
     {
+        $this->mailerNeeded = true;
         $loader->load('resetting.xml');
 
         if (isset($config['email']['from_email'])) {

FOSUserBundle.php

@@ -14,6 +14,7 @@
 use Doctrine\Bundle\CouchDBBundle\DependencyInjection\Compiler\DoctrineCouchDBMappingsPass;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass;
+use FOS\UserBundle\DependencyInjection\Compiler\CheckForMailerPass;
 use FOS\UserBundle\DependencyInjection\Compiler\CheckForSessionPass;
 use FOS\UserBundle\DependencyInjection\Compiler\InjectRememberMeServicesPass;
 use FOS\UserBundle\DependencyInjection\Compiler\InjectUserCheckerPass;
@@ -37,6 +38,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new InjectUserCheckerPass());
         $container->addCompilerPass(new InjectRememberMeServicesPass());
         $container->addCompilerPass(new CheckForSessionPass());
+        $container->addCompilerPass(new CheckForMailerPass());
 
         $this->addRegisterMappingsPass($container);
     }

Resources/config/mailer.xml

@@ -24,6 +24,7 @@
                     <argument key="resetting">%fos_user.resetting.email.from_email%</argument>
                 </argument>
             </argument>
+            <tag name="fos_user.requires_swift" />
         </service>
 
         <service id="fos_user.mailer.twig_swift" class="FOS\UserBundle\Mailer\TwigSwiftMailer" public="false">
@@ -41,6 +42,7 @@
                     <argument key="resetting">%fos_user.resetting.email.from_email%</argument>
                 </argument>
             </argument>
+            <tag name="fos_user.requires_swift" />
         </service>
 
         <service id="fos_user.mailer.noop" class="FOS\UserBundle\Mailer\NoopMailer" public="false" />