navigator.epubReadingSystem version info / git commit hash, shell script added to XCode build

Resources/epubReadingSystem.js

@@ -0,0 +1,11 @@
+
+ReadiumSDK.READIUM_iOS_sha = '';
+ReadiumSDK.READIUM_iOS_tag = '';
+ReadiumSDK.READIUM_iOS_clean = '';
+ReadiumSDK.READIUM_SDK_sha = '';
+ReadiumSDK.READIUM_SDK_tag = '';
+ReadiumSDK.READIUM_SDK_clean = '';
+ReadiumSDK.READIUM_SHARED_JS_sha = '';
+ReadiumSDK.READIUM_SHARED_JS_tag = '';
+ReadiumSDK.READIUM_SHARED_JS_clean = '';
+ReadiumSDK.READIUM_dateTimeString = '';

Resources/epubReadingSystem.sh

@@ -0,0 +1,117 @@
+#!/bin/sh
+
+echo "###########################################"
+echo "###########################################"
+
+pwd=`pwd`
+echo "Path:"
+echo "${pwd}"
+echo "------"
+
+JS_FILE="${pwd}/Resources/epubReadingSystem_.js"
+test -z "${CONTENTS_FOLDER_PATH}" || JS_FILE="${TARGET_BUILD_DIR}/${CONTENTS_FOLDER_PATH}/epubReadingSystem.js"
+echo "Javascript output:"
+echo "${JS_FILE}"
+test -z "${CONTENTS_FOLDER_PATH}" && echo "WARNING: file 'epubReadingSystem.js' will NOT be updated in XCode build folder! (running script from raw command line?)"
+echo "------"
+
+FIRST=""
+
+GitDo() {
+ROOT_DIR=$1
+INTERMEDIATE_DIR=$2
+GIT_SUBMODULE=$3
+SUB_DIR="${ROOT_DIR}${INTERMEDIATE_DIR}${GIT_SUBMODULE}"
+TARGET_PREFIX=$4
+
+cd "${SUB_DIR}"
+
+echo "========================="
+echo "Git target prefix:"
+echo "${TARGET_PREFIX}"
+echo "------"
+
+GIT_DIR="${ROOT_DIR}/.git"
+echo "Git directory:"
+echo "${GIT_DIR}"
+echo "------"
+
+echo "Git submodule directory:"
+echo "${SUB_DIR}"
+echo "------"
+
+# We use "cd" instead! (more reliable, due to vendor submodules not necessarily setup the way we do it internally for Readium)
+GIT_DIR_CWD=""
+# GIT_DIR_CWD="--git-dir=${GIT_DIR} --work-tree=${SUB_DIR}"
+# echo "Git path spec:"
+# echo "${GIT_DIR_CWD}"
+# echo "------"
+
+GIT_HEAD_PATH="${GIT_DIR}/HEAD"
+test -f "${SUB_DIR}/HEAD" && GIT_HEAD_PATH="${SUB_DIR}/HEAD"
+test -f "${GIT_DIR}/modules/${GIT_SUBMODULE}/HEAD" && GIT_HEAD_PATH="${GIT_DIR}/modules/${GIT_SUBMODULE}/HEAD"
+echo "Git HEAD path:"
+echo "${GIT_HEAD_PATH}";
+echo "------"
+
+GIT_HEAD=`cat "${GIT_HEAD_PATH}"`
+echo "Git HEAD:"
+echo "${GIT_HEAD}";
+echo "------"
+
+test "${GIT_HEAD#'ref: '}" != "${GIT_HEAD}" && echo "(attached head)" && GIT_SHA=`git ${GIT_DIR_CWD} rev-parse --verify HEAD`
+test "${GIT_HEAD#'ref: '}" == "${GIT_HEAD}" && echo "(detached head)" && GIT_SHA="${GIT_HEAD}"
+
+echo "Git SHA:"
+echo "${GIT_SHA}"
+echo "------"
+
+GIT_TAG=`git ${GIT_DIR_CWD} describe --tags --long ${GIT_SHA}`
+echo "Git TAG:"
+echo "${GIT_TAG}"
+echo "------"
+
+GIT_STATUS=`git ${GIT_DIR_CWD} status --porcelain`
+echo "Git STATUS:"
+echo "${GIT_STATUS}"
+echo "------"
+
+GIT_CLEAN=false
+test -z "${GIT_STATUS}" && GIT_CLEAN=true
+echo "Git CLEAN:"
+echo "${GIT_CLEAN}"
+echo "------"
+
+echo "FIRST:"
+echo "${FIRST}"
+echo "------"
+
+test -z "${FIRST}" && echo $"" > "${JS_FILE}"
+FIRST="false"
+
+echo "ReadiumSDK.READIUM_${TARGET_PREFIX}_sha = '${GIT_SHA}';" >> "${JS_FILE}"
+echo "ReadiumSDK.READIUM_${TARGET_PREFIX}_tag = '${GIT_TAG}';" >> "${JS_FILE}"
+echo "ReadiumSDK.READIUM_${TARGET_PREFIX}_clean = '${GIT_CLEAN}';" >> "${JS_FILE}"
+
+}
+
+
+
+GitDo "${pwd}" "" "" "iOS"
+
+GitDo "${pwd}" "/" "readium-sdk" "SDK"
+
+GitDo "${pwd}" "/Resources/" "readium-shared-js" "SHARED_JS"
+
+
+
+READIUM_dateTimeString=`date`
+echo "ReadiumSDK.READIUM_dateTimeString = '${READIUM_dateTimeString}';" >> "${JS_FILE}"
+
+
+cat ${JS_FILE}
+
+cd "${pwd}"
+
+echo "###########################################"
+echo "###########################################"

