@thathoff/cordova-plugin-universal-links 0.3.0

package/hooks/lib/ios/projectEntitlements.js

@@ -0,0 +1,174 @@
+/*
+Script creates entitlements file with the list of hosts, specified in config.xml.
+File name is: ProjectName.entitlements
+Location: ProjectName/
+
+Script only generates content. File it self is included in the xcode project in another hook: xcodePreferences.js.
+*/
+
+var path = require('path');
+var fs = require('fs');
+var plist = require('plist');
+var mkpath = require('mkpath');
+var ConfigXmlHelper = require('../configXmlHelper.js');
+var ASSOCIATED_DOMAINS = 'com.apple.developer.associated-domains';
+var context;
+var projectRoot;
+var projectName;
+var entitlementsFilePath;
+
+module.exports = {
+  generateAssociatedDomainsEntitlements: generateEntitlements
+};
+
+// region Public API
+
+/**
+ * Generate entitlements file content.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ * @param {Object} pluginPreferences - plugin preferences from config.xml; already parsed
+ */
+function generateEntitlements(cordovaContext, pluginPreferences) {
+  context = cordovaContext;
+
+  var currentEntitlements = getEntitlementsFileContent();
+  var newEntitlements = injectPreferences(currentEntitlements, pluginPreferences);
+
+  saveContentToEntitlementsFile(newEntitlements);
+}
+
+// endregion
+
+// region Work with entitlements file
+
+/**
+ * Save data to entitlements file.
+ *
+ * @param {Object} content - data to save; JSON object that will be transformed into xml
+ */
+function saveContentToEntitlementsFile(content) {
+  var plistContent = plist.build(content);
+  var filePath = pathToEntitlementsFile();
+
+  // ensure that file exists
+  mkpath.sync(path.dirname(filePath));
+
+  // save it's content
+  fs.writeFileSync(filePath, plistContent, 'utf8');
+}
+
+/**
+ * Read data from existing entitlements file. If none exist - default value is returned
+ *
+ * @return {String} entitlements file content
+ */
+function getEntitlementsFileContent() {
+  var pathToFile = pathToEntitlementsFile();
+  var content;
+
+  try {
+    content = fs.readFileSync(pathToFile, 'utf8');
+  } catch (err) {
+    return defaultEntitlementsFile();
+  }
+
+  return plist.parse(content);
+}
+
+/**
+ * Get content for an empty entitlements file.
+ *
+ * @return {String} default entitlements file content
+ */
+function defaultEntitlementsFile() {
+  return {};
+}
+
+/**
+ * Inject list of hosts into entitlements file.
+ *
+ * @param {Object} currentEntitlements - entitlements where to inject preferences
+ * @param {Object} pluginPreferences - list of hosts from config.xml
+ * @return {Object} new entitlements content
+ */
+function injectPreferences(currentEntitlements, pluginPreferences) {
+  var newEntitlements = currentEntitlements;
+  var content = generateAssociatedDomainsContent(pluginPreferences);
+
+  newEntitlements[ASSOCIATED_DOMAINS] = content;
+
+  return newEntitlements;
+}
+
+/**
+ * Generate content for associated-domains dictionary in the entitlements file.
+ *
+ * @param {Object} pluginPreferences - list of hosts from conig.xml
+ * @return {Object} associated-domains dictionary content
+ */
+function generateAssociatedDomainsContent(pluginPreferences) {
+  var domainsList = [];
+
+  // generate list of host links
+  pluginPreferences.hosts.forEach(function(host) {
+    var link = domainsListEntryForHost(host);
+    if (domainsList.indexOf(link) == -1) {
+      domainsList.push(link);
+    }
+  });
+
+  return domainsList;
+}
+
+/**
+ * Generate domain record for the given host.
+ *
+ * @param {Object} host - host entry
+ * @return {String} record
+ */
+function domainsListEntryForHost(host) {
+  return 'applinks:' + host.name;
+}
+
+// endregion
+
+// region Path helper methods
+
+/**
+ * Path to entitlements file.
+ *
+ * @return {String} absolute path to entitlements file
+ */
+function pathToEntitlementsFile() {
+  if (entitlementsFilePath === undefined) {
+    entitlementsFilePath = path.join(getProjectRoot(), 'platforms', 'ios', getProjectName(), 'Resources', getProjectName() + '.entitlements');
+  }
+
+  return entitlementsFilePath;
+}
+
+/**
+ * Projects root folder path.
+ *
+ * @return {String} absolute path to the projects root
+ */
+function getProjectRoot() {
+  return context.opts.projectRoot;
+}
+
+/**
+ * Name of the project from config.xml
+ *
+ * @return {String} project name
+ */
+function getProjectName() {
+  if (projectName === undefined) {
+    var configXmlHelper = new ConfigXmlHelper(context);
+    projectName = configXmlHelper.getProjectName();
+  }
+
+  return projectName;
+}
+
+// endregion

