[GDPR Data Extractor] DataobjectProvider and Asset Provider

config/gdpr.yaml

@@ -25,3 +25,16 @@ services:
         tags: ["pimcore.studio_backend.gdpr_data_provider"]
         arguments:
             $logsDir: "%kernel.logs_dir%"
+
+    Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\DataObjectProvider:
+        tags: ["pimcore.studio_backend.gdpr_data_provider"]
+
+    Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\AssetsProvider:
+        tags: ["pimcore.studio_backend.gdpr_data_provider"]
+
+    # --- Legacy Code from the admin-ui-classic-bundle ---
+    Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\Legacy\ObjectExporterInterface:
+        class: Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\Legacy\ObjectExporter
+
+    Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\Legacy\AssetExporterInterface:
+        class: Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\Legacy\AssetExporter

src/Gdpr/Attribute/Request/GdprRequestBody.php

@@ -18,6 +18,7 @@
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\RequestBody;
+use Pimcore\Bundle\StudioBackendBundle\Filter\Attribute\Property\FilterProperty;
 
 /**
  * @internal
@@ -49,6 +50,8 @@ public function __construct()
                         description: 'The object containing the search values.',
                         type: 'object'
                     ),
+
+                    new FilterProperty(),
                 ],
                 type: 'object',
             ),

src/Gdpr/Attribute/Request/SearchTerms.php

@@ -29,21 +29,41 @@
 final readonly class SearchTerms
 {
     public function __construct(
-        #[Property(description: 'The ID to search for.', type: 'string', nullable: true)]
-        #[Type('string')]
-        public ?string $id = null,
+        #[Property(
+            description: 'The ID to search for.',
+            type: 'int',
+            nullable: true,
+            example: 3
+        )]
+        #[Type('int')]
+        private ?int $id = null,
 
-        #[Property(description: 'The first name to search for.', type: 'string', nullable: true)]
+        #[Property(
+            description: 'The first name to search for.',
+            type: 'string',
+            nullable: true,
+            example: 'John'
+        )]
         #[Type('string')]
-        public ?string $firstname = null,
+        private ?string $firstname = null,
 
-        #[Property(description: 'The last name to search for.', type: 'string', nullable: true)]
+        #[Property(
+            description: 'The last name to search for.',
+            type: 'string',
+            nullable: true,
+            example: 'Doe'
+        )]
         #[Type('string')]
-        public ?string $lastname = null,
+        private ?string $lastname = null,
 
-        #[Property(description: 'The email address to search for.', type: 'string', nullable: true)]
+        #[Property(
+            description: 'The email address to search for.',
+            type: 'string',
+            nullable: true,
+            example: '[email protected]'
+        )]
         #[Type('string')]
-        public ?string $email = null,
+        private ?string $email = null,
     ) {
         if ($this->id === null &&
             $this->firstname === null &&
@@ -54,7 +74,7 @@ public function __construct(
         }
     }
 
-    public function getId(): ?string
+    public function getId(): ?int
     {
         return $this->id;
     }

src/Gdpr/Controller/ExportController.php

@@ -25,7 +25,7 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
-use Symfony\Component\HttpFoundation\StreamedResponse;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
@@ -81,7 +81,7 @@ public function __construct(
     public function startExport(
         int $id,
         #[MapQueryParameter] string $providerKey
-    ): StreamedResponse {
-        return $this->gdprManagerService->getExportDataAsJson($id, $providerKey);
+    ): Response {
+        return $this->gdprManagerService->getExportData($id, $providerKey);
     }
 }

src/Gdpr/Controller/SearchDataProviderController.php

@@ -17,7 +17,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Gdpr\Attribute\Request\GdprRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Gdpr\MappedParameter\GdprStructuredSearchRequest;
+use Pimcore\Bundle\StudioBackendBundle\Gdpr\MappedParameter\GdprStructuredSearchParameters;
 use Pimcore\Bundle\StudioBackendBundle\Gdpr\Schema\GdprSearchResultProperty;
 use Pimcore\Bundle\StudioBackendBundle\Gdpr\Service\GdprManagerServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\Content\CollectionJson;
@@ -26,6 +26,7 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
+use Pimcore\Bundle\StudioBackendBundle\Util\Trait\PaginatedResponseTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
@@ -37,6 +38,8 @@
  */
 final class SearchDataProviderController extends AbstractApiController
 {
+    use PaginatedResponseTrait;
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly GdprManagerServiceInterface $gdprManagerService,
@@ -77,11 +80,15 @@ public function __construct(
         HttpResponseCodes::UNPROCESSABLE_CONTENT,
     ])]
     public function searchData(
-        #[MapRequestPayload] GdprStructuredSearchRequest $request
+        #[MapRequestPayload] GdprStructuredSearchParameters $request
     ): JsonResponse {
 
         $collection = $this->gdprManagerService->search($request);
 
-        return $this->jsonResponse($collection);
+        return $this->getPaginatedCollection(
+            $this->serializer,
+            $collection->getItems(),
+            $collection->getTotalItems()
+        );
     }
 }

src/Gdpr/MappedParameter/GdprStructuredSearchRequest.php → src/Gdpr/MappedParameter/GdprStructuredSearchParameters.php

@@ -13,6 +13,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Gdpr\MappedParameter;
 
