Moved attachment related services into their own namespaces.

src/Services/Attachments/AttachmentManager.php

@@ -0,0 +1,178 @@
+<?php
+/**
+ *
+ * part-db version 0.1
+ * Copyright (C) 2005 Christoph Lechner
+ * http://www.cl-projects.de/
+ *
+ * part-db version 0.2+
+ * Copyright (C) 2009 K. Jacobs and others (see authors.php)
+ * http://code.google.com/p/part-db/
+ *
+ * Part-DB Version 0.4+
+ * Copyright (C) 2016 - 2019 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 General Public License
+ * as published by the Free Software Foundation; either version 2
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ *
+ */
+
+namespace App\Services;
+
+
+use App\Entity\Attachments\Attachment;
+use App\Entity\Attachments\AttachmentContainingDBElement;
+use App\Entity\Attachments\AttachmentTypeAttachment;
+use App\Entity\Attachments\CategoryAttachment;
+use App\Entity\Attachments\CurrencyAttachment;
+use App\Entity\Attachments\DeviceAttachment;
+use App\Entity\Attachments\FootprintAttachment;
+use App\Entity\Attachments\GroupAttachment;
+use App\Entity\Attachments\ManufacturerAttachment;
+use App\Entity\Attachments\MeasurementUnitAttachment;
+use App\Entity\Attachments\PartAttachment;
+use App\Entity\Attachments\StorelocationAttachment;
+use App\Entity\Attachments\SupplierAttachment;
+use App\Entity\Attachments\UserAttachment;
+use App\Services\Attachments\AttachmentPathResolver;
+use Symfony\Component\HttpFoundation\File\UploadedFile;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * This service contains basic commonly used functions to work with attachments.
+ * Especially this services gives you important infos about attachments, that can not be retrieved via the entities
+ * (like filesize or if a file is existing).
+ *
+ * Special operations like getting attachment urls or handling file uploading/downloading are in their own services.
+ * @package App\Services
+ */
+class AttachmentManager
+{
+
+    protected $pathResolver;
+
+    public function __construct(AttachmentPathResolver $pathResolver)
+    {
+        $this->pathResolver = $pathResolver;
+    }
+
+    /**
+     * Gets an SPLFileInfo object representing the file associated with the attachment.
+     * @param Attachment $attachment The attachment for which the file should be generated
+     * @return \SplFileInfo|null The fileinfo for the attachment file. Null, if the attachment is external or has
+     * invalid file.
+     */
+    public function attachmentToFile(Attachment $attachment) : ?\SplFileInfo
+    {
+        if ($attachment->isExternal() || !$this->isFileExisting($attachment)) {
+            return null;
+        }
+
+        return new \SplFileInfo($this->toAbsoluteFilePath($attachment));
+    }
+
+    /**
+     * Returns the absolute filepath of the attachment. Null is returned, if the attachment is externally saved,
+     * or is not existing.
+     * @param Attachment $attachment The attachment for which the filepath should be determined
+     * @return string|null
+     */
+    public function toAbsoluteFilePath(Attachment $attachment): ?string
+    {
+        if (empty($attachment->getPath())) {
+            return null;
+        }
+
+        if ($attachment->isExternal()) {
+            return null;
+        }
+
+        $path = $this->pathResolver->placeholderToRealPath($attachment->getPath());
+
+        //realpath does not work with null as argument
+        if ($path === null) {
+            return null;
+        }
+
+        $tmp = realpath($path);
+        //If path is not existing realpath returns false.
+        if ($tmp === false) {
+            return null;
+        }
+        return $tmp;
+    }
+
+    /**
+     * Checks if the file in this attachement is existing. This works for files on the HDD, and for URLs
+     * (it's not checked if the ressource behind the URL is really existing, so for every external attachment true is returned).
+     *
+     * @param Attachment $attachment The attachment for which the existence should be checked
+     *
+     * @return bool True if the file is existing.
+     */
+    public function isFileExisting(Attachment $attachment): bool
+    {
+        if (empty($attachment->getPath())) {
+            return false;
+        }
+
+        return file_exists($this->toAbsoluteFilePath($attachment)) || $attachment->isExternal();
+    }
+
+    /**
+     * Returns the filesize of the attachments in bytes.
+     * For external attachments or not existing attachments, null is returned.
+     *
+     * @param Attachment $attachment The filesize for which the filesize should be calculated.
+     * @return int|null
+     */
+    public function getFileSize(Attachment $attachment): ?int
+    {
+        if ($attachment->isExternal()) {
+            return null;
+        }
+
+        if (!$this->isFileExisting($attachment)) {
+            return null;
+        }
+
+        $tmp = filesize($this->toAbsoluteFilePath($attachment));
+        return  $tmp !== false ? $tmp : null;
+    }
+
+    /**
+     * Returns a human readable version of the attachment file size.
+     * For external attachments, null is returned.
+     *
+     * @param Attachment $attachment
+     * @param int $decimals The number of decimals numbers that should be printed
+     * @return string|null A string like 1.3M
+     */
+    public function getHumanFileSize(Attachment $attachment, $decimals = 2): ?string
+    {
+        $bytes = $this->getFileSize($attachment);
+
+        if ($bytes == null) {
+            return null;
+        }
+
+        //Format filesize for human reading
+        //Taken from: https://www.php.net/manual/de/function.filesize.php#106569 and slightly modified
+
+        $sz = 'BKMGTP';
+        $factor = (int) floor((strlen($bytes) - 1) / 3);
+        return sprintf("%.{$decimals}f", $bytes / 1024 ** $factor) . @$sz[$factor];
+    }
+}

