diff options
author | Homer Horwitz | 2009-04-05 17:08:11 +0000 |
---|---|---|
committer | Homer Horwitz | 2009-04-05 17:08:11 +0000 |
commit | 648452dd91e07be4ec0e81793807e86bd48362c4 (patch) | |
tree | 4c1e7f1e48381fd9049efd5eda6440f885af86a4 | |
parent | - Move IWindModule to OpenSim.Region.Framework.Interfaces (diff) | |
download | opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.zip opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.gz opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.bz2 opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.xz |
- Add new RegionModulesControllerPlugin to the application modules
- Change several classes to use the new plugin for handling of region-modules
(NOTE: No regionmodule is using this yet)
- Add necessary prebuild parts (don't forget to runprebuild)
Attention: Work in progress. This shouldn't break anything, but you never know...
12 files changed, 530 insertions, 20 deletions
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs new file mode 100644 index 0000000..7dc4a74 --- /dev/null +++ b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs | |||
@@ -0,0 +1,192 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using System.Reflection; | ||
31 | using log4net; | ||
32 | using Mono.Addins; | ||
33 | using OpenSim; | ||
34 | using OpenSim.Region.Framework.Interfaces; | ||
35 | using OpenSim.Region.Framework.Scenes; | ||
36 | |||
37 | namespace OpenSim.ApplicationPlugins.RegionModulesController | ||
38 | { | ||
39 | public class RegionModulesControllerPlugin : IRegionModulesController, IApplicationPlugin | ||
40 | { | ||
41 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
42 | |||
43 | private OpenSimBase m_openSim; // for getting the config | ||
44 | |||
45 | private string m_name; | ||
46 | |||
47 | private List<Type> m_nonSharedModules = new List<Type>(); | ||
48 | private List<Type> m_sharedModules = new List<Type>(); | ||
49 | |||
50 | private List<ISharedRegionModule> m_sharedInstances = new List<ISharedRegionModule>(); | ||
51 | |||
52 | #region IApplicationPlugin implementation | ||
53 | |||
54 | public void Initialise (OpenSimBase openSim) | ||
55 | { | ||
56 | m_log.DebugFormat("[REGIONMODULES]: Initializing..."); | ||
57 | m_openSim = openSim; | ||
58 | openSim.ApplicationRegistry.RegisterInterface<IRegionModulesController>(this); | ||
59 | |||
60 | string id = AddinManager.CurrentAddin.Id; | ||
61 | int pos = id.LastIndexOf("."); | ||
62 | if (pos == -1) m_name = id; | ||
63 | else m_name = id.Substring(pos + 1); | ||
64 | |||
65 | ExtensionNodeList list = AddinManager.GetExtensionNodes("/OpenSim/RegionModules"); | ||
66 | m_log.DebugFormat("[XXX] list: {0}", list.Count); | ||
67 | // load all the (new) region-module classes | ||
68 | foreach (TypeExtensionNode node in AddinManager.GetExtensionNodes("/OpenSim/RegionModules")) | ||
69 | { | ||
70 | m_log.DebugFormat("[REGIONMODULES]: Found node {0}", node.Id); | ||
71 | // TODO why does node.Type.isSubclassOf(typeof(ISharedRegionModule)) not work? | ||
72 | if (node.Type.GetInterface(typeof(ISharedRegionModule).ToString()) != null) | ||
73 | { | ||
74 | m_log.DebugFormat("[REGIONMODULES]: Found shared region module {0}, class {1}", node.Id, node.Type); | ||
75 | m_sharedModules.Add(node.Type); | ||
76 | } | ||
77 | else if (node.Type.GetInterface(typeof(INonSharedRegionModule).ToString()) != null) | ||
78 | { | ||
79 | m_log.DebugFormat("[REGIONMODULES]: Found non-shared region module {0}, class {1}", node.Id, node.Type); | ||
80 | m_nonSharedModules.Add(node.Type); | ||
81 | } | ||
82 | else | ||
83 | m_log.DebugFormat("[REGIONMODULES]: Found unknown type of module {0}, class {1}", node.Id, node.Type); | ||
84 | } | ||
85 | |||
86 | // now we've got all the region-module classes loaded, create one instance of every ISharedRegionModule, | ||
87 | // initialize and postinitialize it. This Initialise we are in is called before LoadRegion.PostInitialise | ||
88 | // is called (which loads the regions), so we don't have any regions in the server yet. | ||
89 | foreach (Type type in m_sharedModules) | ||
90 | { | ||
91 | ISharedRegionModule module = (ISharedRegionModule)Activator.CreateInstance(type); | ||
92 | m_sharedInstances.Add(module); | ||
93 | module.Initialise(openSim.ConfigSource.Source); | ||
94 | } | ||
95 | |||
96 | foreach (ISharedRegionModule module in m_sharedInstances) | ||
97 | { | ||
98 | module.PostInitialise(); | ||
99 | } | ||
100 | } | ||
101 | |||
102 | public void PostInitialise () | ||
103 | { | ||
104 | } | ||
105 | |||
106 | #endregion | ||
107 | |||
108 | #region IPlugin implementation | ||
109 | |||
110 | public void Initialise () | ||
111 | { | ||
112 | throw new System.NotImplementedException(); | ||
113 | } | ||
114 | |||
115 | #endregion | ||
116 | |||
117 | #region IDisposable implementation | ||
118 | |||
119 | public void Dispose () | ||
120 | { | ||
121 | // we expect that all regions have been removed already | ||
122 | while (m_sharedInstances.Count > 0) | ||
123 | { | ||
124 | m_sharedInstances[0].Close(); | ||
125 | m_sharedInstances.RemoveAt(0); | ||
126 | } | ||
127 | m_sharedModules.Clear(); | ||
128 | m_nonSharedModules.Clear(); | ||
129 | } | ||
130 | |||
131 | #endregion | ||
132 | |||
133 | |||
134 | public string Version | ||
135 | { | ||
136 | get | ||
137 | { | ||
138 | return AddinManager.CurrentAddin.Version; | ||
139 | } | ||
140 | } | ||
141 | |||
142 | public string Name | ||
143 | { | ||
144 | get | ||
145 | { | ||
146 | return m_name; | ||
147 | } | ||
148 | } | ||
149 | |||
150 | #region IRegionModulesController implementation | ||
151 | |||
152 | public void AddRegionToModules (Scene scene) | ||
153 | { | ||
154 | foreach (ISharedRegionModule module in m_sharedInstances) | ||
155 | { | ||
156 | m_log.DebugFormat("[REGIONMODULE]: Adding scene {0} to shared module {1}", | ||
157 | scene.RegionInfo.RegionName, module.Name); | ||
158 | module.AddRegion(scene); | ||
159 | scene.AddRegionModule(module.Name, module); | ||
160 | } | ||
161 | |||
162 | foreach (Type type in m_nonSharedModules) | ||
163 | { | ||
164 | INonSharedRegionModule module = (INonSharedRegionModule)Activator.CreateInstance(type); | ||
165 | m_log.DebugFormat("[REGIONMODULE]: Adding scene {0} to non-shared module {1}", | ||
166 | scene.RegionInfo.RegionName, module.Name); | ||
167 | module.Initialise(m_openSim.ConfigSource.Source); | ||
168 | module.AddRegion(scene); | ||
169 | scene.AddRegionModule(module.Name, module); | ||
170 | } | ||
171 | } | ||
172 | |||
173 | public void RemoveRegionFromModules (Scene scene) | ||
174 | { | ||
175 | foreach (IRegionModuleBase module in scene.RegionModules.Values) | ||
176 | { | ||
177 | m_log.DebugFormat("[REGIONMODULE]: Removing scene {0} from module {1}", | ||
178 | scene.RegionInfo.RegionName, module.Name); | ||
179 | module.RemoveRegion(scene); | ||
180 | if (module is INonSharedRegionModule) | ||
181 | { | ||
182 | // as we were the only user, this instance has to die | ||
183 | module.Close(); | ||
184 | } | ||
185 | } | ||
186 | scene.RegionModules.Clear(); | ||
187 | } | ||
188 | |||
189 | #endregion | ||
190 | |||
191 | } | ||
192 | } | ||
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml b/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml new file mode 100644 index 0000000..a92713b --- /dev/null +++ b/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml | |||
@@ -0,0 +1,13 @@ | |||
1 | <Addin id="OpenSim.ApplicationPlugins.RegionModulesController" version="0.1"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.ApplicationPlugins.RegionModulesController.dll"/> | ||
4 | </Runtime> | ||
5 | |||
6 | <Dependencies> | ||
7 | <Addin id="OpenSim" version="0.5" /> | ||
8 | </Dependencies> | ||
9 | |||
10 | <Extension path = "/OpenSim/Startup"> | ||
11 | <Plugin id="RegionModulesController" type="OpenSim.ApplicationPlugins.RegionModulesController.RegionModulesControllerPlugin" /> | ||
12 | </Extension> | ||
13 | </Addin> | ||
diff --git a/OpenSim/Region/Application/OpenSimBase.cs b/OpenSim/Region/Application/OpenSimBase.cs index f24cf99..fd3549e 100644 --- a/OpenSim/Region/Application/OpenSimBase.cs +++ b/OpenSim/Region/Application/OpenSimBase.cs | |||
@@ -517,7 +517,7 @@ namespace OpenSim | |||
517 | IClientNetworkServer clientServer; | 517 | IClientNetworkServer clientServer; |
518 | Scene scene = SetupScene(regionInfo, proxyOffset, m_config.Source, out clientServer); | 518 | Scene scene = SetupScene(regionInfo, proxyOffset, m_config.Source, out clientServer); |
519 | 519 | ||
520 | m_log.Info("[MODULES]: Loading Region's modules"); | 520 | m_log.Info("[MODULES]: Loading Region's modules (old style)"); |
521 | 521 | ||
522 | List<IRegionModule> modules = m_moduleLoader.PickupModules(scene, "."); | 522 | List<IRegionModule> modules = m_moduleLoader.PickupModules(scene, "."); |
523 | 523 | ||
@@ -525,6 +525,15 @@ namespace OpenSim | |||
525 | // script module can pick up events exposed by a module | 525 | // script module can pick up events exposed by a module |
526 | m_moduleLoader.InitialiseSharedModules(scene); | 526 | m_moduleLoader.InitialiseSharedModules(scene); |
527 | 527 | ||
528 | // Use this in the future, the line above will be deprecated soon | ||
529 | m_log.Info("[MODULES]: Loading Region's modules (new style)"); | ||
530 | IRegionModulesController controller; | ||
531 | if (ApplicationRegistry.TryGet(out controller)) | ||
532 | { | ||
533 | controller.AddRegionToModules(scene); | ||
534 | } | ||
535 | else m_log.Error("[MODULES]: The new RegionModulesController is missing..."); | ||
536 | |||
528 | scene.SetModuleInterfaces(); | 537 | scene.SetModuleInterfaces(); |
529 | 538 | ||
530 | // Prims have to be loaded after module configuration since some modules may be invoked during the load | 539 | // Prims have to be loaded after module configuration since some modules may be invoked during the load |
@@ -571,11 +580,22 @@ namespace OpenSim | |||
571 | module.PostInitialise(); | 580 | module.PostInitialise(); |
572 | } | 581 | } |
573 | } | 582 | } |
583 | scene.EventManager.OnShutdown += delegate() { ShutdownRegion(scene); }; | ||
574 | 584 | ||
575 | mscene = scene; | 585 | mscene = scene; |
576 | return clientServer; | 586 | return clientServer; |
577 | } | 587 | } |
578 | 588 | ||
589 | private void ShutdownRegion(Scene scene) | ||
590 | { | ||
591 | m_log.DebugFormat("[SHUTDOWN]: Shutting down region {0}", scene.RegionInfo.RegionName); | ||
592 | IRegionModulesController controller; | ||
593 | if (ApplicationRegistry.TryGet<IRegionModulesController>(out controller)) | ||
594 | { | ||
595 | controller.RemoveRegionFromModules(scene); | ||
596 | } | ||
597 | } | ||
598 | |||
579 | public void RemoveRegion(Scene scene, bool cleanup) | 599 | public void RemoveRegion(Scene scene, bool cleanup) |
580 | { | 600 | { |
581 | // only need to check this if we are not at the | 601 | // only need to check this if we are not at the |
diff --git a/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml b/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml new file mode 100644 index 0000000..6896876 --- /dev/null +++ b/OpenSim/Region/CoreModules/Resources/CoreModulePlugin.addin.xml | |||
@@ -0,0 +1,20 @@ | |||
1 | <Addin id="OpenSim.Region.CoreModules" version="0.2"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.Region.CoreModules.dll"/> | ||
4 | </Runtime> | ||
5 | |||
6 | <Dependencies> | ||
7 | <Addin id="OpenSim" version="0.5" /> | ||
8 | </Dependencies> | ||
9 | |||
10 | <Extension path = "/OpenSim/RegionModules"> | ||
11 | <RegionModule id="WorldMapModule" type="OpenSim.Region.CoreModules.World.WorldMap.NewWorldMapModule" /> | ||
12 | <RegionModule id="CommsModule" type="OpenSim.Region.CoreModules.Communications.Local.NewLocalInterregionComms" /> | ||
13 | </Extension> | ||
14 | |||
15 | <Extension path = "/OpenSim/WindModule"> | ||
16 | <WindModel id="ConfigurableWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind" /> | ||
17 | <WindModel id="SimpleRandomWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind" /> | ||
18 | </Extension> | ||
19 | |||
20 | </Addin> | ||
diff --git a/OpenSim/Region/CoreModules/Resources/Wind.Models.addin.xml b/OpenSim/Region/CoreModules/Resources/Wind.Models.addin.xml deleted file mode 100644 index 7735826..0000000 --- a/OpenSim/Region/CoreModules/Resources/Wind.Models.addin.xml +++ /dev/null | |||
@@ -1,12 +0,0 @@ | |||
1 | <Addin id="WindModule.Default.WindModels" version="1.0"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.Region.CoreModules.dll"/> | ||
4 | </Runtime> | ||
5 | <Dependencies> | ||
6 | <Addin id="OpenSim" version="0.5" /> | ||
7 | </Dependencies> | ||
8 | <Extension path = "/OpenSim/WindModule"> | ||
9 | <WindModel id="ConfigurableWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind" /> | ||
10 | <WindModel id="SimpleRandomWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind" /> | ||
11 | </Extension> | ||
12 | </Addin> | ||
diff --git a/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs b/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs new file mode 100644 index 0000000..b8af866 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs | |||
@@ -0,0 +1,35 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | |||
30 | namespace OpenSim.Region.Framework.Interfaces | ||
31 | { | ||
32 | public interface INonSharedRegionModule : IRegionModuleBase | ||
33 | { | ||
34 | } | ||
35 | } | ||
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs new file mode 100644 index 0000000..265b464 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs | |||
@@ -0,0 +1,76 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using Mono.Addins; | ||
30 | using Nini.Config; | ||
31 | using OpenSim.Region.Framework.Scenes; | ||
32 | |||
33 | namespace OpenSim.Region.Framework.Interfaces | ||
34 | { | ||
35 | public interface IRegionModuleBase | ||
36 | { | ||
37 | /// <value> | ||
38 | /// The name of the module | ||
39 | /// </value> | ||
40 | string Name { get; } | ||
41 | |||
42 | /// <summary> | ||
43 | /// This is called to initialize the region module. For shared modules, this is called | ||
44 | /// exactly once, after creating the single (shared) instance. For non-shared modules, | ||
45 | /// this is called once on each instance, after the instace for the region has been created. | ||
46 | /// </summary> | ||
47 | /// <param name="source"> | ||
48 | /// A <see cref="IConfigSource"/> | ||
49 | /// </param> | ||
50 | void Initialise(IConfigSource source); | ||
51 | |||
52 | /// <summary> | ||
53 | /// This is the inverse to <see cref="Initialise"/>. After a Close(), this instance won't be usable anymore. | ||
54 | /// </summary> | ||
55 | void Close(); | ||
56 | |||
57 | /// <summary> | ||
58 | /// This is called whenever a <see cref="Scene"/> is added. For shared modules, this can happen several times. | ||
59 | /// For non-shared modules, this happens exactly once, after <see cref="Initialise"/> has been called. | ||
60 | /// </summary> | ||
61 | /// <param name="scene"> | ||
62 | /// A <see cref="Scene"/> | ||
63 | /// </param> | ||
64 | void AddRegion(Scene scene); | ||
65 | |||
66 | /// <summary> | ||
67 | /// This is called whenever a <see cref="Scene"/> is removed. For shared modules, this can happen several times. | ||
68 | /// For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. | ||
69 | /// </summary> | ||
70 | /// <param name="scene"> | ||
71 | /// A <see cref="Scene"/> | ||
72 | /// </param> | ||
73 | void RemoveRegion(Scene scene); | ||
74 | } | ||
75 | |||
76 | } | ||
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs b/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs new file mode 100644 index 0000000..d38c962 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs | |||
@@ -0,0 +1,38 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using OpenSim.Region.Framework.Scenes; | ||
30 | |||
31 | namespace OpenSim.Region.Framework.Interfaces | ||
32 | { | ||
33 | public interface IRegionModulesController | ||
34 | { | ||
35 | void AddRegionToModules(Scene scene); | ||
36 | void RemoveRegionFromModules (Scene scene); | ||
37 | } | ||
38 | } | ||
diff --git a/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs b/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs new file mode 100644 index 0000000..d0b6ecc --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs | |||
@@ -0,0 +1,40 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSim Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | |||
30 | namespace OpenSim.Region.Framework.Interfaces | ||
31 | { | ||
32 | public interface ISharedRegionModule : IRegionModuleBase | ||
33 | { | ||
34 | /// <summary> | ||
35 | /// This is called exactly once after all the shared region-modules have been instanciated and | ||
36 | /// <see cref="IRegionModuleBase.Initialise"/>d. | ||
37 | /// </summary> | ||
38 | void PostInitialise(); | ||
39 | } | ||
40 | } | ||
diff --git a/OpenSim/Region/Framework/Scenes/SceneBase.cs b/OpenSim/Region/Framework/Scenes/SceneBase.cs index 3695b21..42f3d97 100644 --- a/OpenSim/Region/Framework/Scenes/SceneBase.cs +++ b/OpenSim/Region/Framework/Scenes/SceneBase.cs | |||
@@ -59,13 +59,19 @@ namespace OpenSim.Region.Framework.Scenes | |||
59 | } | 59 | } |
60 | protected Dictionary<string, IRegionModule> m_modules = new Dictionary<string, IRegionModule>(); | 60 | protected Dictionary<string, IRegionModule> m_modules = new Dictionary<string, IRegionModule>(); |
61 | 61 | ||
62 | public Dictionary<string, IRegionModuleBase> RegionModules | ||
63 | { | ||
64 | get { return m_regionModules; } | ||
65 | } | ||
66 | private Dictionary<string, IRegionModuleBase> m_regionModules = new Dictionary<string, IRegionModuleBase>(); | ||
67 | |||
62 | /// <value> | 68 | /// <value> |
63 | /// The module interfaces available from this scene. | 69 | /// The module interfaces available from this scene. |
64 | /// </value> | 70 | /// </value> |
65 | protected Dictionary<Type, List<object>> ModuleInterfaces = new Dictionary<Type, List<object>>(); | 71 | protected Dictionary<Type, List<object>> ModuleInterfaces = new Dictionary<Type, List<object>>(); |
66 | 72 | ||
67 | protected Dictionary<string, object> ModuleAPIMethods = new Dictionary<string, object>(); | 73 | protected Dictionary<string, object> ModuleAPIMethods = new Dictionary<string, object>(); |
68 | 74 | ||
69 | /// <value> | 75 | /// <value> |
70 | /// The module commanders available from this scene | 76 | /// The module commanders available from this scene |
71 | /// </value> | 77 | /// </value> |
@@ -235,7 +241,7 @@ namespace OpenSim.Region.Framework.Scenes | |||
235 | } | 241 | } |
236 | } | 242 | } |
237 | Modules.Clear(); | 243 | Modules.Clear(); |
238 | 244 | ||
239 | try | 245 | try |
240 | { | 246 | { |
241 | EventManager.TriggerShutdown(); | 247 | EventManager.TriggerShutdown(); |
@@ -279,6 +285,24 @@ namespace OpenSim.Region.Framework.Scenes | |||
279 | } | 285 | } |
280 | 286 | ||
281 | /// <summary> | 287 | /// <summary> |
288 | /// Add a region-module to this scene. TODO: This will replace AddModule in the future. | ||
289 | /// </summary> | ||
290 | /// <param name="name"></param> | ||
291 | /// <param name="module"></param> | ||
292 | public void AddRegionModule(string name, IRegionModuleBase module) | ||
293 | { | ||
294 | if (!RegionModules.ContainsKey(name)) | ||
295 | { | ||
296 | RegionModules.Add(name, module); | ||
297 | } | ||
298 | } | ||
299 | |||
300 | public void RemoveRegionModule(string name) | ||
301 | { | ||
302 | RegionModules.Remove(name); | ||
303 | } | ||
304 | |||
305 | /// <summary> | ||
282 | /// Register a module commander. | 306 | /// Register a module commander. |
283 | /// </summary> | 307 | /// </summary> |
284 | /// <param name="commander"></param> | 308 | /// <param name="commander"></param> |
@@ -368,6 +392,25 @@ namespace OpenSim.Region.Framework.Scenes | |||
368 | } | 392 | } |
369 | } | 393 | } |
370 | 394 | ||
395 | public void UnregisterModuleInterface<M>(M mod) | ||
396 | { | ||
397 | List<Object> l; | ||
398 | if (ModuleInterfaces.TryGetValue(typeof(M), out l)) | ||
399 | { | ||
400 | if (l.Remove(mod)) | ||
401 | { | ||
402 | if (mod is IEntityCreator) | ||
403 | { | ||
404 | IEntityCreator entityCreator = (IEntityCreator)mod; | ||
405 | foreach (PCode pcode in entityCreator.CreationCapabilities) | ||
406 | { | ||
407 | m_entityCreators[pcode] = null; | ||
408 | } | ||
409 | } | ||
410 | } | ||
411 | } | ||
412 | } | ||
413 | |||
371 | public void StackModuleInterface<M>(M mod) | 414 | public void StackModuleInterface<M>(M mod) |
372 | { | 415 | { |
373 | List<Object> l; | 416 | List<Object> l; |
@@ -462,11 +505,19 @@ namespace OpenSim.Region.Framework.Scenes | |||
462 | 505 | ||
463 | if (mod != null) | 506 | if (mod != null) |
464 | { | 507 | { |
465 | if (!(mod is IRegionModule)) | 508 | if (mod is IRegionModule) |
466 | throw new Exception("AddCommand module parameter must be IRegionModule"); | 509 | { |
467 | IRegionModule module = (IRegionModule)mod; | 510 | IRegionModule module = (IRegionModule)mod; |
468 | modulename = module.Name; | 511 | modulename = module.Name; |
469 | shared = module.IsSharedModule; | 512 | shared = module.IsSharedModule; |
513 | } | ||
514 | else if (mod is IRegionModuleBase) | ||
515 | { | ||
516 | IRegionModuleBase module = (IRegionModuleBase)mod; | ||
517 | modulename = module.Name; | ||
518 | shared = mod is ISharedRegionModule; | ||
519 | } | ||
520 | else throw new Exception("AddCommand module parameter must be IRegionModule or IRegionModuleBase"); | ||
470 | } | 521 | } |
471 | 522 | ||
472 | MainConsole.Instance.Commands.AddCommand(modulename, shared, command, shorthelp, longhelp, callback); | 523 | MainConsole.Instance.Commands.AddCommand(modulename, shared, command, shorthelp, longhelp, callback); |
diff --git a/bin/OpenSim.addin.xml b/bin/OpenSim.addin.xml index ff92555..da64c63 100644 --- a/bin/OpenSim.addin.xml +++ b/bin/OpenSim.addin.xml | |||
@@ -5,16 +5,24 @@ | |||
5 | <Import assembly="OpenSim.Region.Framework.dll"/> | 5 | <Import assembly="OpenSim.Region.Framework.dll"/> |
6 | <Import assembly="Mono.Addins.dll"/> | 6 | <Import assembly="Mono.Addins.dll"/> |
7 | </Runtime> | 7 | </Runtime> |
8 | |||
8 | <ExtensionPoint path="/OpenSim/Startup"> | 9 | <ExtensionPoint path="/OpenSim/Startup"> |
9 | <ExtensionNode name="Plugin" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.IApplicationPlugin"/> | 10 | <ExtensionNode name="Plugin" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.IApplicationPlugin"/> |
10 | </ExtensionPoint> | 11 | </ExtensionPoint> |
12 | |||
11 | <ExtensionPoint path="/OpenSim/AssetCache" name="Region Asset Cache Plugin-point" > | 13 | <ExtensionPoint path="/OpenSim/AssetCache" name="Region Asset Cache Plugin-point" > |
12 | <ExtensionNode name="Cache" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.Framework.IAssetCache"/> | 14 | <ExtensionNode name="Cache" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.Framework.IAssetCache"/> |
13 | </ExtensionPoint> | 15 | </ExtensionPoint> |
16 | |||
14 | <ExtensionPoint path="/OpenSim/AssetClient" name="Region Asset Cache Server Interface Plugin-point"> | 17 | <ExtensionPoint path="/OpenSim/AssetClient" name="Region Asset Cache Server Interface Plugin-point"> |
15 | <ExtensionNode name="AssetClient" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.Framework.IAssetServer"/> | 18 | <ExtensionNode name="AssetClient" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.Framework.IAssetServer"/> |
16 | </ExtensionPoint> | 19 | </ExtensionPoint> |
20 | |||
17 | <ExtensionPoint path="/OpenSim/WindModule" name="Wind Module Plugins for wind models"> | 21 | <ExtensionPoint path="/OpenSim/WindModule" name="Wind Module Plugins for wind models"> |
18 | <ExtensionNode name="WindModel" type="Mono.Addins.TypeExtensionNode" objectType="OpenSim.Region.Framework.Interfaces.IWindModelPlugin"/> | 22 | <ExtensionNode name="WindModel" type="Mono.Addins.TypeExtensionNode" objectType="OpenSim.Region.Framework.Interfaces.IWindModelPlugin"/> |
19 | </ExtensionPoint> | 23 | </ExtensionPoint> |
24 | |||
25 | <ExtensionPoint path="/OpenSim/RegionModules"> | ||
26 | <ExtensionNode name="RegionModule" type="Mono.Addins.TypeExtensionNode" objectType="OpenSim.Region.Framework.Interfaces.IRegionModuleBase"/> | ||
27 | </ExtensionPoint> | ||
20 | </Addin> | 28 | </Addin> |
diff --git a/prebuild.xml b/prebuild.xml index ca1a533..29b0861 100644 --- a/prebuild.xml +++ b/prebuild.xml | |||
@@ -635,6 +635,7 @@ | |||
635 | <Reference name="Nini.dll" /> | 635 | <Reference name="Nini.dll" /> |
636 | <Reference name="log4net.dll"/> | 636 | <Reference name="log4net.dll"/> |
637 | <Reference name="DotNetOpenMail.dll"/> | 637 | <Reference name="DotNetOpenMail.dll"/> |
638 | <Reference name="Mono.Addins.dll"/> | ||
638 | 639 | ||
639 | <Files> | 640 | <Files> |
640 | <Match pattern="*.cs" recurse="true"> | 641 | <Match pattern="*.cs" recurse="true"> |
@@ -1204,6 +1205,7 @@ | |||
1204 | <Exclude name="Tests" pattern="Tests" /> | 1205 | <Exclude name="Tests" pattern="Tests" /> |
1205 | <Exclude name="TerrainDefaultEffects" pattern="World/Terrain/DefaultEffects" /> | 1206 | <Exclude name="TerrainDefaultEffects" pattern="World/Terrain/DefaultEffects" /> |
1206 | </Match> | 1207 | </Match> |
1208 | <Match pattern="*.addin.xml" path="Resources" buildAction="EmbeddedResource" recurse="true"/> | ||
1207 | </Files> | 1209 | </Files> |
1208 | </Project> | 1210 | </Project> |
1209 | 1211 | ||
@@ -1491,6 +1493,33 @@ | |||
1491 | </Files> | 1493 | </Files> |
1492 | </Project> | 1494 | </Project> |
1493 | 1495 | ||
1496 | <Project name="OpenSim.ApplicationPlugins.RegionModulesController" path="OpenSim/ApplicationPlugins/RegionModulesController" type="Library"> | ||
1497 | <Configuration name="Debug"> | ||
1498 | <Options> | ||
1499 | <OutputPath>../../../bin/</OutputPath> | ||
1500 | </Options> | ||
1501 | </Configuration> | ||
1502 | <Configuration name="Release"> | ||
1503 | <Options> | ||
1504 | <OutputPath>../../../bin/</OutputPath> | ||
1505 | </Options> | ||
1506 | </Configuration> | ||
1507 | |||
1508 | <ReferencePath>../../../bin/</ReferencePath> | ||
1509 | <Reference name="Mono.Addins.dll" /> | ||
1510 | <Reference name="Nini.dll" /> | ||
1511 | <Reference name="OpenSim"/> | ||
1512 | <Reference name="OpenSim.Region.Framework"/> | ||
1513 | <Reference name="System"/> | ||
1514 | <Reference name="System.Xml"/> | ||
1515 | <Reference name="log4net.dll"/> | ||
1516 | |||
1517 | <Files> | ||
1518 | <Match pattern="*.cs" recurse="true"/> | ||
1519 | <Match pattern="*.addin.xml" path="Resources" buildAction="EmbeddedResource" recurse="true"/> | ||
1520 | </Files> | ||
1521 | </Project> | ||
1522 | |||
1494 | <Project name="OpenSim.ApplicationPlugins.CreateCommsManager" path="OpenSim/ApplicationPlugins/CreateCommsManager" type="Library"> | 1523 | <Project name="OpenSim.ApplicationPlugins.CreateCommsManager" path="OpenSim/ApplicationPlugins/CreateCommsManager" type="Library"> |
1495 | <Configuration name="Debug"> | 1524 | <Configuration name="Debug"> |
1496 | <Options> | 1525 | <Options> |