Dev

.github/workflows/ci.yml

@@ -73,6 +73,7 @@ jobs:
           export PHPLIST_DATABASE_PASSWORD=${{ env.DB_PASSWORD }}
           export PHPLIST_DATABASE_PORT=${{ job.services.mysql.ports['3306'] }}
           export PHPLIST_DATABASE_HOST=127.0.0.1
+          export PHPLIST_DATABASE_PATH=
           vendor/bin/phpunit tests/Integration/
         continue-on-error: ${{matrix.php-versions == '8.0' }} # [temp-php8]
       - name: Running static analysis

.github/workflows/client-docs.yml

@@ -11,6 +11,7 @@ on:
 
 jobs:
   generate-openapi:
+    if: (github.event_name == 'push' && (github.ref_name == 'main' || github.ref_name == 'dev')) || (github.event_name == 'pull_request' && github.base_ref == 'main')
     runs-on: ubuntu-22.04
     outputs:
       source_branch: ${{ steps.branch.outputs.source_branch }}

.github/workflows/front-docs.yml

@@ -14,6 +14,7 @@ on:
       - main
 jobs:
   generate-openapi:
+    if: (github.event_name == 'push' && (github.ref_name == 'main' || github.ref_name == 'dev')) || (github.event_name == 'pull_request' && github.base_ref == 'main')
     runs-on: ubuntu-22.04
     outputs:
       source_branch: ${{ steps.branch.outputs.source_branch }}

.gitignore

@@ -15,3 +15,5 @@
 /var/
 /vendor/
 .phpunit.result.cache
+.env
+.env.dist

composer.json

@@ -42,7 +42,8 @@
     },
     "require": {
         "php": "^8.1",
-        "phplist/core": "dev-main",
+        "phplist/core": "dev-dev",
+        "elasticsearch/elasticsearch": "^8.9",
         "friendsofsymfony/rest-bundle": "*",
         "symfony/test-pack": "^1.0",
         "symfony/process": "^6.4",
@@ -57,7 +58,7 @@
         "phpunit/phpunit": "^10.0",
         "guzzlehttp/guzzle": "^7.2.0",
         "squizlabs/php_codesniffer": "^3.2.0",
-        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan": "^2.2",
         "nette/caching": "^3.0.0",
         "nikic/php-parser": "^4.19.1",
         "phpmd/phpmd": "^2.6.0",
@@ -85,6 +86,7 @@
             "PhpList\\Core\\Composer\\ScriptHandler::createGeneralConfiguration",
             "PhpList\\Core\\Composer\\ScriptHandler::createBundleConfiguration",
             "PhpList\\Core\\Composer\\ScriptHandler::createRoutesConfiguration",
+            "PhpList\\Core\\Composer\\ScriptHandler::createDotenvConfiguration",
             "PhpList\\Core\\Composer\\ScriptHandler::createParametersConfiguration",
             "PhpList\\Core\\Composer\\ScriptHandler::clearAllCaches"
         ],
@@ -114,27 +116,32 @@
                 "rest-api-identity": {
                     "resource": "@PhpListRestBundle/Identity/Controller/",
                     "type": "attribute",
-                    "prefix": "/api/v2"
+                    "prefix": "/api/v2",
+                    "name_prefix": "api_"
                 },
                 "rest-api-subscription": {
                     "resource": "@PhpListRestBundle/Subscription/Controller/",
                     "type": "attribute",
-                    "prefix": "/api/v2"
+                    "prefix": "/api/v2",
+                    "name_prefix": "api_"
                 },
                 "rest-api-messaging": {
                     "resource": "@PhpListRestBundle/Messaging/Controller/",
                     "type": "attribute",
-                    "prefix": "/api/v2"
+                    "prefix": "/api/v2",
+                    "name_prefix": "api_"
                 },
                 "rest-api-configuration": {
                     "resource": "@PhpListRestBundle/Configuration/Controller/",
                     "type": "attribute",
-                    "prefix": "/api/v2"
+                    "prefix": "/api/v2",
+                    "name_prefix": "api_"
                 },
                 "rest-api-analitics": {
                     "resource": "@PhpListRestBundle/Statistics/Controller/",
                     "type": "attribute",
-                    "prefix": "/api/v2"
+                    "prefix": "/api/v2",
+                    "name_prefix": "api_"
                 }
             }
         }

