Add custom KiCad autocomplete list settings

src/Controller/KicadListEditorController.php

@@ -23,7 +23,10 @@ declare(strict_types=1);
 namespace App\Controller;
 
 use App\Form\Settings\KicadListEditorType;
+use App\Settings\MiscSettings\KiCadEDASettings;
 use App\Services\EDA\KicadListFileManager;
+use Jbtronics\SettingsBundle\Exception\SettingsNotValidException;
+use Jbtronics\SettingsBundle\Manager\SettingsManagerInterface;
 use RuntimeException;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -34,14 +37,26 @@ use function Symfony\Component\Translation\t;
 
 final class KicadListEditorController extends AbstractController
 {
+    public function __construct(
+        private readonly SettingsManagerInterface $settingsManager,
+    ) {
+    }
+
     #[Route('/settings/misc/kicad-lists', name: 'settings_kicad_lists')]
     public function __invoke(Request $request, KicadListFileManager $fileManager): Response
     {
+        $this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');
         $this->denyAccessUnlessGranted('@config.change_system_settings');
 
+        /** @var KiCadEDASettings $settings */
+        $settings = $this->settingsManager->createTemporaryCopy(KiCadEDASettings::class);
         $form = $this->createForm(KicadListEditorType::class, [
-            'footprints' => $fileManager->getFootprintsContent(),
-            'symbols' => $fileManager->getSymbolsContent(),
+            'useCustomList' => $settings->useCustomList,
+            'customFootprints' => $fileManager->getCustomFootprintsContent(),
+            'customSymbols' => $fileManager->getCustomSymbolsContent(),
+        ], [
+            'default_footprints' => $fileManager->getFootprintsContent(),
+            'default_symbols' => $fileManager->getSymbolsContent(),
         ]);
 
         $form->handleRequest($request);
@@ -50,11 +65,14 @@ final class KicadListEditorController extends AbstractController
             $data = $form->getData();
 
             try {
-                $fileManager->save($data['footprints'], $data['symbols']);
+                $fileManager->saveCustom($data['customFootprints'], $data['customSymbols']);
+                $settings->useCustomList = (bool) $data['useCustomList'];
+                $this->settingsManager->mergeTemporaryCopy($settings);
+                $this->settingsManager->save($settings);
                 $this->addFlash('success', t('settings.flash.saved'));
 
                 return $this->redirectToRoute('settings_kicad_lists');
-            } catch (RuntimeException $exception) {
+            } catch (RuntimeException|SettingsNotValidException $exception) {
                 $this->addFlash('error', $exception->getMessage());
             }
         }

src/Form/Part/EDA/KicadFieldAutocompleteType.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace App\Form\Part\EDA;
 
 use App\Form\Type\StaticFileAutocompleteType;
+use App\Settings\MiscSettings\KiCadEDASettings;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -39,6 +40,13 @@ class KicadFieldAutocompleteType extends AbstractType
     //Do not use a leading slash here! otherwise it will not work under prefixed reverse proxies
     public const FOOTPRINT_PATH = 'kicad/footprints.txt';
     public const SYMBOL_PATH = 'kicad/symbols.txt';
+    public const CUSTOM_FOOTPRINT_PATH = 'kicad/footprints_custom.txt';
+    public const CUSTOM_SYMBOL_PATH = 'kicad/symbols_custom.txt';
+
+    public function __construct(
+        private readonly KiCadEDASettings $kiCadEDASettings,
+    ) {
+    }
 
     public function configureOptions(OptionsResolver $resolver): void
     {
@@ -47,8 +55,8 @@ class KicadFieldAutocompleteType extends AbstractType
 
         $resolver->setDefaults([
             'file' => fn(Options $options) => match ($options['type']) {
-                self::TYPE_FOOTPRINT => self::FOOTPRINT_PATH,
-                self::TYPE_SYMBOL => self::SYMBOL_PATH,
+                self::TYPE_FOOTPRINT => $this->kiCadEDASettings->useCustomList ? self::CUSTOM_FOOTPRINT_PATH : self::FOOTPRINT_PATH,
+                self::TYPE_SYMBOL => $this->kiCadEDASettings->useCustomList ? self::CUSTOM_SYMBOL_PATH : self::SYMBOL_PATH,
                 default => throw new \InvalidArgumentException('Invalid type'),
             }
         ]);
@@ -58,4 +66,4 @@ class KicadFieldAutocompleteType extends AbstractType
     {
         return StaticFileAutocompleteType::class;
     }
-}
+}

src/Form/Settings/KicadListEditorType.php

