/* * Copyright (c) Contributors, http://opensimulator.org/ * See CONTRIBUTORS.TXT for a full list of copyright holders. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of the OpenSim Project nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ using System; using System.Collections; using System.Collections.Generic; using System.Reflection; using System.Net; using System.Threading; using libsecondlife; using log4net; using Nini.Config; using Nwc.XmlRpc; using OpenSim.Framework; using OpenSim.Region.Environment.Interfaces; using OpenSim.Region.Environment.Scenes; namespace OpenSim.Region.Environment.Modules.Avatar.InstantMessage { public class InstantMessageModule : IRegionModule { private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); private readonly List m_scenes = new List(); private Dictionary m_userRegionMap = new Dictionary(); #region IRegionModule Members private bool gridmode = false; public void Initialise(Scene scene, IConfigSource config) { lock (m_scenes) { if (m_scenes.Count == 0) { //scene.AddXmlRPCHandler("avatar_location_update", processPresenceUpdate); scene.AddXmlRPCHandler("grid_instant_message", processXMLRPCGridInstantMessage); ReadConfig(config); } if (!m_scenes.Contains(scene)) { m_scenes.Add(scene); scene.EventManager.OnNewClient += OnNewClient; scene.EventManager.OnGridInstantMessageToIMModule += OnGridInstantMessage; } } } private void ReadConfig(IConfigSource config) { IConfig cnf = config.Configs["Startup"]; if (cnf != null) { gridmode = cnf.GetBoolean("gridmode", false); } } public void PostInitialise() { } public void Close() { } public string Name { get { return "InstantMessageModule"; } } public bool IsSharedModule { get { return true; } } #endregion private void OnNewClient(IClientAPI client) { client.OnInstantMessage += OnInstantMessage; } private void OnInstantMessage(IClientAPI client, LLUUID fromAgentID, LLUUID fromAgentSession, LLUUID toAgentID, LLUUID imSessionID, uint timestamp, string fromAgentName, string message, byte dialog, bool fromGroup, byte offline, uint ParentEstateID, LLVector3 Position, LLUUID RegionID, byte[] binaryBucket) { bool dialogHandledElsewhere = ((dialog == 38) || (dialog == 39) || (dialog == 40) || dialog == (byte) InstantMessageDialog.InventoryOffered || dialog == (byte) InstantMessageDialog.InventoryAccepted || dialog == (byte) InstantMessageDialog.InventoryDeclined); // IM dialogs need to be pre-processed and have their sessionID filled by the server // so the sim can match the transaction on the return packet. // Don't send a Friend Dialog IM with a LLUUID.Zero session. if (!(dialogHandledElsewhere && imSessionID == LLUUID.Zero)) { // Try root avatar only first foreach (Scene scene in m_scenes) { if (scene.Entities.ContainsKey(toAgentID) && scene.Entities[toAgentID] is ScenePresence) { // Local message ScenePresence user = (ScenePresence) scene.Entities[toAgentID]; if (!user.IsChildAgent) { user.ControllingClient.SendInstantMessage(fromAgentID, fromAgentSession, message, toAgentID, imSessionID, fromAgentName, dialog, timestamp); // Message sent return; } } } // try child avatar second foreach (Scene scene in m_scenes) { if (scene.Entities.ContainsKey(toAgentID) && scene.Entities[toAgentID] is ScenePresence) { // Local message ScenePresence user = (ScenePresence) scene.Entities[toAgentID]; user.ControllingClient.SendInstantMessage(fromAgentID, fromAgentSession, message, toAgentID, imSessionID, fromAgentName, dialog, timestamp); // Message sent return; } } if (gridmode) { // Still here, try send via Grid // TODO if (client != null) { if (dialog != (byte)InstantMessageDialog.StartTyping && dialog != (byte)InstantMessageDialog.StopTyping && dialog != (byte)InstantMessageDialog.SessionDrop) client.SendInstantMessage(toAgentID, fromAgentSession, "Unable to send instant message", fromAgentID, imSessionID, "System", (byte)InstantMessageDialog.BusyAutoResponse, (uint)Util.UnixTimeSinceEpoch());// SendAlertMessage("Unable to send instant message"); } } } } // Trusty OSG1 called method. This method also gets called from the FriendsModule // Turns out the sim has to send an instant message to the user to get it to show an accepted friend. private void OnGridInstantMessage(GridInstantMessage msg) { // Trigger the above event handler OnInstantMessage(null, new LLUUID(msg.fromAgentID), new LLUUID(msg.fromAgentSession), new LLUUID(msg.toAgentID), new LLUUID(msg.imSessionID), msg.timestamp, msg.fromAgentName, msg.message, msg.dialog, msg.fromGroup, msg.offline, msg.ParentEstateID, new LLVector3(msg.Position.x, msg.Position.y, msg.Position.z), new LLUUID(msg.RegionID), msg.binaryBucket); } protected virtual XmlRpcResponse processXMLRPCGridInstantMessage(XmlRpcRequest request) { bool successful = false; // various rational defaults LLUUID fromAgentID = LLUUID.Zero; LLUUID fromAgentSession = LLUUID.Zero; LLUUID toAgentID = LLUUID.Zero; LLUUID imSessionID = LLUUID.Zero; uint timestamp = 0; string fromAgentName = ""; string message = ""; byte dialog = (byte)0; bool fromGroup = false; byte offline = (byte)0; uint ParentEstateID=0; LLVector3 Position = LLVector3.Zero; LLUUID RegionID = LLUUID.Zero ; byte[] binaryBucket = new byte[0]; float pos_x = 0; float pos_y = 0; float pos_z = 0; Hashtable requestData = (Hashtable)request.Params[0]; if (requestData.ContainsKey("from_agent_id") && requestData.ContainsKey("from_agent_session") && requestData.ContainsKey("to_agent_id") && requestData.ContainsKey("im_session_id") && requestData.ContainsKey("timestamp") && requestData.ContainsKey("from_agent_name") && requestData.ContainsKey("message") && requestData.ContainsKey("dialog") && requestData.ContainsKey("from_group") && requestData.ContainsKey("offline") && requestData.ContainsKey("parent_estate_id") && requestData.ContainsKey("position_x") && requestData.ContainsKey("position_y") && requestData.ContainsKey("position_z") && requestData.ContainsKey("region_id") && requestData.ContainsKey("binary_bucket") && requestData.ContainsKey("region_handle")) { Helpers.TryParse((string)requestData["from_agent_id"], out fromAgentID); Helpers.TryParse((string)requestData["from_agent_session"], out fromAgentSession); Helpers.TryParse((string)requestData["to_agent_id"], out toAgentID); Helpers.TryParse((string)requestData["im_session_id"], out imSessionID); Helpers.TryParse((string)requestData["region_id"], out RegionID); # region timestamp try { timestamp = (uint)Convert.ToInt32((string)requestData["timestamp"]); } catch (ArgumentException) { } catch (FormatException) { } catch (OverflowException) { } # endregion fromAgentName = (string)requestData["from_agent_name"]; message = (string)requestData["message"]; dialog = (byte)requestData["dialog"]; if ((string)requestData["from_group"] == "TRUE") fromGroup = true; offline = (byte)requestData["offline"]; # region ParentEstateID try { ParentEstateID = (uint)Convert.ToInt32((string)requestData["parent_estate_id"]); } catch (ArgumentException) { } catch (FormatException) { } catch (OverflowException) { } # endregion # region pos_x try { pos_x = (uint)Convert.ToInt32((string)requestData["position_x"]); } catch (ArgumentException) { } catch (FormatException) { } catch (OverflowException) { } # endregion # region pos_y try { pos_y = (uint)Convert.ToInt32((string)requestData["position_y"]); } catch (ArgumentException) { } catch (FormatException) { } catch (OverflowException) { } # endregion # region pos_z try { pos_z = (uint)Convert.ToInt32((string)requestData["position_z"]); } catch (ArgumentException) { } catch (FormatException) { } catch (OverflowException) { } # endregion Position = new LLVector3(pos_x, pos_y, pos_z); binaryBucket = (byte[])requestData["binary_bucket"]; GridInstantMessage gim = new GridInstantMessage(); gim.fromAgentID = fromAgentID.UUID; gim.fromAgentName = fromAgentName; gim.fromAgentSession = fromAgentSession.UUID; gim.fromGroup = fromGroup; gim.imSessionID = imSessionID.UUID; gim.RegionID = RegionID.UUID; gim.timestamp = timestamp; gim.toAgentID = toAgentID.UUID; gim.message = message; gim.dialog = dialog; gim.offline = offline; gim.ParentEstateID = ParentEstateID; gim.Position = new sLLVector3(Position); gim.binaryBucket = binaryBucket; foreach (Scene scene in m_scenes) { if (scene.Entities.ContainsKey(toAgentID) && scene.Entities[toAgentID] is ScenePresence) { // Local message ScenePresence user = (ScenePresence)scene.Entities[toAgentID]; if (!user.IsChildAgent) { scene.EventManager.TriggerGridInstantMessage(gim, InstantMessageReceiver.FriendsModule | InstantMessageReceiver.GroupsModule | InstantMessageReceiver.IMModule); } } } OnGridInstantMessage(gim); successful = true; } XmlRpcResponse resp = new XmlRpcResponse(); Hashtable respdata = new Hashtable(); if (successful) respdata["success"] = "TRUE"; else respdata["success"] = "FALSE"; resp.Value = respdata; return resp; } protected virtual void SendGridInstantMessageViaXMLRPC(IClientAPI client, LLUUID fromAgentID, LLUUID fromAgentSession, LLUUID toAgentID, LLUUID imSessionID, uint timestamp, string fromAgentName, string message, byte dialog, bool fromGroup, byte offline, uint ParentEstateID, LLVector3 Position, LLUUID RegionID, byte[] binaryBucket, ulong regionhandle, ulong prevRegionHandle) { UserAgentData upd = null; bool lookupAgent = false; lock (m_userRegionMap) { if (m_userRegionMap.ContainsKey(toAgentID) && prevRegionHandle == 0) { upd = new UserAgentData(); upd.AgentOnline = true; upd.Handle = m_userRegionMap[toAgentID]; } else { lookupAgent = true; } } if (lookupAgent) { upd = m_scenes[0].CommsManager.UserService.GetAgentByUUID(toAgentID); // check if we've tried this before.. if (upd.Handle == prevRegionHandle) { m_log.Error("[GRID INSTANT MESSAGE]: Unable to deliver an instant message"); if (client != null) client.SendInstantMessage(toAgentID, fromAgentSession, "Unable to send instant message", fromAgentID, imSessionID, "System", (byte)InstantMessageDialog.MessageFromObject,(uint)Util.UnixTimeSinceEpoch());// SendAlertMessage("Unable to send instant message"); return; } } if (upd != null) { if (upd.AgentOnline) { RegionInfo reginfo = m_scenes[0].CommsManager.GridService.RequestNeighbourInfo(upd.Handle); if (reginfo != null) { GridInstantMessage msg = new GridInstantMessage(); msg.fromAgentID = fromAgentID.UUID; msg.fromAgentSession = fromAgentSession.UUID; msg.toAgentID = toAgentID.UUID; msg.imSessionID = imSessionID.UUID; msg.timestamp = timestamp; msg.fromAgentName = fromAgentName; msg.message = message; msg.dialog = dialog; msg.fromGroup = fromGroup; msg.offline = offline; msg.ParentEstateID = ParentEstateID; msg.Position = new sLLVector3(Position); msg.RegionID = RegionID.UUID; msg.binaryBucket = binaryBucket; Hashtable msgdata = ConvertGridInstantMessageToXMLRPC(msg); msgdata["region_handle"] = getLocalRegionHandleFromUUID(RegionID); bool imresult = doIMSending(reginfo, msgdata); if (imresult) { lock (m_userRegionMap) { if (m_userRegionMap.ContainsKey(toAgentID)) { m_userRegionMap[toAgentID] = upd.Handle; } else { m_userRegionMap.Add(toAgentID, upd.Handle); } } m_log.Info("[GRID INSTANT MESSAGE]: Successfully sent a message"); } else { // try again, but lookup user this time. SendGridInstantMessageViaXMLRPC(client, fromAgentID, fromAgentSession, toAgentID, imSessionID, timestamp, fromAgentName, message, dialog, fromGroup, offline, ParentEstateID, Position, RegionID, binaryBucket, regionhandle, upd.Handle); } } } else { // send Agent Offline message if (client != null) client.SendInstantMessage(toAgentID, fromAgentSession, "Unable to send instant message", fromAgentID, imSessionID, "System", (byte)InstantMessageDialog.MessageFromObject, (uint)Util.UnixTimeSinceEpoch());// SendAlertMessage("Unable to send instant message"); } } else { // send Agent Offline message if (client != null) client.SendInstantMessage(toAgentID, fromAgentSession, "Unable to send instant message", fromAgentID, imSessionID, "System", (byte)InstantMessageDialog.MessageFromObject, (uint)Util.UnixTimeSinceEpoch());// SendAlertMessage("Unable to send instant message"); } } private bool doIMSending(RegionInfo reginfo, Hashtable xmlrpcdata) { ArrayList SendParams = new ArrayList(); SendParams.Add(xmlrpcdata); XmlRpcRequest GridReq = new XmlRpcRequest("grid_instant_message", SendParams); try { XmlRpcResponse GridResp = GridReq.Send("http://" + reginfo.ExternalHostName + ":" + reginfo.HttpPort, 3000); Hashtable responseData = (Hashtable)GridResp.Value; if (responseData.ContainsKey("success")) { if ((string)responseData["success"] == "TRUE") { return true; } else { return false; } } else { return false; } } catch (WebException) { m_log.ErrorFormat("[GRID INSTANT MESSAGE]: Error sending message to {0} the host didn't respond", "http://" + reginfo.ExternalHostName + ":" + reginfo.HttpPort); } return false; } private ulong getLocalRegionHandleFromUUID(LLUUID regionID) { ulong returnhandle = 0; lock (m_scenes) { foreach (Scene sn in m_scenes) { if (sn.RegionInfo.RegionID == regionID) { returnhandle = sn.RegionInfo.RegionHandle; break; } } } return returnhandle; } private Hashtable ConvertGridInstantMessageToXMLRPC(GridInstantMessage msg) { Hashtable gim = new Hashtable(); gim["from_agent_id"] = msg.fromAgentID.ToString(); gim["from_agent_session"] = msg.fromAgentSession.ToString(); gim["to_agent_id"] = msg.toAgentID.ToString(); gim["im_session_id"] = msg.imSessionID.ToString(); gim["timestamp"] = msg.timestamp.ToString(); gim["from_agent_name"] = msg.fromAgentName; gim["message"] = msg.message; gim["dialog"] = msg.dialog; if (msg.fromGroup) gim["from_group"] = "TRUE"; else gim["from_group"] = "FALSE"; gim["offline"] = msg.offline; gim["parent_estate_id"] = msg.ParentEstateID.ToString(); gim["position_x"] = msg.Position.x.ToString(); gim["position_y"] = msg.Position.y.ToString(); gim["position_z"] = msg.Position.z.ToString(); gim["region_id"] = msg.RegionID.ToString(); gim["binary_bucket"] = msg.binaryBucket; return gim; } } }