20179022714

Committed 12 Dec 2025 08:27PM UTC coverage: 43.981%. First build

Build # 20179022714

Build Type

Pull #6169

github

Committed by

web-flow

Commit Message

Merge e97580bc2 into c05b15a8e

Pull Request Pull Request #6169: feat: file level signature flow

Run Details

36 of 42 new or added lines in 8 files covered. (85.71%)

5816 of 13224 relevant lines covered (43.98%)

5.13 hits per line

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

76.11

/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\AppInfo\Application;
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\Enum\SignatureFlow;
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\IAppConfig;
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,
                protected IAppConfig $appConfig,
        ) {
        }

        public function save(array $data): FileEntity {
                $file = $this->saveFile($data);
                $this->saveVisibleElements($data, $file);
                if (!isset($data['status'])) {
                        $data['status'] = $file->getStatus();
                }
                $this->sequentialSigningService->setFile($file);
                $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);
                }

                if (isset($data['signatureFlow']) && is_string($data['signatureFlow'])) {
                        try {
                                $signatureFlow = \OCA\Libresign\Enum\SignatureFlow::from($data['signatureFlow']);
                                $file->setSignatureFlowEnum($signatureFlow);
                        } catch (\ValueError) {
                                $this->setSignatureFlowFromGlobalConfig($file);
                        }
                } else {
                        $this->setSignatureFlowFromGlobalConfig($file);
                }

                $this->fileMapper->insert($file);
                return $file;
        }

        private function setSignatureFlowFromGlobalConfig(FileEntity $file): void {
                $globalFlowValue = $this->appConfig->getValueString(Application::APP_ID, 'signature_flow', SignatureFlow::PARALLEL->value);
                $globalFlow = SignatureFlow::from($globalFlowValue);
                $file->setSignatureFlowEnum($globalFlow);
        }

        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();
                        $fileStatus = $data['status'] ?? null;

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

                                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($fileStatus),
                                                        fileId: $fileId,
                                                        signingOrder: $signingOrder,
                                                        fileStatus: $fileStatus,
                                                        signerStatus: $signerStatus,
                                                );
                                        }
                                } else {
                                        $return[] = $this->associateToSigner(
                                                identifyMethods: $user['identify'],
                                                displayName: $user['displayName'] ?? '',
                                                description: $user['description'] ?? '',
                                                notify: empty($user['notify']) && $this->isStatusAbleToNotify($fileStatus),
                                                fileId: $fileId,
                                                signingOrder: $signingOrder,
                                                fileStatus: $fileStatus,
                                                signerStatus: $signerStatus,
                                        );
                                }
                        }
                }
                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,
                ?int $fileStatus = null,
                ?int $signerStatus = null,
        ): 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);

                $isNewSignRequest = !$signRequest->getId();
                $currentStatus = $signRequest->getStatusEnum();

                if ($isNewSignRequest || $currentStatus === \OCA\Libresign\Enum\SignRequestStatus::DRAFT) {
                        $desiredStatus = $this->determineInitialStatus($signingOrder, $fileStatus, $signerStatus, $currentStatus, $fileId);
                        $this->updateStatusIfAllowed($signRequest, $currentStatus, $desiredStatus, $isNewSignRequest);
                }

                $this->saveSignRequest($signRequest);

                $shouldNotify = $notify && $signRequest->getStatusEnum() === \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN;

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

        private function updateStatusIfAllowed(
                SignRequestEntity $signRequest,
                \OCA\Libresign\Enum\SignRequestStatus $currentStatus,
                \OCA\Libresign\Enum\SignRequestStatus $desiredStatus,
                bool $isNewSignRequest,
        ): void {
                if ($isNewSignRequest || $this->sequentialSigningService->isStatusUpgrade($currentStatus, $desiredStatus)) {
                        $signRequest->setStatusEnum($desiredStatus);
                }
        }

        private function determineInitialStatus(
                int $signingOrder,
                ?int $fileStatus = null,
                ?int $signerStatus = null,
                ?\OCA\Libresign\Enum\SignRequestStatus $currentStatus = null,
                ?int $fileId = null,
        ): \OCA\Libresign\Enum\SignRequestStatus {
                if ($signerStatus !== null) {
                        $desiredStatus = \OCA\Libresign\Enum\SignRequestStatus::from($signerStatus);
                        if ($currentStatus !== null && !$this->sequentialSigningService->isStatusUpgrade($currentStatus, $desiredStatus)) {
                                return $currentStatus;
                        }

                        // Validate status transition based on signing order
                        if ($fileId !== null) {
                                return $this->sequentialSigningService->validateStatusByOrder($desiredStatus, $signingOrder, $fileId);
                        }

                        return $desiredStatus;
                }

                // If fileStatus is explicitly DRAFT (0), keep signer as DRAFT
                // This allows adding new signers in DRAFT mode even when file is not in DRAFT status
                if ($fileStatus === FileEntity::STATUS_DRAFT) {
                        return \OCA\Libresign\Enum\SignRequestStatus::DRAFT;
                }

                if ($fileStatus === FileEntity::STATUS_ABLE_TO_SIGN) {
                        if ($this->sequentialSigningService->isOrderedNumericFlow()) {
                                // In ordered flow, only first signer (order 1) should be ABLE_TO_SIGN
                                // Others remain DRAFT until their turn
                                return $signingOrder === 1
                                        ? \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN
                                        : \OCA\Libresign\Enum\SignRequestStatus::DRAFT;
                        }
                        // In parallel flow, all can sign
                        return \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN;
                }

                if (!$this->sequentialSigningService->isOrderedNumericFlow()) {
                        return \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN;
                }

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

LibreSign / libresign / 20179022714

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