cordova-plugin-app-preferences/bin/lib/ios.js

Application preferences plugin and preference pane generator

var mappings = require("./mappings"),
	platformName = "ios",
	platformDir = 'platforms/ios/',
	xcodeprojRegex = /\.xcodeproj$/i;

module.exports = function (Q, fs, path, plist, xcode) {

	function mapConfig(config) {
		var element = {};

		if (!config.type) {
			throw "no type defined for "+JSON.stringify (config, null, "\t");
		}

		var mapping = mappings[config.type];

		if (!mapping)
			throw "no mapping for "+ config.type;

		element.Type = mapping[platformName];

		if (mapping.required) {
			mapping.required.forEach (function (k) {
				if (!(k in config)) {
					throw 'ERROR: attribute "'+ k + '" not found for ' + config.title + ' (type: ' + config.type + ')';
				}
			});
		}

		if (mapping.attrs) {
			for (var attrName in mapping.attrs) {
				if (!config.hasOwnProperty(attrName))
					continue;
				var attrConfig = mapping.attrs[attrName];
				var elementKey = attrConfig[platformName];
				if (attrConfig.value) {
					if (!attrConfig.value[config[attrName]] || !attrConfig.value[config[attrName]][platformName])
						throw "no mapping for type: "+ config.type + ", attr: " + attrName + ", value: " + config[attrName];
					element[elementKey] = attrConfig.value[config[attrName]][platformName];
				} else {
					element[elementKey] = config[attrName];
				}
			}
		}

		if (mapping.fixup && mapping.fixup[platformName]) {
			mapping.fixup[platformName] (element, config, mapping);
		}

		return element;
	}

	// build iOS settings bundle
	function buildItems(data) {

		var items = [];
		for (var i=0, l=data.length; i<l; i++) {

			var src = data[i];

			items.push(mapConfig(src));

			if (src.type == 'group') {
				src.items.forEach(function(s) {
					items.push(mapConfig(s));
				});
			}
		}

		return items;
	}

	function parseXCode(projPath) {
		var proj = xcode.project(projPath);

		proj.parseSync();

		return proj;
	}

	function buildXCode() {
		// console.log ('searching for xcodeproj:', process.cwd(), platformDir, xcodeprojRegex);
		return fs.find(platformDir, xcodeprojRegex).then(function(projPath) {
			projPath = path.join(projPath, "project.pbxproj");

			var xcproj = parseXCode (projPath);
			xcproj.addResourceFile('Settings.bundle', {sourceTree: "SOURCE_ROOT"});
			var contents = xcproj.writeSync();

			return fs.writeFile(projPath, contents);

		});
	}

	function cleanXCode() {
		return fs.find(platformDir, xcodeprojRegex).then(function(projPath) {
			projPath = path.join(projPath, "project.pbxproj");

			var xcproj = parseXCode (projPath);
			xcproj.removeResourceFile ('Settings.bundle', {sourceTree: "SOURCE_ROOT"});
			var contents = xcproj.writeSync();

			return fs.writeFile(projPath, contents);

		});
	}

	function build(config) {

		var plistXml = plist.build({ PreferenceSpecifiers: buildItems(config) });

		return fs.exists('platforms/ios')
			// Check if Settings.bundle is generated by plugin
			.then (function () {
				return fs.exists ('platforms/ios/Settings.bundle')
			}, function (err) {
				if (err.code === "NEXIST") throw "no-platform"; throw err;
			})
			.then (function () {
				return fs.exists ('platforms/ios/Settings.bundle/.me.apla.apppreferences');
			}, function () {return true;})
			// Write settings plist
			.then(function () {
				return fs.mkdir('platforms/ios/Settings.bundle');
			}, function (err) {throw "incompatible";})
			.then(function () {
				return fs.writeFile('platforms/ios/Settings.bundle/.me.apla.apppreferences', "");
			})
			.then(function () {return fs.writeFile('platforms/ios/Settings.bundle/Root.plist', plistXml); })

			// Write localization resource file
			.then(function () {return fs.mkdir('platforms/ios/Settings.bundle/en.lproj'); })
			.then(function () {return fs.writeFile('platforms/ios/Settings.bundle/en.lproj/Root.strings', '/* */'); })

			// Add Settings plist to xcodeproj
			.then(buildXCode)

			.then(function () {console.log('ios settings bundle was successfully generated'); })
			.catch(function (err) {
				console.log ('error', err);
				if (err === "no-platform") {
					console.log ("Platform ios not found: skipping");
					return;
				} else if (err === "incompatible") {
					throw "Settings.bundle already exists and not generated by plugin. Please remove Settings.bundle from platforms/ios or app-settings.json from project root.";
				//} else if (err.code === 'NEXIST') {
				//	console.log ("Platform ios not found: skipping", Object.keys (err));
				//	return;
				}

				throw err;
			});
	}

	function clean(config) {
		return fs.exists('platforms/ios')
			// Check if Settings.bundle is generated by plugin
			.then (function () { return fs.exists ('platforms/ios/Settings.bundle/.me.apla.apppreferences'); })
			// Remove settings plist
			.then(function () { return fs.unlink('platforms/ios/Settings.bundle/Root.plist'); }, function (err) {if (err.code === "NEXIST") throw "incompatible"; throw err; })
			.then(function () { return fs.unlink('platforms/ios/Settings.bundle/.me.apla.apppreferences'); })

			// Remove localization resource file
			.then(function () { return fs.unlink('platforms/ios/Settings.bundle/en.lproj/Root.strings', '/* */'); })

			// Remove directories
			.then(function () { return fs.rmdir('platforms/ios/Settings.bundle/en.lproj'); })
			.then(function () { return fs.rmdir('platforms/ios/Settings.bundle'); })

			// Remove Settings plist from xcodeproj
			.then(cleanXCode)

			.then(function () { console.log('ios settings bundle was successfully cleaned'); })
			.catch(function (err) {

				if (err === "incompatible") {
					console.log ("Settings.bundle is generated by external tool, skipping");
				//} else if (err.code === 'NEXIST') {
				//	console.log("Platform ios not found: skipping");
					return;
				}

				throw err;
			});
	}

	return {
		mapConfig: mapConfig,
		buildItems: buildItems,

		build: build,
		clean: clean
	};
};