allow to add a personal note to a share

Signed-off-by: Bjoern Schiessle <bjoern@schiessle.org>

2 files changed, 71 insertions, 3 deletions

diff --git a/apps/files_sharing/lib/Controller/ShareAPIController.php b/apps/files_sharing/lib/Controller/ShareAPIController.php
index d30d5a05a22..816ecde9c40 100644
--- a/apps/files_sharing/lib/Controller/ShareAPIController.php
+++ b/apps/files_sharing/lib/Controller/ShareAPIController.php
@@ -698,17 +698,21 @@ class ShareAPIController extends OCSController {
 	 * @param string $password
 	 * @param string $publicUpload
 	 * @param string $expireDate
+	 * @param string $note
 	 * @return DataResponse
-	 * @throws OCSNotFoundException
+	 * @throws LockedException
+	 * @throws NotFoundException
 	 * @throws OCSBadRequestException
 	 * @throws OCSForbiddenException
+	 * @throws OCSNotFoundException
 	 */
 	public function updateShare(
 		string $id,
 		int $permissions = null,
 		string $password = null,
 		string $publicUpload = null,
-		string $expireDate = null
+		string $expireDate = null,
+		string $note = null
 	): DataResponse {
 		try {
 			$share = $this->getShareById($id);
@@ -722,10 +726,14 @@ class ShareAPIController extends OCSController {
 			throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
 		}
 
-		if ($permissions === null && $password === null && $publicUpload === null && $expireDate === null) {
+		if ($permissions === null && $password === null && $publicUpload === null && $expireDate === null && $note === null) {
 			throw new OCSBadRequestException($this->l->t('Wrong or no update parameter given'));
 		}
 
+		if($note !== null) {
+			$share->setNote($note);
+		}
+
 		/*
 		 * expirationdate, password and publicUpload only make sense for link shares
 		 */
diff --git a/apps/sharebymail/lib/ShareByMailProvider.php b/apps/sharebymail/lib/ShareByMailProvider.php
index 1a1855b9c44..bf251c627a0 100644
--- a/apps/sharebymail/lib/ShareByMailProvider.php
+++ b/apps/sharebymail/lib/ShareByMailProvider.php
@@ -506,6 +506,61 @@ class ShareByMailProvider implements IShareProvider {
 		return true;
 	}
 
+	protected function sendNote(IShare $share) {
+
+		$recipient = $share->getSharedWith();
+
+
+		$filename = $share->getNode()->getName();
+		$initiator = $share->getSharedBy();
+		$note = $share->getNote();
+
+		$initiatorUser = $this->userManager->get($initiator);
+		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+		$initiatorEmailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
+
+		$plainBodyPart = $this->l->t("%s shared »%s« with you and want to add:\n", [$initiatorDisplayName, $filename]);
+		$htmlBodyPart = $this->l->t('%s shared »%s« with you and want to add:', [$initiatorDisplayName, $filename]);
+
+		$message = $this->mailer->createMessage();
+
+		$emailTemplate = $this->mailer->createEMailTemplate('shareByMail.sendNote', [
+			'filename' => $filename,
+			'note' => $note,
+			'initiator' => $initiatorDisplayName,
+			'initiatorEmail' => $initiatorEmailAddress,
+			'shareWith' => $recipient,
+		]);
+
+		$emailTemplate->setSubject($this->l->t('»%s« added a note to a file shared with you', [$initiatorDisplayName]));
+		$emailTemplate->addHeader();
+		$emailTemplate->addHeading($this->l->t('Note regarding »%s«', [$filename]), false);
+		$emailTemplate->addBodyText(htmlspecialchars($htmlBodyPart), $plainBodyPart);
+		$emailTemplate->addBodyText($note);
+
+		// The "From" contains the sharers name
+		$instanceName = $this->defaults->getName();
+		$senderName = $this->l->t(
+			'%s via %s',
+			[
+				$initiatorDisplayName,
+				$instanceName
+			]
+		);
+		$message->setFrom([\OCP\Util::getDefaultEmailAddress($instanceName) => $senderName]);
+		if ($initiatorEmailAddress !== null) {
+			$message->setReplyTo([$initiatorEmailAddress => $initiatorDisplayName]);
+			$emailTemplate->addFooter($instanceName . ' - ' . $this->defaults->getSlogan());
+		} else {
+			$emailTemplate->addFooter();
+		}
+
+		$message->setTo([$recipient]);
+		$message->useTemplate($emailTemplate);
+		$this->mailer->send($message);
+
+	}
+
 	/**
 	 * send auto generated password to the owner. This happens if the admin enforces
 	 * a password for mail shares and forbid to send the password by mail to the recipient
@@ -662,8 +717,13 @@ class ShareByMailProvider implements IShareProvider {
 			->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy()))
 			->set('password', $qb->createNamedParameter($share->getPassword()))
 			->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE))
+			->set('note', $qb->createNamedParameter($share->getNote()))
 			->execute();
 
+		if ($originalShare->getNote() !== $share->getNote() && $share->getNote() !== '') {
+			$this->sendNote($share);
+		}
+
 		return $share;
 	}