- 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...

8 files changed, 288 insertions, 20 deletions

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
             IClientNetworkServer clientServer;
             Scene scene = SetupScene(regionInfo, proxyOffset, m_config.Source, out clientServer);
 
-            m_log.Info("[MODULES]: Loading Region's modules");
+            m_log.Info("[MODULES]: Loading Region's modules (old style)");
 
             List<IRegionModule> modules = m_moduleLoader.PickupModules(scene, ".");
 
@@ -525,6 +525,15 @@ namespace OpenSim
             // script module can pick up events exposed by a module
             m_moduleLoader.InitialiseSharedModules(scene);
 
+            // Use this in the future, the line above will be deprecated soon
+            m_log.Info("[MODULES]: Loading Region's modules (new style)");
+            IRegionModulesController controller;
+            if (ApplicationRegistry.TryGet(out controller))
+            {
+                controller.AddRegionToModules(scene);
+            }
+            else m_log.Error("[MODULES]: The new RegionModulesController is missing...");
+
             scene.SetModuleInterfaces();
 
             // Prims have to be loaded after module configuration since some modules may be invoked during the load            
@@ -571,11 +580,22 @@ namespace OpenSim
                     module.PostInitialise();
                 }
             }
+            scene.EventManager.OnShutdown += delegate() { ShutdownRegion(scene); };
 
             mscene = scene;
             return clientServer;
         }
 
