Part-DB.Part-DB-server/src/Services/Attachments/AttachmentReverseSearch.php

<?php

declare(strict_types=1);

/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 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\Attachments;

use App\Entity\Attachments\Attachment;
use function count;
use Doctrine\ORM\EntityManagerInterface;
use Liip\ImagineBundle\Imagine\Cache\CacheManager;
use SplFileInfo;
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.
 */
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;
    }
}