Adding a class to make it easier to set custom authentication error messages

weaverryan · weaverryan · commit 556abe02b0e2 · 2015-09-26T11:43:50.000-04:00
diff --git a/src/Symfony/Component/Security/Core/Exception/SafeMessageAuthenticationException.php b/src/Symfony/Component/Security/Core/Exception/SafeMessageAuthenticationException.php
@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Core\Exception;
+use Exception;
+
+/**
+ * An authentication exception where you can control the message shown to the user
+ *
+ * Be sure that the message passed to this exception is something that
+ * can be shown safely to your user. In other words, avoid catching
+ * other exceptions and passing their message directly to this class.
+ *
+ * @author Ryan Weaver <ryan@knpuniversity.com>
+ */
+class SafeMessageAuthenticationException extends AuthenticationException
+{
+    private $messageKey;
+
+    private $messageData = array();
+
+    public function __construct($message = "", array $messageData = array(), $code = 0, Exception $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+
+        $this->setSafeMessage($message, $messageData);
+    }
+
+
+    /**
+     * Set a message that will be shown to the user.
+     *
+     * @param string $messageKey  The message or message key
+     * @param array  $messageData Data to be passed into the translator
+     */
+    public function setSafeMessage($messageKey, array $messageData = array())
+    {
+        $this->messageKey = $messageKey;
+        $this->messageData = $messageData;
+    }
+
+    public function getMessageKey()
+    {
+        return null !== $this->messageKey ? $this->messageKey : parent::getMessageKey();
+    }
+
+    public function getMessageData()
+    {
+        return $this->messageData;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function serialize()
+    {
+        return serialize(array(
+            parent::serialize(),
+            $this->messageKey,
+            $this->messageData,
+        ));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unserialize($str)
+    {
+        list($parentData, $this->messageKey, $this->messageData) = unserialize($str);
+
+        parent::unserialize($parentData);
+    }
+}
diff --git a/src/Symfony/Component/Security/Core/Tests/Exception/SafeMessageAuthenticationExceptionTest.php b/src/Symfony/Component/Security/Core/Tests/Exception/SafeMessageAuthenticationExceptionTest.php
@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Core\Tests\Exception;
+
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Core\Exception\SafeMessageAuthenticationException;
+
+class SafeMessageAuthenticationExceptionTest extends \PHPUnit_Framework_TestCase
+{
+    public function testConstructWithSAfeMessage()
+    {
+        $e = new SafeMessageAuthenticationException('SAFE MESSAGE', array('foo' => true));
+
+        $this->assertEquals('SAFE MESSAGE', $e->getMessageKey());
+        $this->assertEquals(array('foo' => true), $e->getMessageData());
+        $this->assertEquals('SAFE MESSAGE', $e->getMessage());
+    }
+
+    /**
+     * @dataProvider provideKeysAndData
+     */
+    public function testMessageKeyAndData($key, array $data, $expectedKey, array $expectedData)
+    {
+        $e = new SafeMessageAuthenticationException();
+        $e->setSafeMessage($key, $data);
+
+        $this->assertEquals($expectedKey, $e->getMessageKey());
+        $this->assertEquals($expectedData, $e->getMessageData());
+    }
+
+    public function provideKeysAndData()
+    {
+        // the parent exception
+        $authenticationException = new AuthenticationException();
+
+        $tests = array();
+        // null key means the parent is used
+        $tests[] = array(null, array(), $authenticationException->getMessageKey(), array());
+        $tests[] = array('', array(), '', array());
+        $tests[] = array('MESSAGE', array('bar' => false), 'MESSAGE', array('bar' => false));
+
+        return $tests;
+    }
+}
