Show attachments in part info

WIP: viewing and downloading attachments is not possible yet.

src/Controller/PartController.php

@@ -34,6 +34,7 @@ use App\Entity\Category;
 use App\Entity\Part;
 use App\Form\PartType;
 use App\Services\AttachmentFilenameService;
+use App\Services\AttachmentHelper;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -46,7 +47,7 @@ class PartController extends AbstractController
      * @Route("/part/{id}/info", name="part_info")
      * @Route("/part/{id}", requirements={"id"="\d+"})
      */
-    public function show(Part $part, AttachmentFilenameService $attachmentFilenameService)
+    public function show(Part $part, AttachmentFilenameService $attachmentFilenameService, AttachmentHelper $attachmentHelper)
     {
         $this->denyAccessUnlessGranted('read', $part);
 
@@ -56,6 +57,7 @@ class PartController extends AbstractController
             [
                 'part' => $part,
                 'main_image' => $attachmentFilenameService->attachmentPathToAbsolutePath($filename),
+                'attachment_helper' => $attachmentHelper
             ]
             );
     }

src/Entity/Attachment.php

@@ -46,9 +46,9 @@ abstract class Attachment extends NamedDBElement
 
     /**
      * @var string The filename using the %BASE% variable
-     * @ORM\Column(type="string")
+     * @ORM\Column(type="string", name="filename")
      */
-    protected $filename;
+    protected $path;
 
     /**
      * ORM mapping is done in sub classes (like PartAttachment)
@@ -74,7 +74,7 @@ abstract class Attachment extends NamedDBElement
      */
     public function isPicture(): bool
     {
-        $extension = pathinfo($this->getFilename(), PATHINFO_EXTENSION);
+        $extension = pathinfo($this->getPath(), PATHINFO_EXTENSION);
 
         // list all file extensions which are supported to display them by HTML code
         $picture_extensions = array('gif', 'png', 'jpg', 'jpeg', 'bmp', 'svg', 'tif');
@@ -82,12 +82,31 @@ abstract class Attachment extends NamedDBElement
         return in_array(strtolower($extension), $picture_extensions, true);
     }
 
+    /**
+     * Checks if the attachment file is externally saved (the database saves an URL)
+     * @return bool true, if the file is saved externally
+     */
+    public function isExternal() : bool
+    {
+        return static::isUrl($this->getPath());
+    }
+
     /********************************************************************************
      *
      *   Getters
      *
      *********************************************************************************/
 
+    /**
+     * Returns the extension of the file referenced via the attachment.
+     * For a path like %BASE/path/foo.bar, bar will be returned.
+     * @return string
+     */
+    public function getExtension() : string
+    {
+        return pathinfo($this->getPath(), PATHINFO_EXTENSION);
+    }
+
     /**
      * Get the element, associated with this Attachement (for example a "Part" object).
      *
@@ -106,18 +125,34 @@ abstract class Attachment extends NamedDBElement
      */
     public function isFileExisting(): bool
     {
-        return file_exists($this->getFilename()) || isURL($this->getFilename());
+        return file_exists($this->getPath()) || static::isURL($this->getPath());
     }
 
     /**
-     * Get the filename, relative to %BASE%.
+     * Get the filepath, relative to %BASE%.
      *
-     * @return string
+     * @return string A string like %BASE/path/foo.bar
      */
