groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-01-13 05:39:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

IPN-Vorschlagslogik erweitert und Bauteil-IPN vereindeutigt

Browse source 
Die IPN-Logik wurde um eine Konfiguration zur automatischen Suffix-Anfügung und die Berücksichtigung von doppelten Beschreibungen bei Bedarf ergänzt. Zudem wurde das Datenmodell angepasst, um eine eindeutige Speicherung der IPN zu gewährleisten.
This commit is contained in:
Marcel Diegelmann 2025-09-29 13:54:13 +02:00
parent 9b90a513c9
commit 654c2ed2af
16 changed files with 165 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/Controller/PartController.php
View file

@ -452,7 +452,7 @@ final class PartController extends AbstractController
$template,
[
'part' => $new_part,
'ipnSuggestions' => $partRepository->autoCompleteIpn($data, base64_encode($data->getDescription()), $this->ipnSuggestSettings->suggestPartDigits),
'ipnSuggestions' => $partRepository->autoCompleteIpn($data, $data->getDescription(), $this->ipnSuggestSettings->suggestPartDigits),
'form' => $form,
'merge_old_name' => $merge_infos['tname_before'] ?? null,
'merge_other' => $merge_infos['other_part'] ?? null,

2
src/Controller/TypeaheadController.php
View file

@ -198,7 +198,7 @@ class TypeaheadController extends AbstractController
$partId = null;
}
$categoryId = $request->query->getInt('categoryId');
$description = $request->query->getString('description');
$description = base64_decode($request->query->getString('description'), true);
/** @var Part $part */
$part = $partId !== null ? $entityManager->getRepository(Part::class)->find($partId) : new Part();

2
src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php
View file

@ -63,7 +63,7 @@ trait AdvancedPropertyTrait
*/
#[Assert\Length(max: 100)]
#[Groups(['extended', 'full', 'import', 'part:read', 'part:write'])]
#[ORM\Column(type: Types::STRING, length: 100, nullable: true)]
#[ORM\Column(type: Types::STRING, length: 100, unique: true, nullable: true)]
#[Length(max: 100)]
#[UniquePartIpnConstraint]
protected ?string $ipn = null;

95
src/EventSubscriber/UserSystem/PartUniqueIpnSubscriber.php
View file

