ISSUE-345: privileges, analytics (#149)

* ISSUE-345: admin privileges

* ISSUE-345: dev version

* ISSUE-345: check manage subscribers privilege

* ISSUE-345: check manage campaigns privilege

* ISSUE-345: analytics controller

* ISSUE-345: campaign stat normalizer

* ISSUE-345: view open stat normalizer

* ISSUE-345: return 400 on validation exception

* ISSUE-345: test fix

* ISSUE-345: make it more specific

* ISSUE-345: style fix

* ISSUE-345: refactor

* ISSUE-345: top domains stats

* ISSUE-345: top local parts stats

* ISSUE-345: style

* ISSUE-345: note

* ISSUE-345: do not publish fos

* ISSUE-345: AccessDeniedException

* ISSUE-345: version

* ISSUE-345: test fix

---------

Co-authored-by: Tatevik <tatevikg1@gmail.com>

Author: TatevikGr

composer.json

@@ -16,12 +16,17 @@
         {
             "name": "Xheni Myrtaj",
             "email": "xheni@phplist.com",
-            "role": "Maintainer"
+            "role": "Former developer"
         },
         {
             "name": "Oliver Klee",
             "email": "oliver@phplist.com",
             "role": "Former developer"
+        },
+        {
+            "name": "Tatevik Grigoryan",
+            "email": "tatevik@phplist.com",
+            "role": "Maintainer"
         }
     ],
     "support": {
@@ -31,7 +36,7 @@
     },
     "require": {
         "php": "^8.1",
-        "phplist/core": "v5.0.0-alpha7",
+        "phplist/core": "v5.0.0-alpha8",
         "friendsofsymfony/rest-bundle": "*",
         "symfony/test-pack": "^1.0",
         "symfony/process": "^6.4",
@@ -93,7 +98,6 @@
         "symfony-tests-dir": "tests",
         "phplist/core": {
             "bundles": [
-                "FOS\\RestBundle\\FOSRestBundle",
                 "PhpList\\RestBundle\\PhpListRestBundle"
             ],
             "routes": {
@@ -111,6 +115,11 @@
                     "resource": "@PhpListRestBundle/Messaging/Controller/",
                     "type": "attribute",
                     "prefix": "/api/v2"
+                },
+                "rest-api-analitics": {
+                    "resource": "@PhpListRestBundle/Statistics/Controller/",
+                    "type": "attribute",
+                    "prefix": "/api/v2"
                 }
             }
         }

config/services/controllers.yml

@@ -24,3 +24,10 @@ services:
     autowire: true
     autoconfigure: true
     public: true
+
+  PhpList\RestBundle\Statistics\Controller\:
+    resource: '../src/Statistics/Controller'
+    tags: [ 'controller.service_arguments' ]
+    autowire: true
+    autoconfigure: true
+    public: true

config/services/managers.yml

@@ -39,3 +39,16 @@ services:
   PhpList\Core\Domain\Subscription\Service\SubscriberCsvExporter:
     autowire: true
     autoconfigure: true
+
+  PhpList\Core\Domain\Analytics\Service\Manager\LinkTrackManager:
+    autowire: true
+    autoconfigure: true
+
+  PhpList\Core\Domain\Analytics\Service\Manager\UserMessageViewManager:
+    autowire: true
+    autoconfigure: true
+
+  PhpList\Core\Domain\Analytics\Service\AnalyticsService:
+    autowire: true
+    autoconfigure: true
+

config/services/normalizers.yml

@@ -69,3 +69,19 @@ services:
   PhpList\RestBundle\Subscription\Serializer\SubscribersExportRequestNormalizer:
     tags: [ 'serializer.normalizer' ]
     autowire: true
+
+  PhpList\RestBundle\Statistics\Serializer\CampaignStatisticsNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true
+
+  PhpList\RestBundle\Statistics\Serializer\ViewOpensStatisticsNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true
+
+  PhpList\RestBundle\Statistics\Serializer\TopDomainsNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true
+
+  PhpList\RestBundle\Statistics\Serializer\TopLocalPartsNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true

config/services/providers.yml

@@ -7,3 +7,7 @@ services:
   PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider:
     autowire: true
     autoconfigure: true
+
+  PhpList\RestBundle\Messaging\Service\CampaignService:
+    autowire: true
+    autoconfigure: true

src/Common/Controller/BaseController.php

@@ -11,6 +11,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 
+/**  @SuppressWarnings(PHPMD.NumberOfChildren) */
 abstract class BaseController extends AbstractController
 {
     protected Authentication $authentication;

src/Common/EventListener/ExceptionListener.php

@@ -5,11 +5,14 @@
 namespace PhpList\RestBundle\Common\EventListener;
 
 use Exception;
+use PhpList\Core\Domain\Identity\Exception\AdminAttributeCreationException;
 use PhpList\Core\Domain\Subscription\Exception\SubscriptionCreationException;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+use Symfony\Component\Validator\Exception\ValidatorException;
 
 class ExceptionListener
 {
@@ -34,6 +37,21 @@ public function onKernelException(ExceptionEvent $event): void
                 'message' => $exception->getMessage(),
             ], $exception->getStatusCode());
             $event->setResponse($response);
