Merge pull request #1544 from wallabag/2fa-email

v2 – Add custom email for 2FA

7 files changed, 242 insertions, 0 deletions

diff --git a/src/Wallabag/UserBundle/DependencyInjection/Configuration.php b/src/Wallabag/UserBundle/DependencyInjection/Configuration.php
new file mode 100644
index 00000000..4223f8db
--- /dev/null
+++ b/src/Wallabag/UserBundle/DependencyInjection/Configuration.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Wallabag\UserBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('wallabag_user');
+
+        return $treeBuilder;
+    }
+}
diff --git a/src/Wallabag/UserBundle/DependencyInjection/WallabagUserExtension.php b/src/Wallabag/UserBundle/DependencyInjection/WallabagUserExtension.php
new file mode 100644
index 00000000..c12a8937
--- /dev/null
+++ b/src/Wallabag/UserBundle/DependencyInjection/WallabagUserExtension.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Wallabag\UserBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader;
+
+class WallabagUserExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('services.yml');
+    }
+
+    public function getAlias()
+    {
+        return 'wallabag_user';
+    }
+}
diff --git a/src/Wallabag/UserBundle/Mailer/AuthCodeMailer.php b/src/Wallabag/UserBundle/Mailer/AuthCodeMailer.php
new file mode 100644
index 00000000..f1960070
--- /dev/null
+++ b/src/Wallabag/UserBundle/Mailer/AuthCodeMailer.php
@@ -0,0 +1,93 @@
+<?php
+
+namespace Wallabag\UserBundle\Mailer;
+
+use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface;
+use Scheb\TwoFactorBundle\Mailer\AuthCodeMailerInterface;
+use Symfony\Component\Translation\DataCollectorTranslator;
+
+/**
+ * Custom mailer for TwoFactorBundle email.
+ * It adds a custom template to the email so user won't get a lonely authentication code but a complete email.
+ */
+class AuthCodeMailer implements AuthCodeMailerInterface
+{
+    /**
+     * SwiftMailer.
+     *
+     * @var \Swift_Mailer
+     */
+    private $mailer;
+
+    /**
+     * Translator for email content.
+     *
+     * @var DataCollectorTranslator
+     */
+    private $translator;
+
+    /**
+     * Sender email address.
+     *
+     * @var string
+     */
+    private $senderEmail;
+
+    /**
+     * Sender name.
+     *
+     * @var string
+     */
+    private $senderName;
+
+    /**
+     * Support URL to report any bugs.
+     *
+     * @var string
+     */
+    private $supportUrl;
+
+    /**
+     * Initialize the auth code mailer with the SwiftMailer object.
+     *
+     * @param \Swift_Mailer           $mailer
+     * @param DataCollectorTranslator $translator
+     * @param string                  $senderEmail
+     * @param string                  $senderName
+     * @param string                  $supportUrl
+     */
+    public function __construct(\Swift_Mailer $mailer, DataCollectorTranslator $translator, $senderEmail, $senderName, $supportUrl)
+    {
+        $this->mailer = $mailer;
+        $this->translator = $translator;
+        $this->senderEmail = $senderEmail;
+        $this->senderName = $senderName;
+        $this->supportUrl = $supportUrl;
+    }
+
+    /**
+     * Send the auth code to the user via email.
+     *
+     * @param TwoFactorInterface $user
+     */
+    public function sendAuthCode(TwoFactorInterface $user)
+    {
+        $message = new \Swift_Message();
+        $message
+            ->setTo($user->getEmail())
+            ->setFrom($this->senderEmail, $this->senderName)
+            ->setSubject($this->translator->trans('auth_code.mailer.subject', array(), 'wallabag_user'))
+            ->setBody($this->translator->trans(
+                'auth_code.mailer.body',
+                [
+                    '%user%' => $user->getName(),
+                    '%code%' => $user->getEmailAuthCode(),
+                    '%support%' => $this->supportUrl,
+                ],
+                'wallabag_user'
+            ))
+        ;
+
+        $this->mailer->send($message);
+    }
+}
diff --git a/src/Wallabag/UserBundle/Resources/config/services.yml b/src/Wallabag/UserBundle/Resources/config/services.yml
index e69de29b..9109b6a3 100644
--- a/src/Wallabag/UserBundle/Resources/config/services.yml
+++ b/src/Wallabag/UserBundle/Resources/config/services.yml
@@ -0,0 +1,9 @@
+services:
+    wallabag_user.auth_code_mailer:
+        class: Wallabag\UserBundle\Mailer\AuthCodeMailer
+        arguments:
+            - "@mailer"
+            - "@translator"
+            - "%scheb_two_factor.email.sender_email%"
+            - "%scheb_two_factor.email.sender_name%"
+            - "%wallabag_support_url%"
diff --git a/src/Wallabag/UserBundle/Resources/translations/wallabag_user.en.yml b/src/Wallabag/UserBundle/Resources/translations/wallabag_user.en.yml
new file mode 100644
index 00000000..f806d1d6
--- /dev/null
+++ b/src/Wallabag/UserBundle/Resources/translations/wallabag_user.en.yml
@@ -0,0 +1,10 @@
+# Two factor mail
+auth_code.mailer.subject: 'Wallabag authentication Code'
+auth_code.mailer.body: |
+    Hi %user%,
+
+    Since you enable two factor authentication on your wallabag account and you just logged in from a new device (computer, phone, etc.), we send you a code to validate your connection.
+    Here is the code: %code%
+
+    Please don't hesitate to contact us if you have any problems: %support%
+    The wallabag team
diff --git a/src/Wallabag/UserBundle/Resources/translations/wallabag_user.fr.yml b/src/Wallabag/UserBundle/Resources/translations/wallabag_user.fr.yml
new file mode 100644
index 00000000..386b2d9e
--- /dev/null
+++ b/src/Wallabag/UserBundle/Resources/translations/wallabag_user.fr.yml
@@ -0,0 +1,10 @@
+# Two factor mail
+auth_code.mailer.subject: "Code d'authentification wallabag"
+auth_code.mailer.body: |
+    Bonjour %user%,
+
+    Comme vous avez activé la double authentification sur votre compte wallabag et que vous venez de vous connecter depuis un nouvel appareil (ordinateur, téléphone, etc.), nous vous envoyons un code pour valider votre connexion.
+    Voici le code à renseigner: %code%
+
+    Si vous avez un problème de connexion, n'hésitez pas à contacter le support: %support%
+    L'équipe wallabag
diff --git a/src/Wallabag/UserBundle/Tests/Mailer/AuthCodeMailerTest.php b/src/Wallabag/UserBundle/Tests/Mailer/AuthCodeMailerTest.php
new file mode 100644
index 00000000..9122576a
--- /dev/null
+++ b/src/Wallabag/UserBundle/Tests/Mailer/AuthCodeMailerTest.php
@@ -0,0 +1,78 @@
+<?php
+
+namespace Wallabag\UserBundle\Tests\Mailer;
+
+use Wallabag\UserBundle\Entity\User;
+use Wallabag\UserBundle\Mailer\AuthCodeMailer;
+use Symfony\Component\Translation\Translator;
+use Symfony\Component\Translation\Loader\ArrayLoader;
+use Symfony\Component\Translation\DataCollectorTranslator;
+
+/**
+ * @see https://www.pmg.com/blog/integration-testing-swift-mailer/
+ */
+final class CountableMemorySpool extends \Swift_MemorySpool implements \Countable
+{
+    public function count()
+    {
+        return count($this->messages);
+    }
+
+    public function getMessages()
+    {
+        return $this->messages;
+    }
+}
+
+class AuthCodeMailerTest extends \PHPUnit_Framework_TestCase
+{
+    protected $mailer;
+    protected $spool;
+    protected $dataCollector;
+
+    protected function setUp()
+    {
+        $this->spool = new CountableMemorySpool();
+        $transport = new \Swift_Transport_SpoolTransport(
+            new \Swift_Events_SimpleEventDispatcher(),
+            $this->spool
+        );
+        $this->mailer = new \Swift_Mailer($transport);
+
+        $translator = new Translator('en');
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', array(
+            'auth_code.mailer.subject' => 'auth_code subject',
+            'auth_code.mailer.body' => 'Hi %user%, here is the code: %code% and the support: %support%',
+        ), 'en', 'wallabag_user');
+
+        $this->dataCollector = new DataCollectorTranslator($translator);
+    }
+
+    public function testSendEmail()
+    {
+        $user = new User();
+        $user->setTwoFactorAuthentication(true);
+        $user->setEmailAuthCode(666666);
+        $user->setEmail('test@wallabag.io');
+        $user->setName('Bob');
+
+        $authCodeMailer = new AuthCodeMailer(
+            $this->mailer,
+            $this->dataCollector,
+            'nobody@test.io',
+            'wallabag test',
+            'http://0.0.0.0'
+        );
+
+        $authCodeMailer->sendAuthCode($user);
+
+        $this->assertCount(1, $this->spool);
+
+        $msg = $this->spool->getMessages()[0];
+        $this->assertArrayHasKey('test@wallabag.io', $msg->getTo());
+        $this->assertEquals(array('nobody@test.io' => 'wallabag test'), $msg->getFrom());
+        $this->assertEquals('auth_code subject', $msg->getSubject());
+        $this->assertContains('Hi Bob, here is the code: 666666 and the support: http://0.0.0.0', $msg->toString());
+    }
+}