• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

LibreSign / libresign / 22082781483

17 Feb 2026 01:28AM UTC coverage: 52.311%. First build
22082781483

Pull #6912

github

web-flow
Merge cfefd6887 into d076967de
Pull Request #6912: feat: signers contract normalization

34 of 43 new or added lines in 4 files covered. (79.07%)

9271 of 17723 relevant lines covered (52.31%)

6.23 hits per line

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

52.99
/lib/Service/RequestSignatureService.php
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\FileStatus;
19
use OCA\Libresign\Enum\SignatureFlow;
20
use OCA\Libresign\Events\SignRequestCanceledEvent;
21
use OCA\Libresign\Exception\LibresignException;
22
use OCA\Libresign\Handler\DocMdpHandler;
23
use OCA\Libresign\Helper\FileUploadHelper;
24
use OCA\Libresign\Helper\ValidateHelper;
25
use OCA\Libresign\Service\Envelope\EnvelopeFileRelocator;
26
use OCA\Libresign\Service\Envelope\EnvelopeService;
27
use OCA\Libresign\Service\File\Pdf\PdfMetadataExtractor;
28
use OCA\Libresign\Service\IdentifyMethod\IIdentifyMethod;
29
use OCA\Libresign\Service\SignRequest\SignRequestService;
30
use OCP\EventDispatcher\IEventDispatcher;
31
use OCP\Files\IMimeTypeDetector;
32
use OCP\Files\Node;
33
use OCP\Http\Client\IClientService;
34
use OCP\IAppConfig;
35
use OCP\IL10N;
36
use OCP\IUser;
37
use OCP\IUserManager;
38
use Psr\Log\LoggerInterface;
39
use Sabre\DAV\UUIDUtil;
40

