1 # Copyright (c) Stas Shtin, 2010
3 # This file is part of IPyPBX.
5 # IPyPBX is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # IPyPBX is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with IPyPBX. If not, see <http://www.gnu.org/licenses/>.
18 import xml.etree.ElementTree as etree
19 from PyQt4 import QtCore, QtNetwork
22 class FreeswitchConfigServer(QtNetwork.QTcpServer):
24 TCP server that receives config requests from freeswitch.
27 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
28 <document type="freeswitch/xml">
29 <section name="result">
30 <result status="not found" />
34 responseTemplate = '''HTTP/1.1 200 OK
35 Content-Type: text/xml; charset=utf-8
40 def __init__(self, window):
41 super(FreeswitchConfigServer, self).__init__(window)
45 self.connection_id = None
46 self.is_running = False
48 GenClass(window, self) for GenClass in (
51 self.httpRequestParser = HttpRequestParser(self)
53 def setSocketData(self, host, port, connection_id):
55 Set host and port for socket to listen on.
57 If the settings differ from previous values, server gets restarted.
59 # Check if restart is needed before new settings are applied.
61 (host, port) != (self.host, self.port)) and connection_id
67 self.connection_id = connection_id
69 # Restart server if necessary.
73 def startServer(self):
75 Start listening on our socket.
77 if not self.is_running:
78 if self.host and self.port:
79 self.newConnection.connect(self.clientConnecting)
80 self.listen(QtNetwork.QHostAddress(self.host), self.port)
81 self.is_running = True
85 Stop listening on our socket.
89 self.is_running = False
91 def restartServer(self):
98 def clientConnecting(self):
100 Handle client connection.
102 if self.hasPendingConnections():
103 self.socket = self.nextPendingConnection()
104 self.socket.readyRead.connect(self.receiveData)
106 def receiveData(self):
107 # TODO: read in chunks.
108 for line in str(self.socket.readAll()).split('\r\n'):
109 print self.httpRequestParser.i, line
110 self.httpRequestParser.handle(line)
112 response = self.httpRequestParser.result or self.configNotFound
113 http_response = self.responseTemplate % (len(response), response)
114 self.socket.write(http_response)
118 self.httpRequestParser.reset()
121 class HttpParseError(Exception):
123 Error parsing HTTP request.
127 class HttpRequestParser(object):
129 A simple state machine for parsing HTTP requests.
131 HTTP_NONE, HTTP_REQUEST, HTTP_HEADERS, HTTP_EMPTY, HTTP_MESSAGE, \
133 HTTP_STATES = ['NONE', 'REQUEST', 'HEADERS', 'EMPTY', 'MESSAGE', 'DONE']
135 def __init__(self, parent):
142 Reset parser to initial state.
145 # Initial values for request data.
147 self.request_path = None
148 self.http_version = None
154 self.state = self.HTTP_NONE
156 def handle(self, line):
158 Dispatch line to current state handler.
160 for state in self.HTTP_STATES:
161 if getattr(self, 'HTTP_%s' % state) == self.state:
162 getattr(self, 'handle%s' % state.title())(line)
165 raise HttpParseError('Unknown HTTP state')
167 def handleNone(self, line):
169 Pass line to next state.
174 def handleRequest(self, line):
176 Retrieve HTTP method, request path and HTTP version from request.
179 self.method, self.request_path, self.http_version = line.split(' ')
184 def handleHeaders(self, line):
186 Parse headers while not found an empty line.
189 key, value = line.split(': ')
190 self.headers[key] = value
195 def handleEmpty(self, line):
197 Empty line separator is found - proceed to next state.
201 def handleMessage(self, line):
203 Append to message body.
205 self.data = dict(pair.split('=', 2) for pair in line.split('&'))
207 #for k, v in self.data.items():
211 for generator in self.parent.generators:
212 if generator.canHandle(self.data):
214 self.result = etree.tostring(generator.generateConfig(
219 class FreeswitchConfigGenerator(object):
221 Base class for generating XML configs.
226 def __init__(self, model, parent):
232 Return database instance.
234 return self.model.controllers['connection'].model.database()
235 database = property(database)
237 def canHandle(self, params):
239 Check if this generator can handle a request from freeswitch.
241 for key, value in self.param_match.iteritems():
242 if params.get(key, None) != value:
247 def baseElements(self):
248 root_elt = etree.Element('document', type='freeswitch/xml')
249 section_elt = etree.SubElement(
250 root_elt, 'section', name=self.param_match['section'])
251 return root_elt, section_elt
252 baseElements = property(baseElements)
254 def generateConfig(self, params):
255 return NotImplemented
258 def addParams(parent_elt, params):
260 Create params element based on data passed in a list.
262 for name, value in params:
264 parent_elt, 'param', name=name, value=str(value))
267 class SofiaConfGenerator(FreeswitchConfigGenerator):
269 Generates sofia.conf.xml config file.
271 param_match = {'section': 'configuration', 'key_value': 'sofia.conf'}
272 config_name = 'sofia.conf'
274 def generateConfig(self, params):
276 root_elt, section_elt = self.baseElements
278 # Create configuration, settings and profiles elements.
279 configuration_elt = etree.SubElement(
280 section_elt, 'configuration', name=self.config_name,
281 description='%s config' % self.config_name)
282 profiles_elt = etree.SubElement(configuration_elt, 'profiles')
284 database = self.database
286 # Create all profiles for current host.
287 profiles_query = database.exec_(
289 select id, name, external_sip_ip, external_rtp_ip, sip_ip, rtp_ip,
290 sip_port, accept_blind_registration, authenticate_calls
291 from ipypbxweb_sipprofile where connection_id = %i
292 ''' % self.parent.connection_id)
293 while profiles_query.next():
294 # Create profile element.
295 profile_id, _ok = profiles_query.value(0).toInt()
296 profile_elt = etree.SubElement(
297 profiles_elt, 'profile',
298 name=profiles_query.value(1).toString())
300 # Create domains for current profile.
301 domains_elt = etree.SubElement(profile_elt, 'domains')
302 domains_query = database.exec_(
303 'select host_name from ipypbxweb_domain where sip_profile_id = '
305 while domains_query.next():
306 domain_elt = etree.SubElement(
307 domains_elt, 'domain',
308 name=domains_query.value(0).toString(), alias='true',
312 profile_sip_port, _ok = profiles_query.value(6).toInt()
314 # Create settings for current profile.
315 settings_elt = etree.SubElement(profile_elt, 'settings')
317 ('dialplan', 'XML,enum'),
318 ('ext-sip-ip', profiles_query.value(2).toString()),
319 ('ext-rtp-ip', profiles_query.value(3).toString()),
320 ('sip-ip', profiles_query.value(4).toString()),
321 ('rtp-ip', profiles_query.value(5).toString()),
322 ('sip-port', profile_sip_port),
324 ('rtp-timer-name', 'soft'),
325 ('codec-prefs', 'PCMU@20i'),
328 ('dtmf-duration', '100'),
330 ('accept-blind-reg', profiles_query.value(7).toBool()),
331 ('auth-calls', profiles_query.value(8).toBool()))
332 self.addParams(settings_elt, params)
334 # Create gateways for current profile.
335 gateways_elt = etree.SubElement(profile_elt, 'gateways')
336 gateways_query = database.exec_(
338 select name, username, realm, from_domain, password,
339 retry_in_seconds, expire_in_seconds, caller_id_in_from_field,
341 from ipypbxweb_gateway where sip_profile_id = %i
343 while gateways_query.next():
344 # Create gateway element.
345 gateway_elt = etree.SubElement(
346 gateways_elt, 'gateway', name=gateways_query.value(0).toString())
347 retry_seconds, _ok = gateways_query.value(5).toInt()
348 expire_seconds, _ok = gateways_query.value(6).toInt()
350 ('username', gateways_query.value(1).toString()),
351 ('realm', gateways_query.value(2).toString()),
352 ('from-domain', gateways_query.value(3).toString()),
353 ('password', gateways_query.value(4).toString()),
354 ('retry-seconds', retry_seconds),
355 ('expire-seconds', expire_seconds),
356 ('caller-id-in-from', gateways_query.value(7).toBool()),
357 ('extension', gateways_query.value(8).toString()),
358 # TODO: proxy, register
360 self.addParams(gateway_elt, params)
364 class DirectoryGenerator(FreeswitchConfigGenerator):
366 Generates user directory.
368 param_match = {'section': 'directory'}
370 def generateConfig(self, params):
372 root_elt, section_elt = self.baseELements
374 database = self.database
376 # Find profile id from params.
377 profile_query = database.exec_(
379 select id from ipypbxweb_sipprofile
380 where name= '%s' and connection_id = %i limit 1
381 ''' % (params['profile'], self.parent.connection_id))
384 if profile_query.next():
385 profile_id, _ok = profile_query.value(0).toInt()
388 # Matching SIP profile not found.
391 # List all domains for this profile.
392 domains_query = database.exec_(
394 select id, host_name from ipypbxweb_domain
395 where sip_profile_id = %i
398 while domains_query.next():
399 domain_id, _ok = domains_query.value(0).toInt()
401 # Create domaim element.
402 domain_elt = etree.SubElement(
403 section_elt, 'domain', name=domains_query.value(1).toString())
405 # TODO: add domain params section if we need it, i.e.:
407 # <param name="dial-string"
408 # value="{presence_id=${dialed_user}@${dialed_domain}}$\
409 # {sofia_contact(${dialed_user}@${dialed_domain})}"/>
412 # For new we put all users into one group called default.
413 groups_elt = etree.SubElement(domain_elt, 'groups')
414 group_elt = etree.SubElement(groups_elt, 'group', name='default')
416 users_elt = etree.SubElement(group_elt, 'users')
418 users_query = database.exec_(
420 select user_id, password from ipypbxweb_endpoint
424 # Create user entries for all endpoints for this domain.
425 while users_query.next():
426 user_elt = etree.SubElement(
427 users_elt, 'user', id=users_query.value(0).toString())
429 # Specify endpoint password.
431 ('password', users_query.value(1).toString()),
433 self.addParams(user_elt, params)