Skip to content

Commit ec23a79

Browse files
flcdrgflcdrg
authored
Merge pull request #32 from flcdrg/conditions-uninstall
Support for Condition on script elements plus ability to run on uninstall
2 parents cbb4f9d + 9b9e06b commit ec23a79

File tree

5 files changed

+211
-15
lines changed

5 files changed

+211
-15
lines changed

‎PowerShellActions/CustomAction.cs‎

Lines changed: 111 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,39 @@ public class CustomActions
1717
// Specify or calculate the total number of ticks the custom action adds to the length of the ProgressBar
1818
public const uint TotalTicks = TickIncrement * NumberItems;
1919
private const uint NumberItems = 100;
20+
2021
private const string PowerShellFilesElevatedDeferredProperty = "PowerShellFilesElevatedDeferred";
2122
private const string PowerShellFilesDeferredProperty = "PowerShellFilesDeferred";
2223
private const string PowerShellScriptsElevatedDeferredProperty = "PowerShellScriptsElevatedDeferred";
2324
private const string PowerShellScriptsDeferredProperty = "PowerShellScriptsDeferred";
2425

26+
private const string PowerShellFilesElevatedUninstallDeferredProperty = "PowerShellFilesElevatedUninstallDeferred";
27+
private const string PowerShellFilesUninstallDeferredProperty = "PowerShellFilesUninstallDeferred";
28+
private const string PowerShellScriptsElevatedUninstallDeferredProperty = "PowerShellScriptsElevatedUninstallDeferred";
29+
private const string PowerShellScriptsUninstallDeferredProperty = "PowerShellScriptsUninstallDeferred";
30+
2531
[CustomAction]
2632
public static ActionResult PowerShellFilesImmediate(Session session)
2733
{
34+
session.Log("PowerShellFilesImmediate start");
35+
2836
return FilesImmediate(session, 0, PowerShellFilesDeferredProperty);
2937
}
3038

3139
[CustomAction]
32-
public static ActionResult PowerShellFilesElevatedImmediate(Session session)
40+
public static ActionResult PowerShellFilesDeferred(Session session)
3341
{
34-
return FilesImmediate(session, 1, PowerShellFilesElevatedDeferredProperty);
42+
session.Log("PowerShellFilesDeferred start");
43+
44+
return FilesDeferred(session, PowerShellFilesDeferredProperty);
3545
}
3646

3747
[CustomAction]
38-
public static ActionResult PowerShellFilesDeferred(Session session)
48+
public static ActionResult PowerShellFilesElevatedImmediate(Session session)
3949
{
40-
session.Log("PowerShellFilesDeferred start");
50+
session.Log("PowerShellFilesElevatedImmediate start");
4151

42-
return FilesDeferred(session, PowerShellFilesDeferredProperty);
52+
return FilesImmediate(session, 1, PowerShellFilesElevatedDeferredProperty);
4353
}
4454

4555
[CustomAction]
@@ -51,29 +61,103 @@ public static ActionResult PowerShellFilesElevatedDeferred(Session session)
5161
}
5262

5363
[CustomAction]
54-
public static ActionResult PowerShellScriptsImmediate(Session session)
64+
public static ActionResult PowerShellFilesUninstall(Session session)
5565
{
56-
return ScriptsImmediate(session, 0, PowerShellScriptsDeferredProperty);
66+
session.Log("PowerShellFilesUninstall start");
67+
68+
return FilesImmediate(session, 0, PowerShellFilesUninstallDeferredProperty);
5769
}
5870

