Allow to scan IPN barcodes using the built in barcode scanner

This improves issue #373

src/Controller/ScanController.php

@@ -71,11 +71,12 @@ class ScanController extends AbstractController
 
         if ($input === null && $form->isSubmitted() && $form->isValid()) {
             $input = $form['input']->getData();
+            $mode = $form['mode']->getData();
         }
 
         if ($input !== null) {
             try {
-                $scan_result = $this->barcodeNormalizer->scanBarcodeContent($input);
+                $scan_result = $this->barcodeNormalizer->scanBarcodeContent($input, $mode ?? null);
                 try {
                     return $this->redirect($this->barcodeParser->getRedirectURL($scan_result));
                 } catch (EntityNotFoundException) {

src/DataFixtures/PartFixtures.php

@@ -83,6 +83,7 @@ class PartFixtures extends Fixture implements DependentFixtureInterface
         $part->setManufacturer($manager->find(Manufacturer::class, 1));
         $part->setTags('test, Test, Part2');
         $part->setMass(100.2);
+        $part->setIpn('IPN123');
         $part->setNeedsReview(true);
         $part->setManufacturingStatus(ManufacturingStatus::ACTIVE);
         $manager->persist($part);

src/Form/LabelSystem/ScanDialogType.php

@@ -41,7 +41,9 @@ declare(strict_types=1);
 
 namespace App\Form\LabelSystem;
 
+use App\Services\LabelSystem\Barcodes\BarcodeSourceType;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\EnumType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -59,6 +61,20 @@ class ScanDialogType extends AbstractType
             ],
         ]);
 
+        $builder->add('mode', EnumType::class, [
+            'label' => 'scan_dialog.mode',
+            'expanded' => true,
+            'class' => BarcodeSourceType::class,
+            'required' => false,
+            'placeholder' => 'scan_dialog.mode.auto',
+            'choice_label' => fn (?BarcodeSourceType $enum) => match($enum) {
+                null => 'scan_dialog.mode.auto',
+                BarcodeSourceType::INTERNAL => 'scan_dialog.mode.internal',
+                BarcodeSourceType::IPN => 'scan_dialog.mode.ipn',
+            },
+
+        ]);
+
         $builder->add('submit', SubmitType::class, [
             'label' => 'scan_dialog.submit',
         ]);

src/Services/LabelSystem/Barcodes/BarcodeScanHelper.php

@@ -42,6 +42,8 @@ declare(strict_types=1);
 namespace App\Services\LabelSystem\Barcodes;
 
 use App\Entity\LabelSystem\LabelSupportedElement;
+use App\Entity\Parts\Part;
+use Doctrine\ORM\EntityManagerInterface;
 use InvalidArgumentException;
 
 /**
@@ -61,6 +63,10 @@ final class BarcodeScanHelper
         'location' => LabelSupportedElement::STORELOCATION,
     ];
 
+    public function __construct(private readonly EntityManagerInterface $entityManager)
+    {
+    }
+
     /**
      * Parse the given barcode content and return the target type and ID.
      * If the barcode could not be parsed, an exception is thrown.
@@ -76,6 +82,9 @@ final class BarcodeScanHelper
         if ($type === BarcodeSourceType::INTERNAL) {
             return $this->parseInternalBarcode($input) ?? throw new InvalidArgumentException('Could not parse barcode');
         }
+        if ($type === BarcodeSourceType::IPN) {
+            return $this->parseIPNBarcode($input) ?? throw new InvalidArgumentException('Could not parse barcode');
+        }
 
         //Null means auto and we try the different formats
         $result = $this->parseInternalBarcode($input);
@@ -83,9 +92,35 @@ final class BarcodeScanHelper
         if ($result !== null) {
             return $result;
         }
+
+        //Try to parse as IPN barcode
+        $result = $this->parseIPNBarcode($input);
+        if ($result !== null) {
+            return $result;
+        }
+
         throw new InvalidArgumentException('Unknown barcode format');
     }
 
+    private function parseIPNBarcode(string $input): ?BarcodeScanResult
+    {
+        $part_repo = $this->entityManager->getRepository(Part::class);
+        //Find only the first result
+        $results = $part_repo->findBy(['ipn' => $input], limit: 1);
+
+        if (count($results) === 0) {
+            return null;
+        }
+        //We found a part, so use it to create the result
+        $part = $results[0];
+
+        return new BarcodeScanResult(
+            target_type: LabelSupportedElement::PART,
+            target_id: $part->getID(),
+            source_type: BarcodeSourceType::IPN
+        );
+    }
+
     /**
      * This function tries to interpret the given barcode content as an internal barcode.
      * If the barcode could not be parsed at all, null is returned. If the barcode is a valid format, but could

src/Services/LabelSystem/Barcodes/BarcodeSourceType.php

@@ -30,4 +30,6 @@ enum BarcodeSourceType
 {
     /** This Barcode was generated using Part-DB internal recommended barcode generator */
     case INTERNAL;
+    /** This barcode is containing an internal part number (IPN) */
+    case IPN;
 }

