upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-06-09 00:32:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 35

Provide the proper language to the mailer

Browse source 
Else we can't properly translate the footer in the recipients e-mail
language.

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2020-03-31 14:02:39 +02:00
parent 73ef2f3e86
commit 7550043371
No known key found for this signature in database
GPG key ID: F941078878347C0C
11 changed files with 45 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
apps/settings/tests/Mailer/NewUserMailHelperTest.php
View file

@ -79,7 +79,7 @@ class NewUserMailHelperTest extends TestCase {
$template = new EMailTemplate(
$this->defaults,
$this->urlGenerator,
$this->l10n,
$this->l10nFactory,
'test.TestTemplate',
[]
);
@ -378,8 +378,8 @@ Set your password: https://example.com/resetPassword/MySuperLongSecureRandomToke
Install Client: https://nextcloud.com/install/#install-clients
--
TestCloud -
--
TestCloud -
This is an automatically sent email, please do not reply.
EOF;

4
apps/theming/lib/ThemingDefaults.php
View file

@ -145,8 +145,8 @@ class ThemingDefaults extends \OC_Defaults {
return $this->config->getAppValue('theming', 'url', $this->url);
}
public function getSlogan() {
return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan()));
public function getSlogan(?string $lang = null) {
return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan($lang)));
}
public function getImprintUrl() {

22
lib/private/Mail/EMailTemplate.php
View file

@ -35,8 +35,8 @@ declare(strict_types=1);
namespace OC\Mail;
use OCP\Defaults;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;
use OCP\Mail\IEMailTemplate;
/**
@ -52,8 +52,8 @@ class EMailTemplate implements IEMailTemplate {
protected $themingDefaults;
/** @var IURLGenerator */
protected $urlGenerator;
/** @var IL10N */
protected $l10n;
/** @var IFactory */
protected $l10nFactory;
/** @var string */
protected $emailId;
/** @var array */
@ -350,21 +350,14 @@ EOF;
</table>
EOF;
/**
* @param Defaults $themingDefaults
* @param IURLGenerator $urlGenerator
* @param IL10N $l10n
* @param string $emailId
* @param array $data
*/
public function __construct(Defaults $themingDefaults,
IURLGenerator $urlGenerator,
IL10N $l10n,
IFactory $l10nFactory,
$emailId,
array $data) {
$this->themingDefaults = $themingDefaults;
$this->urlGenerator = $urlGenerator;
$this->l10n = $l10n;
$this->l10nFactory = $l10nFactory;
$this->htmlBody .= $this->head;
$this->emailId = $emailId;
$this->data = $data;
@ -607,9 +600,10 @@ EOF;
*
* @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
*/
public function addFooter(string $text = '') {
public function addFooter(string $text = '', ?string $lang = null) {
if($text === '') {
$text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan() . '<br>' . $this->l10n->t('This is an automatically sent email, please do not reply.');
$l10n = $this->l10nFactory->get('lib', $lang);
$text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan($lang) . '<br>' . $l10n->t('This is an automatically sent email, please do not reply.');
}
if ($this->footerAdded) {

11
lib/private/Mail/Mailer.php
View file

@ -38,6 +38,7 @@ use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;
use OCP\Mail\IAttachment;
use OCP\Mail\IEMailTemplate;
use OCP\Mail\IMailer;
@ -74,6 +75,10 @@ class Mailer implements IMailer {
private $urlGenerator;
/** @var IL10N */
private $l10n;
/**
* @var IFactory
*/
private $l10nFactory;
/**
* @param IConfig $config
@ -86,12 +91,14 @@ class Mailer implements IMailer {
ILogger $logger,
Defaults $defaults,
IURLGenerator $urlGenerator,
IL10N $l10n) {
IL10N $l10n,
IFactory $l10nFactory) {
$this->config = $config;
$this->logger = $logger;
$this->defaults = $defaults;
$this->urlGenerator = $urlGenerator;
$this->l10n = $l10n;
$this->l10nFactory = $l10nFactory;
}
/**
@ -149,7 +156,7 @@ class Mailer implements IMailer {
return new EMailTemplate(
$this->defaults,
$this->urlGenerator,
$this->l10n,
$this->l10nFactory,
$emailId,
$data
);

4
lib/private/Server.php
View file

@ -164,6 +164,7 @@ use OCP\IL10N;
use OCP\IServerContainer;
use OCP\ITempManager;
use OCP\IUser;
use OCP\L10N\IFactory;
use OCP\Lock\ILockingProvider;
use OCP\Log\ILogFactory;
use OCP\Remote\Api\IApiFactory;
@ -946,7 +947,8 @@ class Server extends ServerContainer implements IServerContainer {
$c->getLogger(),
$c->query(Defaults::class),
$c->getURLGenerator(),
$c->getL10N('lib')
$c->getL10N('lib'),
$c->query(IFactory::class)
);
});
$this->registerAlias('Mailer', \OCP\Mail\IMailer::class);

4
lib/private/Share20/Manager.php
View file

@ -894,9 +894,9 @@ class Manager implements IManager {
$initiatorEmail = $initiatorUser->getEMailAddress();
if($initiatorEmail !== null) {
$message->setReplyTo([$initiatorEmail => $initiatorDisplayName]);
$emailTemplate->addFooter($instanceName . ($this->defaults->getSlogan() !== '' ? ' - ' . $this->defaults->getSlogan() : ''));
$emailTemplate->addFooter($instanceName . ($this->defaults->getSlogan($l->getLanguageCode()) !== '' ? ' - ' . $this->defaults->getSlogan($l->getLanguageCode()) : ''));
} else {
$emailTemplate->addFooter();
$emailTemplate->addFooter('', $l->getLanguageCode());
}
$message->useTemplate($emailTemplate);

6
lib/private/legacy/defaults.php
View file

@ -215,12 +215,12 @@ class OC_Defaults {
* Returns slogan
* @return string slogan
*/
public function getSlogan() {
public function getSlogan(?string $lang = null) {
if ($this->themeExist('getSlogan')) {
return $this->theme->getSlogan();
return $this->theme->getSlogan($lang);
} else {
if ($this->defaultSlogan === null) {
$l10n = \OC::$server->getL10N('lib');
$l10n = \OC::$server->getL10N('lib', $lang);
$this->defaultSlogan = $l10n->t('a safe home for all your data');
}
return $this->defaultSlogan;

4
lib/public/Defaults.php
View file

@ -137,8 +137,8 @@ class Defaults {
* @return string
* @since 6.0.0
*/
public function getSlogan() {
return $this->defaults->getSlogan();
public function getSlogan(?string $lang = null) {
return $this->defaults->getSlogan($lang);
}
/**

3
lib/public/Mail/IEMailTemplate.php
View file

@ -140,10 +140,11 @@ interface IEMailTemplate {
* Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
*
* @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
* @param string $lang Optional language to set the default footer in
*
* @since 12.0.0
*/
public function addFooter(string $text = '');
public function addFooter(string $text = '', ?string $lang = null);
/**
* Returns the rendered email subject as string

9
tests/lib/Mail/EMailTemplateTest.php
View file

@ -27,6 +27,7 @@ use OC\Mail\EMailTemplate;
use OCP\Defaults;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;
use Test\TestCase;
class EMailTemplateTest extends TestCase {
@ -34,7 +35,7 @@ class EMailTemplateTest extends TestCase {
private $defaults;
/** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */
private $urlGenerator;
/** @var IL10N|\PHPUnit_Framework_MockObject_MockObject */
/** @var IFactory|\PHPUnit_Framework_MockObject_MockObject */
private $l10n;
/** @var EMailTemplate */
private $emailTemplate;
@ -44,7 +45,11 @@ class EMailTemplateTest extends TestCase {
$this->defaults = $this->createMock(Defaults::class);
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->l10n = $this->createMock(IL10N::class);
$this->l10n = $this->createMock(IFactory::class);
$this->l10n->method('get')
->with('lib', '')
->willReturn($this->createMock(IL10N::class));
$this->emailTemplate = new EMailTemplate(
$this->defaults,

6
tests/lib/Mail/MailerTest.php
View file

@ -15,6 +15,7 @@ use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;
use Test\TestCase;
class MailerTest extends TestCase {
@ -44,7 +45,8 @@ class MailerTest extends TestCase {
$this->logger,
$this->defaults,
$this->urlGenerator,
$this->l10n
$this->l10n,
$this->createMock(IFactory::class)
);
}
@ -126,7 +128,7 @@ class MailerTest extends TestCase {
$this->assertInstanceOf('\OC\Mail\Message', $this->mailer->createMessage());
}
public function testSendInvalidMailException() {
$this->expectException(\Exception::class);