Add a module skeleton for offline IM storage. No functionality yet.

OpenSim/Region/CoreModules/Avatar/InstantMessage/OfflineMessageModule.cs

@@ -0,0 +1,131 @@
+/*
+ * 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.Collections.Generic;
+using System.Reflection;
+using log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Client;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
+{
+    public class OfflineMessageModule : IRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private bool enabled = false;
+        private List<Scene> m_SceneList = new List<Scene>();
+
+        public void Initialise(Scene scene, IConfigSource config)
+        {
+            IConfig cnf = config.Configs["Messaging"];
+            if (cnf != null && cnf.GetString(
+                    "OfflineMessageModule", "None") !=
+                    "OfflineMessageModule")
+                return;
+
+            enabled = true;
+
+            lock (m_SceneList)
+            {
+                if (m_SceneList.Count == 0)
+                {
+                    IMessageTransferModule trans = scene.RequestModuleInterface<IMessageTransferModule>();
+                    if (trans == null)
+                    {
+                        enabled = false;
+                        return;
+                    }
+
+                    trans.OnUndeliveredMessage += UndeliveredMessage;
+                }
+
+                if (!m_SceneList.Contains(scene))
+                    m_SceneList.Add(scene);
+
+                scene.EventManager.OnNewClient += OnNewClient;
+            }
+        }
+
+        public void PostInitialise()
+        {
+        }
+
+        public string Name
+        {
+            get { return "OfflineMessageModule"; }
+        }
+
+        public bool IsSharedModule
+        {
+            get { return true; }
+        }
+        
+        public void Close()
+        {
+        }
+
+        private IClientAPI FindClient(UUID agentID)
+        {
+            foreach (Scene s in m_SceneList)
+            {
+                ScenePresence presence = s.GetScenePresence(agentID);
+                if (!presence.IsChildAgent)
+                    return presence.ControllingClient;
+            }
+            return null;
+        }
+
+        private void OnNewClient(IClientAPI client)
+        {
+            client.OnRetrieveInstantMessages += RetrieveInstantMessages;
+        }
+
+        private void RetrieveInstantMessages(IClientAPI client)
+        {
+            m_log.Debug("[OFFLINE MESSAGING] RetrieveInstantMessages called");
+        }
+
+        private void UndeliveredMessage(GridInstantMessage im)
+        {
+            IClientAPI client = FindClient(new UUID(im.toAgentID));
+            if (client == null)
+                return;
+
+            client.SendInstantMessage(new UUID(im.toAgentID),
+                    "User is not logged in. "+
+                    "Message saved.",
+                    new UUID(im.fromAgentID), "System",
+                    (byte)InstantMessageDialog.BusyAutoResponse,
+                    (uint)Util.UnixTimeSinceEpoch());
+        }
+    }
+}
+

bin/OpenSim.ini.example

@@ -375,6 +375,9 @@ InterregionComms = "RESTComms"
     ; Control which region module is used for instant messaging.
     ; Default is InstantMessageModule (this is the name of the core IM module as well as the setting)
     InstantMessageModule = InstantMessageModule
+    ; MessageTransferModule = MessageTransferModule
+    ; OfflineMessageModule = OfflineMessageModule
+    ; OfflineMessagesURL = http://yourserver/offlines.php
 
 
 [ODEPhysicsSettings]