aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2010-12-04 02:38:26 +0000
committerJustin Clark-Casey (justincc)2010-12-04 02:38:26 +0000
commit510b55c7f08e01b1d7ff14cbfdea367b9744dc23 (patch)
tree0888cd0d120b9ed9ccf6dd918ac601100a08d39e
parentcorrect the id of the example module (diff)
downloadopensim-SC_OLD-510b55c7f08e01b1d7ff14cbfdea367b9744dc23.zip
opensim-SC_OLD-510b55c7f08e01b1d7ff14cbfdea367b9744dc23.tar.gz
opensim-SC_OLD-510b55c7f08e01b1d7ff14cbfdea367b9744dc23.tar.bz2
opensim-SC_OLD-510b55c7f08e01b1d7ff14cbfdea367b9744dc23.tar.xz
refactor some common code in RegionModulesControllerPlugin
also some minor doc changes in BareBonesNonSharedModule
-rw-r--r--OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs100
-rw-r--r--OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs15
2 files changed, 54 insertions, 61 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/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs
index 5ece77d..7d37135 100644
--- a/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs
+++ b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs
@@ -41,10 +41,13 @@ namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
41 /// <remarks> 41 /// <remarks>
42 /// This module is the simplest possible example of a non-shared region module (a module where each scene/region 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 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 example. 44 /// please create a separate class.
45 /// 45 ///
46 /// This module is not active by default. If you want to see it in action, 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... 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.
48 /// </remarks> 51 /// </remarks>
49 //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")] 52 //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")]
50 public class BareBonesNonSharedModule : INonSharedRegionModule 53 public class BareBonesNonSharedModule : INonSharedRegionModule
@@ -57,27 +60,27 @@ namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
57 60
58 public void Initialise(IConfigSource source) 61 public void Initialise(IConfigSource source)
59 { 62 {
60 m_log.DebugFormat("[BARE BONES]: INITIALIZED MODULE"); 63 m_log.DebugFormat("[BARE BONES NON SHARED]: INITIALIZED MODULE");
61 } 64 }
62 65
63 public void Close() 66 public void Close()
64 { 67 {
65 m_log.DebugFormat("[BARE BONES]: CLOSED MODULE"); 68 m_log.DebugFormat("[BARE BONES NON SHARED]: CLOSED MODULE");
66 } 69 }
67 70
68 public void AddRegion(Scene scene) 71 public void AddRegion(Scene scene)
69 { 72 {
70 m_log.DebugFormat("[BARE BONES]: REGION {0} ADDED", scene.RegionInfo.RegionName); 73 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
71 } 74 }
72 75
73 public void RemoveRegion(Scene scene) 76 public void RemoveRegion(Scene scene)
74 { 77 {
75 m_log.DebugFormat("[BARE BONES]: REGION {0} REMOVED", scene.RegionInfo.RegionName); 78 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
76 } 79 }
77 80
78 public void RegionLoaded(Scene scene) 81 public void RegionLoaded(Scene scene)
79 { 82 {
80 m_log.DebugFormat("[BARE BONES]: REGION {0} LOADED", scene.RegionInfo.RegionName); 83 m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
81 } 84 }
82 } 85 }
83} \ No newline at end of file 86} \ No newline at end of file