Added an very basic system to configure info providers

src/Services/InfoProviderSystem/DTOs/SearchResultDTO.php

@@ -0,0 +1,52 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\DTOs;
+
+use App\Entity\Parts\ManufacturingStatus;
+
+class SearchResultDTO
+{
+    public function __construct(
+        /** @var string The provider key (e.g. "digikey") */
+        public readonly string $provider_key,
+        /** @var string The ID which identifies the part in the provider system */
+        public readonly string $provider_id,
+        /** @var string The name of the part  */
+        public readonly string $name,
+        /** @var string A short description of the part */
+        public readonly string $description,
+        /** @var string|null The manufacturer of the part */
+        public readonly ?string $manufacturer = null,
+        /** @var string|null The manufacturer part number */
+        public readonly ?string $mpn = null,
+        /** @var string|null An URL to a preview image */
+        public readonly ?string $preview_image_url = null,
+        /** @var ManufacturingStatus|null The manufacturing status of the part */
+        public readonly ?ManufacturingStatus $manufacturing_status = null,
+        /** @var string|null A link to the part on the providers page */
+        public readonly ?string $provider_url = null,
+    ) {
+
+    }
+}

src/Services/InfoProviderSystem/ProviderRegistry.php

@@ -0,0 +1,107 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem;
+
+use App\Services\InfoProviderSystem\Providers\InfoProviderInterface;
+
+class ProviderRegistry
+{
+
+    /**
+     * @var InfoProviderInterface[] The info providers index by their keys
+     * @psalm-var array
+     */
+    private array $providers_by_name = [];
+
+    /**
+     * @var InfoProviderInterface[] The enabled providers indexed by their keys
+     * @psalm-var array
+     */
+    private array $providers_active = [];
+
+    /**
+     * @var InfoProviderInterface[] The disabled providers indexed by their keys
+     * @psalm-var array
+     */
+    private array $providers_disabled = [];
+
+    /**
+     * @param  iterable<InfoProviderInterface>  $providers
+     */
+    public function __construct(private readonly iterable $providers)
+    {
+        foreach ($providers as $provider) {
+            $key = $provider->getProviderKey();
+
+            if (isset($this->providers_by_name[$key])) {
+                throw new \LogicException("Provider with key $key already registered");
+            }
+
+            $this->providers_by_name[$key] = $provider;
+            if ($provider->isActive()) {
+                $this->providers_active[$key] = $provider;
+            } else {
+                $this->providers_disabled[$key] = $provider;
+            }
+        }
+    }
+
+    /**
+     * Returns an array of all registered providers (enabled and disabled)
+     * @return InfoProviderInterface[]
+     */
+    public function getProviders(): array
+    {
+        return $this->providers_by_name;
+    }
+
+    /**
+     * Returns the provider identified by the given key
+     * @param  string  $key
+     * @return InfoProviderInterface
+     * @throws \InvalidArgumentException If the provider with the given key does not exist
+     */
+    public function getProviderByKey(string $key): InfoProviderInterface
+    {
+        return $this->providers_by_name[$key] ?? throw new \InvalidArgumentException("Provider with key $key not found");
+    }
+
+    /**
+     * Returns an array of all active providers
+     * @return InfoProviderInterface[]
+     */
+    public function getActiveProviders(): array
+    {
+        return $this->providers_active;
+    }
+
+    /**
+     * Returns an array of all disabled providers
+     * @return InfoProviderInterface[]
+     */
+    public function getDisabledProviders(): array
+    {
+        return $this->providers_disabled;
+    }
+}

src/Services/InfoProviderSystem/Providers/DigikeyProvider.php

@@ -0,0 +1,121 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\Providers;
+
+use App\Entity\Parts\ManufacturingStatus;
+use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+class DigikeyProvider implements InfoProviderInterface
+{
+
+    public function __construct(private readonly HttpClientInterface $digikeyClient)
+    {
+
+    }
+
+    public function getProviderInfo(): array
+    {
+        return [
+            'name' => 'DigiKey',
+            'description' => 'This provider uses the DigiKey API to search for parts.',
+            'url' => 'https://www.digikey.com/',
+        ];
+    }
+
+    public function getCapabilities(): array
+    {
+        return [
+            ProviderCapabilities::BASIC,
+            ProviderCapabilities::FOOTPRINT,
+            ProviderCapabilities::PICTURE,
+            ProviderCapabilities::DATASHEET,
+            ProviderCapabilities::PRICE,
+        ];
+    }
+
+    public function getProviderKey(): string
+    {
+        return 'digikey';
+    }
+
+    public function isActive(): bool
+    {
+        return true;
+    }
+
+    public function searchByKeyword(string $keyword): array
+    {
+        $request = [
+            'Keywords' => $keyword,
+            'RecordCount' => 50,
+            'RecordStartPosition' => 0,
+            'ExcludeMarketPlaceProducts' => 'true',
+        ];
+
+        $response = $this->digikeyClient->request('POST', '/Search/v3/Products/Keyword', [
+            'json' => $request,
+        ]);
+
+        $response_array = $response->toArray();
+
+
+        $result = [];
+        $products = $response_array['Products'];
+        foreach ($products as $product) {
+            $result[] = new SearchResultDTO(
+                provider_key: $this->getProviderKey(),
+                provider_id: $product['DigiKeyPartNumber'],
+                name: $product['ManufacturerPartNumber'],
+                description: $product['ProductDescription'],
+                manufacturer: $product['Manufacturer']['Value'] ?? null,
+                mpn: $product['ManufacturerPartNumber'],
+                preview_image_url: $product['PrimaryPhoto'] ?? null,
+                manufacturing_status: $this->productStatusToManufacturingStatus($product['ProductStatus']),
+                provider_url: 'https://digikey.com'.$product['ProductUrl'],
+            );
+        }
+
+        return $result;
+    }
+
+    /**
+     * Converts the product status from the Digikey API to the manufacturing status used in Part-DB
+     * @param  string|null  $dk_status
+     * @return ManufacturingStatus|null
+     */
+    private function productStatusToManufacturingStatus(?string $dk_status): ?ManufacturingStatus
+    {
+        return match ($dk_status) {
+            null => null,
+            'Active' => ManufacturingStatus::ACTIVE,
+            'Obsolete' => ManufacturingStatus::DISCONTINUED,
+            'Discontinued at Digi-Key' => ManufacturingStatus::EOL,
+            'Last Time Buy' => ManufacturingStatus::EOL,
+            'Not For New Designs' => ManufacturingStatus::NRFND,
+            'Preliminary' => ManufacturingStatus::ANNOUNCED,
+            default => ManufacturingStatus::NOT_SET,
+        };
+    }
+}

