Improved organisation of Services

src/Services/Tools/ExchangeRateUpdater.php

@@ -0,0 +1,56 @@
+<?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/>.
+ */
+
+namespace App\Services\Tools;
+
+use App\Entity\PriceInformations\Currency;
+use Brick\Math\BigDecimal;
+use Brick\Math\RoundingMode;
+use Swap\Swap;
+
+class ExchangeRateUpdater
+{
+    private string $base_currency;
+    private Swap $swap;
+
+    public function __construct(string $base_currency, Swap $swap)
+    {
+        $this->base_currency = $base_currency;
+        $this->swap = $swap;
+    }
+
+    /**
+     * Updates the exchange rate of the given currency using the globally configured providers.
+     */
+    public function update(Currency $currency): Currency
+    {
+        //Currency pairs are always in the format "BASE/QUOTE"
+        $rate = $this->swap->latest($this->base_currency.'/'.$currency->getIsoCode());
+        //The rate says how many quote units are worth one base unit
+        //So we need to invert it to get the exchange rate
+
+        $rate_bd = BigDecimal::of($rate->getValue());
+        $rate_inverted = BigDecimal::one()->dividedBy($rate_bd, Currency::PRICE_SCALE, RoundingMode::HALF_UP);
+
+        $currency->setExchangeRate($rate_inverted);
+
+        return $currency;
+    }
+}

src/Services/Tools/StatisticsHelper.php

@@ -0,0 +1,170 @@
+<?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\Services\Tools;
+
+use App\Entity\Attachments\Attachment;
+use App\Entity\Attachments\AttachmentType;
+use App\Entity\Devices\Device;
+use App\Entity\Parts\Category;
+use App\Entity\Parts\Footprint;
+use App\Entity\Parts\Manufacturer;
+use App\Entity\Parts\MeasurementUnit;
+use App\Entity\Parts\Part;
+use App\Entity\Parts\Storelocation;
+use App\Entity\Parts\Supplier;
+use App\Entity\PriceInformations\Currency;
+use App\Repository\AttachmentRepository;
+use App\Repository\PartRepository;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\NonUniqueResultException;
+use Doctrine\ORM\NoResultException;
+use InvalidArgumentException;
+
+class StatisticsHelper
+{
+    protected EntityManagerInterface $em;
+    protected PartRepository $part_repo;
+    protected AttachmentRepository $attachment_repo;
+
+    public function __construct(EntityManagerInterface $em)
+    {
+        $this->em = $em;
+        $this->part_repo = $this->em->getRepository(Part::class);
+        $this->attachment_repo = $this->em->getRepository(Attachment::class);
+    }
+
+    /**
+     *  Returns the count of distinct parts.
+     */
+    public function getDistinctPartsCount(): int
+    {
+        return $this->part_repo->count([]);
+    }
+
+    /**
+     * Returns the summed instocked over all parts (only parts without a measurement unit).
+     *
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
+    public function getPartsInstockSum(): float
+    {
+        return $this->part_repo->getPartsInstockSum();
+    }
+
+    /**
+     * Returns the number of all parts which have price informations.
+     *
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
+    public function getPartsCountWithPrice(): int
+    {
+        return $this->part_repo->getPartsCountWithPrice();
+    }
+
+    /**
+     * Returns the number of datastructures for the given type.
+     */
+    public function getDataStructuresCount(string $type): int
+    {
+        $arr = [
+            'attachment_type' => AttachmentType::class,
+            'category' => Category::class,
+            'device' => Device::class,
+            'footprint' => Footprint::class,
+            'manufacturer' => Manufacturer::class,
+            'measurement_unit' => MeasurementUnit::class,
+            'storelocation' => Storelocation::class,
+            'supplier' => Supplier::class,
+            'currency' => Currency::class,
+        ];
+
+        if (!isset($arr[$type])) {
+            throw new InvalidArgumentException('No count for the given type available!');
+        }
+
+        /** @var EntityRepository $repo */
+        $repo = $this->em->getRepository($arr[$type]);
+
+        return $repo->count([]);
+    }
+
+    /**
+     * Gets the count of all attachments.
+     */
+    public function getAttachmentsCount(): int
+    {
+        return $this->attachment_repo->count([]);
+    }
+
+    /**
+     * Gets the count of all private/secure attachments.
+     */
+    public function getPrivateAttachmentsCount(): int
+    {
+        return $this->attachment_repo->getPrivateAttachmentsCount();
+    }
+
+    /**
+     * Gets the count of all external (only containing an URL) attachments.
+     *
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
+    public function getExternalAttachmentsCount(): int
+    {
+        return $this->attachment_repo->getExternalAttachments();
+    }
+
+    /**
+     * Gets the count of all attachments where the user uploaded an file.
+     *
+     * @throws NoResultException
+     * @throws NonUniqueResultException
+     */
+    public function getUserUploadedAttachmentsCount(): int
+    {
+        return $this->attachment_repo->getUserUploadedAttachments();
+    }
+}

src/Services/Tools/TagFinder.php

@@ -0,0 +1,98 @@
+<?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);
+
+namespace App\Services\Tools;
+
+use App\Entity\Parts\Part;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+use function \mb_strlen;
+use function array_slice;
+
+/**
+ * A service related for searching for tags. Mostly useful for autocomplete reasons.
+ */
+class TagFinder
+{
+    protected EntityManagerInterface $em;
+
+    public function __construct(EntityManagerInterface $entityManager)
+    {
+        $this->em = $entityManager;
+    }
+
+    /**
+     * Search tags that begins with the certain keyword.
+     *
+     * @param string $keyword The keyword the tag must begin with
+     * @param array  $options Some options specifying the search behavior. See configureOptions for possible options.
+     *
+     * @return string[] an array containing the tags that match the given keyword
+     */
+    public function searchTags(string $keyword, array $options = []): array
+    {
+        $results = [];
+        $keyword_regex = '/^'.preg_quote($keyword, '/').'/';
+
+        $resolver = new OptionsResolver();
+        $this->configureOptions($resolver);
+
+        $options = $resolver->resolve($options);
+
+        //If the keyword is too short we will get to much results, which takes too much time...
+        if (mb_strlen($keyword) < $options['min_keyword_length']) {
+            return [];
+        }
+
+        //Build a query to get all
+        $qb = $this->em->createQueryBuilder();
+
+        $qb->select('p.tags')
+            ->from(Part::class, 'p')
+            ->where('p.tags LIKE ?1')
+            ->setMaxResults($options['query_limit'])
+            //->orderBy('RAND()')
+            ->setParameter(1, '%'.$keyword.'%');
+
+        $possible_tags = $qb->getQuery()->getArrayResult();
+
+        //Iterate over each possible tags (which are comma separated) and extract tags which match our keyword
+        foreach ($possible_tags as $tags) {
+            $tags = explode(',', $tags['tags']);
+            $results = array_merge($results, preg_grep($keyword_regex, $tags));
+        }
+
+        $results = array_unique($results);
+        //Limit the returned tag count to specified value.
+        return array_slice($results, 0, $options['return_limit']);
+    }
+
+    protected function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'query_limit' => 75,
+            'return_limit' => 75,
+            'min_keyword_length' => 2,
+        ]);
+    }
+}