Merge branch 'master' into careminster-presence-refactor

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
                 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/Application/OpenSimBase.cs b/OpenSim/Region/Application/OpenSimBase.cs
index 06b4aea..6a7272d 100644
--- a/OpenSim/Region/Application/OpenSimBase.cs
+++ b/OpenSim/Region/Application/OpenSimBase.cs
@@ -361,13 +361,13 @@ namespace OpenSim
             m_moduleLoader.InitialiseSharedModules(scene);
 
             // Use this in the future, the line above will be deprecated soon
-            m_log.Info("[REGIONMODULE]: Loading Region's modules (new style)");
+            m_log.Info("[REGIONMODULES]: Loading Region's modules (new style)");
             IRegionModulesController controller;
             if (ApplicationRegistry.TryGet(out controller))
             {
                 controller.AddRegionToModules(scene);
             }
-            else m_log.Error("[REGIONMODULE]: The new RegionModulesController is missing...");
+            else m_log.Error("[REGIONMODULES]: The new RegionModulesController is missing...");
 
             if (m_securePermissionsLoading)
             {
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;
 
 namespace OpenSim.Region.Examples.SimpleModule
 {
+    /// <summary>
+    /// Example region module.
+    /// </summary>
+    /// <remarks>
+    /// This is an old and unmaintained region module which uses the old style module interface.  It is not loaded into
+    /// OpenSim by default.  If you want to try enabling it, look in the bin folder of this project.
+    /// Please see the README.txt in this project on the filesystem for some more information.  
+    /// Nonetheless, it may contain some useful example code so has been left here for now.
+    /// 
+    /// You can see bare bones examples of the more modern region module system in OpenSim/Region/OptionalModules/Example
+    /// </remarks>
     public class RegionModule : IRegionModule
     {
         #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 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSimulator Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.Reflection;
+using log4net;
+using Mono.Addins;
+using Nini.Config;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared
+{
+    /// <summary>
+    /// Simplest possible example of a non-shared region module.
+    /// </summary>
+    /// <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 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
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        public string Name { get { return "Bare Bones Non Shared Module"; } }        
+        
+        public Type ReplaceableInterface { get { return null; } }
+        
+        public void Initialise(IConfigSource source)
+        {
+            m_log.DebugFormat("[BARE BONES NON SHARED]: INITIALIZED MODULE");
+        }
+        
+        public void Close()
+        {
+            m_log.DebugFormat("[BARE BONES NON SHARED]: CLOSED MODULE");
+        }
+        
+        public void AddRegion(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
+        }
+        
+        public void RemoveRegion(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
+        }        
+        
+        public void RegionLoaded(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES NON SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
+        }                
+    }
+}
\ 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 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSimulator Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.Reflection;
+using log4net;
+using Mono.Addins;
+using Nini.Config;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.OptionalModules.Example.BareBonesShared
+{
+    /// <summary>
+    /// Simplest possible example of a shared region module.
+    /// </summary>
+    /// <remarks>
+    /// This module is the simplest possible example of a shared region module (a module which is shared by every
+    /// scene/region running on the simulator).  If anybody wants to create a more complex example in the future then 
+    /// 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 = "BareBonesSharedModule")]
+    public class BareBonesSharedModule : ISharedRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);                
+        
+        public string Name { get { return "Bare Bones Shared Module"; } }        
+        
+        public Type ReplaceableInterface { get { return null; } }
+        
+        public void Initialise(IConfigSource source)
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: INITIALIZED MODULE");
+        }
+        
+        public void PostInitialise()
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: POST INITIALIZED MODULE");
+        }
+        
+        public void Close()
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: CLOSED MODULE");
+        }
+        
+        public void AddRegion(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} ADDED", scene.RegionInfo.RegionName);
+        }
+        
+        public void RemoveRegion(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
+        }        
+        
+        public void RegionLoaded(Scene scene)
+        {
+            m_log.DebugFormat("[BARE BONES SHARED]: REGION {0} LOADED", scene.RegionInfo.RegionName);
+        }                
+    }
+}
\ No newline at end of file