Improved the LocationGuesser API to be usable for relations as well

Two ItemFactory instances are exposed, depending on the need:
- $siteItemFactory: locations and aliases are within the current site root only
- $relatedItemFactory: locations and aliases can be in other public siteaccesses / site roots

src/GraphQL/Resolver/LocationGuesser/AllAllowedLocationProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser;
+
+use eZ\Publish\API\Repository\LocationService;
+use eZ\Publish\API\Repository\Values\Content\Content;
+
+/**
+ * Returns all the locations the current user has access to.
+ */
+class AllAllowedLocationProvider implements LocationProvider
+{
+    /**
+     * @var \eZ\Publish\API\Repository\LocationService
+     */
+    private $locationService;
+
+    public function __construct(LocationService $locationService)
+    {
+        $this->locationService = $locationService;
+    }
+
+    public function getLocations(Content $content): LocationList
+    {
+        $list = new LocationList($content);
+
+        foreach ($this->locationService->loadLocations($content->contentInfo) as $location) {
+            $list->addLocation($location);
+        }
+
+        return $list;
+    }
+}

src/GraphQL/Resolver/LocationGuesser/CurrentSiteLocationProvider.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser;
+
+use eZ\Publish\API\Repository\SearchService;
+use eZ\Publish\API\Repository\Values\Content\Content;
+use eZ\Publish\API\Repository\Values\Content\LocationQuery;
+use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
+use EzSystems\EzPlatformGraphQL\GraphQL\InputMapper\ContentCollectionFilterBuilder;
+
+/**
+ * Returns the locations from the current site (e.g. within its tree root).
+ */
+class CurrentSiteLocationProvider implements LocationProvider
+{
+    /**
+     * @var \eZ\Publish\API\Repository\SearchService
+     */
+    private $searchService;
+    /**
+     * @var \EzSystems\EzPlatformGraphQL\GraphQL\InputMapper\ContentCollectionFilterBuilder
+     */
+    private $filterBuilder;
+
+    public function __construct(SearchService $searchService, ContentCollectionFilterBuilder $filterBuilder)
+    {
+        $this->searchService = $searchService;
+        $this->filterBuilder = $filterBuilder;
+    }
+
+    public function getLocations(Content $content): LocationList
+    {
+        $query = new LocationQuery([
+            'filter' => new Criterion\LogicalAnd([
+                $this->filterBuilder->buildFilter(),
+                new Criterion\ContentId($content->id),
+            ]),
+        ]);
+
+        $list = new LocationList($content);
+        foreach ($this->searchService->findLocations($query)->searchHits as $searchHit) {
+            $list->addLocation($searchHit->valueObject);
+        }
+
+        return $list;
+    }
+}

src/GraphQL/Resolver/LocationGuesser/FilterLocationGuesser.php

@@ -4,14 +4,14 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser;
 
-use eZ\Publish\API\Repository\LocationService;
 use eZ\Publish\API\Repository\Values\Content\Content;
