From 4bcf0c514215b4b4d6517dabc07c3125af4d8707 Mon Sep 17 00:00:00 2001
From: Jakub Brzegowski <symfiz@gmail.com>
Date: Thu, 16 May 2024 09:21:26 +0200
Subject: [PATCH] IBX-7653: IsContainer criterion added (#333)

---
 .sonarcloud.properties                        |  2 +-
 .../Content/Query/Criterion/IsContainer.php   | 32 +++++++++
 .../Content/IsContainerQueryBuilder.php       | 52 ++++++++++++++
 .../legacy/criterion_handlers_common.yml      |  6 ++
 .../Gateway/CriterionHandler/IsContainer.php  | 56 +++++++++++++++
 .../BaseRepositoryFilteringTestCase.php       |  2 +
 .../Core/Repository/SearchServiceTest.php     | 16 +++++
 .../_fixtures/Legacy/IsContainerFalse.php     | 59 ++++++++++++++++
 .../_fixtures/Legacy/IsContainerTrue.php      | 69 +++++++++++++++++++
 9 files changed, 293 insertions(+), 1 deletion(-)
 create mode 100644 src/contracts/Repository/Values/Content/Query/Criterion/IsContainer.php
 create mode 100644 src/lib/Persistence/Legacy/Filter/CriterionQueryBuilder/Content/IsContainerQueryBuilder.php
 create mode 100644 src/lib/Search/Legacy/Content/Common/Gateway/CriterionHandler/IsContainer.php
 create mode 100644 tests/integration/Core/Repository/_fixtures/Legacy/IsContainerFalse.php
 create mode 100644 tests/integration/Core/Repository/_fixtures/Legacy/IsContainerTrue.php

diff --git a/.sonarcloud.properties b/.sonarcloud.properties
index a6f00c520f..43ab56dedb 100644
--- a/.sonarcloud.properties
+++ b/.sonarcloud.properties
@@ -1 +1 @@
-sonar.exclusions=**/Tests/**/_fixtures/*
+sonar.exclusions=tests/**/_fixtures/**/*
diff --git a/src/contracts/Repository/Values/Content/Query/Criterion/IsContainer.php b/src/contracts/Repository/Values/Content/Query/Criterion/IsContainer.php
new file mode 100644
index 0000000000..4a01a3a20a
--- /dev/null
+++ b/src/contracts/Repository/Values/Content/Query/Criterion/IsContainer.php
@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Operator\Specifications;
+use Ibexa\Contracts\Core\Repository\Values\Filter\FilteringCriterion;
+
+final class IsContainer extends Criterion implements FilteringCriterion
+{
+    public function __construct(bool $value = true)
+    {
+        parent::__construct(null, null, $value);
+    }
+
+    public function getSpecifications(): array
+    {
+        return [
+            new Specifications(
+                Operator::EQ,
+                Specifications::FORMAT_SINGLE,
+                Specifications::TYPE_BOOLEAN
+            ),
+        ];
+    }
+}
diff --git a/src/lib/Persistence/Legacy/Filter/CriterionQueryBuilder/Content/IsContainerQueryBuilder.php b/src/lib/Persistence/Legacy/Filter/CriterionQueryBuilder/Content/IsContainerQueryBuilder.php
new file mode 100644
index 0000000000..fc4161230f
--- /dev/null
+++ b/src/lib/Persistence/Legacy/Filter/CriterionQueryBuilder/Content/IsContainerQueryBuilder.php
@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Core\Persistence\Legacy\Filter\CriterionQueryBuilder\Content;
+
+use Doctrine\DBAL\ParameterType;
+use Ibexa\Contracts\Core\Persistence\Filter\Doctrine\FilteringQueryBuilder;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\IsContainer;
+use Ibexa\Contracts\Core\Repository\Values\Filter\CriterionQueryBuilder;
+use Ibexa\Contracts\Core\Repository\Values\Filter\FilteringCriterion;
+use Ibexa\Core\Persistence\Legacy\Content\Type\Gateway;
+
+/**
+ * @internal for internal use by Repository Filtering
+ */
+final class IsContainerQueryBuilder implements CriterionQueryBuilder
+{
+    public function accepts(FilteringCriterion $criterion): bool
+    {
+        return $criterion instanceof IsContainer;
+    }
+
+    /**
+     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\IsContainer $criterion
+     */
+    public function buildQueryConstraint(
+        FilteringQueryBuilder $queryBuilder,
+        FilteringCriterion $criterion
+    ): ?string {
+        $queryBuilder
+            ->joinOnce(
+                'content',
+                Gateway::CONTENT_TYPE_TABLE,
+                'content_type',
+                'content.contentclass_id = content_type.id',
+            );
+
+        /** @var array{bool} $criterionValue */
+        $criterionValue = $criterion->value;
+        $isContainer = reset($criterionValue);
+
+        return $queryBuilder->expr()->in(
+            'content_type.is_container',
+            $queryBuilder->createNamedParameter((int)$isContainer, ParameterType::INTEGER)
+        );
+    }
+}
diff --git a/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_common.yml b/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_common.yml
index e62b350481..2b5edd76c0 100644
--- a/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_common.yml
+++ b/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_common.yml
@@ -144,6 +144,12 @@ services:
             - {name: ibexa.search.legacy.gateway.criterion_handler.content}
             - {name: ibexa.search.legacy.gateway.criterion_handler.location}
 
+    Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\IsContainer:
+        parent: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler
+        tags:
+            - {name: ibexa.search.legacy.gateway.criterion_handler.content}
+            - {name: ibexa.search.legacy.gateway.criterion_handler.location}
+
     Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\LanguageCode:
         class: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\LanguageCode
         parent: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler
diff --git a/src/lib/Search/Legacy/Content/Common/Gateway/CriterionHandler/IsContainer.php b/src/lib/Search/Legacy/Content/Common/Gateway/CriterionHandler/IsContainer.php
new file mode 100644
index 0000000000..80189c186e
--- /dev/null
+++ b/src/lib/Search/Legacy/Content/Common/Gateway/CriterionHandler/IsContainer.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler;
+
+use Doctrine\DBAL\ParameterType;
+use Doctrine\DBAL\Query\QueryBuilder;
+use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Ibexa\Core\Persistence\Legacy\Content\Type\Gateway as ContentTypeGateway;
+use Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;
+use Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler;
+
+final class IsContainer extends CriterionHandler
+{
+    public function accept(Criterion $criterion): bool
+    {
+        return $criterion instanceof Criterion\IsContainer;
+    }
+
+    /**
+     * @phpstan-param array{languages: string[]} $languageSettings
+     */
+    public function handle(
+        CriteriaConverter $converter,
+        QueryBuilder $queryBuilder,
+        Criterion $criterion,
+        array $languageSettings
+    ) {
+        /** @var array{bool} $criterionValue */
+        $criterionValue = $criterion->value;
+        $isContainer = reset($criterionValue);
+
+        $subSelect = $this->connection->createQueryBuilder();
+        $subSelect
+            ->select(
+                'id'
+            )->from(
+                ContentTypeGateway::CONTENT_TYPE_TABLE
+            )->where(
+                $queryBuilder->expr()->eq(
+                    'is_container',
+                    $queryBuilder->createNamedParameter((int)$isContainer, ParameterType::INTEGER)
+                )
+            );
+
+        return $queryBuilder->expr()->in(
+            'c.contentclass_id',
+            $subSelect->getSQL()
+        );
+    }
+}
diff --git a/tests/integration/Core/Repository/Filtering/BaseRepositoryFilteringTestCase.php b/tests/integration/Core/Repository/Filtering/BaseRepositoryFilteringTestCase.php
index 9807765353..6118035a9a 100644
--- a/tests/integration/Core/Repository/Filtering/BaseRepositoryFilteringTestCase.php
+++ b/tests/integration/Core/Repository/Filtering/BaseRepositoryFilteringTestCase.php
@@ -239,6 +239,8 @@ public function getCriteriaForInitialData(): iterable
             Criterion\Operator::BETWEEN,
             [1080220197, 1448889046]
         );
