addition of setup registrykey configuration

Author: jessk-msft

source/P4VFS.Console/P4VFS.Notes.txt

@@ -17,6 +17,10 @@ Version [1.29.0.0]
   to stress test a wide range of message sizes
 * Fixing unit tests deterministic random byte generation to more randomly include 
   zero as randomly as possible
+* Support for additional registry keys to set defined in the setup application configuration
+  file (typically named P4VFS.Setup.xml residing in the same folder as the installer).
+  This is helpfull for setting possibly setting a version key to indicate what settings
+  template was also installed.
 
 Version [1.28.4.0]
 * Addition of optional service commandline argument to launch with debugger attached. 

source/P4VFS.Driver/Include/DriverVersion.h

@@ -4,8 +4,8 @@
 
 #define P4VFS_VER_MAJOR					1			// Increment this number almost never
 #define P4VFS_VER_MINOR					28			// Increment this number whenever the driver changes
-#define P4VFS_VER_BUILD					4			// Increment this number when a major user mode change has been made
-#define P4VFS_VER_REVISION				9			// Increment this number when we rebuild with any change
+#define P4VFS_VER_BUILD					5			// Increment this number when a major user mode change has been made
+#define P4VFS_VER_REVISION				0			// Increment this number when we rebuild with any change
 
 #define P4VFS_VER_STRINGIZE_EX(v)		L#v
 #define P4VFS_VER_STRINGIZE(v)			P4VFS_VER_STRINGIZE_EX(v)

source/P4VFS.Setup/P4VFS.Setup.csproj

@@ -104,7 +104,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="Source\Configuration.cs" />
+    <Compile Include="Source\SetupConfiguration.cs" />
     <Compile Include="Source\Program.cs" />
     <Compile Include="Source\SetupWindow.xaml.cs">
       <DependentUpon>SetupWindow.xaml</DependentUpon>

source/P4VFS.Setup/Source/Configuration.cs

@@ -17,7 +17,7 @@ namespace Microsoft.P4VFS.Setup
 	public class Program
 	{
 		public static SetupWindow _SetupWindow;
-		public static List<string> _IncludeFiles;
+		public static SetupConfiguration _Configuration;
 		public static bool _Admin;
 		public static bool _Console;
 		public static bool _P4vfsDebug;
@@ -58,11 +58,9 @@ public static int Main(string[] args)
 			_Admin = false;
 			_Console = false;
 			_P4vfsDebug = false;
-			_IncludeFiles = new List<string>();
+			_Configuration = new SetupConfiguration();
 
-			Configuration config = LoadConfiguration();
-			if (config != null && config.IncludeFiles != null)
-				_IncludeFiles.AddRange(config.IncludeFiles);
+			_Configuration.Import(LoadConfiguration());
 
 			int argIndex = 0;
 			for (; argIndex < args.Length; ++argIndex)
@@ -74,7 +72,7 @@ public static int Main(string[] args)
 				else if (String.Compare(args[argIndex], "-c") == 0)
 					_Console = true;
 				else if (String.Compare(args[argIndex], "-i") == 0 && argIndex+1 < args.Length)
-					_IncludeFiles.Add(args[++argIndex]);
+					_Configuration.IncludeFiles.Add(args[++argIndex]);
 				else if (String.Compare(args[argIndex], "-d") == 0)
 					_P4vfsDebug = true;
 				else
@@ -250,7 +248,7 @@ private static bool CommandInstall(string[] args)
 				}
 
 				progress.WriteLine(6, String.Format("Installing application setup ..."));
-				if (InstallAplicationSetup() == false)
+				if (InstallApplicationSetup() == false)
 				{
 					WriteLine(String.Format("Failed installing requirements for application setup"));
 					return false;
@@ -368,7 +366,9 @@ private static bool InstallEnvironment()
 
 					List<string> paths = new List<string>(srcPath.Split(new char[]{';'}, StringSplitOptions.RemoveEmptyEntries));
 					if (paths.Any(s => String.Compare(InstallFolder, Regex.Replace(s, @"[\\/]+", "\\").TrimEnd('\\'), StringComparison.InvariantCultureIgnoreCase) == 0) == false)
+					{
 						paths.Add(InstallFolder);
+					}
 
 					string dstPath = String.Join(";", paths);
 					envKey.SetValue("PATH", dstPath, RegistryValueKind.ExpandString);
@@ -398,7 +398,7 @@ private static void RefreshEnvironmentVariables()
 			Environment.SetEnvironmentVariable("P4VFS_INSTALL", null, EnvironmentVariableTarget.Machine);
 		}
 