41
class RequestSignatureService {
42

43
        public function __construct(
44
                protected FileService $fileService,
45
                protected IL10N $l10n,
46
                protected IdentifyMethodService $identifyMethod,
47
                protected SignRequestMapper $signRequestMapper,
48
                protected IUserManager $userManager,
49
                protected FileMapper $fileMapper,
50
                protected IdentifyMethodMapper $identifyMethodMapper,
51
                protected PdfMetadataExtractor $pdfMetadataExtractor,
52
                protected FileElementService $fileElementService,
53
                protected FileElementMapper $fileElementMapper,
54
                protected FolderService $folderService,
55
                protected IMimeTypeDetector $mimeTypeDetector,
56
                protected ValidateHelper $validateHelper,
57
                protected IClientService $client,
58
                protected DocMdpHandler $docMdpHandler,
59
                protected LoggerInterface $logger,
60
                protected SequentialSigningService $sequentialSigningService,
61
                protected IAppConfig $appConfig,
62
                protected IEventDispatcher $eventDispatcher,
63
                protected FileStatusService $fileStatusService,
64
                protected DocMdpConfigService $docMdpConfigService,
65
                protected EnvelopeService $envelopeService,
66
                protected EnvelopeFileRelocator $envelopeFileRelocator,
67
                protected FileUploadHelper $uploadHelper,
68
                protected SignRequestService $signRequestService,
69
        ) {
70
        }
45✔
71

72
        /**
73
         * Save files - creates single file or envelope based on files count
74
         *
75
         * @return array{file: FileEntity, children: list<FileEntity>}
76
         */
77
        public function saveFiles(array $data): array {
78
                if (empty($data['files'])) {
3✔
79
                        throw new LibresignException('Files parameter is required');
×
80
                }
81

82
                if (count($data['files']) === 1) {
3✔
83
                        $fileData = $data['files'][0];
2✔
84

85
                        $saveData = [
2✔
86
                                'name' => $data['name'] ?? $fileData['name'] ?? '',
2✔
87
                                'userManager' => $data['userManager'],
2✔
88
                                'status' => FileStatus::DRAFT->value,
2✔
89
                                'settings' => $data['settings'],
2✔
90
                        ];
2✔
91

92
                        if (isset($fileData['uploadedFile'])) {
2✔
93
                                $saveData['uploadedFile'] = $fileData['uploadedFile'];
1✔
94
                        } elseif (isset($fileData['fileNode'])) {
1✔
95
                                $saveData['file'] = ['fileNode' => $fileData['fileNode']];
×
96
                        } else {
97
                                $saveData['file'] = $fileData;
1✔
98
                        }
99

100
                        $savedFile = $this->save($saveData);
2✔
101

102
                        return [
2✔
103
                                'file' => $savedFile,
2✔
104
                                'children' => [$savedFile],
2✔
105
                        ];
2✔
106
                }
107

108
                $result = $this->saveEnvelope([
1✔
109
                        'files' => $data['files'],
1✔
110
                        'name' => $data['name'],
1✔
111
                        'userManager' => $data['userManager'],
1✔
112
                        'settings' => $data['settings'],
1✔
113
                        'signers' => $data['signers'] ?? [],
1✔
114
                        'status' => $data['status'] ?? FileStatus::DRAFT->value,
1✔
115
                        'visibleElements' => $data['visibleElements'] ?? [],
1✔
116
                        'signatureFlow' => $data['signatureFlow'] ?? null,
1✔
117
                ]);
1✔
118

119
                return [
1✔
120
                        'file' => $result['envelope'],
1✔
121
                        'children' => $result['files'],
1✔
122
                ];
1✔
123
        }
124

125
        public function save(array $data): FileEntity {
126
                $file = $this->saveFile($data);
14✔
127
                if (!isset($data['status'])) {
14✔
128
                        $data['status'] = $file->getStatus();
12✔
129
                }
130
                $this->sequentialSigningService->setFile($file);
14✔
131
                $this->associateToSigners($data, $file);
14✔
132
                $this->propagateSignersToChildren($file, $data);
14✔
133
                $this->saveVisibleElements($data, $file);
14✔
134

135
                return $file;
14✔
136
        }
137

138
        private function propagateSignersToChildren(FileEntity $envelope, array $data): void {
139
                if ($envelope->getNodeType() !== 'envelope' || empty($data['signers'])) {
14✔
140
                        return;
14✔
141
                }
142

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

145
                $dataWithoutNotification = $data;
×
NEW
146
                foreach ($dataWithoutNotification['signers'] as &$signer) {
×
NEW
147
                        $signer['notify'] = 0;
×
148
                }
149

150
                foreach ($children as $child) {
×
151
                        $this->identifyMethod->clearCache();
×
152
                        $this->sequentialSigningService->setFile($child);
×
153
                        $this->associateToSigners($dataWithoutNotification, $child);
×
154
                }
155

156
                if ($envelope->getStatus() > FileStatus::DRAFT->value) {
×
157
                        $this->fileStatusService->propagateStatusToChildren($envelope->getId(), $envelope->getStatus());
×
158
                }
159
        }
160

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

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

169
                $envelope = null;
×
170
                $files = [];
×
171
                $createdNodes = [];
×
172

173
                try {
174
                        $envelopePath = $data['settings']['path'] ?? null;
×
175
                        $envelope = $this->envelopeService->createEnvelope($envelopeName, $userId, $filesCount, $envelopePath);
×
176

177
                        $envelopeFolder = $this->envelopeService->getEnvelopeFolder($envelope);
×
178
                        $envelopeSettings = array_merge($data['settings'] ?? [], [
×
179
                                'envelopeFolderId' => $envelopeFolder->getId(),
×
180
                        ]);
×
181

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

186
                                $fileData['node'] = $node;
×
187
                                $fileEntity = $this->createFileForEnvelope($fileData, $userManager, $envelopeSettings);
×
188
                                $this->envelopeService->addFileToEnvelope($envelope->getId(), $fileEntity);
×
189
                                $files[] = $fileEntity;
×
190
                        }
191

NEW
192
                        if (!empty($data['signers'])) {
×
193
                                $this->sequentialSigningService->setFile($envelope);
×
194
                                $this->associateToSigners($data, $envelope);
×
195
                                $this->propagateSignersToChildren($envelope, $data);
×
196
                        }
197

198
                        return [
×
199
                                'envelope' => $envelope,
×
200
                                'files' => $files,
×
201
                        ];
×
202
                } catch (\Throwable $e) {
×
203
                        $this->rollbackEnvelopeCreation($envelope, $files, $createdNodes);
×
204
                        throw $e;
×
205
                }
