aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Services/FreeswitchService/FreeswitchService.cs
blob: c3f10560d7353d63a872a3228a787ccff1673a56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/*
 * 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 OpenSimulator 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.Text;
using System.Reflection;
using Nini.Config;
using log4net;
using OpenSim.Framework;
using OpenSim.Data;
using OpenSim.Services.Interfaces;
using OpenMetaverse;
using OpenMetaverse.StructuredData;
using System.Collections;

namespace OpenSim.Services.FreeswitchService
{
    public class FreeswitchService : FreeswitchServiceBase, IFreeswitchService
    {
        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        public FreeswitchService(IConfigSource config) : base(config)
        {
            // Perform initilialization here
        }

        public Hashtable HandleDialplanRequest(Hashtable request)
        {
            m_log.DebugFormat("[FreeSwitchVoice]: HandleDialplanRequest called with {0}",request.ToString());

            Hashtable response = new Hashtable();

            foreach (DictionaryEntry item in request)
            {
//               m_log.InfoFormat("[FreeSwitchDirectory]: requestBody item {0} {1}",item.Key, item.Value);
            }

            string requestcontext = (string) request["Hunt-Context"];
            response["content_type"] = "text/xml";
            response["keepalive"] = false;
            response["int_response_code"] = 200;

            if (m_freeSwitchContext != String.Empty && m_freeSwitchContext != requestcontext)
            {
                m_log.Debug("[FreeSwitchDirectory]: returning empty as it's for another context");
                response["str_response_string"] = "";
            }
            else
            {
                response["str_response_string"] = String.Format(@"<?xml version=""1.0"" encoding=""utf-8""?>
                   <document type=""freeswitch/xml"">
                     <section name=""dialplan"">
                     <context name=""{0}"">" + 

/*                           <!-- dial via SIP uri -->
                            <extension name=""sip_uri"">
                                   <condition field=""destination_number"" expression=""^sip:(.*)$"">
                                   <action application=""bridge"" data=""sofia/${use_profile}/$1""/>
                                   <!--<action application=""bridge"" data=""$1""/>-->
                                   </condition>
                           </extension>*/

                           @"<extension name=""opensim_conferences"">
                                   <condition field=""destination_number"" expression=""^confctl-(.*)$"">
                                           <action application=""answer""/>
                                           <action application=""conference"" data=""$1-{1}@{0}""/>
                                   </condition>
                           </extension>

                           <extension name=""opensim_conf"">
                                   <condition field=""destination_number"" expression=""^conf-(.*)$"">
                                           <action application=""answer""/>
                                           <action application=""conference"" data=""$1-{1}@{0}""/>
                                   </condition>
                           </extension>

                           <extension name=""avatar"">
                                   <condition field=""destination_number"" expression=""^(x.*)$"">
                                           <action application=""bridge"" data=""user/$1""/>
                                   </condition>
                           </extension>

                     </context>
                   </section>
                   </document>", m_freeSwitchContext, m_freeSwitchRealm);
            }

            return response;
        }

        public Hashtable HandleDirectoryRequest(Hashtable request)
        {
            Hashtable response = new Hashtable();
            string domain = (string) request["domain"];
            if (domain != m_freeSwitchRealm) 
            {
                response["content_type"] = "text/xml";
                response["keepalive"] = false;
                response["int_response_code"] = 200;
                response["str_response_string"] = "";
            } 
            else 
            {
//                 m_log.DebugFormat("[FreeSwitchDirectory]: HandleDirectoryRequest called with {0}",request.ToString());
            
                 // information in the request we might be interested in
             
                 // Request 1 sip_auth for users account
             
                 //Event-Calling-Function=sofia_reg_parse_auth
                 //Event-Calling-Line-Number=1494
                 //action=sip_auth
                 //sip_user_agent=Vivox-SDK-2.1.3010.6151-Mac%20(Feb-11-2009/16%3A42%3A41)
                 //sip_auth_username=xhZuXKmRpECyr2AARJYyGgg%3D%3D  (==)
                 //sip_auth_realm=9.20.151.43
                 //sip_contact_user=xhZuXKmRpECyr2AARJYyGgg%3D%3D (==)
                 //sip_contact_host=192.168.0.3    // this shouldnt really be a local IP, investigate STUN servers
                 //sip_to_user=xhZuXKmRpECyr2AARJYyGgg%3D%3D
                 //sip_to_host=9.20.151.43
                 //sip_auth_method=REGISTER
                 //user=xhZuXKmRpECyr2AARJYyGgg%3D%3D
                 //domain=9.20.151.43
                 //ip=9.167.220.137    // this is the correct IP rather than sip_contact_host above when through a vpn or NAT setup
             
//                 foreach (DictionaryEntry item in request)
//                    m_log.DebugFormat("[FreeSwitchDirectory]: requestBody item {0} {1}", item.Key, item.Value);
             
                 string eventCallingFunction = (string) request["Event-Calling-Function"];
                 if (eventCallingFunction == null)
                 {
                     eventCallingFunction = "sofia_reg_parse_auth";
                 }

                 if (eventCallingFunction.Length == 0)
                 {
                     eventCallingFunction = "sofia_reg_parse_auth";
                 }
             
                 if (eventCallingFunction == "sofia_reg_parse_auth")
                 {
                     string sipAuthMethod = (string)request["sip_auth_method"];
                 
                     if (sipAuthMethod == "REGISTER")
                     {
                         response = HandleRegister(m_freeSwitchContext, m_freeSwitchRealm, request);
                     } 
                     else if (sipAuthMethod == "INVITE")
                     {
                          response = HandleInvite(m_freeSwitchContext, m_freeSwitchRealm, request);
                     }
                     else
                     {
                         m_log.ErrorFormat("[FreeSwitchVoice]: HandleDirectoryRequest unknown sip_auth_method {0}",sipAuthMethod);
                         response["int_response_code"] = 404;
                         response["content_type"] = "text/xml";
                         response["str_response_string"] = "";
                     }
                 }
                 else if (eventCallingFunction == "switch_xml_locate_user")
                 {
                     response = HandleLocateUser(m_freeSwitchRealm, request);
                 }
                 else if (eventCallingFunction == "user_data_function") // gets called when an avatar to avatar call is made
                 {
                      response = HandleLocateUser(m_freeSwitchRealm, request);
                 }
                 else if (eventCallingFunction == "user_outgoing_channel")
                 {
                     response = HandleRegister(m_freeSwitchContext, m_freeSwitchRealm, request);
                 }
                 else if (eventCallingFunction == "config_sofia") // happens once on freeswitch startup
                 {
                     response = HandleConfigSofia(m_freeSwitchContext, m_freeSwitchRealm, request);
                 }
                 else if (eventCallingFunction == "switch_load_network_lists")
                 {
                     //response = HandleLoadNetworkLists(request);
                     response["int_response_code"] = 404;
                     response["keepalive"] = false;
                     response["content_type"] = "text/xml";
                     response["str_response_string"] = "";
                 }
                 else
                 {
                     m_log.ErrorFormat("[FreeSwitchVoice]: HandleDirectoryRequest unknown Event-Calling-Function {0}",eventCallingFunction);
                     response["int_response_code"] = 404;
                     response["keepalive"] = false;
                     response["content_type"] = "text/xml";
                     response["str_response_string"] = "";
                 }
            }
            return response;
        }
        
        private Hashtable HandleRegister(string Context, string Realm, Hashtable request)
        {
            m_log.Info("[FreeSwitchDirectory]: HandleRegister called");
            
            // TODO the password we return needs to match that sent in the request, this is hard coded for now
            string password = "1234";
            string domain = (string) request["domain"];
            string user = (string) request["user"];
            
            Hashtable response = new Hashtable();
            response["content_type"] = "text/xml";
            response["keepalive"] = false;
            response["int_response_code"] = 200;

            response["str_response_string"] = String.Format(
                "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
                "<document type=\"freeswitch/xml\">\r\n" +
                    "<section name=\"directory\" description=\"User Directory\">\r\n" +
                        "<domain name=\"{0}\">\r\n" +
                            "<user id=\"{1}\">\r\n" +
                                "<params>\r\n" +
                                    "<param name=\"password\" value=\"{2}\" />\r\n" +
                                    "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
                                "</params>\r\n" +
                                "<variables>\r\n" +
                                    "<variable name=\"user_context\" value=\"{3}\" />\r\n" +
                                    "<variable name=\"presence_id\" value=\"{1}@{0}\"/>"+
                                "</variables>\r\n" +
                            "</user>\r\n" +
                        "</domain>\r\n" +
                    "</section>\r\n" +
                "</document>\r\n",
                domain , user, password, Context);
                
            return response;
        }
        
        private Hashtable HandleInvite(string Context, string Realm, Hashtable request)
        {
            m_log.Info("[FreeSwitchDirectory]: HandleInvite called");
            
            // TODO the password we return needs to match that sent in the request, this is hard coded for now
            string password = "1234";
            string domain = (string) request["domain"];
            string user = (string) request["user"];
            string sipRequestUser = (string) request["sip_request_user"];
            
            Hashtable response = new Hashtable();
            response["content_type"] = "text/xml";
            response["keepalive"] = false;
            response["int_response_code"] = 200;
            response["str_response_string"] = String.Format(
                "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
                "<document type=\"freeswitch/xml\">\r\n" +
                    "<section name=\"directory\" description=\"User Directory\">\r\n" +
                        "<domain name=\"{0}\">\r\n" +
                            "<user id=\"{1}\">\r\n" +
                                "<params>\r\n" +
                                    "<param name=\"password\" value=\"{2}\" />\r\n" +
                                    "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${1}@${{dialed_domain}}}}${{sofia_contact(${1}@${{dialed_domain}})}}\"/>\r\n" +
                                "</params>\r\n" +
                                "<variables>\r\n" +
                                    "<variable name=\"user_context\" value=\"{4}\" />\r\n" +
                                    "<variable name=\"presence_id\" value=\"{1}@$${{domain}}\"/>"+
                                "</variables>\r\n" +
                            "</user>\r\n" +
                            "<user id=\"{3}\">\r\n" +
                                "<params>\r\n" +
                                    "<param name=\"password\" value=\"{2}\" />\r\n" +
                                    "<param name=\"dial-string\" value=\"{{sip_contact_user={1}}}{{presence_id=${3}@${{dialed_domain}}}}${{sofia_contact(${3}@${{dialed_domain}})}}\"/>\r\n" +
                                "</params>\r\n" +
                                "<variables>\r\n" +
                                    "<variable name=\"user_context\" value=\"{4}\" />\r\n" +
                                    "<variable name=\"presence_id\" value=\"{3}@$${{domain}}\"/>"+
                                "</variables>\r\n" +
                            "</user>\r\n" +
                        "</domain>\r\n" +
                    "</section>\r\n" +
                "</document>\r\n",
                domain , user, password,sipRequestUser, Context);
                
            return response;
        }

        private Hashtable HandleLocateUser(String Realm, Hashtable request)
        {
            m_log.Info("[FreeSwitchDirectory]: HandleLocateUser called");
            
            // TODO the password we return needs to match that sent in the request, this is hard coded for now
            string domain = (string) request["domain"];
            string user = (string) request["user"];
            
            Hashtable response = new Hashtable();
            response["content_type"] = "text/xml";
            response["keepalive"] = false;
            response["int_response_code"] = 200;
            response["str_response_string"] = String.Format(
                "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
                "<document type=\"freeswitch/xml\">\r\n" +
                    "<section name=\"directory\" description=\"User Directory\">\r\n" +
                        "<domain name=\"{0}\">\r\n" +
                            "<params>\r\n" +
                                "<param name=\"dial-string\" value=\"{{sip_contact_user=${{dialed_user}}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
                            "</params>\r\n" +
                            "<user id=\"{1}\">\r\n" +
                            "<variables>\r\n"+
                              "<variable name=\"default_gateway\" value=\"$${{default_provider}}\"/>\r\n"+
                              "<variable name=\"presence_id\" value=\"{1}@$${{domain}}\"/>"+
                            "</variables>\r\n"+
                            "</user>\r\n" +
                        "</domain>\r\n" +
                    "</section>\r\n" +
                "</document>\r\n",
                domain , user);
            
            return response;
        }
       
        private Hashtable HandleConfigSofia(string Context, string Realm, Hashtable request)
        {
            m_log.Info("[FreeSwitchDirectory]: HandleConfigSofia called.");
            
            // TODO the password we return needs to match that sent in the request, this is hard coded for now
            string domain = (string) request["domain"];
            
            Hashtable response = new Hashtable();
            response["content_type"] = "text/xml";
            response["keepalive"] = false;
            response["int_response_code"] = 200;
            response["str_response_string"] = String.Format(
                "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n" +
                "<document type=\"freeswitch/xml\">\r\n" +
                    "<section name=\"directory\" description=\"User Directory\">\r\n" +
                        "<domain name=\"{0}\">\r\n" +
                            "<params>\r\n" +
                                "<param name=\"dial-string\" value=\"{{sip_contact_user=${{dialed_user}}}}{{presence_id=${{dialed_user}}@${{dialed_domain}}}}${{sofia_contact(${{dialed_user}}@${{dialed_domain}})}}\"/>\r\n" +
                            "</params>\r\n" +
                            "<groups name=\"default\">\r\n"+
                                "<users>\r\n"+
                                    "<user id=\"$${{default_provider}}\">\r\n"+
                                        "<gateways>\r\n"+
                                          "<gateway name=\"$${{default_provider}}\">\r\n"+
                                            "<param name=\"username\" value=\"$${{default_provider_username}}\"/>\r\n"+
                                            "<param name=\"password\" value=\"$${{default_provider_password}}\"/>\r\n"+
                                            "<param name=\"from-user\" value=\"$${{default_provider_username}}\"/>\r\n"+
                                            "<param name=\"from-domain\" value=\"$${{default_provider_from_domain}}\"/>\r\n"+
                                            "<param name=\"expire-seconds\" value=\"600\"/>\r\n"+
                                            "<param name=\"register\" value=\"$${{default_provider_register}}\"/>\r\n"+
                                            "<param name=\"retry-seconds\" value=\"30\"/>\r\n"+
                                            "<param name=\"extension\" value=\"$${{default_provider_contact}}\"/>\r\n"+
                                            "<param name=\"contact-params\" value=\"domain_name=$${{domain}}\"/>\r\n"+
                                            "<param name=\"context\" value=\"{1}\"/>\r\n"+
                                          "</gateway>\r\n"+
                                        "</gateways>\r\n"+
                                        "<params>\r\n"+
                                          "<param name=\"password\" value=\"$${{default_provider_password}}\"/>\r\n"+
                                        "</params>\r\n"+
                                      "</user>\r\n"+
                                "</users>"+
                            "</groups>\r\n" +
                            "<variables>\r\n"+
                              "<variable name=\"default_gateway\" value=\"$${{default_provider}}\"/>\r\n"+
                            "</variables>\r\n"+
                        "</domain>\r\n" +
                    "</section>\r\n" +
                "</document>\r\n", 
                domain, Context); 
             
            return response;
        }

        public string GetJsonConfig()
        {
            OSDMap map = new OSDMap(9);

            map.Add("Realm", m_freeSwitchRealm);
            map.Add("SIPProxy", m_freeSwitchSIPProxy);
            map.Add("AttemptUseSTUN", m_freeSwitchAttemptUseSTUN);
            map.Add("EchoServer", m_freeSwitchEchoServer);
            map.Add("EchoPort", m_freeSwitchEchoPort);
            map.Add("DefaultWellKnownIP", m_freeSwitchDefaultWellKnownIP);
            map.Add("DefaultTimeout", m_freeSwitchDefaultTimeout);
            map.Add("Context", m_freeSwitchContext);
            map.Add("APIPrefix", m_freeSwitchAPIPrefix);

            return OSDParser.SerializeJsonString(map);
        }
    }
}