libresign/lib/Service/SequentialSigningService.php
Vitor Mattos ede3fe8b9b
fix: cs
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
2025-12-12 15:07:42 -03:00

235 lines
6.4 KiB
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 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\SignRequestMapper;
use OCA\Libresign\Enum\SignatureFlow;
use OCA\Libresign\Enum\SignRequestStatus;
use OCP\IAppConfig;
class SequentialSigningService {
private int $currentOrder = 1;
public function __construct(
private IAppConfig $appConfig,
private SignRequestMapper $signRequestMapper,
private IdentifyMethodService $identifyMethodService,
) {
}
/**
* Check if ordered numeric flow is enabled
*/
public function isOrderedNumericFlow(): bool {
return $this->getSignatureFlow() === SignatureFlow::ORDERED_NUMERIC;
}
/**
* Reset the internal order counter
*/
public function resetOrderCounter(): void {
$this->currentOrder = 1;
}
/**
* Determine signing order based on flow configuration
* Manages internal counter automatically
*
* @param int|null $userProvidedOrder Order explicitly set by user
* @return int The order to use
*/
public function determineSigningOrder(?int $userProvidedOrder): int {
if (!$this->isOrderedNumericFlow()) {
return 1;
}
if ($userProvidedOrder !== null) {
if ($userProvidedOrder > $this->currentOrder) {
$this->currentOrder = $userProvidedOrder;
}
return $userProvidedOrder;
}
return $this->currentOrder++;
}
/**
* Release next order of signers after current order is completed
* Called when a signature is saved
*
* @param int $fileId
* @param int $completedOrder The order that was just completed
*/
public function releaseNextOrder(int $fileId, int $completedOrder): void {
if (!$this->isOrderedNumericFlow()) {
return;
}
$allSignRequests = $this->signRequestMapper->getByFileId($fileId);
if (!$this->isOrderFullyCompleted($allSignRequests, $completedOrder)) {
return;
}
$nextOrder = $this->findNextOrder($allSignRequests, $completedOrder);
if ($nextOrder === null) {
return;
}
$this->activateSignersForOrder($allSignRequests, $nextOrder);
}
/**
* Reorder and activate signers after a SignRequest deletion
* This ensures no gaps in the signing sequence
*
* @param int $fileId The file ID
* @param int $deletedOrder The order that was deleted
*/
public function reorderAfterDeletion(int $fileId, int $deletedOrder): void {
if (!$this->isOrderedNumericFlow()) {
return;
}
$allSignRequests = $this->signRequestMapper->getByFileId($fileId);
$hasSignersAtDeletedOrder = !empty(array_filter(
$allSignRequests,
fn ($sr) => $sr->getSigningOrder() === $deletedOrder
));
if (!$hasSignersAtDeletedOrder) {
$previousOrder = $deletedOrder - 1;
if ($previousOrder > 0 && $this->isOrderFullyCompleted($allSignRequests, $previousOrder)) {
$nextOrder = $this->findNextOrder($allSignRequests, $deletedOrder);
if ($nextOrder !== null) {
$this->activateSignersForOrder($allSignRequests, $nextOrder);
}
}
}
}
private function isOrderFullyCompleted(array $signRequests, int $order): bool {
$pendingSigners = array_filter(
$signRequests,
fn ($sr) => $sr->getSigningOrder() === $order
&& $sr->getStatusEnum() !== SignRequestStatus::SIGNED
);
return empty($pendingSigners);
}
private function findNextOrder(array $signRequests, int $completedOrder): ?int {
$allOrders = array_unique(array_map(fn ($sr) => $sr->getSigningOrder(), $signRequests));
sort($allOrders);
foreach ($allOrders as $order) {
if ($order > $completedOrder) {
return $order;
}
}
return null;
}
private function activateSignersForOrder(array $signRequests, int $order): void {
$signersToActivate = array_filter(
$signRequests,
fn ($sr) => $sr->getSigningOrder() === $order
);
foreach ($signersToActivate as $signer) {
if ($signer->getStatusEnum() === SignRequestStatus::DRAFT) {
$signer->setStatusEnum(SignRequestStatus::ABLE_TO_SIGN);
$this->signRequestMapper->update($signer);
$identifyMethods = $this->identifyMethodService->getIdentifyMethodsFromSignRequestId($signer->getId());
foreach ($identifyMethods as $methodGroup) {
foreach ($methodGroup as $identifyMethod) {
$identifyMethod->willNotifyUser(true);
$identifyMethod->notify();
}
}
}
}
}
private function getSignatureFlow(): SignatureFlow {
$value = $this->appConfig->getValueString(
Application::APP_ID,
'signature_flow',
SignatureFlow::PARALLEL->value
);
return SignatureFlow::from($value);
}
/**
* Check if there are signers with lower signing order that haven't signed yet
*/
public function hasPendingLowerOrderSigners(int $fileId, int $currentOrder): bool {
$signRequests = $this->signRequestMapper->getByFileId($fileId);
foreach ($signRequests as $signRequest) {
$order = $signRequest->getSigningOrder();
$status = $signRequest->getStatusEnum();
// If a signer with lower order hasn't signed yet, return true
if ($order < $currentOrder && $status !== SignRequestStatus::SIGNED) {
return true;
}
}
return false;
}
/**
* Check if changing from currentStatus to desiredStatus is an upgrade (or same level)
* Status hierarchy: DRAFT (0) < ABLE_TO_SIGN (1) < SIGNED (2)
*/
public function isStatusUpgrade(
SignRequestStatus $currentStatus,
SignRequestStatus $desiredStatus,
): bool {
return $desiredStatus->value >= $currentStatus->value;
}
/**
* Validate if a signer can transition to ABLE_TO_SIGN status based on signing order
* In ordered numeric flow, prevents skipping ahead if lower-order signers haven't signed
*
* @param SignRequestStatus $desiredStatus The status being requested
* @param int $signingOrder The signer's order
* @param int $fileId The file ID
* @return SignRequestStatus The validated status (may return DRAFT if validation fails)
*/
public function validateStatusByOrder(
SignRequestStatus $desiredStatus,
int $signingOrder,
int $fileId,
): SignRequestStatus {
// Only validate for ordered numeric flow
if (!$this->isOrderedNumericFlow()) {
return $desiredStatus;
}
// Only validate when trying to set ABLE_TO_SIGN and not the first signer
if ($desiredStatus !== SignRequestStatus::ABLE_TO_SIGN || $signingOrder <= 1) {
return $desiredStatus;
}
// Check if any lower order signers haven't signed yet
if ($this->hasPendingLowerOrderSigners($fileId, $signingOrder)) {
return SignRequestStatus::DRAFT;
}
return $desiredStatus;
}
}