+        } elseif ($exception instanceof AdminAttributeCreationException) {
+            $response = new JsonResponse([
+                'message' => $exception->getMessage(),
+            ], $exception->getStatusCode());
+            $event->setResponse($response);
+        } elseif ($exception instanceof ValidatorException) {
+            $response = new JsonResponse([
+                'message' => $exception->getMessage(),
+            ], 400);
+            $event->setResponse($response);
+        } elseif ($exception instanceof AccessDeniedException) {
+            $response = new JsonResponse([
+                'message' => $exception->getMessage(),
+            ], 403);
+            $event->setResponse($response);
         } elseif ($exception instanceof Exception) {
             $response = new JsonResponse([
                 'message' => $exception->getMessage(),

src/Identity/OpenApi/SwaggerSchemasRequest.php

@@ -36,6 +36,18 @@
             type: 'boolean',
             example: false
         ),
+        new OA\Property(
+            property: 'privileges',
+            description: 'Array of privileges where keys are privilege names and values are booleans',
+            properties: [
+                new OA\Property(property: 'subscribers', type: 'boolean', example: true),
+                new OA\Property(property: 'campaigns', type: 'boolean', example: false),
+                new OA\Property(property: 'statistics', type: 'boolean', example: true),
+                new OA\Property(property: 'settings', type: 'boolean', example: false),
+            ],
+            type: 'object',
+            example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+        ),
     ],
     type: 'object'
 )]
@@ -68,6 +80,18 @@
             type: 'boolean',
             example: false
         ),
+        new OA\Property(
+            property: 'privileges',
+            description: 'Array of privileges where keys are privilege names and values are booleans',
+            properties: [
+                new OA\Property(property: 'subscribers', type: 'boolean', example: true),
+                new OA\Property(property: 'campaigns', type: 'boolean', example: false),
+                new OA\Property(property: 'statistics', type: 'boolean', example: true),
+                new OA\Property(property: 'settings', type: 'boolean', example: false),
+            ],
+            type: 'object',
+            example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+        ),
     ],
     type: 'object'
 )]

src/Identity/Request/CreateAdministratorRequest.php

@@ -6,6 +6,7 @@
 
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Model\Dto\CreateAdministratorDto;
+use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
 use PhpList\RestBundle\Common\Request\RequestInterface;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmail;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueLoginName;
@@ -31,13 +32,26 @@ class CreateAdministratorRequest implements RequestInterface
     #[Assert\Type('bool')]
     public bool $superUser = false;
 
+    /**
+     * Array of privileges where keys are privilege names (from PrivilegeFlag enum) and values are booleans.
+     * Example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+     */
+    #[Assert\Type('array')]
+    #[Assert\All([
+        'constraints' => [
+            new Assert\Type(['type' => 'bool']),
+        ],
+    ])]
+    public array $privileges = [];
+
     public function getDto(): CreateAdministratorDto
     {
         return new CreateAdministratorDto(
-            $this->loginName,
-            $this->password,
-            $this->email,
-            $this->superUser
+            loginName: $this->loginName,
+            password: $this->password,
+            email: $this->email,
+            isSuperUser: $this->superUser,
+            privileges: $this->privileges
         );
     }
 }

src/Identity/Request/UpdateAdministratorRequest.php

@@ -6,6 +6,7 @@
 
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Model\Dto\UpdateAdministratorDto;
+use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
 use PhpList\RestBundle\Common\Request\RequestInterface;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueEmail;
 use PhpList\RestBundle\Identity\Validator\Constraint\UniqueLoginName;
@@ -29,6 +30,18 @@ class UpdateAdministratorRequest implements RequestInterface
     #[Assert\Type('bool')]
     public ?bool $superAdmin = null;
 
+    /**
+     * Array of privileges where keys are privilege names (from PrivilegeFlag enum) and values are booleans.
+     * Example: ['subscribers' => true, 'campaigns' => false, 'statistics' => true, 'settings' => false]
+     */
+    #[Assert\Type('array')]
+    #[Assert\All([
+        'constraints' => [
+            new Assert\Type(['type' => 'bool']),
+        ],
+    ])]
+    public array $privileges = [];
+
     public function getDto(): UpdateAdministratorDto
     {
         return new UpdateAdministratorDto(
@@ -37,6 +50,7 @@ public function getDto(): UpdateAdministratorDto
             password: $this->password,
             email: $this->email,
             superAdmin: $this->superAdmin,
+            privileges: $this->privileges
         );
     }
 }