diff --git a/config/services.yaml b/config/services.yaml index 37c19bca..c5542897 100644 --- a/config/services.yaml +++ b/config/services.yaml @@ -10,6 +10,7 @@ parameters: banner: '' # The info text shown in the homepage use_gravatar: true # Set to false, if no Gravatar images should be used for user profiles. default_currency: 'EUR' # The currency that should be used + media_directory: '' services: # default configuration for services in *this* file diff --git a/data/media/.gitignore b/data/media/.gitignore new file mode 100644 index 00000000..2e0e43de --- /dev/null +++ b/data/media/.gitignore @@ -0,0 +1,2 @@ +# Ignore everything +* \ No newline at end of file diff --git a/src/Controller/PartController.php b/src/Controller/PartController.php index 0b614a34..8d386c73 100644 --- a/src/Controller/PartController.php +++ b/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 ] ); } diff --git a/src/Entity/Attachment.php b/src/Entity/Attachment.php index 56a954b2..90bf6168 100644 --- a/src/Entity/Attachment.php +++ b/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); + } + } } diff --git a/src/Entity/Part.php b/src/Entity/Part.php index 16be2d6c..91c338aa 100644 --- a/src/Entity/Part.php +++ b/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) { diff --git a/src/Services/AttachmentHelper.php b/src/Services/AttachmentHelper.php new file mode 100644 index 00000000..42dfc05e --- /dev/null +++ b/src/Services/AttachmentHelper.php @@ -0,0 +1,130 @@ +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]; + } + +} \ No newline at end of file diff --git a/templates/Parts/info/_attachments_info.html.twig b/templates/Parts/info/_attachments_info.html.twig new file mode 100644 index 00000000..c6cfe535 --- /dev/null +++ b/templates/Parts/info/_attachments_info.html.twig @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + {% for attachment in part.attachments %} + + + + + + + + + + {% endfor %} + + + +
{% trans %}attachment.name{% endtrans %}{% trans %}attachment.attachment_type{% endtrans %}{% trans %}attachment.file_name{% endtrans %}{% trans %}attachment.file_size{% endtrans %}
+ {% if attachment_helper.fileExisting(attachment) %} + + {% else %} + + {% endif %} + {{ attachment.name }}{{ attachment.type.fullPath }}{{ attachment.filename }} + {% if attachment_helper.fileExisting(attachment) %} + {{ attachment_helper.humanFileSize(attachment) }} + {% else %} + {% trans %}attachment.file_not_found{% endtrans %} + {% endif %} +
+ + + +
+ +
+ ID: {{ attachment.iD }} + {% trans %}createdAt{% endtrans %}: {{ attachment.addedDate | localizeddate("short")}} + {% trans %}createdAt{% endtrans %}: {{ attachment.addedDate | localizeddate("short")}} +
+ {% trans %}attachment.edit{% endtrans %} + {% trans %}attachment.delete{% endtrans %} +
+
+
\ No newline at end of file diff --git a/templates/Parts/info/_main_infos.html.twig b/templates/Parts/info/_main_infos.html.twig index c20630cb..829aa65d 100644 --- a/templates/Parts/info/_main_infos.html.twig +++ b/templates/Parts/info/_main_infos.html.twig @@ -32,7 +32,7 @@
- {{ part.averagePrice | moneyFormat }} + {% if part.averagePrice is not null %}{{ part.averagePrice | moneyFormat }}{% else %}-{% endif %}
{# {% if part.comment != "" %}