Finish the offline IM module (still needs a server). Add rudimentary

support for the mute list (no functionality yet, but allows the
RetrieveInstantMessages event to fire now).

OpenSim/Client/MXP/ClientStack/MXPClientView.cs

@@ -1601,5 +1601,9 @@ namespace OpenSim.Client.MXP.ClientStack
         public void SendUseCachedMuteList()
         {
         }
+
+        public void SendMuteListUpdate(string filename)
+        {
+        }
     }
 }

OpenSim/Framework/IClientAPI.cs

@@ -1133,6 +1133,7 @@ namespace OpenSim.Framework
         void SendUserInfoReply(bool imViaEmail, bool visible, string email);
         
         void SendUseCachedMuteList();
+        void SendMuteListUpdate(string filename);
 
         void KillEndDone();
 

OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs

@@ -8700,6 +8700,17 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             OutPacket(useCachedMuteList, ThrottleOutPacketType.Task);
         }
 
+        public void SendMuteListUpdate(string filename)
+        {
+            MuteListUpdatePacket muteListUpdate = (MuteListUpdatePacket)PacketPool.Instance.GetPacket(PacketType.MuteListUpdate);
+
+            muteListUpdate.MuteData = new MuteListUpdatePacket.MuteDataBlock();
+            muteListUpdate.MuteData.AgentID = AgentId;
+            muteListUpdate.MuteData.Filename = Utils.StringToBytes(filename);
+
+            OutPacket(muteListUpdate, ThrottleOutPacketType.Task);
+        }
+
         public string Report()
         {
             LLPacketHandler handler = (LLPacketHandler) m_PacketHandler;

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

@@ -0,0 +1,138 @@
+/*
+ * 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 System.Collections.Generic;
+using System.Reflection;
+using log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Client;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.Avatar.MuteList
+{
+    public class MuteListModule : IRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private bool enabled = true;
+        private List<Scene> m_SceneList = new List<Scene>();
+        private string m_RestURL = String.Empty;
+
+        public void Initialise(Scene scene, IConfigSource config)
+        {
+            if (!enabled)
+                return;
+
+            IConfig cnf = config.Configs["Messaging"];
+            if (cnf != null && cnf.GetString(
+                    "MuteListModule", "None") !=
+                    "MuteListModule")
+            {
+                enabled = false;
+                return;
+            }
+
+            lock (m_SceneList)
+            {
+                if (m_SceneList.Count == 0)
+                {
+                    m_RestURL = cnf.GetString("MuteListURL", "");
+                    if (m_RestURL == "")
+                    {
+                        m_log.Error("[MUTE LIST] Module was enabled, but no URL is given, disabling");
+                        enabled = false;
+                        return;
+                    }
+                }
+                if (!m_SceneList.Contains(scene))
+                    m_SceneList.Add(scene);
+
+                scene.EventManager.OnNewClient += OnNewClient;
+            }
+        }
+
+        public void PostInitialise()
+        {
+            if (!enabled)
+                return;
+
+            if (m_SceneList.Count == 0)
+                return;
+
+            m_log.Debug("[MUTE LIST] Mute list enabled");
+        }
+
+        public string Name
+        {
+            get { return "MuteListModule"; }
+        }
+
+        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 != null && !presence.IsChildAgent)
+                    return presence.ControllingClient;
+            }
+            return null;
+        }
+
+        private void OnNewClient(IClientAPI client)
+        {
+            client.OnMuteListRequest += OnMuteListRequest;
+        }
+
+        private void OnMuteListRequest(IClientAPI client, uint crc)
+        {
+            m_log.DebugFormat("[MUTE LIST] Got mute list requestg for crc {0}", crc);
+            string filename = "mutes"+client.AgentId.ToString();
+
+            IXfer xfer = client.Scene.RequestModuleInterface<IXfer>();
+            if (xfer != null)
+            {
+                xfer.AddNewFile(filename, new Byte[0]);
+                client.SendMuteListUpdate(filename);
+            }
+        }
+    }
+}
+

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

@@ -24,12 +24,15 @@
  * (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.Collections.Generic;
 using System.Reflection;
 using log4net;
 using Nini.Config;
 using OpenMetaverse;
 using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Servers;
 using OpenSim.Framework.Client;
 using OpenSim.Region.Framework.Interfaces;
 using OpenSim.Region.Framework.Scenes;
@@ -40,21 +43,36 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
     {
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-        private bool enabled = false;
+        private bool enabled = true;
         private List<Scene> m_SceneList = new List<Scene>();
+        private string m_RestURL = String.Empty;
 
         public void Initialise(Scene scene, IConfigSource config)
         {
+            if (!enabled)
+                return;
+
             IConfig cnf = config.Configs["Messaging"];
             if (cnf != null && cnf.GetString(
                     "OfflineMessageModule", "None") !=
                     "OfflineMessageModule")
+            {
+                enabled = false;
                 return;
-
+            }
-            enabled = true;
 
             lock (m_SceneList)
             {
+                if (m_SceneList.Count == 0)
+                {
+                    m_RestURL = cnf.GetString("OfflineMessageURL", "");
+                    if (m_RestURL == "")
+                    {
+                        m_log.Error("[OFFLINE MESSAGING] Module was enabled, but no URL is given, disabling");
+                        enabled = false;
+                        return;
+                    }
+                }
                 if (!m_SceneList.Contains(scene))
                     m_SceneList.Add(scene);
 
@@ -64,6 +82,9 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
 
         public void PostInitialise()
         {
+            if (!enabled)
+                return;
+
             if (m_SceneList.Count == 0)
                 return;
 
@@ -80,6 +101,7 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
                     m_SceneList.Clear();
                 }
 
+                m_log.Error("[OFFLINE MESSAGING] No message transfer module is enabled. Diabling offline messages");
                 return;
             }
 
@@ -107,7 +129,7 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
             foreach (Scene s in m_SceneList)
             {
                 ScenePresence presence = s.GetScenePresence(agentID);
-                if (!presence.IsChildAgent)
+                if (presence != null && !presence.IsChildAgent)
                     return presence.ControllingClient;
             }
             return null;
@@ -116,18 +138,49 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
         private void OnNewClient(IClientAPI client)
         {
             client.OnRetrieveInstantMessages += RetrieveInstantMessages;
+            // TODO:: Remove when mute lists are supported
+            //
+            //client.OnEconomyDataRequest += OnEconomyDataRequest;
         }
 
+        // TODO: Remove method when mute lists are supported
+        //
+        //private void OnEconomyDataRequest(UUID agentID)
+        //{
+        //    IClientAPI client = FindClient(agentID);
+        //    if (client == null)
+        //    {
+        //        m_log.ErrorFormat("[OFFLINE MESSAGING] Can't find client {0}", agentID.ToString());
+        //        return;
+        //    }
+        //    RetrieveInstantMessages(client);
+        //}
+
         private void RetrieveInstantMessages(IClientAPI client)
         {
-            m_log.Debug("[OFFLINE MESSAGING] RetrieveInstantMessages called");
+            m_log.DebugFormat("[OFFLINE MESSAGING] Retrieving stored messages for {0}", client.AgentId);
+
+            List<GridInstantMessage>msglist = SynchronousRestObjectPoster.BeginPostObject<UUID, List<GridInstantMessage>>(
+                    "POST", m_RestURL+"/RetrieveMessages/", client.AgentId);
+
+            foreach (GridInstantMessage im in msglist)
+            {
+                DateTime saved = Util.ToDateTime((uint)im.timestamp);
+
+                client.SendInstantMessage(new UUID(im.toAgentID),
+                        "(saved " + saved.ToString() + ") " + im.message,
+                        new UUID(im.fromAgentID), im.fromAgentName,
+                        (byte)im.dialog,
+                        (uint)im.timestamp);
+            }
         }
 
         private void UndeliveredMessage(GridInstantMessage im)
         {
             if (im.offline != 0)
             {
-                // TODO: Actually save it
+                bool success = SynchronousRestObjectPoster.BeginPostObject<GridInstantMessage, bool>(
+                        "POST", m_RestURL+"/SaveMessage/", im);
 
                 if(im.dialog == (byte)InstantMessageDialog.MessageFromAgent)
                 {
@@ -137,9 +190,9 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
 
                     client.SendInstantMessage(new UUID(im.fromAgentID),
                             "User is not logged in. "+
-                            "Message saved.",
+                            (success ? "Message saved." : "Message not saved"),
                             new UUID(im.toAgentID), "System",
-                            (byte)InstantMessageDialog.BusyAutoResponse,
+                            (byte)InstantMessageDialog.MessageFromAgent,
                             (uint)Util.UnixTimeSinceEpoch());
                 }
             }

OpenSim/Region/Examples/SimpleModule/MyNpcCharacter.cs

@@ -1068,6 +1068,10 @@ namespace OpenSim.Region.Examples.SimpleModule
         {
         }
 
+        public void SendMuteListUpdate(string filename)
+        {
+        }
+
         #endregion
     }
 }

OpenSim/Region/OptionalModules/World/NPC/NPCAvatar.cs

@@ -1068,6 +1068,10 @@ namespace OpenSim.Region.OptionalModules.World.NPC
         {
         }
 
+        public void SendMuteListUpdate(string filename)
+        {
+        }
+
         #endregion
     }
 }

OpenSim/Tests/Common/Mock/TestClient.cs

@@ -1109,5 +1109,9 @@ namespace OpenSim.Tests.Common.Mock
         public void SendUseCachedMuteList()
         {
         }
+
+        public void SendMuteListUpdate(string filename)
+        {
+        }
     }
 }

bin/OpenSim.ini.example

@@ -378,6 +378,8 @@ InterregionComms = "RESTComms"
     ; MessageTransferModule = MessageTransferModule
     ; OfflineMessageModule = OfflineMessageModule
     ; OfflineMessagesURL = http://yourserver/offlines.php
+    ; MuteListModule = MuteListModule
+    ; MuteListsURL = http://yourserver/mutes.php
 
 
 [ODEPhysicsSettings]