@thathoff/cordova-plugin-universal-links 0.3.0

package/hooks/lib/android/webSiteHook.js

@@ -0,0 +1,162 @@
+/*
+Class creates android_web_hook.html file in your Cordova project root folder.
+File holds <link /> tags, which are generated based on data, specified in config.xml.
+You need to include those tags on your website to link web pages to the content inside your application.
+
+More documentation on that can be found here:
+https://developer.android.com/training/app-indexing/enabling-app-indexing.html
+*/
+
+var fs = require('fs');
+var path = require('path');
+var mkpath = require('mkpath');
+var ConfigXmlHelper = require('../configXmlHelper.js');
+var WEB_HOOK_FILE_PATH = path.join('ul_web_hooks', 'android', 'android_web_hook.html');
+var WEB_HOOK_TPL_FILE_PATH = path.join('plugins', 'cordova-plugin-universal-links', 'ul_web_hooks', 'android_web_hook_tpl.html');
+var LINK_PLACEHOLDER = '[__LINKS__]';
+var LINK_TEMPLATE = '<link rel="alternate" href="android-app://<package_name>/<scheme>/<host><path>" />';
+
+module.exports = {
+  generate: generateWebHook
+};
+
+// region Public API
+
+/**
+ * Generate website hook for android application.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ * @param {Object} pluginPreferences - plugin preferences from config.xml file; already parsed
+ */
+function generateWebHook(cordovaContext, pluginPreferences) {
+  var projectRoot = cordovaContext.opts.projectRoot;
+  var configXmlHelper = new ConfigXmlHelper(cordovaContext);
+  var packageName = configXmlHelper.getPackageName('android');
+  var template = readTemplate(projectRoot);
+
+  // if template was not found - exit
+  if (template == null || template.length == 0) {
+    return;
+  }
+
+  // generate hook content
+  var linksToInsert = generateLinksSet(projectRoot, packageName, pluginPreferences);
+  var hookContent = template.replace(LINK_PLACEHOLDER, linksToInsert);
+
+  // save hook
+  saveWebHook(projectRoot, hookContent);
+}
+
+// endregion
+
+// region Public API
+
+/**
+ * Read hook teplate from plugin directory.
+ *
+ * @param {String} projectRoot - absolute path to cordova's project root
+ * @return {String} data from the template file
+ */
+function readTemplate(projectRoot) {
+  var filePath = path.join(projectRoot, WEB_HOOK_TPL_FILE_PATH);
+  var tplData = null;
+
+  try {
+    tplData = fs.readFileSync(filePath, 'utf8');
+  } catch (err) {
+    console.warn('Template file for android web hook is not found!');
+    console.warn(err);
+  }
+
+  return tplData;
+}
+
+/**
+ * Generate list of <link /> tags based on plugin preferences.
+ *
+ * @param {String} projectRoot - absolute path to cordova's project root
+ * @param {String} packageName - android application package name
+ * @param {Object} pluginPreferences - plugin preferences, defined in config.xml; already parsed
+ * @return {String} list of <link /> tags
+ */
+function generateLinksSet(projectRoot, packageName, pluginPreferences) {
+  var linkTpl = LINK_TEMPLATE.replace('<package_name>', packageName);
+  var content = '';
+
+  pluginPreferences.hosts.forEach(function(host) {
+    host.paths.forEach(function(hostPath) {
+      content += generateLinkTag(linkTpl, host.scheme, host.name, hostPath) + '\n';
+    });
+  });
+
+  return content;
+}
+
+/**
+ * Generate <link /> tag.
+ *
+ * @param {String} linkTpl - template to use for tag generation
+ * @param {String} scheme - host scheme
+ * @param {String} host - host name
+ * @param {String} path - host path
+ * @return {String} <link /> tag
+ */
+function generateLinkTag(linkTpl, scheme, host, path) {
+  linkTpl = linkTpl.replace('<scheme>', scheme).replace('<host>', host);
+  if (path == null || path === '*') {
+    return linkTpl.replace('<path>', '');
+  }
+
+  // for android we need to replace * with .* for pattern matching
+  if (path.indexOf('*') >= 0) {
+    path = path.replace(/\*/g, '.*');
+  }
+
+  // path should start with /
+  if (path.indexOf('/') != 0) {
+    path = '/' + path;
+  }
+
+  return linkTpl.replace('<path>', path);
+}
+
+/**
+ * Save data to website hook file.
+ *
+ * @param {String} projectRoot - absolute path to project root
+ * @param {String} hookContent - data to save
+ * @return {boolean} true - if data was saved; otherwise - false;
+ */
+function saveWebHook(projectRoot, hookContent) {
+  var filePath = path.join(projectRoot, WEB_HOOK_FILE_PATH);
+  var isSaved = true;
+
+  // ensure directory exists
+  createDirectoryIfNeeded(path.dirname(filePath));
+
+  // write data to file
+  try {
+    fs.writeFileSync(filePath, hookContent, 'utf8');
+  } catch (err) {
+    console.warn('Failed to create android web hook!');
+    console.warn(err);
+    isSaved = false;
+  }
+
+  return isSaved;
+}
+
+/**
+ * Create directory if it doesn't exist yet.
+ *
+ * @param {String} dir - absolute path to directory
+ */
+function createDirectoryIfNeeded(dir) {
+  try {
+    mkpath.sync(dir);
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+// endregion

package/hooks/lib/configXmlHelper.js

@@ -0,0 +1,117 @@
+/*
+Helper class to read data from config.xml file.
+*/
+var path = require('path');
+var xmlHelper = require('./xmlHelper.js');
+var ANDROID = 'android';
+var IOS = 'ios';
+var CONFIG_FILE_NAME = 'config.xml';
+var context;
+var projectRoot;
+
+module.exports = ConfigXmlHelper;
+
+// region public API
+
+/**
+ * Constructor.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ */
+function ConfigXmlHelper(cordovaContext) {
+  context = cordovaContext;
+  projectRoot = context.opts.projectRoot;
+}
+
+/**
+ * Read config.xml data as JSON object.
+ *
+ * @return {Object} JSON object with data from config.xml
+ */
+ConfigXmlHelper.prototype.read = function() {
+  var filePath = getConfigXmlFilePath();
+
+  return xmlHelper.readXmlAsJson(filePath);
+}
+
+/**
+ * Get package name for the application. Depends on the platform.
+ *
+ * @param {String} platform - 'ios' or 'android'; for what platform we need a package name
+ * @return {String} package/bundle name
+ */
+ConfigXmlHelper.prototype.getPackageName = function(platform) {
+  var configFilePath = getConfigXmlFilePath();
+  var config = getCordovaConfigParser(configFilePath);
+  var packageName;
+
+  switch (platform) {
+    case ANDROID:
+      {
+        packageName = config.android_packageName();
+        break;
+      }
+    case IOS:
+      {
+        packageName = config.ios_CFBundleIdentifier();
+        break;
+      }
+  }
+  if (packageName === undefined || packageName.length == 0) {
+    packageName = config.packageName();
+  }
+
+  return packageName;
+}
+
+/**
+ * Get name of the current project.
+ *
+ * @return {String} name of the project
+ */
+ConfigXmlHelper.prototype.getProjectName = function() {
+  return getProjectName();
+}
+
+// endregion
+
+// region Private API
+
+/**
+ * Get config parser from cordova library.
+ *
+ * @param {String} configFilePath absolute path to the config.xml file
+ * @return {Object}
+ */
+function getCordovaConfigParser(configFilePath) {
+  var ConfigParser;
+
+  // If we are running Cordova 5.4 or abova - use parser from cordova-common.
+  // Otherwise - from cordova-lib.
+  try {
+    ConfigParser = context.requireCordovaModule('cordova-common/src/ConfigParser/ConfigParser');
+  } catch (e) {
+    ConfigParser = context.requireCordovaModule('cordova-lib/src/configparser/ConfigParser')
+  }
+
+  return new ConfigParser(configFilePath);
+}
+
+/**
+ * Get absolute path to the config.xml.
+ */
+function getConfigXmlFilePath() {
+  return path.join(projectRoot, CONFIG_FILE_NAME);
+}
+
+/**
+ * Get project name from config.xml
+ */
+function getProjectName() {
+  var configFilePath = getConfigXmlFilePath();
+  var config = getCordovaConfigParser(configFilePath);
+
+  return config.name();
+}
+
+// endregion

package/hooks/lib/configXmlParser.js

@@ -0,0 +1,145 @@
+/*
+Parser for config.xml file. Read plugin-specific preferences (from <universal-links> tag) as JSON object.
+*/
+var path = require('path');
+var ConfigXmlHelper = require('./configXmlHelper.js');
+var DEFAULT_SCHEME = 'http';
+
+module.exports = {
+  readPreferences: readPreferences
+};
+
+// region Public API
+
+/**
+ * Read plugin preferences from the config.xml file.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ * @return {Array} list of host objects
+ */
+function readPreferences(cordovaContext) {
+  // read data from projects root config.xml file
+  var configXml = new ConfigXmlHelper(cordovaContext).read();
+  if (configXml == null) {
+    console.warn('config.xml not found! Please, check that it exist\'s in your project\'s root directory.');
+    return null;
+  }
+
+  // look for data from the <universal-links> tag
+  var ulXmlPreferences = configXml.widget['universal-links'];
+  if (ulXmlPreferences == null || ulXmlPreferences.length == 0) {
+    console.warn('<universal-links> tag is not set in the config.xml. Universal Links plugin is not going to work.');
+    return null;
+  }
+
+  var xmlPreferences = ulXmlPreferences[0];
+
+  // read hosts
+  var hosts = constructHostsList(xmlPreferences);
+
+  // read ios team ID
+  var iosTeamId = getTeamIdPreference(xmlPreferences);
+
+  return {
+    'hosts': hosts,
+    'iosTeamId': iosTeamId
+  };
+}
+
+// endregion
+
+// region Private API
+
+function getTeamIdPreference(xmlPreferences) {
+  if (xmlPreferences.hasOwnProperty('ios-team-id')) {
+    return xmlPreferences['ios-team-id'][0]['$']['value'];
+  }
+
+  return null;
+}
+
+/**
+ * Construct list of host objects, defined in xml file.
+ *
+ * @param {Object} xmlPreferences - plugin preferences from config.xml as JSON object
+ * @return {Array} array of JSON objects, where each entry defines host data from config.xml.
+ */
+function constructHostsList(xmlPreferences) {
+  var hostsList = [];
+
+  // look for defined hosts
+  var xmlHostList = xmlPreferences['host'];
+  if (xmlHostList == null || xmlHostList.length == 0) {
+    return [];
+  }
+
+  xmlHostList.forEach(function(xmlElement) {
+    var host = constructHostEntry(xmlElement);
+    if (host) {
+      hostsList.push(host);
+    }
+  });
+
+  return hostsList;
+}
+
+/**
+ * Construct host object from xml data.
+ *
+ * @param {Object} xmlElement - xml data to process.
+ * @return {Object} host entry as JSON object
+ */
+function constructHostEntry(xmlElement) {
+  var host = {
+      scheme: DEFAULT_SCHEME,
+      name: '',
+      paths: []
+    };
+  var hostProperties = xmlElement['$'];
+
+  if (hostProperties == null || hostProperties.length == 0) {
+    return null;
+  }
+
+  // read host name
+  host.name = hostProperties.name;
+
+  // read scheme if defined
+  if (hostProperties['scheme'] != null) {
+    host.scheme = hostProperties.scheme;
+  }
+
+  // construct paths list, defined for the given host
+  host.paths = constructPaths(xmlElement);
+
+  return host;
+}
+
+/**
+ * Construct list of path objects from the xml data.
+ *
+ * @param {Object} xmlElement - xml data to process
+ * @return {Array} list of path entries, each on is a JSON object
+ */
+function constructPaths(xmlElement) {
+  if (xmlElement['path'] == null) {
+    return ['*'];
+  }
+
+  var paths = [];
+  xmlElement.path.some(function(pathElement) {
+    var url = pathElement['$']['url'];
+
+    // Ignore explicit paths if '*' is defined
+    if (url === '*') {
+      paths = ['*'];
+      return true;
+    }
+
+    paths.push(url);
+  });
+
+  return paths;
+}
+
+// endregion

package/hooks/lib/ios/appleAppSiteAssociationFile.js

@@ -0,0 +1,173 @@
+/*
+Script generates apple-app-site-association files: one for each domain, defined in config.xml.
+It is executed on 'after prepare' stage, usually when you execute 'cordova build'. Files are placed in 'ul_web_hooks/ios/' folder
+of your projects root.
+
+Files are created with the following name:
+hostname#apple-app-site-association
+
+Prefix 'hostname#' describes on which host this file should be placed. Don't forget to remove it before uploading file on your host.
+Also, in the file you need to replace <YOUR_TEAM_ID_FROM_MEMBER_CENTER> with the real team id from the member center, if <ios-team-id> preference was not set in projects config.xml.
+
+In order to activate support for Universal Links on iOS you need to sign them with the valid SSL certificate and place in the root of your domain.
+
+Additional documentation regarding apple-app-site-association file can be found here:
+- https://developer.apple.com/library/ios/documentation/General/Conceptual/AppSearch/UniversalLinks.html
+- https://developer.apple.com/library/ios/documentation/Security/Reference/SharedWebCredentialsRef/index.html#//apple_ref/doc/uid/TP40014989
+*/
+
+
+var path = require('path');
+var mkpath = require('mkpath');
+var fs = require('fs');
+var rimraf = require('rimraf');
+var ConfigXmlHelper = require('../configXmlHelper.js');
+var IOS_TEAM_ID = '<YOUR_TEAM_ID_FROM_MEMBER_CENTER>';
+var ASSOCIATION_FILE_NAME = 'apple-app-site-association';
+var bundleId;
+var context;
+
+module.exports = {
+  generate: generate
+};
+
+// region Public API
+
+/**
+ * Generate apple-app-site-association files.
+ *
+ * @param {Object} cordovaContext - cordova context object
+ * @param {Object} pluginPreferences - list of hosts from the config.xml; already parsed
+ */
+function generate(cordovaContext, pluginPreferences) {
+  context = cordovaContext;
+  removeOldFiles();
+  createNewAssociationFiles(pluginPreferences);
+}
+
+// endregion
+
+// region Content generation
+
+/**
+ * Remove old files from ul_web_hooks/ios folder.
+ */
+function removeOldFiles() {
+  rimraf.sync(getWebHookDirectory());
+}
+
+/**
+ * Generate new set of apple-app-site-association files.
+ *
+ * @param {Object} pluginPreferences - list of hosts from config.xml
+ */
+function createNewAssociationFiles(pluginPreferences) {
+  var teamId = pluginPreferences.iosTeamId;
+  if (!teamId) {
+    teamId = IOS_TEAM_ID;
+  }
+
+  pluginPreferences.hosts.forEach(function(host) {
+    var content = generateFileContentForHost(host, teamId);
+    saveContentToFile(host.name, content);
+  });
+}
+
+/**
+ * Generate content of the apple-app-site-association file for the specific host.
+ *
+ * @param {Object} host - host information
+ * @return {Object} content of the file as JSON object
+ */
+function generateFileContentForHost(host, teamId) {
+  var appID = teamId + '.' + getBundleId();
+  var paths = host.paths.slice();
+
+  // if paths are '*' - we should add '/' to it to support root domains.
+  // https://github.com/nordnet/cordova-universal-links-plugin/issues/46
+  if (paths.length == 1 && paths[0] === '*') {
+    paths.push('/');
+  }
+
+  return {
+    "applinks": {
+      "apps": [],
+      "details": [{
+        "appID": appID,
+        "paths": paths
+      }]
+    }
+  };
+}
+
+/**
+ * Save data to the the apple-app-site-association file.
+ *
+ * @param {String} filePrefix - prefix for the generated file; usually - hostname
+ * @param {Object} content - file content as JSON object
+ */
+function saveContentToFile(filePrefix, content) {
+  var dirPath = getWebHookDirectory();
+  var filePath = path.join(dirPath, filePrefix + '#' + ASSOCIATION_FILE_NAME);
+
+  // create all directories from file path
+  createDirectoriesIfNeeded(dirPath);
+
+  // write content to the file
+  try {
+    fs.writeFileSync(filePath, JSON.stringify(content, null, 2), 'utf8');
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+/**
+ * Create all directories from the given path.
+ *
+ * @param {String} dirPath - full path to directory
+ */
+function createDirectoriesIfNeeded(dirPath) {
+  try {
+    mkpath.sync(dirPath);
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+// endregion
+
+// region Support methods
+
+/**
+ * Path to the ios web hook directory.
+ *
+ * @return {String} path to web hook directory
+ */
+function getWebHookDirectory() {
+  return path.join(getProjectRoot(), 'ul_web_hooks', 'ios');
+}
+
+/**
+ * Project root directory
+ *
+ * @return {String} absolute path to project root
+ */
+function getProjectRoot() {
+  return context.opts.projectRoot;
+}
+
+/**
+ * Get bundle id from the config.xml file.
+ *
+ * @return {String} bundle id
+ */
+function getBundleId() {
+  if (bundleId === undefined) {
+    var configXmlHelper = new ConfigXmlHelper(context);
+    bundleId = configXmlHelper.getPackageName('ios');
+  }
+
+  return bundleId;
+}
+
+// endregion