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
0.6.5-rc1
Charles Krinke 2009-04-25 18:58:18 +00:00
parent e8c8cd52b8
commit c17a125445
3 changed files with 812 additions and 522 deletions

View File

@ -146,11 +146,15 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
| GroupPowers.VoteOnProposal; | GroupPowers.VoteOnProposal;
param["OwnersPowers"] = ((ulong)OwnerPowers).ToString(); param["OwnersPowers"] = ((ulong)OwnerPowers).ToString();
Hashtable respData = XmlRpcCall("groups.createGroup", param); Hashtable respData = XmlRpcCall("groups.createGroup", param);
if (respData.Contains("error")) if (respData.Contains("error"))
{ {
// UUID is not nullable // UUID is not nullable
return UUID.Zero; return UUID.Zero;
} }
@ -224,7 +228,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
public GroupRecord GetGroupRecord(UUID GroupID, string GroupName) public GroupRecord GetGroupRecord(UUID GroupID, string GroupName)
{ {
Hashtable param = new Hashtable(); Hashtable param = new Hashtable();
if (GroupID != UUID.Zero) if ((GroupID != null) && (GroupID != UUID.Zero))
{ {
param["GroupID"] = GroupID.ToString(); param["GroupID"] = GroupID.ToString();
} }
@ -233,6 +237,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
param["Name"] = GroupName.ToString(); param["Name"] = GroupName.ToString();
} }
Hashtable respData = XmlRpcCall("groups.getGroup", param); Hashtable respData = XmlRpcCall("groups.getGroup", param);
if (respData.Contains("error")) if (respData.Contains("error"))
@ -249,6 +254,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
Hashtable param = new Hashtable(); Hashtable param = new Hashtable();
param["GroupID"] = GroupID.ToString(); param["GroupID"] = GroupID.ToString();
Hashtable respData = XmlRpcCall("groups.getGroup", param); Hashtable respData = XmlRpcCall("groups.getGroup", param);
if (respData.Contains("error")) if (respData.Contains("error"))
@ -264,6 +270,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
MemberGroupProfile.PowersMask = MemberInfo.GroupPowers; MemberGroupProfile.PowersMask = MemberInfo.GroupPowers;
return MemberGroupProfile; return MemberGroupProfile;
} }
private GroupProfileData GroupProfileHashtableToGroupProfileData(Hashtable groupProfile) private GroupProfileData GroupProfileHashtableToGroupProfileData(Hashtable groupProfile)
@ -294,6 +301,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
private GroupRecord GroupProfileHashtableToGroupRecord(Hashtable groupProfile) private GroupRecord GroupProfileHashtableToGroupRecord(Hashtable groupProfile)
{ {
GroupRecord group = new GroupRecord(); GroupRecord group = new GroupRecord();
group.GroupID = UUID.Parse((string)groupProfile["GroupID"]); group.GroupID = UUID.Parse((string)groupProfile["GroupID"]);
group.GroupName = groupProfile["Name"].ToString(); group.GroupName = groupProfile["Name"].ToString();
@ -313,6 +321,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
return group; return group;
} }
public void SetAgentActiveGroup(UUID AgentID, UUID GroupID) public void SetAgentActiveGroup(UUID AgentID, UUID GroupID)
{ {
Hashtable param = new Hashtable(); Hashtable param = new Hashtable();
@ -341,6 +350,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
param["ListInProfile"] = ListInProfile ? "1" : "0"; param["ListInProfile"] = ListInProfile ? "1" : "0";
XmlRpcCall("groups.setAgentGroupInfo", param); XmlRpcCall("groups.setAgentGroupInfo", param);
} }
public void AddAgentToGroupInvite(UUID inviteID, UUID groupID, UUID roleID, UUID agentID) 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(); param["GroupID"] = groupID.ToString();
XmlRpcCall("groups.addAgentToGroupInvite", param); XmlRpcCall("groups.addAgentToGroupInvite", param);
} }
public GroupInviteInfo GetAgentToGroupInvite(UUID inviteID) public GroupInviteInfo GetAgentToGroupInvite(UUID inviteID)
@ -400,6 +411,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
param["GroupID"] = GroupID.ToString(); param["GroupID"] = GroupID.ToString();
XmlRpcCall("groups.removeAgentFromGroup", param); XmlRpcCall("groups.removeAgentFromGroup", param);
} }
public void AddAgentToGroupRole(UUID AgentID, UUID GroupID, UUID RoleID) public void AddAgentToGroupRole(UUID AgentID, UUID GroupID, UUID RoleID)
@ -422,6 +434,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
XmlRpcCall("groups.removeAgentFromGroupRole", param); XmlRpcCall("groups.removeAgentFromGroupRole", param);
} }
public List<DirGroupsReplyData> FindGroups(string search) public List<DirGroupsReplyData> FindGroups(string search)
{ {
Hashtable param = new Hashtable(); Hashtable param = new Hashtable();
@ -482,6 +495,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
return HashTableToGroupMembershipData(respData); return HashTableToGroupMembershipData(respData);
} }
public List<GroupMembershipData> GetAgentGroupMemberships(UUID AgentID) public List<GroupMembershipData> GetAgentGroupMemberships(UUID AgentID)
{ {
Hashtable param = new Hashtable(); Hashtable param = new Hashtable();
@ -529,6 +543,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
} }
return Roles; return Roles;
} }
public List<GroupRolesData> GetGroupRoles(UUID GroupID) public List<GroupRolesData> GetGroupRoles(UUID GroupID)
@ -559,6 +575,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
} }
return Roles; return Roles;
} }
private static GroupMembershipData HashTableToGroupMembershipData(Hashtable respData) private static GroupMembershipData HashTableToGroupMembershipData(Hashtable respData)
@ -583,7 +600,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
data.AllowPublish = ((string)respData["AllowPublish"] == "1"); data.AllowPublish = ((string)respData["AllowPublish"] == "1");
if (respData["Charter"] != null) if (respData["Charter"] != null)
{ {
data.Charter = (string)respData["Charter"]; data.Charter = (string)respData["Charter"];
} }
data.FounderID = new UUID((string)respData["FounderID"]); data.FounderID = new UUID((string)respData["FounderID"]);
data.GroupID = new UUID((string)respData["GroupID"]); data.GroupID = new UUID((string)respData["GroupID"]);
@ -626,6 +643,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
} }
return members; return members;
} }
public List<GroupRoleMembersData> GetGroupRoleMembers(UUID GroupID) public List<GroupRoleMembersData> GetGroupRoleMembers(UUID GroupID)
@ -642,10 +660,10 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
foreach (Hashtable membership in respData.Values) foreach (Hashtable membership in respData.Values)
{ {
GroupRoleMembersData data = new GroupRoleMembersData(); GroupRoleMembersData data = new GroupRoleMembersData();
data.MemberID = new UUID((string)membership["AgentID"]); data.MemberID = new UUID((string)membership["AgentID"]);
data.RoleID = new UUID((string)membership["RoleID"]); data.RoleID = new UUID((string)membership["RoleID"]);
members.Add(data); members.Add(data);
} }
} }
@ -685,9 +703,9 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
param["NoticeID"] = noticeID.ToString(); param["NoticeID"] = noticeID.ToString();
Hashtable respData = XmlRpcCall("groups.getGroupNotice", param); Hashtable respData = XmlRpcCall("groups.getGroupNotice", param);
if (!respData.Contains("error"))
if (respData.Contains("error"))
{ {
return null; return null;
} }
@ -775,7 +793,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
Hashtable error = new Hashtable(); Hashtable error = new Hashtable();
error.Add("error", "invalid return value"); error.Add("error", "invalid return value");
return error; return error;
} }
private void LogRespDataToConsoleError(Hashtable respData) private void LogRespDataToConsoleError(Hashtable respData)
{ {
@ -785,15 +803,15 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
{ {
m_log.ErrorFormat("[GROUPDATA] Key: {0}", key); m_log.ErrorFormat("[GROUPDATA] Key: {0}", key);
// object o = respData[key];
string[] lines = respData[key].ToString().Split(new char[] { '\n' }); string[] lines = respData[key].ToString().Split(new char[] { '\n' });
foreach (string line in lines) foreach (string line in lines)
{ {
m_log.ErrorFormat("[GROUPDATA] {0}", line); m_log.ErrorFormat("[GROUPDATA] {0}", line);
} }
} }
} }
} }
public class GroupNoticeInfo public class GroupNoticeInfo

