Mark headers for translation
[ipypbx] / src / ipypbx / controllers.py
index b0a3fb2..de4674e 100644 (file)
 # You should have received a copy of the GNU General Public License
 # along with IPyPBX.  If not, see <http://www.gnu.org/licenses/>.
 
-from ipypbx import models, state
+from PyQt4 import QtCore, QtGui, QtSql
 
 
-class BaseHandler(object):
+class BaseController(QtCore.QObject):
     """
-    Base class for various entity handlers.
+    Base class for other controllers.
 
     Doesn't do anything useful on its own.
     """
-    items = None
-    current_items = None
+    # TODO: possibly use a separate class for options and a meta-class.
+    fields = ()
+    view_list_fields = ()
+    view_display_fields = ()
+    view_display_fields_hidden = 'ID', 'Connection ID'
+    is_bound_to_connection = True
+    
+    def __init__(self, model=None, view_list=None, view_display=None, parent=None, views=None):
+        super(BaseController, self).__init__(parent=parent)
 
-    def __init__(self, parent):
-        self.parent = parent
-        self.initState()
+        self.views = views
+        
+        # Find out base name.
+        classname = self.__class__.__name__
+        self.basename = (
+            classname[:-10] if classname.endswith('Controller')
+            else classname)
+        self.basename = self.basename[0].lower() + self.basename[1:]
 
-    def initState(self):
-        return NotImplemented
+        # Are we given an existing model?
+        if model:
+            self.model = model
+        # Otherwise initialize a new model.
+        else:
+            self.model = QtSql.QSqlTableModel(parent)
+            self.model.setTable('ipypbxweb_%s' % self.basename.lower())
 
+            # Create model header from fields list.
+            for i, field in enumerate(self.fields):
+                self.model.setHeaderData(
+                    i, QtCore.Qt.Horizontal,
+                    QtCore.QVariant(QtGui.QApplication.translate(
+                        "MainWindow", field, None,
+                        QtGui.QApplication.UnicodeUTF8)))
 
-class ConnectionsHandler(BaseHandler):
-    """
-    Connections handler.
-    """
-    def initState(self):
-        self.connections = list(state.store.query(models.Connection))
-        self.currentConnection = None
+            # Fetch model data.
+            self.model.select()
+
+        # Are we given an existing view list?
+        if view_list:
+            self.view_list = view_list
+        # Otherwise get view list from the parent.            
+        else:
+            self.view_list = getattr(views, self.basename + 'ViewList')
+            self.view_list.setModel(self.model)
+
+            # Hide fields not meant for display.
+            for i, field in enumerate(self.fields):
+                if field not in self.view_list_fields:
+                    self.view_list.hideColumn(i)
+
+            # Stretch headers to fill all available width.
+            self.view_list.setSelectionMode(QtGui.QTableView.SingleSelection)
+            self.view_list.setSelectionBehavior(QtGui.QTableView.SelectRows)
+            self.view_list.resizeColumnsToContents()
+            self.view_list.resizeRowsToContents()
+            self.view_list.horizontalHeader().setStretchLastSection(True)
 
-        for connection in self.connections:
-            self.parent.ui.connectionList.addItem(connection.name)
+        # Select first row.
+        self.view_list.selectRow(0)
+
+        # Are we given an existing view display?
+        if view_display:
+            self.view_display = view_display
+        # Otherwise get view display from the parent.
+        else:
+            self.view_display = QtGui.QDataWidgetMapper(parent)
+            self.view_display.setModel(self.model)
+
+            # If view_display_fields is not send, display all fields except
+            # the first one that is usually the ID.
+            display_fields = [
+                field for field in self.fields if not field in
+                self.view_display_fields_hidden]
+            
+            for i, field in enumerate(self.fields):
+                if field in display_fields:
+                    field_widget = self.getFieldWidget(field)
+                    self.view_display.addMapping(field_widget, i)
+
+        # Select first row in the view list.
+        self.view_display.toFirst()
         
-    def select(self, index):
+        # Register signals for this controller.
+        for data in self.getSignalsData():
+            if len(data) == 3:
+                sender, signal, receiver = data
+                QtCore.QObject.connect(sender, QtCore.SIGNAL(signal), receiver)
+            elif len(data) == 4:
+                sender, signal, receiver, slot = data
+                QtCore.QObject.connect(
+                    sender, QtCore.SIGNAL(signal), receiver, QtCore.SLOT(slot))
+                                       
+    def getFieldWidget(self, field):
         """
-        Select another connection as current.
+        Return widget for given field name.
         """
-        self.currentConnection = state.connections[index]
+        return getattr(
+            self.views,
+            self.basename + ''.join(word.capitalize()
+                                    for word in field.split(' ')))
 
-    def clone(self):
+    def getSignalsData(self):
         """
-        TODO: Clone an existing connection.
-
-        This creates a new connection with bound data copied from another one.
+        Default signals built from controller's base name.
         """
