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.

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: improve checking of data URLs #1412

Merged
merged 1 commit into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ private void initialize()
severities.put(MessageId.RSC_026, Severity.ERROR);
severities.put(MessageId.RSC_027, Severity.WARNING);
severities.put(MessageId.RSC_028, Severity.ERROR);
severities.put(MessageId.RSC_029, Severity.ERROR);

// Scripting
severities.put(MessageId.SCP_001, Severity.SUPPRESSED); // checking scripts is out of scope
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/adobe/epubcheck/messages/MessageId.java
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,7 @@ public enum MessageId implements Comparable<MessageId>
RSC_026("RSC-026"),
RSC_027("RSC-027"),
RSC_028("RSC-028"),
RSC_029("RSC-029"),

// Messages relating to scripting
SCP_001("SCP-001"),
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/adobe/epubcheck/ocf/OCFContainer.java
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,9 @@ public boolean isRemote(URL url)
}
else
{
return !(URLUtils.isSameOrigin(url, rootURL));
return URLUtils.isRemote(url, rootURL);
}
}


}
6 changes: 5 additions & 1 deletion src/main/java/com/adobe/epubcheck/opf/OPFChecker.java
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ protected boolean checkContent()
// only check the filename in single-file mode
// (it is checked by the container checker in full-publication mode)
// and for local resources (i.e. computed to a file URL)
if (!context.container.isPresent() && !item.isRemote())
if (!context.container.isPresent() && !item.isRemote() && !item.hasDataURL())
{
new OCFFilenameChecker(item.getPath(), context, item.getLocation()).check();
}
Expand Down Expand Up @@ -378,6 +378,10 @@ else if (isBlessedStyleType(mimeType))

protected void checkItemContent(OPFItem item)
{
// We do not currently support checking resources defined as data URLs
if (item.hasDataURL()) {
return;
}
// Create a new validation context for the OPF item
// FIXME 2022 set context OPFItem here
// (instead of from XRefChecker in the builder code)
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/com/adobe/epubcheck/opf/OPFChecker30.java
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ else if (!overlayTextChecker.isCorrectOverlay(docURL, mo))
@Override
protected void checkSpineItem(OPFItem item, OPFHandler opfHandler)
{
// Items with `data:` URLs are not allowed in the spine
if (item.hasDataURL()) {
report.message(MessageId.RSC_029, item.getLocation());
return;
}

String mimeType = item.getMimeType();

if (item.getProperties()
Expand Down
17 changes: 17 additions & 0 deletions src/main/java/com/adobe/epubcheck/opf/OPFItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,13 @@ private OPFItem(Builder builder)
{
this.path = url.toHumanString();
}
// If the item is defined with a data URL, return
// the URL string truncated arbitrarily to 30 chars
else if ("data".equals(url.scheme()))
{
String urlString = url.toString();
this.path = url.toString().substring(0, Math.min(urlString.length(), 30)) + "…";
}
// If a container is present (full-publication check)
// the item path is relative to the root of the container
else if (builder.container.isPresent())
Expand Down Expand Up @@ -289,6 +296,16 @@ public boolean isFixedLayout()
return fixedLayout;
}

/**
* Returns <code>true</code> iff this item is a remote resource.
*
* @return <code>true</code> iff this item is a remote resource.
*/
public boolean hasDataURL()
{
return "data".equals(url.scheme());
}

/**
* Returns <code>true</code> iff this item is a remote resource.
*
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/adobe/epubcheck/opf/ValidationContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ private String computePath()
{
if (container.isPresent() && !container.get().isRemote(url))
{
if (!url.path().isEmpty())
if (url.path() != null && !url.path().isEmpty())
{
return url.path().substring(1);
}
Expand Down Expand Up @@ -181,7 +181,7 @@ public boolean isRemote(URL url)
}
else
{
return !(URLUtils.isSameOrigin(url, this.url));
return URLUtils.isRemote(url, this.url);
}
}

Expand Down