SingleFile/lib/single-file-extension-bootstrap.js

(function () {
	'use strict';

	/*
	 * Copyright 2010-2020 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 browser, globalThis, window, document, location, setTimeout, XMLHttpRequest, Node, DOMParser */

	const MAX_CONTENT_SIZE = 32 * (1024 * 1024);

	const singlefile = globalThis.singlefileBootstrap;
	const pendingResponses = new Map();

	let unloadListenerAdded, optionsAutoSave, tabId, tabIndex, autoSaveEnabled, autoSaveTimeout, autoSavingPage, pageAutoSaved, previousLocationHref, savedPageDetected, compressContent, extractDataFromPageTags, insertTextBody;
	singlefile.pageInfo = {
		updatedResources: {},
		visitDate: new Date()
	};
	browser.runtime.sendMessage({ method: "bootstrap.init" }).then(message => {
		optionsAutoSave = message.optionsAutoSave;
		const options = message.options;
		tabId = message.tabId;
		tabIndex = message.tabIndex;
		autoSaveEnabled = message.autoSaveEnabled;
		if (options && options.autoOpenEditor && detectSavedPage(document)) {
			if (document.readyState == "loading") {
				document.addEventListener("DOMContentLoaded", () => openEditor(document));
			} else {
				openEditor(document);
			}
		} else {
			if (document.readyState == "loading") {
				document.addEventListener("DOMContentLoaded", refresh);
			} else {
				refresh();
			}
		}
	});
	browser.runtime.onMessage.addListener(message => {
		if ((autoSaveEnabled && message.method == "content.autosave") ||
			message.method == "content.maybeInit" ||
			message.method == "content.init" ||
			message.method == "content.openEditor" ||
			message.method == "devtools.resourceCommitted" ||
			message.method == "singlefile.fetchResponse") {
			return onMessage(message);
		}
	});
	document.addEventListener("DOMContentLoaded", init, false);
	if (globalThis.window == globalThis.top && location && location.href && (location.href.startsWith("file://") || location.href.startsWith("content://"))) {
		if (document.readyState == "loading") {
			document.addEventListener("DOMContentLoaded", extractFile, false);
		} else {
			extractFile();
		}
	}

	async function extractFile() {
		if (document.documentElement.dataset.sfz !== undefined) {
			const data = await getContent();
			executeBootstrap(data);
		} else {
			if ((document.body && document.body.childNodes.length == 1 && document.body.childNodes[0].tagName == "PRE" && /<html[^>]* data-sfz[^>]*>/i.test(document.body.childNodes[0].textContent))) {
				const doc = (new DOMParser()).parseFromString(document.body.childNodes[0].textContent, "text/html");
				document.replaceChild(doc.documentElement, document.documentElement);
				document.querySelectorAll("script").forEach(element => {
					const scriptElement = document.createElement("script");
					scriptElement.textContent = element.textContent;
					element.parentElement.replaceChild(scriptElement, element);
				});
				await extractFile();
			}
		}
	}

	function getContent() {
		return new Promise((resolve, reject) => {
			const xhr = new XMLHttpRequest();
			xhr.open("GET", location.href);
			xhr.send();
			xhr.responseType = "arraybuffer";
			xhr.onload = () => resolve(new Uint8Array(xhr.response));
			xhr.onerror = () => {
				const errorMessageElement = document.getElementById("sfz-error-message");
				if (errorMessageElement) {
					errorMessageElement.remove();
				}
				const requestId = pendingResponses.size;
				pendingResponses.set(requestId, { resolve, reject });
				browser.runtime.sendMessage({ method: "singlefile.fetch", requestId, url: location.href });
			};
		});
	}

	function executeBootstrap(data) {
		const scriptElement = document.createElement("script");
		scriptElement.textContent = "(() => { document.currentScript.remove(); const bootstrapReady = this.bootstrap && this.bootstrap([" + (new Uint8Array(data)).toString() + "]); if (bootstrapReady) { bootstrapReady.then(() => document.dispatchEvent(new CustomEvent(\"single-file-display-infobar\"))); } })()";
		document.body.appendChild(scriptElement);
	}

	async function onMessage(message) {
		if (autoSaveEnabled && message.method == "content.autosave") {
			initAutoSavePage(message);
			return {};
		}
		if (message.method == "content.maybeInit") {
			init();
			return {};
		}
		if (message.method == "content.init") {
			optionsAutoSave = message.options;
			autoSaveEnabled = message.autoSaveEnabled;
			refresh();
			return {};
		}
		if (message.method == "content.openEditor") {
			if (detectSavedPage(document)) {
				openEditor(document);
			} else {
				refresh();
			}
			return {};
		}
		if (message.method == "devtools.resourceCommitted") {
			singlefile.pageInfo.updatedResources[message.url] = { content: message.content, type: message.type, encoding: message.encoding };
			return {};
		}
		if (message.method == "singlefile.fetchResponse") {
			return await onFetchResponse(message);
		}
	}

	async function onFetchResponse(message) {
		const pendingResponse = pendingResponses.get(message.requestId);
		if (pendingResponse) {
			if (message.error) {
				pendingResponse.reject(new Error(message.error));
				pendingResponses.delete(message.requestId);
			} else {
				if (message.truncated) {
					if (pendingResponse.array) {
						pendingResponse.array = pendingResponse.array.concat(message.array);
					} else {
						pendingResponse.array = message.array;
						pendingResponses.set(message.requestId, pendingResponse);
					}
					if (message.finished) {
						message.array = pendingResponse.array;
					}
				}
				if (!message.truncated || message.finished) {
					pendingResponse.resolve(message.array);
					pendingResponses.delete(message.requestId);
				}
			}
			return {};
		}
	}

	function init() {
		const legacyInfobarElement = document.querySelector("singlefile-infobar");
		if (legacyInfobarElement) {
			legacyInfobarElement.remove();
		}
		if (previousLocationHref != location.href && !singlefile.pageInfo.processing) {
			pageAutoSaved = false;
			previousLocationHref = location.href;
			browser.runtime.sendMessage({ method: "tabs.init", savedPageDetected: detectSavedPage(document) }).catch(() => { });
			browser.runtime.sendMessage({ method: "ui.processInit" }).catch(() => { });
		}
	}

	async function initAutoSavePage(message) {
		optionsAutoSave = message.options;
		if (document.readyState != "complete") {
			await new Promise(resolve => globalThis.addEventListener("load", resolve));
		}
		await autoSavePage();
		if (optionsAutoSave.autoSaveRepeat) {
			setTimeout(() => {
				if (autoSaveEnabled && !autoSavingPage) {
					pageAutoSaved = false;
					optionsAutoSave.autoSaveDelay = 0;
					onMessage(message);
				}
			}, optionsAutoSave.autoSaveRepeatDelay * 1000);
		}
	}

	async function autoSavePage() {
		const helper = singlefile.helper;
		if ((!autoSavingPage || autoSaveTimeout) && !pageAutoSaved) {
			autoSavingPage = true;
			if (optionsAutoSave.autoSaveDelay && !autoSaveTimeout) {
				await new Promise(resolve => autoSaveTimeout = setTimeout(resolve, optionsAutoSave.autoSaveDelay * 1000));
				await autoSavePage();
			} else {
				const waitForUserScript = window[helper.WAIT_FOR_USERSCRIPT_PROPERTY_NAME];
				let frames = [];
				let framesSessionId;
				autoSaveTimeout = null;
				if (!optionsAutoSave.removeFrames && globalThis.frames && globalThis.frames.length) {
					frames = await singlefile.processors.frameTree.getAsync(optionsAutoSave);
				}
				framesSessionId = frames && frames.sessionId;
				if (optionsAutoSave.userScriptEnabled && waitForUserScript) {
					await waitForUserScript(helper.ON_BEFORE_CAPTURE_EVENT_NAME);
				}
				const docData = helper.preProcessDoc(document, globalThis, optionsAutoSave);
				savePage(docData, frames);
				if (framesSessionId) {
					singlefile.processors.frameTree.cleanup(framesSessionId);
				}
				helper.postProcessDoc(document, docData.markedElements, docData.invalidElements);
				if (optionsAutoSave.userScriptEnabled && waitForUserScript) {
					await waitForUserScript(helper.ON_AFTER_CAPTURE_EVENT_NAME);
				}
				pageAutoSaved = true;
				autoSavingPage = false;
			}
		}
	}

	function refresh() {
		if (autoSaveEnabled && optionsAutoSave && (optionsAutoSave.autoSaveUnload || optionsAutoSave.autoSaveLoadOrUnload || optionsAutoSave.autoSaveDiscard || optionsAutoSave.autoSaveRemove)) {
			if (!unloadListenerAdded) {
				globalThis.addEventListener("unload", onUnload);
				document.addEventListener("visibilitychange", onVisibilityChange);
				unloadListenerAdded = true;
			}
		} else {
			globalThis.removeEventListener("unload", onUnload);
			document.removeEventListener("visibilitychange", onVisibilityChange);
			unloadListenerAdded = false;
		}
	}

	function onVisibilityChange() {
		if (document.visibilityState == "hidden" && optionsAutoSave.autoSaveDiscard) {
			autoSaveUnloadedPage({ autoSaveDiscard: optionsAutoSave.autoSaveDiscard });
		}
	}

	function onUnload() {
		if (!pageAutoSaved && (optionsAutoSave.autoSaveUnload || optionsAutoSave.autoSaveLoadOrUnload || optionsAutoSave.autoSaveRemove)) {
			autoSaveUnloadedPage({ autoSaveUnload: optionsAutoSave.autoSaveUnload, autoSaveRemove: optionsAutoSave.autoSaveRemove });
		}
	}

	function autoSaveUnloadedPage({ autoSaveUnload, autoSaveDiscard, autoSaveRemove }) {
		const helper = singlefile.helper;
		const waitForUserScript = window[helper.WAIT_FOR_USERSCRIPT_PROPERTY_NAME];
		let frames = [];
		if (!optionsAutoSave.removeFrames && globalThis.frames && globalThis.frames.length) {
			frames = singlefile.processors.frameTree.getSync(optionsAutoSave);
		}
		if (optionsAutoSave.userScriptEnabled && waitForUserScript) {
			waitForUserScript(helper.ON_BEFORE_CAPTURE_EVENT_NAME);
		}
		const docData = helper.preProcessDoc(document, globalThis, optionsAutoSave);
		savePage(docData, frames, { autoSaveUnload, autoSaveDiscard, autoSaveRemove });
	}

	function savePage(docData, frames, { autoSaveUnload, autoSaveDiscard, autoSaveRemove } = {}) {
		const helper = singlefile.helper;
		const updatedResources = singlefile.pageInfo.updatedResources;
		const visitDate = singlefile.pageInfo.visitDate.getTime();
		Object.keys(updatedResources).forEach(url => updatedResources[url].retrieved = false);
		browser.runtime.sendMessage({
			method: "autosave.save",
			tabId,
			tabIndex,
			taskId: optionsAutoSave.taskId,
			content: helper.serialize(document),
			canvases: docData.canvases,
			fonts: docData.fonts,
			stylesheets: docData.stylesheets,
			images: docData.images,
			posters: docData.posters,
			usedFonts: docData.usedFonts,
			shadowRoots: docData.shadowRoots,
			videos: docData.videos,
			referrer: docData.referrer,
			adoptedStyleSheets: docData.adoptedStyleSheets,
			frames: frames,
			url: location.href,
			updatedResources,
			visitDate,
			autoSaveUnload,
			autoSaveDiscard,
			autoSaveRemove
		});
	}

	async function openEditor(document) {
		let content;
		if (compressContent) {
			content = await getContent();
		} else {
			serializeShadowRoots(document);
			content = singlefile.helper.serialize(document);
		}
		for (let blockIndex = 0; blockIndex * MAX_CONTENT_SIZE < content.length; blockIndex++) {
			const message = {
				method: "editor.open",
				filename: decodeURIComponent(location.href.match(/^.*\/(.*)$/)[1]),
				compressContent,
				extractDataFromPageTags,
				insertTextBody,
				selfExtractingArchive: compressContent
			};
			message.truncated = content.length > MAX_CONTENT_SIZE;
			if (message.truncated) {
				message.finished = (blockIndex + 1) * MAX_CONTENT_SIZE > content.length;
				if (content instanceof Uint8Array) {
					message.content = Array.from(content.subarray(blockIndex * MAX_CONTENT_SIZE, (blockIndex + 1) * MAX_CONTENT_SIZE));
				} else {
					message.content = content.substring(blockIndex * MAX_CONTENT_SIZE, (blockIndex + 1) * MAX_CONTENT_SIZE);
				}
			} else {
				message.content = content instanceof Uint8Array ? Array.from(content) : content;
			}
			await browser.runtime.sendMessage(message);
		}
	}

	function detectSavedPage(document) {
		if (savedPageDetected === undefined) {
			const helper = singlefile.helper;
			const firstDocumentChild = document.documentElement.firstChild;
			compressContent = document.documentElement.dataset.sfz == "";
			extractDataFromPageTags = Boolean(document.querySelector("sfz-extra-data"));
			insertTextBody = Boolean(document.querySelector("body > main[hidden]"));
			savedPageDetected = compressContent || (
				firstDocumentChild.nodeType == Node.COMMENT_NODE &&
				(firstDocumentChild.textContent.includes(helper.COMMENT_HEADER) || firstDocumentChild.textContent.includes(helper.COMMENT_HEADER_LEGACY)));
		}
		return savedPageDetected;
	}

	function serializeShadowRoots(node) {
		const SHADOWROOT_ATTRIBUTE_NAME = "shadowrootmode";
		node.querySelectorAll("*").forEach(element => {
			const shadowRoot = singlefile.helper.getShadowRoot(element);
			if (shadowRoot) {
				serializeShadowRoots(shadowRoot);
				const templateElement = document.createElement("template");
				templateElement.setAttribute(SHADOWROOT_ATTRIBUTE_NAME, "open");
				Array.from(shadowRoot.childNodes).forEach(childNode => templateElement.appendChild(childNode));
				element.appendChild(templateElement);
			}
		});
	}

})();