20083390077

Committed 10 Dec 2025 12:46AM UTC coverage: 43.838%. First build

Build # 20083390077

Build Type

Pull #6069

github

Committed by

web-flow

Commit Message

Merge 20c802121 into c646f673a

Pull Request Pull Request #6069: feat: sequential signing

Run Details

39 of 121 new or added lines in 7 files covered. (32.23%)

5727 of 13064 relevant lines covered (43.84%)

5.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.57

/lib/Service/RequestSignatureService.php

<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Libresign\Service;

use OCA\Libresign\Db\File as FileEntity;
use OCA\Libresign\Db\FileElementMapper;
use OCA\Libresign\Db\FileMapper;
use OCA\Libresign\Db\IdentifyMethodMapper;
use OCA\Libresign\Db\SignRequest as SignRequestEntity;
use OCA\Libresign\Db\SignRequestMapper;
use OCA\Libresign\Handler\DocMdpHandler;
use OCA\Libresign\Helper\ValidateHelper;
use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\Files\IMimeTypeDetector;
use OCP\Files\Node;
use OCP\Http\Client\IClientService;
use OCP\IL10N;
use OCP\IUser;
use OCP\IUserManager;
use Psr\Log\LoggerInterface;
use Sabre\DAV\UUIDUtil;

class RequestSignatureService {
        use TFile;

        public function __construct(
                protected IL10N $l10n,
                protected IdentifyMethodService $identifyMethod,
                protected SignRequestMapper $signRequestMapper,
                protected IUserManager $userManager,
                protected FileMapper $fileMapper,
                protected IdentifyMethodMapper $identifyMethodMapper,
                protected PdfParserService $pdfParserService,
                protected FileElementService $fileElementService,
                protected FileElementMapper $fileElementMapper,
                protected FolderService $folderService,
                protected IMimeTypeDetector $mimeTypeDetector,
                protected ValidateHelper $validateHelper,
                protected IClientService $client,
                protected DocMdpHandler $docMdpHandler,
                protected LoggerInterface $logger,
                protected SequentialSigningService $sequentialSigningService,
        ) {
        }

        public function save(array $data): FileEntity {
                $file = $this->saveFile($data);
                $this->saveVisibleElements($data, $file);
                if (empty($data['status'])) {
                        $data['status'] = $file->getStatus();
                }
                $this->associateToSigners($data, $file->getId());
                return $file;
        }

        /**
         * Save file data
         *
         * @param array{?userManager: IUser, ?signRequest: SignRequest, name: string, callback: string, uuid?: ?string, status: int, file?: array{fileId?: int, fileNode?: Node}} $data
         */
        public function saveFile(array $data): FileEntity {
                if (!empty($data['uuid'])) {
                        $file = $this->fileMapper->getByUuid($data['uuid']);
                        return $this->updateStatus($file, $data['status'] ?? 0);
                }
                $fileId = null;
                if (isset($data['file']['fileNode']) && $data['file']['fileNode'] instanceof Node) {
                        $fileId = $data['file']['fileNode']->getId();
                } elseif (!empty($data['file']['fileId'])) {
                        $fileId = $data['file']['fileId'];
                }
                if (!is_null($fileId)) {
                        try {
                                $file = $this->fileMapper->getByFileId($fileId);
                                return $this->updateStatus($file, $data['status'] ?? 0);
                        } catch (\Throwable) {
                        }
                }

                $node = $this->getNodeFromData($data);

                $file = new FileEntity();
                $file->setNodeId($node->getId());
                if ($data['userManager'] instanceof IUser) {
                        $file->setUserId($data['userManager']->getUID());
                } elseif ($data['signRequest'] instanceof SignRequestEntity) {
                        $file->setSignRequestId($data['signRequest']->getId());
                }
                $file->setUuid(UUIDUtil::getUUID());
                $file->setCreatedAt(new \DateTime('now', new \DateTimeZone('UTC')));
                $metadata = $this->getFileMetadata($node);
                $file->setName($this->removeExtensionFromName($data['name'], $metadata));
                $file->setMetadata($metadata);
                if (!empty($data['callback'])) {
                        $file->setCallback($data['callback']);
                }
                if (isset($data['status'])) {
                        $file->setStatus($data['status']);
                } else {
                        $file->setStatus(FileEntity::STATUS_ABLE_TO_SIGN);
                }
                $this->fileMapper->insert($file);
                return $file;
        }

