Part-DB-server/src/Controller/ScanController.php

<?php
/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2022 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);

/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 2019 - 2022 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/>.
 */

namespace App\Controller;

use App\Form\LabelSystem\ScanDialogType;
use App\Services\LabelSystem\BarcodeScanner\BarcodeRedirector;
use App\Services\LabelSystem\BarcodeScanner\BarcodeScanHelper;
use App\Services\LabelSystem\BarcodeScanner\BarcodeSourceType;
use App\Services\LabelSystem\BarcodeScanner\LocalBarcodeScanResult;
use App\Services\LabelSystem\BarcodeScanner\LCSCBarcodeScanResult;
use App\Services\LabelSystem\BarcodeScanner\EIGP114BarcodeScanResult;
use Doctrine\ORM\EntityNotFoundException;
use InvalidArgumentException;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
use Symfony\Component\Routing\Attribute\Route;
use App\Services\InfoProviderSystem\PartInfoRetriever;
use App\Services\InfoProviderSystem\ProviderRegistry;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use App\Entity\Parts\Part;
use \App\Entity\Parts\StorageLocation;

/**
 * @see \App\Tests\Controller\ScanControllerTest
 */
#[Route(path: '/scan')]
class ScanController extends AbstractController
{
    public function __construct(
	protected BarcodeRedirector $barcodeParser,
	protected BarcodeScanHelper $barcodeNormalizer,
        private readonly ProviderRegistry $providerRegistry,
        private readonly PartInfoRetriever $infoRetriever,
	) {}

