ChatModule.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections.Generic;
  29. using System.Reflection;
  30. using log4net;
  31. using Nini.Config;
  32. using OpenMetaverse;
  33. using OpenSim.Framework;
  34. using OpenSim.Region.Framework.Interfaces;
  35. using OpenSim.Region.Framework.Scenes;
  36. namespace OpenSim.Region.CoreModules.Avatar.Chat
  37. {
  38. public class ChatModule : ISharedRegionModule
  39. {
  40. private static readonly ILog m_log =
  41. LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  42. private const int DEBUG_CHANNEL = 2147483647;
  43. private bool m_enabled = true;
  44. private int m_saydistance = 30;
  45. private int m_shoutdistance = 100;
  46. private int m_whisperdistance = 10;
  47. private List<Scene> m_scenes = new List<Scene>();
  48. internal object m_syncy = new object();
  49. internal IConfig m_config;
  50. #region ISharedRegionModule Members
  51. public virtual void Initialise(IConfigSource config)
  52. {
  53. m_config = config.Configs["Chat"];
  54. if (null == m_config)
  55. {
  56. m_log.Info("[CHAT]: no config found, plugin disabled");
  57. m_enabled = false;
  58. return;
  59. }
  60. if (!m_config.GetBoolean("enabled", true))
  61. {
  62. m_log.Info("[CHAT]: plugin disabled by configuration");
  63. m_enabled = false;
  64. return;
  65. }
  66. m_whisperdistance = config.Configs["Chat"].GetInt("whisper_distance", m_whisperdistance);
  67. m_saydistance = config.Configs["Chat"].GetInt("say_distance", m_saydistance);
  68. m_shoutdistance = config.Configs["Chat"].GetInt("shout_distance", m_shoutdistance);
  69. }
  70. public virtual void AddRegion(Scene scene)
  71. {
  72. if (!m_enabled) return;
  73. lock (m_syncy)
  74. {
  75. if (!m_scenes.Contains(scene))
  76. {
  77. m_scenes.Add(scene);
  78. scene.EventManager.OnNewClient += OnNewClient;
  79. scene.EventManager.OnChatFromWorld += OnChatFromWorld;
  80. scene.EventManager.OnChatBroadcast += OnChatBroadcast;
  81. }
  82. }
  83. m_log.InfoFormat("[CHAT]: Initialized for {0} w:{1} s:{2} S:{3}", scene.RegionInfo.RegionName,
  84. m_whisperdistance, m_saydistance, m_shoutdistance);
  85. }
  86. public virtual void RegionLoaded(Scene scene)
  87. {
  88. }
  89. public virtual void RemoveRegion(Scene scene)
  90. {
  91. if (!m_enabled) return;
  92. lock (m_syncy)
  93. {
  94. if (m_scenes.Contains(scene))
  95. {
  96. scene.EventManager.OnNewClient -= OnNewClient;
  97. scene.EventManager.OnChatFromWorld -= OnChatFromWorld;
  98. scene.EventManager.OnChatBroadcast -= OnChatBroadcast;
  99. m_scenes.Remove(scene);
  100. }
  101. }
  102. }
  103. public virtual void Close()
  104. {
  105. }
  106. public virtual void PostInitialise()
  107. {
  108. }
  109. public Type ReplaceableInterface
  110. {
  111. get { return null; }
  112. }
  113. public virtual string Name
  114. {
  115. get { return "ChatModule"; }
  116. }
  117. #endregion
  118. public virtual void OnNewClient(IClientAPI client)
  119. {
  120. client.OnChatFromClient += OnChatFromClient;
  121. }
  122. protected OSChatMessage FixPositionOfChatMessage(OSChatMessage c)
  123. {
  124. ScenePresence avatar;
  125. Scene scene = (Scene)c.Scene;
  126. if ((avatar = scene.GetScenePresence(c.Sender.AgentId)) != null)
  127. c.Position = avatar.AbsolutePosition;
  128. return c;
  129. }
  130. public virtual void OnChatFromClient(Object sender, OSChatMessage c)
  131. {
  132. c = FixPositionOfChatMessage(c);
  133. // redistribute to interested subscribers
  134. Scene scene = (Scene)c.Scene;
  135. scene.EventManager.TriggerOnChatFromClient(sender, c);
  136. // early return if not on public or debug channel
  137. if (c.Channel != 0 && c.Channel != DEBUG_CHANNEL) return;
  138. // sanity check:
  139. if (c.Sender == null)
  140. {
  141. m_log.ErrorFormat("[CHAT] OnChatFromClient from {0} has empty Sender field!", sender);
  142. return;
  143. }
  144. DeliverChatToAvatars(ChatSourceType.Agent, c);
  145. }
  146. public virtual void OnChatFromWorld(Object sender, OSChatMessage c)
  147. {
  148. // early return if not on public or debug channel
  149. if (c.Channel != 0 && c.Channel != DEBUG_CHANNEL) return;
  150. DeliverChatToAvatars(ChatSourceType.Object, c);
  151. }
  152. protected virtual void DeliverChatToAvatars(ChatSourceType sourceType, OSChatMessage c)
  153. {
  154. string fromName = c.From;
  155. UUID fromID = UUID.Zero;
  156. string message = c.Message;
  157. IScene scene = c.Scene;
  158. Vector3 fromPos = c.Position;
  159. Vector3 regionPos = new Vector3(scene.RegionInfo.RegionLocX * Constants.RegionSize,
  160. scene.RegionInfo.RegionLocY * Constants.RegionSize, 0);
  161. if (c.Channel == DEBUG_CHANNEL) c.Type = ChatTypeEnum.DebugChannel;
  162. switch (sourceType)
  163. {
  164. case ChatSourceType.Agent:
  165. if (!(scene is Scene))
  166. {
  167. m_log.WarnFormat("[CHAT]: scene {0} is not a Scene object, cannot obtain scene presence for {1}",
  168. scene.RegionInfo.RegionName, c.Sender.AgentId);
  169. return;
  170. }
  171. ScenePresence avatar = (scene as Scene).GetScenePresence(c.Sender.AgentId);
  172. fromPos = avatar.AbsolutePosition;
  173. fromName = avatar.Name;
  174. fromID = c.Sender.AgentId;
  175. break;
  176. case ChatSourceType.Object:
  177. fromID = c.SenderUUID;
  178. break;
  179. }
  180. // TODO: iterate over message
  181. if (message.Length >= 1000) // libomv limit
  182. message = message.Substring(0, 1000);
  183. // m_log.DebugFormat("[CHAT]: DCTA: fromID {0} fromName {1}, cType {2}, sType {3}", fromID, fromName, c.Type, sourceType);
  184. foreach (Scene s in m_scenes)
  185. {
  186. s.ForEachScenePresence(
  187. delegate(ScenePresence presence)
  188. {
  189. TrySendChatMessage(presence, fromPos, regionPos, fromID, fromName, c.Type, message, sourceType);
  190. }
  191. );
  192. }
  193. }
  194. static private Vector3 CenterOfRegion = new Vector3(128, 128, 30);
  195. public virtual void OnChatBroadcast(Object sender, OSChatMessage c)
  196. {
  197. // unless the chat to be broadcast is of type Region, we
  198. // drop it if its channel is neither 0 nor DEBUG_CHANNEL
  199. if (c.Channel != 0 && c.Channel != DEBUG_CHANNEL && c.Type != ChatTypeEnum.Region) return;
  200. ChatTypeEnum cType = c.Type;
  201. if (c.Channel == DEBUG_CHANNEL)
  202. cType = ChatTypeEnum.DebugChannel;
  203. if (cType == ChatTypeEnum.Region)
  204. cType = ChatTypeEnum.Say;
  205. if (c.Message.Length > 1100)
  206. c.Message = c.Message.Substring(0, 1000);
  207. // broadcast chat works by redistributing every incoming chat
  208. // message to each avatar in the scene.
  209. string fromName = c.From;
  210. UUID fromID = UUID.Zero;
  211. ChatSourceType sourceType = ChatSourceType.Object;
  212. if (null != c.Sender)
  213. {
  214. ScenePresence avatar = (c.Scene as Scene).GetScenePresence(c.Sender.AgentId);
  215. fromID = c.Sender.AgentId;
  216. fromName = avatar.Name;
  217. sourceType = ChatSourceType.Agent;
  218. }
  219. else if (c.SenderUUID != UUID.Zero)
  220. {
  221. fromID = c.SenderUUID;
  222. }
  223. // m_log.DebugFormat("[CHAT] Broadcast: fromID {0} fromName {1}, cType {2}, sType {3}", fromID, fromName, cType, sourceType);
  224. ((Scene)c.Scene).ForEachScenePresence(
  225. delegate(ScenePresence presence)
  226. {
  227. // ignore chat from child agents
  228. if (presence.IsChildAgent) return;
  229. IClientAPI client = presence.ControllingClient;
  230. // don't forward SayOwner chat from objects to
  231. // non-owner agents
  232. if ((c.Type == ChatTypeEnum.Owner) &&
  233. (null != c.SenderObject) &&
  234. (((SceneObjectPart)c.SenderObject).OwnerID != client.AgentId))
  235. return;
  236. client.SendChatMessage(c.Message, (byte)cType, CenterOfRegion, fromName, fromID,
  237. (byte)sourceType, (byte)ChatAudibleLevel.Fully);
  238. });
  239. }
  240. protected virtual void TrySendChatMessage(ScenePresence presence, Vector3 fromPos, Vector3 regionPos,
  241. UUID fromAgentID, string fromName, ChatTypeEnum type,
  242. string message, ChatSourceType src)
  243. {
  244. // don't send stuff to child agents
  245. if (presence.IsChildAgent) return;
  246. Vector3 fromRegionPos = fromPos + regionPos;
  247. Vector3 toRegionPos = presence.AbsolutePosition +
  248. new Vector3(presence.Scene.RegionInfo.RegionLocX * Constants.RegionSize,
  249. presence.Scene.RegionInfo.RegionLocY * Constants.RegionSize, 0);
  250. int dis = (int)Util.GetDistanceTo(toRegionPos, fromRegionPos);
  251. if (type == ChatTypeEnum.Whisper && dis > m_whisperdistance ||
  252. type == ChatTypeEnum.Say && dis > m_saydistance ||
  253. type == ChatTypeEnum.Shout && dis > m_shoutdistance)
  254. {
  255. return;
  256. }
  257. // TODO: should change so the message is sent through the avatar rather than direct to the ClientView
  258. presence.ControllingClient.SendChatMessage(message, (byte) type, fromPos, fromName,
  259. fromAgentID,(byte)src,(byte)ChatAudibleLevel.Fully);
  260. }
  261. }
  262. }