206
        }
207

208
        private function processFileData(array $fileData, ?IUser $userManager, array $settings): Node {
209
                $name = $this->requireFileName($fileData);
×
210

211
                if (isset($fileData['uploadedFile'])) {
×
212
                        $sourceNode = $this->fileService->getNodeFromData([
×
213
                                'userManager' => $userManager,
×
214
                                'name' => $name,
×
215
                                'uploadedFile' => $fileData['uploadedFile'],
×
216
                                'settings' => $settings,
×
217
                        ]);
×
218
                } else {
219
                        $sourceNode = $this->fileService->getNodeFromData([
×
220
                                'userManager' => $userManager,
×
221
                                'name' => $name,
×
222
                                'file' => $fileData,
×
223
                                'settings' => $settings,
×
224
                        ]);
×
225
                }
226

227
                if (isset($settings['envelopeFolderId'])) {
×
228
                        return $this->envelopeFileRelocator->ensureFileInEnvelopeFolder(
×
229
                                $sourceNode,
×
230
                                $settings['envelopeFolderId'],
×
231
                                $userManager,
×
232
                        );
×
233
                }
234

235
                return $sourceNode;
×
236
        }
237

238
        private function requireFileName(array $fileData): string {
239
                $name = trim((string)($fileData['name'] ?? ''));
×
240
                if ($name === '') {
×
241
                        throw new LibresignException($this->l10n->t('File name is required'));
×
242
                }
243
                return $name;
×
244
        }
245

246
        private function rollbackEnvelopeCreation(?FileEntity $envelope, array $files, array $createdNodes): void {
247
                $this->rollbackCreatedNodes($createdNodes);
×
248
                $this->rollbackCreatedFiles($files);
×
249
                $this->rollbackEnvelope($envelope);
×
250
        }
251

252
        private function rollbackCreatedNodes(array $nodes): void {
253
                foreach ($nodes as $node) {
×
254
                        try {
255
                                $node->delete();
×
256
                        } catch (\Throwable $deleteError) {
×
257
                                $this->logger->error('Failed to rollback created node in envelope', [
×
258
                                        'nodeId' => $node->getId(),
×
259
                                        'error' => $deleteError->getMessage(),
×
260
                                ]);
×
261
                        }
262
                }
263
        }
264

265
        private function rollbackCreatedFiles(array $files): void {
266
                foreach ($files as $file) {
×
267
                        try {
268
                                $this->fileMapper->delete($file);
×
269
                        } catch (\Throwable $deleteError) {
×
270
                                $this->logger->error('Failed to rollback created file entity in envelope', [
×
271
                                        'fileId' => $file->getId(),
×
272
                                        'error' => $deleteError->getMessage(),
×
273
                                ]);
×
274
                        }
275
                }
276
        }
277

278
        private function rollbackEnvelope(?FileEntity $envelope): void {
279
                if ($envelope === null) {
×
280
                        return;
×
281
                }
282

283
                try {
284
                        $this->fileMapper->delete($envelope);
×
285
                } catch (\Throwable $deleteError) {
×
286
                        $this->logger->error('Failed to rollback created envelope', [
×
287
                                'envelopeId' => $envelope->getId(),
×
288
                                'error' => $deleteError->getMessage(),
×
289
                        ]);
×
290
                }
291
        }
292

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

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