+        private void ShutdownRegion(Scene scene)
+        {
+            m_log.DebugFormat("[SHUTDOWN]: Shutting down region {0}", scene.RegionInfo.RegionName);
+            IRegionModulesController controller;
+            if (ApplicationRegistry.TryGet<IRegionModulesController>(out controller))
+            {
+                controller.RemoveRegionFromModules(scene);
+            }
+        }
+
         public void RemoveRegion(Scene scene, bool cleanup)
         {
             // 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 @@
+<Addin id="OpenSim.Region.CoreModules" version="0.2">
+    <Runtime>
+        <Import assembly="OpenSim.Region.CoreModules.dll"/>
+    </Runtime>
+
+    <Dependencies>
+        <Addin id="OpenSim" version="0.5" />
+    </Dependencies>
+
+    <Extension path = "/OpenSim/RegionModules">
+        <RegionModule id="WorldMapModule" type="OpenSim.Region.CoreModules.World.WorldMap.NewWorldMapModule" />
+        <RegionModule id="CommsModule" type="OpenSim.Region.CoreModules.Communications.Local.NewLocalInterregionComms" />
+    </Extension>
+
+    <Extension path = "/OpenSim/WindModule">
+        <WindModel id="ConfigurableWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind" />
+        <WindModel id="SimpleRandomWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind" />
+    </Extension>
+
+</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 @@
-<Addin id="WindModule.Default.WindModels" version="1.0">
-    <Runtime>
-        <Import assembly="OpenSim.Region.CoreModules.dll"/>
-    </Runtime>
-    <Dependencies>
-        <Addin id="OpenSim" version="0.5" />
-    </Dependencies>
-        <Extension path = "/OpenSim/WindModule">
-                <WindModel id="ConfigurableWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind" />
-                <WindModel id="SimpleRandomWind" type="OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind" />
-        </Extension>
-</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 @@
+/*
+ * 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 OpenSim 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;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+    public interface INonSharedRegionModule : IRegionModuleBase
+    {
+    }
+}
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 @@
+/*
+ * 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 OpenSim 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 Mono.Addins;
+using Nini.Config;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+    public interface IRegionModuleBase
+    {
+        /// <value>
+        /// The name of the module
+        /// </value>
+        string Name { get; }
+
+        /// <summary>
+        /// This is called to initialize the region module. For shared modules, this is called
+        /// exactly once, after creating the single (shared) instance. For non-shared modules,
+        /// this is called once on each instance, after the instace for the region has been created.
+        /// </summary>
+        /// <param name="source">
+        /// A <see cref="IConfigSource"/>
+        /// </param>
+        void Initialise(IConfigSource source);
+
+        /// <summary>
+        /// This is the inverse to <see cref="Initialise"/>. After a Close(), this instance won't be usable anymore.
+        /// </summary>
+        void Close();
+
+        /// <summary>
+        /// This is called whenever a <see cref="Scene"/> is added. For shared modules, this can happen several times.
+        /// For non-shared modules, this happens exactly once, after <see cref="Initialise"/> has been called.
+        /// </summary>
+        /// <param name="scene">
+        /// A <see cref="Scene"/>
+        /// </param>
+        void AddRegion(Scene scene);
+
+        /// <summary>
+        /// This is called whenever a <see cref="Scene"/> is removed. For shared modules, this can happen several times.
+        /// For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.
+        /// </summary>
+        /// <param name="scene">
+        /// A <see cref="Scene"/>
+        /// </param>
+        void RemoveRegion(Scene scene);
+    }
+
+}
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 @@
+/*
+ * 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 OpenSim 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 OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+    public interface IRegionModulesController
+    {
+        void AddRegionToModules(Scene scene);
+        void RemoveRegionFromModules (Scene scene);
+    }
+}
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 @@
+/*
+ * 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 OpenSim 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;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+    public interface ISharedRegionModule : IRegionModuleBase
+    {
+        /// <summary>
+        /// This is called exactly once after all the shared region-modules have been instanciated and
+        /// <see cref="IRegionModuleBase.Initialise"/>d.
+        /// </summary>
+        void PostInitialise();
+    }
+}
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
         }
         protected Dictionary<string, IRegionModule> m_modules = new Dictionary<string, IRegionModule>();
 
+        public Dictionary<string, IRegionModuleBase> RegionModules
+        {
+            get { return m_regionModules; }
+        }
+        private Dictionary<string, IRegionModuleBase> m_regionModules = new Dictionary<string, IRegionModuleBase>();
+
         /// <value>
         /// The module interfaces available from this scene.
         /// </value>
         protected Dictionary<Type, List<object>> ModuleInterfaces = new Dictionary<Type, List<object>>();
 
         protected Dictionary<string, object> ModuleAPIMethods = new Dictionary<string, object>();
-        
+
         /// <value>
         /// The module commanders available from this scene
         /// </value>
@@ -235,7 +241,7 @@ namespace OpenSim.Region.Framework.Scenes
                 }
             }
             Modules.Clear();
-            
+
             try
             {
                 EventManager.TriggerShutdown();
@@ -279,6 +285,24 @@ namespace OpenSim.Region.Framework.Scenes
         }
 
         /// <summary>
+        /// Add a region-module to this scene. TODO: This will replace AddModule in the future.
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="module"></param>
+        public void AddRegionModule(string name, IRegionModuleBase module)
+        {
+            if (!RegionModules.ContainsKey(name))
+            {
+                RegionModules.Add(name, module);
+            }
+        }
+
+        public void RemoveRegionModule(string name)
+        {
+            RegionModules.Remove(name);
+        }
+
+        /// <summary>
         /// Register a module commander.
         /// </summary>
         /// <param name="commander"></param>
@@ -368,6 +392,25 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
+        public void UnregisterModuleInterface<M>(M mod)
+        {
+            List<Object> l;
+            if (ModuleInterfaces.TryGetValue(typeof(M), out l))
+            {
+                if (l.Remove(mod))
+                {
+                    if (mod is IEntityCreator)
+                    {
+                        IEntityCreator entityCreator = (IEntityCreator)mod;
+                        foreach (PCode pcode in entityCreator.CreationCapabilities)
+                        {
+                            m_entityCreators[pcode] = null;
+                        }
+                    }
+                }
+            }
+        }
+
         public void StackModuleInterface<M>(M mod)
         {
             List<Object> l;
@@ -462,11 +505,19 @@ namespace OpenSim.Region.Framework.Scenes
 
             if (mod != null)
             {
-                if (!(mod is IRegionModule))
-                    throw new Exception("AddCommand module parameter must be IRegionModule");
-                IRegionModule module = (IRegionModule)mod;
-                modulename = module.Name;
-                shared = module.IsSharedModule;
+                if (mod is IRegionModule)
+                {
+                    IRegionModule module = (IRegionModule)mod;
+                    modulename = module.Name;
+                    shared = module.IsSharedModule;
+                }
+                else if (mod is IRegionModuleBase)
+                {
+                    IRegionModuleBase module = (IRegionModuleBase)mod;
+                    modulename = module.Name;
+                    shared = mod is ISharedRegionModule;
+                }
+                else throw new Exception("AddCommand module parameter must be IRegionModule or IRegionModuleBase");
             }
 
             MainConsole.Instance.Commands.AddCommand(modulename, shared, command, shorthelp, longhelp, callback);