tests/Services/LabelSystem/Barcodes/BarcodeScanHelperTest.php

@@ -103,6 +103,10 @@ class BarcodeScanHelperTest extends WebTestCase
             '00001236'];
         yield [new BarcodeScanResult(LabelSupportedElement::PART, 1_234_567, BarcodeSourceType::INTERNAL),
             '12345678'];
+
+        //Test IPN barcode
+        yield [new BarcodeScanResult(LabelSupportedElement::PART, 2, BarcodeSourceType::IPN),
+            'IPN123'];
     }
 
     public static function invalidDataProvider(): array

translations/security.en.xlf

@@ -2,13 +2,13 @@
 <xliff xmlns="urn:oasis:names:tc:xliff:document:2.0" version="2.0" srcLang="en" trgLang="en">
   <file id="security.en">
     <unit id="aazoCks" name="user.login_error.user_disabled">
-      <segment state="translated">
+      <segment>
         <source>user.login_error.user_disabled</source>
         <target>Your account is disabled! Contact an administrator if you think this is wrong.</target>
       </segment>
     </unit>
     <unit id="Dpb9AmY" name="saml.error.cannot_login_local_user_per_saml">
-      <segment state="translated">
+      <segment>
         <source>saml.error.cannot_login_local_user_per_saml</source>
         <target>You cannot login as local user via SSO! Use your local user password instead.</target>
       </segment>

translations/validators.en.xlf

@@ -37,7 +37,7 @@
         <note priority="1">Part-DB1\src\Entity\UserSystem\Group.php:0</note>
         <note priority="1">Part-DB1\src\Entity\UserSystem\User.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>part.master_attachment.must_be_picture</source>
         <target>The preview attachment must be a valid picture!</target>
       </segment>
@@ -82,7 +82,7 @@
         <note priority="1">src\Entity\StructuralDBElement.php:0</note>
         <note priority="1">src\Entity\Supplier.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>structural.entity.unique_name</source>
         <target>An element with this name already exists on this level!</target>
       </segment>
@@ -102,7 +102,7 @@
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\StorelocationParameter.php:0</note>
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\SupplierParameter.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>parameters.validator.min_lesser_typical</source>
         <target>Value must be lesser or equal the the typical value ({{ compared_value }}).</target>
       </segment>
@@ -122,7 +122,7 @@
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\StorelocationParameter.php:0</note>
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\SupplierParameter.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>parameters.validator.min_lesser_max</source>
         <target>Value must be lesser than the maximum value ({{ compared_value }}).</target>
       </segment>
@@ -142,7 +142,7 @@
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\StorelocationParameter.php:0</note>
         <note category="file-source" priority="1">Part-DB1\src\Entity\Parameters\SupplierParameter.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>parameters.validator.max_greater_typical</source>
         <target>Value must be greater or equal than the typical value ({{ compared_value }}).</target>
       </segment>
@@ -152,7 +152,7 @@
         <note category="file-source" priority="1">Part-DB1\src\Entity\UserSystem\User.php:0</note>
         <note priority="1">Part-DB1\src\Entity\UserSystem\User.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>validator.user.username_already_used</source>
         <target>A user with this name is already exisiting</target>
       </segment>
@@ -162,7 +162,7 @@
         <note category="file-source" priority="1">Part-DB1\src\Entity\UserSystem\User.php:0</note>
         <note priority="1">Part-DB1\src\Entity\UserSystem\User.php:0</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>user.invalid_username</source>
         <target>The username must contain only letters, numbers, underscores, dots, pluses or minuses!</target>
       </segment>
@@ -171,7 +171,7 @@
       <notes>
         <note category="state" priority="1">obsolete</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>validator.noneofitschild.self</source>
         <target>An element can not be its own parent!</target>
       </segment>
@@ -180,139 +180,139 @@
       <notes>
         <note category="state" priority="1">obsolete</note>
       </notes>
-      <segment state="translated">
+      <segment>
         <source>validator.noneofitschild.children</source>
         <target>You can not assign children element as parent (This would cause loops)!</target>
       </segment>
     </unit>
     <unit id="ayNr6QK" name="validator.select_valid_category">
-      <segment state="translated">
+      <segment>
         <source>validator.select_valid_category</source>
         <target>Please select a valid category!</target>
       </segment>
     </unit>
     <unit id="6vIlN5q" name="validator.part_lot.only_existing">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.only_existing</source>
         <target>Can not add new parts to this location as it is marked as "Only Existing"</target>
       </segment>
     </unit>
     <unit id="3xoKOIS" name="validator.part_lot.location_full.no_increase">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.location_full.no_increase</source>
         <target>Location is full. Amount can not be increased (new value must be smaller than {{ old_amount }}).</target>
       </segment>
     </unit>
     <unit id="R6Ov4Yt" name="validator.part_lot.location_full">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.location_full</source>
         <target>Location is full. Can not add new parts to it.</target>
       </segment>
     </unit>
     <unit id="BNQk2e7" name="validator.part_lot.single_part">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.single_part</source>
         <target>This location can only contain a single part and it is already full!</target>
       </segment>
     </unit>
     <unit id="4gPskOG" name="validator.attachment.must_not_be_null">