@ -5,14 +5,12 @@ namespace App\EventSubscriber\UserSystem;
use App\Entity\Parts\Part;
use App\Settings\MiscSettings\IpnSuggestSettings;
use Doctrine\Common\EventSubscriber;
use Doctrine\Persistence\Event\LifecycleEventArgs;
use Doctrine\ORM\Events;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Event\OnFlushEventArgs;
class PartUniqueIpnSubscriber implements EventSubscriber
{
public function __construct(
private EntityManagerInterface $entityManager,
private IpnSuggestSettings $ipnSuggestSettings
) {
}
@ -20,55 +18,80 @@ class PartUniqueIpnSubscriber implements EventSubscriber
public function getSubscribedEvents(): array
{
return [
Events::prePersist,
Events::preUpdate,
Events::onFlush,
];
}
public function prePersist(LifecycleEventArgs $args): void
public function onFlush(OnFlushEventArgs $args): void
{
$entity = $args->getObject();
if ($entity instanceof Part) {
$this->ensureUniqueIpn($entity);
}
}
public function preUpdate(LifecycleEventArgs $args): void
{
$entity = $args->getObject();
if ($entity instanceof Part) {
$this->ensureUniqueIpn($entity);
}
}
private function ensureUniqueIpn(Part $part): void
{
if ($part->getIpn() === null || $part->getIpn() === '') {
if (!$this->ipnSuggestSettings->autoAppendSuffix) {
return;
}
$existingPart = $this->entityManager
->getRepository(Part::class)
->findOneBy(['ipn' => $part->getIpn()]);
$em = $args->getObjectManager();
$uow = $em->getUnitOfWork();
$meta = $em->getClassMetadata(Part::class);
if ($existingPart && $existingPart->getId() !== $part->getId()) {
if ($this->ipnSuggestSettings->enableUniqueCheck) {
// Collect all IPNs already reserved in the current flush (so new entities do not collide with each other)
$reservedIpns = [];
// Helper to assign a collision-free IPN for a Part entity
$ensureUnique = function (Part $part) use ($em, $uow, $meta, &$reservedIpns) {
$ipn = $part->getIpn();
if ($ipn === null || $ipn === '') {
return;
}
// Anhang eines Inkrements bis ein einzigartiger Wert gefunden wird
// Check against IPNs already reserved in the current flush (except itself)
$originalIpn = $ipn;
$candidate = $originalIpn;
$increment = 1;
$originalIpn = $part->getIpn();
while ($this->entityManager
->getRepository(Part::class)
->findOneBy(['ipn' => $originalIpn . "_$increment"])) {
$conflicts = function (string $candidate) use ($em, $part, $reservedIpns) {
// Collision within the current flush session?
if (isset($reservedIpns[$candidate]) && $reservedIpns[$candidate] !== $part) {
return true;
}
// Collision with an existing DB row?
$existing = $em->getRepository(Part::class)->findOneBy(['ipn' => $candidate]);
return $existing !== null && $existing->getId() !== $part->getId();
};
while ($conflicts($candidate)) {
$candidate = $originalIpn . '_' . $increment;
$increment++;
}
$part->setIpn($originalIpn . "_$increment");
if ($candidate !== $ipn) {
$before = $part->getIpn();
$part->setIpn($candidate);
// Recompute the change set so Doctrine writes the change
$uow->recomputeSingleEntityChangeSet($meta, $part);
$reservedIpns[$candidate] = $part;
// If the old IPN was reserved already, clean it up
if ($before !== null && isset($reservedIpns[$before]) && $reservedIpns[$before] === $part) {
unset($reservedIpns[$before]);
}
} else {
// Candidate unchanged, but reserve it so subsequent entities see it
$reservedIpns[$candidate] = $part;
}
};
// 1) Iterate over new entities
foreach ($uow->getScheduledEntityInsertions() as $entity) {
if ($entity instanceof Part) {
$ensureUnique($entity);
}
}
// 2) Iterate over updates (if IPN changed, ensure uniqueness again)
foreach ($uow->getScheduledEntityUpdates() as $entity) {
if ($entity instanceof Part) {
$ensureUnique($entity);
}
}
}
}

25
src/Form/Part/PartBaseType.php
View file

@ -41,6 +41,7 @@ use App\Form\Type\StructuralEntityType;
use App\Services\InfoProviderSystem\DTOs\PartDetailDTO;
use App\Services\LogSystem\EventCommentNeededHelper;
use App\Services\LogSystem\EventCommentType;
use App\Settings\MiscSettings\IpnSuggestSettings;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
@ -56,8 +57,12 @@ use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
class PartBaseType extends AbstractType
{
public function __construct(protected Security $security, protected UrlGeneratorInterface $urlGenerator, protected EventCommentNeededHelper $event_comment_needed_helper)
{
public function __construct(
protected Security $security,
protected UrlGeneratorInterface $urlGenerator,
protected EventCommentNeededHelper $event_comment_needed_helper,
protected IpnSuggestSettings $ipnSuggestSettings,
) {
}
public function buildForm(FormBuilderInterface $builder, array $options): void
@ -69,6 +74,16 @@ class PartBaseType extends AbstractType
/** @var PartDetailDTO|null $dto */
$dto = $options['info_provider_dto'];
$descriptionAttr = [
'placeholder' => 'part.edit.description.placeholder',
'rows' => 2,
];
if ($this->ipnSuggestSettings->useDuplicateDescription) {
// Only add attribute when duplicate description feature is enabled
$descriptionAttr['data-ipn-suggestion'] = 'descriptionField';
}
//Common section
$builder
->add('name', TextType::class, [
@ -83,11 +98,7 @@ class PartBaseType extends AbstractType
'empty_data' => '',
'label' => 'part.edit.description',
'mode' => 'markdown-single_line',
'attr' => [
'placeholder' => 'part.edit.description.placeholder',
'rows' => 2,
'data-ipn-suggestion' => 'descriptionField',
],
'attr' => $descriptionAttr,
])
->add('minAmount', SIUnitType::class, [
'attr' => [

42
src/Repository/PartRepository.php
View file

@ -25,6 +25,7 @@ namespace App\Repository;
use App\Entity\Parts\Category;
use App\Entity\Parts\Part;
use App\Entity\Parts\PartLot;
use App\Settings\MiscSettings\IpnSuggestSettings;
use Doctrine\ORM\NonUniqueResultException;
use Doctrine\ORM\NoResultException;
use Doctrine\ORM\QueryBuilder;
@ -37,14 +38,17 @@ use Doctrine\ORM\EntityManagerInterface;
class PartRepository extends NamedDBElementRepository
{
private TranslatorInterface $translator;
private IpnSuggestSettings $ipnSuggestSettings;
public function __construct(
EntityManagerInterface $em,
TranslatorInterface $translator
TranslatorInterface $translator,
IpnSuggestSettings $ipnSuggestSettings,
) {
parent::__construct($em, $em->getClassMetadata(Part::class));
$this->translator = $translator;
$this->ipnSuggestSettings = $ipnSuggestSettings;
}
/**
@ -98,8 +102,7 @@ class PartRepository extends NamedDBElementRepository
->where('ILIKE(part.name, :query) = TRUE')
->orWhere('ILIKE(part.description, :query) = TRUE')
->orWhere('ILIKE(category.name, :query) = TRUE')
->orWhere('ILIKE(footprint.name, :query) = TRUE')
;
->orWhere('ILIKE(footprint.name, :query) = TRUE');
$qb->setParameter('query', '%'.$query.'%');
@ -117,7 +120,7 @@ class PartRepository extends NamedDBElementRepository
* the part's current category and its hierarchy. If the part is unsaved, a default "n.a." prefix is returned.
*
* @param Part $part The part for which autocomplete suggestions are generated.
* @param string $description Base64-encoded description to assist in generating suggestions.
* @param string $description description to assist in generating suggestions.
* @param int $suggestPartDigits The number of digits used in autocomplete increments.
*
* @return array An associative array containing the following keys:
@ -128,24 +131,13 @@ class PartRepository extends NamedDBElementRepository
{
$category = $part->getCategory();
$ipnSuggestions = ['commonPrefixes' => [], 'prefixesPartIncrement' => []];
$description = base64_decode($description, true);
if (strlen($description) > 150) {
$description = substr($description, 0, 150);
}
// Validate the category and ensure it's an instance of Category
if ($category instanceof Category) {
$currentPath = $category->getPartIpnPrefix();
$directIpnPrefixEmpty = $category->getPartIpnPrefix() === '';
$currentPath = $currentPath === '' ? 'n.a.' : $currentPath;
$increment = $this->generateNextPossiblePartIncrement($currentPath, $part, $suggestPartDigits);
$ipnSuggestions['commonPrefixes'][] = [
'title' => $currentPath . '-',
'description' => $directIpnPrefixEmpty ? $this->translator->trans('part.edit.tab.advanced.ipn.prefix_empty.direct_category', ['%name%' => $category->getName()]) : $this->translator->trans('part.edit.tab.advanced.ipn.prefix.direct_category')
];
if ($description !== '' && $this->ipnSuggestSettings->useDuplicateDescription) {
// Check if the description is already used in another part,
$suggestionByDescription = $this->getIpnSuggestByDescription($description);
@ -162,6 +154,20 @@ class PartRepository extends NamedDBElementRepository
'description' => $this->translator->trans('part.edit.tab.advanced.ipn.prefix.description.increment')
];
}
}
// Validate the category and ensure it's an instance of Category
if ($category instanceof Category) {
$currentPath = $category->getPartIpnPrefix();
$directIpnPrefixEmpty = $category->getPartIpnPrefix() === '';
$currentPath = $currentPath === '' ? 'n.a.' : $currentPath;
$increment = $this->generateNextPossiblePartIncrement($currentPath, $part, $suggestPartDigits);
$ipnSuggestions['commonPrefixes'][] = [
'title' => $currentPath . '-',
'description' => $directIpnPrefixEmpty ? $this->translator->trans('part.edit.tab.advanced.ipn.prefix_empty.direct_category', ['%name%' => $category->getName()]) : $this->translator->trans('part.edit.tab.advanced.ipn.prefix.direct_category')
];
$ipnSuggestions['prefixesPartIncrement'][] = [
'title' => $currentPath . '-' . $increment,
@ -331,7 +337,7 @@ class PartRepository extends NamedDBElementRepository
// Find the basic format (the IPN without suffix) from the first IPN
$baseIpn = $givenIpns[0] ?? '';
$baseIpn = preg_replace('/_\d+$/', '', $baseIpn); // Entferne vorhandene "_<Zahl>"
$baseIpn = preg_replace('/_\d+$/', '', $baseIpn); // Remove existing "_ <number>"
if ($baseIpn === '') {
return null;

12
src/Settings/MiscSettings/IpnSuggestSettings.php
View file

@ -39,10 +39,10 @@ class IpnSuggestSettings
use SettingsTrait;
#[SettingsParameter(
label: new TM("settings.misc.ipn_suggest.enableUniqueCheck"),
envVar: "bool:IPN_ENABLE_UNIQUE_CHECK", envVarMode: EnvVarMode::OVERWRITE,
label: new TM("settings.misc.ipn_suggest.autoAppendSuffix"),
envVar: "bool:IPN_AUTO_APPEND_SUFFIX", envVarMode: EnvVarMode::OVERWRITE,
)]
public bool $enableUniqueCheck = true;
public bool $autoAppendSuffix = true;
#[SettingsParameter(label: new TM("settings.misc.ipn_suggest.suggestPartDigits"),
description: new TM("settings.misc.ipn_suggest.suggestPartDigits.help"),
@ -51,4 +51,10 @@ class IpnSuggestSettings
)]
#[Assert\Range(min: 1, max: 6)]
public int $suggestPartDigits = 4;
#[SettingsParameter(
label: new TM("settings.misc.ipn_suggest.useDuplicateDescription"),
envVar: "bool:IPN_USE_DUPLICATE_DESCRIPTION", envVarMode: EnvVarMode::OVERWRITE,
)]
public bool $useDuplicateDescription = false;
}

16
src/Validator/Constraints/UniquePartIpnConstraint.php
View file

@ -2,19 +2,21 @@
namespace App\Validator\Constraints;
use Attribute;
use Symfony\Component\Validator\Constraint;
/**
* @Annotation
* @Target({"PROPERTY"})
*/
#[\Attribute(\Attribute::TARGET_PROPERTY)]
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
class UniquePartIpnConstraint extends Constraint
{
public string $message = 'part.ipn.must_be_unique';
public string $message = 'part.ipn.must_be_unique';
public function getTargets(): string|array
{
return [self::CLASS_CONSTRAINT, self::PROPERTY_CONSTRAINT];
}
public function validatedBy(): string
{
return UniquePartIpnValidator::class;
}
}
}

2
src/Validator/Constraints/UniquePartIpnValidator.php
View file

@ -25,7 +25,7 @@ class UniquePartIpnValidator extends ConstraintValidator
return;
}
if (!$this->ipnSuggestSettings->enableUniqueCheck) {
if ($this->ipnSuggestSettings->autoAppendSuffix) {
return;
}