Merge branch 'master' into settings-bundle

src/Controller/ToolsController.php

@@ -22,17 +22,18 @@ declare(strict_types=1);
  */
 namespace App\Controller;
 
-use Symfony\Component\Runtime\SymfonyRuntime;
 use App\Services\Attachments\AttachmentSubmitHandler;
 use App\Services\Attachments\AttachmentURLGenerator;
 use App\Services\Attachments\BuiltinAttachmentsFinder;
+use App\Services\Doctrine\DBInfoHelper;
+use App\Services\Doctrine\NatsortDebugHelper;
 use App\Services\Misc\GitVersionInfo;
-use App\Services\Misc\DBInfoHelper;
 use App\Services\System\UpdateAvailableManager;
 use App\Settings\AppSettings;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Runtime\SymfonyRuntime;
 
 #[Route(path: '/tools')]
 class ToolsController extends AbstractController
@@ -46,7 +47,7 @@ class ToolsController extends AbstractController
     }
 
     #[Route(path: '/server_infos', name: 'tools_server_infos')]
-    public function systemInfos(GitVersionInfo $versionInfo, DBInfoHelper $DBInfoHelper,
+    public function systemInfos(GitVersionInfo $versionInfo, DBInfoHelper $DBInfoHelper, NatsortDebugHelper $natsortDebugHelper,
         AttachmentSubmitHandler $attachmentSubmitHandler, UpdateAvailableManager $updateAvailableManager,
         AppSettings $settings): Response
     {
@@ -95,6 +96,8 @@ class ToolsController extends AbstractController
             'db_size' => $DBInfoHelper->getDatabaseSize(),
             'db_name' => $DBInfoHelper->getDatabaseName() ?? 'Unknown',
             'db_user' => $DBInfoHelper->getDatabaseUsername() ?? 'Unknown',
+            'db_natsort_method' => $natsortDebugHelper->getNaturalSortMethod(),
+            'db_natsort_slow_allowed' => $natsortDebugHelper->isSlowNaturalSortAllowed(),
 
             //New version section
             'new_version_available' => $updateAvailableManager->isUpdateAvailable(),

src/Doctrine/Functions/Natsort.php

@@ -55,6 +55,15 @@ class Natsort extends FunctionNode
         self::$allowSlowNaturalSort = $allow;
     }
 
+    /**
+     * Check if the slow natural sort is allowed
+     * @return bool
+     */
+    public static function isSlowNaturalSortAllowed(): bool
+    {
+        return self::$allowSlowNaturalSort;
+    }
+
     /**
      * Check if the MariaDB version which is connected to supports the natural sort (meaning it has a version of 10.7.0 or higher)
      * The result is cached in memory.

src/Form/Fixes/FixNumberType.php

@@ -0,0 +1,51 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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);
+
+
+namespace App\Form\Fixes;
+
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\NumberType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class FixNumberType extends AbstractTypeExtension
+{
+
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        //Remove existing view transformers
+        $builder->resetViewTransformers();
+
+        //And add our fixed version
+        $builder->addViewTransformer(new FixedNumberToLocalizedStringTransformer(
+            $options['scale'],
+            $options['grouping'],
+            $options['rounding_mode'],
+            $options['html5'] ? 'en' : null
+        ));
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [NumberType::class];
+    }
+}

src/Form/Fixes/FixedNumberToLocalizedStringTransformer.php

@@ -0,0 +1,228 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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\Form\Fixes;
+
+use Symfony\Component\Form\DataTransformerInterface;
+use Symfony\Component\Form\Exception\TransformationFailedException;
+
+/**
+ * Same as the default NumberToLocalizedStringTransformer, but with a fix for the decimal separator.
+ * See https://github.com/symfony/symfony/pull/57861
+ */
+class FixedNumberToLocalizedStringTransformer implements DataTransformerInterface
+{
+    protected $grouping;
+
+    protected $roundingMode;
+
+    private ?int $scale;
+    private ?string $locale;
+
+    public function __construct(?int $scale = null, ?bool $grouping = false, ?int $roundingMode = \NumberFormatter::ROUND_HALFUP, ?string $locale = null)
+    {
+        $this->scale = $scale;
+        $this->grouping = $grouping ?? false;
+        $this->roundingMode = $roundingMode ?? \NumberFormatter::ROUND_HALFUP;
+        $this->locale = $locale;
+    }
+
+    /**
+     * Transforms a number type into localized number.
+     *
+     * @param int|float|null $value Number value
+     *
+     * @throws TransformationFailedException if the given value is not numeric
+     *                                       or if the value cannot be transformed
+     */
+    public function transform(mixed $value): string
+    {
+        if (null === $value) {
+            return '';
+        }
+
+        if (!is_numeric($value)) {
+            throw new TransformationFailedException('Expected a numeric.');
+        }
+
+        $formatter = $this->getNumberFormatter();
+        $value = $formatter->format($value);
+
+        if (intl_is_failure($formatter->getErrorCode())) {
+            throw new TransformationFailedException($formatter->getErrorMessage());
+        }
+
+        // Convert non-breaking and narrow non-breaking spaces to normal ones
+        $value = str_replace(["\xc2\xa0", "\xe2\x80\xaf"], ' ', $value);
+
+        return $value;
+    }
+
+    /**
+     * Transforms a localized number into an integer or float.
+     *
+     * @param string $value The localized value
+     *
+     * @throws TransformationFailedException if the given value is not a string
+     *                                       or if the value cannot be transformed
+     */
+    public function reverseTransform(mixed $value): int|float|null
+    {
+        if (null !== $value && !\is_string($value)) {
+            throw new TransformationFailedException('Expected a string.');
+        }
+
+        if (null === $value || '' === $value) {
+            return null;
+        }
+
+        if (\in_array($value, ['NaN', 'NAN', 'nan'], true)) {
+            throw new TransformationFailedException('"NaN" is not a valid number.');
+        }
+
+        $position = 0;
+        $formatter = $this->getNumberFormatter();
+        $groupSep = $formatter->getSymbol(\NumberFormatter::GROUPING_SEPARATOR_SYMBOL);
+        $decSep = $formatter->getSymbol(\NumberFormatter::DECIMAL_SEPARATOR_SYMBOL);
+
+        if ('.' !== $decSep && (!$this->grouping || '.' !== $groupSep)) {
+            $value = str_replace('.', $decSep, $value);
+        }
+
+        if (',' !== $decSep && (!$this->grouping || ',' !== $groupSep)) {
+            $value = str_replace(',', $decSep, $value);
+        }
+
+        //If the value is in exponential notation with a negative exponent, we end up with a float value too
+        if (str_contains($value, $decSep) || stripos($value, 'e-') !== false) {
+            $type = \NumberFormatter::TYPE_DOUBLE;
+        } else {
+            $type = \PHP_INT_SIZE === 8
+                ? \NumberFormatter::TYPE_INT64
+                : \NumberFormatter::TYPE_INT32;
+        }
+
+        $result = $formatter->parse($value, $type, $position);
+
+        if (intl_is_failure($formatter->getErrorCode())) {
+            throw new TransformationFailedException($formatter->getErrorMessage());
+        }
+
+        if ($result >= \PHP_INT_MAX || $result <= -\PHP_INT_MAX) {
+            throw new TransformationFailedException('I don\'t have a clear idea what infinity looks like.');
+        }
+
+        $result = $this->castParsedValue($result);
+
+        if (false !== $encoding = mb_detect_encoding($value, null, true)) {
+            $length = mb_strlen($value, $encoding);
+            $remainder = mb_substr($value, $position, $length, $encoding);
+        } else {
+            $length = \strlen($value);
+            $remainder = substr($value, $position, $length);
+        }
+
+        // After parsing, position holds the index of the character where the
+        // parsing stopped
+        if ($position < $length) {
+            // Check if there are unrecognized characters at the end of the
+            // number (excluding whitespace characters)
+            $remainder = trim($remainder, " \t\n\r\0\x0b\xc2\xa0");
+
+            if ('' !== $remainder) {
+                throw new TransformationFailedException(sprintf('The number contains unrecognized characters: "%s".', $remainder));
+            }
+        }
+
+        // NumberFormatter::parse() does not round
+        return $this->round($result);
+    }
+
+    /**
+     * Returns a preconfigured \NumberFormatter instance.
+     */
+    protected function getNumberFormatter(): \NumberFormatter
+    {
+        $formatter = new \NumberFormatter($this->locale ?? \Locale::getDefault(), \NumberFormatter::DECIMAL);
+
+        if (null !== $this->scale) {
+            $formatter->setAttribute(\NumberFormatter::FRACTION_DIGITS, $this->scale);
+            $formatter->setAttribute(\NumberFormatter::ROUNDING_MODE, $this->roundingMode);
+        }
+
+        $formatter->setAttribute(\NumberFormatter::GROUPING_USED, $this->grouping);
+
+        return $formatter;
+    }
+
+    /**
+     * @internal
+     */
+    protected function castParsedValue(int|float $value): int|float
+    {
+        if (\is_int($value) && $value === (int) $float = (float) $value) {
+            return $float;
+        }
+
+        return $value;
+    }
+
+    /**
+     * Rounds a number according to the configured scale and rounding mode.
+     */
+    private function round(int|float $number): int|float
+    {
+        if (null !== $this->scale && null !== $this->roundingMode) {
+            // shift number to maintain the correct scale during rounding
+            $roundingCoef = 10 ** $this->scale;
+            // string representation to avoid rounding errors, similar to bcmul()
+            $number = (string) ($number * $roundingCoef);
+
+            switch ($this->roundingMode) {
+                case \NumberFormatter::ROUND_CEILING:
+                    $number = ceil($number);
+                    break;
+                case \NumberFormatter::ROUND_FLOOR:
+                    $number = floor($number);
+                    break;
+                case \NumberFormatter::ROUND_UP:
+                    $number = $number > 0 ? ceil($number) : floor($number);
+                    break;
+                case \NumberFormatter::ROUND_DOWN:
+                    $number = $number > 0 ? floor($number) : ceil($number);
+                    break;
+                case \NumberFormatter::ROUND_HALFEVEN:
+                    $number = round($number, 0, \PHP_ROUND_HALF_EVEN);
+                    break;
+                case \NumberFormatter::ROUND_HALFUP:
+                    $number = round($number, 0, \PHP_ROUND_HALF_UP);
+                    break;
+                case \NumberFormatter::ROUND_HALFDOWN:
+                    $number = round($number, 0, \PHP_ROUND_HALF_DOWN);
+                    break;
+            }
+
+            $number = 1 === $roundingCoef ? (int) $number : $number / $roundingCoef;
+        }
+
+        return $number;
+    }
+}

src/Form/ParameterType.php

@@ -53,6 +53,7 @@ use App\Entity\Parameters\PartParameter;
 use App\Entity\Parameters\StorageLocationParameter;
 use App\Entity\Parameters\SupplierParameter;
 use App\Entity\Parts\MeasurementUnit;
+use App\Form\Type\ExponentialNumberType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\NumberType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
@@ -93,7 +94,7 @@ class ParameterType extends AbstractType
             ],
         ]);
 
