1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
namespace WixToolset.Extensibility
{
using System;
using System.IO;
using System.Reflection;
using WixToolset.Data;
using WixToolset.Tools;
/// <summary>
/// A command line option.
/// </summary>
public struct HeatCommandLineOption
{
public string Option;
public string Description;
/// <summary>
/// Instantiates a new CommandLineOption.
/// </summary>
/// <param name="option">The option name.</param>
/// <param name="description">The description of the option.</param>
public HeatCommandLineOption(string option, string description)
{
this.Option = option;
this.Description = description;
}
}
/// <summary>
/// An extension for the WiX Toolset Harvester application.
/// </summary>
public abstract class HeatExtension
{
/// <summary>
/// Gets or sets the heat core for the extension.
/// </summary>
/// <value>The heat core for the extension.</value>
public IHeatCore Core { get; set; }
/// <summary>
/// Gets the supported command line types for this extension.
/// </summary>
/// <value>The supported command line types for this extension.</value>
public virtual HeatCommandLineOption[] CommandLineTypes
{
get { return null; }
}
/// <summary>
/// Loads a HeatExtension from a type description string.
/// </summary>
/// <param name="extension">The extension type description string.</param>
/// <returns>The loaded HeatExtension.</returns>
/// <remarks>
/// <paramref name="extension"/> can be in several different forms:
/// <list type="number">
/// <item><term>AssemblyQualifiedName (TopNamespace.SubNameSpace.ContainingClass+NestedClass, MyAssembly, Version=1.3.0.0, Culture=neutral, PublicKeyToken=b17a5c561934e089)</term></item>
/// <item><term>AssemblyName (MyAssembly, Version=1.3.0.0, Culture=neutral, PublicKeyToken=b17a5c561934e089)</term></item>
/// <item><term>Absolute path to an assembly (C:\MyExtensions\ExtensionAssembly.dll)</term></item>
/// <item><term>Filename of an assembly in the application directory (ExtensionAssembly.dll)</term></item>
/// <item><term>Relative path to an assembly (..\..\MyExtensions\ExtensionAssembly.dll)</term></item>
/// </list>
/// To specify a particular class to use, prefix the fully qualified class name to the assembly and separate them with a comma.
/// For example: "TopNamespace.SubNameSpace.ContainingClass+NestedClass, C:\MyExtensions\ExtensionAssembly.dll"
/// </remarks>
public static HeatExtension Load(string extension)
{
Type extensionType = null;
int commaIndex = extension.IndexOf(',');
string className = String.Empty;
string assemblyName = extension;
if (0 <= commaIndex)
{
className = extension.Substring(0, commaIndex);
assemblyName = (extension.Length <= commaIndex + 1 ? String.Empty : extension.Substring(commaIndex + 1));
}
className = className.Trim();
assemblyName = assemblyName.Trim();
if (null == extensionType && 0 < assemblyName.Length)
{
Assembly extensionAssembly;
// case 3: Absolute path to an assembly
if (Path.IsPathRooted(assemblyName))
{
extensionAssembly = ExtensionLoadFrom(assemblyName);
}
else
{
try
{
// case 2: AssemblyName
extensionAssembly = Assembly.Load(assemblyName);
}
catch (IOException e)
{
if (e is FileLoadException || e is FileNotFoundException)
{
try
{
// case 4: Filename of an assembly in the application directory
extensionAssembly = Assembly.Load(Path.GetFileNameWithoutExtension(assemblyName));
}
catch (IOException innerE)
{
if (innerE is FileLoadException || innerE is FileNotFoundException)
{
// case 5: Relative path to an assembly
// we want to use Assembly.Load when we can because it has some benefits over Assembly.LoadFrom
// (see the documentation for Assembly.LoadFrom). However, it may fail when the path is a relative
// path, so we should try Assembly.LoadFrom one last time. We could have detected a directory
// separator character and used Assembly.LoadFrom directly, but dealing with path canonicalization
// issues is something we don't want to deal with if we don't have to.
extensionAssembly = ExtensionLoadFrom(assemblyName);
}
else
{
throw new WixException(WixErrors.InvalidExtension(assemblyName, innerE.Message));
}
}
}
else
{
throw new WixException(WixErrors.InvalidExtension(assemblyName, e.Message));
}
}
}
if (0 < className.Length)
{
try
{
// case 1: AssemblyQualifiedName
extensionType = extensionAssembly.GetType(className, true /* throwOnError */, true /* ignoreCase */);
}
catch (Exception e)
{
throw new WixException(WixErrors.InvalidExtensionType(assemblyName, className, e.GetType().ToString(), e.Message));
}
}
else
{
// if no class name was specified, then let's hope the assembly defined a default WixExtension
AssemblyDefaultHeatExtensionAttribute extensionAttribute = (AssemblyDefaultHeatExtensionAttribute)Attribute.GetCustomAttribute(extensionAssembly, typeof(AssemblyDefaultHeatExtensionAttribute));
if (null != extensionAttribute)
{
extensionType = extensionAttribute.ExtensionType;
}
else
{
throw new WixException(WixErrors.InvalidExtensionType(assemblyName, typeof(AssemblyDefaultHeatExtensionAttribute).ToString()));
}
}
}
if (extensionType.IsSubclassOf(typeof(HeatExtension)))
{
return Activator.CreateInstance(extensionType) as HeatExtension;
}
else
{
throw new WixException(WixErrors.InvalidExtensionType(extension, extensionType.ToString(), typeof(HeatExtension).ToString()));
}
}
/// <summary>
/// Parse the command line options for this extension.
/// </summary>
/// <param name="type">The active harvester type.</param>
/// <param name="args">The option arguments.</param>
public virtual void ParseOptions(string type, string[] args)
{
}
private static Assembly ExtensionLoadFrom(string assemblyName)
{
Assembly extensionAssembly = null;
try
{
extensionAssembly = Assembly.LoadFrom(assemblyName);
}
catch (Exception e)
{
throw new WixException(WixErrors.InvalidExtension(assemblyName, e.Message));
}
return extensionAssembly;
}
}
}
|