-use eZ\Publish\API\Repository\Values\Content\Location;
 
 /**
- * Guesses a location based on voters.
+ * Guesses locations for a site by filtering out a provided list.
  */
 class FilterLocationGuesser implements LocationGuesser
 {
@@ -21,33 +21,29 @@ class FilterLocationGuesser implements LocationGuesser
     private $filters;
 
     /**
-     * @var \eZ\Publish\API\Repository\LocationService
+     * @var \EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationProvider
      */
-    private $locationService;
+    private $provider;
 
-    /**
-     * @param LocationFilter[] $filters
-     */
-    public function __construct(LocationService $locationService, array $filters)
+    public function __construct(LocationProvider $provider, array $filters)
     {
+        $this->provider = $provider;
         $this->filters = $filters;
-        $this->locationService = $locationService;
     }
 
     /**
      * {@inheritdoc}
      */
     public function guessLocation(Content $content): LocationGuess
     {
-        $locationList = new LocationList($content);
-        foreach ($this->locationService->loadLocations($content->contentInfo) as $location) {
-            $locationList->addLocation($location);
-        }
-
-        foreach ($this->filters as $filter) {
-            $filter->filter($content, $locationList);
-            if ($locationList->hasOneLocation()) {
-                return new LocationGuess($content, $locationList->getLocations());
+        $locationList = $this->provider->getLocations($content);
+
+        if (!$locationList->hasOneLocation()) {
+            foreach ($this->filters as $filter) {
+                $filter->filter($content, $locationList);
+                if ($locationList->hasOneLocation()) {
+                    return new LocationGuess($content, $locationList->getLocations());
+                }
             }
         }
 

src/GraphQL/Resolver/LocationGuesser/LocationGuesser.php

@@ -7,7 +7,6 @@
 namespace EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser;
 
 use eZ\Publish\API\Repository\Values\Content\Content;
-use eZ\Publish\API\Repository\Values\Content\Location;
 
 interface LocationGuesser
 {

src/GraphQL/Resolver/LocationGuesser/LocationList.php

@@ -56,6 +56,9 @@ public function getLocation(): Location
         }
     }
 
+    /**
+     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
+     */
     public function getLocations(): array
     {
         return \iterator_to_array($this->locations);

src/GraphQL/Resolver/LocationGuesser/LocationProvider.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser;
+
+use eZ\Publish\API\Repository\Values\Content\Content;
+
+interface LocationProvider
+{
+    public function getLocations(Content $content): LocationList;
+}

src/GraphQL/Resolver/RelationFieldResolver.php

@@ -21,10 +21,10 @@ final class RelationFieldResolver
     /** @var \EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory */
     private $itemFactory;
 
-    public function __construct(ContentLoader $contentLoader, ItemFactory $itemFactory)
+    public function __construct(ContentLoader $contentLoader, ItemFactory $relatedContentItemFactory)
     {
         $this->contentLoader = $contentLoader;
-        $this->itemFactory = $itemFactory;
+        $this->itemFactory = $relatedContentItemFactory;
     }
 
     public function resolveRelationFieldValue(Field $field, $multiple = false)
@@ -35,8 +35,6 @@ public function resolveRelationFieldValue(Field $field, $multiple = false)
             return $multiple ? [] : null;
         }
 
-        // @todo do we want to restrict results to the current siteaccess (tree root) ?
-        //       What if the user has access to locations from other siteaccesses ?
         $contentItems = $this->contentLoader->find(new Query(
             ['filter' => new Query\Criterion\ContentId($destinationContentIds)]
         ));

src/GraphQL/Value/Item.php

@@ -11,8 +11,10 @@
 use eZ\Publish\API\Repository\Values\Content\Location;
 use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
 use eZ\Publish\Core\MVC\Symfony\SiteAccess;
+use EzSystems\EzPlatformGraphQL\Exception\NoValidLocationsException;
 use EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser;
 use EzSystems\EzPlatformGraphQL\GraphQL\Resolver\SiteaccessGuesser\SiteaccessGuesser;
+use Overblog\GraphQLBundle\Error\UserError;
 
 /**
  * A DXP item, combination of a Content and Location.
@@ -57,7 +59,11 @@ public function getContent(): Content
     public function getLocation(): Location
     {
         if ($this->location === null) {
-            $this->location = $this->locationGuesser->guessLocation($this->content)->getLocation();
+            try {
+                $this->location = $this->locationGuesser->guessLocation($this->content)->getLocation();
+            } catch (NoValidLocationsException $e) {
+                throw new UserError($e->getMessage(), 0, $e);
+            }
         }
 
         return $this->location;

src/Resources/config/services/location_guesser.yaml

@@ -8,10 +8,20 @@ services:
 
     EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\MainLocationFilter: ~
 
-    EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser:
-        class: 'EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\FilterLocationGuesser'
+    EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\CurrentSiteLocationProvider: ~
+
+    EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\AllAllowedLocationProvider: ~
+
+    EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser\CurrentSiteContent:
+        class: EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\FilterLocationGuesser
         arguments:
+            $provider: '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\CurrentSiteLocationProvider'
             $filters:
-                - '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\TreeRootLocationFilter'
                 - '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\MainLocationFilter'
 
+    EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser\RelatedContent:
+        class: EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\FilterLocationGuesser
+        arguments:
+            $provider: '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\AllAllowedLocationProvider'
+            $filters:
+                - '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\MainLocationFilter'

src/Resources/config/services/services.yaml

@@ -17,7 +17,19 @@ services:
         arguments:
             $siteAccessGroups: '%ezpublish.siteaccess.groups%'
 
-    EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory: ~
+    EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory $currentSiteItemFactory: '@EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory\CurrentSite'
+
+    EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory $relatedContentItemFactory: '@EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory\RelatedContent'
+
+    EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory\CurrentSite:
+        class: 'EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory'
+        arguments:
+            $locationGuesser: '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser\CurrentSiteContent'
+
+    EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory\RelatedContent:
+        class: 'EzSystems\EzPlatformGraphQL\GraphQL\ItemFactory'
+        arguments:
+            $locationGuesser: '@EzSystems\EzPlatformGraphQL\GraphQL\Resolver\LocationGuesser\LocationGuesser\RelatedContent'
 
     EzSystems\EzPlatformGraphQL\GraphQL\Resolver\SiteaccessGuesser\SiteaccessGuesser:
         arguments: