MAGETWO-92722: [Backport for 2.2.x] E-mail admin users when a new administrator is created.

Oleksandr Gorkun · Oleksandr Gorkun · commit dbef5af8ae69 · 2018-06-18T16:57:18.000+03:00
diff --git a/app/code/Magento/User/Controller/Adminhtml/User/Save.php b/app/code/Magento/User/Controller/Adminhtml/User/Save.php
@@ -6,6 +6,7 @@
 namespace Magento\User\Controller\Adminhtml\User;
 
 use Magento\Framework\Exception\AuthenticationException;
+use Magento\Framework\Exception\MailException;
 use Magento\Framework\Exception\State\UserLockedException;
 use Magento\Security\Model\SecurityCookie;
 
@@ -84,17 +85,19 @@ public function execute()
             $currentUser->performIdentityCheck($data[$currentUserPasswordField]);
             $model->save();
 
-            $model->sendNotificationEmailsIfRequired();
-
             $this->messageManager->addSuccess(__('You saved the user.'));
             $this->_getSession()->setUserData(false);
             $this->_redirect('adminhtml/*/');
+
+            $model->sendNotificationEmailsIfRequired();
         } catch (UserLockedException $e) {
             $this->_auth->logout();
             $this->getSecurityCookie()->setLogoutReasonCookie(
                 \Magento\Security\Model\AdminSessionsManager::LOGOUT_REASON_USER_LOCKED
             );
             $this->_redirect('adminhtml/*/');
+        } catch (MailException $exception) {
+            $this->messageManager->addErrorMessage($exception->getMessage());
         } catch (\Magento\Framework\Exception\AuthenticationException $e) {
             $this->messageManager->addError(__('You have entered an invalid password for current user.'));
             $this->redirectToEdit($model, $data);
diff --git a/app/code/Magento/User/Model/User.php b/app/code/Magento/User/Model/User.php
@@ -7,7 +7,9 @@
 
 use Magento\Backend\App\Area\FrontNameResolver;
 use Magento\Backend\Model\Auth\Credential\StorageInterface;
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\MailException;
 use Magento\Framework\Model\AbstractModel;
 use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\Serialize\Serializer\Json;
@@ -40,10 +42,14 @@ class User extends AbstractModel implements StorageInterface, UserInterface
      */
     const XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template';
 
+    const XML_PATH_NEW_USER_EMAIL_TEMPLATE = 'admin/emails/new_user_notification_template';
+
     const XML_PATH_FORGOT_EMAIL_IDENTITY = 'admin/emails/forgot_email_identity';
 
     const XML_PATH_USER_NOTIFICATION_TEMPLATE = 'admin/emails/user_notification_template';
 
+    const DEPLOYMENT_CONFIG_ADMIN_EMAIL = 'user_admin_email';
+
     /** @deprecated */
     const XML_PATH_RESET_PASSWORD_TEMPLATE = 'admin/emails/reset_password_template';
 
@@ -121,6 +127,11 @@ class User extends AbstractModel implements StorageInterface, UserInterface
      */
     private $serializer;
 
+    /**
+     * @var DeploymentConfig
+     */
+    private $deploymentConfig;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -136,6 +147,7 @@ class User extends AbstractModel implements StorageInterface, UserInterface
      * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
      * @param array $data
      * @param Json $serializer
+     * @param DeploymentConfig|null $deploymentConfig
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -152,7 +164,8 @@ public function __construct(
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = [],
-        Json $serializer = null
+        Json $serializer = null,
+        DeploymentConfig $deploymentConfig = null
     ) {
         $this->_encryptor = $encryptor;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
@@ -164,6 +177,8 @@ public function __construct(
         $this->_storeManager = $storeManager;
         $this->validationRules = $validationRules;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
+        $this->deploymentConfig = $deploymentConfig
+            ?? ObjectManager::getInstance()->get(DeploymentConfig::class);
     }
 
     /**
@@ -395,23 +410,58 @@ public function roleUserExists()
         return is_array($result) && count($result) > 0 ? true : false;
     }
 
+    /**
+     * Send a notification to an admin.
+     *
+     * @param string $templateConfigId
+     * @param array $templateVars
+     * @param string|null $toEmail
+     * @param string|null $toName
+     * @throws MailException
+     *
+     * @return void
+     */
+    private function sendNotification(
+        string $templateConfigId,
+        array $templateVars,
+        string $toEmail = null,
+        string $toName = null
+    ) {
+        $toEmail = $toEmail ?? $this->getEmail();
+        $toName = $toName ?? $this->getName();
+        $this->_transportBuilder
+            ->setTemplateIdentifier($this->_config->getValue($templateConfigId))
+            ->setTemplateModel(\Magento\Email\Model\BackendTemplate::class)
+            ->setTemplateOptions([
+                'area' => FrontNameResolver::AREA_CODE,
+                'store' => Store::DEFAULT_STORE_ID
+            ])
+            ->setTemplateVars($templateVars)
+            ->setFrom(
+                $this->_config->getValue(self::XML_PATH_FORGOT_EMAIL_IDENTITY)
+            )
+            ->addTo($toEmail, $toName)
+            ->getTransport()
+            ->sendMessage();
+    }
+
     /**
      * Send email with reset password confirmation link
      *
      * @return $this
      */
     public function sendPasswordResetConfirmationEmail()
     {
-        $templateId = $this->_config->getValue(self::XML_PATH_FORGOT_EMAIL_TEMPLATE);
-        $transport = $this->_transportBuilder->setTemplateIdentifier($templateId)
-            ->setTemplateModel(\Magento\Email\Model\BackendTemplate::class)
-            ->setTemplateOptions(['area' => FrontNameResolver::AREA_CODE, 'store' => Store::DEFAULT_STORE_ID])
-            ->setTemplateVars(['user' => $this, 'store' => $this->_storeManager->getStore(Store::DEFAULT_STORE_ID)])
-            ->setFrom($this->_config->getValue(self::XML_PATH_FORGOT_EMAIL_IDENTITY))
-            ->addTo($this->getEmail(), $this->getName())
-            ->getTransport();
+        $this->sendNotification(
+            self::XML_PATH_FORGOT_EMAIL_TEMPLATE,
+            [
+                'user' => $this,
+                'store' => $this->_storeManager->getStore(
+                    Store::DEFAULT_STORE_ID
+                )
+            ]
+        );
 
-        $transport->sendMessage();
         return $this;
     }
 
@@ -427,19 +477,63 @@ public function sendPasswordResetNotificationEmail()
         return $this;
     }
 
+    /**
+     * Send notification about a new user created.
+     *
+     * @throws MailException
+     * @return void
+     */
+    private function sendNewUserNotificationEmail()
+    {
+        $toEmails = [];
+        $generalEmail = $this->_config->getValue(
+            'trans_email/ident_general/email'
+        );
+        if ($generalEmail) {
+            $toEmails[] = $generalEmail;
+        }
+        $adminEmail = $this->deploymentConfig->get(
+            static::DEPLOYMENT_CONFIG_ADMIN_EMAIL
+        );
+        if ($adminEmail) {
+            $toEmails[] = $adminEmail;
+        }
+
+        foreach ($toEmails as $toEmail) {
+            $this->sendNotification(
+                self::XML_PATH_NEW_USER_EMAIL_TEMPLATE,
+                [
+                    'user'  => $this,
+                    'store' => $this->_storeManager->getStore(
+                        Store::DEFAULT_STORE_ID
+                    )
+                ],
+                $toEmail,
+                'Administrator'
+            );
+        }
+    }
+
     /**
      * Check changes and send notification emails
      *
+     * @throws MailException
      * @return $this
      * @since 100.1.0
      */
     public function sendNotificationEmailsIfRequired()
     {
-        $changes = $this->createChangesDescriptionString();
-
-        if ($changes) {
-            if ($this->getEmail() != $this->getOrigData('email') && $this->getOrigData('email')) {
-                $this->sendUserNotificationEmail($changes, $this->getOrigData('email'));
+        if ($this->isObjectNew()) {
+            //Notification about a new user
+            $this->sendNewUserNotificationEmail();
+        } elseif ($changes = $this->createChangesDescriptionString()) {
+            if ($this->getEmail() != $this->getOrigData('email')
+                && $this->getOrigData('email')
+            ) {
+                $this->sendUserNotificationEmail(
+                    $changes,
+                    $this->getOrigData('email')
+                );
             }
             $this->sendUserNotificationEmail($changes);
         }
@@ -479,31 +573,24 @@ protected function createChangesDescriptionString()
      *
      * @param string $changes
      * @param string $email
+     * @throws MailException
      * @return $this
      * @since 100.1.0
      */
     protected function sendUserNotificationEmail($changes, $email = null)
     {
-        if ($email === null) {
-            $email = $this->getEmail();
-        }
-
-        $transport = $this->_transportBuilder
-            ->setTemplateIdentifier($this->_config->getValue(self::XML_PATH_USER_NOTIFICATION_TEMPLATE))
-            ->setTemplateModel(\Magento\Email\Model\BackendTemplate::class)
-            ->setTemplateOptions(['area' => FrontNameResolver::AREA_CODE, 'store' => Store::DEFAULT_STORE_ID])
-            ->setTemplateVars(
-                [
-                    'user' => $this,
-                    'store' => $this->_storeManager->getStore(Store::DEFAULT_STORE_ID),
-                    'changes' => $changes
-                ]
-            )
-            ->setFrom($this->_config->getValue(self::XML_PATH_FORGOT_EMAIL_IDENTITY))
-            ->addTo($email, $this->getName())
-            ->getTransport();
+        $this->sendNotification(
+            self::XML_PATH_USER_NOTIFICATION_TEMPLATE,
+            [
+                'user' => $this,
+                'store' => $this->_storeManager->getStore(
+                    Store::DEFAULT_STORE_ID
+                ),
+                'changes' => $changes
+            ],
+            $email
+        );
 
-        $transport->sendMessage();
         return $this;
     }
 
diff --git a/app/code/Magento/User/etc/config.xml b/app/code/Magento/User/etc/config.xml
@@ -10,6 +10,7 @@
         <admin>
             <emails>
                 <forgot_email_template>admin_emails_forgot_email_template</forgot_email_template>
+                <new_user_notification_template>admin_emails_new_user_notification_template</new_user_notification_template>
                 <forgot_email_identity>general</forgot_email_identity>
                 <user_notification_template>admin_emails_user_notification_template</user_notification_template>
             </emails>
diff --git a/app/code/Magento/User/etc/email_templates.xml b/app/code/Magento/User/etc/email_templates.xml
@@ -8,4 +8,10 @@
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
     <template id="admin_emails_forgot_email_template" label="Forgot Admin Password" file="password_reset_confirmation.html" type="text" module="Magento_User" area="adminhtml"/>
     <template id="admin_emails_user_notification_template" label="User Notification" file="user_notification.html" type="text" module="Magento_User" area="adminhtml"/>
+    <template id="admin_emails_new_user_notification_template"
+              label="New User Notification"
+              file="new_user_notification.html"
+              type="text"
+              module="Magento_User"
+              area="adminhtml"/>
 </config>
diff --git a/app/code/Magento/User/view/adminhtml/email/new_user_notification.html b/app/code/Magento/User/view/adminhtml/email/new_user_notification.html
@@ -0,0 +1,18 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<!--@subject {{trans "New admin user '%user_name' created" user_name=$user.name}} @-->
+<!--@vars {
+"var store.getFrontendName()|escape":"Store Name"
+} @-->
+
+{{trans "Hello,"}}
+
+{{trans "A new admin account was created for %first_name, %last_name using %email." first_name=$user.first_name last_name=$user.last_name email=$user.email}}
+{{trans "If you have not authorized this action, please contact us immediately at %store_email" store_email=$store_email |escape}}{{depend store_phone}} {{trans "or call us at %store_phone" store_phone=$store_phone |escape}}{{/depend}}.
+
+{{trans "Thanks,"}}
+{{var store.getFrontendName()}}
