feat: cancel signature request notification

appinfo/info.xml

@@ -82,13 +82,15 @@ Developed with ❤️ by [LibreCode](https://librecode.coop). Help us transform
 		<settings>
 			<setting>OCA\Libresign\Activity\Settings\FileToSign</setting>
 			<setting>OCA\Libresign\Activity\Settings\FileSigned</setting>
+			<setting>OCA\Libresign\Activity\Settings\SignRequestCanceled</setting>
 		</settings>
 		<filters>
 			<filter>OCA\Libresign\Activity\Filter</filter>
 		</filters>
 		<providers>
 			<provider>OCA\Libresign\Activity\Provider\SignRequest</provider>
 			<provider>OCA\Libresign\Activity\Provider\Signed</provider>
+			<provider>OCA\Libresign\Activity\Provider\SignRequestCanceled</provider>
 		</providers>
 	</activity>
 	<navigations>

lib/Activity/Listener.php

@@ -14,6 +14,7 @@
 use OCA\Libresign\Db\SignRequestMapper;
 use OCA\Libresign\Events\SendSignNotificationEvent;
 use OCA\Libresign\Events\SignedEvent;
+use OCA\Libresign\Events\SignRequestCanceledEvent;
 use OCA\Libresign\Service\AccountService;
 use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
 use OCP\Activity\Exceptions\UnknownActivityException;
@@ -43,7 +44,7 @@ public function __construct(
 
 	#[\Override]
 	public function handle(Event $event): void {
-		/** @var SendSignNotificationEvent|SignedEvent $event */
+		/** @var SendSignNotificationEvent|SignedEvent|SignRequestCanceledEvent $event */
 		match ($event::class) {
 			SendSignNotificationEvent::class => $this->generateNewSignNotificationActivity(
 				$event->getSignRequest(),
@@ -55,6 +56,11 @@ public function handle(Event $event): void {
 				$event->getLibreSignFile(),
 				$event->getIdentifyMethod(),
 			),
+			SignRequestCanceledEvent::class => $this->generateCanceledActivity(
+				$event->getSignRequest(),
+				$event->getLibreSignFile(),
+				$event->getIdentifyMethod(),
+			),
 		};
 	}
 
@@ -167,6 +173,51 @@ protected function generateSignedEventActivity(
 		}
 	}
 
+	protected function generateCanceledActivity(
+		SignRequest $signRequest,
+		FileEntity $libreSignFile,
+		IIdentifyMethod $identifyMethod,
+	): void {
+		$actor = $this->userSession->getUser();
+		if (!$actor instanceof IUser) {
+			return;
+		}
+		$actorId = $actor->getUID();
+
+		$event = $this->activityManager->generateEvent();
+		try {
+			$event
+				->setApp(Application::APP_ID)
+				->setType(SignRequestCanceledEvent::SIGN_REQUEST_CANCELED)
+				->setAuthor($actorId)
+				->setObject('signRequest', $signRequest->getId())
+				->setTimestamp($this->timeFactory->getTime())
+				->setAffectedUser($identifyMethod->getEntity()->getIdentifierValue())
+				->setGenerateNotification(false);
+
+			$event->setSubject('sign_request_canceled', [
+				'from' => $this->getUserParameter(
+					$actor->getUID(),
+					$actor->getDisplayName(),
+				),
+				'file' => $this->getFileParameter($signRequest, $libreSignFile),
+				'signer' => $this->getUserParameter(
+					$identifyMethod->getEntity()->getIdentifierValue(),
+					$signRequest->getDisplayName(),
+				),
+				'signRequest' => [
+					'type' => 'sign-request',
+					'id' => (string)$signRequest->getId(),
+					'name' => $actor->getDisplayName(),
+				],
+			]);
+			$this->activityManager->publish($event);
+		} catch (UnknownActivityException $e) {
+			$this->logger->error($e->getMessage(), ['exception' => $e]);
+			return;
+		}
+	}
+
 	/**
 	 * @return array{type: 'file', id: string, name: string, path: string, link: string}
 	 */

lib/Activity/Provider/SignRequestCanceled.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Libresign\Activity\Provider;
+
+use OCA\Libresign\AppInfo\Application;
+use OCP\Activity\Exceptions\UnknownActivityException;
+use OCP\Activity\IEvent;
+use OCP\Activity\IManager;
+use OCP\Activity\IProvider;
+use OCP\IURLGenerator;
+use OCP\IUserManager;
+use OCP\L10N\IFactory;
+use OCP\RichObjectStrings\Definitions;
+
+class SignRequestCanceled implements IProvider {
+	public function __construct(
+		protected IFactory $languageFactory,
+		protected IURLGenerator $url,
+		protected Definitions $definitions,
+		protected IManager $activityManager,
+		protected IUserManager $userManager,
+	) {
+	}
+
+	#[\Override]
+	public function parse($language, IEvent $event, ?IEvent $previousEvent = null): IEvent {
+		if ($event->getApp() !== Application::APP_ID) {
+			throw new UnknownActivityException('app');
+		}
+
+		if ($event->getSubject() !== 'sign_request_canceled') {
+			throw new UnknownActivityException('subject');
+		}
+
+		$this->definitions->definitions['sign-request'] = [
+			'author' => 'LibreSign',
+			'since' => '28.0.0',
+			'parameters' => [
+				'id' => [
+					'since' => '28.0.0',
+					'required' => true,
+					'description' => 'The id of SignRequest object',
+					'example' => '12345',
+				],
+				'name' => [
+					'since' => '28.0.0',
+					'required' => true,
+					'description' => 'The display name of signer',
+					'example' => 'John Doe',
+				],
+			],
+		];
+
+		if ($this->activityManager->getRequirePNG()) {
+			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath(Application::APP_ID, 'app-dark.png')));
+		} else {
+			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath(Application::APP_ID, 'app-dark.svg')));
+		}
+
+		$l = $this->languageFactory->get(Application::APP_ID, $language);
+		$parameters = $event->getSubjectParameters();
+
+		$subject = $l->t('{from} canceled the signature request for {file}');
+		$event->setParsedSubject(
+			str_replace(
+				['{from}', '{file}'],
+				[
+					$parameters['from']['name'],
+					$parameters['file']['name'],
+				],
+				$subject
+			))
+			->setRichSubject($subject, $parameters);
+
+		return $event;
+	}
+}

