Patch from mcortez. This appears to be a huge change to the groups module

and I can't say if this is beneficial or destructive due to the way it
was delivered (zipfile). Pushing this on faith alone.

1 files changed, 98 insertions, 118 deletions

diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
index 533815f..17a5349 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
@@ -49,14 +49,9 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         private List<Scene> m_sceneList = new List<Scene>();
 
-        private IMessageTransferModule m_msgTransferModule = null;
-
-        private IGroupsModule m_groupsModule = null;
-
-        // TODO: Move this off to the Groups Server
-        public Dictionary<Guid, List<Guid>> m_agentsInGroupSession = new Dictionary<Guid, List<Guid>>();
-        public Dictionary<Guid, List<Guid>> m_agentsDroppedSession = new Dictionary<Guid, List<Guid>>();
-
+        private IMessageTransferModule m_msgTransferModule = null;

+

+        private IGroupsServicesConnector m_groupData = null;

 
         // Config Options
         private bool m_groupMessagingEnabled = false;
@@ -113,14 +108,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             if (!m_groupMessagingEnabled)
                 return;
 
-            if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);
-
-            m_groupsModule = scene.RequestModuleInterface<IGroupsModule>();
+            if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);

+

+            m_groupData = scene.RequestModuleInterface<IGroupsServicesConnector>();
 
-            // No groups module, no groups messaging
-            if (m_groupsModule == null)
-            {
-                m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsModule, GroupsMessagingModule is now disabled.");
+            // No groups module, no groups messaging

+            if (m_groupData == null)
+            {

+                m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsServicesConnector, GroupsMessagingModule is now disabled.");
                 Close();
                 m_groupMessagingEnabled = false;
                 return;
@@ -142,7 +137,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
             scene.EventManager.OnNewClient += OnNewClient;
             scene.EventManager.OnIncomingInstantMessage += OnGridInstantMessage;
-
+            scene.EventManager.OnClientLogin += OnClientLogin;
         }
 
         public void RemoveRegion(Scene scene)
@@ -170,7 +165,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
             m_sceneList.Clear();
 
-            m_groupsModule = null;
+            m_groupData = null;
             m_msgTransferModule = null;
         }
 
@@ -195,16 +190,18 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         #endregion
 
+        /// <summary>

+        /// Not really needed, but does confirm that the group exists.