config/services.yml

@@ -12,7 +12,7 @@ services:
         calls:
             - ['registerHandler', [ 'json', ['@my.secure_handler', 'createResponse'] ] ]
 
-    PhpList\Core\Security\Authentication:
+    PhpList\Core\Domain\Identity\Service\Authentication:
         autowire: true
         autoconfigure: true
 

config/services/messenger_handlers.yml

@@ -1,10 +1,10 @@
 services:
-    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\CampaignProcessorMessageHandler:
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessorMessageHandler:
         autowire: true
         autoconfigure: true
         public: false
 
-    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessor\TestCampaignProcessorMessageHandler:
+    PhpList\Core\Domain\Messaging\MessageHandler\CampaignProcessorTestMessageHandler:
         autowire: true
         autoconfigure: true
         public: false

config/services/validators.yml

@@ -3,6 +3,7 @@ services:
     arguments:
       $serializer: '@phplist.request_serializer'
       $validator: '@validator'
+      $nameConverter: '@Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter'
 
   PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmailValidator:
     autowire: true

phpunit.xml.dist

@@ -5,10 +5,11 @@
          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.2/phpunit.xsd"
          backupGlobals="false"
          colors="true"
-         bootstrap="vendor/autoload.php"
+         bootstrap="tests/bootstrap.php"
 >
     <php>
         <ini name="error_reporting" value="-1"/>
         <server name="KERNEL_CLASS" value="PhpList\Core\Core\ApplicationKernel"/>
+        <server name="APP_ENV" value="test" force="true"/>
     </php>
 </phpunit>

src/Common/Controller/BaseController.php

@@ -5,13 +5,13 @@
 namespace PhpList\RestBundle\Common\Controller;
 
 use PhpList\Core\Domain\Identity\Model\Administrator;
-use PhpList\Core\Security\Authentication;
+use PhpList\Core\Domain\Identity\Service\Authentication;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
-/**  @SuppressWarnings(PHPMD.NumberOfChildren) */
+/**  @SuppressWarnings("PHPMD.NumberOfChildren") */
 abstract class BaseController extends AbstractController
 {
     protected Authentication $authentication;

src/Common/EventListener/ExceptionListener.php

@@ -9,7 +9,7 @@
 use PhpList\Core\Domain\Messaging\Exception\AttachmentFileNotFoundException;
 use PhpList\Core\Domain\Messaging\Exception\MessageNotReceivedException;
 use PhpList\Core\Domain\Messaging\Exception\SubscriberNotFoundException;
-use PhpList\Core\Domain\Subscription\Exception\AttributeDefinitionCreationException;
+use PhpList\Core\Domain\Common\Exception\AttributeDefinitionCreationException;
 use PhpList\Core\Domain\Subscription\Exception\SubscriptionCreationException;
 use PhpList\Core\Domain\Common\Exception\InvalidUploadException;
 use PhpList\Core\Domain\Common\Exception\MissingUploadException;
@@ -57,7 +57,7 @@ public function onKernelException(ExceptionEvent $event): void
                 new JsonResponse([
                     'message' => 'Validation failed',
                     'errors' => $this->parseFlatValidationMessage($exception->getMessage()),
-                    ], 422)
+                ], 422)
             );
 
             return;

src/Common/Serializer/CursorPaginationNormalizer.php

