/* * Copyright (c) 2024 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.Reflection; using System.Collections.Generic; using System.Text.RegularExpressions; using System.Runtime.CompilerServices; using VNLib.Utils.Logging; using VNLib.Utils.Resources; using VNLib.Plugins.Essentials.Runtime; namespace VNLib.Plugins.Extensions.Loading.Routing { /// /// Provides advanced QOL features to plugin loading /// public static partial class RoutingExtensions { private static readonly ConditionalWeakTable _pluginRefs = new(); private static readonly ConditionalWeakTable _pluginEndpoints = new(); /// /// Constructs and routes the specific endpoint type for the current plugin /// /// The type /// /// public static T Route(this PluginBase plugin) where T : IEndpoint { //Create the endpoint service, then route it T endpoint = plugin.CreateService(); //Route the endpoint Route(plugin, endpoint); //Store ref to plugin for endpoint _pluginRefs.Add(endpoint, plugin); //Function that initalizes the endpoint's path and logging variables InitEndpointSettings(plugin, endpoint); return endpoint; } /// /// Routes a single endpoint for the current plugin and exports the collection to the /// service pool /// /// /// The endpoint to add to the collection public static void Route(this PluginBase plugin, IEndpoint endpoint) { /* * Export the new collection to the service pool in the constructor * function to ensure it's only export once per plugin */ static EndpointCollection OnCreate(PluginBase plugin) { EndpointCollection collection = new(); plugin.ExportService(collection); return collection; } //Get the endpoint collection for the current plugin EndpointCollection endpoints = _pluginEndpoints.GetValue(plugin, OnCreate); //Add the endpoint to the collection endpoints.Endpoints.Add(endpoint); } /// /// Gets the plugin that loaded the current endpoint /// /// /// The plugin that loaded the current endpoint /// 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 readonly Regex ConfigSyntaxParser = ParserRegex(); private delegate void InitFunc(string path, ILogProvider log); [GeneratedRegex("{{(.*?)}}", RegexOptions.Compiled)] private static partial Regex ParserRegex(); private static void InitEndpointSettings(PluginBase plugin, T endpoint) where T : IEndpoint { //Load optional config IConfigScope? config = plugin.TryGetConfigForType(); EndpointPathAttribute? pathAttr = typeof(T).GetCustomAttribute(); /* * gets the protected function for assigning the endpoint path * and logger instance. */ InitFunc? initPathAndLog = ManagedLibrary.TryGetMethod(endpoint, "InitPathAndLog", BindingFlags.NonPublic); if (pathAttr is null || initPathAndLog is null) { return; } ILogProvider logger = ConfigureLogger(plugin, config); try { //Invoke init function and pass in variable names initPathAndLog( path: SubsituteConfigStringValue(pathAttr.Path, config), logger ); } catch (ConfigurationException) { throw; } catch(Exception e) { throw new ConfigurationException($"Failed to initalize endpoint {endpoint.GetType().Name}", e); } } internal static string SubsituteConfigStringValue(string pathVar, IConfigScope? config) { if (config is null) { return pathVar; } // Replace the matched pattern with the corresponding value from the dictionary return ConfigSyntaxParser.Replace(pathVar, match => { string varName = match.Groups[1].Value; //Get the value from the config scope or return the original variable unmodified return config.GetValueOrDefault(varName, varName); }); } internal static ILogProvider ConfigureLogger(PluginBase plugin, IConfigScope? config) { ILogProvider logger = plugin.Log; string? logName = typeof(T).GetCustomAttribute()?.LogName; if (!string.IsNullOrWhiteSpace(logName)) { logger = plugin.Log.CreateScope(SubsituteConfigStringValue(logName, config)); } return logger; } private sealed class EndpointCollection : IVirtualEndpointDefinition { public List Endpoints { get; } = []; /// IEnumerable IVirtualEndpointDefinition.GetEndpoints() => Endpoints; } } }