src/Services/Attachments/AttachmentReverseSearch.php

@@ -0,0 +1,102 @@
+<?php
+/**
+ *
+ * part-db version 0.1
+ * Copyright (C) 2005 Christoph Lechner
+ * http://www.cl-projects.de/
+ *
+ * part-db version 0.2+
+ * Copyright (C) 2009 K. Jacobs and others (see authors.php)
+ * http://code.google.com/p/part-db/
+ *
+ * Part-DB Version 0.4+
+ * Copyright (C) 2016 - 2019 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 General Public License
+ * as published by the Free Software Foundation; either version 2
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ *
+ */
+
+namespace App\Services;
+
+use App\Entity\Attachments\Attachment;
+use App\Services\Attachments\AttachmentPathResolver;
+use App\Services\Attachments\AttachmentURLGenerator;
+use Doctrine\ORM\EntityManagerInterface;
+use Liip\ImagineBundle\Imagine\Cache\CacheManager;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpFoundation\File\File;
+
+/**
+ * This service provides functions to find attachments via an reverse search based on a file.
+ * @package App\Services
+ */
+class AttachmentReverseSearch
+{
+    protected $em;
+    protected $pathResolver;
+    protected $cacheManager;
+    protected $attachmentURLGenerator;
+
+    public function __construct(EntityManagerInterface $em, AttachmentPathResolver $pathResolver,
+                                CacheManager $cacheManager, AttachmentURLGenerator $attachmentURLGenerator)
+    {
+        $this->em = $em;
+        $this->pathResolver = $pathResolver;
+        $this->cacheManager = $cacheManager;
+        $this->attachmentURLGenerator = $attachmentURLGenerator;
+    }
+
+    /**
+     * Find all attachments that use the given file
+     * @param \SplFileInfo $file The file for which is searched
+     * @return Attachment[] An list of attachments that use the given file.
+     */
+    public function findAttachmentsByFile(\SplFileInfo $file) : array
+    {
+        //Path with %MEDIA%
+        $relative_path_new = $this->pathResolver->realPathToPlaceholder($file->getPathname());
+        //Path with %BASE%
+        $relative_path_old = $this->pathResolver->realPathToPlaceholder($file->getPathname(), true);
+
+        $repo = $this->em->getRepository(Attachment::class);
+        return $repo->findBy(['path' => [$relative_path_new, $relative_path_old]]);
+    }
+
+    /**
+     * Deletes the given file if it is not used by more than $threshold attachments
+     * @param \SplFileInfo $file The file that should be removed
+     * @param int $threshold The threshold used, to determine if a file should be deleted or not.
+     * @return bool True, if the file was delete. False if not.
+     */
+    public function deleteIfNotUsed(\SplFileInfo $file, int $threshold = 1) : bool
+    {
+
+        /* When the file is used more then $threshold times, don't delete it */
+        if (count($this->findAttachmentsByFile($file)) > $threshold) {
+            return false;
+        }
+
+        //Remove file from liip image cache
+        $this->cacheManager->remove($this->attachmentURLGenerator->absolutePathToAssetPath($file->getPathname()));
+
+        $fs = new Filesystem();
+        $fs->remove($file);
+
+
+
+        return true;
+    }
+}

