[6.x] Multisite globals selection

src/Data/HasOrigin.php

@@ -12,35 +12,57 @@ trait HasOrigin
     protected $origin;
     private $cachedKeys;
 
-    public function keys()
+    public function keys(array $visited = [])
     {
-        if ($this->cachedKeys) {
+        if (empty($visited) && $this->cachedKeys) {
             return $this->cachedKeys;
         }
 
+        $key = $this->originVisitKey();
+
+        if (in_array($key, $visited, true)) {
+            return collect();
+        }
+
+        $visited[] = $key;
+
         $originFallbackKeys = method_exists($this, 'getOriginFallbackValues') ? $this->getOriginFallbackValues()->keys() : collect();
 
-        $originKeys = $this->hasOrigin() ? $this->origin()->keys() : collect();
+        $originKeys = $this->hasOrigin() ? $this->origin()->keys($visited) : collect();
 
         $computedKeys = method_exists($this, 'computedKeys') ? $this->computedKeys() : [];
 
-        return $this->cachedKeys = collect()
+        $keys = collect()
             ->merge($originFallbackKeys)
             ->merge($originKeys)
             ->merge($this->data->keys())
             ->merge($computedKeys);
+
+        if (count($visited) === 1) {
+            $this->cachedKeys = $keys;
+        }
+
+        return $keys;
     }
 
     public function values()
     {
         return $this->getValues(false);
     }
 
-    public function getValues($wrapComputed)
+    public function getValues($wrapComputed, array $visited = [])
     {
+        $key = $this->originVisitKey();
+
+        if (in_array($key, $visited, true)) {
+            return collect();
+        }
+
+        $visited[] = $key;
+
         $originFallbackValues = method_exists($this, 'getOriginFallbackValues') ? $this->getOriginFallbackValues() : collect();
 
-        $originValues = $this->hasOrigin() ? $this->origin()->values() : collect();
+        $originValues = $this->hasOrigin() ? $this->origin()->getValues($wrapComputed, $visited) : collect();
 
         $computedData = method_exists($this, 'getComputedData') ? $this->getComputedData($wrapComputed) : [];
 
@@ -51,11 +73,19 @@ public function getValues($wrapComputed)
             ->merge($computedData);
     }
 
-    public function value($key)
+    public function value($key, array $visited = [])
     {
+        $visitKey = $this->originVisitKey();
+
+        if (in_array($visitKey, $visited, true)) {
+            return null;
+        }
+
+        $visited[] = $visitKey;
+
         $originFallbackValue = method_exists($this, 'getOriginFallbackValue') ? $this->getOriginFallbackValue($key) : null;
 
-        $originValue = $this->hasOrigin() ? $this->origin()->value($key) : $originFallbackValue;
+        $originValue = $this->hasOrigin() ? $this->origin()->value($key, $visited) : $originFallbackValue;
 
         $value = $this->has($key) ? $this->get($key) : $originValue;
 
@@ -111,14 +141,60 @@ public function isRoot()
         return ! $this->hasOrigin();
     }
 
+    public function hasOriginCycle(): bool
+    {
+        $seen = [];
+        $entry = $this;
+
+        while ($entry->hasOrigin()) {
+            $key = $entry->originVisitKey();
+
+            if (isset($seen[$key])) {
+                return true;
+            }
+
+            $seen[$key] = true;
+
+            $entry = $entry->origin();
+
+            if (! $entry) {
+                break;
+            }
+        }
+
+        return false;
+    }
+
     public function root()
     {
         $entry = $this;
+        $seen = [];
 
         while ($entry->hasOrigin()) {
+            $key = $entry->originVisitKey();
+
+            if (isset($seen[$key])) {
+                break;
+            }
+
+            $seen[$key] = true;
+
             $entry = $entry->origin();
         }
 
         return $entry;
     }
+
+    protected function originVisitKey()
+    {
+        if (method_exists($this, 'id')) {
+            $id = $this->id();
+
+            if ($id !== null) {
+                return $id;
+            }
+        }
+
+        return 'object:'.spl_object_id($this);
+    }
 }

src/Entries/Entry.php

@@ -9,6 +9,7 @@
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Traits\Localizable;
+use Illuminate\Validation\ValidationException;
 use LogicException;
 use Statamic\Contracts\Auth\Protect\Protectable;
 use Statamic\Contracts\Data\Augmentable;
@@ -54,6 +55,8 @@
 use Statamic\Support\Traits\FluentlyGetsAndSets;
 use Statamic\View\Cascade;
 