Resources/host_app_feedback.js

@@ -1,4 +1,4 @@
-//  LauncherOSX
+//  LauncheriOS
 //
 //  Created by Boris Schneiderman.
 //  Copyright (c) 2014 Readium Foundation and/or its licensees. All rights reserved.
@@ -26,11 +26,62 @@
 //  OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ReadiumSDK.HostAppFeedback = function() {
+
+    var initNavigatorEpubReadingSystem = function() {
+
+        // Adjust to taste (application/vendor -level metadata):
+        window.navigator.epubReadingSystem.name = "Readium SDKLauncher-iOS";
+        window.navigator.epubReadingSystem.version = "1.0.0";
+
+        // Readium "internal" version:
+        ReadiumSDK.READIUM_version = "1.0.0";
+
+        // Do not edit the following lines! (low-level metadata)
+        // The templated values ("ReadiumSDK.READIUM_"-prefixed values) are auto-generated by the build script,
+        // see the "epubReadingSystem.js" file.
+
+        window.navigator.epubReadingSystem.readium = {};
+        window.navigator.epubReadingSystem.readium.buildInfo = {};
+
+        window.navigator.epubReadingSystem.readium.buildInfo.dateTime = ReadiumSDK.READIUM_dateTimeString;
+        //new Date(timestamp).toString();
+
+        window.navigator.epubReadingSystem.readium.buildInfo.version = ReadiumSDK.READIUM_version;
+
+        window.navigator.epubReadingSystem.readium.buildInfo.gitRepositories = [];
+
+        var repo1 = {};
+        repo1.name = "SDKLauncher-iOS";
+        repo1.sha = ReadiumSDK.READIUM_iOS_sha;
+        repo1.tag = ReadiumSDK.READIUM_iOS_tag;
+        repo1.clean = ReadiumSDK.READIUM_iOS_clean;
+        repo1.url = "https://github.com/readium/" + repo1.name + "/tree/" + repo1.sha;
+        window.navigator.epubReadingSystem.readium.buildInfo.gitRepositories.push(repo1);
+
+        var repo2 = {};
+        repo2.name = "readium-sdk";
+        repo2.sha = ReadiumSDK.READIUM_SDK_sha;
+        repo2.tag = ReadiumSDK.READIUM_SDK_tag;
+        repo2.clean = ReadiumSDK.READIUM_SDK_clean;
+        repo2.url = "https://github.com/readium/" + repo2.name + "/tree/" + repo2.sha;
+        window.navigator.epubReadingSystem.readium.buildInfo.gitRepositories.push(repo2);
+
+        var repo3 = {};
+        repo3.name = "readium-shared-js";
+        repo3.sha = ReadiumSDK.READIUM_SHARED_JS_sha;
+        repo3.tag = ReadiumSDK.READIUM_SHARED_JS_tag;
+        repo3.clean = ReadiumSDK.READIUM_SHARED_JS_clean;
+        repo3.url = "https://github.com/readium/" + repo3.name + "/tree/" + repo3.sha;
+        window.navigator.epubReadingSystem.readium.buildInfo.gitRepositories.push(repo3);
+
+        // Debug check:
+        //console.debug(JSON.stringify(window.navigator.epubReadingSystem, undefined, 2));
+    };
+
 	ReadiumSDK.on(ReadiumSDK.Events.READER_INITIALIZED, function() {
-
-        window.navigator.epubReadingSystem.name = "Launcher-iOS";
-        window.navigator.epubReadingSystem.version = "0.0.1";
-
+
+        initNavigatorEpubReadingSystem();
+
 		ReadiumSDK.reader.on(ReadiumSDK.Events.PAGINATION_CHANGED, this.onPaginationChanged, this);
 		ReadiumSDK.reader.on(ReadiumSDK.Events.SETTINGS_APPLIED, this.onSettingsApplied, this);
         ReadiumSDK.reader.on(ReadiumSDK.Events.MEDIA_OVERLAY_STATUS_CHANGED, this.onMediaOverlayStatusChanged, this);

Resources/reader.html

@@ -46,6 +46,8 @@
         <script src="readium-shared-js/js/views/media_overlay_player.js" type="text/javascript"></script>
         <script src="readium-shared-js/js/views/media_overlay_data_injector.js" type="text/javascript"></script>
         <script src="readium-shared-js/js/views/annotations_manager.js" type="text/javascript"></script>
+
+        <script src="epubReadingSystem.js" type="text/javascript"></script>
         <script src="host_app_feedback.js" type="text/javascript"></script>
 
 		<script type="text/javascript">

SDKLauncher-iOS.xcodeproj/project.pbxproj

@@ -100,10 +100,13 @@
 		34E12BAA180301A2004DCB68 /* Icon-76.png in Resources */ = {isa = PBXBuildFile; fileRef = 34E12B9D180301A2004DCB68 /* Icon-76.png */; };
 		34E12BAB180301A2004DCB68 /* [email protected] in Resources */ = {isa = PBXBuildFile; fileRef = 34E12B9E180301A2004DCB68 /* [email protected] */; };
 		8307EC6919E3DE4A00B00468 /* mathjax in Resources */ = {isa = PBXBuildFile; fileRef = 8307EC6719E3DDEC00B00468 /* mathjax */; };
+		83919F161A1E074200FC8118 /* epubReadingSystem.js in Resources */ = {isa = PBXBuildFile; fileRef = A250D199754564056CB0267E /* epubReadingSystem.js */; };
 		83EBB4A419F56C1C0083E8F1 /* annotations.css in Resources */ = {isa = PBXBuildFile; fileRef = 83EBB4A319F56C1C0083E8F1 /* annotations.css */; };
 		85DE51A117FDDCAC00F55130 /* page-blanche-20130322.epub in Resources */ = {isa = PBXBuildFile; fileRef = 85DE51A017FDDCAC00F55130 /* page-blanche-20130322.epub */; };
+		A250D5118ECA530997C6E72B /* epubReadingSystem.js in Sources */ = {isa = PBXBuildFile; fileRef = A250D199754564056CB0267E /* epubReadingSystem.js */; };
 		A250D5FFC597F4E5EB74D3AC /* epub30-test-0120-20131022.epub in Resources */ = {isa = PBXBuildFile; fileRef = A250D58D34D67FC218608A1F /* epub30-test-0120-20131022.epub */; };
 		A250D8E19073D0C5B921BA5F /* epub30-test-0220-20131022.epub in Resources */ = {isa = PBXBuildFile; fileRef = A250D54A5C423A86C6099037 /* epub30-test-0220-20131022.epub */; };
+		A250DD9ED6B68B6BD9F73160 /* epubReadingSystem.epub in Resources */ = {isa = PBXBuildFile; fileRef = A250DD41B691E2CA16B1735D /* epubReadingSystem.epub */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -291,8 +294,10 @@
 		8307EC6719E3DDEC00B00468 /* mathjax */ = {isa = PBXFileReference; lastKnownFileType = folder; path = mathjax; sourceTree = "<group>"; };
 		83EBB4A319F56C1C0083E8F1 /* annotations.css */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.css; path = annotations.css; sourceTree = "<group>"; };
 		85DE51A017FDDCAC00F55130 /* page-blanche-20130322.epub */ = {isa = PBXFileReference; lastKnownFileType = file; path = "page-blanche-20130322.epub"; sourceTree = "<group>"; };
+		A250D199754564056CB0267E /* epubReadingSystem.js */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.javascript; path = epubReadingSystem.js; sourceTree = "<group>"; };
 		A250D54A5C423A86C6099037 /* epub30-test-0220-20131022.epub */ = {isa = PBXFileReference; lastKnownFileType = file.epub; path = "epub30-test-0220-20131022.epub"; sourceTree = "<group>"; };
 		A250D58D34D67FC218608A1F /* epub30-test-0120-20131022.epub */ = {isa = PBXFileReference; lastKnownFileType = file.epub; path = "epub30-test-0120-20131022.epub"; sourceTree = "<group>"; };
+		A250DD41B691E2CA16B1735D /* epubReadingSystem.epub */ = {isa = PBXFileReference; lastKnownFileType = file.epub; path = epubReadingSystem.epub; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -324,6 +329,7 @@
 				341A1F701790BC6800E603C4 /* host_app_feedback.js */,
 				3403516116CE93F2009E3B88 /* reader.css */,
 				3403516216CE93F2009E3B88 /* reader.html */,
+				A250D199754564056CB0267E /* epubReadingSystem.js */,
 			);
 			name = Injection;
 			sourceTree = "<group>";
@@ -337,6 +343,7 @@
 				340535BA16BC793700D4A802 /* wasteland-20120118.epub */,
 				A250D58D34D67FC218608A1F /* epub30-test-0120-20131022.epub */,
 				A250D54A5C423A86C6099037 /* epub30-test-0220-20131022.epub */,
+				A250DD41B691E2CA16B1735D /* epubReadingSystem.epub */,
 			);
 			name = EPub;
 			sourceTree = "<group>";