-		private static bool InstallAplicationSetup()
+		private static bool InstallApplicationSetup()
 		{
 			try
 			{
@@ -419,6 +419,12 @@ private static bool InstallAplicationSetup()
 					appKey.SetValue("UninstallString", String.Format("\"{0}\" uninstall", installedSetupExe), RegistryValueKind.String);
 					appKey.SetValue("Publisher", "Microsoft Corporation", RegistryValueKind.String);
 					appKey.SetValue("InstallLocation", InstallFolder, RegistryValueKind.String);
+
+					foreach (SetupRegistryKey setupKey in _Configuration.RegistryKeys)
+					{
+						WriteLine(String.Format("Setting additional registry key: {0}={1}", setupKey.Name, setupKey.Value));
+						appKey.SetValue(setupKey.Name, setupKey.Value, RegistryValueKind.String);
+					}
 				}
 			}
 			catch (Exception e)
@@ -637,13 +643,13 @@ private static string CreateStagingFolder()
 			}
 
 			string[] resourceNames = Assembly.GetExecutingAssembly().GetManifestResourceNames();
-			using (LogProgress progress = new LogProgress(resourceNames.Length+_IncludeFiles.Count+2))
+			using (LogProgress progress = new LogProgress(resourceNames.Length+_Configuration.IncludeFiles.Count+2))
 			{
 				WriteLine(String.Format("Staging: {0}", stagingFolder));
 				if (ExtractResourcesToFolder(resourceNames, stagingFolder, progress) == false)
 					return null;
 
-				foreach (string includeFile in _IncludeFiles)
+				foreach (string includeFile in _Configuration.IncludeFiles)
 				{
 					progress.Increment();
 					string includeFilePath = ResolveIncludeFilePath(includeFile);
@@ -728,7 +734,7 @@ private static string ResolveIncludeFilePath(string filePath)
 			return filePath;
 		}
 
-		private static Configuration LoadConfiguration()
+		private static SetupConfiguration LoadConfiguration()
 		{
 			string[] configFiles = new[]{
 				"P4VFS.Setup.xml",
@@ -740,7 +746,7 @@ private static Configuration LoadConfiguration()
 				string configFilePath = Path.GetFullPath(Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), configFile));
 				if (File.Exists(configFilePath))
 				{
-					Configuration config = Configuration.LoadFromFile(configFilePath);
+					SetupConfiguration config = SetupConfiguration.LoadFromFile(configFilePath);
 					if (config != null)
 					{
 						WriteLine(String.Format("Loaded Configuration: {0}", configFilePath));

source/P4VFS.Setup/Source/Program.cs

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+using System;
+using System.IO;
+using System.Linq;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+
+namespace Microsoft.P4VFS.Setup
+{
+	[XmlRoot("Configuration", Namespace="")]
+	public class SetupConfiguration
+	{
+		[XmlArray("IncludeFiles"), XmlArrayItem("Path", typeof(string))]
+		public List<string> IncludeFiles;
+
+		[XmlArray("RegistryKeys"), XmlArrayItem("Key", typeof(SetupRegistryKey))]
+		public List<SetupRegistryKey> RegistryKeys;
+
+		public static SetupConfiguration LoadFromFile(string fileName)
+		{
+			try
+			{
+				using (FileStream fs = File.OpenRead(fileName))
+				{
+					XmlSerializer xml = new XmlSerializer(typeof(SetupConfiguration));
+					SetupConfiguration config = xml.Deserialize(fs) as SetupConfiguration;
+					return config;
+				}
+			}
+			catch {}
+			return null;
+		}
+
+		public void Import(SetupConfiguration config)
+		{
+			if (IncludeFiles == null)
+				IncludeFiles = new List<string>();
+			if (config?.IncludeFiles != null)
+				IncludeFiles.AddRange(config.IncludeFiles);
+
+			if (RegistryKeys == null)
+				RegistryKeys = new List<SetupRegistryKey>();
+			if (config?.RegistryKeys != null)
+				RegistryKeys.AddRange(config.RegistryKeys);
+		}
+	}
+
+	public class SetupRegistryKey
+	{
+		[XmlAttribute]
+		public string Name;
+
+		[XmlAttribute]
+		public string Value;
+	}
+}
+