From ff9f7dc2e3153d2dcfd3b5a302a14c1c081df8a3 Mon Sep 17 00:00:00 2001
From: "Walter, Markus (DI PA DCP R&D 5)" <walter.markus@siemens.com>
Date: Mon, 8 Jan 2024 09:16:48 +0100
Subject: [PATCH] Add changes for modifying environment values

- environment value can be modified by serveral rules
- documentation added
---
 doc/xmlConfigFile.md                          | 14 ++++++++++++-
 doc/yamlConfigFile.md                         |  4 ++++
 .../Configuration/XmlServiceConfig.cs         | 20 ++++++++++++++++++
 .../Configuration/YamlServiceConfig.cs        | 21 ++++++++++++++++++-
 4 files changed, 57 insertions(+), 2 deletions(-)

diff --git a/doc/xmlConfigFile.md b/doc/xmlConfigFile.md
index f5536e7..d7cb513 100644
--- a/doc/xmlConfigFile.md
+++ b/doc/xmlConfigFile.md
@@ -16,7 +16,9 @@ Example:
   <id>jenkins</id>
   <name>Jenkins</name>
   <description>This service runs Jenkins continuous integration system.</description>
-  <env name="JENKINS_HOME" value="%BASE%"/>
+  <env name="JENKINS_HOME" value="%BASE%">
+    <rule regex="\\" replace="\/"/>
+  </env>
   <executable>java</executable>
   <arguments>-Xrs -Xmx256m -jar "%BASE%\jenkins.war" --httpPort=8080</arguments>
   <log mode="roll"></log>
@@ -139,6 +141,16 @@ This optional element can be specified multiple times if necessary to specify en
 <env name="HOME" value="c:\abc" />
 ```
 
+#### Rule
+
+This optional element can be specified multiple time within element "env". The syntax is:
+
+```xml
+<rule regex="\\" value="\/"
+```
+
+With the help of a rule replacements in a environment variable can be done after expansion. That is helpful e.g. when working with Linux tools on Windows and Windows environment variables are used in "env" for paths to change back slashes to forward slashes and mask white spaces.
+
 ### interactive
 
 If this optional element is specified, the service will be allowed to interact with the desktop, such as by showing a new window and dialog boxes. 
diff --git a/doc/yamlConfigFile.md b/doc/yamlConfigFile.md
index 01b3bd9..d8e90e2 100644
--- a/doc/yamlConfigFile.md
+++ b/doc/yamlConfigFile.md
@@ -171,6 +171,10 @@ env:
         value: host1;host2
 ```
 
+#### Rule
+
+This optional element can be specified multiple time within element "env". With the help of a rule replacements in a environment variable can be done after expansion. That is helpful e.g. when working with Linux tools on Windows and Windows environment variables are used in "env" for paths to change back slashes to forward slashes and mask white spaces.
+
 ### interactive
 
 If this optional element is specified, the service will be allowed to interact with the desktop, such as by showing a new window and dialog boxes. 
diff --git a/src/WinSW.Core/Configuration/XmlServiceConfig.cs b/src/WinSW.Core/Configuration/XmlServiceConfig.cs
index b1bbbda..d36b6d7 100644
--- a/src/WinSW.Core/Configuration/XmlServiceConfig.cs
+++ b/src/WinSW.Core/Configuration/XmlServiceConfig.cs
@@ -4,6 +4,7 @@ using System.Diagnostics;
 using System.IO;
 using System.ServiceProcess;
 using System.Text;
+using System.Text.RegularExpressions;
 using System.Xml;
 using WinSW.Configuration;
 using WinSW.Native;
@@ -682,6 +683,25 @@ namespace WinSW
                 var node = nodeList[i]!;
                 string key = node.Attributes!["name"]?.Value ?? throw new InvalidDataException("'name' is missing");
                 string value = Environment.ExpandEnvironmentVariables(node.Attributes["value"]?.Value ?? throw new InvalidDataException("'value' is missing"));
+
+                if (node.HasChildNodes)
+                {
+                    var ruleList = node.SelectNodes("rule")!;
+
+                    for (int ruleNumber = 0; ruleNumber < ruleList.Count; ruleNumber++)
+                    {
+                        var rule = ruleList[ruleNumber]!;
+
+                        string regularExpression = rule.Attributes!["regex"]!.Value;
+                        string replacement = rule.Attributes!["replace"]!.Value;
+
+                        if (!string.IsNullOrEmpty(regularExpression) && !string.IsNullOrEmpty(replacement))
+                        {
+                            value = Regex.Replace(value, regularExpression, replacement);
+                        }
+                    }
+                }
+
                 environment[key] = value;
 
                 Environment.SetEnvironmentVariable(key, value);
diff --git a/src/WinSW.Core/Configuration/YamlServiceConfig.cs b/src/WinSW.Core/Configuration/YamlServiceConfig.cs
index b6613d3..5111c3b 100644
--- a/src/WinSW.Core/Configuration/YamlServiceConfig.cs
+++ b/src/WinSW.Core/Configuration/YamlServiceConfig.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
@@ -6,6 +6,7 @@ using System.IO;
 using System.Runtime.CompilerServices;
 #endif
 using System.ServiceProcess;
+using System.Text.RegularExpressions;
 using System.Xml;
 using WinSW.Native;
 using WinSW.Util;
@@ -219,6 +220,17 @@ namespace WinSW.Configuration
                 string key = item.Name;
                 string value = Environment.ExpandEnvironmentVariables(item.Value);
 
+                foreach (var ruleItem in item.Rule!)
+                {
+                    string regularExpression = ruleItem.Regex!;
+                    string replacement = ruleItem.Replace!;
+
+                    if (!string.IsNullOrEmpty(regularExpression) && !string.IsNullOrEmpty(replacement))
+                    {
+                        value = Regex.Replace(value, regularExpression, replacement);
+                    }
+                }
+
                 this.EnvironmentVariables[key] = value;
                 Environment.SetEnvironmentVariable(key, value);
             }
@@ -424,6 +436,13 @@ namespace WinSW.Configuration
         {
             public string? Name;
             public string? Value;
+            public List<RawYamlRule>? Rule;
+        }
+
+        internal sealed class RawYamlRule
+        {
+            public string? Regex;
+            public string? Replace;
         }
 
         internal sealed class YamlFailureAction