Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: check stylesheets declared in SVG #1461

Merged
merged 1 commit into from
Dec 15, 2022
Merged

feat: check stylesheets declared in SVG #1461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/main/java/com/adobe/epubcheck/css/CSSHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ else if (uriOrString.getType() == CssConstruct.Type.STRING)
}
if (uri != null)
{
resolveAndRegister(uri, line, col, atRule.toCssString(), Reference.Type.GENERIC);
resolveAndRegister(uri, line, col, atRule.toCssString(), Reference.Type.STYLESHEET);
}
}
}
Expand Down Expand Up @@ -390,7 +390,10 @@ private void resolveAndRegister(String uriString, int line, int col, String cssC
if (url != null && context.referenceRegistry.isPresent())
{
context.referenceRegistry.get().registerReference(url, type, getCorrectedEPUBLocation(line, col, cssContext));
if (context.isRemote(url))
// register that a remote resource was found
// no need to register a remote stylesheet, as these are disallowed
// and will be reported elsewhere
if (type != Reference.Type.STYLESHEET && context.isRemote(url))
{
detectedProperties.add(ITEM_PROPERTIES.REMOTE_RESOURCES);
}
Expand Down
71 changes: 56 additions & 15 deletions src/main/java/com/adobe/epubcheck/ops/OPSHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@
import java.util.Locale;
import java.util.Stack;

import org.w3c.epubcheck.constants.MIMEType;
import org.w3c.epubcheck.core.references.Reference;
import org.w3c.epubcheck.core.references.Reference.Type;
import org.xml.sax.SAXException;

import com.adobe.epubcheck.api.EPUBLocation;
import com.adobe.epubcheck.css.CSSChecker;
Expand All @@ -40,6 +43,8 @@
import com.adobe.epubcheck.xml.model.XMLElement;

import io.mola.galimatias.URL;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.tree.util.ProcInstParser;

public class OPSHandler extends XMLHandler
{
Expand Down Expand Up @@ -190,6 +195,10 @@ public void startElement()
Reference.Type resourceType = Reference.Type.GENERIC;
if (ns != null)
{
if (name.equals("style"))
{
textNode = new StringBuilder();
}
if (ns.equals("http://www.w3.org/2000/svg"))
{
if (name.equals("lineargradient") || name.equals("radialgradient")
Expand Down Expand Up @@ -246,10 +255,6 @@ else if (name.equals("link"))
{
checkLink();
}
else if (name.equals("style"))
{
textNode = new StringBuilder();
}
else if (name.equals("iframe"))
{
checkIFrame();
Expand Down Expand Up @@ -341,20 +346,21 @@ public void endElement()

EPUBLocation currentLocation = elementLocationStack.pop();

if (EpubConstants.HtmlNamespaceUri.equals(ns))
if ("style".equals(name))
{

if ("style".equals(name))
String style = textNode.toString();
if (style.length() > 0)
{
String style = textNode.toString();
if (style.length() > 0)
{
this.hasCSS = true;
new CSSChecker(context, style, currentLocation.getLine(), false).check();
}
textNode = null;
this.hasCSS = true;
new CSSChecker(context, style, currentLocation.getLine(), false).check();
}
else if ("table".equals(name))
textNode = null;
}

if (EpubConstants.HtmlNamespaceUri.equals(ns))
{

if ("table".equals(name))
{
if (tableDepth > 0)
{
Expand Down Expand Up @@ -392,4 +398,39 @@ public void characters(char[] chars, int start, int length)
}
}

@Override
public void processingInstruction(String target, String data)
throws SAXException
{
super.processingInstruction(target, data);

// for SVG documents, parse 'xml-stylesheet' processing instructions
if (MIMEType.SVG.is(context.mimeType) && "xml-stylesheet".equals(target))
{
checkXMLStylesheetPI(data);
}
}

protected void checkXMLStylesheetPI(String data)
{
assert data != null;
try
{
String type = ProcInstParser.getPseudoAttribute(data, "type");
if (type == null || MIMEType.CSS.is(type))
{
String href = ProcInstParser.getPseudoAttribute(data, "href");
URL url = checkURL(href);
if (url != null)
{
hasCSS = true;
registerReference(url, Type.STYLESHEET);
}
}
} catch (XPathException e1)
{
// ignore invalid declaration, must have been reported earlier
}
}

}
10 changes: 10 additions & 0 deletions src/test/resources/epub3/03-resources/files/file-url-in-svg-content-error.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/test/resources/epub3/03-resources/files/file-url-in-xhtml-content-error.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
<head>
<meta charset="utf-8"/>
<title>Minimal EPUB</title>
<style>
@import url(file:example);
</style>
</head>
<body>
<h1>Loomings</h1>
Expand Down
9 changes: 9 additions & 0 deletions ...sources/files/resources-remote-stylesheet-svg-import-error/EPUB/content_001.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions ...rces/epub3/03-resources/files/resources-remote-stylesheet-svg-import-error/EPUB/nav.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
<head>
<meta charset="utf-8"/>
<title>Minimal Nav</title>
</head>
<body>
<nav epub:type="toc">
<ol>
<li><a href="content_001.svg">content 001</a></li>
</ol>
</nav>
</body>
</html>
16 changes: 16 additions & 0 deletions ...es/epub3/03-resources/files/resources-remote-stylesheet-svg-import-error/EPUB/package.opf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?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>
</metadata>
<manifest>
<item id="content_001" href="content_001.svg" media-type="image/svg+xml"/>
<item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
</manifest>
<spine>
<itemref idref="content_001" />
</spine>
</package>
6 changes: 6 additions & 0 deletions ...b3/03-resources/files/resources-remote-stylesheet-svg-import-error/META-INF/container.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
<rootfiles>
<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
</rootfiles>
</container>
1 change: 1 addition & 0 deletions .../resources/epub3/03-resources/files/resources-remote-stylesheet-svg-import-error/mimetype
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
application/epub+zip
7 changes: 7 additions & 0 deletions ...esources/files/resources-remote-stylesheet-svg-xmlpi-error/EPUB/content_001.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions ...urces/epub3/03-resources/files/resources-remote-stylesheet-svg-xmlpi-error/EPUB/nav.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
<head>
<meta charset="utf-8"/>
<title>Minimal Nav</title>
</head>
<body>
<nav epub:type="toc">
<ol>
<li><a href="content_001.svg">content 001</a></li>
</ol>
</nav>
</body>
</html>
16 changes: 16 additions & 0 deletions ...ces/epub3/03-resources/files/resources-remote-stylesheet-svg-xmlpi-error/EPUB/package.opf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?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>
</metadata>
<manifest>
<item id="content_001" href="content_001.svg" media-type="image/svg+xml"/>
<item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
</manifest>
<spine>
<itemref idref="content_001" />
</spine>
</package>
6 changes: 6 additions & 0 deletions ...ub3/03-resources/files/resources-remote-stylesheet-svg-xmlpi-error/META-INF/container.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
<rootfiles>
<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
</rootfiles>
</container>
1 change: 1 addition & 0 deletions ...t/resources/epub3/03-resources/files/resources-remote-stylesheet-svg-xmlpi-error/mimetype
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
application/epub+zip
22 changes: 20 additions & 2 deletions src/test/resources/epub3/03-resources/resources.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,18 @@
Then error RSC-006 is reported
And no other errors or warnings are reported

@spec @xref:sec-resource-locations
Scenario: Report a remote stylesheet declared in SVG XML processing instruction
When checking EPUB 'resources-remote-stylesheet-svg-xmlpi-error'
Then error RSC-006 is reported
And no other errors or warnings are reported

@spec @xref:sec-resource-locations
Scenario: Report a remote stylesheet declared in SVG inline style import
When checking EPUB 'resources-remote-stylesheet-svg-import-error'
Then error RSC-006 is reported
And no other errors or warnings are reported

@spec @xref:sec-resource-locations
Scenario: Warn about a remote resource with a non `https` URL
When checking EPUB 'resources-remote-not-https-warning'
Expand Down Expand Up @@ -544,9 +556,15 @@
And no other errors or warnings are reported

@spec @xref:sec-file-urls
Scenario: Report a file URL used in a content document
Scenario: Report a file URL used in an XHTML content document
When checking document 'file-url-in-xhtml-content-error.xhtml'
Then error RSC-030 is reported
Then error RSC-030 is reported 2 times
And no other errors or warnings are reported

@spec @xref:sec-file-urls
Scenario: Report a file URL used in an SVG content document
When checking document 'file-url-in-svg-content-error.svg'
Then error RSC-030 is reported 2 times
And no other errors or warnings are reported

@spec @xref:sec-file-urls
Expand Down
Binary file added ...dia-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/EPUB/content_001.mp3
View file
Open in desktop
Binary file not shown.
9 changes: 9 additions & 0 deletions ...ia-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/EPUB/content_001.smil
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<smil xmlns="http://www.w3.org/ns/SMIL" xmlns:epub="http://www.idpf.org/2007/ops" version="3.0">
<body>
<par id="par1">
<text src="content_001.svg#c01"/>
<audio src="content_001.mp3"/>
</par>
</body>
</smil>
14 changes: 14 additions & 0 deletions ...ys/files/mediaoverlays-active-class-svg-inline-style-valid/EPUB/content_001.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions .../09-media-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/EPUB/nav.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
<head>
<meta charset="utf-8"/>
<title>Minimal Nav</title>
</head>
<body>
<nav epub:type="toc">
<ol>
<li><a href="content_001.svg">content 001</a></li>
</ol>
</nav>
</body>
</html>
22 changes: 22 additions & 0 deletions ...9-media-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/EPUB/package.opf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?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>
<meta property="media:duration">2.5s</meta>
<meta property="media:duration" refines="#mo_001">2.5s</meta>
<meta property="media:active-class">-epub-media-overlay-active</meta>
<meta property="media:playback-active-class">-epub-media-overlay-playing</meta>
</metadata>
<manifest>
<item id="content_001" href="content_001.svg" media-type="image/svg+xml" media-overlay="mo_001"/>
<item id="mo_001" href="content_001.smil" media-type="application/smil+xml"/>
<item id="audio_001" href="content_001.mp3" media-type="audio/mpeg"/>
<item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
</manifest>
<spine>
<itemref idref="content_001" />
</spine>
</package>
6 changes: 6 additions & 0 deletions ...a-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/META-INF/container.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
<rootfiles>
<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
</rootfiles>
</container>
1 change: 1 addition & 0 deletions .../epub3/09-media-overlays/files/mediaoverlays-active-class-svg-inline-style-valid/mimetype
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
application/epub+zip
Binary file added ...-overlays/files/mediaoverlays-active-class-svg-style-not-found-error/EPUB/content_001.mp3
View file
Open in desktop
Binary file not shown.
9 changes: 9 additions & 0 deletions ...overlays/files/mediaoverlays-active-class-svg-style-not-found-error/EPUB/content_001.smil
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<smil xmlns="http://www.w3.org/ns/SMIL" xmlns:epub="http://www.idpf.org/2007/ops" version="3.0">
<body>
<par id="par1">
<text src="content_001.svg#c01"/>
<audio src="content_001.mp3"/>
</par>
</body>
</smil>
6 changes: 6 additions & 0 deletions ...files/mediaoverlays-active-class-svg-style-not-found-error/EPUB/content_001.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading