single-file-core 1.1.77 → 1.1.78

package/core/constants.js

@@ -0,0 +1,13 @@
+const SINGLE_FILE_PREFIX = "single-file-";
+const COMMENT_HEADER = "Page saved with SingleFile";
+const SINGLE_FILE_SIGNATURE = "SingleFile";
+const WAIT_FOR_USERSCRIPT_PROPERTY_NAME = "_singleFile_waitForUserScript";
+const MESSAGE_PREFIX = "__frameTree__::";
+
+export {
+	SINGLE_FILE_PREFIX,
+	COMMENT_HEADER,
+	SINGLE_FILE_SIGNATURE,
+	WAIT_FOR_USERSCRIPT_PROPERTY_NAME,
+	MESSAGE_PREFIX
+};

package/core/helper.js

@@ -26,31 +26,38 @@
 import * as cssUnescape from "./../vendor/css-unescape.js";
 import * as hooksFrames from "./../processors/hooks/content/content-hooks-frames.js";
 import * as infobar from "./infobar.js";
+import {
+	SINGLE_FILE_PREFIX,
+	COMMENT_HEADER,
+	WAIT_FOR_USERSCRIPT_PROPERTY_NAME,
+	MESSAGE_PREFIX
+} from "./constants.js";
 
-const ON_BEFORE_CAPTURE_EVENT_NAME = "single-file-on-before-capture";
-const ON_AFTER_CAPTURE_EVENT_NAME = "single-file-on-after-capture";
-const GET_ADOPTED_STYLESHEETS_REQUEST_EVENT = "single-file-request-get-adopted-stylesheets";
-const UNREGISTER_GET_ADOPTED_STYLESHEETS_REQUEST_EVENT = "single-file-unregister-request-get-adopted-stylesheets";
-const GET_ADOPTED_STYLESHEETS_RESPONSE_EVENT = "single-file-response-get-adopted-stylesheets";
-const REMOVED_CONTENT_ATTRIBUTE_NAME = "data-single-file-removed-content";
-const HIDDEN_CONTENT_ATTRIBUTE_NAME = "data-single-file-hidden-content";
-const KEPT_CONTENT_ATTRIBUTE_NAME = "data-single-file-kept-content";
-const HIDDEN_FRAME_ATTRIBUTE_NAME = "data-single-file-hidden-frame";
-const PRESERVED_SPACE_ELEMENT_ATTRIBUTE_NAME = "data-single-file-preserved-space-element";
-const SHADOW_ROOT_ATTRIBUTE_NAME = "data-single-file-shadow-root-element";
-const WIN_ID_ATTRIBUTE_NAME = "data-single-file-win-id";
-const IMAGE_ATTRIBUTE_NAME = "data-single-file-image";
-const POSTER_ATTRIBUTE_NAME = "data-single-file-poster";
-const VIDEO_ATTRIBUTE_NAME = "data-single-file-video";
-const CANVAS_ATTRIBUTE_NAME = "data-single-file-canvas";
-const STYLE_ATTRIBUTE_NAME = "data-single-file-movable-style";
-const INPUT_VALUE_ATTRIBUTE_NAME = "data-single-file-input-value";
-const LAZY_SRC_ATTRIBUTE_NAME = "data-single-file-lazy-loaded-src";
-const STYLESHEET_ATTRIBUTE_NAME = "data-single-file-stylesheet";
-const DISABLED_NOSCRIPT_ATTRIBUTE_NAME = "data-single-file-disabled-noscript";
-const SELECTED_CONTENT_ATTRIBUTE_NAME = "data-single-file-selected-content";
-const INVALID_ELEMENT_ATTRIBUTE_NAME = "data-single-file-invalid-element";
-const ASYNC_SCRIPT_ATTRIBUTE_NAME = "data-single-file-async-script";
+const ON_BEFORE_CAPTURE_EVENT_NAME = SINGLE_FILE_PREFIX + "on-before-capture";
+const ON_AFTER_CAPTURE_EVENT_NAME = SINGLE_FILE_PREFIX + "on-after-capture";
+const GET_ADOPTED_STYLESHEETS_REQUEST_EVENT = SINGLE_FILE_PREFIX + "request-get-adopted-stylesheets";
+const GET_ADOPTED_STYLESHEETS_RESPONSE_EVENT = SINGLE_FILE_PREFIX + "response-get-adopted-stylesheets";
+const UNREGISTER_GET_ADOPTED_STYLESHEETS_REQUEST_EVENT = SINGLE_FILE_PREFIX + "unregister-request-get-adopted-stylesheets";
+const ON_INIT_USERSCRIPT_EVENT = SINGLE_FILE_PREFIX + "user-script-init";
+const REMOVED_CONTENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "removed-content";
+const HIDDEN_CONTENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "hidden-content";
+const KEPT_CONTENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "kept-content";
+const HIDDEN_FRAME_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "hidden-frame";
+const PRESERVED_SPACE_ELEMENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "preserved-space-element";
+const SHADOW_ROOT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "shadow-root-element";
+const WIN_ID_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "win-id";
+const IMAGE_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "image";
+const POSTER_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "poster";
+const VIDEO_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "video";
+const CANVAS_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "canvas";
+const STYLE_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "movable-style";
+const INPUT_VALUE_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "input-value";
+const LAZY_SRC_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "lazy-loaded-src";
+const STYLESHEET_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "stylesheet";
+const DISABLED_NOSCRIPT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "disabled-noscript";
+const SELECTED_CONTENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "selected-content";
+const INVALID_ELEMENT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "invalid-element";
+const ASYNC_SCRIPT_ATTRIBUTE_NAME = "data-" + SINGLE_FILE_PREFIX + "async-script";
 const FLOW_ELEMENTS_SELECTOR = "*:not(base):not(link):not(meta):not(noscript):not(script):not(style):not(template):not(title)";
 const KEPT_TAG_NAMES = ["NOSCRIPT", "DISABLED-NOSCRIPT", "META", "LINK", "STYLE", "TITLE", "TEMPLATE", "SOURCE", "OBJECT", "SCRIPT", "HEAD", "BODY"];
 const REGEXP_SIMPLE_QUOTES_STRING = /^'(.*?)'$/;
