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
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: RoutingExtensions.cs
*
* RoutingExtensions.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Linq;
using System.Reflection;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using VNLib.Plugins.Extensions.Loading.Events;
namespace VNLib.Plugins.Extensions.Loading.Routing
{
/// <summary>
/// Provides advanced QOL features to plugin loading
/// </summary>
public static class RoutingExtensions
{
private static readonly ConditionalWeakTable<IEndpoint, PluginBase?> _pluginRefs = new();
/// <summary>
/// Constructs and routes the specific endpoint type for the current plugin
/// </summary>
/// <typeparam name="T">The <see cref="IEndpoint"/> type</typeparam>
/// <param name="plugin"></param>
/// <param name="configRequired">If true, requires the configuration exist in the config file</param>
/// <param name="pluginConfigPathName">The path to the plugin sepcific configuration property</param>
/// <exception cref="TargetInvocationException"></exception>
public static T Route<T>(this PluginBase plugin, string? pluginConfigPathName, bool configRequired = true) where T : IEndpoint
{
Type endpointType = typeof(T);
T endpoint;
//If the config attribute is not set, then ignore the config variables
if (string.IsNullOrWhiteSpace(pluginConfigPathName))
{
ConstructorInfo? constructor = endpointType.GetConstructor(new Type[] { typeof(PluginBase) });
_ = constructor ?? throw new EntryPointNotFoundException($"No constructor t(PluginBase p) found for {endpointType.Name}");
//Create the new endpoint and pass the plugin instance
endpoint = (T)constructor.Invoke(new object[] { plugin });
//Register event handlers for the endpoint
ScheduleIntervals(plugin, endpoint, endpointType, null);
}
else
{
//Try to get config but allow null if not required
IConfigScope? config = plugin.TryGetConfig(pluginConfigPathName);
if(configRequired && config == null)
{
ConfigurationExtensions.ThrowConfigNotFoundForType(endpointType);
return default;
}
//Choose constructor based on config
if (config != null)
{
ConstructorInfo? constructor = endpointType.GetConstructor(new Type[] { typeof(PluginBase), typeof(IConfigScope) });
//Make sure the constructor exists
_ = constructor ?? throw new EntryPointNotFoundException($"No constructor t(PluginBase p, IConfigScope cs) found for {endpointType.Name}");
//Create the new endpoint and pass the plugin instance along with the configuration object
endpoint = (T)constructor.Invoke(new object[] { plugin, config });
//Register event handlers for the endpoint
ScheduleIntervals(plugin, endpoint, endpointType, config);
}
else
{
//Config does not exist, so use the default constructor
ConstructorInfo? constructor = endpointType.GetConstructor(new Type[] { typeof(PluginBase) });
_ = constructor ?? throw new EntryPointNotFoundException($"No constructor t(PluginBase p) found for {endpointType.Name}");
//Create the new endpoint and pass the plugin instance
endpoint = (T)constructor.Invoke(new object[] { plugin });
//Register event handlers for the endpoint
ScheduleIntervals(plugin, endpoint, endpointType, null);
}
}
//Route the endpoint
plugin.Route(endpoint);
//Store ref to plugin for endpoint
_pluginRefs.Add(endpoint, plugin);
//See if the endpoint is disposable
if (endpoint is IDisposable dis)
{
//Register dispose for unload
_ = plugin.RegisterForUnload(dis.Dispose);
}
return endpoint;
}
/// <summary>
/// Constructs and routes the specific endpoint type for the current plugin
/// </summary>
/// <typeparam name="T">The <see cref="IEndpoint"/> type</typeparam>
/// <param name="plugin"></param>
/// <exception cref="TargetInvocationException"></exception>
public static T Route<T>(this PluginBase plugin) where T : IEndpoint
{
Type endpointType = typeof(T);
//Get config name attribute
ConfigurationNameAttribute? configAttr = endpointType.GetCustomAttribute<ConfigurationNameAttribute>();
//Route using attribute
return plugin.Route<T>(configAttr?.ConfigVarName, configAttr?.Required == true);
}
/// <summary>
/// Gets the plugin that loaded the current endpoint
/// </summary>
/// <param name="ep"></param>
/// <returns>The plugin that loaded the current endpoint</returns>
/// <exception cref="InvalidOperationException"></exception>
public static PluginBase GetPlugin(this IEndpoint ep)
{
_ = _pluginRefs.TryGetValue(ep, out PluginBase? pBase);
return pBase ?? throw new InvalidOperationException("Endpoint was not dynamically routed");
}
private static void ScheduleIntervals<T>(PluginBase plugin, T endpointInstance, Type epType, IConfigScope? endpointLocalConfig) where T : IEndpoint
{
//Get all methods that have the configurable async interval attribute specified
IEnumerable<Tuple<ConfigurableAsyncIntervalAttribute, AsyncSchedulableCallback>> confIntervals = epType.GetMethods()
.Where(m => m.GetCustomAttribute<ConfigurableAsyncIntervalAttribute>() != null)
.Select(m => new Tuple<ConfigurableAsyncIntervalAttribute, AsyncSchedulableCallback>
(m.GetCustomAttribute<ConfigurableAsyncIntervalAttribute>()!, m.CreateDelegate<AsyncSchedulableCallback>(endpointInstance)));
//If the endpoint has a local config, then use it to find the interval
if (endpointLocalConfig != null)
{
//Schedule event handlers on the current plugin
foreach (Tuple<ConfigurableAsyncIntervalAttribute, AsyncSchedulableCallback> interval in confIntervals)
{
int value = endpointLocalConfig[interval.Item1.IntervalPropertyName].GetInt32();
//Get the timeout from its resolution variable
TimeSpan timeout = interval.Item1.Resolution switch
{
IntervalResultionType.Seconds => TimeSpan.FromSeconds(value),
IntervalResultionType.Minutes => TimeSpan.FromMinutes(value),
IntervalResultionType.Hours => TimeSpan.FromHours(value),
_ => TimeSpan.FromMilliseconds(value),
};
//Schedule
plugin.ScheduleInterval(interval.Item2, timeout);
}
}
//Get all methods that have the async interval attribute specified
IEnumerable<Tuple<AsyncIntervalAttribute, AsyncSchedulableCallback>> intervals = epType.GetMethods()
.Where(m => m.GetCustomAttribute<AsyncIntervalAttribute>() != null)
.Select(m => new Tuple<AsyncIntervalAttribute, AsyncSchedulableCallback>(
m.GetCustomAttribute<AsyncIntervalAttribute>()!, m.CreateDelegate<AsyncSchedulableCallback>(endpointInstance))
);
//Schedule event handlers on the current plugin
foreach (Tuple<AsyncIntervalAttribute, AsyncSchedulableCallback> interval in intervals)
{
plugin.ScheduleInterval(interval.Item2, interval.Item1.Interval);
}
}
}
}
|
