From 6c47ce53e7ef3848861eb329c6497381da9dcb0c Mon Sep 17 00:00:00 2001 From: Pol Dellaiera Date: Tue, 14 Sep 2021 15:06:22 +0200 Subject: [PATCH 01/37] chore: Remove duplicated entry from composer.json. --- composer.json | 1 - 1 file changed, 1 deletion(-) diff --git a/composer.json b/composer.json index 88e3c520a..ab244d40d 100644 --- a/composer.json +++ b/composer.json @@ -53,7 +53,6 @@ "symfony/validator": "4.*", "sensio/framework-extra-bundle": "^5.5", "symfony/yaml": "4.*", - "symfony/webpack-encore-bundle": "^1.11", "knplabs/knp-menu": "^3.1", "knplabs/knp-menu-bundle": "^3.0", "symfony/templating": "4.*", From fe533bc716105660d8c98ee1f2b1a98dacab1676 Mon Sep 17 00:00:00 2001 From: Pol Dellaiera Date: Tue, 14 Sep 2021 15:07:23 +0200 Subject: [PATCH 02/37] chore: Normalize `composer.json` file. --- composer.json | 116 +++++++++++++++++++++++++------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/composer.json b/composer.json index ab244d40d..a2aa29a5a 100644 --- a/composer.json +++ b/composer.json @@ -1,12 +1,69 @@ { "name": "chill-project/chill-bundles", - "license": "AGPL-3.0-only", "type": "library", "description": "Most used bundles for chill-project", "keywords": [ "chill", "social worker" ], + "license": "AGPL-3.0-only", + "require": { + "champs-libres/async-uploader-bundle": "dev-sf4", + "champs-libres/wopi-bundle": "dev-master", + "composer/package-versions-deprecated": "^1.10", + "doctrine/doctrine-bundle": "^2.1", + "doctrine/doctrine-migrations-bundle": "^3.0", + "doctrine/orm": "^2.7", + "erusev/parsedown": "^1.7", + "graylog2/gelf-php": "^1.5", + "knplabs/knp-menu": "^3.1", + "knplabs/knp-menu-bundle": "^3.0", + "knplabs/knp-time-bundle": "^1.12", + "league/csv": "^9.7.1", + "nyholm/psr7": "^1.4", + "phpoffice/phpspreadsheet": "^1.16", + "sensio/framework-extra-bundle": "^5.5", + "symfony/asset": "4.*", + "symfony/browser-kit": "^5.2", + "symfony/css-selector": "^5.2", + "symfony/expression-language": "4.*", + "symfony/form": "4.*", + "symfony/intl": "4.*", + "symfony/monolog-bundle": "^3.5", + "symfony/security-bundle": "4.*", + "symfony/serializer": "^5.2", + "symfony/swiftmailer-bundle": "^3.5", + "symfony/templating": "4.*", + "symfony/translation": "4.*", + "symfony/twig-bundle": "^4.4", + "symfony/validator": "4.*", + "symfony/webpack-encore-bundle": "^1.11", + "symfony/workflow": "4.*", + "symfony/yaml": "4.*", + "twig/extra-bundle": "^2.12 || ^3.0", + "twig/intl-extra": "^3.0", + "twig/markdown-extra": "^3.3", + "twig/twig": "^2.12 || ^3.0" + }, + "conflict": { + "symfony/symfony": "*" + }, + "require-dev": { + "doctrine/doctrine-fixtures-bundle": "^3.3", + "fakerphp/faker": "^1.13", + "nelmio/alice": "^3.8", + "phpunit/phpunit": "^7.0", + "symfony/debug-bundle": "^5.1", + "symfony/dotenv": "^5.1", + "symfony/maker-bundle": "^1.20", + "symfony/phpunit-bridge": "^5.2", + "symfony/stopwatch": "^5.1", + "symfony/var-dumper": "4.*", + "symfony/web-profiler-bundle": "^5.0" + }, + "config": { + "bin-dir": "bin" + }, "autoload": { "psr-4": { "Chill\\ActivityBundle\\": "src/Bundle/ChillActivityBundle", @@ -33,67 +90,10 @@ }, "minimum-stability": "dev", "prefer-stable": true, - "require": { - "champs-libres/async-uploader-bundle": "dev-sf4", - "champs-libres/wopi-bundle": "dev-master", - "nyholm/psr7": "^1.4", - "graylog2/gelf-php": "^1.5", - "symfony/form": "4.*", - "symfony/twig-bundle": "^4.4", - "twig/extra-bundle": "^2.12|^3.0", - "twig/twig": "^2.12|^3.0", - "composer/package-versions-deprecated": "^1.10", - "doctrine/doctrine-bundle": "^2.1", - "doctrine/doctrine-migrations-bundle": "^3.0", - "doctrine/orm": "^2.7", - "symfony/asset": "4.*", - "symfony/monolog-bundle": "^3.5", - "symfony/security-bundle": "4.*", - "symfony/translation": "4.*", - "symfony/validator": "4.*", - "sensio/framework-extra-bundle": "^5.5", - "symfony/yaml": "4.*", - "knplabs/knp-menu": "^3.1", - "knplabs/knp-menu-bundle": "^3.0", - "symfony/templating": "4.*", - "twig/intl-extra": "^3.0", - "symfony/workflow": "4.*", - "symfony/expression-language": "4.*", - "knplabs/knp-time-bundle": "^1.12", - "symfony/intl": "4.*", - "symfony/swiftmailer-bundle": "^3.5", - "league/csv": "^9.7.1", - "phpoffice/phpspreadsheet": "^1.16", - "symfony/browser-kit": "^5.2", - "symfony/css-selector": "^5.2", - "twig/markdown-extra": "^3.3", - "erusev/parsedown": "^1.7", - "symfony/serializer": "^5.2", - "symfony/webpack-encore-bundle": "^1.11" - }, - "conflict": { - "symfony/symfony": "*" - }, - "require-dev": { - "fakerphp/faker": "^1.13", - "phpunit/phpunit": "^7.0", - "symfony/dotenv": "^5.1", - "symfony/maker-bundle": "^1.20", - "doctrine/doctrine-fixtures-bundle": "^3.3", - "symfony/stopwatch": "^5.1", - "symfony/web-profiler-bundle": "^5.0", - "symfony/var-dumper": "4.*", - "symfony/debug-bundle": "^5.1", - "symfony/phpunit-bridge": "^5.2", - "nelmio/alice": "^3.8" - }, "scripts": { "auto-scripts": { "cache:clear": "symfony-cmd", "assets:install %PUBLIC_DIR%": "symfony-cmd" } - }, - "config": { - "bin-dir": "bin" } } From 951d686366cd778374f32e9a835a13d2fc79725a Mon Sep 17 00:00:00 2001 From: Pol Dellaiera Date: Tue, 14 Sep 2021 15:08:00 +0200 Subject: [PATCH 03/37] refactor: Update WOPI related stuff based on upstream changes. --- src/Bundle/ChillWopiBundle/src/Resources/config/services.php | 2 +- src/Bundle/ChillWopiBundle/src/Service/Wopi/ChillWopi.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Bundle/ChillWopiBundle/src/Resources/config/services.php b/src/Bundle/ChillWopiBundle/src/Resources/config/services.php index a40796607..455e658e2 100644 --- a/src/Bundle/ChillWopiBundle/src/Resources/config/services.php +++ b/src/Bundle/ChillWopiBundle/src/Resources/config/services.php @@ -10,7 +10,7 @@ declare(strict_types=1); namespace Symfony\Component\DependencyInjection\Loader\Configurator; use ChampsLibres\AsyncUploaderBundle\TempUrl\TempUrlGeneratorInterface; -use ChampsLibres\WopiLib\WopiInterface; +use ChampsLibres\WopiLib\Service\Contract\WopiInterface; use Chill\WopiBundle\Service\Wopi\ChillWopi; return static function (ContainerConfigurator $container) { diff --git a/src/Bundle/ChillWopiBundle/src/Service/Wopi/ChillWopi.php b/src/Bundle/ChillWopiBundle/src/Service/Wopi/ChillWopi.php index bb0dfb8e2..fc4e526a1 100644 --- a/src/Bundle/ChillWopiBundle/src/Service/Wopi/ChillWopi.php +++ b/src/Bundle/ChillWopiBundle/src/Service/Wopi/ChillWopi.php @@ -11,7 +11,7 @@ namespace Chill\WopiBundle\Service\Wopi; use ChampsLibres\AsyncUploaderBundle\TempUrl\TempUrlGeneratorInterface; use ChampsLibres\WopiLib\Discovery\WopiDiscoveryInterface; -use ChampsLibres\WopiLib\WopiInterface; +use ChampsLibres\WopiLib\Service\Contract\WopiInterface; use Chill\DocStoreBundle\Repository\StoredObjectRepository; use Exception; use loophp\psr17\Psr17Interface; @@ -228,7 +228,7 @@ final class ChillWopi implements WopiInterface ->withBody($this->psr17->createStream((string) json_encode([]))); } - public function putRelativeFile(string $fileId, ?string $accessToken, RequestInterface $request): ResponseInterface + public function putRelativeFile(string $fileId, string $accessToken, ?string $suggestedTarget, ?string $relativeTarget, bool $overwriteRelativeTarget, int $size, RequestInterface $request): ResponseInterface { return $this->getDebugResponse(__FUNCTION__, $request); } From 03e86245281d01c1ad9ca37cbb7fd45392814494 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 1 Sep 2021 14:03:23 +0200 Subject: [PATCH 04/37] entity person: allow center to be not null --- .../ChillPersonBundle/Entity/Person.php | 1 - .../migrations/Version20210831140339.php | 29 +++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 src/Bundle/ChillPersonBundle/migrations/Version20210831140339.php diff --git a/src/Bundle/ChillPersonBundle/Entity/Person.php b/src/Bundle/ChillPersonBundle/Entity/Person.php index 35db2ef83..5bfe3bd10 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person.php @@ -254,7 +254,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var Center * * @ORM\ManyToOne(targetEntity="Chill\MainBundle\Entity\Center") - * @ORM\JoinColumn(nullable=false) */ private $center; diff --git a/src/Bundle/ChillPersonBundle/migrations/Version20210831140339.php b/src/Bundle/ChillPersonBundle/migrations/Version20210831140339.php new file mode 100644 index 000000000..dd3a60d75 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/migrations/Version20210831140339.php @@ -0,0 +1,29 @@ +addSql('ALTER TABLE chill_person_person ALTER center_id DROP NOT NULL'); + } + + public function down(Schema $schema): void + { + $this->addSql('ALTER TABLE chill_person_person ALTER center_id SET NOT NULL'); + } +} From eec798cfd3b908de56b591a406e8f5f50a9237df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 1 Sep 2021 14:04:40 +0200 Subject: [PATCH 05/37] entity person: create a validator to check a person entity is linked with a center This validator take a parameter in configuration --- .../ChillPersonExtension.php | 3 ++ .../DependencyInjection/Configuration.php | 33 ++++++------ .../Person/PersonHasCenterValidatorTest.php | 50 +++++++++++++++++++ .../Constraints/Person/PersonHasCenter.php | 15 ++++++ .../Person/PersonHasCenterValidator.php | 41 +++++++++++++++ 5 files changed, 127 insertions(+), 15 deletions(-) create mode 100644 src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonHasCenterValidatorTest.php create mode 100644 src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php create mode 100644 src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenterValidator.php diff --git a/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php b/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php index 07d5dc88f..48ac993c3 100644 --- a/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php +++ b/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php @@ -60,6 +60,9 @@ class ChillPersonExtension extends Extension implements PrependExtensionInterfac $container->setParameter('chill_person.allow_multiple_simultaneous_accompanying_periods', $config['allow_multiple_simultaneous_accompanying_periods']); + // register all configuration in a unique parameter + $container->setParameter('chill_person', $config); + $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../config')); $loader->load('services.yaml'); $loader->load('services/widgets.yaml'); diff --git a/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php b/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php index 927612d5f..7daec4f63 100644 --- a/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php +++ b/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php @@ -44,22 +44,25 @@ class Configuration implements ConfigurationInterface ->canBeDisabled() ->children() ->scalarNode('birthdate_not_after') - ->info($this->validationBirthdateNotAfterInfos) - ->defaultValue('P1D') - ->validate() - ->ifTrue(function($period) { - try { - $interval = new \DateInterval($period); - } catch (\Exception $ex) { - return true; - } - return false; - }) - ->thenInvalid('Invalid period for birthdate validation : "%s" ' - . 'The parameter should match duration as defined by ISO8601 : ' - . 'https://en.wikipedia.org/wiki/ISO_8601#Durations') + ->info($this->validationBirthdateNotAfterInfos) + ->defaultValue('P1D') + ->validate() + ->ifTrue(function($period) { + try { + $interval = new \DateInterval($period); + } catch (\Exception $ex) { + return true; + } + return false; + }) + ->thenInvalid('Invalid period for birthdate validation : "%s" ' + . 'The parameter should match duration as defined by ISO8601 : ' + . 'https://en.wikipedia.org/wiki/ISO_8601#Durations') ->end() // birthdate_not_after, parent = children of validation - + ->booleanNode('center_required') + ->info('Enable a center for each person entity. If disabled, you must provide your own center provider') + ->defaultValue(true) + ->end() ->end() // children for 'validation', parent = validation ->end() //validation, parent = children of root ->end() // children of root, parent = root diff --git a/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonHasCenterValidatorTest.php b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonHasCenterValidatorTest.php new file mode 100644 index 000000000..8cd0e6b83 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonHasCenterValidatorTest.php @@ -0,0 +1,50 @@ +getConstraint(); + $personHasCenter = (new Person())->setCenter(new Center()); + $personNoCenter = new Person(); + + $this->validator->validate($personHasCenter, $constraint); + $this->assertNoViolation(); + + $this->validator->validate($personNoCenter, $constraint); + $this->buildViolation('msg') + ->atPath('property.path.center') + ->assertRaised(); + } + + protected function getConstraint() + { + return new PersonHasCenter([ + 'message' => 'msg' + ]); + } + + protected function createValidator() + { + $parameterBag = $this->createMock(ParameterBagInterface::class); + $parameterBag + ->method('get') + ->with($this->equalTo('chill_person')) + ->willReturn([ + 'validation' => [ + 'center_required' => true + ] + ]) + ; + + return new PersonHasCenterValidator($parameterBag); + } +} diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php new file mode 100644 index 000000000..c6c8c7c14 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php @@ -0,0 +1,15 @@ +centerRequired = $parameterBag->get('chill_person')['validation']['center_required']; + } + + /** + * @inheritDoc + */ + public function validate($person, Constraint $constraint) + { + if (!$person instanceof Person) { + throw new UnexpectedTypeException($constraint, Person::class); + } + + if (!$this->centerRequired) { + return; + } + + if (NULL === $person->getCenter()) { + $this + ->context + ->buildViolation($constraint->message) + ->atPath('center') + ->addViolation() + ; + } + } +} From 7faddbe3feaf7b41b0bec1613909d3598fe54e68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 1 Sep 2021 14:41:27 +0200 Subject: [PATCH 06/37] move birthday validator to namespace person + rewrite tests --- .../Validator/BirthdateValidatorTest.php | 112 ------------------ .../Person/BirthdateValidatorTest.php | 72 +++++++++++ .../Constraints/{ => Person}/Birthdate.php | 11 +- .../{ => Person}/BirthdateValidator.php | 22 ++-- 4 files changed, 86 insertions(+), 131 deletions(-) delete mode 100644 src/Bundle/ChillPersonBundle/Tests/Validator/BirthdateValidatorTest.php create mode 100644 src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php rename src/Bundle/ChillPersonBundle/Validator/Constraints/{ => Person}/Birthdate.php (89%) rename src/Bundle/ChillPersonBundle/Validator/Constraints/{ => Person}/BirthdateValidator.php (94%) diff --git a/src/Bundle/ChillPersonBundle/Tests/Validator/BirthdateValidatorTest.php b/src/Bundle/ChillPersonBundle/Tests/Validator/BirthdateValidatorTest.php deleted file mode 100644 index 57b4c2577..000000000 --- a/src/Bundle/ChillPersonBundle/Tests/Validator/BirthdateValidatorTest.php +++ /dev/null @@ -1,112 +0,0 @@ - - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see . - */ - -namespace Chill\PersonBundle\Tests\Validator; - -use Chill\PersonBundle\Validator\Constraints\BirthdateValidator; -use Chill\PersonBundle\Validator\Constraints\Birthdate; -use Prophecy\Argument; -use Prophecy\Prophet; - -/** - * Test the behaviour of BirthdayValidator - * - * @author Julien Fastré - */ -class BirthdateValidatorTest extends \PHPUnit\Framework\TestCase -{ - /** - * A prophecy for \Symfony\Component\Validator\Context\ExecutionContextInterface - * - * Will reveal \Symfony\Component\Validator\Context\ExecutionContextInterface - */ - private $context; - - private $prophet; - - /** - * - * @var Birthdate - */ - private $constraint; - - public function setUp() - { - $this->prophet = new Prophet; - - $constraintViolationBuilder = $this->prophet->prophesize(); - $constraintViolationBuilder->willImplement('Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface'); - - $constraintViolationBuilder->setParameter(Argument::any(), Argument::any()) - ->willReturn($constraintViolationBuilder->reveal()); - $constraintViolationBuilder->addViolation() - ->willReturn($constraintViolationBuilder->reveal()); - - $this->context = $this->prophet->prophesize(); - $this->context->willImplement('Symfony\Component\Validator\Context\ExecutionContextInterface'); - $this->context->buildViolation(Argument::type('string')) - ->willReturn($constraintViolationBuilder->reveal()); - - $this->constraint = new Birthdate(); - } - - public function testValidBirthDate() - { - - $date = new \DateTime('2015-01-01'); - - $birthdateValidator = new BirthdateValidator(); - $birthdateValidator->initialize($this->context->reveal()); - - $birthdateValidator->validate($date, $this->constraint); - - $this->context->buildViolation(Argument::any())->shouldNotHaveBeenCalled(); - } - - public function testInvalidBirthDate() - { - $date = new \DateTime('tomorrow'); - - $birthdateValidator = new BirthdateValidator(); - $birthdateValidator->initialize($this->context->reveal()); - - $birthdateValidator->validate($date, $this->constraint); - - $this->context->buildViolation(Argument::type('string'))->shouldHaveBeenCalled(); - } - - public function testInvalidBirthDateWithParameter() - { - $date = (new \DateTime('today'))->sub(new \DateInterval('P1M')); - - $birthdateValidator = new BirthdateValidator('P1Y'); - $birthdateValidator->initialize($this->context->reveal()); - - $birthdateValidator->validate($date, $this->constraint); - - $this->context->buildViolation(Argument::type('string'))->shouldHaveBeenCalled(); - } - - public function tearDown() - { - $this->prophet->checkPredictions(); - } - - -} diff --git a/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php new file mode 100644 index 000000000..2e7df4817 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php @@ -0,0 +1,72 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +namespace Chill\PersonBundle\Tests\Validator\Person; + +use Chill\PersonBundle\Validator\Constraints\Person\BirthdateValidator; +use Chill\PersonBundle\Validator\Constraints\Person\Birthdate; +use Symfony\Component\Validator\Test\ConstraintValidatorTestCase; +use Chill\PersonBundle\Entity\Person; + +/** + * Test the behaviour of BirthdayValidator + * + * @author Julien Fastré + */ +class BirthdateValidatorTest extends ConstraintValidatorTestCase +{ + + public function testValidateTodayInvalid() + { + $bornToday = new \DateTime('now'); + $this->validator->validate($bornToday, $this->createConstraint()); + $this->buildViolation('msg') + ->setParameter('%date%', (new \DateTime('yesterday'))->format('d-m-Y')) + ->assertRaised(); + } + + public function testValidateYesterdayValid() + { + $bornYesterday = new \DateTime('yesterday'); + $this->validator->validate($bornYesterday, $this->createConstraint()); + $this->assertNoViolation(); + } + + public function testTomorrowInvalid() + { + $bornAfter = new \DateTime('+2 days'); + $this->validator->validate($bornAfter, $this->createConstraint()); + $this->buildViolation('msg') + ->setParameter('%date%', (new \DateTime('yesterday'))->format('d-m-Y')) + ->assertRaised(); + } + + private function createConstraint() + { + return new Birthdate([ + 'message' => 'msg' + ]); + } + + + protected function createValidator() + { + return new BirthdateValidator('P1D'); + } +} diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/Birthdate.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php similarity index 89% rename from src/Bundle/ChillPersonBundle/Validator/Constraints/Birthdate.php rename to src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php index d09d549fd..b8cf6d8c2 100644 --- a/src/Bundle/ChillPersonBundle/Validator/Constraints/Birthdate.php +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php @@ -17,14 +17,14 @@ * along with this program. If not, see . */ -namespace Chill\PersonBundle\Validator\Constraints; +namespace Chill\PersonBundle\Validator\Constraints\Person; use Symfony\Component\Validator\Constraint; /** * Create a constraint on birth date: the birthdate after today are not allowed. - * - * It is possible to add a delay before today, expressed as described in + * + * It is possible to add a delay before today, expressed as described in * interval_spec : http://php.net/manual/en/dateinterval.construct.php * (this interval_spec itself is based on ISO8601 : * https://en.wikipedia.org/wiki/ISO_8601#Durations) @@ -34,9 +34,4 @@ use Symfony\Component\Validator\Constraint; class Birthdate extends Constraint { public $message = "The birthdate must be before %date%"; - - public function validatedBy() - { - return 'birthdate_not_before'; - } } diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/BirthdateValidator.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php similarity index 94% rename from src/Bundle/ChillPersonBundle/Validator/Constraints/BirthdateValidator.php rename to src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php index cba955ef6..5d16be230 100644 --- a/src/Bundle/ChillPersonBundle/Validator/Constraints/BirthdateValidator.php +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php @@ -17,49 +17,49 @@ * along with this program. If not, see . */ -namespace Chill\PersonBundle\Validator\Constraints; +namespace Chill\PersonBundle\Validator\Constraints\Person; use Symfony\Component\Validator\Constraint; use Symfony\Component\Validator\ConstraintValidator; /** - * + * * * @author Julien Fastré */ class BirthdateValidator extends ConstraintValidator { private $interval_spec = null; - + public function __construct($interval_spec = null) { $this->interval_spec = $interval_spec; } - + public function validate($value, Constraint $constraint) { if ($value === NULL) { - + return; } - + if (!$value instanceof \DateTime) { throw new \LogicException('The input should a be a \DateTime interface,' . (is_object($value) ? get_class($value) : gettype($value))); } - + $limitDate = $this->getLimitDate(); - + if ($limitDate < $value) { $this->context->buildViolation($constraint->message) ->setParameter('%date%', $limitDate->format('d-m-Y')) ->addViolation(); } - + } - + /** - * + * * @return \DateTime */ private function getLimitDate() From 41d76542b4682443e37da4f5a559baf695118313 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 1 Sep 2021 16:06:20 +0200 Subject: [PATCH 07/37] move validation on person into annotations --- .../DependencyInjection/Configuration.php | 32 +++---- .../ChillPersonBundle/Entity/Person.php | 84 +++++++++++++++++-- .../Person/BirthdateValidatorTest.php | 2 + .../Validator/Person/PersonValidationTest.php | 55 ++++++++++++ .../Constraints/Person/Birthdate.php | 4 +- .../Constraints/Person/BirthdateValidator.php | 1 + .../Constraints/Person/PersonHasCenter.php | 3 + .../ChillPersonBundle/config/services.yaml | 14 ++-- .../ChillPersonBundle/config/validation.yaml | 67 --------------- 9 files changed, 165 insertions(+), 97 deletions(-) create mode 100644 src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonValidationTest.php diff --git a/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php b/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php index 7daec4f63..bf2d18922 100644 --- a/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php +++ b/src/Bundle/ChillPersonBundle/DependencyInjection/Configuration.php @@ -43,26 +43,26 @@ class Configuration implements ConfigurationInterface ->arrayNode('validation') ->canBeDisabled() ->children() - ->scalarNode('birthdate_not_after') - ->info($this->validationBirthdateNotAfterInfos) - ->defaultValue('P1D') - ->validate() - ->ifTrue(function($period) { - try { - $interval = new \DateInterval($period); - } catch (\Exception $ex) { - return true; - } - return false; - }) - ->thenInvalid('Invalid period for birthdate validation : "%s" ' - . 'The parameter should match duration as defined by ISO8601 : ' - . 'https://en.wikipedia.org/wiki/ISO_8601#Durations') - ->end() // birthdate_not_after, parent = children of validation ->booleanNode('center_required') ->info('Enable a center for each person entity. If disabled, you must provide your own center provider') ->defaultValue(true) ->end() + ->scalarNode('birthdate_not_after') + ->info($this->validationBirthdateNotAfterInfos) + ->defaultValue('P1D') + ->validate() + ->ifTrue(function($period) { + try { + $interval = new \DateInterval($period); + } catch (\Exception $ex) { + return true; + } + return false; + }) + ->thenInvalid('Invalid period for birthdate validation : "%s" ' + . 'The parameter should match duration as defined by ISO8601 : ' + . 'https://en.wikipedia.org/wiki/ISO_8601#Durations') + ->end() // birthdate_not_after, parent = children of validation ->end() // children for 'validation', parent = validation ->end() //validation, parent = children of root ->end() // children of root, parent = root diff --git a/src/Bundle/ChillPersonBundle/Entity/Person.php b/src/Bundle/ChillPersonBundle/Entity/Person.php index 5bfe3bd10..f42ca6f00 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person.php @@ -43,6 +43,11 @@ use Doctrine\Common\Collections\Criteria; use Symfony\Component\Validator\Context\ExecutionContextInterface; use Symfony\Component\Serializer\Annotation\DiscriminatorMap; use Chill\PersonBundle\Entity\Household\PersonHouseholdAddress; +use Symfony\Component\Validator\Constraints as Assert; +use Chill\PersonBundle\Validator\Constraints\Person\Birthdate; +use Chill\MainBundle\Validation\Constraint\PhonenumberConstraint; +use Chill\PersonBundle\Validator\Constraints\Person\PersonHasCenter; +use Chill\PersonBundle\Validator\Constraints\Household\HouseholdMembershipSequential; /** * Person Class @@ -57,6 +62,12 @@ use Chill\PersonBundle\Entity\Household\PersonHouseholdAddress; * @DiscriminatorMap(typeProperty="type", mapping={ * "person"=Person::class * }) + * @PersonHasCenter( + * groups={"general", "creation"} + * ) + * @HouseholdMembershipSequential( + * groups={"household_memberships"} + * ) */ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateInterface { @@ -75,6 +86,13 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="string", length=255) + * @Assert\NotBlank( + * groups={"general", "creation"} + * ) + * @Assert\Length( + * max=255, + * groups={"general", "creation"} + * ) */ private $firstName; @@ -83,6 +101,13 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="string", length=255) + * @Assert\NotBlank( + * groups={"general", "creation"} + * ) + * @Assert\Length( + * max=255, + * groups={"general", "creation"} + * ) */ private $lastName; @@ -102,6 +127,12 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var \DateTime * * @ORM\Column(type="date", nullable=true) + * @Assert\Date( + * groups={"general", "creation"} + * ) + * @Birthdate( + * groups={"general", "creation"} + * ) */ private $birthdate; @@ -110,6 +141,9 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var \DateTimeImmutable * * @ORM\Column(type="date_immutable", nullable=true) + * @Assert\Date( + * groups={"general", "creation"} + * ) */ private ?\DateTimeImmutable $deathdate; @@ -150,6 +184,9 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="string", length=9, nullable=true) + * @Assert\NotNull( + * groups={"general", "creation"} + * ) */ private $gender; @@ -179,8 +216,11 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var \DateTime * * @ORM\Column(type="date", nullable=true) + * @Assert\Date( + * groups={"general", "creation"} + * ) */ - private $maritalStatusDate; + private ?\DateTime $maritalStatusDate; /** * Comment on marital status @@ -202,6 +242,10 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="text", nullable=true) + * @Assert\Email( + * checkMX=true, + * groups={"general", "creation"} + * ) */ private $email = ''; @@ -210,6 +254,14 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="text", length=40, nullable=true) + * @Assert\Regex( + * pattern="/^([\+{1}])([0-9\s*]{4,20})$/", + * groups={"general", "creation"} + * ) + * @PhonenumberConstraint( + * type="landline", + * groups={"general", "creation"} + * ) */ private $phonenumber = ''; @@ -218,6 +270,14 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * @var string * * @ORM\Column(type="text", length=40, nullable=true) + * @Assert\Regex( + * pattern="/^([\+{1}])([0-9\s*]{4,20})$/", + * groups={"general", "creation"} + * ) + * @PhonenumberConstraint( + * type="mobile", + * groups={"general", "creation"} + * ) */ private $mobilenumber = ''; @@ -230,12 +290,13 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * cascade={"persist", "remove", "merge", "detach"}, * orphanRemoval=true * ) + * @Assert\Valid( + * traverse=true, + * groups={"general", "creation"} + * ) */ private $otherPhoneNumbers; - //TO-ADD caseOpeningDate - //TO-ADD nativeLanguag - /** * The person's spoken languages * @var ArrayCollection @@ -352,6 +413,8 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI private $addresses; /** + * fullname canonical. Read-only field, which is calculated by + * the database. * @var string * * @ORM\Column(type="text", nullable=true) @@ -372,6 +435,8 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI private array $currentHouseholdAt = []; /** + * Read-only field, computed by the database + * * @ORM\OneToMany( * targetEntity=PersonHouseholdAddress::class, * mappedBy="person" @@ -389,8 +454,6 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI /** * Person constructor. - * - * @param \DateTime|null $opening */ public function __construct() { @@ -403,6 +466,7 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI $this->householdAddresses = new ArrayCollection(); $this->genderComment = new CommentEmbeddable(); $this->maritalStatusComment = new CommentEmbeddable(); + $this->periodLocatedOn = new ArrayCollection(); } /** @@ -1200,6 +1264,10 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * Validation callback that checks if the accompanying periods are valid * * This method add violation errors. + * + * @Assert\Callback( + * groups={"accompanying_period_consistent"} + * ) */ public function isAccompanyingPeriodValid(ExecutionContextInterface $context) { @@ -1245,6 +1313,10 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * two addresses with the same validFrom date) * * This method add violation errors. + * + * @Assert\Callback( + * groups={"addresses_consistent"} + * ) */ public function isAddressesValid(ExecutionContextInterface $context) { diff --git a/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php index 2e7df4817..6c726dd1c 100644 --- a/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php +++ b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/BirthdateValidatorTest.php @@ -38,6 +38,7 @@ class BirthdateValidatorTest extends ConstraintValidatorTestCase $this->validator->validate($bornToday, $this->createConstraint()); $this->buildViolation('msg') ->setParameter('%date%', (new \DateTime('yesterday'))->format('d-m-Y')) + ->setCode('3f42fd96-0b2d-11ec-8cf3-0f3b1b1ca1c4') ->assertRaised(); } @@ -54,6 +55,7 @@ class BirthdateValidatorTest extends ConstraintValidatorTestCase $this->validator->validate($bornAfter, $this->createConstraint()); $this->buildViolation('msg') ->setParameter('%date%', (new \DateTime('yesterday'))->format('d-m-Y')) + ->setCode('3f42fd96-0b2d-11ec-8cf3-0f3b1b1ca1c4') ->assertRaised(); } diff --git a/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonValidationTest.php b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonValidationTest.php new file mode 100644 index 000000000..8d6c930d9 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Tests/Validator/Person/PersonValidationTest.php @@ -0,0 +1,55 @@ +validator = self::$container->get(ValidatorInterface::class); + } + + public function testFirstnameValidation() + { + $person = (new Person()) + ->setFirstname(\str_repeat('a', 500)); + $errors = $this->validator->validate($person, null, ["creation"]); + foreach ($errors->getIterator() as $error) { + if (Length::TOO_LONG_ERROR === $error->getCode()) { + $this->assertTrue(true, + "error code for firstname too long is present"); + return; + } + } + $this->assertTrue(false, + "error code for fistname too long is present"); + + } + + public function testBirthdateInFuture() + { + $person = (new Person()) + ->setBirthdate(new \Datetime('+2 months')); + $errors = $this->validator->validate($person, null, ["creation"]); + foreach ($errors->getIterator() as $error) { + if (Birthdate::BIRTHDATE_INVALID_CODE === $error->getCode()) { + $this->assertTrue(true, + "error code for birthdate invalid is present"); + return; + } + } + $this->assertTrue(false, + "error code for birthdate invalid is present"); + + } + +} diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php index b8cf6d8c2..20f3ed97b 100644 --- a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/Birthdate.php @@ -29,9 +29,11 @@ use Symfony\Component\Validator\Constraint; * (this interval_spec itself is based on ISO8601 : * https://en.wikipedia.org/wiki/ISO_8601#Durations) * - * @author Julien Fastré + * @Annotation */ class Birthdate extends Constraint { + public const BIRTHDATE_INVALID_CODE = '3f42fd96-0b2d-11ec-8cf3-0f3b1b1ca1c4'; + public $message = "The birthdate must be before %date%"; } diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php index 5d16be230..238a3d160 100644 --- a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/BirthdateValidator.php @@ -53,6 +53,7 @@ class BirthdateValidator extends ConstraintValidator if ($limitDate < $value) { $this->context->buildViolation($constraint->message) ->setParameter('%date%', $limitDate->format('d-m-Y')) + ->setCode(Birthdate::BIRTHDATE_INVALID_CODE) ->addViolation(); } diff --git a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php index c6c8c7c14..5cabd8838 100644 --- a/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php +++ b/src/Bundle/ChillPersonBundle/Validator/Constraints/Person/PersonHasCenter.php @@ -2,6 +2,9 @@ namespace Chill\PersonBundle\Validator\Constraints\Person; +/** + * @Annotation + */ class PersonHasCenter extends \Symfony\Component\Validator\Constraint { public string $message = "A center is required"; diff --git a/src/Bundle/ChillPersonBundle/config/services.yaml b/src/Bundle/ChillPersonBundle/config/services.yaml index c2f60a729..bf4b8ddd8 100644 --- a/src/Bundle/ChillPersonBundle/config/services.yaml +++ b/src/Bundle/ChillPersonBundle/config/services.yaml @@ -62,18 +62,18 @@ services: - { name: security.voter } - { name: chill.role } - chill.person.birthdate_validation: - class: Chill\PersonBundle\Validator\Constraints\BirthdateValidator + Chill\PersonBundle\Validator\Constraints\: + autowire: true + autoconfigure: true + resource: '../Validator/Constraints/' + + # override default config, must be loaded after resource + Chill\PersonBundle\Validator\Constraints\BirthdateValidator: arguments: - "%chill_person.validation.birtdate_not_before%" tags: - { name: validator.constraint_validator, alias: birthdate_not_before } - Chill\PersonBundle\Validator\Constraints\Household\HouseholdMembershipSequentialValidator: - autowire: true - tags: - - { name: validator.constraint_validator } - Chill\PersonBundle\Repository\: autowire: true autoconfigure: true diff --git a/src/Bundle/ChillPersonBundle/config/validation.yaml b/src/Bundle/ChillPersonBundle/config/validation.yaml index 23369a467..c41513778 100644 --- a/src/Bundle/ChillPersonBundle/config/validation.yaml +++ b/src/Bundle/ChillPersonBundle/config/validation.yaml @@ -1,70 +1,3 @@ -Chill\PersonBundle\Entity\Person: - properties: - firstName: - - NotBlank: - groups: [general, creation] - - Length: - min: 2 - max: 255 - minMessage: 'This name is too short. It must containt {{ limit }} chars' - maxMessage: 'This name is too long. It must containt {{ limit }} chars' - groups: [general, creation] - lastName: - - NotBlank: - groups: [general, creation] - - Length: - min: 2 - max: 255 - minMessage: 'This name is too short. It must containt {{ limit }} chars' - maxMessage: 'This name is too long. It must containt {{ limit }} chars' - groups: [general, creation] - birthdate: - - Date: - message: 'Birthdate not valid' - groups: [general, creation] - - Chill\PersonBundle\Validator\Constraints\Birthdate: - groups: [general, creation] - gender: - - NotNull: - groups: [general, creation] - #accompanyingPeriods: - # - Valid: - # traverse: true - email: - - Email: - groups: [general, creation] - message: 'The email is not valid' - checkMX: true - phonenumber: - - Regex: - pattern: '/^([\+{1}])([0-9\s*]{4,20})$/' - groups: [general, creation] - message: 'Invalid phone number: it should begin with the international prefix starting with "+", hold only digits and be smaller than 20 characters. Ex: +33123456789' - - Chill\MainBundle\Validation\Constraint\PhonenumberConstraint: - type: landline - groups: [ general, creation ] - mobilenumber: - - Regex: - pattern: '/^([\+{1}])([0-9\s*]{4,20})$/' - groups: [general, creation] - message: 'Invalid phone number: it should begin with the international prefix starting with "+", hold only digits and be smaller than 20 characters. Ex: +33623456789' - - Chill\MainBundle\Validation\Constraint\PhonenumberConstraint: - type: mobile - groups: [ general, creation ] - otherPhoneNumbers: - - Valid: - traverse: true - constraints: - - Callback: - callback: isAccompanyingPeriodValid - groups: [accompanying_period_consistent] - - Callback: - callback: isAddressesValid - groups: [addresses_consistent] - - Chill\PersonBundle\Validator\Constraints\Household\HouseholdMembershipSequential: - groups: [ 'household_memberships' ] - - Chill\PersonBundle\Entity\AccompanyingPeriod: properties: openingDate: From 24506554523dd0997ef257637d64ae5e01dc464e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 1 Sep 2021 17:04:24 +0200 Subject: [PATCH 08/37] enable autoloading for form in person bundle --- .../Form/Type/Select2MaritalStatusType.php | 18 ++--- .../ChillPersonBundle/config/services.yaml | 8 --- .../config/services/form.yaml | 71 ++----------------- 3 files changed, 15 insertions(+), 82 deletions(-) diff --git a/src/Bundle/ChillPersonBundle/Form/Type/Select2MaritalStatusType.php b/src/Bundle/ChillPersonBundle/Form/Type/Select2MaritalStatusType.php index 0cff8ee51..34fd9897e 100644 --- a/src/Bundle/ChillPersonBundle/Form/Type/Select2MaritalStatusType.php +++ b/src/Bundle/ChillPersonBundle/Form/Type/Select2MaritalStatusType.php @@ -20,6 +20,9 @@ namespace Chill\PersonBundle\Form\Type; +use Chill\MainBundle\Templating\TranslatableStringHelper; +use Chill\PersonBundle\Entity\MaritalStatus; +use Doctrine\ORM\EntityManagerInterface; use Symfony\Component\Form\AbstractType; use Symfony\Component\OptionsResolver\OptionsResolver; use Chill\MainBundle\Form\Type\DataTransformer\ObjectToIdTransformer; @@ -35,15 +38,13 @@ use Chill\MainBundle\Form\Type\Select2ChoiceType; */ class Select2MaritalStatusType extends AbstractType { - /** @var RequestStack */ - private $requestStack; + private EntityManagerInterface $em; - /** @var ObjectManager */ - private $em; + private TranslatableStringHelper $translatableStringHelper; - public function __construct(RequestStack $requestStack,ObjectManager $em) + public function __construct(TranslatableStringHelper $translatableStringHelper, EntityManagerInterface $em) { - $this->requestStack = $requestStack; + $this->translatableStringHelper = $translatableStringHelper; $this->em = $em; } @@ -63,18 +64,17 @@ class Select2MaritalStatusType extends AbstractType public function configureOptions(OptionsResolver $resolver) { - $locale = $this->requestStack->getCurrentRequest()->getLocale(); $maritalStatuses = $this->em->getRepository('Chill\PersonBundle\Entity\MaritalStatus')->findAll(); $choices = array(); foreach ($maritalStatuses as $ms) { - $choices[$ms->getId()] = $ms->getName()[$locale]; + $choices[$ms->getId()] = $this->translatableStringHelper->localize($ms->getName()); } asort($choices, SORT_STRING | SORT_FLAG_CASE); $resolver->setDefaults(array( - 'class' => 'Chill\PersonBundle\Entity\MaritalStatus', + 'class' => MaritalStatus::class, 'choices' => array_combine(array_values($choices),array_keys($choices)) )); } diff --git a/src/Bundle/ChillPersonBundle/config/services.yaml b/src/Bundle/ChillPersonBundle/config/services.yaml index bf4b8ddd8..43e042e6b 100644 --- a/src/Bundle/ChillPersonBundle/config/services.yaml +++ b/src/Bundle/ChillPersonBundle/config/services.yaml @@ -24,14 +24,6 @@ services: tags: - { name: console.command } - chill.person.form.type.select2maritalstatus: - class: Chill\PersonBundle\Form\Type\Select2MaritalStatusType - arguments: - - "@request_stack" - - "@doctrine.orm.entity_manager" - tags: - - { name: form.type, alias: select2_chill_marital_status } - chill.person.timeline.accompanying_period_opening: class: Chill\PersonBundle\Timeline\TimelineAccompanyingPeriodOpening arguments: diff --git a/src/Bundle/ChillPersonBundle/config/services/form.yaml b/src/Bundle/ChillPersonBundle/config/services/form.yaml index b61de615d..dacfa41de 100644 --- a/src/Bundle/ChillPersonBundle/config/services/form.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/form.yaml @@ -1,5 +1,10 @@ services: + Chill\PersonBundle\Form\: + autowire: true + autoconfigure: true + resource: '../../Form/' + Chill\PersonBundle\Form\PersonType: arguments: - '%chill_person.person_fields%' @@ -7,14 +12,7 @@ services: tags: - { name: form.type, alias: '@chill.person.form.person_creation' } - Chill\PersonBundle\Form\CreationPersonType: - arguments: - - '@chill.main.form.data_transformer.center_transformer' - - '@Chill\PersonBundle\Config\ConfigPersonAltNamesHelper' - tags: - - { name: form.type, alias: '@chill.main.form.person_creation' } - - chill.person.accompanying_period_closing_motive: + Chill\PersonBundle\Form\Type\ClosingMotivePickerType: class: Chill\PersonBundle\Form\Type\ClosingMotivePickerType arguments: $translatableStringHelper: '@Chill\MainBundle\Templating\TranslatableStringHelper' @@ -28,60 +26,3 @@ services: $config: "%chill_person.accompanying_period_fields%" tags: - { name: form.type } - - chill.person.form.type.pick_person: - class: Chill\PersonBundle\Form\Type\PickPersonType - arguments: - - '@Chill\PersonBundle\Repository\PersonRepository' - - "@security.token_storage" - - "@chill.main.security.authorization.helper" - - '@Symfony\Component\Routing\Generator\UrlGeneratorInterface' - - '@Symfony\Component\Translation\TranslatorInterface' - tags: - - { name: form.type } - - Chill\PersonBundle\Form\Type\PersonAltNameType: - arguments: - $configHelper: '@Chill\PersonBundle\Config\ConfigPersonAltNamesHelper' - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } - - Chill\PersonBundle\Form\Type\PersonPhoneType: - arguments: - $phonenumberHelper: '@Chill\MainBundle\Phonenumber\PhonenumberHelper' - $em: '@Doctrine\ORM\EntityManagerInterface' - tags: - - { name: form.type } - - Chill\PersonBundle\Form\SocialWork\SocialIssueType: - arguments: - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } - - Chill\PersonBundle\Form\SocialWork\SocialActionType: - arguments: - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } - - Chill\PersonBundle\Form\SocialWork\EvaluationType: - arguments: - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } - - - Chill\PersonBundle\Form\SocialWork\GoalType: - arguments: - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } - - - Chill\PersonBundle\Form\SocialWork\ResultType: - arguments: - $translatableStringHelper: '@chill.main.helper.translatable_string' - tags: - - { name: form.type } From 5b70fb2ee569b8dc186d8af616e50c77abeb7d09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 3 Sep 2021 12:41:41 +0200 Subject: [PATCH 09/37] adapt UI and controller for Person without centers --- .../ChillMainBundle/Form/Type/CenterType.php | 7 ++- .../Resolver/CenterResolverDispatcher.php | 34 +++++++++++++ .../Resolver/CenterResolverInterface.php | 19 ++++++++ .../Resolver/DefaultCenterResolver.php | 30 ++++++++++++ .../Resolver/ResolverTwigExtension.php | 36 ++++++++++++++ .../translations/messages.fr.yml | 1 + .../Controller/PersonController.php | 15 +++--- .../Form/CreationPersonType.php | 22 ++++++--- .../Resources/views/Entity/person.html.twig | 4 +- .../views/Person/banner_custom.html.twig | 4 +- .../Resources/views/Person/create.html.twig | 7 ++- .../ChillPersonBundle/Search/PersonSearch.php | 17 ++++--- .../Security/Authorization/PersonVoter.php | 48 ++++++++++--------- .../config/services/security.yaml | 5 +- 14 files changed, 196 insertions(+), 53 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/DefaultCenterResolver.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/ResolverTwigExtension.php diff --git a/src/Bundle/ChillMainBundle/Form/Type/CenterType.php b/src/Bundle/ChillMainBundle/Form/Type/CenterType.php index ba039c938..0366e8ccf 100644 --- a/src/Bundle/ChillMainBundle/Form/Type/CenterType.php +++ b/src/Bundle/ChillMainBundle/Form/Type/CenterType.php @@ -95,9 +95,12 @@ class CenterType extends AbstractType public function configureOptions(OptionsResolver $resolver) { if (count($this->reachableCenters) > 1) { - $resolver->setDefault('class', Center::class); - $resolver->setDefault('choices', $this->reachableCenters); + $resolver->setDefault('class', Center::class) + ->setDefault('choices', $this->reachableCenters) + ->setDefault('placeholder', 'Pick a center') + ; } + } /** diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php new file mode 100644 index 000000000..6b1f2a897 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php @@ -0,0 +1,34 @@ +resolvers = $resolvers; + } + + /** + * @param mixed $entity + * @param array|null $options + * @return null|Center|Center[] + */ + public function resolveCenter($entity, ?array $options = []) + { + foreach($this->resolvers as $priority => $resolver) { + if ($resolver->supports($entity, $options)) { + return $resolver->resolveCenter($entity, $options); + } + } + + return null; + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverInterface.php b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverInterface.php new file mode 100644 index 000000000..db49874b7 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverInterface.php @@ -0,0 +1,19 @@ +getCenter(); + } + + public static function getDefaultPriority(): int + { + return -256; + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/ResolverTwigExtension.php b/src/Bundle/ChillMainBundle/Security/Resolver/ResolverTwigExtension.php new file mode 100644 index 000000000..21ece21a3 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/ResolverTwigExtension.php @@ -0,0 +1,36 @@ +centerResolverDispatcher = $centerResolverDispatcher; + } + + public function getFilters() + { + return [ + new TwigFilter('chill_resolve_center', [$this, 'resolveCenter']) + ]; + } + + /** + * @param mixed $entity + * @param array|null $options + * @return Center|Center[]|null + */ + public function resolveCenter($entity, ?array $options = []) + { + return $this->centerResolverDispatcher->resolveCenter($entity, $options); + } + +} diff --git a/src/Bundle/ChillMainBundle/translations/messages.fr.yml b/src/Bundle/ChillMainBundle/translations/messages.fr.yml index b230b6ac1..59dcd8c73 100644 --- a/src/Bundle/ChillMainBundle/translations/messages.fr.yml +++ b/src/Bundle/ChillMainBundle/translations/messages.fr.yml @@ -177,6 +177,7 @@ Exports list: Liste des exports Create an export: Créer un export #export creation step 'center' : pick a center Pick centers: Choisir les centres +Pick a center: Choisir un centre The export will contains only data from the picked centers.: L'export ne contiendra que les données des centres choisis. This will eventually restrict your possibilities in filtering the data.: Les possibilités de filtrages seront adaptées aux droits de consultation pour les centres choisis. Go to export options: Vers la préparation de l'export diff --git a/src/Bundle/ChillPersonBundle/Controller/PersonController.php b/src/Bundle/ChillPersonBundle/Controller/PersonController.php index 759f892b2..03da97d5f 100644 --- a/src/Bundle/ChillPersonBundle/Controller/PersonController.php +++ b/src/Bundle/ChillPersonBundle/Controller/PersonController.php @@ -230,13 +230,16 @@ final class PersonController extends AbstractController */ public function newAction(Request $request) { - $defaultCenter = $this->security - ->getUser() - ->getGroupCenters()[0] - ->getCenter(); + $person = new Person(); - $person = (new Person(new \DateTime('now'))) - ->setCenter($defaultCenter); + if (1 === count($this->security->getUser() + ->getGroupCenters())) { + $person->setCenter( + $this->security->getUser() + ->getGroupCenters()[0] + ->getCenter() + ); + } $form = $this->createForm(CreationPersonType::class, $person, [ 'validation_groups' => ['create'] diff --git a/src/Bundle/ChillPersonBundle/Form/CreationPersonType.php b/src/Bundle/ChillPersonBundle/Form/CreationPersonType.php index 32b7a69f2..36d088c25 100644 --- a/src/Bundle/ChillPersonBundle/Form/CreationPersonType.php +++ b/src/Bundle/ChillPersonBundle/Form/CreationPersonType.php @@ -21,7 +21,9 @@ namespace Chill\PersonBundle\Form; +use Chill\MainBundle\Form\Event\CustomizeFormEvent; use Chill\PersonBundle\Entity\Person; +use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\Form\AbstractType; use Symfony\Component\Form\FormBuilderInterface; use Symfony\Component\OptionsResolver\OptionsResolver; @@ -33,6 +35,7 @@ use Chill\PersonBundle\Form\Type\GenderType; use Chill\MainBundle\Form\Type\DataTransformer\CenterTransformer; use Chill\PersonBundle\Config\ConfigPersonAltNamesHelper; use Chill\PersonBundle\Form\Type\PersonAltNameType; +use Chill\MainBundle\Form\Type\Export\PickCenterType; final class CreationPersonType extends AbstractType { @@ -40,10 +43,6 @@ final class CreationPersonType extends AbstractType // TODO: See if this is still valid and update accordingly. const NAME = 'chill_personbundle_person_creation'; - const FORM_NOT_REVIEWED = 'not_reviewed'; - const FORM_REVIEWED = 'reviewed' ; - const FORM_BEING_REVIEWED = 'being_reviewed'; - /** * * @var CenterTransformer @@ -56,12 +55,16 @@ final class CreationPersonType extends AbstractType */ protected $configPersonAltNamesHelper; + private EventDispatcherInterface $dispatcher; + public function __construct( CenterTransformer $centerTransformer, - ConfigPersonAltNamesHelper $configPersonAltNamesHelper + ConfigPersonAltNamesHelper $configPersonAltNamesHelper, + EventDispatcherInterface $dispatcher ) { $this->centerTransformer = $centerTransformer; $this->configPersonAltNamesHelper = $configPersonAltNamesHelper; + $this->dispatcher = $dispatcher; } /** @@ -79,7 +82,9 @@ final class CreationPersonType extends AbstractType ->add('gender', GenderType::class, array( 'required' => true, 'placeholder' => null )) - ->add('center', CenterType::class) + ->add('center', CenterType::class, [ + 'required' => false + ]) ; if ($this->configPersonAltNamesHelper->hasAltNames()) { @@ -87,6 +92,11 @@ final class CreationPersonType extends AbstractType 'by_reference' => false ]); } + + $this->dispatcher->dispatch( + new CustomizeFormEvent(static::class, $builder), + CustomizeFormEvent::NAME + ); } /** diff --git a/src/Bundle/ChillPersonBundle/Resources/views/Entity/person.html.twig b/src/Bundle/ChillPersonBundle/Resources/views/Entity/person.html.twig index f60b7dc9e..612a5609c 100644 --- a/src/Bundle/ChillPersonBundle/Resources/views/Entity/person.html.twig +++ b/src/Bundle/ChillPersonBundle/Resources/views/Entity/person.html.twig @@ -146,10 +146,10 @@ {% endif %} {% endif %} - {% if options['addCenter'] %} + {% if options['addCenter'] and person|chill_resolve_center is not null %}
  • - {{ person.center }} + {{ person|chill_resolve_center.name }}
    • {% endif %} diff --git a/src/Bundle/ChillPersonBundle/Resources/views/Person/banner_custom.html.twig b/src/Bundle/ChillPersonBundle/Resources/views/Person/banner_custom.html.twig index d01a53c22..564f1803e 100644 --- a/src/Bundle/ChillPersonBundle/Resources/views/Person/banner_custom.html.twig +++ b/src/Bundle/ChillPersonBundle/Resources/views/Person/banner_custom.html.twig @@ -17,11 +17,11 @@ {%- endif -%}
    - {%- if chill_person.fields.spoken_languages == 'visible' -%} + {% if person|chill_resolve_center is not null%} {{ 'Center'|trans|upper}} : - {{ person.center.name|upper }} + {{ person|chill_resolve_center.name|upper }} {%- endif -%}
    diff --git a/src/Bundle/ChillPersonBundle/Resources/views/Person/create.html.twig b/src/Bundle/ChillPersonBundle/Resources/views/Person/create.html.twig index 7056f25a3..bd1042dd7 100644 --- a/src/Bundle/ChillPersonBundle/Resources/views/Person/create.html.twig +++ b/src/Bundle/ChillPersonBundle/Resources/views/Person/create.html.twig @@ -76,10 +76,9 @@ {{ form_row(form.gender, { 'label' : 'Gender'|trans }) }} -
    - {# TODO remove this field (vendee) #} - {{ form_row(form.center, { 'label' : 'Center'|trans }) }} -
    + {% if form.center is defined %} + {{ form_row(form.center) }} + {% endif %}
    • diff --git a/src/Bundle/ChillPersonBundle/Search/PersonSearch.php b/src/Bundle/ChillPersonBundle/Search/PersonSearch.php index fe938999a..231636fff 100644 --- a/src/Bundle/ChillPersonBundle/Search/PersonSearch.php +++ b/src/Bundle/ChillPersonBundle/Search/PersonSearch.php @@ -153,7 +153,7 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, protected function search(array $terms, $start, $limit, array $options = array()) { $qb = $this->createQuery($terms, 'search'); - + if ($options['simplify'] ?? false) { $qb->select( 'p.id', @@ -176,7 +176,7 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, $qb ->orderBy('p.firstName') ->addOrderBy('p.lastName'); - + if ($options['simplify'] ?? false) { return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); } else { @@ -291,10 +291,15 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, //restraint center for security $reachableCenters = $this->helper->getReachableCenters($this->user, new Role('CHILL_PERSON_SEE')); - $qb->andWhere($qb->expr() - ->in('p.center', ':centers')) - ->setParameter('centers', $reachableCenters) - ; + $qb->andWhere( + $qb->expr()->orX( + $qb->expr() + ->in('p.center', ':centers'), + $qb->expr() + ->isNull('p.center') + ) + ); + $qb->setParameter('centers', $reachableCenters); $this->_cacheQuery[$cacheKey] = $qb; diff --git a/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php b/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php index f81a6efa1..e68d90365 100644 --- a/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php +++ b/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php @@ -23,16 +23,12 @@ use Chill\MainBundle\Security\Authorization\AbstractChillVoter; use Chill\MainBundle\Entity\User; use Chill\MainBundle\Security\Authorization\AuthorizationHelper; use Chill\MainBundle\Security\ProvideRoleHierarchyInterface; +use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; use Chill\PersonBundle\Entity\Person; use Chill\MainBundle\Entity\Center; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; use Symfony\Component\Security\Core\Role\Role; -/** - * - * - * @author Julien Fastré - */ class PersonVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterface { const CREATE = 'CHILL_PERSON_CREATE'; @@ -41,18 +37,19 @@ class PersonVoter extends AbstractChillVoter implements ProvideRoleHierarchyInte const STATS = 'CHILL_PERSON_STATS'; const LISTS = 'CHILL_PERSON_LISTS'; const DUPLICATE = 'CHILL_PERSON_DUPLICATE'; - - /** - * - * @var AuthorizationHelper - */ - protected $helper; - - public function __construct(AuthorizationHelper $helper) - { + + protected AuthorizationHelper $helper; + + protected CenterResolverDispatcher $centerResolverDispatcher; + + public function __construct( + AuthorizationHelper $helper, + CenterResolverDispatcher $centerResolverDispatcher + ) { $this->helper = $helper; + $this->centerResolverDispatcher = $centerResolverDispatcher; } - + protected function supports($attribute, $subject) { if ($subject instanceof Person) { @@ -69,23 +66,30 @@ class PersonVoter extends AbstractChillVoter implements ProvideRoleHierarchyInte return false; } } - + protected function voteOnAttribute($attribute, $subject, TokenInterface $token) { if (!$token->getUser() instanceof User) { return false; } - + if ($subject === null) { - $centers = $this->helper->getReachableCenters($token->getUser(), + $centers = $this->helper->getReachableCenters($token->getUser(), new Role($attribute)); - + return count($centers) > 0; } - + + $center = $this->centerResolverDispatcher->resolveCenter($subject); + + if (NULL === $center && $subject instanceof Person) { + // person without any center are seen by everybody + return true; + } + return $this->helper->userHasAccess($token->getUser(), $subject, $attribute); } - + private function getAttributes() { return array(self::CREATE, self::UPDATE, self::SEE, self::STATS, self::LISTS, self::DUPLICATE); @@ -100,7 +104,7 @@ class PersonVoter extends AbstractChillVoter implements ProvideRoleHierarchyInte { return $this->getAttributes(); } - + public function getRolesWithHierarchy() { return [ 'Person' => $this->getRoles() ]; diff --git a/src/Bundle/ChillPersonBundle/config/services/security.yaml b/src/Bundle/ChillPersonBundle/config/services/security.yaml index 21590fcda..8504874a3 100644 --- a/src/Bundle/ChillPersonBundle/config/services/security.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/security.yaml @@ -1,8 +1,7 @@ services: chill.person.security.authorization.person: + autowire: true class: Chill\PersonBundle\Security\Authorization\PersonVoter - arguments: - - "@chill.main.security.authorization.helper" tags: - { name: security.voter } - { name: chill.role } @@ -13,4 +12,4 @@ services: tags: - { name: security.voter } - { name: chill.role } - + From dc09c9424a0cd1958736bb77e185ea71b4da08f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 3 Sep 2021 12:43:12 +0200 Subject: [PATCH 10/37] refactor ACL for easy voter. Apply on TaskVoter --- .../Authorization/PersonDocumentVoter.php | 33 ++-- .../Form/Event/CustomizeFormEvent.php | 36 ++++ .../Authorization/AbstractChillVoter.php | 12 +- .../Authorization/AuthorizationHelper.php | 154 ++++++++++-------- .../Security/Authorization/DefaultVoter.php | 69 ++++++++ .../Authorization/DefaultVoterFactory.php | 27 +++ .../Authorization/VoterFactoryInterface.php | 7 + .../Security/Authorization/VoterGenerator.php | 36 ++++ .../Authorization/VoterGeneratorInterface.php | 7 + .../Security/Authorization/VoterInterface.php | 7 + .../Resolver/CenterResolverDispatcherTest.php | 27 +++ .../config/services/security.yaml | 34 +++- .../Security/Authorization/TaskVoter.php | 93 +++++++---- .../config/services/security.yaml | 8 +- 14 files changed, 411 insertions(+), 139 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Form/Event/CustomizeFormEvent.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterGenerator.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterInterface.php create mode 100644 src/Bundle/ChillMainBundle/Tests/Security/Resolver/CenterResolverDispatcherTest.php diff --git a/src/Bundle/ChillDocStoreBundle/Security/Authorization/PersonDocumentVoter.php b/src/Bundle/ChillDocStoreBundle/Security/Authorization/PersonDocumentVoter.php index 78429b439..c92971b8f 100644 --- a/src/Bundle/ChillDocStoreBundle/Security/Authorization/PersonDocumentVoter.php +++ b/src/Bundle/ChillDocStoreBundle/Security/Authorization/PersonDocumentVoter.php @@ -23,6 +23,7 @@ use Chill\MainBundle\Security\Authorization\AbstractChillVoter; use Chill\MainBundle\Security\Authorization\AuthorizationHelper; use Chill\MainBundle\Security\ProvideRoleHierarchyInterface; use Chill\DocStoreBundle\Entity\PersonDocument; +use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; use Chill\PersonBundle\Entity\Person; use Chill\MainBundle\Entity\User; use Chill\PersonBundle\Security\Authorization\PersonVoter; @@ -42,30 +43,25 @@ class PersonDocumentVoter extends AbstractChillVoter implements ProvideRoleHiera const UPDATE = 'CHILL_PERSON_DOCUMENT_UPDATE'; const DELETE = 'CHILL_PERSON_DOCUMENT_DELETE'; - /** - * @var AuthorizationHelper - */ - protected $authorizationHelper; + protected AuthorizationHelper $authorizationHelper; - /** - * @var AccessDecisionManagerInterface - */ - protected $accessDecisionManager; + protected AccessDecisionManagerInterface $accessDecisionManager; - /** - * @var LoggerInterface - */ - protected $logger; + protected LoggerInterface $logger; + + protected CenterResolverDispatcher $centerResolverDispatcher; public function __construct( AccessDecisionManagerInterface $accessDecisionManager, AuthorizationHelper $authorizationHelper, - LoggerInterface $logger + LoggerInterface $logger//, + //CenterResolverDispatcher $centerResolverDispatcher ) { $this->accessDecisionManager = $accessDecisionManager; $this->authorizationHelper = $authorizationHelper; $this->logger = $logger; + //$this->centerResolverDispatcher = $centerResolverDispatcher; } public function getRoles() @@ -78,17 +74,18 @@ class PersonDocumentVoter extends AbstractChillVoter implements ProvideRoleHiera self::DELETE ]; } - + protected function supports($attribute, $subject) { if (\in_array($attribute, $this->getRoles()) && $subject instanceof PersonDocument) { return true; } - - if ($subject instanceof Person && $attribute === self::CREATE) { + + if ($subject instanceof Person + && \in_array($attribute, [self::CREATE, self::SEE])) { return true; } - + return false; } @@ -107,6 +104,8 @@ class PersonDocumentVoter extends AbstractChillVoter implements ProvideRoleHiera return false; } + $center = $this->centerResolverDispatcher->resolveCenter($subject); + if ($subject instanceof PersonDocument) { return $this->authorizationHelper->userHasAccess($token->getUser(), $subject, $attribute); diff --git a/src/Bundle/ChillMainBundle/Form/Event/CustomizeFormEvent.php b/src/Bundle/ChillMainBundle/Form/Event/CustomizeFormEvent.php new file mode 100644 index 000000000..43fab6f62 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Form/Event/CustomizeFormEvent.php @@ -0,0 +1,36 @@ +type = $type; + $this->builder = $builder; + } + + /** + * @return string + */ + public function getType(): string + { + return $this->type; + } + + /** + * @return FormBuilderInterface + */ + public function getBuilder(): FormBuilderInterface + { + return $this->builder; + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/AbstractChillVoter.php b/src/Bundle/ChillMainBundle/Security/Authorization/AbstractChillVoter.php index 842fc5ecc..9131a6501 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/AbstractChillVoter.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/AbstractChillVoter.php @@ -23,8 +23,8 @@ use Symfony\Component\Security\Core\Authorization\Voter\Voter; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; /** - * Voter for Chill software. - * + * Voter for Chill software. + * * This abstract Voter provide generic methods to handle object specific to Chill * * @@ -36,20 +36,20 @@ abstract class AbstractChillVoter extends Voter implements ChillVoterInterface { @trigger_error('This voter should implements the new `supports` ' . 'methods introduced by Symfony 3.0, and do not rely on ' - . 'getSupportedAttributes and getSupportedClasses methods.', + . 'getSupportedAttributes and getSupportedClasses methods.', E_USER_DEPRECATED); return \in_array($attribute, $this->getSupportedAttributes($attribute)) && \in_array(\get_class($subject), $this->getSupportedClasses()); } - + protected function voteOnAttribute($attribute, $subject, TokenInterface $token) { @trigger_error('This voter should implements the new `voteOnAttribute` ' . 'methods introduced by Symfony 3.0, and do not rely on ' . 'isGranted method', E_USER_DEPRECATED); - + return $this->isGranted($attribute, $subject, $token->getUser()); } - + } diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php index 697158bf8..ab1d1aed1 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php @@ -23,6 +23,8 @@ use Chill\MainBundle\Entity\User; use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Entity\HasCenterInterface; use Chill\MainBundle\Entity\HasScopeInterface; +use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; +use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface; use Symfony\Component\Security\Core\Role\RoleHierarchyInterface; use Symfony\Component\Security\Core\Role\Role; use Chill\MainBundle\Entity\Scope; @@ -32,87 +34,97 @@ use Chill\MainBundle\Entity\GroupCenter; use Chill\MainBundle\Entity\RoleScope; /** - * Helper for authorizations. - * + * Helper for authorizations. + * * Provides methods for user and entities information. * * @author Julien Fastré */ class AuthorizationHelper { + protected RoleHierarchyInterface $roleHierarchy; + /** - * - * @var RoleHierarchyInterface - */ - protected $roleHierarchy; - - /** - * The role in a hierarchy, given by the parameter + * The role in a hierarchy, given by the parameter * `security.role_hierarchy.roles` from the container. * * @var string[] */ - protected $hierarchy; - - /** - * - * @var EntityManagerInterface - */ - protected $em; - + protected array $hierarchy; + + protected EntityManagerInterface $em; + + protected CenterResolverDispatcher $centerResolverDispatcher; + public function __construct( RoleHierarchyInterface $roleHierarchy, - $hierarchy, - EntityManagerInterface $em + ParameterBagInterface $parameterBag, + EntityManagerInterface $em, + CenterResolverDispatcher $centerResolverDispatcher ) { $this->roleHierarchy = $roleHierarchy; - $this->hierarchy = $hierarchy; + $this->hierarchy = $parameterBag->get('security.role_hierarchy.roles'); $this->em = $em; + $this->centerResolverDispatcher = $centerResolverDispatcher; } - + /** * Determines if a user is active on this center - * + * + * If + * * @param User $user - * @param Center $center + * @param Center|Center[] $center May be an array of center * @return bool */ - public function userCanReachCenter(User $user, Center $center) + public function userCanReachCenter(User $user, $center) { - foreach ($user->getGroupCenters() as $groupCenter) { - if ($center->getId() === $groupCenter->getCenter()->getId()) { - - return true; + if ($center instanceof \Traversable) { + foreach ($center as $c) { + if ($c->userCanReachCenter($user, $c)) { + return true; + } } + return false; + } elseif ($center instanceof Center) { + foreach ($user->getGroupCenters() as $groupCenter) { + if ($center->getId() === $groupCenter->getCenter()->getId()) { + return true; + } + } + + return false; } - - return false; + + throw new \UnexpectedValueException(sprintf("The entity given is not an ". + "instance of %s, %s given", Center::class, get_class($center))); } - + /** - * + * * Determines if the user has access to the given entity. - * + * * if the entity implements Chill\MainBundle\Entity\HasScopeInterface, * the scope is taken into account. - * + * * @param User $user - * @param HasCenterInterface $entity the entity may also implement HasScopeInterface + * @param mixed $entity the entity may also implement HasScopeInterface * @param string|Role $attribute * @return boolean true if the user has access */ - public function userHasAccess(User $user, HasCenterInterface $entity, $attribute) + public function userHasAccess(User $user, $entity, $attribute) { - - $center = $entity->getCenter(); - + if (NULL === $center = $this->centerResolverDispatcher->resolveCenter($entity)) { + return false; + } + if (!$this->userCanReachCenter($user, $center)) { return false; } - + foreach ($user->getGroupCenters() as $groupCenter){ //filter on center - if ($groupCenter->getCenter()->getId() === $entity->getCenter()->getId()) { + if ($groupCenter->getCenter() === $center) { $permissionGroup = $groupCenter->getPermissionsGroup(); //iterate on roleScopes foreach($permissionGroup->getRoleScopes() as $roleScope) { @@ -134,17 +146,17 @@ class AuthorizationHelper } } } - + } } - + return false; } - + /** * Get reachable Centers for the given user, role, * and optionnaly Scope - * + * * @param User $user * @param string|Role $role * @param null|Scope $scope @@ -156,7 +168,7 @@ class AuthorizationHelper $role = $role->getRole(); } $centers = array(); - + foreach ($user->getGroupCenters() as $groupCenter){ $permissionGroup = $groupCenter->getPermissionsGroup(); //iterate on roleScopes @@ -170,13 +182,13 @@ class AuthorizationHelper if ($scope->getId() == $roleScope->getScope()->getId()){ $centers[] = $groupCenter->getCenter(); break 1; - } + } } } } - + } - + return $centers; } @@ -203,10 +215,10 @@ class AuthorizationHelper return $results; } - + /** * Return all reachable scope for a given user, center and role - * + * * @deprecated Use getReachableCircles * * @param User $user @@ -222,10 +234,10 @@ class AuthorizationHelper return $this->getReachableCircles($user, $role, $center); } - + /** * Return all reachable circle for a given user, center and role - * + * * @param User $user * @param string|Role $role * @param Center $center @@ -237,7 +249,7 @@ class AuthorizationHelper $role = $role->getRole(); } $scopes = array(); - + foreach ($user->getGroupCenters() as $groupCenter){ if ($center->getId() === $groupCenter->getCenter()->getId()) { //iterate on permissionGroup @@ -251,12 +263,12 @@ class AuthorizationHelper } } } - + return $scopes; } - + /** - * + * * @param Role $role * @param Center $center * @param Scope $circle @@ -267,7 +279,7 @@ class AuthorizationHelper $parents = $this->getParentRoles($role); $parents[] = $role; $parentRolesString = \array_map(function(Role $r) { return $r->getRole(); }, $parents); - + $qb = $this->em->createQueryBuilder(); $qb ->select('u') @@ -278,21 +290,21 @@ class AuthorizationHelper ->where('gc.center = :center') ->andWhere($qb->expr()->in('rs.role', $parentRolesString)) ; - + $qb->setParameter('center', $center); - + if ($circle !== null) { $qb->andWhere('rs.scope = :circle') ->setParameter('circle', $circle) ; } - + return $qb->getQuery()->getResult(); } - + /** * Test if a parent role may give access to a given child role - * + * * @param Role $childRole The role we want to test if he is reachable * @param Role $parentRole The role which should give access to $childRole * @return boolean true if the child role is granted by parent role @@ -301,14 +313,14 @@ class AuthorizationHelper { $reachableRoles = $this->roleHierarchy ->getReachableRoleNames([$parentRole]); - + return in_array($childRole, $reachableRoles); } - + /** - * Return all the role which give access to the given role. Only the role + * Return all the role which give access to the given role. Only the role * which are registered into Chill are taken into account. - * + * * @param Role $role * @return Role[] the role which give access to the given $role */ @@ -319,18 +331,18 @@ class AuthorizationHelper $roles = \array_map( function($string) { return new Role($string); - }, + }, \array_keys($this->hierarchy) ); - + foreach ($roles as $r) { $childRoles = $this->roleHierarchy->getReachableRoleNames([$r->getRole()]); - + if (\in_array($role, $childRoles)) { $parentRoles[] = $r; } } - + return $parentRoles; } } diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php new file mode 100644 index 000000000..98882b876 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php @@ -0,0 +1,69 @@ +authorizationHelper = $authorizationHelper; + $this->centerResolverDispatcher = $centerResolverDispatcher; + $this->configuration = $configuration; + } + + public function supports($attribute, $subject): bool + { + foreach ($this->configuration as list($attributes, $subj)) { + if ($subj === null) { + if ($subject === null && \in_array($attribute, $attributes)) { + return true; + } + } elseif ($subject instanceof $subj) { + return \in_array($attribute, $attributes); + } + } + + return false; + } + + public function voteOnAttribute($attribute, $subject, $token): bool + { + if (!$token->getUser() instanceof User) { + return false; + } + + if (NULL === $subject) { + if (NULL === $center = $this->centerResolverDispatcher + ->resolveCenter($subject)) { + return false; + } + return $this->authorizationHelper->userCanReachCenter( + $token->getUser(), + $center + ); + } + + return $this->authorizationHelper->userHasAccess( + $token->getUser(), + $subject, + $attribute + ); + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php new file mode 100644 index 000000000..4f3f232d9 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php @@ -0,0 +1,27 @@ +authorizationHelper = $authorizationHelper; + $this->centerResolverDispatcher = $centerResolverDispatcher; + } + + public function generate($context): VoterGeneratorInterface + { + return new VoterGenerator( + $this->authorizationHelper, + $this->centerResolverDispatcher + ); + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php b/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php new file mode 100644 index 000000000..b12739674 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php @@ -0,0 +1,7 @@ +authorizationHelper = $authorizationHelper; + $this->centerResolverDispatcher = $centerResolverDispatcher; + } + + public function addCheckFor($subject, $attributes): self + { + $this->configuration[] = [$attributes, $subject]; + + return $this; + } + + public function build(): VoterInterface + { + return new DefaultVoter( + $this->authorizationHelper, + $this->centerResolverDispatcher, + $this->configuration + ); + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php b/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php new file mode 100644 index 000000000..0aaf04ecd --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php @@ -0,0 +1,7 @@ +dispatcher = self::$container->get(CenterResolverDispatcher::class); + } + + public function testResolveCenter() + { + $center = new Center(); + + $resolved = $this->dispatcher->resolveCenter($center); + + $this->assertSame($center, $resolved); + } +} diff --git a/src/Bundle/ChillMainBundle/config/services/security.yaml b/src/Bundle/ChillMainBundle/config/services/security.yaml index 474ac0093..405dce19b 100644 --- a/src/Bundle/ChillMainBundle/config/services/security.yaml +++ b/src/Bundle/ChillMainBundle/config/services/security.yaml @@ -3,12 +3,38 @@ services: autowire: true autoconfigure: true + # do not autowire the directory Security/Resolver + Chill\MainBundle\Security\Resolver\CenterResolverDispatcher: + arguments: + - !tagged_iterator chill_main.center_resolver + + # do not autowire the directory Security/Resolver + _instanceof: + Chill\MainBundle\Security\Resolver\CenterResolverInterface: + tags: + - chill_main.center_resolver + + # do not autowire the directory Security/Resolver + Chill\MainBundle\Security\Resolver\DefaultCenterResolver: + autoconfigure: true + autowire: true + + # do not autowire the directory Security/Resolver + Chill\MainBundle\Security\Resolver\ResolverTwigExtension: + autoconfigure: true + autowire: true + + # do not autowire the directory Security/Resolver + Chill\MainBundle\Security\Authorization\DefaultVoterFactory: + autowire: true + + # do not autowire the directory Security/Resolver + Chill\MainBundle\Security\Authorization\VoterFactoryInterface: '@Chill\MainBundle\Security\Authorization\DefaultVoterFactory' + chill.main.security.authorization.helper: class: Chill\MainBundle\Security\Authorization\AuthorizationHelper - arguments: - $roleHierarchy: "@security.role_hierarchy" - $hierarchy: "%security.role_hierarchy.roles%" - $em: '@Doctrine\ORM\EntityManagerInterface' + autowire: true + autoconfigure: true Chill\MainBundle\Security\Authorization\AuthorizationHelper: '@chill.main.security.authorization.helper' chill.main.role_provider: diff --git a/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php b/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php index 8b8bce839..7c4f2d4d9 100644 --- a/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php +++ b/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php @@ -18,7 +18,12 @@ namespace Chill\TaskBundle\Security\Authorization; +use Chill\EventBundle\Entity\Event; +use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Security\Authorization\AbstractChillVoter; +use Chill\MainBundle\Security\Authorization\VoterFactoryInterface; +use Chill\MainBundle\Security\Authorization\VoterInterface; +use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; use Chill\TaskBundle\Entity\AbstractTask; use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface; use Chill\MainBundle\Security\Authorization\AuthorizationHelper; @@ -32,12 +37,7 @@ use Symfony\Component\Security\Core\Role\Role; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Chill\TaskBundle\Security\Authorization\AuthorizationEvent; -/** - * - * - * @author Julien Fastré - */ -class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterface +final class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterface { const CREATE = 'CHILL_TASK_TASK_CREATE'; const UPDATE = 'CHILL_TASK_TASK_UPDATE'; @@ -51,50 +51,52 @@ class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterf self::DELETE ]; - /** - * - * @var AuthorizationHelper - */ - protected $authorizationHelper; + protected AuthorizationHelper $authorizationHelper; - /** - * - * @var AccessDecisionManagerInterface - */ - protected $accessDecisionManager; + protected AccessDecisionManagerInterface $accessDecisionManager; - /** - * - * @var LoggerInterface - */ - protected $logger; - - /** - * - * @var EventDispatcherInterface - */ - protected $eventDispatcher; + protected LoggerInterface $logger; + + protected EventDispatcherInterface $eventDispatcher; + + protected CenterResolverDispatcher $centerResolverDispatcher; + + protected VoterInterface $voter; public function __construct( AccessDecisionManagerInterface $accessDecisionManager, AuthorizationHelper $authorizationHelper, EventDispatcherInterface $eventDispatcher, - LoggerInterface $logger + LoggerInterface $logger, + CenterResolverDispatcher $centerResolverDispatcher, + VoterFactoryInterface $voterFactory ) { $this->accessDecisionManager = $accessDecisionManager; $this->authorizationHelper = $authorizationHelper; $this->eventDispatcher = $eventDispatcher; $this->logger = $logger; + $this->centerResolverDispatcher = $centerResolverDispatcher; + + $this->voter = $voterFactory + ->generate(AbstractTask::class) + ->addCheckFor(AbstractTask::class, self::ROLES) + ->addCheckFor(Person::class, [self::SHOW]) + ->addCheckFor(null, [self::SHOW]) + ->build() + ; } public function supports($attribute, $subject) { + return $this->voter->supports($attribute, $subject); + /* return ($subject instanceof AbstractTask && in_array($attribute, self::ROLES)) || ($subject instanceof Person && \in_array($attribute, [ self::CREATE, self::SHOW ])) || (NULL === $subject && $attribute === self::SHOW ) ; + */ } /** @@ -111,40 +113,60 @@ class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterf if (!$token->getUser() instanceof User) { return false; } - + $event = new AuthorizationEvent($subject, $attribute, $token); - + $this->eventDispatcher->dispatch(AuthorizationEvent::VOTE, $event); - + if ($event->hasVote()) { - + $this->logger->debug("The TaskVoter is overriding by " .AuthorizationEvent::VOTE, [ 'vote' => $event->getVote(), 'task_id' => $subject->getId() ]); - + return $event->getVote(); } + // do pre-flight check, relying on other decision manager + // those pre-flight check concern associated entities + if ($subject instanceof AbstractTask) { + if (NULL !== $person = $subject->getPerson()) { + if (!$this->accessDecisionManager->decide($token, [PersonVoter::SEE], $person)) { + return false; + } + } elseif (false) { + // here will come the test if the task is associated to an accompanying course + } + } + + // do regular check. + return $this->voter->voteOnAttribute($attribute, $subject, $token); + + /* if ($subject instanceof AbstractTask) { if ($subject->getPerson() === null) { throw new \LogicException("You should associate a person with task " . "in order to check autorizations"); } - + $person = $subject->getPerson(); } elseif ($subject instanceof Person) { $person = $subject; } else { // subject is null. We check that at least one center is reachable $centers = $this->authorizationHelper->getReachableCenters($token->getUser(), new Role($attribute)); - + return count($centers) > 0; } if (!$this->accessDecisionManager->decide($token, [PersonVoter::SEE], $person)) { + return false; + } + $center = $this->centerResolverDispatcher->resolveCenter($subject); + if (NULL === $center) { return false; } @@ -153,6 +175,7 @@ class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterf $subject, $attribute ); + */ } public function getRoles() diff --git a/src/Bundle/ChillTaskBundle/config/services/security.yaml b/src/Bundle/ChillTaskBundle/config/services/security.yaml index e58fd19e3..c1d176637 100644 --- a/src/Bundle/ChillTaskBundle/config/services/security.yaml +++ b/src/Bundle/ChillTaskBundle/config/services/security.yaml @@ -1,11 +1,7 @@ services: chill_task.task_voter: class: Chill\TaskBundle\Security\Authorization\TaskVoter - arguments: - - "@security.access.decision_manager" - - "@chill.main.security.authorization.helper" - - '@Symfony\Component\EventDispatcher\EventDispatcherInterface' - - "@logger" + autowire: true + autoconfigure: true tags: - - { name: security.voter } - { name: chill.role } From 960bac8c377787ed87d6cdbd68265bcb3ebc7694 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 3 Sep 2021 16:05:45 +0200 Subject: [PATCH 11/37] create alias for RoleProvider for allowing autowiring --- src/Bundle/ChillMainBundle/config/services/security.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Bundle/ChillMainBundle/config/services/security.yaml b/src/Bundle/ChillMainBundle/config/services/security.yaml index 405dce19b..9925f972c 100644 --- a/src/Bundle/ChillMainBundle/config/services/security.yaml +++ b/src/Bundle/ChillMainBundle/config/services/security.yaml @@ -39,6 +39,7 @@ services: chill.main.role_provider: class: Chill\MainBundle\Security\RoleProvider + Chill\MainBundle\Security\RoleProvider: '@chill.main.role_provider' chill.main.user_provider: class: Chill\MainBundle\Security\UserProvider\UserProvider From 9b38e486dff668d8ec3d92d2c17ee0e9281f9a52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 3 Sep 2021 17:28:03 +0200 Subject: [PATCH 12/37] extends User entity + alter admin (WIP) --- .../ChillMainExtension.php | 23 +++ src/Bundle/ChillMainBundle/Entity/User.php | 182 ++++++++++++++---- src/Bundle/ChillMainBundle/Entity/UserJob.php | 76 ++++++++ .../ChillMainBundle/Form/UserJobType.php | 27 +++ src/Bundle/ChillMainBundle/Form/UserType.php | 53 ++++- .../views/CRUD/Admin/index.html.twig | 8 + .../Resources/views/UserJob/index.html.twig | 26 +++ .../ChillMainBundle/config/services/form.yaml | 5 + .../ChillMainBundle/config/validation.yaml | 2 + .../migrations/Version20210903144853.php | 53 +++++ 10 files changed, 413 insertions(+), 42 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Entity/UserJob.php create mode 100644 src/Bundle/ChillMainBundle/Form/UserJobType.php create mode 100644 src/Bundle/ChillMainBundle/Resources/views/CRUD/Admin/index.html.twig create mode 100644 src/Bundle/ChillMainBundle/Resources/views/UserJob/index.html.twig create mode 100644 src/Bundle/ChillMainBundle/migrations/Version20210903144853.php diff --git a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php index 1637ee098..09897fec2 100644 --- a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php +++ b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php @@ -19,6 +19,8 @@ namespace Chill\MainBundle\DependencyInjection; +use Chill\MainBundle\Entity\UserJob; +use Chill\MainBundle\Form\UserJobType; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\Config\FileLocator; use Symfony\Component\HttpKernel\DependencyInjection\Extension; @@ -264,6 +266,27 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface, protected function prependCruds(ContainerBuilder $container) { $container->prependExtensionConfig('chill_main', [ + 'cruds' => [ + [ + 'class' => UserJob::class, + 'name' => 'admin_user_job', + 'base_path' => '/admin/main/user-job', + 'base_role' => 'ROLE_ADMIN', + 'form_class' => UserJobType::class, + 'actions' => [ + 'index' => [ + 'role' => 'ROLE_ADMIN', + 'template' => '@ChillMain/UserJob/index.html.twig', + ], + 'new' => [ + 'role' => 'ROLE_ADMIN' + ], + 'edit' => [ + 'role' => 'ROLE_ADMIN' + ] + ], + ], + ], 'apis' => [ [ 'class' => \Chill\MainBundle\Entity\Address::class, diff --git a/src/Bundle/ChillMainBundle/Entity/User.php b/src/Bundle/ChillMainBundle/Entity/User.php index 76bb7b54d..140e0889c 100644 --- a/src/Bundle/ChillMainBundle/Entity/User.php +++ b/src/Bundle/ChillMainBundle/Entity/User.php @@ -5,6 +5,7 @@ namespace Chill\MainBundle\Entity; use Doctrine\ORM\Mapping as ORM; use Doctrine\Common\Collections\Collection; use Doctrine\Common\Collections\ArrayCollection; +use Chill\MainBundle\Entity\UserJob; use Symfony\Component\Security\Core\User\AdvancedUserInterface; use Symfony\Component\Validator\Context\ExecutionContextInterface; use Symfony\Component\Serializer\Annotation\DiscriminatorMap; @@ -20,7 +21,7 @@ use Symfony\Component\Serializer\Annotation\DiscriminatorMap; * }) */ class User implements AdvancedUserInterface { - + /** * @var integer * @@ -36,7 +37,7 @@ class User implements AdvancedUserInterface { * @ORM\Column(type="string", length=80) */ private $username; - + /** * @var string * @@ -46,14 +47,19 @@ class User implements AdvancedUserInterface { * unique=true) */ private $usernameCanonical; - + + /** + * @ORM\Column(type="string", length=200) + */ + private string $label = ''; + /** * @var string * * @ORM\Column(type="string", length=150, nullable=true) */ private $email; - + /** * @var string * @@ -64,14 +70,14 @@ class User implements AdvancedUserInterface { * unique=true) */ private $emailCanonical; - + /** * @var string * * @ORM\Column(type="string", length=255) */ private $password; - + /** * @var string * @internal must be set to null if we use bcrypt @@ -79,7 +85,7 @@ class User implements AdvancedUserInterface { * @ORM\Column(type="string", length=255, nullable=true) */ private $salt = null; - + /** * @var boolean * @@ -87,14 +93,14 @@ class User implements AdvancedUserInterface { * sf4 check: in yml was false by default !? */ private $locked = true; - + /** * @var boolean * * @ORM\Column(type="boolean") */ private $enabled = true; - + /** * @var Collection * @@ -112,7 +118,25 @@ class User implements AdvancedUserInterface { * @ORM\Column(type="json_array", nullable=true) */ private $attributes; - + + /** + * @var Center|null + * @ORM\ManyToOne(targetEntity=Center::class) + */ + private ?Center $mainCenter = null; + + /** + * @var Scope|null + * @ORM\ManyToOne(targetEntity=Scope::class) + */ + private ?Scope $mainScope = null; + + /** + * @var UserJob|null + * @ORM\ManyToOne(targetEntity=UserJob::class) + */ + private ?UserJob $userJob = null; + /** * User constructor. */ @@ -120,13 +144,13 @@ class User implements AdvancedUserInterface { { $this->groupCenters = new ArrayCollection(); } - + /** * @return string */ public function __toString() { - return $this->getUsername(); + return $this->getLabel(); } /** @@ -148,10 +172,14 @@ class User implements AdvancedUserInterface { public function setUsername($name) { $this->username = $name; - + + if (empty($this->getLabel())) { + $this->setLabel($name); + } + return $this; } - + /** * @return string */ @@ -159,11 +187,11 @@ class User implements AdvancedUserInterface { { return $this->username; } - + /** */ public function eraseCredentials() {} - + /** * @return array */ @@ -171,7 +199,7 @@ class User implements AdvancedUserInterface { { return array('ROLE_USER'); } - + /** * @return null|string */ @@ -179,7 +207,7 @@ class User implements AdvancedUserInterface { { return $this->salt; } - + /** * @param $usernameCanonical * @return $this @@ -187,10 +215,10 @@ class User implements AdvancedUserInterface { public function setUsernameCanonical($usernameCanonical) { $this->usernameCanonical = $usernameCanonical; - + return $this; } - + /** * @return string */ @@ -198,7 +226,7 @@ class User implements AdvancedUserInterface { { return $this->usernameCanonical; } - + /** * @param $email * @return $this @@ -206,10 +234,10 @@ class User implements AdvancedUserInterface { public function setEmail($email) { $this->email = $email; - + return $this; } - + /** * @return string */ @@ -217,7 +245,7 @@ class User implements AdvancedUserInterface { { return $this->email; } - + /** * @param $emailCanonical * @return $this @@ -225,10 +253,10 @@ class User implements AdvancedUserInterface { public function setEmailCanonical($emailCanonical) { $this->emailCanonical = $emailCanonical; - + return $this; } - + /** * @return string */ @@ -236,7 +264,7 @@ class User implements AdvancedUserInterface { { return $this->emailCanonical; } - + /** * @param $password * @return $this @@ -244,7 +272,7 @@ class User implements AdvancedUserInterface { function setPassword($password) { $this->password = $password; - + return $this; } @@ -255,7 +283,7 @@ class User implements AdvancedUserInterface { { return $this->password; } - + /** * @param $salt * @return $this @@ -265,7 +293,7 @@ class User implements AdvancedUserInterface { $this->salt = $salt; return $this; } - + /** * @return bool */ @@ -273,7 +301,7 @@ class User implements AdvancedUserInterface { { return true; } - + /** * @return bool */ @@ -281,7 +309,7 @@ class User implements AdvancedUserInterface { { return $this->locked; } - + /** * @return bool */ @@ -289,7 +317,7 @@ class User implements AdvancedUserInterface { { return true; } - + /** * @return bool */ @@ -297,17 +325,17 @@ class User implements AdvancedUserInterface { { return $this->enabled; } - + /** * @param bool $enabled */ public function setEnabled($enabled) { $this->enabled = $enabled; - + return $this; } - + /** * @return GroupCenter */ @@ -315,7 +343,7 @@ class User implements AdvancedUserInterface { { return $this->groupCenters; } - + /** * @param \Chill\MainBundle\Entity\GroupCenter $groupCenter * @return \Chill\MainBundle\Entity\User @@ -325,7 +353,7 @@ class User implements AdvancedUserInterface { $this->groupCenters->add($groupCenter); return $this; } - + /** * @param \Chill\MainBundle\Entity\GroupCenter $groupCenter * @throws \RuntimeException if the groupCenter is not in the collection @@ -337,9 +365,9 @@ class User implements AdvancedUserInterface { . "it seems not to be associated with the user. Aborting.")); } } - + /** - * This function check that groupCenter are present only once. The validator + * This function check that groupCenter are present only once. The validator * use this function to avoid a user to be associated to the same groupCenter * more than once. */ @@ -350,7 +378,7 @@ class User implements AdvancedUserInterface { if (in_array($groupCenter->getId(), $groupCentersIds)) { $context->buildViolation("The user has already those permissions") ->addViolation(); - + } else { $groupCentersIds[] = $groupCenter->getId(); } @@ -384,4 +412,76 @@ class User implements AdvancedUserInterface { return $this->attributes; } + + /** + * @return string + */ + public function getLabel(): string + { + return $this->label; + } + + /** + * @param string $label + * @return User + */ + public function setLabel(string $label): User + { + $this->label = $label; + return $this; + } + + /** + * @return Center|null + */ + public function getMainCenter(): ?Center + { + return $this->mainCenter; + } + + /** + * @param Center|null $mainCenter + * @return User + */ + public function setMainCenter(?Center $mainCenter): User + { + $this->mainCenter = $mainCenter; + return $this; + } + + /** + * @return Scope|null + */ + public function getMainScope(): ?Scope + { + return $this->mainScope; + } + + /** + * @param Scope|null $mainScope + * @return User + */ + public function setMainScope(?Scope $mainScope): User + { + $this->mainScope = $mainScope; + return $this; + } + + /** + * @return UserJob|null + */ + public function getUserJob(): ?UserJob + { + return $this->userJob; + } + + /** + * @param UserJob|null $userJob + * @return User + */ + public function setUserJob(?UserJob $userJob): User + { + $this->userJob = $userJob; + return $this; + } } diff --git a/src/Bundle/ChillMainBundle/Entity/UserJob.php b/src/Bundle/ChillMainBundle/Entity/UserJob.php new file mode 100644 index 000000000..9d1ca9157 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Entity/UserJob.php @@ -0,0 +1,76 @@ +id; + } + + /** + * @return array|string[] + */ + public function getLabel(): array + { + return $this->label; + } + + /** + * @param array|string[] $label + * @return UserJob + */ + public function setLabel(array $label): UserJob + { + $this->label = $label; + return $this; + } + + /** + * @return bool + */ + public function isActive(): bool + { + return $this->active; + } + + /** + * @param bool $active + * @return UserJob + */ + public function setActive(bool $active): UserJob + { + $this->active = $active; + return $this; + } +} diff --git a/src/Bundle/ChillMainBundle/Form/UserJobType.php b/src/Bundle/ChillMainBundle/Form/UserJobType.php new file mode 100644 index 000000000..eec718261 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Form/UserJobType.php @@ -0,0 +1,27 @@ +add('label', TranslatableStringFormType::class, [ + 'label' => 'Label', + 'required' => true + ]) + ->add('active', ChoiceType::class, [ + 'choices' => [ + 'Active' => true, + 'Inactive' => false + ] + ]) + ; + } + +} diff --git a/src/Bundle/ChillMainBundle/Form/UserType.php b/src/Bundle/ChillMainBundle/Form/UserType.php index 5196ee6c0..09e2d1391 100644 --- a/src/Bundle/ChillMainBundle/Form/UserType.php +++ b/src/Bundle/ChillMainBundle/Form/UserType.php @@ -2,7 +2,15 @@ namespace Chill\MainBundle\Form; +use Chill\MainBundle\Entity\Center; +use Chill\MainBundle\Entity\Scope; +use Chill\MainBundle\Entity\UserJob; +use Chill\MainBundle\Templating\TranslatableStringHelper; +use Doctrine\ORM\EntityRepository; +use Symfony\Bridge\Doctrine\Form\Type\EntityType; use Symfony\Component\Form\AbstractType; +use Symfony\Component\Form\Extension\Core\Type\EmailType; +use Symfony\Component\Form\Extension\Core\Type\TextType; use Symfony\Component\Form\FormBuilderInterface; use Symfony\Component\OptionsResolver\OptionsResolver; use Symfony\Component\Form\Extension\Core\Type\ChoiceType; @@ -16,6 +24,16 @@ use Chill\MainBundle\Form\UserPasswordType; class UserType extends AbstractType { + private TranslatableStringHelper $translatableStringHelper; + + /** + * @param TranslatableStringHelper $translatableStringHelper + */ + public function __construct(TranslatableStringHelper $translatableStringHelper) + { + $this->translatableStringHelper = $translatableStringHelper; + } + /** * @param FormBuilderInterface $builder * @param array $options @@ -24,7 +42,40 @@ class UserType extends AbstractType { $builder ->add('username') - ->add('email') + ->add('email', EmailType::class, [ + 'required' => true + ]) + ->add('label', TextType::class) + ->add('mainCenter', EntityType::class, [ + 'label' => 'main center', + 'required' => false, + 'placeholder' => 'choose a main center', + 'class' => Center::class, + 'query_builder' => function (EntityRepository $er) { + $qb = $er->createQueryBuilder('c'); + $qb->addOrderBy('c.name'); + + return $qb; + } + ]) + ->add('mainScope', EntityType::class, [ + 'label' => 'Choose a main scope', + 'required' => false, + 'placeholder' => 'choose a main scope', + 'class' => Scope::class, + 'choice_label' => function (Scope $c) { + return $this->translatableStringHelper->localize($c->getName()); + }, + ]) + ->add('userJob', EntityType::class, [ + 'label' => 'Choose a job', + 'required' => false, + 'placeholder' => 'choose a job', + 'class' => UserJob::class, + 'choice_label' => function (UserJob $c) { + return $this->translatableStringHelper->localize($c->getLabel()); + }, + ]) ; if ($options['is_creation']) { $builder->add('plainPassword', RepeatedType::class, array( diff --git a/src/Bundle/ChillMainBundle/Resources/views/CRUD/Admin/index.html.twig b/src/Bundle/ChillMainBundle/Resources/views/CRUD/Admin/index.html.twig new file mode 100644 index 000000000..1dc0acc81 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Resources/views/CRUD/Admin/index.html.twig @@ -0,0 +1,8 @@ +{% extends '@ChillMain/Admin/layout.html.twig' %} + +{% block title %}{{ ('crud.' ~ crud_name ~ '.index.title')|trans({'%crud_name%': crud_name}) }}{% endblock %} + +{% block content %} + {% embed '@ChillMain/CRUD/_index.html.twig' %} + {% endembed %} +{% endblock content %} diff --git a/src/Bundle/ChillMainBundle/Resources/views/UserJob/index.html.twig b/src/Bundle/ChillMainBundle/Resources/views/UserJob/index.html.twig new file mode 100644 index 000000000..8f037f150 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Resources/views/UserJob/index.html.twig @@ -0,0 +1,26 @@ +{% extends '@ChillMain/CRUD/Admin/index.html.twig' %} + +{% block content %} + {% embed '@ChillMain/CRUD/_index.html.twig' %} + {% block table_entities_thead_tr %} + id + label +   + {% endblock %} + {% block table_entities_tbody %} + {% for entity in entities %} + + {{ entity.id }} + {{ entity.label|localize_translatable_string }} + +
        +
      • + +
        • +
      + + + {% endfor %} + {% endblock %} + {% endembed %} +{% endblock content %} diff --git a/src/Bundle/ChillMainBundle/config/services/form.yaml b/src/Bundle/ChillMainBundle/config/services/form.yaml index bd5c1ece5..f719edb55 100644 --- a/src/Bundle/ChillMainBundle/config/services/form.yaml +++ b/src/Bundle/ChillMainBundle/config/services/form.yaml @@ -113,6 +113,10 @@ services: tags: - { name: form.type } + Chill\MainBundle\Form\UserType: + autowire: true + autoconfigure: true + Chill\MainBundle\Form\PermissionsGroupType: tags: - { name: form.type } @@ -123,3 +127,4 @@ services: - "@security.token_storage" tags: - { name: form.type } + diff --git a/src/Bundle/ChillMainBundle/config/validation.yaml b/src/Bundle/ChillMainBundle/config/validation.yaml index dd5f8d985..79cf4d8f9 100644 --- a/src/Bundle/ChillMainBundle/config/validation.yaml +++ b/src/Bundle/ChillMainBundle/config/validation.yaml @@ -18,6 +18,8 @@ Chill\MainBundle\Entity\User: min: 3 email: - Email: ~ + label: + - NotBlank: ~ constraints: - Callback: callback: isGroupCenterPresentOnce diff --git a/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php b/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php new file mode 100644 index 000000000..4e252c3a3 --- /dev/null +++ b/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php @@ -0,0 +1,53 @@ +addSql('CREATE SEQUENCE chill_main_user_job_id_seq INCREMENT BY 1 MINVALUE 1 START 1'); + $this->addSql('CREATE TABLE chill_main_user_job (id INT NOT NULL, label JSON NOT NULL, active BOOLEAN NOT NULL, PRIMARY KEY(id))'); + $this->addSql('ALTER TABLE users ADD label VARCHAR(200) NULL DEFAULT NULL'); + $this->addSql('UPDATE users SET label=username'); + $this->addSql('ALTER TABLE users ALTER label DROP DEFAULT'); + $this->addSql('ALTER TABLE users ALTER label SET NOT NULL'); + $this->addSql('ALTER TABLE users ADD mainCenter_id INT DEFAULT NULL'); + $this->addSql('ALTER TABLE users ADD mainScope_id INT DEFAULT NULL'); + $this->addSql('ALTER TABLE users ADD userJob_id INT DEFAULT NULL'); + $this->addSql('ALTER TABLE users ALTER usernamecanonical SET NOT NULL'); + $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E92C2125C1 FOREIGN KEY (mainCenter_id) REFERENCES centers (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); + $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E9115E73F3 FOREIGN KEY (mainScope_id) REFERENCES scopes (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); + $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E964B65C5B FOREIGN KEY (userJob_id) REFERENCES chill_main_user_job (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); + $this->addSql('CREATE INDEX IDX_1483A5E92C2125C1 ON users (mainCenter_id)'); + $this->addSql('CREATE INDEX IDX_1483A5E9115E73F3 ON users (mainScope_id)'); + $this->addSql('CREATE INDEX IDX_1483A5E964B65C5B ON users (userJob_id)'); + } + + public function down(Schema $schema): void + { + $this->addSql('ALTER TABLE users DROP CONSTRAINT FK_1483A5E964B65C5B'); + $this->addSql('DROP SEQUENCE chill_main_user_job_id_seq CASCADE'); + $this->addSql('DROP TABLE chill_main_user_job'); + $this->addSql('ALTER TABLE users DROP CONSTRAINT FK_1483A5E92C2125C1'); + $this->addSql('ALTER TABLE users DROP CONSTRAINT FK_1483A5E9115E73F3'); + $this->addSql('ALTER TABLE users DROP label'); + $this->addSql('ALTER TABLE users DROP mainCenter_id'); + $this->addSql('ALTER TABLE users DROP mainScope_id'); + $this->addSql('ALTER TABLE users DROP userJob_id'); + $this->addSql('ALTER TABLE users ALTER usernameCanonical DROP NOT NULL'); + } +} From b4e78a948bfd7831db40869ea72f94ba3ad3b3ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 6 Sep 2021 14:50:52 +0200 Subject: [PATCH 13/37] remove NOT NULL for User::usernamecanonical --- src/Bundle/ChillMainBundle/Entity/User.php | 3 ++- .../ChillMainBundle/migrations/Version20210903144853.php | 1 - 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Bundle/ChillMainBundle/Entity/User.php b/src/Bundle/ChillMainBundle/Entity/User.php index 140e0889c..41d6db40c 100644 --- a/src/Bundle/ChillMainBundle/Entity/User.php +++ b/src/Bundle/ChillMainBundle/Entity/User.php @@ -44,7 +44,8 @@ class User implements AdvancedUserInterface { * @ORM\Column( * type="string", * length=80, - * unique=true) + * unique=true, + * nullable=true) */ private $usernameCanonical; diff --git a/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php b/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php index 4e252c3a3..7fe6b8e72 100644 --- a/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php +++ b/src/Bundle/ChillMainBundle/migrations/Version20210903144853.php @@ -28,7 +28,6 @@ final class Version20210903144853 extends AbstractMigration $this->addSql('ALTER TABLE users ADD mainCenter_id INT DEFAULT NULL'); $this->addSql('ALTER TABLE users ADD mainScope_id INT DEFAULT NULL'); $this->addSql('ALTER TABLE users ADD userJob_id INT DEFAULT NULL'); - $this->addSql('ALTER TABLE users ALTER usernamecanonical SET NOT NULL'); $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E92C2125C1 FOREIGN KEY (mainCenter_id) REFERENCES centers (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E9115E73F3 FOREIGN KEY (mainScope_id) REFERENCES scopes (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); $this->addSql('ALTER TABLE users ADD CONSTRAINT FK_1483A5E964B65C5B FOREIGN KEY (userJob_id) REFERENCES chill_main_user_job (id) NOT DEFERRABLE INITIALLY IMMEDIATE'); From addcf72ae62611205c793027a93e34af2aea24e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 8 Sep 2021 18:37:30 +0200 Subject: [PATCH 14/37] improve addresses --- src/Bundle/ChillMainBundle/Doctrine/Type/PointType.php | 4 ++-- src/Bundle/ChillMainBundle/Entity/Address.php | 10 ++++++++++ .../Repository/AddressReferenceRepository.php | 8 ++++++++ 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/Bundle/ChillMainBundle/Doctrine/Type/PointType.php b/src/Bundle/ChillMainBundle/Doctrine/Type/PointType.php index 086b566da..0a0c160cd 100644 --- a/src/Bundle/ChillMainBundle/Doctrine/Type/PointType.php +++ b/src/Bundle/ChillMainBundle/Doctrine/Type/PointType.php @@ -21,7 +21,7 @@ class PointType extends Type { * * @param array $fieldDeclaration * @param AbstractPlatform $platform - * @return type + * @return string */ public function getSqlDeclaration(array $fieldDeclaration, AbstractPlatform $platform) { @@ -32,7 +32,7 @@ class PointType extends Type { * * @param type $value * @param AbstractPlatform $platform - * @return Point + * @return ?Point */ public function convertToPHPValue($value, AbstractPlatform $platform) { diff --git a/src/Bundle/ChillMainBundle/Entity/Address.php b/src/Bundle/ChillMainBundle/Entity/Address.php index f3973ff0f..22e4848bf 100644 --- a/src/Bundle/ChillMainBundle/Entity/Address.php +++ b/src/Bundle/ChillMainBundle/Entity/Address.php @@ -383,6 +383,16 @@ class Address ; } + public static function createFromAddressReference(AddressReference $original): Address + { + return (new Address()) + ->setPoint($original->getPoint()) + ->setPostcode($original->getPostcode()) + ->setStreet($original->getStreet()) + ->setStreetNumber($original->getStreetNumber()) + ; + } + public function getStreet(): ?string { return $this->street; diff --git a/src/Bundle/ChillMainBundle/Repository/AddressReferenceRepository.php b/src/Bundle/ChillMainBundle/Repository/AddressReferenceRepository.php index f040446b3..cf488f411 100644 --- a/src/Bundle/ChillMainBundle/Repository/AddressReferenceRepository.php +++ b/src/Bundle/ChillMainBundle/Repository/AddressReferenceRepository.php @@ -36,6 +36,14 @@ final class AddressReferenceRepository implements ObjectRepository return $this->repository->findAll(); } + public function countAll(): int + { + $qb = $this->repository->createQueryBuilder('ar'); + $qb->select('count(ar.id)'); + + return $qb->getQuery()->getSingleScalarResult(); + } + /** * @return AddressReference[] */ From f87f03b5c0adc15c21f6f9a98f9a3b4c0143b49c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 10 Sep 2021 12:06:00 +0200 Subject: [PATCH 15/37] Move CenterResolverInterface auto-configuring to bundledefinition It seems that the service encountered in bundle loaded before does not works. --- src/Bundle/ChillMainBundle/ChillMainBundle.php | 3 +++ src/Bundle/ChillMainBundle/config/services/security.yaml | 6 ------ 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/src/Bundle/ChillMainBundle/ChillMainBundle.php b/src/Bundle/ChillMainBundle/ChillMainBundle.php index ee9523273..d059443b5 100644 --- a/src/Bundle/ChillMainBundle/ChillMainBundle.php +++ b/src/Bundle/ChillMainBundle/ChillMainBundle.php @@ -3,6 +3,7 @@ namespace Chill\MainBundle; use Chill\MainBundle\Routing\LocalMenuBuilderInterface; +use Chill\MainBundle\Security\Resolver\CenterResolverInterface; use Symfony\Component\HttpKernel\Bundle\Bundle; use Symfony\Component\DependencyInjection\ContainerBuilder; use Chill\MainBundle\DependencyInjection\CompilerPass\SearchableServicesCompilerPass; @@ -27,6 +28,8 @@ class ChillMainBundle extends Bundle $container->registerForAutoconfiguration(LocalMenuBuilderInterface::class) ->addTag('chill.menu_builder'); + $container->registerForAutoconfiguration(CenterResolverInterface::class) + ->addTag('chill_main.center_resolver'); $container->addCompilerPass(new SearchableServicesCompilerPass()); $container->addCompilerPass(new ConfigConsistencyCompilerPass()); diff --git a/src/Bundle/ChillMainBundle/config/services/security.yaml b/src/Bundle/ChillMainBundle/config/services/security.yaml index 9925f972c..7590acb5f 100644 --- a/src/Bundle/ChillMainBundle/config/services/security.yaml +++ b/src/Bundle/ChillMainBundle/config/services/security.yaml @@ -8,12 +8,6 @@ services: arguments: - !tagged_iterator chill_main.center_resolver - # do not autowire the directory Security/Resolver - _instanceof: - Chill\MainBundle\Security\Resolver\CenterResolverInterface: - tags: - - chill_main.center_resolver - # do not autowire the directory Security/Resolver Chill\MainBundle\Security\Resolver\DefaultCenterResolver: autoconfigure: true From 6bc83edfe9267eca4bc941e8ad5451a621baa6ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 10 Sep 2021 17:44:01 +0200 Subject: [PATCH 16/37] Refactor PersonSearch and create PersonACLAwareRepository The search api delegates the query to a person acl aware "repository" (although this does not implements ObjectRepository interface). --- .../ChillMainBundle/ChillMainBundle.php | 1 + .../Search/SearchInterface.php | 43 ++- .../Repository/PersonACLAwareRepository.php | 272 +++++++++++++++++ .../PersonACLAwareRepositoryInterface.php | 50 +++ .../Repository/PersonRepository.php | 24 +- .../ChillPersonBundle/Search/PersonSearch.php | 285 ++++++------------ .../Search/SimilarityPersonSearch.php | 212 ++----------- .../ChillPersonBundle/config/services.yaml | 1 - .../config/services/repository.yaml | 5 + .../config/services/search.yaml | 20 +- 10 files changed, 497 insertions(+), 416 deletions(-) create mode 100644 src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php create mode 100644 src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepositoryInterface.php diff --git a/src/Bundle/ChillMainBundle/ChillMainBundle.php b/src/Bundle/ChillMainBundle/ChillMainBundle.php index d059443b5..d2ae5f1b5 100644 --- a/src/Bundle/ChillMainBundle/ChillMainBundle.php +++ b/src/Bundle/ChillMainBundle/ChillMainBundle.php @@ -3,6 +3,7 @@ namespace Chill\MainBundle; use Chill\MainBundle\Routing\LocalMenuBuilderInterface; +use Chill\MainBundle\Search\SearchInterface; use Chill\MainBundle\Security\Resolver\CenterResolverInterface; use Symfony\Component\HttpKernel\Bundle\Bundle; use Symfony\Component\DependencyInjection\ContainerBuilder; diff --git a/src/Bundle/ChillMainBundle/Search/SearchInterface.php b/src/Bundle/ChillMainBundle/Search/SearchInterface.php index 708835b47..958ce9ddd 100644 --- a/src/Bundle/ChillMainBundle/Search/SearchInterface.php +++ b/src/Bundle/ChillMainBundle/Search/SearchInterface.php @@ -23,45 +23,44 @@ namespace Chill\MainBundle\Search; /** * This interface must be implemented on services which provide search results. - * + * * @todo : write doc and add a link to documentation - * + * * @author Julien Fastré * */ interface SearchInterface { - const SEARCH_PREVIEW_OPTION = '_search_preview'; - + /** * Request parameters contained inside the `add_q` parameters */ const REQUEST_QUERY_PARAMETERS = '_search_parameters'; - + /** * Supplementary parameters to the query string */ const REQUEST_QUERY_KEY_ADD_PARAMETERS = 'add_q'; - /** + /** * return the result in a html string. The string will be inclued (as raw) * into a global view. - * + * * The global view may be : * {% for result as resultsFromDifferentSearchInterface %} * {{ result|raw }} * {% endfor %} - * + * * **available options** : - * - SEARCH_PREVIEW_OPTION (boolean) : if renderResult should return a "preview" of + * - SEARCH_PREVIEW_OPTION (boolean) : if renderResult should return a "preview" of * the results. In this case, a subset of results should be returned, and, * if the query return more results, a button "see all results" should be * displayed at the end of the list. - * - * **Interaction between `start` and `limit` and pagination : you should - * take only the given parameters into account; the results from pagination - * should be ignored. (Most of the time, it should be the same). + * + * **Interaction between `start` and `limit` and pagination : you should + * take only the given parameters into account; the results from pagination + * should be ignored. (Most of the time, it should be the same). * * @param array $terms the string to search * @param int $start the first result (for pagination) @@ -72,10 +71,10 @@ interface SearchInterface */ public function renderResult(array $terms, $start=0, $limit=50, array $options = array(), $format = 'html'); - /** + /** * we may desactive the search interface by default. in this case, - * the search will be launch and rendered only with "advanced search" - * + * the search will be launch and rendered only with "advanced search" + * * this may be activated/desactived from bundle definition in config.yml * * @return bool @@ -84,18 +83,18 @@ interface SearchInterface /** * the order in which the results will appears in the global view - * + * * (this may be eventually defined in config.yml) - * - * @return int + * + * @return int */ public function getOrder(); - + /** * indicate if the implementation supports the given domain - * + * * @return boolean */ public function supports($domain, $format); - + } diff --git a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php new file mode 100644 index 000000000..f466260ca --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php @@ -0,0 +1,272 @@ +security = $security; + $this->em = $em; + $this->countryRepository = $countryRepository; + $this->authorizationHelper = $authorizationHelper; + } + + /** + * @return array|Person[] + * @throws NonUniqueResultException + * @throws ParsingException + */ + public function findBySearchCriteria( + int $start, + int $limit, + bool $simplify = false, + string $default = null, + string $firstname = null, + string $lastname = null, + ?\DateTime $birthdate = null, + ?\DateTime $birthdateBefore = null, + ?\DateTime $birthdateAfter = null, + string $gender = null, + string $countryCode = null + ): array { + $qb = $this->createSearchQuery($default, $firstname, $lastname, + $birthdate, $birthdateBefore, $birthdateAfter, $gender, + $countryCode); + $this->addACLClauses($qb, 'p'); + + if ($simplify) { + $qb->select( + 'p.id', + $qb->expr()->concat( + 'p.firstName', + $qb->expr()->literal(' '), + 'p.lastName' + ).'AS text' + ); + } else { + $qb->select('p'); + } + + $qb + ->setMaxResults($limit) + ->setFirstResult($start); + + //order by firstname, lastname + $qb + ->orderBy('p.firstName') + ->addOrderBy('p.lastName'); + + if ($simplify) { + return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); + } else { + return $qb->getQuery()->getResult(); + } + } + + public function countBySearchCriteria( + string $default = null, + string $firstname = null, + string $lastname = null, + ?\DateTime $birthdate = null, + ?\DateTime $birthdateBefore = null, + ?\DateTime $birthdateAfter = null, + string $gender = null, + string $countryCode = null + ): int { + $qb = $this->createSearchQuery($default, $firstname, $lastname, + $birthdate, $birthdateBefore, $birthdateAfter, $gender, + $countryCode); + $this->addACLClauses($qb, 'p'); + + $qb->select('COUNT(p.id)'); + + return $qb->getQuery()->getSingleScalarResult(); + } + + public function findBySimilaritySearch(string $pattern, int $firstResult, + int $maxResult, bool $simplify = false) + { + $qb = $this->createSimilarityQuery($pattern); + $this->addACLClauses($qb, 'sp'); + + if ($simplify) { + $qb->select( + 'sp.id', + $qb->expr()->concat( + 'sp.firstName', + $qb->expr()->literal(' '), + 'sp.lastName' + ).'AS text' + ); + } else { + $qb->select('p'); + } + + $qb + ->setMaxResults($maxResult) + ->setFirstResult($firstResult); + + //order by firstname, lastname + $qb + ->orderBy('sp.firstName') + ->addOrderBy('sp.lastName'); + + if ($simplify) { + return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); + } else { + return $qb->getQuery()->getResult(); + } + } + + public function countBySimilaritySearch(string $pattern) + { + $qb = $this->createSimilarityQuery($pattern); + $this->addACLClauses($qb, 'sp'); + + $qb->select('COUNT(sp.id)'); + + return $qb->getQuery()->getSingleScalarResult(); + } + + private function createSearchQuery( + string $default = null, + string $firstname = null, + string $lastname = null, + ?\DateTime $birthdate = null, + ?\DateTime $birthdateBefore = null, + ?\DateTime $birthdateAfter = null, + string $gender = null, + string $countryCode = null + ): QueryBuilder { + + if (!$this->security->getUser() instanceof User) { + throw new \RuntimeException("Search must be performed by a valid user"); + } + $qb = $this->em->createQueryBuilder(); + $qb->from(Person::class, 'p'); + + if (NULL !== $firstname) { + $qb->andWhere($qb->expr()->like('UNACCENT(LOWER(p.firstName))', ':firstname')) + ->setParameter('firstname', '%'.$firstname.'%'); + } + + if (NULL !== $lastname) { + $qb->andWhere($qb->expr()->like('UNACCENT(LOWER(p.lastName))', ':lastname')) + ->setParameter('lastname', '%'.$lastname.'%'); + } + + if (NULL !== $birthdate) { + $qb->andWhere($qb->expr()->eq('s.birthdate', ':birthdate')) + ->setParameter('birthdate', $birthdate); + } + + if (NULL !== $birthdateAfter) { + $qb->andWhere($qb->expr()->gt('p.birthdate', ':birthdateafter')) + ->setParameter('birthdateafter', $birthdateAfter); + } + + if (NULL !== $birthdateBefore) { + $qb->andWhere($qb->expr()->lt('p.birthdate', ':birthdatebefore')) + ->setParameter('birthdatebefore', $birthdateBefore); + } + + if (NULL !== $gender) { + $qb->andWhere($qb->expr()->eq('p.gender', ':gender')) + ->setParameter('gender', $gender); + } + + if (NULL !== $countryCode) { + try { + $country = $this->countryRepository->findOneBy(['countryCode' => $countryCode]); + } catch (NoResultException $ex) { + throw new ParsingException('The country code "'.$countryCode.'" ' + . ', used in nationality, is unknow', 0, $ex); + } catch (NonUniqueResultException $e) { + throw $e; + } + + $qb->andWhere($qb->expr()->eq('p.nationality', ':nationality')) + ->setParameter('nationality', $country); + } + + if (NULL !== $default) { + $grams = explode(' ', $default); + + foreach($grams as $key => $gram) { + $qb->andWhere($qb->expr() + ->like('p.fullnameCanonical', 'UNACCENT(LOWER(:default_'.$key.'))')) + ->setParameter('default_'.$key, '%'.$gram.'%'); + } + } + + return $qb; + } + + private function addACLClauses(QueryBuilder $qb, string $personAlias): void + { + // restrict center for security + $reachableCenters = $this->authorizationHelper + ->getReachableCenters($this->security->getUser(), 'CHILL_PERSON_SEE'); + $qb->andWhere( + $qb->expr()->orX( + $qb->expr() + ->in($personAlias.'.center', ':centers'), + $qb->expr() + ->isNull($personAlias.'.center') + ) + ); + $qb->setParameter('centers', $reachableCenters); + } + + private function createSimilarityQuery($pattern): QueryBuilder + { + $qb = $this->em->createQueryBuilder(); + + $qb->from(Person::class, 'sp'); + + $grams = explode(' ', $pattern); + + foreach($grams as $key => $gram) { + $qb->andWhere('SIMILARITY(sp.fullnameCanonical, UNACCENT(LOWER(:default_'.$key.')) ) >= 0.15') + ->setParameter('default_'.$key, '%'.$gram.'%'); + } + + $qb->andWhere($qb->expr() + ->notIn( + 'sp.id', + $this->createSearchQuery($pattern) + ->addSelect('p.id') + ->getDQL() + ) + ); + + return $qb; + } +} diff --git a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepositoryInterface.php b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepositoryInterface.php new file mode 100644 index 000000000..8e83da03d --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepositoryInterface.php @@ -0,0 +1,50 @@ +repository->findBy(['id' => $ids]); } + public function findAll() + { + return $this->repository->findAll(); + } + + public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $offset = null) + { + return $this->repository->findBy($criteria, $orderBy, $limit, $offset); + } + + public function findOneBy(array $criteria) + { + return $this->repository->findOneBy($criteria); + } + + public function getClassName() + { + return Person::class; + } + /** * @param $centers * @param $firstResult diff --git a/src/Bundle/ChillPersonBundle/Search/PersonSearch.php b/src/Bundle/ChillPersonBundle/Search/PersonSearch.php index 231636fff..f62b90006 100644 --- a/src/Bundle/ChillPersonBundle/Search/PersonSearch.php +++ b/src/Bundle/ChillPersonBundle/Search/PersonSearch.php @@ -20,71 +20,39 @@ namespace Chill\PersonBundle\Search; use Chill\MainBundle\Search\AbstractSearch; -use Doctrine\ORM\EntityManagerInterface; +use Chill\PersonBundle\Repository\PersonACLAwareRepositoryInterface; use Chill\PersonBundle\Entity\Person; use Chill\MainBundle\Search\SearchInterface; -use Symfony\Component\DependencyInjection\ContainerAwareInterface; -use Symfony\Component\DependencyInjection\ContainerAwareTrait; use Chill\MainBundle\Search\ParsingException; -use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface; -use Chill\MainBundle\Security\Authorization\AuthorizationHelper; -use Symfony\Component\Security\Core\Role\Role; use Chill\MainBundle\Pagination\PaginatorFactory; use Symfony\Component\Form\Extension\Core\Type\TextType; use Chill\MainBundle\Form\Type\ChillDateType; use Symfony\Component\Form\Extension\Core\Type\ChoiceType; use Symfony\Component\Form\FormBuilderInterface; use Chill\MainBundle\Search\HasAdvancedSearchFormInterface; -use Doctrine\ORM\Query; +use Symfony\Component\Templating\EngineInterface; -class PersonSearch extends AbstractSearch implements ContainerAwareInterface, - HasAdvancedSearchFormInterface +class PersonSearch extends AbstractSearch implements HasAdvancedSearchFormInterface { - use ContainerAwareTrait; - - /** - * - * @var EntityManagerInterface - */ - private $em; - - /** - * - * @var \Chill\MainBundle\Entity\User - */ - private $user; - - /** - * - * @var AuthorizationHelper - */ - private $helper; - - /** - * - * @var PaginatorFactory - */ - protected $paginatorFactory; + protected EngineInterface $templating; + protected PaginatorFactory $paginatorFactory; + protected PersonACLAwareRepositoryInterface $personACLAwareRepository; const NAME = "person_regular"; + private const POSSIBLE_KEYS = [ + '_default', 'firstname', 'lastname', 'birthdate', 'birthdate-before', + 'birthdate-after', 'gender', 'nationality' + ]; public function __construct( - EntityManagerInterface $em, - TokenStorageInterface $tokenStorage, - AuthorizationHelper $helper, - PaginatorFactory $paginatorFactory) - { - $this->em = $em; - $this->user = $tokenStorage->getToken()->getUser(); - $this->helper = $helper; + EngineInterface $templating, + PaginatorFactory $paginatorFactory, + PersonACLAwareRepositoryInterface $personACLAwareRepository + ) { + $this->templating = $templating; $this->paginatorFactory = $paginatorFactory; - - // throw an error if user is not a valid user - if (!$this->user instanceof \Chill\MainBundle\Entity\User) { - throw new \LogicException('The user provided must be an instance' - . ' of Chill\MainBundle\Entity\User'); - } + $this->personACLAwareRepository = $personACLAwareRepository; } /* @@ -120,12 +88,14 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, $paginator = $this->paginatorFactory->create($total); if ($format === 'html') { - return $this->container->get('templating')->render('@ChillPerson/Person/list_with_period.html.twig', + return $this->templating->render('@ChillPerson/Person/list_with_period.html.twig', array( 'persons' => $this->search($terms, $start, $limit, $options), - 'pattern' => $this->recomposePattern($terms, array('nationality', - 'firstname', 'lastname', 'birthdate', 'gender', - 'birthdate-before','birthdate-after'), $terms['_domain']), + 'pattern' => $this->recomposePattern( + $terms, + \array_filter(self::POSSIBLE_KEYS, fn($item) => $item !== '_default'), + $terms['_domain'] + ), 'total' => $total, 'start' => $start, 'search_name' => self::NAME, @@ -152,158 +122,81 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, */ protected function search(array $terms, $start, $limit, array $options = array()) { - $qb = $this->createQuery($terms, 'search'); + [ + '_default' => $default, + 'firstname' => $firstname, + 'lastname' => $lastname, + 'birthdate' => $birthdate, + 'birthdate-before' => $birthdateBefore, + 'birthdate-after' => $birthdateAfter, + 'gender' => $gender, + 'nationality' => $countryCode, - if ($options['simplify'] ?? false) { - $qb->select( - 'p.id', - $qb->expr()->concat( - 'p.firstName', - $qb->expr()->literal(' '), - 'p.lastName' - ).'AS text' - ); - } else { - $qb->select('p'); + ] = $terms + \array_fill_keys(self::POSSIBLE_KEYS, null); + + foreach (['birthdateBefore', 'birthdateAfter', 'birthdate'] as $v) { + if (NULL !== ${$v}) { + try { + ${$v} = new \DateTime(${$v}); + } catch (\Exception $e) { + throw new ParsingException('The date is ' + . 'not parsable', 0, $e); + } + } } - $qb - ->setMaxResults($limit) - ->setFirstResult($start); - - //order by firstname, lastname - - $qb - ->orderBy('p.firstName') - ->addOrderBy('p.lastName'); - - if ($options['simplify'] ?? false) { - return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); - } else { - return $qb->getQuery()->getResult(); - } + return $this->personACLAwareRepository + ->findBySearchCriteria( + $start, + $limit, + $options['simplify'] ?? false, + $default, + $firstname, + $lastname, + $birthdate, + $birthdateBefore, + $birthdateAfter, + $gender, + $countryCode, + ); } - protected function count(array $terms) + protected function count(array $terms): int { - $qb = $this->createQuery($terms); + [ + '_default' => $default, + 'firstname' => $firstname, + 'lastname' => $lastname, + 'birthdate' => $birthdate, + 'birthdate-before' => $birthdateBefore, + 'birthdate-after' => $birthdateAfter, + 'gender' => $gender, + 'nationality' => $countryCode, - $qb->select('COUNT(p.id)'); + ] = $terms + \array_fill_keys(self::POSSIBLE_KEYS, null); - return $qb->getQuery()->getSingleScalarResult(); - } - - - private $_cacheQuery = array(); - - /** - * - * @param array $terms - * @return \Doctrine\ORM\QueryBuilder - */ - public function createQuery(array $terms) - { - //get from cache - $cacheKey = md5(serialize($terms)); - if (array_key_exists($cacheKey, $this->_cacheQuery)) { - return clone $this->_cacheQuery[$cacheKey]; - } - - $qb = $this->em->createQueryBuilder(); - - $qb->from('ChillPersonBundle:Person', 'p'); - - if (array_key_exists('firstname', $terms)) { - $qb->andWhere($qb->expr()->like('UNACCENT(LOWER(p.firstName))', ':firstname')) - ->setParameter('firstname', '%'.$terms['firstname'].'%'); - } - - if (array_key_exists('lastname', $terms)) { - $qb->andWhere($qb->expr()->like('UNACCENT(LOWER(p.lastName))', ':lastname')) - ->setParameter('lastname', '%'.$terms['lastname'].'%'); - } - - foreach (['birthdate', 'birthdate-before', 'birthdate-after'] as $key) - if (array_key_exists($key, $terms)) { - try { - $date = new \DateTime($terms[$key]); - } catch (\Exception $ex) { - throw new ParsingException('The date is ' - . 'not parsable', 0, $ex); - } - - switch($key) { - case 'birthdate': - $qb->andWhere($qb->expr()->eq('p.birthdate', ':birthdate')) - ->setParameter('birthdate', $date); - break; - case 'birthdate-before': - $qb->andWhere($qb->expr()->lt('p.birthdate', ':birthdatebefore')) - ->setParameter('birthdatebefore', $date); - break; - case 'birthdate-after': - $qb->andWhere($qb->expr()->gt('p.birthdate', ':birthdateafter')) - ->setParameter('birthdateafter', $date); - break; - default: - throw new \LogicException("this case $key should not exists"); - } - - } - - if (array_key_exists('gender', $terms)) { - if (!in_array($terms['gender'], array(Person::MALE_GENDER, Person::FEMALE_GENDER))) { - throw new ParsingException('The gender ' - .$terms['gender'].' is not accepted. Should be "'.Person::MALE_GENDER - .'" or "'.Person::FEMALE_GENDER.'"'); - } - - $qb->andWhere($qb->expr()->eq('p.gender', ':gender')) - ->setParameter('gender', $terms['gender']); - } - - if (array_key_exists('nationality', $terms)) { - try { - $country = $this->em->createQuery('SELECT c FROM ' - . 'ChillMainBundle:Country c WHERE ' - . 'LOWER(c.countryCode) LIKE :code') - ->setParameter('code', $terms['nationality']) - ->getSingleResult(); - } catch (\Doctrine\ORM\NoResultException $ex) { - throw new ParsingException('The country code "'.$terms['nationality'].'" ' - . ', used in nationality, is unknow', 0, $ex); - } - - $qb->andWhere($qb->expr()->eq('p.nationality', ':nationality')) - ->setParameter('nationality', $country); - } - - if ($terms['_default'] !== '') { - $grams = explode(' ', $terms['_default']); - - foreach($grams as $key => $gram) { - $qb->andWhere($qb->expr() - ->like('p.fullnameCanonical', 'UNACCENT(LOWER(:default_'.$key.'))')) - ->setParameter('default_'.$key, '%'.$gram.'%'); + foreach (['birthdateBefore', 'birthdateAfter', 'birthdate'] as $v) { + if (NULL !== ${$v}) { + try { + ${$v} = new \DateTime(${$v}); + } catch (\Exception $e) { + throw new ParsingException('The date is ' + . 'not parsable', 0, $e); + } } } - //restraint center for security - $reachableCenters = $this->helper->getReachableCenters($this->user, - new Role('CHILL_PERSON_SEE')); - $qb->andWhere( - $qb->expr()->orX( - $qb->expr() - ->in('p.center', ':centers'), - $qb->expr() - ->isNull('p.center') - ) - ); - $qb->setParameter('centers', $reachableCenters); - - $this->_cacheQuery[$cacheKey] = $qb; - - return clone $qb; + return $this->personACLAwareRepository + ->countBySearchCriteria( + $default, + $firstname, + $lastname, + $birthdate, + $birthdateBefore, + $birthdateAfter, + $gender, + $countryCode, + ); } public function buildForm(FormBuilderInterface $builder) @@ -396,4 +289,10 @@ class PersonSearch extends AbstractSearch implements ContainerAwareInterface, return 'Search within persons'; } + public static function getAlias(): string + { + return self::NAME; + } + + } diff --git a/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php b/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php index ea2c9a5c7..f1ea52c8e 100644 --- a/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php +++ b/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php @@ -2,90 +2,32 @@ namespace Chill\PersonBundle\Search; - use Chill\MainBundle\Pagination\PaginatorFactory; use Chill\MainBundle\Search\AbstractSearch; use Chill\MainBundle\Search\SearchInterface; -use Chill\MainBundle\Security\Authorization\AuthorizationHelper; -use Doctrine\ORM\EntityManagerInterface; -use Symfony\Component\DependencyInjection\ContainerAwareInterface; -use Symfony\Component\DependencyInjection\ContainerAwareTrait; -use Symfony\Component\Form\FormBuilderInterface; -use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface; -use Symfony\Component\Security\Core\Role\Role; +use Chill\PersonBundle\Repository\PersonACLAwareRepositoryInterface; +use Symfony\Component\Templating\EngineInterface; -/** - * Class SimilarityPersonSearch - * - * @package Chill\PersonBundle\Search - */ class SimilarityPersonSearch extends AbstractSearch { - - use ContainerAwareTrait; - - /** - * - * @var EntityManagerInterface - */ - private $em; - - /** - * - * @var \Chill\MainBundle\Entity\User - */ - private $user; - - /** - * - * @var AuthorizationHelper - */ - private $helper; - - /** - * - * @var PaginatorFactory - */ - protected $paginatorFactory; - + protected PaginatorFactory $paginatorFactory; + + private PersonACLAwareRepositoryInterface $personACLAwareRepository; + + private EngineInterface $templating; + const NAME = "person_similarity"; - - /** - * - * @var PersonSearch - */ - private $personSearch; - - - /** - * SimilarityPersonSearch constructor. - * - * @param EntityManagerInterface $em - * @param TokenStorageInterface $tokenStorage - * @param AuthorizationHelper $helper - * @param PaginatorFactory $paginatorFactory - * @param PersonSearch $personSearch - */ + public function __construct( - EntityManagerInterface $em, - TokenStorageInterface $tokenStorage, - AuthorizationHelper $helper, PaginatorFactory $paginatorFactory, - PersonSearch $personSearch) - { - $this->em = $em; - $this->user = $tokenStorage->getToken()->getUser(); - $this->helper = $helper; + PersonACLAwareRepositoryInterface $personACLAwareRepository, + EngineInterface $templating + ) { $this->paginatorFactory = $paginatorFactory; - $this->personSearch = $personSearch; - - // throw an error if user is not a valid user - if (!$this->user instanceof \Chill\MainBundle\Entity\User) { - throw new \LogicException('The user provided must be an instance' - . ' of Chill\MainBundle\Entity\User'); - } + $this->personACLAwareRepository = $personACLAwareRepository; + $this->templating = $templating; } - + /* * (non-PHPdoc) * @see \Chill\MainBundle\Search\SearchInterface::getOrder() @@ -94,7 +36,7 @@ class SimilarityPersonSearch extends AbstractSearch { return 200; } - + /* * (non-PHPdoc) * @see \Chill\MainBundle\Search\SearchInterface::isActiveByDefault() @@ -103,30 +45,27 @@ class SimilarityPersonSearch extends AbstractSearch { return true; } - + public function supports($domain, $format) { return 'person' === $domain; } - + /** * @param array $terms * @param int $start * @param int $limit * @param array $options * @param string $format - * @return array */ public function renderResult(array $terms, $start = 0, $limit = 50, array $options = array(), $format = 'html') { $total = $this->count($terms); $paginator = $this->paginatorFactory->create($total); - - if ($format === 'html') - { - if ($total !== 0) - { - return $this->container->get('templating')->render('ChillPersonBundle:Person:list.html.twig', + + if ($format === 'html') { + if ($total !== 0) { + return $this->templating->render('ChillPersonBundle:Person:list.html.twig', array( 'persons' => $this->search($terms, $start, $limit, $options), 'pattern' => $this->recomposePattern($terms, array('nationality', @@ -143,9 +82,8 @@ class SimilarityPersonSearch extends AbstractSearch else { return null; } - - } elseif ($format === 'json') - { + + } elseif ($format === 'json') { return [ 'results' => $this->search($terms, $start, $limit, \array_merge($options, [ 'simplify' => true ])), 'pagination' => [ @@ -154,8 +92,7 @@ class SimilarityPersonSearch extends AbstractSearch ]; } } - - + /** * * @param string $pattern @@ -166,101 +103,12 @@ class SimilarityPersonSearch extends AbstractSearch */ protected function search(array $terms, $start, $limit, array $options = array()) { - $qb = $this->createQuery($terms, 'search'); - - - if ($options['simplify'] ?? false) { - $qb->select( - 'sp.id', - $qb->expr()->concat( - 'sp.firstName', - $qb->expr()->literal(' '), - 'sp.lastName' - ).'AS text' - ); - } else { - $qb->select('sp'); - } - - $qb - ->setMaxResults($limit) - ->setFirstResult($start); - - //order by firstname, lastname - - $qb - ->orderBy('sp.firstName') - ->addOrderBy('sp.lastName'); - - if ($options['simplify'] ?? false) { - return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); - } else { - return $qb->getQuery()->getResult(); - } + return $this->personACLAwareRepository + ->findBySimilaritySearch($terms['_default']); } - - + protected function count(array $terms) { - $qb = $this->createQuery($terms); - - - $qb->select('COUNT(sp.id)'); - - return $qb->getQuery()->getSingleScalarResult(); + return $this->personACLAwareRepository->countBySimilaritySearch($terms['_default']); } - - - private $_cacheQuery = array(); - - /** - * - * @param array $terms - * @return \Doctrine\ORM\QueryBuilder - */ - protected function createQuery(array $terms) - { - //get from cache - $cacheKey = md5(serialize($terms)); - if (array_key_exists($cacheKey, $this->_cacheQuery)) { - return clone $this->_cacheQuery[$cacheKey]; - } - - $qb = $this->em->createQueryBuilder(); - - $qb ->select('sp') - ->from('ChillPersonBundle:Person', 'sp'); - - if ($terms['_default'] !== '') { - $grams = explode(' ', $terms['_default']); - - foreach($grams as $key => $gram) { - $qb->andWhere('SIMILARITY(sp.fullnameCanonical, UNACCENT(LOWER(:default_'.$key.')) ) >= 0.15') - ->setParameter('default_'.$key, '%'.$gram.'%'); - } - - $qb->andWhere($qb->expr() - ->notIn( - 'sp.id', - $this->personSearch - ->createQuery($terms) - ->addSelect('p.id') - ->getDQL() - ) - ); - } - - //restraint center for security - $reachableCenters = $this->helper->getReachableCenters($this->user, - new Role('CHILL_PERSON_SEE')); - $qb->andWhere($qb->expr() - ->in('sp.center', ':centers')) - ->setParameter('centers', $reachableCenters) - ; - - $this->_cacheQuery[$cacheKey] = $qb; - - return clone $qb; - } - -} \ No newline at end of file +} diff --git a/src/Bundle/ChillPersonBundle/config/services.yaml b/src/Bundle/ChillPersonBundle/config/services.yaml index 43e042e6b..6133068a4 100644 --- a/src/Bundle/ChillPersonBundle/config/services.yaml +++ b/src/Bundle/ChillPersonBundle/config/services.yaml @@ -70,7 +70,6 @@ services: autowire: true autoconfigure: true resource: '../Repository/' - tags: ['doctrine.repository_service'] Chill\PersonBundle\Controller\: autowire: true diff --git a/src/Bundle/ChillPersonBundle/config/services/repository.yaml b/src/Bundle/ChillPersonBundle/config/services/repository.yaml index 72ca27e24..fa76ccd7c 100644 --- a/src/Bundle/ChillPersonBundle/config/services/repository.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/repository.yaml @@ -1,6 +1,11 @@ services: + # note: the services.yaml file define some autoloading + chill.person.repository.person: class: Chill\PersonBundle\Repository\PersonRepository autowire: true autoconfigure: true Chill\PersonBundle\Repository\PersonRepository: '@chill.person.repository.person' + + Chill\PersonBundle\Repository\PersonACLAwareRepositoryInterface: '@Chill\PersonBundle\Repository\PersonACLAwareRepository' + diff --git a/src/Bundle/ChillPersonBundle/config/services/search.yaml b/src/Bundle/ChillPersonBundle/config/services/search.yaml index 284773196..6a7cd4496 100644 --- a/src/Bundle/ChillPersonBundle/config/services/search.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/search.yaml @@ -1,25 +1,11 @@ services: - chill.person.search_person: - class: Chill\PersonBundle\Search\PersonSearch - arguments: - - "@doctrine.orm.entity_manager" - - "@security.token_storage" - - "@chill.main.security.authorization.helper" - - "@chill_main.paginator_factory" - calls: - - ['setContainer', ["@service_container"]] + Chill\PersonBundle\Search\PersonSearch: + autowire: true tags: - { name: chill.search, alias: 'person_regular' } Chill\PersonBundle\Search\SimilarityPersonSearch: - arguments: - - "@doctrine.orm.entity_manager" - - "@security.token_storage" - - "@chill.main.security.authorization.helper" - - "@chill_main.paginator_factory" - - '@chill.person.search_person' - calls: - - ['setContainer', ["@service_container"]] + autowire: true tags: - { name: chill.search, alias: 'person_similarity' } From f63d4fcfbaf53f5ad297f682dab2157edfddce5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 10 Sep 2021 18:22:50 +0200 Subject: [PATCH 17/37] optimize query for person --- .../ChillMainExtension.php | 2 ++ .../Doctrine/DQL/Similarity.php | 19 ++++------- .../Doctrine/DQL/StrictWordSimilarityOPS.php | 34 +++++++++++++++++++ .../Repository/PersonACLAwareRepository.php | 19 ++++------- .../Search/SimilarityPersonSearch.php | 2 +- .../migrations/Version20210910161858.php | 31 +++++++++++++++++ 6 files changed, 82 insertions(+), 25 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Doctrine/DQL/StrictWordSimilarityOPS.php create mode 100644 src/Bundle/ChillPersonBundle/migrations/Version20210910161858.php diff --git a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php index 09897fec2..77da7b435 100644 --- a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php +++ b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php @@ -19,6 +19,7 @@ namespace Chill\MainBundle\DependencyInjection; +use Chill\MainBundle\Doctrine\DQL\StrictWordSimilarityOPS; use Chill\MainBundle\Entity\UserJob; use Chill\MainBundle\Form\UserJobType; use Symfony\Component\DependencyInjection\ContainerBuilder; @@ -185,6 +186,7 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface, 'JSONB_EXISTS_IN_ARRAY' => JsonbExistsInArray::class, 'SIMILARITY' => Similarity::class, 'OVERLAPSI' => OverlapsI::class, + 'STRICT_WORD_SIMILARITY_OPS' => StrictWordSimilarityOPS::class ], ], 'hydrators' => [ diff --git a/src/Bundle/ChillMainBundle/Doctrine/DQL/Similarity.php b/src/Bundle/ChillMainBundle/Doctrine/DQL/Similarity.php index 988e55f5f..1875f978c 100644 --- a/src/Bundle/ChillMainBundle/Doctrine/DQL/Similarity.php +++ b/src/Bundle/ChillMainBundle/Doctrine/DQL/Similarity.php @@ -21,20 +21,15 @@ namespace Chill\MainBundle\Doctrine\DQL; use Doctrine\ORM\Query\AST\Functions\FunctionNode; use Doctrine\ORM\Query\Lexer; -/** - * - * - * - */ class Similarity extends FunctionNode { private $firstPart; - + private $secondPart; - + public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) { - return 'SIMILARITY('.$this->firstPart->dispatch($sqlWalker). + return 'SIMILARITY('.$this->firstPart->dispatch($sqlWalker). ', ' . $this->secondPart->dispatch($sqlWalker) .")"; } @@ -42,13 +37,13 @@ class Similarity extends FunctionNode { $parser->match(Lexer::T_IDENTIFIER); $parser->match(Lexer::T_OPEN_PARENTHESIS); - + $this->firstPart = $parser->StringPrimary(); - + $parser->match(Lexer::T_COMMA); - + $this->secondPart = $parser->StringPrimary(); - + $parser->match(Lexer::T_CLOSE_PARENTHESIS); } } diff --git a/src/Bundle/ChillMainBundle/Doctrine/DQL/StrictWordSimilarityOPS.php b/src/Bundle/ChillMainBundle/Doctrine/DQL/StrictWordSimilarityOPS.php new file mode 100644 index 000000000..22dcda879 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Doctrine/DQL/StrictWordSimilarityOPS.php @@ -0,0 +1,34 @@ +firstPart->dispatch($sqlWalker). + ' <<% ' . $this->secondPart->dispatch($sqlWalker); + } + + public function parse(\Doctrine\ORM\Query\Parser $parser) + { + $parser->match(Lexer::T_IDENTIFIER); + $parser->match(Lexer::T_OPEN_PARENTHESIS); + + $this->firstPart = $parser->StringPrimary(); + + $parser->match(Lexer::T_COMMA); + + $this->secondPart = $parser->StringPrimary(); + + $parser->match(Lexer::T_CLOSE_PARENTHESIS); + } +} diff --git a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php index f466260ca..40d06615c 100644 --- a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php @@ -12,7 +12,6 @@ use Doctrine\ORM\NonUniqueResultException; use Doctrine\ORM\NoResultException; use Doctrine\ORM\Query; use Doctrine\ORM\QueryBuilder; -use Symfony\Component\Security\Core\Role\Role; use Symfony\Component\Security\Core\Security; @@ -126,7 +125,7 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac ).'AS text' ); } else { - $qb->select('p'); + $qb->select('sp'); } $qb @@ -254,18 +253,14 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $grams = explode(' ', $pattern); foreach($grams as $key => $gram) { - $qb->andWhere('SIMILARITY(sp.fullnameCanonical, UNACCENT(LOWER(:default_'.$key.')) ) >= 0.15') + $qb->andWhere('STRICT_WORD_SIMILARITY_OPS(:default_'.$key.', sp.fullnameCanonical) = TRUE') ->setParameter('default_'.$key, '%'.$gram.'%'); - } - $qb->andWhere($qb->expr() - ->notIn( - 'sp.id', - $this->createSearchQuery($pattern) - ->addSelect('p.id') - ->getDQL() - ) - ); + // remove the perfect matches + $qb->andWhere($qb->expr() + ->notLike('sp.fullnameCanonical', 'UNACCENT(LOWER(:not_default_'.$key.'))')) + ->setParameter('not_default_'.$key, '%'.$gram.'%'); + } return $qb; } diff --git a/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php b/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php index f1ea52c8e..e62c2ee55 100644 --- a/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php +++ b/src/Bundle/ChillPersonBundle/Search/SimilarityPersonSearch.php @@ -104,7 +104,7 @@ class SimilarityPersonSearch extends AbstractSearch protected function search(array $terms, $start, $limit, array $options = array()) { return $this->personACLAwareRepository - ->findBySimilaritySearch($terms['_default']); + ->findBySimilaritySearch($terms['_default'], $start, $limit, $options['simplify'] ?? false); } protected function count(array $terms) diff --git a/src/Bundle/ChillPersonBundle/migrations/Version20210910161858.php b/src/Bundle/ChillPersonBundle/migrations/Version20210910161858.php new file mode 100644 index 000000000..82cade6cf --- /dev/null +++ b/src/Bundle/ChillPersonBundle/migrations/Version20210910161858.php @@ -0,0 +1,31 @@ +addSql('DROP INDEX fullnamecanonical_trgm_idx'); + $this->addSql('CREATE INDEX fullnameCanonical_trgm_idx ON chill_person_person USING GIST (center_id, fullnameCanonical gist_trgm_ops)'); + } + + public function down(Schema $schema): void + { + $this->addSql('DROP INDEX fullnamecanonical_trgm_idx'); + $this->addSql('CREATE INDEX fullnameCanonical_trgm_idx ON chill_person_person USING GIST (fullnameCanonical gist_trgm_ops)'); + } +} From 50b7554aea8fb52a16056779fb2ba98a1db548b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 15 Sep 2021 12:24:58 +0200 Subject: [PATCH 18/37] optimize query for current address + documentation --- .../Household/PersonHouseholdAddress.php | 35 ++++++++ .../ChillPersonBundle/Entity/Person.php | 45 ++++++++++- .../Entity/Person/PersonCurrentAddress.php | 81 +++++++++++++++++++ .../migrations/Version20210915093624.php | 49 +++++++++++ 4 files changed, 207 insertions(+), 3 deletions(-) create mode 100644 src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php create mode 100644 src/Bundle/ChillPersonBundle/migrations/Version20210915093624.php diff --git a/src/Bundle/ChillPersonBundle/Entity/Household/PersonHouseholdAddress.php b/src/Bundle/ChillPersonBundle/Entity/Household/PersonHouseholdAddress.php index 511416a0e..28235b521 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Household/PersonHouseholdAddress.php +++ b/src/Bundle/ChillPersonBundle/Entity/Household/PersonHouseholdAddress.php @@ -8,6 +8,29 @@ use Chill\PersonBundle\Entity\Person; use Doctrine\ORM\Mapping as ORM; /** + * This class links a person to the history of his addresses, through + * household membership. + * + * It is optimized on DB side, and compute the start date and end date + * of each address by the belonging of household. + * + * **note**: the start date and end date are the date of belonging to the address, + * not the belonging of the household. + * + * Example: + * + * * person A is member of household W from 2021-01-01 to 2021-12-01 + * * person A is member of household V from 2021-12-01, still present after + * * household W lives in address Q from 2020-06-01 to 2021-06-01 + * * household W lives in address R from 2021-06-01 to 2022-06-01 + * * household V lives in address T from 2021-12-01 to still living there after + * + * The person A will have those 3 entities: + * + * 1. 1st entity: from 2021-01-01 to 2021-06-01, household W, address Q; + * 2. 2st entity: from 2021-06-01 to 2021-12-01, household W, address R; + * 3. 3st entity: from 2021-12-01 to NULL, household V, address T; + * * @ORM\Entity(readOnly=true) * @ORM\Table(name="view_chill_person_household_address") */ @@ -45,11 +68,23 @@ class PersonHouseholdAddress */ private $address; + /** + * The start date of the intersection address/household + * + * (this is not the startdate of the household, not + * the startdate of the address) + */ public function getValidFrom(): ?\DateTimeInterface { return $this->validFrom; } + /** + * The end date of the intersection address/household + * + * (this is not the enddate of the household, not + * the enddate of the address) + */ public function getValidTo(): ?\DateTimeImmutable { return $this->validTo; diff --git a/src/Bundle/ChillPersonBundle/Entity/Person.php b/src/Bundle/ChillPersonBundle/Entity/Person.php index f42ca6f00..bc5c46e08 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person.php @@ -35,6 +35,7 @@ use Chill\PersonBundle\Entity\Household\HouseholdMember; use Chill\MainBundle\Entity\HasCenterInterface; use Chill\MainBundle\Entity\Address; use Chill\MainBundle\Entity\Embeddable\CommentEmbeddable; +use Chill\PersonBundle\Entity\Person\PersonCurrentAddress; use DateTime; use Doctrine\ORM\Mapping as ORM; use Doctrine\Common\Collections\Collection; @@ -412,6 +413,15 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI */ private $addresses; + /** + * The current person address. + * + * This is computed through database and is optimized on database side. + * + * @var PersonCurrentAddress|null + */ + private ?PersonCurrentAddress $currentPersonAddress = null; + /** * fullname canonical. Read-only field, which is calculated by * the database. @@ -564,6 +574,8 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI return $participation->getAccompanyingPeriod(); } } + + return null; } /** @@ -1242,13 +1254,31 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI return $this->addresses; } + /** + * @deprecated Use `getCurrentPersonAddress` instead + * @param DateTime|null $from + * @return false|mixed|null + * @throws \Exception + */ public function getLastAddress(DateTime $from = null) { - $from ??= new DateTime('now'); + return $this->getCurrentPersonAddress($from); + } + + /** + * get the address associated with the person at the given date + * + * @param DateTime|null $at + * @return Address|null + * @throws \Exception + */ + public function getCurrentPersonAddress(?\DateTime $at = null): ?Address + { + $at ??= new DateTime('now'); /** @var ArrayIterator $addressesIterator */ $addressesIterator = $this->getAddresses() - ->filter(static fn (Address $address): bool => $address->getValidFrom() <= $from) + ->filter(static fn (Address $address): bool => $address->getValidFrom() <= $at) ->getIterator(); $addressesIterator->uasort( @@ -1496,7 +1526,16 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI public function getCurrentHouseholdAddress(?\DateTimeImmutable $at = null): ?Address { - $at = $at === null ? new \DateTimeImmutable('today') : $at; + if ( + NULL === $at + || + $at->format('Ymd') === (new \DateTime('today'))->format('Ymd') + ) { + return $this->currentPersonAddress instanceof PersonCurrentAddress + ? $this->currentPersonAddress->getAddress() : NULL; + } + + // if not now, compute the date from history $criteria = new Criteria(); $expr = Criteria::expr(); diff --git a/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php b/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php new file mode 100644 index 000000000..21962b700 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php @@ -0,0 +1,81 @@ +person; + } + + /** + * @return Address + */ + public function getAddress(): Address + { + return $this->address; + } + + /** + * This date is the intersection of household membership + * and address validity + * + * @return \DateTimeImmutable + */ + public function getValidFrom(): \DateTimeImmutable + { + return $this->validFrom; + } + + /** + * This date is the intersection of household membership + * and address validity + * + * @return \DateTimeImmutable|null + */ + public function getValidTo(): ?\DateTimeImmutable + { + return $this->validTo; + } +} diff --git a/src/Bundle/ChillPersonBundle/migrations/Version20210915093624.php b/src/Bundle/ChillPersonBundle/migrations/Version20210915093624.php new file mode 100644 index 000000000..f285fde47 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/migrations/Version20210915093624.php @@ -0,0 +1,49 @@ +addSql("CREATE VIEW view_chill_person_current_address AS + SELECT + cphm.person_id AS person_id, + cma.id AS address_id, + CASE WHEN cphm.startdate > COALESCE(cma.validfrom, '-infinity'::date) THEN cphm.startdate ELSE cma.validfrom END AS valid_from, + CASE WHEN COALESCE(cphm.enddate, 'infinity'::date) < COALESCE(cma.validto, 'infinity'::date) THEN cphm.enddate ELSE cma.validto END AS valid_to + FROM chill_person_household_members AS cphm + LEFT JOIN chill_person_household_to_addresses AS cphta ON cphta.household_id = cphm.household_id + LEFT JOIN chill_main_address AS cma ON cphta.address_id = cma.id + WHERE + cphm.sharedhousehold IS TRUE + AND + current_date between cphm.startdate AND coalesce(enddate, 'infinity'::date) + AND + current_date between cma.validfrom AND coalesce(validto, 'infinity'::date) + "); + + $this->addSql("CREATE INDEX chill_custom_main_address_filtering_idx ON chill_main_address USING btree (id, validfrom ASC, validto DESC)"); + $this->addSql("CREATE INDEX chill_custom_person_household_members_sharing_idx ON chill_person_household_members USING btree (person_id, startdate ASC, enddate DESC, household_id) WHERE sharedhousehold IS TRUE"); + } + + public function down(Schema $schema): void + { + $this->addSql("DROP VIEW view_chill_person_current_address"); + $this->addSql("DROP INDEX chill_custom_main_address_filtering_idx"); + $this->addSql("DROP INDEX chill_custom_person_household_members_sharing_idx"); + } +} From ebb2f5d243eb732fae309f8763232538787fe30f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Thu, 16 Sep 2021 16:43:38 +0200 Subject: [PATCH 19/37] Add shortcut person <-> current address, and update api for re-implements searching * add geographic function ST_CONTAINS * add a link between the current valid address and person, optimized on database side; * update PersonACLAwareRepository for re-using methods elsewhere. --- .../ChillMainExtension.php | 4 +- .../Doctrine/DQL/STContains.php | 52 +++++++++ .../ChillPersonBundle/Entity/Person.php | 1 + .../Entity/Person/PersonCurrentAddress.php | 3 +- .../Repository/PersonACLAwareRepository.php | 103 +++++++++++------- 5 files changed, 122 insertions(+), 41 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Doctrine/DQL/STContains.php diff --git a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php index 77da7b435..a25bee94a 100644 --- a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php +++ b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php @@ -19,6 +19,7 @@ namespace Chill\MainBundle\DependencyInjection; +use Chill\MainBundle\Doctrine\DQL\STContains; use Chill\MainBundle\Doctrine\DQL\StrictWordSimilarityOPS; use Chill\MainBundle\Entity\UserJob; use Chill\MainBundle\Form\UserJobType; @@ -186,7 +187,8 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface, 'JSONB_EXISTS_IN_ARRAY' => JsonbExistsInArray::class, 'SIMILARITY' => Similarity::class, 'OVERLAPSI' => OverlapsI::class, - 'STRICT_WORD_SIMILARITY_OPS' => StrictWordSimilarityOPS::class + 'STRICT_WORD_SIMILARITY_OPS' => StrictWordSimilarityOPS::class, + 'ST_CONTAINS' => STContains::class, ], ], 'hydrators' => [ diff --git a/src/Bundle/ChillMainBundle/Doctrine/DQL/STContains.php b/src/Bundle/ChillMainBundle/Doctrine/DQL/STContains.php new file mode 100644 index 000000000..5235d51bb --- /dev/null +++ b/src/Bundle/ChillMainBundle/Doctrine/DQL/STContains.php @@ -0,0 +1,52 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +namespace Chill\MainBundle\Doctrine\DQL; + +use Doctrine\ORM\Query\AST\Functions\FunctionNode; +use Doctrine\ORM\Query\Lexer; + +/** + * Geometry function 'ST_CONTAINS', added by postgis + */ +class STContains extends FunctionNode +{ + private $firstPart; + + private $secondPart; + + public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker) + { + return 'ST_CONTAINS('.$this->firstPart->dispatch($sqlWalker). + ', ' . $this->secondPart->dispatch($sqlWalker) .")"; + } + + public function parse(\Doctrine\ORM\Query\Parser $parser) + { + $parser->match(Lexer::T_IDENTIFIER); + $parser->match(Lexer::T_OPEN_PARENTHESIS); + + $this->firstPart = $parser->StringPrimary(); + + $parser->match(Lexer::T_COMMA); + + $this->secondPart = $parser->StringPrimary(); + + $parser->match(Lexer::T_CLOSE_PARENTHESIS); + } +} diff --git a/src/Bundle/ChillPersonBundle/Entity/Person.php b/src/Bundle/ChillPersonBundle/Entity/Person.php index bc5c46e08..2b0b5edbd 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person.php @@ -419,6 +419,7 @@ class Person implements HasCenterInterface, TrackCreationInterface, TrackUpdateI * This is computed through database and is optimized on database side. * * @var PersonCurrentAddress|null + * @ORM\OneToOne(targetEntity=PersonCurrentAddress::class, mappedBy="person") */ private ?PersonCurrentAddress $currentPersonAddress = null; diff --git a/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php b/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php index 21962b700..e982f8b97 100644 --- a/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php +++ b/src/Bundle/ChillPersonBundle/Entity/Person/PersonCurrentAddress.php @@ -22,7 +22,8 @@ class PersonCurrentAddress { /** * @ORM\Id - * @ORM\OneToOne(targetEntity=Person::class) + * @ORM\OneToOne(targetEntity=Person::class, inversedBy="currentPersonAddress") + * @ORM\JoinColumn(name="person_id", referencedColumnName="id") */ protected Person $person; diff --git a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php index 40d06615c..5214b38b7 100644 --- a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php @@ -60,17 +60,32 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $countryCode); $this->addACLClauses($qb, 'p'); + return $this->getQueryResult($qb, $simplify, $limit, $start); + } + + /** + * Helper method to prepare and return the search query for PersonACL. + * + * This method replace the select clause with required parameters, depending on the + * "simplify" parameter. It also add query limits. + * + * The given alias must represent the person alias. + * + * @return array|Person[] + */ + public function getQueryResult(QueryBuilder $qb, string $alias, bool $simplify, int $limit, int $start): array + { if ($simplify) { $qb->select( - 'p.id', + $alias.'.id', $qb->expr()->concat( - 'p.firstName', + $alias.'.firstName', $qb->expr()->literal(' '), - 'p.lastName' + $alias.'.lastName' ).'AS text' ); } else { - $qb->select('p'); + $qb->select($alias); } $qb @@ -79,8 +94,8 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac //order by firstname, lastname $qb - ->orderBy('p.firstName') - ->addOrderBy('p.lastName'); + ->orderBy($alias.'.firstName') + ->addOrderBy($alias.'.lastName'); if ($simplify) { return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); @@ -104,7 +119,20 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $countryCode); $this->addACLClauses($qb, 'p'); - $qb->select('COUNT(p.id)'); + return $this->getCountQueryResult($qb); + } + + /** + * Helper method to prepare and return the count for search query + * + * This method replace the select clause with required parameters, depending on the + * "simplify" parameter. + * + * The given alias must represent the person alias in the query builder. + */ + public function getCountQueryResult(QueryBuilder $qb, $alias): int + { + $qb->select('COUNT('.$alias.'.id)'); return $qb->getQuery()->getSingleScalarResult(); } @@ -115,33 +143,7 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $qb = $this->createSimilarityQuery($pattern); $this->addACLClauses($qb, 'sp'); - if ($simplify) { - $qb->select( - 'sp.id', - $qb->expr()->concat( - 'sp.firstName', - $qb->expr()->literal(' '), - 'sp.lastName' - ).'AS text' - ); - } else { - $qb->select('sp'); - } - - $qb - ->setMaxResults($maxResult) - ->setFirstResult($firstResult); - - //order by firstname, lastname - $qb - ->orderBy('sp.firstName') - ->addOrderBy('sp.lastName'); - - if ($simplify) { - return $qb->getQuery()->getResult(Query::HYDRATE_ARRAY); - } else { - return $qb->getQuery()->getResult(); - } + return $this->getQueryResult($qb, 'sp', $simplify, $maxResult, $firstResult); } public function countBySimilaritySearch(string $pattern) @@ -149,12 +151,27 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $qb = $this->createSimilarityQuery($pattern); $this->addACLClauses($qb, 'sp'); - $qb->select('COUNT(sp.id)'); - - return $qb->getQuery()->getSingleScalarResult(); + return $this->getCountQueryResult($qb, 'sp'); } - private function createSearchQuery( + /** + * Create a search query without ACL + * + * The person alias is a "p" + * + * @param string|null $default + * @param string|null $firstname + * @param string|null $lastname + * @param \DateTime|null $birthdate + * @param \DateTime|null $birthdateBefore + * @param \DateTime|null $birthdateAfter + * @param string|null $gender + * @param string|null $countryCode + * @return QueryBuilder + * @throws NonUniqueResultException + * @throws ParsingException + */ + public function createSearchQuery( string $default = null, string $firstname = null, string $lastname = null, @@ -244,7 +261,15 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $qb->setParameter('centers', $reachableCenters); } - private function createSimilarityQuery($pattern): QueryBuilder + /** + * Create a query for searching by similarity. + * + * The person alias is "sp". + * + * @param $pattern + * @return QueryBuilder + */ + public function createSimilarityQuery($pattern): QueryBuilder { $qb = $this->em->createQueryBuilder(); From cf40f3846352c59e14cb7fa12a246acfb70ead1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 17 Sep 2021 10:08:33 +0200 Subject: [PATCH 20/37] rename voter helepers --- ...efaultVoter.php => DefaultVoterHelper.php} | 11 +---- ...tory.php => DefaultVoterHelperFactory.php} | 4 +- ...or.php => DefaultVoterHelperGenerator.php} | 6 +-- .../Authorization/VoterFactoryInterface.php | 7 --- .../Authorization/VoterGeneratorInterface.php | 8 ++++ .../VoterHelperFactoryInterface.php | 8 ++++ .../Authorization/VoterHelperInterface.php | 12 +++++ .../Security/Authorization/VoterInterface.php | 7 --- .../Security/Authorization/PersonVoter.php | 48 ++++++------------- .../Security/Authorization/TaskVoter.php | 8 ++-- 10 files changed, 54 insertions(+), 65 deletions(-) rename src/Bundle/ChillMainBundle/Security/Authorization/{DefaultVoter.php => DefaultVoterHelper.php} (83%) rename src/Bundle/ChillMainBundle/Security/Authorization/{DefaultVoterFactory.php => DefaultVoterHelperFactory.php} (85%) rename src/Bundle/ChillMainBundle/Security/Authorization/{VoterGenerator.php => DefaultVoterHelperGenerator.php} (84%) delete mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterHelperFactoryInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterHelperInterface.php delete mode 100644 src/Bundle/ChillMainBundle/Security/Authorization/VoterInterface.php diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php similarity index 83% rename from src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php rename to src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php index 98882b876..bd1e0e1cb 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoter.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php @@ -5,7 +5,7 @@ namespace Chill\MainBundle\Security\Authorization; use Chill\MainBundle\Entity\User; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; -class DefaultVoter implements VoterInterface +class DefaultVoterHelper implements VoterHelperInterface { protected AuthorizationHelper $authorizationHelper; @@ -50,14 +50,7 @@ class DefaultVoter implements VoterInterface } if (NULL === $subject) { - if (NULL === $center = $this->centerResolverDispatcher - ->resolveCenter($subject)) { - return false; - } - return $this->authorizationHelper->userCanReachCenter( - $token->getUser(), - $center - ); + return 0 < count($this->authorizationHelper->getReachableCenters($token->getUser(), $attribute, null)); } return $this->authorizationHelper->userHasAccess( diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperFactory.php similarity index 85% rename from src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php rename to src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperFactory.php index 4f3f232d9..9349eaed2 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterFactory.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperFactory.php @@ -4,7 +4,7 @@ namespace Chill\MainBundle\Security\Authorization; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; -class DefaultVoterFactory implements VoterFactoryInterface +class DefaultVoterHelperFactory implements VoterHelperFactoryInterface { protected AuthorizationHelper $authorizationHelper; protected CenterResolverDispatcher $centerResolverDispatcher; @@ -19,7 +19,7 @@ class DefaultVoterFactory implements VoterFactoryInterface public function generate($context): VoterGeneratorInterface { - return new VoterGenerator( + return new DefaultVoterHelperGenerator( $this->authorizationHelper, $this->centerResolverDispatcher ); diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/VoterGenerator.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php similarity index 84% rename from src/Bundle/ChillMainBundle/Security/Authorization/VoterGenerator.php rename to src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php index e3b517f99..753586270 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/VoterGenerator.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php @@ -4,7 +4,7 @@ namespace Chill\MainBundle\Security\Authorization; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; -final class VoterGenerator implements VoterGeneratorInterface +final class DefaultVoterHelperGenerator implements VoterGeneratorInterface { protected AuthorizationHelper $authorizationHelper; protected CenterResolverDispatcher $centerResolverDispatcher; @@ -25,9 +25,9 @@ final class VoterGenerator implements VoterGeneratorInterface return $this; } - public function build(): VoterInterface + public function build(): VoterHelperInterface { - return new DefaultVoter( + return new DefaultVoterHelper( $this->authorizationHelper, $this->centerResolverDispatcher, $this->configuration diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php b/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php deleted file mode 100644 index b12739674..000000000 --- a/src/Bundle/ChillMainBundle/Security/Authorization/VoterFactoryInterface.php +++ /dev/null @@ -1,7 +0,0 @@ -helper = $helper; $this->centerResolverDispatcher = $centerResolverDispatcher; + $this->voter = $voterFactory + ->generate(self::class) + ->addCheckFor(Center::class, [self::STATS, self::LISTS, self::DUPLICATE]) + ->addCheckFor(Person::class, [self::CREATE, self::UPDATE, self::SEE, self::DUPLICATE]) + ->addCheckFor(null, [self::CREATE] ) + ->build() + ; } protected function supports($attribute, $subject) { - if ($subject instanceof Person) { - return \in_array($attribute, [ - self::CREATE, self::UPDATE, self::SEE, self::DUPLICATE - ]); - } elseif ($subject instanceof Center) { - return \in_array($attribute, [ - self::STATS, self::LISTS, self::DUPLICATE - ]); - } elseif ($subject === null) { - return $attribute === self::CREATE; - } else { - return false; - } + return $this->voter->supports($attribute, $subject); } protected function voteOnAttribute($attribute, $subject, TokenInterface $token) { - if (!$token->getUser() instanceof User) { - return false; - } - - if ($subject === null) { - $centers = $this->helper->getReachableCenters($token->getUser(), - new Role($attribute)); - - return count($centers) > 0; - } - - $center = $this->centerResolverDispatcher->resolveCenter($subject); - - if (NULL === $center && $subject instanceof Person) { - // person without any center are seen by everybody - return true; - } - - return $this->helper->userHasAccess($token->getUser(), $subject, $attribute); + return $this->voter->voteOnAttribute($attribute, $subject, $token); } private function getAttributes() diff --git a/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php b/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php index 7c4f2d4d9..2f760a84b 100644 --- a/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php +++ b/src/Bundle/ChillTaskBundle/Security/Authorization/TaskVoter.php @@ -21,8 +21,8 @@ namespace Chill\TaskBundle\Security\Authorization; use Chill\EventBundle\Entity\Event; use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Security\Authorization\AbstractChillVoter; -use Chill\MainBundle\Security\Authorization\VoterFactoryInterface; -use Chill\MainBundle\Security\Authorization\VoterInterface; +use Chill\MainBundle\Security\Authorization\VoterHelperFactoryInterface; +use Chill\MainBundle\Security\Authorization\VoterHelperInterface; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; use Chill\TaskBundle\Entity\AbstractTask; use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface; @@ -61,7 +61,7 @@ final class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchy protected CenterResolverDispatcher $centerResolverDispatcher; - protected VoterInterface $voter; + protected VoterHelperInterface $voter; public function __construct( AccessDecisionManagerInterface $accessDecisionManager, @@ -69,7 +69,7 @@ final class TaskVoter extends AbstractChillVoter implements ProvideRoleHierarchy EventDispatcherInterface $eventDispatcher, LoggerInterface $logger, CenterResolverDispatcher $centerResolverDispatcher, - VoterFactoryInterface $voterFactory + VoterHelperFactoryInterface $voterFactory ) { $this->accessDecisionManager = $accessDecisionManager; $this->authorizationHelper = $authorizationHelper; From 74598ee926bd7cf653693b46c8bc74c8fd37016f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 17 Sep 2021 13:57:45 +0200 Subject: [PATCH 21/37] apply new role on accompanying period --- .../Form/Type/ScopePickerType.php | 9 +- .../Authorization/AuthorizationHelper.php | 23 +-- .../Authorization/DefaultVoterHelper.php | 2 +- .../DefaultVoterHelperGenerator.php | 2 +- .../Authorization/VoterGeneratorInterface.php | 2 +- .../Authorization/AuthorizationHelperTest.php | 157 +++++++++--------- .../config/services/security.yaml | 4 +- .../AccompanyingCourseController.php | 8 +- .../AccompanyingPeriodController.php | 31 ++-- .../ChillPersonExtension.php | 29 +++- .../Menu/PersonMenuBuilder.php | 27 ++- .../AccompanyingPeriodACLAwareRepository.php | 58 +++++++ .../AccompanyingPeriodRepository.php | 5 + .../Repository/PersonACLAwareRepository.php | 4 +- .../Authorization/AccompanyingPeriodVoter.php | 88 ++++++---- .../Security/Authorization/PersonVoter.php | 8 - .../config/services/controller.yaml | 5 +- .../config/services/menu.yaml | 11 +- .../config/services/security.yaml | 3 +- 19 files changed, 281 insertions(+), 195 deletions(-) create mode 100644 src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php diff --git a/src/Bundle/ChillMainBundle/Form/Type/ScopePickerType.php b/src/Bundle/ChillMainBundle/Form/Type/ScopePickerType.php index 832db628f..ebf474657 100644 --- a/src/Bundle/ChillMainBundle/Form/Type/ScopePickerType.php +++ b/src/Bundle/ChillMainBundle/Form/Type/ScopePickerType.php @@ -146,14 +146,7 @@ class ScopePickerType extends AbstractType ->setParameter('center', $center->getId()) // role constraints ->andWhere($qb->expr()->in('rs.role', ':roles')) - ->setParameter( - 'roles', \array_map( - function (Role $role) { - return $role->getRole(); - }, - $roles - ) - ) + ->setParameter('roles', $roles) // user contraint ->andWhere(':user MEMBER OF gc.users') ->setParameter('user', $this->tokenStorage->getToken()->getUser()); diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php index ab1d1aed1..d7507f7a0 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php @@ -269,16 +269,12 @@ class AuthorizationHelper /** * - * @param Role $role - * @param Center $center - * @param Scope $circle - * @return Users + * @return User[] */ - public function findUsersReaching(Role $role, Center $center, Scope $circle = null) + public function findUsersReaching(string $role, Center $center, Scope $circle = null): array { $parents = $this->getParentRoles($role); $parents[] = $role; - $parentRolesString = \array_map(function(Role $r) { return $r->getRole(); }, $parents); $qb = $this->em->createQueryBuilder(); $qb @@ -288,7 +284,7 @@ class AuthorizationHelper ->join('gc.permissionsGroup', 'pg') ->join('pg.roleScopes', 'rs') ->where('gc.center = :center') - ->andWhere($qb->expr()->in('rs.role', $parentRolesString)) + ->andWhere($qb->expr()->in('rs.role', $parents)) ; $qb->setParameter('center', $center); @@ -322,21 +318,16 @@ class AuthorizationHelper * which are registered into Chill are taken into account. * * @param Role $role - * @return Role[] the role which give access to the given $role + * @return string[] the role which give access to the given $role */ - public function getParentRoles(Role $role) + public function getParentRoles($role): array { $parentRoles = []; // transform the roles from role hierarchy from string to Role - $roles = \array_map( - function($string) { - return new Role($string); - }, - \array_keys($this->hierarchy) - ); + $roles = \array_keys($this->hierarchy); foreach ($roles as $r) { - $childRoles = $this->roleHierarchy->getReachableRoleNames([$r->getRole()]); + $childRoles = $this->roleHierarchy->getReachableRoleNames([$r]); if (\in_array($role, $childRoles)) { $parentRoles[] = $r; diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php index bd1e0e1cb..ef1d319ac 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelper.php @@ -5,7 +5,7 @@ namespace Chill\MainBundle\Security\Authorization; use Chill\MainBundle\Entity\User; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; -class DefaultVoterHelper implements VoterHelperInterface +final class DefaultVoterHelper implements VoterHelperInterface { protected AuthorizationHelper $authorizationHelper; diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php index 753586270..c8300e45a 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/DefaultVoterHelperGenerator.php @@ -18,7 +18,7 @@ final class DefaultVoterHelperGenerator implements VoterGeneratorInterface $this->centerResolverDispatcher = $centerResolverDispatcher; } - public function addCheckFor($subject, $attributes): self + public function addCheckFor(?string $subject, array $attributes): self { $this->configuration[] = [$attributes, $subject]; diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php b/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php index 306427238..70e517536 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/VoterGeneratorInterface.php @@ -9,7 +9,7 @@ interface VoterGeneratorInterface * @param array $attributes an array of attributes * @return $this */ - public function addCheckFor(string $class, array $attributes): self; + public function addCheckFor(?string $class, array $attributes): self; public function build(): VoterHelperInterface; } diff --git a/src/Bundle/ChillMainBundle/Tests/Security/Authorization/AuthorizationHelperTest.php b/src/Bundle/ChillMainBundle/Tests/Security/Authorization/AuthorizationHelperTest.php index fbd3cd4d1..ae167adb5 100644 --- a/src/Bundle/ChillMainBundle/Tests/Security/Authorization/AuthorizationHelperTest.php +++ b/src/Bundle/ChillMainBundle/Tests/Security/Authorization/AuthorizationHelperTest.php @@ -30,22 +30,22 @@ use Chill\MainBundle\Entity\Scope; use Chill\MainBundle\Entity\Center; /** - * + * * * @author Julien Fastré */ class AuthorizationHelperTest extends KernelTestCase { - + use PrepareUserTrait, PrepareCenterTrait, PrepareScopeTrait, ProphecyTrait; - - public function setUp() + + public function setUp() { static::bootKernel(); } - + /** - * + * * @return \Chill\MainBundle\Security\Authorization\AuthorizationHelper */ private function getAuthorizationHelper() @@ -54,13 +54,13 @@ class AuthorizationHelperTest extends KernelTestCase ->get('chill.main.security.authorization.helper') ; } - + /** * Test function userCanReach of helper. - * + * * A user can reach center => the function should return true. */ - public function testUserCanReachCenter_UserShouldReach() + public function testUserCanReachCenter_UserShouldReach() { $center = $this->prepareCenter(1, 'center'); $scope = $this->prepareScope(1, 'default'); @@ -72,16 +72,16 @@ class AuthorizationHelperTest extends KernelTestCase ) )); $helper = $this->getAuthorizationHelper(); - + $this->assertTrue($helper->userCanReachCenter($user, $center)); } - + /** * Test function userCanReach of helper - * + * * A user can not reachcenter =>W the function should return false */ - public function testUserCanReachCenter_UserShouldNotReach() + public function testUserCanReachCenter_UserShouldNotReach() { $centerA = $this->prepareCenter(1, 'center'); $centerB = $this->prepareCenter(2, 'centerB'); @@ -94,11 +94,11 @@ class AuthorizationHelperTest extends KernelTestCase ) )); $helper = $this->getAuthorizationHelper(); - + $this->assertFalse($helper->userCanReachCenter($user, $centerB)); - + } - + public function testUserHasAccess_shouldHaveAccess_EntityWithoutScope() { $center = $this->prepareCenter(1, 'center'); @@ -114,11 +114,11 @@ class AuthorizationHelperTest extends KernelTestCase $entity = $this->getProphet()->prophesize(); $entity->willImplement('\Chill\MainBundle\Entity\HasCenterInterface'); $entity->getCenter()->willReturn($center); - - $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), + + $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + public function testUserHasAccess_ShouldHaveAccessWithInheritance_EntityWithoutScope() { $center = $this->prepareCenter(1, 'center'); @@ -130,17 +130,17 @@ class AuthorizationHelperTest extends KernelTestCase ) ) )); - + $helper = $this->getAuthorizationHelper(); $entity = $this->getProphet()->prophesize(); $entity->willImplement('\Chill\MainBundle\Entity\HasCenterInterface'); $entity->getCenter()->willReturn($center); - - $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), + + $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), 'CHILL_INHERITED_ROLE_1')); } - - + + public function testuserHasAccess_UserHasNoRole_EntityWithoutScope() { $center = $this->prepareCenter(1, 'center'); @@ -156,10 +156,10 @@ class AuthorizationHelperTest extends KernelTestCase $entity = $this->getProphet()->prophesize(); $entity->willImplement('\Chill\MainBundle\Entity\HasCenterInterface'); $entity->getCenter()->willReturn($center); - + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + /** * test that a user has no access on a entity, but is granted on the same role * on another center @@ -186,10 +186,10 @@ class AuthorizationHelperTest extends KernelTestCase $entity = $this->getProphet()->prophesize(); $entity->willImplement('\Chill\MainBundle\Entity\HasCenterInterface'); $entity->getCenter()->willReturn($centerA); - + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + public function testtestUserHasAccess_UserShouldHaveAccess_EntityWithScope() { $center = $this->prepareCenter(1, 'center'); @@ -207,10 +207,10 @@ class AuthorizationHelperTest extends KernelTestCase $entity->willImplement('\Chill\MainBundle\Entity\HasScopeInterface'); $entity->getCenter()->willReturn($center); $entity->getScope()->willReturn($scope); - + $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + public function testUserHasAccess_UserHasNoRole_EntityWithScope() { $center = $this->prepareCenter(1, 'center'); @@ -228,10 +228,10 @@ class AuthorizationHelperTest extends KernelTestCase $entity->willImplement('\Chill\MainBundle\Entity\HasScopeInterface'); $entity->getCenter()->willReturn($center); $entity->getScope()->willReturn($scope); - + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'ANOTHER_ROLE')); } - + public function testUserHasAccess_UserHasNoCenter_EntityWithScope() { $centerA = $this->prepareCenter(1, 'center'); //the user will have this center @@ -250,10 +250,10 @@ class AuthorizationHelperTest extends KernelTestCase $entity->willImplement('\Chill\MainBundle\Entity\HasScopeInterface'); $entity->getCenter()->willReturn($centerB); $entity->getScope()->willReturn($scope); - + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + public function testUserHasAccess_UserHasNoScope_EntityWithScope() { $center = $this->prepareCenter(1, 'center'); @@ -272,12 +272,12 @@ class AuthorizationHelperTest extends KernelTestCase $entity->willImplement('\Chill\MainBundle\Entity\HasScopeInterface'); $entity->getCenter()->willReturn($center); $entity->getScope()->willReturn($scopeA); - + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } - + /** - * + * * @dataProvider dataProvider_getReachableCenters * @param Center $shouldHaveCenter * @param User $user @@ -288,7 +288,7 @@ class AuthorizationHelperTest extends KernelTestCase { $this->assertEquals($test, $result, $msg); } - + public function dataProvider_getReachableCenters() { $this->setUp(); @@ -297,10 +297,10 @@ class AuthorizationHelperTest extends KernelTestCase $scopeA = $this->prepareScope(1, 'scope default'); $scopeB = $this->prepareScope(2, 'scope B'); $scopeC = $this->prepareScope(3, 'scope C'); - + $userA = $this->prepareUser(array( array( - 'center' => $centerA, + 'center' => $centerA, 'permissionsGroup' => array( ['scope' => $scopeB, 'role' => 'CHILL_ROLE_1'], ['scope' => $scopeA, 'role' => 'CHILL_ROLE_2'] @@ -313,62 +313,62 @@ class AuthorizationHelperTest extends KernelTestCase ['scope' => $scopeC, 'role' => 'CHILL_ROLE_2'] ) ) - + )); - + $ah = $this->getAuthorizationHelper(); - + return array( // without scopes array( - true, - in_array($centerA, $ah->getReachableCenters($userA, + true, + in_array($centerA, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_1'), null)), 'center A should be available for userA, with role 1 ' ), array( - true, - in_array($centerA, $ah->getReachableCenters($userA, + true, + in_array($centerA, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_2'), null)), 'center A should be available for userA, with role 2 ' ), array( - true, - in_array($centerB, $ah->getReachableCenters($userA, + true, + in_array($centerB, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_2'), null)), 'center A should be available for userA, with role 2 ' ), array( - false, + false, in_array($centerB, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_1'), null)), 'center B should NOT be available for userA, with role 1 ' ), // with scope array( - true, - in_array($centerA, $ah->getReachableCenters($userA, + true, + in_array($centerA, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_1'), $scopeB)), 'center A should be available for userA, with role 1, scopeC ' ), array( - false, - in_array($centerA, $ah->getReachableCenters($userA, + false, + in_array($centerA, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_2'), $scopeC)), 'center A should NOT be available for userA, with role 2, scopeA ' ), array( - true, - in_array($centerB, $ah->getReachableCenters($userA, + true, + in_array($centerB, $ah->getReachableCenters($userA, new Role('CHILL_ROLE_2'), $scopeA)), 'center B should be available for userA, with role 2, scopeA ' ), ); - + } - + /** - * + * * @dataProvider dataProvider_getReachableScopes * @param boolean $expectedResult * @param Scope $testedScope @@ -382,11 +382,11 @@ class AuthorizationHelperTest extends KernelTestCase { $reachableScopes = $this->getAuthorizationHelper() ->getReachableScopes($user, $role, $center); - + $this->assertEquals($expectedResult, in_array($testedScope, $reachableScopes), $message); } - + public function dataProvider_getReachableScopes() { $centerA = $this->prepareCenter(1, 'center A'); @@ -394,10 +394,10 @@ class AuthorizationHelperTest extends KernelTestCase $scopeA = $this->prepareScope(1, 'scope default'); $scopeB = $this->prepareScope(2, 'scope B'); $scopeC = $this->prepareScope(3, 'scope C'); - + $userA = $this->prepareUser(array( array( - 'center' => $centerA, + 'center' => $centerA, 'permissionsGroup' => array( ['scope' => $scopeB, 'role' => 'CHILL_ROLE_1'], ['scope' => $scopeA, 'role' => 'CHILL_ROLE_2'] @@ -411,9 +411,9 @@ class AuthorizationHelperTest extends KernelTestCase ['scope' => $scopeB, 'role' => 'CHILL_ROLE_2'] ) ) - + )); - + return array( array( true, @@ -442,37 +442,30 @@ class AuthorizationHelperTest extends KernelTestCase ) ); } - + public function testGetParentRoles() { $parentRoles = $this->getAuthorizationHelper() - ->getParentRoles(new Role('CHILL_INHERITED_ROLE_1')); - - $this->assertContains( - 'CHILL_MASTER_ROLE', - \array_map( - function(Role $role) { - return $role->getRole(); - }, - $parentRoles - ), + ->getParentRoles('CHILL_INHERITED_ROLE_1'); + + $this->assertContains('CHILL_MASTER_ROLE', $parentRoles, "Assert that `CHILL_MASTER_ROLE` is a parent of `CHILL_INHERITED_ROLE_1`"); } - + public function testFindUsersReaching() { $centerA = static::$kernel->getContainer() ->get('doctrine.orm.entity_manager') ->getRepository(Center::class) ->findOneByName('Center A'); - + $users = $this->getAuthorizationHelper() - ->findUsersReaching(new Role('CHILL_PERSON_SEE'), + ->findUsersReaching(new Role('CHILL_PERSON_SEE'), $centerA); - + $usernames = \array_map(function(User $u) { return $u->getUsername(); }, $users); - + $this->assertContains('center a_social', $usernames); } - + } diff --git a/src/Bundle/ChillMainBundle/config/services/security.yaml b/src/Bundle/ChillMainBundle/config/services/security.yaml index 7590acb5f..c9703dbfe 100644 --- a/src/Bundle/ChillMainBundle/config/services/security.yaml +++ b/src/Bundle/ChillMainBundle/config/services/security.yaml @@ -19,11 +19,11 @@ services: autowire: true # do not autowire the directory Security/Resolver - Chill\MainBundle\Security\Authorization\DefaultVoterFactory: + Chill\MainBundle\Security\Authorization\DefaultVoterHelperFactory: autowire: true # do not autowire the directory Security/Resolver - Chill\MainBundle\Security\Authorization\VoterFactoryInterface: '@Chill\MainBundle\Security\Authorization\DefaultVoterFactory' + Chill\MainBundle\Security\Authorization\VoterHelperFactoryInterface: '@Chill\MainBundle\Security\Authorization\DefaultVoterHelperFactory' chill.main.security.authorization.helper: class: Chill\MainBundle\Security\Authorization\AuthorizationHelper diff --git a/src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseController.php b/src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseController.php index 2f086c9f5..1bf40d146 100644 --- a/src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseController.php +++ b/src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseController.php @@ -73,7 +73,7 @@ class AccompanyingCourseController extends Controller } } - $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::SEE, $period); + $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::CREATE, $period); $em->persist($period); $em->flush(); @@ -92,6 +92,8 @@ class AccompanyingCourseController extends Controller */ public function indexAction(AccompanyingPeriod $accompanyingCourse): Response { + $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::SEE, $accompanyingCourse); + // compute some warnings // get persons without household $withoutHousehold = []; @@ -131,6 +133,8 @@ class AccompanyingCourseController extends Controller */ public function editAction(AccompanyingPeriod $accompanyingCourse): Response { + $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::SEE, $accompanyingCourse); + return $this->render('@ChillPerson/AccompanyingCourse/edit.html.twig', [ 'accompanyingCourse' => $accompanyingCourse ]); @@ -146,6 +150,8 @@ class AccompanyingCourseController extends Controller */ public function historyAction(AccompanyingPeriod $accompanyingCourse): Response { + $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::SEE, $accompanyingCourse); + return $this->render('@ChillPerson/AccompanyingCourse/history.html.twig', [ 'accompanyingCourse' => $accompanyingCourse ]); diff --git a/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php b/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php index f31dfa585..9cba2ec1d 100644 --- a/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php +++ b/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php @@ -23,7 +23,10 @@ namespace Chill\PersonBundle\Controller; use Chill\PersonBundle\Privacy\PrivacyEvent; +use Chill\PersonBundle\Repository\AccompanyingPeriodACLAwareRepository; +use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter; use Doctrine\DBAL\Exception; +use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Form\AccompanyingPeriodType; @@ -53,21 +56,24 @@ class AccompanyingPeriodController extends AbstractController */ protected $validator; - /** - * AccompanyingPeriodController constructor. - * - * @param EventDispatcherInterface $eventDispatcher - * @param ValidatorInterface $validator - */ - public function __construct(EventDispatcherInterface $eventDispatcher, ValidatorInterface $validator) - { + protected AccompanyingPeriodACLAwareRepository $accompanyingPeriodACLAwareRepository; + + public function __construct( + AccompanyingPeriodACLAwareRepository $accompanyingPeriodACLAwareRepository, + EventDispatcherInterface $eventDispatcher, + ValidatorInterface $validator + ) { + $this->accompanyingPeriodACLAwareRepository = $accompanyingPeriodACLAwareRepository; $this->eventDispatcher = $eventDispatcher; $this->validator = $validator; } - public function listAction(int $person_id): Response + /** + * @ParamConverter("person", options={"id"="person_id"}) + */ + public function listAction(Person $person): Response { - $person = $this->_getPerson($person_id); + $this->denyAccessUnlessGranted(AccompanyingPeriodVoter::SEE, $person); $event = new PrivacyEvent($person, [ 'element_class' => AccompanyingPeriod::class, @@ -75,9 +81,10 @@ class AccompanyingPeriodController extends AbstractController ]); $this->eventDispatcher->dispatch(PrivacyEvent::PERSON_PRIVACY_EVENT, $event); - $accompanyingPeriods = $person->getAccompanyingPeriodsOrdered(); + $accompanyingPeriods = $this->accompanyingPeriodACLAwareRepository + ->findByPerson($person, AccompanyingPeriodVoter::SEE); - return $this->render('ChillPersonBundle:AccompanyingPeriod:list.html.twig', [ + return $this->render('@ChillPerson/AccompanyingPeriod/list.html.twig', [ 'accompanying_periods' => $accompanyingPeriods, 'person' => $person ]); diff --git a/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php b/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php index 48ac993c3..485185ce7 100644 --- a/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php +++ b/src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php @@ -18,6 +18,7 @@ namespace Chill\PersonBundle\DependencyInjection; +use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\Config\FileLocator; use Symfony\Component\HttpKernel\DependencyInjection\Extension; @@ -258,14 +259,26 @@ class ChillPersonExtension extends Extension implements PrependExtensionInterfac */ protected function prependRoleHierarchy(ContainerBuilder $container) { - $container->prependExtensionConfig('security', array( - 'role_hierarchy' => array( - 'CHILL_PERSON_UPDATE' => array('CHILL_PERSON_SEE'), - 'CHILL_PERSON_CREATE' => array('CHILL_PERSON_SEE'), - PersonVoter::LISTS => [ ChillExportVoter::EXPORT ], - PersonVoter::STATS => [ ChillExportVoter::EXPORT ] - ) - )); + $container->prependExtensionConfig('security', [ + 'role_hierarchy' => [ + PersonVoter::UPDATE => [PersonVoter::SEE], + PersonVoter::CREATE => [PersonVoter::SEE], + PersonVoter::LISTS => [ChillExportVoter::EXPORT], + PersonVoter::STATS => [ChillExportVoter::EXPORT], + // accompanying period + AccompanyingPeriodVoter::SEE_DETAILS => [AccompanyingPeriodVoter::SEE], + AccompanyingPeriodVoter::CREATE => [AccompanyingPeriodVoter::SEE_DETAILS], + AccompanyingPeriodVoter::DELETE => [AccompanyingPeriodVoter::SEE_DETAILS], + AccompanyingPeriodVoter::EDIT => [AccompanyingPeriodVoter::SEE_DETAILS], + // give all ACL for FULL + AccompanyingPeriodVoter::FULL => [ + AccompanyingPeriodVoter::SEE_DETAILS, + AccompanyingPeriodVoter::CREATE, + AccompanyingPeriodVoter::EDIT, + AccompanyingPeriodVoter::DELETE + ] + ] + ]); } /** diff --git a/src/Bundle/ChillPersonBundle/Menu/PersonMenuBuilder.php b/src/Bundle/ChillPersonBundle/Menu/PersonMenuBuilder.php index fdb8feb3e..0c83d8a6a 100644 --- a/src/Bundle/ChillPersonBundle/Menu/PersonMenuBuilder.php +++ b/src/Bundle/ChillPersonBundle/Menu/PersonMenuBuilder.php @@ -18,14 +18,17 @@ namespace Chill\PersonBundle\Menu; use Chill\MainBundle\Routing\LocalMenuBuilderInterface; +use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter; use Knp\Menu\MenuItem; +use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface; +use Symfony\Component\Security\Core\Security; use Symfony\Contracts\Translation\TranslatorInterface; /** * Add menu entrie to person menu. - * + * * Menu entries added : - * + * * - person details ; * - accompanying period (if `visible`) * @@ -37,21 +40,25 @@ class PersonMenuBuilder implements LocalMenuBuilderInterface * @var string 'visible' or 'hidden' */ protected $showAccompanyingPeriod; - + /** * * @var TranslatorInterface */ protected $translator; - + + private Security $security; + public function __construct( - $showAccompanyingPeriod, + ParameterBagInterface $parameterBag, + Security $security, TranslatorInterface $translator ) { - $this->showAccompanyingPeriod = $showAccompanyingPeriod; + $this->showAccompanyingPeriod = $parameterBag->get('chill_person.accompanying_period'); + $this->security = $security; $this->translator = $translator; } - + public function buildMenu($menuId, MenuItem $menu, array $parameters) { $menu->addChild($this->translator->trans('Person details'), [ @@ -83,8 +90,10 @@ class PersonMenuBuilder implements LocalMenuBuilderInterface ->setExtras([ 'order' => 99999 ]); - - if ($this->showAccompanyingPeriod === 'visible') { + + if ($this->showAccompanyingPeriod === 'visible' + && $this->security->isGranted(AccompanyingPeriodVoter::SEE, $parameters['person']) + ) { $menu->addChild($this->translator->trans('Accompanying period list'), [ 'route' => 'chill_person_accompanying_period_list', 'routeParameters' => [ diff --git a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php new file mode 100644 index 000000000..cdc439e32 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php @@ -0,0 +1,58 @@ +accompanyingPeriodRepository = $accompanyingPeriodRepository; + $this->security = $security; + $this->authorizationHelper = $authorizationHelper; + $this->centerResolverDispatcher = $centerResolverDispatcher; + } + + public function findByPerson( + Person $person, + string $role, + ?array $orderBy = [], + int $limit = null, + int $offset = null + ): array { + dump(__METHOD__); + $qb = $this->accompanyingPeriodRepository->createQueryBuilder('ap'); + $scopes = $this->authorizationHelper + ->getReachableCircles($this->security->getUser(), $role, + $this->centerResolverDispatcher->resolveCenter($person)); + + if (0 === count($scopes)) { + return []; + } + + $qb + ->join('ap.participations', 'participation') + ->where($qb->expr()->eq('participation.person', ':person')) + ->setParameter('person', $person) + ; + // add join condition for scopes + $orx = $qb->expr()->orX(); + foreach ($scopes as $key => $scope) { + $orx->add($qb->expr()->in('ap.scopes', ':scope_'.$key)); + $qb->setParameter('scope_'.$key, $scope); + } + $qb->andWhere($orx); + + return $qb->getQuery()->getResult(); + } + +} diff --git a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodRepository.php b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodRepository.php index f9d1b060f..c9e8397a8 100644 --- a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodRepository.php @@ -59,6 +59,11 @@ final class AccompanyingPeriodRepository implements ObjectRepository return $this->findOneBy($criteria); } + public function createQueryBuilder(string $alias, ?string $indexBy = null): QueryBuilder + { + return $this->repository->createQueryBuilder($alias, $indexBy); + } + public function getClassName() { return AccompanyingPeriod::class; diff --git a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php index 5214b38b7..d15e8cd7a 100644 --- a/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/PersonACLAwareRepository.php @@ -60,7 +60,7 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $countryCode); $this->addACLClauses($qb, 'p'); - return $this->getQueryResult($qb, $simplify, $limit, $start); + return $this->getQueryResult($qb, 'p', $simplify, $limit, $start); } /** @@ -119,7 +119,7 @@ final class PersonACLAwareRepository implements PersonACLAwareRepositoryInterfac $countryCode); $this->addACLClauses($qb, 'p'); - return $this->getCountQueryResult($qb); + return $this->getCountQueryResult($qb,'p'); } /** diff --git a/src/Bundle/ChillPersonBundle/Security/Authorization/AccompanyingPeriodVoter.php b/src/Bundle/ChillPersonBundle/Security/Authorization/AccompanyingPeriodVoter.php index 2801cb8f7..5247df505 100644 --- a/src/Bundle/ChillPersonBundle/Security/Authorization/AccompanyingPeriodVoter.php +++ b/src/Bundle/ChillPersonBundle/Security/Authorization/AccompanyingPeriodVoter.php @@ -4,73 +4,101 @@ namespace Chill\PersonBundle\Security\Authorization; use Chill\MainBundle\Security\Authorization\AbstractChillVoter; use Chill\MainBundle\Entity\User; -use Chill\MainBundle\Security\Authorization\AuthorizationHelper; +use Chill\MainBundle\Security\Authorization\VoterHelperFactoryInterface; +use Chill\MainBundle\Security\Authorization\VoterHelperInterface; use Chill\MainBundle\Security\ProvideRoleHierarchyInterface; use Chill\PersonBundle\Entity\Person; use Chill\PersonBundle\Entity\AccompanyingPeriod; -use Chill\MainBundle\Entity\Center; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; -use Symfony\Component\Security\Core\Role\Role; +use Symfony\Component\Security\Core\Security; class AccompanyingPeriodVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterface { - protected AuthorizationHelper $helper; - public const SEE = 'CHILL_PERSON_ACCOMPANYING_PERIOD_SEE'; + /** + * details are for seeing: + * + * * SocialIssues + */ + public const SEE_DETAILS = 'CHILL_PERSON_ACCOMPANYING_PERIOD_SEE_DETAILS'; + public const CREATE = 'CHILL_PERSON_ACCOMPANYING_PERIOD_CREATE'; + public const EDIT = 'CHILL_PERSON_ACCOMPANYING_PERIOD_UPDATE'; + public const DELETE = 'CHILL_PERSON_ACCOMPANYING_PERIOD_DELETE'; /** - * @param AuthorizationHelper $helper + * Give all the right above */ - public function __construct(AuthorizationHelper $helper) - { - $this->helper = $helper; + public const FULL = 'CHILL_PERSON_ACCOMPANYING_PERIOD_FULL'; + + public const ALL = [ + self::SEE, + self::SEE_DETAILS, + self::CREATE, + self::EDIT, + self::DELETE, + self::FULL, + ]; + + private VoterHelperInterface $voterHelper; + + private Security $security; + + public function __construct( + Security $security, + VoterHelperFactoryInterface $voterHelperFactory + ) { + $this->security = $security; + $this->voterHelper = $voterHelperFactory + ->generate(self::class) + ->addCheckFor(null, [self::CREATE]) + ->addCheckFor(AccompanyingPeriod::class, self::ALL) + ->addCheckFor(Person::class, [self::SEE]) + ->build(); } protected function supports($attribute, $subject) { - return $subject instanceof AccompanyingPeriod; + return $this->voterHelper->supports($attribute, $subject); } - protected function voteOnAttribute($attribute, $subject, TokenInterface $token) + protected function voteOnAttribute($attribute, $subject, TokenInterface $token): bool { if (!$token->getUser() instanceof User) { return false; } - // TODO take scopes into account - if (count($subject->getPersons()) === 0) { - return true; - } - foreach ($subject->getPersons() as $person) { - // give access as soon as on center is reachable - if ($this->helper->userHasAccess($token->getUser(), $person->getCenter(), $attribute)) { - return true; + if ($subject instanceof AccompanyingPeriod) { + if (AccompanyingPeriod::STEP_DRAFT === $subject->getStep()) { + // only creator can see, edit, delete, etc. + if ($subject->getCreatedBy() === $token->getUser() + || NULL === $subject->getCreatedBy()) { + return true; + } + + return false; } - return false; + // if confidential, only the referent can see it + if ($subject->isConfidential()) { + return $token->getUser() === $subject->getUser(); + } } - } - private function getAttributes() - { - return [ - self::SEE - ]; + return $this->voterHelper->voteOnAttribute($attribute, $subject, $token); } public function getRoles() { - return $this->getAttributes(); + return self::ALL; } public function getRolesWithoutScope() { return []; } - + public function getRolesWithHierarchy() { - return [ 'Person' => $this->getRoles() ]; + return [ 'Accompanying period' => $this->getRoles() ]; } - } diff --git a/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php b/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php index 6338f5f45..2d585e80e 100644 --- a/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php +++ b/src/Bundle/ChillPersonBundle/Security/Authorization/PersonVoter.php @@ -40,19 +40,11 @@ class PersonVoter extends AbstractChillVoter implements ProvideRoleHierarchyInte const LISTS = 'CHILL_PERSON_LISTS'; const DUPLICATE = 'CHILL_PERSON_DUPLICATE'; - protected AuthorizationHelper $helper; - - protected CenterResolverDispatcher $centerResolverDispatcher; - protected VoterHelperInterface $voter; public function __construct( - AuthorizationHelper $helper, - CenterResolverDispatcher $centerResolverDispatcher, VoterHelperFactoryInterface $voterFactory ) { - $this->helper = $helper; - $this->centerResolverDispatcher = $centerResolverDispatcher; $this->voter = $voterFactory ->generate(self::class) ->addCheckFor(Center::class, [self::STATS, self::LISTS, self::DUPLICATE]) diff --git a/src/Bundle/ChillPersonBundle/config/services/controller.yaml b/src/Bundle/ChillPersonBundle/config/services/controller.yaml index 6efdb4640..489168425 100644 --- a/src/Bundle/ChillPersonBundle/config/services/controller.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/controller.yaml @@ -12,9 +12,8 @@ services: tags: ['controller.service_arguments'] Chill\PersonBundle\Controller\AccompanyingPeriodController: - arguments: - $eventDispatcher: '@Symfony\Component\EventDispatcher\EventDispatcherInterface' - $validator: '@Symfony\Component\Validator\Validator\ValidatorInterface' + autowire: true + autoconfigure: true tags: ['controller.service_arguments'] Chill\PersonBundle\Controller\PersonAddressController: diff --git a/src/Bundle/ChillPersonBundle/config/services/menu.yaml b/src/Bundle/ChillPersonBundle/config/services/menu.yaml index 344eb2a17..a9f566466 100644 --- a/src/Bundle/ChillPersonBundle/config/services/menu.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/menu.yaml @@ -19,14 +19,7 @@ services: # - { name: 'chill.menu_builder' } # Chill\PersonBundle\Menu\PersonMenuBuilder: - arguments: - $showAccompanyingPeriod: '%chill_person.accompanying_period%' - $translator: '@Symfony\Contracts\Translation\TranslatorInterface' + autowire: true + autoconfigure: true tags: - { name: 'chill.menu_builder' } - - # Chill\PersonBundle\Menu\AccompanyingCourseMenuBuilder: - # arguments: - # $translator: '@Symfony\Contracts\Translation\TranslatorInterface' - # tags: - # - { name: 'chill.menu_builder' } diff --git a/src/Bundle/ChillPersonBundle/config/services/security.yaml b/src/Bundle/ChillPersonBundle/config/services/security.yaml index 8504874a3..6dc3c92d3 100644 --- a/src/Bundle/ChillPersonBundle/config/services/security.yaml +++ b/src/Bundle/ChillPersonBundle/config/services/security.yaml @@ -7,8 +7,7 @@ services: - { name: chill.role } Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter: - arguments: - - "@chill.main.security.authorization.helper" + autowire: true tags: - { name: security.voter } - { name: chill.role } From b6c58a5c31f43edb3d739458dd957327400d8a7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Sun, 19 Sep 2021 20:56:20 +0200 Subject: [PATCH 22/37] Continue work on ACL rewritting * fix center resolver dispatcher * add scope resolver * tests for authorization helper --- .../ChillMainBundle/ChillMainBundle.php | 3 + .../Entity/HasCentersInterface.php | 8 ++ .../Entity/HasScopesInterface.php | 11 +++ .../Authorization/AuthorizationHelper.php | 71 +++++++++++--- .../Resolver/CenterResolverDispatcher.php | 2 - .../Resolver/DefaultCenterResolver.php | 11 ++- .../Resolver/DefaultScopeResolver.php | 42 ++++++++ .../Resolver/ScopeResolverDispatcher.php | 44 +++++++++ .../Resolver/ScopeResolverInterface.php | 30 ++++++ .../Authorization/AuthorizationHelperTest.php | 98 ++++++++++++++++++- .../Resolver/DefaultScopeResolverTest.php | 62 ++++++++++++ .../Resolver/ScopeResolverDispatcherTest.php | 60 ++++++++++++ .../config/services/security.yaml | 8 ++ .../AccompanyingPeriodController.php | 6 +- .../Entity/AccompanyingPeriod.php | 26 ++++- .../AccompanyingPeriodACLAwareRepository.php | 28 +++++- ...nyingPeriodACLAwareRepositoryInterface.php | 16 +++ .../config/services/repository.yaml | 1 + 18 files changed, 498 insertions(+), 29 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Entity/HasCentersInterface.php create mode 100644 src/Bundle/ChillMainBundle/Entity/HasScopesInterface.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/DefaultScopeResolver.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverDispatcher.php create mode 100644 src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php create mode 100644 src/Bundle/ChillMainBundle/Tests/Security/Resolver/DefaultScopeResolverTest.php create mode 100644 src/Bundle/ChillMainBundle/Tests/Security/Resolver/ScopeResolverDispatcherTest.php create mode 100644 src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepositoryInterface.php diff --git a/src/Bundle/ChillMainBundle/ChillMainBundle.php b/src/Bundle/ChillMainBundle/ChillMainBundle.php index d2ae5f1b5..d5fb7b79d 100644 --- a/src/Bundle/ChillMainBundle/ChillMainBundle.php +++ b/src/Bundle/ChillMainBundle/ChillMainBundle.php @@ -5,6 +5,7 @@ namespace Chill\MainBundle; use Chill\MainBundle\Routing\LocalMenuBuilderInterface; use Chill\MainBundle\Search\SearchInterface; use Chill\MainBundle\Security\Resolver\CenterResolverInterface; +use Chill\MainBundle\Security\Resolver\ScopeResolverInterface; use Symfony\Component\HttpKernel\Bundle\Bundle; use Symfony\Component\DependencyInjection\ContainerBuilder; use Chill\MainBundle\DependencyInjection\CompilerPass\SearchableServicesCompilerPass; @@ -31,6 +32,8 @@ class ChillMainBundle extends Bundle ->addTag('chill.menu_builder'); $container->registerForAutoconfiguration(CenterResolverInterface::class) ->addTag('chill_main.center_resolver'); + $container->registerForAutoconfiguration(ScopeResolverInterface::class) + ->addTag('chill_main.scope_resolver'); $container->addCompilerPass(new SearchableServicesCompilerPass()); $container->addCompilerPass(new ConfigConsistencyCompilerPass()); diff --git a/src/Bundle/ChillMainBundle/Entity/HasCentersInterface.php b/src/Bundle/ChillMainBundle/Entity/HasCentersInterface.php new file mode 100644 index 000000000..921cbba41 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Entity/HasCentersInterface.php @@ -0,0 +1,8 @@ +roleHierarchy = $roleHierarchy; $this->hierarchy = $parameterBag->get('security.role_hierarchy.roles'); $this->em = $em; $this->centerResolverDispatcher = $centerResolverDispatcher; + $this->logger = $logger; + $this->scopeResolverDispatcher = $scopeResolverDispatcher; } /** @@ -114,11 +125,32 @@ class AuthorizationHelper */ public function userHasAccess(User $user, $entity, $attribute) { - if (NULL === $center = $this->centerResolverDispatcher->resolveCenter($entity)) { - return false; - } + $center = $this->centerResolverDispatcher->resolveCenter($entity); + if (is_iterable($center)) { + foreach ($center as $c) { + if ($this->userHasAccessForCenter($user, $c, $entity, $attribute)) { + return true; + } + } + + return false; + } elseif ($center instanceof Center) { + return $this->userHasAccessForCenter($user, $center, $entity, $attribute); + } elseif (NULL === $center) { + return false; + } else { + throw new \UnexpectedValueException("could not resolver a center"); + } + } + + private function userHasAccessForCenter(User $user, Center $center, $entity, $attribute): bool + { if (!$this->userCanReachCenter($user, $center)) { + $this->logger->debug("user cannot reach center of entity", [ + 'center_name' => $center->getName(), + 'user' => $user->getUsername() + ]); return false; } @@ -132,24 +164,35 @@ class AuthorizationHelper if ($this->isRoleReached($attribute, $roleScope->getRole())) { //if yes, we have a right on something... // perform check on scope if necessary - if ($entity instanceof HasScopeInterface) { - $scope = $entity->getScope(); - if ($scope === NULL) { - return true; - } - if ($scope->getId() === $roleScope - ->getScope()->getId()) { - return true; - } + if ($this->scopeResolverDispatcher->isConcerned($entity)) { + $scope = $this->scopeResolverDispatcher->resolveScope($entity); + + if (NULL === $scope) { + return true; + } elseif (is_iterable($scope)) { + foreach ($scope as $s) { + if ($s === $roleScope->getScope()) { + return true; + } + } + } else { + if ($scope === $roleScope->getScope()) { + return true; + } + } } else { return true; } } } - } } + $this->logger->debug("user can reach center entity, but not role", [ + 'username' => $user->getUsername(), + 'center' => $center->getName() + ]); + return false; } diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php index 6b1f2a897..1e2f9c02b 100644 --- a/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php +++ b/src/Bundle/ChillMainBundle/Security/Resolver/CenterResolverDispatcher.php @@ -9,8 +9,6 @@ class CenterResolverDispatcher */ private iterable $resolvers = []; - private CenterResolverInterface $defaultResolver; - public function __construct(iterable $resolvers) { $this->resolvers = $resolvers; diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/DefaultCenterResolver.php b/src/Bundle/ChillMainBundle/Security/Resolver/DefaultCenterResolver.php index 31531e0cc..e3e92164a 100644 --- a/src/Bundle/ChillMainBundle/Security/Resolver/DefaultCenterResolver.php +++ b/src/Bundle/ChillMainBundle/Security/Resolver/DefaultCenterResolver.php @@ -4,12 +4,13 @@ namespace Chill\MainBundle\Security\Resolver; use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Entity\HasCenterInterface; +use Chill\MainBundle\Entity\HasCentersInterface; class DefaultCenterResolver implements CenterResolverInterface { public function supports($entity, ?array $options = []): bool { - return $entity instanceof HasCenterInterface; + return $entity instanceof HasCenterInterface || $entity instanceof HasCentersInterface; } /** @@ -20,7 +21,13 @@ class DefaultCenterResolver implements CenterResolverInterface */ public function resolveCenter($entity, ?array $options = []) { - return $entity->getCenter(); + if ($entity instanceof HasCenterInterface) { + return $entity->getCenter(); + } elseif ($entity instanceof HasCentersInterface) { + return $entity->getCenters(); + } else { + throw new \UnexpectedValueException("should be an instanceof"); + } } public static function getDefaultPriority(): int diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/DefaultScopeResolver.php b/src/Bundle/ChillMainBundle/Security/Resolver/DefaultScopeResolver.php new file mode 100644 index 000000000..caf052764 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/DefaultScopeResolver.php @@ -0,0 +1,42 @@ +getScope(); + } elseif ($entity instanceof HasScopesInterface) { + return $entity->getScopes(); + } else { + throw new \UnexpectedValueException("should be an instanceof %s or %s", + HasScopesInterface::class, HasScopeInterface::class); + } + } + + public function isConcerned($entity, ?array $options = []): bool + { + return $entity instanceof HasScopeInterface || $entity instanceof HasScopesInterface; + } + + public static function getDefaultPriority(): int + { + return -256; + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverDispatcher.php b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverDispatcher.php new file mode 100644 index 000000000..cc3f11560 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverDispatcher.php @@ -0,0 +1,44 @@ +resolvers = $resolvers; + } + + /** + * @param $entity + * @return Scope|Scope[]|iterable + */ + public function resolveScope($entity, ?array $options = []) + { + foreach ($this->resolvers as $resolver) { + if ($resolver->supports($entity, $options)) { + return $resolver->resolveScope($entity, $options); + } + } + + return null; + } + + public function isConcerned($entity, ?array $options = []): bool + { + foreach ($this->resolvers as $resolver) { + if ($resolver->supports($entity, $options)) { + return $resolver->isConcerned($entity, $options); + } + } + + return false; + } +} diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php new file mode 100644 index 000000000..2f5669d0d --- /dev/null +++ b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php @@ -0,0 +1,30 @@ +getAuthorizationHelper(); $entity = $this->getProphet()->prophesize(); - $entity->willImplement('\Chill\MainBundle\Entity\HasCenterInterface'); - $entity->willImplement('\Chill\MainBundle\Entity\HasScopeInterface'); + $entity->willImplement(HasCenterInterface::class); + $entity->willImplement(HasScopeInterface::class); $entity->getCenter()->willReturn($center); $entity->getScope()->willReturn($scopeA); $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); } + public function testUserHasAccess_MultiCenter_EntityWithoutScope() + { + $center = $this->prepareCenter(1, 'center'); + $centerB = $this->prepareCenter(1, 'centerB'); + $scopeB = $this->prepareScope(2, 'other'); //the user will be granted this scope + $user = $this->prepareUser(array( + array( + 'center' => $center, 'permissionsGroup' => array( + ['scope' => $scopeB, 'role' => 'CHILL_ROLE'] + ) + ) + )); + $helper = $this->getAuthorizationHelper(); + $entity = $this->getProphet()->prophesize(); + $entity->willImplement(HasCentersInterface::class); + $entity->getCenters()->willReturn([$center, $centerB]); + + $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); + } + + public function testUserHasNoAccess_MultiCenter_EntityWithoutScope() + { + $center = $this->prepareCenter(1, 'center'); + $centerB = $this->prepareCenter(1, 'centerB'); + $centerC = $this->prepareCenter(1, 'centerC'); + $scopeB = $this->prepareScope(2, 'other'); //the user will be granted this scope + $user = $this->prepareUser(array( + array( + 'center' => $center, 'permissionsGroup' => array( + ['scope' => $scopeB, 'role' => 'CHILL_ROLE'] + ) + ) + )); + $helper = $this->getAuthorizationHelper(); + $entity = $this->getProphet()->prophesize(); + $entity->willImplement(HasCentersInterface::class); + $entity->getCenters()->willReturn([$centerB, $centerC]); + + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); + } + + public function testUserHasNoAccess_EntityMultiScope() + { + $centerA = $this->prepareCenter(1, 'center'); + $centerB = $this->prepareCenter(1, 'centerB'); + $scopeA = $this->prepareScope(2, 'other'); //the user will be granted this scope + $scopeB = $this->prepareScope(2, 'other'); //the user will be granted this scope + $scopeC = $this->prepareScope(2, 'other'); //the user will be granted this scope + $user = $this->prepareUser(array( + array( + 'center' => $centerA, 'permissionsGroup' => array( + ['scope' => $scopeA, 'role' => 'CHILL_ROLE'] + ) + ) + )); + $helper = $this->getAuthorizationHelper(); + $entity = $this->getProphet()->prophesize(); + $entity->willImplement(HasCentersInterface::class); + $entity->willImplement(HasScopesInterface::class); + $entity->getCenters()->willReturn([$centerA, $centerB]); + $entity->getScopes()->willReturn([$scopeB, $scopeC]); + + $this->assertFalse($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); + } + + public function testUserHasAccess_EntityMultiScope() + { + $centerA = $this->prepareCenter(1, 'center'); + $centerB = $this->prepareCenter(1, 'centerB'); + $scopeA = $this->prepareScope(2, 'other'); //the user will be granted this scope + $scopeB = $this->prepareScope(2, 'other'); //the user will be granted this scope + $user = $this->prepareUser(array( + array( + 'center' => $centerA, 'permissionsGroup' => array( + ['scope' => $scopeA, 'role' => 'CHILL_ROLE'] + ) + ) + )); + $helper = $this->getAuthorizationHelper(); + $entity = $this->getProphet()->prophesize(); + $entity->willImplement(HasCentersInterface::class); + $entity->willImplement(HasScopesInterface::class); + $entity->getCenters()->willReturn([$centerA, $centerB]); + $entity->getScopes()->willReturn([$scopeA, $scopeB]); + + $this->assertTrue($helper->userHasAccess($user, $entity->reveal(), 'CHILL_ROLE')); + } + + + /** * * @dataProvider dataProvider_getReachableCenters diff --git a/src/Bundle/ChillMainBundle/Tests/Security/Resolver/DefaultScopeResolverTest.php b/src/Bundle/ChillMainBundle/Tests/Security/Resolver/DefaultScopeResolverTest.php new file mode 100644 index 000000000..de6d19b5a --- /dev/null +++ b/src/Bundle/ChillMainBundle/Tests/Security/Resolver/DefaultScopeResolverTest.php @@ -0,0 +1,62 @@ +scopeResolver = new DefaultScopeResolver(); + } + + public function testHasScopeInterface() + { + $scope = new Scope(); + $entity = new class($scope) implements HasScopeInterface { + + public function __construct(Scope $scope) { + $this->scope = $scope; + } + + public function getScope() + { + return $this->scope; + } + + }; + + $this->assertTrue($this->scopeResolver->supports($entity)); + $this->assertTrue($this->scopeResolver->isConcerned($entity)); + $this->assertSame($scope, $this->scopeResolver->resolveScope($entity)); + } + + public function testHasScopesInterface() + { + $entity = new class($scopeA = new Scope(), $scopeB = new Scope()) implements HasScopesInterface { + + public function __construct(Scope $scopeA, Scope $scopeB) { + $this->scopes = [$scopeA, $scopeB]; + } + + public function getScopes(): iterable + { + return $this->scopes; + } + }; + + $this->assertTrue($this->scopeResolver->supports($entity)); + $this->assertTrue($this->scopeResolver->isConcerned($entity)); + $this->assertIsArray($this->scopeResolver->resolveScope($entity)); + $this->assertSame($scopeA, $this->scopeResolver->resolveScope($entity)[0]); + $this->assertSame($scopeB, $this->scopeResolver->resolveScope($entity)[1]); + } + +} diff --git a/src/Bundle/ChillMainBundle/Tests/Security/Resolver/ScopeResolverDispatcherTest.php b/src/Bundle/ChillMainBundle/Tests/Security/Resolver/ScopeResolverDispatcherTest.php new file mode 100644 index 000000000..2a36fd365 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Tests/Security/Resolver/ScopeResolverDispatcherTest.php @@ -0,0 +1,60 @@ +scopeResolverDispatcher = new ScopeResolverDispatcher([new DefaultScopeResolver()]); + } + + public function testHasScopeInterface() + { + $scope = new Scope(); + $entity = new class($scope) implements HasScopeInterface { + + public function __construct(Scope $scope) { + $this->scope = $scope; + } + + public function getScope() + { + return $this->scope; + } + + }; + + $this->assertTrue($this->scopeResolverDispatcher->isConcerned($entity)); + $this->assertSame($scope, $this->scopeResolverDispatcher->resolveScope($entity)); + } + + public function testHasScopesInterface() + { + $entity = new class($scopeA = new Scope(), $scopeB = new Scope()) implements HasScopesInterface { + + public function __construct(Scope $scopeA, Scope $scopeB) { + $this->scopes = [$scopeA, $scopeB]; + } + + public function getScopes(): iterable + { + return $this->scopes; + } + }; + + $this->assertTrue($this->scopeResolverDispatcher->isConcerned($entity)); + $this->assertIsArray($this->scopeResolverDispatcher->resolveScope($entity)); + $this->assertSame($scopeA, $this->scopeResolverDispatcher->resolveScope($entity)[0]); + $this->assertSame($scopeB, $this->scopeResolverDispatcher->resolveScope($entity)[1]); + } +} diff --git a/src/Bundle/ChillMainBundle/config/services/security.yaml b/src/Bundle/ChillMainBundle/config/services/security.yaml index c9703dbfe..0d820220b 100644 --- a/src/Bundle/ChillMainBundle/config/services/security.yaml +++ b/src/Bundle/ChillMainBundle/config/services/security.yaml @@ -8,11 +8,19 @@ services: arguments: - !tagged_iterator chill_main.center_resolver + Chill\MainBundle\Security\Resolver\ScopeResolverDispatcher: + arguments: + - !tagged_iterator chill_main.scope_resolver + # do not autowire the directory Security/Resolver Chill\MainBundle\Security\Resolver\DefaultCenterResolver: autoconfigure: true autowire: true + Chill\MainBundle\Security\Resolver\DefaultScopeResolver: + autoconfigure: true + autowire: true + # do not autowire the directory Security/Resolver Chill\MainBundle\Security\Resolver\ResolverTwigExtension: autoconfigure: true diff --git a/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php b/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php index 9cba2ec1d..255c6d9ba 100644 --- a/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php +++ b/src/Bundle/ChillPersonBundle/Controller/AccompanyingPeriodController.php @@ -23,7 +23,7 @@ namespace Chill\PersonBundle\Controller; use Chill\PersonBundle\Privacy\PrivacyEvent; -use Chill\PersonBundle\Repository\AccompanyingPeriodACLAwareRepository; +use Chill\PersonBundle\Repository\AccompanyingPeriodACLAwareRepositoryInterface; use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter; use Doctrine\DBAL\Exception; use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter; @@ -56,10 +56,10 @@ class AccompanyingPeriodController extends AbstractController */ protected $validator; - protected AccompanyingPeriodACLAwareRepository $accompanyingPeriodACLAwareRepository; + protected AccompanyingPeriodACLAwareRepositoryInterface $accompanyingPeriodACLAwareRepository; public function __construct( - AccompanyingPeriodACLAwareRepository $accompanyingPeriodACLAwareRepository, + AccompanyingPeriodACLAwareRepositoryInterface $accompanyingPeriodACLAwareRepository, EventDispatcherInterface $eventDispatcher, ValidatorInterface $validator ) { diff --git a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php index 1c375d051..5672b7f09 100644 --- a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php +++ b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php @@ -24,6 +24,8 @@ namespace Chill\PersonBundle\Entity; use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface; use Chill\MainBundle\Doctrine\Model\TrackCreationInterface; +use Chill\MainBundle\Entity\HasCentersInterface; +use Chill\MainBundle\Entity\HasScopesInterface; use Chill\MainBundle\Entity\Scope; use Chill\MainBundle\Entity\Address; use Chill\PersonBundle\Entity\AccompanyingPeriod\AccompanyingPeriodWork; @@ -52,7 +54,8 @@ use Symfony\Component\Validator\Constraints as Assert; * "accompanying_period"=AccompanyingPeriod::class * }) */ -class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface +class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface, + HasScopesInterface, HasCentersInterface { /** * Mark an accompanying period as "occasional" @@ -809,11 +812,16 @@ class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface return $this; } + /** + * @return iterable|Collection + */ public function getScopes(): Collection { return $this->scopes; } + + public function addScope(Scope $scope): self { $this->scopes[] = $scope; @@ -1040,4 +1048,20 @@ class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface return 'none'; } } + + public function getCenters(): ?iterable + {dump(__METHOD__); + foreach ($this->getPersons() as $person) { + if (!in_array($person->getCenter(), $centers ?? []) + && NULL !== $person->getCenter()) { + $centers[] = $person->getCenter(); + } + } + + dump($centers); + + return $centers ?? null; + } + + } diff --git a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php index cdc439e32..c8cca82f5 100644 --- a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php +++ b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepository.php @@ -4,10 +4,11 @@ namespace Chill\PersonBundle\Repository; use Chill\MainBundle\Security\Authorization\AuthorizationHelper; use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; +use Chill\PersonBundle\Entity\AccompanyingPeriod; use Chill\PersonBundle\Entity\Person; use Symfony\Component\Security\Core\Security; -final class AccompanyingPeriodACLAwareRepository +final class AccompanyingPeriodACLAwareRepository implements AccompanyingPeriodACLAwareRepositoryInterface { private AccompanyingPeriodRepository $accompanyingPeriodRepository; private Security $security; @@ -29,7 +30,6 @@ final class AccompanyingPeriodACLAwareRepository int $limit = null, int $offset = null ): array { - dump(__METHOD__); $qb = $this->accompanyingPeriodRepository->createQueryBuilder('ap'); $scopes = $this->authorizationHelper ->getReachableCircles($this->security->getUser(), $role, @@ -42,12 +42,30 @@ final class AccompanyingPeriodACLAwareRepository $qb ->join('ap.participations', 'participation') ->where($qb->expr()->eq('participation.person', ':person')) + ->andWhere( + $qb->expr()->orX( + 'ap.confidential = FALSE', + $qb->expr()->eq('ap.user', ':user') + ) + ) + ->andWhere( + $qb->expr()->orX( + $qb->expr()->neq('ap.step', ':draft'), + $qb->expr()->eq('ap.createdBy', ':creator') + ) + ) + ->setParameter('draft', AccompanyingPeriod::STEP_DRAFT) ->setParameter('person', $person) - ; + ->setParameter('user', $this->security->getUser()) + ->setParameter('creator', $this->security->getUser()) + ; // add join condition for scopes - $orx = $qb->expr()->orX(); + $orx = $qb->expr()->orX( + $qb->expr()->eq('ap.step', ':draft') + ); + foreach ($scopes as $key => $scope) { - $orx->add($qb->expr()->in('ap.scopes', ':scope_'.$key)); + $orx->add($qb->expr()->isMemberOf(':scope_'.$key, 'ap.scopes')); $qb->setParameter('scope_'.$key, $scope); } $qb->andWhere($orx); diff --git a/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepositoryInterface.php b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepositoryInterface.php new file mode 100644 index 000000000..a5798d3e8 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Repository/AccompanyingPeriodACLAwareRepositoryInterface.php @@ -0,0 +1,16 @@ + Date: Mon, 20 Sep 2021 13:03:59 +0200 Subject: [PATCH 23/37] upgrade voter and acl for activities and implement autoconfiguration for ChillProvideRole interface --- .../Controller/ActivityController.php | 27 +++--- .../Repository/ActivityACLAwareRepository.php | 72 +++++++++++++--- .../ActivityACLAwareRepositoryInterface.php | 19 +++++ .../Repository/ActivityRepository.php | 68 +++++++++++++-- .../Security/Authorization/ActivityVoter.php | 85 +++++++++++-------- .../ChillActivityBundle/config/services.yaml | 21 ++--- .../config/services/controller.yaml | 6 +- .../config/services/repositories.yaml | 8 +- .../ChillMainBundle/ChillMainBundle.php | 4 + .../Authorization/AuthorizationHelper.php | 21 +++-- .../Entity/AccompanyingPeriod.php | 6 +- 11 files changed, 236 insertions(+), 101 deletions(-) create mode 100644 src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepositoryInterface.php diff --git a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php index fe515918a..0988eedfe 100644 --- a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php +++ b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php @@ -22,6 +22,9 @@ namespace Chill\ActivityBundle\Controller; +use Chill\ActivityBundle\Repository\ActivityACLAwareRepository; +use Chill\ActivityBundle\Repository\ActivityACLAwareRepositoryInterface; +use Chill\ActivityBundle\Security\Authorization\ActivityVoter; use Chill\MainBundle\Security\Authorization\AuthorizationHelper; use Chill\PersonBundle\Entity\AccompanyingPeriod; use Chill\PersonBundle\Entity\Person; @@ -53,12 +56,16 @@ class ActivityController extends AbstractController protected SerializerInterface $serializer; + protected ActivityACLAwareRepositoryInterface $activityACLAwareRepository; + public function __construct( + ActivityACLAwareRepositoryInterface $activityACLAwareRepository, EventDispatcherInterface $eventDispatcher, AuthorizationHelper $authorizationHelper, LoggerInterface $logger, SerializerInterface $serializer ) { + $this->activityACLAwareRepository = $activityACLAwareRepository; $this->eventDispatcher = $eventDispatcher; $this->authorizationHelper = $authorizationHelper; $this->logger = $logger; @@ -77,13 +84,9 @@ class ActivityController extends AbstractController [$person, $accompanyingPeriod] = $this->getEntity($request); if ($person instanceof Person) { - $reachableScopes = $this->authorizationHelper - ->getReachableCircles($this->getUser(), new Role('CHILL_ACTIVITY_SEE'), - $person->getCenter()); - - $activities = $em->getRepository(Activity::class) - ->findByPersonImplied($person, $reachableScopes) - ; + $this->denyAccessUnlessGranted(ActivityVoter::SEE, $person); + $activities = $this->activityACLAwareRepository + ->findByPerson($person, ActivityVoter::SEE, 0, null); $event = new PrivacyEvent($person, array( 'element_class' => Activity::class, @@ -93,10 +96,10 @@ class ActivityController extends AbstractController $view = 'ChillActivityBundle:Activity:listPerson.html.twig'; } elseif ($accompanyingPeriod instanceof AccompanyingPeriod) { - $activities = $em->getRepository('ChillActivityBundle:Activity')->findBy( - ['accompanyingPeriod' => $accompanyingPeriod], - ['date' => 'DESC'], - ); + $this->denyAccessUnlessGranted(ActivityVoter::SEE, $accompanyingPeriod); + + $activities = $this->activityACLAwareRepository + ->findByAccompanyingPeriod($accompanyingPeriod, ActivityVoter::SEE); $view = 'ChillActivityBundle:Activity:listAccompanyingCourse.html.twig'; } @@ -238,7 +241,7 @@ class ActivityController extends AbstractController if (!$entity) { throw $this->createNotFoundException('Unable to find Activity entity.'); } - + if (null !== $accompanyingPeriod) { $entity->personsAssociated = $entity->getPersonsAssociated(); $entity->personsNotAssociated = $entity->getPersonsNotAssociated(); diff --git a/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepository.php b/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepository.php index b198875c5..b498a6090 100644 --- a/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepository.php +++ b/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepository.php @@ -23,6 +23,8 @@ namespace Chill\ActivityBundle\Repository; use Chill\ActivityBundle\Entity\Activity; +use Chill\MainBundle\Security\Resolver\CenterResolverDispatcher; +use Chill\PersonBundle\Entity\AccompanyingPeriod; use Chill\PersonBundle\Entity\Person; use Chill\ActivityBundle\Repository\ActivityRepository; use Chill\ActivityBundle\Security\Authorization\ActivityVoter; @@ -33,9 +35,10 @@ use Chill\MainBundle\Security\Authorization\AuthorizationHelper; use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface; use Symfony\Component\Security\Core\Role\Role; use Doctrine\ORM\EntityManagerInterface; +use Symfony\Component\Security\Core\Security; -final class ActivityACLAwareRepository +final class ActivityACLAwareRepository implements ActivityACLAwareRepositoryInterface { private AuthorizationHelper $authorizationHelper; @@ -45,16 +48,63 @@ final class ActivityACLAwareRepository private EntityManagerInterface $em; + private Security $security; + + private CenterResolverDispatcher $centerResolverDispatcher; + public function __construct( AuthorizationHelper $authorizationHelper, + CenterResolverDispatcher $centerResolverDispatcher, TokenStorageInterface $tokenStorage, ActivityRepository $repository, - EntityManagerInterface $em + EntityManagerInterface $em, + Security $security ) { $this->authorizationHelper = $authorizationHelper; + $this->centerResolverDispatcher = $centerResolverDispatcher; $this->tokenStorage = $tokenStorage; $this->repository = $repository; $this->em = $em; + $this->security = $security; + } + + /** + * @param Person $person + * @param string $role + * @param int|null $start + * @param int|null $limit + * @param array $orderBy + * @return array|Activity[] + */ + public function findByPerson(Person $person, string $role, ?int $start = 0, ?int $limit = 1000, ?array $orderBy = []): array + { + $user = $this->security->getUser(); + $center = $this->centerResolverDispatcher->resolveCenter($person); + if (0 === count($orderBy)) { + $orderBy = ['date' => 'DESC']; + } + + $reachableScopes = $this->authorizationHelper + ->getReachableCircles($user, $role, $center); + + return $this->em->getRepository(Activity::class) + ->findByPersonImplied($person, $reachableScopes, $orderBy, $limit, $start); + ; + } + + public function findByAccompanyingPeriod(AccompanyingPeriod $period, string $role, ?int $start = 0, ?int $limit = 1000, ?array $orderBy = []): array + { + $user = $this->security->getUser(); + $center = $this->centerResolverDispatcher->resolveCenter($period); + if (0 === count($orderBy)) { + $orderBy = ['date' => 'DESC']; + } + + $scopes = $this->authorizationHelper + ->getReachableCircles($user, $role, $center); + + return $this->em->getRepository(Activity::class) + ->findByAccompanyingPeriod($period, $scopes, true, $limit, $start, $orderBy); } public function queryTimelineIndexer(string $context, array $args = []): array @@ -81,7 +131,7 @@ final class ActivityACLAwareRepository $metadataActivity = $this->em->getClassMetadata(Activity::class); $metadataPerson = $this->em->getClassMetadata(Person::class); $associationMapping = $metadataActivity->getAssociationMapping('person'); - + return $metadataActivity->getTableName().' JOIN ' .$metadataPerson->getTableName().' ON ' .$metadataPerson->getTableName().'.'. @@ -95,7 +145,7 @@ final class ActivityACLAwareRepository { $where = ''; $parameters = []; - + $metadataActivity = $this->em->getClassMetadata(Activity::class); $metadataPerson = $this->em->getClassMetadata(Person::class); $activityToPerson = $metadataActivity->getAssociationMapping('person')['joinColumns'][0]['name']; @@ -105,20 +155,20 @@ final class ActivityACLAwareRepository // acls: $role = new Role(ActivityVoter::SEE); - $reachableCenters = $this->authorizationHelper->getReachableCenters($this->tokenStorage->getToken()->getUser(), + $reachableCenters = $this->authorizationHelper->getReachableCenters($this->tokenStorage->getToken()->getUser(), $role); - + if (count($reachableCenters) === 0) { // insert a dummy condition return 'FALSE = TRUE'; } - if ($context === 'person') { - // we start with activities having the person_id linked to person + if ($context === 'person') { + // we start with activities having the person_id linked to person $where .= sprintf('%s = ? AND ', $activityToPerson); $parameters[] = $person->getId(); } - + // we add acl (reachable center and scopes) $where .= '('; // first loop for the for centers $centersI = 0; // like centers#i @@ -131,7 +181,7 @@ final class ActivityACLAwareRepository $reachableScopes = $this->authorizationHelper->getReachableScopes($this->tokenStorage->getToken()->getUser(), $role, $center); // we get the ids for those scopes $reachablesScopesId = array_map( - function(Scope $scope) { return $scope->getId(); }, + function(Scope $scope) { return $scope->getId(); }, $reachableScopes ); @@ -162,7 +212,7 @@ final class ActivityACLAwareRepository } // close loop for centers $where .= ')'; - + return [$where, $parameters]; } diff --git a/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepositoryInterface.php b/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepositoryInterface.php new file mode 100644 index 000000000..0b646f7c5 --- /dev/null +++ b/src/Bundle/ChillActivityBundle/Repository/ActivityACLAwareRepositoryInterface.php @@ -0,0 +1,19 @@ + 'DESC'], $limit = 100, $offset = 0) + /** + * @param $person + * @param array $scopes + * @param string[] $orderBy + * @param int $limit + * @param int $offset + * @return array|Activity[] + */ + public function findByPersonImplied(Person $person, array $scopes, ?array $orderBy = [ 'date' => 'DESC'], ?int $limit = 100, ?int $offset = 0): array { $qb = $this->createQueryBuilder('a'); $qb->select('a'); $qb - // TODO add acl - //->where($qb->expr()->in('a.scope', ':scopes')) - //->setParameter('scopes', $scopes) + ->where($qb->expr()->in('a.scope', ':scopes')) + ->setParameter('scopes', $scopes) ->andWhere( $qb->expr()->orX( $qb->expr()->eq('a.person', ':person'), @@ -61,7 +70,56 @@ class ActivityRepository extends ServiceEntityRepository $qb->addOrderBy('a.'.$k, $dir); } + $qb->setMaxResults($limit)->setFirstResult($offset); + return $qb->getQuery() ->getResult(); - } + } + + /** + * @param AccompanyingPeriod $period + * @param array $scopes + * @param int|null $limit + * @param int|null $offset + * @param array|string[] $orderBy + * @return array|Activity[] + */ + public function findByAccompanyingPeriod(AccompanyingPeriod $period, array $scopes, ?bool $allowNullScope = false, ?int $limit = 100, ?int $offset = 0, array $orderBy = ['date' => 'desc']): array + { + $qb = $this->createQueryBuilder('a'); + $qb->select('a'); + + if (!$allowNullScope) { + $qb + ->where($qb->expr()->in('a.scope', ':scopes')) + ->setParameter('scopes', $scopes) + ; + } else { + $qb + ->where( + $qb->expr()->orX( + $qb->expr()->in('a.scope', ':scopes'), + $qb->expr()->isNull('a.scope') + ) + ) + ->setParameter('scopes', $scopes) + ; + } + + $qb + ->andWhere( + $qb->expr()->eq('a.accompanyingPeriod', ':period') + ) + ->setParameter('period', $period) + ; + + foreach ($orderBy as $k => $dir) { + $qb->addOrderBy('a.'.$k, $dir); + } + + $qb->setMaxResults($limit)->setFirstResult($offset); + + return $qb->getQuery() + ->getResult(); + } } diff --git a/src/Bundle/ChillActivityBundle/Security/Authorization/ActivityVoter.php b/src/Bundle/ChillActivityBundle/Security/Authorization/ActivityVoter.php index 79cb6d852..cc9cecf52 100644 --- a/src/Bundle/ChillActivityBundle/Security/Authorization/ActivityVoter.php +++ b/src/Bundle/ChillActivityBundle/Security/Authorization/ActivityVoter.php @@ -19,6 +19,11 @@ namespace Chill\ActivityBundle\Security\Authorization; +use Chill\MainBundle\Security\Authorization\VoterHelperFactoryInterface; +use Chill\MainBundle\Security\Authorization\VoterHelperInterface; +use Chill\PersonBundle\Entity\AccompanyingPeriod; +use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter; +use Chill\PersonBundle\Security\Authorization\PersonVoter; use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; use Chill\MainBundle\Security\Authorization\AbstractChillVoter; @@ -28,11 +33,10 @@ use Chill\MainBundle\Entity\User; use Chill\ActivityBundle\Entity\Activity; use Chill\PersonBundle\Entity\Person; use Symfony\Component\Security\Core\Role\Role; +use Symfony\Component\Security\Core\Security; /** - * - * - * @author Julien Fastré + * Voter for Activity class */ class ActivityVoter extends AbstractChillVoter implements ProvideRoleHierarchyInterface { @@ -41,30 +45,37 @@ class ActivityVoter extends AbstractChillVoter implements ProvideRoleHierarchyIn const SEE_DETAILS = 'CHILL_ACTIVITY_SEE_DETAILS'; const UPDATE = 'CHILL_ACTIVITY_UPDATE'; const DELETE = 'CHILL_ACTIVITY_DELETE'; + const FULL = 'CHILL_ACTIVITY_FULL'; - /** - * - * @var AuthorizationHelper - */ - protected $helper; + private const ALL = [ + self::CREATE, + self::SEE, + self::UPDATE, + self::DELETE, + self::SEE_DETAILS, + self::FULL + ]; - public function __construct(AuthorizationHelper $helper) - { - $this->helper = $helper; + protected VoterHelperInterface $voterHelper; + + protected Security $security; + + public function __construct( + Security $security, + VoterHelperFactoryInterface $voterHelperFactory + ) { + $this->security = $security; + $this->voterHelper = $voterHelperFactory->generate(self::class) + ->addCheckFor(Person::class, [self::SEE, self::CREATE]) + ->addCheckFor(AccompanyingPeriod::class, [self::SEE, self::CREATE]) + ->addCheckFor(Activity::class, self::ALL) + ->build(); } protected function supports($attribute, $subject) { - if ($subject instanceof Activity) { - return \in_array($attribute, $this->getAttributes()); - } elseif ($subject instanceof Person) { - return $attribute === self::SEE - || - $attribute === self::CREATE; - } else { - return false; - } + return $this->voterHelper->supports($attribute, $subject); } protected function voteOnAttribute($attribute, $subject, TokenInterface $token) @@ -72,32 +83,34 @@ class ActivityVoter extends AbstractChillVoter implements ProvideRoleHierarchyIn if (!$token->getUser() instanceof User) { return false; } - - if ($subject instanceof Person) { - $centers = $this->helper->getReachableCenters($token->getUser(), new Role($attribute)); - - return \in_array($subject->getCenter(), $centers); + + if ($subject instanceof Activity) { + if ($subject->getPerson() instanceof Person) { + // the context is person: we must have the right to see the person + if (!$this->security->isGranted(PersonVoter::SEE, $subject->getPerson())) { + return false; + } + } elseif ($subject->getAccompanyingPeriod() instanceof AccompanyingPeriod) { + if (!$this->security->isGranted(AccompanyingPeriodVoter::SEE, $subject->getAccompanyingPeriod())) { + return false; + } + } else { + throw new \RuntimeException("could not determine context of activity"); + } } - - /* @var $subject Activity */ - return $this->helper->userHasAccess($token->getUser(), $subject, $attribute); - } - - private function getAttributes() - { - return [ self::CREATE, self::SEE, self::UPDATE, self::DELETE, - self::SEE_DETAILS ]; + + return $this->voterHelper->voteOnAttribute($attribute, $subject, $token); } public function getRoles() { - return $this->getAttributes(); + return self::ALL; } public function getRolesWithoutScope() { - return array(); + return []; } diff --git a/src/Bundle/ChillActivityBundle/config/services.yaml b/src/Bundle/ChillActivityBundle/config/services.yaml index 86168101a..0a65e08c8 100644 --- a/src/Bundle/ChillActivityBundle/config/services.yaml +++ b/src/Bundle/ChillActivityBundle/config/services.yaml @@ -1,20 +1,4 @@ services: - chill.activity.security.authorization.activity_voter: - class: Chill\ActivityBundle\Security\Authorization\ActivityVoter - arguments: - - "@chill.main.security.authorization.helper" - tags: - - { name: security.voter } - - { name: chill.role } - - chill.activity.security.authorization.activity_stats_voter: - class: Chill\ActivityBundle\Security\Authorization\ActivityStatsVoter - arguments: - - "@chill.main.security.authorization.helper" - tags: - - { name: security.voter } - - { name: chill.role } - chill.activity.timeline: class: Chill\ActivityBundle\Timeline\TimelineActivityProvider @@ -38,3 +22,8 @@ services: autowire: true autoconfigure: true resource: '../Notification' + + Chill\ActivityBundle\Security\Authorization\: + resource: '../Security/Authorization/' + autowire: true + autoconfigure: true diff --git a/src/Bundle/ChillActivityBundle/config/services/controller.yaml b/src/Bundle/ChillActivityBundle/config/services/controller.yaml index 106b2c6e4..96ace0a64 100644 --- a/src/Bundle/ChillActivityBundle/config/services/controller.yaml +++ b/src/Bundle/ChillActivityBundle/config/services/controller.yaml @@ -1,8 +1,4 @@ services: Chill\ActivityBundle\Controller\ActivityController: - arguments: - $eventDispatcher: '@Symfony\Component\EventDispatcher\EventDispatcherInterface' - $authorizationHelper: '@Chill\MainBundle\Security\Authorization\AuthorizationHelper' - $logger: '@chill.main.logger' - $serializer: '@Symfony\Component\Serializer\SerializerInterface' + autowire: true tags: ['controller.service_arguments'] diff --git a/src/Bundle/ChillActivityBundle/config/services/repositories.yaml b/src/Bundle/ChillActivityBundle/config/services/repositories.yaml index 2f0a9b83c..26bc58ac9 100644 --- a/src/Bundle/ChillActivityBundle/config/services/repositories.yaml +++ b/src/Bundle/ChillActivityBundle/config/services/repositories.yaml @@ -24,9 +24,7 @@ services: - '@Doctrine\Persistence\ManagerRegistry' Chill\ActivityBundle\Repository\ActivityACLAwareRepository: - arguments: - $tokenStorage: '@Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface' - $authorizationHelper: '@Chill\MainBundle\Security\Authorization\AuthorizationHelper' - $repository: '@Chill\ActivityBundle\Repository\ActivityRepository' - $em: '@Doctrine\ORM\EntityManagerInterface' + autowire: true + autoconfigure: true + Chill\ActivityBundle\Repository\ActivityACLAwareRepositoryInterface: '@Chill\ActivityBundle\Repository\ActivityACLAwareRepository' diff --git a/src/Bundle/ChillMainBundle/ChillMainBundle.php b/src/Bundle/ChillMainBundle/ChillMainBundle.php index d5fb7b79d..91c58f68b 100644 --- a/src/Bundle/ChillMainBundle/ChillMainBundle.php +++ b/src/Bundle/ChillMainBundle/ChillMainBundle.php @@ -4,6 +4,8 @@ namespace Chill\MainBundle; use Chill\MainBundle\Routing\LocalMenuBuilderInterface; use Chill\MainBundle\Search\SearchInterface; +use Chill\MainBundle\Security\Authorization\ChillVoterInterface; +use Chill\MainBundle\Security\ProvideRoleInterface; use Chill\MainBundle\Security\Resolver\CenterResolverInterface; use Chill\MainBundle\Security\Resolver\ScopeResolverInterface; use Symfony\Component\HttpKernel\Bundle\Bundle; @@ -30,6 +32,8 @@ class ChillMainBundle extends Bundle $container->registerForAutoconfiguration(LocalMenuBuilderInterface::class) ->addTag('chill.menu_builder'); + $container->registerForAutoconfiguration(ProvideRoleInterface::class) + ->addTag('chill.role'); $container->registerForAutoconfiguration(CenterResolverInterface::class) ->addTag('chill_main.center_resolver'); $container->registerForAutoconfiguration(ScopeResolverInterface::class) diff --git a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php index bf45a98d6..2b223a0fe 100644 --- a/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php +++ b/src/Bundle/ChillMainBundle/Security/Authorization/AuthorizationHelper.php @@ -265,11 +265,11 @@ class AuthorizationHelper * @deprecated Use getReachableCircles * * @param User $user - * @param Role $role - * @param Center $center + * @param string role + * @param Center|Center[] $center * @return Scope[] */ - public function getReachableScopes(User $user, $role, Center $center) + public function getReachableScopes(User $user, $role, $center) { if ($role instanceof Role) { $role = $role->getRole(); @@ -283,15 +283,24 @@ class AuthorizationHelper * * @param User $user * @param string|Role $role - * @param Center $center + * @param Center|Center[] $center * @return Scope[] */ - public function getReachableCircles(User $user, $role, Center $center) + public function getReachableCircles(User $user, $role, $center) { + $scopes = []; + + if (is_iterable($center)) { + foreach ($center as $c) { + $scopes = \array_merge($scopes, $this->getReachableCircles($user, $role, $c)); + } + + return $scopes; + } + if ($role instanceof Role) { $role = $role->getRole(); } - $scopes = array(); foreach ($user->getGroupCenters() as $groupCenter){ if ($center->getId() === $groupCenter->getCenter()->getId()) { diff --git a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php index 5672b7f09..d69a7a51a 100644 --- a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php +++ b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php @@ -1050,7 +1050,7 @@ class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface } public function getCenters(): ?iterable - {dump(__METHOD__); + { foreach ($this->getPersons() as $person) { if (!in_array($person->getCenter(), $centers ?? []) && NULL !== $person->getCenter()) { @@ -1058,10 +1058,6 @@ class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface } } - dump($centers); - return $centers ?? null; } - - } From e7928c222d77785c05df5be1477a2206af7a32a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 20 Sep 2021 14:11:33 +0200 Subject: [PATCH 24/37] creating endpoint for scopes --- .../ChillMainExtension.php | 20 +++++++++++++++++++ .../ChillMainBundle/chill.api.specs.yaml | 11 ++++++++++ 2 files changed, 31 insertions(+) diff --git a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php index a25bee94a..d0aada689 100644 --- a/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php +++ b/src/Bundle/ChillMainBundle/DependencyInjection/ChillMainExtension.php @@ -398,6 +398,26 @@ class ChillMainExtension extends Extension implements PrependExtensionInterface, ], ] ], + [ + 'class' => \Chill\MainBundle\Entity\Scope::class, + 'name' => 'scope', + 'base_path' => '/api/1.0/main/scope', + 'base_role' => 'ROLE_USER', + 'actions' => [ + '_index' => [ + 'methods' => [ + Request::METHOD_GET => true, + Request::METHOD_HEAD => true + ], + ], + '_entity' => [ + 'methods' => [ + Request::METHOD_GET => true, + Request::METHOD_HEAD => true, + ] + ], + ] + ], ] ]); } diff --git a/src/Bundle/ChillMainBundle/chill.api.specs.yaml b/src/Bundle/ChillMainBundle/chill.api.specs.yaml index 3dd8c8736..f6945e20b 100644 --- a/src/Bundle/ChillMainBundle/chill.api.specs.yaml +++ b/src/Bundle/ChillMainBundle/chill.api.specs.yaml @@ -480,3 +480,14 @@ paths: description: "not found" 401: description: "Unauthorized" + + /1.0/main/scope.json: + get: + tags: + - scope + summary: return a list of scopes + responses: + 200: + description: "ok" + 401: + description: "Unauthorized" From c382008b4de48d90e979fef3fbd705e915938e56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 22 Sep 2021 12:23:15 +0200 Subject: [PATCH 25/37] fix tests (wip) --- .../AccompanyingCourseApiControllerTest.php | 126 ++++++++++-------- 1 file changed, 71 insertions(+), 55 deletions(-) diff --git a/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php b/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php index 3f427e811..a24e94bfa 100644 --- a/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php +++ b/src/Bundle/ChillPersonBundle/Tests/Controller/AccompanyingCourseApiControllerTest.php @@ -23,6 +23,7 @@ namespace Chill\PersonBundle\Tests\Controller; +use Chill\PersonBundle\Repository\AccompanyingPeriodRepository; use Symfony\Bundle\FrameworkBundle\Test\WebTestCase; use Chill\PersonBundle\Entity\AccompanyingPeriod; use Chill\PersonBundle\Entity\AccompanyingPeriodParticipation; @@ -47,6 +48,8 @@ class AccompanyingCourseApiControllerTest extends WebTestCase protected ?AccompanyingPeriod $period = NULL; + protected ?int $periodId = NULL; + /** * Setup before the first test of this class (see phpunit doc) */ @@ -70,15 +73,15 @@ class AccompanyingCourseApiControllerTest extends WebTestCase * * @dataProvider dataGenerateRandomAccompanyingCourse */ - public function testAccompanyingCourseShow(int $personId, AccompanyingPeriod $period) + public function testAccompanyingCourseShow(int $personId, int $periodId) { - $c = $this->client->request(Request::METHOD_GET, sprintf('/api/1.0/person/accompanying-course/%d.json', $period->getId())); + $c = $this->client->request(Request::METHOD_GET, sprintf('/api/1.0/person/accompanying-course/%d.json', $periodId)); $response = $this->client->getResponse(); $this->assertEquals(200, $response->getStatusCode(), "Test that the response of rest api has a status code ok (200)"); $data = \json_decode($response->getContent()); - $this->assertEquals($data->id, $period->getId(), + $this->assertEquals($data->id, $periodId, "test that the response's data contains the id of the period" ); $this->assertGreaterThan(0, $data->participations); @@ -326,14 +329,16 @@ class AccompanyingCourseApiControllerTest extends WebTestCase * * @dataProvider dataGenerateRandomAccompanyingCourse */ - public function testAccompanyingPeriodPatch(int $personId, AccompanyingPeriod $period) + public function testAccompanyingPeriodPatch(int $personId, int $periodId) { + $period = self::$container->get(AccompanyingPeriodRepository::class) + ->find($periodId); $initialValueEmergency = $period->isEmergency(); $em = self::$container->get(EntityManagerInterface::class); $this->client->request( Request::METHOD_PATCH, - sprintf('/api/1.0/person/accompanying-course/%d.json', $period->getId()), + sprintf('/api/1.0/person/accompanying-course/%d.json', $periodId), [], // parameters [], // files [], // server parameters @@ -343,11 +348,10 @@ class AccompanyingCourseApiControllerTest extends WebTestCase $this->assertEquals(200, $response->getStatusCode()); $period = $em->getRepository(AccompanyingPeriod::class) - ->find($period->getId()); - $em->refresh($period); + ->find($periodId); $this->assertEquals(!$initialValueEmergency, $period->isEmergency()); - // restore the initial valud + // restore the initial value $period->setEmergency($initialValueEmergency); $em->flush(); } @@ -361,12 +365,32 @@ class AccompanyingCourseApiControllerTest extends WebTestCase $em = static::$container->get(EntityManagerInterface::class); $center = $em->getRepository(Center::class) ->findOneBy(array('name' => 'Center A')); + $qb = $em->createQueryBuilder(); - $personIds = $em->createQuery("SELECT p.id FROM ". - Person::class." p ". - " WHERE p.center = :center") + $personIds = $qb + ->select('p.id') + ->distinct(true) + ->from(Person::class, 'p') + ->join('p.accompanyingPeriodParticipations', 'participation') + ->join('participation.accompanyingPeriod', 'ap') + ->where( + $qb->expr()->eq( + 'p.center', + ':center' + ) + ) + ->andWhere( + $qb->expr()->gt( + 'SIZE(p.accompanyingPeriodParticipations)', + 0) + ) + ->andWhere( + $qb->expr()->eq('ap.step', ':step') + ) ->setParameter('center', $center) + ->setParameter('step', AccompanyingPeriod::STEP_CONFIRMED) ->setMaxResults($maxResults) + ->getQuery() ->getScalarResult(); // create a random order @@ -400,11 +424,11 @@ class AccompanyingCourseApiControllerTest extends WebTestCase * * @dataProvider dataGenerateRandomAccompanyingCourse */ - public function testAccompanyingCourseAddParticipation(int $personId, AccompanyingPeriod $period) + public function testAccompanyingCourseAddParticipation(int $personId, int $periodId) { $this->client->request( Request::METHOD_POST, - sprintf('/api/1.0/person/accompanying-course/%d/participation.json', $period->getId()), + sprintf('/api/1.0/person/accompanying-course/%d/participation.json', $periodId), [], // parameters [], // files [], // server parameters @@ -420,7 +444,8 @@ class AccompanyingCourseApiControllerTest extends WebTestCase // check by deownloading the accompanying cours - $this->client->request(Request::METHOD_GET, sprintf('/api/1.0/person/accompanying-course/%d.json', $period->getId())); + $this->client->request(Request::METHOD_GET, sprintf('/api/1.0/person/accompanying-course/%d.json', $periodId)); + $this->assertEquals(200, $response->getStatusCode(), "Test that the response of rest api has a status code ok (200)"); $response = $this->client->getResponse(); $data = \json_decode($response->getContent()); @@ -435,7 +460,7 @@ class AccompanyingCourseApiControllerTest extends WebTestCase // check removing the participation $this->client->request( Request::METHOD_DELETE, - sprintf('/api/1.0/person/accompanying-course/%d/participation.json', $period->getId()), + sprintf('/api/1.0/person/accompanying-course/%d/participation.json', $periodId), [], // parameters [], // files [], // server parameters @@ -450,42 +475,6 @@ class AccompanyingCourseApiControllerTest extends WebTestCase $this->assertNotNull($data['startDate']); $this->assertArrayHasKey('endDate', $data); $this->assertNotNull($data['endDate']); - - - // set to variable for tear down - $this->personId = $personId; - $this->period = $period; - } - - protected function tearDown() - { - $em = static::$container->get(EntityManagerInterface::class); - - // remove participation if set - if ($this->personId && $this->period) { - $participation = $em - ->getRepository(AccompanyingPeriodParticipation::class) - ->findOneBy(['person' => $this->personId, 'accompanyingPeriod' => $this->period]) - ; - - if (NULL !== $participation) { - $em->remove($participation); - $em->flush(); - } - $this->personId = NULL; - $this->period = NULL; - } elseif ($this->period) { - $period = $em - ->getRepository(AccompanyingPeriod::class) - ->find($this->period->getId()) ; - - if ($period !== NULL) { - $em->remove($period); - $em->flush(); - } - - $this->period = null; - } } public function dataGenerateRandomAccompanyingCourseWithSocialIssue() @@ -505,12 +494,32 @@ class AccompanyingCourseApiControllerTest extends WebTestCase $em = static::$container->get(EntityManagerInterface::class); $center = $em->getRepository(Center::class) ->findOneBy(array('name' => 'Center A')); + $qb = $em->createQueryBuilder(); - $personIds = $em->createQuery("SELECT p.id FROM ". - Person::class." p ". - " WHERE p.center = :center") + $personIds = $qb + ->select('p.id') + ->distinct(true) + ->from(Person::class, 'p') + ->join('p.accompanyingPeriodParticipations', 'participation') + ->join('participation.accompanyingPeriod', 'ap') + ->where( + $qb->expr()->eq( + 'p.center', + ':center' + ) + ) + ->andWhere( + $qb->expr()->gt( + 'SIZE(p.accompanyingPeriodParticipations)', + 0) + ) + ->andWhere( + $qb->expr()->eq('ap.step', ':step') + ) ->setParameter('center', $center) + ->setParameter('step', AccompanyingPeriod::STEP_CONFIRMED) ->setMaxResults($maxResults) + ->getQuery() ->getScalarResult(); // create a random order @@ -556,7 +565,10 @@ class AccompanyingCourseApiControllerTest extends WebTestCase $qb = $em->createQueryBuilder(); $personIds = $qb ->select('p.id') + ->distinct(true) ->from(Person::class, 'p') + ->join('p.accompanyingPeriodParticipations', 'participation') + ->join('participation.accompanyingPeriod', 'ap') ->where( $qb->expr()->eq( 'p.center', @@ -568,7 +580,11 @@ class AccompanyingCourseApiControllerTest extends WebTestCase 'SIZE(p.accompanyingPeriodParticipations)', 0) ) + ->andWhere( + $qb->expr()->eq('ap.step', ':step') + ) ->setParameter('center', $center) + ->setParameter('step', AccompanyingPeriod::STEP_CONFIRMED) ->setMaxResults($maxResults) ->getQuery() ->getScalarResult(); @@ -584,7 +600,7 @@ class AccompanyingCourseApiControllerTest extends WebTestCase ->find($id); $periods = $person->getAccompanyingPeriods(); - yield [\array_pop($personIds)["id"], $periods[\array_rand($periods)] ]; + yield [\array_pop($personIds)["id"], $periods[\array_rand($periods)]->getId() ]; $nbGenerated++; } From c62254caec3101a8e1ee74ad6fe25f8a64c0e377 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 22 Sep 2021 12:23:26 +0200 Subject: [PATCH 26/37] add scope selection on accompanying course --- src/Bundle/ChillMainBundle/Entity/Scope.php | 24 +-- .../Resources/public/lib/api/scope.js | 17 +++ .../Resolver/ScopeResolverInterface.php | 19 ++- .../ChillMainBundle/chill.api.specs.yaml | 20 +++ .../DataFixtures/ORM/LoadPeople.php | 39 ++++- .../DataFixtures/ORM/LoadPersonACL.php | 12 +- .../Entity/AccompanyingPeriod.php | 4 +- .../public/vuejs/AccompanyingCourse/App.vue | 3 + .../public/vuejs/AccompanyingCourse/api.js | 48 +++++- .../AccompanyingCourse/components/Confirm.vue | 4 + .../AccompanyingCourse/components/Scopes.vue | 47 ++++++ .../vuejs/AccompanyingCourse/js/i18n.js | 5 + .../vuejs/AccompanyingCourse/store/index.js | 144 +++++++++++++++++- 13 files changed, 351 insertions(+), 35 deletions(-) create mode 100644 src/Bundle/ChillMainBundle/Resources/public/lib/api/scope.js create mode 100644 src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Scopes.vue diff --git a/src/Bundle/ChillMainBundle/Entity/Scope.php b/src/Bundle/ChillMainBundle/Entity/Scope.php index ba11a1842..2e75c5791 100644 --- a/src/Bundle/ChillMainBundle/Entity/Scope.php +++ b/src/Bundle/ChillMainBundle/Entity/Scope.php @@ -3,17 +3,17 @@ /* * Chill is a suite of a modules, Chill is a software for social workers * Copyright (C) 2014, Champs Libres Cooperative SCRLFS, - * + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. - * + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. - * + * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ @@ -46,17 +46,17 @@ class Scope * @Groups({"read"}) */ private $id; - + /** * translatable names - * + * * @var array * * @ORM\Column(type="json_array") * @Groups({"read"}) */ private $name = []; - + /** * @var Collection * @@ -66,8 +66,8 @@ class Scope * @ORM\Cache(usage="NONSTRICT_READ_WRITE") */ private $roleScopes; - - + + /** * Scope constructor. */ @@ -75,7 +75,7 @@ class Scope { $this->roleScopes = new ArrayCollection(); } - + /** * @return int */ @@ -91,7 +91,7 @@ class Scope { return $this->name; } - + /** * @param $name * @return $this @@ -101,7 +101,7 @@ class Scope $this->name = $name; return $this; } - + /** * @return Collection */ @@ -109,7 +109,7 @@ class Scope { return $this->roleScopes; } - + /** * @param RoleScope $roleScope */ diff --git a/src/Bundle/ChillMainBundle/Resources/public/lib/api/scope.js b/src/Bundle/ChillMainBundle/Resources/public/lib/api/scope.js new file mode 100644 index 000000000..a8df4ed88 --- /dev/null +++ b/src/Bundle/ChillMainBundle/Resources/public/lib/api/scope.js @@ -0,0 +1,17 @@ +const fetchScopes = () => { + return window.fetch('/api/1.0/main/scope.json').then(response => { + if (response.ok) { + return response.json(); + } + }).then(data => { + console.log(data); + return new Promise((resolve, reject) => { + console.log(data); + resolve(data.results); + }); + }); +}; + +export { + fetchScopes +}; diff --git a/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php index 2f5669d0d..04e949a59 100644 --- a/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php +++ b/src/Bundle/ChillMainBundle/Security/Resolver/ScopeResolverInterface.php @@ -2,16 +2,21 @@ namespace Chill\MainBundle\Security\Resolver; -use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Entity\Scope; +/** + * Interface to implement to define a ScopeResolver. + */ interface ScopeResolverInterface { + /** + * Return true if this resolve is able to decide "something" on this entity. + */ public function supports($entity, ?array $options = []): bool; /** - * @param $entity - * @param array|null $options + * Will return the scope for the entity + * * @return Scope|array|Scope[] */ public function resolveScope($entity, ?array $options = []); @@ -19,12 +24,12 @@ interface ScopeResolverInterface /** * Return true if the entity is concerned by scope, false otherwise. - * - * @param $entity - * @param array|null $options - * @return bool */ public function isConcerned($entity, ?array $options = []): bool; + /** + * get the default priority for this resolver. Resolver with an higher priority will be + * queried first. + */ public static function getDefaultPriority(): int; } diff --git a/src/Bundle/ChillMainBundle/chill.api.specs.yaml b/src/Bundle/ChillMainBundle/chill.api.specs.yaml index f6945e20b..8ee69e96d 100644 --- a/src/Bundle/ChillMainBundle/chill.api.specs.yaml +++ b/src/Bundle/ChillMainBundle/chill.api.specs.yaml @@ -491,3 +491,23 @@ paths: description: "ok" 401: description: "Unauthorized" + + /1.0/main/scope/{id}.json: + get: + tags: + - scope + summary: return a list of scopes + parameters: + - name: id + in: path + required: true + description: The scope id + schema: + type: integer + format: integer + minimum: 1 + responses: + 200: + description: "ok" + 401: + description: "Unauthorized" diff --git a/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPeople.php b/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPeople.php index d6bdce233..848e8f874 100644 --- a/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPeople.php +++ b/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPeople.php @@ -24,8 +24,12 @@ namespace Chill\PersonBundle\DataFixtures\ORM; use Chill\MainBundle\Entity\Center; use Chill\MainBundle\Entity\Country; use Chill\MainBundle\Entity\PostalCode; +use Chill\MainBundle\Entity\Scope; +use Chill\MainBundle\Entity\User; use Chill\MainBundle\Repository\CenterRepository; use Chill\MainBundle\Repository\CountryRepository; +use Chill\MainBundle\Repository\ScopeRepository; +use Chill\MainBundle\Repository\UserRepository; use Chill\PersonBundle\Entity\AccompanyingPeriod; use Chill\PersonBundle\Entity\MaritalStatus; use Chill\PersonBundle\Entity\SocialWork\SocialIssue; @@ -90,12 +94,26 @@ class LoadPeople extends AbstractFixture implements OrderedFixtureInterface, Con protected MaritalStatusRepository $maritalStatusRepository; + /** + * @var array|Scope[] + */ + protected array $cacheScopes = []; + + protected ScopeRepository $scopeRepository; + + /** @var array|User[] */ + protected array $cacheUsers = []; + + protected UserRepository $userRepository; + public function __construct( Registry $workflowRegistry, SocialIssueRepository $socialIssueRepository, CenterRepository $centerRepository, CountryRepository $countryRepository, - MaritalStatusRepository $maritalStatusRepository + MaritalStatusRepository $maritalStatusRepository, + ScopeRepository $scopeRepository, + UserRepository $userRepository ) { $this->faker = Factory::create('fr_FR'); $this->faker->addProvider($this); @@ -105,7 +123,8 @@ class LoadPeople extends AbstractFixture implements OrderedFixtureInterface, Con $this->countryRepository = $countryRepository; $this->maritalStatusRepository = $maritalStatusRepository; $this->loader = new NativeLoader($this->faker); - + $this->scopeRepository = $scopeRepository; + $this->userRepository = $userRepository; } public function getOrder() @@ -220,10 +239,16 @@ class LoadPeople extends AbstractFixture implements OrderedFixtureInterface, Con new \DateInterval('P' . \random_int(0, 180) . 'D') ) ); + $accompanyingPeriod->setCreatedBy($this->getRandomUser()) + ->setCreatedAt(new \DateTimeImmutable('now')); $person->addAccompanyingPeriod($accompanyingPeriod); $accompanyingPeriod->addSocialIssue($this->getRandomSocialIssue()); if (\random_int(0, 10) > 3) { + // always add social scope: + $accompanyingPeriod->addScope($this->getReference('scope_social')); + var_dump(count($accompanyingPeriod->getScopes())); + $accompanyingPeriod->setAddressLocation($this->createAddress()); $manager->persist($accompanyingPeriod->getAddressLocation()); $workflow = $this->workflowRegistry->get($accompanyingPeriod); @@ -231,9 +256,19 @@ class LoadPeople extends AbstractFixture implements OrderedFixtureInterface, Con } $manager->persist($person); + $manager->persist($accompanyingPeriod); echo "add person'".$person->__toString()."'\n"; } + private function getRandomUser(): User + { + if (0 === count($this->cacheUsers)) { + $this->cacheUsers = $this->userRepository->findAll(); + } + + return $this->cacheUsers[\array_rand($this->cacheUsers)]; + } + private function createAddress(): Address { $objectSet = $this->loader->loadData([ diff --git a/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPersonACL.php b/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPersonACL.php index c8593d1fd..18f8e5879 100644 --- a/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPersonACL.php +++ b/src/Bundle/ChillPersonBundle/DataFixtures/ORM/LoadPersonACL.php @@ -40,13 +40,13 @@ class LoadPersonACL extends AbstractFixture implements OrderedFixtureInterface return 9600; } - + public function load(ObjectManager $manager) { foreach (LoadPermissionsGroup::$refs as $permissionsGroupRef) { $permissionsGroup = $this->getReference($permissionsGroupRef); $scopeSocial = $this->getReference('scope_social'); - + //create permission group switch ($permissionsGroup->getName()) { case 'social': @@ -55,7 +55,7 @@ class LoadPersonACL extends AbstractFixture implements OrderedFixtureInterface $permissionsGroup->addRoleScope( (new RoleScope()) - ->setRole(AccompanyingPeriodVoter::SEE) + ->setRole(AccompanyingPeriodVoter::FULL) ->setScope($scopeSocial) ); @@ -87,7 +87,7 @@ class LoadPersonACL extends AbstractFixture implements OrderedFixtureInterface $manager->persist($roleScopeUpdate); $manager->persist($roleScopeCreate); $manager->persist($roleScopeDuplicate); - + break; case 'administrative': printf("Adding CHILL_PERSON_SEE to %s permission group \n", $permissionsGroup->getName()); @@ -98,9 +98,9 @@ class LoadPersonACL extends AbstractFixture implements OrderedFixtureInterface $manager->persist($roleScopeSee); break; } - + } - + $manager->flush(); } diff --git a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php index d69a7a51a..14fb26f1a 100644 --- a/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php +++ b/src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php @@ -824,7 +824,9 @@ class AccompanyingPeriod implements TrackCreationInterface, TrackUpdateInterface public function addScope(Scope $scope): self { - $this->scopes[] = $scope; + if (!$this->scopes->contains($scope)) { + $this->scopes[] = $scope; + } return $this; } diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/App.vue b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/App.vue index e621feead..797f246fe 100644 --- a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/App.vue +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/App.vue @@ -10,6 +10,7 @@ + @@ -32,6 +33,7 @@ import PersonsAssociated from './components/PersonsAssociated.vue'; import Requestor from './components/Requestor.vue'; import SocialIssue from './components/SocialIssue.vue'; import CourseLocation from './components/CourseLocation.vue'; +import Scopes from './components/Scopes.vue'; import Referrer from './components/Referrer.vue'; import Resources from './components/Resources.vue'; import Comment from './components/Comment.vue'; @@ -47,6 +49,7 @@ export default { Requestor, SocialIssue, CourseLocation, + Scopes, Referrer, Resources, Comment, diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/api.js b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/api.js index 52e253ac1..ee4c3e11b 100644 --- a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/api.js +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/api.js @@ -191,7 +191,49 @@ const getListOrigins = () => { if (response.ok) { return response.json(); } throw { msg: 'Error while retriving origin\'s list.', sta: response.status, txt: response.statusText, err: new Error(), body: response.body }; }); -} +}; + +const addScope = (id, scope) => { + const url = `/api/1.0/person/accompanying-course/${id}/scope.json`; + console.log(url); + console.log(scope); + + return fetch(url, { + method: 'POST', + body: JSON.stringify({ + id: scope.id, + type: scope.type, + }), + headers: { + 'Content-Type': 'application/json;charset=utf-8' + }, + }) + .then(response => { + if (response.ok) { return response.json(); } + throw { msg: 'Error while adding scope', sta: response.status, txt: response.statusText, err: new Error(), body: response.body }; + }); +}; + +const removeScope = (id, scope) => { + const url = `/api/1.0/person/accompanying-course/${id}/scope.json`; + console.log(url); + console.log(scope); + + return fetch(url, { + method: 'DELETE', + body: JSON.stringify({ + id: scope.id, + type: scope.type, + }), + headers: { + 'Content-Type': 'application/json;charset=utf-8' + }, + }) + .then(response => { + if (response.ok) { return response.json(); } + throw { msg: 'Error while adding scope', sta: response.status, txt: response.statusText, err: new Error(), body: response.body }; + }); +}; export { getAccompanyingCourse, @@ -204,5 +246,7 @@ export { getUsers, whoami, getListOrigins, - postSocialIssue + postSocialIssue, + addScope, + removeScope, }; diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Confirm.vue b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Confirm.vue index 44479831c..b7834039d 100644 --- a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Confirm.vue +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Confirm.vue @@ -88,6 +88,10 @@ export default { socialIssue: { msg: 'confirm.socialIssue_not_valid', anchor: '#section-50' + }, + scopes: { + msg: 'confirm.set_a_scope', + anchor: '#section-65' } } } diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Scopes.vue b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Scopes.vue new file mode 100644 index 000000000..ca1b36770 --- /dev/null +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/components/Scopes.vue @@ -0,0 +1,47 @@ + + + + + diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/js/i18n.js b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/js/i18n.js index d7c01a174..cf3a0fb7e 100644 --- a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/js/i18n.js +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/js/i18n.js @@ -86,6 +86,10 @@ const appMessages = { person_locator: "Parcours localisé auprès de {0}", no_address: "Il n'y a pas d'adresse associée au parcours" }, + scopes: { + title: "Services", + add_at_least_one: "Indiquez au moins un service", + }, referrer: { title: "Référent du parcours", label: "Vous pouvez choisir un TMS ou vous assigner directement comme référent", @@ -113,6 +117,7 @@ const appMessages = { participation_not_valid: "sélectionnez au minimum 1 usager", socialIssue_not_valid: "sélectionnez au minimum une problématique sociale", location_not_valid: "indiquez au minimum une localisation temporaire du parcours", + set_a_scope: "indiquez au moins un service", sure: "Êtes-vous sûr ?", sure_description: "Une fois le changement confirmé, il ne sera plus possible de le remettre à l'état de brouillon !", ok: "Confirmer le parcours" diff --git a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/store/index.js b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/store/index.js index 34a6786fc..4deb86e40 100644 --- a/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/store/index.js +++ b/src/Bundle/ChillPersonBundle/Resources/public/vuejs/AccompanyingCourse/store/index.js @@ -1,28 +1,41 @@ import 'es6-promise/auto'; import { createStore } from 'vuex'; +import { fetchScopes } from 'ChillMainAssets/lib/api/scope.js'; import { getAccompanyingCourse, patchAccompanyingCourse, confirmAccompanyingCourse, postParticipation, postRequestor, postResource, - postSocialIssue } from '../api'; + postSocialIssue, + addScope, + removeScope, +} from '../api'; const debug = process.env.NODE_ENV !== 'production'; const id = window.accompanyingCourseId; -let initPromise = getAccompanyingCourse(id) - .then(accompanying_course => new Promise((resolve, reject) => { +let scopesPromise = fetchScopes(); +let accompanyingCoursePromise = getAccompanyingCourse(id); + +let initPromise = Promise.all([scopesPromise, accompanyingCoursePromise]) + .then(([scopes, accompanyingCourse]) => new Promise((resolve, reject) => { const store = createStore({ strict: debug, modules: { }, state: { - accompanyingCourse: accompanying_course, + accompanyingCourse: accompanyingCourse, addressContext: {}, - errorMsg: [] + errorMsg: [], + // all the available scopes + scopes: scopes, + // the scopes at start. If the user remove all scopes, we re-add those scopes, by security + scopesAtStart: accompanyingCourse.scopes.map(scope => scope), + // the scope states at server side + scopesAtBackend: accompanyingCourse.scopes.map(scope => scope), }, getters: { isParticipationValid(state) { @@ -34,11 +47,16 @@ let initPromise = getAccompanyingCourse(id) isLocationValid(state) { return state.accompanyingCourse.location !== null; }, + isScopeValid(state) { + console.log('is scope valid', state.accompanyingCourse.scopes.length > 0); + return state.accompanyingCourse.scopes.length > 0; + }, validationKeys(state, getters) { let keys = []; if (!getters.isParticipationValid) { keys.push('participation'); } if (!getters.isLocationValid) { keys.push('location'); } if (!getters.isSocialIssueValid) { keys.push('socialIssue'); } + if (!getters.isScopeValid) { keys.push('scopes'); } //console.log('getter keys', keys); return keys; }, @@ -137,6 +155,21 @@ let initPromise = getAccompanyingCourse(id) setEditContextTrue(state) { //console.log('### mutation: set edit context = true'); state.addressContext.edit = true; + }, + setScopes(state, scopes) { + state.accompanyingCourse.scopes = scopes; + }, + addScopeAtBackend(state, scope) { + let scopeIds = state.scopesAtBackend.map(s => s.id); + if (!scopeIds.includes(scope.id)) { + state.scopesAtBackend.push(scope); + } + }, + removeScopeAtBackend(state, scope){ + let scopeIds = state.scopesAtBackend.map(s => s.id); + if (scopeIds.includes(scope.id)) { + state.scopesAtBackend = state.scopesAtBackend.filter(s => s.id !== scope.id); + } } }, actions: { @@ -223,6 +256,107 @@ let initPromise = getAccompanyingCourse(id) resolve(); })).catch((error) => { commit('catchError', error) }); }, + /** + * Handle the checked/unchecked scopes + * + * When the user set the scopes in a invalid situation (when no scopes are cheched), this + * method will internally re-add the scopes as they were originally when the page was loaded, but + * this does not appears for the user (they remains unchecked). When the user re-add a scope, the + * scope is back in a valid state, and the store synchronize with the new state (all the original scopes + * are removed if necessary, and the new checked scopes is backed). + * + * So, for instance: + * + * at load: + * + * [x] scope A (at backend: [x]) + * [x] scope B (at backend: [x]) + * [ ] scope C (at backend: [ ]) + * + * The user uncheck scope A: + * + * [ ] scope A (at backend: [ ] as soon as the operation finish) + * [x] scope B (at backend: [x]) + * [ ] scope C (at backend: [ ]) + * + * The user uncheck scope B. The state is invalid (no scope checked), so we go back to initial state when + * the page loaded): + * + * [ ] scope A (at backend: [x] as soon as the operation finish) + * [ ] scope B (at backend: [x] as soon as the operation finish) + * [ ] scope C (at backend: [ ]) + * + * The user check scope C. The scopes are back to valid state. So we go back to synchronization with UI and + * backend): + * + * [ ] scope A (at backend: [ ] as soon as the operation finish) + * [ ] scope B (at backend: [ ] as soon as the operation finish) + * [x] scope C (at backend: [x] as soon as the operation finish) + * + * **Warning** There is a problem if the user check/uncheck faster than the backend is synchronized. + * + * @param commit + * @param state + * @param dispatch + * @param scopes + * @returns Promise + */ + setScopes({ commit, state, dispatch }, scopes) { + let currentServerScopesIds = state.scopesAtBackend.map(scope => scope.id); + let checkedScopesIds = scopes.map(scope => scope.id); + let removedScopesIds = currentServerScopesIds.filter(id => !checkedScopesIds.includes(id)); + let addedScopesIds = checkedScopesIds.filter(id => !currentServerScopesIds.includes(id)); + let lengthAfterOperation = currentServerScopesIds.length + addedScopesIds.length + - removedScopesIds.length; + + if (lengthAfterOperation > 0 || (lengthAfterOperation === 0 && state.scopesAtStart.length === 0) ) { + return dispatch('updateScopes', { + addedScopesIds, removedScopesIds + }).then(() => { + // warning: when the operation of dispatch are too slow, the user may check / uncheck before + // the end of the synchronisation with the server (done by dispatch operation). Then, it leads to + // check/uncheck in the UI. I do not know of to avoid it. + commit('setScopes', scopes); + return Promise.resolve(); + }); + } else { + return dispatch('setScopes', state.scopesAtStart).then(() => { + commit('setScopes', scopes); + return Promise.resolve(); + }); + } + }, + /** + * Internal function for the store to effectively update scopes. + * + * Return a promise which resolves when all update operation are + * successful and finished. + * + * @param state + * @param commit + * @param addedScopesIds + * @param removedScopesIds + * @return Promise + */ + updateScopes({ state, commit }, { addedScopesIds, removedScopesIds }) { + let promises = []; + state.scopes.forEach(scope => { + if (addedScopesIds.includes(scope.id)) { + promises.push(addScope(state.accompanyingCourse.id, scope).then(() => { + commit('addScopeAtBackend', scope); + return Promise.resolve(); + })); + } + if (removedScopesIds.includes(scope.id)) { + promises.push(removeScope(state.accompanyingCourse.id, scope).then(() => { + commit('removeScopeAtBackend', scope); + return Promise.resolve(); + })); + } + }); + + return Promise.all(promises); + }, postFirstComment({ commit }, payload) { //console.log('## action: postFirstComment: payload', payload); patchAccompanyingCourse(id, { type: "accompanying_period", initialComment: payload }) From b06e726ad17651e382d9a222490ddb598cf3688a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 22 Sep 2021 12:28:14 +0200 Subject: [PATCH 27/37] fix required fields in user controller test --- .../Tests/Controller/UserControllerTest.php | 68 ++++++++++--------- 1 file changed, 35 insertions(+), 33 deletions(-) diff --git a/src/Bundle/ChillMainBundle/Tests/Controller/UserControllerTest.php b/src/Bundle/ChillMainBundle/Tests/Controller/UserControllerTest.php index eeff4cc06..1953439dd 100644 --- a/src/Bundle/ChillMainBundle/Tests/Controller/UserControllerTest.php +++ b/src/Bundle/ChillMainBundle/Tests/Controller/UserControllerTest.php @@ -7,11 +7,11 @@ use Symfony\Bundle\FrameworkBundle\Test\WebTestCase; class UserControllerTest extends WebTestCase { private $client; - + public function setUp() { self::bootKernel(); - + $this->client = static::createClient(array(), array( 'PHP_AUTH_USER' => 'admin', 'PHP_AUTH_PW' => 'password', @@ -23,62 +23,64 @@ class UserControllerTest extends WebTestCase { // get the list $crawler = $this->client->request('GET', '/fr/admin/user/'); - $this->assertEquals(200, $this->client->getResponse()->getStatusCode(), + $this->assertEquals(200, $this->client->getResponse()->getStatusCode(), "Unexpected HTTP status code for GET /admin/user/"); - + $link = $crawler->selectLink('Ajouter un nouvel utilisateur')->link(); $this->assertInstanceOf('Symfony\Component\DomCrawler\Link', $link); $this->assertRegExp('|/fr/admin/user/new$|', $link->getUri()); } - + public function testNew() { $crawler = $this->client->request('GET', '/fr/admin/user/new'); - + $username = 'Test_user'. uniqid(); $password = 'Password1234!'; - dump($crawler->text()); // Fill in the form and submit it $form = $crawler->selectButton('Créer')->form(array( 'chill_mainbundle_user[username]' => $username, 'chill_mainbundle_user[plainPassword][first]' => $password, - 'chill_mainbundle_user[plainPassword][second]' => $password + 'chill_mainbundle_user[plainPassword][second]' => $password, + 'chill_mainbundle_user[email]' => $username.'@gmail.com', + 'chill_mainbundle_user[label]' => $username, + )); $this->client->submit($form); $crawler = $this->client->followRedirect(); // Check data in the show view - $this->assertGreaterThan(0, $crawler->filter('td:contains("Test_user")')->count(), + $this->assertGreaterThan(0, $crawler->filter('td:contains("Test_user")')->count(), 'Missing element td:contains("Test user")'); - + $update = $crawler->selectLink('Modifier')->link(); - + $this->assertInstanceOf('Symfony\Component\DomCrawler\Link', $update); $this->assertRegExp('|/fr/admin/user/[0-9]{1,}/edit$|', $update->getUri()); - + //test the auth of the new client $this->isPasswordValid($username, $password); - + return $update; } - + protected function isPasswordValid($username, $password) { /* @var $passwordEncoder \Symfony\Component\Security\Core\Encoder\UserPasswordEncoder */ $passwordEncoder = self::$kernel->getContainer() ->get('security.password_encoder'); - + $user = self::$kernel->getContainer() ->get('doctrine.orm.entity_manager') ->getRepository('ChillMainBundle:User') ->findOneBy(array('username' => $username)); - + $this->assertTrue($passwordEncoder->isPasswordValid($user, $password)); } - + /** - * + * * @param \Symfony\Component\DomCrawler\Link $update * @depends testNew */ @@ -90,24 +92,24 @@ class UserControllerTest extends WebTestCase $form = $crawler->selectButton('Mettre à jour')->form(array( 'chill_mainbundle_user[username]' => $username, )); - + $this->client->submit($form); $crawler = $this->client->followRedirect(); // Check the element contains an attribute with value equals "Foo" - $this->assertGreaterThan(0, $crawler->filter('[value="'.$username.'"]')->count(), + $this->assertGreaterThan(0, $crawler->filter('[value="'.$username.'"]')->count(), 'Missing element [value="Foo bar"]'); - + $updatePassword = $crawler->selectLink('Modifier le mot de passe')->link(); - + $this->assertInstanceOf('Symfony\Component\DomCrawler\Link', $updatePassword); - $this->assertRegExp('|/fr/admin/user/[0-9]{1,}/edit_password$|', + $this->assertRegExp('|/fr/admin/user/[0-9]{1,}/edit_password$|', $updatePassword->getUri()); - + return array('link' => $updatePassword, 'username' => $username); } - + /** - * + * * @param \Symfony\Component\DomCrawler\Link $updatePassword * @depends testUpdate */ @@ -116,22 +118,22 @@ class UserControllerTest extends WebTestCase $link = $params['link']; $username = $params['username']; $newPassword = '1234Password!'; - + $crawler = $this->client->click($link); - + $form = $crawler->selectButton('Changer le mot de passe')->form(array( 'chill_mainbundle_user_password[new_password][first]' => $newPassword, 'chill_mainbundle_user_password[new_password][second]' => $newPassword, )); - + $this->client->submit($form); - - $this->assertTrue($this->client->getResponse()->isRedirect(), + + $this->assertTrue($this->client->getResponse()->isRedirect(), "the response is a redirection"); $this->client->followRedirect(); - + $this->isPasswordValid($username, $newPassword); } - + } From 7df923c669144576c777335cd74a4f087b1a016e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 22 Sep 2021 12:28:35 +0200 Subject: [PATCH 28/37] fix vendor dir in composer.json --- composer.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/composer.json b/composer.json index a2aa29a5a..747747290 100644 --- a/composer.json +++ b/composer.json @@ -62,7 +62,8 @@ "symfony/web-profiler-bundle": "^5.0" }, "config": { - "bin-dir": "bin" + "bin-dir": "bin", + "vendor-dir": "tests/app/vendor" }, "autoload": { "psr-4": { From 27674985bd3aee6b9c753a76a5c7ee163dcc3043 Mon Sep 17 00:00:00 2001 From: nobohan Date: Fri, 17 Sep 2021 16:29:55 +0200 Subject: [PATCH 29/37] rdv: add pagination in calendar item list + refactor list views --- .../Controller/CalendarController.php | 45 ++++-- .../Repository/CalendarRepository.php | 6 + .../Resources/views/Calendar/list.html.twig | 135 ------------------ .../listByAccompanyingCourse.html.twig | 121 +++++++++++++++- .../views/Calendar/listByUser.html.twig | 5 +- 5 files changed, 161 insertions(+), 151 deletions(-) delete mode 100644 src/Bundle/ChillCalendarBundle/Resources/views/Calendar/list.html.twig diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index fff20940a..e7226b1bd 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -36,7 +36,9 @@ use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Security\Core\Role\Role; use Chill\CalendarBundle\Entity\Calendar; use Chill\CalendarBundle\Form\CalendarType; +use Chill\CalendarBundle\Repository\CalendarRepository; use Chill\MainBundle\Entity\User; +use Chill\MainBundle\Pagination\PaginatorFactory; use Symfony\Component\Serializer\SerializerInterface; use Symfony\Component\Routing\Annotation\Route; @@ -55,16 +57,24 @@ class CalendarController extends AbstractController protected SerializerInterface $serializer; + protected PaginatorFactory $paginator; + + private CalendarRepository $calendarRepository; + public function __construct( EventDispatcherInterface $eventDispatcher, AuthorizationHelper $authorizationHelper, LoggerInterface $logger, - SerializerInterface $serializer + SerializerInterface $serializer, + PaginatorFactory $paginator, + CalendarRepository $calendarRepository ) { $this->eventDispatcher = $eventDispatcher; $this->authorizationHelper = $authorizationHelper; $this->logger = $logger; $this->serializer = $serializer; + $this->paginator = $paginator; + $this->calendarRepository = $calendarRepository; } /** @@ -73,31 +83,40 @@ class CalendarController extends AbstractController */ public function listAction(Request $request): Response { - $em = $this->getDoctrine()->getManager(); $view = null; [$user, $accompanyingPeriod] = $this->getEntity($request); if ($user instanceof User) { - $calendarItems = $em->getRepository(Calendar::class) - ->findByUser($user) - ; + $calendarItems = $this->calendarRepository->findByUser($user); + $view = '@ChillCalendar/Calendar/listByUser.html.twig'; + + return $this->render($view, [ + 'calendarItems' => $calendarItems, + 'user' => $user + ]); + } elseif ($accompanyingPeriod instanceof AccompanyingPeriod) { - $calendarItems = $em->getRepository(Calendar::class)->findBy( + + $total = $this->calendarRepository->countByAccompanyingPeriod($accompanyingPeriod); + $paginator = $this->paginator->create($total); + $calendarItems = $this->calendarRepository->findBy( ['accompanyingPeriod' => $accompanyingPeriod], - ['startDate' => 'DESC'] + ['startDate' => 'DESC'], + $paginator->getItemsPerPage(), + $paginator->getCurrentPageFirstItemNumber() ); $view = '@ChillCalendar/Calendar/listByAccompanyingCourse.html.twig'; - } - return $this->render($view, [ - 'calendarItems' => $calendarItems, - 'user' => $user, - 'accompanyingCourse' => $accompanyingPeriod, - ]); + return $this->render($view, [ + 'calendarItems' => $calendarItems, + 'accompanyingCourse' => $accompanyingPeriod, + 'paginator' => $paginator + ]); + } } /** diff --git a/src/Bundle/ChillCalendarBundle/Repository/CalendarRepository.php b/src/Bundle/ChillCalendarBundle/Repository/CalendarRepository.php index edb51bb35..b87f4f525 100644 --- a/src/Bundle/ChillCalendarBundle/Repository/CalendarRepository.php +++ b/src/Bundle/ChillCalendarBundle/Repository/CalendarRepository.php @@ -3,7 +3,9 @@ namespace Chill\CalendarBundle\Repository; use Chill\CalendarBundle\Entity\Calendar; +use Chill\PersonBundle\Entity\AccompanyingPeriod; use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository; +use Doctrine\ORM\EntityRepository; use Doctrine\Persistence\ManagerRegistry; /** @@ -14,9 +16,13 @@ use Doctrine\Persistence\ManagerRegistry; */ class CalendarRepository extends ServiceEntityRepository { + + // private EntityRepository $repository; + public function __construct(ManagerRegistry $registry) { parent::__construct($registry, Calendar::class); + // $this->repository = $entityManager->getRepository(AccompanyingPeriodWork::class); } // /** diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/list.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/list.html.twig deleted file mode 100644 index 44295e192..000000000 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/list.html.twig +++ /dev/null @@ -1,135 +0,0 @@ -{% set user_id = null %} -{% if user %} - {% set user_id = user.id %} -{% endif %} - -{% set accompanying_course_id = null %} -{% if accompanyingCourse %} - {% set accompanying_course_id = accompanyingCourse.id %} -{% endif %} - -{% if context == 'user' %} -

      {{ 'My calendar list' |trans }}

      -{% else %} -

      {{ 'Calendar list' |trans }}

      -{% endif %} - -{% if context == 'user' %} -
      -{% else %} - - {% if calendarItems|length == 0 %} -

      - {{ "There is no calendar items."|trans }} - -

      - {% else %} - -
      - - {% for calendar in calendarItems %} - -
      -
      -
      - - - {% if calendar.startDate and calendar.endDate %} - {% if calendar.endDate.diff(calendar.startDate).days >= 1 %} -

      {{ "From the day"|trans }} {{ calendar.startDate|format_datetime('medium', 'short') }}

      -

      {{ "to the day"|trans }} {{ calendar.endDate|format_datetime('medium', 'short') }}

      - {% else %} -

      {{ calendar.startDate|format_date('full') }}

      -

      {{ calendar.startDate|format_datetime('none', 'short', locale='fr') }} - {{ calendar.endDate|format_datetime('none', 'short', locale='fr') }}

      - -
      -

      - - {{ calendar.endDate.diff(calendar.startDate)|date("%H:%M")}} -

      -
      - {% endif %} - - {% endif %} - - -
      -
      -
        - {% if calendar.user %} -
      • - {{ 'by'|trans }}{{ calendar.user.usernameCanonical }} -
        • - {% endif %} - - {% if calendar.mainUser is not empty %} -
      • - {{ 'main user concerned'|trans }}: {{ calendar.mainUser.usernameCanonical }} -
        • - {% endif %} - -
      -
        -
      • - -
        • - {# TOOD - {% if is_granted('CHILL_ACTIVITY_UPDATE', calendar) %} - #} -
      • - -
        • - {# TOOD - {% endif %} - {% if is_granted('CHILL_ACTIVITY_DELETE', calendar) %} - #} -
      • - -
        • - {# - {% endif %} - #} -
      -
      -
      - - {% - if calendar.comment.comment is not empty - or calendar.users|length > 0 - or calendar.thirdParties|length > 0 - or calendar.users|length > 0 - %} -
      -
      - - {% include 'ChillActivityBundle:Activity:concernedGroups.html.twig' with {'context': context, 'with_display': 'row', 'entity': calendar } %} -
      - - {% if calendar.comment.comment is not empty %} -
      - {{ calendar.comment|chill_entity_render_box( { 'limit_lines': 3, 'metadata': false } ) }} -
      - {% endif %} -
      - {% endif %} - -
      - {% endfor %} -
      - {% endif %} - - {% if context != 'user' %} - {# TODO set this condition in configuration #} - - {% endif %} - - - -{% endif %} - diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig index c0230344d..1ade76a26 100644 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig +++ b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig @@ -4,6 +4,123 @@ {% block title %}{{ 'Calendar list' |trans }}{% endblock title %} +{% set user_id = null %} +{% set accompanying_course_id = accompanyingCourse.id %} + {% block content %} - {% include 'ChillCalendarBundle:Calendar:list.html.twig' with {'context': 'accompanyingCourse'} %} -{% endblock %} + +

      {{ 'Calendar list' |trans }}

      + +{% if calendarItems|length == 0 %} +

      + {{ "There is no calendar items."|trans }} + +

      +{% else %} + +
      + + {% for calendar in calendarItems %} + +
      +
      +
      + + {% if calendar.startDate and calendar.endDate %} + {% if calendar.endDate.diff(calendar.startDate).days >= 1 %} +

      {{ "From the day"|trans }} {{ calendar.startDate|format_datetime('medium', 'short') }}

      +

      {{ "to the day"|trans }} {{ calendar.endDate|format_datetime('medium', 'short') }}

      + {% else %} +

      {{ calendar.startDate|format_date('full') }}

      +

      {{ calendar.startDate|format_datetime('none', 'short', locale='fr') }} - {{ calendar.endDate|format_datetime('none', 'short', locale='fr') }}

      + +
      +

      + + {{ calendar.endDate.diff(calendar.startDate)|date("%H:%M")}} +

      +
      + {% endif %} + + {% endif %} + +
      +
      +
        + {% if calendar.user %} +
      • + {{ 'by'|trans }}{{ calendar.user.usernameCanonical }} +
        • + {% endif %} + + {% if calendar.mainUser is not empty %} +
      • + {{ 'main user concerned'|trans }}: {{ calendar.mainUser.usernameCanonical }} +
        • + {% endif %} + +
      +
        +
      • + +
        • + {# TOOD + {% if is_granted('CHILL_ACTIVITY_UPDATE', calendar) %} + #} +
      • + +
        • + {# TOOD + {% endif %} + {% if is_granted('CHILL_ACTIVITY_DELETE', calendar) %} + #} +
      • + +
        • + {# + {% endif %} + #} +
      +
      +
      + + {% + if calendar.comment.comment is not empty + or calendar.users|length > 0 + or calendar.thirdParties|length > 0 + or calendar.users|length > 0 + %} +
      +
      + + {% include 'ChillActivityBundle:Activity:concernedGroups.html.twig' with {'context': accompanyingCourse, 'with_display': 'row', 'entity': calendar } %} +
      + + {% if calendar.comment.comment is not empty %} +
      + {{ calendar.comment|chill_entity_render_box( { 'limit_lines': 3, 'metadata': false } ) }} +
      + {% endif %} +
      + {% endif %} + +
      + {% endfor %} + + {% if calendarItems|length < paginator.getTotalItems %} + {{ chill_pagination(paginator) }} + {% endif %} + +
      +{% endif %} + + + + +{% endblock %} \ No newline at end of file diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig index 004000fc6..6171a0026 100644 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig +++ b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig @@ -5,7 +5,10 @@ {% block title %}{{ 'My calendar list' |trans }}{% endblock title %} {% block content %} - {% include 'ChillCalendarBundle:Calendar:list.html.twig' with {'context': 'user'} %} + +

      {{ 'My calendar list' |trans }}

      +
      + {% endblock %} {% block js %} From 5b81bffcf6c1336d00f62669e30a41b81be52f42 Mon Sep 17 00:00:00 2001 From: nobohan Date: Fri, 17 Sep 2021 16:33:11 +0200 Subject: [PATCH 30/37] rdv: twig - headings change --- .../Resources/views/Calendar/listByAccompanyingCourse.html.twig | 2 +- .../Resources/views/Calendar/listByUser.html.twig | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig index 1ade76a26..07aed8686 100644 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig +++ b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByAccompanyingCourse.html.twig @@ -9,7 +9,7 @@ {% block content %} -

      {{ 'Calendar list' |trans }}

      +

      {{ 'Calendar list' |trans }}

      {% if calendarItems|length == 0 %}

      diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig index 6171a0026..055d967a7 100644 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig +++ b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/listByUser.html.twig @@ -6,7 +6,7 @@ {% block content %} -

      {{ 'My calendar list' |trans }}

      +

      {{ 'My calendar list' |trans }}

      {% endblock %} From 3385cb2ddab707369d2fa8ffd6c8009344059955 Mon Sep 17 00:00:00 2001 From: nobohan Date: Mon, 20 Sep 2021 13:38:49 +0200 Subject: [PATCH 31/37] rdv: rename twig view file --- .../ChillCalendarBundle/Controller/CalendarController.php | 2 +- ...anyingCourse.html.twig => newByAccompanyingCourse.html.twig} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename src/Bundle/ChillCalendarBundle/Resources/views/Calendar/{newAccompanyingCourse.html.twig => newByAccompanyingCourse.html.twig} (100%) diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index e7226b1bd..467c8eed2 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -130,7 +130,7 @@ class CalendarController extends AbstractController [$user, $accompanyingPeriod] = $this->getEntity($request); if ($accompanyingPeriod instanceof AccompanyingPeriod) { - $view = '@ChillCalendar/Calendar/newAccompanyingCourse.html.twig'; + $view = '@ChillCalendar/Calendar/newByAccompanyingCourse.html.twig'; } // elseif ($user instanceof User) { // $view = '@ChillCalendar/Calendar/newUser.html.twig'; diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/newAccompanyingCourse.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/newByAccompanyingCourse.html.twig similarity index 100% rename from src/Bundle/ChillCalendarBundle/Resources/views/Calendar/newAccompanyingCourse.html.twig rename to src/Bundle/ChillCalendarBundle/Resources/views/Calendar/newByAccompanyingCourse.html.twig From e8d8a57b4b7a7357dcbc86aa209044d0ab8a6bcf Mon Sep 17 00:00:00 2001 From: nobohan Date: Mon, 20 Sep 2021 15:23:54 +0200 Subject: [PATCH 32/37] rdv: rdv -> activity: pass calendar data to new activity controller --- .../Controller/ActivityController.php | 18 +++++++++++++++++ .../views/Activity/selectType.html.twig | 7 ++++++- .../Controller/CalendarController.php | 20 ++++++++++++++++++- .../Resources/views/Calendar/show.html.twig | 12 +++++++++-- .../translations/messages.fr.yml | 3 ++- 5 files changed, 55 insertions(+), 5 deletions(-) diff --git a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php index 0988eedfe..2ede8737f 100644 --- a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php +++ b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php @@ -139,6 +139,12 @@ class ActivityController extends AbstractController ]; } + if ($request->query->has('activityData')) { + $activityData = $request->query->get('activityData'); + } else { + $activityData = []; + } + if ($view === null) { throw $this->createNotFoundException('Template not found'); } @@ -147,6 +153,7 @@ class ActivityController extends AbstractController 'person' => $person, 'accompanyingCourse' => $accompanyingPeriod, 'data' => $data, + 'activityData' => $activityData ]); } @@ -166,10 +173,21 @@ class ActivityController extends AbstractController $activityType = $em->getRepository(\Chill\ActivityBundle\Entity\ActivityType::class) ->find($activityType_id); + + if ($request->query->has('activityData')) { + $activityData = $request->query->get('activityData'); + dump($activityData); + } + if (!$activityType instanceof \Chill\ActivityBundle\Entity\ActivityType || !$activityType->isActive()) { $params = $this->buildParamsToUrl($person, $accompanyingPeriod); + + if (NULL !== $activityData) { + $params['activityData'] = $activityData; + } + return $this->redirectToRoute('chill_activity_activity_select_type', $params); } diff --git a/src/Bundle/ChillActivityBundle/Resources/views/Activity/selectType.html.twig b/src/Bundle/ChillActivityBundle/Resources/views/Activity/selectType.html.twig index 996d95b0f..4120d8285 100644 --- a/src/Bundle/ChillActivityBundle/Resources/views/Activity/selectType.html.twig +++ b/src/Bundle/ChillActivityBundle/Resources/views/Activity/selectType.html.twig @@ -18,7 +18,12 @@ {% set accompanying_course_id = accompanyingCourse.id %} {% endif %} - +
      {{ activityType.name|localize_translatable_string }} diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index 467c8eed2..103887d36 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -215,10 +215,28 @@ class CalendarController extends AbstractController throw $this->createNotFoundException('Template not found'); } + $personsId = []; + foreach ($entity->getPersons() as $p) { + array_push($personsId, $p->getId()); + } + + $professionalsId = []; + foreach ($entity->getProfessionals() as $p) { + array_push($professionalsId, $p->getId()); + } + + $activityData = [ + 'personsId' => $personsId, + 'professionalsId' => $professionalsId, + 'date' => $entity->getStartDate()->format('Y-m-d'), + 'durationTime' => $entity->getEndDate()->diff($entity->getStartDate())->format("%H:%M") + ]; + return $this->render($view, [ 'accompanyingCourse' => $accompanyingPeriod, 'entity' => $entity, - 'user' => $user + 'user' => $user, + 'activityData' => $activityData //'delete_form' => $deleteForm->createView(), ]); } diff --git a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/show.html.twig b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/show.html.twig index 971abe67d..e8830a33d 100644 --- a/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/show.html.twig +++ b/src/Bundle/ChillCalendarBundle/Resources/views/Calendar/show.html.twig @@ -65,13 +65,21 @@
      • - + {{ 'Back to the list'|trans }}
        • +
      • + + {{ 'Transform to activity'|trans }} + +
        • {% if accompanyingCourse %}
      • - + {{ 'Edit'|trans }}
        • diff --git a/src/Bundle/ChillCalendarBundle/translations/messages.fr.yml b/src/Bundle/ChillCalendarBundle/translations/messages.fr.yml index 0eb7349a4..562233546 100644 --- a/src/Bundle/ChillCalendarBundle/translations/messages.fr.yml +++ b/src/Bundle/ChillCalendarBundle/translations/messages.fr.yml @@ -23,4 +23,5 @@ Add a new calendar: Ajouter un nouveau rendez-vous "Success : calendar item created!": "Rendez-vous créé" The calendar item has been successfully removed.: Le rendez-vous a été supprimé From the day: Du -to the day: au \ No newline at end of file +to the day: au +Transform to activity: Transformer en échange \ No newline at end of file From 17036e83ba3ac68fd9376d8ff1ef15437cbd22af Mon Sep 17 00:00:00 2001 From: nobohan Date: Mon, 20 Sep 2021 17:02:24 +0200 Subject: [PATCH 33/37] rdv: rdv-> activity: convert some fields --- .../Controller/ActivityController.php | 29 +++++++++++++++++++ .../Controller/CalendarController.php | 5 +++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php index 2ede8737f..6d9d61355 100644 --- a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php +++ b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php @@ -205,6 +205,35 @@ class ActivityController extends AbstractController $entity->setType($activityType); $entity->setDate(new \DateTime('now')); + if ($request->query->has('activityData')) { + $activityData = $request->query->get('activityData'); + + $durationTimeInMinutes = $activityData['durationTime']; + $hours = floor($durationTimeInMinutes / 60); + $minutes = $durationTimeInMinutes % 60; + + $duration = \DateTime::createFromFormat("H:i", $hours.':'.$minutes); + if ($duration) { + $entity->setDurationTime($duration); + } + + $date = \DateTime::createFromFormat('Y-m-d', $activityData['date']); + if ($date) { + $entity->setDate($date); + } + + foreach($activityData['personsId'] as $personId){ + $person = $em->getRepository(\Chill\PersonBundle\Entity\Person::class)->find($personId); + $entity->addPerson($person); + } + + foreach($activityData['professionalsId'] as $professionalsId){ + $professional = $em->getRepository(\Chill\ThirdPartyBundle\Entity\ThirdParty::class)->find($professionalsId); + $entity->addThirdParty($professional); + } + + } + // TODO revoir le Voter de Activity pour tenir compte qu'une activité peut appartenir a une période // $this->denyAccessUnlessGranted('CHILL_ACTIVITY_CREATE', $entity); diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index 103887d36..0513e933c 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -225,11 +225,14 @@ class CalendarController extends AbstractController array_push($professionalsId, $p->getId()); } + $durationTime = $entity->getEndDate()->diff($entity->getStartDate()); + $durationTimeInMinutes = $durationTime->days*1440 + $durationTime->h*60 + $durationTime->i; + $activityData = [ 'personsId' => $personsId, 'professionalsId' => $professionalsId, 'date' => $entity->getStartDate()->format('Y-m-d'), - 'durationTime' => $entity->getEndDate()->diff($entity->getStartDate())->format("%H:%M") + 'durationTime' => $durationTimeInMinutes ]; return $this->render($view, [ From c6bbe46baebbf743521eb54b62202e2096c89c1e Mon Sep 17 00:00:00 2001 From: nobohan Date: Tue, 21 Sep 2021 09:46:09 +0200 Subject: [PATCH 34/37] rdv: rdv -> activity: fix some bugs (duplicate person var name, case keys are missing) --- .../Controller/ActivityController.php | 47 ++++++++++--------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php index 6d9d61355..beaff22d4 100644 --- a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php +++ b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php @@ -173,10 +173,9 @@ class ActivityController extends AbstractController $activityType = $em->getRepository(\Chill\ActivityBundle\Entity\ActivityType::class) ->find($activityType_id); - + $activityData = null; if ($request->query->has('activityData')) { $activityData = $request->query->get('activityData'); - dump($activityData); } if (!$activityType instanceof \Chill\ActivityBundle\Entity\ActivityType || @@ -184,10 +183,9 @@ class ActivityController extends AbstractController $params = $this->buildParamsToUrl($person, $accompanyingPeriod); - if (NULL !== $activityData) { + if (null !== $activityData) { $params['activityData'] = $activityData; } - return $this->redirectToRoute('chill_activity_activity_select_type', $params); } @@ -208,30 +206,36 @@ class ActivityController extends AbstractController if ($request->query->has('activityData')) { $activityData = $request->query->get('activityData'); - $durationTimeInMinutes = $activityData['durationTime']; - $hours = floor($durationTimeInMinutes / 60); - $minutes = $durationTimeInMinutes % 60; - - $duration = \DateTime::createFromFormat("H:i", $hours.':'.$minutes); - if ($duration) { - $entity->setDurationTime($duration); + if (array_key_exists('durationTime', $activityData)) { + $durationTimeInMinutes = $activityData['durationTime']; + $hours = floor($durationTimeInMinutes / 60); + $minutes = $durationTimeInMinutes % 60; + $duration = \DateTime::createFromFormat("H:i", $hours.':'.$minutes); + if ($duration) { + $entity->setDurationTime($duration); + } } - $date = \DateTime::createFromFormat('Y-m-d', $activityData['date']); - if ($date) { - $entity->setDate($date); + if (array_key_exists('date', $activityData)) { + $date = \DateTime::createFromFormat('Y-m-d', $activityData['date']); + if ($date) { + $entity->setDate($date); + } } - foreach($activityData['personsId'] as $personId){ - $person = $em->getRepository(\Chill\PersonBundle\Entity\Person::class)->find($personId); - $entity->addPerson($person); + if (array_key_exists('personsId', $activityData)) { + foreach($activityData['personsId'] as $personId){ + $concernedPerson = $em->getRepository(\Chill\PersonBundle\Entity\Person::class)->find($personId); + $entity->addPerson($concernedPerson); + } } - foreach($activityData['professionalsId'] as $professionalsId){ - $professional = $em->getRepository(\Chill\ThirdPartyBundle\Entity\ThirdParty::class)->find($professionalsId); - $entity->addThirdParty($professional); + if (array_key_exists('professionalsId', $activityData)) { + foreach($activityData['professionalsId'] as $professionalsId){ + $professional = $em->getRepository(\Chill\ThirdPartyBundle\Entity\ThirdParty::class)->find($professionalsId); + $entity->addThirdParty($professional); + } } - } // TODO revoir le Voter de Activity pour tenir compte qu'une activité peut appartenir a une période @@ -251,6 +255,7 @@ class ActivityController extends AbstractController $this->addFlash('success', $this->get('translator')->trans('Success : activity created!')); $params = $this->buildParamsToUrl($person, $accompanyingPeriod); + $params['id'] = $entity->getId(); return $this->redirectToRoute('chill_activity_activity_show', $params); From 99f2692684ad05898e52366c5d8d32122c25d6ba Mon Sep 17 00:00:00 2001 From: nobohan Date: Tue, 21 Sep 2021 10:06:06 +0200 Subject: [PATCH 35/37] activity: correction of displaying activity when durationTime or travelTime is null --- .../Resources/views/Activity/list.html.twig | 2 +- .../Resources/views/Activity/show.html.twig | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/Bundle/ChillActivityBundle/Resources/views/Activity/list.html.twig b/src/Bundle/ChillActivityBundle/Resources/views/Activity/list.html.twig index 07b59c7e7..c227f5539 100644 --- a/src/Bundle/ChillActivityBundle/Resources/views/Activity/list.html.twig +++ b/src/Bundle/ChillActivityBundle/Resources/views/Activity/list.html.twig @@ -19,7 +19,7 @@ {% endif %}
        - {% if t.durationTimeVisible > 0 %} + {% if activity.durationTime and t.durationTimeVisible %}

        {{ activity.durationTime|date('H:i') }} diff --git a/src/Bundle/ChillActivityBundle/Resources/views/Activity/show.html.twig b/src/Bundle/ChillActivityBundle/Resources/views/Activity/show.html.twig index 81ebddc05..1f54692d9 100644 --- a/src/Bundle/ChillActivityBundle/Resources/views/Activity/show.html.twig +++ b/src/Bundle/ChillActivityBundle/Resources/views/Activity/show.html.twig @@ -64,12 +64,22 @@ {% if t.durationTimeVisible %}

        {{ 'Duration Time'|trans }}
        -
        {{ entity.durationTime|date('H:i') }}
        +
        {% if entity.durationTime is not null %} + {{ entity.durationTime|date('H:i') }} + {% else %} + {{ 'None'|trans|capitalize }} + {% endif %} +
        {% endif %} {% if t.travelTimeVisible %}
        {{ 'Travel Time'|trans }}
        -
        {{ entity.travelTime|date('H:i') }}
        +
        {% if entity.travelTime is not null %} + {{ entity.travelTime|date('H:i') }} + {% else %} + {{ 'None'|trans|capitalize }} + {% endif %} +
        {% endif %} {% if t.commentVisible %} From 1a6c37e5a6cbd37f740107a7453ee2c0d6a90b90 Mon Sep 17 00:00:00 2001 From: nobohan Date: Tue, 21 Sep 2021 15:44:45 +0200 Subject: [PATCH 36/37] rdv->activity: create event for storing the linked activity to a calendar --- .../Controller/CalendarController.php | 1 + .../ChillCalendarExtension.php | 1 + .../Event/ListenToActivityCreate.php | 40 +++++++++++++++++++ .../Resources/config/services/event.yml | 10 +++++ 4 files changed, 52 insertions(+) create mode 100644 src/Bundle/ChillCalendarBundle/Event/ListenToActivityCreate.php create mode 100644 src/Bundle/ChillCalendarBundle/Resources/config/services/event.yml diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index 0513e933c..c87f7ebd1 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -229,6 +229,7 @@ class CalendarController extends AbstractController $durationTimeInMinutes = $durationTime->days*1440 + $durationTime->h*60 + $durationTime->i; $activityData = [ + 'calendarId' => $id, 'personsId' => $personsId, 'professionalsId' => $professionalsId, 'date' => $entity->getStartDate()->format('Y-m-d'), diff --git a/src/Bundle/ChillCalendarBundle/DependencyInjection/ChillCalendarExtension.php b/src/Bundle/ChillCalendarBundle/DependencyInjection/ChillCalendarExtension.php index 8660fac52..eaa8a1416 100644 --- a/src/Bundle/ChillCalendarBundle/DependencyInjection/ChillCalendarExtension.php +++ b/src/Bundle/ChillCalendarBundle/DependencyInjection/ChillCalendarExtension.php @@ -29,6 +29,7 @@ class ChillCalendarExtension extends Extension implements PrependExtensionInterf $loader->load('services/controller.yml'); $loader->load('services/fixtures.yml'); $loader->load('services/form.yml'); + $loader->load('services/event.yml'); } public function prepend(ContainerBuilder $container) diff --git a/src/Bundle/ChillCalendarBundle/Event/ListenToActivityCreate.php b/src/Bundle/ChillCalendarBundle/Event/ListenToActivityCreate.php new file mode 100644 index 000000000..76a47015d --- /dev/null +++ b/src/Bundle/ChillCalendarBundle/Event/ListenToActivityCreate.php @@ -0,0 +1,40 @@ +requestStack = $requestStack; + } + + public function postPersist(Activity $activity, LifecycleEventArgs $event): void + { + // Get the calendarId from the request + $request = $this->requestStack->getCurrentRequest(); + if ($request->query->has('activityData')) { + $activityData = $request->query->get('activityData'); + if (array_key_exists('calendarId', $activityData)) { + $calendarId = $activityData['calendarId']; + } + } + + // Attach the activity to the calendar + $em = $event->getObjectManager(); + + $calendar = $em->getRepository(\Chill\CalendarBundle\Entity\Calendar::class)->find($calendarId); + $calendar->setActivity($activity); + + $em->persist($calendar); + $em->flush(); + + } +} \ No newline at end of file diff --git a/src/Bundle/ChillCalendarBundle/Resources/config/services/event.yml b/src/Bundle/ChillCalendarBundle/Resources/config/services/event.yml new file mode 100644 index 000000000..348677174 --- /dev/null +++ b/src/Bundle/ChillCalendarBundle/Resources/config/services/event.yml @@ -0,0 +1,10 @@ +services: + Chill\CalendarBundle\Event\ListenToActivityCreate: + autowire: true + autoconfigure: true + tags: + - + name: 'doctrine.orm.entity_listener' + event: 'postPersist' + entity: 'Chill\ActivityBundle\Entity\Activity' + \ No newline at end of file From d172ae96826dd3ea0c485ecdfe71ec6d56604201 Mon Sep 17 00:00:00 2001 From: nobohan Date: Tue, 21 Sep 2021 16:48:43 +0200 Subject: [PATCH 37/37] rdv -> activity: add comment --- .../Controller/ActivityController.php | 10 ++++++++++ .../Controller/CalendarController.php | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php index beaff22d4..a454626b7 100644 --- a/src/Bundle/ChillActivityBundle/Controller/ActivityController.php +++ b/src/Bundle/ChillActivityBundle/Controller/ActivityController.php @@ -39,6 +39,7 @@ use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Security\Core\Role\Role; use Chill\ActivityBundle\Entity\Activity; use Chill\ActivityBundle\Form\ActivityType; +use Chill\MainBundle\Entity\Embeddable\CommentEmbeddable; use Symfony\Component\Serializer\SerializerInterface; /** @@ -236,6 +237,15 @@ class ActivityController extends AbstractController $entity->addThirdParty($professional); } } + + if (array_key_exists('comment', $activityData)) { + $comment = new CommentEmbeddable(); + $comment->setComment($activityData['comment']); + $comment->setUserId($this->getUser()->getid()); + $comment->setDate(new \DateTime('now')); + $entity->setComment($comment); + } + } // TODO revoir le Voter de Activity pour tenir compte qu'une activité peut appartenir a une période diff --git a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php index c87f7ebd1..71e461464 100644 --- a/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php +++ b/src/Bundle/ChillCalendarBundle/Controller/CalendarController.php @@ -233,7 +233,8 @@ class CalendarController extends AbstractController 'personsId' => $personsId, 'professionalsId' => $professionalsId, 'date' => $entity->getStartDate()->format('Y-m-d'), - 'durationTime' => $durationTimeInMinutes + 'durationTime' => $durationTimeInMinutes, + 'comment' => $entity->getComment()->getComment(), ]; return $this->render($view, [