Add support for right-clicking on images (bug 1012805) #20626
+572
−22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marco-c
changed the title
nicolo-ribaudo
force-pushed
the
images-right-click
branch
from
21c238b to
117cef6
Compare
nicolo-ribaudo
force-pushed
the
images-right-click
branch
from
117cef6 to
f50a6a6
Compare
This patch adds right-click support for images in the PDF, allowing users to download them. To minimize memory consumption, we: - Do not store the images separately, and instead crop them out of the PDF page canvas - Only extract the images when needed (i.e. when the user right-clicks on them), rather than eagery having all of them available. To do so, we layer one empty 0x0 canvas per image, stretched to cover the whole image, and only populate its contents on right click. These images need to be inside the text layer: they cannot be _behind_ it, otherwise they would be covered by the text layer's container and not be clickable, and they cannot be in front of it, otherwise they would make the text spans unselectable. This feature is managed by a new preference, `imagesRightClickMinSize`: - when it's set to `-1`, right-click support is disabled - when set to `0`, all images are available for right click - when set to a positive integer, only images whose width and height are greater than or equal to that value (in the PDF page frame of reference) are available for right click.
nicolo-ribaudo
force-pushed
the
images-right-click
branch
from
f50a6a6 to
ff250a7
Compare
Contributor
timvandermeij
left a comment
timvandermeij
left a comment
There was a problem hiding this comment.
I did a first pass over this PR, which resulted in the following comments. Overall this looks really good, and we can run the tests after this has been addressed.
| @@ -0,0 +1,159 @@ | |||
| /* Copyright 2024 Mozilla Foundation | |||
| const cwdURL = pathToFileURL(process.cwd()) + "/"; | ||
| this.rootURL = new URL(`${root || "."}/`, cwdURL); | ||
| this.host = host || "localhost"; | ||
| this.host = host; // || "localhost"; |
Contributor
There was a problem hiding this comment.
This change should probably be reverted.
Contributor
Author
There was a problem hiding this comment.
I opened #20646 so that I can stop having to comment this line out when testing on mobile.
| return `${(value * 100).toFixed(2)}%`; | ||
| } | ||
|
|
||
| class TextLayerImages { |
Contributor
There was a problem hiding this comment.
It might be good to add a small docstring to this class to explain its purpose.
| }; | ||
|
|
||
| export { CanvasDependencyTracker, CanvasNestedDependencyTracker, Dependencies }; | ||
| class CanvasImagesTracker { |
Contributor
There was a problem hiding this comment.
It might be good to add a small docstring to this class to explain its purpose.
| * @returns {Promise<void>} | ||
| */ | ||
| async render({ viewport, textContentParams = null }) { | ||
| async render({ viewport, images, textContentParams = null }) { |
Contributor
There was a problem hiding this comment.
The TextLayerBuilderRenderOptions type should be updated accordingly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes https://bugzilla.mozilla.org/show_bug.cgi?id=1012805
TODO: