aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Environment
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/Environment')
-rw-r--r--OpenSim/Region/Environment/InstantMessageReceiver.cs28
-rw-r--r--OpenSim/Region/Environment/Modules/FriendsModule.cs175
-rw-r--r--OpenSim/Region/Environment/Modules/InstantMessageModule.cs45
-rw-r--r--OpenSim/Region/Environment/Scenes/Scene.cs41
-rw-r--r--OpenSim/Region/Environment/Scenes/SceneEvents.cs36
5 files changed, 291 insertions, 34 deletions
diff --git a/OpenSim/Region/Environment/InstantMessageReceiver.cs b/OpenSim/Region/Environment/InstantMessageReceiver.cs
new file mode 100644
index 0000000..ecda399
--- /dev/null
+++ b/OpenSim/Region/Environment/InstantMessageReceiver.cs
@@ -0,0 +1,28 @@
1using System;
2
3namespace OpenSim.Region.Environment
4{
5 /// <summary>
6 /// Bit Vector for Which Modules to send an instant message to from the Scene or an Associated Module
7 /// </summary>
8
9 // This prevents the Modules from sending Instant messages to other modules through the scene
10 // and then receiving the same messages
11
12 // This is mostly here because on LLSL and the SecondLife Client, IMs,Groups and friends are linked
13 // inseparably
14
15 [Flags]
16 public enum InstantMessageReceiver : uint
17 {
18 /// <summary>None of them.. here for posterity and amusement</summary>
19 None = 0,
20 /// <summary>The IM Module</summary>
21 IMModule = 0x00000001,
22 /// <summary>The Friends Module</summary>
23 FriendsModule = 0x00000002,
24 /// <summary>The Groups Module</summary>
25 GroupsModule = 0x00000004
26
27 }
28}
diff --git a/OpenSim/Region/Environment/Modules/FriendsModule.cs b/OpenSim/Region/Environment/Modules/FriendsModule.cs
index ee78f15..d6be63b 100644
--- a/OpenSim/Region/Environment/Modules/FriendsModule.cs
+++ b/OpenSim/Region/Environment/Modules/FriendsModule.cs
@@ -35,53 +35,180 @@ using OpenSim.Framework.Console;
35using OpenSim.Region.Environment.Interfaces; 35using OpenSim.Region.Environment.Interfaces;
36using OpenSim.Region.Environment.Scenes; 36using OpenSim.Region.Environment.Scenes;
37using libsecondlife; 37using libsecondlife;
38using libsecondlife.Packets;
39 38
40namespace OpenSim.Region.Environment.Modules 39namespace OpenSim.Region.Environment.Modules
41{ 40{
42 public class FriendsModule : IRegionModule 41 public class FriendsModule : IRegionModule
43 { 42 {
44 private List<Scene> m_scenes = new List<Scene>(); 43
45 private LogBase m_log; 44 private LogBase m_log;
46 45
46 private Scene m_scene;
47
48 Dictionary<LLUUID, LLUUID> m_pendingFriendRequests = new Dictionary<LLUUID, LLUUID>();
49
47 public void Initialise(Scene scene, IConfigSource config) 50 public void Initialise(Scene scene, IConfigSource config)
48 { 51 {
49 m_log = MainLog.Instance; 52 m_log = MainLog.Instance;
50 if (!m_scenes.Contains(scene)) 53 m_scene = scene;
51 { 54 scene.EventManager.OnNewClient += OnNewClient;
52 m_scenes.Add(scene); 55 scene.EventManager.OnGridInstantMessageToFriendsModule += OnGridInstantMessage;
53 scene.EventManager.OnNewClient += OnNewClient;
54 }
55 } 56 }
56 57
57 private void OnNewClient(IClientAPI client) 58 private void OnNewClient(IClientAPI client)
58 { 59 {
59 //FormFriendship(client,new Guid("c43a67ab-b196-4d62-936c-b40369547dee")); 60 // All friends establishment protocol goes over instant message
60 //FormFriendship(client, new Guid("0a2f777b-f44c-4662-8b22-c90ae038a3e6")); 61 // There's no way to send a message from the sim
61 } 62 // to a user to 'add a friend' without causing dialog box spam
63 //
64 // The base set of friends are added when the user signs on in their XMLRPC response
65 // Generated by LoginService. The friends are retreived from the database by the UserManager
62 66
63 public void PostInitialise() 67 // Subscribe to instant messages
68 client.OnInstantMessage += OnInstantMessage;
69 client.OnApproveFriendRequest += OnApprovedFriendRequest;
70 client.OnDenyFriendRequest += OnDenyFriendRequest;
71 client.OnTerminateFriendship += OnTerminateFriendship;
72
73
74 }
75 private void OnInstantMessage(LLUUID fromAgentID,
76 LLUUID fromAgentSession, LLUUID toAgentID,
77 LLUUID imSessionID, uint timestamp, string fromAgentName,
78 string message, byte dialog, bool fromGroup, byte offline,
79 uint ParentEstateID, LLVector3 Position, LLUUID RegionID,
80 byte[] binaryBucket)
64 { 81 {
82 // Friend Requests go by Instant Message.. using the dialog param
83 // https://wiki.secondlife.com/wiki/ImprovedInstantMessage
84
85 // 38 == Offer friendship
86 if (dialog == (byte)38)
87 {
88 LLUUID friendTransactionID = LLUUID.Random();
89
90 m_pendingFriendRequests.Add(friendTransactionID, fromAgentID);
91
92 m_log.Verbose("FRIEND", "38 - From:" + fromAgentID.ToString() + " To: " + toAgentID.ToString() + " Session:" + imSessionID.ToString() + " Message:" + message);
93 GridInstantMessage msg = new GridInstantMessage();
94 msg.fromAgentID = fromAgentID.UUID;
95 msg.fromAgentSession = fromAgentSession.UUID;
96 msg.toAgentID = toAgentID.UUID;
97 msg.imSessionID = friendTransactionID.UUID; // This is the item we're mucking with here
98 m_log.Verbose("FRIEND","Filling Session: " + msg.imSessionID.ToString());
99 msg.timestamp = timestamp;
100 msg.fromAgentName = fromAgentName;
101 msg.message = message;
102 msg.dialog = dialog;
103 msg.fromGroup = fromGroup;
104 msg.offline = offline;
105 msg.ParentEstateID = ParentEstateID;
106 msg.Position = new sLLVector3(Position);
107 msg.RegionID = RegionID.UUID;
108 msg.binaryBucket = binaryBucket;
109 m_scene.TriggerGridInstantMessage(msg, InstantMessageReceiver.IMModule);
110 }
111 if (dialog == (byte)39)
112 {
113 m_log.Verbose("FRIEND", "38 - From:" + fromAgentID.ToString() + " To: " + toAgentID.ToString() + " Session:" + imSessionID.ToString() + " Message:" + message);
114
115 }
116 if (dialog == (byte)40)
117 {
118 m_log.Verbose("FRIEND", "38 - From:" + fromAgentID.ToString() + " To: " + toAgentID.ToString() + " Session:" + imSessionID.ToString() + " Message:" + message);
119 }
120
121 // 39 == Accept Friendship
122
123 // 40 == Decline Friendship
124
65 } 125 }
66 126
67 private void FormFriendship(IClientAPI client, Guid friend) 127 private void OnApprovedFriendRequest(IClientAPI client, LLUUID agentID, LLUUID transactionID, List<LLUUID> callingCardFolders)
68 { 128 {
69 foreach (Scene scene in m_scenes) 129 if (m_pendingFriendRequests.ContainsKey(transactionID))
70 { 130 {
71 if (scene.Entities.ContainsKey(client.AgentId) && scene.Entities[client.AgentId] is ScenePresence) 131 // Found Pending Friend Request with that Transaction..
72 { 132
73 OnlineNotificationPacket ONPack = new OnlineNotificationPacket(); 133 // Compose response to other agent.
74 OnlineNotificationPacket.AgentBlockBlock[] AgentBlock = new OnlineNotificationPacket.AgentBlockBlock[1]; 134 GridInstantMessage msg = new GridInstantMessage();
75 135 msg.toAgentID = m_pendingFriendRequests[transactionID].UUID;
76 AgentBlock[0] = new OnlineNotificationPacket.AgentBlockBlock(); 136 msg.fromAgentID = agentID.UUID;
77 AgentBlock[0].AgentID = new LLUUID(friend); 137 msg.fromAgentName = client.FirstName + " " + client.LastName;
78 ONPack.AgentBlock = AgentBlock; 138 msg.fromAgentSession = client.SessionId.UUID;
79 client.OutPacket(ONPack,ThrottleOutPacketType.Task); 139 msg.fromGroup = false;
80 } 140 msg.imSessionID = transactionID.UUID;
141 msg.message = agentID.UUID.ToString();
142 msg.ParentEstateID = 0;
143 msg.timestamp = (uint)Util.UnixTimeSinceEpoch();
144 msg.RegionID = m_scene.RegionInfo.RegionID.UUID;
145 msg.dialog = (byte)39;// Approved friend request
146 msg.Position = new sLLVector3();
147 msg.offline = (byte)0;
148 msg.binaryBucket = new byte[0];
149 m_scene.TriggerGridInstantMessage(msg, InstantMessageReceiver.IMModule);
150 m_scene.StoreAddFriendship(m_pendingFriendRequests[transactionID], agentID, (uint)1);
151 m_pendingFriendRequests.Remove(transactionID);
152
153 // TODO: Inform agent that the friend is online
81 } 154 }
155 }
156 private void OnDenyFriendRequest(IClientAPI client, LLUUID agentID, LLUUID transactionID, List<LLUUID> callingCardFolders)
157 {
158 if (m_pendingFriendRequests.ContainsKey(transactionID))
159 {
160 // Found Pending Friend Request with that Transaction..
161
162 // Compose response to other agent.
163 GridInstantMessage msg = new GridInstantMessage();
164 msg.toAgentID = m_pendingFriendRequests[transactionID].UUID;
165 msg.fromAgentID = agentID.UUID;
166 msg.fromAgentName = client.FirstName + " " + client.LastName;
167 msg.fromAgentSession = client.SessionId.UUID;
168 msg.fromGroup = false;
169 msg.imSessionID = transactionID.UUID;
170 msg.message = agentID.UUID.ToString();
171 msg.ParentEstateID = 0;
172 msg.timestamp = (uint)Util.UnixTimeSinceEpoch();
173 msg.RegionID = m_scene.RegionInfo.RegionID.UUID;
174 msg.dialog = (byte)40;// Deny friend request
175 msg.Position = new sLLVector3();
176 msg.offline = (byte)0;
177 msg.binaryBucket = new byte[0];
178 m_scene.TriggerGridInstantMessage(msg, InstantMessageReceiver.IMModule);
179 m_pendingFriendRequests.Remove(transactionID);
180
181 }
182
183
184 }
185
186 private void OnTerminateFriendship(IClientAPI client, LLUUID agent, LLUUID exfriendID)
187 {
188 m_scene.StoreRemoveFriendship(agent, exfriendID);
189 // TODO: Inform the client that the ExFriend is offline
82 190
83 } 191 }
84 192
193
194 private void OnGridInstantMessage(GridInstantMessage msg)
195 {
196 // Trigger the above event handler
197 OnInstantMessage(new LLUUID(msg.fromAgentID), new LLUUID(msg.fromAgentSession),
198 new LLUUID(msg.toAgentID), new LLUUID(msg.imSessionID), msg.timestamp, msg.fromAgentName,
199 msg.message, msg.dialog, msg.fromGroup, msg.offline, msg.ParentEstateID,
200 new LLVector3(msg.Position.x, msg.Position.y, msg.Position.z), new LLUUID(msg.RegionID),
201 msg.binaryBucket);
202
203 }
204
205
206 public void PostInitialise()
207 {
208 }
209
210
211
85 public void Close() 212 public void Close()
86 { 213 {
87 } 214 }
@@ -93,7 +220,7 @@ namespace OpenSim.Region.Environment.Modules
93 220
94 public bool IsSharedModule 221 public bool IsSharedModule
95 { 222 {
96 get { return true; } 223 get { return false; }
97 } 224 }
98 } 225 }
99} \ No newline at end of file 226} \ No newline at end of file
diff --git a/OpenSim/Region/Environment/Modules/InstantMessageModule.cs b/OpenSim/Region/Environment/Modules/InstantMessageModule.cs
index 1e1d236..0967b70 100644
--- a/OpenSim/Region/Environment/Modules/InstantMessageModule.cs
+++ b/OpenSim/Region/Environment/Modules/InstantMessageModule.cs
@@ -52,6 +52,7 @@ namespace OpenSim.Region.Environment.Modules
52 { 52 {
53 m_scenes.Add(scene); 53 m_scenes.Add(scene);
54 scene.EventManager.OnNewClient += OnNewClient; 54 scene.EventManager.OnNewClient += OnNewClient;
55 scene.EventManager.OnGridInstantMessageToIMModule += OnGridInstantMessage;
55 } 56 }
56 } 57 }
57 58
@@ -67,19 +68,29 @@ namespace OpenSim.Region.Environment.Modules
67 uint ParentEstateID, LLVector3 Position, LLUUID RegionID, 68 uint ParentEstateID, LLVector3 Position, LLUUID RegionID,
68 byte[] binaryBucket) 69 byte[] binaryBucket)
69 { 70 {
70 foreach (Scene scene in m_scenes) 71
72 bool FriendDialog = ((dialog == (byte)38) || (dialog == (byte)39) || (dialog == (byte)40));
73
74 // IM dialogs need to be pre-processed and have their sessionID filled by the server
75 // so the sim can match the transaction on the return packet.
76
77 // Don't send a Friend Dialog IM with a LLUUID.Zero session.
78 if (!(FriendDialog && imSessionID == LLUUID.Zero))
71 { 79 {
72 if (scene.Entities.ContainsKey(toAgentID) && scene.Entities[toAgentID] is ScenePresence) 80 foreach (Scene scene in m_scenes)
73 { 81 {
74 // Local message 82 if (scene.Entities.ContainsKey(toAgentID) && scene.Entities[toAgentID] is ScenePresence)
75 ScenePresence user = (ScenePresence) scene.Entities[toAgentID];
76 if (!user.IsChildAgent)
77 { 83 {
78 user.ControllingClient.SendInstantMessage(fromAgentID, fromAgentSession, message, 84 // Local message
79 toAgentID, imSessionID, fromAgentName, dialog, 85 ScenePresence user = (ScenePresence)scene.Entities[toAgentID];
80 timestamp); 86 if (!user.IsChildAgent)
81 // Message sent 87 {
82 return; 88 user.ControllingClient.SendInstantMessage(fromAgentID, fromAgentSession, message,
89 toAgentID, imSessionID, fromAgentName, dialog,
90 timestamp);
91 // Message sent
92 return;
93 }
83 } 94 }
84 } 95 }
85 } 96 }
@@ -87,6 +98,20 @@ namespace OpenSim.Region.Environment.Modules
87 // Still here, try send via Grid 98 // Still here, try send via Grid
88 // TODO 99 // TODO
89 } 100 }
101
102 // Trusty OSG1 called method. This method also gets called from the FriendsModule
103 // Turns out the sim has to send an instant message to the user to get it to show an accepted friend.
104
105 private void OnGridInstantMessage(GridInstantMessage msg)
106 {
107 // Trigger the above event handler
108 OnInstantMessage(new LLUUID(msg.fromAgentID), new LLUUID(msg.fromAgentSession),
109 new LLUUID(msg.toAgentID), new LLUUID(msg.imSessionID), msg.timestamp, msg.fromAgentName,
110 msg.message, msg.dialog, msg.fromGroup, msg.offline, msg.ParentEstateID,
111 new LLVector3(msg.Position.x,msg.Position.y,msg.Position.z), new LLUUID(msg.RegionID),
112 msg.binaryBucket);
113
114 }
90 115
91 public void PostInitialise() 116 public void PostInitialise()
92 { 117 {
diff --git a/OpenSim/Region/Environment/Scenes/Scene.cs b/OpenSim/Region/Environment/Scenes/Scene.cs
index a0f19bd..ba99640 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.cs
@@ -1625,6 +1625,8 @@ namespace OpenSim.Region.Environment.Scenes
1625 } 1625 }
1626 } 1626 }
1627 1627
1628
1629
1628 #endregion 1630 #endregion
1629 1631
1630 #region Other Methods 1632 #region Other Methods
@@ -1699,6 +1701,45 @@ namespace OpenSim.Region.Environment.Scenes
1699 } 1701 }
1700 } 1702 }
1701 1703
1704 /// <summary>
1705 /// This method is a way for the Friends Module to create an instant
1706 /// message to the avatar and for Instant Messages that travel across
1707 /// gridcomms to make it to the Instant Message Module.
1708 ///
1709 /// Friendship establishment and groups are unfortunately tied with instant messaging and
1710 /// there's no way to separate them completely.
1711 /// </summary>
1712 /// <param name="message">object containing the instant message data</param>
1713 /// <returns>void</returns>
1714 public void TriggerGridInstantMessage(GridInstantMessage message,InstantMessageReceiver options)
1715 {
1716 m_eventManager.TriggerGridInstantMessage(message,options);
1717 }
1718
1719
1720 public virtual void StoreAddFriendship(LLUUID ownerID, LLUUID friendID, uint perms)
1721 {
1722 // TODO: m_sceneGridService.DoStuff;
1723 CommsManager.AddNewUserFriend(ownerID, friendID, perms);
1724 }
1725
1726 public virtual void StoreUpdateFriendship(LLUUID ownerID, LLUUID friendID, uint perms)
1727 {
1728 // TODO: m_sceneGridService.DoStuff;
1729 CommsManager.UpdateUserFriendPerms(ownerID, friendID, perms);
1730 }
1731
1732 public virtual void StoreRemoveFriendship(LLUUID ownerID, LLUUID ExfriendID)
1733 {
1734 // TODO: m_sceneGridService.DoStuff;
1735 CommsManager.RemoveUserFriend(ownerID, ExfriendID);
1736 }
1737 public virtual List<FriendListItem> StoreGetFriendsForUser(LLUUID ownerID)
1738 {
1739 // TODO: m_sceneGridService.DoStuff;
1740 return CommsManager.GetUserFriendList(ownerID);
1741 }
1742
1702 #endregion 1743 #endregion
1703 1744
1704 #region Console Commands 1745 #region Console Commands
diff --git a/OpenSim/Region/Environment/Scenes/SceneEvents.cs b/OpenSim/Region/Environment/Scenes/SceneEvents.cs
index a6a8fb6..5bf23ac 100644
--- a/OpenSim/Region/Environment/Scenes/SceneEvents.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneEvents.cs
@@ -27,12 +27,14 @@
27*/ 27*/
28 28
29using libsecondlife; 29using libsecondlife;
30using System;
30using OpenSim.Framework; 31using OpenSim.Framework;
31using OpenSim.Region.Environment.Interfaces; 32using OpenSim.Region.Environment.Interfaces;
32using OpenSim.Region.Environment.LandManagement; 33using OpenSim.Region.Environment.LandManagement;
33 34
34namespace OpenSim.Region.Environment.Scenes 35namespace OpenSim.Region.Environment.Scenes
35{ 36{
37
36 /// <summary> 38 /// <summary>
37 /// A class for triggering remote scene events. 39 /// A class for triggering remote scene events.
38 /// </summary> 40 /// </summary>
@@ -115,6 +117,16 @@ namespace OpenSim.Region.Environment.Scenes
115 public event AvatarEnteringNewParcel OnAvatarEnteringNewParcel; 117 public event AvatarEnteringNewParcel OnAvatarEnteringNewParcel;
116 118
117 119
120 public delegate void NewGridInstantMessage(GridInstantMessage message);
121
122 public event NewGridInstantMessage OnGridInstantMessageToIMModule;
123
124 public event NewGridInstantMessage OnGridInstantMessageToFriendsModule;
125
126 public event NewGridInstantMessage OnGridInstantMessageToGroupsModule;
127
128
129
118 public void TriggerOnClientMovement(ScenePresence avatar) 130 public void TriggerOnClientMovement(ScenePresence avatar)
119 { 131 {
120 if (OnClientMovement != null) 132 if (OnClientMovement != null)
@@ -265,5 +277,29 @@ namespace OpenSim.Region.Environment.Scenes
265 OnAvatarEnteringNewParcel(avatar, localLandID, regionID); 277 OnAvatarEnteringNewParcel(avatar, localLandID, regionID);
266 } 278 }
267 } 279 }
280
281 ///<summary>Used to pass instnat messages around between the Scene, the Friends Module and the Instant Messsage Module</summary>
282 ///<param name="message">Object containing the Instant Message Data</param>
283 ///<param name="whichModule">A bit vector containing the modules to send the message to</param>
284 public void TriggerGridInstantMessage(GridInstantMessage message, InstantMessageReceiver whichModule)
285 {
286 if ((whichModule & InstantMessageReceiver.IMModule) != 0)
287 {
288
289 if (OnGridInstantMessageToIMModule != null)
290 {
291 OnGridInstantMessageToIMModule(message);
292 }
293 }
294 if ((whichModule & InstantMessageReceiver.FriendsModule) != 0)
295 {
296 if (OnGridInstantMessageToFriendsModule != null)
297 {
298 OnGridInstantMessageToFriendsModule(message);
299 }
300
301 }
302 }
303
268 } 304 }
269} \ No newline at end of file 305} \ No newline at end of file