lib/Activity/Settings/SignRequestCanceled.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Libresign\Activity\Settings;
+
+use OCA\Libresign\Events\SignRequestCanceledEvent;
+use OCA\Libresign\Helper\ValidateHelper;
+use OCP\IL10N;
+use OCP\IUserSession;
+
+class SignRequestCanceled extends LibresignActivitySettings {
+	public function __construct(
+		protected IL10N $l,
+		protected ValidateHelper $validateHelper,
+		protected IUserSession $userSession,
+	) {
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	#[\Override]
+	public function getIdentifier(): string {
+		return SignRequestCanceledEvent::SIGN_REQUEST_CANCELED;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	#[\Override]
+	public function getName(): string {
+		return $this->l->t('A signature request has been <strong>canceled</strong>');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	#[\Override]
+	public function getPriority(): int {
+		return 51;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	#[\Override]
+	public function canChangeNotification(): bool {
+		return true;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	#[\Override]
+	public function canChangeMail() {
+		return true;
+	}
+}

lib/AppInfo/Application.php

@@ -14,6 +14,7 @@
 use OCA\Libresign\Capabilities;
 use OCA\Libresign\Events\SendSignNotificationEvent;
 use OCA\Libresign\Events\SignedEvent;
+use OCA\Libresign\Events\SignRequestCanceledEvent;
 use OCA\Libresign\Files\TemplateLoader as FilesTemplateLoader;
 use OCA\Libresign\Listener\BeforeNodeDeletedListener;
 use OCA\Libresign\Listener\LoadAdditionalListener;
@@ -74,14 +75,17 @@ public function register(IRegistrationContext $context): void {
 		// Activity listeners
 		$context->registerEventListener(SendSignNotificationEvent::class, ActivityListener::class);
 		$context->registerEventListener(SignedEvent::class, ActivityListener::class);
+		$context->registerEventListener(SignRequestCanceledEvent::class, ActivityListener::class);
 
 		// Notification listeners
 		$context->registerEventListener(SendSignNotificationEvent::class, NotificationListener::class);
 		$context->registerEventListener(SignedEvent::class, NotificationListener::class);
+		$context->registerEventListener(SignRequestCanceledEvent::class, NotificationListener::class);
 
 		// MailNotify listener
 		$context->registerEventListener(SendSignNotificationEvent::class, MailNotifyListener::class);
 		$context->registerEventListener(SignedEvent::class, MailNotifyListener::class);
+		$context->registerEventListener(SignRequestCanceledEvent::class, MailNotifyListener::class);
 
 		// TwofactorGateway listener
 		$context->registerEventListener(SendSignNotificationEvent::class, TwofactorGatewayListener::class);

lib/Events/SignRequestCanceledEvent.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Libresign\Events;
+
+use OCA\Libresign\Db\File as FileEntity;
+use OCA\Libresign\Db\SignRequest;
+use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
+use OCP\EventDispatcher\Event;
+
+class SignRequestCanceledEvent extends Event {
+	public const SIGN_REQUEST_CANCELED = 'libresign_sign_request_canceled';
+
+	public function __construct(
+		private SignRequest $signRequest,
+		private FileEntity $libreSignFile,
+		private IIdentifyMethod $identifyMethod,
+	) {
+	}
+
+	public function getLibreSignFile(): FileEntity {
+		return $this->libreSignFile;
+	}
+
+	public function getSignRequest(): SignRequest {
+		return $this->signRequest;
+	}
+
+	public function getIdentifyMethod(): IIdentifyMethod {
+		return $this->identifyMethod;
+	}
+}

lib/Listener/MailNotifyListener.php

@@ -13,6 +13,7 @@
 use OCA\Libresign\Db\SignRequestMapper;
 use OCA\Libresign\Events\SendSignNotificationEvent;
 use OCA\Libresign\Events\SignedEvent;
+use OCA\Libresign\Events\SignRequestCanceledEvent;
 use OCA\Libresign\Service\IdentifyMethod\IdentifyService;
 use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
 use OCA\Libresign\Service\MailService;
@@ -37,7 +38,7 @@ public function __construct(
 
 	#[\Override]
 	public function handle(Event $event): void {
-		/** @var SendSignNotificationEvent|SignedEvent $event */
+		/** @var SendSignNotificationEvent|SignedEvent|SignRequestCanceledEvent $event */
 		match ($event::class) {
 			SendSignNotificationEvent::class => $this->sendSignMailNotification(
 				$event->getSignRequest(),
@@ -49,6 +50,11 @@ public function handle(Event $event): void {
 				$event->getLibreSignFile(),
 				$event->getUser(),
 			),
+			SignRequestCanceledEvent::class => $this->sendCanceledMailNotification(
+				$event->getSignRequest(),
+				$event->getIdentifyMethod(),
+				$event->getLibreSignFile(),
+			),
 		};
 	}
 
@@ -121,6 +127,47 @@ protected function sendSignedMailNotification(
 		}
 	}
 
+	protected function sendCanceledMailNotification(
+		SignRequest $signRequest,
+		IIdentifyMethod $identifyMethod,
+		FileEntity $libreSignFile,
+	): void {
+		try {
+			if ($identifyMethod->getEntity()->isDeletedAccount()) {
+				return;
+			}
+
+			$email = '';
+			if ($identifyMethod->getName() === 'account') {
+				$userId = $identifyMethod->getEntity()->getIdentifierValue();
+				$user = $this->userManager->get($userId);
+				if ($user) {
+					$email = $user->getEMailAddress();
+				}
+			} elseif ($identifyMethod->getName() === 'email') {
+				$email = $identifyMethod->getEntity()->getIdentifierValue();
+			}
+
+			if (empty($email)) {
+				return;
+			}
+
+			$users = $this->userManager->getByEmail($email);
+			if (count($users) === 1) {
+				$userId = $users[0]->getUID();
+				if ($this->isNotificationDisabledAtActivity($userId, SignRequestCanceledEvent::SIGN_REQUEST_CANCELED)) {
+					return;
+				}
+			}
+
+			$this->mail->notifyCanceledRequest($signRequest, $email, $libreSignFile);
+
+		} catch (\InvalidArgumentException $e) {
+			$this->logger->error($e->getMessage(), ['exception' => $e]);
+			return;
+		}
+	}
+
 	private function isNotificationDisabledAtActivity(string $userId, string $type): bool {
 		if (!class_exists(\OCA\Activity\UserSettings::class)) {
 			return false;