package/hooks/lib/ios/xcodePreferences.js

@@ -0,0 +1,243 @@
+/*
+Script activates support for Universal Links in the application by setting proper preferences in the xcode project file.
+Which is:
+- deployment target set to iOS 9.0
+- .entitlements file added to project PBXGroup and PBXFileReferences section
+- path to .entitlements file added to Code Sign Entitlements preference
+*/
+
+var path = require('path');
+var compare = require('node-version-compare');
+var ConfigXmlHelper = require('../configXmlHelper.js');
+const xcode = require('xcode');
+const fileSystem = require('fs');
+const glob = require('glob');
+const shelljs = require('shelljs');
+var IOS_DEPLOYMENT_TARGET = '8.0';
+var COMMENT_KEY = /_comment$/;
+var context;
+
+module.exports = {
+  enableAssociativeDomainsCapability: enableAssociativeDomainsCapability
+}
+
+// region Public API
+
+/**
+ * Activate associated domains capability for the application.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ */
+function enableAssociativeDomainsCapability(cordovaContext) {
+  context = cordovaContext;
+
+  var projectFile = loadProjectFile();
+
+  // adjust preferences
+  activateAssociativeDomains(projectFile.xcode);
+
+  // add entitlements file to pbxfilereference
+  addPbxReference(projectFile.xcode);
+
+  // save changes
+  projectFile.write();
+}
+
+// endregion
+
+// region Alter project file preferences
+
+/**
+ * Activate associated domains support in the xcode project file:
+ * - set deployment target to ios 9;
+ * - add .entitlements file to Code Sign Entitlements preference.
+ *
+ * @param {Object} xcodeProject - xcode project preferences; all changes are made in that instance
+ */
+function activateAssociativeDomains(xcodeProject) {
+  var configurations = nonComments(xcodeProject.pbxXCBuildConfigurationSection());
+  var entitlementsFilePath = pathToEntitlementsFile();
+  var config;
+  var buildSettings;
+  var deploymentTargetIsUpdated;
+
+  for (config in configurations) {
+    buildSettings = configurations[config].buildSettings;
+    buildSettings['CODE_SIGN_ENTITLEMENTS'] = '"' + entitlementsFilePath + '"';
+
+    // if deployment target is less then the required one - increase it
+    if (buildSettings['IPHONEOS_DEPLOYMENT_TARGET']) {
+      if (compare(buildSettings['IPHONEOS_DEPLOYMENT_TARGET'], IOS_DEPLOYMENT_TARGET) == -1) {
+        buildSettings['IPHONEOS_DEPLOYMENT_TARGET'] = IOS_DEPLOYMENT_TARGET;
+        deploymentTargetIsUpdated = true;
+      }
+    } else {
+      buildSettings['IPHONEOS_DEPLOYMENT_TARGET'] = IOS_DEPLOYMENT_TARGET;
+      deploymentTargetIsUpdated = true;
+    }
+  }
+
+  if (deploymentTargetIsUpdated) {
+    console.log('IOS project now has deployment target set as: ' + IOS_DEPLOYMENT_TARGET);
+  }
+
+  console.log('IOS project Code Sign Entitlements now set to: ' + entitlementsFilePath);
+}
+
+// endregion
+
+// region PBXReference methods
+
+/**
+ * Add .entitlemets file into the project.
+ *
+ * @param {Object} xcodeProject - xcode project preferences; all changes are made in that instance
+ */
+function addPbxReference(xcodeProject) {
+  var fileReferenceSection = nonComments(xcodeProject.pbxFileReferenceSection());
+  var entitlementsFileName = path.basename(pathToEntitlementsFile());
+
+  if (isPbxReferenceAlreadySet(fileReferenceSection, entitlementsFileName)) {
+    console.log('Entitlements file is in reference section.');
+    return;
+  }
+
+  console.log('Entitlements file is not in references section, adding it');
+  xcodeProject.addResourceFile(entitlementsFileName);
+}
+
+/**
+ * Check if .entitlemets file reference already set.
+ *
+ * @param {Object} fileReferenceSection - PBXFileReference section
+ * @param {String} entitlementsRelativeFilePath - relative path to entitlements file
+ * @return true - if reference is set; otherwise - false
+ */
+function isPbxReferenceAlreadySet(fileReferenceSection, entitlementsRelativeFilePath) {
+  var isAlreadyInReferencesSection = false;
+  var uuid;
+  var fileRefEntry;
+
+  for (uuid in fileReferenceSection) {
+    fileRefEntry = fileReferenceSection[uuid];
+    if (fileRefEntry.path && fileRefEntry.path.indexOf(entitlementsRelativeFilePath) > -1) {
+      isAlreadyInReferencesSection = true;
+      break;
+    }
+  }
+
+  return isAlreadyInReferencesSection;
+}
+
+// region Xcode project file helpers
+
+/**
+ * Load iOS project file from platform specific folder.
+ *
+ * @return {Object} projectFile - project file information
+ */
+function loadProjectFile() {
+  var platform_ios;
+  var projectFile;
+
+  try {
+    // try pre-5.0 cordova structure
+    platform_ios = context.requireCordovaModule(
+      'cordova-lib/src/plugman/platforms',
+    ).ios;
+
+    projectFile = platform_ios.parseProjectFile(iosPlatformPath());
+  } catch (e) {
+    try {
+      // let's try cordova 5.0 structure
+      platform_ios = context.requireCordovaModule('ios');
+      projectFile = platform_ios.parseProjectFile(iosPlatformPath());
+    } catch (e) {
+      // Then cordova 7.0
+      const project_files = glob.sync(
+        path.join(iosPlatformPath(), '*.xcodeproj', 'project.pbxproj'),
+      );
+
+      if (project_files.length === 0) {
+        throw new Error(
+          'does not appear to be an xcode project (no xcode project file)',
+        );
+      }
+
+      const pbxPath = project_files[0];
+
+      const xcodeproj = xcode.project(pbxPath);
+      xcodeproj.parseSync();
+
+      projectFile = {
+        xcode: xcodeproj,
+        write() {
+          const fs = fileSystem;
+
+          const frameworks_file = path.join(
+            iosPlatformPath(),
+            'frameworks.json',
+          );
+          let frameworks = {};
+          try {
+            frameworks = context.requireCordovaModule(frameworks_file);
+          } catch (e) {}
+
+          fs.writeFileSync(pbxPath, xcodeproj.writeSync());
+          if (Object.keys(frameworks).length === 0) {
+            // If there is no framework references remain in the project, just remove this file
+            shelljs.rm('-rf', frameworks_file);
+            return;
+          }
+          fs.writeFileSync(
+            frameworks_file,
+            JSON.stringify(this.frameworks, null, 4),
+          );
+        },
+      };
+    }
+  }
+
+  return projectFile;
+}
+
+/**
+ * Remove comments from the file.
+ *
+ * @param {Object} obj - file object
+ * @return {Object} file object without comments
+ */
+function nonComments(obj) {
+  var keys = Object.keys(obj);
+  var newObj = {};
+
+  for (var i = 0, len = keys.length; i < len; i++) {
+    if (!COMMENT_KEY.test(keys[i])) {
+      newObj[keys[i]] = obj[keys[i]];
+    }
+  }
+
+  return newObj;
+}
+
+// endregion
+
+// region Path helpers
+
+function iosPlatformPath() {
+  return path.join(projectRoot(), 'platforms', 'ios');
+}
+
+function projectRoot() {
+  return context.opts.projectRoot;
+}
+
+function pathToEntitlementsFile() {
+  var configXmlHelper = new ConfigXmlHelper(context),
+    projectName = configXmlHelper.getProjectName(),
+    fileName = projectName + '.entitlements';
+
+  return path.join(projectName, 'Resources', fileName);
+}
+
+// endregion

