20621495436

Committed 31 Dec 2025 02:59PM UTC coverage: 44.647%. First build

Build # 20621495436

Build Type

Pull #6256

github

Committed by

web-flow

Commit Message

Merge 4343635f1 into 27812ed76

Pull Request Pull Request #6256: feat: add dashboard pending signatures widget

Run Details

57 of 239 new or added lines in 16 files covered. (23.85%)

6618 of 14823 relevant lines covered (44.65%)

5.05 hits per line

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

49.58

/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\Events\SignRequestCanceledEvent;
use OCA\Libresign\Exception\LibresignException;
use OCA\Libresign\Handler\DocMdpHandler;
use OCA\Libresign\Helper\FileUploadHelper;
use OCA\Libresign\Helper\ValidateHelper;
use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
use OCP\EventDispatcher\IEventDispatcher;
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 {

        public function __construct(
                protected FileService $fileService,
                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,
                protected IEventDispatcher $eventDispatcher,
                protected FileStatusService $fileStatusService,
                protected DocMdpConfigService $docMdpConfigService,
                protected EnvelopeService $envelopeService,
                protected FileUploadHelper $uploadHelper,
                protected SignRequestService $signRequestService,
        ) {
        }

        /**
         * Save files - creates single file or envelope based on files count
         *
         * @param array{files: array, name: string, settings: array, userManager: IUser} $data
         * @return array{file: FileEntity, children: FileEntity[]}
         */
        public function saveFiles(array $data): array {
                if (empty($data['files'])) {
                        throw new LibresignException('Files parameter is required');
                }

                if (count($data['files']) === 1) {
                        $fileData = $data['files'][0];

                        $saveData = [
                                'name' => $data['name'] ?? $fileData['name'] ?? '',
                                'userManager' => $data['userManager'],
                                'status' => FileEntity::STATUS_DRAFT,
                                'settings' => $data['settings'],
                        ];

                        if (isset($fileData['uploadedFile'])) {
                                $saveData['uploadedFile'] = $fileData['uploadedFile'];
                        } elseif (isset($fileData['fileNode'])) {
                                $saveData['file'] = ['fileNode' => $fileData['fileNode']];
                        } else {
                                $saveData['file'] = $fileData;
                        }

                        $savedFile = $this->save($saveData);

                        return [
                                'file' => $savedFile,
                                'children' => [$savedFile],
                        ];
                }

                $result = $this->saveEnvelope([
                        'files' => $data['files'],
                        'name' => $data['name'],
                        'userManager' => $data['userManager'],
                        'settings' => $data['settings'],
                ]);

                return [
                        'file' => $result['envelope'],
                        'children' => $result['files'],
                ];
        }

        public function save(array $data): FileEntity {
                $file = $this->saveFile($data);
                if (!isset($data['status'])) {
                        $data['status'] = $file->getStatus();
                }
                $this->sequentialSigningService->setFile($file);
                $this->associateToSigners($data, $file);
                $this->propagateSignersToChildren($file, $data);
                $this->saveVisibleElements($data, $file);

                return $file;
        }

        private function propagateSignersToChildren(FileEntity $envelope, array $data): void {
                if ($envelope->getNodeType() !== 'envelope' || empty($data['users'])) {
                        return;
                }

                $children = $this->fileMapper->getChildrenFiles($envelope->getId());

                $dataWithoutNotification = $data;
                foreach ($dataWithoutNotification['users'] as &$user) {
                        $user['notify'] = 0;
                }

                foreach ($children as $child) {
                        $this->identifyMethod->clearCache();
                        $this->sequentialSigningService->setFile($child);
                        $this->associateToSigners($dataWithoutNotification, $child);
                }

                if ($envelope->getStatus() > FileEntity::STATUS_DRAFT) {
                        $this->fileStatusService->propagateStatusToChildren($envelope->getId(), $envelope->getStatus());
                }
        }

        public function saveEnvelope(array $data): array {
                $this->envelopeService->validateEnvelopeConstraints(count($data['files']));

                $envelopeName = $data['name'] ?: $this->l10n->t('Envelope %s', [date('Y-m-d H:i:s')]);
                $userManager = $data['userManager'] ?? null;
                $userId = $userManager instanceof IUser ? $userManager->getUID() : null;
                $filesCount = count($data['files']);

                $envelope = null;
                $files = [];
                $createdNodes = [];

                try {
                        $envelope = $this->envelopeService->createEnvelope($envelopeName, $userId, $filesCount);

                        $envelopeFolder = $this->envelopeService->getEnvelopeFolder($envelope);
                        $envelopeSettings = array_merge($data['settings'] ?? [], [
                                'envelopeFolderId' => $envelopeFolder->getId(),
                        ]);

                        foreach ($data['files'] as $fileData) {
                                $node = $this->processFileData($fileData, $userManager, $envelopeSettings);
                                $createdNodes[] = $node;

                                $fileData['node'] = $node;
                                $fileEntity = $this->createFileForEnvelope($fileData, $userManager, $envelopeSettings);
                                $this->envelopeService->addFileToEnvelope($envelope->getId(), $fileEntity);
                                $files[] = $fileEntity;
                        }

                        return [
                                'envelope' => $envelope,
                                'files' => $files,
                        ];
                } catch (\Throwable $e) {
                        $this->rollbackEnvelopeCreation($envelope, $files, $createdNodes);
                        throw $e;
                }
        }

        private function processFileData(array $fileData, ?IUser $userManager, array $settings): Node {
                if (isset($fileData['uploadedFile'])) {
                        return $this->fileService->getNodeFromData([
                                'userManager' => $userManager,
                                'name' => $fileData['name'] ?? '',
                                'uploadedFile' => $fileData['uploadedFile'],
                                'settings' => $settings,
                        ]);
                }

                return $this->fileService->getNodeFromData([
                        'userManager' => $userManager,
                        'name' => $fileData['name'] ?? '',
                        'file' => $fileData,
                        'settings' => $settings,
                ]);
        }

        private function rollbackEnvelopeCreation(?FileEntity $envelope, array $files, array $createdNodes): void {
                $this->rollbackCreatedNodes($createdNodes);
                $this->rollbackCreatedFiles($files);
                $this->rollbackEnvelope($envelope);
        }

        private function rollbackCreatedNodes(array $nodes): void {
                foreach ($nodes as $node) {
                        try {
                                $node->delete();
                        } catch (\Throwable $deleteError) {
                                $this->logger->error('Failed to rollback created node in envelope', [
                                        'nodeId' => $node->getId(),
                                        'error' => $deleteError->getMessage(),
                                ]);
                        }
                }
        }

        private function rollbackCreatedFiles(array $files): void {
                foreach ($files as $file) {
                        try {
                                $this->fileMapper->delete($file);
                        } catch (\Throwable $deleteError) {
                                $this->logger->error('Failed to rollback created file entity in envelope', [
                                        'fileId' => $file->getId(),
                                        'error' => $deleteError->getMessage(),
                                ]);
                        }
                }
        }

        private function rollbackEnvelope(?FileEntity $envelope): void {
                if ($envelope === null) {
                        return;
                }

                try {
                        $this->fileMapper->delete($envelope);
                } catch (\Throwable $deleteError) {
                        $this->logger->error('Failed to rollback created envelope', [
                                'envelopeId' => $envelope->getId(),
                                'error' => $deleteError->getMessage(),
                        ]);
                }
        }

        private function createFileForEnvelope(array $fileData, ?IUser $userManager, array $settings): FileEntity {
                if (!isset($fileData['node'])) {
                        throw new \InvalidArgumentException('Node not provided in file data');
                }

                $node = $fileData['node'];
                $fileName = $fileData['name'] ?? $node->getName();

                return $this->saveFile([
                        'file' => ['fileNode' => $node],
                        'name' => $fileName,
                        'userManager' => $userManager,
                        'status' => FileEntity::STATUS_DRAFT,
                        'settings' => $settings,
                ]);
        }

        /**
         * 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']);
                        $this->updateSignatureFlowIfAllowed($file, $data);
                        if (!empty($data['name'])) {
                                $file->setName($data['name']);
                                $this->fileMapper->update($file);
                        }
                        return $this->fileStatusService->updateFileStatusIfUpgrade($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->getByNodeId($fileId);
                                $this->updateSignatureFlowIfAllowed($file, $data);
                                return $this->fileStatusService->updateFileStatusIfUpgrade($file, $data['status'] ?? 0);
                        } catch (\Throwable) {
                        }
                }

                $node = $this->fileService->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);
                $name = trim((string)($data['name'] ?? ''));
                if ($name === '') {
                        $name = $node->getName();
                }
                $file->setName($this->removeExtensionFromName($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['parentFileId'])) {
                        $file->setParentFileId($data['parentFileId']);
                }

                $this->setSignatureFlow($file, $data);
                $this->setDocMdpLevelFromGlobalConfig($file);

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

        private function updateSignatureFlowIfAllowed(FileEntity $file, array $data): void {
                $adminFlow = $this->appConfig->getValueString(Application::APP_ID, 'signature_flow', SignatureFlow::NONE->value);
                $adminForcedConfig = $adminFlow !== SignatureFlow::NONE->value;

                if ($adminForcedConfig) {
                        $adminFlowEnum = SignatureFlow::from($adminFlow);
                        if ($file->getSignatureFlowEnum() !== $adminFlowEnum) {
                                $file->setSignatureFlowEnum($adminFlowEnum);
                                $this->fileMapper->update($file);
                        }
                        return;
                }

                if (isset($data['signatureFlow']) && !empty($data['signatureFlow'])) {
                        $newFlow = SignatureFlow::from($data['signatureFlow']);
                        if ($file->getSignatureFlowEnum() !== $newFlow) {
                                $file->setSignatureFlowEnum($newFlow);
                                $this->fileMapper->update($file);
                        }
                }
        }

        private function setSignatureFlow(FileEntity $file, array $data): void {
                $adminFlow = $this->appConfig->getValueString(Application::APP_ID, 'signature_flow', SignatureFlow::NONE->value);

                if (isset($data['signatureFlow']) && !empty($data['signatureFlow'])) {
                        $file->setSignatureFlowEnum(SignatureFlow::from($data['signatureFlow']));
                } elseif ($adminFlow !== SignatureFlow::NONE->value) {
                        $file->setSignatureFlowEnum(SignatureFlow::from($adminFlow));
                } else {
                        $file->setSignatureFlowEnum(SignatureFlow::NONE);
                }
        }

        private function setDocMdpLevelFromGlobalConfig(FileEntity $file): void {
                if ($this->docMdpConfigService->isEnabled()) {
                        $docmdpLevel = $this->docMdpConfigService->getLevel();
                        $file->setDocmdpLevelEnum($docmdpLevel);
                }
        }

        private function getFileMetadata(\OCP\Files\Node $node): array {
                $metadata = [];
                if ($extension = strtolower($node->getExtension())) {
                        $metadata = [
                                'extension' => $extension,
                        ];
                        if ($metadata['extension'] === 'pdf') {
                                $pdfParser = $this->pdfParserService->setFile($node);
                                $metadata = array_merge(
                                        $metadata,
                                        $pdfParser->getPageDimensions()
                                );
                                $metadata['pdfVersion'] = $pdfParser->getPdfVersion();
                        }
                }
                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, FileEntity $file): void {
                $signRequests = $this->signRequestMapper->getByFileId($file->getId());
                foreach ($signRequests as $key => $signRequest) {
                        $identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequest->getId());
                        if (empty($identifyMethods)) {
                                $this->unassociateToUser($file->getId(), $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->getId(), $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, FileEntity $file): array {
                $return = [];
                if (!empty($data['users'])) {
                        $this->deleteIdentifyMethodIfNotExits($data['users'], $file);

                        $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;
                                $shouldNotify = !isset($user['notify']) || $user['notify'] !== 0;

                                if (isset($user['identifyMethods'])) {
                                        foreach ($user['identifyMethods'] as $identifyMethod) {
                                                $return[] = $this->signRequestService->createOrUpdateSignRequest(
                                                        identifyMethods: [
                                                                $identifyMethod['method'] => $identifyMethod['value'],
                                                        ],
                                                        displayName: $user['displayName'] ?? '',
                                                        description: $user['description'] ?? '',
                                                        notify: $shouldNotify,
                                                        fileId: $file->getId(),
                                                        signingOrder: $signingOrder,
                                                        fileStatus: $fileStatus,
                                                        signerStatus: $signerStatus,
                                                );
                                        }
                                } else {
                                        $return[] = $this->signRequestService->createOrUpdateSignRequest(
                                                identifyMethods: $user['identify'],
                                                displayName: $user['displayName'] ?? '',
                                                description: $user['description'] ?? '',
                                                notify: $shouldNotify,
                                                fileId: $file->getId(),
                                                signingOrder: $signingOrder,
                                                fileStatus: $fileStatus,
                                                signerStatus: $signerStatus,
                                        );
                                }
                        }
                }
                return $return;
        }



        private function saveVisibleElements(array $data, FileEntity $file): array {
                if (empty($data['visibleElements'])) {
                        return [];
                }
                $persisted = [];
                foreach ($data['visibleElements'] as $element) {
                        if ($file->isEnvelope() && !empty($element['signRequestId'])) {
                                $envelopeSignRequest = $this->signRequestMapper->getById((int)$element['signRequestId']);
                                // Only translate if the provided SR belongs to the envelope itself
                                if ($envelopeSignRequest && $envelopeSignRequest->getFileId() === $file->getId()) {
                                        $childrenSrs = $this->signRequestMapper->getByEnvelopeChildrenAndIdentifyMethod($file->getId(), (int)$element['signRequestId']);
                                        foreach ($childrenSrs as $childSr) {
                                                if ($childSr->getFileId() === (int)$element['fileId']) {
                                                        $element['signRequestId'] = $childSr->getId();
                                                        break;
                                                }
                                        }
                                }
                        }

                        $persisted[] = $this->fileElementService->saveVisibleElement($element);
                }
                return $persisted;
        }


        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 unassociateToUser(int $fileId, int $signRequestId): void {
                $file = $this->fileMapper->getById($fileId);
                $signRequest = $this->signRequestMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);
                $deletedOrder = $signRequest->getSigningOrder();
                $groupedIdentifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequestId);

                $this->dispatchCancellationEventIfNeeded($signRequest, $file, $groupedIdentifyMethods);

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

                        $this->sequentialSigningService
                                ->setFile($file)
                                ->reorderAfterDeletion($file->getId(), $deletedOrder);

                        $this->propagateSignerDeletionToChildren($file, $signRequest);
                } catch (\Throwable) {
                }
        }

        private function propagateSignerDeletionToChildren(FileEntity $envelope, SignRequestEntity $deletedSignRequest): void {
                if ($envelope->getNodeType() !== 'envelope') {
                        return;
                }

                $children = $this->fileMapper->getChildrenFiles($envelope->getId());

                $identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($deletedSignRequest->getId());
                if (empty($identifyMethods)) {
                        return;
                }

                foreach ($children as $child) {
                        try {
                                $this->identifyMethod->clearCache();
                                $childSignRequest = $this->signRequestService->getSignRequestByIdentifyMethod(
                                        current(reset($identifyMethods)),
                                        $child->getId()
                                );

                                if ($childSignRequest->getId()) {
                                        $this->unassociateToUser($child->getId(), $childSignRequest->getId());
                                }
                        } catch (\Throwable $e) {
                                continue;
                        }
                }
        }

        private function dispatchCancellationEventIfNeeded(
                SignRequestEntity $signRequest,
                FileEntity $file,
                array $groupedIdentifyMethods,
        ): void {
                if ($signRequest->getStatus() !== \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN->value) {
                        return;
                }

                try {
                        foreach ($groupedIdentifyMethods as $identifyMethods) {
                                foreach ($identifyMethods as $identifyMethod) {
                                        $event = new SignRequestCanceledEvent(
                                                $signRequest,
                                                $file,
                                                $identifyMethod,
                                        );
                                        $this->eventDispatcher->dispatchTyped($event);
                                }
                        }
                } catch (\Throwable $e) {
                        $this->logger->error('Error dispatching SignRequestCanceledEvent: ' . $e->getMessage(), ['exception' => $e]);
                }
        }

        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'])) {
                        $fileData = $this->fileMapper->getById($data['file']['fileId']);
                        $signatures = $this->signRequestMapper->getByFileId($fileData->getId());
                } else {
                        throw new \Exception($this->l10n->t('Please provide either UUID or File object'));
                }
                foreach ($signatures as $signRequest) {
                        $this->identifyMethod->deleteBySignRequestId($signRequest->getId());
                        $this->signRequestMapper->delete($signRequest);
                }
                $this->fileMapper->delete($fileData);
                $this->fileElementService->deleteVisibleElements($fileData->getId());
        }
}

LibreSign / libresign / 20621495436

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