+use Pimcore\Bundle\StudioBackendBundle\Filter\MappedParameter\FilterParameter;
 use Pimcore\Bundle\StudioBackendBundle\Gdpr\Attribute\Request\SearchTerms;
 use Symfony\Component\Validator\Constraints\All;
 use Symfony\Component\Validator\Constraints\NotBlank;
@@ -23,19 +24,40 @@
 /**
  * @internal
  */
-final readonly class GdprStructuredSearchRequest
+final readonly class GdprStructuredSearchParameters
 {
     /**
      * @param string[] $providers
      */
     public function __construct(
         #[NotBlank]
         #[All(new Type('string'))]
-        public array $providers,
+        private readonly array $providers,
 
         #[Valid]
         #[NotNull]
-        public SearchTerms $searchTerms
+        private readonly SearchTerms $searchTerms,
+
+        #[Valid]
+        private readonly FilterParameter $filters
     ) {
     }
+
+    /**
+     * @return string[]
+     */
+    public function getProviders(): array
+    {
+        return $this->providers;
+    }
+
+    public function getSearchTerms(): SearchTerms
+    {
+        return $this->searchTerms;
+    }
+
+    public function getFilters(): FilterParameter
+    {
+        return $this->filters;
+    }
 }

src/Gdpr/Provider/AssetsProvider.php

@@ -0,0 +1,165 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\Search\SortDirection;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Provider\AssetQueryProviderInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Query\QueryInterface;
+use Pimcore\Bundle\StudioBackendBundle\DataIndex\Service\AssetSearchServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\Filter\MappedParameter\FilterParameter;
+use Pimcore\Bundle\StudioBackendBundle\Gdpr\Attribute\Request\SearchTerms;
+use Pimcore\Bundle\StudioBackendBundle\Gdpr\Provider\Legacy\AssetExporterInterface;
+use Pimcore\Bundle\StudioBackendBundle\Gdpr\Schema\GdprDataColumn;
+use Pimcore\Bundle\StudioBackendBundle\Gdpr\Schema\GdprDataRow;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
+use Pimcore\Model\Asset;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @internal
+ */
+final readonly class AssetsProvider implements DataProviderInterface
+{
+    public function __construct(
+        private AssetQueryProviderInterface $query,
+        private AssetSearchServiceInterface $searchService,
+        private AssetExporterInterface $assetExporter
+    ) {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function findData(SearchTerms $terms, FilterParameter $options): array
+    {
+        $query = $this->query->createAssetQuery();
+
+        $query->excludeFolders();
+
+        if ($terms->getId() !== null) {
+            $query->filterInteger('id', $terms->getId());
+        }
+
+        $texts = [
+            $terms->getFirstname(),
+            $terms->getLastname(),
+            $terms->getEmail(),
+        ];
+
+        foreach ($texts as $value) {
+            $value = trim((string)$value);
+            if ($value !== '') {
+                $query->filterFullText($value);
+            }
+        }
+
+        $this->applySearchOptions($query, $options);
+
+        $searchResult = $this->searchService->searchAssets($query);
+
+        $columns = $this->getAvailableColumns();
+
+        $items   = $searchResult->getItems();
+
+        $rows = array_map(
+            fn ($item) => new GdprDataRow([
+                'type' => $item->getType(),
+                'id' => $item->getId(),
+                'fullPath' => $item->getFullPath(),
+                'subType' => $item->getMimeType(),
+            ], $columns),
+            $items
+        );
+
+        return [
+                'totalSubItems' => $searchResult->getTotalItems(),
+                'rows'          => $rows,
+            ];
+    }
+
+    private function applySearchOptions(QueryInterface $query, FilterParameter $options): void
+    {
+        $query->setPage($options->getPage());
+        $query->setPageSize($options->getPageSize());
+
+        $sortFilter = $options->getSortFilter();
+
+        if ($sortFilter->getKey() && $sortFilter->getDirection()) {
+            $directionEnum = strtolower($sortFilter->getDirection()) === SortDirection::DESC->value
+                ? SortDirection::DESC
+                : SortDirection::ASC;
+
+            $query->orderByField($sortFilter->getKey(), $directionEnum);
+        }
+
+    }
+
+    public function getDeleteSwaggerOperationId(): string
+    {
+        return 'pimcore_studio_api_assets_batch_delete';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSingleItemForDownload(int $id): Response
+    {
+        try {
+            $asset = Asset::getById((int)$id);
+
+        } catch (NotFoundException) {
+            throw new NotFoundException('Asset Not Found', $id);
+        }
+
+        return $this->assetExporter->doExportData($asset);
+
+    }
+
+    public function getName(): string
+    {
+        return 'Assets';
+    }
+
+    public function getKey(): string
+    {
+        return 'assets';
+    }
+
+    public function getSortPriority(): int
+    {
+        return 8;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredPermissions(): array
+    {
+        return [UserPermissions::ASSETS->value];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAvailableColumns(): array
+    {
+        return [
+            new GdprDataColumn('type', 'Type'),
+            new GdprDataColumn('id', 'ID'),
+            new GdprDataColumn('fullPath', 'Full Path'),
+            new GdprDataColumn('subType', 'Type'),
+        ];
+    }
+}