Refactor contact module

app/code/Magento/Contact/Controller/Index.php

@@ -5,74 +5,51 @@
  */
 namespace Magento\Contact\Controller;
 
-use Magento\Framework\Exception\NotFoundException;
+use Magento\Contact\Model\ConfigInterface;
+use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\RequestInterface;
-use Magento\Store\Model\ScopeInterface;
+use Magento\Framework\Exception\NotFoundException;
 
 /**
- * Contact index controller
+ * Contact module base controller
  */
 abstract class Index extends \Magento\Framework\App\Action\Action
 {
     /**
      * Recipient email config path
      */
-    const XML_PATH_EMAIL_RECIPIENT = 'contact/email/recipient_email';
+    const XML_PATH_EMAIL_RECIPIENT = ConfigInterface::XML_PATH_EMAIL_RECIPIENT;
 
     /**
      * Sender email config path
      */
-    const XML_PATH_EMAIL_SENDER = 'contact/email/sender_email_identity';
+    const XML_PATH_EMAIL_SENDER = ConfigInterface::XML_PATH_EMAIL_SENDER;
 
     /**
      * Email template config path
      */
-    const XML_PATH_EMAIL_TEMPLATE = 'contact/email/email_template';
+    const XML_PATH_EMAIL_TEMPLATE = ConfigInterface::XML_PATH_EMAIL_TEMPLATE;
 
     /**
      * Enabled config path
      */
-    const XML_PATH_ENABLED = 'contact/contact/enabled';
-
-    /**
-     * @var \Magento\Framework\Mail\Template\TransportBuilder
-     */
-    protected $_transportBuilder;
-
-    /**
-     * @var \Magento\Framework\Translate\Inline\StateInterface
-     */
-    protected $inlineTranslation;
-
-    /**
-     * @var \Magento\Framework\App\Config\ScopeConfigInterface
-     */
-    protected $scopeConfig;
+    const XML_PATH_ENABLED = ConfigInterface::XML_PATH_ENABLED;
 
     /**
-     * @var \Magento\Store\Model\StoreManagerInterface
+     * @var ConfigInterface
      */
-    protected $storeManager;
+    private $contactsConfig;
 
     /**
-     * @param \Magento\Framework\App\Action\Context $context
-     * @param \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder
-     * @param \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation
+     * @param Context $context
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      */
     public function __construct(
-        \Magento\Framework\App\Action\Context $context,
-        \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder,
-        \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation,
-        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
-        \Magento\Store\Model\StoreManagerInterface $storeManager
+        Context $context,
+        ConfigInterface $contactsConfig
     ) {
         parent::__construct($context);
-        $this->_transportBuilder = $transportBuilder;
-        $this->inlineTranslation = $inlineTranslation;
-        $this->scopeConfig = $scopeConfig;
-        $this->storeManager = $storeManager;
+        $this->contactsConfig = $contactsConfig;
     }
 
     /**
@@ -84,7 +61,7 @@ public function __construct(
      */
     public function dispatch(RequestInterface $request)
     {
-        if (!$this->scopeConfig->isSetFlag(self::XML_PATH_ENABLED, ScopeInterface::SCOPE_STORE)) {
+        if (!$this->contactsConfig->isEnabled()) {
             throw new NotFoundException(__('Page not found.'));
         }
         return parent::dispatch($request);

app/code/Magento/Contact/Controller/Index/Post.php

@@ -6,8 +6,16 @@
  */
 namespace Magento\Contact\Controller\Index;
 
-use Magento\Framework\App\Request\DataPersistorInterface;
+use Magento\Contact\Model\ConfigInterface;
+use Magento\Contact\Model\MailInterface;
+use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\Request\DataPersistorInterface;
+use Magento\Framework\Controller\Result\Redirect;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\HTTP\PhpEnvironment\Request;
+use Magento\Framework\Mail\Template\TransportBuilder;
+use Magento\Framework\Translate\Inline\StateInterface;
 
 class Post extends \Magento\Contact\Controller\Index
 {
@@ -16,75 +24,60 @@ class Post extends \Magento\Contact\Controller\Index
      */
     private $dataPersistor;
 
+    /**
+     * @var Context
+     */
+    private $context;
+
+    /**
+     * @var MailInterface
+     */
+    private $mail;
+
+    /**
+     * @param Context $context
+     * @param MailInterface $mail
+     * @param ConfigInterface $contactsConfig
+     * @param DataPersistorInterface $dataPersistor
+     */
+    public function __construct(
+        Context $context,
+        MailInterface $mail,
+        ConfigInterface $contactsConfig,
+        DataPersistorInterface $dataPersistor
+    ) {
+        parent::__construct($context, $contactsConfig);
+        $this->context = $context;
+        $this->mail = $mail;
+        $this->dataPersistor = $dataPersistor;
+    }
+
     /**
      * Post user question
      *
-     * @return void
-     * @throws \Exception
+     * @return Redirect
      */
     public function execute()
     {
-        $post = $this->getRequest()->getPostValue();
-        if (!$post) {
-            $this->_redirect('*/*/');
-            return;
+        if (! $this->isPostRequest()) {
+            return $this->resultRedirectFactory->create()->setPath('*/*/');
         }
-
-        $this->inlineTranslation->suspend();
         try {
-            $postObject = new \Magento\Framework\DataObject();
-            $postObject->setData($post);
-
-            $error = false;
-
-            if (!\Zend_Validate::is(trim($post['name']), 'NotEmpty')) {
-                $error = true;
-            }
-            if (!\Zend_Validate::is(trim($post['comment']), 'NotEmpty')) {
-                $error = true;
-            }
-            if (!\Zend_Validate::is(trim($post['email']), 'EmailAddress')) {
-                $error = true;
-            }
-            if (\Zend_Validate::is(trim($post['hideit']), 'NotEmpty')) {
-                $error = true;
-            }
-            if ($error) {
-                throw new \Exception();
-            }
-
-            $storeScope = \Magento\Store\Model\ScopeInterface::SCOPE_STORE;
-            $transport = $this->_transportBuilder
-                ->setTemplateIdentifier($this->scopeConfig->getValue(self::XML_PATH_EMAIL_TEMPLATE, $storeScope))
-                ->setTemplateOptions(
-                    [
-                        'area' => \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE,
-                        'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID,
-                    ]
-                )
-                ->setTemplateVars(['data' => $postObject])
-                ->setFrom($this->scopeConfig->getValue(self::XML_PATH_EMAIL_SENDER, $storeScope))
-                ->addTo($this->scopeConfig->getValue(self::XML_PATH_EMAIL_RECIPIENT, $storeScope))
-                ->setReplyTo($post['email'])
-                ->getTransport();
-
-            $transport->sendMessage();
-            $this->inlineTranslation->resume();
+            $this->sendEmail($this->validatedParams());
             $this->messageManager->addSuccess(
                 __('Thanks for contacting us with your comments and questions. We\'ll respond to you very soon.')
             );
             $this->getDataPersistor()->clear('contact_us');
-            $this->_redirect('contact/index');
-            return;
+        } catch (LocalizedException $e) {
+            $this->messageManager->addErrorMessage($e->getMessage());
+            $this->getDataPersistor()->set('contact_us', $this->getRequest()->getParams());
         } catch (\Exception $e) {
-            $this->inlineTranslation->resume();
-            $this->messageManager->addError(
+            $this->messageManager->addErrorMessage(
                 __('We can\'t process your request right now. Sorry, that\'s all we know.')
             );
-            $this->getDataPersistor()->set('contact_us', $post);
-            $this->_redirect('contact/index');
-            return;
+            $this->getDataPersistor()->set('contact_us', $this->getRequest()->getParams());
         }
+        return $this->resultRedirectFactory->create()->setPath('contact/index');
     }
 
     /**
@@ -101,4 +94,46 @@ private function getDataPersistor()
 
         return $this->dataPersistor;
     }
+
+    /**
+     * @param array $post Post data from contact form
+     * @return void
+     */
+    private function sendEmail($post)
+    {
+        $this->mail->send($post['email'], ['data' => new \Magento\Framework\DataObject($post)]);
+    }
+
+    /**
+     * @return bool
+     */
+    private function isPostRequest()
+    {
+        /** @var Request $request */
+        $request = $this->getRequest();
+        return !empty($request->getPostValue());
+    }
+
+    /**
+     * @return array
+     * @throws \Exception
+     */
+    private function validatedParams()
+    {
+        $request = $this->getRequest();
+        if (trim($request->getParam('name')) === '') {
+            throw new LocalizedException(__('Name is missing'));
+        }
+        if (trim($request->getParam('comment')) === '') {
+            throw new LocalizedException(__('Comment is missing'));
+        }
+        if (false === \strpos($request->getParam('email'), '@')) {
+            throw new LocalizedException(__('Invalid email address'));
+        }
+        if (trim($request->getParam('hideit')) !== '') {
+            throw new \Exception();
+        }
+
+        return $request->getParams();
+    }
 }

app/code/Magento/Contact/Helper/Data.php

@@ -6,6 +6,7 @@
 
 namespace Magento\Contact\Helper;
 
+use Magento\Contact\Model\ConfigInterface;
 use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Customer\Helper\View as CustomerViewHelper;
 use Magento\Framework\App\Request\DataPersistorInterface;
@@ -16,7 +17,7 @@
  */
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
-    const XML_PATH_ENABLED = 'contact/contact/enabled';
+    const XML_PATH_ENABLED = ConfigInterface::XML_PATH_ENABLED;
 
     /**
      * Customer session
@@ -59,6 +60,7 @@ public function __construct(
      * Check if enabled
      *
      * @return string|null
+     * @deprecated use \Magento\Contact\Api\ConfigInterface::isEnabled() instead
      */
     public function isEnabled()
     {

app/code/Magento/Contact/Model/Config.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Contact\Model;
+
+use Magento\Contact\Model\ConfigInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Model\ScopeInterface;
+
+/**
+ * Contact module configuration
+ */
+class Config implements ConfigInterface
+{
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(ScopeConfigInterface $scopeConfig)
+    {
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isEnabled()
+    {
+        return $this->scopeConfig->isSetFlag(
+            self::XML_PATH_ENABLED,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * @return string
+     */
+    public function emailTemplate()
+    {
+        return $this->scopeConfig->getValue(
+            ConfigInterface::XML_PATH_EMAIL_TEMPLATE,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * @return string
+     */
+    public function emailSender()
+    {
+        return $this->scopeConfig->getValue(
+            ConfigInterface::XML_PATH_EMAIL_SENDER,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * @return string
+     */
+    public function emailRecipient()
+    {
+        return $this->scopeConfig->getValue(
+            ConfigInterface::XML_PATH_EMAIL_RECIPIENT,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+}