-        $builder->add('value_max', NumberType::class, [
+        $builder->add('value_max', ExponentialNumberType::class, [
             'label' => false,
             'required' => false,
             'html5' => true,
@@ -104,7 +105,7 @@ class ParameterType extends AbstractType
                 'style' => 'max-width: 12ch;',
             ],
         ]);
-        $builder->add('value_min', NumberType::class, [
+        $builder->add('value_min', ExponentialNumberType::class, [
             'label' => false,
             'required' => false,
             'html5' => true,
@@ -115,7 +116,7 @@ class ParameterType extends AbstractType
                 'style' => 'max-width: 12ch;',
             ],
         ]);
-        $builder->add('value_typical', NumberType::class, [
+        $builder->add('value_typical', ExponentialNumberType::class, [
             'label' => false,
             'required' => false,
             'html5' => true,

src/Form/Type/ExponentialNumberType.php

@@ -0,0 +1,52 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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);
+
+
+namespace App\Form\Type;
+
+use App\Form\Type\Helper\ExponentialNumberTransformer;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\NumberType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+/**
+ * Similar to the NumberType, but formats small values in scienfitic notation instead of rounding it to 0, like NumberType
+ */
+class ExponentialNumberType extends AbstractType
+{
+    public function getParent(): string
+    {
+        return NumberType::class;
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder->resetViewTransformers();
+
+        $builder->addViewTransformer(new ExponentialNumberTransformer(
+            $options['scale'],
+            $options['grouping'],
+            $options['rounding_mode'],
+            $options['html5'] ? 'en' : null
+        ));
+    }
+}

src/Form/Type/Helper/ExponentialNumberTransformer.php

@@ -0,0 +1,96 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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);
+
+
+namespace App\Form\Type\Helper;
+
+use App\Form\Fixes\FixedNumberToLocalizedStringTransformer;
+use Symfony\Component\Form\Exception\TransformationFailedException;
+
+/**
+ * This transformer formats small values in scienfitic notation instead of rounding it to 0, like the default
+ * NumberFormatter.
+ */
+class ExponentialNumberTransformer extends FixedNumberToLocalizedStringTransformer
+{
+    public function __construct(
+        protected ?int $scale = null,
+        ?bool $grouping = false,
+        ?int $roundingMode = \NumberFormatter::ROUND_HALFUP,
+        protected ?string $locale = null
+    ) {
+        parent::__construct($scale, $grouping, $roundingMode, $locale);
+    }
+
+    /**
+     * Transforms a number type into localized number.
+     *
+     * @param int|float|null $value Number value
+     *
+     * @throws TransformationFailedException if the given value is not numeric
+     *                                       or if the value cannot be transformed
+     */
+    public function transform(mixed $value): string
+    {
+        if (null === $value) {
+            return '';
+        }
+
+        if (!is_numeric($value)) {
+            throw new TransformationFailedException('Expected a numeric.');
+        }
+
+        //If the value is too small, the number formatter would return 0, therfore use exponential notation for small numbers
+        if (abs($value) < 1e-3) {
+            $formatter = $this->getScientificNumberFormatter();
+        } else {
+            $formatter = $this->getNumberFormatter();
+        }
+
+
+
+        $value = $formatter->format($value);
+
+        if (intl_is_failure($formatter->getErrorCode())) {
+            throw new TransformationFailedException($formatter->getErrorMessage());
+        }
+
+        // Convert non-breaking and narrow non-breaking spaces to normal ones
+        $value = str_replace(["\xc2\xa0", "\xe2\x80\xaf"], ' ', $value);
+
+        return $value;
+    }
+
+    protected function getScientificNumberFormatter(): \NumberFormatter
+    {
+        $formatter = new \NumberFormatter($this->locale ?? \Locale::getDefault(), \NumberFormatter::SCIENTIFIC);
+
+        if (null !== $this->scale) {
+            $formatter->setAttribute(\NumberFormatter::FRACTION_DIGITS, $this->scale);
+            $formatter->setAttribute(\NumberFormatter::ROUNDING_MODE, $this->roundingMode);
+        }
+
+        $formatter->setAttribute(\NumberFormatter::GROUPING_USED, (int) $this->grouping);
+
+        return $formatter;
+    }
+}

src/Services/Doctrine/DBInfoHelper.php

@@ -1,4 +1,22 @@
 <?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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);
 
@@ -20,10 +38,10 @@ declare(strict_types=1);
  *  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\Services\Misc;
+namespace App\Services\Doctrine;
 
-use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\DBAL\Platforms\SQLitePlatform;

src/Services/Doctrine/NatsortDebugHelper.php

@@ -0,0 +1,86 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 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);
+
+
+namespace App\Services\Doctrine;
+
+use App\Doctrine\Functions\Natsort;
+use App\Entity\Parts\Part;
+use Doctrine\ORM\EntityManagerInterface;
+
+/**
+ * This service allows to debug the natsort function by showing various information about the current state of
+ * the natsort function.
+ */
+class NatsortDebugHelper
+{
+    public function __construct(private readonly EntityManagerInterface $entityManager)
+    {
+        // This is a dummy constructor
+    }
+
+    /**
+     * Check if the slow natural sort is allowed on the Natsort function.
+     * If it is not, then the request handler might need to be adjusted.
+     * @return bool
+     */
+    public function isSlowNaturalSortAllowed(): bool
+    {
+        return Natsort::isSlowNaturalSortAllowed();
+    }
+
+    public function getNaturalSortMethod(): string
+    {
+        //Construct a dummy query which uses the Natsort function
+        $query = $this->entityManager->createQuery('SELECT natsort(1) FROM ' . Part::class . ' p');
+        $sql = $query->getSQL();
+        //Remove the leading SELECT and the trailing semicolon
+        $sql = substr($sql, 7, -1);
+
+        //Remove AS and everything afterwards
+        $sql = preg_replace('/\s+AS\s+.*/', '', $sql);
+
+        //If just 1 is returned, then we use normal (non-natural sorting)
+        if ($sql === '1') {
+            return 'Disabled';
+        }
+
+        if (str_contains( $sql, 'COLLATE numeric')) {
+            return 'Native (PostgreSQL)';
+        }
+
+        if (str_contains($sql, 'NATURAL_SORT_KEY')) {
+            return 'Native (MariaDB)';
+        }
+
+        if (str_contains($sql, 'COLLATE NATURAL_CMP')) {
+            return 'Emulation via PHP (SQLite)';
+        }
+
+        if (str_contains($sql, 'NatSortKey')) {
+            return 'Emulation via custom function (MySQL)';
+        }
+
+
+        return 'Unknown ('.  $sql . ')';
+    }
+}