Merge pull request #4244 from nextcloud/welcome-email

New layout for welcome email

3 files changed, 81 insertions, 207 deletions

diff --git a/apps/provisioning_api/lib/AppInfo/Application.php b/apps/provisioning_api/lib/AppInfo/Application.php
index 2d6a82e2ff9..fd03fd41e16 100644
--- a/apps/provisioning_api/lib/AppInfo/Application.php
+++ b/apps/provisioning_api/lib/AppInfo/Application.php
@@ -3,8 +3,11 @@
 namespace OCA\Provisioning_API\AppInfo;
 
 use OC\AppFramework\Utility\SimpleContainer;
+use OC\AppFramework\Utility\TimeFactory;
+use OC\Settings\Mailer\NewUserMailHelper;
 use OCA\Provisioning_API\Middleware\ProvisioningApiMiddleware;
 use OCP\AppFramework\App;
+use OCP\Util;
 
 class Application extends App {
 	public function __construct(array $urlParams = array()) {
@@ -13,6 +16,19 @@ class Application extends App {
 		$container = $this->getContainer();
 		$server = $container->getServer();
 
+		$container->registerService(NewUserMailHelper::class, function(SimpleContainer $c) use ($server) {
+			return new NewUserMailHelper(
+				$server->getThemingDefaults(),
+				$server->getURLGenerator(),
+				$server->getL10N('settings'),
+				$server->getMailer(),
+				$server->getSecureRandom(),
+				new TimeFactory(),
+				$server->getConfig(),
+				$server->getCrypto(),
+				Util::getDefaultEmailAddress('no-reply')
+			);
+		});
 		$container->registerService('ProvisioningApiMiddleware', function(SimpleContainer $c) use ($server) {
 			$user = $server->getUserManager()->get($c['UserId']);
 			$isAdmin = $user !== null ? $server->getGroupManager()->isAdmin($user->getUID()) : false;
diff --git a/apps/provisioning_api/lib/Controller/UsersController.php b/apps/provisioning_api/lib/Controller/UsersController.php
index cb4e4b32917..9684c7f5656 100644
--- a/apps/provisioning_api/lib/Controller/UsersController.php
+++ b/apps/provisioning_api/lib/Controller/UsersController.php
@@ -30,6 +30,7 @@
 namespace OCA\Provisioning_API\Controller;
 
 use OC\Accounts\AccountManager;
+use OC\Settings\Mailer\NewUserMailHelper;
 use \OC_Helper;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\TemplateResponse;
@@ -72,6 +73,8 @@ class UsersController extends OCSController {
 	private $defaults;
 	/** @var IFactory */
 	private $l10nFactory;
+	/** @var NewUserMailHelper */
+	private $newUserMailHelper;
 
 	/**
 	 * @param string $appName
@@ -87,6 +90,7 @@ class UsersController extends OCSController {
 	 * @param IMailer $mailer
 	 * @param \OC_Defaults $defaults
 	 * @param IFactory $l10nFactory
+	 * @param NewUserMailHelper $newUserMailHelper
 	 */
 	public function __construct($appName,
 								IRequest $request,
@@ -100,7 +104,8 @@ class UsersController extends OCSController {
 								IURLGenerator $urlGenerator,
 								IMailer $mailer,
 								\OC_Defaults $defaults,
-								IFactory $l10nFactory) {
+								IFactory $l10nFactory,
+								NewUserMailHelper $newUserMailHelper) {
 		parent::__construct($appName, $request);
 
 		$this->userManager = $userManager;
@@ -114,6 +119,7 @@ class UsersController extends OCSController {
 		$this->mailer = $mailer;
 		$this->defaults = $defaults;
 		$this->l10nFactory = $l10nFactory;
+		$this->newUserMailHelper = $newUserMailHelper;
 	}
 
 	/**
@@ -807,30 +813,10 @@ class UsersController extends OCSController {
 
 		$l10n = $this->l10nFactory->get('settings', $lang);
 
-		// data for the mail template
-		$mailData = [
-			'username' => $username,
-			'url' => $this->urlGenerator->getAbsoluteURL('/')
-		];
-
-		// FIXME: set users language in email
-		$mail = new TemplateResponse('settings', 'email.new_user', $mailData, 'blank');
-		$mailContent = $mail->render();
-
-		// FIXME: set users language in email
-		$mail = new TemplateResponse('settings', 'email.new_user_plain_text', $mailData, 'blank');
-		$plainTextMailContent = $mail->render();
-
-		$subject = $l10n->t('Your %s account was created', [$this->defaults->getName()]);
-
 		try {
-			$message = $this->mailer->createMessage();
-			$message->setTo([$email => $username]);
-			$message->setSubject($subject);
-			$message->setHtmlBody($mailContent);
-			$message->setPlainBody($plainTextMailContent);
-			$message->setFrom([$this->fromMailAddress => $this->defaults->getName()]);
-			$this->mailer->send($message);
+			$this->newUserMailHelper->setL10N($l10n);
+			$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
+			$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
 		} catch(\Exception $e) {
 			$this->logger->error("Can't send new user mail to $email: " . $e->getMessage(), array('app' => 'settings'));
 			throw new OCSException('Sending email failed', 102);
diff --git a/apps/provisioning_api/tests/Controller/UsersControllerTest.php b/apps/provisioning_api/tests/Controller/UsersControllerTest.php
index 2c85fe0483b..24516840a7a 100644
--- a/apps/provisioning_api/tests/Controller/UsersControllerTest.php
+++ b/apps/provisioning_api/tests/Controller/UsersControllerTest.php
@@ -32,6 +32,8 @@ namespace OCA\Provisioning_API\Tests\Controller;
 use Exception;
 use OC\Accounts\AccountManager;
 use OC\Group\Manager;
+use OC\Mail\IEMailTemplate;
+use OC\Settings\Mailer\NewUserMailHelper;
 use OC\SubAdmin;
 use OCA\Provisioning_API\Controller\UsersController;
 use OCP\AppFramework\Http\DataResponse;
@@ -54,39 +56,30 @@ class UsersControllerTest extends TestCase {
 
 	/** @var IUserManager|PHPUnit_Framework_MockObject_MockObject */
 	protected $userManager;
-
 	/** @var IConfig|PHPUnit_Framework_MockObject_MockObject */
 	protected $config;
-
 	/** @var Manager|PHPUnit_Framework_MockObject_MockObject */
 	protected $groupManager;
-
 	/** @var IUserSession|PHPUnit_Framework_MockObject_MockObject */
 	protected $userSession;
-
 	/** @var ILogger|PHPUnit_Framework_MockObject_MockObject */
 	protected $logger;
-
 	/** @var UsersController|PHPUnit_Framework_MockObject_MockObject */
 	protected $api;
-
 	/** @var  AccountManager|PHPUnit_Framework_MockObject_MockObject */
 	protected $accountManager;
-
 	/** @var  IRequest|PHPUnit_Framework_MockObject_MockObject */
 	protected $request;
-
-	/** @var IURLGenerator | PHPUnit_Framework_MockObject_MockObject */
+	/** @var IURLGenerator|PHPUnit_Framework_MockObject_MockObject */
 	private $urlGenerator;
-
-	/** @var IMailer | PHPUnit_Framework_MockObject_MockObject */
+	/** @var IMailer|PHPUnit_Framework_MockObject_MockObject */
 	private $mailer;
-
-	/** @var \OC_Defaults | PHPUnit_Framework_MockObject_MockObject */
+	/** @var \OC_Defaults|PHPUnit_Framework_MockObject_MockObject */
 	private $defaults;
-
-	/** @var IFactory | PHPUnit_Framework_MockObject_MockObject */
+	/** @var IFactory|PHPUnit_Framework_MockObject_MockObject */
 	private $l10nFactory;
+	/** @var NewUserMailHelper|PHPUnit_Framework_MockObject_MockObject */
+	private $newUserMailHelper;
 
 	protected function setUp() {
 		parent::setUp();
@@ -102,6 +95,7 @@ class UsersControllerTest extends TestCase {
 		$this->mailer = $this->createMock(IMailer::class);
 		$this->defaults = $this->createMock(\OC_Defaults::class);
 		$this->l10nFactory = $this->createMock(IFactory::class);
+		$this->newUserMailHelper = $this->createMock(NewUserMailHelper::class);
 
 		$this->api = $this->getMockBuilder(UsersController::class)
 			->setConstructorArgs([
@@ -117,7 +111,8 @@ class UsersControllerTest extends TestCase {
 				$this->urlGenerator,
 				$this->mailer,
 				$this->defaults,
-				$this->l10nFactory
+				$this->l10nFactory,
+				$this->newUserMailHelper
 			])
 			->setMethods(['fillStorageInfo'])
 			->getMock();
@@ -2621,7 +2616,8 @@ class UsersControllerTest extends TestCase {
 				$this->urlGenerator,
 				$this->mailer,
 				$this->defaults,
-				$this->l10nFactory
+				$this->l10nFactory,
+				$this->newUserMailHelper
 			])
 			->setMethods(['getUserData'])
 			->getMock();
@@ -2684,7 +2680,8 @@ class UsersControllerTest extends TestCase {
 				$this->urlGenerator,
 				$this->mailer,
 				$this->defaults,
-				$this->l10nFactory
+				$this->l10nFactory,
+				$this->newUserMailHelper
 			])
 			->setMethods(['getUserData'])
 			->getMock();
@@ -2884,56 +2881,6 @@ class UsersControllerTest extends TestCase {
 			->expects($this->once())
 			->method('getEmailAddress')
 			->will($this->returnValue('abc@example.org'));
-		$message = $this->getMockBuilder('\OC\Mail\Message')
-			->disableOriginalConstructor()->getMock();
-		$message
-			->expects($this->at(0))
-			->method('setTo')
-			->with(['abc@example.org' => 'user-id']);
-		$message
-			->expects($this->at(1))
-			->method('setSubject')
-			->with('Your  account was created');
-		$htmlBody = new TemplateResponse(
-			'settings',
-			'email.new_user',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(2))
-			->method('setHtmlBody')
-			->with($htmlBody->render());
-		$plainBody = new TemplateResponse(
-			'settings',
-			'email.new_user_plain_text',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(3))
-			->method('setPlainBody')
-			->with($plainBody->render());
-		$message
-			->expects($this->at(4))
-			->method('setFrom')
-			->with(['test@example.org' => null]);
-
-		$this->mailer
-			->expects($this->at(0))
-			->method('createMessage')
-			->will($this->returnValue($message));
-		$this->mailer
-			->expects($this->at(1))
-			->method('send')
-			->with($message);
-
 		$this->config
 			->expects($this->at(0))
 			->method('getUserValue')
@@ -2942,11 +2889,6 @@ class UsersControllerTest extends TestCase {
 		$l10n = $this->getMockBuilder(IL10N::class)
 			->disableOriginalConstructor()
 			->getMock();
-		$l10n
-			->expects($this->at(0))
-			->method('t')
-			->with('Your %s account was created', [null])
-			->willReturn('Your  account was created');
 		$this->l10nFactory
 			->expects($this->at(0))
 			->method('languageExists')
@@ -2957,6 +2899,19 @@ class UsersControllerTest extends TestCase {
 			->method('get')
 			->with('settings', 'es')
 			->willReturn($l10n);
+		$emailTemplate = $this->createMock(IEMailTemplate::class);
+		$this->newUserMailHelper
+			->expects($this->at(0))
+			->method('setL10N')
+			->willReturn($l10n);
+		$this->newUserMailHelper
+			->expects($this->at(1))
+			->method('generateTemplate')
+			->willReturn($emailTemplate);
+		$this->newUserMailHelper
+			->expects($this->at(2))
+			->method('sendMail')
+			->with($targetUser, $emailTemplate);
 
 		$this->api->resendWelcomeMessage('UserToGet');
 	}
@@ -2996,56 +2951,6 @@ class UsersControllerTest extends TestCase {
 			->expects($this->once())
 			->method('getEmailAddress')
 			->will($this->returnValue('abc@example.org'));
-		$message = $this->getMockBuilder('\OC\Mail\Message')
-			->disableOriginalConstructor()->getMock();
-		$message
-			->expects($this->at(0))
-			->method('setTo')
-			->with(['abc@example.org' => 'user-id']);
-		$message
-			->expects($this->at(1))
-			->method('setSubject')
-			->with('Your  account was created');
-		$htmlBody = new TemplateResponse(
-			'settings',
-			'email.new_user',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(2))
-			->method('setHtmlBody')
-			->with($htmlBody->render());
-		$plainBody = new TemplateResponse(
-			'settings',
-			'email.new_user_plain_text',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(3))
-			->method('setPlainBody')
-			->with($plainBody->render());
-		$message
-			->expects($this->at(4))
-			->method('setFrom')
-			->with(['test@example.org' => null]);
-
-		$this->mailer
-			->expects($this->at(0))
-			->method('createMessage')
-			->will($this->returnValue($message));
-		$this->mailer
-			->expects($this->at(1))
-			->method('send')
-			->with($message);
-
 		$this->config
 			->expects($this->at(0))
 			->method('getUserValue')
@@ -3054,11 +2959,6 @@ class UsersControllerTest extends TestCase {
 		$l10n = $this->getMockBuilder(IL10N::class)
 			->disableOriginalConstructor()
 			->getMock();
-		$l10n
-			->expects($this->at(0))
-			->method('t')
-			->with('Your %s account was created', [null])
-			->willReturn('Your  account was created');
 		$this->l10nFactory
 			->expects($this->at(0))
 			->method('languageExists')
@@ -3069,6 +2969,19 @@ class UsersControllerTest extends TestCase {
 			->method('get')
 			->with('settings', 'en')
 			->willReturn($l10n);
+		$emailTemplate = $this->createMock(IEMailTemplate::class);
+		$this->newUserMailHelper
+			->expects($this->at(0))
+			->method('setL10N')
+			->willReturn($l10n);
+		$this->newUserMailHelper
+			->expects($this->at(1))
+			->method('generateTemplate')
+			->willReturn($emailTemplate);
+		$this->newUserMailHelper
+			->expects($this->at(2))
+			->method('sendMail')
+			->with($targetUser, $emailTemplate);
 
 		$this->api->resendWelcomeMessage('UserToGet');
 	}
@@ -3113,56 +3026,6 @@ class UsersControllerTest extends TestCase {
 			->expects($this->once())
 			->method('getEmailAddress')
 			->will($this->returnValue('abc@example.org'));
-		$message = $this->getMockBuilder('\OC\Mail\Message')
-			->disableOriginalConstructor()->getMock();
-		$message
-			->expects($this->at(0))
-			->method('setTo')
-			->with(['abc@example.org' => 'user-id']);
-		$message
-			->expects($this->at(1))
-			->method('setSubject')
-			->with('Your  account was created');
-		$htmlBody = new TemplateResponse(
-			'settings',
-			'email.new_user',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(2))
-			->method('setHtmlBody')
-			->with($htmlBody->render());
-		$plainBody = new TemplateResponse(
-			'settings',
-			'email.new_user_plain_text',
-			[
-				'username' => 'user-id',
-				'url' => null,
-			],
-			'blank'
-		);
-		$message
-			->expects($this->at(3))
-			->method('setPlainBody')
-			->with($plainBody->render());
-		$message
-			->expects($this->at(4))
-			->method('setFrom')
-			->with(['test@example.org' => null]);
-
-		$this->mailer
-			->expects($this->at(0))
-			->method('createMessage')
-			->will($this->returnValue($message));
-		$this->mailer
-			->expects($this->at(1))
-			->method('send')
-			->will($this->throwException(new \Exception()));
-
 		$this->config
 			->expects($this->at(0))
 			->method('getUserValue')
@@ -3171,11 +3034,6 @@ class UsersControllerTest extends TestCase {
 		$l10n = $this->getMockBuilder(IL10N::class)
 			->disableOriginalConstructor()
 			->getMock();
-		$l10n
-			->expects($this->at(0))
-			->method('t')
-			->with('Your %s account was created', [null])
-			->willReturn('Your  account was created');
 		$this->l10nFactory
 			->expects($this->at(0))
 			->method('languageExists')
@@ -3186,6 +3044,20 @@ class UsersControllerTest extends TestCase {
 			->method('get')
 			->with('settings', 'es')
 			->willReturn($l10n);
+		$emailTemplate = $this->createMock(IEMailTemplate::class);
+		$this->newUserMailHelper
+			->expects($this->at(0))
+			->method('setL10N')
+			->willReturn($l10n);
+		$this->newUserMailHelper
+			->expects($this->at(1))
+			->method('generateTemplate')
+			->willReturn($emailTemplate);
+		$this->newUserMailHelper
+			->expects($this->at(2))
+			->method('sendMail')
+			->with($targetUser, $emailTemplate)
+			->willThrowException(new \Exception());
 
 		$this->api->resendWelcomeMessage('UserToGet');
 	}