Laravel 9 compatibility

.github/workflows/tests.yml

@@ -14,17 +14,22 @@ jobs:
     strategy:
       matrix:
         php: [7.4, 8.0, 8.1]
-        laravel: [8.*]
+        laravel: [8.*, 9.*]
         stability: [prefer-lowest, prefer-stable]
         os: [ubuntu-latest]
         include:
           - laravel: 8.*
             framework: ^8.24.0
+          - laravel: 9.*
+            framework: ^9.0
           - os: windows-latest
             php: 8.0
             laravel: 8.*
             framework: ^8.24.0
             stability: prefer-stable
+        exclude:
+          - laravel: 9.*
+            php: 7.4
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 

CHANGELOG.md

@@ -13,6 +13,8 @@
 - CP forms only submit visible fields, in order to fix sometimes/required_if/etc validation rules. [#5101](https://github.com/statamic/cms/issues/5101) by @jesseleite
 
 ### What's changed
+- PHP 7.2 and 7.3 are no longer supported.
+- Laravel 6 and 7 are no longer supported.
 - Entries fieldtypes augment to query builders instead of collections. [#5238](https://github.com/statamic/cms/issues/5238) by @jasonvarga
 - The `page` and each Global Set in the cascade are now `Values` instances. [#5201](https://github.com/statamic/cms/issues/5201) by @jasonvarga
 - The `Augmented` interface's `get` method now has a return typehint of `Value`. [#5302](https://github.com/statamic/cms/issues/5302) by @jasonvarga

composer.json

@@ -15,20 +15,20 @@
         "facade/ignition-contracts": "^1.0",
         "guzzlehttp/guzzle": "^6.3 || ^7.0",
         "james-heinrich/getid3": "^1.9",
-        "laravel/framework": "^6.20.14 || ^7.30.4 || ^8.24.0",
+        "laravel/framework": "^8.24.0 || ^9.0",
         "laravel/helpers": "^1.1",
-        "league/commonmark": "^1.5",
+        "league/commonmark": "^1.5 || ^2.0",
         "league/csv": "^9.0",
-        "league/glide": "^1.1",
+        "league/glide": "^1.1 || ^2.0",
         "michelf/php-smartypants": "^1.8",
         "pixelfear/composer-dist-plugin": "^0.1.4",
-        "rebing/graphql-laravel": "^6.5",
+        "rebing/graphql-laravel": "^6.5 || ^8.0",
         "spatie/blink": "^1.1.2",
         "statamic/stringy": "^3.1",
-        "symfony/http-foundation": "^4.3.3 || ^5.1.4",
+        "symfony/http-foundation": "^4.3.3 || ^5.1.4 || ^6.0",
         "symfony/lock": "^5.1",
         "symfony/var-exporter": "^4.3 || ^5.1",
-        "symfony/yaml": "^4.1 || ^5.1",
+        "symfony/yaml": "^4.1 || ^5.1 || ^6.0",
         "ueberdosis/html-to-prosemirror": "^1.3",
         "ueberdosis/prosemirror-to-html": "^2.6",
         "wilderborn/partyline": "^1.0"
@@ -37,7 +37,7 @@
         "fakerphp/faker": "~1.10",
         "google/cloud-translate": "^1.6",
         "mockery/mockery": "^1.2.3",
-        "orchestra/testbench": "^4.0 || ^5.0 || ^6.7.0"
+        "orchestra/testbench": "^6.7.0 || ^7.0"
     },
     "config": {
         "optimize-autoloader": true,

src/Assets/AssetContainer.php

@@ -361,7 +361,15 @@ public function assetFolder($path)
      */
     public function accessible()
     {
-        return $this->disk()->filesystem()->getDriver()->getConfig()->get('url') !== null;
+        $config = $this->disk()->filesystem()->getConfig();
+
+        // If Flysystem 1.x, it will be an array, so wrap it with `collect()` so it can `get()` values;
+        // Otherwise it will already be a `ReadOnlyConfiguration` object with a `get()` method.
+        if (is_array($config)) {
+            $config = collect($config);
+        }
+
+        return $config->get('url') !== null;
     }
 
     /**

src/Assets/AssetContainerContents.php

@@ -3,7 +3,6 @@
 namespace Statamic\Assets;
 
 use Illuminate\Support\Facades\Cache;
-use League\Flysystem\Util;
 use Statamic\Support\Str;
 
 class AssetContainerContents
@@ -26,10 +25,93 @@ public function all()
                 // and will let us perform more efficient filtering and caching.
                 $files = $this->filesystem()->listContents('/', true);
 
+                // If Flysystem 3.x, re-apply sorting and return a backwards compatible result set.
+                // See: https://flysystem.thephpleague.com/v2/docs/usage/directory-listings/
+                if (! is_array($files)) {
+                    return collect($files->sortByPath()->toArray())->keyBy('path')->map(function ($file) {
+                        return $this->normalizeFlysystemAttributes($file);
+                    });
+                }
+
                 return collect($files)->keyBy('path');
             });
     }
 
+    /**
+     * Normalize flysystem 3.x `FileAttributes` and `DirectoryAttributes` payloads back to the 1.x array style.
+     *
+     * @param  mixed  $attributes
+     * @return array
+     */
+    private function normalizeFlysystemAttributes($attributes)
+    {
+        // Merge attributes with `pathinfo()`, since Flysystem 3.x removed `Util::pathinfo()`.
+        $normalized = array_merge([
+            'type' => $attributes->type(),
+            'path' => $attributes->path(),
+            'timestamp' => $attributes->lastModified(),
+        ], pathinfo($attributes['path']));
+
+        // Flysystem 1.x never returned `.` dirnames.
+        if (isset($normalized['dirname']) && $normalized['dirname'] === '.') {
+            $normalized['dirname'] = '';
+        }
+
+        // Only return `size` if type is file.
+        if ($normalized['type'] === 'file') {
+            $normalized['size'] = $attributes->fileSize();
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Normalize flysystem 3.x meta data to match 1.x payloads.
+     *
+     * @param  string  $path
+     * @return array
+     */
+    private function getNormalizedFlysystemMetadata($path)
+    {
+        $isFlysystemV1 = method_exists($this->filesystem(), 'getTimestamp');
+
+        // Determine whether or not to use Flysystem 1.x or 3.x getter methods.
+        $lastModifiedMethod = $isFlysystemV1 ? 'getTimestamp' : 'lastModified';
+        $fileSizeMethod = $isFlysystemV1 ? 'getSize' : 'fileSize';
+
+        // Use exception handling to avoid another `has()` API method call.
+        try {
+            $timestamp = $this->filesystem()->{$lastModifiedMethod}($path);
+        } catch (\Exception $exception) {
+            return false;
+        }
+
+        // Use exception handling to normalize file size output.
+        try {
+            $size = $this->filesystem()->{$fileSizeMethod}($path);
+        } catch (\Exception $exception) {
+            $size = false;
+        }
+
+        // Determine `type` off returned size to avoid another API method call.
+        $type = $size === false ? 'dir' : 'file';
+
+        // Merge `pathinfo()` in, since Flysystem 3.x removed `Util::pathinfo()`.
+        $normalized = array_merge(compact('type', 'path', 'timestamp'), pathinfo($path));
+
+        // Flysystem 1.x never returned `.` dirnames.
+        if (isset($normalized['dirname']) && $normalized['dirname'] === '.') {
+            $normalized['dirname'] = '';
+        }
+
+        // Only return `size` if type is file.
+        if ($type === 'file') {
+            $normalized['size'] = $size;
+        }
+
+        return $normalized;
+    }
+
     public function cached()
     {
         return Cache::get($this->key());
@@ -124,25 +206,21 @@ public function forget($path)
 
     public function add($path)
     {
-        try {
-            // If the file doesn't exist, this will either throw an exception or return
-            // false depending on the adapter and whether or not asserts are enabled.
-            if (! $metadata = $this->filesystem()->getMetadata($path)) {
-                return $this;
-            }
-
-            // Add parent directories
-            if (($dir = dirname($path)) !== '.') {
-                $this->add($dir);
-            }
-
-            $this->all()->put($path, $metadata + Util::pathinfo($path));
-
-            $this->filteredFiles = null;
-            $this->filteredDirectories = null;
-        } finally {
+        if (! $metadata = $this->getNormalizedFlysystemMetadata($path)) {
             return $this;
         }
+
+        // Add parent directories
+        if (($dir = dirname($path)) !== '.') {
+            $this->add($dir);
+        }
+
+        $this->all()->put($path, $metadata);
+
+        $this->filteredFiles = null;
+        $this->filteredDirectories = null;
+
+        return $this;
     }
 
     private function key()

src/Assets/Attributes.php

@@ -93,7 +93,7 @@ private function getImageAttributes()
         $manager->copy("source://{$this->asset->path()}", $destination);
 
         try {
-            [$width, $height] = getimagesize($cache->getAdapter()->getPathPrefix().$cachePath);
+            [$width, $height] = getimagesize($this->prefixPath($cachePath));
             $size = compact('width', 'height');
         } catch (\Exception $e) {
             $size = [];
@@ -126,7 +126,7 @@ private function getSvgAttributes()
 
         $manager->copy("source://{$this->asset->path()}", $destination);
 
-        $svg = simplexml_load_file($cache->getAdapter()->getPathPrefix().$cachePath);
+        $svg = simplexml_load_file($this->prefixPath($cachePath));
 
         $cache->delete($cachePath);
 
@@ -170,4 +170,9 @@ private function getCacheFlysystem()
 
         return Storage::disk($disk)->getDriver();
     }
+
+    private function prefixPath($path)
+    {
+        return Storage::disk('attributes-cache')->path($path);
+    }
 }

src/Auth/Permission.php

@@ -26,7 +26,7 @@ public function value(string $value = null)
             return $this;
         }
 
-        return str_replace('{'.$this->placeholder.'}', $this->placeholderValue, $this->value);
+        return str_replace('{'.$this->placeholder.'}', (string) $this->placeholderValue, $this->value);
     }
 
     public function originalValue()

src/Console/Commands/ListCommand.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Command;
 use Statamic\Console\RunsInPlease;
+use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Helper\DescriptorHelper;
 
 class ListCommand extends Command
@@ -31,7 +32,7 @@ public function handle()
         ]);
     }
 
-    public function getApplication()
+    public function getApplication(): ?Application
     {
         $app = parent::getApplication();
 

src/Console/EnhancesCommands.php

@@ -8,7 +8,7 @@
 
 trait EnhancesCommands
 {
-    public function run(InputInterface $input, OutputInterface $output)
+    public function run(InputInterface $input, OutputInterface $output): int
     {
         Partyline::bind($this);
 

src/Data/AugmentedCollection.php

@@ -44,7 +44,7 @@ public function toArray()
         })->all();
     }
 
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return array_map(function ($value) {
             if ($this->shallowNesting && $value instanceof Augmentable) {

src/Facades/Endpoint/Path.php

@@ -2,7 +2,6 @@
 
 namespace Statamic\Facades\Endpoint;
 
-use League\Flysystem\Util;
 use Statamic\Facades\Pattern;
 use Statamic\Support\Str;
 
@@ -83,7 +82,12 @@ public function resolve($path)
     {
         $leadingSlash = Str::startsWith($path, '/');
 
-        $path = Util::normalizeRelativePath(self::tidy($path));
+        $path = self::tidy($path);
+
+        // The `Util` class was removed in Flysystem 3.x, but this functionality exists in the new `WhitespacePathNormalizer`.
+        $path = class_exists('\League\Flysystem\Util')
+            ? \League\Flysystem\Util::normalizeRelativePath($path)
+            : (new \League\Flysystem\WhitespacePathNormalizer)->normalizePath($path);
 
         // Flysystem's method removes the leading slashes. We want to maintain them.
         return $leadingSlash ? Str::ensureLeft($path, '/') : $path;
@@ -106,7 +110,7 @@ public function assemble($args)
             return null;
         }
 
-        return self::tidy(join('/', $args));
+        return self::tidy(implode('/', $args));
     }
 
     /**
@@ -194,10 +198,10 @@ public function tidy($path)
     {
         // Replace backslashes with forward slashes for consistency between platforms.
         // PHP is capable of understanding Windows paths that use forward slashes.
-        $path = str_replace('\\', '/', $path);
+        $path = str_replace('\\', '/', (string) $path);
 
         // Remove occurrences of "//" in a $path (except when part of a protocol).
-        return preg_replace('#(^|[^:])//+#', '\\1/', $path);
+        return preg_replace('#(^|[^:])//+#', '\\1/', (string) $path);
     }
 
     /**

src/Filesystem/FlysystemAdapter.php

@@ -3,7 +3,6 @@
 namespace Statamic\Filesystem;
 
 use Illuminate\Contracts\Filesystem\Filesystem as FilesystemAdapter;
-use League\Flysystem\Adapter\Local;
 use Statamic\Facades\Path;
 use Statamic\Support\Str;
 
@@ -25,13 +24,18 @@ public function normalizePath($path)
         }
 
         if (Path::isAbsolute($path)) {
-            $adapter = $this->filesystem->getDriver()->getAdapter();
+            $adapter = $this->filesystem->getAdapter();
 
-            if (! $adapter instanceof Local) {
+            // Determine which adapter to use for Flysystem 1.x or 3.x.
+            $localClass = class_exists($legacyAdapter = '\League\Flysystem\Adapter\Local')
+                ? $legacyAdapter
+                : '\League\Flysystem\Local\LocalFilesystemAdapter';
+
+            if (! $adapter instanceof $localClass) {
                 throw new \LogicException('Cannot use absolute paths on non-local adapters.');
             }
 
-            if (! Str::startsWith($path, $root = Path::tidy($adapter->getPathPrefix()))) {
+            if (! Str::startsWith($path, $root = Path::tidy($this->filesystem->path('/')))) {
                 throw new \LogicException("Cannot reference path [{$path}] outside the root [{$root}]");
             }
 

src/GraphQL/DefaultSchema.php

@@ -46,7 +46,7 @@ public function getConfig()
             'query' => $this->getQueries(),
             'mutation' => [],
             'middleware' => $this->getMiddleware(),
-            'method' => ['get', 'post'],
+            'method' => ['GET', 'POST'],
         ];
     }