ionic/node_modules/ionic-app-lib/lib/config-xml.js

A tool for creating and developing Ionic Framework mobile apps.

var fs = require('fs');
var path = require('path');
var Q = require('q');
var xml2js = require('xml2js');
var log = require('./logging').logger;

var ConfigXml = module.exports;

ConfigXml.loadToJson = function(appDirectory) {
  var d = Q.defer();

  if (!appDirectory) {
    appDirectory = process.cwd();
  }

  var configXmlPath = path.join(appDirectory, 'config.xml');

  fs.readFile(configXmlPath, { encoding: 'utf8' }, function(err, data) {
    if (err) return d.reject(err);

    xml2js.parseString(data, function(err, configJson) {
      if (err) return d.reject(err);

      d.resolve(configJson);
    });
  });

  return d.promise;
};

ConfigXml.loadToStream = function(appDirectory) {
  if (!appDirectory) {
    appDirectory = process.cwd();
  }

  return fs.createReadStream(path.join(appDirectory, 'config.xml'));
};

ConfigXml.setConfigXml = function setConfigXml(appDirectory, options) {
  var madeChange = false;

  if (!appDirectory) {
    appDirectory = process.cwd();
  }

  log.debug('ConfigXml.setConfigXml', appDirectory, options);

  var configXmlPath = path.join(appDirectory, 'config.xml');

  if (!fs.existsSync(configXmlPath)) {

    // working directory does not have the config.xml file
    if (options.errorWhenNotFound) {
      return Q.reject('Unable to locate config.xml file. Please ensure the working ' +
                      'directory is at the root of the app where the config.xml should be located.');
    }
  }

  return ConfigXml.loadToJson(appDirectory, options)
    .then(function(configJson) {
      if (!configJson.widget) {
        throw new Error('\nYour config.xml file is invalid. You must have a <widget> element.');
      } else if (configJson.widget && !configJson.widget.content) {
        throw new Error('\nYour config.xml file does not have a <content> element. ' +
                        '\nAdd something like: <content src="index.html"/>');
      }

      if (options.devServer) {
        if (!configJson.widget.content[0].$['original-src']) {
          configJson.widget.content[0].$['original-src'] = configJson.widget.content[0].$.src;
          madeChange = true;
        }
        if (configJson.widget.content[0].$.src !== options.devServer) {
          configJson.widget.content[0].$.src = options.devServer;

          // Check if they have the allow-navigation entry for our dev server
          var an = configJson.widget['allow-navigation'];
          var allowNavNode = {
            $: {
              href: options.devServer
            }
          };
          if(!an) {
            // They don't have any allow-navigations, so we need to create a new node
            configJson.widget['allow-navigation'] = [ allowNavNode ];
          } else {
            var foundAllowNav = false;
            for(var i = 0 ; i < an.length; i++) {
              if(an[i].$.href == options.devServer) {
                foundAllowNav = true;
              }
            }
            if(!foundAllowNav) {
              configJson.widget['allow-navigation'].push(allowNavNode);
            }
          }

          madeChange = true;
        }

      } else if (options.resetContent) {

        if (configJson.widget.content[0].$['original-src']) {
          configJson.widget.content[0].$.src = configJson.widget.content[0].$['original-src'];
          delete configJson.widget.content[0].$['original-src'];
          madeChange = true;
        }
      }

      if (madeChange) {
        var xmlBuilder = new xml2js.Builder();
        var configString = xmlBuilder.buildObject(configJson);
        fs.writeFileSync(configXmlPath, configString);
      }
    });
};