301
                return $this->saveFile([
×
302
                        'file' => ['fileNode' => $node],
×
303
                        'name' => $fileName,
×
304
                        'userManager' => $userManager,
×
305
                        'status' => FileStatus::DRAFT->value,
×
306
                        'settings' => $settings,
×
307
                ]);
×
308
        }
309

310
        /**
311
         * Save file data
312
         *
313
         * @param array{?userManager: IUser, ?signRequest: SignRequest, name: string, callback: string, uuid?: ?string, status: int, file?: array{fileId?: int, fileNode?: Node}} $data
314
         */
315
        public function saveFile(array $data): FileEntity {
316
                if (!empty($data['uuid'])) {
15✔
317
                        $file = $this->fileMapper->getByUuid($data['uuid']);
1✔
318
                        $this->updateSignatureFlowIfAllowed($file, $data);
1✔
319
                        if (!empty($data['name'])) {
1✔
320
                                $file->setName($data['name']);
×
321
                                $this->fileService->update($file);
×
322
                        }
323
                        return $this->fileStatusService->updateFileStatusIfUpgrade($file, $data['status'] ?? 0);
1✔
324
                }
325
                $fileId = null;
15✔
326
                if (isset($data['file']['fileNode']) && $data['file']['fileNode'] instanceof Node) {
15✔
327
                        $fileId = $data['file']['fileNode']->getId();
×
328
                } elseif (!empty($data['file']['fileId'])) {
15✔
329
                        $fileId = $data['file']['fileId'];
×
330
                }
331
                if (!is_null($fileId)) {
15✔
332
                        try {
333
                                $file = $this->fileMapper->getByNodeId($fileId);
×
334
                                $this->updateSignatureFlowIfAllowed($file, $data);
×
335
                                return $this->fileStatusService->updateFileStatusIfUpgrade($file, $data['status'] ?? 0);
×
336
                        } catch (\Throwable) {
×
337
                        }
338
                }
339

340
                $node = $this->fileService->getNodeFromData($data);
15✔
341

342
                $file = new FileEntity();
15✔
343
                $file->setNodeId($node->getId());
15✔
344
                if (isset($data['userManager']) && $data['userManager'] instanceof IUser) {
15✔
345
                        $file->setUserId($data['userManager']->getUID());
15✔
346
                } elseif (isset($data['signRequest']) && $data['signRequest'] instanceof SignRequestEntity) {
×
347
                        $signRequestFileId = $data['signRequest']->getFileId();
×
348
                        if ($signRequestFileId) {
×
349
                                $signRequestFile = $this->fileMapper->getById($signRequestFileId);
×
350
                                $file->setUserId($signRequestFile->getUserId());
×
351
                        }
352
                }
353
                $file->setUuid(UUIDUtil::getUUID());
15✔
354
                $file->setCreatedAt(new \DateTime('now', new \DateTimeZone('UTC')));
15✔
355
                $metadata = $this->getFileMetadata($node);
15✔
356
                $name = trim((string)($data['name'] ?? ''));
15✔
357
                if ($name === '') {
15✔
358
                        $name = $node->getName();
×
359
                }
360
                $file->setName($this->removeExtensionFromName($name, $metadata));
15✔
361
                $file->setMetadata($metadata);
15✔
362
                if (!empty($data['callback'])) {
15✔
363
                        $file->setCallback($data['callback']);
×
364
                }
365
                if (isset($data['status'])) {
15✔
366
                        $file->setStatus($data['status']);
2✔
367
                } else {
368
                        $file->setStatus(FileStatus::ABLE_TO_SIGN->value);
13✔
369
                }
370

371
                if (isset($data['parentFileId'])) {
15✔
372
                        $file->setParentFileId($data['parentFileId']);
×
373
                }
374

375
                $this->setSignatureFlow($file, $data);
15✔
376
                $this->setDocMdpLevelFromGlobalConfig($file);
15✔
377

378
                $this->fileMapper->insert($file);
15✔
379
                return $file;
15✔
380
        }