src/Services/InfoProviderSystem/Providers/InfoProviderInterface.php

@@ -0,0 +1,72 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\Providers;
+
+use App\Services\InfoProviderSystem\DTOs\SearchResultDTO;
+
+interface InfoProviderInterface
+{
+
+    /**
+     * Get information about this provider
+     *
+     * @return array An associative array with the following keys (? means optional):
+     * - name: The (user friendly) name of the provider (e.g. "Digikey"), will be translated
+     * - description?: A short description of the provider (e.g. "Digikey is a ..."), will be translated
+     * - logo?: The logo of the provider (e.g. "digikey.png")
+     * - url?: The url of the provider (e.g. "https://www.digikey.com")
+     * - disabled_help?: A help text which is shown when the provider is disabled, explaining how to enable it
+     *
+     * @phpstan-return array{ name: string, description?: string, logo?: string, url?: string, disabled_help?: string }
+     */
+    public function getProviderInfo(): array;
+
+    /**
+     * Returns a unique key for this provider, which will be saved into the database
+     * and used to identify the provider
+     * @return string A unique key for this provider (e.g. "digikey")
+     */
+    public function getProviderKey(): string;
+
+    /**
+     * Checks if this provider is enabled or not (meaning that it can be used for searching)
+     * @return bool True if the provider is enabled, false otherwise
+     */
+    public function isActive(): bool;
+
+    /**
+     * Searches for a keyword and returns a list of search results
+     * @param  string  $keyword The keyword to search for
+     * @return SearchResultDTO[] A list of search results
+     */
+    public function searchByKeyword(string $keyword): array;
+
+    /**
+     * A list of capabilities this provider supports (which kind of data it can provide).
+     * Not every part have to contain all of these data, but the provider should be able to provide them in general.
+     * Currently, this list is purely informational and not used in functional checks.
+     * @return ProviderCapabilities[]
+     */
+    public function getCapabilities(): array;
+}

src/Services/InfoProviderSystem/Providers/ProviderCapabilities.php

@@ -0,0 +1,67 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\Providers;
+
+/**
+ * This enum contains all capabilities (which data it can provide) a provider can have.
+ */
+enum ProviderCapabilities
+{
+    /** Basic information about a part, like the name, description, part number, manufacturer etc */
+    case BASIC;
+
+    /** Information about the footprint of a part */
+    case FOOTPRINT;
+
+    /** Provider can provide a picture for a part */
+    case PICTURE;
+
+    /** Provider can provide datasheets for a part */
+    case DATASHEET;
+
+    /** Provider can provide prices for a part */
+    case PRICE;
+
+    public function getTranslationKey(): string
+    {
+        return 'info_providers.capabilities.' . match($this) {
+                self::BASIC => 'basic',
+                self::FOOTPRINT => 'footprint',
+                self::PICTURE => 'picture',
+                self::DATASHEET => 'datasheet',
+                self::PRICE => 'price',
+            };
+    }
+
+    public function getFAIconClass(): string
+    {
+        return 'fa-solid ' . match($this) {
+                self::BASIC => 'fa-info-circle',
+                self::FOOTPRINT => 'fa-microchip',
+                self::PICTURE => 'fa-image',
+                self::DATASHEET => 'fa-file-alt',
+                self::PRICE => 'fa-money-bill-wave',
+            };
+    }
+}

src/Services/InfoProviderSystem/Providers/TestProvider.php

@@ -0,0 +1,61 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Services\InfoProviderSystem\Providers;
+
+class TestProvider implements InfoProviderInterface
+{
+
+    public function getProviderInfo(): array
+    {
+        return [
+            'name' => 'Test Provider',
+            'description' => 'This is a test provider',
+            //'url' => 'https://example.com',
+            'disabled_help' => 'This provider is disabled for testing purposes'
+        ];
+    }
+
+    public function getProviderKey(): string
+    {
+        return 'test';
+    }
+
+    public function isActive(): bool
+    {
+        return false;
+    }
+
+    public function searchByKeyword(string $keyword): array
+    {
+        // TODO: Implement searchByKeyword() method.
+    }
+
+    public function getCapabilities(): array
+    {
+        return [
+            ProviderCapabilities::BASIC,
+            ProviderCapabilities::FOOTPRINT,
+        ];
+    }
+}