+        # Default signals handle row selection, Add and Save buttons.
+        return (
+            (getattr(self.views, self.basename + 'Add'), 'clicked()', self.add),
+            (self.view_list.selectionModel(),
+             'currentRowChanged(QModelIndex,QModelIndex)',
+             self.view_display, 'setCurrentModelIndex(QModelIndex)'),
+            (getattr(self.views, self.basename + 'Save'), 'clicked()',
+             self.save),
+            )
 
     def add(self):
         """
-        Add new connection.
+        Add new object.
         """
-        self.currentConnection = None
-
-        name_template = 'New connection [{0:02}]'
-        for i in xrange(1, 100):
-            name = name_template.format(i)
-            connection_exists = False
-            for connection in self.connections:
-                if connection.name == name:
-                    connection_exists = True
-                    break
-
-            if not connection_exists:
-                break
-            
-        self.parent.ui.connectionName.setText(name)
-        self.parent.ui.connectionName.setFocus()
-        self.parent.ui.connectionName.selectAll()
-        self.parent.ui.connectionLocalIpAddress.clear()
-        self.parent.ui.connectionLocalPort.clear()
-        self.parent.ui.connectionFreeswitchIpAddress.clear()
-        self.parent.ui.connectionFreeswitchPort.clear()
+        # Add a new row to list view.
+        num_rows = self.model.rowCount()
+        self.model.insertRows(num_rows, 1)
+        self.view_list.selectRow(num_rows)
 
+        # Disable adding more than one row.
+        self.getFieldWidget('Add').setEnabled(False)
+
+        # Focust to the first displayed field.
+        self.getFieldWidget(self.getDisplayFields()[0]).setFocus()
+
+        # Clear all displayed fields.
+        for field in self.getDisplayFields():
+            if hasattr(field, 'clear'):
+                self.getFieldWidget(field).clear()
+        
     def save(self):
         """
-        Save new or existing connection.
+        Save to database.
         """
-        name = unicode(self.parent.ui.connectionName.text())
-
-        # Add to connection list if we've created it.
-        if self.currentConnection is None:            
-            self.currentConnection = models.Connection(store=state.store)            
-            self.connections.append(self.currentConnection)
-            self.parent.ui.connectionList.addItem(name)
-
-        self.currentConnection.name = name
-        self.currentConnection.local_ip_address = unicode(
-            self.parent.ui.connectionLocalIpAddress.text())
-        self.currentConnection.local_port = int(
-            self.parent.ui.connectionLocalPort.text())
-        self.currentConnection.freeswitch_ip_address = unicode(
-            self.parent.ui.connectionFreeswitchIpAddress.text())
-        self.currentConnection.freeswitch_port = int(
-            self.parent.ui.connectionFreeswitchPort.text())
-
-        self.currentConnection.checkpoint()
+        # For now we just submit everything - QT seems to be able to handle it
+        # on its own.
+        self.view_display.submit()
+        self.getFieldWidget('Add').setEnabled(True)
+
+    def update(self):
+        pass
+
+
+class ConnectionController(BaseController):
+    """
+    Connections controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local IP Address'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Local Port'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch IP Address'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Freeswitch Port'))
+    view_list_fields = 'Name', 'Freeswitch IP Address', 'Freeswitch Port'
+    
+    def clone(self):
+        """
+        TODO: Clone an existing connection.
+
+        This creates a new connection with bound data copied from another one.
+        """
+
+    
+class SipProfileController(BaseController):
+    """
+    SIP Profile controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External RTP IP'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'External SIP IP'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'RTP IP'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP IP'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Port'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Accept Blind Registration'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
+    view_list_fields = 'Name', 'SIP IP', 'SIP Port'
+    
+
+class DomainController(BaseController):
+    """
+    Domain controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Host Name'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
+    view_list_fields = 'SIP Profile ID', 'Host Name', 'Is Active'
+
+
+class GatewayController(BaseController):
+    """
+    Gateway controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'SIP Profile ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Name'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Username'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Realm'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'From Domain'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Expire In Seconds'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Retry In Seconds'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Caller ID In From Field'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
+    view_list_fields = 'SIP Profile ID', 'Name'
+
+
+class EndpointController(BaseController):
+    """
+    Endpoint controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'User ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Password'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
+    view_list_fields = 'User ID', 'Password', 'Domain ID'
+    
+
+class ExtensionController(BaseController):
+    """
+    Extension controller.
+    """
+    fields = (
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Connection ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Destination Match'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'XML Dialplan'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Domain ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Endpoint ID'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Authenticate Calls'),
+        QtCore.QT_TRANSLATE_NOOP('MainWindow', 'Is Active'))
+    view_list_fields = 'Destination Match', 'Domain ID', 'Endpoint ID'
+