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/>.
22 from ipypbx import http
23 from PyQt4 import QtCore, QtGui, QtSql
26 class BaseController(QtCore.QObject):
28 Base class for other controllers.
30 Doesn't do anything useful on its own.
32 # TODO: possibly use a separate class for options and a meta-class.
35 view_display_fields = ()
36 view_display_fields_hidden = 'ID', 'Connection ID'
37 is_bound_to_connection = True
41 def __init__(self, parent=None, views=None):
42 super(BaseController, self).__init__(parent=parent)
47 classname = self.__class__.__name__
49 classname[:-10] if classname.endswith('Controller')
51 self.basename = self.basename[0].lower() + self.basename[1:]
53 # Initialize a new model.
54 self.model = QtSql.QSqlRelationalTableModel(parent)
55 self.model.setTable('ipypbxweb_%s' % self.basename.lower())
56 self.model.setEditStrategy(self.model.OnRowChange)
58 # Create model header from fields list.
59 for i, field in enumerate(self.fields):
60 self.model.setHeaderData(
61 i, QtCore.Qt.Horizontal,
62 QtCore.QVariant(QtGui.QApplication.translate(
63 "MainWindow", field, None,
64 QtGui.QApplication.UnicodeUTF8)))
69 # Otherwise get view list from the parent.
70 self.view_list = getattr(views, self.basename + 'ViewList')
71 self.view_list.setModel(self.model)
72 self.view_list.setSelectionMode(self.view_list.SingleSelection)
74 # Hide fields not meant for display.
75 for i, field in enumerate(self.fields):
76 if field not in self.view_list_fields:
77 self.view_list.hideColumn(i)
79 # Stretch headers to fill all available width.
80 self.view_list.setSelectionMode(QtGui.QTableView.SingleSelection)
81 self.view_list.setSelectionBehavior(QtGui.QTableView.SelectRows)
82 self.view_list.resizeColumnsToContents()
83 self.view_list.resizeRowsToContents()
84 self.view_list.horizontalHeader().setStretchLastSection(True)
87 self.view_list.selectRow(0)
89 # Get view display from the parent.
90 self.view_display = QtGui.QDataWidgetMapper(parent)
91 self.view_display.setModel(self.model)
93 display_fields = self.getDisplayFields()
95 for i, field in enumerate(self.fields):
96 if field in display_fields:
97 field_widget = self.getFieldWidget(field)
98 self.view_display.addMapping(field_widget, i)
100 # Set relations for model & view display.
102 self.delegate = QtSql.QSqlRelationalDelegate(self)
103 self.view_display.setItemDelegate(self.delegate)
105 for data in self.relations:
106 column, name, table, display = data
107 column_index = self.model.fieldIndex(column)
109 # SetRelation screws table data filtering?
110 self.model.setRelation(
112 QtSql.QSqlRelation('ipypbxweb_%s' % table, 'id', display))
115 rel = self.model.relationModel(column_index)
117 widget = self.getFieldWidget(name)
118 widget.setModel(self.parent().controllers[table].model)
119 widget.setModelColumn(rel.fieldIndex(display))
120 #widget.setItemDelegate(self.delegate)
123 # Select first row in the view list.
124 self.view_display.toFirst()
126 # Signals for this controller.
128 (getattr(self.views, self.basename + 'Add'), 'clicked()',
130 (self.model, 'primeInsert(int,QSqlRecord&)', self.objectAdded),
131 (self.view_list.selectionModel(),
132 'currentRowChanged(QModelIndex,QModelIndex)',
133 self.view_display, 'setCurrentModelIndex(QModelIndex)'),
134 (self.parent().controllers.get('connection', self
135 ).view_list.selectionModel(),
136 'currentRowChanged(QModelIndex,QModelIndex)',
137 self.connectionChange),
138 (getattr(self.views, self.basename + 'Save'), 'clicked()',
141 # Connect all signals.
142 for data in signal_data:
144 # Connect to python function.
145 sender, signal, receiver = data
146 QtCore.QObject.connect(sender, QtCore.SIGNAL(signal), receiver)
148 # Connect to Qt slot.
149 sender, signal, receiver, slot = data
150 QtCore.QObject.connect(
151 sender, QtCore.SIGNAL(signal), receiver, QtCore.SLOT(slot))
153 def getFieldWidget(self, field):
155 Return widget for given field name.
159 self.basename + ''.join(word.capitalize()
160 for word in field.split(' ')))
162 def getDisplayFields(self):
164 Return list of display fields.
166 If view_display_fields is not send, display all fields except
167 the first one that is usually the ID.
170 field for field in self.fields
171 if not field in self.view_display_fields_hidden]
177 # Add a new row to list view.
178 num_rows = self.model.rowCount()
179 self.model.insertRows(num_rows, 1)
180 self.view_list.selectRow(num_rows)
182 # Disable adding more than one row.
183 self.getFieldWidget('Add').setEnabled(False)
185 # Focust to the first displayed field.
186 self.getFieldWidget(self.getDisplayFields()[0]).setFocus()
188 def connectionChange(self, index, row):
190 Overload to handle connection change.
192 return NotImplemented
198 index = self.view_list.currentIndex()
199 self.view_display.submit()
200 self.view_list.setCurrentIndex(index)
201 self.getFieldWidget('Add').setEnabled(True)
204 class ConnectionController(BaseController):
206 Connections controller.
209 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
210 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
211 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local IP Address'),
212 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local Port'),
213 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch IP Address'),
214 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch Port'))
215 view_list_fields = 'Name', 'Freeswitch IP Address', 'Freeswitch Port'
218 def __init__(self, parent=None, views=None):
219 super(ConnectionController, self).__init__(parent, views)
221 for row in range(self.model.rowCount()):
222 # Get local IP address and port from the table for each row.
223 server = http.FreeswitchConfigServer(self)
224 server.setSocketData(*self.getSocketData(row))
226 self.servers.append(server)
228 def getSocketData(self, row):
229 local_ip_address = self.model.record(row).value(
230 'local_ip_address').toString()
231 local_port, _ok = self.model.record(row).value(
232 'local_port').toInt()
235 return local_ip_address, local_port
237 def connectionChange(self, index):
239 Restart config server on connection change if necessary.
241 current_row = index.row()
242 if current_row != -1:
243 # Select the new row.
244 connection_id, _ok = index.model().data(
245 index.sibling(current_row, 0)).toInt()
247 # Apply new socket location.
248 self.servers[current_row].setSocketData(
249 *self.getSocketData(current_row))
251 def objectAdded(self, row, record):
253 New connection added.
257 def addServer(self, host=None, port=None):
259 Add a new config server.
261 server = http.FreeswitchConfigServer(self)
262 server.setSocketData(host, port)
264 self.servers.append(server)
267 class ConnectionChangeListenerController(BaseController):
269 Mixin class for reacting on connection change.
271 def connectionChange(self, index):
273 Connection change handler.
275 Filters table by a new connection ID and stores last connection ID
278 index_row = index.row()
280 # Get connection_id field value.
281 connection_id, _ok = index.model().data(
282 index.sibling(index.row(), 0)).toInt()
283 self.connection_id = connection_id
285 # Filter is customizable in order to allow ugly hacks :-)
286 self.model.setFilter(self.getFilter(connection_id))
289 self.view_list.selectRow(0)
291 # Create a new object if none exist.
292 if not self.model.rowCount():
295 def getFilter(self, connection_id):
296 return 'ipypbxweb_%s.connection_id = %i' % (
297 self.basename, connection_id)
299 def objectAdded(self, row, record):
301 Set connection_id from currently selected connection.
303 record.setValue('connection_id', self.connection_id)
306 class SipProfileController(ConnectionChangeListenerController):
308 SIP Profile controller.
311 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
312 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
313 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
314 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External RTP IP'),
315 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External SIP IP'),
316 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'RTP IP'),
317 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP IP'),
318 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Port'),
319 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Accept Blind Registration'),
320 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
321 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
322 view_list_fields = 'Name', 'SIP IP', 'SIP Port'
325 class DomainController(ConnectionChangeListenerController):
330 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
331 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
332 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
333 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Host Name'),
334 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
335 view_list_fields = 'SIP Profile ID', 'Host Name'
336 relations = (('sip_profile_id', 'SIP Profile ID', 'sipprofile', 'name'),)
339 class GatewayController(ConnectionChangeListenerController):
344 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
345 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
346 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
347 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
348 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Username'),
349 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
350 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Realm'),
351 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'From Domain'),
352 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Extension'),
353 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Expire In Seconds'),
354 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Retry In Seconds'),
355 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Caller ID In From Field'),
356 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
357 view_list_fields = 'SIP Profile ID', 'Name'
358 relations = (('sip_profile_id', 'SIP Profile ID', 'sipprofile', 'name'),)
361 class EndpointController(ConnectionChangeListenerController):
366 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
367 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
368 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'User ID'),
369 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
370 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
371 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
372 view_list_fields = 'User ID', 'Domain ID'
373 relations = (('domain_id', 'Domain ID', 'domain', 'host_name'),)
376 class ExtensionController(ConnectionChangeListenerController):
378 Extension controller.
381 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
382 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
383 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Destination Match'),
384 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'XML Dialplan'),
385 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
386 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Endpoint ID'),
387 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
388 QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
389 view_list_fields = 'Destination Match',
390 view_display_fields_hidden = 'ID', 'Connection ID', 'Endpoint ID'
392 ('domain_id', 'Domain ID', 'domain', 'host_name'),
393 # ('endpoint_id', 'Endpoint ID', 'endpoint', 'user_id'),
396 def objectAdded(self, row, record):
398 'xml_dialplan', '<action application="echo" data=""/>')
399 super(ExtensionController, self).objectAdded(row, record)
401 def getFilter(self, connection_id):
402 # Workaround for Qt bug:
403 # http://bugreports.qt.nokia.com/browse/QTBUG-8217 . Apparently they
404 # don't hurry to fix it.
405 return '1 = 1) or (ipypbxweb_%s.connection_id = %i' % (
406 self.basename, connection_id)