@@ -11,7 +11,7 @@ class CursorPaginationNormalizer implements NormalizerInterface
 {
     /**
      * @param CursorPaginationResult $object
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function normalize($object, string $format = null, array $context = []): array
     {
@@ -32,10 +32,20 @@ public function normalize($object, string $format = null, array $context = []):
     }
 
     /**
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function supportsNormalization($data, string $format = null): bool
     {
         return $data instanceof CursorPaginationResult;
     }
+
+    /**
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
+     */
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            CursorPaginationResult::class => true,
+        ];
+    }
 }

src/Common/Validator/RequestValidator.php

@@ -8,6 +8,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Throwable;
@@ -16,7 +17,8 @@ class RequestValidator
 {
     public function __construct(
         private readonly DenormalizerInterface $serializer,
-        private readonly ValidatorInterface $validator
+        private readonly ValidatorInterface $validator,
+        private readonly NameConverterInterface $nameConverter
     ) {
     }
 
@@ -66,7 +68,7 @@ public function validateDto(RequestInterface $request): RequestInterface
             foreach ($errors as $violation) {
                 $lines[] = sprintf(
                     '%s: %s',
-                    $violation->getPropertyPath(),
+                    $this->nameConverter->normalize($violation->getPropertyPath()),
                     $violation->getMessage()
                 );
             }

src/Configuration/Controller/ConfigController.php

@@ -9,8 +9,8 @@
 use PhpList\Core\Domain\Configuration\Exception\ConfigNotEditableException;
 use PhpList\Core\Domain\Configuration\Model\Config;
 use PhpList\Core\Domain\Configuration\Service\Manager\ConfigManager;
-use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
-use PhpList\Core\Security\Authentication;
+use PhpList\Core\Domain\Identity\Service\Authentication;
+use PhpList\Core\Domain\Identity\Service\PermissionChecker;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Configuration\Request\CreateConfigRequest;
@@ -31,6 +31,7 @@ public function __construct(
         private readonly ConfigManager $manager,
         private readonly ConfigNormalizer $normalizer,
         private readonly EntityManagerInterface $entityManager,
+        private readonly PermissionChecker $permissionChecker,
     ) {
         parent::__construct($authentication, $validator);
     }
@@ -76,7 +77,10 @@ public function __construct(
     )]
     public function list(Request $request): JsonResponse
     {
-        $this->denyUnlessSettingsAdmin($request, 'You are not allowed to view configuration.');
+        $admin = $this->requireAuthentication($request);
+        if (!$this->permissionChecker->canList($admin, Config::class)) {
+            throw $this->createAccessDeniedException('You are not allowed to view configuration.');
+        }
         $items = $this->manager->getAllEditable();
 
         usort(
@@ -148,10 +152,13 @@ public function getOne(
         Request $request,
         #[MapEntity(mapping: ['key' => 'key'])] ?Config $config,
     ): JsonResponse {
-        $this->denyUnlessSettingsAdmin($request, 'You are not allowed to view configuration.');
+        $admin = $this->requireAuthentication($request);
         if ($config === null) {
             throw $this->createNotFoundException('Configuration item not found.');
         }
+        if (!$this->permissionChecker->canView($admin, $config)) {
+            throw $this->createAccessDeniedException('You are not allowed to view configuration.');
+        }
 
         return $this->json($this->normalizer->normalize($config), Response::HTTP_OK);
     }
@@ -202,7 +209,10 @@ public function getOne(
     )]
     public function create(Request $request): JsonResponse
     {
-        $this->denyUnlessSettingsAdmin($request, 'You are not allowed to create configuration.');
+        $admin = $this->requireAuthentication($request);
+        if (!$this->permissionChecker->canCreate($admin, Config::class)) {
+            throw $this->createAccessDeniedException('You are not allowed to create configuration.');
+        }
         /* @var CreateConfigRequest $configRequest */
         $configRequest = $this->validator->validate($request, CreateConfigRequest::class);
 
@@ -267,10 +277,13 @@ public function update(
         Request $request,
         #[MapEntity(mapping: ['key' => 'key'])] ?Config $config = null
     ): JsonResponse {
-        $this->denyUnlessSettingsAdmin($request, 'You are not allowed to update configuration.');
+        $admin = $this->requireAuthentication($request);
         if ($config === null) {
             throw $this->createNotFoundException('Configuration item not found.');
         }
+        if (!$this->permissionChecker->canEdit($admin, $config)) {
+            throw $this->createAccessDeniedException('You are not allowed to update configuration.');
+        }
         /* @var UpdateConfigRequest $dto */
         $dto = $this->validator->validate($request, UpdateConfigRequest::class);
 
@@ -325,22 +338,17 @@ public function delete(
         Request $request,
         #[MapEntity(mapping: ['key' => 'key'])] ?Config $config = null
     ): JsonResponse {
-        $this->denyUnlessSettingsAdmin($request, 'You are not allowed to delete configuration.');
+        $admin = $this->requireAuthentication($request);
         if ($config === null) {
             throw $this->createNotFoundException('Configuration item not found.');
         }
+        if (!$this->permissionChecker->canDelete($admin, $config)) {
+            throw $this->createAccessDeniedException('You are not allowed to delete configuration.');
+        }
 
         $this->manager->delete($config);
         $this->entityManager->flush();
 
         return $this->json(null, Response::HTTP_NO_CONTENT);
     }
-
-    private function denyUnlessSettingsAdmin(Request $request, string $message): void
-    {
-        $admin = $this->requireAuthentication($request);
-        if (!$admin->getPrivileges()->has(PrivilegeFlag::Settings)) {
-            throw $this->createAccessDeniedException($message);
-        }
-    }
 }

src/Configuration/Serializer/ConfigNormalizer.php

@@ -23,7 +23,7 @@ class ConfigNormalizer implements NormalizerInterface
     /**
      * Normalizes a configuration item.
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function normalize($object, string $format = null, array $context = []): array
     {
@@ -42,10 +42,20 @@ public function normalize($object, string $format = null, array $context = []):
     /**
      * Checks whether the value can be normalized.
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function supportsNormalization($data, string $format = null): bool
     {
         return $data instanceof Config;
     }
+
+    /**
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
+     */
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            Config::class => true,
+        ];
+    }
 }

