-
Notifications
You must be signed in to change notification settings - Fork 158
/
KitManager.cs
312 lines (266 loc) · 8.02 KB
/
KitManager.cs
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
#nullable enable
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using Speckle.Core.Helpers;
using Speckle.Core.Logging;
using Speckle.Core.Models;
namespace Speckle.Core.Kits;
public static class KitManager
{
private static string? _kitsFolder;
public static readonly AssemblyName SpeckleAssemblyName = typeof(Base).GetTypeInfo().Assembly.GetName();
private static Dictionary<string, ISpeckleKit> _SpeckleKits = new();
private static List<Type> _AvailableTypes = new();
private static bool _initialized;
/// <summary>
/// Local installations store kits in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits
/// Admin/System-wide installations in C:\ProgramData\Speckle\Kits
/// </summary>
public static string KitsFolder
{
get => _kitsFolder ??= SpecklePathProvider.KitsFolderPath;
set => _kitsFolder = value;
}
/// <summary>
/// Returns a list of all the kits found on this user's device.
/// </summary>
public static IEnumerable<ISpeckleKit> Kits
{
get
{
Initialize();
return _SpeckleKits.Values.Where(v => v != null); //NOTE: null check here should be unnecessary
}
}
/// <summary>
/// Returns a list of all the types found in all the kits on this user's device.
/// </summary>
public static IEnumerable<Type> Types
{
get
{
Initialize();
return _AvailableTypes;
}
}
/// <summary>
/// Checks whether a specific kit exists.
/// </summary>
/// <param name="assemblyFullName"></param>
/// <returns></returns>
public static bool HasKit(string assemblyFullName)
{
Initialize();
return _SpeckleKits.ContainsKey(assemblyFullName);
}
/// <summary>
/// Gets a specific kit.
/// </summary>
/// <param name="assemblyFullName"></param>
/// <returns></returns>
public static ISpeckleKit GetKit(string assemblyFullName)
{
Initialize();
return _SpeckleKits[assemblyFullName];
}
/// <summary>
/// Gets the default Speckle provided kit, "Objects".
/// </summary>
/// <returns></returns>
public static ISpeckleKit GetDefaultKit()
{
Initialize();
return _SpeckleKits.First(kvp => kvp.Value.Name == "Objects").Value;
}
/// <summary>
/// Returns all the kits with potential converters for the software app.
/// </summary>
/// <param name="app"></param>
/// <returns></returns>
public static IEnumerable<ISpeckleKit> GetKitsWithConvertersForApp(string app)
{
foreach (var kit in Kits)
if (kit.Converters.Contains(app))
yield return kit;
}
/// <summary>
/// Tells the kit manager to initialise from a specific location.
/// </summary>
/// <param name="kitFolderLocation"></param>
public static void Initialize(string kitFolderLocation)
{
if (_initialized)
{
SpeckleLog.Logger.Error("{objectType} is already initialised", typeof(KitManager));
throw new SpeckleException(
"The kit manager has already been initialised. Make sure you call this method earlier in your code!"
);
}
KitsFolder = kitFolderLocation;
Load();
_initialized = true;
}
#region Private Methods
private static void Initialize()
{
if (!_initialized)
{
Load();
_initialized = true;
}
}
private static void Load()
{
SpeckleLog.Logger.Information("Initializing Kit Manager in {KitsFolder}", SpecklePathProvider.KitsFolderPath);
GetLoadedSpeckleReferencingAssemblies();
LoadSpeckleReferencingAssemblies();
_AvailableTypes = _SpeckleKits
.Where(kit => kit.Value != null) //Null check should be unnecessary
.SelectMany(kit => kit.Value.Types)
.ToList();
}
// recursive search for referenced assemblies
public static List<Assembly> GetReferencedAssemblies()
{
var returnAssemblies = new List<Assembly>();
var loadedAssemblies = new HashSet<string>();
var assembliesToCheck = new Queue<Assembly?>();
assembliesToCheck.Enqueue(Assembly.GetEntryAssembly());
while (assembliesToCheck.Count > 0)
{
var assemblyToCheck = assembliesToCheck.Dequeue();
if (assemblyToCheck == null)
continue;
foreach (var reference in assemblyToCheck.GetReferencedAssemblies())
{
// filtering out system dlls
if (reference.FullName.StartsWith("System."))
continue;
if (reference.FullName.StartsWith("Microsoft."))
continue;
if (loadedAssemblies.Contains(reference.FullName))
continue;
Assembly assembly;
try
{
assembly = Assembly.Load(reference);
}
catch
{
continue;
}
assembliesToCheck.Enqueue(assembly);
loadedAssemblies.Add(reference.FullName);
returnAssemblies.Add(assembly);
}
}
return returnAssemblies;
}
private static void GetLoadedSpeckleReferencingAssemblies()
{
List<Assembly> assemblies = AppDomain.CurrentDomain.GetAssemblies().ToList();
assemblies.AddRange(GetReferencedAssemblies());
foreach (var assembly in assemblies)
{
if (assembly.IsDynamic || assembly.ReflectionOnly)
continue;
if (!assembly.IsReferencing(SpeckleAssemblyName))
continue;
if (_SpeckleKits.ContainsKey(assembly.FullName))
continue;
var kitClass = GetKitClass(assembly);
if (kitClass == null)
continue;
if (Activator.CreateInstance(kitClass) is ISpeckleKit speckleKit)
_SpeckleKits.Add(assembly.FullName, speckleKit);
}
}
private static void LoadSpeckleReferencingAssemblies()
{
if (!Directory.Exists(KitsFolder))
return;
var directories = Directory.GetDirectories(KitsFolder);
foreach (var directory in directories)
{
foreach (var assemblyPath in Directory.EnumerateFiles(directory, "*.dll"))
{
var unloadedAssemblyName = SafeGetAssemblyName(assemblyPath);
if (unloadedAssemblyName == null)
continue;
try
{
var assembly = Assembly.LoadFrom(assemblyPath);
var kitClass = GetKitClass(assembly);
if (assembly.IsReferencing(SpeckleAssemblyName) && kitClass != null)
if (!_SpeckleKits.ContainsKey(assembly.FullName))
if (Activator.CreateInstance(kitClass) is ISpeckleKit speckleKit)
_SpeckleKits.Add(assembly.FullName, speckleKit);
}
catch (FileLoadException ex) { }
catch (BadImageFormatException ex) { }
}
}
}
private static Type? GetKitClass(Assembly assembly)
{
try
{
var kitClass = assembly
.GetTypes()
.FirstOrDefault(type =>
{
return type.GetInterfaces().Any(iface => iface.Name == nameof(ISpeckleKit));
});
return kitClass;
}
catch
{
// this will be a ReflectionTypeLoadException and is expected. we don't need to care!
return null;
}
}
private static Assembly? SafeLoadAssembly(AppDomain domain, AssemblyName assemblyName)
{
try
{
return domain.Load(assemblyName);
}
catch
{
return null;
}
}
private static AssemblyName? SafeGetAssemblyName(string assemblyPath)
{
try
{
return AssemblyName.GetAssemblyName(assemblyPath);
}
catch
{
return null;
}
}
#endregion
}
public static class AssemblyExtensions
{
/// <summary>
/// Indicates if a given assembly references another which is identified by its name.
/// </summary>
/// <param name="assembly">The assembly which will be probed.</param>
/// <param name="referenceName">The reference assembly name.</param>
/// <returns>A boolean value indicating if there is a reference.</returns>
public static bool IsReferencing(this Assembly assembly, AssemblyName referenceName)
{
if (AssemblyName.ReferenceMatchesDefinition(assembly.GetName(), referenceName))
return true;
foreach (var referencedAssemblyName in assembly.GetReferencedAssemblies())
if (AssemblyName.ReferenceMatchesDefinition(referencedAssemblyName, referenceName))
return true;
return false;
}
}