feat., Imaginary: disable document processing by default #46447

ernolf · 2024-07-11T11:47:17Z

Resolves: /Add Option to Disable Imaginary PDF Previews #42175

Summary

Document previews often appear as minimal, almost blank "miniatures" that can inadvertently reveal content, which may not always be desired.
Many users prefer having document icons instead of these previews.
The classic preview provider settings have considered this preference.
This feature reintroduces this choice for Imaginary.
Given that it is easier to generate previews than to remove existing ones, the default value is set to 'false'.

ernolf

TODO

...

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

Signed-off-by: ernolf <raphael.gradenwitz@googlemail.com>

szaimen

Thanks for the PR @ernolf!

I'd personally vote for enabling it by default and allowing to disable it

szaimen · 2024-07-11T18:48:43Z

config/config.sample.php

+ * Defaults to ``false``
+ */
+'imaginary_process_documents' => false,


Suggested change

* Defaults to ``false``

*/

'imaginary_process_documents' => false,

* Defaults to ``true``

*/

'imaginary_process_documents' => true,

szaimen · 2024-07-11T18:48:59Z

lib/private/Preview/Imaginary.php

-		return '/(image\/(bmp|x-bitmap|png|jpeg|gif|heic|heif|svg\+xml|tiff|webp)|application\/(pdf|illustrator))/';
+		$config = \OC::$server->getConfig();
+		// Check if processing of documents is enabled
+		$processDocuments = $config->getSystemValueBool('imaginary_process_documents', false);


Suggested change

$processDocuments = $config->getSystemValueBool('imaginary_process_documents', false);

$processDocuments = $config->getSystemValueBool('imaginary_process_documents', true);

szaimen · 2024-07-11T18:49:10Z

lib/private/Preview/Imaginary.php

 			case 'application/pdf':
 			case 'application/illustrator':
