Add additional viewer support modules that allow certain viewers to modify their UI on the fly.

3 files changed, 494 insertions, 0 deletions

diff --git a/OpenSim/Region/OptionalModules/ViewerSupport/CameraOnlyModeModule.cs b/OpenSim/Region/OptionalModules/ViewerSupport/CameraOnlyModeModule.cs
new file mode 100644
index 0000000..c56e029
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/ViewerSupport/CameraOnlyModeModule.cs
@@ -0,0 +1,173 @@
+/*
+ * 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.IO;
+using System.Reflection;
+using System.Text;
+using System.Collections.Generic;
+using System.Threading;
+
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+using OpenSim;
+using OpenSim.Region;
+using OpenSim.Region.Framework;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Framework;
+//using OpenSim.Framework.Capabilities;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Servers.HttpServer;
+using Nini.Config;
+using log4net;
+using Mono.Addins;
+using OSDMap = OpenMetaverse.StructuredData.OSDMap;
+using TeleportFlags = OpenSim.Framework.Constants.TeleportFlags;
+
+namespace OpenSim.Region.OptionalModules.ViewerSupport
+{
+    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "CameraOnlyMode")]
+    public class CameraOnlyModeModule : INonSharedRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private Scene m_scene;
+        private SimulatorFeaturesHelper m_Helper;
+        private bool m_Enabled;
+        private int m_UserLevel;
+
+        public string Name
+        {
+            get { return "CameraOnlyModeModule"; }
+        }
+
+        public Type ReplaceableInterface
+        {
+            get { return null; }
+        }
+
+        public void Initialise(IConfigSource config)
+        {
+            IConfig moduleConfig = config.Configs["CameraOnlyModeModule"];
+            if (moduleConfig != null)
+            {
+                m_Enabled = moduleConfig.GetBoolean("enabled", false);
+                if (m_Enabled)
+                {
+                    m_UserLevel = moduleConfig.GetInt("UserLevel", 0);
+                    m_log.Info("[CAMERA-ONLY MODE]: CameraOnlyModeModule enabled");
+                }
+
+            }
+        }
+
+        public void Close()
+        {
+        }
+
+        public void AddRegion(Scene scene)
+        {
+            if (m_Enabled)
+            {
+                m_scene = scene;
+                IEntityTransferModule et = m_scene.RequestModuleInterface<IEntityTransferModule>();
+                m_Helper = new SimulatorFeaturesHelper(scene, et);
+                //m_scene.EventManager.OnMakeRootAgent += (OnMakeRootAgent);
+            }
+        }
+
+        //private void OnMakeRootAgent(ScenePresence obj)
+        //{
+        //    throw new NotImplementedException();
+        //}
+
+        public void RegionLoaded(Scene scene)
+        {
+            if (m_Enabled)
+            {
+                ISimulatorFeaturesModule featuresModule = m_scene.RequestModuleInterface<ISimulatorFeaturesModule>();
+
+                if (featuresModule != null && m_Enabled)
+                    featuresModule.OnSimulatorFeaturesRequest += OnSimulatorFeaturesRequest;
+            }
+        }
+
+        public void RemoveRegion(Scene scene)
+        {
+        }
+
+        private void OnSimulatorFeaturesRequest(UUID agentID, ref OSDMap features)
+        {
+            m_log.DebugFormat("[CAMERA-ONLY MODE]: OnSimulatorFeaturesRequest in {0}", m_scene.RegionInfo.RegionName);
+            if (m_Helper.ShouldSend(agentID) && m_Helper.UserLevel(agentID) <= m_UserLevel)
+            {
+                OSDMap extrasMap;
+                if (features.ContainsKey("OpenSimExtras"))
+                {
+                    extrasMap = (OSDMap)features["OpenSimExtras"];
+                }
+                else
+                {
+                    extrasMap = new OSDMap();
+                    features["OpenSimExtras"] = extrasMap;
+                }
+                extrasMap["camera-only-mode"] = OSDMap.FromString("true");
+                m_log.DebugFormat("[CAMERA-ONLY MODE]: Sent in {0}", m_scene.RegionInfo.RegionName);
+                Util.FireAndForget(delegate { DetachAttachments(agentID); });
+            }
+            else
+                m_log.DebugFormat("[CAMERA-ONLY MODE]: NOT Sending camera-only-mode in {0}", m_scene.RegionInfo.RegionName);
+        }
+
+        private void DetachAttachments(UUID agentID)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(agentID);
+            if ((sp.TeleportFlags & TeleportFlags.ViaLogin) != 0)
+                // Wait a little, cos there's weird stuff going on at  login related to
+                // the Current Outfit Folder
+                Thread.Sleep(8000);
+
+            if (sp != null && m_scene.AttachmentsModule != null)
+            {
+                List<SceneObjectGroup> attachs = sp.GetAttachments();
+                if (attachs != null && attachs.Count > 0)
+                {
+                    foreach (SceneObjectGroup sog in attachs)
+                    {
+                        m_log.DebugFormat("[CAMERA-ONLY MODE]: Forcibly detaching attach {0} from {1} in {2}", 
+                            sog.Name, sp.Name, m_scene.RegionInfo.RegionName);
+
+                        m_scene.AttachmentsModule.DetachSingleAttachmentToInv(sp, sog);
+                    }
+                }
+            }
+        }
+
+    }
+
+}
diff --git a/OpenSim/Region/OptionalModules/ViewerSupport/SimulatorFeaturesHelper.cs b/OpenSim/Region/OptionalModules/ViewerSupport/SimulatorFeaturesHelper.cs
new file mode 100644
index 0000000..1900f31
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/ViewerSupport/SimulatorFeaturesHelper.cs
@@ -0,0 +1,174 @@
+/*
+ * 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.IO;
+using System.Reflection;
+using System.Text;
+using System.Collections.Generic;
+using System.Threading;
+
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+using OpenSim;
+using OpenSim.Region;
+using OpenSim.Region.Framework;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Framework;
+using OpenSim.Services.Interfaces;
+//using OpenSim.Framework.Capabilities;
+using Nini.Config;
+using log4net;
+using OSDMap = OpenMetaverse.StructuredData.OSDMap;
+using TeleportFlags = OpenSim.Framework.Constants.TeleportFlags;
+
+namespace OpenSim.Region.OptionalModules.ViewerSupport
+{
+    public class SimulatorFeaturesHelper 
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private IEntityTransferModule m_TransferModule;
+        private Scene m_scene;
+
+        private struct RegionSend {
+            public UUID region;
+            public bool send;
+        };
+        // Using a static cache so that we don't have to perform the time-consuming tests
+        // in ShouldSend on Extra SimFeatures that go on the same response but come from
+        // different modules.
+        // This cached is indexed on the agentID and maps to a list of regions
+        private static ExpiringCache<UUID, List<RegionSend>> m_Cache = new ExpiringCache<UUID, List<RegionSend>>();
+        private const double TIMEOUT = 1.0; // time in cache
+
+        public SimulatorFeaturesHelper(Scene scene, IEntityTransferModule et)
+        {
+            m_scene = scene;
+            m_TransferModule = et;
+        }
+
+        public bool ShouldSend(UUID agentID)
+        {
+            List<RegionSend> rsendlist;
+            RegionSend rsend;
+            if (m_Cache.TryGetValue(agentID, out rsendlist))
+            {
+                rsend = rsendlist.Find(r => r.region == m_scene.RegionInfo.RegionID);
+                if (rsend.region != UUID.Zero) // Found it
+                {
+                    return rsend.send;
+                }
+            }
+
+            // Relatively complex logic for deciding whether to send the extra SimFeature or not.
+            // This is because the viewer calls this cap to all sims that it knows about,
+            // including the departing sims and non-neighbors (those that are cached).
+            rsend.region = m_scene.RegionInfo.RegionID;
+            rsend.send = false;
+            IClientAPI client = null;
+            int counter = 200;
+
+            // Let's wait a little to see if we get a client here
+            while (!m_scene.TryGetClient(agentID, out client) && counter-- > 0)
+                Thread.Sleep(50);
+
+            if (client != null)
+            {
+                ScenePresence sp = WaitGetScenePresence(agentID);
+                if (sp == null) // Client is connected but SP still doesn't exist: this may happen on login
+                {
+                    m_log.DebugFormat("[XXX]: SP is null");
+                }
+                else
+                {
+                    // On the receiving region, the call to this cap may arrive before
+                    // the agent is root. Make sure we only proceed from here when the agent
+                    // has been made root
+                    counter = 200;
+                    while ((sp.IsInTransit || sp.IsChildAgent) && counter-- > 0)
+                    {
+                        Thread.Sleep(50);
+                    }
+
+                    // The viewer calls this cap on the departing sims too. Make sure
+                    // that we only proceed after the agent is not in transit anymore.
+                    // The agent must be root and not going anywhere
+                    if (!sp.IsChildAgent && !m_TransferModule.IsInTransit(agentID))
+                        rsend.send = true;
+                    else
+                        m_log.DebugFormat("[XXX]: Child or in transit");
+                }
+            }
+            else
+                m_log.DebugFormat("[XXX]: client is null");
+
+            if (rsendlist == null)
+            {
+                rsendlist = new List<RegionSend>();
+                m_Cache.AddOrUpdate(agentID, rsendlist, TIMEOUT);
+            }
+            rsendlist.Add(rsend);
+
+            return rsend.send;
+        }
+
+        public int UserLevel(UUID agentID)
+        {
+            int level = 0;
+            UserAccount account = m_scene.UserAccountService.GetUserAccount(m_scene.RegionInfo.ScopeID, agentID);
+            if (account != null)
+                level = account.UserLevel;
+
+            return level;
+        }
+
+        protected virtual ScenePresence WaitGetScenePresence(UUID agentID)
+        {
+            int ntimes = 20;
+            ScenePresence sp = null;
+            while ((sp = m_scene.GetScenePresence(agentID)) == null && (ntimes-- > 0))
+                Thread.Sleep(1000);
+
+            if (sp == null)
+                m_log.WarnFormat(
+                    "[XXX]: Did not find presence with id {0} in {1} before timeout",
+                    agentID, m_scene.RegionInfo.RegionName);
+            else
+            {
+                ntimes = 10;
+                while (sp.IsInTransit && (ntimes-- > 0))
+                    Thread.Sleep(1000);
+            }
+
+            return sp;
+        }
+
+    }
+
+}
diff --git a/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs b/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs
new file mode 100644
index 0000000..6415c6c
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs
@@ -0,0 +1,147 @@
+/*
+ * 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.IO;
+using System.Reflection;
+using System.Text;
+using System.Collections.Generic;
+using System.Threading;
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+using OpenSim;
+using OpenSim.Region;
+using OpenSim.Region.Framework;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Framework;
+//using OpenSim.Framework.Capabilities;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Servers.HttpServer;
+using Nini.Config;
+using log4net;
+using Mono.Addins;
+using OSDMap = OpenMetaverse.StructuredData.OSDMap;
+using TeleportFlags = OpenSim.Framework.Constants.TeleportFlags;
+
+namespace OpenSim.Region.OptionalModules.ViewerSupport
+{
+    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "SpecialUI")]
+    public class SpecialUIModule : INonSharedRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private const string VIEWER_SUPPORT_DIR = "ViewerSupport";
+
+        private Scene m_scene;
+        private SimulatorFeaturesHelper m_Helper;
+        private bool m_Enabled;
+        private int m_UserLevel;
+
+        public string Name
+        {
+            get { return "SpecialUIModule"; }
+        }
+
+        public Type ReplaceableInterface
+        {
+            get { return null; }
+        }
+
+        public void Initialise(IConfigSource config)
+        {
+            IConfig moduleConfig = config.Configs["SpecialUIModule"];
+            if (moduleConfig != null)
+            {
+                m_Enabled = moduleConfig.GetBoolean("enabled", false);
+                if (m_Enabled)
+                {
+                    m_UserLevel = moduleConfig.GetInt("UserLevel", 0);
+                    m_log.Info("[SPECIAL UI]: SpecialUIModule enabled");
+                }
+
+            }
+        }
+
+        public void Close()
+        {
+        }
+
+        public void AddRegion(Scene scene)
+        {
+            if (m_Enabled)
+            {
+                m_scene = scene;
+                IEntityTransferModule et = m_scene.RequestModuleInterface<IEntityTransferModule>();
+                m_Helper = new SimulatorFeaturesHelper(scene, et);
+            }
+        }
+
+        public void RegionLoaded(Scene scene)
+        {
+            if (m_Enabled)
+            {
+                ISimulatorFeaturesModule featuresModule = m_scene.RequestModuleInterface<ISimulatorFeaturesModule>();
+
+                if (featuresModule != null && m_Enabled)
+                    featuresModule.OnSimulatorFeaturesRequest += OnSimulatorFeaturesRequest;
+            }
+        }
+
+        public void RemoveRegion(Scene scene)
+        {
+        }
+
+        private void OnSimulatorFeaturesRequest(UUID agentID, ref OSDMap features)
+        {
+            m_log.DebugFormat("[SPECIAL UI]: OnSimulatorFeaturesRequest in {0}", m_scene.RegionInfo.RegionName);
+            if (m_Helper.ShouldSend(agentID) && m_Helper.UserLevel(agentID) <= m_UserLevel)
+            {
+                using (StreamReader s = new StreamReader(Path.Combine(VIEWER_SUPPORT_DIR, "panel_toolbar.xml")))
+                {
+                    OSDMap extrasMap;
+                    if (features.ContainsKey("OpenSimExtras"))
+                        extrasMap = (OSDMap)features["OpenSimExtras"];
+                    else
+                    {
+                        extrasMap = new OSDMap();
+                        features["OpenSimExtras"] = extrasMap;
+                    }
+
+                    OSDMap specialUI = new OSDMap();
+                    specialUI["toolbar"] = OSDMap.FromString(s.ReadToEnd());
+                    extrasMap["special-ui"] = specialUI;
+                }
+                m_log.DebugFormat("[SPECIAL UI]: Sending panel_toolbar.xml in {0}", m_scene.RegionInfo.RegionName);
+            }
+            else
+                m_log.DebugFormat("[SPECIAL UI]: NOT Sending panel_toolbar.xml in {0}", m_scene.RegionInfo.RegionName);
+
+        }
+
+    }
+
+}