Refactor the status bits out of the MainWindow to StatusPanelWidget

1 files changed, 216 insertions, 0 deletions

diff --git a/src/leap/gui/statuspanel.py b/src/leap/gui/statuspanel.py
new file mode 100644
index 00000000..53c19e86
--- /dev/null
+++ b/src/leap/gui/statuspanel.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+# statuspanel.py
+# Copyright (C) 2013 LEAP
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Status Panel widget implementation
+"""
+import logging
+
+from functools import partial
+from PySide import QtCore, QtGui
+
+from ui_statuspanel import Ui_StatusPanel
+from leap.services.eip.vpnprocess import VPNManager
+from leap.platform_init import IS_MAC
+from leap.common.check import leap_assert_type
+
+logger = logging.getLogger(__name__)
+
+
+class StatusPanelWidget(QtGui.QWidget):
+    """
+    Status widget that displays the current state of the LEAP services
+    """
+
+    start_eip = QtCore.Signal()
+    stop_eip = QtCore.Signal()
+
+    def __init__(self, parent=None):
+        QtGui.QWidget.__init__(self, parent)
+
+        self._systray = None
+        self._action_eip_status = None
+
+        self.ui = Ui_StatusPanel()
+        self.ui.setupUi(self)
+
+        self.ui.btnEipStartStop.setEnabled(False)
+        self.ui.btnEipStartStop.clicked.connect(
+            self.start_eip)
+
+        if IS_MAC:
+            EIP_ICONS = (
+                ":/images/conn_connecting-light.png",
+                ":/images/conn_connected-light.png",
+                ":/images/conn_error-light.png")
+        else:
+            EIP_ICONS = (
+                ":/images/conn_connecting.png",
+                ":/images/conn_connected.png",
+                ":/images/conn_error.png")
+
+        self.CONNECTING_ICON = QtGui.QPixmap(EIP_ICONS[0])
+        self.CONNECTED_ICON = QtGui.QPixmap(EIP_ICONS[1])
+        self.ERROR_ICON = QtGui.QPixmap(EIP_ICONS[2])
+
+    def set_systray(self, systray):
+        """
+        Sets the systray object to use
+
+        :param systray: Systray object
+        :type systray: QtGui.QSystemTrayIcon
+        """
+        leap_assert_type(systray, QtGui.QSystemTrayIcon)
+        self._systray = systray
+
+    def set_action_eip_status(self, action_eip_status):
+        """
+        Sets the action_eip_status to use
+
+        :param action_eip_status: action_eip_status to be used
+        :type action_eip_status: QtGui.QAction
+        """
+        leap_assert_type(action_eip_status, QtGui.QAction)
+        self._action_eip_status = action_eip_status
+
+    def set_eip_status(self, status, error=False):
+        """
+        Sets the status label at the VPN stage to status
+
+        :param status: status message
+        :type status: str or unicode
+        :param error: if the status is an erroneous one, then set this
+                      to True
+        :type error: bool
+        """
+        leap_assert_type(error, bool)
+
+        self._systray.setToolTip(status)
+        if error:
+            status = "<font color='red'>%s</font>" % (status,)
+        self.ui.lblEIPStatus.setText(status)
+
+    def set_startstop_enabled(self, value):
+        """
+        Enable or disable btnEipStartStop based on value
+
+        :param value: True for enabled, False otherwise
+        :type value: bool
+        """
+        leap_assert_type(value, bool)
+        self.ui.btnEipStartStop.setEnabled(value)
+
+    def eip_started(self):
+        """
+        Sets the state of the widget to how it should look after EIP
+        has started
+        """
+        self.ui.btnEipStartStop.setText(self.tr("Turn OFF"))
+        self.ui.btnEipStartStop.disconnect(self)
+        self.ui.btnEipStartStop.clicked.connect(
+            self.stop_eip)
+
+    def eip_stopped(self):
+        """
+        Sets the state of the widget to how it should look after EIP
+        has stopped
+        """
+        self.ui.btnEipStartStop.setText(self.tr("Turn ON"))
+        self.ui.btnEipStartStop.disconnect(self)
+        self.ui.btnEipStartStop.clicked.connect(
+            self.start_eip)
+
+    def set_icon(self, icon):
+        """
+        Sets the icon to display for EIP
+
+        :param icon: icon to display
+        :type icon: QPixmap
+        """
+        self.ui.lblVPNStatusIcon.setPixmap(icon)
+
+    def update_vpn_status(self, data):
+        """
+        SLOT
+        TRIGGER: VPN.status_changed
+
+        Updates the download/upload labels based on the data provided
+        by the VPN thread
+        """
+        upload = float(data[VPNManager.TUNTAP_WRITE_KEY])
+        upload = upload / 1000.0
+        upload_str = "%12.2f Kb" % (upload,)
+        self.ui.lblUpload.setText(upload_str)
+        download = float(data[VPNManager.TUNTAP_READ_KEY])
+        download = download / 1000.0
+        download_str = "%12.2f Kb" % (download,)
+        self.ui.lblDownload.setText(download_str)
+
+    def update_vpn_state(self, data):
+        """
+        SLOT
+        TRIGGER: VPN.state_changed
+
+        Updates the displayed VPN state based on the data provided by
+        the VPN thread
+        """
+        status = data[VPNManager.STATUS_STEP_KEY]
+        self.set_eip_status_icon(status)
+        if status == "AUTH":
+            self.set_eip_status(self.tr("Authenticating..."))
+        elif status == "GET_CONFIG":
+            self.set_eip_status(self.tr("Retrieving configuration..."))
+        elif status == "CONNECTED":
+            self.set_eip_status(self.tr("On"))
+        elif status == "WAIT":
+            self.set_eip_status(self.tr("Waiting to start..."))
+        elif status == "ASSIGN_IP":
+            self.set_eip_status(self.tr("Assigning IP"))
+        elif status == "ALREADYRUNNING":
+            # Put the following calls in Qt's event queue, otherwise
+            # the UI won't update properly
+            QtCore.QTimer.singleShot(0, self.stop_eip)
+            QtCore.QTimer.singleShot(0, partial(self.set_eip_status,
+                                                self.tr("Unable to start VPN, "
+                                                        "it's already "
+                                                        "running.")))
+        else:
+            self._set_eip_status(status)
+
+    def set_eip_status_icon(self, status):
+        """
+        Given a status step from the VPN thread, set the icon properly
+
+        :param status: status step
+        :type status: str
+        """
+        selected_pixmap = self.ERROR_ICON
+        tray_message = self.tr("Encryption is OFF")
+        if status in ("WAIT", "AUTH", "GET_CONFIG",
+                      "RECONNECTING", "ASSIGN_IP"):
+            selected_pixmap = self.CONNECTING_ICON
+            tray_message = self.tr("Turning ON")
+        elif status in ("CONNECTED"):
+            tray_message = self.tr("Encryption is ON")
+            selected_pixmap = self.CONNECTED_ICON
+
+        self.set_icon(selected_pixmap)
+        self._systray.setIcon(QtGui.QIcon(selected_pixmap))
+        self._action_eip_status.setText(tray_message)
+
+    def set_provider(self, provider):
+        self.ui.lblProvider.setText(provider)