refactor some common code in RegionModulesControllerPlugin

also some minor doc changes in BareBonesNonSharedModule

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
                 new List<ISharedRegionModule>();
 
 #region IApplicationPlugin implementation
-
+        
         public void Initialise (OpenSimBase openSim)
         {
             m_openSim = openSim;
@@ -91,66 +91,24 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
             {
                 if (node.Type.GetInterface(typeof(ISharedRegionModule).ToString()) != null)
                 {
-                    // Get the config string
-                    string moduleString =
-                            modulesConfig.GetString("Setup_" + node.Id, String.Empty);
-
-                    // We have a selector
-                    if (moduleString != String.Empty)
+                    if (CheckModuleEnabled(node, modulesConfig))
                     {
-                        // Allow disabling modules even if they don't have
-                        // support for it
-                        if (moduleString == "disabled")
-                            continue;
-
-                        // Split off port, if present
-                        string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
-                        // Format is [port/][class]
-                        string className = moduleParts[0];
-                        if (moduleParts.Length > 1)
-                            className = moduleParts[1];
-
-                        // Match the class name if given
-                        if (className != String.Empty &&
-                                node.Type.ToString() != className)
-                            continue;
+                        m_log.DebugFormat("[REGIONMODULES]: Found shared region module {0}, class {1}", node.Id, node.Type);
+                        m_sharedModules.Add(node);
                     }
-
-                    m_log.DebugFormat("[REGIONMODULES]: Found shared region module {0}, class {1}", node.Id, node.Type);
-                    m_sharedModules.Add(node);
                 }
                 else if (node.Type.GetInterface(typeof(INonSharedRegionModule).ToString()) != null)
                 {
-                    // Get the config string
-                    string moduleString =
-                            modulesConfig.GetString("Setup_" + node.Id, String.Empty);
-
-                    // We have a selector
-                    if (moduleString != String.Empty)
+                    if (CheckModuleEnabled(node, modulesConfig))
                     {
-                        // Allow disabling modules even if they don't have
-                        // support for it
-                        if (moduleString == "disabled")
-                            continue;
-
-                        // Split off port, if present
-                        string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
-                        // Format is [port/][class]
-                        string className = moduleParts[0];
-                        if (moduleParts.Length > 1)
-                            className = moduleParts[1];
-
-                        // Match the class name if given
-                        if (className != String.Empty &&
-                                node.Type.ToString() != className)
-                            continue;
+                        m_log.DebugFormat("[REGIONMODULES]: Found non-shared region module {0}, class {1}", node.Id, node.Type);
+                        m_nonSharedModules.Add(node);
                     }
-
-                    m_log.DebugFormat("[REGIONMODULES]: Found non-shared region module {0}, class {1}", node.Id, node.Type);
-                    m_nonSharedModules.Add(node);
                 }
                 else
+                {
                     m_log.DebugFormat("[REGIONMODULES]: Found unknown type of module {0}, class {1}", node.Id, node.Type);
+                }
             }
 
             // Load and init the module. We try a constructor with a port
@@ -197,8 +155,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
                 m_sharedInstances.Add(module);
                 module.Initialise(m_openSim.ConfigSource.Source);
             }
-
-
         }
 
         public void PostInitialise ()
@@ -210,7 +166,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
             {
                 module.PostInitialise();
             }
-
         }
 
 #endregion
@@ -244,7 +199,6 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
 
 #endregion
 
-
         public string Version
         {
             get
@@ -262,6 +216,42 @@ namespace OpenSim.ApplicationPlugins.RegionModulesController
         }
 
 #region IRegionModulesController implementation
+        
+        /// <summary>
+        /// Check that the given module is no disabled in the [Modules] section of the config files.
+        /// </summary>
+        /// <param name="node"></param>
+        /// <param name="modulesConfig">The config section</param>
+        /// <returns>true if the module is enabled, false if it is disabled</returns>
+        protected bool CheckModuleEnabled(TypeExtensionNode node, IConfig modulesConfig)
+        {
+            // Get the config string
+            string moduleString =
+                    modulesConfig.GetString("Setup_" + node.Id, String.Empty);
+
+            // We have a selector
+            if (moduleString != String.Empty)
+            {
+                // Allow disabling modules even if they don't have
+                // support for it
+                if (moduleString == "disabled")
+                    return false;
+
+                // Split off port, if present
+                string[] moduleParts = moduleString.Split(new char[] { '/' }, 2);
+                // Format is [port/][class]
+                string className = moduleParts[0];
+                if (moduleParts.Length > 1)
+                    className = moduleParts[1];
+
+                // Match the class name if given
+                if (className != String.Empty &&
+                        node.Type.ToString() != className)
+                    return false;
+            }            
+            
+            return true;
+        }        
 
         // The root of all evil.
         // 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
     /// <remarks>
     /// This module is the simplest possible example of a non-shared region module (a module where each scene/region
     /// in the simulator has its own copy).  If anybody wants to create a more complex example in the future then 
-    /// please create a separate example.
+    /// please create a separate class.
     /// 
     /// This module is not active by default.  If you want to see it in action, 
     /// then just uncomment the line below starting with [Extension(Path...
+    /// 
+    /// When the module is enabled it will print messages when it receives certain events to the screen and the log
+    /// file.
     /// </remarks>
     //[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "BareBonesNonSharedModule")]
     public class BareBonesNonSharedModule : INonSharedRegionModule
@@ -57,27 +60,27 @@ namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
         
         public void Initialise(IConfigSource source)
         {
-            m_log.DebugFormat("[BARE BONES]: INITIALIZED MODULE");
+            m_log.DebugFormat("[BARE BONES NON SHARED]: INITIALIZED MODULE");
         }
         
         public void Close()
         {
-            m_log.DebugFormat("[BARE BONES]: CLOSED MODULE");
+            m_log.DebugFormat("[BARE BONES NON SHARED]: CLOSED MODULE");
         }
         
         public void AddRegion(Scene scene)
         {
-            m_log.DebugFormat("[BARE BONES]: REGION {0} ADDED", scene.RegionInfo.RegionName);
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
         }
         
         public void RemoveRegion(Scene scene)
         {
-            m_log.DebugFormat("[BARE BONES]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
         }        
         
         public void RegionLoaded(Scene scene)
         {
-            m_log.DebugFormat("[BARE BONES]: REGION {0} LOADED", scene.RegionInfo.RegionName);
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
         }                
     }
 }
\ No newline at end of file