71+
5972
[CustomAction]
60-
public static ActionResult PowerShellScriptsElevatedImmediate(Session session)
73+
public static ActionResult PowerShellFilesUninstallDeferred(Session session)
6174
{
62-
return ScriptsImmediate(session, 1, PowerShellScriptsElevatedDeferredProperty);
75+
session.Log("PowerShellFilesUninstallDeferred start");
76+
77+
return FilesDeferred(session, PowerShellFilesUninstallDeferredProperty);
78+
}
79+
80+
81+
[CustomAction]
82+
public static ActionResult PowerShellFilesElevatedUninstall(Session session)
83+
{
84+
session.Log("PowerShellFilesElevatedUninstall start");
85+
86+
return FilesImmediate(session, 1, PowerShellFilesElevatedUninstallDeferredProperty);
87+
}
88+
89+
[CustomAction]
90+
public static ActionResult PowerShellFilesElevatedUninstallDeferred(Session session)
91+
{
92+
session.Log("PowerShellFilesElevatedUninstallDeferred start");
93+
94+
return FilesDeferred(session, PowerShellFilesElevatedUninstallDeferredProperty);
95+
}
96+
97+
[CustomAction]
98+
public static ActionResult PowerShellScriptsImmediate(Session session)
99+
{
100+
session.Log("PowerShellScriptsImmediate start");
101+
102+
return ScriptsImmediate(session, 0, PowerShellScriptsDeferredProperty);
63103
}
64104

65105
[CustomAction]
66106
public static ActionResult PowerShellScriptsDeferred(Session session)
67107
{
108+
session.Log("PowerShellScriptsDeferred start");
109+
68110
return ScriptsDeferred(session, PowerShellScriptsDeferredProperty);
69111
}
70112

113+
[CustomAction]
114+
public static ActionResult PowerShellScriptsElevatedImmediate(Session session)
115+
{
116+
session.Log("PowerShellScriptsElevatedImmediate start");
117+
118+
return ScriptsImmediate(session, 1, PowerShellScriptsElevatedDeferredProperty);
119+
}
120+
71121
[CustomAction]
72122
public static ActionResult PowerShellScriptsElevatedDeferred(Session session)
73123
{
124+
session.Log("PowerShellScriptsElevatedDeferred start");
125+
74126
return ScriptsDeferred(session, PowerShellScriptsElevatedDeferredProperty);
75127
}
76128