-      <segment state="translated">
+      <segment>
         <source>validator.attachment.must_not_be_null</source>
         <target>You must select an attachment type!</target>
       </segment>
     </unit>
     <unit id="cDDVrWT" name="validator.orderdetail.supplier_must_not_be_null">
-      <segment state="translated">
+      <segment>
         <source>validator.orderdetail.supplier_must_not_be_null</source>
         <target>You must select an supplier!</target>
       </segment>
     </unit>
     <unit id="k5DDdB4" name="validator.measurement_unit.use_si_prefix_needs_unit">
-      <segment state="translated">
+      <segment>
         <source>validator.measurement_unit.use_si_prefix_needs_unit</source>
         <target>To enable SI prefixes, you have to set a unit symbol!</target>
       </segment>
     </unit>
     <unit id="DuzIOCr" name="part.ipn.must_be_unique">
-      <segment state="translated">
+      <segment>
         <source>part.ipn.must_be_unique</source>
         <target>The internal part number must be unique. {{ value }} is already in use!</target>
       </segment>
     </unit>
     <unit id="Z4Kuuo2" name="validator.project.bom_entry.name_or_part_needed">
-      <segment state="translated">
+      <segment>
         <source>validator.project.bom_entry.name_or_part_needed</source>
         <target>You have to choose a part for a part BOM entry or set a name for a non-part BOM entry.</target>
       </segment>
     </unit>
     <unit id="WF_v4ih" name="project.bom_entry.name_already_in_bom">
-      <segment state="translated">
+      <segment>
         <source>project.bom_entry.name_already_in_bom</source>
         <target>There is already an BOM entry with this name!</target>
       </segment>
     </unit>
     <unit id="5v4p85H" name="project.bom_entry.part_already_in_bom">
-      <segment state="translated">
+      <segment>
         <source>project.bom_entry.part_already_in_bom</source>
         <target>This part already exists in the BOM!</target>
       </segment>
     </unit>
     <unit id="3lM32Tw" name="project.bom_entry.mountnames_quantity_mismatch">
-      <segment state="translated">
+      <segment>
         <source>project.bom_entry.mountnames_quantity_mismatch</source>
         <target>The number of mountnames has to match the BOMs quantity!</target>
       </segment>
     </unit>
     <unit id="x47D5WT" name="project.bom_entry.can_not_add_own_builds_part">
-      <segment state="translated">
+      <segment>
         <source>project.bom_entry.can_not_add_own_builds_part</source>
         <target>You can not add a project's own builds part to the BOM.</target>
       </segment>
     </unit>
     <unit id="2x2XDI_" name="project.bom_has_to_include_all_subelement_parts">
-      <segment state="translated">
+      <segment>
         <source>project.bom_has_to_include_all_subelement_parts</source>
         <target>The project BOM has to include all subprojects builds parts. Part %part_name% of project %project_name% missing!</target>
       </segment>
     </unit>
     <unit id="U9b1EzD" name="project.bom_entry.price_not_allowed_on_parts">
-      <segment state="translated">
+      <segment>
         <source>project.bom_entry.price_not_allowed_on_parts</source>
         <target>Prices are not allowed on BOM entries associated with a part. Define the price on the part instead.</target>
       </segment>
     </unit>
     <unit id="ID056SR" name="validator.project_build.lot_bigger_than_needed">
-      <segment state="translated">
+      <segment>
         <source>validator.project_build.lot_bigger_than_needed</source>
         <target>You have selected more quantity to withdraw than needed! Remove unnecessary quantity.</target>
       </segment>
     </unit>
     <unit id="6hV5UqD" name="validator.project_build.lot_smaller_than_needed">
-      <segment state="translated">
+      <segment>
         <source>validator.project_build.lot_smaller_than_needed</source>
         <target>You have selected less quantity to withdraw than needed for the build! Add additional quantity.</target>
       </segment>
     </unit>
     <unit id="G9ZKt.4" name="part.name.must_match_category_regex">
-      <segment state="translated">
+      <segment>
         <source>part.name.must_match_category_regex</source>
         <target>The part name does not match the regular expression stated by the category: %regex%</target>
       </segment>
     </unit>
     <unit id="m8kMFhf" name="validator.attachment.name_not_blank">
-      <segment state="translated">
+      <segment>
         <source>validator.attachment.name_not_blank</source>
         <target>Set a value here, or upload a file to automatically use its filename as name for the attachment.</target>
       </segment>
     </unit>
     <unit id="nwGaNBW" name="validator.part_lot.owner_must_match_storage_location_owner">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.owner_must_match_storage_location_owner</source>
         <target>The owner of this lot must match the owner of the selected storage location (%owner_name%)!</target>
       </segment>
     </unit>
     <unit id="HXSz3nQ" name="validator.part_lot.owner_must_not_be_anonymous">
-      <segment state="translated">
+      <segment>
         <source>validator.part_lot.owner_must_not_be_anonymous</source>
         <target>A lot owner must not be the anonymous user!</target>
       </segment>