        private function updateStatus(FileEntity $file, int $status): FileEntity {
                if ($status > $file->getStatus()) {
                        $file->setStatus($status);
                        /** @var FileEntity */
                        return $this->fileMapper->update($file);
                }
                return $file;
        }

        private function getFileMetadata(\OCP\Files\Node $node): array {
                $metadata = [];
                if ($extension = strtolower($node->getExtension())) {
                        $metadata = [
                                'extension' => $extension,
                        ];
                        if ($metadata['extension'] === 'pdf') {
                                $metadata = array_merge(
                                        $metadata,
                                        $this->pdfParserService
                                                ->setFile($node)
                                                ->getPageDimensions()
                                );
                        }
                }
                return $metadata;
        }

        private function removeExtensionFromName(string $name, array $metadata): string {
                if (!isset($metadata['extension'])) {
                        return $name;
                }
                $extensionPattern = '/\.' . preg_quote($metadata['extension'], '/') . '$/i';
                $result = preg_replace($extensionPattern, '', $name);
                return $result ?? $name;
        }

        private function deleteIdentifyMethodIfNotExits(array $users, int $fileId): void {
                $file = $this->fileMapper->getById($fileId);
                $signRequests = $this->signRequestMapper->getByFileId($fileId);
                foreach ($signRequests as $key => $signRequest) {
                        $identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequest->getId());
                        if (empty($identifyMethods)) {
                                $this->unassociateToUser($file->getNodeId(), $signRequest->getId());
                                continue;
                        }
                        foreach ($identifyMethods as $methodName => $list) {
                                foreach ($list as $method) {
                                        $exists[$key]['identify'][$methodName] = $method->getEntity()->getIdentifierValue();
                                        if (!$this->identifyMethodExists($users, $method)) {
                                                $this->unassociateToUser($file->getNodeId(), $signRequest->getId());
                                                continue 3;
                                        }
                                }
                        }
                }
        }

        private function identifyMethodExists(array $users, IIdentifyMethod $identifyMethod): bool {
                foreach ($users as $user) {
                        if (!empty($user['identifyMethods'])) {
                                foreach ($user['identifyMethods'] as $data) {
                                        if ($identifyMethod->getEntity()->getIdentifierKey() !== $data['method']) {
                                                continue;
                                        }
                                        if ($identifyMethod->getEntity()->getIdentifierValue() === $data['value']) {
                                                return true;
                                        }
                                }
                        } else {
                                foreach ($user['identify'] as $method => $value) {
                                        if ($identifyMethod->getEntity()->getIdentifierKey() !== $method) {
                                                continue;
                                        }
                                        if ($identifyMethod->getEntity()->getIdentifierValue() === $value) {
                                                return true;
                                        }
                                }
                        }
                }
                return false;
        }

        /**
         * @return SignRequestEntity[]
         *
         * @psalm-return list<SignRequestEntity>
         */
        private function associateToSigners(array $data, int $fileId): array {
                $return = [];
                if (!empty($data['users'])) {
                        $this->deleteIdentifyMethodIfNotExits($data['users'], $fileId);

                        $this->sequentialSigningService->resetOrderCounter();

                        foreach ($data['users'] as $user) {
                                $userProvidedOrder = isset($user['signingOrder']) ? (int)$user['signingOrder'] : null;
                                $signingOrder = $this->sequentialSigningService->determineSigningOrder($userProvidedOrder);

                                if (isset($user['identifyMethods'])) {
                                        foreach ($user['identifyMethods'] as $identifyMethod) {
                                                $return[] = $this->associateToSigner(
                                                        identifyMethods: [
                                                                $identifyMethod['method'] => $identifyMethod['value'],
                                                        ],
                                                        displayName: $user['displayName'] ?? '',
                                                        description: $user['description'] ?? '',
                                                        notify: empty($user['notify']) && $this->isStatusAbleToNotify($data['status'] ?? null),
                                                        fileId: $fileId,
                                                        signingOrder: $signingOrder,
                                                );
                                        }
                                } else {
                                        $return[] = $this->associateToSigner(
                                                identifyMethods: $user['identify'],
                                                displayName: $user['displayName'] ?? '',
                                                description: $user['description'] ?? '',
                                                notify: empty($user['notify']) && $this->isStatusAbleToNotify($data['status'] ?? null),
                                                fileId: $fileId,
                                                signingOrder: $signingOrder,
                                        );
                                }
                        }
                }
                return $return;
        }

        private function isStatusAbleToNotify(?int $status): bool {
                return in_array($status, [
                        FileEntity::STATUS_ABLE_TO_SIGN,
                        FileEntity::STATUS_PARTIAL_SIGNED,
                ]);
        }

        private function associateToSigner(
                array $identifyMethods,
                string $displayName,
                string $description,
                bool $notify,
                int $fileId,
                int $signingOrder = 0,
        ): SignRequestEntity {
                $identifyMethodsIncances = $this->identifyMethod->getByUserData($identifyMethods);
                if (empty($identifyMethodsIncances)) {
                        throw new \Exception($this->l10n->t('Invalid identification method'));
                }
                $signRequest = $this->getSignRequestByIdentifyMethod(
                        current($identifyMethodsIncances),
                        $fileId
                );
                $displayName = $this->getDisplayNameFromIdentifyMethodIfEmpty($identifyMethodsIncances, $displayName);
                $this->setDataToUser($signRequest, $displayName, $description, $fileId);

                $signRequest->setSigningOrder($signingOrder);

                if (!$signRequest->getId()) {
                        $initialStatus = $this->determineInitialStatus($signingOrder);
                        $signRequest->setStatusEnum($initialStatus);
                }

                $this->saveSignRequest($signRequest);
                foreach ($identifyMethodsIncances as $identifyMethod) {
                        $identifyMethod->getEntity()->setSignRequestId($signRequest->getId());
                        $identifyMethod->willNotifyUser($notify);
                        $identifyMethod->save();
                }
                return $signRequest;
        }

        private function determineInitialStatus(int $signingOrder): \OCA\Libresign\Db\SignRequestStatus {
                if (!$this->sequentialSigningService->isOrderedNumericFlow()) {
                        return \OCA\Libresign\Db\SignRequestStatus::ABLE_TO_SIGN;
                }

                return $signingOrder === 1
                        ? \OCA\Libresign\Db\SignRequestStatus::ABLE_TO_SIGN
                        : \OCA\Libresign\Db\SignRequestStatus::DRAFT;
        }

        /**
         * @param IIdentifyMethod[] $identifyMethodsIncances
         * @param string $displayName
         * @return string
         */
        private function getDisplayNameFromIdentifyMethodIfEmpty(array $identifyMethodsIncances, string $displayName): string {
                if (!empty($displayName)) {
                        return $displayName;
                }
                foreach ($identifyMethodsIncances as $identifyMethod) {
                        if ($identifyMethod->getName() === 'account') {
                                return $this->userManager->get($identifyMethod->getEntity()->getIdentifierValue())->getDisplayName();
                        }
                }
                foreach ($identifyMethodsIncances as $identifyMethod) {
                        if ($identifyMethod->getName() !== 'account') {
                                return $identifyMethod->getEntity()->getIdentifierValue();
                        }
                }
                return '';
        }

        private function saveVisibleElements(array $data, FileEntity $file): array {
                if (empty($data['visibleElements'])) {
                        return [];
                }
                $elements = $data['visibleElements'];
                foreach ($elements as $key => $element) {
                        $element['fileId'] = $file->getId();
                        $elements[$key] = $this->fileElementService->saveVisibleElement($element);
                }
                return $elements;
        }

        public function validateNewRequestToFile(array $data): void {
                $this->validateNewFile($data);
                $this->validateUsers($data);
                $this->validateHelper->validateFileStatus($data);
        }

        public function validateNewFile(array $data): void {
                if (empty($data['name'])) {
                        throw new \Exception($this->l10n->t('Name is mandatory'));
                }
                $this->validateHelper->validateNewFile($data);
        }

        public function validateUsers(array $data): void {
                if (empty($data['users'])) {
                        throw new \Exception($this->l10n->t('Empty users list'));
                }
                if (!is_array($data['users'])) {
                        // TRANSLATION This message will be displayed when the request to API with the key users has a value that is not an array
                        throw new \Exception($this->l10n->t('User list needs to be an array'));
                }
                foreach ($data['users'] as $user) {
                        if (!array_key_exists('identify', $user)) {
                                throw new \Exception('Identify key not found');
                        }
                        $this->identifyMethod->setAllEntityData($user);
                }
        }

        public function saveSignRequest(SignRequestEntity $signRequest): void {
                if ($signRequest->getId()) {
                        $this->signRequestMapper->update($signRequest);
                } else {
                        $this->signRequestMapper->insert($signRequest);
                }
        }

        /**
         * @psalm-suppress MixedMethodCall
         */
        private function setDataToUser(SignRequestEntity $signRequest, string $displayName, string $description, int $fileId): void {
                $signRequest->setFileId($fileId);
                if (!$signRequest->getUuid()) {
                        $signRequest->setUuid(UUIDUtil::getUUID());
                }
                if (!empty($displayName)) {
                        $signRequest->setDisplayName($displayName);
                }
                if (!empty($description)) {
                        $signRequest->setDescription($description);
                }
                if (!$signRequest->getId()) {
                        $signRequest->setCreatedAt(new \DateTime('now', new \DateTimeZone('UTC')));
                }
        }

        private function getSignRequestByIdentifyMethod(IIdentifyMethod $identifyMethod, int $fileId): SignRequestEntity {
                try {
                        $signRequest = $this->signRequestMapper->getByIdentifyMethodAndFileId($identifyMethod, $fileId);
                } catch (DoesNotExistException) {
                        $signRequest = new SignRequestEntity();
                }
                return $signRequest;
        }

        public function unassociateToUser(int $fileId, int $signRequestId): void {
                $signRequest = $this->signRequestMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);
                $deletedOrder = $signRequest->getSigningOrder();

                try {
                        $this->signRequestMapper->delete($signRequest);
                        $groupedIdentifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequestId);
                        foreach ($groupedIdentifyMethods as $identifyMethods) {
                                foreach ($identifyMethods as $identifyMethod) {
                                        $identifyMethod->delete();
                                }
                        }
                        $visibleElements = $this->fileElementMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);
                        foreach ($visibleElements as $visibleElement) {
                                $this->fileElementMapper->delete($visibleElement);
                        }

                        $this->sequentialSigningService->reorderAfterDeletion($fileId, $deletedOrder);
                } catch (\Throwable) {
                }
        }

        public function deleteRequestSignature(array $data): void {
                if (!empty($data['uuid'])) {
                        $signatures = $this->signRequestMapper->getByFileUuid($data['uuid']);
                        $fileData = $this->fileMapper->getByUuid($data['uuid']);
                } elseif (!empty($data['file']['fileId'])) {
                        $signatures = $this->signRequestMapper->getByNodeId($data['file']['fileId']);
                        $fileData = $this->fileMapper->getByFileId($data['file']['fileId']);
                } else {
                        throw new \Exception($this->l10n->t('Please provide either UUID or File object'));
                }
                foreach ($signatures as $signRequest) {
                        $this->signRequestMapper->delete($signRequest);
                }
                $this->fileMapper->delete($fileData);
                $this->fileElementService->deleteVisibleElements($fileData->getId());
        }
}

