Detect pre-paginated/fixed-layout layout

Author: Mikkel Vester Petersen

src/book.js

@@ -14,9 +14,11 @@ import Archive from "./archive";
 import request from "./utils/request";
 import EpubCFI from "./epubcfi";
 import Store from "./store";
+import DisplayOptions from "./displayoptions";
 import { EPUBJS_VERSION, EVENTS } from "./utils/constants";
 
 const CONTAINER_PATH = "META-INF/container.xml";
+const IBOOKS_DISPLAY_OPTIONS_PATH = "META-INF/com.apple.ibooks.display-options.xml";
 
 const INPUT_TYPE = {
 	BINARY: "binary",
@@ -85,7 +87,8 @@ class Book {
 			cover: new defer(),
 			navigation: new defer(),
 			pageList: new defer(),
-			resources: new defer()
+			resources: new defer(),
+			displayOptions: new defer()
 		};
 
 		this.loaded = {
@@ -95,7 +98,8 @@ class Book {
 			cover: this.loading.cover.promise,
 			navigation: this.loading.navigation.promise,
 			pageList: this.loading.pageList.promise,
-			resources: this.loading.resources.promise
+			resources: this.loading.resources.promise,
+			displayOptions: this.loading.displayOptions.promise
 		};
 
 		/**
@@ -109,7 +113,8 @@ class Book {
 			this.loaded.metadata,
 			this.loaded.cover,
 			this.loaded.navigation,
-			this.loaded.resources
+			this.loaded.resources,
+			this.loaded.displayOptions
 		]);
 
 
@@ -211,6 +216,13 @@ class Book {
 		 */
 		this.packaging = undefined;
 
+		/**
+		 * @member {DisplayOptions} displayOptions
+		 * @memberof DisplayOptions
+		 * @private
+		 */
+		this.displayOptions = undefined;
+
 		// this.toc = undefined;
 		if (this.settings.store) {
 			this.store(this.settings.store);
@@ -437,6 +449,20 @@ class Book {
 	unpack(packaging) {
 		this.package = packaging; //TODO: deprecated this
 
+		if (this.packaging.metadata.layout === "") {
+			// rendition:layout not set - check display options if book is pre-paginated
+			this.load(this.url.resolve(IBOOKS_DISPLAY_OPTIONS_PATH)).then((xml) => {
+				this.displayOptions = new DisplayOptions(xml);
+				this.loading.displayOptions.resolve(this.displayOptions);
+			}).catch((err) => {
+				this.displayOptions = new DisplayOptions();
+				this.loading.displayOptions.resolve(this.displayOptions);
+			});
+		} else {
+			this.displayOptions = new DisplayOptions();
+			this.loading.displayOptions.resolve(this.displayOptions);
+		}
+
 		this.spine.unpack(this.packaging, this.resolve.bind(this), this.canonical.bind(this));
 
 		this.resources = new Resources(this.packaging.manifest, {
@@ -466,14 +492,18 @@ class Book {
 
 		if(this.archived || this.settings.replacements && this.settings.replacements != "none") {
 			this.replacements().then(() => {
-				this.opening.resolve(this);
+				this.loaded.displayOptions.then(() => {
+					this.opening.resolve(this);
+				});
 			})
 			.catch((err) => {
 				console.error(err);
 			});
 		} else {
 			// Resolve book opened promise
-			this.opening.resolve(this);
+			this.loaded.displayOptions.then(() => {
+				this.opening.resolve(this);
+			});
 		}
 
 	}
@@ -707,6 +737,7 @@ class Book {
 		this.container && this.container.destroy();
 		this.packaging && this.packaging.destroy();
 		this.rendition && this.rendition.destroy();
+		this.displayOptions && this.displayOptions.destroy();
 
 		this.spine = undefined;
 		this.locations = undefined;

src/displayoptions.js

@@ -0,0 +1,70 @@
+import {qs, qsa } from "./utils/core";
+
+/**
+ * Open DisplayOptions Format Parser
+ * @class
+ * @param {document} displayOptionsDocument XML
+ */
+class DisplayOptions {
+	constructor(displayOptionsDocument) {
+		this.interactive = "";
+		this.fixedLayout = "";
+		this.openToSpread = "";
+		this.orientationLock = "";
+
+		if (displayOptionsDocument) {
+			this.parse(displayOptionsDocument);
+		}
+	}
+
+	/**
+	 * Parse XML
+	 * @param  {document} displayOptionsDocument XML
+	 * @return {DisplayOptions} self
+	 */
+	parse(displayOptionsDocument) {
+		if(!displayOptionsDocument) {
+			return this;
+		}
+
+		const displayOptionsNode = qs(displayOptionsDocument, "display_options");
+		if(!displayOptionsNode) {
+			return this;
+		} 
+
+		const options = qsa(displayOptionsNode, "option");
+		options.forEach((el) => {
+			let value = "";
+
+			if (el.childNodes.length) {
+				value = el.childNodes[0].nodeValue;
+			}
+
+			switch (el.attributes.name.value) {
+			    case "interactive":
+			        this.interactive = value;
+			        break;
+			    case "fixed-layout":
+			        this.fixedLayout = value;
+			        break;
+			    case "open-to-spread":
+			        this.openToSpread = value;
+			        break;
+			    case "orientation-lock":
+			        this.orientationLock = value;
+			        break;
+			}
+		});
+
+		return this;
+	}
+
+	destroy() {
+		this.interactive = undefined;
+		this.fixedLayout = undefined;
+		this.openToSpread = undefined;
+		this.orientationLock = undefined;
+	}
+}
+
+export default DisplayOptions;

src/rendition.js

@@ -203,6 +203,9 @@ class Rendition {
 	 * @return {Promise} rendering has started
 	 */
 	start(){
+		if (!this.settings.layout && (this.book.package.metadata.layout === "pre-paginated" || this.book.displayOptions.fixedLayout === "true")) {
+			this.settings.layout = "pre-paginated";
+		}
 
 		if(!this.manager) {
 			this.ViewManager = this.requireManager(this.settings.manager);