aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs100
-rw-r--r--OpenSim/Region/Application/OpenSimBase.cs4
-rw-r--r--OpenSim/Region/Examples/SimpleModule/RegionModule.cs11
-rw-r--r--OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs86
-rw-r--r--OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs91
5 files changed, 235 insertions, 57 deletions
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs
index 9d79b3a..49bd911 100644
--- a/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs
+++ b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs
@@ -62,7 +62,7 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
62 new List<ISharedRegionModule>(); 62 new List<ISharedRegionModule>();
63 63
64#region IApplicationPlugin implementation 64#region IApplicationPlugin implementation
65 65
66 public void Initialise (OpenSimBase openSim) 66 public void Initialise (OpenSimBase openSim)
67 { 67 {
68 m_openSim = openSim; 68 m_openSim = openSim;
@@ -91,66 +91,24 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
91 { 91 {
92 if (node.Type.GetInterface(typeof(ISharedRegionModule).ToString()) != null) 92 if (node.Type.GetInterface(typeof(ISharedRegionModule).ToString()) != null)
93 { 93 {
94 // Get the config string 94 if (CheckModuleEnabled(node, modulesConfig))
95 string moduleString =
96 modulesConfig.GetString("Setup_" + node.Id, String.Empty);
97
98 // We have a selector
99 if (moduleString != String.Empty)
100 { 95 {
101 // Allow disabling modules even if they don't have 96 m_log.DebugFormat("[REGIONMODULES]: Found shared region module {0}, class {1}", node.Id, node.Type);
102 // support for it 97 m_sharedModules.Add(node);
103 if (moduleString == "disabled")
104 continue;
105
106 // Split off port, if present
107 string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
108 // Format is [port/][class]
109 string className = moduleParts[0];
110 if (moduleParts.Length > 1)
111 className = moduleParts[1];
112
113 // Match the class name if given
114 if (className != String.Empty &&
115 node.Type.ToString() != className)
116 continue;
117 } 98 }
118
119 m_log.DebugFormat("[REGIONMODULES]: Found shared region module {0}, class {1}", node.Id, node.Type);
120 m_sharedModules.Add(node);
121 } 99 }
122 else if (node.Type.GetInterface(typeof(INonSharedRegionModule).ToString()) != null) 100 else if (node.Type.GetInterface(typeof(INonSharedRegionModule).ToString()) != null)
123 { 101 {
124 // Get the config string 102 if (CheckModuleEnabled(node, modulesConfig))
125 string moduleString =
126 modulesConfig.GetString("Setup_" + node.Id, String.Empty);
127
128 // We have a selector
129 if (moduleString != String.Empty)
130 { 103 {
131 // Allow disabling modules even if they don't have 104 m_log.DebugFormat("[REGIONMODULES]: Found non-shared region module {0}, class {1}", node.Id, node.Type);
132 // support for it 105 m_nonSharedModules.Add(node);
133 if (moduleString == "disabled")
134 continue;
135
136 // Split off port, if present
137 string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
138 // Format is [port/][class]
139 string className = moduleParts[0];
140 if (moduleParts.Length > 1)
141 className = moduleParts[1];
142
143 // Match the class name if given
144 if (className != String.Empty &&
145 node.Type.ToString() != className)
146 continue;
147 } 106 }
148
149 m_log.DebugFormat("[REGIONMODULES]: Found non-shared region module {0}, class {1}", node.Id, node.Type);
150 m_nonSharedModules.Add(node);
151 } 107 }
152 else 108 else
109 {
153 m_log.DebugFormat("[REGIONMODULES]: Found unknown type of module {0}, class {1}", node.Id, node.Type); 110 m_log.DebugFormat("[REGIONMODULES]: Found unknown type of module {0}, class {1}", node.Id, node.Type);
111 }
154 } 112 }
155 113
156 // Load and init the module. We try a constructor with a port 114 // Load and init the module. We try a constructor with a port
@@ -197,8 +155,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
197 m_sharedInstances.Add(module); 155 m_sharedInstances.Add(module);
198 module.Initialise(m_openSim.ConfigSource.Source); 156 module.Initialise(m_openSim.ConfigSource.Source);
199 } 157 }
200
201
202 } 158 }
203 159
204 public void PostInitialise () 160 public void PostInitialise ()
@@ -210,7 +166,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
210 { 166 {
211 module.PostInitialise(); 167 module.PostInitialise();
212 } 168 }
213
214 } 169 }
215 170
216#endregion 171#endregion
@@ -244,7 +199,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
244 199
245#endregion 200#endregion
246 201
247
248 public string Version 202 public string Version
249 { 203 {
250 get 204 get
@@ -262,6 +216,42 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
262 } 216 }
263 217
264#region IRegionModulesController implementation 218#region IRegionModulesController implementation
219
220 /// <summary>
221 /// Check that the given module is no disabled in the [Modules] section of the config files.
222 /// </summary>
223 /// <param name="node"></param>
224 /// <param name="modulesConfig">The config section</param>
225 /// <returns>true if the module is enabled, false if it is disabled</returns>
226 protected bool CheckModuleEnabled(TypeExtensionNode node, IConfig modulesConfig)
227 {
228 // Get the config string
229 string moduleString =
230 modulesConfig.GetString("Setup_" + node.Id, String.Empty);
231
232 // We have a selector
233 if (moduleString != String.Empty)
234 {
235 // Allow disabling modules even if they don't have
236 // support for it
237 if (moduleString == "disabled")
238 return false;
239
240 // Split off port, if present
241 string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
242 // Format is [port/][class]
243 string className = moduleParts[0];
244 if (moduleParts.Length > 1)
245 className = moduleParts[1];
246
247 // Match the class name if given
248 if (className != String.Empty &&
249 node.Type.ToString() != className)
250 return false;
251 }
252
253 return true;
254 }
265 255
266 // The root of all evil. 256 // The root of all evil.
267 // This is where we handle adding the modules to scenes when they 257 // This is where we handle adding the modules to scenes when they
diff --git a/OpenSim/Region/Application/OpenSimBase.cs b/OpenSim/Region/Application/OpenSimBase.cs
index 36d5e51..eee2300 100644
--- a/OpenSim/Region/Application/OpenSimBase.cs
+++ b/OpenSim/Region/Application/OpenSimBase.cs
@@ -352,13 +352,13 @@ namespace OpenSim
352 m_moduleLoader.InitialiseSharedModules(scene); 352 m_moduleLoader.InitialiseSharedModules(scene);
353 353
354 // Use this in the future, the line above will be deprecated soon 354 // Use this in the future, the line above will be deprecated soon
355 m_log.Info("[REGIONMODULE]: Loading Region's modules (new style)"); 355 m_log.Info("[REGIONMODULES]: Loading Region's modules (new style)");
356 IRegionModulesController controller; 356 IRegionModulesController controller;
357 if (ApplicationRegistry.TryGet(out controller)) 357 if (ApplicationRegistry.TryGet(out controller))
358 { 358 {
359 controller.AddRegionToModules(scene); 359 controller.AddRegionToModules(scene);
360 } 360 }
361 else m_log.Error("[REGIONMODULE]: The new RegionModulesController is missing..."); 361 else m_log.Error("[REGIONMODULES]: The new RegionModulesController is missing...");
362 362
363 scene.SetModuleInterfaces(); 363 scene.SetModuleInterfaces();
364 364
diff --git a/OpenSim/Region/Examples/SimpleModule/RegionModule.cs b/OpenSim/Region/Examples/SimpleModule/RegionModule.cs
index 6da41db..088b818 100644
--- a/OpenSim/Region/Examples/SimpleModule/RegionModule.cs
+++ b/OpenSim/Region/Examples/SimpleModule/RegionModule.cs
@@ -34,6 +34,17 @@ using OpenSim.Region.Framework.Scenes;
34 34
35namespace OpenSim.Region.Examples.SimpleModule 35namespace OpenSim.Region.Examples.SimpleModule
36{ 36{
37 /// <summary>
38 /// Example region module.
39 /// </summary>
40 /// <remarks>
41 /// This is an old and unmaintained region module which uses the old style module interface. It is not loaded into
42 /// OpenSim by default. If you want to try enabling it, look in the bin folder of this project.
43 /// Please see the README.txt in this project on the filesystem for some more information.
44 /// Nonetheless, it may contain some useful example code so has been left here for now.
45 ///
46 /// You can see bare bones examples of the more modern region module system in OpenSim/Region/OptionalModules/Example
47 /// </remarks>
37 public class RegionModule : IRegionModule 48 public class RegionModule : IRegionModule
38 { 49 {
39 #region IRegionModule Members 50 #region IRegionModule Members
diff --git a/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs
new file mode 100644
index 0000000..7d37135
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs
@@ -0,0 +1,86 @@
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 OpenSimulator 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
28using System;
29using System.Reflection;
30using log4net;
31using Mono.Addins;
32using Nini.Config;
33using OpenSim.Region.Framework.Interfaces;
34using OpenSim.Region.Framework.Scenes;
35
36namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
37{
38 /// <summary>
39 /// Simplest possible example of a non-shared region module.
40 /// </summary>
41 /// <remarks>
42 /// This module is the simplest possible example of a non-shared region module (a module where each scene/region
43 /// in the simulator has its own copy). If anybody wants to create a more complex example in the future then
44 /// please create a separate class.
45 ///
46 /// This module is not active by default. If you want to see it in action,
47 /// then just uncomment the line below starting with [Extension(Path...
48 ///
49 /// When the module is enabled it will print messages when it receives certain events to the screen and the log
50 /// file.
51 /// </remarks>
52 //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")]
53 public class BareBonesNonSharedModule : INonSharedRegionModule
54 {
55 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
56
57 public string Name { get { return "Bare Bones Non Shared Module"; } }
58
59 public Type ReplaceableInterface { get { return null; } }
60
61 public void Initialise(IConfigSource source)
62 {
63 m_log.DebugFormat("[BARE BONES NON SHARED]: INITIALIZED MODULE");
64 }
65
66 public void Close()
67 {
68 m_log.DebugFormat("[BARE BONES NON SHARED]: CLOSED MODULE");
69 }
70
71 public void AddRegion(Scene scene)
72 {
73 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
74 }
75
76 public void RemoveRegion(Scene scene)
77 {
78 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
79 }
80
81 public void RegionLoaded(Scene scene)
82 {
83 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
84 }
85 }
86} \ No newline at end of file
diff --git a/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs b/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs
new file mode 100644
index 0000000..781fe95
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs
@@ -0,0 +1,91 @@
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 OpenSimulator 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
28using System;
29using System.Reflection;
30using log4net;
31using Mono.Addins;
32using Nini.Config;
33using OpenSim.Region.Framework.Interfaces;
34using OpenSim.Region.Framework.Scenes;
35
36namespace OpenSim.Region.OptionalModules.Example.BareBonesShared
37{
38 /// <summary>
39 /// Simplest possible example of a shared region module.
40 /// </summary>
41 /// <remarks>
42 /// This module is the simplest possible example of a shared region module (a module which is shared by every
43 /// scene/region running on the simulator). If anybody wants to create a more complex example in the future then
44 /// please create a separate class.
45 ///
46 /// This module is not active by default. If you want to see it in action,
47 /// then just uncomment the line below starting with [Extension(Path...
48 ///
49 /// When the module is enabled it will print messages when it receives certain events to the screen and the log
50 /// file.
51 /// </remarks>
52 //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesSharedModule")]
53 public class BareBonesSharedModule : ISharedRegionModule
54 {
55 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
56
57 public string Name { get { return "Bare Bones Shared Module"; } }
58
59 public Type ReplaceableInterface { get { return null; } }
60
61 public void Initialise(IConfigSource source)
62 {
63 m_log.DebugFormat("[BARE BONES SHARED]: INITIALIZED MODULE");
64 }
65
66 public void PostInitialise()
67 {
68 m_log.DebugFormat("[BARE BONES SHARED]: POST INITIALIZED MODULE");
69 }
70
71 public void Close()
72 {
73 m_log.DebugFormat("[BARE BONES SHARED]: CLOSED MODULE");
74 }
75
76 public void AddRegion(Scene scene)
77 {
78 m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
79 }
80
81 public void RemoveRegion(Scene scene)
82 {
83 m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
84 }
85
86 public void RegionLoaded(Scene scene)
87 {
88 m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
89 }
90 }
91} \ No newline at end of file