Skip to content

Fix language in share notes email for users #21535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blizzz merged 1 commit into from
Jun 23, 2020
Merged

Fix language in share notes email for users #21535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 33 additions & 26 deletions lib/private/Share20/DefaultShareProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,13 @@
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Mail\IMailer;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IShare;
Expand Down Expand Up @@ -82,41 +83,34 @@ class DefaultShareProvider implements IShareProvider {
/** @var Defaults */
private $defaults;

/** @var IL10N */
private $l;
/** @var IFactory */
private $l10nFactory;

/** @var IURLGenerator */
private $urlGenerator;

/**
* DefaultShareProvider constructor.
*
* @param IDBConnection $connection
* @param IUserManager $userManager
* @param IGroupManager $groupManager
* @param IRootFolder $rootFolder
* @param IMailer $mailer ;
* @param Defaults $defaults
* @param IL10N $l
* @param IURLGenerator $urlGenerator
*/
/** @var IConfig */
private $config;

public function __construct(
IDBConnection $connection,
IUserManager $userManager,
IGroupManager $groupManager,
IRootFolder $rootFolder,
IMailer $mailer,
Defaults $defaults,
IL10N $l,
IURLGenerator $urlGenerator) {
IFactory $l10nFactory,
IURLGenerator $urlGenerator,
IConfig $config) {
$this->dbConn = $connection;
$this->userManager = $userManager;
$this->groupManager = $groupManager;
$this->rootFolder = $rootFolder;
$this->mailer = $mailer;
$this->defaults = $defaults;
$this->l = $l;
$this->l10nFactory = $l10nFactory;
$this->urlGenerator = $urlGenerator;
$this->config = $config;
}

/**
Expand Down Expand Up @@ -1401,45 +1395,58 @@ private function propagateNote(IShare $share) {
* @throws \OCP\Files\NotFoundException
*/
private function sendNote(array $recipients, IShare $share) {
$toList = [];
$toListByLanguage = [];

foreach ($recipients as $recipient) {
/** @var IUser $recipient */
$email = $recipient->getEMailAddress();
if ($email) {
$toList[$email] = $recipient->getDisplayName();
$language = $this->config->getSystemValue('force_language', false);
$language = \is_string($language) ? $language : $this->config->getUserValue($recipient->getUID(), 'core', 'lang', null);
$language = $language ?? $this->config->getSystemValue('default_language', 'en');

if (!isset($toListByLanguage[$language])) {
$toListByLanguage[$language] = [];
}
$toListByLanguage[$language][$email] = $recipient->getDisplayName();
}
}

if (!empty($toList)) {
if (empty($toListByLanguage)) {
return;
}

foreach ($toListByLanguage as $l10n => $toList) {
$filename = $share->getNode()->getName();
$initiator = $share->getSharedBy();
$note = $share->getNote();

$l = $this->l10nFactory->get('lib', $l10n);

$initiatorUser = $this->userManager->get($initiator);
$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
$initiatorEmailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
$plainHeading = $this->l->t('%1$s shared »%2$s« with you and wants to add:', [$initiatorDisplayName, $filename]);
$htmlHeading = $this->l->t('%1$s shared »%2$s« with you and wants to add', [$initiatorDisplayName, $filename]);
$plainHeading = $l->t('%1$s shared »%2$s« with you and wants to add:', [$initiatorDisplayName, $filename]);
$htmlHeading = $l->t('%1$s shared »%2$s« with you and wants to add', [$initiatorDisplayName, $filename]);
$message = $this->mailer->createMessage();

$emailTemplate = $this->mailer->createEMailTemplate('defaultShareProvider.sendNote');

$emailTemplate->setSubject($this->l->t('»%s« added a note to a file shared with you', [$initiatorDisplayName]));
$emailTemplate->setSubject($l->t('»%s« added a note to a file shared with you', [$initiatorDisplayName]));
$emailTemplate->addHeader();
$emailTemplate->addHeading($htmlHeading, $plainHeading);
$emailTemplate->addBodyText(htmlspecialchars($note), $note);

$link = $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $share->getNode()->getId()]);
$emailTemplate->addBodyButton(
$this->l->t('Open »%s«', [$filename]),
$l->t('Open »%s«', [$filename]),
$link
);


// The "From" contains the sharers name
$instanceName = $this->defaults->getName();
$senderName = $this->l->t(
$senderName = $l->t(
'%1$s via %2$s',
[
$initiatorDisplayName,
Expand Down
5 changes: 3 additions & 2 deletions lib/private/Share20/ProviderFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,9 @@ protected function defaultShareProvider() {
$this->serverContainer->getLazyRootFolder(),
$this->serverContainer->getMailer(),
$this->serverContainer->query(Defaults::class),
$this->serverContainer->getL10N('sharing'),
$this->serverContainer->getURLGenerator()
$this->serverContainer->getL10NFactory(),
$this->serverContainer->getURLGenerator(),
$this->serverContainer->getConfig()
);
}

Expand Down
41 changes: 29 additions & 12 deletions tests/lib/Share20/DefaultShareProviderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,18 @@
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IGroup;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Mail\IMailer;
use OCP\Share\IShare;
use PHPUnit\Framework\MockObject\MockObject;

/**
* Class DefaultShareProviderTest
Expand Down Expand Up @@ -64,6 +67,9 @@ class DefaultShareProviderTest extends \Test\TestCase {
/** @var \PHPUnit_Framework_MockObject_MockObject|IMailer */
protected $mailer;

/** @var IFactory|MockObject */
protected $l10nFactory;

/** @var \PHPUnit_Framework_MockObject_MockObject|IL10N */
protected $l10n;

Expand All @@ -73,15 +79,20 @@ class DefaultShareProviderTest extends \Test\TestCase {
/** @var \PHPUnit_Framework_MockObject_MockObject|IURLGenerator */
protected $urlGenerator;

/** @var IConfig|MockObject */
protected $config;

protected function setUp(): void {
$this->dbConn = \OC::$server->getDatabaseConnection();
$this->userManager = $this->createMock(IUserManager::class);
$this->groupManager = $this->createMock(IGroupManager::class);
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->mailer = $this->createMock(IMailer::class);
$this->l10nFactory = $this->createMock(IFactory::class);
$this->l10n = $this->createMock(IL10N::class);
$this->defaults = $this->getMockBuilder(Defaults::class)->disableOriginalConstructor()->getMock();
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->config = $this->createMock(IConfig::class);

$this->userManager->expects($this->any())->method('userExists')->willReturn(true);

Expand All @@ -95,8 +106,9 @@ protected function setUp(): void {
$this->rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
);
}

Expand Down Expand Up @@ -454,8 +466,9 @@ public function testDeleteSingleShare() {
$this->rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
])
->setMethods(['getShareById'])
->getMock();
Expand Down Expand Up @@ -548,8 +561,9 @@ public function testDeleteGroupShareWithUserGroupShares() {
$this->rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
])
->setMethods(['getShareById'])
->getMock();
Expand Down Expand Up @@ -2474,8 +2488,9 @@ public function testGetSharesInFolder() {
$rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
);

$password = md5(time());
Expand Down Expand Up @@ -2571,8 +2586,9 @@ public function testGetAccessListNoCurrentAccessRequired() {
$rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
);

$u1 = $userManager->createUser('testShare1', 'test');
Expand Down Expand Up @@ -2666,8 +2682,9 @@ public function testGetAccessListCurrentAccessRequired() {
$rootFolder,
$this->mailer,
$this->defaults,
$this->l10n,
$this->urlGenerator
$this->l10nFactory,
$this->urlGenerator,
$this->config
);

$u1 = $userManager->createUser('testShare1', 'test');
Expand Down