+        /// </summary>

         public bool StartGroupChatSession(UUID agentID, UUID groupID)
         {
             if (m_debugEnabled)
                 m_log.DebugFormat("[GROUPS-MESSAGING]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);
                 
-            GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID);
+            GroupRecord groupInfo = m_groupData.GetGroupRecord(agentID, groupID, null);
 
             if (groupInfo != null)
-            {
-                AddAgentToGroupSession(agentID.Guid, groupID.Guid);
+            {

                 return true;
             }
             else
@@ -216,11 +213,12 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
         public void SendMessageToGroup(GridInstantMessage im, UUID groupID)
         {
             if (m_debugEnabled) 
-                m_log.DebugFormat("[GROUPS-MESSAGING]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);
-
-            foreach (GroupMembersData member in m_groupsModule.GroupMembersRequest(null, groupID))
-            {
-                if (!m_agentsDroppedSession.ContainsKey(im.imSessionID) || m_agentsDroppedSession[im.imSessionID].Contains(member.AgentID.Guid))
+                m_log.DebugFormat("[GROUPS-MESSAGING]: {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);

+

+

+            foreach (GroupMembersData member in m_groupData.GetGroupMembers(UUID.Zero, groupID))
+            {

+                if (m_groupData.hasAgentDroppedGroupChatSession(member.AgentID, groupID))
                 {
                     // Don't deliver messages to people who have dropped this session
                     if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: {0} has dropped session, not delivering to them", member.AgentID);
@@ -228,8 +226,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                 }
 
                 // Copy Message
-                GridInstantMessage msg = new GridInstantMessage();
-                msg.imSessionID = im.imSessionID;
+                GridInstantMessage msg = new GridInstantMessage();

+                msg.imSessionID = groupID.Guid;
                 msg.fromAgentName = im.fromAgentName;
                 msg.message = im.message;
                 msg.dialog = im.dialog;
@@ -240,8 +238,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                 msg.binaryBucket = im.binaryBucket;
                 msg.timestamp = (uint)Util.UnixTimeSinceEpoch();
 
-                // Updat Pertinate fields to make it a "group message"
-                msg.fromAgentID = groupID.Guid;
+                msg.fromAgentID = im.fromAgentID;
                 msg.fromGroup = true;
 
                 msg.toAgentID = member.AgentID.Guid;
@@ -262,7 +259,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             }
         }
         
-        #region SimGridEventHandlers
+        #region SimGridEventHandlers

+

+        void OnClientLogin(IClientAPI client)

+        {

+            if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: OnInstantMessage registered for {0}", client.Name);
+

+            

+        }
 
         private void OnNewClient(IClientAPI client)
         {
@@ -299,44 +303,48 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         private void ProcessMessageFromGroupSession(GridInstantMessage msg)
         {
-            if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Session message from {0} going to agent {1}", msg.fromAgentName, msg.toAgentID);
+            if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Session message from {0} going to agent {1}", msg.fromAgentName, msg.toAgentID);

+

+            UUID AgentID = new UUID(msg.fromAgentID);

+            UUID GroupID = new UUID(msg.imSessionID);
 
             switch (msg.dialog)
             {
-                case (byte)InstantMessageDialog.SessionAdd:
-                    AddAgentToGroupSession(msg.fromAgentID, msg.imSessionID);
+                case (byte)InstantMessageDialog.SessionAdd:

+                    m_groupData.AgentInvitedToGroupChatSession(AgentID, GroupID);
                     break;
 
-                case (byte)InstantMessageDialog.SessionDrop:
-                    RemoveAgentFromGroupSession(msg.fromAgentID, msg.imSessionID);
+                case (byte)InstantMessageDialog.SessionDrop:

+                    m_groupData.AgentDroppedFromGroupChatSession(AgentID, GroupID);
                     break;
 
-                case (byte)InstantMessageDialog.SessionSend:
-                    if (!m_agentsInGroupSession.ContainsKey(msg.toAgentID)
-                        && !m_agentsDroppedSession.ContainsKey(msg.toAgentID))
+                case (byte)InstantMessageDialog.SessionSend:

+                    if (!m_groupData.hasAgentDroppedGroupChatSession(AgentID, GroupID)

+                        && !m_groupData.hasAgentBeenInvitedToGroupChatSession(AgentID, GroupID)
+                        )
                     {
                         // Agent not in session and hasn't dropped from session
-                        // Add them to the session for now, and Invite them
-                        AddAgentToGroupSession(msg.toAgentID, msg.imSessionID);
+                        // Add them to the session for now, and Invite them

+                        m_groupData.AgentInvitedToGroupChatSession(AgentID, GroupID);
 
                         UUID toAgentID = new UUID(msg.toAgentID);
                         IClientAPI activeClient = GetActiveClient(toAgentID);
                         if (activeClient != null)
                         {
-                            UUID groupID = new UUID(msg.fromAgentID);
-
-                            GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID);
+                            GroupRecord groupInfo = m_groupData.GetGroupRecord(UUID.Zero, GroupID, null);
                             if (groupInfo != null)
                             {
                                 if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Sending chatterbox invite instant message");
 
-                                // Force? open the group session dialog???
+                                // Force? open the group session dialog???

+                                // and simultanously deliver the message, so we don't need to do a seperate client.SendInstantMessage(msg);
                                 IEventQueue eq = activeClient.Scene.RequestModuleInterface<IEventQueue>();
-                                eq.ChatterboxInvitation(
-                                    groupID
+                                eq.ChatterboxInvitation(

+                                    GroupID
                                     , groupInfo.GroupName
                                     , new UUID(msg.fromAgentID)
-                                    , msg.message, new UUID(msg.toAgentID)
+                                    , msg.message
+                                    , new UUID(msg.toAgentID)
                                     , msg.fromAgentName
                                     , msg.dialog
                                     , msg.timestamp
@@ -349,8 +357,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                                     , Utils.StringToBytes(groupInfo.GroupName)
                                     );
 
-                                eq.ChatterBoxSessionAgentListUpdates(
-                                    new UUID(groupID)
+                                eq.ChatterBoxSessionAgentListUpdates(

+                                    new UUID(GroupID)
                                     , new UUID(msg.fromAgentID)
                                     , new UUID(msg.toAgentID)
                                     , false //canVoiceChat
@@ -359,8 +367,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                                     );
                             }
                         }
-                    }
-                    else if (!m_agentsDroppedSession.ContainsKey(msg.toAgentID))
+                    }

+                    else if (!m_groupData.hasAgentDroppedGroupChatSession(AgentID, GroupID))
                     {
                         // User hasn't dropped, so they're in the session, 
                         // maybe we should deliver it.
@@ -386,56 +394,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         #endregion
 
-        #region ClientEvents
-
-        private void RemoveAgentFromGroupSession(Guid agentID, Guid sessionID)
-        {
-            if (m_agentsInGroupSession.ContainsKey(sessionID))
-            {
-                // If in session remove
-                if (m_agentsInGroupSession[sessionID].Contains(agentID))
-                {
-                    m_agentsInGroupSession[sessionID].Remove(agentID);
-                }
-
-                // If not in dropped list, add
-                if (!m_agentsDroppedSession[sessionID].Contains(agentID))
-                {
-                    if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Dropped {1} from session {0}", sessionID, agentID);
-                    m_agentsDroppedSession[sessionID].Add(agentID);
-                }
-            }
-        }
-
-        private void AddAgentToGroupSession(Guid agentID, Guid sessionID)
-        {
-            // Add Session Status if it doesn't exist for this session
-            CreateGroupSessionTracking(sessionID);
-
-            // If nessesary, remove from dropped list
-            if (m_agentsDroppedSession[sessionID].Contains(agentID))
-            {
-                m_agentsDroppedSession[sessionID].Remove(agentID);
-            }
-
-            // If nessesary, add to in session list
-            if (!m_agentsInGroupSession[sessionID].Contains(agentID))
-            {
-                if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Added {1} to session {0}", sessionID, agentID);
-                m_agentsInGroupSession[sessionID].Add(agentID);
-            }
-        }
-
-        private void CreateGroupSessionTracking(Guid sessionID)
-        {
-            if (!m_agentsInGroupSession.ContainsKey(sessionID))
-            {
-                if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING]: Creating session tracking for : {0}", sessionID);
-                m_agentsInGroupSession.Add(sessionID, new List<Guid>());
-                m_agentsDroppedSession.Add(sessionID, new List<Guid>());
-            }
-        }
-        
+

+        #region ClientEvents

         private void OnInstantMessage(IClientAPI remoteClient, GridInstantMessage im)
         {
             if (m_debugEnabled)
@@ -447,20 +407,24 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
             // Start group IM session
             if ((im.dialog == (byte)InstantMessageDialog.SessionGroupStart))
-            {
-                UUID groupID = new UUID(im.toAgentID);
-                GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID);
+            {

+                if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING]: imSessionID({0}) toAgentID({1})", im.imSessionID, im.toAgentID);

+

+                UUID GroupID = new UUID(im.imSessionID);

+                UUID AgentID = new UUID(im.fromAgentID);

+

+                GroupRecord groupInfo = m_groupData.GetGroupRecord(UUID.Zero, GroupID, null);
     
                 if (groupInfo != null)
-                {                
-                    AddAgentToGroupSession(im.fromAgentID, groupInfo.GroupID.Guid);
+                {

+                    m_groupData.AgentInvitedToGroupChatSession(AgentID, GroupID);
 
-                    ChatterBoxSessionStartReplyViaCaps(remoteClient, groupInfo.GroupName, groupID);
+                    ChatterBoxSessionStartReplyViaCaps(remoteClient, groupInfo.GroupName, GroupID);
 
                     IEventQueue queue = remoteClient.Scene.RequestModuleInterface<IEventQueue>();
-                    queue.ChatterBoxSessionAgentListUpdates(
-                        new UUID(groupID)
-                        , new UUID(im.fromAgentID)
+                    queue.ChatterBoxSessionAgentListUpdates(

+                        GroupID

+                        , AgentID
                         , new UUID(im.toAgentID)
                         , false //canVoiceChat
                         , false //isModerator
@@ -471,13 +435,17 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
             // Send a message from locally connected client to a group
             if ((im.dialog == (byte)InstantMessageDialog.SessionSend))
-            {
-                UUID groupID = new UUID(im.toAgentID);
+            {

+                UUID GroupID = new UUID(im.imSessionID);

+                UUID AgentID = new UUID(im.fromAgentID);

 
                 if (m_debugEnabled) 
-                    m_log.DebugFormat("[GROUPS-MESSAGING]: Send message to session for group {0} with session ID {1}", groupID, im.imSessionID.ToString());
+                    m_log.DebugFormat("[GROUPS-MESSAGING]: Send message to session for group {0} with session ID {1}", GroupID, im.imSessionID.ToString());
 
-                SendMessageToGroup(im, groupID);
+                //If this agent is sending a message, then they want to be in the session

+                m_groupData.AgentInvitedToGroupChatSession(AgentID, GroupID);

+

+                SendMessageToGroup(im, GroupID);
             }
         }
 
@@ -533,7 +501,9 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
         /// Try to find an active IClientAPI reference for agentID giving preference to root connections
         /// </summary>
         private IClientAPI GetActiveClient(UUID agentID)
-        {
+        {

+            if (m_debugEnabled) m_log.WarnFormat("[GROUPS-MESSAGING]: Looking for local client {0}", agentID);
+
             IClientAPI child = null;
 
             // Try root avatar first
@@ -544,17 +514,27 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                 {
                     ScenePresence user = (ScenePresence)scene.Entities[agentID];
                     if (!user.IsChildAgent)
-                    {
+                    {

+                        if (m_debugEnabled) m_log.WarnFormat("[GROUPS-MESSAGING]: Found root agent for client : {0}", user.ControllingClient.Name);

                         return user.ControllingClient;
                     }
                     else
-                    {
+                    {

+                        if (m_debugEnabled) m_log.WarnFormat("[GROUPS-MESSAGING]: Found child agent for client : {0}", user.ControllingClient.Name);

                         child = user.ControllingClient;
                     }
                 }
             }
 
-            // If we didn't find a root, then just return whichever child we found, or null if none
+            // If we didn't find a root, then just return whichever child we found, or null if none

+            if (child == null)

+            {

+                if (m_debugEnabled) m_log.WarnFormat("[GROUPS-MESSAGING]: Could not find local client for agent : {0}", agentID);

+            }

+            else

+            {

+                if (m_debugEnabled) m_log.WarnFormat("[GROUPS-MESSAGING]: Returning child agent for client : {0}", child.Name);

+            }
             return child;
         }