View File

@ -26,7 +26,6 @@
*/ */
using System; using System;
//using System.Collections;
using System.Collections.Generic; using System.Collections.Generic;
using System.Reflection; using System.Reflection;
@ -47,25 +46,27 @@ using Caps = OpenSim.Framework.Communications.Capabilities.Caps;
namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups 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 static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private List<Scene> m_SceneList = new List<Scene>(); private List<Scene> m_sceneList = new List<Scene>();
// must be NonShared for this to work, otherewise we may actually get multiple active clients private IMessageTransferModule m_msgTransferModule = null;
private Dictionary<Guid, IClientAPI> m_ActiveClients = new Dictionary<Guid, IClientAPI>();
private IMessageTransferModule m_MsgTransferModule = null; private IGroupsModule m_groupsModule = null;
// TODO: Move this off to the xmlrpc 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 IGroupsModule m_GroupsModule = null;
// Config Options // Config Options
private bool m_GroupMessagingEnabled = true; private bool m_groupMessagingEnabled = true;
private bool m_debugEnabled = true; private bool m_debugEnabled = true;
#region IRegionModule Members #region IRegionModuleBase Members
public void Initialise(IConfigSource config) public void Initialise(IConfigSource config)
{ {
@ -90,14 +91,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
if (groupsConfig.GetString("Module", "Default") != "XmlRpcGroups") if (groupsConfig.GetString("Module", "Default") != "XmlRpcGroups")
{ {
m_log.Info("[GROUPS-MESSAGING]: Config Groups Module not set to XmlRpcGroups"); m_log.Info("[GROUPS-MESSAGING]: Config Groups Module not set to XmlRpcGroups");
m_GroupMessagingEnabled = false; m_groupMessagingEnabled = false;
return; 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."); m_log.Info("[GROUPS-MESSAGING]: XmlRpcGroups Messaging disabled.");
return; return;
@ -113,76 +114,74 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
public void AddRegion(Scene scene) public void AddRegion(Scene scene)
{ {
// NoOp
} }
public void RegionLoaded(Scene scene) public void RegionLoaded(Scene scene)
{ {
if (!m_GroupMessagingEnabled) if (!m_groupMessagingEnabled)
return; 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<IGroupsModule>(); m_groupsModule = scene.RequestModuleInterface<IGroupsModule>();
// No groups module, no groups messaging // No groups module, no groups messaging
if (m_GroupsModule == null) if (m_groupsModule == null)
{ {
m_GroupMessagingEnabled = false; m_groupMessagingEnabled = false;
m_log.Info("[GROUPS-MESSAGING]: Could not get IGroupsModule, XmlRpcGroupsMessaging is now disabled."); m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsModule, XmlRpcGroupsMessaging is now disabled.");
Close(); Close();
return; return;
} }
m_MsgTransferModule = scene.RequestModuleInterface<IMessageTransferModule>(); m_msgTransferModule = scene.RequestModuleInterface<IMessageTransferModule>();
// No message transfer module, no groups messaging // No message transfer module, no groups messaging
if (m_MsgTransferModule == null) if (m_msgTransferModule == null)
{ {
m_GroupMessagingEnabled = false; m_groupMessagingEnabled = false;
m_log.Info("[GROUPS-MESSAGING]: Could not get MessageTransferModule"); m_log.Error("[GROUPS-MESSAGING]: Could not get MessageTransferModule");
Close(); Close();
return; return;
} }
m_SceneList.Add(scene); m_sceneList.Add(scene);
scene.EventManager.OnNewClient += OnNewClient; scene.EventManager.OnNewClient += OnNewClient;
scene.EventManager.OnClientClosed += OnClientClosed;
scene.EventManager.OnIncomingInstantMessage += OnGridInstantMessage; scene.EventManager.OnIncomingInstantMessage += OnGridInstantMessage;
} }
public void RemoveRegion(Scene scene) public void RemoveRegion(Scene scene)
{ {
if (!m_GroupMessagingEnabled) if (!m_groupMessagingEnabled)
return; 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() public void Close()
{ {
if (!m_GroupMessagingEnabled) if (!m_groupMessagingEnabled)
return; 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.OnNewClient -= OnNewClient;
scene.EventManager.OnClientClosed -= OnClientClosed;
scene.EventManager.OnIncomingInstantMessage -= OnGridInstantMessage; scene.EventManager.OnIncomingInstantMessage -= OnGridInstantMessage;
} }
m_SceneList.Clear(); m_sceneList.Clear();
m_GroupsModule = null; m_groupsModule = null;
m_MsgTransferModule = null; m_msgTransferModule = null;
} }
public string Name public string Name
@ -192,195 +191,293 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
#endregion #endregion
#region ISharedRegionModule Members
public void PostInitialise()
{
// NoOp
}
#endregion
#region SimGridEventHandlers #region SimGridEventHandlers
private void OnNewClient(IClientAPI client) private void OnNewClient(IClientAPI client)
{ {
RegisterClientAgent(client); if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] OnInstantMessage registered for {0}", client.Name);
}
private void OnClientClosed(UUID AgentId) client.OnInstantMessage += OnInstantMessage;
{
UnregisterClientAgent(AgentId);
} }
private void OnGridInstantMessage(GridInstantMessage msg) 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); DebugGridInstantMessage(msg);
}
// Incoming message from a group // 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)
))
{ {
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnGridInstantMessage from group session {0} going to agent {1}", msg.fromAgentID, msg.toAgentID); ProcessMessageFromGroupSession(msg);
if (m_ActiveClients.ContainsKey(msg.toAgentID))
{
UUID GroupID = new UUID(msg.fromAgentID);
// SendMessageToGroup(im);
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");
// Force? open the group session dialog???
IEventQueue eq = m_ActiveClients[msg.toAgentID].Scene.RequestModuleInterface<IEventQueue>();
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));
eq.ChatterBoxSessionAgentListUpdates(
new UUID(GroupID),
new UUID(msg.fromAgentID),
new UUID(msg.toAgentID),
false, //canVoiceChat
false, //isModerator
false); //text mute
}
}
} }
} }
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))
{
// 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);
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);
if (groupInfo != null)
{
if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Sending chatterbox invite instant message");
// Force? open the group session dialog???
IEventQueue eq = activeClient.Scene.RequestModuleInterface<IEventQueue>();
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)
);
eq.ChatterBoxSessionAgentListUpdates(
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 #endregion
#region ClientEvents #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>());
}
}
private void OnInstantMessage(IClientAPI remoteClient, GridInstantMessage im) 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);
DebugGridInstantMessage(im); DebugGridInstantMessage(im);
}
// Start group IM session // Start group IM session
if ((im.dialog == (byte)InstantMessageDialog.SessionGroupStart)) if ((im.dialog == (byte)InstantMessageDialog.SessionGroupStart))
{ {
UUID GroupID = new UUID(im.toAgentID); UUID groupID = new UUID(im.toAgentID);
GroupRecord GroupInfo = m_GroupsModule.GetGroupRecord(GroupID); GroupRecord groupInfo = m_groupsModule.GetGroupRecord(groupID);
if (GroupInfo != null) if (groupInfo != null)
{ {
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Start Group Session for {0}", GroupInfo.GroupName); if (m_debugEnabled) m_log.DebugFormat("[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])); AddAgentToGroupSession(im.fromAgentID, im.imSessionID);
ChatterBoxSessionStartReplyViaCaps(remoteClient, GroupInfo.GroupName, GroupID); ChatterBoxSessionStartReplyViaCaps(remoteClient, groupInfo.GroupName, groupID);
IEventQueue queue = remoteClient.Scene.RequestModuleInterface<IEventQueue>(); IEventQueue queue = remoteClient.Scene.RequestModuleInterface<IEventQueue>();
queue.ChatterBoxSessionAgentListUpdates( queue.ChatterBoxSessionAgentListUpdates(
new UUID(GroupID), new UUID(groupID)
new UUID(im.fromAgentID), , new UUID(im.fromAgentID)
new UUID(im.toAgentID), , new UUID(im.toAgentID)
false, //canVoiceChat , false //canVoiceChat
false, //isModerator , false //isModerator
false); //text mute , false //text mute
);
} }
} }
// Send a message to a group // Send a message from locally connected client to a group
if ((im.dialog == (byte)InstantMessageDialog.SessionSend)) if ((im.dialog == (byte)InstantMessageDialog.SessionSend))
{ {
UUID GroupID = new UUID(im.toAgentID); UUID groupID = new UUID(im.toAgentID);
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Send message to session for group {0}", GroupID); if (m_debugEnabled) m_log.DebugFormat("[GROUPS-MESSAGING] Send message to session for group {0} with session ID {1}", groupID, im.imSessionID.ToString());
SendMessageToGroup(im, GroupID); SendMessageToGroup(im, groupID);
}
// Incoming message from a group
if ((im.dialog == (byte)InstantMessageDialog.SessionSend) && (im.fromGroup == true))
{
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] Message from group session {0} going to agent {1}", im.fromAgentID, im.toAgentID);
} }
} }
#endregion #endregion
private void RegisterClientAgent(IClientAPI client)
{
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] {0} called", System.Reflection.MethodBase.GetCurrentMethod().Name);
lock (m_ActiveClients)
{
if (!m_ActiveClients.ContainsKey(client.AgentId.Guid))
{
client.OnInstantMessage += OnInstantMessage;
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnInstantMessage registered for {0}", client.Name);
m_ActiveClients.Add(client.AgentId.Guid, client);
}
else
{
// Remove old client connection for this agent
UnregisterClientAgent(client.AgentId);
// Add new client connection
RegisterClientAgent(client);
}
}
}
private void UnregisterClientAgent(UUID agentID)
{
lock (m_ActiveClients)
{
if (m_ActiveClients.ContainsKey(agentID.Guid))
{
IClientAPI client = m_ActiveClients[agentID.Guid];
client.OnInstantMessage -= OnInstantMessage;
if (m_debugEnabled) m_log.InfoFormat("[GROUPS-MESSAGING] OnInstantMessage unregistered for {0}", client.Name);
m_ActiveClients.Remove(agentID.Guid);
}
else
{
m_log.InfoFormat("[GROUPS-MESSAGING] Client closed that wasn't registered here.");
}
}
}
private void SendMessageToGroup(GridInstantMessage im, UUID groupID) 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(); GridInstantMessage msg = new GridInstantMessage();
msg.imSessionID = im.imSessionID; msg.imSessionID = im.imSessionID;
msg.fromAgentID = im.imSessionID; // GroupID
msg.timestamp = (uint)Util.UnixTimeSinceEpoch();
msg.fromAgentName = im.fromAgentName; msg.fromAgentName = im.fromAgentName;
msg.message = im.message; msg.message = im.message;
msg.dialog = im.dialog; msg.dialog = im.dialog;
msg.fromGroup = true; msg.offline = im.offline;
msg.offline = (byte)0;
msg.ParentEstateID = im.ParentEstateID; msg.ParentEstateID = im.ParentEstateID;
msg.Position = im.Position; msg.Position = im.Position;
msg.RegionID = im.RegionID; 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; 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) 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); OSDMap moderatedMap = new OSDMap(4);
moderatedMap.Add("voice", OSD.FromBoolean(false)); moderatedMap.Add("voice", OSD.FromBoolean(false));
@ -398,12 +495,14 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
bodyMap.Add("success", OSD.FromBoolean(true)); bodyMap.Add("success", OSD.FromBoolean(true));
bodyMap.Add("session_info", sessionMap); bodyMap.Add("session_info", sessionMap);
IEventQueue queue = remoteClient.Scene.RequestModuleInterface<IEventQueue>(); IEventQueue queue = remoteClient.Scene.RequestModuleInterface<IEventQueue>();
if (queue != null) if (queue != null)
{ {
queue.Enqueue(EventQueueHelper.buildEvent("ChatterBoxSessionStartReply", bodyMap), remoteClient.AgentId); 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")); m_log.WarnFormat("[GROUPS-MESSAGING] IM: binaryBucket({0})", OpenMetaverse.Utils.BytesToHexString(im.binaryBucket, "BinaryBucket"));
} }
} }
#region Client Tools
/// <summary>
/// Try to find an active IClientAPI reference for agentID giving preference to root connections
/// </summary>
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
}
} }