1	<?php
2
3	declare(strict_types=1);
4	/**
5	* SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
6	* SPDX-License-Identifier: AGPL-3.0-or-later
7	*/
8
9	namespace OCA\Libresign\Service;
10
11	use OCA\Libresign\Db\File as FileEntity;
12	use OCA\Libresign\Db\FileElementMapper;
13	use OCA\Libresign\Db\FileMapper;
14	use OCA\Libresign\Db\IdentifyMethodMapper;
15	use OCA\Libresign\Db\SignRequest as SignRequestEntity;
16	use OCA\Libresign\Db\SignRequestMapper;
17	use OCA\Libresign\Handler\DocMdpHandler;
18	use OCA\Libresign\Helper\ValidateHelper;
19	use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
20	use OCP\AppFramework\Db\DoesNotExistException;
21	use OCP\Files\IMimeTypeDetector;
22	use OCP\Files\Node;
23	use OCP\Http\Client\IClientService;
24	use OCP\IL10N;
25	use OCP\IUser;
26	use OCP\IUserManager;
27	use Psr\Log\LoggerInterface;
28	use Sabre\DAV\UUIDUtil;
29
30	class RequestSignatureService {
31	use TFile;
32
33	public function __construct(
34	protected IL10N $l10n,
35	protected IdentifyMethodService $identifyMethod,
36	protected SignRequestMapper $signRequestMapper,
37	protected IUserManager $userManager,
38	protected FileMapper $fileMapper,
39	protected IdentifyMethodMapper $identifyMethodMapper,
40	protected PdfParserService $pdfParserService,
41	protected FileElementService $fileElementService,
42	protected FileElementMapper $fileElementMapper,
43	protected FolderService $folderService,
44	protected IMimeTypeDetector $mimeTypeDetector,
45	protected ValidateHelper $validateHelper,
46	protected IClientService $client,
47	protected DocMdpHandler $docMdpHandler,
48	protected LoggerInterface $logger,
49	protected SequentialSigningService $sequentialSigningService,
50	) {
51	}	54✔
52
53	public function save(array $data): FileEntity {
54	$file = $this->saveFile($data);	14✔
55	$this->saveVisibleElements($data, $file);	14✔
56	if (empty($data['status'])) {	14✔
57	$data['status'] = $file->getStatus();	13✔
58	}
59	$this->associateToSigners($data, $file->getId());	14✔
60	return $file;	14✔
61	}
62
63	/**
64	* Save file data
65	*
66	* @param array{?userManager: IUser, ?signRequest: SignRequest, name: string, callback: string, uuid?: ?string, status: int, file?: array{fileId?: int, fileNode?: Node}} $data
67	*/
68	public function saveFile(array $data): FileEntity {
69	if (!empty($data['uuid'])) {	15✔
70	$file = $this->fileMapper->getByUuid($data['uuid']);	1✔
71	return $this->updateStatus($file, $data['status'] ?? 0);	1✔
72	}
73	$fileId = null;	15✔
74	if (isset($data['file']['fileNode']) && $data['file']['fileNode'] instanceof Node) {	15✔
75	$fileId = $data['file']['fileNode']->getId();	1✔
76	} elseif (!empty($data['file']['fileId'])) {	14✔
77	$fileId = $data['file']['fileId'];	×
78	}
79	if (!is_null($fileId)) {	15✔
80	try {
81	$file = $this->fileMapper->getByFileId($fileId);	1✔
82	return $this->updateStatus($file, $data['status'] ?? 0);	×
83	} catch (\Throwable) {	1✔
84	}
85	}
86
87	$node = $this->getNodeFromData($data);	15✔
88
89	$file = new FileEntity();	15✔
90	$file->setNodeId($node->getId());	15✔
91	if ($data['userManager'] instanceof IUser) {	15✔
92	$file->setUserId($data['userManager']->getUID());	15✔
93	} elseif ($data['signRequest'] instanceof SignRequestEntity) {	×
94	$file->setSignRequestId($data['signRequest']->getId());	×
95	}
96	$file->setUuid(UUIDUtil::getUUID());	15✔
97	$file->setCreatedAt(new \DateTime('now', new \DateTimeZone('UTC')));	15✔
98	$metadata = $this->getFileMetadata($node);	15✔
99	$file->setName($this->removeExtensionFromName($data['name'], $metadata));	15✔
100	$file->setMetadata($metadata);	15✔
101	if (!empty($data['callback'])) {	15✔
102	$file->setCallback($data['callback']);	×
103	}
104	if (isset($data['status'])) {	15✔
105	$file->setStatus($data['status']);	2✔
106	} else {
107	$file->setStatus(FileEntity::STATUS_ABLE_TO_SIGN);	13✔
108	}
109	$this->fileMapper->insert($file);	15✔
110	return $file;	15✔
111	}
112
113	private function updateStatus(FileEntity $file, int $status): FileEntity {
114	if ($status > $file->getStatus()) {	1✔
115	$file->setStatus($status);	×
116	/** @var FileEntity */
117	return $this->fileMapper->update($file);	×
118	}
119	return $file;	1✔
120	}
121
122	private function getFileMetadata(\OCP\Files\Node $node): array {
123	$metadata = [];	18✔
124	if ($extension = strtolower($node->getExtension())) {	18✔
125	$metadata = [	17✔
126	'extension' => $extension,	17✔
127	];	17✔
128	if ($metadata['extension'] === 'pdf') {	17✔
129	$metadata = array_merge(	16✔
130	$metadata,	16✔
131	$this->pdfParserService	16✔
132	->setFile($node)	16✔
133	->getPageDimensions()	16✔
134	);	16✔
135	}
136	}
137	return $metadata;	18✔
138	}
139
140	private function removeExtensionFromName(string $name, array $metadata): string {
141	if (!isset($metadata['extension'])) {	15✔
142	return $name;	×
143	}
144	$extensionPattern = '/\.' . preg_quote($metadata['extension'], '/') . '$/i';	15✔
145	$result = preg_replace($extensionPattern, '', $name);	15✔
146	return $result ?? $name;	15✔
147	}
148
149	private function deleteIdentifyMethodIfNotExits(array $users, int $fileId): void {
150	$file = $this->fileMapper->getById($fileId);	13✔
151	$signRequests = $this->signRequestMapper->getByFileId($fileId);	13✔
152	foreach ($signRequests as $key => $signRequest) {	13✔
153	$identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequest->getId());	1✔
154	if (empty($identifyMethods)) {	1✔
155	$this->unassociateToUser($file->getNodeId(), $signRequest->getId());	×
156	continue;	×
157	}
158	foreach ($identifyMethods as $methodName => $list) {	1✔
159	foreach ($list as $method) {	1✔
160	$exists[$key]['identify'][$methodName] = $method->getEntity()->getIdentifierValue();	1✔
161	if (!$this->identifyMethodExists($users, $method)) {	1✔
162	$this->unassociateToUser($file->getNodeId(), $signRequest->getId());	1✔
163	continue 3;	1✔
164	}
165	}
166	}
167	}
168	}
169
170	private function identifyMethodExists(array $users, IIdentifyMethod $identifyMethod): bool {
171	foreach ($users as $user) {	1✔
172	if (!empty($user['identifyMethods'])) {	1✔
173	foreach ($user['identifyMethods'] as $data) {	×
174	if ($identifyMethod->getEntity()->getIdentifierKey() !== $data['method']) {	×
175	continue;	×
176	}
177	if ($identifyMethod->getEntity()->getIdentifierValue() === $data['value']) {	×
178	return true;	×
179	}
180	}
181	} else {
182	foreach ($user['identify'] as $method => $value) {	1✔
183	if ($identifyMethod->getEntity()->getIdentifierKey() !== $method) {	1✔
184	continue;	×
185	}
186	if ($identifyMethod->getEntity()->getIdentifierValue() === $value) {	1✔
187	return true;	×
188	}
189	}
190	}
191	}
192	return false;	1✔
193	}
194
195	/**
196	* @return SignRequestEntity[]
197	*
198	* @psalm-return list<SignRequestEntity>
199	*/
200	private function associateToSigners(array $data, int $fileId): array {
201	$return = [];	14✔
202	if (!empty($data['users'])) {	14✔
203	$this->deleteIdentifyMethodIfNotExits($data['users'], $fileId);	13✔
204
205	$this->sequentialSigningService->resetOrderCounter();	13✔
206
207	foreach ($data['users'] as $user) {	13✔
208	$userProvidedOrder = isset($user['signingOrder']) ? (int)$user['signingOrder'] : null;	13✔
209	$signingOrder = $this->sequentialSigningService->determineSigningOrder($userProvidedOrder);	13✔
210
211	if (isset($user['identifyMethods'])) {	13✔
212	foreach ($user['identifyMethods'] as $identifyMethod) {	×
213	$return[] = $this->associateToSigner(	×
214	identifyMethods: [	×
215	$identifyMethod['method'] => $identifyMethod['value'],	×
216	],	×
217	displayName: $user['displayName'] ?? '',	×
218	description: $user['description'] ?? '',	×
219	notify: empty($user['notify']) && $this->isStatusAbleToNotify($data['status'] ?? null),	×
220	fileId: $fileId,	×
NEW 221	signingOrder: $signingOrder,	×
222	);	×
223	}
224	} else {
225	$return[] = $this->associateToSigner(	13✔
226	identifyMethods: $user['identify'],	13✔
227	displayName: $user['displayName'] ?? '',	13✔
228	description: $user['description'] ?? '',	13✔
229	notify: empty($user['notify']) && $this->isStatusAbleToNotify($data['status'] ?? null),	13✔
230	fileId: $fileId,	13✔
231	signingOrder: $signingOrder,	13✔
232	);	13✔
233	}
234	}
235	}
236	return $return;	14✔
237	}
238
239	private function isStatusAbleToNotify(?int $status): bool {
240	return in_array($status, [	13✔
241	FileEntity::STATUS_ABLE_TO_SIGN,	13✔
242	FileEntity::STATUS_PARTIAL_SIGNED,	13✔
243	]);	13✔
244	}
245
246	private function associateToSigner(
247	array $identifyMethods,
248	string $displayName,
249	string $description,
250	bool $notify,
251	int $fileId,
252	int $signingOrder = 0,
253	): SignRequestEntity {
254	$identifyMethodsIncances = $this->identifyMethod->getByUserData($identifyMethods);	13✔
255	if (empty($identifyMethodsIncances)) {	13✔
256	throw new \Exception($this->l10n->t('Invalid identification method'));	×
257	}
258	$signRequest = $this->getSignRequestByIdentifyMethod(	13✔
259	current($identifyMethodsIncances),	13✔
260	$fileId	13✔
261	);	13✔
262	$displayName = $this->getDisplayNameFromIdentifyMethodIfEmpty($identifyMethodsIncances, $displayName);	13✔
263	$this->setDataToUser($signRequest, $displayName, $description, $fileId);	13✔
264
265	$signRequest->setSigningOrder($signingOrder);	13✔
266
267	if (!$signRequest->getId()) {	13✔
268	$initialStatus = $this->determineInitialStatus($signingOrder);	13✔
269	$signRequest->setStatusEnum($initialStatus);	13✔
270	}
271
272	$this->saveSignRequest($signRequest);	13✔
273	foreach ($identifyMethodsIncances as $identifyMethod) {	13✔
274	$identifyMethod->getEntity()->setSignRequestId($signRequest->getId());	13✔
275	$identifyMethod->willNotifyUser($notify);	13✔
276	$identifyMethod->save();	13✔
277	}
278	return $signRequest;	13✔
279	}
280
281	private function determineInitialStatus(int $signingOrder): \OCA\Libresign\Db\SignRequestStatus {
282	if (!$this->sequentialSigningService->isOrderedNumericFlow()) {	13✔
283	return \OCA\Libresign\Db\SignRequestStatus::ABLE_TO_SIGN;	13✔
284	}
285
NEW 286	return $signingOrder === 1	×
NEW 287	? \OCA\Libresign\Db\SignRequestStatus::ABLE_TO_SIGN	×
NEW 288	: \OCA\Libresign\Db\SignRequestStatus::DRAFT;	×
289	}
290
291	/**
292	* @param IIdentifyMethod[] $identifyMethodsIncances
293	* @param string $displayName
294	* @return string
295	*/
296	private function getDisplayNameFromIdentifyMethodIfEmpty(array $identifyMethodsIncances, string $displayName): string {
297	if (!empty($displayName)) {	13✔
298	return $displayName;	×
299	}
300	foreach ($identifyMethodsIncances as $identifyMethod) {	13✔
301	if ($identifyMethod->getName() === 'account') {	13✔
302	return $this->userManager->get($identifyMethod->getEntity()->getIdentifierValue())->getDisplayName();	2✔
303	}
304	}
305	foreach ($identifyMethodsIncances as $identifyMethod) {	11✔
306	if ($identifyMethod->getName() !== 'account') {	11✔
307	return $identifyMethod->getEntity()->getIdentifierValue();	11✔
308	}
309	}
310	return '';	×
311	}
312
313	private function saveVisibleElements(array $data, FileEntity $file): array {
314	if (empty($data['visibleElements'])) {	17✔
315	return [];	15✔
316	}
317	$elements = $data['visibleElements'];	2✔
318	foreach ($elements as $key => $element) {	2✔
319	$element['fileId'] = $file->getId();	2✔
320	$elements[$key] = $this->fileElementService->saveVisibleElement($element);	2✔
321	}
322	return $elements;	2✔
323	}
324
325	public function validateNewRequestToFile(array $data): void {
326	$this->validateNewFile($data);	7✔
327	$this->validateUsers($data);	6✔
328	$this->validateHelper->validateFileStatus($data);	2✔
329	}
330
331	public function validateNewFile(array $data): void {
332	if (empty($data['name'])) {	7✔
333	throw new \Exception($this->l10n->t('Name is mandatory'));	1✔
334	}
335	$this->validateHelper->validateNewFile($data);	6✔
336	}
337
338	public function validateUsers(array $data): void {
339	if (empty($data['users'])) {	6✔
340	throw new \Exception($this->l10n->t('Empty users list'));	3✔
341	}
342	if (!is_array($data['users'])) {	3✔
343	// TRANSLATION This message will be displayed when the request to API with the key users has a value that is not an array
344	throw new \Exception($this->l10n->t('User list needs to be an array'));	1✔
345	}
346	foreach ($data['users'] as $user) {	2✔
347	if (!array_key_exists('identify', $user)) {	2✔
348	throw new \Exception('Identify key not found');	×
349	}
350	$this->identifyMethod->setAllEntityData($user);	2✔
351	}
352	}
353
354	public function saveSignRequest(SignRequestEntity $signRequest): void {
355	if ($signRequest->getId()) {	15✔
356	$this->signRequestMapper->update($signRequest);	1✔
357	} else {
358	$this->signRequestMapper->insert($signRequest);	14✔
359	}
360	}
361
362	/**
363	* @psalm-suppress MixedMethodCall
364	*/
365	private function setDataToUser(SignRequestEntity $signRequest, string $displayName, string $description, int $fileId): void {
366	$signRequest->setFileId($fileId);	13✔
367	if (!$signRequest->getUuid()) {	13✔
368	$signRequest->setUuid(UUIDUtil::getUUID());	13✔
369	}
370	if (!empty($displayName)) {	13✔
371	$signRequest->setDisplayName($displayName);	13✔
372	}
373	if (!empty($description)) {	13✔
374	$signRequest->setDescription($description);	×
375	}
376	if (!$signRequest->getId()) {	13✔
377	$signRequest->setCreatedAt(new \DateTime('now', new \DateTimeZone('UTC')));	13✔
378	}
379	}
380
381	private function getSignRequestByIdentifyMethod(IIdentifyMethod $identifyMethod, int $fileId): SignRequestEntity {
382	try {
383	$signRequest = $this->signRequestMapper->getByIdentifyMethodAndFileId($identifyMethod, $fileId);	13✔
384	} catch (DoesNotExistException) {	13✔
385	$signRequest = new SignRequestEntity();	13✔
386	}
387	return $signRequest;	13✔
388	}
389
390	public function unassociateToUser(int $fileId, int $signRequestId): void {
391	$signRequest = $this->signRequestMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);	2✔
392	$deletedOrder = $signRequest->getSigningOrder();	2✔
393
394	try {
395	$this->signRequestMapper->delete($signRequest);	2✔
396	$groupedIdentifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequestId);	2✔
397	foreach ($groupedIdentifyMethods as $identifyMethods) {	2✔
398	foreach ($identifyMethods as $identifyMethod) {	2✔
399	$identifyMethod->delete();	2✔
400	}
401	}
402	$visibleElements = $this->fileElementMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);	2✔
403	foreach ($visibleElements as $visibleElement) {	2✔
404	$this->fileElementMapper->delete($visibleElement);	×
405	}
406
407	$this->sequentialSigningService->reorderAfterDeletion($fileId, $deletedOrder);	2✔
408	} catch (\Throwable) {	×
409	}
410	}
411
412	public function deleteRequestSignature(array $data): void {
413	if (!empty($data['uuid'])) {	2✔
414	$signatures = $this->signRequestMapper->getByFileUuid($data['uuid']);	×
415	$fileData = $this->fileMapper->getByUuid($data['uuid']);	×
416	} elseif (!empty($data['file']['fileId'])) {	2✔
417	$signatures = $this->signRequestMapper->getByNodeId($data['file']['fileId']);	2✔
418	$fileData = $this->fileMapper->getByFileId($data['file']['fileId']);	2✔
419	} else {
420	throw new \Exception($this->l10n->t('Please provide either UUID or File object'));	×
421	}
422	foreach ($signatures as $signRequest) {	2✔
423	$this->signRequestMapper->delete($signRequest);	2✔
424	}
425	$this->fileMapper->delete($fileData);	2✔
426	$this->fileElementService->deleteVisibleElements($fileData->getId());	2✔
427	}
428	}

LibreSign / libresign / 20083390077

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous