single-file-core 1.2.35 → 1.2.37

package/core/helper.js

@@ -21,7 +21,7 @@
  *   Source.
  */
 
-/* global globalThis, CustomEvent */
+/* global globalThis */
 
 import * as cssUnescape from "./../vendor/css-unescape.js";
 import * as hooksFrames from "./../processors/hooks/content/content-hooks-frames.js";
@@ -77,6 +77,10 @@ const EMPTY_RESOURCE = "data:,";
 const addEventListener = (type, listener, options) => globalThis.addEventListener(type, listener, options);
 const dispatchEvent = event => { try { globalThis.dispatchEvent(event); } catch (error) {  /* ignored */ } };
 const JSON = globalThis.JSON;
+const crypto = globalThis.crypto;
+const TextEncoder = globalThis.TextEncoder;
+const Blob = globalThis.Blob;
+const CustomEvent = globalThis.CustomEvent;
 
 export {
 	initUserScriptHandler,
@@ -90,6 +94,8 @@ export {
 	normalizeFontFamily,
 	getShadowRoot,
 	appendInfobar,
+	getContentSize,
+	digest,
 	ON_BEFORE_CAPTURE_EVENT_NAME,
 	ON_AFTER_CAPTURE_EVENT_NAME,
 	WIN_ID_ATTRIBUTE_NAME,
@@ -596,6 +602,33 @@ function getFontWeight(weight) {
 	return FONT_WEIGHTS[weight.toLowerCase().trim()] || weight;
 }
 
+function getContentSize(content) {
+	return new Blob([content]).size;
+}
+
+async function digest(algo, text) {
+	try {
+		const hash = await crypto.subtle.digest(algo, new TextEncoder("utf-8").encode(text));
+		return hex(hash);
+	} catch (error) {
+		return "";
+	}
+}
+
+// https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
+function hex(buffer) {
+	const hexCodes = [];
+	const view = new DataView(buffer);
+	for (let i = 0; i < view.byteLength; i += 4) {
+		const value = view.getUint32(i);
+		const stringValue = value.toString(16);
+		const padding = "00000000";
+		const paddedValue = (padding + stringValue).slice(-padding.length);
+		hexCodes.push(paddedValue);
+	}
+	return hexCodes.join("");
+}
+
 function flatten(array) {
 	return array.flat ? array.flat() : array.reduce((a, b) => a.concat(Array.isArray(b) ? flatten(b) : b), []);
 }

package/core/index.js

@@ -102,6 +102,7 @@ const RESOLVE_URLS_STAGE = 0;
 const REPLACE_DATA_STAGE = 1;
 const REPLACE_DOCS_STAGE = 2;
 const POST_PROCESS_STAGE = 3;
+const FINALIZE_STAGE = 4;
 const STAGES = [{
 	sequential: [
 		{ action: "preProcessPage" },
@@ -164,6 +165,11 @@ const STAGES = [{
 		{ option: "enableMaff", action: "insertMAFFMetaData" },
 		{ action: "setDocInfo" }
 	]
+}, {
+	sequential: [
+		{ action: "loadOptionsFromPage" },
+		{ option: "saveFilenameTemplateData", action: "saveFilenameTemplateData" },
+	]
 }];
 
 class Runner {
@@ -247,6 +253,7 @@ class Runner {
 		this.options.win = null;
 		await this.executeStage(REPLACE_DOCS_STAGE);
 		await this.executeStage(POST_PROCESS_STAGE);
+		await this.executeStage(FINALIZE_STAGE);
 		this.processor.finalize();
 	}
 
@@ -410,6 +417,7 @@ class BatchRequest {
 // ---------
 const SHADOWROOT_ATTRIBUTE_NAME = "shadowrootmode";
 const SCRIPT_TEMPLATE_SHADOW_ROOT = "data-template-shadow-root";
+const SCRIPT_OPTIONS = "data-single-file-options";
 const UTF8_CHARSET = "utf-8";
 
 class Processor {
@@ -632,6 +640,44 @@ class Processor {
 		}
 	}
 
+	loadOptionsFromPage() {
+		const optionsElement = this.doc.body.querySelector("script[type=\"application/json\"][" + SCRIPT_OPTIONS + "]");
+		if (optionsElement) {
+			const options = JSON.parse(optionsElement.textContent);
+			Object.keys(options).forEach(option => this.options[option] = options[option]);
+			this.options.saveDate = new Date(this.options.saveDate);
+			this.options.visitDate = new Date(this.options.visitDate);
+		}
+	}
+
+	saveFilenameTemplateData() {
+		const optionsElement = this.doc.createElement("script");
+		optionsElement.type = "application/json";
+		optionsElement.setAttribute(SCRIPT_OPTIONS, "");
+		optionsElement.textContent = JSON.stringify({
+			saveUrl: this.options.url,
+			saveDate: this.options.saveDate.getTime(),
+			visitDate: this.options.visitDate.getTime(),
+			filenameTemplate: this.options.filenameTemplate,
+			filenameReplacedCharacters: this.options.filenameReplacedCharacters,
+			filenameReplacementCharacter: this.options.filenameReplacementCharacter,
+			filenameMaxLengthUnit: this.options.filenameMaxLengthUnit,
+			filenameMaxLength: this.options.filenameMaxLength,
+			replaceEmojisInFilename: this.options.replaceEmojisInFilename,
+			compressContent: this.options.compressContent,
+			selfExtractingArchive: this.options.selfExtractingArchive,
+			extractDataFromPage: this.options.extractDataFromPage,
+			referrer: this.options.referrer,
+			title: this.options.title,
+			info: this.options.info
+		});
+		if (this.doc.body.firstChild) {
+			this.doc.body.insertBefore(optionsElement, this.doc.body.firstChild);
+		} else {
+			this.doc.body.appendChild(optionsElement);
+		}
+	}
+
 	replaceStyleContents() {
 		if (this.options.stylesheets) {
 			this.doc.querySelectorAll("style").forEach((styleElement, styleIndex) => {
@@ -781,7 +827,7 @@ class Processor {
 				element.setAttribute("src", DISABLED_SCRIPT);
 			}
 		});
-		const scriptElements = this.doc.querySelectorAll("script:not([type=\"application/ld+json\"]):not([" + SCRIPT_TEMPLATE_SHADOW_ROOT + "])");
+		const scriptElements = this.doc.querySelectorAll("script:not([type=\"application/ld+json\"]):not([" + SCRIPT_TEMPLATE_SHADOW_ROOT + "]):not([" + SCRIPT_OPTIONS + "])");
 		this.stats.set("discarded", "scripts", scriptElements.length);
 		this.stats.set("processed", "scripts", scriptElements.length);
 		scriptElements.forEach(element => element.remove());

package/core/util.js

@@ -72,9 +72,7 @@ const DOMParser = globalThis.DOMParser;
 const Blob = globalThis.Blob;
 const FileReader = globalThis.FileReader;
 const fetch = (url, options) => globalThis.fetch(url, options);
-const crypto = globalThis.crypto;
 const TextDecoder = globalThis.TextDecoder;
-const TextEncoder = globalThis.TextEncoder;
 
 export {
 	getInstance
@@ -147,21 +145,16 @@ function getInstance(utilOptions) {
 			}
 		},
 		async digest(algo, text) {
-			try {
-				const hash = await crypto.subtle.digest(algo, new TextEncoder("utf-8").encode(text));
-				return hex(hash);
-			} catch (error) {
-				return "";
-			}
+			return helper.digest(algo, text);
 		},
 		getContentSize(content) {
-			return new Blob([content]).size;
+			return helper.getContentSize(content);
 		},
 		formatFilename(content, doc, options) {
-			return modules.templateFormatter.formatFilename(content, doc, options, this);
+			return modules.templateFormatter.formatFilename(content, doc, options);
 		},
 		async evalTemplate(template, options, content, doc, dontReplaceSlash) {
-			return modules.templateFormatter.evalTemplate(template, options, this, content, doc, dontReplaceSlash);
+			return modules.templateFormatter.evalTemplate(template, options, content, doc, dontReplaceSlash);
 		},
 		minifyHTML(doc, options) {
 			return modules.htmlMinifier.process(doc, options);
@@ -484,20 +477,6 @@ function guessMIMEType(expectedType, buffer, asBinary) {
 	}
 }
 
-// https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
-function hex(buffer) {
-	const hexCodes = [];
-	const view = new DataView(buffer);
-	for (let i = 0; i < view.byteLength; i += 4) {
-		const value = view.getUint32(i);
-		const stringValue = value.toString(16);
-		const padding = "00000000";
-		const paddedValue = (padding + stringValue).slice(-padding.length);
-		hexCodes.push(paddedValue);
-	}
-	return hexCodes.join("");
-}
-
 function getDoctypeString(doc) {
 	const docType = doc.doctype;
 	let docTypeString = "";

package/modules/template-formatter.js

@@ -24,6 +24,7 @@
 /* global Blob, FileReader, URL, URLSearchParams */
 
 import { parse } from "./template-parser.js";
+import { getContentSize, digest } from "./../core/helper.js";
 
 // eslint-disable-next-line quotes
 const DEFAULT_REPLACED_CHARACTERS = ["~", "+", "\\\\", "?", "%", "*", ":", "|", '"', "<", ">", "\x00-\x1f", "\x7F"];
@@ -16865,8 +16866,8 @@ enterprisecloud.nu
 
 export { formatFilename, evalTemplate };
 
-async function formatFilename(content, doc, options, util) {
-	let filename = (await evalTemplate(options.filenameTemplate, options, util, content, doc)) || "";
+async function formatFilename(content, doc, options) {
+	let filename = (await evalTemplate(options.filenameTemplate, options, content, doc)) || "";
 	filename = filename.trim();
 	if (options.replaceEmojisInFilename) {
 		EMOJIS.forEach(emoji => (filename = replaceAll(filename, emoji, " _" + EMOJI_NAMES[emoji] + "_ ")));
@@ -16876,7 +16877,7 @@ async function formatFilename(content, doc, options, util) {
 	if (!options.backgroundSave) {
 		filename = filename.replace(/\//g, replacementCharacter);
 	}
-	if (!options.keepFilename && ((options.filenameMaxLengthUnit == "bytes" && util.getContentSize(filename) > options.filenameMaxLength) || filename.length > options.filenameMaxLength)) {
+	if (!options.keepFilename && ((options.filenameMaxLengthUnit == "bytes" && getContentSize(filename) > options.filenameMaxLength) || filename.length > options.filenameMaxLength)) {
 		const extensionMatch = filename.match(/(\.[^.]{3,4})$/);
 		const extension = extensionMatch && extensionMatch[0] && extensionMatch[0].length > 1 ? extensionMatch[0] : "";
 		filename = options.filenameMaxLengthUnit == "bytes" ? await truncateText(filename, options.filenameMaxLength - extension.length) : filename.substring(0, options.filenameMaxLength - extension.length);
@@ -16891,7 +16892,7 @@ async function formatFilename(content, doc, options, util) {
 	return filename.trim();
 }
 
-async function evalTemplate(template = "", options, util, content, doc, dontReplaceSlash) {
+async function evalTemplate(template = "", options, content, doc, dontReplaceSlash) {
 	const url = new URL(options.saveUrl);
 	const urlHref = decode(url.href);
 	const params = Array.from(new URLSearchParams(url.search));
@@ -16923,7 +16924,7 @@ async function evalTemplate(template = "", options, util, content, doc, dontRepl
 		"url-hostname-root": { getter: () => urlRoot },
 		"url-hostname-subdomains": { getter: () => urlSubDomains },
 		"url-href": { getter: () => urlHref, dontReplaceSlash: dontReplaceSlashIfUndefined },
-		"url-href-digest-sha-1": { getter: urlHref ? async () => util.digest("SHA-1", urlHref) : "" },
+		"url-href-digest-sha-1": { getter: urlHref ? async () => digest("SHA-1", urlHref) : "" },
 		"url-href-flat": { getter: () => decode(url.href), dontReplaceSlash: false },
 		"url-referrer": { getter: () => decode(options.referrer), dontReplaceSlash: dontReplaceSlashIfUndefined },
 		"url-referrer-flat": { getter: () => decode(options.referrer), dontReplaceSlash: false },
@@ -16943,9 +16944,9 @@ async function evalTemplate(template = "", options, util, content, doc, dontRepl
 		"filename-extension": { getter: () => getFilenameExtension(options) }
 	};
 	if (content) {
-		variables["digest-sha-256"] = { getter: async () => util.digest("SHA-256", content) };
-		variables["digest-sha-384"] = { getter: async () => util.digest("SHA-384", content) };
-		variables["digest-sha-512"] = { getter: async () => util.digest("SHA-512", content) };
+		variables["digest-sha-256"] = { getter: async () => digest("SHA-256", content) };
+		variables["digest-sha-384"] = { getter: async () => digest("SHA-384", content) };
+		variables["digest-sha-512"] = { getter: async () => digest("SHA-512", content) };
 	}
 	if (options.saveDate) {
 		addDateVariables(options.saveDate);

package/package.json

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

package/single-file-editor-helper.js

@@ -22,6 +22,7 @@
  */
 
 import * as serializer from "./modules/html-serializer.js";
+import { formatFilename } from "./modules/template-formatter.js";
 import * as infobar from "./core/infobar.js";
 import { getInstance } from "./core/util.js";
 import * as zip from "./vendor/zip/zip.js";
@@ -48,6 +49,7 @@ const helper = {
 	zip,
 	extract,
 	display,
+	formatFilename,
 	INFOBAR_TAGNAME: infobar.INFOBAR_TAGNAME
 };