381

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

386
                if ($adminForcedConfig) {
1✔
387
                        $adminFlowEnum = SignatureFlow::from($adminFlow);
×
388
                        if ($file->getSignatureFlowEnum() !== $adminFlowEnum) {
×
389
                                $file->setSignatureFlowEnum($adminFlowEnum);
×
390
                                $this->fileService->update($file);
×
391
                        }
392
                        return;
×
393
                }
394

395
                if (isset($data['signatureFlow']) && !empty($data['signatureFlow'])) {
1✔
396
                        $newFlow = SignatureFlow::from($data['signatureFlow']);
×
397
                        if ($file->getSignatureFlowEnum() !== $newFlow) {
×
398
                                $file->setSignatureFlowEnum($newFlow);
×
399
                                $this->fileService->update($file);
×
400
                        }
401
                }
402
        }
403

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

407
                if (isset($data['signatureFlow']) && !empty($data['signatureFlow'])) {
15✔
408
                        $file->setSignatureFlowEnum(SignatureFlow::from($data['signatureFlow']));
×
409
                } elseif ($adminFlow !== SignatureFlow::NONE->value) {
15✔
410
                        $file->setSignatureFlowEnum(SignatureFlow::from($adminFlow));
×
411
                } else {
412
                        $file->setSignatureFlowEnum(SignatureFlow::NONE);
15✔
413
                }
414
        }
415

416
        private function setDocMdpLevelFromGlobalConfig(FileEntity $file): void {
417
                if ($this->docMdpConfigService->isEnabled()) {
15✔
418
                        $docmdpLevel = $this->docMdpConfigService->getLevel();
×
419
                        $file->setDocmdpLevelEnum($docmdpLevel);
×
420
                }
421
        }
422

423
        private function getFileMetadata(\OCP\Files\Node $node): array {
424
                $metadata = [];
18✔
425
                if ($extension = strtolower($node->getExtension())) {
18✔
426
                        $metadata = [
17✔
427
                                'extension' => $extension,
17✔
428
                        ];
17✔
429
                        if ($metadata['extension'] === 'pdf') {
17✔
430
                                $this->pdfMetadataExtractor->setFile($node);
16✔
431
                                $metadata = array_merge(
16✔
432
                                        $metadata,
16✔
433
                                        $this->pdfMetadataExtractor->getPageDimensions()
16✔
434
                                );
16✔
435
                                $metadata['pdfVersion'] = $this->pdfMetadataExtractor->getPdfVersion();
16✔
436
                        }
437
                }
438
                return $metadata;
18✔
439
        }
440

441
        private function removeExtensionFromName(string $name, array $metadata): string {
442
                if (!isset($metadata['extension'])) {
15✔
443
                        return $name;
×
444
                }
445
                $extensionPattern = '/\.' . preg_quote($metadata['extension'], '/') . '$/i';
15✔
446
                $result = preg_replace($extensionPattern, '', $name);
15✔
447
                return $result ?? $name;
15✔
448
        }
449

450
        private function deleteIdentifyMethodIfNotExits(array $signers, FileEntity $file): void {
451
                $signRequests = $this->signRequestMapper->getByFileId($file->getId());
13✔
452
                foreach ($signRequests as $key => $signRequest) {
13✔
453
                        $identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequest->getId());
1✔
454
                        if (empty($identifyMethods)) {
1✔
455
                                $this->unassociateToUser($file->getId(), $signRequest->getId());
×
456
                                continue;
×
457
                        }
458
                        foreach ($identifyMethods as $methodName => $list) {
1✔
459
                                foreach ($list as $method) {
1✔
460
                                        $exists[$key]['identify'][$methodName] = $method->getEntity()->getIdentifierValue();
1✔
461
                                        if (!$this->identifyMethodExists($signers, $method)) {
1✔
462
                                                $this->unassociateToUser($file->getId(), $signRequest->getId());
1✔
463
                                                continue 3;
1✔
464
                                        }
465
                                }
466
                        }
467
                }
