IBX-12106: Fixed handling of invalid xml:id values in RichText - #343
Merged
Conversation
tbialcz
force-pushed
the
ibx-12106-sanitize-invalid-xml-id
branch
from
August 24, 2026 07:45
b4e6e8b to
f3ee157
Compare
ibexa-workflow-automation-1
Bot
requested review from
Steveb-p,
ViniTou,
alongosz,
barw4,
bnowak,
ciastektk,
konradoboza,
mikadamczyk and
wiewiurdp
and removed request for
a team
August 24, 2026 07:46
bnowak
reviewed
Aug 24, 2026
bnowak
approved these changes
Aug 24, 2026
alongosz
reviewed
Aug 26, 2026
Steveb-p
reviewed
Aug 27, 2026
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Ibexa\Contracts\FieldTypeRichText\RichText; |
Contributor
There was a problem hiding this comment.
It's not a Contract - external packages should not be able to use it. Afaik you only add this interface because you need it for tests. It can live alongside the implementation.
Contributor
Author
There was a problem hiding this comment.
It’s not only for tests. The deprecation points developers to this service, so I thought it belongs in Contracts.
tbialcz
force-pushed
the
ibx-12106-sanitize-invalid-xml-id
branch
from
August 27, 2026 08:13
a8d95a7 to
1ee97f7
Compare
ViniTou
approved these changes
Aug 27, 2026
barw4
approved these changes
Aug 27, 2026
tbialcz
force-pushed
the
ibx-12106-sanitize-invalid-xml-id
branch
2 times, most recently
from
August 28, 2026 05:15
3bf2e45 to
60810e7
Compare
Steveb-p
reviewed
Aug 31, 2026
tbialcz
force-pushed
the
ibx-12106-sanitize-invalid-xml-id
branch
from
August 31, 2026 13:20
60810e7 to
f393e87
Compare
alongosz
reviewed
Sep 2, 2026
alongosz
approved these changes
Sep 3, 2026
alongosz
left a comment
alongosz
left a comment
Member
There was a problem hiding this comment.
+1, given my last remark is about the pre-existing code in a different form, that just would be nice to have fixed here.
alongosz
approved these changes
Sep 3, 2026
KamilSznajdrowicz
force-pushed
the
ibx-12106-sanitize-invalid-xml-id
branch
from
September 10, 2026 12:04
71faf1f to
7189cdb
Compare
|
KamilSznajdrowicz
approved these changes
Sep 11, 2026
KamilSznajdrowicz
left a comment
KamilSznajdrowicz
left a comment
There was a problem hiding this comment.
QA Approved
PR tested on 4.6.x-dev, patch applied and successfully tested on v4.6.32
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 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.
Description:
Pasting external HTML into a RichText field can bring ids which are not valid XML
xml:idvalues (e.g.id="227",id="foo bar"). Since EZP-31574 draft saves skip validation, so such ids get stored in DocBook. Every laterloadXML()of that content emits a libxml warning, which Symfony's error handler turns into an exception — the content can no longer be rendered or deleted.Two fixes:
XmlIdinput converter (priority 60, right after the XSLT) fixes invalidxml:idvalues on save: invalid characters become_, ids starting with a digit get a_prefix, collisions get a_1suffix. Internal anchor links (xlink:href="#...") are updated to match, so they keep working.DOMDocumentLoaderInterfaceservice (DOMDocumentLoader) loads already stored XML without emitting libxml warnings — errors are logged instead (Monolog channelibexa.richtext), with content/version/field ID where available. It is injected intoType::fromPersistenceValue(),RichTextStorage,SearchFieldand RESTRichTextProcessor, so content broken before this fix renders again and can be edited or deleted. Re-saving it fixes the stored ids.Passing a string to
Value::__construct()is now deprecated (since 4.6.33, only\DOMDocumentin 6.0) — load the document with the new service instead.For QA:
<p id="227">text</p>and<a href="#227">link</a>, save/publish — no error, and the stored DocBook containsxml:id="_227"andxlink:href="#_227".xml:id="227") — its page, draft edit page, restore from trash and send to trash all work without a 500._227.RichText XML document loaded with libxml errorswithcontentId/versionNo/fieldIdin the context, on theibexa.richtextchannel (ibexa.richtext.WARNINGinvar/log/dev.log).Documentation:
Ibexa\Contracts\FieldTypeRichText\RichText\DOMDocumentLoaderInterfaceservice for loading stored RichText XML.ibexa.richtextused byDOMDocumentLoaderandRichTextStorage.new Value(string $xml)— pass\DOMDocumentinstead; the string argument will be removed in 6.0.