mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-10-03 20:09:42 +00:00
Compare commits
3 Commits
385-invita
...
v4.5.0
Author | SHA1 | Date | |
---|---|---|---|
955cb817c4
|
|||
823f9546b9 | |||
be39fa16e7 |
@@ -1,6 +0,0 @@
|
|||||||
kind: Fixed
|
|
||||||
body: Increased the number of required characters when setting a new password in Chill from 9 to 14 - GDPR compliance
|
|
||||||
time: 2025-09-18T11:40:44.858533536+02:00
|
|
||||||
custom:
|
|
||||||
Issue: "426"
|
|
||||||
SchemaChange: No schema change
|
|
13
.changes/v4.5.0.md
Normal file
13
.changes/v4.5.0.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
## v4.5.0 - 2025-10-03
|
||||||
|
### Feature
|
||||||
|
* Only allow delete of attachment on workflows that are not final
|
||||||
|
* Move up signature buttons on index workflow page for easier access
|
||||||
|
* Filter out document from attachment list if it is the same as the workflow document
|
||||||
|
* Block edition on attached document on workflow, if the workflow is finalized or sent external
|
||||||
|
* Convert workflow's attached document to pdf while sending them external
|
||||||
|
* After a signature is canceled or rejected, going to a waiting page until the post-process routines apply a workflow transition
|
||||||
|
### Fixed
|
||||||
|
* ([#426](https://gitlab.com/Chill-Projet/chill-bundles/-/issues/426)) Increased the number of required characters when setting a new password in Chill from 9 to 14 - GDPR compliance
|
||||||
|
* Fix permissions on storedObject which are subject by a workflow
|
||||||
|
### DX
|
||||||
|
* Introduce a WaitingScreen component to display a waiting screen
|
14
CHANGELOG.md
14
CHANGELOG.md
@@ -6,6 +6,20 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
|
|||||||
and is generated by [Changie](https://github.com/miniscruff/changie).
|
and is generated by [Changie](https://github.com/miniscruff/changie).
|
||||||
|
|
||||||
|
|
||||||
|
## v4.5.0 - 2025-10-03
|
||||||
|
### Feature
|
||||||
|
* Only allow delete of attachment on workflows that are not final
|
||||||
|
* Move up signature buttons on index workflow page for easier access
|
||||||
|
* Filter out document from attachment list if it is the same as the workflow document
|
||||||
|
* Block edition on attached document on workflow, if the workflow is finalized or sent external
|
||||||
|
* Convert workflow's attached document to pdf while sending them external
|
||||||
|
* After a signature is canceled or rejected, going to a waiting page until the post-process routines apply a workflow transition
|
||||||
|
### Fixed
|
||||||
|
* ([#426](https://gitlab.com/Chill-Projet/chill-bundles/-/issues/426)) Increased the number of required characters when setting a new password in Chill from 9 to 14 - GDPR compliance
|
||||||
|
* Fix permissions on storedObject which are subject by a workflow
|
||||||
|
### DX
|
||||||
|
* Introduce a WaitingScreen component to display a waiting screen
|
||||||
|
|
||||||
## v4.4.2 - 2025-09-12
|
## v4.4.2 - 2025-09-12
|
||||||
### Fixed
|
### Fixed
|
||||||
* Fix document generation and workflow generation do not work on accompanying period work documents
|
* Fix document generation and workflow generation do not work on accompanying period work documents
|
||||||
|
@@ -25,7 +25,7 @@ export interface GenericDoc {
|
|||||||
type: "doc_store_generic_doc";
|
type: "doc_store_generic_doc";
|
||||||
uniqueKey: string;
|
uniqueKey: string;
|
||||||
key: string;
|
key: string;
|
||||||
identifiers: object;
|
identifiers: { id: number };
|
||||||
context: "person" | "accompanying-period";
|
context: "person" | "accompanying-period";
|
||||||
doc_date: DateTime;
|
doc_date: DateTime;
|
||||||
metadata: GenericDocMetadata;
|
metadata: GenericDocMetadata;
|
||||||
|
@@ -46,6 +46,16 @@ abstract class AbstractStoredObjectVoter implements StoredObjectVoterInterface
|
|||||||
|
|
||||||
public function voteOnAttribute(StoredObjectRoleEnum $attribute, StoredObject $subject, TokenInterface $token): bool
|
public function voteOnAttribute(StoredObjectRoleEnum $attribute, StoredObject $subject, TokenInterface $token): bool
|
||||||
{
|
{
|
||||||
|
// we first try to get the permission from the workflow, as attachement (this is the less intensive query)
|
||||||
|
$workflowPermissionAsAttachment = match ($attribute) {
|
||||||
|
StoredObjectRoleEnum::SEE => $this->workflowDocumentService->isAllowedByWorkflowForReadOperation($subject),
|
||||||
|
StoredObjectRoleEnum::EDIT => $this->workflowDocumentService->isAllowedByWorkflowForWriteOperation($subject),
|
||||||
|
};
|
||||||
|
|
||||||
|
if (WorkflowRelatedEntityPermissionHelper::FORCE_DENIED === $workflowPermissionAsAttachment) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
// Retrieve the related entity
|
// Retrieve the related entity
|
||||||
$entity = $this->getRepository()->findAssociatedEntityToStoredObject($subject);
|
$entity = $this->getRepository()->findAssociatedEntityToStoredObject($subject);
|
||||||
|
|
||||||
@@ -66,7 +76,7 @@ abstract class AbstractStoredObjectVoter implements StoredObjectVoterInterface
|
|||||||
return match ($workflowPermission) {
|
return match ($workflowPermission) {
|
||||||
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT => true,
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT => true,
|
||||||
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED => false,
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED => false,
|
||||||
WorkflowRelatedEntityPermissionHelper::ABSTAIN => $regularPermission,
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN => WorkflowRelatedEntityPermissionHelper::FORCE_GRANT === $workflowPermissionAsAttachment || $regularPermission,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -14,6 +14,12 @@ namespace Chill\DocStoreBundle\Security\Authorization;
|
|||||||
use Chill\DocStoreBundle\Entity\StoredObject;
|
use Chill\DocStoreBundle\Entity\StoredObject;
|
||||||
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
|
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interface for voting on stored object permissions.
|
||||||
|
*
|
||||||
|
* Each time a stored object is attached to a document, the voter is responsible for determining
|
||||||
|
* whether the user has the necessary permissions to access or modify the stored object.
|
||||||
|
*/
|
||||||
interface StoredObjectVoterInterface
|
interface StoredObjectVoterInterface
|
||||||
{
|
{
|
||||||
public function supports(StoredObjectRoleEnum $attribute, StoredObject $subject): bool;
|
public function supports(StoredObjectRoleEnum $attribute, StoredObject $subject): bool;
|
||||||
|
@@ -86,9 +86,165 @@ class AbstractStoredObjectVoterTest extends TestCase
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @dataProvider dataProviderVoteOnAttribute
|
* @dataProvider dataProviderVoteOnAttributeWithStoredObjectPermission
|
||||||
*/
|
*/
|
||||||
public function testVoteOnAttribute(
|
public function testVoteOnAttributeWithStoredObjectPermission(
|
||||||
|
StoredObjectRoleEnum $attribute,
|
||||||
|
bool $expected,
|
||||||
|
bool $isGrantedRegularPermission,
|
||||||
|
string $isGrantedWorkflowPermission,
|
||||||
|
string $isGrantedStoredObjectAttachment,
|
||||||
|
): void {
|
||||||
|
$storedObject = new StoredObject();
|
||||||
|
$repository = new DummyRepository($related = new \stdClass());
|
||||||
|
$token = new UsernamePasswordToken(new User(), 'dummy');
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('SOME_ROLE', $related)->willReturn($isGrantedRegularPermission);
|
||||||
|
|
||||||
|
$workflowRelatedEntityPermissionHelper = $this->prophesize(WorkflowRelatedEntityPermissionHelper::class);
|
||||||
|
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->isGranted('SOME_ROLE', $related)->willReturn($isGrantedRegularPermission);
|
||||||
|
|
||||||
|
if (StoredObjectRoleEnum::SEE === $attribute) {
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForReadOperation($storedObject)
|
||||||
|
->shouldBeCalled()
|
||||||
|
->willReturn($isGrantedStoredObjectAttachment);
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForReadOperation($related)
|
||||||
|
->willReturn($isGrantedWorkflowPermission);
|
||||||
|
} elseif (StoredObjectRoleEnum::EDIT === $attribute) {
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForWriteOperation($storedObject)
|
||||||
|
->shouldBeCalled()
|
||||||
|
->willReturn($isGrantedStoredObjectAttachment);
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForWriteOperation($related)
|
||||||
|
->willReturn($isGrantedWorkflowPermission);
|
||||||
|
} else {
|
||||||
|
throw new \LogicException('Invalid attribute for StoredObjectVoter');
|
||||||
|
}
|
||||||
|
|
||||||
|
$storedObjectVoter = new class ($repository, $workflowRelatedEntityPermissionHelper->reveal(), $security->reveal()) extends AbstractStoredObjectVoter {
|
||||||
|
public function __construct(private $repository, $helper, $security)
|
||||||
|
{
|
||||||
|
parent::__construct($security, $helper);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getRepository(): AssociatedEntityToStoredObjectInterface
|
||||||
|
{
|
||||||
|
return $this->repository;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getClass(): string
|
||||||
|
{
|
||||||
|
return \stdClass::class;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function attributeToRole(StoredObjectRoleEnum $attribute): string
|
||||||
|
{
|
||||||
|
return 'SOME_ROLE';
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function canBeAssociatedWithWorkflow(): bool
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
$actual = $storedObjectVoter->voteOnAttribute($attribute, $storedObject, $token);
|
||||||
|
|
||||||
|
self::assertEquals($expected, $actual);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function dataProviderVoteOnAttributeWithStoredObjectPermission(): iterable
|
||||||
|
{
|
||||||
|
foreach (['read' => StoredObjectRoleEnum::SEE, 'write' => StoredObjectRoleEnum::EDIT] as $action => $attribute) {
|
||||||
|
yield 'Not related to any workflow nor attachment ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Not related to any workflow nor attachment (refuse) ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
false,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (workflow) ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (stored object) ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (workflow) although grant ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (stored object) although grant ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (initially refused) (workflow) although grant ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
false,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Is granted by a workflow takes precedence (initially refused) (stored object) although grant ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
false,
|
||||||
|
false,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Force grant inverse the regular permission (workflow) ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
true,
|
||||||
|
false,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
];
|
||||||
|
|
||||||
|
yield 'Force grant inverse the regular permission (so) ('.$action.')' => [
|
||||||
|
$attribute,
|
||||||
|
true,
|
||||||
|
false,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::ABSTAIN,
|
||||||
|
WorkflowRelatedEntityPermissionHelper::FORCE_GRANT,
|
||||||
|
];
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider dataProviderVoteOnAttributeWithoutStoredObjectPermission
|
||||||
|
*/
|
||||||
|
public function testVoteOnAttributeWithoutStoredObjectPermission(
|
||||||
StoredObjectRoleEnum $attribute,
|
StoredObjectRoleEnum $attribute,
|
||||||
bool $expected,
|
bool $expected,
|
||||||
bool $canBeAssociatedWithWorkflow,
|
bool $canBeAssociatedWithWorkflow,
|
||||||
@@ -105,6 +261,10 @@ class AbstractStoredObjectVoterTest extends TestCase
|
|||||||
$security->isGranted('SOME_ROLE', $related)->willReturn($isGrantedRegularPermission);
|
$security->isGranted('SOME_ROLE', $related)->willReturn($isGrantedRegularPermission);
|
||||||
|
|
||||||
$workflowRelatedEntityPermissionHelper = $this->prophesize(WorkflowRelatedEntityPermissionHelper::class);
|
$workflowRelatedEntityPermissionHelper = $this->prophesize(WorkflowRelatedEntityPermissionHelper::class);
|
||||||
|
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForReadOperation($storedObject)->willReturn(WorkflowRelatedEntityPermissionHelper::ABSTAIN);
|
||||||
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForWriteOperation($storedObject)->willReturn(WorkflowRelatedEntityPermissionHelper::ABSTAIN);
|
||||||
|
|
||||||
if (null !== $isGrantedWorkflowPermissionRead) {
|
if (null !== $isGrantedWorkflowPermissionRead) {
|
||||||
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForReadOperation($related)
|
$workflowRelatedEntityPermissionHelper->isAllowedByWorkflowForReadOperation($related)
|
||||||
->willReturn($isGrantedWorkflowPermissionRead)->shouldBeCalled();
|
->willReturn($isGrantedWorkflowPermissionRead)->shouldBeCalled();
|
||||||
@@ -123,7 +283,7 @@ class AbstractStoredObjectVoterTest extends TestCase
|
|||||||
self::assertEquals($expected, $voter->voteOnAttribute($attribute, $storedObject, $token), $message);
|
self::assertEquals($expected, $voter->voteOnAttribute($attribute, $storedObject, $token), $message);
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function dataProviderVoteOnAttribute(): iterable
|
public static function dataProviderVoteOnAttributeWithoutStoredObjectPermission(): iterable
|
||||||
{
|
{
|
||||||
// not associated on a workflow
|
// not associated on a workflow
|
||||||
yield [StoredObjectRoleEnum::SEE, true, false, true, null, null, 'not associated on a workflow, granted by regular access, must not rely on helper'];
|
yield [StoredObjectRoleEnum::SEE, true, false, true, null, null, 'not associated on a workflow, granted by regular access, must not rely on helper'];
|
||||||
|
@@ -11,6 +11,7 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\MainBundle\Controller;
|
namespace Chill\MainBundle\Controller;
|
||||||
|
|
||||||
|
use Chill\MainBundle\CRUD\Controller\ApiController;
|
||||||
use Chill\MainBundle\Entity\User;
|
use Chill\MainBundle\Entity\User;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
use Chill\MainBundle\Pagination\PaginatorFactory;
|
use Chill\MainBundle\Pagination\PaginatorFactory;
|
||||||
@@ -27,7 +28,7 @@ use Symfony\Component\Security\Core\Exception\AccessDeniedException;
|
|||||||
use Symfony\Component\Security\Core\Security;
|
use Symfony\Component\Security\Core\Security;
|
||||||
use Symfony\Component\Serializer\SerializerInterface;
|
use Symfony\Component\Serializer\SerializerInterface;
|
||||||
|
|
||||||
class WorkflowApiController
|
class WorkflowApiController extends ApiController
|
||||||
{
|
{
|
||||||
public function __construct(private readonly EntityManagerInterface $entityManager, private readonly EntityWorkflowRepository $entityWorkflowRepository, private readonly PaginatorFactory $paginatorFactory, private readonly Security $security, private readonly SerializerInterface $serializer) {}
|
public function __construct(private readonly EntityManagerInterface $entityManager, private readonly EntityWorkflowRepository $entityWorkflowRepository, private readonly PaginatorFactory $paginatorFactory, private readonly Security $security, private readonly SerializerInterface $serializer) {}
|
||||||
|
|
||||||
|
@@ -44,7 +44,7 @@ final readonly class WorkflowSignatureStateChangeController
|
|||||||
$signature,
|
$signature,
|
||||||
$request,
|
$request,
|
||||||
EntityWorkflowStepSignatureVoter::CANCEL,
|
EntityWorkflowStepSignatureVoter::CANCEL,
|
||||||
function (EntityWorkflowStepSignature $signature) {$this->signatureStepStateChanger->markSignatureAsCanceled($signature); },
|
fn (EntityWorkflowStepSignature $signature): string => $this->signatureStepStateChanger->markSignatureAsCanceled($signature),
|
||||||
'@ChillMain/WorkflowSignature/cancel.html.twig',
|
'@ChillMain/WorkflowSignature/cancel.html.twig',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -56,11 +56,18 @@ final readonly class WorkflowSignatureStateChangeController
|
|||||||
$signature,
|
$signature,
|
||||||
$request,
|
$request,
|
||||||
EntityWorkflowStepSignatureVoter::REJECT,
|
EntityWorkflowStepSignatureVoter::REJECT,
|
||||||
function (EntityWorkflowStepSignature $signature) {$this->signatureStepStateChanger->markSignatureAsRejected($signature); },
|
fn (EntityWorkflowStepSignature $signature): string => $this->signatureStepStateChanger->markSignatureAsRejected($signature),
|
||||||
'@ChillMain/WorkflowSignature/reject.html.twig',
|
'@ChillMain/WorkflowSignature/reject.html.twig',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param callable(EntityWorkflowStepSignature): string $markSignature
|
||||||
|
*
|
||||||
|
* @throws \Twig\Error\LoaderError
|
||||||
|
* @throws \Twig\Error\RuntimeError
|
||||||
|
* @throws \Twig\Error\SyntaxError
|
||||||
|
*/
|
||||||
private function markSignatureAction(
|
private function markSignatureAction(
|
||||||
EntityWorkflowStepSignature $signature,
|
EntityWorkflowStepSignature $signature,
|
||||||
Request $request,
|
Request $request,
|
||||||
@@ -79,12 +86,13 @@ final readonly class WorkflowSignatureStateChangeController
|
|||||||
$form->handleRequest($request);
|
$form->handleRequest($request);
|
||||||
|
|
||||||
if ($form->isSubmitted() && $form->isValid()) {
|
if ($form->isSubmitted() && $form->isValid()) {
|
||||||
$this->entityManager->wrapInTransaction(function () use ($signature, $markSignature) {
|
$expectedStep = $this->entityManager->wrapInTransaction(fn () => $markSignature($signature));
|
||||||
$markSignature($signature);
|
|
||||||
});
|
|
||||||
|
|
||||||
return new RedirectResponse(
|
return new RedirectResponse(
|
||||||
$this->chillUrlGenerator->returnPathOr('chill_main_workflow_show', ['id' => $signature->getStep()->getEntityWorkflow()->getId()])
|
$this->chillUrlGenerator->forwardReturnPath(
|
||||||
|
'chill_main_workflow_wait',
|
||||||
|
['id' => $signature->getStep()->getEntityWorkflow()->getId(), 'expectedStep' => $expectedStep]
|
||||||
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -0,0 +1,41 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\MainBundle\Controller;
|
||||||
|
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Chill\MainBundle\Routing\ChillUrlGeneratorInterface;
|
||||||
|
use Symfony\Component\HttpFoundation\RedirectResponse;
|
||||||
|
use Symfony\Component\HttpFoundation\Response;
|
||||||
|
use Symfony\Component\Routing\Annotation\Route;
|
||||||
|
use Twig\Environment;
|
||||||
|
|
||||||
|
final readonly class WorkflowWaitStepChangeController
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private ChillUrlGeneratorInterface $chillUrlGenerator,
|
||||||
|
private Environment $twig,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
#[Route('/{_locale}/main/workflow/{id}/wait/{expectedStep}', name: 'chill_main_workflow_wait', methods: ['GET'])]
|
||||||
|
public function waitForSignatureChange(EntityWorkflow $entityWorkflow, string $expectedStep): Response
|
||||||
|
{
|
||||||
|
if ($entityWorkflow->getStep() === $expectedStep) {
|
||||||
|
return new RedirectResponse(
|
||||||
|
$this->chillUrlGenerator->returnPathOr('chill_main_workflow_show', ['id' => $entityWorkflow->getId()])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Response(
|
||||||
|
$this->twig->render('@ChillMain/Workflow/waiting.html.twig', ['workflow' => $entityWorkflow, 'expectedStep' => $expectedStep])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
@@ -30,6 +30,7 @@ use Chill\MainBundle\Controller\UserGroupAdminController;
|
|||||||
use Chill\MainBundle\Controller\UserGroupApiController;
|
use Chill\MainBundle\Controller\UserGroupApiController;
|
||||||
use Chill\MainBundle\Controller\UserJobApiController;
|
use Chill\MainBundle\Controller\UserJobApiController;
|
||||||
use Chill\MainBundle\Controller\UserJobController;
|
use Chill\MainBundle\Controller\UserJobController;
|
||||||
|
use Chill\MainBundle\Controller\WorkflowApiController;
|
||||||
use Chill\MainBundle\DependencyInjection\Widget\Factory\WidgetFactoryInterface;
|
use Chill\MainBundle\DependencyInjection\Widget\Factory\WidgetFactoryInterface;
|
||||||
use Chill\MainBundle\Doctrine\DQL\Age;
|
use Chill\MainBundle\Doctrine\DQL\Age;
|
||||||
use Chill\MainBundle\Doctrine\DQL\Extract;
|
use Chill\MainBundle\Doctrine\DQL\Extract;
|
||||||
@@ -66,6 +67,7 @@ use Chill\MainBundle\Entity\Regroupment;
|
|||||||
use Chill\MainBundle\Entity\User;
|
use Chill\MainBundle\Entity\User;
|
||||||
use Chill\MainBundle\Entity\UserGroup;
|
use Chill\MainBundle\Entity\UserGroup;
|
||||||
use Chill\MainBundle\Entity\UserJob;
|
use Chill\MainBundle\Entity\UserJob;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
use Chill\MainBundle\Form\CenterType;
|
use Chill\MainBundle\Form\CenterType;
|
||||||
use Chill\MainBundle\Form\CivilityType;
|
use Chill\MainBundle\Form\CivilityType;
|
||||||
use Chill\MainBundle\Form\CountryType;
|
use Chill\MainBundle\Form\CountryType;
|
||||||
@@ -79,6 +81,7 @@ use Chill\MainBundle\Form\UserGroupType;
|
|||||||
use Chill\MainBundle\Form\UserJobType;
|
use Chill\MainBundle\Form\UserJobType;
|
||||||
use Chill\MainBundle\Form\UserType;
|
use Chill\MainBundle\Form\UserType;
|
||||||
use Chill\MainBundle\Security\Authorization\ChillExportVoter;
|
use Chill\MainBundle\Security\Authorization\ChillExportVoter;
|
||||||
|
use Chill\MainBundle\Security\Authorization\EntityWorkflowVoter;
|
||||||
use Misd\PhoneNumberBundle\Doctrine\DBAL\Types\PhoneNumberType;
|
use Misd\PhoneNumberBundle\Doctrine\DBAL\Types\PhoneNumberType;
|
||||||
use Ramsey\Uuid\Doctrine\UuidType;
|
use Ramsey\Uuid\Doctrine\UuidType;
|
||||||
use Symfony\Component\Config\FileLocator;
|
use Symfony\Component\Config\FileLocator;
|
||||||
@@ -940,6 +943,21 @@ class ChillMainExtension extends Extension implements
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
|
[
|
||||||
|
'class' => EntityWorkflow::class,
|
||||||
|
'name' => 'workflow',
|
||||||
|
'base_path' => '/api/1.0/main/workflow',
|
||||||
|
'base_role' => EntityWorkflowVoter::SEE,
|
||||||
|
'controller' => WorkflowApiController::class,
|
||||||
|
'actions' => [
|
||||||
|
'_entity' => [
|
||||||
|
'methods' => [
|
||||||
|
Request::METHOD_GET => true,
|
||||||
|
Request::METHOD_HEAD => true,
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
],
|
||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
@@ -0,0 +1,13 @@
|
|||||||
|
/**
|
||||||
|
* Extracts the "returnPath" parameter from the current URL's query string and returns it.
|
||||||
|
* If the parameter is not present, returns the provided fallback path.
|
||||||
|
*
|
||||||
|
* @param {string} fallbackPath - The fallback path to use if "returnPath" is not found in the query string.
|
||||||
|
* @return {string} The "returnPath" from the query string, or the fallback path if "returnPath" is not present.
|
||||||
|
*/
|
||||||
|
export function returnPathOr(fallbackPath: string): string {
|
||||||
|
const urlParams = new URLSearchParams(window.location.search);
|
||||||
|
const returnPath = urlParams.get("returnPath");
|
||||||
|
|
||||||
|
return returnPath ?? fallbackPath;
|
||||||
|
}
|
@@ -0,0 +1,16 @@
|
|||||||
|
import { EntityWorkflow } from "ChillMainAssets/types";
|
||||||
|
import { makeFetch } from "ChillMainAssets/lib/api/apiMethods";
|
||||||
|
|
||||||
|
export const fetchWorkflow = async (
|
||||||
|
workflowId: number,
|
||||||
|
): Promise<EntityWorkflow> => {
|
||||||
|
try {
|
||||||
|
return await makeFetch<null, EntityWorkflow>(
|
||||||
|
"GET",
|
||||||
|
`/api/1.0/main/workflow/${workflowId}.json`,
|
||||||
|
);
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`Failed to fetch workflow ${workflowId}:`, error);
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
};
|
@@ -1,5 +1,6 @@
|
|||||||
import { GenericDoc } from "ChillDocStoreAssets/types/generic_doc";
|
import { GenericDoc } from "ChillDocStoreAssets/types/generic_doc";
|
||||||
import { StoredObject, StoredObjectStatus } from "ChillDocStoreAssets/types";
|
import { StoredObject, StoredObjectStatus } from "ChillDocStoreAssets/types";
|
||||||
|
import { Person } from "../../../ChillPersonBundle/Resources/public/types";
|
||||||
|
|
||||||
export interface DateTime {
|
export interface DateTime {
|
||||||
datetime: string;
|
datetime: string;
|
||||||
@@ -202,6 +203,58 @@ export interface WorkflowAttachment {
|
|||||||
genericDoc: null | GenericDoc;
|
genericDoc: null | GenericDoc;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface Workflow {
|
||||||
|
name: string;
|
||||||
|
text: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EntityWorkflowStep {
|
||||||
|
type: "entity_workflow_step";
|
||||||
|
id: number;
|
||||||
|
comment: string;
|
||||||
|
currentStep: StepDefinition;
|
||||||
|
isFinal: boolean;
|
||||||
|
isFreezed: boolean;
|
||||||
|
isFinalized: boolean;
|
||||||
|
transitionPrevious: Transition | null;
|
||||||
|
transitionAfter: Transition | null;
|
||||||
|
previousId: number | null;
|
||||||
|
nextId: number | null;
|
||||||
|
transitionPreviousBy: User | null;
|
||||||
|
transitionPreviousAt: DateTime | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Transition {
|
||||||
|
name: string;
|
||||||
|
text: string;
|
||||||
|
isForward: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StepDefinition {
|
||||||
|
name: string;
|
||||||
|
text: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EntityWorkflow {
|
||||||
|
type: "entity_workflow";
|
||||||
|
id: number;
|
||||||
|
relatedEntityClass: string;
|
||||||
|
relatedEntityId: number;
|
||||||
|
workflow: Workflow;
|
||||||
|
currentStep: EntityWorkflowStep;
|
||||||
|
steps: EntityWorkflowStep[];
|
||||||
|
datas: WorkflowData;
|
||||||
|
title: string;
|
||||||
|
isOnHoldAtCurrentStep: boolean;
|
||||||
|
_permissions: {
|
||||||
|
CHILL_MAIN_WORKFLOW_ATTACHMENT_EDIT: boolean;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface WorkflowData {
|
||||||
|
persons: Person[];
|
||||||
|
}
|
||||||
|
|
||||||
export interface ExportGeneration {
|
export interface ExportGeneration {
|
||||||
id: string;
|
id: string;
|
||||||
type: "export_generation";
|
type: "export_generation";
|
||||||
@@ -215,3 +268,8 @@ export interface ExportGeneration {
|
|||||||
export interface PrivateCommentEmbeddable {
|
export interface PrivateCommentEmbeddable {
|
||||||
comments: Record<number, string>;
|
comments: Record<number, string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Possible states for the WaitingScreen Component.
|
||||||
|
*/
|
||||||
|
export type WaitingScreenState = "pending" | "failure" | "stopped" | "ready";
|
||||||
|
@@ -10,7 +10,8 @@ import { computed, onMounted, ref } from "vue";
|
|||||||
import { StoredObject, StoredObjectStatus } from "ChillDocStoreAssets/types";
|
import { StoredObject, StoredObjectStatus } from "ChillDocStoreAssets/types";
|
||||||
import { fetchExportGenerationStatus } from "ChillMainAssets/lib/api/export";
|
import { fetchExportGenerationStatus } from "ChillMainAssets/lib/api/export";
|
||||||
import DocumentActionButtonsGroup from "ChillDocStoreAssets/vuejs/DocumentActionButtonsGroup.vue";
|
import DocumentActionButtonsGroup from "ChillDocStoreAssets/vuejs/DocumentActionButtonsGroup.vue";
|
||||||
import { ExportGeneration } from "ChillMainAssets/types";
|
import WaitingScreen from "../_components/WaitingScreen.vue";
|
||||||
|
import { ExportGeneration, WaitingScreenState } from "ChillMainAssets/types";
|
||||||
|
|
||||||
interface AppProps {
|
interface AppProps {
|
||||||
exportGenerationId: string;
|
exportGenerationId: string;
|
||||||
@@ -34,13 +35,16 @@ const storedObject = computed<null | StoredObject>(() => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
const isPending = computed<boolean>(() => status.value === "pending");
|
const isPending = computed<boolean>(() => status.value === "pending");
|
||||||
const isFetching = computed<boolean>(
|
|
||||||
() => tryiesForReady.value < maxTryiesForReady,
|
|
||||||
);
|
|
||||||
const isReady = computed<boolean>(() => status.value === "ready");
|
|
||||||
const isFailure = computed<boolean>(() => status.value === "failure");
|
|
||||||
const filename = computed<string>(() => `${props.title}-${props.createdDate}`);
|
const filename = computed<string>(() => `${props.title}-${props.createdDate}`);
|
||||||
|
|
||||||
|
const state = computed<WaitingScreenState>((): WaitingScreenState => {
|
||||||
|
if (status.value === "empty") {
|
||||||
|
return "pending";
|
||||||
|
}
|
||||||
|
|
||||||
|
return status.value;
|
||||||
|
});
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* counter for the number of times that we check for a new status
|
* counter for the number of times that we check for a new status
|
||||||
*/
|
*/
|
||||||
@@ -85,57 +89,36 @@ onMounted(() => {
|
|||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div id="waiting-screen">
|
<WaitingScreen :state="state">
|
||||||
<div
|
<template v-slot:pending>
|
||||||
v-if="isPending && isFetching"
|
<p>
|
||||||
class="alert alert-danger text-center"
|
{{ trans(EXPORT_GENERATION_EXPORT_GENERATION_IS_PENDING) }}
|
||||||
>
|
</p>
|
||||||
<div>
|
</template>
|
||||||
<p>
|
|
||||||
{{ trans(EXPORT_GENERATION_EXPORT_GENERATION_IS_PENDING) }}
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
<template v-slot:stopped>
|
||||||
<i class="fa fa-cog fa-spin fa-3x fa-fw"></i>
|
<p>
|
||||||
<span class="sr-only">Loading...</span>
|
{{ trans(EXPORT_GENERATION_TOO_MANY_RETRIES) }}
|
||||||
</div>
|
</p>
|
||||||
</div>
|
</template>
|
||||||
<div v-if="isPending && !isFetching" class="alert alert-info">
|
|
||||||
<div>
|
|
||||||
<p>
|
|
||||||
{{ trans(EXPORT_GENERATION_TOO_MANY_RETRIES) }}
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div v-if="isFailure" class="alert alert-danger text-center">
|
|
||||||
<div>
|
|
||||||
<p>
|
|
||||||
{{ trans(EXPORT_GENERATION_ERROR_WHILE_GENERATING_EXPORT) }}
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div v-if="isReady" class="alert alert-success text-center">
|
|
||||||
<div>
|
|
||||||
<p>
|
|
||||||
{{ trans(EXPORT_GENERATION_EXPORT_READY) }}
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p v-if="storedObject !== null">
|
<template v-slot:failure>
|
||||||
<document-action-buttons-group
|
<p>
|
||||||
:stored-object="storedObject"
|
{{ trans(EXPORT_GENERATION_ERROR_WHILE_GENERATING_EXPORT) }}
|
||||||
:filename="filename"
|
</p>
|
||||||
></document-action-buttons-group>
|
</template>
|
||||||
</p>
|
|
||||||
</div>
|
<template v-slot:ready>
|
||||||
</div>
|
<p>
|
||||||
</div>
|
{{ trans(EXPORT_GENERATION_EXPORT_READY) }}
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p v-if="storedObject !== null">
|
||||||
|
<document-action-buttons-group
|
||||||
|
:stored-object="storedObject"
|
||||||
|
:filename="filename"
|
||||||
|
></document-action-buttons-group>
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
</WaitingScreen>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped lang="scss">
|
|
||||||
#waiting-screen {
|
|
||||||
> .alert {
|
|
||||||
min-height: 350px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
|
@@ -0,0 +1,75 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { useIntervalFn } from "@vueuse/core";
|
||||||
|
import { fetchWorkflow } from "ChillMainAssets/lib/workflow/api";
|
||||||
|
import { returnPathOr } from "ChillMainAssets/lib/return_path/returnPathHelper";
|
||||||
|
import { ref } from "vue";
|
||||||
|
import WaitingScreen from "ChillMainAssets/vuejs/_components/WaitingScreen.vue";
|
||||||
|
import { WaitingScreenState } from "ChillMainAssets/types";
|
||||||
|
import {
|
||||||
|
trans,
|
||||||
|
WORKFLOW_WAIT_TITLE,
|
||||||
|
WORKFLOW_WAIT_ERROR_WHILE_WAITING,
|
||||||
|
WORKFLOW_WAIT_SUCCESS,
|
||||||
|
} from "translator";
|
||||||
|
|
||||||
|
interface WaitPostProcessWorkflowComponentProps {
|
||||||
|
workflowId: number;
|
||||||
|
expectedStep: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = defineProps<WaitPostProcessWorkflowComponentProps>();
|
||||||
|
const counter = ref<number>(0);
|
||||||
|
const MAX_TRYIES = 50;
|
||||||
|
|
||||||
|
const state = ref<WaitingScreenState>("pending");
|
||||||
|
|
||||||
|
const { pause, resume } = useIntervalFn(
|
||||||
|
async () => {
|
||||||
|
try {
|
||||||
|
const workflow = await fetchWorkflow(props.workflowId);
|
||||||
|
counter.value++;
|
||||||
|
if (workflow.currentStep.currentStep.name === props.expectedStep) {
|
||||||
|
window.location.assign(
|
||||||
|
returnPathOr("/fr/main/workflow" + workflow.id + "/show"),
|
||||||
|
);
|
||||||
|
resume();
|
||||||
|
state.value = "ready";
|
||||||
|
}
|
||||||
|
|
||||||
|
if (counter.value > MAX_TRYIES) {
|
||||||
|
pause();
|
||||||
|
state.value = "failure";
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
pause();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
2000,
|
||||||
|
{ immediate: true },
|
||||||
|
);
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="container">
|
||||||
|
<WaitingScreen :state="state">
|
||||||
|
<template v-slot:pending>
|
||||||
|
<p>
|
||||||
|
{{ trans(WORKFLOW_WAIT_TITLE) }}
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
<template v-slot:failure>
|
||||||
|
<p>
|
||||||
|
{{ trans(WORKFLOW_WAIT_ERROR_WHILE_WAITING) }}
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
<template v-slot:ready>
|
||||||
|
<p>
|
||||||
|
{{ trans(WORKFLOW_WAIT_SUCCESS) }}
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
</WaitingScreen>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss"></style>
|
@@ -0,0 +1,51 @@
|
|||||||
|
import { createApp } from "vue";
|
||||||
|
import App from "./App.vue";
|
||||||
|
|
||||||
|
function mountApp(): void {
|
||||||
|
const el = document.querySelector<HTMLDivElement>(".screen-wait");
|
||||||
|
if (!el) {
|
||||||
|
console.error(
|
||||||
|
"WaitPostProcessWorkflow: mount element .screen-wait not found",
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const workflowIdAttr = el.getAttribute("data-workflow-id");
|
||||||
|
const expectedStep = el.getAttribute("data-expected-step") || "";
|
||||||
|
|
||||||
|
if (!workflowIdAttr) {
|
||||||
|
console.error(
|
||||||
|
"WaitPostProcessWorkflow: data-workflow-id attribute missing on mount element",
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!expectedStep) {
|
||||||
|
console.error(
|
||||||
|
"WaitPostProcessWorkflow: data-expected-step attribute missing on mount element",
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const workflowId = Number(workflowIdAttr);
|
||||||
|
if (Number.isNaN(workflowId)) {
|
||||||
|
console.error(
|
||||||
|
"WaitPostProcessWorkflow: data-workflow-id is not a valid number:",
|
||||||
|
workflowIdAttr,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const app = createApp(App, {
|
||||||
|
workflowId,
|
||||||
|
expectedStep,
|
||||||
|
});
|
||||||
|
|
||||||
|
app.mount(el);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === "loading") {
|
||||||
|
document.addEventListener("DOMContentLoaded", mountApp);
|
||||||
|
} else {
|
||||||
|
mountApp();
|
||||||
|
}
|
@@ -1,10 +1,11 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { computed, useTemplateRef } from "vue";
|
import { computed, onMounted, ref, useTemplateRef } from "vue";
|
||||||
import type { WorkflowAttachment } from "ChillMainAssets/types";
|
import type { EntityWorkflow, WorkflowAttachment } from "ChillMainAssets/types";
|
||||||
import PickGenericDocModal from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDocModal.vue";
|
import PickGenericDocModal from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDocModal.vue";
|
||||||
import { GenericDocForAccompanyingPeriod } from "ChillDocStoreAssets/types/generic_doc";
|
import { GenericDocForAccompanyingPeriod } from "ChillDocStoreAssets/types/generic_doc";
|
||||||
import AttachmentList from "ChillMainAssets/vuejs/WorkflowAttachment/Component/AttachmentList.vue";
|
import AttachmentList from "ChillMainAssets/vuejs/WorkflowAttachment/Component/AttachmentList.vue";
|
||||||
import { GenericDoc } from "ChillDocStoreAssets/types";
|
import { GenericDoc } from "ChillDocStoreAssets/types";
|
||||||
|
import { fetchWorkflow } from "ChillMainAssets/lib/workflow/api";
|
||||||
|
|
||||||
interface AppConfig {
|
interface AppConfig {
|
||||||
workflowId: number;
|
workflowId: number;
|
||||||
@@ -34,6 +35,13 @@ const attachedGenericDoc = computed<GenericDocForAccompanyingPeriod[]>(
|
|||||||
) as GenericDocForAccompanyingPeriod[],
|
) as GenericDocForAccompanyingPeriod[],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const workflow = ref<EntityWorkflow | null>(null);
|
||||||
|
|
||||||
|
onMounted(async () => {
|
||||||
|
workflow.value = await fetchWorkflow(Number(props.workflowId));
|
||||||
|
console.log("workflow", workflow.value);
|
||||||
|
});
|
||||||
|
|
||||||
const openModal = function () {
|
const openModal = function () {
|
||||||
pickDocModal.value?.openModal();
|
pickDocModal.value?.openModal();
|
||||||
};
|
};
|
||||||
@@ -49,20 +57,30 @@ const onPickGenericDoc = ({
|
|||||||
const onRemoveAttachment = (payload: { attachment: WorkflowAttachment }) => {
|
const onRemoveAttachment = (payload: { attachment: WorkflowAttachment }) => {
|
||||||
emit("removeAttachment", payload);
|
emit("removeAttachment", payload);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const canEditAttachement = computed<boolean>(() => {
|
||||||
|
if (null === workflow.value) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return workflow.value._permissions.CHILL_MAIN_WORKFLOW_ATTACHMENT_EDIT;
|
||||||
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<pick-generic-doc-modal
|
<pick-generic-doc-modal
|
||||||
|
:workflow="workflow"
|
||||||
:accompanying-period-id="props.accompanyingPeriodId"
|
:accompanying-period-id="props.accompanyingPeriodId"
|
||||||
:to-remove="attachedGenericDoc"
|
:to-remove="attachedGenericDoc"
|
||||||
ref="pickDocModal"
|
ref="pickDocModal"
|
||||||
@pickGenericDoc="onPickGenericDoc"
|
@pickGenericDoc="onPickGenericDoc"
|
||||||
></pick-generic-doc-modal>
|
></pick-generic-doc-modal>
|
||||||
<attachment-list
|
<attachment-list
|
||||||
|
:workflow="workflow"
|
||||||
:attachments="props.attachments"
|
:attachments="props.attachments"
|
||||||
@removeAttachment="onRemoveAttachment"
|
@removeAttachment="onRemoveAttachment"
|
||||||
></attachment-list>
|
></attachment-list>
|
||||||
<ul class="record_actions">
|
<ul v-if="canEditAttachement" class="record_actions">
|
||||||
<li>
|
<li>
|
||||||
<button type="button" class="btn btn-create" @click="openModal">
|
<button type="button" class="btn btn-create" @click="openModal">
|
||||||
Ajouter une pièce jointe
|
Ajouter une pièce jointe
|
||||||
|
@@ -1,10 +1,11 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { WorkflowAttachment } from "ChillMainAssets/types";
|
import { EntityWorkflow, WorkflowAttachment } from "ChillMainAssets/types";
|
||||||
import GenericDocItemBox from "ChillMainAssets/vuejs/WorkflowAttachment/Component/GenericDocItemBox.vue";
|
import GenericDocItemBox from "ChillMainAssets/vuejs/WorkflowAttachment/Component/GenericDocItemBox.vue";
|
||||||
import DocumentActionButtonsGroup from "ChillDocStoreAssets/vuejs/DocumentActionButtonsGroup.vue";
|
import DocumentActionButtonsGroup from "ChillDocStoreAssets/vuejs/DocumentActionButtonsGroup.vue";
|
||||||
|
|
||||||
interface AttachmentListProps {
|
interface AttachmentListProps {
|
||||||
attachments: WorkflowAttachment[];
|
attachments: WorkflowAttachment[];
|
||||||
|
workflow: EntityWorkflow | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const emit = defineEmits<{
|
const emit = defineEmits<{
|
||||||
@@ -36,7 +37,12 @@ const props = defineProps<AttachmentListProps>();
|
|||||||
:stored-object="a.genericDoc.storedObject"
|
:stored-object="a.genericDoc.storedObject"
|
||||||
></document-action-buttons-group>
|
></document-action-buttons-group>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li
|
||||||
|
v-if="
|
||||||
|
!workflow?._permissions
|
||||||
|
.CHILL_MAIN_WORKFLOW_ATTACHMENT_EDIT
|
||||||
|
"
|
||||||
|
>
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
class="btn btn-delete"
|
class="btn btn-delete"
|
||||||
|
@@ -6,8 +6,10 @@ import {
|
|||||||
import PickGenericDocItem from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDocItem.vue";
|
import PickGenericDocItem from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDocItem.vue";
|
||||||
import { fetch_generic_docs_by_accompanying_period } from "ChillDocStoreAssets/js/generic-doc-api";
|
import { fetch_generic_docs_by_accompanying_period } from "ChillDocStoreAssets/js/generic-doc-api";
|
||||||
import { computed, onMounted, ref } from "vue";
|
import { computed, onMounted, ref } from "vue";
|
||||||
|
import { EntityWorkflow } from "ChillMainAssets/types";
|
||||||
|
|
||||||
interface PickGenericDocProps {
|
interface PickGenericDocProps {
|
||||||
|
workflow: EntityWorkflow | null;
|
||||||
accompanyingPeriodId: number;
|
accompanyingPeriodId: number;
|
||||||
pickedList: GenericDocForAccompanyingPeriod[];
|
pickedList: GenericDocForAccompanyingPeriod[];
|
||||||
toRemove: GenericDocForAccompanyingPeriod[];
|
toRemove: GenericDocForAccompanyingPeriod[];
|
||||||
@@ -36,9 +38,21 @@ const isPicked = (genericDoc: GenericDocForAccompanyingPeriod): boolean =>
|
|||||||
) !== -1;
|
) !== -1;
|
||||||
|
|
||||||
onMounted(async () => {
|
onMounted(async () => {
|
||||||
genericDocs.value = await fetch_generic_docs_by_accompanying_period(
|
const fetchedGenericDocs = await fetch_generic_docs_by_accompanying_period(
|
||||||
props.accompanyingPeriodId,
|
props.accompanyingPeriodId,
|
||||||
);
|
);
|
||||||
|
const documentClasses = [
|
||||||
|
"Chill\\DocStoreBundle\\Entity\\AccompanyingCourseDocument",
|
||||||
|
"Chill\\PersonBundle\\Entity\\AccompanyingPeriod\\AccompanyingPeriodWorkEvaluationDocument",
|
||||||
|
"Chill\\DocStoreBundle\\Entity\\PersonDocument",
|
||||||
|
];
|
||||||
|
|
||||||
|
genericDocs.value = fetchedGenericDocs.filter(
|
||||||
|
(doc) =>
|
||||||
|
!documentClasses.includes(
|
||||||
|
props.workflow?.relatedEntityClass || "",
|
||||||
|
) || props.workflow?.relatedEntityId !== doc.identifiers.id,
|
||||||
|
);
|
||||||
loaded.value = true;
|
loaded.value = true;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@@ -3,8 +3,10 @@ import Modal from "ChillMainAssets/vuejs/_components/Modal.vue";
|
|||||||
import { computed, ref, useTemplateRef } from "vue";
|
import { computed, ref, useTemplateRef } from "vue";
|
||||||
import PickGenericDoc from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDoc.vue";
|
import PickGenericDoc from "ChillMainAssets/vuejs/WorkflowAttachment/Component/PickGenericDoc.vue";
|
||||||
import { GenericDocForAccompanyingPeriod } from "ChillDocStoreAssets/types/generic_doc";
|
import { GenericDocForAccompanyingPeriod } from "ChillDocStoreAssets/types/generic_doc";
|
||||||
|
import { EntityWorkflow } from "ChillMainAssets/types";
|
||||||
|
|
||||||
interface PickGenericDocModalProps {
|
interface PickGenericDocModalProps {
|
||||||
|
workflow: EntityWorkflow | null;
|
||||||
accompanyingPeriodId: number;
|
accompanyingPeriodId: number;
|
||||||
toRemove: GenericDocForAccompanyingPeriod[];
|
toRemove: GenericDocForAccompanyingPeriod[];
|
||||||
}
|
}
|
||||||
@@ -80,6 +82,7 @@ defineExpose({ openModal, closeModal });
|
|||||||
</template>
|
</template>
|
||||||
<template v-slot:body>
|
<template v-slot:body>
|
||||||
<pick-generic-doc
|
<pick-generic-doc
|
||||||
|
:workflow="props.workflow"
|
||||||
:accompanying-period-id="props.accompanyingPeriodId"
|
:accompanying-period-id="props.accompanyingPeriodId"
|
||||||
:to-remove="props.toRemove"
|
:to-remove="props.toRemove"
|
||||||
:picked-list="pickeds"
|
:picked-list="pickeds"
|
||||||
|
@@ -0,0 +1,62 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { WaitingScreenState } from "ChillMainAssets/types";
|
||||||
|
|
||||||
|
interface Props {
|
||||||
|
state: WaitingScreenState;
|
||||||
|
}
|
||||||
|
|
||||||
|
const props = defineProps<Props>();
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div id="waiting-screen">
|
||||||
|
<div
|
||||||
|
v-if="props.state === 'pending' && !!$slots.pending"
|
||||||
|
class="alert alert-danger text-center"
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<slot name="pending"></slot>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
<i class="fa fa-cog fa-spin fa-3x fa-fw"></i>
|
||||||
|
<span class="sr-only">Loading...</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
v-if="props.state === 'stopped' && !!$slots.stopped"
|
||||||
|
class="alert alert-info"
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<slot name="stopped"></slot>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
v-if="props.state === 'failure' && !!$slots.failure"
|
||||||
|
class="alert alert-danger text-center"
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<slot name="failure"></slot>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
v-if="props.state === 'ready' && !!$slots.ready"
|
||||||
|
class="alert alert-success text-center"
|
||||||
|
>
|
||||||
|
<div>
|
||||||
|
<slot name="ready"></slot>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
#waiting-screen {
|
||||||
|
> .alert {
|
||||||
|
min-height: 350px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
@@ -58,12 +58,14 @@
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
{% if signatures|length > 0 %}
|
||||||
|
<section class="step my-4">{% include '@ChillMain/Workflow/_signature.html.twig' %}</section>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
<section class="step my-4">{% include '@ChillMain/Workflow/_attachment.html.twig' %}</section>
|
<section class="step my-4">{% include '@ChillMain/Workflow/_attachment.html.twig' %}</section>
|
||||||
|
|
||||||
<section class="step my-4">{% include '@ChillMain/Workflow/_follow.html.twig' %}</section>
|
<section class="step my-4">{% include '@ChillMain/Workflow/_follow.html.twig' %}</section>
|
||||||
{% if signatures|length > 0 %}
|
{% if entity_workflow.currentStep.sends|length > 0 %}
|
||||||
<section class="step my-4">{% include '@ChillMain/Workflow/_signature.html.twig' %}</section>
|
|
||||||
{% elseif entity_workflow.currentStep.sends|length > 0 %}
|
|
||||||
<section class="step my-4">
|
<section class="step my-4">
|
||||||
<h2>{{ 'workflow.external_views.title'|trans({'numberOfSends': entity_workflow.currentStep.sends|length }) }}</h2>
|
<h2>{{ 'workflow.external_views.title'|trans({'numberOfSends': entity_workflow.currentStep.sends|length }) }}</h2>
|
||||||
{% include '@ChillMain/Workflow/_send_views_list.html.twig' with {'sends': entity_workflow.currentStep.sends} %}
|
{% include '@ChillMain/Workflow/_send_views_list.html.twig' with {'sends': entity_workflow.currentStep.sends} %}
|
||||||
|
@@ -0,0 +1,18 @@
|
|||||||
|
{% extends '@ChillMain/layout.html.twig' %}
|
||||||
|
|
||||||
|
{% block title %}{{ 'workflow.signature.waiting_for'|trans }}{% endblock %}
|
||||||
|
|
||||||
|
{% block css %}
|
||||||
|
{{ encore_entry_link_tags('page_workflow_waiting_post_process') }}
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block js %}
|
||||||
|
{{ encore_entry_script_tags('page_workflow_waiting_post_process') }}
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<h1>{{ block('title') }}</h1>
|
||||||
|
|
||||||
|
<div class="screen-wait" data-workflow-id="{{ workflow.id|e('html_attr') }}" data-expected-step="{{ expectedStep|e('html_attr') }}"></div>
|
||||||
|
|
||||||
|
{% endblock %}
|
@@ -0,0 +1,53 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\MainBundle\Security\Authorization;
|
||||||
|
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
|
||||||
|
use Symfony\Component\Security\Core\Authorization\Voter\Voter;
|
||||||
|
use Symfony\Component\Workflow\Registry;
|
||||||
|
|
||||||
|
final class EntityWorkflowAttachmentVoter extends Voter
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private readonly Registry $registry,
|
||||||
|
) {}
|
||||||
|
public const EDIT = 'CHILL_MAIN_WORKFLOW_ATTACHMENT_EDIT';
|
||||||
|
|
||||||
|
protected function supports(string $attribute, $subject): bool
|
||||||
|
{
|
||||||
|
return $subject instanceof EntityWorkflow && self::EDIT === $attribute;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function voteOnAttribute(string $attribute, $subject, TokenInterface $token): bool
|
||||||
|
{
|
||||||
|
if (!$subject instanceof EntityWorkflow) {
|
||||||
|
throw new \UnexpectedValueException('Subject must be an instance of EntityWorkflow');
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($subject->isFinal()) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$workflow = $this->registry->get($subject, $subject->getWorkflowName());
|
||||||
|
|
||||||
|
$marking = $workflow->getMarking($subject);
|
||||||
|
foreach ($marking->getPlaces() as $place => $int) {
|
||||||
|
$placeMetadata = $workflow->getMetadataStore()->getPlaceMetadata($place);
|
||||||
|
if ($placeMetadata['isSentExternal'] ?? false) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
@@ -12,18 +12,25 @@ declare(strict_types=1);
|
|||||||
namespace Chill\MainBundle\Serializer\Normalizer;
|
namespace Chill\MainBundle\Serializer\Normalizer;
|
||||||
|
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Chill\MainBundle\Security\Authorization\EntityWorkflowAttachmentVoter;
|
||||||
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
||||||
use Chill\MainBundle\Workflow\Helper\MetadataExtractor;
|
use Chill\MainBundle\Workflow\Helper\MetadataExtractor;
|
||||||
|
use Symfony\Component\Security\Core\Security;
|
||||||
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
|
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
|
||||||
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
|
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
|
||||||
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
||||||
use Symfony\Component\Workflow\Registry;
|
use Symfony\Component\Workflow\Registry;
|
||||||
|
|
||||||
class EntityWorkflowNormalizer implements NormalizerInterface, NormalizerAwareInterface
|
final class EntityWorkflowNormalizer implements NormalizerInterface, NormalizerAwareInterface
|
||||||
{
|
{
|
||||||
use NormalizerAwareTrait;
|
use NormalizerAwareTrait;
|
||||||
|
|
||||||
public function __construct(private readonly EntityWorkflowManager $entityWorkflowManager, private readonly MetadataExtractor $metadataExtractor, private readonly Registry $registry) {}
|
public function __construct(
|
||||||
|
private readonly EntityWorkflowManager $entityWorkflowManager,
|
||||||
|
private readonly MetadataExtractor $metadataExtractor,
|
||||||
|
private readonly Registry $registry,
|
||||||
|
private readonly Security $security,
|
||||||
|
) {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param EntityWorkflow $object
|
* @param EntityWorkflow $object
|
||||||
@@ -46,6 +53,9 @@ class EntityWorkflowNormalizer implements NormalizerInterface, NormalizerAwareIn
|
|||||||
'datas' => $this->normalizer->normalize($handler->getEntityData($object), $format, $context),
|
'datas' => $this->normalizer->normalize($handler->getEntityData($object), $format, $context),
|
||||||
'title' => $handler->getEntityTitle($object),
|
'title' => $handler->getEntityTitle($object),
|
||||||
'isOnHoldAtCurrentStep' => $object->isOnHoldAtCurrentStep(),
|
'isOnHoldAtCurrentStep' => $object->isOnHoldAtCurrentStep(),
|
||||||
|
'_permissions' => [
|
||||||
|
EntityWorkflowAttachmentVoter::EDIT => $this->security->isGranted(EntityWorkflowAttachmentVoter::EDIT, $object),
|
||||||
|
],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -0,0 +1,173 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\MainBundle\Tests\Security\Authorization;
|
||||||
|
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Chill\MainBundle\Security\Authorization\EntityWorkflowAttachmentVoter;
|
||||||
|
use Chill\MainBundle\Workflow\EntityWorkflowMarkingStore;
|
||||||
|
use Chill\MainBundle\Workflow\WorkflowTransitionContextDTO;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
|
||||||
|
use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
|
||||||
|
use Symfony\Component\Workflow\DefinitionBuilder;
|
||||||
|
use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore;
|
||||||
|
use Symfony\Component\Workflow\Registry;
|
||||||
|
use Symfony\Component\Workflow\SupportStrategy\WorkflowSupportStrategyInterface;
|
||||||
|
use Symfony\Component\Workflow\Transition;
|
||||||
|
use Symfony\Component\Workflow\Workflow;
|
||||||
|
use Symfony\Component\Workflow\WorkflowInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*
|
||||||
|
* @coversNothing
|
||||||
|
*/
|
||||||
|
class EntityWorkflowAttachmentVoterTest extends TestCase
|
||||||
|
{
|
||||||
|
use ProphecyTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider dataVoteOnAttribute
|
||||||
|
*/
|
||||||
|
public function testVoteOnAttribute(EntityWorkflow $entityWorkflow, int $expected): void
|
||||||
|
{
|
||||||
|
$voter = new EntityWorkflowAttachmentVoter($this->buildRegistry());
|
||||||
|
$actual = $voter->vote(
|
||||||
|
new UsernamePasswordToken(new User(), 'default'),
|
||||||
|
$entityWorkflow,
|
||||||
|
['CHILL_MAIN_WORKFLOW_ATTACHMENT_EDIT'],
|
||||||
|
);
|
||||||
|
$this->assertEquals($expected, $actual);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function dataVoteOnAttribute(): iterable
|
||||||
|
{
|
||||||
|
$entity = new EntityWorkflow();
|
||||||
|
$entity->setWorkflowName('dummy');
|
||||||
|
|
||||||
|
$workflow = static::buildRegistry()->get($entity, 'dummy');
|
||||||
|
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entity);
|
||||||
|
$dto->futureDestUsers[] = new User();
|
||||||
|
$workflow->apply(
|
||||||
|
$entity,
|
||||||
|
'to_final_positive',
|
||||||
|
['context' => $dto,
|
||||||
|
'byUser' => new User(),
|
||||||
|
'transition' => 'to_final_positive',
|
||||||
|
'transitionAt' => new \DateTimeImmutable()],
|
||||||
|
);
|
||||||
|
// we need to mark manually as final, as the listener is not registered
|
||||||
|
$entity->getCurrentStep()->setIsFinal(true);
|
||||||
|
|
||||||
|
yield 'on final positive' => [
|
||||||
|
$entity,
|
||||||
|
VoterInterface::ACCESS_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
$entity = new EntityWorkflow();
|
||||||
|
$entity->setWorkflowName('dummy');
|
||||||
|
|
||||||
|
$workflow = static::buildRegistry()->get($entity, 'dummy');
|
||||||
|
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entity);
|
||||||
|
$dto->futureDestUsers[] = new User();
|
||||||
|
$workflow->apply(
|
||||||
|
$entity,
|
||||||
|
'to_final_negative',
|
||||||
|
['context' => $dto,
|
||||||
|
'byUser' => new User(),
|
||||||
|
'transition' => 'to_final_negative',
|
||||||
|
'transitionAt' => new \DateTimeImmutable()],
|
||||||
|
);
|
||||||
|
// we need to mark manually as final, as the listener is not registered
|
||||||
|
$entity->getCurrentStep()->setIsFinal(true);
|
||||||
|
|
||||||
|
yield 'on final negative' => [
|
||||||
|
$entity,
|
||||||
|
VoterInterface::ACCESS_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
$entity = new EntityWorkflow();
|
||||||
|
$entity->setWorkflowName('dummy');
|
||||||
|
|
||||||
|
$workflow = static::buildRegistry()->get($entity, 'dummy');
|
||||||
|
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entity);
|
||||||
|
$dto->futureDestUsers[] = new User();
|
||||||
|
$workflow->apply(
|
||||||
|
$entity,
|
||||||
|
'to_sent_external',
|
||||||
|
['context' => $dto,
|
||||||
|
'byUser' => new User(),
|
||||||
|
'transition' => 'to_sent_external',
|
||||||
|
'transitionAt' => new \DateTimeImmutable()],
|
||||||
|
);
|
||||||
|
|
||||||
|
yield 'on sent_external' => [
|
||||||
|
$entity,
|
||||||
|
VoterInterface::ACCESS_DENIED,
|
||||||
|
];
|
||||||
|
|
||||||
|
$entity = new EntityWorkflow();
|
||||||
|
$entity->setWorkflowName('dummy');
|
||||||
|
|
||||||
|
yield 'on initial' => [
|
||||||
|
$entity,
|
||||||
|
VoterInterface::ACCESS_GRANTED,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function buildRegistry(): Registry
|
||||||
|
{
|
||||||
|
$builder = new DefinitionBuilder();
|
||||||
|
$builder
|
||||||
|
->setInitialPlaces(['initial'])
|
||||||
|
->addPlaces(['initial', 'sent_external', 'final_positive', 'final_negative'])
|
||||||
|
->addTransitions([
|
||||||
|
new Transition('to_final_positive', ['initial'], 'final_positive'),
|
||||||
|
new Transition('to_sent_external', ['initial'], 'sent_external'),
|
||||||
|
new Transition('to_final_negative', ['initial'], 'final_negative'),
|
||||||
|
|
||||||
|
])
|
||||||
|
->setMetadataStore(
|
||||||
|
new InMemoryMetadataStore(
|
||||||
|
placesMetadata: [
|
||||||
|
'sent_external' => [
|
||||||
|
'isSentExternal' => true,
|
||||||
|
],
|
||||||
|
'final_positive' => [
|
||||||
|
'isFinal' => true,
|
||||||
|
'isFinalPositive' => true,
|
||||||
|
],
|
||||||
|
'final_negative' => [
|
||||||
|
'isFinal' => true,
|
||||||
|
'isFinalPositive' => false,
|
||||||
|
],
|
||||||
|
]
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
$workflow = new Workflow($builder->build(), new EntityWorkflowMarkingStore(), name: 'dummy');
|
||||||
|
$registry = new Registry();
|
||||||
|
$registry->addWorkflow($workflow, new class () implements WorkflowSupportStrategyInterface {
|
||||||
|
public function supports(WorkflowInterface $workflow, object $subject): bool
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return $registry;
|
||||||
|
}
|
||||||
|
}
|
@@ -11,6 +11,9 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\MainBundle\Tests\Workflow\Helper;
|
namespace Chill\MainBundle\Tests\Workflow\Helper;
|
||||||
|
|
||||||
|
use Chill\DocStoreBundle\Entity\StoredObject;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflowAttachment;
|
||||||
|
use Chill\MainBundle\Repository\Workflow\EntityWorkflowAttachmentRepository;
|
||||||
use Chill\MainBundle\Workflow\Helper\WorkflowRelatedEntityPermissionHelper;
|
use Chill\MainBundle\Workflow\Helper\WorkflowRelatedEntityPermissionHelper;
|
||||||
use Chill\MainBundle\Entity\User;
|
use Chill\MainBundle\Entity\User;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
@@ -148,8 +151,11 @@ class WorkflowRelatedEntityPermissionHelperTest extends TestCase
|
|||||||
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
yield [[], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
'abstain because the user is not present as a dest user'];
|
'abstain because there is no workflow'];
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::FORCE_DENIED, new \DateTimeImmutable(),
|
||||||
|
'force deny because the user is not present as a dest user'];
|
||||||
|
|
||||||
$entityWorkflow = new EntityWorkflow();
|
$entityWorkflow = new EntityWorkflow();
|
||||||
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
@@ -171,6 +177,9 @@ class WorkflowRelatedEntityPermissionHelperTest extends TestCase
|
|||||||
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
||||||
'force grant because the user was a previous user'];
|
'force grant because the user was a previous user'];
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::FORCE_DENIED, new \DateTimeImmutable(),
|
||||||
|
'force denied because the user was not a previous user'];
|
||||||
|
|
||||||
$entityWorkflow = new EntityWorkflow();
|
$entityWorkflow = new EntityWorkflow();
|
||||||
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
$dto->futureDestUsers[] = $user = new User();
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
@@ -232,6 +241,13 @@ class WorkflowRelatedEntityPermissionHelperTest extends TestCase
|
|||||||
|
|
||||||
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
'abstain: there is a signature on a canceled workflow'];
|
'abstain: there is a signature on a canceled workflow'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('sent_external', $dto, 'to_sent_external', new \DateTimeImmutable(), $user);
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_DENIED, new \DateTimeImmutable(), 'force denied: the workflow is sent to an external user'];
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testNoWorkflow(): void
|
public function testNoWorkflow(): void
|
||||||
@@ -253,7 +269,217 @@ class WorkflowRelatedEntityPermissionHelperTest extends TestCase
|
|||||||
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
|
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
|
||||||
$entityWorkflowManager->findByRelatedEntity(Argument::type('object'))->willReturn($entityWorkflows);
|
$entityWorkflowManager->findByRelatedEntity(Argument::type('object'))->willReturn($entityWorkflows);
|
||||||
|
|
||||||
return new WorkflowRelatedEntityPermissionHelper($security->reveal(), $entityWorkflowManager->reveal(), $this->buildRegistry(), new MockClock($atDateTime ?? new \DateTimeImmutable()));
|
$repository = $this->prophesize(EntityWorkflowAttachmentRepository::class);
|
||||||
|
$repository->findByStoredObject(Argument::type(StoredObject::class))->willReturn([]);
|
||||||
|
|
||||||
|
return new WorkflowRelatedEntityPermissionHelper($security->reveal(), $entityWorkflowManager->reveal(), $repository->reveal(), $this->buildRegistry(), new MockClock($atDateTime ?? new \DateTimeImmutable()));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider provideDataAllowedByWorkflowReadOperationByAttachment
|
||||||
|
*
|
||||||
|
* @param list<EntityWorkflow> $entityWorkflows
|
||||||
|
*/
|
||||||
|
public function testAllowedByWorkflowReadByAttachment(
|
||||||
|
array $entityWorkflows,
|
||||||
|
User $user,
|
||||||
|
string $expected,
|
||||||
|
?\DateTimeImmutable $atDate,
|
||||||
|
string $message,
|
||||||
|
): void {
|
||||||
|
// all entities must have this workflow name, so we are ok to set it here
|
||||||
|
foreach ($entityWorkflows as $entityWorkflow) {
|
||||||
|
$entityWorkflow->setWorkflowName('dummy');
|
||||||
|
}
|
||||||
|
$helper = $this->buildHelperForAttachment($entityWorkflows, $user, $atDate);
|
||||||
|
|
||||||
|
self::assertEquals($expected, $helper->isAllowedByWorkflowForReadOperation(new StoredObject()), $message);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function provideDataAllowedByWorkflowReadOperationByAttachment(): iterable
|
||||||
|
{
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain because the user is not present as a dest user'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
||||||
|
'force grant because the user is a current user'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
||||||
|
'force grant because the user was a previous user'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futurePersonSignatures[] = new Person();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'Abstain: there is a signature for person, but the attachment is not concerned'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider provideDataAllowedByWorkflowWriteOperationByAttachment
|
||||||
|
*
|
||||||
|
* @param list<EntityWorkflow> $entityWorkflows
|
||||||
|
*/
|
||||||
|
public function testAllowedByWorkflowWriteByAttachment(
|
||||||
|
array $entityWorkflows,
|
||||||
|
User $user,
|
||||||
|
string $expected,
|
||||||
|
?\DateTimeImmutable $atDate,
|
||||||
|
string $message,
|
||||||
|
): void {
|
||||||
|
// all entities must have this workflow name, so we are ok to set it here
|
||||||
|
foreach ($entityWorkflows as $entityWorkflow) {
|
||||||
|
$entityWorkflow->setWorkflowName('dummy');
|
||||||
|
}
|
||||||
|
$helper = $this->buildHelperForAttachment($entityWorkflows, $user, $atDate);
|
||||||
|
|
||||||
|
self::assertEquals($expected, $helper->isAllowedByWorkflowForWriteOperation(new StoredObject()), $message);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function provideDataAllowedByWorkflowWriteOperationByAttachment(): iterable
|
||||||
|
{
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain because there is no workflow'];
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain because the user is not present as a dest user (and attachment)'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
||||||
|
'force grant because the user is a current user'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_GRANT, new \DateTimeImmutable(),
|
||||||
|
'force grant because the user was a previous user'];
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain because the user was not a previous user'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$entityWorkflow->setStep('final_positive', $dto, 'to_final_positive', new \DateTimeImmutable(), new User());
|
||||||
|
$entityWorkflow->getCurrentStep()->setIsFinal(true);
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_DENIED, new \DateTimeImmutable(),
|
||||||
|
'force denied: user was a previous user, but it is finalized positive'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$entityWorkflow->setStep('final_negative', $dto, 'to_final_negative', new \DateTimeImmutable());
|
||||||
|
$entityWorkflow->getCurrentStep()->setIsFinal(true);
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain: user was a previous user, it is finalized, but finalized negative'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futurePersonSignatures[] = new Person();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$signature = $entityWorkflow->getCurrentStep()->getSignatures()->first();
|
||||||
|
$signature->setState(EntityWorkflowSignatureStateEnum::SIGNED)->setStateDate(new \DateTimeImmutable());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain: there is a signature, but not on the attachment'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futurePersonSignatures[] = new Person();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], new User(), WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain: there is a signature, but the signature is not on the attachment'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futurePersonSignatures[] = new Person();
|
||||||
|
$entityWorkflow->setStep('test', $dto, 'to_test', new \DateTimeImmutable(), new User());
|
||||||
|
$signature = $entityWorkflow->getCurrentStep()->getSignatures()->first();
|
||||||
|
$signature->setState(EntityWorkflowSignatureStateEnum::SIGNED)->setStateDate(new \DateTimeImmutable());
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$entityWorkflow->setStep('final_negative', $dto, 'to_final_negative', new \DateTimeImmutable(), new User());
|
||||||
|
$entityWorkflow->getCurrentStep()->setIsFinal(true);
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::ABSTAIN, new \DateTimeImmutable(),
|
||||||
|
'abstain: there is a signature on a canceled workflow'];
|
||||||
|
|
||||||
|
$entityWorkflow = new EntityWorkflow();
|
||||||
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$dto->futureDestUsers[] = $user = new User();
|
||||||
|
$entityWorkflow->setStep('sent_external', $dto, 'to_sent_external', new \DateTimeImmutable(), $user);
|
||||||
|
|
||||||
|
yield [[$entityWorkflow], $user, WorkflowRelatedEntityPermissionHelper::FORCE_DENIED, new \DateTimeImmutable(),
|
||||||
|
'force denied: the workflow is sent to an external user'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param list<EntityWorkflow> $entityWorkflows
|
||||||
|
*/
|
||||||
|
private function buildHelperForAttachment(array $entityWorkflows, User $user, ?\DateTimeImmutable $atDateTime): WorkflowRelatedEntityPermissionHelper
|
||||||
|
{
|
||||||
|
$security = $this->prophesize(Security::class);
|
||||||
|
$security->getUser()->willReturn($user);
|
||||||
|
|
||||||
|
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
|
||||||
|
$entityWorkflowManager->findByRelatedEntity(Argument::type('object'))->shouldNotBeCalled();
|
||||||
|
|
||||||
|
$repository = $this->prophesize(EntityWorkflowAttachmentRepository::class);
|
||||||
|
$attachments = [];
|
||||||
|
foreach ($entityWorkflows as $entityWorkflow) {
|
||||||
|
$attachments[] = new EntityWorkflowAttachment('dummy', ['id' => 1], $entityWorkflow, new StoredObject());
|
||||||
|
}
|
||||||
|
$repository->findByStoredObject(Argument::type(StoredObject::class))->willReturn($attachments);
|
||||||
|
|
||||||
|
return new WorkflowRelatedEntityPermissionHelper($security->reveal(), $entityWorkflowManager->reveal(), $repository->reveal(), $this->buildRegistry(), new MockClock($atDateTime ?? new \DateTimeImmutable()));
|
||||||
}
|
}
|
||||||
|
|
||||||
private static function buildRegistry(): Registry
|
private static function buildRegistry(): Registry
|
||||||
@@ -261,10 +487,13 @@ class WorkflowRelatedEntityPermissionHelperTest extends TestCase
|
|||||||
$builder = new DefinitionBuilder();
|
$builder = new DefinitionBuilder();
|
||||||
$builder
|
$builder
|
||||||
->setInitialPlaces(['initial'])
|
->setInitialPlaces(['initial'])
|
||||||
->addPlaces(['initial', 'test', 'final_positive', 'final_negative'])
|
->addPlaces(['initial', 'test', 'sent_external', 'final_positive', 'final_negative'])
|
||||||
->setMetadataStore(
|
->setMetadataStore(
|
||||||
new InMemoryMetadataStore(
|
new InMemoryMetadataStore(
|
||||||
placesMetadata: [
|
placesMetadata: [
|
||||||
|
'sent_external' => [
|
||||||
|
'isSentExternal' => true,
|
||||||
|
],
|
||||||
'final_positive' => [
|
'final_positive' => [
|
||||||
'isFinal' => true,
|
'isFinal' => true,
|
||||||
'isFinalPositive' => true,
|
'isFinalPositive' => true,
|
||||||
|
@@ -11,8 +11,11 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\MainBundle\Tests\Workflow\Messenger;
|
namespace Chill\MainBundle\Tests\Workflow\Messenger;
|
||||||
|
|
||||||
|
use Chill\DocStoreBundle\Entity\StoredObject;
|
||||||
|
use Chill\DocStoreBundle\Service\StoredObjectToPdfConverter;
|
||||||
use Chill\MainBundle\Entity\User;
|
use Chill\MainBundle\Entity\User;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflowAttachment;
|
||||||
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
|
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
|
||||||
use Chill\MainBundle\Workflow\EntityWorkflowHandlerInterface;
|
use Chill\MainBundle\Workflow\EntityWorkflowHandlerInterface;
|
||||||
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
||||||
@@ -23,6 +26,7 @@ use Chill\ThirdPartyBundle\Entity\ThirdParty;
|
|||||||
use PHPUnit\Framework\TestCase;
|
use PHPUnit\Framework\TestCase;
|
||||||
use Prophecy\Argument;
|
use Prophecy\Argument;
|
||||||
use Prophecy\PhpUnit\ProphecyTrait;
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
|
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
|
||||||
use Symfony\Component\Mailer\MailerInterface;
|
use Symfony\Component\Mailer\MailerInterface;
|
||||||
use Symfony\Component\Mime\Address;
|
use Symfony\Component\Mime\Address;
|
||||||
@@ -39,24 +43,54 @@ class PostSendExternalMessageHandlerTest extends TestCase
|
|||||||
public function testSendMessageHappyScenario(): void
|
public function testSendMessageHappyScenario(): void
|
||||||
{
|
{
|
||||||
$entityWorkflow = $this->buildEntityWorkflow();
|
$entityWorkflow = $this->buildEntityWorkflow();
|
||||||
|
|
||||||
|
// Prepare attachments (2 attachments)
|
||||||
|
$attachmentStoredObject1 = new StoredObject();
|
||||||
|
$attachmentStoredObject2 = new StoredObject();
|
||||||
|
new EntityWorkflowAttachment('generic_doc', ['id' => 1], $entityWorkflow, $attachmentStoredObject1);
|
||||||
|
new EntityWorkflowAttachment('generic_doc', ['id' => 2], $entityWorkflow, $attachmentStoredObject2);
|
||||||
|
|
||||||
|
// Prepare transition DTO and sends
|
||||||
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
$dto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
$dto->futureDestineeEmails = ['external@example.com'];
|
$dto->futureDestineeEmails = ['external@example.com'];
|
||||||
$dto->futureDestineeThirdParties = [(new ThirdParty())->setEmail('3party@example.com')];
|
$dto->futureDestineeThirdParties = [(new ThirdParty())->setEmail('3party@example.com')];
|
||||||
$entityWorkflow->setStep('send_external', $dto, 'to_send_external', new \DateTimeImmutable(), new User());
|
$entityWorkflow->setStep('send_external', $dto, 'to_send_external', new \DateTimeImmutable(), new User());
|
||||||
|
|
||||||
|
// Repository returns our workflow
|
||||||
$repository = $this->prophesize(EntityWorkflowRepository::class);
|
$repository = $this->prophesize(EntityWorkflowRepository::class);
|
||||||
$repository->find(1)->willReturn($entityWorkflow);
|
$repository->find(1)->willReturn($entityWorkflow);
|
||||||
|
|
||||||
|
// Mailer must send to both recipients
|
||||||
$mailer = $this->prophesize(MailerInterface::class);
|
$mailer = $this->prophesize(MailerInterface::class);
|
||||||
$mailer->send(Argument::that($this->buildCheckAddressCallback('3party@example.com')))->shouldBeCalledOnce();
|
$mailer->send(Argument::that($this->buildCheckAddressCallback('3party@example.com')))->shouldBeCalledOnce();
|
||||||
$mailer->send(Argument::that($this->buildCheckAddressCallback('external@example.com')))->shouldBeCalledOnce();
|
$mailer->send(Argument::that($this->buildCheckAddressCallback('external@example.com')))->shouldBeCalledOnce();
|
||||||
|
|
||||||
|
// Workflow manager and handler
|
||||||
$workflowHandler = $this->prophesize(EntityWorkflowHandlerInterface::class);
|
$workflowHandler = $this->prophesize(EntityWorkflowHandlerInterface::class);
|
||||||
$workflowHandler->getEntityTitle($entityWorkflow, Argument::any())->willReturn('title');
|
$workflowHandler->getEntityTitle($entityWorkflow, Argument::any())->willReturn('title');
|
||||||
$workflowManager = $this->prophesize(EntityWorkflowManager::class);
|
$workflowManager = $this->prophesize(EntityWorkflowManager::class);
|
||||||
$workflowManager->getHandler($entityWorkflow)->willReturn($workflowHandler->reveal());
|
$workflowManager->getHandler($entityWorkflow)->willReturn($workflowHandler->reveal());
|
||||||
|
|
||||||
$handler = new PostSendExternalMessageHandler($repository->reveal(), $mailer->reveal(), $workflowManager->reveal());
|
// Associated stored object for the workflow
|
||||||
|
$associatedStoredObject = new StoredObject();
|
||||||
|
$workflowManager->getAssociatedStoredObject($entityWorkflow)->willReturn($associatedStoredObject);
|
||||||
|
|
||||||
|
// Converter should be called for each attachment and the associated stored object
|
||||||
|
$converter = $this->prophesize(StoredObjectToPdfConverter::class);
|
||||||
|
$converter->addConvertedVersion($attachmentStoredObject1, 'fr')->shouldBeCalledOnce();
|
||||||
|
$converter->addConvertedVersion($attachmentStoredObject2, 'fr')->shouldBeCalledOnce();
|
||||||
|
$converter->addConvertedVersion($associatedStoredObject, 'fr')->shouldBeCalledOnce();
|
||||||
|
|
||||||
|
// Logger (not used in happy path, but required by handler)
|
||||||
|
$logger = $this->prophesize(LoggerInterface::class);
|
||||||
|
|
||||||
|
$handler = new PostSendExternalMessageHandler(
|
||||||
|
$repository->reveal(),
|
||||||
|
$mailer->reveal(),
|
||||||
|
$workflowManager->reveal(),
|
||||||
|
$converter->reveal(),
|
||||||
|
$logger->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
$handler(new PostSendExternalMessage(1, 'fr'));
|
$handler(new PostSendExternalMessage(1, 'fr'));
|
||||||
|
|
||||||
|
@@ -11,9 +11,12 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\MainBundle\Workflow\Helper;
|
namespace Chill\MainBundle\Workflow\Helper;
|
||||||
|
|
||||||
|
use Chill\DocStoreBundle\Entity\StoredObject;
|
||||||
use Chill\MainBundle\Entity\User;
|
use Chill\MainBundle\Entity\User;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflowAttachment;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflowSignatureStateEnum;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflowSignatureStateEnum;
|
||||||
|
use Chill\MainBundle\Repository\Workflow\EntityWorkflowAttachmentRepository;
|
||||||
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
||||||
use Symfony\Component\Clock\ClockInterface;
|
use Symfony\Component\Clock\ClockInterface;
|
||||||
use Symfony\Component\Security\Core\Security;
|
use Symfony\Component\Security\Core\Security;
|
||||||
@@ -58,21 +61,39 @@ class WorkflowRelatedEntityPermissionHelper
|
|||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly Security $security,
|
private readonly Security $security,
|
||||||
private readonly EntityWorkflowManager $entityWorkflowManager,
|
private readonly EntityWorkflowManager $entityWorkflowManager,
|
||||||
|
private readonly EntityWorkflowAttachmentRepository $entityWorkflowAttachmentRepository,
|
||||||
private readonly Registry $registry,
|
private readonly Registry $registry,
|
||||||
private readonly ClockInterface $clock,
|
private readonly ClockInterface $clock,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @param object $entity The entity may be an
|
||||||
|
*
|
||||||
* @return 'FORCE_GRANT'|'FORCE_DENIED'|'ABSTAIN'
|
* @return 'FORCE_GRANT'|'FORCE_DENIED'|'ABSTAIN'
|
||||||
*/
|
*/
|
||||||
public function isAllowedByWorkflowForReadOperation(object $entity): string
|
public function isAllowedByWorkflowForReadOperation(object $entity): string
|
||||||
{
|
{
|
||||||
$entityWorkflows = $this->entityWorkflowManager->findByRelatedEntity($entity);
|
if ($entity instanceof StoredObject) {
|
||||||
|
$attachments = $this->entityWorkflowAttachmentRepository->findByStoredObject($entity);
|
||||||
|
$entityWorkflows = array_map(static fn (EntityWorkflowAttachment $attachment) => $attachment->getEntityWorkflow(), $attachments);
|
||||||
|
$isAttached = true;
|
||||||
|
} else {
|
||||||
|
$entityWorkflows = $this->entityWorkflowManager->findByRelatedEntity($entity);
|
||||||
|
$isAttached = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ([] === $entityWorkflows) {
|
||||||
|
return self::ABSTAIN;
|
||||||
|
}
|
||||||
|
|
||||||
if ($this->isUserInvolvedInAWorkflow($entityWorkflows)) {
|
if ($this->isUserInvolvedInAWorkflow($entityWorkflows)) {
|
||||||
return self::FORCE_GRANT;
|
return self::FORCE_GRANT;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ($isAttached) {
|
||||||
|
return self::ABSTAIN;
|
||||||
|
}
|
||||||
|
|
||||||
// give a view permission if there is a Person signature pending, or in the 12 hours following
|
// give a view permission if there is a Person signature pending, or in the 12 hours following
|
||||||
// the signature last state
|
// the signature last state
|
||||||
foreach ($entityWorkflows as $workflow) {
|
foreach ($entityWorkflows as $workflow) {
|
||||||
@@ -100,33 +121,51 @@ class WorkflowRelatedEntityPermissionHelper
|
|||||||
*/
|
*/
|
||||||
public function isAllowedByWorkflowForWriteOperation(object $entity): string
|
public function isAllowedByWorkflowForWriteOperation(object $entity): string
|
||||||
{
|
{
|
||||||
$entityWorkflows = $this->entityWorkflowManager->findByRelatedEntity($entity);
|
if ($entity instanceof StoredObject) {
|
||||||
$runningWorkflows = [];
|
$attachments = $this->entityWorkflowAttachmentRepository->findByStoredObject($entity);
|
||||||
|
$entityWorkflows = array_map(static fn (EntityWorkflowAttachment $attachment) => $attachment->getEntityWorkflow(), $attachments);
|
||||||
|
$isAttached = true;
|
||||||
|
} else {
|
||||||
|
$entityWorkflows = $this->entityWorkflowManager->findByRelatedEntity($entity);
|
||||||
|
$isAttached = false;
|
||||||
|
}
|
||||||
|
|
||||||
// if a workflow is finalized positive, we are not allowed to edit to document any more
|
if ([] === $entityWorkflows) {
|
||||||
|
return self::ABSTAIN;
|
||||||
|
}
|
||||||
|
|
||||||
|
// if a workflow is finalized positive, anyone is allowed to edit the document anymore
|
||||||
foreach ($entityWorkflows as $entityWorkflow) {
|
foreach ($entityWorkflows as $entityWorkflow) {
|
||||||
if ($entityWorkflow->isFinal()) {
|
$workflow = $this->registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
|
||||||
$workflow = $this->registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
|
$marking = $workflow->getMarkingStore()->getMarking($entityWorkflow);
|
||||||
$marking = $workflow->getMarkingStore()->getMarking($entityWorkflow);
|
foreach ($marking->getPlaces() as $place => $int) {
|
||||||
foreach ($marking->getPlaces() as $place => $int) {
|
$placeMetadata = $workflow->getMetadataStore()->getPlaceMetadata($place);
|
||||||
$placeMetadata = $workflow->getMetadataStore()->getPlaceMetadata($place);
|
if (
|
||||||
if (true === ($placeMetadata['isFinalPositive'] ?? false)) {
|
($entityWorkflow->isFinal() && ($placeMetadata['isFinalPositive'] ?? false))
|
||||||
// the workflow is final, and final positive, so we stop here.
|
|| ($placeMetadata['isSentExternal'] ?? false)
|
||||||
return self::FORCE_DENIED;
|
) {
|
||||||
}
|
// the workflow is final, and final positive, or is sentExternal, so we stop here.
|
||||||
|
return self::FORCE_DENIED;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
// if not finalized positive
|
||||||
|
$entityWorkflow->isFinal() && !($placeMetadata['isFinalPositive'] ?? false)
|
||||||
|
) {
|
||||||
|
return self::ABSTAIN;
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
$runningWorkflows[] = $entityWorkflow;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// if there is a signature on a **running workflow**, no one can edit the workflow any more
|
$runningWorkflows = array_filter($entityWorkflows, fn (EntityWorkflow $ew) => !$ew->isFinal());
|
||||||
foreach ($runningWorkflows as $entityWorkflow) {
|
|
||||||
foreach ($entityWorkflow->getSteps() as $step) {
|
// if there is a signature on a **running workflow**, no one is allowed edit the workflow anymore
|
||||||
foreach ($step->getSignatures() as $signature) {
|
if (!$isAttached) {
|
||||||
if (EntityWorkflowSignatureStateEnum::SIGNED === $signature->getState()) {
|
foreach ($runningWorkflows as $entityWorkflow) {
|
||||||
return self::FORCE_DENIED;
|
foreach ($entityWorkflow->getSteps() as $step) {
|
||||||
|
foreach ($step->getSignatures() as $signature) {
|
||||||
|
if (EntityWorkflowSignatureStateEnum::SIGNED === $signature->getState()) {
|
||||||
|
return self::FORCE_DENIED;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -137,7 +176,11 @@ class WorkflowRelatedEntityPermissionHelper
|
|||||||
return self::FORCE_GRANT;
|
return self::FORCE_GRANT;
|
||||||
}
|
}
|
||||||
|
|
||||||
return self::ABSTAIN;
|
if ($isAttached) {
|
||||||
|
return self::ABSTAIN;
|
||||||
|
}
|
||||||
|
|
||||||
|
return self::FORCE_DENIED;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@@ -11,9 +11,13 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\MainBundle\Workflow\Messenger;
|
namespace Chill\MainBundle\Workflow\Messenger;
|
||||||
|
|
||||||
|
use Chill\DocStoreBundle\Exception\StoredObjectManagerException;
|
||||||
|
use Chill\DocStoreBundle\Service\StoredObjectToPdfConverter;
|
||||||
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
||||||
use Chill\MainBundle\Entity\Workflow\EntityWorkflowSend;
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflowSend;
|
||||||
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
|
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
|
||||||
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
use Chill\MainBundle\Workflow\EntityWorkflowManager;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
|
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
|
||||||
use Symfony\Component\Mailer\MailerInterface;
|
use Symfony\Component\Mailer\MailerInterface;
|
||||||
use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
|
use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
|
||||||
@@ -25,6 +29,8 @@ final readonly class PostSendExternalMessageHandler implements MessageHandlerInt
|
|||||||
private EntityWorkflowRepository $entityWorkflowRepository,
|
private EntityWorkflowRepository $entityWorkflowRepository,
|
||||||
private MailerInterface $mailer,
|
private MailerInterface $mailer,
|
||||||
private EntityWorkflowManager $workflowManager,
|
private EntityWorkflowManager $workflowManager,
|
||||||
|
private StoredObjectToPdfConverter $storedObjectToPdfConverter,
|
||||||
|
private LoggerInterface $logger,
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
public function __invoke(PostSendExternalMessage $message): void
|
public function __invoke(PostSendExternalMessage $message): void
|
||||||
@@ -35,11 +41,34 @@ final readonly class PostSendExternalMessageHandler implements MessageHandlerInt
|
|||||||
throw new UnrecoverableMessageHandlingException(sprintf('Entity workflow with id %d not found', $message->entityWorkflowId));
|
throw new UnrecoverableMessageHandlingException(sprintf('Entity workflow with id %d not found', $message->entityWorkflowId));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$this->convertToPdf($entityWorkflow, $message->lang);
|
||||||
|
|
||||||
foreach ($entityWorkflow->getCurrentStep()->getSends() as $send) {
|
foreach ($entityWorkflow->getCurrentStep()->getSends() as $send) {
|
||||||
$this->sendEmailToDestinee($send, $message);
|
$this->sendEmailToDestinee($send, $message);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function convertToPdf(EntityWorkflow $entityWorkflow, string $locale): void
|
||||||
|
{
|
||||||
|
foreach ($entityWorkflow->getAttachments() as $attachment) {
|
||||||
|
try {
|
||||||
|
$this->storedObjectToPdfConverter->addConvertedVersion($attachment->getProxyStoredObject(), $locale);
|
||||||
|
} catch (StoredObjectManagerException $e) {
|
||||||
|
$this->logger->error('Error converting attachment to PDF', ['backtrace' => $e->getTraceAsString(), 'attachment_id' => $attachment->getId()]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$storedObject = $this->workflowManager->getAssociatedStoredObject($entityWorkflow);
|
||||||
|
|
||||||
|
if (null !== $storedObject) {
|
||||||
|
try {
|
||||||
|
$this->storedObjectToPdfConverter->addConvertedVersion($storedObject, $locale);
|
||||||
|
} catch (StoredObjectManagerException $e) {
|
||||||
|
$this->logger->error('Error converting stored object to PDF', ['backtrace' => $e->getTraceAsString(), 'stored_object_id' => $storedObject->getId(), 'workflow_id' => $entityWorkflow->getId()]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private function sendEmailToDestinee(EntityWorkflowSend $send, PostSendExternalMessage $message): void
|
private function sendEmailToDestinee(EntityWorkflowSend $send, PostSendExternalMessage $message): void
|
||||||
{
|
{
|
||||||
$entityWorkflow = $send->getEntityWorkflowStep()->getEntityWorkflow();
|
$entityWorkflow = $send->getEntityWorkflowStep()->getEntityWorkflow();
|
||||||
|
@@ -22,6 +22,7 @@ use Psr\Log\LoggerInterface;
|
|||||||
use Symfony\Component\Clock\ClockInterface;
|
use Symfony\Component\Clock\ClockInterface;
|
||||||
use Symfony\Component\Messenger\MessageBusInterface;
|
use Symfony\Component\Messenger\MessageBusInterface;
|
||||||
use Symfony\Component\Workflow\Registry;
|
use Symfony\Component\Workflow\Registry;
|
||||||
|
use Symfony\Component\Workflow\Transition;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles state changes for signature steps within a workflow.
|
* Handles state changes for signature steps within a workflow.
|
||||||
@@ -50,8 +51,10 @@ class SignatureStepStateChanger
|
|||||||
*
|
*
|
||||||
* @param EntityWorkflowStepSignature $signature the signature entity to be marked as signed
|
* @param EntityWorkflowStepSignature $signature the signature entity to be marked as signed
|
||||||
* @param int|null $atIndex optional index position for the signature within the zone
|
* @param int|null $atIndex optional index position for the signature within the zone
|
||||||
|
*
|
||||||
|
* @return string The expected new workflow's step, after transition is applyied
|
||||||
*/
|
*/
|
||||||
public function markSignatureAsSigned(EntityWorkflowStepSignature $signature, ?int $atIndex): void
|
public function markSignatureAsSigned(EntityWorkflowStepSignature $signature, ?int $atIndex): string
|
||||||
{
|
{
|
||||||
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
||||||
|
|
||||||
@@ -60,7 +63,14 @@ class SignatureStepStateChanger
|
|||||||
->setZoneSignatureIndex($atIndex)
|
->setZoneSignatureIndex($atIndex)
|
||||||
->setStateDate($this->clock->now());
|
->setStateDate($this->clock->now());
|
||||||
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as signed', ['signatureId' => $signature->getId(), 'index' => (string) $atIndex]);
|
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as signed', ['signatureId' => $signature->getId(), 'index' => (string) $atIndex]);
|
||||||
|
['transition' => $transition, 'futureUser' => $futureUser] = $this->decideTransition($signature);
|
||||||
|
|
||||||
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
||||||
|
if (null === $transition) {
|
||||||
|
return $signature->getStep()->getEntityWorkflow()->getStep();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $transition->getTos()[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -71,8 +81,10 @@ class SignatureStepStateChanger
|
|||||||
*
|
*
|
||||||
* This method updates the signature state to 'canceled' and logs the action.
|
* This method updates the signature state to 'canceled' and logs the action.
|
||||||
* It also dispatches a message to notify about the state change.
|
* It also dispatches a message to notify about the state change.
|
||||||
|
*
|
||||||
|
* @return string The expected new workflow's step, after transition is applyied
|
||||||
*/
|
*/
|
||||||
public function markSignatureAsCanceled(EntityWorkflowStepSignature $signature): void
|
public function markSignatureAsCanceled(EntityWorkflowStepSignature $signature): string
|
||||||
{
|
{
|
||||||
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
||||||
|
|
||||||
@@ -80,7 +92,15 @@ class SignatureStepStateChanger
|
|||||||
->setState(EntityWorkflowSignatureStateEnum::CANCELED)
|
->setState(EntityWorkflowSignatureStateEnum::CANCELED)
|
||||||
->setStateDate($this->clock->now());
|
->setStateDate($this->clock->now());
|
||||||
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as canceled', ['signatureId' => $signature->getId()]);
|
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as canceled', ['signatureId' => $signature->getId()]);
|
||||||
|
|
||||||
|
['transition' => $transition, 'futureUser' => $futureUser] = $this->decideTransition($signature);
|
||||||
|
|
||||||
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
||||||
|
if (null === $transition) {
|
||||||
|
return $signature->getStep()->getEntityWorkflow()->getStep();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $transition->getTos()[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -93,8 +113,10 @@ class SignatureStepStateChanger
|
|||||||
* a state change has occurred.
|
* a state change has occurred.
|
||||||
*
|
*
|
||||||
* @param EntityWorkflowStepSignature $signature the signature entity to be marked as rejected
|
* @param EntityWorkflowStepSignature $signature the signature entity to be marked as rejected
|
||||||
|
*
|
||||||
|
* @return string The expected new workflow's step, after transition is applyied
|
||||||
*/
|
*/
|
||||||
public function markSignatureAsRejected(EntityWorkflowStepSignature $signature): void
|
public function markSignatureAsRejected(EntityWorkflowStepSignature $signature): string
|
||||||
{
|
{
|
||||||
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_WRITE);
|
||||||
|
|
||||||
@@ -102,7 +124,16 @@ class SignatureStepStateChanger
|
|||||||
->setState(EntityWorkflowSignatureStateEnum::REJECTED)
|
->setState(EntityWorkflowSignatureStateEnum::REJECTED)
|
||||||
->setStateDate($this->clock->now());
|
->setStateDate($this->clock->now());
|
||||||
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as rejected', ['signatureId' => $signature->getId()]);
|
$this->logger->info(self::LOG_PREFIX.'Mark signature entity as rejected', ['signatureId' => $signature->getId()]);
|
||||||
|
|
||||||
|
['transition' => $transition, 'futureUser' => $futureUser] = $this->decideTransition($signature);
|
||||||
|
|
||||||
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
$this->messageBus->dispatch(new PostSignatureStateChangeMessage((int) $signature->getId()));
|
||||||
|
|
||||||
|
if (null === $transition) {
|
||||||
|
return $signature->getStep()->getEntityWorkflow()->getStep();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $transition->getTos()[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -117,10 +148,35 @@ class SignatureStepStateChanger
|
|||||||
{
|
{
|
||||||
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_READ);
|
$this->entityManager->refresh($signature, LockMode::PESSIMISTIC_READ);
|
||||||
|
|
||||||
|
['transition' => $transition, 'futureUser' => $futureUser] = $this->decideTransition($signature);
|
||||||
|
|
||||||
|
if (null === $transition) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$entityWorkflow = $signature->getStep()->getEntityWorkflow();
|
||||||
|
$workflow = $this->registry->get($entityWorkflow, $entityWorkflow->getWorkflowName());
|
||||||
|
$transitionDto = new WorkflowTransitionContextDTO($entityWorkflow);
|
||||||
|
$transitionDto->futureDestUsers[] = $futureUser;
|
||||||
|
|
||||||
|
$workflow->apply($entityWorkflow, $transition->getName(), [
|
||||||
|
'context' => $transitionDto,
|
||||||
|
'transitionAt' => $this->clock->now(),
|
||||||
|
'transition' => $transition->getName(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->logger->info(self::LOG_PREFIX.'Transition automatically applied', ['signatureId' => $signature->getId()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array{transition: Transition|null, futureUser: User|null}
|
||||||
|
*/
|
||||||
|
private function decideTransition(EntityWorkflowStepSignature $signature): array
|
||||||
|
{
|
||||||
if (!EntityWorkflowStepSignature::isAllSignatureNotPendingForStep($signature->getStep())) {
|
if (!EntityWorkflowStepSignature::isAllSignatureNotPendingForStep($signature->getStep())) {
|
||||||
$this->logger->info(self::LOG_PREFIX.'This is not the last signature, skipping transition to another place', ['signatureId' => $signature->getId()]);
|
$this->logger->info(self::LOG_PREFIX.'This is not the last signature, skipping transition to another place', ['signatureId' => $signature->getId()]);
|
||||||
|
|
||||||
return;
|
return ['transition' => null, 'futureUser' => null];
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->logger->debug(self::LOG_PREFIX.'Continuing the process to find a transition', ['signatureId' => $signature->getId()]);
|
$this->logger->debug(self::LOG_PREFIX.'Continuing the process to find a transition', ['signatureId' => $signature->getId()]);
|
||||||
@@ -144,7 +200,7 @@ class SignatureStepStateChanger
|
|||||||
if (null === $transition) {
|
if (null === $transition) {
|
||||||
$this->logger->info(self::LOG_PREFIX.'The transition is not configured, will not apply a transition', ['signatureId' => $signature->getId()]);
|
$this->logger->info(self::LOG_PREFIX.'The transition is not configured, will not apply a transition', ['signatureId' => $signature->getId()]);
|
||||||
|
|
||||||
return;
|
return ['transition' => null, 'futureUser' => null];
|
||||||
}
|
}
|
||||||
|
|
||||||
if ('person' === $signature->getSignerKind()) {
|
if ('person' === $signature->getSignerKind()) {
|
||||||
@@ -156,19 +212,16 @@ class SignatureStepStateChanger
|
|||||||
if (null === $futureUser) {
|
if (null === $futureUser) {
|
||||||
$this->logger->info(self::LOG_PREFIX.'No previous user, will not apply a transition', ['signatureId' => $signature->getId()]);
|
$this->logger->info(self::LOG_PREFIX.'No previous user, will not apply a transition', ['signatureId' => $signature->getId()]);
|
||||||
|
|
||||||
return;
|
return ['transition' => null, 'futureUser' => null];
|
||||||
}
|
}
|
||||||
|
|
||||||
$transitionDto = new WorkflowTransitionContextDTO($entityWorkflow);
|
foreach ($workflow->getDefinition()->getTransitions() as $transitionObj) {
|
||||||
$transitionDto->futureDestUsers[] = $futureUser;
|
if ($transitionObj->getName() === $transition) {
|
||||||
|
return ['transition' => $transitionObj, 'futureUser' => $futureUser];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$workflow->apply($entityWorkflow, $transition, [
|
throw new \RuntimeException('Transition not found');
|
||||||
'context' => $transitionDto,
|
|
||||||
'transitionAt' => $this->clock->now(),
|
|
||||||
'transition' => $transition,
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->logger->info(self::LOG_PREFIX.'Transition automatically applied', ['signatureId' => $signature->getId()]);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private function getPreviousSender(EntityWorkflowStep $entityWorkflowStep): ?User
|
private function getPreviousSender(EntityWorkflowStep $entityWorkflowStep): ?User
|
||||||
|
@@ -965,6 +965,31 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/UserJob"
|
$ref: "#/components/schemas/UserJob"
|
||||||
|
/1.0/main/workflow/{id}.json:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- workflow
|
||||||
|
summary: Return a workflow
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
description: The workflow id
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
format: integer
|
||||||
|
minimum: 1
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: "ok"
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/Workflow"
|
||||||
|
404:
|
||||||
|
description: "not found"
|
||||||
|
401:
|
||||||
|
description: "Unauthorized"
|
||||||
/1.0/main/workflow/my:
|
/1.0/main/workflow/my:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
@@ -120,5 +120,8 @@ module.exports = function (encore, entries) {
|
|||||||
"vue_onthefly",
|
"vue_onthefly",
|
||||||
__dirname + "/Resources/public/vuejs/OnTheFly/index.js",
|
__dirname + "/Resources/public/vuejs/OnTheFly/index.js",
|
||||||
);
|
);
|
||||||
|
encore.addEntry(
|
||||||
|
"page_workflow_waiting_post_process",
|
||||||
|
__dirname + "/Resources/public/vuejs/WaitPostProcessWorkflow/index.ts"
|
||||||
|
);
|
||||||
};
|
};
|
||||||
|
@@ -666,10 +666,17 @@ workflow:
|
|||||||
cancel_are_you_sure: Êtes-vous sûr de vouloir annuler la signature de %signer%
|
cancel_are_you_sure: Êtes-vous sûr de vouloir annuler la signature de %signer%
|
||||||
reject_signature_of: Rejet de la signature de %signer%
|
reject_signature_of: Rejet de la signature de %signer%
|
||||||
reject_are_you_sure: Êtes-vous sûr de vouloir rejeter la signature de %signer%
|
reject_are_you_sure: Êtes-vous sûr de vouloir rejeter la signature de %signer%
|
||||||
|
waiting_for: En attente de modification de l'état de la signature
|
||||||
|
|
||||||
attachments:
|
attachments:
|
||||||
title: Pièces jointes
|
title: Pièces jointes
|
||||||
|
|
||||||
|
wait:
|
||||||
|
title: En attente de traitement
|
||||||
|
error_while_waiting: Le traitement a échoué
|
||||||
|
success: Traitement terminé. Redirection en cours...
|
||||||
|
|
||||||
|
|
||||||
Subscribe final: Recevoir une notification à l'étape finale
|
Subscribe final: Recevoir une notification à l'étape finale
|
||||||
Subscribe all steps: Recevoir une notification à chaque étape
|
Subscribe all steps: Recevoir une notification à chaque étape
|
||||||
CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION: Appliquer les transitions sur tous les workflows
|
CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION: Appliquer les transitions sur tous les workflows
|
||||||
|
Reference in New Issue
Block a user