468
        }
469

470
        private function identifyMethodExists(array $signers, IIdentifyMethod $identifyMethod): bool {
471
                foreach ($signers as $signer) {
1✔
472
                        if (!empty($signer['identifyMethods'])) {
1✔
NEW
473
                                foreach ($signer['identifyMethods'] as $data) {
×
474
                                        if ($identifyMethod->getEntity()->getIdentifierKey() !== $data['method']) {
×
475
                                                continue;
×
476
                                        }
477
                                        if ($identifyMethod->getEntity()->getIdentifierValue() === $data['value']) {
×
478
                                                return true;
×
479
                                        }
480
                                }
481
                        } else {
482
                                foreach ($signer['identify'] as $method => $value) {
1✔
483
                                        if ($identifyMethod->getEntity()->getIdentifierKey() !== $method) {
1✔
484
                                                continue;
×
485
                                        }
486
                                        if ($identifyMethod->getEntity()->getIdentifierValue() === $value) {
1✔
487
                                                return true;
×
488
                                        }
489
                                }
490
                        }
491
                }
492
                return false;
1✔
493
        }
494

495
        /**
496
         * @return SignRequestEntity[]
497
         *
498
         * @psalm-return list<SignRequestEntity>
499
         */
500
        private function associateToSigners(array $data, FileEntity $file): array {
501
                $return = [];
14✔
502
                if (!empty($data['signers'])) {
14✔
503
                        $this->deleteIdentifyMethodIfNotExits($data['signers'], $file);
13✔
504
                        $this->identifyMethod->clearCache();
13✔
505

506
                        $this->sequentialSigningService->resetOrderCounter();
13✔
507
                        $fileStatus = $data['status'] ?? null;
13✔
508

509
                        foreach ($data['signers'] as $signer) {
13✔
510
                                $userProvidedOrder = isset($signer['signingOrder']) ? (int)$signer['signingOrder'] : null;
13✔
511
                                $signingOrder = $this->sequentialSigningService->determineSigningOrder($userProvidedOrder);
13✔
512
                                $signerStatus = $signer['status'] ?? null;
13✔
513
                                $shouldNotify = !isset($signer['notify']) || $signer['notify'] !== 0;
13✔
514

515
                                if (isset($signer['identifyMethods'])) {
13✔
NEW
516
                                        foreach ($signer['identifyMethods'] as $identifyMethod) {
×
517
                                                $return[] = $this->signRequestService->createOrUpdateSignRequest(
×
518
                                                        identifyMethods: [
×
519
                                                                $identifyMethod['method'] => $identifyMethod['value'],
×
520
                                                        ],
×
NEW
521
                                                        displayName: $signer['displayName'] ?? '',
×
NEW
522
                                                        description: $signer['description'] ?? '',
×
523
                                                        notify: $shouldNotify,
×
524
                                                        fileId: $file->getId(),
×
525
                                                        signingOrder: $signingOrder,
×
526
                                                        fileStatus: $fileStatus,
×
527
                                                        signerStatus: $signerStatus,
×
528
                                                );
×
529
                                        }
530
                                } else {
531
                                        $return[] = $this->signRequestService->createOrUpdateSignRequest(
13✔
532
                                                identifyMethods: $signer['identify'],
13✔
533
                                                displayName: $signer['displayName'] ?? '',
13✔
534
                                                description: $signer['description'] ?? '',
13✔
535
                                                notify: $shouldNotify,
13✔
536
                                                fileId: $file->getId(),
13✔
537
                                                signingOrder: $signingOrder,
13✔
538
                                                fileStatus: $fileStatus,
13✔
539
                                                signerStatus: $signerStatus,
13✔
540
                                        );
13✔
541
                                }
542
                        }
543
                }
544
                return $return;
14✔
545
        }
546

547

548

