HTML Input for PDF Generation #1455
Merged
Conversation
This file contains 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
OX-10783
The PDF renderer requires XHTML as input, and we used to rely on the invoker to provide valid content. However, luckily, the world has moved on from XHTML. In order to relax the requirements and facilitate reuse of HTML templates, this commit introduces an additional processing step that removes problematic elements and ensures XHTML automatically. OX-10783
OX-10783
sabieber
approved these changes
Sep 4, 2024
| @@ -53,14 +55,37 @@ public boolean generate(Generator generator, OutputStream out) throws Exception | |||
| ITextRenderer renderer = new ITextRenderer(); | |||
| renderer.getSharedContext() | |||
| .setReplacedElementFactory(new ImageReplacedElementFactory(renderer.getOutputDevice())); | |||
| renderer.setDocumentFromString(content); | |||
| renderer.setDocumentFromString(cleanHtml(content)); | |||
There was a problem hiding this comment.
Optional: Maybe this could be enabled optionally? Don't know if it could break stuff in S2
There was a problem hiding this comment.
Hmm, how? As an additional pseudo-parameter in the context? As a system-wide setting? Both do not seem to be particularly elegant 😇
Let's see what S2 is going to say about this PR, okay? We can also flag it as breaking, but it should process all previously valid input as it was, and only affect the behaviour in case of faulty input.
OX-10783
2 tasks
mkeckmkeck
approved these changes
Sep 5, 2024
jakobvogel
added
the
💣 BREAKING CHANGE
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The Flying Saucer PDF renderer requires XHTML as input, and we rely on the invoker to provide valid content. However, luckily, the world has moved on from XHTML. In order to relax the requirements and facilitate reuse of HTML templates, this PR introduces an additional processing step that removes problematic elements and ensures XHTML automatically.
Marked as breaking as PDF rendering should be checked after upgrading.
Additional Notes
Checklist