feat(index): add load index action

Author: jankal

src/Action/LoadIndexAction.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NuonicPluginInstaller\Action;
+
+use League\Flysystem\FilesystemOperator;
+use NuonicPluginInstaller\Config\ConfigValue;
+use NuonicPluginInstaller\Config\PluginConfigService;
+use NuonicPluginInstaller\Exception\IndexLoadFailedException;
+use NuonicPluginInstaller\Service\IndexFileService;
+use Shopware\Core\System\SystemConfig\Exception\InvalidSettingValueException;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+class LoadIndexAction
+{
+    private const FALLBACK_PACKAGE_SOURCE = 'https://raw.githubusercontent.com/nuonic-digital/plugin-data/refs/heads/dev/shopware_extensions_v1.json';
+
+    public function __construct(
+        private PluginConfigService $config,
+        private HttpClientInterface $httpClient,
+        private FilesystemOperator $filesystem,
+    ) {
+    }
+
+    public function execute(): void
+    {
+        try {
+            $url = $this->config->getString(ConfigValue::PACKAGE_SOURCE);
+        } catch (InvalidSettingValueException $e) {
+            $url = null;
+        }
+        if (is_null($url) || '' === trim($url)) {
+            $url = self::FALLBACK_PACKAGE_SOURCE;
+        }
+
+        $response = $this->httpClient->request('GET', $url);
+
+        if (200 !== $response->getStatusCode()) {
+            throw new IndexLoadFailedException();
+        }
+
+
+        $this->filesystem->writeStream(IndexFileService::FILE_NAME, $this->httpClient->stream($response));
+    }
+}

src/Config/ConfigValue.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NuonicPluginInstaller\Config;
+
+final readonly class ConfigValue
+{
+    public const PACKAGE_SOURCE = 'packageSource';
+}

src/Exception/IndexLoadFailedException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NuonicPluginInstaller\Exception;
+
+class IndexLoadFailedException extends \RuntimeException
+{
+}

src/Exception/MalformedIndexException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NuonicPluginInstaller\Exception;
+
+class MalformedIndexException extends \RuntimeException
+{
+}

src/Resources/config/config.xml

@@ -4,5 +4,16 @@
     <card>
         <title>Basic configuration</title>
         <title lang="de-DE">Grundeinstellungen</title>
+
+        <input-field type="text">
+            <name>packageSource</name>
+            <label>Package source URL</label>
+            <label lang="de-DE">URL der Paketquelle</label>
+            <placeholder>https://raw.githubusercontent.com/....</placeholder>
+            <defaultValue>https://raw.githubusercontent.com/nuonic-digital/plugin-data/refs/heads/dev/shopware_extensions_v1.json</defaultValue>
+            <required>true</required>
+            <helpText>The plugin will load it's package index from the given package source url</helpText>
+            <helpText lang="de-DE">Das Plugin wird seinen Paketindex von der angegebenen Paketquelle laden</helpText>
+        </input-field>
     </card>
 </config>

src/Resources/config/services.xml

@@ -15,5 +15,15 @@
         <service id="NuonicPluginInstaller\Core\Framework\Plugin\AvailableOpensourcePlugin\Aggregate\AvailableOpensourcePluginTranslation\AvailableOpensourcePluginTranslationDefinition">
             <tag name="shopware.entity.definition" entity="nuonic_available_opensource_plugin_translation" />
         </service>
+
+        <service id="NuonicPluginInstaller\Action\LoadIndexAction">
+            <argument type="service" id="NuonicPluginInstaller\Config\PluginConfigService" />
+            <argument type="service" id="http_client" />
+            <argument type="service" id="nuonic_plugin_installer.filesystem.private" />
+        </service>
+
+        <service id="NuonicPluginInstaller\Service\IndexFileServiceInterface" class="NuonicPluginInstaller\Service\IndexFileService">
+            <argument type="service" id="nuonic_plugin_installer.filesystem.private" />
+        </service>
     </services>
 </container>

src/Service/IndexFileService.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NuonicPluginInstaller\Service;
+
+use League\Flysystem\FilesystemException;
+use League\Flysystem\FilesystemOperator;
+use NuonicPluginInstaller\Exception\MalformedIndexException;
+use NuonicPluginInstaller\Struct\PackageIndexEntry;
+
+class IndexFileService implements IndexFileServiceInterface
+{
+    public const FILE_NAME = 'shopware-extension-index.json';
+
+    /** @var array<string, PackageIndexEntry> */
+    private array $packageInformation = [];
+
+    public function __construct(
+        private readonly FilesystemOperator $filesystem,
+    ) {
+    }
+
+    public function getPackageInformation(string $packageName): ?PackageIndexEntry
+    {
+        if (!isset($this->packageInformation[$packageName])) {
+            $this->loadPluginInformationFromFile();
+        }
+
+        return $this->packageInformation[$packageName];
+    }
+
+    public function listPackages(): array
+    {
+        if (empty($this->packageInformation)) {
+            $this->loadPluginInformationFromFile();
+        }
+
+        return $this->packageInformation;
+    }
+
+    /**
+     * @return void
+     * @throws MalformedIndexException
+     */
+    private function loadPluginInformationFromFile(): void
+    {
+        try {
+            $jsonData = $this->filesystem->read(self::FILE_NAME);
+            $data = json_decode($jsonData, true, 512, JSON_THROW_ON_ERROR);
+        } catch (FilesystemException $e) {
+            // if the file does not exist, do not build an index
+            return;
+        } catch (\JsonException $e) {
+            throw new MalformedIndexException(sprintf('JSON decoding failed: %s', $e->getMessage()), $e->getCode(), $e);
+        }
+
+        foreach ($data as $package => $packageInfo) {
+            if (!isset($packageInfo['repositoryUrl'], $packageInfo['ref'])) {
+                throw new MalformedIndexException(sprintf('Package information is missing required fields for package: %s', $package));
+            }
+
+            $this->packageInformation[$package] = new PackageIndexEntry(
+                repositoryUrl: $packageInfo['repositoryUrl'],
+                ref: $packageInfo['ref'],
+            );
+        }
+    }
+}

src/Service/IndexFileServiceInterface.php

@@ -4,14 +4,17 @@
 
 namespace NuonicPluginInstaller\Service;
 
+use NuonicPluginInstaller\Exception\MalformedIndexException;
 use NuonicPluginInstaller\Struct\PackageIndexEntry;
 
 interface IndexFileServiceInterface
 {
-    public function getPackageInformation(string $packageName): PackageIndexEntry;
+    /** @throws MalformedIndexException */
+    public function getPackageInformation(string $packageName): ?PackageIndexEntry;
 
     /**
      * @return PackageIndexEntry[]
+     * @throws MalformedIndexException
      */
     public function listPackages(): array;
 }