549
        private function saveVisibleElements(array $data, FileEntity $file): array {
550
                if (empty($data['visibleElements'])) {
19✔
551
                        return [];
15✔
552
                }
553
                $persisted = [];
4✔
554
                foreach ($data['visibleElements'] as $element) {
4✔
555
                        if ($file->isEnvelope() && !empty($element['signRequestId'])) {
4✔
556
                                $envelopeSignRequest = $this->signRequestMapper->getById((int)$element['signRequestId']);
2✔
557
                                // Only translate if the provided SR belongs to the envelope itself
558
                                if ($envelopeSignRequest && $envelopeSignRequest->getFileId() === $file->getId()) {
2✔
559
                                        $childrenSrs = $this->signRequestMapper->getByEnvelopeChildrenAndIdentifyMethod($file->getId(), (int)$element['signRequestId']);
1✔
560
                                        foreach ($childrenSrs as $childSr) {
1✔
561
                                                if ($childSr->getFileId() === (int)$element['fileId']) {
1✔
562
                                                        $element['signRequestId'] = $childSr->getId();
1✔
563
                                                        break;
1✔
564
                                                }
565
                                        }
566
                                }
567
                        }
568

569
                        $persisted[] = $this->fileElementService->saveVisibleElement($element);
4✔
570
                }
571
                return $persisted;
4✔
572
        }
573

574

575
        public function validateNewRequestToFile(array $data): void {
576
                $this->validateNewFile($data);
7✔
577
                $this->validateSigners($data);
6✔
578
                $this->validateHelper->validateFileStatus($data);
2✔
579
        }
580

581
        public function validateNewFile(array $data): void {
582
                if (empty($data['name'])) {
7✔
583
                        throw new \Exception($this->l10n->t('File name is required'));
1✔
584
                }
585
                $this->validateHelper->validateNewFile($data);
6✔
586
        }
587

588
        public function validateSigners(array $data): void {
589
                if (empty($data['signers'])) {
6✔
590
                        if (($data['status'] ?? FileStatus::ABLE_TO_SIGN->value) === FileStatus::DRAFT->value) {
3✔
591
                                return;
×
592
                        }
593
                        throw new \Exception($this->l10n->t('Empty signers list'));
3✔
594
                }
595
                if (!is_array($data['signers'])) {
3✔
596
                        // TRANSLATION This message will be displayed when the request to API with the key signers has a value that is not an array
597
                        throw new \Exception($this->l10n->t('Signers list needs to be an array'));
1✔
598
                }
599
                foreach ($data['signers'] as $signer) {
2✔
600
                        if (!array_key_exists('identify', $signer)) {
2✔
601
                                throw new \Exception('Identify key not found');
×
602
                        }
603
                        $this->identifyMethod->setAllEntityData($signer);
2✔
604
                }
605
        }
606

607

608

609
        public function unassociateToUser(int $fileId, int $signRequestId): void {
610
                $file = $this->fileMapper->getById($fileId);
2✔
611
                $signRequest = $this->signRequestMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);
2✔
612
                $deletedOrder = $signRequest->getSigningOrder();
2✔
613
                $groupedIdentifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($signRequestId);
2✔
614

615
                $this->dispatchCancellationEventIfNeeded($signRequest, $file, $groupedIdentifyMethods);
2✔
616

617
                try {
618
                        $this->signRequestMapper->delete($signRequest);
2✔
619
                        $this->identifyMethod->deleteBySignRequestId($signRequestId);
2✔
620
                        $visibleElements = $this->fileElementMapper->getByFileIdAndSignRequestId($fileId, $signRequestId);
2✔
621
                        foreach ($visibleElements as $visibleElement) {
2✔
622
                                $this->fileElementMapper->delete($visibleElement);
×
623
                        }
624

625
                        $this->sequentialSigningService
2✔
626
                                ->setFile($file)
2✔
627
                                ->reorderAfterDeletion($file->getId(), $deletedOrder);
2✔
628

629
                        $this->propagateSignerDeletionToChildren($file, $signRequest);
2✔
630
                        $this->revertStatusToDraftIfNoSignersRemain($file);
2✔
631
                } catch (\Throwable) {
×
632
                }
