SingleFile/lib/hooks/hooks-frame.js

/*
 * Copyright 2010-2019 Gildas Lormeau
 * contact : gildas.lormeau <at> gmail.com
 * 
 * This file is part of SingleFile.
 *
 *   SingleFile is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   SingleFile 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 Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with SingleFile.  If not, see <http://www.gnu.org/licenses/>.
 */

/* global window, addEventListener, dispatchEvent, CustomEvent, document, HTMLDocument, FileReader, Blob, setTimeout, clearTimeout, screen, Element, UIEvent */

this.hooksFrame = this.hooksFrame || (() => {

	const LOAD_DEFERRED_IMAGES_START_EVENT = "single-file-load-deferred-images-start";
	const LOAD_DEFERRED_IMAGES_END_EVENT = "single-file-load-deferred-images-end";
	const LOAD_IMAGE_EVENT = "single-file-load-image";
	const IMAGE_LOADED_EVENT = "single-file-image-loaded";
	const NEW_FONT_FACE_EVENT = "single-file-new-font-face";
	const fontFaces = [];

	if (document instanceof HTMLDocument) {
		const scriptElement = document.createElement("script");
		scriptElement.textContent = `(${hook.toString()})(${JSON.stringify({ LOAD_DEFERRED_IMAGES_START_EVENT, LOAD_DEFERRED_IMAGES_END_EVENT, LOAD_IMAGE_EVENT, IMAGE_LOADED_EVENT, NEW_FONT_FACE_EVENT })})`;
		(document.documentElement || document).appendChild(scriptElement);
		scriptElement.remove();
		addEventListener(NEW_FONT_FACE_EVENT, event => fontFaces.push(event.detail));
	}

	return {
		getFontsData: () => fontFaces,
		loadDeferredImagesStart: () => dispatchEvent(new CustomEvent(LOAD_DEFERRED_IMAGES_START_EVENT)),
		loadDeferredImagesEnd: () => dispatchEvent(new CustomEvent(LOAD_DEFERRED_IMAGES_END_EVENT)),
		LOAD_IMAGE_EVENT,
		IMAGE_LOADED_EVENT
	};

	function hook(constants) {
		const {
			LOAD_DEFERRED_IMAGES_START_EVENT,
			LOAD_DEFERRED_IMAGES_END_EVENT,
			LOAD_IMAGE_EVENT,
			IMAGE_LOADED_EVENT,
			NEW_FONT_FACE_EVENT
		} = constants;
		const FONT_STYLE_PROPERTIES = {
			family: "font-family",
			style: "font-style",
			weight: "font-weight",
			stretch: "font-stretch",
			unicodeRange: "unicode-range",
			variant: "font-variant",
			featureSettings: "font-feature-settings"
		};

		const requestAnimationFrame = window.requestAnimationFrame;
		const cancelAnimationFrame = window.cancelAnimationFrame;
		const observers = new Map();
		const observedElements = new Map();
		let loadDeferredImages;

		addEventListener(LOAD_DEFERRED_IMAGES_START_EVENT, () => {
			loadDeferredImages = true;
			const clientHeight = document.documentElement.clientHeight;
			const clientWidth = document.documentElement.clientWidth;
			const scrollHeight = Math.max(document.documentElement.scrollHeight - (clientHeight * .5), clientHeight);
			const scrollWidth = Math.max(document.documentElement.scrollWidth - (clientWidth * .5), clientWidth);
			document.documentElement.__defineGetter__("clientHeight", () => scrollHeight);
			document.documentElement.__defineGetter__("clientWidth", () => scrollWidth);
			screen.__defineGetter__("height", () => scrollHeight);
			screen.__defineGetter__("width", () => scrollWidth);
			document.__defineGetter__("cookie", () => { throw new Error("document.cookie temporary blocked by SingleFile"); });
			if (!window._singleFile_getBoundingClientRect) {
				window._singleFile_getBoundingClientRect = Element.prototype.getBoundingClientRect;
				Element.prototype.getBoundingClientRect = function () {
					const boundingRect = window._singleFile_getBoundingClientRect.call(this);
					if (this == document.documentElement) {
						boundingRect.__defineGetter__("height", () => scrollHeight);
						boundingRect.__defineGetter__("bottom", () => scrollHeight + boundingRect.top);
						boundingRect.__defineGetter__("width", () => scrollWidth);
						boundingRect.__defineGetter__("right", () => scrollWidth + boundingRect.left);
					}
					return boundingRect;
				};
				window._singleFile_innerHeight = window.innerHeight;
				window._singleFile_innerWidth = window.innerWidth;
				window.__defineGetter__("innerHeight", () => scrollHeight);
				window.__defineGetter__("innerWidth", () => scrollWidth);
			}
			if (!window._singleFile_localStorage) {
				window._singleFile_localStorage = window.localStorage;
				window.__defineGetter__("localStorage", () => { throw new Error("localStorage temporary blocked by SingleFile"); });
			}
			if (!window._singleFileImage) {
				const Image = window.Image;
				window._singleFileImage = window.Image;
				window.__defineGetter__("Image", function () {
					return function () {
						const image = new Image(...arguments);
						const result = new Image(...arguments);
						result.__defineSetter__("src", function (value) {
							dispatchEvent(new CustomEvent(LOAD_IMAGE_EVENT));
							image.src = value;
						});
						result.__defineGetter__("src", function () {
							return image.src;
						});
						result.__defineSetter__("srcset", function (value) {
							dispatchEvent(new CustomEvent(LOAD_IMAGE_EVENT));
							image.srcset = value;
						});
						result.__defineGetter__("srcset", function () {
							return image.srcset;
						});
						image.onload = image.onprogress = image.onloadend = image.onerror = event => {
							dispatchEvent(new CustomEvent(IMAGE_LOADED_EVENT));
							result.dispatchEvent(new UIEvent(event.type, event));
						};
						return result;
					};
				});
			}
			dispatchEvent(new UIEvent("resize"));
			dispatchEvent(new UIEvent("scroll"));
			const docBoundingRect = document.documentElement.getBoundingClientRect();
			Array.from(observers).forEach(([intersectionObserver, observer]) => {
				const rootBoundingRect = observer.options.root && observer.options.root.getBoundingClientRect();
				observer.callback(observedElements.get(intersectionObserver).map(target => {
					const boundingClientRect = target.getBoundingClientRect();
					const isIntersecting = true;
					const intersectionRatio = 1;
					const rootBounds = observer.options && observer.options.root ? rootBoundingRect : docBoundingRect;
					const time = 0;
					return { target, intersectionRatio, boundingClientRect, intersectionRect: boundingClientRect, isIntersecting, rootBounds, time };
				}), intersectionObserver);
			});
			if (pendingRequestAnimationFrameCalls.size) {
				Array.from(pendingRequestAnimationFrameCalls).forEach(([id, callback]) => {
					cancelAnimationFrame(id);
					callback();
				});
			}
		});

		addEventListener(LOAD_DEFERRED_IMAGES_END_EVENT, () => {
			loadDeferredImages = false;
			delete document.documentElement.clientHeight;
			delete document.documentElement.clientWidth;
			delete screen.height;
			delete screen.width;
			delete document.cookie;
			if (window._singleFile_getBoundingClientRect) {
				Element.prototype.getBoundingClientRect = window._singleFile_getBoundingClientRect;
				window.innerHeight = window._singleFile_innerHeight;
				window.innerWidth = window._singleFile_innerWidth;
				delete window._singleFile_getBoundingClientRect;
				delete window._singleFile_innerHeight;
				delete window._singleFile_innerWidth;
			}
			if (window._singleFile_localStorage) {
				delete window.localStorage;
				window.localStorage = window._singleFile_localStorage;
				delete window._singleFile_localStorage;
			}
			if (window._singleFileImage) {
				delete window.Image;
				window.Image = window._singleFileImage;
				delete window._singleFileImage;
			}
			dispatchEvent(new UIEvent("resize"));
			dispatchEvent(new UIEvent("scroll"));
		});

		let warningRequestAnimationFrameDisplayed;
		const pendingRequestAnimationFrameCalls = new Map();
		const pendingSetTimeoutCalls = new Map();
		window.requestAnimationFrame = function (callback) {
			if (!warningRequestAnimationFrameDisplayed) {
				console.warn("SingleFile is hooking the requestAnimationFrame and cancelAnimationFrame functions to load deferred images."); // eslint-disable-line no-console
				warningRequestAnimationFrameDisplayed = true;
			}
			let requestId;
			if (loadDeferredImages) {
				requestId = setTimeout(() => {
					pendingSetTimeoutCalls.delete(requestId);
					callback(0);
				}, 0);
				pendingSetTimeoutCalls.set(requestId, callback);
			} else {
				requestId = requestAnimationFrame(timestamp => {
					pendingRequestAnimationFrameCalls.delete(requestId);
					callback(timestamp);
				});
				pendingRequestAnimationFrameCalls.set(requestId, callback);
			}
			return requestId;
		};
		window.requestAnimationFrame.toString = function () { return "requestAnimationFrame() { [native code] }"; };

		window.cancelAnimationFrame = function (requestId) {
			const pendingCallDeleted = pendingRequestAnimationFrameCalls.delete(requestId);
			if (pendingCallDeleted) {
				return cancelAnimationFrame(requestId);
			} else {
				const pendingCallDeleted = pendingSetTimeoutCalls.delete(requestId);
				if (pendingCallDeleted) {
					return clearTimeout(requestId);
				} else {
					return cancelAnimationFrame(requestId);
				}
			}
		};
		window.cancelAnimationFrame.toString = function () { return "cancelAnimationFrame() { [native code] }"; };

		const FontFace = window.FontFace;
		let warningFontFaceDisplayed;
		window.__defineGetter__("FontFace", () => new Proxy(FontFace, {
			construct(FontFace, argumentsList) {
				if (!warningFontFaceDisplayed) {
					console.warn("SingleFile is hooking the FontFace constructor to get font URLs."); // eslint-disable-line no-console
					warningFontFaceDisplayed = true;
				}
				const detail = {};
				detail["font-family"] = argumentsList[0];
				detail.src = argumentsList[1];
				const descriptors = argumentsList[2];
				if (descriptors) {
					Object.keys(descriptors).forEach(descriptor => {
						if (FONT_STYLE_PROPERTIES[descriptor]) {
							detail[FONT_STYLE_PROPERTIES[descriptor]] = descriptors[descriptor];
						}
					});
				}
				if (detail.src instanceof ArrayBuffer) {
					const reader = new FileReader();
					reader.readAsDataURL(new Blob([detail.src]));
					reader.addEventListener("load", () => {
						detail.src = "url(" + reader.result + ")";
						dispatchEvent(new CustomEvent(NEW_FONT_FACE_EVENT, { detail }));
					});
				} else {
					dispatchEvent(new CustomEvent(NEW_FONT_FACE_EVENT, { detail }));
				}
				return new FontFace(...argumentsList);
			}
		}));

		if (window.IntersectionObserver) {
			const IntersectionObserver = window.IntersectionObserver;
			const observeIntersection = IntersectionObserver.prototype.observe;
			const unobserveIntersection = IntersectionObserver.prototype.unobserve;
			let warningIntersectionObserverDisplayed;
			window.__defineGetter__("IntersectionObserver", () => new Proxy(IntersectionObserver, {
				construct(IntersectionObserver, argumentsList) {
					if (!warningIntersectionObserverDisplayed) {
						console.warn("SingleFile is hooking the IntersectionObserver API to detect and load deferred images."); // eslint-disable-line no-console
						warningRequestAnimationFrameDisplayed = true;
					}
					const intersectionObserver = new IntersectionObserver(...argumentsList);
					const callback = argumentsList[0];
					const options = argumentsList[1];
					intersectionObserver.observe = function (targetElement) {
						let targetElements = observedElements.get(intersectionObserver);
						if (!targetElements) {
							targetElements = [];
							observedElements.set(intersectionObserver, targetElements);
						}
						targetElements.push(targetElement);
						return observeIntersection.call(intersectionObserver, targetElement);
					};
					intersectionObserver.unobserve = function (targetElement) {
						let targetElements = observedElements.get(intersectionObserver);
						if (targetElements) {
							targetElements = targetElements.filter(element => element <= targetElement);
							if (targetElements.length) {
								observedElements.set(intersectionObserver, targetElements);
							} else {
								observedElements.delete(intersectionObserver);
							}
						}
						return unobserveIntersection.call(intersectionObserver, targetElement);
					};
					observers.set(intersectionObserver, { callback, options });
					return intersectionObserver;
				}
			}));
			window.__defineSetter__("IntersectionObserver", () => { });
		}
	}

})();