129+
[CustomAction]
130+
public static ActionResult PowerShellScriptsUninstall(Session session)
131+
{
132+
session.Log("PowerShellScriptsUninstall start");
133+
134+
return ScriptsImmediate(session, 0, PowerShellScriptsUninstallDeferredProperty);
135+
}
136+
137+
[CustomAction]
138+
public static ActionResult PowerShellScriptsUninstallDeferred(Session session)
139+
{
140+
session.Log("PowerShellScriptsUninstallDeferred start");
141+
142+
return ScriptsDeferred(session, PowerShellScriptsUninstallDeferredProperty);
143+
}
144+
145+
[CustomAction]
146+
public static ActionResult PowerShellScriptsElevatedUninstall(Session session)
147+
{
148+
session.Log("PowerShellScriptsElevatedUninstall start");
149+
150+
return ScriptsImmediate(session, 1, PowerShellScriptsElevatedUninstallDeferredProperty);
151+
}
152+
153+
[CustomAction]
154+
public static ActionResult PowerShellScriptsElevatedUninstallDeferred(Session session)
155+
{
156+
session.Log("PowerShellScriptsElevatedUninstallDeferred start");
157+
158+
return ScriptsDeferred(session, PowerShellScriptsElevatedUninstallDeferredProperty);
159+
}
160+
77161
[Serializable]
78162
public class ScriptActionData
79163
{
@@ -92,13 +176,20 @@ private static ActionResult ScriptsImmediate(Session session, int elevated, stri
92176
try
93177
{
94178
List<ScriptActionData> scripts = new List<ScriptActionData>();
95-
using (View view = db.OpenView(string.Format("SELECT `Id`, `Script`, `IgnoreErrors` FROM `PowerShellScripts` WHERE `Elevated` = {0} ORDER BY `Order`", elevated)))
179+
using (View view = db.OpenView(string.Format("SELECT `Id`, `Script`, `IgnoreErrors`, `Condition` FROM `PowerShellScripts` WHERE `Elevated` = {0} ORDER BY `Order`", elevated)))
96180
{
97181
view.Execute();
98182

99183
Record row;
100184
while ((row = view.Fetch()) != null)
101185
{
186+
string condition = row["Condition"]?.ToString();
187+
if (!string.IsNullOrEmpty(condition) && !session.EvaluateCondition(condition))
188+
{
189+
session.Log($"Condition evaluated to false. Skip PS script {row["Id"]?.ToString()}");
190+
continue;
191+
}
192+
102193
string script = Encoding.Unicode.GetString(Convert.FromBase64String(row["Script"].ToString()));
103194
script = session.Format(script);
104195
script = Convert.ToBase64String(Encoding.Unicode.GetBytes(script));
@@ -204,7 +295,7 @@ private static ActionResult ScriptsDeferred(Session session, string deferredProp
204295
foreach (ScriptActionData datum in scripts)
205296
{
206297
string script = Encoding.Unicode.GetString(Convert.FromBase64String(datum.Script));
207-
session.Log("Executing PowerShell script:\n{0}", script);
298+
session.Log($"Executing PowerShell script {datum.Id}:\n{script}");
208299

209300
using (var task = new PowerShellTask(script, session))
210301
{
@@ -254,14 +345,21 @@ private static ActionResult FilesImmediate(Session session, int elevated, string
254345
try
255346
{
256347
XDocument doc;
257-
using (View view = db.OpenView(string.Format("SELECT `Id`, `File`, `Arguments`, `IgnoreErrors` FROM `{0}` WHERE `Elevated` = {1} ORDER BY `Order`", tableName, elevated)))
348+
using (View view = db.OpenView(string.Format("SELECT `Id`, `File`, `Arguments`, `IgnoreErrors`, `Condition` FROM `{0}` WHERE `Elevated` = {1} ORDER BY `Order`", tableName, elevated)))
258349
{
259350
view.Execute();
260351

261352
doc = new XDocument(new XDeclaration("1.0", "utf-16", "yes"), new XElement("r"));
262353

263354
foreach (Record row in view)
264355
{
356+
string condition = row["Condition"]?.ToString();
357+
if (!string.IsNullOrEmpty(condition) && !session.EvaluateCondition(condition))
358+
{
359+
session.Log($"Condition evaluated to false. Skip PS file {row["Id"]?.ToString()}");
360+
continue;
361+
}
362+
265363
var args = session.Format(row["Arguments"].ToString());
266364
var IgnoreErrors = session.Format(row["IgnoreErrors"].ToString());
267365

@@ -356,9 +454,9 @@ private static ActionResult FilesDeferred(Session session, string deferredProper
356454
foreach (XElement row in doc.Root.Elements("d"))
357455
{
358456
string file = row.Attribute("file").Value;
359-
360457
string arguments = row.Attribute("args").Value;
361458
string IgnoreErrors = row.Attribute("IgnoreErrors").Value;
459+
session.Log($"Executing PowerShell file: '{file}' {arguments}");
362460

363461
using (var task = new PowerShellTask(file, arguments, session))
364462
{

‎PowerShellLibrary/Library.wxs‎

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@
1515
Impersonate="yes"
1616
Execute="deferred"
1717
Return="check" />
18+
19+
<CustomAction Id="PowerShellScriptsUninstall"
20+
BinaryKey="CA_DLL"
21+
DllEntry="PowerShellScriptsUninstall"
22+
Execute="immediate"
23+
Return="check" />
24+
25+
<CustomAction Id="PowerShellScriptsUninstallDeferred"
26+
BinaryKey="CA_DLL"
27+
DllEntry="PowerShellScriptsUninstallDeferred"
28+
Impersonate="yes"
29+
Execute="deferred"
30+
Return="check" />
1831

1932
<CustomAction Id="PowerShellScriptsElevatedImmediate"
2033
BinaryKey="CA_DLL"
@@ -29,6 +42,19 @@
2942
Execute="deferred"
3043
Return="check" />
3144

45+
<CustomAction Id="PowerShellScriptsElevatedUninstall"
46+
BinaryKey="CA_DLL"
47+
DllEntry="PowerShellScriptsElevatedUninstall"
48+
Execute="immediate"
49+
Return="check" />
50+
51+
<CustomAction Id="PowerShellScriptsElevatedUninstallDeferred"
52+
BinaryKey="CA_DLL"
53+
DllEntry="PowerShellScriptsElevatedUninstallDeferred"
54+
Impersonate="no"
55+
Execute="deferred"
56+
Return="check" />
57+
3258
<CustomAction Id="PowerShellFilesImmediate"
3359
BinaryKey="CA_DLL"
3460
DllEntry="PowerShellFilesImmediate"
@@ -42,6 +68,19 @@
4268
Execute="deferred"
4369
Return="check" />
4470

71+
<CustomAction Id="PowerShellFilesUninstall"
72+
BinaryKey="CA_DLL"
73+
DllEntry="PowerShellFilesUninstall"
74+
Execute="immediate"
75+
Return="check" />
76+
77+
<CustomAction Id="PowerShellFilesUninstallDeferred"
78+
BinaryKey="CA_DLL"
79+
DllEntry="PowerShellFilesUninstallDeferred"
80+
Impersonate="yes"
81+
Execute="deferred"
82+
Return="check" />
83+
4584
<CustomAction Id="PowerShellFilesElevatedImmediate"
4685
BinaryKey="CA_DLL"
4786
DllEntry="PowerShellFilesElevatedImmediate"
@@ -55,6 +94,19 @@
5594
Execute="deferred"
5695
Return="check" />
5796

97+
<CustomAction Id="PowerShellFilesElevatedUninstall"
98+
BinaryKey="CA_DLL"
99+
DllEntry="PowerShellFilesElevatedUninstall"
100+
Execute="immediate"
101+
Return="check" />
102+
103+
<CustomAction Id="PowerShellFilesElevatedUninstallDeferred"
104+
BinaryKey="CA_DLL"
105+
DllEntry="PowerShellFilesElevatedUninstallDeferred"
106+
Impersonate="no"
107+
Execute="deferred"
108+
Return="check" />
109+
58110
<InstallExecuteSequence>
59111
<!-- These are the 'immediate' actions that prep the data for the 'deferred' actions-->
60112
<Custom Action="PowerShellScriptsImmediate" Before="PowerShellScriptsDeferred" Overridable="yes">NOT Installed</Custom>
@@ -74,13 +126,35 @@
74126

75127
<Custom Action="PowerShellFilesElevatedDeferred" After="InstallFiles" Overridable="yes">NOT Installed</Custom>
76128

129+
<!-- 'Uninstall immediate' actions -->
130+
<Custom Action="PowerShellScriptsUninstall" Before="PowerShellScriptsUninstallDeferred" Overridable="yes">REMOVE="ALL"</Custom>
131+
132+
<Custom Action="PowerShellScriptsElevatedUninstall" Before="PowerShellScriptsElevatedUninstallDeferred" Overridable="yes">REMOVE="ALL"</Custom>
133+
134+
<Custom Action="PowerShellFilesUninstall" Before="PowerShellFilesUninstallDeferred" Overridable="yes">REMOVE="ALL"</Custom>
135+
136+
<Custom Action="PowerShellFilesElevatedUninstall" Before="PowerShellFilesElevatedUninstallDeferred" Overridable="yes">REMOVE="ALL"</Custom>
137+
138+
<!-- 'Uninstall deferred' actions -->
139+
<Custom Action="PowerShellScriptsUninstallDeferred" After="RemoveFiles" Overridable="yes">REMOVE="ALL"</Custom>
140+
141+
<Custom Action="PowerShellScriptsElevatedUninstallDeferred" After="RemoveFiles" Overridable="yes">REMOVE="ALL"</Custom>
142+
143+
<Custom Action="PowerShellFilesUninstallDeferred" After="RemoveFiles" Overridable="yes">REMOVE="ALL"</Custom>
144+
145+
<Custom Action="PowerShellFilesElevatedUninstallDeferred" After="RemoveFiles" Overridable="yes">REMOVE="ALL"</Custom>
77146
</InstallExecuteSequence>
78147

79148
<UI>
80149
<ProgressText Action="PowerShellFilesDeferred">PowerShell Files</ProgressText>
81150
<ProgressText Action="PowerShellScriptsDeferred">PowerShell Inline</ProgressText>
82151
<ProgressText Action="PowerShellScriptsElevatedDeferred">PowerShell Inline (elevated)</ProgressText>
83152
<ProgressText Action="PowerShellFilesElevatedDeferred">PowerShell Files (elevated)</ProgressText>
84-
</UI>
153+
154+
<ProgressText Action="PowerShellFilesUninstallDeferred">PowerShell Uninstall Files</ProgressText>
155+
<ProgressText Action="PowerShellScriptsUninstallDeferred">PowerShell Uninstall Inline</ProgressText>
156+
<ProgressText Action="PowerShellScriptsElevatedUninstallDeferred">PowerShell Uninstall Inline (elevated)</ProgressText>
157+
<ProgressText Action="PowerShellFilesElevatedUninstallDeferred">PowerShell Uninstall Files (elevated)</ProgressText>
158+
</UI>
85159
</Fragment>
86160
</Wix>

‎PowerShellWixExtension/PowerShellCompilerExtension.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ private void ParseFileElement(XmlNode node)
5959
string superElementId = null;
6060
string file = null;
6161
string arguments = null;
62+
string condition = null;
6263
var elevated = YesNoType.No;
6364
YesNoType ignoreErrors = YesNoType.No;
6465
int order = 1000000000 + sourceLineNumber[0].LineNumber;
@@ -88,6 +89,9 @@ private void ParseFileElement(XmlNode node)
8889
case "Order":
8990
order = Core.GetAttributeIntegerValue(sourceLineNumber, attribute, 0, 1000000000);
9091
break;
92+
case "Condition":
93+
condition = Core.GetAttributeValue(sourceLineNumber, attribute);
94+
break;
9195
default:
9296
Core.UnexpectedAttribute(sourceLineNumber, attribute);
9397
break;
@@ -121,6 +125,7 @@ private void ParseFileElement(XmlNode node)
121125
superElementRow[3] = elevated == YesNoType.Yes ? 1 : 0;
122126
superElementRow[4] = (ignoreErrors == YesNoType.Yes) ? 1 : 0;
123127
superElementRow[5] = order;
128+
superElementRow[6] = condition;
124129
}
125130

126131
Core.CreateWixSimpleReferenceRow(sourceLineNumber, "CustomAction", "PowerShellFilesImmediate");
@@ -132,6 +137,7 @@ private void ParseScriptElement(XmlNode node)
132137

133138
string superElementId = null;
134139
string scriptData = null;
140+
string condition = null;
135141
var elevated = YesNoType.No;
136142
YesNoType ignoreErrors = YesNoType.No;
137143
int order = 1000000000 + sourceLineNumber[0].LineNumber;
@@ -155,6 +161,9 @@ private void ParseScriptElement(XmlNode node)
155161
case "Order":
156162
order = Core.GetAttributeIntegerValue(sourceLineNumber, attribute, 0, 1000000000);
157163
break;
164+
case "Condition":
165+
condition = Core.GetAttributeValue(sourceLineNumber, attribute);
166+
break;
158167

159168
default:
160169
Core.UnexpectedAttribute(sourceLineNumber, attribute);
@@ -196,6 +205,7 @@ private void ParseScriptElement(XmlNode node)
196205
superElementRow[2] = elevated == YesNoType.Yes ? 1 : 0;
197206
superElementRow[3] = (ignoreErrors == YesNoType.Yes) ? 1 : 0;
198207
superElementRow[4] = order;
208+
superElementRow[5] = condition;
199209
}
200210

201211
Core.CreateWixSimpleReferenceRow(sourceLineNumber, "CustomAction", "PowerShellScriptsImmediate");

0 commit comments

Comments
 (0)