633
        }
634

635
        private function revertStatusToDraftIfNoSignersRemain(FileEntity $file): void {
636
                $remaining = $this->signRequestMapper->getByFileId($file->getId());
2✔
637
                if (empty($remaining)) {
2✔
638
                        $file->setStatus(FileStatus::DRAFT->value);
2✔
639
                        $this->fileStatusService->update($file);
2✔
640
                }
641
        }
642

643
        private function propagateSignerDeletionToChildren(FileEntity $envelope, SignRequestEntity $deletedSignRequest): void {
644
                if ($envelope->getNodeType() !== 'envelope') {
2✔
645
                        return;
2✔
646
                }
647

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

650
                $identifyMethods = $this->identifyMethod->getIdentifyMethodsFromSignRequestId($deletedSignRequest->getId());
×
651
                if (empty($identifyMethods)) {
×
652
                        return;
×
653
                }
654

655
                foreach ($children as $child) {
×
656
                        try {
657
                                $this->identifyMethod->clearCache();
×
658
                                $childSignRequest = $this->signRequestService->getSignRequestByIdentifyMethod(
×
659
                                        current(reset($identifyMethods)),
×
660
                                        $child->getId()
×
661
                                );
×
662

663
                                if ($childSignRequest->getId()) {
×
664
                                        $this->unassociateToUser($child->getId(), $childSignRequest->getId());
×
665
                                }
666
                        } catch (\Throwable $e) {
×
667
                                continue;
×
668
                        }
669
                }
670
        }
671

672
        private function dispatchCancellationEventIfNeeded(
673
                SignRequestEntity $signRequest,
674
                FileEntity $file,
675
                array $groupedIdentifyMethods,
676
        ): void {
677
                if ($signRequest->getStatus() !== \OCA\Libresign\Enum\SignRequestStatus::ABLE_TO_SIGN->value) {
2✔
678
                        return;
×
679
                }
680

681
                try {
682
                        foreach ($groupedIdentifyMethods as $identifyMethods) {
2✔
683
                                foreach ($identifyMethods as $identifyMethod) {
2✔
684
                                        $event = new SignRequestCanceledEvent(
2✔
685
                                                $signRequest,
2✔
686
                                                $file,
2✔
687
                                                $identifyMethod,
2✔
688
                                        );
2✔
689
                                        $this->eventDispatcher->dispatchTyped($event);
2✔
690
                                }
691
                        }
692
                } catch (\Throwable $e) {
×
693
                        $this->logger->error('Error dispatching SignRequestCanceledEvent: ' . $e->getMessage(), ['exception' => $e]);
×
694
                }
695
        }
696

697
        public function deleteRequestSignature(array $data): void {
698
                if (!empty($data['uuid'])) {
1✔
699
                        $signatures = $this->signRequestMapper->getByFileUuid($data['uuid']);
×
700
                        $fileData = $this->fileMapper->getByUuid($data['uuid']);
×
701
                } elseif (!empty($data['file']['fileId'])) {
1✔
702
                        $fileData = $this->fileMapper->getById($data['file']['fileId']);
1✔
703
                        $signatures = $this->signRequestMapper->getByFileId($fileData->getId());
1✔
704
                } else {
705
                        throw new \Exception($this->l10n->t('Please provide either UUID or File object'));
×
706
                }
707
                foreach ($signatures as $signRequest) {
1✔
708
                        $this->identifyMethod->deleteBySignRequestId($signRequest->getId());
1✔
709
                        $this->signRequestMapper->delete($signRequest);
1✔
710
                }
711
                $this->fileMapper->delete($fileData);
1✔
712
                $this->fileElementService->deleteVisibleElements($fileData->getId());
1✔
713
        }
714
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc