From c17a12544561de8103e1631c1a23dd225bd39698 Mon Sep 17 00:00:00 2001 From: Charles Krinke Date: Sat, 25 Apr 2009 18:58:18 +0000 Subject: Thank you kindly, MCortez for a patch that: The attached patch fixes a few problems that people were having with the Messaging provided by the XmlRpcGroups optional module, namely: * Fixes 2x echo in group messaging * Fixes problems with cross instance, non-neighbor, messaging --- .../Avatar/XmlRpcGroups/XmlRpcGroupData.cs | 36 +- .../Avatar/XmlRpcGroups/XmlRpcGroupsMessaging.cs | 423 +++++++---- .../Avatar/XmlRpcGroups/XmlRpcGroupsModule.cs | 841 ++++++++++++--------- 3 files changed, 795 insertions(+), 505 deletions(-) (limited to 'OpenSim/Region/OptionalModules/Avatar') diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupData.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupData.cs index 2a5a319..27cffd6 100644 --- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupData.cs +++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupData.cs @@ -146,11 +146,15 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups | GroupPowers.VoteOnProposal; param["OwnersPowers"] = ((ulong)OwnerPowers).ToString(); + + + Hashtable respData = XmlRpcCall("groups.createGroup", param); if (respData.Contains("error")) { // UUID is not nullable + return UUID.Zero; } @@ -224,7 +228,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups public GroupRecord GetGroupRecord(UUID GroupID, string GroupName) { Hashtable param = new Hashtable(); - if (GroupID != UUID.Zero) + if ((GroupID != null) && (GroupID != UUID.Zero)) { param["GroupID"] = GroupID.ToString(); } @@ -233,6 +237,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups param["Name"] = GroupName.ToString(); } + Hashtable respData = XmlRpcCall("groups.getGroup", param); if (respData.Contains("error")) @@ -249,6 +254,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups Hashtable param = new Hashtable(); param["GroupID"] = GroupID.ToString(); + Hashtable respData = XmlRpcCall("groups.getGroup", param); if (respData.Contains("error")) @@ -264,6 +270,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups MemberGroupProfile.PowersMask = MemberInfo.GroupPowers; return MemberGroupProfile; + } private GroupProfileData GroupProfileHashtableToGroupProfileData(Hashtable groupProfile) @@ -294,6 +301,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups private GroupRecord GroupProfileHashtableToGroupRecord(Hashtable groupProfile) { + GroupRecord group = new GroupRecord(); group.GroupID = UUID.Parse((string)groupProfile["GroupID"]); group.GroupName = groupProfile["Name"].ToString(); @@ -313,6 +321,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups return group; } + public void SetAgentActiveGroup(UUID AgentID, UUID GroupID) { Hashtable param = new Hashtable(); @@ -341,6 +350,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups param["ListInProfile"] = ListInProfile ? "1" : "0"; XmlRpcCall("groups.setAgentGroupInfo", param); + } public void AddAgentToGroupInvite(UUID inviteID, UUID groupID, UUID roleID, UUID agentID) @@ -352,6 +362,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups param["GroupID"] = groupID.ToString(); XmlRpcCall("groups.addAgentToGroupInvite", param); + } public GroupInviteInfo GetAgentToGroupInvite(UUID inviteID) @@ -400,6 +411,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups param["GroupID"] = GroupID.ToString(); XmlRpcCall("groups.removeAgentFromGroup", param); + } public void AddAgentToGroupRole(UUID AgentID, UUID GroupID, UUID RoleID) @@ -422,6 +434,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups XmlRpcCall("groups.removeAgentFromGroupRole", param); } + public List FindGroups(string search) { Hashtable param = new Hashtable(); @@ -482,6 +495,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups return HashTableToGroupMembershipData(respData); } + public List GetAgentGroupMemberships(UUID AgentID) { Hashtable param = new Hashtable(); @@ -529,6 +543,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups } return Roles; + + } public List GetGroupRoles(UUID GroupID) @@ -559,6 +575,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups } return Roles; + } private static GroupMembershipData HashTableToGroupMembershipData(Hashtable respData) @@ -583,7 +600,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups data.AllowPublish = ((string)respData["AllowPublish"] == "1"); if (respData["Charter"] != null) { - data.Charter = (string)respData["Charter"]; + data.Charter = (string)respData["Charter"]; } data.FounderID = new UUID((string)respData["FounderID"]); data.GroupID = new UUID((string)respData["GroupID"]); @@ -626,6 +643,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups } return members; + } public List GetGroupRoleMembers(UUID GroupID) @@ -642,10 +660,10 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups foreach (Hashtable membership in respData.Values) { GroupRoleMembersData data = new GroupRoleMembersData(); - + data.MemberID = new UUID((string)membership["AgentID"]); data.RoleID = new UUID((string)membership["RoleID"]); - + members.Add(data); } } @@ -685,9 +703,9 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups param["NoticeID"] = noticeID.ToString(); Hashtable respData = XmlRpcCall("groups.getGroupNotice", param); - - if (!respData.Contains("error")) + + if (respData.Contains("error")) { return null; } @@ -775,7 +793,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups Hashtable error = new Hashtable(); error.Add("error", "invalid return value"); return error; - } + } private void LogRespDataToConsoleError(Hashtable respData) { @@ -785,15 +803,15 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups { m_log.ErrorFormat("[GROUPDATA] Key: {0}", key); - // object o = respData[key]; - string[] lines = respData[key].ToString().Split(new char[] { '\n' }); foreach (string line in lines) { m_log.ErrorFormat("[GROUPDATA] {0}", line); } + } } + } public class GroupNoticeInfo diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsMessaging.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsMessaging.cs index b1b25aa..b1322ab 100644 --- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsMessaging.cs +++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsMessaging.cs @@ -26,7 +26,6 @@ */ using System; -//using System.Collections; using System.Collections.Generic; using System.Reflection; @@ -47,25 +46,27 @@ using Caps = OpenSim.Framework.Communications.Capabilities.Caps; namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups { - public class XmlRpcGroupsMessaging : INonSharedRegionModule + public class XmlRpcGroupsMessaging : ISharedRegionModule { private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - private List m_SceneList = new List(); + private List m_sceneList = new List(); - // must be NonShared for this to work, otherewise we may actually get multiple active clients - private Dictionary m_ActiveClients = new Dictionary(); + private IMessageTransferModule m_msgTransferModule = null; - private IMessageTransferModule m_MsgTransferModule = null; + private IGroupsModule m_groupsModule = null; + + // TODO: Move this off to the xmlrpc server + public Dictionary> m_agentsInGroupSession = new Dictionary>(); + public Dictionary> m_agentsDroppedSession = new Dictionary>(); - private IGroupsModule m_GroupsModule = null; // Config Options - private bool m_GroupMessagingEnabled = true; + private bool m_groupMessagingEnabled = true; private bool m_debugEnabled = true; - #region IRegionModule Members + #region IRegionModuleBase Members public void Initialise(IConfigSource config) { @@ -90,14 +91,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups if (groupsConfig.GetString("Module", "Default") != "XmlRpcGroups") { m_log.Info("[GROUPS-MESSAGING]: Config Groups Module not set to XmlRpcGroups"); - m_GroupMessagingEnabled = false; + m_groupMessagingEnabled = false; return; } - m_GroupMessagingEnabled = groupsConfig.GetBoolean("XmlRpcMessagingEnabled", true); + m_groupMessagingEnabled = groupsConfig.GetBoolean("XmlRpcMessagingEnabled", true); - if (!m_GroupMessagingEnabled) + if (!m_groupMessagingEnabled) { m_log.Info("[GROUPS-MESSAGING]: XmlRpcGroups Messaging disabled."); return; @@ -113,76 +114,74 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups public void AddRegion(Scene scene) { + // NoOp } public void RegionLoaded(Scene scene) { - if (!m_GroupMessagingEnabled) + if (!m_groupMessagingEnabled) return; - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - m_GroupsModule = scene.RequestModuleInterface(); + m_groupsModule = scene.RequestModuleInterface(); // No groups module, no groups messaging - if (m_GroupsModule == null) + if (m_groupsModule == null) { - m_GroupMessagingEnabled = false; - m_log.Info("[GROUPS-MESSAGING]: Could not get IGroupsModule, XmlRpcGroupsMessaging is now disabled."); + m_groupMessagingEnabled = false; + m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsModule, XmlRpcGroupsMessaging is now disabled."); Close(); return; } - m_MsgTransferModule = scene.RequestModuleInterface(); + m_msgTransferModule = scene.RequestModuleInterface(); // No message transfer module, no groups messaging - if (m_MsgTransferModule == null) + if (m_msgTransferModule == null) { - m_GroupMessagingEnabled = false; - m_log.Info("[GROUPS-MESSAGING]: Could not get MessageTransferModule"); + m_groupMessagingEnabled = false; + m_log.Error("[GROUPS-MESSAGING]: Could not get MessageTransferModule"); Close(); return; } - m_SceneList.Add(scene); + m_sceneList.Add(scene); scene.EventManager.OnNewClient += OnNewClient; - scene.EventManager.OnClientClosed += OnClientClosed; scene.EventManager.OnIncomingInstantMessage += OnGridInstantMessage; } public void RemoveRegion(Scene scene) { - if (!m_GroupMessagingEnabled) + if (!m_groupMessagingEnabled) return; - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - m_SceneList.Remove(scene); + m_sceneList.Remove(scene); } public void Close() { - if (!m_GroupMessagingEnabled) + if (!m_groupMessagingEnabled) return; - m_log.Debug("[GROUPS-MESSAGING]: Shutting down XmlRpcGroupsMessaging module."); - + if(m_debugEnabled) m_log.Debug("[GROUPS-MESSAGING]: Shutting down XmlRpcGroupsMessaging module."); - foreach (Scene scene in m_SceneList) + foreach (Scene scene in m_sceneList) { scene.EventManager.OnNewClient -= OnNewClient; - scene.EventManager.OnClientClosed -= OnClientClosed; scene.EventManager.OnIncomingInstantMessage -= OnGridInstantMessage; } - m_SceneList.Clear(); + m_sceneList.Clear(); - m_GroupsModule = null; - m_MsgTransferModule = null; + m_groupsModule = null; + m_msgTransferModule = null; } public string Name @@ -192,195 +191,293 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups #endregion - #region SimGridEventHandlers + #region ISharedRegionModule Members - private void OnNewClient(IClientAPI client) + public void PostInitialise() { - RegisterClientAgent(client); + // NoOp } - private void OnClientClosed(UUID AgentId) + + #endregion + + #region SimGridEventHandlers + + private void OnNewClient(IClientAPI client) { - UnregisterClientAgent(AgentId); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] OnInstantMessage registered for {0}", client.Name); + + client.OnInstantMessage += OnInstantMessage; } private void OnGridInstantMessage(GridInstantMessage msg) { - m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + // The instant message module will only deliver messages of dialog types: + // MessageFromAgent, StartTyping, StopTyping, MessageFromObject + // + // Any other message type will not be delivered to a client by the + // Instant Message Module + + + if (m_debugEnabled) + { + m_log.DebugFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); DebugGridInstantMessage(msg); + } // Incoming message from a group - if ((msg.dialog == (byte)InstantMessageDialog.SessionSend) && (msg.fromGroup == true)) + if ((msg.fromGroup == true) && + ( (msg.dialog == (byte)InstantMessageDialog.SessionSend) + || (msg.dialog == (byte)InstantMessageDialog.SessionAdd) + || (msg.dialog == (byte)InstantMessageDialog.SessionDrop) + )) + { + ProcessMessageFromGroupSession(msg); + } + + } + + 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); + + switch (msg.dialog) + { + case (byte)InstantMessageDialog.SessionAdd: + AddAgentToGroupSession(msg.fromAgentID, msg.imSessionID); + break; + + case (byte)InstantMessageDialog.SessionDrop: + RemoveAgentFromGroupSession(msg.fromAgentID, msg.imSessionID); + break; + + case (byte)InstantMessageDialog.SessionSend: + if (!m_agentsInGroupSession.ContainsKey(msg.toAgentID) + && !m_agentsDroppedSession.ContainsKey(msg.toAgentID)) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnGridInstantMessage from group session {0} going to agent {1}", msg.fromAgentID, msg.toAgentID); + // 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); - if (m_ActiveClients.ContainsKey(msg.toAgentID)) + UUID toAgentID = new UUID(msg.toAgentID); + IClientAPI activeClient = GetActiveClient(toAgentID); + if (activeClient != null) { - UUID GroupID = new UUID(msg.fromAgentID); - // SendMessageToGroup(im); + UUID groupID = new UUID(msg.fromAgentID); - GroupRecord GroupInfo = m_GroupsModule.GetGroupRecord(GroupID); - if (GroupInfo != null) + GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID); + if (groupInfo != null) { - // TODO: Check to see if already a member of session, if so, do not send chatterbox, just forward message - - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Sending chatterbox invite instant message"); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Sending chatterbox invite instant message"); // Force? open the group session dialog??? - IEventQueue eq = m_ActiveClients[msg.toAgentID].Scene.RequestModuleInterface(); + IEventQueue eq = activeClient.Scene.RequestModuleInterface(); eq.ChatterboxInvitation( - GroupID, - GroupInfo.GroupName, - new UUID(msg.fromAgentID), - msg.message, new UUID(msg.toAgentID), - msg.fromAgentName, - msg.dialog, - msg.timestamp, - msg.offline == 1, - (int)msg.ParentEstateID, - msg.Position, - 1, - new UUID(msg.imSessionID), - msg.fromGroup, - Utils.StringToBytes(GroupInfo.GroupName)); + groupID + , groupInfo.GroupName + , new UUID(msg.fromAgentID) + , msg.message, new UUID(msg.toAgentID) + , msg.fromAgentName + , msg.dialog + , msg.timestamp + , msg.offline == 1 + , (int)msg.ParentEstateID + , msg.Position + , 1 + , new UUID(msg.imSessionID) + , msg.fromGroup + , Utils.StringToBytes(groupInfo.GroupName) + ); eq.ChatterBoxSessionAgentListUpdates( - new UUID(GroupID), - new UUID(msg.fromAgentID), - new UUID(msg.toAgentID), - false, //canVoiceChat - false, //isModerator - false); //text mute + new UUID(groupID) + , new UUID(msg.fromAgentID) + , new UUID(msg.toAgentID) + , false //canVoiceChat + , false //isModerator + , false //text mute + ); + } } } + else if (!m_agentsDroppedSession.ContainsKey(msg.toAgentID)) + { + // User hasn't dropped, so they're in the session, + // maybe we should deliver it. + IClientAPI client = GetActiveClient(new UUID(msg.toAgentID)); + if (client != null) + { + // Deliver locally, directly + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Delivering to {0} locally", client.Name); + client.SendInstantMessage(msg); + } + else + { + m_log.WarnFormat("[GROUPS-MESSAGING] Received a message over the grid for a client that isn't here: {0}", msg.toAgentID); + } + } + break; + default: + m_log.WarnFormat("[GROUPS-MESSAGING] I don't know how to proccess a {0} message.", ((InstantMessageDialog)msg.dialog).ToString()); + break; + } } + + #endregion #region ClientEvents - private void OnInstantMessage(IClientAPI remoteClient, GridInstantMessage im) - { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - - DebugGridInstantMessage(im); - // Start group IM session - if ((im.dialog == (byte)InstantMessageDialog.SessionGroupStart)) + private void RemoveAgentFromGroupSession(Guid agentID, Guid sessionID) + { + if( m_agentsInGroupSession.ContainsKey(sessionID) ) { - UUID GroupID = new UUID(im.toAgentID); - - GroupRecord GroupInfo = m_GroupsModule.GetGroupRecord(GroupID); - if (GroupInfo != null) + // If in session remove + if( m_agentsInGroupSession[sessionID].Contains(agentID) ) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Start Group Session for {0}", GroupInfo.GroupName); - - // remoteClient.SendInstantMessage(new GridInstantMessage(remoteClient.Scene, GroupID, GroupProfile.Name, remoteClient.AgentId, (byte)OpenMetaverse.InstantMessageDialog.SessionSend, true, "Welcome", GroupID, false, new Vector3(), new byte[0])); - - ChatterBoxSessionStartReplyViaCaps(remoteClient, GroupInfo.GroupName, GroupID); + m_agentsInGroupSession[sessionID].Remove(agentID); + } - IEventQueue queue = remoteClient.Scene.RequestModuleInterface(); - queue.ChatterBoxSessionAgentListUpdates( - new UUID(GroupID), - new UUID(im.fromAgentID), - new UUID(im.toAgentID), - false, //canVoiceChat - false, //isModerator - false); //text mute + // 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); } } + } - // Send a message to a group - if ((im.dialog == (byte)InstantMessageDialog.SessionSend)) - { - UUID GroupID = new UUID(im.toAgentID); + private void AddAgentToGroupSession(Guid agentID, Guid sessionID) + { + // Add Session Status if it doesn't exist for this session + CreateGroupSessionTracking(sessionID); - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Send message to session for group {0}", GroupID); + // If nessesary, remove from dropped list + if( m_agentsDroppedSession[sessionID].Contains(agentID) ) + { + m_agentsDroppedSession[sessionID].Remove(agentID); + } - SendMessageToGroup(im, GroupID); + // 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); } + } - // Incoming message from a group - if ((im.dialog == (byte)InstantMessageDialog.SessionSend) && (im.fromGroup == true)) + private void CreateGroupSessionTracking(Guid sessionID) + { + if (!m_agentsInGroupSession.ContainsKey(sessionID)) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Message from group session {0} going to agent {1}", im.fromAgentID, im.toAgentID); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Creating session tracking for : {0}", sessionID); + m_agentsInGroupSession.Add(sessionID, new List()); + m_agentsDroppedSession.Add(sessionID, new List()); } } - #endregion - private void RegisterClientAgent(IClientAPI client) + private void OnInstantMessage(IClientAPI remoteClient, GridInstantMessage im) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) + { + m_log.DebugFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - lock (m_ActiveClients) + DebugGridInstantMessage(im); + } + + // Start group IM session + if ((im.dialog == (byte)InstantMessageDialog.SessionGroupStart)) { - if (!m_ActiveClients.ContainsKey(client.AgentId.Guid)) + UUID groupID = new UUID(im.toAgentID); + + GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID); + if (groupInfo != null) { - client.OnInstantMessage += OnInstantMessage; + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Start Group Session for {0}", groupInfo.GroupName); - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnInstantMessage registered for {0}", client.Name); + AddAgentToGroupSession(im.fromAgentID, im.imSessionID); - m_ActiveClients.Add(client.AgentId.Guid, client); - } - else - { - // Remove old client connection for this agent - UnregisterClientAgent(client.AgentId); + ChatterBoxSessionStartReplyViaCaps(remoteClient, groupInfo.GroupName, groupID); - // Add new client connection - RegisterClientAgent(client); + IEventQueue queue = remoteClient.Scene.RequestModuleInterface(); + queue.ChatterBoxSessionAgentListUpdates( + new UUID(groupID) + , new UUID(im.fromAgentID) + , new UUID(im.toAgentID) + , false //canVoiceChat + , false //isModerator + , false //text mute + ); } } - } - private void UnregisterClientAgent(UUID agentID) - { - lock (m_ActiveClients) + + // Send a message from locally connected client to a group + if ((im.dialog == (byte)InstantMessageDialog.SessionSend)) { - if (m_ActiveClients.ContainsKey(agentID.Guid)) - { - IClientAPI client = m_ActiveClients[agentID.Guid]; - client.OnInstantMessage -= OnInstantMessage; + UUID groupID = new UUID(im.toAgentID); - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnInstantMessage unregistered for {0}", client.Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Send message to session for group {0} with session ID {1}", groupID, im.imSessionID.ToString()); - m_ActiveClients.Remove(agentID.Guid); - } - else - { - m_log.InfoFormat("[GROUPS-MESSAGING] Client closed that wasn't registered here."); - } + SendMessageToGroup(im, groupID); } } + #endregion private void SendMessageToGroup(GridInstantMessage im, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + 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[im.imSessionID].Contains(member.AgentID.Guid)) + { + // 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); + continue; + } + + // Copy Message GridInstantMessage msg = new GridInstantMessage(); msg.imSessionID = im.imSessionID; - msg.fromAgentID = im.imSessionID; // GroupID - msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); msg.fromAgentName = im.fromAgentName; msg.message = im.message; msg.dialog = im.dialog; - msg.fromGroup = true; - msg.offline = (byte)0; + msg.offline = im.offline; msg.ParentEstateID = im.ParentEstateID; msg.Position = im.Position; msg.RegionID = im.RegionID; - msg.binaryBucket = new byte[1]{0}; + msg.binaryBucket = im.binaryBucket; + msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); + + // Updat Pertinate fields to make it a "group message" + msg.fromAgentID = groupID.Guid; + msg.fromGroup = true; - foreach (GroupMembersData member in m_GroupsModule.GroupMembersRequest(null, groupID)) - { msg.toAgentID = member.AgentID.Guid; - m_MsgTransferModule.SendInstantMessage(msg, delegate(bool success) {}); + + IClientAPI client = GetActiveClient(member.AgentID); + if (client == null) + { + // If they're not local, forward across the grid + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Delivering to {0} via Grid", member.AgentID); + m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) { }); + } + else + { + // Deliver locally, directly + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Passing to ProcessMessageFromGroupSession to deliver to {0} locally", client.Name); + ProcessMessageFromGroupSession(msg); + } } } void ChatterBoxSessionStartReplyViaCaps(IClientAPI remoteClient, string groupName, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); OSDMap moderatedMap = new OSDMap(4); moderatedMap.Add("voice", OSD.FromBoolean(false)); @@ -398,12 +495,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups bodyMap.Add("success", OSD.FromBoolean(true)); bodyMap.Add("session_info", sessionMap); + IEventQueue queue = remoteClient.Scene.RequestModuleInterface(); if (queue != null) { queue.Enqueue(EventQueueHelper.buildEvent("ChatterBoxSessionStartReply", bodyMap), remoteClient.AgentId); } + } @@ -422,5 +521,39 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups m_log.WarnFormat("[GROUPS-MESSAGING] IM: binaryBucket({0})", OpenMetaverse.Utils.BytesToHexString(im.binaryBucket, "BinaryBucket")); } } + + #region Client Tools + + /// + /// Try to find an active IClientAPI reference for agentID giving preference to root connections + /// + private IClientAPI GetActiveClient(UUID agentID) + { + IClientAPI child = null; + + // Try root avatar first + foreach (Scene scene in m_sceneList) + { + if (scene.Entities.ContainsKey(agentID) && + scene.Entities[agentID] is ScenePresence) + { + ScenePresence user = (ScenePresence)scene.Entities[agentID]; + if (!user.IsChildAgent) + { + return user.ControllingClient; + } + else + { + child = user.ControllingClient; + } + } + } + + // If we didn't find a root, then just return whichever child we found, or null if none + return child; + } + + #endregion } + } diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsModule.cs index 69c7258..d5cd7e2 100644 --- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsModule.cs +++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsModule.cs @@ -30,7 +30,6 @@ using System.Collections.Generic; using System.Reflection; using System.Collections; -//using Nwc.XmlRpc; using log4net; using Nini.Config; @@ -39,6 +38,7 @@ using OpenMetaverse; using OpenMetaverse.StructuredData; using OpenSim.Framework; +using OpenSim.Framework.Communications; using OpenSim.Region.CoreModules.Framework.EventQueue; using OpenSim.Region.Framework.Interfaces; using OpenSim.Region.Framework.Scenes; @@ -50,7 +50,7 @@ using DirFindFlags = OpenMetaverse.DirectoryManager.DirFindFlags; namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups { - public class XmlRpcGroupsModule : INonSharedRegionModule, IGroupsModule + public class XmlRpcGroupsModule : ISharedRegionModule, IGroupsModule { /// /// ; To use this module, you must specify the following in your OpenSim.ini @@ -75,11 +75,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups private List m_sceneList = new List(); - // This only works when running as non-Shared, in shared, there may be multiple IClientAPIs for a single client - private Dictionary m_activeClients = new Dictionary(); - private IMessageTransferModule m_msgTransferModule = null; - + private IGroupDataProvider m_groupData = null; // Configuration settings @@ -88,7 +85,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups private bool m_groupNoticesEnabled = true; private bool m_debugEnabled = true; - #region IRegionModule Members + #region IRegionModuleBase Members public void Initialise(IConfigSource config) { @@ -142,24 +139,34 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups if (!m_groupsEnabled) return; - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - m_msgTransferModule = scene.RequestModuleInterface(); - - // No message transfer module, no notices, group invites, rejects, ejects, etc if (m_msgTransferModule == null) { - m_groupsEnabled = false; - m_log.Info("[GROUPS]: Could not get MessageTransferModule"); - Close(); - return; + m_msgTransferModule = scene.RequestModuleInterface(); + + // No message transfer module, no notices, group invites, rejects, ejects, etc + if (m_msgTransferModule == null) + { + m_groupsEnabled = false; + m_log.Error("[GROUPS]: Could not get MessageTransferModule"); + Close(); + return; + } } - m_sceneList.Add(scene); + lock (m_sceneList) + { + m_sceneList.Add(scene); + } scene.EventManager.OnNewClient += OnNewClient; - scene.EventManager.OnClientClosed += OnClientClosed; scene.EventManager.OnIncomingInstantMessage += OnGridInstantMessage; + + // The InstantMessageModule itself doesn't do this, + // so lets see if things explode if we don't do it + // scene.EventManager.OnClientClosed += OnClientClosed; + } public void RemoveRegion(Scene scene) @@ -167,117 +174,117 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups if (!m_groupsEnabled) return; - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - m_sceneList.Remove(scene); + lock (m_sceneList) + { + m_sceneList.Remove(scene); + } } public void Close() { if (!m_groupsEnabled) return; - m_log.Debug("[GROUPS]: Shutting down XmlRpcGroups module."); + + if (m_debugEnabled) m_log.Debug("[GROUPS]: Shutting down XmlRpcGroups module."); } public string Name { get { return "XmlRpcGroupsModule"; } } + #endregion - private void UpdateAllClientsWithGroupInfo() - { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - foreach (IClientAPI client in m_activeClients.Values) - { - UpdateClientWithGroupInfo(client); - } - } + #region ISharedRegionModule Members - private void UpdateClientWithGroupInfo(IClientAPI client) + public void PostInitialise() { - m_log.InfoFormat("[GROUPS] {0} called for {1}", System.Reflection.MethodBase.GetCurrentMethod().Name, client.Name); - OnAgentDataUpdateRequest(client, client.AgentId, UUID.Zero); - - - // Need to send a group membership update to the client - // UDP version doesn't seem to behave nicely - // client.SendGroupMembership(GetMembershipData(client.AgentId)); - - GroupMembershipData[] membershipData = m_groupData.GetAgentGroupMemberships(client.AgentId).ToArray(); - - SendGroupMembershipInfoViaCaps(client, membershipData); - client.SendAvatarGroupsReply(client.AgentId, membershipData); - + // NoOp } + #endregion + #region EventHandlers private void OnNewClient(IClientAPI client) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - - lock (m_activeClients) - { - if (!m_activeClients.ContainsKey(client.AgentId)) - { - client.OnUUIDGroupNameRequest += HandleUUIDGroupNameRequest; - client.OnAgentDataUpdateRequest += OnAgentDataUpdateRequest; - client.OnDirFindQuery += OnDirFindQuery; - client.OnInstantMessage += OnInstantMessage; + client.OnUUIDGroupNameRequest += HandleUUIDGroupNameRequest; + client.OnAgentDataUpdateRequest += OnAgentDataUpdateRequest; + client.OnDirFindQuery += OnDirFindQuery; + client.OnRequestAvatarProperties += OnRequestAvatarProperties; - m_activeClients.Add(client.AgentId, client); - } - } + // Used for Notices and Group Invites/Accept/Reject + client.OnInstantMessage += OnInstantMessage; + + SendAgentGroupDataUpdate(client, client.AgentId); + } - UpdateClientWithGroupInfo(client); + private void OnRequestAvatarProperties(IClientAPI remoteClient, UUID avatarID) + { + GroupMembershipData[] avatarGroups = m_groupData.GetAgentGroupMemberships(avatarID).ToArray(); + remoteClient.SendAvatarGroupsReply(avatarID, avatarGroups); } - private void OnClientClosed(UUID agentId) + /* + * This becomes very problematic in a shared module. In a shared module you may have more then one + * reference to IClientAPI's, one for 0 or 1 root connections, and 0 or more child connections. + * The OnClientClosed event does not provide anything to indicate which one of those should be closed + * nor does it provide what scene it was from so that the specific reference can be looked up. + * The InstantMessageModule.cs does not currently worry about unregistering the handles, + * and it should be an issue, since it's the client that references us not the other way around + * , so as long as we don't keep a reference to the client laying around, the client can still be GC'ed + private void OnClientClosed(UUID AgentId) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - lock (m_activeClients) + lock (m_ActiveClients) { - if (m_activeClients.ContainsKey(agentId)) + if (m_ActiveClients.ContainsKey(AgentId)) { - IClientAPI client = m_activeClients[agentId]; + IClientAPI client = m_ActiveClients[AgentId]; client.OnUUIDGroupNameRequest -= HandleUUIDGroupNameRequest; client.OnAgentDataUpdateRequest -= OnAgentDataUpdateRequest; client.OnDirFindQuery -= OnDirFindQuery; client.OnInstantMessage -= OnInstantMessage; - m_activeClients.Remove(agentId); + m_ActiveClients.Remove(AgentId); } else { - m_log.InfoFormat("[GROUPS] Client closed that wasn't registered here."); + if (m_debugEnabled) m_log.WarnFormat("[GROUPS] Client closed that wasn't registered here."); } + + } } + */ void OnDirFindQuery(IClientAPI remoteClient, UUID queryID, string queryText, uint queryFlags, int queryStart) { if (((DirFindFlags)queryFlags & DirFindFlags.Groups) == DirFindFlags.Groups) { - m_log.InfoFormat("[GROUPS] {0} called with queryText({1}) queryFlags({2}) queryStart({3})", - System.Reflection.MethodBase.GetCurrentMethod().Name, queryText, (DirFindFlags)queryFlags, queryStart); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called with queryText({1}) queryFlags({2}) queryStart({3})", System.Reflection.MethodBase.GetCurrentMethod().Name, queryText, (DirFindFlags)queryFlags, queryStart); + // TODO: This currently ignores pretty much all the query flags including Mature and sort order remoteClient.SendDirGroupsReply(queryID, m_groupData.FindGroups(queryText).ToArray()); } + } - private void OnAgentDataUpdateRequest(IClientAPI remoteClient, UUID agentID, UUID sessionID) + private void OnAgentDataUpdateRequest(IClientAPI remoteClient, UUID dataForAgentID, UUID sessionID) { - m_log.InfoFormat("[GROUPS] {0} called with SessionID :: {1}", System.Reflection.MethodBase.GetCurrentMethod().Name, sessionID); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); UUID activeGroupID = UUID.Zero; string activeGroupTitle = string.Empty; string activeGroupName = string.Empty; ulong activeGroupPowers = (ulong)GroupPowers.None; - GroupMembershipData membership = m_groupData.GetAgentActiveMembership(agentID); + GroupMembershipData membership = m_groupData.GetAgentActiveMembership(dataForAgentID); if (membership != null) { activeGroupID = membership.GroupID; @@ -285,59 +292,44 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups activeGroupPowers = membership.GroupPowers; } - string firstname, lastname; - IClientAPI agent; - if (m_activeClients.TryGetValue(agentID, out agent)) - { - firstname = agent.FirstName; - lastname = agent.LastName; - } else { - firstname = "Unknown"; - lastname = "Unknown"; - } - - UpdateScenePresenceWithTitle(agentID, activeGroupTitle); + SendAgentDataUpdate(remoteClient, dataForAgentID, activeGroupID, activeGroupName, activeGroupPowers, activeGroupTitle); - remoteClient.SendAgentDataUpdate(agentID, activeGroupID, firstname, - lastname, activeGroupPowers, activeGroupName, - activeGroupTitle); + SendScenePresenceUpdate(dataForAgentID, activeGroupTitle); } - private void HandleUUIDGroupNameRequest(UUID groupID, IClientAPI remoteClient) + private void HandleUUIDGroupNameRequest(UUID GroupID,IClientAPI remote_client) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - string groupName; + string GroupName; - GroupRecord group = m_groupData.GetGroupRecord(groupID, null); + GroupRecord group = m_groupData.GetGroupRecord(GroupID, null); if (group != null) { - groupName = group.GroupName; + GroupName = group.GroupName; } else { - groupName = "Unknown"; + GroupName = "Unknown"; } - remoteClient.SendGroupNameReply(groupID, groupName); + + remote_client.SendGroupNameReply(GroupID, GroupName); } private void OnInstantMessage(IClientAPI remoteClient, GridInstantMessage im) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // Group invitations - if ((im.dialog == (byte)InstantMessageDialog.GroupInvitationAccept) || - (im.dialog == (byte)InstantMessageDialog.GroupInvitationDecline)) + if ((im.dialog == (byte)InstantMessageDialog.GroupInvitationAccept) || (im.dialog == (byte)InstantMessageDialog.GroupInvitationDecline)) { - m_log.WarnFormat("[GROUPS] Received an IIM for {0}.", ((InstantMessageDialog)im.dialog).ToString()); - UUID inviteID = new UUID(im.imSessionID); GroupInviteInfo inviteInfo = m_groupData.GetAgentToGroupInvite(inviteID); - m_log.WarnFormat("[GROUPS] Invite is for Agent {0} to Group {1}.", inviteInfo.AgentID, inviteInfo.GroupID); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Invite is for Agent {0} to Group {1}.", inviteInfo.AgentID, inviteInfo.GroupID); UUID fromAgentID = new UUID(im.fromAgentID); if ((inviteInfo != null) && (fromAgentID == inviteInfo.AgentID)) @@ -346,32 +338,32 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups // Accept if (im.dialog == (byte)InstantMessageDialog.GroupInvitationAccept) { - m_log.WarnFormat("[GROUPS] Received an accept invite notice."); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Received an accept invite notice."); // and the sessionid is the role m_groupData.AddAgentToGroup(inviteInfo.AgentID, inviteInfo.GroupID, inviteInfo.RoleID); - if (m_msgTransferModule != null) - { - GridInstantMessage msg = new GridInstantMessage(); - msg.imSessionID = UUID.Zero.Guid; - msg.fromAgentID = UUID.Zero.Guid; - msg.toAgentID = inviteInfo.AgentID.Guid; - msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); - msg.fromAgentName = "Groups"; - msg.message = string.Format("You have been added to the group."); - msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.MessageBox; - msg.fromGroup = false; - msg.offline = (byte)0; - msg.ParentEstateID = 0; - msg.Position = Vector3.Zero; - msg.RegionID = UUID.Zero.Guid; - msg.binaryBucket = new byte[0]; - - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) { }); - } + GridInstantMessage msg = new GridInstantMessage(); + msg.imSessionID = UUID.Zero.Guid; + msg.fromAgentID = UUID.Zero.Guid; + msg.toAgentID = inviteInfo.AgentID.Guid; + msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); + msg.fromAgentName = "Groups"; + msg.message = string.Format("You have been added to the group."); + msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.MessageBox; + msg.fromGroup = false; + msg.offline = (byte)0; + msg.ParentEstateID = 0; + msg.Position = Vector3.Zero; + msg.RegionID = UUID.Zero.Guid; + msg.binaryBucket = new byte[0]; + + OutgoingInstantMessage(msg, inviteInfo.AgentID); - UpdateAllClientsWithGroupInfo(); + UpdateAllClientsWithGroupInfo(inviteInfo.AgentID); + + // TODO: If the inviter is still online, they need an agent dataupdate + // and maybe group membership updates for the invitee m_groupData.RemoveAgentToGroupInvite(inviteID); } @@ -379,10 +371,12 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups // Reject if (im.dialog == (byte)InstantMessageDialog.GroupInvitationDecline) { - m_log.WarnFormat("[GROUPS] Received a reject invite notice."); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Received a reject invite notice."); m_groupData.RemoveAgentToGroupInvite(inviteID); } + + } } @@ -394,12 +388,12 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups return; } - UUID groupID = new UUID(im.toAgentID); - if (m_groupData.GetGroupRecord(groupID, null) != null) + UUID GroupID = new UUID(im.toAgentID); + if (m_groupData.GetGroupRecord(GroupID, null) != null) { - UUID noticeID = UUID.Random(); - string subject = im.message.Substring(0, im.message.IndexOf('|')); - string message = im.message.Substring(subject.Length + 1); + UUID NoticeID = UUID.Random(); + string Subject = im.message.Substring(0, im.message.IndexOf('|')); + string Message = im.message.Substring(Subject.Length + 1); byte[] bucket; @@ -408,50 +402,56 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups bucket = new byte[19]; bucket[0] = 0; //dunno bucket[1] = 0; //dunno - groupID.ToBytes(bucket, 2); + GroupID.ToBytes(bucket, 2); bucket[18] = 0; //dunno } else { string binBucket = OpenMetaverse.Utils.BytesToString(im.binaryBucket); binBucket = binBucket.Remove(0, 14).Trim(); - m_log.WarnFormat("I don't understand a group notice binary bucket of: {0}", binBucket); - - OSDMap binBucketOSD = (OSDMap)OSDParser.DeserializeLLSDXml(binBucket); - - foreach (string key in binBucketOSD.Keys) + if (m_debugEnabled) { - m_log.WarnFormat("{0}: {1}", key, binBucketOSD[key].ToString()); - } + m_log.WarnFormat("I don't understand a group notice binary bucket of: {0}", binBucket); + + OSDMap binBucketOSD = (OSDMap)OSDParser.DeserializeLLSDXml(binBucket); + + foreach (string key in binBucketOSD.Keys) + { + m_log.WarnFormat("{0}: {1}", key, binBucketOSD[key].ToString()); + } + } // treat as if no attachment bucket = new byte[19]; bucket[0] = 0; //dunno bucket[1] = 0; //dunno - groupID.ToBytes(bucket, 2); + GroupID.ToBytes(bucket, 2); bucket[18] = 0; //dunno } - m_groupData.AddGroupNotice(groupID, noticeID, im.fromAgentName, subject, message, bucket); + m_groupData.AddGroupNotice(GroupID, NoticeID, im.fromAgentName, Subject, Message, bucket); if (OnNewGroupNotice != null) { - OnNewGroupNotice(groupID, noticeID); + OnNewGroupNotice(GroupID, NoticeID); } // Build notice IIM - GridInstantMessage msg = CreateGroupNoticeIM(UUID.Zero, noticeID, - (byte)OpenMetaverse.InstantMessageDialog.GroupNotice); + GridInstantMessage msg = CreateGroupNoticeIM(UUID.Zero, NoticeID, (byte)OpenMetaverse.InstantMessageDialog.GroupNotice); // Send notice out to everyone that wants notices - foreach (GroupMembersData member in m_groupData.GetGroupMembers(groupID)) + foreach (GroupMembersData member in m_groupData.GetGroupMembers(GroupID)) { if (member.AcceptNotices) { msg.toAgentID = member.AgentID.Guid; - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) {}); + OutgoingInstantMessage(msg, member.AgentID); + } } + + + } } @@ -460,24 +460,28 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups // TODO:FIXME: Use a presense server of some kind to find out where the // client actually is, and try contacting that region directly to notify them, // or provide the notification via xmlrpc update queue - if (im.dialog == 210) + if ((im.dialog == 210)) { // This is sent from the region that the ejectee was ejected from // if it's being delivered here, then the ejectee is here // so we need to send local updates to the agent. - if (m_msgTransferModule != null) - { - im.dialog = (byte)InstantMessageDialog.MessageFromAgent; - m_msgTransferModule.SendInstantMessage(im, delegate(bool success) {}); - } UUID ejecteeID = new UUID(im.toAgentID); - UUID groupID = new UUID(im.toAgentID); - if (m_activeClients.ContainsKey(ejecteeID)) + + im.dialog = (byte)InstantMessageDialog.MessageFromAgent; + OutgoingInstantMessage(im, ejecteeID); + + IClientAPI ejectee = GetActiveClient(ejecteeID); + if (ejectee != null) { - m_activeClients[ejecteeID].SendAgentDropGroup(groupID); + UUID groupID = new UUID(im.fromAgentID); + ejectee.SendAgentDropGroup(groupID); } + } + + + } private void OnGridInstantMessage(GridInstantMessage msg) @@ -487,6 +491,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups // Trigger the above event handler OnInstantMessage(null, msg); + // If a message from a group arrives here, it may need to be forwarded to a local client if (msg.fromGroup == true) { @@ -495,56 +500,40 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups case (byte)InstantMessageDialog.GroupInvitation: case (byte)InstantMessageDialog.GroupNotice: UUID toAgentID = new UUID(msg.toAgentID); - if (m_activeClients.ContainsKey(toAgentID)) + IClientAPI localClient = GetActiveClient(toAgentID); + if( localClient != null ) { - m_activeClients[toAgentID].SendInstantMessage(msg); + localClient.SendInstantMessage(msg); } break; } } } - #endregion - private void UpdateScenePresenceWithTitle(UUID agentID, string title) - { - m_log.DebugFormat("[GROUPS] Updating scene title for {0} with title: {1}", agentID, title); - - ScenePresence presence = null; - lock (m_sceneList) - { - foreach (Scene scene in m_sceneList) - { - presence = scene.GetScenePresence(agentID); - if (presence != null) - { - presence.Grouptitle = title; - - // FixMe: Ter suggests a "Schedule" method that I can't find. - presence.SendFullUpdateToAllClients(); - } - } - } - } + #endregion #region IGroupsModule Members public event NewGroupNotice OnNewGroupNotice; - public GroupRecord GetGroupRecord(UUID groupID) + public GroupRecord GetGroupRecord(UUID GroupID) { - return m_groupData.GetGroupRecord(groupID, null); + return m_groupData.GetGroupRecord(GroupID, null); } public void ActivateGroup(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); m_groupData.SetAgentActiveGroup(remoteClient.AgentId, groupID); - // UpdateClientWithGroupInfo(remoteClient); - UpdateAllClientsWithGroupInfo(); + // Changing active group changes title, active powers, all kinds of things + // anyone who is in any region that can see this client, should probably be + // updated with new group info. At a minimum, they should get ScenePresence + // updated with new title. + UpdateAllClientsWithGroupInfo(remoteClient.AgentId); } /// @@ -552,7 +541,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups /// public List GroupTitlesRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); List agentRoles = m_groupData.GetAgentGroupRoles(remoteClient.AgentId, groupID); GroupMembershipData agentMembership = m_groupData.GetAgentGroupMembership(remoteClient.AgentId, groupID); @@ -576,49 +565,61 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups public List GroupMembersRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); List data = m_groupData.GetGroupMembers(groupID); - - foreach (GroupMembersData member in data) + if (m_debugEnabled) { - m_log.InfoFormat("[GROUPS] {0} {1}", member.AgentID, member.Title); + foreach (GroupMembersData member in data) + { + m_log.DebugFormat("[GROUPS] {0} {1}", member.AgentID, member.Title); + } } return data; + } public List GroupRoleDataRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); List data = m_groupData.GetGroupRoles(groupID); - foreach (GroupRolesData member in data) + if (m_debugEnabled) { - m_log.InfoFormat("[GROUPS] {0} {1}", member.Title, member.Members); + foreach (GroupRolesData member in data) + { + m_log.DebugFormat("[GROUPS] {0} {1}", member.Title, member.Members); + } } return data; + } public List GroupRoleMembersRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); List data = m_groupData.GetGroupRoleMembers(groupID); - foreach (GroupRoleMembersData member in data) + if (m_debugEnabled) { - m_log.InfoFormat("[GROUPS] Av: {0} Role: {1}", member.MemberID, member.RoleID); + foreach (GroupRoleMembersData member in data) + { + m_log.DebugFormat("[GROUPS] Av: {0} Role: {1}", member.MemberID, member.RoleID); + } } - + return data; + + } public GroupProfileData GroupProfileRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); GroupProfileData profile = new GroupProfileData(); @@ -651,45 +652,40 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups return profile; } - public GroupMembershipData[] GetMembershipData(UUID userID) + public GroupMembershipData[] GetMembershipData(UUID agentID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - return m_groupData.GetAgentGroupMemberships(userID).ToArray(); + return m_groupData.GetAgentGroupMemberships(agentID).ToArray(); } - public GroupMembershipData GetMembershipData(UUID groupID, UUID userID) + public GroupMembershipData GetMembershipData(UUID groupID, UUID agentID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - return m_groupData.GetAgentGroupMembership(userID, groupID); + return m_groupData.GetAgentGroupMembership(agentID, groupID); } - public void UpdateGroupInfo(IClientAPI remoteClient, UUID groupID, string charter, - bool showInList, UUID insigniaID, int membershipFee, - bool openEnrollment, bool allowPublish, bool maturePublish) + public void UpdateGroupInfo(IClientAPI remoteClient, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // TODO: Security Check? - m_groupData.UpdateGroup(groupID, charter, showInList, insigniaID, membershipFee, - openEnrollment, allowPublish, maturePublish); + m_groupData.UpdateGroup(groupID, charter, showInList, insigniaID, membershipFee, openEnrollment, allowPublish, maturePublish); } public void SetGroupAcceptNotices(IClientAPI remoteClient, UUID groupID, bool acceptNotices, bool listInProfile) { // TODO: Security Check? - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); m_groupData.SetAgentGroupInfo(remoteClient.AgentId, groupID, acceptNotices, listInProfile); } - public UUID CreateGroup(IClientAPI remoteClient, string name, string charter, - bool showInList, UUID insigniaID, int membershipFee, - bool openEnrollment, bool allowPublish, bool maturePublish) + public UUID CreateGroup(IClientAPI remoteClient, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); if (m_groupData.GetGroupRecord(UUID.Zero, name) != null) { @@ -697,19 +693,19 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups return UUID.Zero; } - UUID groupID = m_groupData.CreateGroup(name, charter, showInList, insigniaID, membershipFee, - openEnrollment, allowPublish, maturePublish, remoteClient.AgentId); + UUID groupID = m_groupData.CreateGroup(name, charter, showInList, insigniaID, membershipFee, openEnrollment, allowPublish, maturePublish, remoteClient.AgentId); remoteClient.SendCreateGroupReply(groupID, true, "Group created successfullly"); - UpdateClientWithGroupInfo(remoteClient); + // Update the founder with new group information. + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); return groupID; } public GroupNoticeData[] GroupNoticesListRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // ToDo: check if agent is a member of group and is allowed to see notices? @@ -721,7 +717,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups /// public string GetGroupTitle(UUID avatarID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); GroupMembershipData membership = m_groupData.GetAgentActiveMembership(avatarID); if (membership != null) @@ -736,18 +732,21 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups /// public void GroupTitleUpdate(IClientAPI remoteClient, UUID groupID, UUID titleRoleID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); m_groupData.SetAgentActiveGroupRole(remoteClient.AgentId, groupID, titleRoleID); - UpdateAllClientsWithGroupInfo(); + // TODO: Not sure what all is needed here, but if the active group role change is for the group + // the client currently has set active, then we need to do a scene presence update too + // if (m_groupData.GetAgentActiveMembership(remoteClient.AgentId).GroupID == GroupID) + + UpdateAllClientsWithGroupInfo(remoteClient.AgentId); } - public void GroupRoleUpdate(IClientAPI remoteClient, UUID groupID, UUID roleID, - string name, string description, string title, ulong powers, byte updateType) + public void GroupRoleUpdate(IClientAPI remoteClient, UUID groupID, UUID roleID, string name, string description, string title, ulong powers, byte updateType) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // TODO: Security Checks? @@ -774,12 +773,13 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups } - UpdateClientWithGroupInfo(remoteClient); + // TODO: This update really should send out updates for everyone in the role that just got changed. + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); } public void GroupRoleChanges(IClientAPI remoteClient, UUID groupID, UUID roleID, UUID memberID, uint changes) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // Todo: Security check switch (changes) @@ -798,44 +798,45 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups m_log.ErrorFormat("[GROUPS] {0} does not understand changes == {1}", System.Reflection.MethodBase.GetCurrentMethod().Name, changes); break; } - UpdateClientWithGroupInfo(remoteClient); + + // TODO: This update really should send out updates for everyone in the role that just got changed. + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); } public void GroupNoticeRequest(IClientAPI remoteClient, UUID groupNoticeID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); GroupNoticeInfo data = m_groupData.GetGroupNotice(groupNoticeID); if (data != null) { - if (m_msgTransferModule != null) - { - GridInstantMessage msg = new GridInstantMessage(); - msg.imSessionID = UUID.Zero.Guid; - msg.fromAgentID = data.GroupID.Guid; - msg.toAgentID = remoteClient.AgentId.Guid; - msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); - msg.fromAgentName = "Group Notice From"; - msg.message = data.noticeData.Subject + "|" + data.Message; - msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.GroupNoticeRequested; - msg.fromGroup = true; - msg.offline = (byte)0; - msg.ParentEstateID = 0; - msg.Position = Vector3.Zero; - msg.RegionID = UUID.Zero.Guid; - msg.binaryBucket = data.BinaryBucket; - - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) { }); - } + GroupRecord groupInfo = m_groupData.GetGroupRecord(data.GroupID, null); + + GridInstantMessage msg = new GridInstantMessage(); + msg.imSessionID = UUID.Zero.Guid; + msg.fromAgentID = data.GroupID.Guid; + msg.toAgentID = remoteClient.AgentId.Guid; + msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); + msg.fromAgentName = "Group Notice : " + groupInfo == null ? "Unknown" : groupInfo.GroupName; + msg.message = data.noticeData.Subject + "|" + data.Message; + msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.GroupNoticeRequested; + msg.fromGroup = true; + msg.offline = (byte)0; + msg.ParentEstateID = 0; + msg.Position = Vector3.Zero; + msg.RegionID = UUID.Zero.Guid; + msg.binaryBucket = data.BinaryBucket; + + OutgoingInstantMessage(msg, remoteClient.AgentId); } } public GridInstantMessage CreateGroupNoticeIM(UUID agentID, UUID groupNoticeID, byte dialog) { - m_log.WarnFormat("[GROUPS] {0} is probably not properly implemented", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); GridInstantMessage msg = new GridInstantMessage(); msg.imSessionID = UUID.Zero.Guid; @@ -857,32 +858,43 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups msg.message = info.noticeData.Subject + "|" + info.Message; msg.binaryBucket = info.BinaryBucket; } + else + { + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Group Notice {0} not found, composing empty message.", groupNoticeID); + msg.fromAgentID = UUID.Zero.Guid; + msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); ; + msg.fromAgentName = string.Empty; + msg.message = string.Empty; + msg.binaryBucket = new byte[0]; + } return msg; } public void SendAgentGroupDataUpdate(IClientAPI remoteClient) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - UpdateClientWithGroupInfo(remoteClient); + // Send agent information about his groups + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); } public void JoinGroupRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // Should check to see if OpenEnrollment, or if there's an outstanding invitation m_groupData.AddAgentToGroup(remoteClient.AgentId, groupID, UUID.Zero); remoteClient.SendJoinGroupReply(groupID, true); - UpdateClientWithGroupInfo(remoteClient); + // Should this send updates to everyone in the group? + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); } public void LeaveGroupRequest(IClientAPI remoteClient, UUID groupID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); m_groupData.RemoveAgentFromGroup(remoteClient.AgentId, groupID); @@ -890,107 +902,97 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups remoteClient.SendAgentDropGroup(groupID); - UpdateClientWithGroupInfo(remoteClient); + // SL sends out notifcations to the group messaging session that the person has left + // Should this also update everyone who is in the group? + SendAgentGroupDataUpdate(remoteClient, remoteClient.AgentId); } public void EjectGroupMemberRequest(IClientAPI remoteClient, UUID groupID, UUID ejecteeID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // Todo: Security check? m_groupData.RemoveAgentFromGroup(ejecteeID, groupID); remoteClient.SendEjectGroupMemberReply(remoteClient.AgentId, groupID, true); - if (m_msgTransferModule != null) - { - GroupRecord groupInfo = m_groupData.GetGroupRecord(groupID, null); - UserProfileData userProfile = m_sceneList[0].CommsManager.UserService.GetUserProfile(ejecteeID); + GroupRecord groupInfo = m_groupData.GetGroupRecord(groupID, null); + UserProfileData userProfile = m_sceneList[0].CommsManager.UserService.GetUserProfile(ejecteeID); - if ((groupInfo == null) || (userProfile == null)) - { - return; - } - + if ((groupInfo == null) || (userProfile == null)) + { + return; + } + - // Send Message to Ejectee - GridInstantMessage msg = new GridInstantMessage(); - - msg.imSessionID = UUID.Zero.Guid; - msg.fromAgentID = remoteClient.AgentId.Guid; - // msg.fromAgentID = info.GroupID; - msg.toAgentID = ejecteeID.Guid; - //msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); - msg.timestamp = 0; - msg.fromAgentName = remoteClient.Name; - msg.message = string.Format("You have been ejected from '{1}' by {0}.", remoteClient.Name, groupInfo.GroupName); - msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.MessageFromAgent; - msg.fromGroup = false; - msg.offline = (byte)0; - msg.ParentEstateID = 0; - msg.Position = Vector3.Zero; - msg.RegionID = remoteClient.Scene.RegionInfo.RegionID.Guid; - msg.binaryBucket = new byte[0]; - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) - { - m_log.DebugFormat("[GROUPS] Message Sent Success: {0}", - success,ToString()); - }); + // Send Message to Ejectee + GridInstantMessage msg = new GridInstantMessage(); + + msg.imSessionID = UUID.Zero.Guid; + msg.fromAgentID = remoteClient.AgentId.Guid; + // msg.fromAgentID = info.GroupID; + msg.toAgentID = ejecteeID.Guid; + //msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); + msg.timestamp = 0; + msg.fromAgentName = remoteClient.Name; + msg.message = string.Format("You have been ejected from '{1}' by {0}.", remoteClient.Name, groupInfo.GroupName); + msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.MessageFromAgent; + msg.fromGroup = false; + msg.offline = (byte)0; + msg.ParentEstateID = 0; + msg.Position = Vector3.Zero; + msg.RegionID = remoteClient.Scene.RegionInfo.RegionID.Guid; + msg.binaryBucket = new byte[0]; + OutgoingInstantMessage(msg, ejecteeID); - // Message to ejector - // Interop, received special 210 code for ejecting a group member - // this only works within the comms servers domain, and won't work hypergrid - // TODO:FIXME: Use a presense server of some kind to find out where the - // client actually is, and try contacting that region directly to notify them, - // or provide the notification via xmlrpc update queue + // Message to ejector + // Interop, received special 210 code for ejecting a group member + // this only works within the comms servers domain, and won't work hypergrid + // TODO:FIXME: Use a presense server of some kind to find out where the + // client actually is, and try contacting that region directly to notify them, + // or provide the notification via xmlrpc update queue - msg = new GridInstantMessage(); - msg.imSessionID = UUID.Zero.Guid; - msg.fromAgentID = remoteClient.AgentId.Guid; - msg.toAgentID = remoteClient.AgentId.Guid; - msg.timestamp = 0; - msg.fromAgentName = remoteClient.Name; - if (userProfile != null) - { - msg.message = string.Format("{2} has been ejected from '{1}' by {0}.", - remoteClient.Name, groupInfo.GroupName, userProfile.Name); - } - else - { - msg.message = string.Format("{2} has been ejected from '{1}' by {0}.", - remoteClient.Name, groupInfo.GroupName, "Unknown member"); - } - msg.dialog = (byte)210; //interop - msg.fromGroup = false; - msg.offline = (byte)0; - msg.ParentEstateID = 0; - msg.Position = Vector3.Zero; - msg.RegionID = remoteClient.Scene.RegionInfo.RegionID.Guid; - msg.binaryBucket = new byte[0]; - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) - { - m_log.DebugFormat("[GROUPS] Message Sent Success: {0}", - success, ToString()); - }); + msg = new GridInstantMessage(); + msg.imSessionID = UUID.Zero.Guid; + msg.fromAgentID = remoteClient.AgentId.Guid; + msg.toAgentID = remoteClient.AgentId.Guid; + msg.timestamp = 0; + msg.fromAgentName = remoteClient.Name; + if (userProfile != null) + { + msg.message = string.Format("{2} has been ejected from '{1}' by {0}.", remoteClient.Name, groupInfo.GroupName, userProfile.Name); } + else + { + msg.message = string.Format("{2} has been ejected from '{1}' by {0}.", remoteClient.Name, groupInfo.GroupName, "Unknown member"); + } + msg.dialog = (byte)210; //interop + msg.fromGroup = false; + msg.offline = (byte)0; + msg.ParentEstateID = 0; + msg.Position = Vector3.Zero; + msg.RegionID = remoteClient.Scene.RegionInfo.RegionID.Guid; + msg.binaryBucket = new byte[0]; + OutgoingInstantMessage(msg, remoteClient.AgentId); - UpdateAllClientsWithGroupInfo(); + + // SL sends out messages to everyone in the group + // Who all should receive updates and what should they be updated with? + UpdateAllClientsWithGroupInfo(ejecteeID); } public void InviteGroupRequest(IClientAPI remoteClient, UUID groupID, UUID invitedAgentID, UUID roleID) { - if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - m_log.WarnFormat("[GROUPS] GID {0}, AID {1}, RID {2} ", groupID, invitedAgentID, roleID); + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); // Todo: Security check, probably also want to send some kind of notification - UUID inviteID = UUID.Random(); - m_log.WarnFormat("[GROUPS] Invite ID: {0}", inviteID); - m_groupData.AddAgentToGroupInvite(inviteID, groupID, roleID, invitedAgentID); + UUID InviteID = UUID.Random(); + m_groupData.AddAgentToGroupInvite(InviteID, groupID, roleID, invitedAgentID); if (m_msgTransferModule != null) { - Guid inviteUUID = inviteID.Guid; + Guid inviteUUID = InviteID.Guid; GridInstantMessage msg = new GridInstantMessage(); @@ -1002,8 +1004,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups //msg.timestamp = (uint)Util.UnixTimeSinceEpoch(); msg.timestamp = 0; msg.fromAgentName = remoteClient.Name; - msg.message = string.Format("{0} has invited you to join a group. There is no cost to join this group.", - remoteClient.Name); + msg.message = string.Format("{0} has invited you to join a group. There is no cost to join this group.", remoteClient.Name); msg.dialog = (byte)OpenMetaverse.InstantMessageDialog.GroupInvitation; msg.fromGroup = true; msg.offline = (byte)0; @@ -1011,60 +1012,198 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups msg.Position = Vector3.Zero; msg.RegionID = remoteClient.Scene.RegionInfo.RegionID.Guid; msg.binaryBucket = new byte[20]; - - m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) - { - m_log.DebugFormat("[GROUPS] Message Sent Success: {0}", success,ToString()); - }); + + OutgoingInstantMessage(msg, invitedAgentID); } } #endregion - void SendGroupMembershipInfoViaCaps(IClientAPI remoteClient, GroupMembershipData[] data) + #region Client/Update Tools + + /// + /// Try to find an active IClientAPI reference for agentID giving preference to root connections + /// + private IClientAPI GetActiveClient(UUID agentID) + { + IClientAPI child = null; + + // Try root avatar first + foreach (Scene scene in m_sceneList) + { + if (scene.Entities.ContainsKey(agentID) && + scene.Entities[agentID] is ScenePresence) + { + ScenePresence user = (ScenePresence)scene.Entities[agentID]; + if (!user.IsChildAgent) + { + return user.ControllingClient; + } + else + { + child = user.ControllingClient; + } + } + } + + // If we didn't find a root, then just return whichever child we found, or null if none + return child; + } + + /// + /// Send 'remoteClient' the group membership 'data' for agent 'dataForAgentID'. + /// + private void SendGroupMembershipInfoViaCaps(IClientAPI remoteClient, UUID dataForAgentID, GroupMembershipData[] data) { if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); - OSDArray agentData = new OSDArray(1); - OSDMap agentDataMap = new OSDMap(1); - agentDataMap.Add("AgentID", OSD.FromUUID(remoteClient.AgentId)); - agentData.Add(agentDataMap); + OSDArray AgentData = new OSDArray(1); + OSDMap AgentDataMap = new OSDMap(1); + AgentDataMap.Add("AgentID", OSD.FromUUID(dataForAgentID)); + AgentData.Add(AgentDataMap); - OSDArray groupData = new OSDArray(data.Length); - OSDArray newGroupData = new OSDArray(data.Length); + OSDArray GroupData = new OSDArray(data.Length); + OSDArray NewGroupData = new OSDArray(data.Length); foreach (GroupMembershipData membership in data) { - OSDMap groupDataMap = new OSDMap(6); - OSDMap newGroupDataMap = new OSDMap(1); - - groupDataMap.Add("GroupID", OSD.FromUUID(membership.GroupID)); - groupDataMap.Add("GroupPowers", OSD.FromBinary(membership.GroupPowers)); - groupDataMap.Add("AcceptNotices", OSD.FromBoolean(membership.AcceptNotices)); - groupDataMap.Add("GroupInsigniaID", OSD.FromUUID(membership.GroupPicture)); - groupDataMap.Add("Contribution", OSD.FromInteger(membership.Contribution)); - groupDataMap.Add("GroupName", OSD.FromString(membership.GroupName)); - newGroupDataMap.Add("ListInProfile", OSD.FromBoolean(membership.ListInProfile)); - - groupData.Add(groupDataMap); - newGroupData.Add(newGroupDataMap); + OSDMap GroupDataMap = new OSDMap(6); + OSDMap NewGroupDataMap = new OSDMap(1); + + GroupDataMap.Add("GroupID", OSD.FromUUID(membership.GroupID)); + GroupDataMap.Add("GroupPowers", OSD.FromBinary(membership.GroupPowers)); + GroupDataMap.Add("AcceptNotices", OSD.FromBoolean(membership.AcceptNotices)); + GroupDataMap.Add("GroupInsigniaID", OSD.FromUUID(membership.GroupPicture)); + GroupDataMap.Add("Contribution", OSD.FromInteger(membership.Contribution)); + GroupDataMap.Add("GroupName", OSD.FromString(membership.GroupName)); + NewGroupDataMap.Add("ListInProfile", OSD.FromBoolean(membership.ListInProfile)); + + GroupData.Add(GroupDataMap); + NewGroupData.Add(NewGroupDataMap); } OSDMap llDataStruct = new OSDMap(3); - llDataStruct.Add("AgentData", agentData); - llDataStruct.Add("GroupData", groupData); - llDataStruct.Add("NewGroupData", newGroupData); + llDataStruct.Add("AgentData", AgentData); + llDataStruct.Add("GroupData", GroupData); + llDataStruct.Add("NewGroupData", NewGroupData); IEventQueue queue = remoteClient.Scene.RequestModuleInterface(); if (queue != null) { - queue.Enqueue(EventQueueHelper.buildEvent("AgentGroupDataUpdate", llDataStruct), - remoteClient.AgentId); + queue.Enqueue(EventQueueHelper.buildEvent("AgentGroupDataUpdate", llDataStruct), remoteClient.AgentId); } } + + private void SendScenePresenceUpdate(UUID AgentID, string Title) + { + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Updating scene title for {0} with title: {1}", AgentID, Title); + + ScenePresence presence = null; + lock (m_sceneList) + { + foreach (Scene scene in m_sceneList) + { + presence = scene.GetScenePresence(AgentID); + if (presence != null) + { + presence.Grouptitle = Title; + + // FixMe: Ter suggests a "Schedule" method that I can't find. + presence.SendFullUpdateToAllClients(); + } + } + } + } + + /// + /// Send updates to all clients who might be interested in groups data for dataForClientID + /// + private void UpdateAllClientsWithGroupInfo(UUID dataForClientID) + { + if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + + // TODO: Probably isn't nessesary to update every client in every scene. + // Need to examine client updates and do only what's nessesary. + lock (m_sceneList) + { + foreach (Scene scene in m_sceneList) + { + scene.ForEachClient(delegate(IClientAPI client) { SendAgentGroupDataUpdate(client, dataForClientID); }); + } + } + } + + /// + /// Update remoteClient with group information about dataForAgentID + /// + private void SendAgentGroupDataUpdate(IClientAPI client, UUID dataForAgentID) + { + if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called for {1}", System.Reflection.MethodBase.GetCurrentMethod().Name, client.Name); + + // TODO: All the client update functions need to be reexamined because most do too much and send too much stuff + + OnAgentDataUpdateRequest(client, dataForAgentID, UUID.Zero); + + + // Need to send a group membership update to the client + // UDP version doesn't seem to behave nicely + // client.SendGroupMembership(GetMembershipData(client.AgentId)); + + GroupMembershipData[] membershipData = m_groupData.GetAgentGroupMemberships(dataForAgentID).ToArray(); + + SendGroupMembershipInfoViaCaps(client, dataForAgentID, membershipData); + client.SendAvatarGroupsReply(dataForAgentID, membershipData); + + } + + private void SendAgentDataUpdate(IClientAPI remoteClient, UUID dataForAgentID, UUID activeGroupID, string activeGroupName, ulong activeGroupPowers, string activeGroupTitle) + { + if (m_debugEnabled) m_log.DebugFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + + // TODO: All the client update functions need to be reexamined because most do too much and send too much stuff + UserProfileData userProfile = m_sceneList[0].CommsManager.UserService.GetUserProfile(dataForAgentID); + string firstname, lastname; + if (userProfile != null) + { + firstname = userProfile.FirstName; + lastname = userProfile.SurName; + } + else + { + firstname = "Unknown"; + lastname = "Unknown"; + } + + remoteClient.SendAgentDataUpdate(dataForAgentID, activeGroupID, firstname, + lastname, activeGroupPowers, activeGroupName, + activeGroupTitle); + } + + #endregion + + #region IM Backed Processes + + private void OutgoingInstantMessage(GridInstantMessage msg, UUID msgTo) + { + if (m_debugEnabled) m_log.InfoFormat("[GROUPS] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name); + + IClientAPI localClient = GetActiveClient(msgTo); + if (localClient != null) + { + if (m_debugEnabled) m_log.InfoFormat("[GROUPS] MsgTo ({0}) is local, delivering directly", localClient.Name); + localClient.SendInstantMessage(msg); + } + else + { + if (m_debugEnabled) m_log.InfoFormat("[GROUPS] MsgTo ({0}) is not local, delivering via TransferModule", msgTo); + m_msgTransferModule.SendInstantMessage(msg, delegate(bool success) { if (m_debugEnabled) m_log.DebugFormat("[GROUPS] Message Sent: {0}", success?"Succeeded":"Failed"); }); + } + } + + #endregion } } -- cgit v1.1