diff options
Diffstat (limited to 'lib/Plugins.Runtime')
| -rw-r--r-- | lib/Plugins.Runtime/LICENSE.txt | 346 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/README.md | 53 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/src/LivePlugin.cs | 220 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/src/LoaderExtensions.cs | 120 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/src/PluginUnloadExcpetion.cs | 46 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/src/RuntimePluginLoader.cs | 250 | ||||
| -rw-r--r-- | lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj | 47 |
7 files changed, 1082 insertions, 0 deletions
diff --git a/lib/Plugins.Runtime/LICENSE.txt b/lib/Plugins.Runtime/LICENSE.txt new file mode 100644 index 0000000..2848520 --- /dev/null +++ b/lib/Plugins.Runtime/LICENSE.txt @@ -0,0 +1,346 @@ +The software in this repository is licensed under the GNU GPL version 2.0 (or any later version). + +SPDX-License-Identifier: GPL-2.0-or-later + +License-Text: + +GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + VNLib.Hashing.Portable is a compact .NET managed cryptographic operation + utilities library. + Copyright (C) 2022 Vaughn Nugent + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License.
\ No newline at end of file diff --git a/lib/Plugins.Runtime/README.md b/lib/Plugins.Runtime/README.md new file mode 100644 index 0000000..1146c9b --- /dev/null +++ b/lib/Plugins.Runtime/README.md @@ -0,0 +1,53 @@ +# VNLib.Plugins.Runtime + +A library that manages the runtime loading/unloading of a managed .NET assembly that exposes one or more types that implement the VNLib.Plugins.IPlugin interface, and the plugins lifecycle. The `DynamicPluginLoader` class also handles "hot" assembly reload and exposes lifecycle hooks for applications to correctly detect those changes. + +### 3rd Party Dependencies +This library does not, modify, contribute, or affect the functionality of any of the 3rd party libraries below. + +**VNLib.Plugins.Runtime** relies on a single 3rd party library [McMaster.NETCore.Plugins](https://github.com/natemcmaster/DotNetCorePlugins) from [Nate McMaster](https://github.com/natemcmaster) for runtime assembly loading. You must include this dependency in your project. + +## Usage +An XML documentation file is included for all public apis. + +```programming language C# + //RuntimePluginLoader is disposable to cleanup optional config files and cleanup all PluginLoader resources + using RuntimePluginLoader plugin = new(<fqAssemblyPath>,...<args>); + + //Load assembly, optional config file, capture all IPlugin types, then call IPlugin.Load() and all other lifecycle hooks + await plugin.InitLoaderAsync(); + //Listen for reload events + plugin.Reloaded += (object? loader, EventAargs = null) =>{}; + + //Get all endpoints from all exposed plugins + IEndpoint[] endpoints = plugin.GetEndpoints().ToArray(); + + //Your plugin types may also expose custom types, you may see if they are available + if(plugin.ExposesType<IMyCustomType>()) + { + IMyCustomType mt = plugin.GetExposedTypeFromPlugin<IMyCustomType>(); + } + + //Trigger manual reload, will unload, then reload and trigger events + plugin.ReloadPlugin(); + + //Unload all plugins + plugin.UnloadAll(); + + //Leaving scope disposes the loader +``` +### Warnings +##### Load/Unload/Hot reload +When hot-reload is disabled and manual reloading is not expected, or unloading is also disabled, you not worry about reload events since the assemblies will never be unloaded. If unloading is disabled and `RuntimePluginLoader.UnloadAll()` is called, only the IPlugin lifecycle hooks will be called (`IPlugin.Unload();`), internal collections are cleared, but no other actions take place. + +`RuntimePluginLoader.UnloadAll()` Should only be called when you are no longer using the assembly, and all **IPlugin** instances or custom types. The **VNLib.Plugins.Essentials.ServiceStack** library is careful to remove all instances of the exposed plugins, their endpoints, and all other custom types that were exposed, before calling this method. + +Disposing the **RuntimePluginLoader** does not unload the plugins, but simply disposes any internal resources disposes the internal **PluginLoader**, so it should only be disposed after `RuntimePluginLoader.UnloadAll()` is called. + +_Please see [McMaster.NETCore.Plugins](https://github.com/natemcmaster/DotNetCorePlugins) for more information on runtime .NET assembly loading and the dangers of doing so_ + +**Hot reload should only be enabled for debugging/development purposes, you should understand the security implications and compatibility of .NET collectable assemblies** + +## License +The software in this repository is licensed under the GNU GPL version 2.0 (or any later version). +See the LICENSE files for more information. diff --git a/lib/Plugins.Runtime/src/LivePlugin.cs b/lib/Plugins.Runtime/src/LivePlugin.cs new file mode 100644 index 0000000..c0011dd --- /dev/null +++ b/lib/Plugins.Runtime/src/LivePlugin.cs @@ -0,0 +1,220 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Runtime +* File: LivePlugin.cs +* +* LivePlugin.cs is part of VNLib.Plugins.Runtime which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Runtime is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins.Runtime 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 +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins.Runtime. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Linq; +using System.Reflection; +using System.Text.Json; + +using VNLib.Utils.Logging; +using VNLib.Utils.Extensions; +using VNLib.Plugins.Attributes; + +namespace VNLib.Plugins.Runtime +{ + /// <summary> + /// <para> + /// Wrapper for a loaded <see cref="IPlugin"/> instance, used internally + /// for a single instance. + /// </para> + /// <para> + /// Lifetime: for the existance of a single loaded + /// plugin instance. Created once per loaded plugin instance. Once the plugin + /// is unloaded, it is no longer useable. + /// </para> + /// </summary> + public class LivePlugin : IEquatable<IPlugin>, IEquatable<LivePlugin> + { + /// <summary> + /// The plugin's <see cref="IPlugin.PluginName"/> property during load time + /// </summary> + /// <exception cref="InvalidOperationException"></exception> + public string PluginName => Plugin?.PluginName ?? throw new InvalidOperationException("Plugin is not loaded"); + + /// <summary> + /// The underlying <see cref="IPlugin"/> that is warpped + /// by he current instance + /// </summary> + public IPlugin? Plugin { get; private set; } + + private readonly Type PluginType; + + private ConsoleEventHandlerSignature? PluginConsoleHandler; + + internal LivePlugin(IPlugin plugin) + { + Plugin = plugin; + PluginType = plugin.GetType(); + GetConsoleHandler(); + } + + private void GetConsoleHandler() + { + //Get the console handler method from the plugin instance + MethodInfo? handler = (from m in PluginType.GetMethods() + where m.GetCustomAttribute<ConsoleEventHandlerAttribute>() != null + select m) + .FirstOrDefault(); + //Get a delegate handler for the plugin + PluginConsoleHandler = handler?.CreateDelegate<ConsoleEventHandlerSignature>(Plugin); + } + + /// <summary> + /// Sets the plugin's configuration if it defines a <see cref="ConfigurationInitalizerAttribute"/> + /// on an instance method + /// </summary> + /// <param name="hostConfig">The host configuration DOM</param> + /// <param name="pluginConf">The plugin local configuration DOM</param> + internal void InitConfig(JsonDocument hostConfig, JsonDocument pluginConf) + { + //Get the console handler method from the plugin instance + MethodInfo? confHan = PluginType.GetMethods().Where(static m => m.GetCustomAttribute<ConfigurationInitalizerAttribute>() != null) + .FirstOrDefault(); + //Get a delegate handler for the plugin + ConfigInitializer? configInit = confHan?.CreateDelegate<ConfigInitializer>(Plugin); + if (configInit == null) + { + return; + } + //Merge configurations before passing to plugin + JsonDocument merged = hostConfig.Merge(pluginConf, "host", PluginType.Name); + try + { + //Invoke + configInit.Invoke(merged); + } + catch + { + merged.Dispose(); + throw; + } + } + + /// <summary> + /// Invokes the plugin's log initalizer method if it defines a <see cref="LogInitializerAttribute"/> + /// on an instance method + /// </summary> + /// <param name="cliArgs">The current process's CLI args</param> + internal void InitLog(string[] cliArgs) + { + //Get the console handler method from the plugin instance + MethodInfo? logInit = (from m in PluginType.GetMethods() + where m.GetCustomAttribute<LogInitializerAttribute>() != null + select m) + .FirstOrDefault(); + //Get a delegate handler for the plugin + LogInitializer? logFunc = logInit?.CreateDelegate<LogInitializer>(Plugin); + //Invoke + logFunc?.Invoke(cliArgs); + } + + /// <summary> + /// Invokes the plugins console event handler if the type has one + /// and the plugin is loaded. + /// </summary> + /// <param name="message">The message to pass to the plugin handler</param> + /// <returns> + /// True if the command was sent to the plugin, false if the plugin is + /// unloaded or did not export a console event handler + /// </returns> + public bool SendConsoleMessage(string message) + { + //Make sure plugin is loaded and has a console handler + if (PluginConsoleHandler == null) + { + return false; + } + //Invoke plugin console handler + PluginConsoleHandler(message); + return true; + } + + /// <summary> + /// Calls the <see cref="IPlugin.Load"/> method on the plugin if its loaded + /// </summary> + internal void LoadPlugin() => Plugin?.Load(); + + /// <summary> + /// Unloads all loaded endpoints from + /// that they were loaded to, then unloads the plugin. + /// </summary> + /// <param name="logSink">An optional log provider to write unload exceptions to</param> + /// <remarks> + /// If <paramref name="logSink"/> is no null unload exceptions are swallowed and written to the log + /// </remarks> + internal void UnloadPlugin(ILogProvider? logSink) + { + /* + * We need to swallow plugin unload errors to avoid + * unknown state, making sure endpoints are properly + * unloaded! + */ + try + { + //Unload the plugin + Plugin?.Unload(); + } + catch (Exception ex) + { + //Create an unload wrapper for the exception + PluginUnloadException wrapper = new("Exception raised during plugin unload", ex); + if (logSink == null) + { + throw wrapper; + } + //Write error to log sink + logSink.Error(wrapper); + } + Plugin = null; + PluginConsoleHandler = null; + } + ///<inheritdoc/> + public override bool Equals(object? obj) + { + Type? pluginType = Plugin?.GetType(); + Type? otherType = obj?.GetType(); + if(pluginType == null || otherType == null) + { + return false; + } + //If the other plugin is the same type as the current instance return true + return pluginType.FullName == otherType.FullName; + } + ///<inheritdoc/> + public bool Equals(LivePlugin? other) + { + return Equals(other?.Plugin); + } + ///<inheritdoc/> + public bool Equals(IPlugin? other) + { + return Equals((object?)other); + } + ///<inheritdoc/> + public override int GetHashCode() + { + return Plugin?.GetHashCode() ?? throw new InvalidOperationException("Plugin is null"); + } + } +} diff --git a/lib/Plugins.Runtime/src/LoaderExtensions.cs b/lib/Plugins.Runtime/src/LoaderExtensions.cs new file mode 100644 index 0000000..795dcf5 --- /dev/null +++ b/lib/Plugins.Runtime/src/LoaderExtensions.cs @@ -0,0 +1,120 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Runtime +* File: LoaderExtensions.cs +* +* LoaderExtensions.cs is part of VNLib.Plugins.Runtime which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Runtime is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins.Runtime 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 +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins.Runtime. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace VNLib.Plugins.Runtime +{ + public static class LoaderExtensions + { + /// <summary> + /// Searches all plugins within the current loader for a + /// single plugin that derrives the specified type + /// </summary> + /// <typeparam name="T">The type the plugin must derrive from</typeparam> + /// <param name="loader"></param> + /// <returns>The instance of the plugin that derrives from the specified type</returns> + public static LivePlugin? GetExposedPlugin<T>(this RuntimePluginLoader loader) + { + return loader.LivePlugins + .Where(static pl => typeof(T).IsAssignableFrom(pl.Plugin!.GetType())) + .SingleOrDefault(); + } + + /// <summary> + /// Searches all plugins within the current loader for a + /// single plugin that derrives the specified type + /// </summary> + /// <typeparam name="T">The type the plugin must derrive from</typeparam> + /// <param name="loader"></param> + /// <returns>The instance of your custom type casted, or null if not found or could not be casted</returns> + public static T? GetExposedTypeFromPlugin<T>(this RuntimePluginLoader loader) where T: class + { + LivePlugin? plugin = loader.LivePlugins + .Where(static pl => typeof(T).IsAssignableFrom(pl.Plugin!.GetType())) + .SingleOrDefault(); + + return plugin?.Plugin as T; + } + + /// <summary> + /// Registers a listener delegate method to invoke when the + /// current <see cref="RuntimePluginLoader"/> is reloaded, and passes + /// the new instance of the specified type + /// </summary> + /// <typeparam name="T">The single plugin type to register a listener for</typeparam> + /// <param name="loader"></param> + /// <param name="reloaded">The delegate method to invoke when the loader has reloaded plugins</param> + /// <exception cref="ArgumentNullException"></exception> + public static bool RegisterListenerForSingle<T>(this RuntimePluginLoader loader, Action<T, T> reloaded) where T: class + { + _ = reloaded ?? throw new ArgumentNullException(nameof(reloaded)); + + //try to get the casted type from the loader + T? current = loader.GetExposedTypeFromPlugin<T>(); + + if (current == null) + { + return false; + } + else + { + loader.Reloaded += delegate (object? sender, EventArgs args) + { + RuntimePluginLoader wpl = (sender as RuntimePluginLoader)!; + //Get the new loaded type + T newT = (wpl.GetExposedPlugin<T>()!.Plugin as T)!; + //Invoke reloaded action + reloaded(current, newT); + //update the new current instance + current = newT; + }; + + return true; + } + } + + /// <summary> + /// Gets all endpoints exposed by all exported plugin instances + /// within the current loader + /// </summary> + /// <param name="loader"></param> + /// <returns>An enumeration of all endpoints</returns> + public static IEnumerable<IEndpoint> GetEndpoints(this RuntimePluginLoader loader) => loader.LivePlugins.SelectMany(static pl => pl.Plugin!.GetEndpoints()); + + /// <summary> + /// Determines if any loaded plugin types exposes an instance of the + /// specified type + /// </summary> + /// <typeparam name="T"></typeparam> + /// <param name="loader"></param> + /// <returns>True if any plugin instance exposes a the specified type, false otherwise</returns> + public static bool ExposesType<T>(this RuntimePluginLoader loader) where T : class + { + return loader.LivePlugins.Any(static pl => typeof(T).IsAssignableFrom(pl.Plugin?.GetType())); + } + } +} diff --git a/lib/Plugins.Runtime/src/PluginUnloadExcpetion.cs b/lib/Plugins.Runtime/src/PluginUnloadExcpetion.cs new file mode 100644 index 0000000..53f63b2 --- /dev/null +++ b/lib/Plugins.Runtime/src/PluginUnloadExcpetion.cs @@ -0,0 +1,46 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Runtime +* File: PluginUnloadExcpetion.cs +* +* PluginUnloadExcpetion.cs is part of VNLib.Plugins.Runtime which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Runtime is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins.Runtime 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 +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins.Runtime. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Runtime.Serialization; + +namespace VNLib.Plugins.Runtime +{ + /// <summary> + /// A wrapper for exceptions that are raised during an + /// assembly plugin unload event. See <see cref="Exception.InnerException"/> + /// for details + /// </summary> + public class PluginUnloadException : Exception + { + public PluginUnloadException() + {} + public PluginUnloadException(string message) : base(message) + {} + public PluginUnloadException(string message, Exception innerException) : base(message, innerException) + {} + protected PluginUnloadException(SerializationInfo info, StreamingContext context) : base(info, context) + {} + } +} diff --git a/lib/Plugins.Runtime/src/RuntimePluginLoader.cs b/lib/Plugins.Runtime/src/RuntimePluginLoader.cs new file mode 100644 index 0000000..c688f8b --- /dev/null +++ b/lib/Plugins.Runtime/src/RuntimePluginLoader.cs @@ -0,0 +1,250 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Runtime +* File: DynamicPluginLoader.cs +* +* DynamicPluginLoader.cs is part of VNLib.Plugins.Runtime which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Runtime is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins.Runtime 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 +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins.Runtime. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.IO; +using System.Linq; +using System.Text.Json; +using System.Reflection; +using System.Runtime.Loader; +using System.Threading.Tasks; +using System.Collections.Generic; + +using McMaster.NETCore.Plugins; + +using VNLib.Utils; +using VNLib.Utils.IO; +using VNLib.Utils.Logging; +using VNLib.Utils.Extensions; + + +namespace VNLib.Plugins.Runtime +{ + /// <summary> + /// A runtime .NET assembly loader specialized to load + /// assemblies that export <see cref="IPlugin"/> types. + /// </summary> + public class RuntimePluginLoader : VnDisposeable + { + protected readonly PluginLoader Loader; + protected readonly string PluginPath; + protected readonly JsonDocument HostConfig; + protected readonly ILogProvider? Log; + protected readonly LinkedList<LivePlugin> LoadedPlugins; + + /// <summary> + /// A readonly collection of all loaded plugin wrappers + /// </summary> + public IReadOnlyCollection<LivePlugin> LivePlugins => LoadedPlugins; + + /// <summary> + /// An event that is raised before the loader + /// unloads all plugin instances + /// </summary> + protected event EventHandler<PluginReloadedEventArgs>? OnBeforeReloaded; + /// <summary> + /// An event that is raised after a successfull reload of all new + /// plugins for the instance + /// </summary> + protected event EventHandler? OnAfterReloaded; + + /// <summary> + /// Raised when the current loader has reloaded the assembly and + /// all plugins were successfully loaded. + /// </summary> + public event EventHandler? Reloaded; + + /// <summary> + /// The current plugin's JSON configuration DOM loaded from the plugin's directory + /// if it exists. Only valid after first initalization + /// </summary> + public JsonDocument? PluginConfigDOM { get; private set; } + /// <summary> + /// Optional loader arguments object for the plugin + /// </summary> + protected JsonElement? LoaderArgs { get; private set; } + + /// <summary> + /// The path of the plugin's configuration file. (Default = pluginPath.json) + /// </summary> + public string PluginConfigPath { get; init; } + /// <summary> + /// Creates a new <see cref="RuntimePluginLoader"/> with the specified + /// assembly location and host config. + /// </summary> + /// <param name="pluginPath"></param> + /// <param name="log">A nullable log provider</param> + /// <param name="hostConfig">The configuration DOM to merge with plugin config DOM and pass to enabled plugins</param> + /// <param name="unloadable">A value that specifies if the assembly can be unloaded</param> + /// <param name="hotReload">A value that spcifies if the loader will listen for changes to the assembly file and reload the plugins</param> + /// <param name="lazy">A value that specifies if assembly dependencies are loaded on-demand</param> + /// <remarks> + /// The <paramref name="log"/> argument may be null if <paramref name="unloadable"/> is false + /// </remarks> + /// <exception cref="ArgumentNullException"></exception> + public RuntimePluginLoader(string pluginPath, JsonDocument? hostConfig = null, ILogProvider? log = null, bool unloadable = false, bool hotReload = false, bool lazy = false) + :this( + new PluginConfig(pluginPath) + { + IsUnloadable = unloadable || hotReload, + EnableHotReload = hotReload, + IsLazyLoaded = lazy, + ReloadDelay = TimeSpan.FromSeconds(1), + PreferSharedTypes = true, + DefaultContext = AssemblyLoadContext.Default + }, + hostConfig, log) + { + } + /// <summary> + /// Creates a new <see cref="RuntimePluginLoader"/> with the specified config and host config dom. + /// </summary> + /// <param name="config">The plugin's loader configuration </param> + /// <param name="hostConfig">The host/process configuration DOM</param> + /// <param name="log">A log provider to write plugin unload log events to</param> + /// <exception cref="ArgumentNullException"></exception> + public RuntimePluginLoader(PluginConfig config, JsonDocument? hostConfig, ILogProvider? log) + { + //Add the assembly from which the IPlugin library was loaded from + config.SharedAssemblies.Add(typeof(IPlugin).Assembly.GetName()); + + //Default to empty config if null + HostConfig = hostConfig ?? JsonDocument.Parse("{}"); + Loader = new(config); + PluginPath = config.MainAssemblyPath; + Log = log; + Loader.Reloaded += Loader_Reloaded; + //Set the config path default + PluginConfigPath = Path.ChangeExtension(PluginPath, ".json"); + LoadedPlugins = new(); + } + + private async void Loader_Reloaded(object sender, PluginReloadedEventArgs eventArgs) + { + try + { + //Invoke reloaded events + OnBeforeReloaded?.Invoke(this, eventArgs); + //Unload all endpoints + LoadedPlugins.TryForeach(lp => lp.UnloadPlugin(Log)); + //Clear list of loaded plugins + LoadedPlugins.Clear(); + //Unload the plugin config + PluginConfigDOM?.Dispose(); + //Reload the assembly and + await InitLoaderAsync(); + //fire after loaded + OnAfterReloaded?.Invoke(this, eventArgs); + //Raise the external reloaded event + Reloaded?.Invoke(this, EventArgs.Empty); + } + catch (Exception ex) + { + Log?.Error(ex); + } + } + + /// <summary> + /// Initializes the plugin loader, the assembly, and all public <see cref="IPlugin"/> + /// types + /// </summary> + /// <returns>A task that represents the initialization</returns> + public async Task InitLoaderAsync() + { + //Load the main assembly + Assembly PluginAsm = Loader.LoadDefaultAssembly(); + //Get the plugin's configuration file + if (FileOperations.FileExists(PluginConfigPath)) + { + //Open and read the config file + await using FileStream confStream = File.OpenRead(PluginConfigPath); + JsonDocumentOptions jdo = new() + { + AllowTrailingCommas = true, + CommentHandling = JsonCommentHandling.Skip, + }; + //parse the plugin config file + PluginConfigDOM = await JsonDocument.ParseAsync(confStream, jdo); + //Store the config loader args + if (PluginConfigDOM.RootElement.TryGetProperty("loader_args", out JsonElement loaderEl)) + { + LoaderArgs = loaderEl; + } + } + else + { + //Set plugin config dom to an empty object if the file does not exist + PluginConfigDOM = JsonDocument.Parse("{}"); + LoaderArgs = null; + } + + string[] cliArgs = Environment.GetCommandLineArgs(); + + //Get all types that implement the IPlugin interface + IEnumerable<IPlugin> plugins = PluginAsm.GetTypes().Where(static type => !type.IsAbstract && typeof(IPlugin).IsAssignableFrom(type)) + //Create the plugin instances + .Select(static type => (Activator.CreateInstance(type) as IPlugin)!); + //Load all plugins that implement the Iplugin interface + foreach (IPlugin plugin in plugins) + { + //Load wrapper + LivePlugin lp = new(plugin); + try + { + //Init config + lp.InitConfig(HostConfig, PluginConfigDOM); + //Init log handler + lp.InitLog(cliArgs); + //Load the plugin + lp.LoadPlugin(); + //Create new plugin loader for the plugin + LoadedPlugins.AddLast(lp); + } + catch (TargetInvocationException te) when (te.InnerException is not null) + { + throw te.InnerException; + } + } + } + /// <summary> + /// Manually reload the internal <see cref="PluginLoader"/> + /// which will reload the assembly and its plugins and endpoints + /// </summary> + public void ReloadPlugin() => Loader.Reload(); + + /// <summary> + /// Attempts to unload all plugins. + /// </summary> + /// <exception cref="AggregateException"></exception> + public void UnloadAll() => LoadedPlugins.TryForeach(lp => lp.UnloadPlugin(Log)); + + ///<inheritdoc/> + protected override void Free() + { + Loader.Dispose(); + PluginConfigDOM?.Dispose(); + } + + } +}
\ No newline at end of file diff --git a/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj b/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj new file mode 100644 index 0000000..b74b29d --- /dev/null +++ b/lib/Plugins.Runtime/src/VNLib.Plugins.Runtime.csproj @@ -0,0 +1,47 @@ +<Project Sdk="Microsoft.NET.Sdk"> + + <PropertyGroup> + <Nullable>enable</Nullable> + <TargetFramework>net6.0</TargetFramework> + <Authors>Vaughn Nugent</Authors> + <Copyright>Copyright © 2022 Vaughn Nugent</Copyright> + <Description>A runtime plugin loader for .NET. Allows runtime loading and tracking of .NET assemblies +that export the VNLib.Plugin.IPlugin interface.</Description> + <Version>1.0.1.1</Version> + <PackageProjectUrl>https://www.vaughnnugent.com/resources</PackageProjectUrl> + <SignAssembly>True</SignAssembly> + <AssemblyOriginatorKeyFile>\\vaughnnugent.com\Internal\Folder Redirection\vman\Documents\Programming\Software\StrongNameingKey.snk</AssemblyOriginatorKeyFile> + </PropertyGroup> + + <!-- Resolve nuget dll files and store them in the output dir --> + <PropertyGroup> + <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> + <GenerateDocumentationFile>True</GenerateDocumentationFile> + <AnalysisLevel>latest-all</AnalysisLevel> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'"> + <Deterministic>False</Deterministic> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'"> + <Deterministic>False</Deterministic> + </PropertyGroup> + + + <ItemGroup> + <PackageReference Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2"> + <PrivateAssets>all</PrivateAssets> + <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> + </PackageReference> + <PackageReference Include="ErrorProne.NET.Structs" Version="0.1.2"> + <PrivateAssets>all</PrivateAssets> + <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> + </PackageReference> + <PackageReference Include="McMaster.NETCore.Plugins" Version="1.4.0" /> + </ItemGroup> + + <ItemGroup> + <ProjectReference Include="..\..\Plugins.Essentials\src\VNLib.Plugins.Essentials.csproj" /> + <ProjectReference Include="..\..\Utils\src\VNLib.Utils.csproj" /> + </ItemGroup> + +</Project> |