+				// Check if processing of documents is enabled
+				if (!$this->config->getSystemValueBool('imaginary_process_documents', false)) {


Suggested change

if (!$this->config->getSystemValueBool('imaginary_process_documents', false)) {

if (!$this->config->getSystemValueBool('imaginary_process_documents', true)) {

szaimen · 2024-07-11T19:19:44Z

config/config.sample.php

@@ -1307,6 +1307,17 @@
 */
 'preview_imaginary_key' => 'secret',

+/**
+ * Imaginary can, but does not, process PDF and Illustrator files by default.


Suggested change

* Imaginary can, but does not, process PDF and Illustrator files by default.

* Imaginary processes PDF and Illustrator files by default.

kesselb · 2024-07-11T20:13:28Z

Thanks for your pull request 👍

Cleaner, then a new configuration option, would be to use subclassing and reuse the existing preview provider configuration.

Change Imaginary.supportedMimeTypes and remove the application mime type
Create a new class ImaginaryDocuments extending Imaginary and overwrite supportedMimeTypes to return only the document mime types.
To enable/disable the provider, add Imaginary or ImaginaryDocuments to the preview provider list.

Index: lib/private/PreviewManager.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/lib/private/PreviewManager.php b/lib/private/PreviewManager.php
--- a/lib/private/PreviewManager.php	(revision e6502b1399ae57a1ab3e9097ab5337e51216adb2)
+++ b/lib/private/PreviewManager.php	(date 1720727804062)
@@ -346,6 +346,7 @@
 		$this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg/');
 		$this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
 		$this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
+		$this->registerCoreProvider(Preview\ImaginaryDocuments::class, Preview\ImaginaryDocuments::supportedMimeTypes());
 
 		// SVG and Bitmap require imagick
 		if ($this->imagickSupport->hasExtension()) {
Index: lib/private/Preview/Imaginary.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/lib/private/Preview/Imaginary.php b/lib/private/Preview/Imaginary.php
--- a/lib/private/Preview/Imaginary.php	(revision e6502b1399ae57a1ab3e9097ab5337e51216adb2)
+++ b/lib/private/Preview/Imaginary.php	(date 1720727664657)
@@ -40,7 +40,7 @@
 	}
 
 	public static function supportedMimeTypes(): string {
-		return '/(image\/(bmp|x-bitmap|png|jpeg|gif|heic|heif|svg\+xml|tiff|webp)|application\/(pdf|illustrator))/';
+		return '/(image\/(bmp|x-bitmap|png|jpeg|gif|heic|heif|svg\+xml|tiff|webp))/';
 	}
 
 	public function getCroppedThumbnail(File $file, int $maxX, int $maxY, bool $crop): ?IImage {
Index: lib/private/Preview/ImaginaryDocuments.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/lib/private/Preview/ImaginaryDocuments.php b/lib/private/Preview/ImaginaryDocuments.php
new file mode 100644
--- /dev/null	(date 1720728758772)
+++ b/lib/private/Preview/ImaginaryDocuments.php	(date 1720728758772)
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\Preview;
+
+class ImaginaryDocuments extends Imaginary {
+	public static function supportedMimeTypes(): string {
+		return '/application\/(pdf|illustrator)/';
+	}
+}

st3iny

Conceptually, this seems like a good idea.

However, I prefer kesselb's approach for its simplicity as this is mostly about changing supported mime types.

ernolf · 2024-07-13T11:33:00Z

I prefer kesselb's approach for its simplicity as this is mostly about changing supported mime types.

I also believe @kesselb's suggestion is beneficial as it moves us towards standardizing preview handling.

Some thoughts:
When categorizing MIME types, we can group them as follows:

Images (Lossy): jpeg, gif, webp
Raw Images (Lossless): bmp, x-bitmap, png, heic, heif, tiff
Vector-based Images: svg+xml, application/illustrator (I have now categorized Illustrator among images, where it rightly belongs.)
PDF/Documents: application/pdf

Maintaining one provider per MIME type (as with legacy providers) or further dividing images into lossy, lossless, and vector-based categories might confuse existing Imaginary users. Therefore, I propose simplifying this into two categories: images processed by "Imaginary" and PDF document previews processed by "ImaginaryPDF". Since only PDF documents can be handled and Illustrator actually belongs among the images, introducing a provider called "ImaginaryDocuments" would also be rather confusing.

I've submitted a new pull request #46508 (this time as a member) that expands on kesselb's approach and this thoughts.

So, I kindly request your support there and would like to close this pull request if that would be OK for you.

github-actions · 2024-07-26T01:50:11Z

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

ernolf · 2024-07-26T08:26:18Z

Since #46508 is merged, this can be closed

ernolf added 2 commits July 11, 2024 14:01

"Imaginary: disable document processing by default"

2aa30d3

Signed-off-by: ernolf <raphael.gradenwitz@googlemail.com>

made description more consistent

5d951fa

Signed-off-by: ernolf <raphael.gradenwitz@googlemail.com>

ernolf force-pushed the master branch from be56db9 to 5d951fa Compare July 11, 2024 12:03

AndyScherzinger added the 3. to review Waiting for reviews label Jul 11, 2024

AndyScherzinger requested review from nickvergessen, sorbaugh and Altahrim July 11, 2024 15:52

szaimen reviewed Jul 11, 2024

View reviewed changes

szaimen requested a review from st3iny July 11, 2024 18:51

szaimen added the enhancement label Jul 11, 2024

szaimen added this to the Nextcloud 30 milestone Jul 11, 2024

szaimen reviewed Jul 11, 2024

View reviewed changes

st3iny reviewed Jul 12, 2024

View reviewed changes

ernolf mentioned this pull request Jul 13, 2024

feat(preview): introducing new class ImaginaryPDF #46508

Merged

5 tasks

github-actions bot added the feedback-requested label Jul 26, 2024

ernolf closed this Jul 26, 2024

skjnldsv removed this from the Nextcloud 30 milestone Aug 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat., Imaginary: disable document processing by default #46447

feat., Imaginary: disable document processing by default #46447

ernolf commented Jul 11, 2024

szaimen left a comment

szaimen Jul 11, 2024

szaimen Jul 11, 2024

szaimen Jul 11, 2024

szaimen Jul 11, 2024

kesselb commented Jul 11, 2024

st3iny left a comment

ernolf commented Jul 13, 2024

github-actions bot commented Jul 26, 2024

ernolf commented Jul 26, 2024

	$processDocuments = $config->getSystemValueBool('imaginary_process_documents', false);
	$processDocuments = $config->getSystemValueBool('imaginary_process_documents', true);

	if (!$this->config->getSystemValueBool('imaginary_process_documents', false)) {
	if (!$this->config->getSystemValueBool('imaginary_process_documents', true)) {

	* Imaginary can, but does not, process PDF and Illustrator files by default.
	* Imaginary processes PDF and Illustrator files by default.

feat., Imaginary: disable document processing by default #46447

feat., Imaginary: disable document processing by default #46447

Conversation

ernolf commented Jul 11, 2024

Summary

TODO

Checklist

szaimen left a comment

Choose a reason for hiding this comment

szaimen Jul 11, 2024

Choose a reason for hiding this comment

szaimen Jul 11, 2024

Choose a reason for hiding this comment

szaimen Jul 11, 2024

Choose a reason for hiding this comment

szaimen Jul 11, 2024

Choose a reason for hiding this comment

kesselb commented Jul 11, 2024

st3iny left a comment

Choose a reason for hiding this comment

ernolf commented Jul 13, 2024

github-actions bot commented Jul 26, 2024

ernolf commented Jul 26, 2024