aboutsummaryrefslogtreecommitdiff
path: root/lib/Plugins.Essentials.ServiceStack/src/ManagedPlugin.cs
blob: 54f009041c502d5cf576ee83c767c5efeccee3eb (plain)
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) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Essentials.ServiceStack
* File: ManagedPlugin.cs 
*
* ManagedPlugin.cs is part of VNLib.Plugins.Essentials.ServiceStack which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.ServiceStack 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 2 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials.ServiceStack 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.IO;
using System.Linq;
using System.Threading;
using System.Reflection;
using System.ComponentModel.Design;

using VNLib.Utils;
using VNLib.Plugins.Runtime;
using VNLib.Plugins.Attributes;

namespace VNLib.Plugins.Essentials.ServiceStack
{

    internal sealed class ManagedPlugin : VnDisposeable, IPluginEventListener, IManagedPlugin
    {
        private readonly IPluginEventListener _serviceDomainListener;
        private readonly RuntimePluginLoader _plugin;

        private UnloadableServiceContainer? _services;

        public ManagedPlugin(RuntimePluginLoader loader, IPluginEventListener listener)
        {
            //configure the loader
            _plugin = loader;

            //Register loading event listener before loading occurs
            _plugin.Controller.Register(this, this);

            //Store listener to raise events
            _serviceDomainListener = listener;
        }


        ///<inheritdoc/>
        public string PluginPath => _plugin.Config.AssemblyFile;

        ///<inheritdoc/>
        public IUnloadableServiceProvider Services
        {
            get
            {
                Check();
                return _services!;
            }
        }

        ///<inheritdoc/>
        public PluginController Controller
        {
            get
            {
                Check();
                return _plugin.Controller;
            }
        }

        internal string PluginFileName => Path.GetFileName(PluginPath);

        internal void InitializePlugins()
        {
            Check();
            _plugin.InitializeController();
        }

        internal void LoadPlugins()
        {
            Check();
            _plugin.LoadPlugins();
        }

        /*
         * Automatically called after the plugin has successfully loaded
         * by event handlers below
         */       
        private void ConfigureServices()
        {
            //If the service container is defined, dispose
            _services?.Dispose();

            //Init new service container
            _services = new();

            //Get types from plugin
            foreach (LivePlugin plugin in _plugin.Controller.Plugins)
            {
                /*
                 * Get the exposed configurator method if declared, 
                 * it may not be defined. 
                 */
                ServiceConfigurator? callback = plugin.PluginType.GetMethods()
                                                .Where(static m => m.GetCustomAttribute<ServiceConfiguratorAttribute>() != null && !m.IsAbstract)
                                                .Select(m => m.CreateDelegate<ServiceConfigurator>(plugin.Plugin))
                                                .FirstOrDefault();

                //Invoke if defined to expose services
                callback?.Invoke(_services);
            }
        }

        internal void ReloadPlugins()
        {
            Check();
            _plugin.ReloadPlugins();
        }

        internal void UnloadPlugins()
        {
            Check();

            //unload plugins
            _plugin.UnloadAll();

            //Services will be cleaned up by the unload event
        }

        void IPluginEventListener.OnPluginLoaded(PluginController controller, object? state)
        {
            //Initialize services after load, before passing event
            ConfigureServices();

            //Propagate event
            _serviceDomainListener.OnPluginLoaded(controller, state);
        }

        void IPluginEventListener.OnPluginUnloaded(PluginController controller, object? state)
        {
            //Cleanup services no longer in use. Plugin is still valid until this method returns
            using (_services)
            {
                //Propagate event
                _serviceDomainListener.OnPluginUnloaded(controller, state);

                //signal service cancel before disposing
                _services?.SignalUnload();
            }
            //Remove ref to services
            _services = null;
        }

        protected override void Free()
        {
            //Dispose services
            _services?.Dispose();
            //Unregister the listener to cleanup resources
            _plugin.Controller.Unregister(this);
            //Dispose loader
            _plugin.Dispose();
        }


        private sealed class UnloadableServiceContainer : ServiceContainer, IUnloadableServiceProvider
        {
            private readonly CancellationTokenSource _cts;

            public UnloadableServiceContainer() : base()
            {
                _cts = new();
            }

            ///<inheritdoc/>
            CancellationToken IUnloadableServiceProvider.UnloadToken => _cts.Token;

            /// <summary>
            /// Signals to listensers that the service container will be unloading
            /// </summary>
            internal void SignalUnload() => _cts.Cancel();

            protected override void Dispose(bool disposing)
            {
                base.Dispose(disposing);
                _cts.Dispose();
            }
        }
    }
}