+        yield 'IsContainer=true' => new Criterion\IsContainer(true);
+        yield 'IsContainer=false' => new Criterion\IsContainer(false);
         yield 'IsUserBased=true' => new Criterion\IsUserBased(true);
         yield 'IsUserBased=false' => new Criterion\IsUserBased(false);
         yield 'IsUserEnabled=true' => new Criterion\IsUserEnabled();
diff --git a/tests/integration/Core/Repository/SearchServiceTest.php b/tests/integration/Core/Repository/SearchServiceTest.php
index a2175606e2..87f59cc671 100644
--- a/tests/integration/Core/Repository/SearchServiceTest.php
+++ b/tests/integration/Core/Repository/SearchServiceTest.php
@@ -682,6 +682,22 @@ public function getContentQuerySearches()
                 ],
                 $fixtureDir . 'Visibility.php',
             ],
+            [
+                [
+                    'query' => new Criterion\IsContainer(true),
+                    'sortClauses' => [new SortClause\ContentId()],
+                    'limit' => 5,
+                ],
+                $fixtureDir . 'IsContainerTrue.php',
+            ],
+            [
+                [
+                    'query' => new Criterion\IsContainer(false),
+                    'sortClauses' => [new SortClause\ContentId()],
+                    'limit' => 5,
+                ],
+                $fixtureDir . 'IsContainerFalse.php',
+            ],
             [
                 [
                     'query' => new Criterion\IsUserEnabled(true),
diff --git a/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerFalse.php b/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerFalse.php
new file mode 100644
index 0000000000..f2645e6790
--- /dev/null
+++ b/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerFalse.php
@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult;
+
+return new SearchResult([
+    'facets' => [],
+    'searchHits' => [
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 10,
+                        'title' => 'Anonymous User',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 14,
+                        'title' => 'Administrator User',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 52,
+                        'title' => 'Common INI settings',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 54,
+                        'title' => 'Ibexa Demo Design (without demo content)',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+        ],
+    'spellSuggestion' => null,
+    'time' => 1,
+    'timedOut' => null,
+    'maxScore' => null,
+    'totalCount' => 4,
+]);
diff --git a/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerTrue.php b/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerTrue.php
new file mode 100644
index 0000000000..52f30b9826
--- /dev/null
+++ b/tests/integration/Core/Repository/_fixtures/Legacy/IsContainerTrue.php
@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit;
+use Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult;
+
+return new SearchResult([
+    'facets' => [],
+    'searchHits' => [
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 4,
+                        'title' => 'Users',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 11,
+                        'title' => 'Members',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 12,
+                        'title' => 'Administrator users',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 13,
+                        'title' => 'Editors',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+            new SearchHit([
+                'valueObject' => [
+                        'id' => 41,
+                        'title' => 'Media',
+                    ],
+                'score' => null,
+                'index' => null,
+                'highlight' => null,
+                'matchedTranslation' => 'eng-US',
+            ]),
+        ],
+    'spellSuggestion' => null,
+    'time' => 1,
+    'timedOut' => null,
+    'maxScore' => null,
+    'totalCount' => 14,
+]);