package/hooks/lib/xmlHelper.js

@@ -0,0 +1,57 @@
+/*
+Small helper class to read/write from/to xml file.
+*/
+
+var fs = require('fs');
+var xml2js = require('xml2js');
+
+module.exports = {
+  readXmlAsJson: readXmlAsJson,
+  writeJsonAsXml: writeJsonAsXml
+};
+
+/**
+ * Read data from the xml file as JSON object.
+ *
+ * @param {String} filePath - absolute path to xml file
+ * @return {Object} JSON object with the contents of the xml file
+ */
+function readXmlAsJson(filePath) {
+  var xmlData;
+  var xmlParser;
+  var parsedData;
+
+  try {
+    xmlData = fs.readFileSync(filePath, 'utf8');
+    xmlParser = new xml2js.Parser();
+    xmlParser.parseString(xmlData, function(err, data) {
+      if (data) {
+        parsedData = data;
+      }
+    });
+  } catch (err) {}
+
+  return parsedData;
+}
+
+/**
+ * Write JSON object as xml into the specified file.
+ *
+ * @param {Object} jsData - JSON object to write
+ * @param {String} filePath - path to the xml file where data should be saved
+ * @return {boolean} true - if data saved to file; false - otherwise
+ */
+function writeJsonAsXml(jsData, filePath, options) {
+  var xmlBuilder = new xml2js.Builder(options);
+  var changedXmlData = xmlBuilder.buildObject(jsData);
+  var isSaved = true;
+
+  try {
+    fs.writeFileSync(filePath, changedXmlData, 'utf8');
+  } catch (err) {
+    console.log(err);
+    isSaved = false;
+  }
+
+  return isSaved;
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@thathoff/cordova-plugin-universal-links",
+  "version": "0.3.0",
+  "description": "Cordova plugin to add in your application support for Universal Links (iOS 9) and Deep Links (Android). Basically, open application through the link in the browser.",
+  "cordova": {
+    "id": "cordova-plugin-universal-links",
+    "platforms": [
+      "ios",
+      "android"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thathoff/cordova-plugin-universal-links.git"
+  },
+  "keywords": [
+    "cordova",
+    "links",
+    "universal",
+    "deep links",
+    "universal links",
+    "ecosystem:cordova",
+    "cordova-ios",
+    "cordova-android",
+    "ios",
+    "android"
+  ],
+  "engines": [
+    {
+      "name": "cordova-ios",
+      "version": ">=3.8"
+    },
+    {
+      "name": "cordova-android",
+      "version": ">=4"
+    }
+  ],
+  "dependencies": {
+    "mkpath": ">=1.0.0",
+    "xml2js": ">=0.4",
+    "rimraf": ">=2.4",
+    "node-version-compare": ">=1.0.1",
+    "plist": ">=1.2.0"
+  },
+  "author": "Nikolay Demyankov for Nordnet Bank AB",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/eldadfux/cordova-plugin-universal-links/issues"
+  },
+  "homepage": "https://github.com/eldadfux/cordova-plugin-universal-links",
+  "main": "index.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/plugin.xml

@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<plugin id="cordova-plugin-universal-links" version="0.3.0" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+
+  <name>Universal Links Plugin</name>
+  <description>
+    Cordova plugin to add in your application support for Universal Links (iOS 9) and Deep Links (Android).
+    Basically, open application through the link in the browser.
+  </description>
+  <license>MIT</license>
+  <keywords>cordova,links,universal,deep</keywords>
+
+  <repo>https://github.com/eldadfux/cordova-plugin-universal-links</repo>
+  <issue>https://github.com/eldadfux/cordova-plugin-universal-links/issues</issue>
+
+  <engines>
+    <engine name="cordova-ios" version=">=3.8"></engine>
+    <engine name="cordova-android" version=">=4"></engine>
+  </engines>
+
+<!-- JavaScrip Library Sources -->
+  <js-module name="universalLinks" src="www/universal_links.js">
+    <clobbers target="universalLinks"/>
+  </js-module>
+
+<!-- Hooks -->
+  <hook src="hooks/afterPrepareHook.js" type="after_prepare"/>
+  <hook src="hooks/beforePluginInstallHook.js" type="before_plugin_install" />
+
+  <platform name="ios">
+    <hook src="hooks/iosBeforePrepareHook.js" type="before_prepare" />
+
+<!-- Plugin inclusion in Cordova config.xml  -->
+    <config-file parent="/*" target="config.xml">
+      <feature name="UniversalLinks">
+        <param name="ios-package" value="CULPlugin"/>
+        <param name="onload" value="true"/>
+      </feature>
+    </config-file>
+
+<!-- Objective-C Sources -->
+
+    <source-file src="src/ios/CULPlugin.m"/>
+    <header-file src="src/ios/CULPlugin.h"/>
+
+    <source-file src="src/ios/AppDelegate+CULPlugin.m"/>
+    <header-file src="src/ios/AppDelegate+CULPlugin.h"/>
+
+<!-- sources for JS folder -->
+    <source-file src="src/ios/JS/CDVPluginResult+CULPlugin.m" target-dir="JS/"/>
+    <header-file src="src/ios/JS/CDVPluginResult+CULPlugin.h" target-dir="JS/"/>
+
+    <source-file src="src/ios/JS/CDVInvokedUrlCommand+CULPlugin.m" target-dir="JS/"/>
+    <header-file src="src/ios/JS/CDVInvokedUrlCommand+CULPlugin.h" target-dir="JS/"/>
+
+<!-- sources for Model folder -->
+    <source-file src="src/ios/Model/CULHost.m" target-dir="Model/"/>
+    <header-file src="src/ios/Model/CULHost.h" target-dir="Model/"/>
+
+    <source-file src="src/ios/Model/CULPath.m" target-dir="Model/"/>
+    <header-file src="src/ios/Model/CULPath.h" target-dir="Model/"/>
+
+<!-- sources for XML Parser folder -->
+    <source-file src="src/ios/Parser/XML/CULXmlTags.m" target-dir="Parser/XML/"/>
+    <header-file src="src/ios/Parser/XML/CULXmlTags.h" target-dir="Parser/XML/"/>
+
+    <source-file src="src/ios/Parser/XML/CULConfigXmlParser.m" target-dir="Parser/XML/"/>
+    <header-file src="src/ios/Parser/XML/CULConfigXmlParser.h" target-dir="Parser/XML/"/>
+
+<!-- sources for JSON Parser folder -->
+    <source-file src="src/ios/Parser/JSON/CULConfigJsonParser.m" target-dir="Parser/JSON/"/>
+    <header-file src="src/ios/Parser/JSON/CULConfigJsonParser.h" target-dir="Parser/JSON/"/>
+
+<!-- sources for Utils folder -->
+    <source-file src="src/ios/Utils/NSBundle+CULPlugin.m" target-dir="Utils/"/>
+    <header-file src="src/ios/Utils/NSBundle+CULPlugin.h" target-dir="Utils/"/>
+
+  </platform>
+
+  <platform name="android">
+<!-- Plugin inclusion in Cordova config.xml -->
+    <config-file parent="/*" target="res/xml/config.xml">
+      <feature name="UniversalLinks">
+        <param name="android-package" value="com.nordnetab.cordova.ul.UniversalLinksPlugin"/>
+        <param name="onload" value="true"/>
+      </feature>
+    </config-file>
+
+<!-- Java Library Sources -->
+<!-- sources for package: com.nordnetab.cordova.ul.js -->
+    <source-file src="src/android/com/nordnetab/cordova/ul/js/JSAction.java" target-dir="src/com/nordnetab/cordova/ul/js/"/>
+
+<!-- sources for package: com.nordnetab.cordova.ul.model -->
+    <source-file src="src/android/com/nordnetab/cordova/ul/model/JSMessage.java" target-dir="src/com/nordnetab/cordova/ul/model/"/>
+    <source-file src="src/android/com/nordnetab/cordova/ul/model/ULHost.java" target-dir="src/com/nordnetab/cordova/ul/model/"/>
+    <source-file src="src/android/com/nordnetab/cordova/ul/model/ULPath.java" target-dir="src/com/nordnetab/cordova/ul/model/"/>
+
+<!-- sources for package: com.nordnetab.cordova.ul.parser -->
+    <source-file src="src/android/com/nordnetab/cordova/ul/parser/ULConfigXmlParser.java" target-dir="src/com/nordnetab/cordova/ul/parser/"/>
+    <source-file src="src/android/com/nordnetab/cordova/ul/parser/XmlTags.java" target-dir="src/com/nordnetab/cordova/ul/parser/"/>
+
+<!-- sources for package: com.nordnetab.cordova.ul -->
+    <source-file src="src/android/com/nordnetab/cordova/ul/UniversalLinksPlugin.java" target-dir="src/com/nordnetab/cordova/ul/"/>
+
+  </platform>
+</plugin>