Merge pull request #6 from Kick-In/symfony-mailer-v2

Add support for Symfony Mailer

Author: bobvandevijver

Backtrace/BacktraceLogFile.php

@@ -2,6 +2,7 @@
 
 namespace Kickin\ExceptionHandlerBundle\Backtrace;
 
+use Exception;
 use Symfony\Component\Filesystem\Exception\IOException;
 use Symfony\Component\Filesystem\Filesystem;
 
@@ -39,6 +40,8 @@ class BacktraceLogFile
    * Constructor -> generate an unique name
    *
    * @param string $folder
+   *
+   * @throws Exception
    */
   public function __construct($folder)
   {
@@ -58,6 +61,8 @@ public function getName()
 
   /**
    * Generates a new, unique name
+   *
+   * @throws Exception
    */
   public function generateNewName()
   {

Configuration/ConfigurationInterface.php

@@ -2,52 +2,52 @@
 
 namespace Kickin\ExceptionHandlerBundle\Configuration;
 
-use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
+/**
+ * Interface ConfigurationInterface
+ *
+ * @internal
+ */
 interface ConfigurationInterface
 {
   /**
    * Indicate whether the current environment is a production environment
    *
    * @return bool
    */
-  public function isProductionEnvironment();
+  public function isProductionEnvironment(): bool;
 
   /**
    * Return the backtrace file root folder path
    *
    * @return string
    */
-  public function getBacktraceFolder();
+  public function getBacktraceFolder(): string;
 
   /**
-   * SwiftMailer representation of the error sender
+   * Retrieve user information from the token, and return it in a single string
+   *
+   * @param TokenInterface|null $token
    *
-   * @return string|array
+   * @return string
    */
-  public function getSender();
+  public function getUserInformation(TokenInterface $token = NULL): string;
 
   /**
-   * SwiftMailer representation of the error receiver
+   * Retrieve the system version
    *
-   * @return mixed
+   * @return string
    */
-  public function getReceiver();
+  public function getSystemVersion(): string;
 
   /**
-   * Retrieve user information from the token, and return it in a single string
-   *
-   * @param TokenInterface|null $token
-   *
-   * @return string
+   * Representation of the error sender
    */
-  public function getUserInformation(TokenInterface $token = null);
+  public function getSender();
 
   /**
-   * Retrieve the system version
-   *
-   * @return mixed
+   * Representation of the error receiver
    */
-  public function getSystemVersion();
+  public function getReceiver();
 }

Configuration/SwiftMailerConfigurationInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Kickin\ExceptionHandlerBundle\Configuration;
+
+/**
+ * Interface SwiftMailerConfigurationInterface
+ */
+interface SwiftMailerConfigurationInterface extends ConfigurationInterface
+{
+  /**
+   * @inheritDoc
+   *
+   * @return string|array
+   */
+  public function getSender();
+
+  /**
+   * @inheritDoc
+   *
+   * @return mixed
+   */
+  public function getReceiver();
+}

Configuration/SymfonyMailerConfigurationInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Kickin\ExceptionHandlerBundle\Configuration;
+
+use Symfony\Component\Mime\Address;
+
+/**
+ * Interface SymfonyMailerConfigurationInterface
+ */
+interface SymfonyMailerConfigurationInterface extends ConfigurationInterface
+{
+  /**
+   * @inheritDoc
+   *
+   * @return Address|string
+   */
+  public function getSender();
+
+  /**
+   * @inheritDoc
+   *
+   * @return Address|string
+   */
+  public function getReceiver();
+}

DependencyInjection/Configuration.php

@@ -17,11 +17,27 @@ class Configuration implements ConfigurationInterface
    */
   public function getConfigTreeBuilder()
   {
-    $treeBuilder = new TreeBuilder();
-    $treeBuilder->root('kickin_exception_handler');
+    $treeBuilder = new TreeBuilder('kickin_exception_handler');
+
+    if (method_exists($treeBuilder, 'getRootNode')) {
+      $rootNode = $treeBuilder->getRootNode();
+    } else {
+      // for symfony/config 4.1 and older
+      $rootNode = $treeBuilder->root('kickin_exception_handler');
+    }
+
     // Here you should define the parameters that are allowed to
     // configure your bundle. See the documentation linked above for
     // more information on that topic.
+
+    $rootNode
+        ->children()
+          ->enumNode('mail_backend')
+            ->values(['swift', 'swift_mailer', 'symfony', 'symfony_mailer'])
+            ->defaultValue('swift')
+          ->end() // mailer_style
+        ->end(); // root children
+
     return $treeBuilder;
   }
 }

DependencyInjection/KickinExceptionHandlerExtension.php

@@ -2,10 +2,14 @@
 
 namespace Kickin\ExceptionHandlerBundle\DependencyInjection;
 
+use Exception;
+use Kickin\ExceptionHandlerBundle\Handler\SwiftMailerExceptionHandler;
+use Kickin\ExceptionHandlerBundle\Handler\SymfonyMailerExceptionHandler;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\DependencyInjection\Loader;
 
 /**
  * This is the class that loads and manages your bundle configuration
@@ -16,12 +20,69 @@ class KickinExceptionHandlerExtension extends Extension
 {
   /**
    * {@inheritDoc}
+   * @throws Exception
    */
   public function load(array $configs, ContainerBuilder $container)
   {
+    // Parse configuration
     $configuration = new Configuration();
-    $this->processConfiguration($configuration, $configs);
-    $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-    $loader->load('services.yml');
+    $config        = $this->processConfiguration($configuration, $configs);
+
+    // Configure the correct service
+    if (in_array($config['mail_backend'], ['swift', 'swift_mailer'])) {
+      $this->configureSwiftmailer($container);
+    } else {
+      $this->configureSymfonyMailer($container);
+    }
+  }
+
+  /**
+   * Configures the Swift Mailer handler
+   *
+   * @param ContainerBuilder $container
+   */
+  private function configureSwiftMailer(ContainerBuilder $container)
+  {
+    if (!class_exists('Swift_Mailer')) {
+      throw new InvalidConfigurationException('You selected SwiftMailer as mail backend, but it is not installed. Try running `composer req symfony/swiftmailer-bundle` or switch to the Symfony mailer in the configuration.');
+    }
+
+    $this->configureMailer($container, SwiftMailerExceptionHandler::class)
+        // Explicitly bind the correct mailer, as we do not want the default mailer
+        ->setArgument('$mailer', new Reference('swiftmailer.mailer.exception_mailer'))
+        // Explicitly bind the correct real transport, as we do not want the default mailer transport
+        // Next to that, we also need the real transport, and not the spool
+        ->setArgument('$transport', new Reference('swiftmailer.mailer.exception_mailer.transport.real'));
+  }
+
+  /**
+   * Configures the Symfony Mailer handler
+   *
+   * @param ContainerBuilder $container
+   */
+  private function configureSymfonyMailer(ContainerBuilder $container)
+  {
+    if (!class_exists('Symfony\Component\Mailer\Mailer')) {
+      throw new InvalidConfigurationException('You selected the Symfony mailer as mail backend, but it is not installed. Try running `composer req symfony/mailer` or switch to SwiftMailer in the configuration.');
+    }
+
+    $this->configureMailer($container, SymfonyMailerExceptionHandler::class);
+  }
+
+  /**
+   * Configure the shared defaults for both handlers
+   *
+   * @param ContainerBuilder $container
+   * @param string           $handlerClass
+   *
+   * @return Definition
+   */
+  private function configureMailer(ContainerBuilder $container, string $handlerClass): Definition
+  {
+    return $container
+        ->autowire($handlerClass)
+        ->setPublic(false)
+        ->setLazy(true)
+        ->setAutoconfigured(true);
   }
-}
+}

Exceptions/FileAlreadyExistsException.php

@@ -2,7 +2,9 @@
 
 namespace Kickin\ExceptionHandlerBundle\Exceptions;
 
-class FileAlreadyExistsException extends \Exception
+use Exception;
+
+class FileAlreadyExistsException extends Exception
 {
 
-}
+}

Exceptions/UploadFailedException.php

@@ -2,7 +2,9 @@
 
 namespace Kickin\ExceptionHandlerBundle\Exceptions;
 
-class UploadFailedException extends \Exception
+use Exception;
+
+class UploadFailedException extends Exception
 {
 
-}
+}