src/metadata/wp7_parser.js - cordova-cli - Git at Google

 /**
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
 */
 var fs            = require('fs'),
     path          = require('path'),
     et            = require('elementtree'),
     util          = require('../util'),
     events        = require('../events'),
     shell         = require('shelljs'),
     events        = require('../events'),
     config_parser = require('../config_parser'),
     config        = require('../config');

 module.exports = function wp7_parser(project) {
     try {
         // TODO : Check that it's not a wp7 project?
         var csproj_file   = fs.readdirSync(project).filter(function(e) { return e.match(/\.csproj$/i); })[0];
         if (!csproj_file) throw new Error('No .csproj file.');
         this.wp7_proj_dir = project;
         this.csproj_path  = path.join(this.wp7_proj_dir, csproj_file);
         this.sln_path     = path.join(this.wp7_proj_dir, csproj_file.replace(/\.csproj/, '.sln'));
     } catch(e) {
         throw new Error('The provided path "' + project + '" is not a Windows Phone 7 project. ' + e);
     }
     this.manifest_path  = path.join(this.wp7_proj_dir, 'Properties', 'WMAppManifest.xml');
 };

 module.exports.check_requirements = function(project_root, callback) {
     events.emit('log', 'Checking wp7 requirements...');
     var lib_path = path.join(util.libDirectory, 'wp8', 'cordova', require('../../platforms').wp7.version, 'wp7');
     var custom_path = config.has_custom_path(project_root, 'wp7');
     if (custom_path) lib_path = custom_path;
     var command = '"' + path.join(lib_path, 'bin', 'check_reqs') + '"';
     events.emit('log', 'Running "' + command + '" (output to follow)');
     shell.exec(command, {silent:true, async:true}, function(code, output) {
         events.emit('log', output);
         if (code != 0) {
             callback(output);
         } else {
             callback(false);
         }
     });
 };

 module.exports.prototype = {
     update_from_config:function(config) {
         //check config parser
         if (config instanceof config_parser) {
         } else throw new Error('update_from_config requires a config_parser object');

         //Get manifest file
         var man = fs.readFileSync(this.manifest_path, 'utf-8');
         var cleanedMan = man.replace('\ufeff', ''); //Windows is the BOM
         var manifest = new et.ElementTree(et.XML(cleanedMan));

         //Update app version
         var version = config.version();
         manifest.find('.//App').attrib.Version = version;

         // Update app name by editing app title in Properties\WMAppManifest.xml
         var name = config.name();
         var prev_name = manifest.find('.//App[@Title]')['attrib']['Title'];
         if(prev_name != name) {
             events.emit('log', "Updating app name from " + prev_name + " to " + name);
             manifest.find('.//App').attrib.Title = name;
             manifest.find('.//App').attrib.Publisher = name + " Publisher";
             manifest.find('.//App').attrib.Author = name + " Author";
             manifest.find('.//PrimaryToken').attrib.TokenID = name;
             //update name of sln and csproj.
             name = name.replace(/(\.\s|\s\.|\s+|\.+)/g, '_'); //make it a ligitamate name
             prev_name = prev_name.replace(/(\.\s|\s\.|\s+|\.+)/g, '_');
             var sln_name = fs.readdirSync(this.wp7_proj_dir).filter(function(e) { return e.match(/\.sln$/i); })[0];
             var sln_path = path.join(this.wp7_proj_dir, sln_name);
             var sln_file = fs.readFileSync(sln_path, 'utf-8');
             var name_regex = new RegExp(prev_name, "g");
             fs.writeFileSync(sln_path, sln_file.replace(name_regex, name), 'utf-8');
             shell.mv('-f', this.csproj_path, path.join(this.wp7_proj_dir, name + '.csproj'));
             this.csproj_path = path.join(this.wp7_proj_dir, name + '.csproj');
             shell.mv('-f', sln_path, path.join(this.wp7_proj_dir, name + '.sln'));
             this.sln_path    = path.join(this.wp7_proj_dir, name + '.sln');
         }

         // Update package name by changing:
         /*  - CordovaAppProj.csproj
          *  - MainPage.xaml
          *  - MainPage.xaml.cs
          *  - App.xaml
          *  - App.xaml.cs
          */
          var pkg = config.packageName();
          var raw = fs.readFileSync(this.csproj_path, 'utf-8');
          var cleanedPage = raw.replace(/^\uFEFF/i, '');
          var csproj = new et.ElementTree(et.XML(cleanedPage));
          prev_name = csproj.find('.//RootNamespace').text;
          if(prev_name != pkg) {
             events.emit('log', "Updating package name from " + prev_name + " to " + pkg);
             //CordovaAppProj.csproj
             csproj.find('.//RootNamespace').text = pkg;
             csproj.find('.//AssemblyName').text = pkg;
             csproj.find('.//XapFilename').text = pkg + '.xap';
             csproj.find('.//SilverlightAppEntry').text = pkg + '.App';
             fs.writeFileSync(this.csproj_path, csproj.write({indent: 4}), 'utf-8');
             //MainPage.xaml
             raw = fs.readFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml'), 'utf-8');
             // Remove potential UTF Byte Order Mark
             cleanedPage = raw.replace(/^\uFEFF/i, '');
             var mainPageXAML = new et.ElementTree(et.XML(cleanedPage));
             mainPageXAML.getroot().attrib['x:Class'] = pkg + '.MainPage';
             fs.writeFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml'), mainPageXAML.write({indent: 4}), 'utf-8');
             //MainPage.xaml.cs
             var mainPageCS = fs.readFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml.cs'), 'utf-8');
             var namespaceRegEx = new RegExp('namespace ' + prev_name);
             fs.writeFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml.cs'), mainPageCS.replace(namespaceRegEx, 'namespace ' + pkg), 'utf-8');
             //App.xaml
             raw = fs.readFileSync(path.join(this.wp7_proj_dir, 'App.xaml'), 'utf-8');
             cleanedPage = raw.replace(/^\uFEFF/i, '');
             var appXAML = new et.ElementTree(et.XML(cleanedPage));
             appXAML.getroot().attrib['x:Class'] = pkg + '.App';
             fs.writeFileSync(path.join(this.wp7_proj_dir, 'App.xaml'), appXAML.write({indent: 4}), 'utf-8');
             //App.xaml.cs
             var appCS = fs.readFileSync(path.join(this.wp7_proj_dir, 'App.xaml.cs'), 'utf-8');
             fs.writeFileSync(path.join(this.wp7_proj_dir, 'App.xaml.cs'), appCS.replace(namespaceRegEx, 'namespace ' + pkg), 'utf-8');
          }

          //Write out manifest
          fs.writeFileSync(this.manifest_path, manifest.write({indent: 4}), 'utf-8');
     },
     // Returns the platform-specific www directory.
     www_dir:function() {
         return path.join(this.wp7_proj_dir, 'www');
     },
     config_xml:function() {
         return path.join(this.wp7_proj_dir, 'config.xml');
     },
     // copies the app www folder into the wp7 project's www folder and updates the csproj file.
     update_www:function() {
         var project_root = util.isCordova(this.wp7_proj_dir);
         var project_www = util.projectWww(project_root);
         // remove stock platform assets
         shell.rm('-rf', this.www_dir());
         // copy over all app www assets
         shell.cp('-rf', project_www, this.wp7_proj_dir);

         // copy over wp7 lib's cordova.js
         var lib_path = path.join(util.libDirectory, 'wp8', 'cordova', require('../../platforms').wp7.version);
         var custom_path = config.has_custom_path(project_root, 'wp7');
         if (custom_path) lib_path = custom_path;
         var cordovajs_path = path.join(lib_path, 'common', 'www', 'cordova.js');
         fs.writeFileSync(path.join(this.www_dir(), 'cordova.js'), fs.readFileSync(cordovajs_path, 'utf-8'), 'utf-8');
         this.update_csproj();
     },
     // updates the csproj file to explicitly list all www content.
     update_csproj:function() {
         var raw = fs.readFileSync(this.csproj_path, 'utf-8');
         var cleaned = raw.replace(/^\uFEFF/i, '');
         var csproj_xml = new et.ElementTree(et.XML(cleaned));
         // remove any previous references to the www files
         var item_groups = csproj_xml.findall('ItemGroup');
         for (var i = 0, l = item_groups.length; i < l; i++) {
             var group = item_groups[i];
             var files = group.findall('Content');
             for (var j = 0, k = files.length; j < k; j++) {
                 var file = files[j];
                 if (file.attrib.Include.substr(0, 3) == 'www' && file.attrib.Include.indexOf('cordova.js') < 0) {
                     // remove file reference
                     group.remove(0, file);
                     // remove ItemGroup if empty
                     var new_group = group.findall('Content');
                     if(new_group.length < 1) {
                         csproj_xml.getroot().remove(0, group);
                     }
                 }
             }
         }

         // now add all www references back in from the root www folder
         var project_root = util.isCordova(this.wp7_proj_dir);
         var www_files = this.folder_contents('www', util.projectWww(project_root));
         for(file in www_files) {
             var item = new et.Element('ItemGroup');
             var content = new et.Element('Content');
             content.attrib.Include = www_files[file];
             item.append(content);
             csproj_xml.getroot().append(item);
         }
         // save file
         fs.writeFileSync(this.csproj_path, csproj_xml.write({indent:4}), 'utf-8');
     },
     // Returns an array of all the files in the given directory with reletive paths
     // - name     : the name of the top level directory (i.e all files will start with this in their path)
     // - path     : the directory whos contents will be listed under 'name' directory
     folder_contents:function(name, dir) {
         var results = [];
         var folder_dir = fs.readdirSync(dir);
         for(item in folder_dir) {
             var stat = fs.statSync(path.join(dir, folder_dir[item]));
             // means its a folder?
             if(stat.size == 0) {
                 var sub_dir = this.folder_contents(path.join(name, folder_dir[item]), path.join(dir, folder_dir[item]));
                 //Add all subfolder item paths
                 for(sub_item in sub_dir) {
                     results.push(sub_dir[sub_item]);
                 }
             }
             else {
                 results.push(path.join(name, folder_dir[item]));
             }
         }
         return results;
     },
     staging_dir: function() {
         return path.join(this.wp7_proj_dir, '.staging', 'www');
     },

     update_staging: function() {
         var projectRoot = util.isCordova(this.wp7_proj_dir);
         if (fs.existsSync(this.staging_dir())) {
             var staging = path.join(this.staging_dir(), '*');
             shell.cp('-rf', staging, this.www_dir());
         }
     },

     // calls the nessesary functions to update the wp7 project
     update_project:function(cfg, callback) {
         //console.log("Updating wp7 project...");

         try {
             this.update_from_config(cfg);
         } catch(e) {
             if (callback) return callback(e);
             else throw e;
         }
         this.update_www();
         // TODO: Add overrides support? Why is this missing?
         this.update_staging();
         util.deleteSvnFolders(this.www_dir());

         //console.log("Done updating.");

         if (callback) callback();
     }
 };
	/**
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	*/
	var fs = require('fs'),
	path = require('path'),
	et = require('elementtree'),
	util = require('../util'),
	events = require('../events'),
	shell = require('shelljs'),
	events = require('../events'),
	config_parser = require('../config_parser'),
	config = require('../config');

	module.exports = function wp7_parser(project) {
	try {
	// TODO : Check that it's not a wp7 project?
	var csproj_file = fs.readdirSync(project).filter(function(e) { return e.match(/\.csproj$/i); })[0];
	if (!csproj_file) throw new Error('No .csproj file.');
	this.wp7_proj_dir = project;
	this.csproj_path = path.join(this.wp7_proj_dir, csproj_file);
	this.sln_path = path.join(this.wp7_proj_dir, csproj_file.replace(/\.csproj/, '.sln'));
	} catch(e) {
	throw new Error('The provided path "' + project + '" is not a Windows Phone 7 project. ' + e);
	}
	this.manifest_path = path.join(this.wp7_proj_dir, 'Properties', 'WMAppManifest.xml');
	};

	module.exports.check_requirements = function(project_root, callback) {
	events.emit('log', 'Checking wp7 requirements...');
	var lib_path = path.join(util.libDirectory, 'wp8', 'cordova', require('../../platforms').wp7.version, 'wp7');
	var custom_path = config.has_custom_path(project_root, 'wp7');
	if (custom_path) lib_path = custom_path;
	var command = '"' + path.join(lib_path, 'bin', 'check_reqs') + '"';
	events.emit('log', 'Running "' + command + '" (output to follow)');
	shell.exec(command, {silent:true, async:true}, function(code, output) {
	events.emit('log', output);
	if (code != 0) {
	callback(output);
	} else {
	callback(false);
	}
	});
	};

	module.exports.prototype = {
	update_from_config:function(config) {
	//check config parser
	if (config instanceof config_parser) {
	} else throw new Error('update_from_config requires a config_parser object');

	//Get manifest file
	var man = fs.readFileSync(this.manifest_path, 'utf-8');
	var cleanedMan = man.replace('\ufeff', ''); //Windows is the BOM
	var manifest = new et.ElementTree(et.XML(cleanedMan));

	//Update app version
	var version = config.version();
	manifest.find('.//App').attrib.Version = version;

	// Update app name by editing app title in Properties\WMAppManifest.xml
	var name = config.name();
	var prev_name = manifest.find('.//App[@Title]')['attrib']['Title'];
	if(prev_name != name) {
	events.emit('log', "Updating app name from " + prev_name + " to " + name);
	manifest.find('.//App').attrib.Title = name;
	manifest.find('.//App').attrib.Publisher = name + " Publisher";
	manifest.find('.//App').attrib.Author = name + " Author";
	manifest.find('.//PrimaryToken').attrib.TokenID = name;
	//update name of sln and csproj.
	name = name.replace(/(\.\s\|\s\.\|\s+\|\.+)/g, '_'); //make it a ligitamate name
	prev_name = prev_name.replace(/(\.\s\|\s\.\|\s+\|\.+)/g, '_');
	var sln_name = fs.readdirSync(this.wp7_proj_dir).filter(function(e) { return e.match(/\.sln$/i); })[0];
	var sln_path = path.join(this.wp7_proj_dir, sln_name);
	var sln_file = fs.readFileSync(sln_path, 'utf-8');
	var name_regex = new RegExp(prev_name, "g");
	fs.writeFileSync(sln_path, sln_file.replace(name_regex, name), 'utf-8');
	shell.mv('-f', this.csproj_path, path.join(this.wp7_proj_dir, name + '.csproj'));
	this.csproj_path = path.join(this.wp7_proj_dir, name + '.csproj');
	shell.mv('-f', sln_path, path.join(this.wp7_proj_dir, name + '.sln'));
	this.sln_path = path.join(this.wp7_proj_dir, name + '.sln');
	}

	// Update package name by changing:
	/* - CordovaAppProj.csproj
	* - MainPage.xaml
	* - MainPage.xaml.cs
	* - App.xaml
	* - App.xaml.cs
	*/
	var pkg = config.packageName();
	var raw = fs.readFileSync(this.csproj_path, 'utf-8');
	var cleanedPage = raw.replace(/^\uFEFF/i, '');
	var csproj = new et.ElementTree(et.XML(cleanedPage));
	prev_name = csproj.find('.//RootNamespace').text;
	if(prev_name != pkg) {
	events.emit('log', "Updating package name from " + prev_name + " to " + pkg);
	//CordovaAppProj.csproj
	csproj.find('.//RootNamespace').text = pkg;
	csproj.find('.//AssemblyName').text = pkg;
	csproj.find('.//XapFilename').text = pkg + '.xap';
	csproj.find('.//SilverlightAppEntry').text = pkg + '.App';
	fs.writeFileSync(this.csproj_path, csproj.write({indent: 4}), 'utf-8');
	//MainPage.xaml
	raw = fs.readFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml'), 'utf-8');
	// Remove potential UTF Byte Order Mark
	cleanedPage = raw.replace(/^\uFEFF/i, '');
	var mainPageXAML = new et.ElementTree(et.XML(cleanedPage));
	mainPageXAML.getroot().attrib['x:Class'] = pkg + '.MainPage';
	fs.writeFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml'), mainPageXAML.write({indent: 4}), 'utf-8');
	//MainPage.xaml.cs
	var mainPageCS = fs.readFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml.cs'), 'utf-8');
	var namespaceRegEx = new RegExp('namespace ' + prev_name);
	fs.writeFileSync(path.join(this.wp7_proj_dir, 'MainPage.xaml.cs'), mainPageCS.replace(namespaceRegEx, 'namespace ' + pkg), 'utf-8');
	//App.xaml
	raw = fs.readFileSync(path.join(this.wp7_proj_dir, 'App.xaml'), 'utf-8');
	cleanedPage = raw.replace(/^\uFEFF/i, '');
	var appXAML = new et.ElementTree(et.XML(cleanedPage));
	appXAML.getroot().attrib['x:Class'] = pkg + '.App';
	fs.writeFileSync(path.join(this.wp7_proj_dir, 'App.xaml'), appXAML.write({indent: 4}), 'utf-8');
	//App.xaml.cs
	var appCS = fs.readFileSync(path.join(this.wp7_proj_dir, 'App.xaml.cs'), 'utf-8');
	fs.writeFileSync(path.join(this.wp7_proj_dir, 'App.xaml.cs'), appCS.replace(namespaceRegEx, 'namespace ' + pkg), 'utf-8');
	}

	//Write out manifest
	fs.writeFileSync(this.manifest_path, manifest.write({indent: 4}), 'utf-8');
	},
	// Returns the platform-specific www directory.
	www_dir:function() {
	return path.join(this.wp7_proj_dir, 'www');
	},
	config_xml:function() {
	return path.join(this.wp7_proj_dir, 'config.xml');
	},
	// copies the app www folder into the wp7 project's www folder and updates the csproj file.
	update_www:function() {
	var project_root = util.isCordova(this.wp7_proj_dir);
	var project_www = util.projectWww(project_root);
	// remove stock platform assets
	shell.rm('-rf', this.www_dir());
	// copy over all app www assets
	shell.cp('-rf', project_www, this.wp7_proj_dir);

	// copy over wp7 lib's cordova.js
	var lib_path = path.join(util.libDirectory, 'wp8', 'cordova', require('../../platforms').wp7.version);
	var custom_path = config.has_custom_path(project_root, 'wp7');
	if (custom_path) lib_path = custom_path;
	var cordovajs_path = path.join(lib_path, 'common', 'www', 'cordova.js');
	fs.writeFileSync(path.join(this.www_dir(), 'cordova.js'), fs.readFileSync(cordovajs_path, 'utf-8'), 'utf-8');
	this.update_csproj();
	},
	// updates the csproj file to explicitly list all www content.
	update_csproj:function() {
	var raw = fs.readFileSync(this.csproj_path, 'utf-8');
	var cleaned = raw.replace(/^\uFEFF/i, '');
	var csproj_xml = new et.ElementTree(et.XML(cleaned));
	// remove any previous references to the www files
	var item_groups = csproj_xml.findall('ItemGroup');
	for (var i = 0, l = item_groups.length; i < l; i++) {
	var group = item_groups[i];
	var files = group.findall('Content');
	for (var j = 0, k = files.length; j < k; j++) {
	var file = files[j];
	if (file.attrib.Include.substr(0, 3) == 'www' && file.attrib.Include.indexOf('cordova.js') < 0) {
	// remove file reference
	group.remove(0, file);
	// remove ItemGroup if empty
	var new_group = group.findall('Content');
	if(new_group.length < 1) {
	csproj_xml.getroot().remove(0, group);
	}
	}
	}
	}

	// now add all www references back in from the root www folder
	var project_root = util.isCordova(this.wp7_proj_dir);
	var www_files = this.folder_contents('www', util.projectWww(project_root));
	for(file in www_files) {
	var item = new et.Element('ItemGroup');
	var content = new et.Element('Content');
	content.attrib.Include = www_files[file];
	item.append(content);
	csproj_xml.getroot().append(item);
	}
	// save file
	fs.writeFileSync(this.csproj_path, csproj_xml.write({indent:4}), 'utf-8');
	},
	// Returns an array of all the files in the given directory with reletive paths
	// - name : the name of the top level directory (i.e all files will start with this in their path)
	// - path : the directory whos contents will be listed under 'name' directory
	folder_contents:function(name, dir) {
	var results = [];
	var folder_dir = fs.readdirSync(dir);
	for(item in folder_dir) {
	var stat = fs.statSync(path.join(dir, folder_dir[item]));
	// means its a folder?
	if(stat.size == 0) {
	var sub_dir = this.folder_contents(path.join(name, folder_dir[item]), path.join(dir, folder_dir[item]));
	//Add all subfolder item paths
	for(sub_item in sub_dir) {
	results.push(sub_dir[sub_item]);
	}
	}
	else {
	results.push(path.join(name, folder_dir[item]));
	}
	}
	return results;
	},
	staging_dir: function() {
	return path.join(this.wp7_proj_dir, '.staging', 'www');
	},

	update_staging: function() {
	var projectRoot = util.isCordova(this.wp7_proj_dir);
	if (fs.existsSync(this.staging_dir())) {
	var staging = path.join(this.staging_dir(), '*');
	shell.cp('-rf', staging, this.www_dir());
	}
	},

	// calls the nessesary functions to update the wp7 project
	update_project:function(cfg, callback) {
	//console.log("Updating wp7 project...");

	try {
	this.update_from_config(cfg);
	} catch(e) {
	if (callback) return callback(e);
	else throw e;
	}
	this.update_www();
	// TODO: Add overrides support? Why is this missing?
	this.update_staging();
	util.deleteSvnFolders(this.www_dir());

	//console.log("Done updating.");

	if (callback) callback();
	}
	};