mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-21 01:25:55 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Jan Böhmer 2024-04-29 22:59:56 +02:00
parent 4a99a5e68f
commit 5a4b7c525b
12 changed files with 358 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

1
composer.json
View file

@ -29,6 +29,7 @@
"hshn/base64-encoded-file": "^5.0",
"jbtronics/2fa-webauthn": "^v2.2.0",
"jbtronics/dompdf-font-loader-bundle": "^1.0.0",
"jbtronics/settings-bundle": "^2.0",
"jfcherng/php-diff": "^6.14",
"knpuniversity/oauth2-client-bundle": "^2.15",
"league/csv": "^9.8.0",

155
composer.lock generated
View file

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "19c280b6d5021cb69af33476174dfc1e",
"content-hash": "047dbea97d20f32d8b1fd175e3891941",
"packages": [
{
"name": "api-platform/core",
@ -2127,6 +2127,74 @@
],
"time": "2023-10-06T06:47:41+00:00"
},
{
"name": "ergebnis/classy",
"version": "1.6.0",
"source": {
"type": "git",
"url": "https://github.com/ergebnis/classy.git",
"reference": "e8da19634d7d7d7e293e916b1419395224658d5a"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/ergebnis/classy/zipball/e8da19634d7d7d7e293e916b1419395224658d5a",
"reference": "e8da19634d7d7d7e293e916b1419395224658d5a",
"shasum": ""
},
"require": {
"ext-tokenizer": "*",
"php": "~8.1.0 || ~8.2.0 || ~8.3.0"
},
"require-dev": {
"ergebnis/composer-normalize": "^2.39.0",
"ergebnis/license": "^2.3.0",
"ergebnis/php-cs-fixer-config": "~6.12.0",
"ergebnis/phpunit-slow-test-detector": "^2.4.0",
"fakerphp/faker": "^1.23.0",
"infection/infection": "~0.27.8",
"phpunit/phpunit": "^10.4.2",
"psalm/plugin-phpunit": "~0.18.4",
"rector/rector": "~0.18.11",
"vimeo/psalm": "^5.16.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-main": "1.0-dev"
}
},
"autoload": {
"psr-4": {
"Ergebnis\\Classy\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Andreas Möller",
"email": "am@localheinz.com",
"homepage": "https://localheinz.com"
}
],
"description": "Provides a finder for classy constructs (classes, enums, interfaces, and traits).",
"homepage": "https://github.com/ergebnis/classy",
"keywords": [
"classes",
"classy",
"constructs",
"finder",
"interfaces",
"traits"
],
"support": {
"issues": "https://github.com/ergebnis/classy/issues",
"source": "https://github.com/ergebnis/classy"
},
"time": "2023-11-27T16:46:22+00:00"
},
{
"name": "erusev/parsedown",
"version": "1.7.4",
@ -3147,6 +3215,91 @@
},
"time": "2023-12-24T14:11:31+00:00"
},
{
"name": "jbtronics/settings-bundle",
"version": "2.0.1",
"source": {
"type": "git",
"url": "https://github.com/jbtronics/settings-bundle.git",
"reference": "c8a54ab5517e42e22c00b65f04ffe308a2b0e69b"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/jbtronics/settings-bundle/zipball/c8a54ab5517e42e22c00b65f04ffe308a2b0e69b",
"reference": "c8a54ab5517e42e22c00b65f04ffe308a2b0e69b",
"shasum": ""
},
"require": {
"ergebnis/classy": "^1.6",
"ext-json": "*",
"php": "^8.1",
"symfony/deprecation-contracts": "^3.4",
"symfony/form": "^6.4|^7.0",
"symfony/framework-bundle": "^6.4|^7.0",
"symfony/translation": "^7.0|^6.4",
"symfony/translation-contracts": "^2.5|^3.0",
"symfony/validator": "^6.4|^7.0",
"symfony/var-exporter": "^6.4|^7.0"
},
"require-dev": {
"doctrine/doctrine-bundle": "^2.11",
"doctrine/doctrine-fixtures-bundle": "^3.5",
"doctrine/orm": "^3.0",
"ekino/phpstan-banned-code": "^1.0",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan": "^1.10",
"phpstan/phpstan-strict-rules": "^1.5",
"phpstan/phpstan-symfony": "^1.3",
"phpunit/phpunit": "^9.5",
"roave/security-advisories": "dev-latest",
"symfony/phpunit-bridge": "^6.4|^7.0",
"symfony/security-csrf": "^7.0|^6.4",
"symfony/twig-bridge": "^6.4|^7.0"
},
"suggest": {
"doctrine/doctrine-bundle": "To use the doctrine ORM storage",
"symfony/twig-bridge": "Allows to access settings in twig templates"
},
"type": "symfony-bundle",
"autoload": {
"psr-4": {
"Jbtronics\\SettingsBundle\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Jan Böhmer",
"email": "mail@jan-boehmer.de"
}
],
"description": "A symfony bundle to easily create typesafe, user-configurable settings for symfony applications",
"keywords": [
"Settings",
"config",
"symfony",
"symfony-bundle",
"user-configurable"
],
"support": {
"issues": "https://github.com/jbtronics/settings-bundle/issues",
"source": "https://github.com/jbtronics/settings-bundle/tree/2.0.1"
},
"funding": [
{
"url": "https://www.paypal.me/do9jhb",
"type": "custom"
},
{
"url": "https://github.com/jbtronics",
"type": "github"
}
],
"time": "2024-04-28T20:49:45+00:00"
},
{
"name": "jfcherng/php-color-output",
"version": "3.0.0",

1
config/bundles.php
View file

@ -32,4 +32,5 @@ return [
KnpU\OAuth2ClientBundle\KnpUOAuth2ClientBundle::class => ['all' => true],
Nelmio\CorsBundle\NelmioCorsBundle::class => ['all' => true],
ApiPlatform\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
Jbtronics\SettingsBundle\JbtronicsSettingsBundle::class => ['all' => true],
];

2
config/packages/settings.yaml Normal file
View file

@ -0,0 +1,2 @@
jbtronics_settings:
default_storage_adapter: Jbtronics\SettingsBundle\Storage\PHPFileStorageAdapter

5
config/services.yaml
View file

@ -307,11 +307,6 @@ services:
$options: '%env(string:PROVIDER_MOUSER_SEARCH_OPTION)%'
$search_limit: '%env(int:PROVIDER_MOUSER_SEARCH_LIMIT)%'
App\Services\InfoProviderSystem\Providers\LCSCProvider:
arguments:
$enabled: '%env(bool:PROVIDER_LCSC_ENABLED)%'
$currency: '%env(string:PROVIDER_LCSC_CURRENCY)%'
####################################################################################################################
# API system
####################################################################################################################

66
src/Controller/SettingsController.php Normal file
View file

@ -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
]);
}
}

11
src/Services/InfoProviderSystem/Providers/LCSCProvider.php
View file

@ -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,
};
}

38
src/Settings/AppSettings.php Normal file
View file

@ -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;
}

37
src/Settings/InfoProviderSystem/InfoProviderSettings.php Normal file
View file

@ -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;
}

43
src/Settings/InfoProviderSystem/LCSCSettings.php Normal file
View file

@ -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';
}

3
symfony.lock
View file

@ -194,6 +194,9 @@
"jbtronics/dompdf-font-loader-bundle": {
"version": "v1.1.1"
},
"jbtronics/settings-bundle": {
"version": "2.0.1"
},
"knpuniversity/oauth2-client-bundle": {
"version": "2.15",
"recipe": {

7
templates/settings/settings.html.twig Normal file
View file

@ -0,0 +1,7 @@
{% extends "main_card.html.twig" %}
{% block card_content %}
{{ form_start(form) }}
{{ form_widget(form.infoProviders) }}
{{ form_end(form) }}
{% endblock %}