@@ -23,17 +23,24 @@ declare(strict_types=1);
 namespace App\Form\Settings;
 
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 
 final class KicadListEditorType extends AbstractType
 {
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
-            ->add('footprints', TextareaType::class, [
-                'label' => 'settings.misc.kicad_eda.editor.footprints',
+            ->add('useCustomList', CheckboxType::class, [
+                'label' => 'settings.misc.kicad_eda.use_custom_list',
+                'help' => 'settings.misc.kicad_eda.use_custom_list.help',
+                'required' => false,
+            ])
+            ->add('customFootprints', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.custom_footprints',
                 'help' => 'settings.misc.kicad_eda.editor.footprints.help',
                 'attr' => [
                     'rows' => 16,
@@ -41,8 +48,21 @@ final class KicadListEditorType extends AbstractType
                     'class' => 'font-monospace',
                 ],
             ])
-            ->add('symbols', TextareaType::class, [
-                'label' => 'settings.misc.kicad_eda.editor.symbols',
+            ->add('defaultFootprints', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.default_footprints',
+                'help' => 'settings.misc.kicad_eda.editor.default_files_help',
+                'disabled' => true,
+                'mapped' => false,
+                'data' => $options['default_footprints'],
+                'attr' => [
+                    'rows' => 16,
+                    'spellcheck' => 'false',
+                    'class' => 'font-monospace',
+                    'readonly' => 'readonly',
+                ],
+            ])
+            ->add('customSymbols', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.custom_symbols',
                 'help' => 'settings.misc.kicad_eda.editor.symbols.help',
                 'attr' => [
                     'rows' => 16,
@@ -50,8 +70,31 @@ final class KicadListEditorType extends AbstractType
                     'class' => 'font-monospace',
                 ],
             ])
+            ->add('defaultSymbols', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.default_symbols',
+                'help' => 'settings.misc.kicad_eda.editor.default_files_help',
+                'disabled' => true,
+                'mapped' => false,
+                'data' => $options['default_symbols'],
+                'attr' => [
+                    'rows' => 16,
+                    'spellcheck' => 'false',
+                    'class' => 'font-monospace',
+                    'readonly' => 'readonly',
+                ],
+            ])
             ->add('save', SubmitType::class, [
                 'label' => 'save',
             ]);
     }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'default_footprints' => '',
+            'default_symbols' => '',
+        ]);
+        $resolver->setAllowedTypes('default_footprints', 'string');
+        $resolver->setAllowedTypes('default_symbols', 'string');
+    }
 }

src/Services/EDA/KicadListFileManager.php

@@ -29,6 +29,8 @@ final class KicadListFileManager
 {
     private const FOOTPRINTS_PATH = '/public/kicad/footprints.txt';
     private const SYMBOLS_PATH = '/public/kicad/symbols.txt';
+    private const CUSTOM_FOOTPRINTS_PATH = '/public/kicad/footprints_custom.txt';
+    private const CUSTOM_SYMBOLS_PATH = '/public/kicad/symbols_custom.txt';
 
     public function __construct(
         #[Autowire('%kernel.project_dir%')]
@@ -41,15 +43,25 @@ final class KicadListFileManager
         return $this->readFile(self::FOOTPRINTS_PATH);
     }
 
+    public function getCustomFootprintsContent(): string
+    {
+        return $this->readFile(self::CUSTOM_FOOTPRINTS_PATH);
+    }
+
     public function getSymbolsContent(): string
     {
         return $this->readFile(self::SYMBOLS_PATH);
     }
 
-    public function save(string $footprints, string $symbols): void
+    public function getCustomSymbolsContent(): string
     {
-        $this->writeFile(self::FOOTPRINTS_PATH, $this->normalizeContent($footprints));
-        $this->writeFile(self::SYMBOLS_PATH, $this->normalizeContent($symbols));
+        return $this->readFile(self::CUSTOM_SYMBOLS_PATH);
+    }
+
+    public function saveCustom(string $footprints, string $symbols): void
+    {
+        $this->writeFile(self::CUSTOM_FOOTPRINTS_PATH, $this->normalizeContent($footprints));
+        $this->writeFile(self::CUSTOM_SYMBOLS_PATH, $this->normalizeContent($symbols));
     }
 
     private function readFile(string $path): string

src/Settings/MiscSettings/KiCadEDASettings.php

@@ -62,4 +62,10 @@ class KiCadEDASettings
 
     )]
     public bool $defaultOrderdetailsVisibility = false;
+
+    #[SettingsParameter(
+        label: new TM("settings.misc.kicad_eda.use_custom_list"),
+        description: new TM("settings.misc.kicad_eda.use_custom_list.help"),
+    )]
+    public bool $useCustomList = false;
 }