src/Services/Attachments/BuiltinAttachmentsFinder.php

@@ -0,0 +1,154 @@
+<?php
+/**
+ *
+ * part-db version 0.1
+ * Copyright (C) 2005 Christoph Lechner
+ * http://www.cl-projects.de/
+ *
+ * part-db version 0.2+
+ * Copyright (C) 2009 K. Jacobs and others (see authors.php)
+ * http://code.google.com/p/part-db/
+ *
+ * Part-DB Version 0.4+
+ * Copyright (C) 2016 - 2019 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 General Public License
+ * as published by the Free Software Foundation; either version 2
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ *
+ */
+
+namespace App\Services;
+
+use App\Entity\Attachments\Attachment;
+use App\Services\Attachments\AttachmentPathResolver;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Contracts\Cache\CacheInterface;
+
+/**
+ * This service is used to find builtin attachment ressources
+ * @package App\Services
+ */
+class BuiltinAttachmentsFinder
+{
+    protected $pathResolver;
+    protected $cache;
+
+    public function __construct(CacheInterface $cache, AttachmentPathResolver $pathResolver)
+    {
+        $this->pathResolver = $pathResolver;
+        $this->cache = $cache;
+    }
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'limit' => 15,  //Given only 15 entries
+            //'allowed_extensions' => [], //Filter the filenames. For example ['jpg', 'jpeg'] to only get jpegs.
+            //'placeholders' => Attachment::BUILTIN_PLACEHOLDER, //By default use all builtin ressources,
+            'empty_returns_all' => false //Return the whole list of ressources when empty keyword is given
+        ]);
+    }
+
+    /**
+     * Returns a list of all builtin ressources.
+     * The array is a list of the relative filenames using the %PLACEHOLDERS%.
+     * The list contains the files from all configured valid ressoureces.
+     * @return array The list of the ressources, or an empty array if an error happened.
+     */
+    public function getListOfRessources() : array
+    {
+        try {
+            return $this->cache->get('attachment_builtin_ressources', function () {
+                $results = [];
+
+                $finder = new Finder();
+                //We search only files
+                $finder->files();
+                //Add the folder for each placeholder
+                foreach (Attachment::BUILTIN_PLACEHOLDER as $placeholder) {
+                    $tmp = $this->pathResolver->placeholderToRealPath($placeholder);
+                    //Ignore invalid/deactivated placeholders:
+                    if ($tmp !== null) {
+                        $finder->in($tmp);
+                    }
+                }
+
+                foreach ($finder as $file) {
+                    $results[] = $this->pathResolver->realPathToPlaceholder($file->getPathname());
+                }
+
+                //Sort results ascending
+                sort($results);
+
+                return $results;
+            });
+        } catch (\Psr\Cache\InvalidArgumentException $ex) {
+            return [];
+        }
+    }
+
+    /**
+     * Find all ressources which are matching the given keyword and the specified options
+     * @param string $keyword The keyword you want to search for.
+     * @param array $options Here you can specify some options (see configureOptions for list of options)
+     * @param array|null $base_list The list from which should be used as base for filtering.
+     * @return array The list of the results matching the specified keyword and options
+     */
+    public function find(string $keyword, array $options = [], ?array $base_list = []) : array
+    {
+        if (empty($base_list)) {
+            $base_list = $this->getListOfRessources();
+        }
+
+        $resolver = new OptionsResolver();
+        $this->configureOptions($resolver);
+        $options = $resolver->resolve($options);
+
+
+
+        /*
+        if (empty($options['placeholders'])) {
+            return [];
+        } */
+
+        if ($keyword === '') {
+            if ($options['empty_returns_all']) {
+                $keyword = '.*';
+            } else {
+                return [];
+            }
+        } else {
+            //Quote all values in the keyword (user is not allowed to use regex characters)
+            $keyword = preg_quote($keyword, '/');
+        }
+
+         /*TODO: Implement placheolder and extension filter */
+        /* if (!empty($options['allowed_extensions'])) {
+            $keyword .= "\.(";
+            foreach ($options['allowed_extensions'] as $extension) {
+                $keyword .= preg_quote($extension, '/') . '|';
+            }
+            $keyword .= ')$';
+        } */
+
+        //Ignore case
+        $regex = '/.*' . $keyword . '.*/i';
+
+        return preg_grep($regex, $base_list);
+    }
+
+}