Use new UniqueObjectCollection constraint to ensure that BOM entries does not contain duplicate items

src/Validator/Constraints/UniqueObjectCollection.php

@@ -0,0 +1,62 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 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\Validator\Constraints;
+
+use InvalidArgumentException;
+use Symfony\Component\Validator\Constraint;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class UniqueObjectCollection extends Constraint
+{
+    public const IS_NOT_UNIQUE = '7911c98d-b845-4da0-94b7-a8dac36bc55a';
+
+    public array|string $fields = [];
+
+    protected const ERROR_NAMES = [
+        self::IS_NOT_UNIQUE => 'IS_NOT_UNIQUE',
+    ];
+
+    public string $message = 'This collection should contain only unique elements.';
+    public $normalizer;
+
+    /**
+     * @param array|string $fields the combination of fields that must contain unique values or a set of options
+     */
+    public function __construct(
+        array $options = null,
+        string $message = null,
+        callable $normalizer = null,
+        array $groups = null,
+        mixed $payload = null,
+        array|string $fields = null,
+        public bool $allowNull = true,
+    ) {
+        parent::__construct($options, $groups, $payload);
+
+        $this->message = $message ?? $this->message;
+        $this->normalizer = $normalizer ?? $this->normalizer;
+        $this->fields = $fields ?? $this->fields;
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', get_debug_type($this->normalizer)));
+        }
+    }
+}

src/Validator/Constraints/UniqueObjectCollectionValidator.php

@@ -0,0 +1,113 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 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\Validator\Constraints;
+
+use App\Entity\Base\AbstractDBElement;
+use App\Validator\UniqueValidatableInterface;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Serializer;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+use Symfony\Component\Validator\Exception\UnexpectedValueException;
+
+class UniqueObjectCollectionValidator extends ConstraintValidator
+{
+
+    public function validate(mixed $value, Constraint $constraint)
+    {
+        if (!$constraint instanceof UniqueObjectCollection) {
+            throw new UnexpectedTypeException($constraint, UniqueObjectCollection::class);
+        }
+
+        $fields = (array) $constraint->fields;
+
+        if (null === $value) {
+            return;
+        }
+
+        if (!\is_array($value) && !$value instanceof \IteratorAggregate) {
+            throw new UnexpectedValueException($value, 'array|IteratorAggregate');
+        }
+
+        $collectionElements = [];
+        $normalizer = $this->getNormalizer($constraint);
+        foreach ($value as $key => $object) {
+
+            if (!$object instanceof UniqueValidatableInterface) {
+                throw new UnexpectedValueException($object, UniqueValidatableInterface::class);
+            }
+
+            //Convert the object to an array using the helper function
+            $element = $object->getComparableFields();
+
+            if ($fields && !$element = $this->reduceElementKeys($fields, $element, $constraint)) {
+                continue;
+            }
+
+            $element = $normalizer($element);
+
+            if (\in_array($element, $collectionElements, true)) {
+
+                $violation = $this->context->buildViolation($constraint->message);
+
+                $violation->atPath('[' . $key . ']' . '.' . $constraint->fields[0]);
+
+                $violation->setParameter('{{ value }}', $this->formatValue($value))
+                    ->setCode(UniqueObjectCollection::IS_NOT_UNIQUE)
+                    ->addViolation();
+
+                return;
+            }
+            $collectionElements[] = $element;
+        }
+    }
+
+    private function getNormalizer(UniqueObjectCollection $unique): callable
+    {
+        if (null === $unique->normalizer) {
+            return static fn ($value) => $value;
+        }
+
+        return $unique->normalizer;
+    }
+
+    private function reduceElementKeys(array $fields, array $element, UniqueObjectCollection $constraint): array
+    {
+        $output = [];
+        foreach ($fields as $field) {
+            if (!\is_string($field)) {
+                throw new UnexpectedTypeException($field, 'string');
+            }
+            if (\array_key_exists($field, $element)) {
+                //Ignore null values if specified
+                if ($element[$field] === null && $constraint->allowNull) {
+                    continue;
+                }
+
+                $output[$field] = $element[$field];
+            }
+        }
+
+        return $output;
+    }
+
+}

src/Validator/UniqueValidatableInterface.php

@@ -0,0 +1,32 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2023 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\Validator;
+
+interface UniqueValidatableInterface
+{
+    /**
+     * This method should return an array of fields that should be used to compare the objects for the UniqueObjectCollection constraint.
+     * All instances of the same class should return the same fields.
+     * The value must be a comparable value (e.g. string, int, float, bool, null).
+     * @return array An array of the form ['field1' => 'value1', 'field2' => 'value2', ...]
+     */
+    public function getComparableFields(): array;
+}