SingleFile/extension/core/content/content.js

/*
 * Copyright 2010-2019 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, SingleFileBrowser, singlefile, frameTree, document, window, lazyLoader, setTimeout, docHelper */

this.singlefile.top = this.singlefile.top || (() => {

	const MAX_CONTENT_SIZE = 64 * (1024 * 1024);
	const DOWNLOADER_FRAME_ID = "single-file-downloader";
	const SingleFile = SingleFileBrowser.getClass();

	let processing = false;

	browser.runtime.onMessage.addListener(message => {
		if (message.method == "content.save") {
			savePage(message);
		}
	});
	return true;

	async function savePage(message) {
		const options = message.options;
		if (!processing) {
			let selectionFound;
			if (options.selected) {
				selectionFound = await singlefile.ui.markSelection();
			}
			if (!options.selected || selectionFound) {
				processing = true;
				try {
					const page = await processPage(options);
					await downloadPage(page, options);
				} catch (error) {
					console.error(error); // eslint-disable-line no-console
					browser.runtime.sendMessage({ method: "ui.processError", error, options: {} });
				}
			} else {
				browser.runtime.sendMessage({ method: "ui.processCancelled", options: {} });
			}
			processing = false;
		}
	}

	async function processPage(options) {
		docHelper.initDoc(document);
		const iframe = document.getElementById(DOWNLOADER_FRAME_ID);
		if (iframe) {
			iframe.remove();
		}
		if (options.shadowEnabled) {
			singlefile.ui.onStartPage();
		}
		const processor = new SingleFile(options);
		const preInitializationPromises = [];
		options.insertSingleFileComment = true;
		if (!options.saveRawPage) {
			if (!options.removeFrames && this.frameTree) {
				let frameTreePromise;
				if (options.loadDeferredImages) {
					frameTreePromise = new Promise(resolve => setTimeout(() => resolve(frameTree.getAsync(options)), options.loadDeferredImagesMaxIdleTime - frameTree.TIMEOUT_INIT_REQUEST_MESSAGE));
				} else {
					frameTreePromise = frameTree.getAsync(options);
				}
				if (options.shadowEnabled) {
					singlefile.ui.onLoadingFrames();
					frameTreePromise.then(() => singlefile.ui.onLoadFrames());
				}
				preInitializationPromises.push(frameTreePromise);
			}
			if (options.loadDeferredImages) {
				const lazyLoadPromise = lazyLoader.process(options);
				if (options.shadowEnabled) {
					singlefile.ui.onLoadingDeferResources();
					lazyLoadPromise.then(() => singlefile.ui.onLoadDeferResources());
				}
				preInitializationPromises.push(lazyLoadPromise);
			}
		}
		let index = 0, maxIndex = 0;
		options.onprogress = event => {
			if (event.type == event.RESOURCES_INITIALIZED) {
				maxIndex = event.detail.max;
			}
			if (event.type == event.RESOURCES_INITIALIZED || event.type == event.RESOURCE_LOADED) {
				if (event.type == event.RESOURCE_LOADED) {
					index++;
				}
				browser.runtime.sendMessage({ method: "ui.processProgress", index, maxIndex, options: {} });
				if (options.shadowEnabled) {
					singlefile.ui.onLoadResource(index, maxIndex);
				}
			} if (event.type == event.PAGE_ENDED) {
				browser.runtime.sendMessage({ method: "ui.processEnd", options: {} });
			} else if (options.shadowEnabled) {
				if (!event.detail.frame) {
					if (event.type == event.PAGE_LOADING) {
						singlefile.ui.onPageLoading();
					} else if (event.type == event.PAGE_LOADED) {
						singlefile.ui.onLoadPage();
					} else if (event.type == event.STAGE_STARTED) {
						if (event.detail.step < 3) {
							singlefile.ui.onStartStage(event.detail.step);
						}
					} else if (event.type == event.STAGE_ENDED) {
						if (event.detail.step < 3) {
							singlefile.ui.onEndStage(event.detail.step);
						}
					} else if (event.type == event.STAGE_TASK_STARTED) {
						singlefile.ui.onStartStageTask(event.detail.step, event.detail.task);
					} else if (event.type == event.STAGE_TASK_ENDED) {
						singlefile.ui.onEndStageTask(event.detail.step, event.detail.task);
					}
				}
			}
		};
		[options.framesData] = await Promise.all(preInitializationPromises);
		const selectedFrame = options.framesData && options.framesData.find(frameData => frameData.requestedFrame);
		options.win = window;
		if (selectedFrame) {
			options.content = selectedFrame.content;
			options.url = selectedFrame.baseURI;
			options.canvasData = selectedFrame.canvasData;
			options.fontsData = selectedFrame.fontsData;
			options.stylesheetContents = selectedFrame.stylesheetContents;
			options.imageData = selectedFrame.imageData;
			options.postersData = selectedFrame.postersData;
			options.usedFonts = selectedFrame.usedFonts;
			options.shadowRootContents = selectedFrame.shadowRootContents;
		} else {
			options.doc = document;
		}
		await processor.run();
		if (!options.saveRawPage && !options.removeFrames && this.frameTree) {
			this.frameTree.cleanup(options);
		}
		if (options.confirmInfobarContent) {
			options.infobarContent = singlefile.ui.prompt("Infobar content", options.infobarContent) || "";
		}
		const page = await processor.getPageData();
		if (options.selected) {
			singlefile.ui.unmarkSelection();
		}
		if (options.shadowEnabled) {
			singlefile.ui.onEndPage();
		}
		if (options.displayStats) {
			console.log("SingleFile stats"); // eslint-disable-line no-console
			console.table(page.stats); // eslint-disable-line no-console
		}
		return page;
	}

	async function downloadPage(page, options) {
		if (options.backgroundSave) {
			let response;
			for (let blockIndex = 0; !response && (blockIndex * MAX_CONTENT_SIZE < page.content.length); blockIndex++) {
				const message = { method: "downloads.download", confirmFilename: options.confirmFilename, filenameConflictAction: options.filenameConflictAction, filename: page.filename, saveToClipboard: options.saveToClipboard };
				message.truncated = page.content.length > MAX_CONTENT_SIZE;
				if (message.truncated) {
					message.finished = (blockIndex + 1) * MAX_CONTENT_SIZE > page.content.length;
					message.content = page.content.substring(blockIndex * MAX_CONTENT_SIZE, (blockIndex + 1) * MAX_CONTENT_SIZE);
				} else {
					message.content = page.content;
				}
				response = await browser.runtime.sendMessage(message);
			}
		} else {
			if (options.saveToClipboard) {
				saveToClipboard(page);
			} else {
				downloadPageForeground(page, options);
			}
		}
	}

	function downloadPageForeground(page, options) {
		if (options.confirmFilename) {
			page.filename = singlefile.ui.prompt("File name", page.filename);
		}
		if (page.filename && page.filename.length) {
			const iframe = document.createElement("iframe");
			iframe.id = DOWNLOADER_FRAME_ID;
			iframe.style.setProperty("display", "inline-block", "important");
			iframe.style.setProperty("max-width", "0", "important");
			iframe.style.setProperty("max-height", "0", "important");
			iframe.style.setProperty("border-width", "0", "important");
			iframe.style.setProperty("margin", "0", "important");
			iframe.src = browser.runtime.getURL("/extension/core/pages/downloader.html");
			iframe.onload = () => iframe.contentWindow.postMessage(JSON.stringify([page.filename, page.content]), "*");
			document.body.appendChild(iframe);
		}
	}

	function saveToClipboard(page) {
		const command = "copy";
		document.addEventListener(command, listener);
		document.execCommand(command);
		document.removeEventListener(command, listener);

		function listener(event) {
			event.clipboardData.setData("text/html", page.content);
			event.clipboardData.setData("text/plain", page.content);
			event.preventDefault();
		}
	}

})();