    #[Route(path: '', name: 'scan_dialog')]
    public function dialog(Request $request, #[MapQueryParameter] ?string $input = null): Response
    {
        $this->denyAccessUnlessGranted('@tools.label_scanner');

        $form = $this->createForm(ScanDialogType::class);
        $form->handleRequest($request);

        $mode = null;
        if ($input === null && $form->isSubmitted() && $form->isValid()) {
            $input = $form['input']->getData();
            $mode = $form['mode']->getData();
        }

        $infoModeData = null;
        $createUrl = null;

        if ($input !== null) {
            try {
                $scan_result = $this->barcodeNormalizer->scanBarcodeContent($input, $mode ?? null);

                //Perform a redirect if the info mode is not enabled
                if (!$form['info_mode']->getData()) {
                    try {
                        // redirect user to part page
                        return $this->redirect($this->barcodeParser->getRedirectURL($scan_result));
                    } catch (EntityNotFoundException) {
                        // Part not found -> show decoded info + optional "create part" link
                        $infoModeData = $scan_result->getDecodedForInfoMode();

                        $createUrl = $this->buildCreateUrlForScanResult($scan_result, $request->getLocale());

                        if ($createUrl === null) {
                            $this->addFlash('warning', 'scan.qr_not_found');
                        }
                    }
                } else { //Otherwise retrieve infoModeData
                    $infoModeData = $scan_result->getDecodedForInfoMode();
                }
            } catch (InvalidArgumentException) {
                $this->addFlash('error', 'scan.format_unknown');
            }
        }

        return $this->render('label_system/scanner/scanner.html.twig', [
            'form' => $form,
            'infoModeData' => $infoModeData,
            'createUrl' => $createUrl,
        ]);
    }

    /**
     * The route definition for this action is done in routes.yaml, as it does not use the _locale prefix as the other routes.
     */
    public function scanQRCode(string $type, int $id): Response
    {
        $type = strtolower($type);

        try {
            $this->addFlash('success', 'scan.qr_success');

            if (!isset(BarcodeScanHelper::QR_TYPE_MAP[$type])) {
                throw new InvalidArgumentException('Unknown type: '.$type);
            }
            //Construct the scan result manually, as we don't have a barcode here
            $scan_result = new LocalBarcodeScanResult(
                target_type: BarcodeScanHelper::QR_TYPE_MAP[$type],
                target_id: $id,
                //The routes are only used on the internal generated QR codes
                source_type: BarcodeSourceType::INTERNAL
            );

            return $this->redirect($this->barcodeParser->getRedirectURL($scan_result));
        } catch (EntityNotFoundException) {
            $this->addFlash('success', 'scan.qr_not_found');

            return $this->redirectToRoute('homepage');
        }
    }

    /**
     * Builds a URL for creating a new part based on the barcode data
     * @param object $scanResult
     * @param string $locale
     * @return string|null
     */
    private function buildCreateUrlForScanResult(object $scanResult, string $locale): ?string
    {
        // LCSC
        if ($scanResult instanceof LCSCBarcodeScanResult) {
            $lcscCode = $scanResult->getPC();
            if (is_string($lcscCode) && $lcscCode !== '') {
                return '/'
                    . rawurlencode($locale)
                    . '/part/from_info_provider/lcsc/'
                    . rawurlencode($lcscCode)
                    . '/create';
            }
        }

        // Mouser / Digi-Key (EIGP114)
        if ($scanResult instanceof EIGP114BarcodeScanResult) {
            $vendor = $scanResult->guessBarcodeVendor();

            // Mouser: use supplierPartNumber -> search provider -> provider_id
            if ($vendor === 'mouser'
                && is_string($scanResult->supplierPartNumber)
                && $scanResult->supplierPartNumber !== ''
            ) {
                try {
                    $mouserProvider = $this->providerRegistry->getProviderByKey('mouser');

                    if (!$mouserProvider->isActive()) {
                        $this->addFlash('warning', 'Mouser provider is disabled / not configured.');
                        return null;
                    }
                    // Search Mouser using the MPN
                    $dtos = $this->infoRetriever->searchByKeyword(
                        keyword: $scanResult->supplierPartNumber,
                        providers: [$mouserProvider]
                    );

                    // If there are results, provider_id is MouserPartNumber (per MouserProvider.php)
                    $best = $dtos[0] ?? null;

                    if ($best !== null && is_string($best->provider_id) && $best->provider_id !== '') {
                        return '/'
                            . rawurlencode($locale)
                            . '/part/from_info_provider/mouser/'
                            . rawurlencode($best->provider_id)
                            . '/create';
                    }

                    $this->addFlash('warning', 'No Mouser match found for this MPN.');
                    return null;
                } catch (\InvalidArgumentException) {
                    // provider key not found in registry
                    $this->addFlash('warning', 'Mouser provider is not installed/enabled.');
                    return null;
                } catch (\Throwable $e) {
                    // Don’t break scanning UX if provider lookup fails
                    $this->addFlash('warning', 'Mouser lookup failed: ' . $e->getMessage());
                    return null;
                }
            }

            // Digi-Key: can use customerPartNumber or supplierPartNumber directly
            if ($vendor === 'digikey') {
                try {
                    $provider = $this->providerRegistry->getProviderByKey('digikey');

                    if (!$provider->isActive()) {
                        $this->addFlash('warning', 'Digi-Key provider is disabled / not configured (API key missing).');
                        return null;
                    }

                    $id = $scanResult->customerPartNumber ?: $scanResult->supplierPartNumber;

                    if (is_string($id) && $id !== '') {
                        return '/'
                            . rawurlencode($locale)
                            . '/part/from_info_provider/digikey/'
                            . rawurlencode($id)
                            . '/create';
                    }
                } catch (\InvalidArgumentException) {
                    $this->addFlash('warning', 'Digi-Key provider is not installed/enabled');
                    return null;
                }
            }
        }

        return null;
    }

    private function buildLocationsForPart(Part $part): array
    {
        $byLocationId = [];

        foreach ($part->getPartLots() as $lot) {
            $loc = $lot->getStorageLocation();
            if ($loc === null) {
                continue;
            }

            $locId = $loc->getID();
            $qty = $lot->getAmount();

            if (!isset($byLocationId[$locId])) {
                $byLocationId[$locId] = [
                    'breadcrumb' => $this->buildStorageBreadcrumb($loc),
                    'qty' => $qty,
                ];
            } else {
                $byLocationId[$locId]['qty'] += $qty;
            }
        }

        return array_values($byLocationId);
    }

    private function buildStorageBreadcrumb(StorageLocation $loc): array
    {
        $items = [];
        $cur = $loc;

        // 20 is the overflow limit in src/Entity/Base/AbstractStructuralDBElement.php line ~273
        for ($i = 0; $i < 20 && $cur !== null; $i++) {
            $items[] = [
                'name' => $cur->getName(),
                'url'  => $this->generateUrl('part_list_store_location', ['id' => $cur->getID()]),
            ];

            $parent = $cur->getParent(); // inherited from AbstractStructuralDBElement
            $cur = ($parent instanceof StorageLocation) ? $parent : null;
        }

        return array_reverse($items);
    }




    #[Route(path: '/augmented', name: 'scan_augmented', methods: ['POST'])]
    public function augmented(Request $request): Response
    {
        $this->denyAccessUnlessGranted('@tools.label_scanner');

        $input = (string) $request->request->get('input', '');
        $mode  = $request->request->get('mode'); // string|null

        if ($input === '') {
            // Return empty fragment or an error fragment; your choice
            return new Response('', 200);
        }

        $modeEnum = null;
        if ($mode !== null && $mode !== '') {
            // Radio values are enum integers in your form
            $modeEnum = BarcodeSourceType::from((int) $mode);
        }

        $scan = $this->barcodeNormalizer->scanBarcodeContent($input, $modeEnum);
        $decoded = $scan->getDecodedForInfoMode();

        $locale = $request->getLocale();
        $part = $this->barcodeParser->resolvePartOrNull($scan);

        $found = $part !== null;
        $partName = null;
        $partUrl = null;
        $locations = [];
        $createUrl = null;

        if ($found) {
            $partName = $part->getName();

            // This is the same route BarcodeRedirector uses
            $partUrl = $this->generateUrl('app_part_show', ['id' => $part->getID()]);

            // Build locations (see below)
            $locations = $this->buildLocationsForPart($part);

        } else {
            // Reuse your centralized create-url logic (the helper you already extracted)
            $createUrl = $this->buildCreateUrlForScanResult($scan, $locale);
        }

        return $this->render('label_system/scanner/augmented_result.html.twig', [
            'decoded' => $decoded,
            'found' => $found,
            'partName' => $partName,
            'partUrl' => $partUrl,
            'locations' => $locations,
            'createUrl' => $createUrl,
        ]);
    }
}