Skip to content

Commit

Permalink
feat: disallow data URLs in the package document
Browse files Browse the repository at this point in the history
EPUB 3.3 now disallows data URLs everywhere in the package document
(in both `item` and `link` elements).

See w3c/epub-specs#2494

Fix #1446
  • Loading branch information
rdeltour committed Dec 15, 2022
1 parent 003234a commit 0175818
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 119 deletions.
9 changes: 7 additions & 2 deletions src/main/java/com/adobe/epubcheck/opf/OPFChecker30.java
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ protected boolean checkContent()
@Override
protected void checkItem(OPFItem item, OPFHandler opfHandler)
{
// Items with `data:` URLs are not allowed in EPUB 3
if (item.hasDataURL())
{
report.message(MessageId.RSC_029, item.getLocation());
return;
}
if (item.getPath().startsWith("META-INF/"))
{
report.message(MessageId.PKG_025, item.getLocation());
Expand Down Expand Up @@ -182,10 +188,9 @@ else if (!overlayTextChecker.isCorrectOverlay(docURL, mo))
@Override
protected void checkSpineItem(OPFItem item, OPFHandler opfHandler)
{
// Items with `data:` URLs are not allowed in the spine
// Items with `data:` URLs are not allowed and reported earlier
if (item.hasDataURL())
{
report.message(MessageId.RSC_029, item.getLocation());
return;
}

Expand Down
15 changes: 10 additions & 5 deletions src/main/java/com/adobe/epubcheck/opf/OPFHandler30.java
Original file line number Diff line number Diff line change
Expand Up @@ -393,12 +393,17 @@ private void processLink()
{
XMLElement e = currentElement();

// check the 'href' URL
// href presence is checked by schema
String href = e.getAttribute("href");
if (href != null)
{ // href presence is checked by schema

// check the 'href' URL
URL url = checkURL(href);
URL url = checkURL(href);
if (url != null)
{
// Data URLs are not allowed on `link` elements
if ("data".equals(url.scheme())) {
report.message(MessageId.RSC_029, location());
return;
}
if (context.isRemote(url))
{
report.info(path, FeatureEnum.REFERENCE, href);
Expand Down

This file was deleted.

Binary file not shown.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:title id="title">Minimal EPUB 3.0</dc:title>
<dc:language>en</dc:language>
<dc:identifier id="q">NOID</dc:identifier>
<meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
<link rel="alternate" href="data:application/xhtml+xml,%3Ch1%3EHello%3C%2Fh1%3E" media-type="application/xhtml+xml"/>
</metadata>
<manifest>
<item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
<item id="content_001" href="content_001.xhtml" media-type="application/xhtml+xml"/>
</manifest>
<spine>
<itemref idref="content_001"/>
</spine>
</package>
20 changes: 11 additions & 9 deletions src/test/resources/epub3/03-resources/resources.feature
Original file line number Diff line number Diff line change
Expand Up @@ -493,16 +493,23 @@
## 3.7 Data URLs

@spec @xref:sec-data-urls
Scenario: Allow a data URL in a manifest item not in the spine
When checking file 'data-url-in-manifest-item-valid.opf'
Then no errors or warnings are reported
Scenario: Report a data URL in a manifest item href (not in the spine)
When checking file 'data-url-in-manifest-item-error.opf'
Then error RSC-029 is reported
And no other errors or warnings are reported

@spec @xref:sec-data-urls
Scenario: Report a data URL in a manifest item referenced in the spine
Scenario: Report a data URL in a manifest item href (referenced in the spine)
When checking file 'data-url-in-manifest-item-in-spine-error.opf'
Then error RSC-029 is reported
And no other errors or warnings are reported

@spec @xref:sec-data-urls
Scenario: Report a data URL in a package link href
When checking file 'data-url-in-package-link-error.opf'
Then error RSC-029 is reported
And no other errors or warnings are reported

@spec @xref:sec-data-urls
Scenario: Report a data URL in the `href` attribute of an HTML `a` element
When checking file 'data-url-in-html-a-href-error.xhtml'
Expand Down Expand Up @@ -536,11 +543,6 @@
When checking EPUB 'data-url-in-html-img-foreign-intrinsic-fallback-valid'
And no errors or warnings are reported

@spec @xref:sec-data-urls
Scenario: Allow a data URL defining a foreign resource with a manifest fallback (in an HTML `img` element)
When checking EPUB 'data-url-in-html-img-foreign-manifest-fallback-valid'
And no errors or warnings are reported

@spec @xref:sec-data-urls
Scenario: Report a data URL defining a foreign resource with no fallback (in an HTML `img` element)
When checking EPUB 'data-url-in-html-img-foreign-no-fallback-error'
Expand Down

0 comments on commit 0175818

Please sign in to comment.