-    public function getFilename(): string
+    public function getPath(): string
     {
-        return $this->filename;
-        //return str_replace('%BASE%', BASE, $this->filename);
+        return $this->path;
+    }
+
+    /**
+     * Returns the filename of the attachment.
+     * For a path like %BASE/path/foo.bar, foo.bar will be returned.
+     *
+     * If the path is a URL (can be checked via isExternal()), null will be returned.
+     *
+     * @return string|null
+     */
+    public function getFilename(): ?string
+    {
+        if ($this->isExternal()) {
+            return null;
+        }
+
+        return pathinfo($this->getPath(), PATHINFO_BASENAME);
     }
 
     /**
@@ -136,13 +171,10 @@ abstract class Attachment extends NamedDBElement
      *
      * @return AttachmentType the type of this attachement
      *
-     * @throws Exception if there was an error
      */
     public function getType(): AttachmentType
     {
-        //TODO
-
-        throw new NotImplementedException('Not implemented yet!');
+        return $this->attachement_type;
     }
 
     /**
@@ -171,4 +203,31 @@ abstract class Attachment extends NamedDBElement
 
         return $this;
     }
+
+    /*****************************************************************************************************
+     * Static functions
+     *****************************************************************************************************/
+
+    /**
+     * Check if a string is a URL and is valid.
+     * @param $string string The string which should be checked.
+     * @param bool $path_required If true, the string must contain a path to be valid. (e.g. foo.bar would be invalid, foo.bar/test.php would be valid).
+     * @param $only_http bool Set this to true, if only HTTPS or HTTP schemata should be allowed.
+     *  *Caution: When this is set to false, a attacker could use the file:// schema, to get internal server files, like /etc/passwd.*
+     * @return bool True if the string is a valid URL. False, if the string is not an URL or invalid.
+     */
+    public static function isURL(string $string, bool $path_required = true, bool $only_http = true) : bool
+    {
+        if ($only_http) {   //Check if scheme is HTTPS or HTTP
+            $scheme = parse_url($string, PHP_URL_SCHEME);
+            if ($scheme !== 'http' && $scheme !== 'https') {
+                return false;   //All other schemes are not valid.
+            }
+        }
+        if ($path_required) {
+            return (bool) filter_var($string, FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED);
+        } else {
+            return (bool) filter_var($string, FILTER_VALIDATE_URL);
+        }
+    }
 }

src/Entity/Part.php

@@ -702,7 +702,7 @@ class Part extends AttachmentContainingDBElement
         $master_picture = $this->getMasterPictureAttachement(); // returns an Attachement-object
 
         if (null !== $master_picture) {
-            return $master_picture->getFilename();
+            return $master_picture->getPath();
         }
 
         if ($use_footprint_filename) {

src/Services/AttachmentHelper.php

@@ -0,0 +1,130 @@
+<?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\Attachment;
+use Doctrine\ORM\EntityManagerInterface;
+use SebastianBergmann\CodeCoverage\Node\File;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+class AttachmentHelper
+{
+
+    protected $base_path;
+
+    public function __construct(ParameterBagInterface $params, KernelInterface $kernel)
+    {
+        $tmp_base_path = $params->get('media_directory');
+
+        $fs = new Filesystem();
+
+        //Determine if it is an absolute path, or if we need to create a real absolute one out of it
+        if ($fs->isAbsolutePath($tmp_base_path)) {
+            $this->base_path = $tmp_base_path;
+        } else {
+            $this->base_path = realpath($kernel->getProjectDir() . $tmp_base_path);
+        }
+    }
+
+    /**
+     * Returns the absolute filepath of the attachment. Null is returned, if the attachment is externally saved.
+     * @param Attachment $attachment The attachment for which the filepath should be determined
+     * @return string|null
+     */
+    public function toAbsoluteFilePath(Attachment $attachment): ?string
+    {
+        if ($attachment->isExternal()) {
+            return null;
+        }
+
+        $path = $attachment->getPath();
+        $path = str_replace("%BASE%", $this->base_path, $path);
+        return realpath($path);
+    }
+
+    /**
+     * 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
+    {
+        return file_exists($this->toAbsoluteFilePath($attachment)) || $attachment->isExternal();
+    }
+
+    /**
+     * Returns the filesize of the attachments in bytes.
+     * For external 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;
+        }
+
+        return filesize($this->toAbsoluteFilePath($attachment));
+    }
+
+    /**
+     * 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];
+    }
+
+}