Started working on moving info provider settings with jbtronics/settings-bundle

src/Controller/SettingsController.php

@@ -0,0 +1,66 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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\Controller;
+
+use App\Settings\AppSettings;
+use Jbtronics\SettingsBundle\Form\SettingsFormFactoryInterface;
+use Jbtronics\SettingsBundle\Manager\SettingsManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+class SettingsController extends AbstractController
+{
+    public function __construct(private readonly SettingsManagerInterface $settingsManager, private readonly SettingsFormFactoryInterface $settingsFormFactory)
+    {}
+
+    #[Route("/settings", name: "system_settings")]
+    public function systemSettings(Request $request): Response
+    {
+        //Create a clone of the settings object
+        $settings = $this->settingsManager->createTemporaryCopy(AppSettings::class);
+
+        //Create a form builder for the settings object
+        $builder = $this->settingsFormFactory->createSettingsFormBuilder($settings);
+
+        //Add a submit button to the form
+        $builder->add('submit', \Symfony\Component\Form\Extension\Core\Type\SubmitType::class, ['label' => 'save']);
+
+        //Create the form
+        $form = $builder->getForm();
+        $form->handleRequest($request);
+
+        //If the form was submitted and is valid, save the settings
+        if ($form->isSubmitted() && $form->isValid()) {
+            $this->settingsManager->mergeTemporaryCopy($settings);
+            $this->settingsManager->save($settings);
+        }
+
+        //Render the form
+        return $this->render('settings/settings.html.twig', [
+            'form' => $form
+        ]);
+    }
+}

src/Services/InfoProviderSystem/Providers/LCSCProvider.php

@@ -29,6 +29,7 @@ use App\Services\InfoProviderSystem\DTOs\ParameterDTO;
 use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
 use App\Services\InfoProviderSystem\DTOs\PriceDTO;
 use App\Services\InfoProviderSystem\DTOs\PurchaseInfoDTO;
+use App\Settings\InfoProviderSystem\LCSCSettings;
 use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
@@ -39,7 +40,7 @@ class LCSCProvider implements InfoProviderInterface
 
     public const DISTRIBUTOR_NAME = 'LCSC';
 
-    public function __construct(private readonly HttpClientInterface $lcscClient, private readonly string $currency, private readonly bool $enabled = true)
+    public function __construct(private readonly HttpClientInterface $lcscClient, private readonly LCSCSettings $settings)
     {
 
     }
@@ -62,7 +63,7 @@ class LCSCProvider implements InfoProviderInterface
     // This provider is always active
     public function isActive(): bool
     {
-        return $this->enabled;
+        return $this->settings->enabled;
     }
 
     /**
@@ -73,7 +74,7 @@ class LCSCProvider implements InfoProviderInterface
     {
         $response = $this->lcscClient->request('GET', self::ENDPOINT_URL . "/product/detail", [
             'headers' => [
-                'Cookie' => new Cookie('currencyCode', $this->currency)
+                'Cookie' => new Cookie('currencyCode', $this->settings->currency)
             ],
             'query' => [
                 'productCode' => $id,
@@ -120,7 +121,7 @@ class LCSCProvider implements InfoProviderInterface
     {
         $response = $this->lcscClient->request('GET', self::ENDPOINT_URL . "/search/global", [
             'headers' => [
-                'Cookie' => new Cookie('currencyCode', $this->currency)
+                'Cookie' => new Cookie('currencyCode', $this->settings->currency)
             ],
             'query' => [
                 'keyword' => $term,
@@ -270,7 +271,7 @@ class LCSCProvider implements InfoProviderInterface
             'kr.' => 'DKK',
             '₹' => 'INR',
             //Fallback to the configured currency
-            default => $this->currency,
+            default => $this->settings->currency,
         };
     }
 

src/Settings/AppSettings.php

@@ -0,0 +1,38 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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\Settings;
+
+use App\Settings\InfoProviderSystem\InfoProviderSettings;
+use Jbtronics\SettingsBundle\Settings\EmbeddedSettings;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+
+#[Settings]
+class AppSettings
+{
+    use SettingsTrait;
+
+    #[EmbeddedSettings]
+    public InfoProviderSettings $infoProviders;
+}

src/Settings/InfoProviderSystem/InfoProviderSettings.php

@@ -0,0 +1,37 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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\Settings\InfoProviderSystem;
+
+use Jbtronics\SettingsBundle\Settings\EmbeddedSettings;
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+
+#[Settings]
+class InfoProviderSettings
+{
+    use SettingsTrait;
+
+    #[EmbeddedSettings]
+    public LCSCSettings $lcsc;
+}

src/Settings/InfoProviderSystem/LCSCSettings.php

@@ -0,0 +1,43 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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\Settings\InfoProviderSystem;
+
+use Jbtronics\SettingsBundle\Settings\Settings;
+use Jbtronics\SettingsBundle\Settings\SettingsParameter;
+use Jbtronics\SettingsBundle\Settings\SettingsTrait;
+use Symfony\Component\Form\Extension\Core\Type\CurrencyType;
+use Symfony\Component\Validator\Constraints as Assert;
+
+#[Settings]
+class LCSCSettings
+{
+    use SettingsTrait;
+
+    #[SettingsParameter(label: "Enable LCSC provider", envVar: "bool:PROVIDER_LCSC_ENABLED")]
+    public bool $enabled = false;
+
+    #[SettingsParameter(label: "LCSC Currency", description: "The currency to retrieve prices from LCSC", formType: CurrencyType::class, envVar: "string:PROVIDER_LCSC_CURRENCY")]
+    #[Assert\Currency()]
+    public string $currency = 'EUR';
+}