git.maemo.org Git - ipypbx/blob - src/ipypbx/controllers.py

   1 # Copyright (c) Stas Shtin, 2010
   2
   3 # This file is part of IPyPBX.
   4
   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.
   9
  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.
  14
  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/>.
  17
  18 from PyQt4 import QtCore, QtGui, QtSql
  19
  20
  21 class BaseController(QtCore.QObject):
  22     """
  23     Base class for other controllers.
  24
  25     Doesn't do anything useful on its own.
  26     """
  27     # TODO: possibly use a separate class for options and a meta-class.
  28     fields = ()
  29     view_list_fields = ()
  30     view_display_fields = ()
  31     view_display_fields_hidden = 'ID', 'Connection ID'
  32     is_bound_to_connection = True
  33
  34     def __init__(self, model=None, view_list=None, view_display=None, parent=None, views=None):
  35         super(BaseController, self).__init__(parent=parent)
  36
  37         self.views = views
  38
  39         # Find out base name.
  40         classname = self.__class__.__name__
  41         self.basename = (
  42             classname[:-10] if classname.endswith('Controller')
  43             else classname)
  44         self.basename = self.basename[0].lower() + self.basename[1:]
  45
  46         # Are we given an existing model?
  47         if model:
  48             self.model = model
  49         # Otherwise initialize a new model.
  50         else:
  51             self.model = QtSql.QSqlTableModel(parent)
  52             self.model.setTable('ipypbxweb_%s' % self.basename.lower())
  53
  54             # Create model header from fields list.
  55             for i, field in enumerate(self.fields):
  56                 self.model.setHeaderData(
  57                     i, QtCore.Qt.Horizontal,
  58                     QtCore.QVariant(QtGui.QApplication.translate(
  59                         "MainWindow", field, None,
  60                         QtGui.QApplication.UnicodeUTF8)))
  61
  62             # Fetch model data.
  63             self.model.select()
  64
  65         # Are we given an existing view list?
  66         if view_list:
  67             self.view_list = view_list
  68         # Otherwise get view list from the parent.
  69         else:
  70             self.view_list = getattr(views, self.basename + 'ViewList')
  71             self.view_list.setModel(self.model)
  72
  73             # Hide fields not meant for display.
  74             for i, field in enumerate(self.fields):
  75                 if field not in self.view_list_fields:
  76                     self.view_list.hideColumn(i)
  77
  78             # Stretch headers to fill all available width.
  79             self.view_list.setSelectionMode(QtGui.QTableView.SingleSelection)
  80             self.view_list.setSelectionBehavior(QtGui.QTableView.SelectRows)
  81             self.view_list.resizeColumnsToContents()
  82             self.view_list.resizeRowsToContents()
  83             self.view_list.horizontalHeader().setStretchLastSection(True)
  84
  85         # Select first row.
  86         self.view_list.selectRow(0)
  87
  88         # Are we given an existing view display?
  89         if view_display:
  90             self.view_display = view_display
  91         # Otherwise get view display from the parent.
  92         else:
  93             self.view_display = QtGui.QDataWidgetMapper(parent)
  94             self.view_display.setModel(self.model)
  95
  96             # If view_display_fields is not send, display all fields except
  97             # the first one that is usually the ID.
  98             display_fields = [
  99                 field for field in self.fields if not field in
 100                 self.view_display_fields_hidden]
 101
 102             for i, field in enumerate(self.fields):
 103                 if field in display_fields:
 104                     field_widget = self.getFieldWidget(field)
 105                     self.view_display.addMapping(field_widget, i)
 106
 107         # Select first row in the view list.
 108         self.view_display.toFirst()
 109
 110         # Register signals for this controller.
 111         for data in self.getSignalsData():
 112             if len(data) == 3:
 113                 sender, signal, receiver = data
 114                 QtCore.QObject.connect(sender, QtCore.SIGNAL(signal), receiver)
 115             elif len(data) == 4:
 116                 sender, signal, receiver, slot = data
 117                 QtCore.QObject.connect(
 118                     sender, QtCore.SIGNAL(signal), receiver, QtCore.SLOT(slot))
 119
 120     def getFieldWidget(self, field):
 121         """
 122         Return widget for given field name.
 123         """
 124         return getattr(
 125             self.views,
 126             self.basename + ''.join(word.capitalize()
 127                                     for word in field.split(' ')))
 128
 129     def getSignalsData(self):
 130         """
 131         Default signals built from controller's base name.
 132         """
 133         # Default signals handle row selection, Add and Save buttons.
 134         return (
 135             (getattr(self.views, self.basename + 'Add'), 'clicked()', self.add),
 136             (self.view_list.selectionModel(),
 137              'currentRowChanged(QModelIndex,QModelIndex)',
 138              self.view_display, 'setCurrentModelIndex(QModelIndex)'),
 139             (getattr(self.views, self.basename + 'Save'), 'clicked()',
 140              self.save),
 141             )
 142
 143     def add(self):
 144         """
 145         Add new object.
 146         """
 147         # Add a new row to list view.
 148         num_rows = self.model.rowCount()
 149         self.model.insertRows(num_rows, 1)
 150         self.view_list.selectRow(num_rows)
 151
 152         # Disable adding more than one row.
 153         self.getFieldWidget('Add').setEnabled(False)
 154
 155         # Focust to the first displayed field.
 156         self.getFieldWidget(self.getDisplayFields()[0]).setFocus()
 157
 158         # Clear all displayed fields.
 159         for field in self.getDisplayFields():
 160             if hasattr(field, 'clear'):
 161                 self.getFieldWidget(field).clear()
 162
 163     def save(self):
 164         """
 165         Save to database.
 166         """
 167         # For now we just submit everything - QT seems to be able to handle it
 168         # on its own.
 169         self.view_display.submit()
 170         self.getFieldWidget('Add').setEnabled(True)
 171
 172     def update(self):
 173         pass
 174
 175
 176 class ConnectionController(BaseController):
 177     """
 178     Connections controller.
 179     """
 180     fields = (
 181         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 182         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
 183         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local IP Address'),
 184         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local Port'),
 185         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch IP Address'),
 186         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch Port'))
 187     view_list_fields = 'Name', 'Freeswitch IP Address', 'Freeswitch Port'
 188
 189     def clone(self):
 190         """
 191         TODO: Clone an existing connection.
 192
 193         This creates a new connection with bound data copied from another one.
 194         """
 195
 196
 197 class SipProfileController(BaseController):
 198     """
 199     SIP Profile controller.
 200     """
 201     fields = (
 202         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 203         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
 204         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
 205         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External RTP IP'),
 206         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External SIP IP'),
 207         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'RTP IP'),
 208         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP IP'),
 209         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Port'),
 210         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Accept Blind Registration'),
 211         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
 212         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
 213     view_list_fields = 'Name', 'SIP IP', 'SIP Port'
 214
 215
 216 class DomainController(BaseController):
 217     """
 218     Domain controller.
 219     """
 220     fields = (
 221         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 222         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
 223         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
 224         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Host Name'),
 225         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
 226     view_list_fields = 'SIP Profile ID', 'Host Name', 'Is Active'
 227
 228
 229 class GatewayController(BaseController):
 230     """
 231     Gateway controller.
 232     """
 233     fields = (
 234         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 235         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
 236         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
 237         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
 238         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Username'),
 239         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
 240         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Realm'),
 241         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'From Domain'),
 242         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Expire In Seconds'),
 243         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Retry In Seconds'),
 244         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Caller ID In From Field'),
 245         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
 246     view_list_fields = 'SIP Profile ID', 'Name'
 247
 248
 249 class EndpointController(BaseController):
 250     """
 251     Endpoint controller.
 252     """
 253     fields = (
 254         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 255         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
 256         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'User ID'),
 257         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
 258         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
 259         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
 260     view_list_fields = 'User ID', 'Password', 'Domain ID'
 261
 262
 263 class ExtensionController(BaseController):
 264     """
 265     Extension controller.
 266     """
 267     fields = (
 268         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
 269         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
 270         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Destination Match'),
 271         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'XML Dialplan'),
 272         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
 273         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Endpoint ID'),
 274         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
 275         QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
 276     view_list_fields = 'Destination Match', 'Domain ID', 'Endpoint ID'
 277