@@ -62,7 +69,6 @@ const FONT_WEIGHTS = {
 	bolder: "700",
 	lighter: "100"
 };
-const COMMENT_HEADER = "Page saved with SingleFile";
 const COMMENT_HEADER_LEGACY = "Archive processed by SingleFile";
 const SINGLE_FILE_UI_ELEMENT_CLASS = "single-file-ui-element";
 const INFOBAR_TAGNAME = infobar.INFOBAR_TAGNAME;
@@ -106,11 +112,13 @@ export {
 	COMMENT_HEADER_LEGACY,
 	SINGLE_FILE_UI_ELEMENT_CLASS,
 	EMPTY_RESOURCE,
-	INFOBAR_TAGNAME
+	INFOBAR_TAGNAME,
+	WAIT_FOR_USERSCRIPT_PROPERTY_NAME,
+	MESSAGE_PREFIX
 };
 
 function initUserScriptHandler() {
-	addEventListener("single-file-user-script-init", () => globalThis._singleFile_waitForUserScript = async eventPrefixName => {
+	addEventListener(ON_INIT_USERSCRIPT_EVENT, () => globalThis[WAIT_FOR_USERSCRIPT_PROPERTY_NAME] = async eventPrefixName => {
 		const event = new CustomEvent(eventPrefixName + "-request", { cancelable: true });
 		const promiseResponse = new Promise(resolve => addEventListener(eventPrefixName + "-response", resolve));
 		dispatchEvent(event);
@@ -283,9 +291,9 @@ function getResourcesInfo(win, doc, element, options, data, elementHidden, compu
 	const tagName = element.tagName && element.tagName.toUpperCase();
 	if (tagName == "CANVAS") {
 		try {
-			data.canvases.push({ 
-				dataURI: element.toDataURL("image/png", ""), 
-				backgroundColor: computedStyle.getPropertyValue("background-color") 
+			data.canvases.push({
+				dataURI: element.toDataURL("image/png", ""),
+				backgroundColor: computedStyle.getPropertyValue("background-color")
 			});
 			element.setAttribute(CANVAS_ATTRIBUTE_NAME, data.canvases.length - 1);
 			data.markedElements.push(element);

package/core/index.js

@@ -34,7 +34,7 @@ const Image = globalThis.Image;
 
 let util, cssTree;
 
-export { 
+export {
 	getClass
 };
 
@@ -48,7 +48,7 @@ class SingleFileClass {
 		this.options = options;
 	}
 	async run() {
-		const waitForUserScript = globalThis._singleFile_waitForUserScript;
+		const waitForUserScript = globalThis[util.WAIT_FOR_USERSCRIPT_PROPERTY_NAME];
 		if (this.options.userScriptEnabled && waitForUserScript) {
 			await waitForUserScript(util.ON_BEFORE_CAPTURE_EVENT_NAME);
 		}
@@ -430,7 +430,7 @@ class Processor {
 		}
 		this.maxResources = this.batchRequest.getMaxResources();
 		if (!this.options.saveRawPage && !this.options.removeFrames && this.options.frames) {
-			this.options.frames.forEach(frameData => (this.maxResources += frameData.maxResources || 0));
+			this.options.frames.forEach(frameData => this.maxResources += frameData.maxResources || 0);
 		}
 		this.stats.set("processed", "resources", this.maxResources);
 	}
@@ -448,7 +448,7 @@ class Processor {
 				acceptHeaders: this.options.acceptHeaders,
 				networkTimeout: this.options.networkTimeout
 			});
-			pageContent = content.data;
+			pageContent = content.data || "";
 		}
 		this.doc = util.parseDocContent(pageContent, this.baseURI);
 		if (this.options.saveRawPage) {
@@ -1277,9 +1277,12 @@ class Processor {
 		let resourcePromises = processAttributeArgs.map(([selector, attributeName, processDuplicates, removeElementIfMissing]) =>
 			ProcessorHelper.processAttribute(this.doc.querySelectorAll(selector), attributeName, this.baseURI, this.options, "image", this.cssVariables, this.styles, this.batchRequest, processDuplicates, removeElementIfMissing)
 		);
+		resourcePromises = resourcePromises.concat([
+			ProcessorHelper.processXLinks(this.doc.querySelectorAll("use"), this.doc, this.baseURI, this.options, this.batchRequest),
+			ProcessorHelper.processSrcset(this.doc.querySelectorAll("img[srcset], source[srcset]"), this.baseURI, this.options, this.batchRequest)
+		]);
 		resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("object[data*=\".pdf\"]"), "data", this.baseURI, this.options, null, this.cssVariables, this.styles, this.batchRequest));
 		resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("embed[src*=\".pdf\"]"), "src", this.baseURI, this.options, null, this.cssVariables, this.styles, this.batchRequest));
-		resourcePromises = resourcePromises.concat([ProcessorHelper.processXLinks(this.doc.querySelectorAll("use"), this.doc, this.baseURI, this.options, this.batchRequest), ProcessorHelper.processSrcset(this.doc.querySelectorAll("img[srcset], source[srcset]"), this.baseURI, this.options, this.batchRequest)]);
 		resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("audio[src], audio > source[src]"), "src", this.baseURI, this.options, "audio", this.cssVariables, this.styles, this.batchRequest));
 		resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("video[src], video > source[src]"), "src", this.baseURI, this.options, "video", this.cssVariables, this.styles, this.batchRequest));
 		await Promise.all(resourcePromises);
@@ -2087,7 +2090,7 @@ function normalizeURL(url) {
 	}
 }
 
-function matchCharsetEquals(stylesheetContent, charset = UTF8_CHARSET) {
+function matchCharsetEquals(stylesheetContent = "", charset = UTF8_CHARSET) {
 	const stylesheetCharset = getCharset(stylesheetContent);
 	if (stylesheetCharset) {
 		return stylesheetCharset == charset.toLowerCase();
@@ -2096,7 +2099,7 @@ function matchCharsetEquals(stylesheetContent, charset = UTF8_CHARSET) {
 	}
 }
 
-function getCharset(stylesheetContent) {
+function getCharset(stylesheetContent = "") {
 	const match = stylesheetContent.match(/^@charset\s+"([^"]*)";/i);
 	if (match && match[1]) {
 		return match[1].toLowerCase().trim();

package/core/infobar.js

@@ -23,6 +23,10 @@
 
 /* global getComputedStyle, XPathResult, Node */
 
+import {
+	SINGLE_FILE_SIGNATURE,
+} from "./constants.js";
+
 const INFOBAR_TAGNAME = "single-file-infobar";
 const INFOBAR_STYLES = `
 .infobar,
@@ -213,7 +217,7 @@ function appendInfobar(doc, options, useShadowRoot) {
 function extractInfobarData(doc) {
 	const result = doc.evaluate("//comment()", doc, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null);
 	let singleFileComment = result && result.singleNodeValue;
-	if (singleFileComment && singleFileComment.nodeType == Node.COMMENT_NODE && singleFileComment.textContent.includes("SingleFile")) {
+	if (singleFileComment && singleFileComment.nodeType == Node.COMMENT_NODE && singleFileComment.textContent.includes(SINGLE_FILE_SIGNATURE)) {
 		const info = singleFileComment.textContent.split("\n");
 		const [, , urlData, ...optionalData] = info;
 		const urlMatch = urlData.match(/^ url: (.*) ?$/);

package/core/util.js

@@ -184,7 +184,8 @@ function getInstance(utilOptions) {
 		COMMENT_HEADER_LEGACY: helper.COMMENT_HEADER_LEGACY,
 		SINGLE_FILE_UI_ELEMENT_CLASS: helper.SINGLE_FILE_UI_ELEMENT_CLASS,
 		EMPTY_RESOURCE: helper.EMPTY_RESOURCE,
-		INFOBAR_TAGNAME: helper.INFOBAR_TAGNAME
+		INFOBAR_TAGNAME: helper.INFOBAR_TAGNAME,
+		WAIT_FOR_USERSCRIPT_PROPERTY_NAME: helper.WAIT_FOR_USERSCRIPT_PROPERTY_NAME
 	};
 
 	async function getContent(resourceURL, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "single-file-core",
-  "version": "1.1.77",
+  "version": "1.1.78",
   "description": "SingleFile Core",
   "author": "Gildas Lormeau",
   "license": "AGPL-3.0-or-later",

package/processors/frame-tree/content/content-frame-tree.js

@@ -28,6 +28,8 @@ import {
 	ON_BEFORE_CAPTURE_EVENT_NAME,
 	ON_AFTER_CAPTURE_EVENT_NAME,
 	WIN_ID_ATTRIBUTE_NAME,
+	WAIT_FOR_USERSCRIPT_PROPERTY_NAME,
+	MESSAGE_PREFIX,
 	preProcessDoc,
 	serialize,
 	postProcessDoc,
@@ -38,13 +40,13 @@ const helper = {
 	ON_BEFORE_CAPTURE_EVENT_NAME,
 	ON_AFTER_CAPTURE_EVENT_NAME,
 	WIN_ID_ATTRIBUTE_NAME,
+	WAIT_FOR_USERSCRIPT_PROPERTY_NAME,
 	preProcessDoc,
 	serialize,
 	postProcessDoc,
 	getShadowRoot
 };
 
-const MESSAGE_PREFIX = "__frameTree__::";
 const FRAMES_CSS_SELECTOR = "iframe, frame, object[type=\"text/html\"][data]";
 const ALL_ELEMENTS_CSS_SELECTOR = "*";
 const INIT_REQUEST_MESSAGE = "singlefile.frameTree.initRequest";
@@ -163,7 +165,7 @@ function getNewSessionId() {
 
 function initRequestSync(message) {
 	const sessionId = message.sessionId;
-	const waitForUserScript = globalThis._singleFile_waitForUserScript;
+	const waitForUserScript = globalThis[helper.WAIT_FOR_USERSCRIPT_PROPERTY_NAME];
 	delete globalThis._singleFile_cleaningUp;
 	if (!TOP_WINDOW) {
 		windowId = globalThis.frameId = message.windowId;
@@ -183,7 +185,7 @@ function initRequestSync(message) {
 
 async function initRequestAsync(message) {
 	const sessionId = message.sessionId;
-	const waitForUserScript = globalThis._singleFile_waitForUserScript;
+	const waitForUserScript = globalThis[helper.WAIT_FOR_USERSCRIPT_PROPERTY_NAME];
 	delete globalThis._singleFile_cleaningUp;
 	if (!TOP_WINDOW) {
 		windowId = globalThis.frameId = message.windowId;