src/Identity/Controller/AdminAttributeDefinitionController.php

@@ -9,7 +9,7 @@
 use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Identity\Model\AdminAttributeDefinition;
 use PhpList\Core\Domain\Identity\Service\Manager\AdminAttributeDefinitionManager;
-use PhpList\Core\Security\Authentication;
+use PhpList\Core\Domain\Identity\Service\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Common\Validator\RequestValidator;

src/Identity/Controller/AdminAttributeValueController.php

@@ -11,7 +11,7 @@
 use PhpList\Core\Domain\Identity\Model\AdminAttributeDefinition;
 use PhpList\Core\Domain\Identity\Model\AdminAttributeValue;
 use PhpList\Core\Domain\Identity\Service\Manager\AdminAttributeManager;
-use PhpList\Core\Security\Authentication;
+use PhpList\Core\Domain\Identity\Service\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Common\Validator\RequestValidator;

src/Identity/Controller/AdministratorController.php

@@ -9,7 +9,7 @@
 use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Service\Manager\AdministratorManager;
-use PhpList\Core\Security\Authentication;
+use PhpList\Core\Domain\Identity\Service\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
@@ -257,7 +257,7 @@ public function updateAdministrator(
         /** @var UpdateAdministratorRequest $updateRequest */
         $updateRequest = $this->validator->validate(
             request: $request,
-            dtoClass:UpdateAdministratorRequest::class,
+            dtoClass: UpdateAdministratorRequest::class,
             beforeValidation: static function (UpdateAdministratorRequest $dto) use ($administrator): void {
                 $dto->setUpdatingId($administrator->getId());
             }