SingleFile/cli/back-ends/webdriver-chromium.js

/*
 * 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 __dirname, require, exports, process, setTimeout, clearTimeout, Buffer */

const path = require("path");

const chrome = require("selenium-webdriver/chrome");
const { Builder } = require("selenium-webdriver");

let driver;

exports.initialize = async () => { };

exports.getPageData = async options => {
	const builder = new Builder();
	builder.setChromeOptions(getBrowserOptions(options));
	driver = builder.forBrowser("chrome").build();
	return await getPageData(driver, options);
};

exports.closeBrowser = () => {
	if (driver) {
		return driver.quit();
	}
};

function getBrowserOptions(options) {
	const chromeOptions = new chrome.Options();
	const optionHeadless = (options.browserHeadless === undefined || options.browserHeadless) && !options.browserDebug;
	if (optionHeadless) {
		chromeOptions.headless();
	}
	if (options.browserExecutablePath) {
		chromeOptions.setChromeBinaryPath(options.browserExecutablePath);
	}
	if (options.webDriverExecutablePath) {
		process.env["webdriver.chrome.driver"] = options.webDriverExecutablePath;
	}
	if (options.browserArgs) {
		const args = JSON.parse(options.browserArgs);
		args.forEach(argument => chromeOptions.addArguments(argument));
	}
	if (options.browserDisableWebSecurity === undefined || options.browserDisableWebSecurity) {
		chromeOptions.addArguments("--disable-web-security");
	}
	chromeOptions.addArguments("--no-pings");
	if (!optionHeadless) {
		if (options.browserDebug) {
			chromeOptions.addArguments("--auto-open-devtools-for-tabs");
		}
		const extensions = [];
		if (options.browserBypassCSP === undefined || options.browserBypassCSP) {
			extensions.push(encode(require.resolve("./extensions/signed/bypass_csp-0.0.3-an+fx.xpi")));
		}
		if (options.browserWaitUntil === undefined || options.browserWaitUntil == "networkidle0" || options.browserWaitUntil == "networkidle2") {
			extensions.push(encode(require.resolve("./extensions/signed/network_idle-0.0.2-an+fx.xpi")));
		}
		if (options.browserExtensions && options.browserExtensions.length) {
			options.browserExtensions.forEach(extensionPath => extensions.push(encode(path.resolve(__dirname, "..", extensionPath))));
		}
		chromeOptions.addExtensions(extensions);
	}
	if (options.userAgent) {
		chromeOptions.addArguments("--user-agent=" + JSON.stringify(options.userAgent));
	}
	if (options.browserMobileEmulation) {
		chromeOptions.setMobileEmulation({
			deviceName: options.browserMobileEmulation
		});
	}
	return chromeOptions;
}

async function getPageData(driver, options) {
	const optionHeadless = (options.browserHeadless === undefined || options.browserHeadless) && !options.browserDebug;
	driver.manage().setTimeouts({ script: options.browserLoadMaxTime, pageLoad: options.browserLoadMaxTime, implicit: options.browserLoadMaxTime });
	if (options.browserWidth && options.browserHeight) {
		const window = driver.manage().window();
		if (window.setRect) {
			window.setRect(options.browserHeight, options.browserWidth);
		} else if (window.setSize) {
			window.setSize(options.browserWidth, options.browserHeight);
		}
	}
	const scripts = await require("./common/scripts.js").get(options);
	if (options.browserDebug) {
		// await driver.sleep(3000);
	}
	await driver.get(options.url);
	await driver.executeScript(scripts);
	if (options.browserWaitUntil != "domcontentloaded") {
		let scriptPromise;
		if (!optionHeadless && (options.browserWaitUntil === undefined || options.browserWaitUntil == "networkidle0")) {
			scriptPromise = driver.executeAsyncScript("addEventListener(\"single-file-network-idle-0\", () => arguments[0](), true)");
		} else if (!optionHeadless && options.browserWaitUntil == "networkidle2") {
			scriptPromise = driver.executeAsyncScript("addEventListener(\"single-file-network-idle-2\", () => arguments[0](), true)");
		} else if (optionHeadless || options.browserWaitUntil == "load") {
			scriptPromise = driver.executeAsyncScript("if (document.readyState == \"loading\" || document.readyState == \"interactive\") { addEventListener(\"load\", () => arguments[0]()) } else { arguments[0](); }");
		}
		let cancelTimeout;
		const timeoutPromise = new Promise(resolve => {
			const timeoutId = setTimeout(resolve, Math.max(0, options.browserLoadMaxTime - 5000));
			cancelTimeout = () => {
				clearTimeout(timeoutId);
				resolve();
			};
		});
		await Promise.race([scriptPromise, timeoutPromise]);
		cancelTimeout();
	}
	const result = await driver.executeAsyncScript(getPageDataScript(), options);
	if (result.error) {
		throw result.error;
	} else {
		return result.pageData;
	}
}

function encode(file) {
	return new Buffer.from(require("fs").readFileSync(file)).toString("base64");
}

function getPageDataScript() {
	return `
	const [options, callback] = arguments;
	getPageData()
		.then(pageData => callback({ pageData }))
		.catch(error => callback({ error: error.toString() }));

	async function getPageData() {
		const pageData = await singlefile.lib.getPageData(options);
		if (options.includeInfobar) {
			await singlefile.common.ui.content.infobar.includeScript(pageData);
		}
		return pageData;
	}
	`;
}