@@ -674,6 +681,7 @@
 				340FC15516BC3B4600346A59 /* Sources */,
 				340FC15616BC3B4600346A59 /* Frameworks */,
 				340FC15716BC3B4600346A59 /* Resources */,
+				83919F191A1E074C00FC8118 /* ShellScript */,
 			);
 			buildRules = (
 			);
@@ -746,6 +754,7 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				83919F161A1E074200FC8118 /* epubReadingSystem.js in Resources */,
 				8307EC6919E3DE4A00B00468 /* mathjax in Resources */,
 				34B56B5E1723158E00A5A4B8 /* childrens-literature-20130206.epub in Resources */,
 				3462FBEB16BC40F9003C79E1 /* Default.png in Resources */,
@@ -779,11 +788,28 @@
 				34E12BA1180301A2004DCB68 /* Icon-40.png in Resources */,
 				A250D5FFC597F4E5EB74D3AC /* epub30-test-0120-20131022.epub in Resources */,
 				A250D8E19073D0C5B921BA5F /* epub30-test-0220-20131022.epub in Resources */,
+				A250DD9ED6B68B6BD9F73160 /* epubReadingSystem.epub in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		83919F191A1E074C00FC8118 /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = ./Resources/epubReadingSystem.sh;
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		340FC15516BC3B4600346A59 /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
@@ -843,6 +869,7 @@
 				341652A816C2F9E700AFDB8B /* SpineItemListController.m in Sources */,
 				342817DD18DBC48700C8434E /* NavigationElementItem.m in Sources */,
 				34212FCF18F0649500A9109F /* GCDAsyncSocket.m in Sources */,
+				A250D5118ECA530997C6E72B /* epubReadingSystem.js in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};