aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/OptionalModules/Avatar
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/OptionalModules/Avatar')
-rw-r--r--OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDialplan.cs104
-rw-r--r--OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDirectory.cs348
-rw-r--r--OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchVoiceModule.cs276
3 files changed, 113 insertions, 615 deletions
diff --git a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDialplan.cs b/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDialplan.cs
deleted file mode 100644
index 46ad30f..0000000
--- a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDialplan.cs
+++ /dev/null
@@ -1,104 +0,0 @@
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
28using log4net;
29using System;
30using System.Reflection;
31using System.Text;
32using System.Collections;
33
34namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
35{
36 public class FreeSwitchDialplan
37 {
38 private static readonly ILog m_log =
39 LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
40
41
42 public Hashtable HandleDialplanRequest(string Context, string Realm, Hashtable request)
43 {
44 m_log.DebugFormat("[FreeSwitchVoice] HandleDialplanRequest called with {0}",request.ToString());
45
46 Hashtable response = new Hashtable();
47
48 foreach (DictionaryEntry item in request)
49 {
50 m_log.InfoFormat("[FreeSwitchDirectory] requestBody item {0} {1}",item.Key, item.Value);
51 }
52
53 string requestcontext = (string) request["Hunt-Context"];
54 response["content_type"] = "text/xml";
55 response["keepalive"] = false;
56 response["int_response_code"] = 200;
57 if (Context != String.Empty && Context != requestcontext)
58 {
59 m_log.Debug("[FreeSwitchDirectory] returning empty as it's for another context");
60 response["str_response_string"] = "";
61 } else {
62 response["str_response_string"] = String.Format(@"<?xml version=""1.0"" encoding=""utf-8""?>
63 <document type=""freeswitch/xml"">
64 <section name=""dialplan"">
65 <context name=""{0}"">" +
66
67/* <!-- dial via SIP uri -->
68 <extension name=""sip_uri"">
69 <condition field=""destination_number"" expression=""^sip:(.*)$"">
70 <action application=""bridge"" data=""sofia/${use_profile}/$1""/>
71 <!--<action application=""bridge"" data=""$1""/>-->
72 </condition>
73 </extension>*/
74
75 @"<extension name=""opensim_conferences"">
76 <condition field=""destination_number"" expression=""^confctl-(.*)$"">
77 <action application=""answer""/>
78 <action application=""conference"" data=""$1-{1}@{0}""/>
79 </condition>
80 </extension>
81
82 <extension name=""opensim_conf"">
83 <condition field=""destination_number"" expression=""^conf-(.*)$"">
84 <action application=""answer""/>
85 <action application=""conference"" data=""$1-{1}@{0}""/>
86 </condition>
87 </extension>
88
89 <extension name=""avatar"">
90 <condition field=""destination_number"" expression=""^(x.*)$"">
91 <action application=""bridge"" data=""user/$1""/>
92 </condition>
93 </extension>
94
95 </context>
96 </section>
97 </document>", Context, Realm);
98 }
99
100 return response;
101 }
102 }
103
104}
diff --git a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDirectory.cs b/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDirectory.cs
deleted file mode 100644
index 17cdf74..0000000
--- a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchDirectory.cs
+++ /dev/null
@@ -1,348 +0,0 @@
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
28using log4net;
29using System;
30using System.Reflection;
31using System.Text;
32using System.Collections;
33
34namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
35{
36 public class FreeSwitchDirectory
37 {
38 private static readonly ILog m_log =
39 LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
40
41 public Hashtable HandleDirectoryRequest(string Context, string Realm, Hashtable request)
42 {
43 Hashtable response = new Hashtable();
44 string domain = (string) request["domain"];
45 if (domain != Realm) {
46 response["content_type"] = "text/xml";
47 response["keepalive"] = false;
48 response["int_response_code"] = 200;
49 response["str_response_string"] = "";
50 } else {
51 m_log.DebugFormat("[FreeSwitchDirectory] HandleDirectoryRequest called with {0}",request.ToString());
52
53 // information in the request we might be interested in
54
55 // Request 1 sip_auth for users account
56
57 //Event-Calling-Function=sofia_reg_parse_auth
58 //Event-Calling-Line-Number=1494
59 //action=sip_auth
60 //sip_user_agent=Vivox-SDK-2.1.3010.6151-Mac%20(Feb-11-2009/16%3A42%3A41)
61 //sip_auth_username=xhZuXKmRpECyr2AARJYyGgg%3D%3D (==)
62 //sip_auth_realm=9.20.151.43
63 //sip_contact_user=xhZuXKmRpECyr2AARJYyGgg%3D%3D (==)
64 //sip_contact_host=192.168.0.3 // this shouldnt really be a local IP, investigate STUN servers
65 //sip_to_user=xhZuXKmRpECyr2AARJYyGgg%3D%3D
66 //sip_to_host=9.20.151.43
67 //sip_auth_method=REGISTER
68 //user=xhZuXKmRpECyr2AARJYyGgg%3D%3D
69 //domain=9.20.151.43
70 //ip=9.167.220.137 // this is the correct IP rather than sip_contact_host above when through a vpn or NAT setup
71
72 foreach (DictionaryEntry item in request)
73 {
74 m_log.InfoFormat("[FreeSwitchDirectory] requestBody item {0} {1}", item.Key, item.Value);
75 }
76
77 string eventCallingFunction = (string) request["Event-Calling-Function"];
78 if (eventCallingFunction == null)
79 {
80 eventCallingFunction = "sofia_reg_parse_auth";
81 }
82
83 if (eventCallingFunction.Length == 0)
84 {
85 eventCallingFunction = "sofia_reg_parse_auth";
86 }
87
88 if (eventCallingFunction == "sofia_reg_parse_auth")
89 {
90 string sipAuthMethod = (string)request["sip_auth_method"];
91
92 if (sipAuthMethod == "REGISTER")
93 {
94 response = HandleRegister(Context, Realm, request);
95 }
96 else if (sipAuthMethod == "INVITE")
97 {
98 response = HandleInvite(Context, Realm, request);
99 }
100 else
101 {
102 m_log.ErrorFormat("[FreeSwitchVoice] HandleDirectoryRequest unknown sip_auth_method {0}",sipAuthMethod);
103 response["int_response_code"] = 404;
104 response["content_type"] = "text/xml";
105 response["str_response_string"] = "";
106 }
107 }
108 else if (eventCallingFunction == "switch_xml_locate_user")
109 {
110 response = HandleLocateUser(Realm, request);
111 }
112 else if (eventCallingFunction == "user_data_function") // gets called when an avatar to avatar call is made
113 {
114 response = HandleLocateUser(Realm, request);
115 }
116 else if (eventCallingFunction == "user_outgoing_channel")
117 {
118 response = HandleRegister(Context, Realm, request);
119 }
120 else if (eventCallingFunction == "config_sofia") // happens once on freeswitch startup
121 {
122 response = HandleConfigSofia(Context, Realm, request);
123 }
124 else if (eventCallingFunction == "switch_load_network_lists")
125 {
126 //response = HandleLoadNetworkLists(request);
127 response["int_response_code"] = 404;
128 response["keepalive"] = false;
129 response["content_type"] = "text/xml";
130 response["str_response_string"] = "";
131 }
132 else
133 {
134 m_log.ErrorFormat("[FreeSwitchVoice] HandleDirectoryRequest unknown Event-Calling-Function {0}",eventCallingFunction);
135 response["int_response_code"] = 404;
136 response["keepalive"] = false;
137 response["content_type"] = "text/xml";
138 response["str_response_string"] = "";
139 }
140 }
141 return response;
142 }
143
144 private Hashtable HandleRegister(string Context, string Realm, Hashtable request)
145 {
146 m_log.Info("[FreeSwitchDirectory] HandleRegister called");
147
148 // TODO the password we return needs to match that sent in the request, this is hard coded for now
149 string password = "1234";
150 string domain = (string) request["domain"];
151 string user = (string) request["user"];
152
153 Hashtable response = new Hashtable();
154 response["content_type"] = "text/xml";
155 response["keepalive"] = false;
156 response["int_response_code"] = 200;
157
158 response["str_response_string"] = String.Format(
159 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
160 "<document type=\"freeswitch/xml\">\r\n" +
161 "<section name=\"directory\" description=\"User Directory\">\r\n" +
162 "<domain name=\"{0}\">\r\n" +
163 "<user id=\"{1}\">\r\n" +
164 "<params>\r\n" +
165 "<param name=\"password\" value=\"{2}\" />\r\n" +
166 "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
167 "</params>\r\n" +
168 "<variables>\r\n" +
169 "<variable name=\"user_context\" value=\"{3}\" />\r\n" +
170 "<variable name=\"presence_id\" value=\"{1}@{0}\"/>"+
171 "</variables>\r\n" +
172 "</user>\r\n" +
173 "</domain>\r\n" +
174 "</section>\r\n" +
175 "</document>\r\n",
176 domain , user, password, Context);
177
178 return response;
179 }
180
181 private Hashtable HandleInvite(string Context, string Realm, Hashtable request)
182 {
183 m_log.Info("[FreeSwitchDirectory] HandleInvite called");
184
185 // TODO the password we return needs to match that sent in the request, this is hard coded for now
186 string password = "1234";
187 string domain = (string) request["domain"];
188 string user = (string) request["user"];
189 string sipRequestUser = (string) request["sip_request_user"];
190
191 Hashtable response = new Hashtable();
192 response["content_type"] = "text/xml";
193 response["keepalive"] = false;
194 response["int_response_code"] = 200;
195 response["str_response_string"] = String.Format(
196 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
197 "<document type=\"freeswitch/xml\">\r\n" +
198 "<section name=\"directory\" description=\"User Directory\">\r\n" +
199 "<domain name=\"{0}\">\r\n" +
200 "<user id=\"{1}\">\r\n" +
201 "<params>\r\n" +
202 "<param name=\"password\" value=\"{2}\" />\r\n" +
203 "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${1}@${{dialed_domain}}}}${{sofia_contact(${1}@${{dialed_domain}})}}\"/>\r\n" +
204 "</params>\r\n" +
205 "<variables>\r\n" +
206 "<variable name=\"user_context\" value=\"{4}\" />\r\n" +
207 "<variable name=\"presence_id\" value=\"{1}@$${{domain}}\"/>"+
208 "</variables>\r\n" +
209 "</user>\r\n" +
210 "<user id=\"{3}\">\r\n" +
211 "<params>\r\n" +
212 "<param name=\"password\" value=\"{2}\" />\r\n" +
213 "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${3}@${{dialed_domain}}}}${{sofia_contact(${3}@${{dialed_domain}})}}\"/>\r\n" +
214 "</params>\r\n" +
215 "<variables>\r\n" +
216 "<variable name=\"user_context\" value=\"{4}\" />\r\n" +
217 "<variable name=\"presence_id\" value=\"{3}@$${{domain}}\"/>"+
218 "</variables>\r\n" +
219 "</user>\r\n" +
220 "</domain>\r\n" +
221 "</section>\r\n" +
222 "</document>\r\n",
223 domain , user, password,sipRequestUser, Context);
224
225 return response;
226 }
227
228 private Hashtable HandleLocateUser(String Realm, Hashtable request)
229 {
230 m_log.Info("[FreeSwitchDirectory] HandleLocateUser called");
231
232 // TODO the password we return needs to match that sent in the request, this is hard coded for now
233 string domain = (string) request["domain"];
234 string user = (string) request["user"];
235
236 Hashtable response = new Hashtable();
237 response["content_type"] = "text/xml";
238 response["keepalive"] = false;
239 response["int_response_code"] = 200;
240 response["str_response_string"] = String.Format(
241 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
242 "<document type=\"freeswitch/xml\">\r\n" +
243 "<section name=\"directory\" description=\"User Directory\">\r\n" +
244 "<domain name=\"{0}\">\r\n" +
245 "<params>\r\n" +
246 "<param name=\"dial-string\" value=\"{{sip_contact_user=${{dialed_user}}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
247 "</params>\r\n" +
248 "<user id=\"{1}\">\r\n" +
249 "<variables>\r\n"+
250 "<variable name=\"default_gateway\" value=\"$${{default_provider}}\"/>\r\n"+
251 "<variable name=\"presence_id\" value=\"{1}@$${{domain}}\"/>"+
252 "</variables>\r\n"+
253 "</user>\r\n" +
254 "</domain>\r\n" +
255 "</section>\r\n" +
256 "</document>\r\n",
257 domain , user);
258
259 return response;
260 }
261
262 private Hashtable HandleConfigSofia(string Context, string Realm, Hashtable request)
263 {
264 m_log.Info("[FreeSwitchDirectory] HandleConfigSofia called");
265
266 // TODO the password we return needs to match that sent in the request, this is hard coded for now
267 string domain = (string) request["domain"];
268
269 Hashtable response = new Hashtable();
270 response["content_type"] = "text/xml";
271 response["keepalive"] = false;
272 response["int_response_code"] = 200;
273 response["str_response_string"] = String.Format(
274 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
275 "<document type=\"freeswitch/xml\">\r\n" +
276 "<section name=\"directory\" description=\"User Directory\">\r\n" +
277 "<domain name=\"{0}\">\r\n" +
278 "<params>\r\n" +
279 "<param name=\"dial-string\" value=\"{{sip_contact_user=${{dialed_user}}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
280 "</params>\r\n" +
281 "<groups name=\"default\">\r\n"+
282 "<users>\r\n"+
283 "<user id=\"$${{default_provider}}\">\r\n"+
284 "<gateways>\r\n"+
285 "<gateway name=\"$${{default_provider}}\">\r\n"+
286 "<param name=\"username\" value=\"$${{default_provider_username}}\"/>\r\n"+
287 "<param name=\"password\" value=\"$${{default_provider_password}}\"/>\r\n"+
288 "<param name=\"from-user\" value=\"$${{default_provider_username}}\"/>\r\n"+
289 "<param name=\"from-domain\" value=\"$${{default_provider_from_domain}}\"/>\r\n"+
290 "<param name=\"expire-seconds\" value=\"600\"/>\r\n"+
291 "<param name=\"register\" value=\"$${{default_provider_register}}\"/>\r\n"+
292 "<param name=\"retry-seconds\" value=\"30\"/>\r\n"+
293 "<param name=\"extension\" value=\"$${{default_provider_contact}}\"/>\r\n"+
294 "<param name=\"contact-params\" value=\"domain_name=$${{domain}}\"/>\r\n"+
295 "<param name=\"context\" value=\"{1}\"/>\r\n"+
296 "</gateway>\r\n"+
297 "</gateways>\r\n"+
298 "<params>\r\n"+
299 "<param name=\"password\" value=\"$${{default_provider_password}}\"/>\r\n"+
300 "</params>\r\n"+
301 "</user>\r\n"+
302 "</users>"+
303 "</groups>\r\n" +
304 "<variables>\r\n"+
305 "<variable name=\"default_gateway\" value=\"$${{default_provider}}\"/>\r\n"+
306 "</variables>\r\n"+
307 "</domain>\r\n" +
308 "</section>\r\n" +
309 "</document>\r\n",
310 domain, Context);
311
312 return response;
313 }
314
315
316// private Hashtable HandleLoadNetworkLists(Hashtable request)
317// {
318// m_log.Info("[FreeSwitchDirectory] HandleLoadNetworkLists called");
319//
320// // TODO the password we return needs to match that sent in the request, this is hard coded for now
321// string domain = (string) request["domain"];
322//
323// Hashtable response = new Hashtable();
324// response["content_type"] = "text/xml";
325// response["keepalive"] = false;
326// response["int_response_code"] = 200;
327// response["str_response_string"] = String.Format(
328// "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
329// "<document type=\"freeswitch/xml\">\r\n" +
330// "<section name=\"directory\" description=\"User Directory\">\r\n" +
331// "<domain name=\"{0}\">\r\n" +
332// "<params>\r\n" +
333// "<param name=\"dial-string\" value=\"{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
334// "</params>\r\n" +
335// "<groups name=\"default\"><users/></groups>\r\n" +
336// "<variables>\r\n"+
337// "<variable name=\"default_gateway\" value=\"$${{default_provider}}\"/>\r\n"+
338// "</variables>\r\n"+
339// "</domain>\r\n" +
340// "</section>\r\n" +
341// "</document>\r\n",
342// domain);
343//
344//
345// return response;
346// }
347 }
348}
diff --git a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchVoiceModule.cs b/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchVoiceModule.cs
index 242bc3f..294d4f0 100644
--- a/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchVoiceModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/Voice/FreeSwitchVoice/FreeSwitchVoiceModule.cs
@@ -37,10 +37,12 @@ using System.Collections;
37using System.Collections.Generic; 37using System.Collections.Generic;
38using System.Reflection; 38using System.Reflection;
39using OpenMetaverse; 39using OpenMetaverse;
40using OpenMetaverse.StructuredData;
40using log4net; 41using log4net;
41using Nini.Config; 42using Nini.Config;
42using Nwc.XmlRpc; 43using Nwc.XmlRpc;
43using OpenSim.Framework; 44using OpenSim.Framework;
45using Mono.Addins;
44 46
45using OpenSim.Framework.Capabilities; 47using OpenSim.Framework.Capabilities;
46using OpenSim.Framework.Servers; 48using OpenSim.Framework.Servers;
@@ -49,28 +51,27 @@ using OpenSim.Region.Framework.Interfaces;
49using OpenSim.Region.Framework.Scenes; 51using OpenSim.Region.Framework.Scenes;
50using Caps = OpenSim.Framework.Capabilities.Caps; 52using Caps = OpenSim.Framework.Capabilities.Caps;
51using System.Text.RegularExpressions; 53using System.Text.RegularExpressions;
54using OpenSim.Server.Base;
55using OpenSim.Services.Interfaces;
56using OSDMap = OpenMetaverse.StructuredData.OSDMap;
52 57
53namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice 58namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
54{ 59{
55 public class FreeSwitchVoiceModule : IRegionModule, IVoiceModule 60 [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "FreeSwitchVoiceModule")]
61 public class FreeSwitchVoiceModule : INonSharedRegionModule, IVoiceModule
56 { 62 {
57 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); 63 private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
58 64
59 private bool UseProxy = false;
60
61 // Capability string prefixes 65 // Capability string prefixes
62 private static readonly string m_parcelVoiceInfoRequestPath = "0007/"; 66 private static readonly string m_parcelVoiceInfoRequestPath = "0007/";
63 private static readonly string m_provisionVoiceAccountRequestPath = "0008/"; 67 private static readonly string m_provisionVoiceAccountRequestPath = "0008/";
64 private static readonly string m_chatSessionRequestPath = "0009/"; 68 private static readonly string m_chatSessionRequestPath = "0009/";
65 69
66 // Control info 70 // Control info
67 private static bool m_WOF = true; 71 private static bool m_Enabled = false;
68 private static bool m_pluginEnabled = false;
69 72
70 // FreeSwitch server is going to contact us and ask us all 73 // FreeSwitch server is going to contact us and ask us all
71 // sorts of things. 74 // sorts of things.
72 private static string m_freeSwitchServerUser;
73 private static string m_freeSwitchServerPass;
74 75
75 // SLVoice client will do a GET on this prefix 76 // SLVoice client will do a GET on this prefix
76 private static string m_freeSwitchAPIPrefix; 77 private static string m_freeSwitchAPIPrefix;
@@ -84,143 +85,147 @@ namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
84 private static string m_freeSwitchRealm; 85 private static string m_freeSwitchRealm;
85 private static string m_freeSwitchSIPProxy; 86 private static string m_freeSwitchSIPProxy;
86 private static bool m_freeSwitchAttemptUseSTUN; 87 private static bool m_freeSwitchAttemptUseSTUN;
87 // private static string m_freeSwitchSTUNServer;
88 private static string m_freeSwitchEchoServer; 88 private static string m_freeSwitchEchoServer;
89 private static int m_freeSwitchEchoPort; 89 private static int m_freeSwitchEchoPort;
90 private static string m_freeSwitchDefaultWellKnownIP; 90 private static string m_freeSwitchDefaultWellKnownIP;
91 private static int m_freeSwitchDefaultTimeout; 91 private static int m_freeSwitchDefaultTimeout;
92 // private static int m_freeSwitchSubscribeRetry;
93 private static string m_freeSwitchUrlResetPassword; 92 private static string m_freeSwitchUrlResetPassword;
94 // private static IPEndPoint m_FreeSwitchServiceIP; 93 private uint m_freeSwitchServicePort;
95 private int m_freeSwitchServicePort;
96 private string m_openSimWellKnownHTTPAddress; 94 private string m_openSimWellKnownHTTPAddress;
97 private string m_freeSwitchContext; 95 private string m_freeSwitchContext;
98 96
99 private FreeSwitchDirectory m_FreeSwitchDirectory;
100 private FreeSwitchDialplan m_FreeSwitchDialplan;
101
102 private readonly Dictionary<string, string> m_UUIDName = new Dictionary<string, string>(); 97 private readonly Dictionary<string, string> m_UUIDName = new Dictionary<string, string>();
103 private Dictionary<string, string> m_ParcelAddress = new Dictionary<string, string>(); 98 private Dictionary<string, string> m_ParcelAddress = new Dictionary<string, string>();
104 99
105 private Scene m_scene; 100 private Scene m_Scene;
106 101
102 private IConfig m_Config;
107 103
108 private IConfig m_config; 104 private IFreeswitchService m_FreeswitchService;
109 105
110 public void Initialise(Scene scene, IConfigSource config) 106 public void Initialise(IConfigSource config)
111 { 107 {
112 m_scene = scene; 108 m_Config = config.Configs["FreeSwitchVoice"];
113 m_config = config.Configs["FreeSwitchVoice"];
114 109
115 if (null == m_config) 110 if (m_Config == null)
116 { 111 {
117 m_log.Info("[FreeSwitchVoice] no config found, plugin disabled"); 112 m_log.Info("[FreeSwitchVoice] no config found, plugin disabled");
118 return; 113 return;
119 } 114 }
120 115
121 if (!m_config.GetBoolean("enabled", false)) 116 if (!m_Config.GetBoolean("Enabled", false))
122 { 117 {
123 m_log.Info("[FreeSwitchVoice] plugin disabled by configuration"); 118 m_log.Info("[FreeSwitchVoice] plugin disabled by configuration");
124 return; 119 return;
125 } 120 }
126 121
127 // This is only done the FIRST time this method is invoked. 122 try
128 if (m_WOF)
129 { 123 {
130 m_pluginEnabled = true; 124 string serviceDll = m_Config.GetString("LocalServiceModule",
131 m_WOF = false; 125 String.Empty);
132 126
133 try 127 if (serviceDll == String.Empty)
134 { 128 {
135 m_freeSwitchServerUser = m_config.GetString("freeswitch_server_user", String.Empty); 129 m_log.Error("[FreeSwitchVoice]: No LocalServiceModule named in section FreeSwitchVoice");
136 m_freeSwitchServerPass = m_config.GetString("freeswitch_server_pass", String.Empty); 130 return;
137 m_freeSwitchAPIPrefix = m_config.GetString("freeswitch_api_prefix", String.Empty); 131 }
138
139 // XXX: get IP address of HTTP server. (This can be this OpenSim server or another, or could be a dedicated grid service or may live on the freeswitch server)
140
141 string serviceIP = m_config.GetString("freeswitch_service_server", String.Empty);
142 int servicePort = m_config.GetInt("freeswitch_service_port", 80);
143 IPAddress serviceIPAddress = IPAddress.Parse(serviceIP);
144 // m_FreeSwitchServiceIP = new IPEndPoint(serviceIPAddress, servicePort);
145 m_freeSwitchServicePort = servicePort;
146 m_freeSwitchRealm = m_config.GetString("freeswitch_realm", String.Empty);
147 m_freeSwitchSIPProxy = m_config.GetString("freeswitch_sip_proxy", m_freeSwitchRealm);
148 m_freeSwitchAttemptUseSTUN = m_config.GetBoolean("freeswitch_attempt_stun", true);
149 // m_freeSwitchSTUNServer = m_config.GetString("freeswitch_stun_server", m_freeSwitchRealm);
150 m_freeSwitchEchoServer = m_config.GetString("freeswitch_echo_server", m_freeSwitchRealm);
151 m_freeSwitchEchoPort = m_config.GetInt("freeswitch_echo_port", 50505);
152 m_freeSwitchDefaultWellKnownIP = m_config.GetString("freeswitch_well_known_ip", m_freeSwitchRealm);
153 m_openSimWellKnownHTTPAddress = m_config.GetString("opensim_well_known_http_address", serviceIPAddress.ToString());
154 m_freeSwitchDefaultTimeout = m_config.GetInt("freeswitch_default_timeout", 5000);
155 // m_freeSwitchSubscribeRetry = m_config.GetInt("freeswitch_subscribe_retry", 120);
156 m_freeSwitchUrlResetPassword = m_config.GetString("freeswitch_password_reset_url", String.Empty);
157 m_freeSwitchContext = m_config.GetString("freeswitch_context", "default");
158
159 if (String.IsNullOrEmpty(m_freeSwitchServerUser) ||
160 String.IsNullOrEmpty(m_freeSwitchServerPass) ||
161 String.IsNullOrEmpty(m_freeSwitchRealm) ||
162 String.IsNullOrEmpty(m_freeSwitchAPIPrefix))
163 {
164 m_log.Error("[FreeSwitchVoice] plugin mis-configured");
165 m_log.Info("[FreeSwitchVoice] plugin disabled: incomplete configuration");
166 return;
167 }
168 132
169 // set up http request handlers for 133 Object[] args = new Object[] { config };
170 // - prelogin: viv_get_prelogin.php 134 m_FreeswitchService = ServerUtils.LoadPlugin<IFreeswitchService>(serviceDll, args);
171 // - signin: viv_signin.php 135
172 // - buddies: viv_buddy.php 136 string jsonConfig = m_FreeswitchService.GetJsonConfig();
173 // - ???: viv_watcher.php 137 m_log.Debug("[FreeSwitchVoice]: Configuration string: " + jsonConfig);
174 // - signout: viv_signout.php 138 OSDMap map = (OSDMap)OSDParser.DeserializeJson(jsonConfig);
175 if (UseProxy) 139
176 { 140 m_freeSwitchAPIPrefix = map["APIPrefix"].AsString();
177 MainServer.Instance.AddHTTPHandler(String.Format("{0}/", m_freeSwitchAPIPrefix), 141 m_freeSwitchRealm = map["Realm"].AsString();
178 ForwardProxyRequest); 142 m_freeSwitchSIPProxy = map["SIPProxy"].AsString();
179 } 143 m_freeSwitchAttemptUseSTUN = map["AttemptUseSTUN"].AsBoolean();
180 else 144 m_freeSwitchEchoServer = map["EchoServer"].AsString();
181 { 145 m_freeSwitchEchoPort = map["EchoPort"].AsInteger();
182 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_get_prelogin.php", m_freeSwitchAPIPrefix), 146 m_freeSwitchDefaultWellKnownIP = map["DefaultWellKnownIP"].AsString();
183 FreeSwitchSLVoiceGetPreloginHTTPHandler); 147 m_freeSwitchDefaultTimeout = map["DefaultTimeout"].AsInteger();
148 m_freeSwitchUrlResetPassword = String.Empty;
149 m_freeSwitchContext = map["Context"].AsString();
150
151 if (String.IsNullOrEmpty(m_freeSwitchRealm) ||
152 String.IsNullOrEmpty(m_freeSwitchAPIPrefix))
153 {
154 m_log.Error("[FreeSwitchVoice] plugin mis-configured");
155 m_log.Info("[FreeSwitchVoice] plugin disabled: incomplete configuration");
156 return;
157 }
184 158
185 // RestStreamHandler h = new 159 // set up http request handlers for
186 // RestStreamHandler("GET", 160 // - prelogin: viv_get_prelogin.php
187 // String.Format("{0}/viv_get_prelogin.php", m_freeSwitchAPIPrefix), FreeSwitchSLVoiceGetPreloginHTTPHandler); 161 // - signin: viv_signin.php
188 // MainServer.Instance.AddStreamHandler(h); 162 // - buddies: viv_buddy.php
163 // - ???: viv_watcher.php
164 // - signout: viv_signout.php
165 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_get_prelogin.php", m_freeSwitchAPIPrefix),
166 FreeSwitchSLVoiceGetPreloginHTTPHandler);
189 167
168 // RestStreamHandler h = new
169 // RestStreamHandler("GET",
170 // String.Format("{0}/viv_get_prelogin.php", m_freeSwitchAPIPrefix), FreeSwitchSLVoiceGetPreloginHTTPHandler);
171 // MainServer.Instance.AddStreamHandler(h);
190 172
191 173
192 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_signin.php", m_freeSwitchAPIPrefix),
193 FreeSwitchSLVoiceSigninHTTPHandler);
194 174
195 // set up http request handlers to provide 175 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_signin.php", m_freeSwitchAPIPrefix),
196 // on-demand FreeSwitch configuration to 176 FreeSwitchSLVoiceSigninHTTPHandler);
197 // FreeSwitch's mod_curl_xml
198 MainServer.Instance.AddHTTPHandler(String.Format("{0}/freeswitch-config", m_freeSwitchAPIPrefix),
199 FreeSwitchConfigHTTPHandler);
200 177
201 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_buddy.php", m_freeSwitchAPIPrefix), 178 MainServer.Instance.AddHTTPHandler(String.Format("{0}/viv_buddy.php", m_freeSwitchAPIPrefix),
202 FreeSwitchSLVoiceBuddyHTTPHandler); 179 FreeSwitchSLVoiceBuddyHTTPHandler);
203 }
204 180
205 m_log.InfoFormat("[FreeSwitchVoice] using FreeSwitch server {0}", m_freeSwitchRealm); 181 m_log.InfoFormat("[FreeSwitchVoice] using FreeSwitch server {0}", m_freeSwitchRealm);
206 182
207 m_FreeSwitchDirectory = new FreeSwitchDirectory(); 183 m_Enabled = true;
208 m_FreeSwitchDialplan = new FreeSwitchDialplan();
209 184
210 m_pluginEnabled = true; 185 m_log.Info("[FreeSwitchVoice] plugin enabled");
211 m_WOF = false; 186 }
187 catch (Exception e)
188 {
189 m_log.ErrorFormat("[FreeSwitchVoice] plugin initialization failed: {0}", e.Message);
190 m_log.DebugFormat("[FreeSwitchVoice] plugin initialization failed: {0}", e.ToString());
191 return;
192 }
212 193
213 m_log.Info("[FreeSwitchVoice] plugin enabled"); 194 // This here is a region module trying to make a global setting.
195 // Not really a good idea but it's Windows only, so I can't test.
196 try
197 {
198 ServicePointManager.ServerCertificateValidationCallback += CustomCertificateValidation;
199 }
200 catch (NotImplementedException)
201 {
202 try
203 {
204#pragma warning disable 0612, 0618
205 // Mono does not implement the ServicePointManager.ServerCertificateValidationCallback yet! Don't remove this!
206 ServicePointManager.CertificatePolicy = new MonoCert();
207#pragma warning restore 0612, 0618
214 } 208 }
215 catch (Exception e) 209 catch (Exception)
216 { 210 {
217 m_log.ErrorFormat("[FreeSwitchVoice] plugin initialization failed: {0}", e.Message); 211 // COmmented multiline spam log message
218 m_log.DebugFormat("[FreeSwitchVoice] plugin initialization failed: {0}", e.ToString()); 212 //m_log.Error("[FreeSwitchVoice]: Certificate validation handler change not supported. You may get ssl certificate validation errors teleporting from your region to some SSL regions.");
219 return;
220 } 213 }
221 } 214 }
215 }
222 216
223 if (m_pluginEnabled) 217 public void AddRegion(Scene scene)
218 {
219 m_Scene = scene;
220
221 // We generate these like this: The region's external host name
222 // as defined in Regions.ini is a good address to use. It's a
223 // dotted quad (or should be!) and it can reach this host from
224 // a client. The port is grabbed from the region's HTTP server.
225 m_openSimWellKnownHTTPAddress = m_Scene.RegionInfo.ExternalHostName;
226 m_freeSwitchServicePort = MainServer.Instance.Port;
227
228 if (m_Enabled)
224 { 229 {
225 // we need to capture scene in an anonymous method 230 // we need to capture scene in an anonymous method
226 // here as we need it later in the callbacks 231 // here as we need it later in the callbacks
@@ -228,36 +233,21 @@ namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
228 { 233 {
229 OnRegisterCaps(scene, agentID, caps); 234 OnRegisterCaps(scene, agentID, caps);
230 }; 235 };
231
232 try
233 {
234 ServicePointManager.ServerCertificateValidationCallback += CustomCertificateValidation;
235 }
236 catch (NotImplementedException)
237 {
238 try
239 {
240#pragma warning disable 0612, 0618
241 // Mono does not implement the ServicePointManager.ServerCertificateValidationCallback yet! Don't remove this!
242 ServicePointManager.CertificatePolicy = new MonoCert();
243#pragma warning restore 0612, 0618
244 }
245 catch (Exception)
246 {
247 m_log.Error("[FreeSwitchVoice]: Certificate validation handler change not supported. You may get ssl certificate validation errors teleporting from your region to some SSL regions.");
248 }
249 }
250 } 236 }
251 } 237 }
252 238
253 public void PostInitialise() 239 public void RemoveRegion(Scene scene)
254 { 240 {
255 if (m_pluginEnabled) 241 }
242
243 public void RegionLoaded(Scene scene)
244 {
245 if (m_Enabled)
256 { 246 {
257 m_log.Info("[FreeSwitchVoice] registering IVoiceModule with the scene"); 247 m_log.Info("[FreeSwitchVoice] registering IVoiceModule with the scene");
258 248
259 // register the voice interface for this module, so the script engine can call us 249 // register the voice interface for this module, so the script engine can call us
260 m_scene.RegisterModuleInterface<IVoiceModule>(this); 250 scene.RegisterModuleInterface<IVoiceModule>(this);
261 } 251 }
262 } 252 }
263 253
@@ -270,9 +260,9 @@ namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
270 get { return "FreeSwitchVoiceModule"; } 260 get { return "FreeSwitchVoiceModule"; }
271 } 261 }
272 262
273 public bool IsSharedModule 263 public Type ReplaceableInterface
274 { 264 {
275 get { return true; } 265 get { return null; }
276 } 266 }
277 267
278 // <summary> 268 // <summary>
@@ -725,46 +715,6 @@ namespace OpenSim.Region.OptionalModules.Avatar.Voice.FreeSwitchVoice
725 715
726 response["int_response_code"] = 200; 716 response["int_response_code"] = 200;
727 return response; 717 return response;
728 /*
729 <level0>
730 <status>OK</status><body><status>Ok</status><cookie_name>lib_session</cookie_name>
731 * <cookie>xMj1QJSc7TA-G7XqcW6QXAg==:1290551700:050d35c6fef96f132f780d8039ff7592::</cookie>
732 * <auth_token>xMj1QJSc7TA-G7XqcW6QXAg==:1290551700:050d35c6fef96f132f780d8039ff7592::</auth_token>
733 * <primary>1</primary>
734 * <account_id>7449</account_id>
735 * <displayname>Teravus Ousley</displayname></body></level0>
736 */
737 }
738
739 public Hashtable FreeSwitchConfigHTTPHandler(Hashtable request)
740 {
741 m_log.DebugFormat("[FreeSwitchVoice] FreeSwitchConfigHTTPHandler called with {0}", (string)request["body"]);
742
743 Hashtable response = new Hashtable();
744 response["str_response_string"] = string.Empty;
745 // all the params come as NVPs in the request body
746 Hashtable requestBody = parseRequestBody((string) request["body"]);
747
748 // is this a dialplan or directory request
749 string section = (string) requestBody["section"];
750
751 if (section == "directory")
752 response = m_FreeSwitchDirectory.HandleDirectoryRequest(m_freeSwitchContext, m_freeSwitchRealm, requestBody);
753 else if (section == "dialplan")
754 response = m_FreeSwitchDialplan.HandleDialplanRequest(m_freeSwitchContext, m_freeSwitchRealm, requestBody);
755 else
756 m_log.WarnFormat("[FreeSwitchVoice]: section was {0}", section);
757
758 // XXX: re-generate dialplan:
759 // - conf == region UUID
760 // - conf number = region port
761 // -> TODO Initialise(): keep track of regions via events
762 // re-generate accounts for all avatars
763 // -> TODO Initialise(): keep track of avatars via events
764 Regex normalizeEndLines = new Regex(@"\r\n", RegexOptions.Compiled | RegexOptions.Singleline | RegexOptions.Multiline);
765
766 m_log.DebugFormat("[FreeSwitchVoice] FreeSwitchConfigHTTPHandler return {0}",normalizeEndLines.Replace(((string)response["str_response_string"]), ""));
767 return response;
768 } 718 }
769 719
770 public Hashtable parseRequestBody(string body) 720 public Hashtable parseRequestBody(string body)
generated by cgit v1.1 at 2024-12-14 13:07:09 +0000