+use function Statamic\trans as __;
+
 class Entry implements Arrayable, ArrayAccess, Augmentable, BulkAugmentable, ContainsQueryableValues, Contract, Localization, Protectable, ResolvesValuesContract, Responsable, SearchableContract
 {
     use ContainsComputedData, ContainsData, ExistsAsFile, FluentlyGetsAndSets, HasAugmentedInstance, Localizable, Publishable, Revisable, Searchable, TracksLastModified, TracksQueriedColumns, TracksQueriedRelations;
@@ -399,6 +402,12 @@ public function saveQuietly()
 
     public function save()
     {
+        if ($this->hasOriginCycle()) {
+            throw ValidationException::withMessages([
+                'origin' => __('Origin sites cannot reference each other in a loop.'),
+            ]);
+        }
+
         $isNew = is_null(Facades\Entry::find($this->id()));
 
         $withEvents = $this->withEvents;
@@ -848,10 +857,21 @@ public function in($locale)
     public function ancestors()
     {
         $ancestors = collect();
+        $seen = [];
 
         $origin = $this->origin();
 
         while ($origin) {
+            $id = $origin->id();
+
+            if ($id !== null && isset($seen[$id])) {
+                break;
+            }
+
+            if ($id !== null) {
+                $seen[$id] = true;
+            }
+
             $ancestors->push($origin);
             $origin = $origin->origin();
         }

src/Facades/Site.php

@@ -11,7 +11,6 @@
  * @method static mixed authorized()
  * @method static mixed default()
  * @method static bool hasMultiple()
- * @method static \Illuminate\Support\Collection filterByGroup($handles, ?string $siteHandle)
  * @method static mixed get($handle)
  * @method static mixed findByUrl($url)
  * @method static mixed current()

src/Http/Controllers/CP/Collections/EntryRevisionsController.php

@@ -97,6 +97,7 @@ public function show(Request $request, $collection, $entry, $revision)
                     'exists' => $exists,
                     'root' => $exists ? $localized->isRoot() : false,
                     'origin' => $exists ? $localized->id() === optional($entry->origin())->id() : null,
+                    'origin_handle' => $exists ? optional($localized->origin())->locale() : null,
                     'published' => $exists ? $localized->published() : false,
                     'url' => $exists ? $localized->editUrl() : null,
                 ];

src/Http/Controllers/CP/Globals/GlobalsController.php

@@ -110,6 +110,8 @@ public function update(Request $request, $set)
                 ->filter(fn ($site) => $site['enabled'])
                 ->mapWithKeys(fn ($site) => [$site['handle'] => $site['origin']]);
 
+            $this->validateAcyclicOrigins($sites);
+
             $set->sites($sites);
         }
 
@@ -118,6 +120,27 @@ public function update(Request $request, $set)
         return response('', 204);
     }
 
+    private function validateAcyclicOrigins($origins)
+    {
+        $origins = collect($origins);
+
+        foreach ($origins as $start => $origin) {
+            $seen = [];
+            $current = $start;
+
+            while ($current) {
+                if (isset($seen[$current])) {
+                    throw \Illuminate\Validation\ValidationException::withMessages([
+                        'sites' => __('Origin sites cannot reference each other in a loop.'),
+                    ]);
+                }
+
+                $seen[$current] = true;
+                $current = $origins->get($current);
+            }
+        }
+    }
+
     public function create()
     {
         $this->authorize('create', GlobalSetContract::class);
@@ -202,7 +225,7 @@ protected function editFormBlueprint($set)
 
         if (Site::multiEnabled()) {
             $fields['sites'] = [
-                'display' => __('Sites'),
+                'display' => __('Localizations'),
                 'fields' => [
                     'sites' => [
                         'type' => 'global_set_sites',

src/Routing/Routable.php

@@ -28,7 +28,7 @@ public function slug($slug = null)
                 return null;
             }
 
-            $lang = method_exists($this, 'site') ? $this->site()->lang() : null;
+            $lang = method_exists($this, 'site') ? $this->site()?->lang() : null;
 
             return Str::slug($slug, '-', $lang);
         })->args(func_get_args());

src/Sites/Sites.php

@@ -58,29 +58,6 @@ public function hasMultiple()
         return $this->sites->count() > 1;
     }
 
-    public function filterByGroup($handles, ?string $siteHandle)
-    {
-        if (! $siteHandle || ! ($site = $this->get($siteHandle))) {
-            return collect($handles);
-        }
-
-        $groupKey = $site->groupHandle() ?? $site->group();
-
-        if (! $groupKey) {
-            return collect($handles);
-        }
-
-        return collect($handles)->filter(function ($handle) use ($groupKey) {
-            $other = $this->get($handle);
-
-            if (! $other) {
-                return false;
-            }
-
-            return ($other->groupHandle() ?? $other->group()) === $groupKey;
-        });
-    }
-
     public function get($handle)
     {
         return $this->sites->get($handle);

tests/Data/Entries/EntryTest.php

@@ -322,6 +322,45 @@ public function values_fall_back_to_the_origin_then_the_collection()
         $this->assertEquals('from origin', $entry->value('test'));
     }
 
+    #[Test]
+    public function it_rejects_saving_when_origins_form_a_cycle()
+    {
+        Collection::make('test')->sites(['en', 'fr'])->save();
+
+        $this->setSites([
+            'en' => ['locale' => 'en_US', 'url' => '/'],
+            'fr' => ['locale' => 'fr_FR', 'url' => '/fr'],
+        ]);
+
+        $english = EntryFactory::id('en-entry')->locale('en')->collection('test')->create();
+        $french = EntryFactory::id('fr-entry')->locale('fr')->collection('test')->origin($english)->create();
+
+        $english->origin($french);
+
+        $this->expectException(\Illuminate\Validation\ValidationException::class);
+
+        $english->save();
+    }
+
+    #[Test]
+    public function ancestors_stop_when_origins_form_a_cycle()
+    {
+        Collection::make('test')->sites(['en', 'fr'])->save();
+
+        $this->setSites([
+            'en' => ['locale' => 'en_US', 'url' => '/'],
+            'fr' => ['locale' => 'fr_FR', 'url' => '/fr'],
+        ]);
+
+        $english = EntryFactory::id('en-entry')->locale('en')->collection('test')->create();
+        $french = EntryFactory::id('fr-entry')->locale('fr')->collection('test')->origin($english)->create();
+
+        $english->origin($french);
+
+        $this->assertEquals(['fr-entry', 'en-entry'], $english->ancestors()->map->id()->all());
+        $this->assertEquals(['en-entry', 'fr-entry'], $french->ancestors()->map->id()->all());
+    }
+
     #[Test]
     public function it_gets_values_from_origin_and_collection()
     {