single-file-core 1.5.86 → 1.5.87

package/package.json

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

package/processors/compression/compression-extract.js

@@ -27,7 +27,7 @@ export {
 	extract
 };
 
-async function extract(content, { password, prompt = () => { }, zipOptions = { useWebWorkers: true }, noBlobURL } = {}) {
+async function extract(content, { password, prompt = () => { }, zipOptions = { useWebWorkers: true }, noBlobURL, entries, pagePath = "" } = {}) {
 	const KNOWN_MIMETYPES = {
 		"gif": "image/gif",
 		"jpg": "image/jpeg",
@@ -74,22 +74,28 @@ async function extract(content, { password, prompt = () => { }, zipOptions = { u
 	const REGEXP_MATCH_MANIFEST = /manifest\.json$/;
 	const CHARSET_UTF8 = ";charset=utf-8";
 	const REGEXP_ESCAPE = /([{}()^$&.*?/+|[\\\\]|\]|-)/g;
-	let reader;
+	let zipReader;
 	zip.configure(zipOptions);
-	if (content.readUint8Array) {
-		reader = content;
-	} else {
-		if (Array.isArray(content)) {
-			content = new Blob([new Uint8Array(content)]);
+	if (!entries) {
+		let reader;
+		if (content.readUint8Array) {
+			reader = content;
+		} else {
+			if (Array.isArray(content)) {
+				content = new Blob([new Uint8Array(content)]);
+			}
+			reader = new zip.BlobReader(content);
 		}
-		reader = new zip.BlobReader(content);
+		zipReader = new zip.ZipReader(reader);
+		entries = await zipReader.getEntries();
+	}
+	if (pagePath) {
+		entries = entries.filter(entry => entry.filename.startsWith(pagePath));
 	}
-	const zipReader = new zip.ZipReader(reader);
-	const entries = await zipReader.getEntries();
 	const options = { password };
 	let docContent, origDocContent, url, resources = [], indexPages = [], textResources = [];
 	await Promise.all(entries.map(async entry => {
-		const { filename } = entry;
+		const filename = entry.filename.substring(pagePath.length);
 		let dataWriter, content, textContent, mimeType;
 		const resourceInfo = {};
 		if (!options.password && entry.encrypted) {
@@ -131,7 +137,7 @@ async function extract(content, { password, prompt = () => { }, zipOptions = { u
 				content = URL.createObjectURL(blob);
 			}
 		}
-		const name = entry.filename.match(/^([0-9_]+\/)?(.*)$/)[2];
+		const name = filename.match(/^([0-9_]+\/)?(.*)$/)[2];
 		let prefixPath = "";
 		const prefixPathMatch = filename.match(/(.*\/)[^/]+$/);
 		if (prefixPathMatch && prefixPathMatch[1]) {
@@ -139,7 +145,7 @@ async function extract(content, { password, prompt = () => { }, zipOptions = { u
 		}
 		Object.assign(resourceInfo, {
 			prefixPath,
-			filename: entry.filename,
+			filename,
 			name,
 			url: entry.comment,
 			content,
@@ -148,7 +154,9 @@ async function extract(content, { password, prompt = () => { }, zipOptions = { u
 			parentResources: []
 		});
 	}));
-	await zipReader.close();
+	if (zipReader) {
+		await zipReader.close();
+	}
 	indexPages.sort(sortByFilenameLengthDec);
 	textResources.sort(sortByFilenameLengthInc);
 	resources = resources.sort(sortByFilenameLengthDec).concat(...textResources).concat(...indexPages);

package/processors/compression/compression-router.js

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2010-2026 Gildas Lormeau
+ * contact : gildas.lormeau <at> gmail.com
+ *
+ * This file is part of SingleFile.
+ *
+ *   The code in this file is free software: you can redistribute it and/or
+ *   modify it under the terms of the GNU Affero General Public License
+ *   (GNU AGPL) as published by the Free Software Foundation, either version 3
+ *   of the License, or (at your option) any later version.
+ *
+ *   The code in this file is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+ *   General Public License for more details.
+ *
+ *   As additional permission under GNU AGPL version 3 section 7, you may
+ *   distribute UNMODIFIED VERSIONS OF THIS file without the copy of the GNU
+ *   AGPL normally required by section 4, provided you include this license
+ *   notice and a URL through which recipients can access the Corresponding
+ *   Source.
+ */
+
+/* global globalThis */
+
+export {
+	router
+};
+
+async function router(content, { extract, display }) {
+	const PAGES_PREFIX = "pages/";
+	const PAGES_FILENAME = "sfz-pages.json";
+	const ROUTE_PREFIX = "#sfz/";
+	const { zip, document, location } = globalThis;
+	const cache = new Map();
+	const urlToPath = new Map();
+	let currentPath;
+	zip.configure({ useWebWorkers: true });
+	const zipReader = new zip.ZipReader(content.readUint8Array ? content : new zip.BlobReader(content));
+	const entries = await zipReader.getEntries();
+	const pagesEntry = entries.find(entry => entry.filename == PAGES_FILENAME);
+	if (!pagesEntry) {
+		throw new Error("Pages data not found");
+	}
+	const { pages } = JSON.parse(await pagesEntry.getData(new zip.TextWriter()));
+	pages.forEach(page => {
+		urlToPath.set(stripFragment(page.url), page.path);
+		if (page.originalUrls) {
+			page.originalUrls.forEach(url => urlToPath.set(stripFragment(url), page.path));
+		}
+	});
+	attachListeners();
+	return renderRoute();
+
+	// document.open() removes the listeners of the document and of its window,
+	// re-attaching identical function references is idempotent
+	function attachListeners() {
+		globalThis.addEventListener("click", interceptClick, true);
+		globalThis.addEventListener("hashchange", onHashChange);
+	}
+
+	function onHashChange() {
+		if (location.hash.startsWith(ROUTE_PREFIX) || !location.hash) {
+			renderRoute().catch(error => globalThis.console.error(error));
+		}
+	}
+
+	function interceptClick(event) {
+		let node = event.target;
+		while (node && node.tagName != "A") {
+			node = node.parentNode;
+		}
+		if (node && node.href) {
+			const path = urlToPath.get(stripFragment(node.href));
+			if (path !== undefined) {
+				event.preventDefault();
+				location.hash = ROUTE_PREFIX + path;
+			}
+		}
+	}
+
+	async function renderRoute() {
+		const hash = decodeURIComponent(location.hash);
+		const path = hash.startsWith(ROUTE_PREFIX) ? hash.substring(ROUTE_PREFIX.length) : pages[0].path;
+		if (path == currentPath || !pages.find(page => page.path == path)) {
+			return;
+		}
+		const docContent = await getPageContent(path);
+		currentPath = path;
+		await display(document, docContent);
+		attachListeners();
+	}
+
+	async function getPageContent(path) {
+		if (!cache.has(path)) {
+			const pageEntries = entries.filter(entry => path == "" ?
+				!entry.filename.startsWith(PAGES_PREFIX) && entry.filename != PAGES_FILENAME :
+				entry.filename.startsWith(path));
+			const { docContent } = await extract(null, { entries: pageEntries, pagePath: path });
+			cache.set(path, docContent);
+		}
+		return cache.get(path);
+	}
+
+	function stripFragment(url) {
+		const indexFragment = url.indexOf("#");
+		return indexFragment == -1 ? url : url.substring(0, indexFragment);
+	}
+}

package/processors/compression/compression.js

@@ -37,6 +37,9 @@ import {
 import {
 	display
 } from "./compression-display.js";
+import {
+	router
+} from "./compression-router.js";
 
 const { Blob, fetch, TextEncoder, TextDecoder, DOMParser } = globalThis;
 
@@ -278,6 +281,9 @@ async function prependHTMLData(pageData, zipDataWriter, script, options) {
 		pageContent += "<li style='margin-bottom:10px'><strong>Chrome/Edge/Brave</strong>: Install <a href='https://www.getsinglefile.com'>SingleFile</a> and enable the option \"Allow access to file URLs\" in the details page of the extension.</li>";
 		pageContent += "<li><strong>Safari</strong>: Select \"Security > Disable Local File Restrictions\" in the \"Develop > Developer settings\" menu.</li></ul></div>";
 	}
+	if (pageData.tocContent) {
+		pageContent += pageData.tocContent;
+	}
 	if (options.insertTextBody) {
 		const doc = (new DOMParser()).parseFromString(pageData.content, "text/html");
 		doc.body.querySelectorAll("style, script, noscript").forEach(element => element.remove());
@@ -300,12 +306,17 @@ async function prependHTMLData(pageData, zipDataWriter, script, options) {
 		insertEmbeddedImage: Boolean(options.embeddedImage),
 		insertEmbeddedScreenshotImage: Boolean(options.embeddedScreenshotImage)
 	};
+	const bootstrapBody = options.multiPageArchive ?
+		"(" + router.toString().replace(/\n|\t/g, "") + ")(content,{extract:" +
+		extract.toString().replace(/\n|\t/g, "") + ",display:" +
+		display.toString().replace(/\n|\t/g, "") + "})" :
+		"(" + extract.toString().replace(/\n|\t/g, "") + ")(content,{prompt}).then(({docContent}) => " +
+		display.toString().replace(/\n|\t/g, "") + "(document,docContent," + JSON.stringify(displayOptions) + "))";
 	script = "<script>" +
 		script +
 		"document.currentScript.remove();" +
-		"globalThis.bootstrap=(()=>{let bootstrapStarted;return async content=>{if (bootstrapStarted) return bootstrapStarted; bootstrapStarted = (" +
-		extract.toString().replace(/\n|\t/g, "") + ")(content,{prompt}).then(({docContent}) => " +
-		display.toString().replace(/\n|\t/g, "") + "(document,docContent," + JSON.stringify(displayOptions) + "));return bootstrapStarted;}})();(" +
+		"globalThis.bootstrap=(()=>{let bootstrapStarted;return async content=>{if (bootstrapStarted) return bootstrapStarted; bootstrapStarted = " +
+		bootstrapBody + ";return bootstrapStarted;}})();(" +
 		getContent.toString().replace(/\n|\t/g, "") + ")().then(globalThis.bootstrap).then(() => document.dispatchEvent(new CustomEvent(\"single-file-display-infobar\"))).catch(error => {" +
 		"console.error(error);" +
 		"const waitMessage = document.getElementById(\"sfz-wait-message\");" +