summaryrefslogtreecommitdiff
path: root/src/leap/bitmask/gui/statuspanel.py
diff options
context:
space:
mode:
authorTomás Touceda <chiiph@leap.se>2013-10-04 12:09:58 -0300
committerTomás Touceda <chiiph@leap.se>2013-10-04 12:09:58 -0300
commit584866689560bd2ebea01ecc5e6ae5e79ce7fc81 (patch)
tree4fe300c3c105e17721f79eeece9bbd3745b43d78 /src/leap/bitmask/gui/statuspanel.py
parent1f0f8efc4cb985c082b3b8fe7b3dc45aed047a47 (diff)
parent759d73ae0728f074e0fb0740269249d0e5066574 (diff)
Merge branch 'release-0.3.4'0.3.4
Diffstat (limited to 'src/leap/bitmask/gui/statuspanel.py')
-rw-r--r--src/leap/bitmask/gui/statuspanel.py710
1 files changed, 0 insertions, 710 deletions
diff --git a/src/leap/bitmask/gui/statuspanel.py b/src/leap/bitmask/gui/statuspanel.py
deleted file mode 100644
index 679f00b1..00000000
--- a/src/leap/bitmask/gui/statuspanel.py
+++ /dev/null
@@ -1,710 +0,0 @@
-# -*- 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 datetime import datetime
-from functools import partial
-
-from PySide import QtCore, QtGui
-
-from leap.bitmask.services.eip.connection import EIPConnection
-from leap.bitmask.services.eip.vpnprocess import VPNManager
-from leap.bitmask.platform_init import IS_WIN, IS_LINUX
-from leap.bitmask.util.averages import RateMovingAverage
-from leap.common.check import leap_assert, leap_assert_type
-from leap.common.events import register
-from leap.common.events import events_pb2 as proto
-
-from ui_statuspanel import Ui_StatusPanel
-
-logger = logging.getLogger(__name__)
-
-
-class StatusPanelWidget(QtGui.QWidget):
- """
- Status widget that displays the current state of the LEAP services
- """
- DISPLAY_TRAFFIC_RATES = True
- RATE_STR = "%14.2f KB/s"
- TOTAL_STR = "%14.2f Kb"
-
- MAIL_OFF_ICON = ":/images/mail-unlocked.png"
- MAIL_ON_ICON = ":/images/mail-locked.png"
-
- eip_connection_connected = QtCore.Signal()
- _soledad_event = QtCore.Signal(object)
- _smtp_event = QtCore.Signal(object)
- _imap_event = QtCore.Signal(object)
- _keymanager_event = QtCore.Signal(object)
-
- def __init__(self, parent=None):
- QtGui.QWidget.__init__(self, parent)
-
- self._systray = None
- self._eip_status_menu = None
-
- self.ui = Ui_StatusPanel()
- self.ui.setupUi(self)
-
- self.eipconnection = EIPConnection()
-
- self.hide_status_box()
-
- # set systray tooltip statuses
- self._eip_status = self._mx_status = ""
-
- # Set the EIP status icons
- self.CONNECTING_ICON = None
- self.CONNECTED_ICON = None
- self.ERROR_ICON = None
- self.CONNECTING_ICON_TRAY = None
- self.CONNECTED_ICON_TRAY = None
- self.ERROR_ICON_TRAY = None
- self._set_eip_icons()
-
- self._set_traffic_rates()
- self._make_status_clickable()
-
- register(signal=proto.KEYMANAGER_LOOKING_FOR_KEY,
- callback=self._mail_handle_keymanager_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.KEYMANAGER_KEY_FOUND,
- callback=self._mail_handle_keymanager_events,
- reqcbk=lambda req, resp: None)
-
- # register(signal=proto.KEYMANAGER_KEY_NOT_FOUND,
- # callback=self._mail_handle_keymanager_events,
- # reqcbk=lambda req, resp: None)
-
- register(signal=proto.KEYMANAGER_STARTED_KEY_GENERATION,
- callback=self._mail_handle_keymanager_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.KEYMANAGER_FINISHED_KEY_GENERATION,
- callback=self._mail_handle_keymanager_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.KEYMANAGER_DONE_UPLOADING_KEYS,
- callback=self._mail_handle_keymanager_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.SOLEDAD_DONE_DOWNLOADING_KEYS,
- callback=self._mail_handle_soledad_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.SOLEDAD_DONE_UPLOADING_KEYS,
- callback=self._mail_handle_soledad_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.SMTP_SERVICE_STARTED,
- callback=self._mail_handle_smtp_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.SMTP_SERVICE_FAILED_TO_START,
- callback=self._mail_handle_smtp_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.IMAP_SERVICE_STARTED,
- callback=self._mail_handle_imap_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.IMAP_SERVICE_FAILED_TO_START,
- callback=self._mail_handle_imap_events,
- reqcbk=lambda req, resp: None)
-
- register(signal=proto.IMAP_UNREAD_MAIL,
- callback=self._mail_handle_imap_events,
- reqcbk=lambda req, resp: None)
-
- self._set_long_mail_status("")
- self.ui.lblUnread.setVisible(False)
-
- self._smtp_started = False
- self._imap_started = False
-
- self._soledad_event.connect(
- self._mail_handle_soledad_events_slot)
- self._imap_event.connect(
- self._mail_handle_imap_events_slot)
- self._smtp_event.connect(
- self._mail_handle_smtp_events_slot)
- self._keymanager_event.connect(
- self._mail_handle_keymanager_events_slot)
-
- def _make_status_clickable(self):
- """
- Makes upload and download figures clickable.
- """
- onclicked = self._on_VPN_status_clicked
- self.ui.btnUpload.clicked.connect(onclicked)
- self.ui.btnDownload.clicked.connect(onclicked)
-
- def _on_VPN_status_clicked(self):
- """
- SLOT
- TRIGGER: self.ui.btnUpload.clicked
- self.ui.btnDownload.clicked
-
- Toggles between rate and total throughput display for vpn
- status figures.
- """
- self.DISPLAY_TRAFFIC_RATES = not self.DISPLAY_TRAFFIC_RATES
- self.update_vpn_status(None) # refresh
-
- def _set_traffic_rates(self):
- """
- Initializes up and download rates.
- """
- self._up_rate = RateMovingAverage()
- self._down_rate = RateMovingAverage()
-
- self.ui.btnUpload.setText(self.RATE_STR % (0,))
- self.ui.btnDownload.setText(self.RATE_STR % (0,))
-
- def _reset_traffic_rates(self):
- """
- Resets up and download rates, and cleans up the labels.
- """
- self._up_rate.reset()
- self._down_rate.reset()
- self.update_vpn_status(None)
-
- def _update_traffic_rates(self, up, down):
- """
- Updates up and download rates.
-
- :param up: upload total.
- :type up: int
- :param down: download total.
- :type down: int
- """
- ts = datetime.now()
- self._up_rate.append((ts, up))
- self._down_rate.append((ts, down))
-
- def _get_traffic_rates(self):
- """
- Gets the traffic rates (in KB/s).
-
- :returns: a tuple with the (up, down) rates
- :rtype: tuple
- """
- up = self._up_rate
- down = self._down_rate
-
- return (up.get_average(), down.get_average())
-
- def _get_traffic_totals(self):
- """
- Gets the traffic total throughput (in Kb).
-
- :returns: a tuple with the (up, down) totals
- :rtype: tuple
- """
- up = self._up_rate
- down = self._down_rate
-
- return (up.get_total(), down.get_total())
-
- def _set_eip_icons(self):
- """
- Sets the EIP status icons for the main window and for the tray
-
- MAC : dark icons
- LINUX : dark icons in window, light icons in tray
- WIN : light icons
- """
- EIP_ICONS = EIP_ICONS_TRAY = (
- ":/images/conn_connecting-light.png",
- ":/images/conn_connected-light.png",
- ":/images/conn_error-light.png")
-
- if IS_LINUX:
- EIP_ICONS_TRAY = (
- ":/images/conn_connecting.png",
- ":/images/conn_connected.png",
- ":/images/conn_error.png")
- elif IS_WIN:
- EIP_ICONS = EIP_ICONS_TRAY = (
- ":/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])
-
- self.CONNECTING_ICON_TRAY = QtGui.QPixmap(EIP_ICONS_TRAY[0])
- self.CONNECTED_ICON_TRAY = QtGui.QPixmap(EIP_ICONS_TRAY[1])
- self.ERROR_ICON_TRAY = QtGui.QPixmap(EIP_ICONS_TRAY[2])
-
- # Systray and actions
-
- 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
- self._systray.setToolTip(self.tr("All services are OFF"))
-
- def _update_systray_tooltip(self):
- """
- Updates the system tray icon tooltip using the eip and mx statuses.
- """
- status = self.tr("Encrypted Internet is {0}").format(self._eip_status)
- status += '\n'
- status += self.tr("Mail is {0}").format(self._mx_status)
- self._systray.setToolTip(status)
-
- def set_action_eip_startstop(self, action_eip_startstop):
- """
- Sets the action_eip_startstop to use.
-
- :param action_eip_startstop: action_eip_status to be used
- :type action_eip_startstop: QtGui.QAction
- """
- self._action_eip_startstop = action_eip_startstop
-
- def set_eip_status_menu(self, eip_status_menu):
- """
- Sets the eip_status_menu to use.
-
- :param eip_status_menu: eip_status_menu to be used
- :type eip_status_menu: QtGui.QMenu
- """
- leap_assert_type(eip_status_menu, QtGui.QMenu)
- self._eip_status_menu = eip_status_menu
-
- def set_action_mail_status(self, action_mail_status):
- """
- Sets the action_mail_status to use.
-
- :param action_mail_status: action_mail_status to be used
- :type action_mail_status: QtGui.QAction
- """
- leap_assert_type(action_mail_status, QtGui.QAction)
- self._action_mail_status = action_mail_status
-
- def set_global_status(self, status, error=False):
- """
- Sets the global status label.
-
- :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)
- if error:
- status = "<font color='red'><b>%s</b></font>" % (status,)
- self.ui.lblGlobalStatus.setText(status)
- self.ui.globalStatusBox.show()
-
- def hide_status_box(self):
- """
- Hide global status box.
- """
- self.ui.globalStatusBox.hide()
-
- # EIP status ---
-
- @property
- def eip_button(self):
- return self.ui.btnEipStartStop
-
- @property
- def eip_label(self):
- return self.ui.lblEIPStatus
-
- def eip_pre_up(self):
- """
- Triggered when the app activates eip.
- Hides the status box and disables the start/stop button.
- """
- self.hide_status_box()
- self.set_startstop_enabled(False)
-
- # XXX disable (later) --------------------------
- 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._eip_status = status
-
- if error:
- status = "<font color='red'>%s</font>" % (status,)
- self.ui.lblEIPStatus.setText(status)
- self._update_systray_tooltip()
-
- # XXX disable ---------------------------------
- def set_startstop_enabled(self, value):
- """
- Enable or disable btnEipStartStop and _action_eip_startstop
- based on value
-
- :param value: True for enabled, False otherwise
- :type value: bool
- """
- leap_assert_type(value, bool)
- self.ui.btnEipStartStop.setEnabled(value)
- self._action_eip_startstop.setEnabled(value)
-
- # XXX disable -----------------------------
- 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.eipconnection.qtsigs.do_connect_signal)
-
- # XXX disable -----------------------------
- def eip_stopped(self):
- """
- Sets the state of the widget to how it should look after EIP
- has stopped
- """
- # XXX should connect this to EIPConnection.disconnected_signal
- self._reset_traffic_rates()
- # XXX disable -----------------------------
- self.ui.btnEipStartStop.setText(self.tr("Turn ON"))
- self.ui.btnEipStartStop.disconnect(self)
- self.ui.btnEipStartStop.clicked.connect(
- self.eipconnection.qtsigs.do_disconnect_signal)
-
- 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.
-
- :param data: a dictionary with the tcp/udp write and read totals.
- If data is None, we just will refresh the display based
- on the previous data.
- :type data: dict
- """
- if data:
- upload = float(data[VPNManager.TCPUDP_WRITE_KEY] or "0")
- download = float(data[VPNManager.TCPUDP_READ_KEY] or "0")
- self._update_traffic_rates(upload, download)
-
- if self.DISPLAY_TRAFFIC_RATES:
- uprate, downrate = self._get_traffic_rates()
- upload_str = self.RATE_STR % (uprate,)
- download_str = self.RATE_STR % (downrate,)
-
- else: # display total throughput
- uptotal, downtotal = self._get_traffic_totals()
- upload_str = self.TOTAL_STR % (uptotal,)
- download_str = self.TOTAL_STR % (downtotal,)
-
- self.ui.btnUpload.setText(upload_str)
- self.ui.btnDownload.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.
-
- Emits:
- If the status is connected, we emit EIPConnection.qtsigs.
- connected_signal
- """
- status = data[VPNManager.STATUS_STEP_KEY]
- self.set_eip_status_icon(status)
- if status == "CONNECTED":
- # XXX should be handled by the state machine too.
- self.set_eip_status(self.tr("ON"))
- logger.debug("STATUS IS CONNECTED --- emitting signal")
- self.eip_connection_connected.emit()
-
- # XXX should lookup status map in EIPConnection
- elif status == "AUTH":
- self.set_eip_status(self.tr("Authenticating..."))
- elif status == "GET_CONFIG":
- self.set_eip_status(self.tr("Retrieving configuration..."))
- 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 == "RECONNECTING":
- self.set_eip_status(self.tr("Reconnecting..."))
- elif status == "ALREADYRUNNING":
- # Put the following calls in Qt's event queue, otherwise
- # the UI won't update properly
- QtCore.QTimer.singleShot(
- 0, self.eipconnection.qtsigs.do_disconnect_signal)
- QtCore.QTimer.singleShot(0, partial(self.set_global_status,
- self.tr("Unable to start VPN, "
- "it's already "
- "running.")))
- else:
- self.set_eip_status(status)
-
- def set_eip_icon(self, icon):
- """
- Sets the icon to display for EIP
-
- :param icon: icon to display
- :type icon: QPixmap
- """
- self.ui.lblVPNStatusIcon.setPixmap(icon)
-
- 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
- selected_pixmap_tray = self.ERROR_ICON_TRAY
- tray_message = self.tr("Encrypted Internet is OFF")
- if status in ("WAIT", "AUTH", "GET_CONFIG",
- "RECONNECTING", "ASSIGN_IP"):
- selected_pixmap = self.CONNECTING_ICON
- selected_pixmap_tray = self.CONNECTING_ICON_TRAY
- tray_message = self.tr("Encrypted Internet is STARTING")
- elif status in ("CONNECTED"):
- tray_message = self.tr("Encrypted Internet is ON")
- selected_pixmap = self.CONNECTED_ICON
- selected_pixmap_tray = self.CONNECTED_ICON_TRAY
-
- self.set_eip_icon(selected_pixmap)
- self._systray.setIcon(QtGui.QIcon(selected_pixmap_tray))
- self._eip_status_menu.setTitle(tray_message)
-
- def set_provider(self, provider):
- self.ui.lblProvider.setText(provider)
-
- #
- # mail methods
- #
-
- def _set_mail_status(self, status, ready=False):
- """
- Sets the Mail status in the label and in the tray icon.
-
- :param status: the status text to display
- :type status: unicode
- :param ready: if mx is ready or not.
- :type ready: bool
- """
- self.ui.lblMailStatus.setText(status)
-
- self._mx_status = self.tr('OFF')
- tray_status = self.tr('Mail is OFF')
-
- icon = QtGui.QPixmap(self.MAIL_OFF_ICON)
- if ready:
- icon = QtGui.QPixmap(self.MAIL_ON_ICON)
- self._mx_status = self.tr('ON')
- tray_status = self.tr('Mail is ON')
-
- self.ui.lblMailIcon.setPixmap(icon)
- self._action_mail_status.setText(tray_status)
- self._update_systray_tooltip()
-
- def _mail_handle_soledad_events(self, req):
- """
- Callback for ...
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- self._soledad_event.emit(req)
-
- def _mail_handle_soledad_events_slot(self, req):
- """
- SLOT
- TRIGGER: _mail_handle_soledad_events
-
- Reacts to an Soledad event
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- self._set_mail_status(self.tr("Starting..."))
-
- ext_status = ""
-
- if req.event == proto.SOLEDAD_DONE_UPLOADING_KEYS:
- ext_status = self.tr("Soledad has started...")
- elif req.event == proto.SOLEDAD_DONE_DOWNLOADING_KEYS:
- ext_status = self.tr("Soledad is starting, please wait...")
- else:
- leap_assert(False,
- "Don't know how to handle this state: %s"
- % (req.event))
-
- self._set_long_mail_status(ext_status)
-
- def _mail_handle_keymanager_events(self, req):
- """
- Callback for the KeyManager events
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- self._keymanager_event.emit(req)
-
- def _mail_handle_keymanager_events_slot(self, req):
- """
- SLOT
- TRIGGER: _mail_handle_keymanager_events
-
- Reacts to an KeyManager event
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- # We want to ignore this kind of events once everything has
- # started
- if self._smtp_started and self._imap_started:
- return
-
- self._set_mail_status(self.tr("Starting..."))
-
- ext_status = ""
-
- if req.event == proto.KEYMANAGER_LOOKING_FOR_KEY:
- ext_status = self.tr("Looking for key for this user")
- elif req.event == proto.KEYMANAGER_KEY_FOUND:
- ext_status = self.tr("Found key! Starting mail...")
- # elif req.event == proto.KEYMANAGER_KEY_NOT_FOUND:
- # ext_status = self.tr("Key not found!")
- elif req.event == proto.KEYMANAGER_STARTED_KEY_GENERATION:
- ext_status = self.tr("Generating new key, please wait...")
- elif req.event == proto.KEYMANAGER_FINISHED_KEY_GENERATION:
- ext_status = self.tr("Finished generating key!")
- elif req.event == proto.KEYMANAGER_DONE_UPLOADING_KEYS:
- ext_status = self.tr("Starting mail...")
- else:
- leap_assert(False,
- "Don't know how to handle this state: %s"
- % (req.event))
-
- self._set_long_mail_status(ext_status)
-
- def _mail_handle_smtp_events(self, req):
- """
- Callback for the SMTP events
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- self._smtp_event.emit(req)
-
- def _mail_handle_smtp_events_slot(self, req):
- """
- SLOT
- TRIGGER: _mail_handle_smtp_events
-
- Reacts to an SMTP event
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- ext_status = ""
-
- if req.event == proto.SMTP_SERVICE_STARTED:
- ext_status = self.tr("SMTP has started...")
- self._smtp_started = True
- if self._smtp_started and self._imap_started:
- self._set_mail_status(self.tr("ON"), ready=True)
- ext_status = ""
- elif req.event == proto.SMTP_SERVICE_FAILED_TO_START:
- ext_status = self.tr("SMTP failed to start, check the logs.")
- self._set_mail_status(self.tr("Failed"))
- else:
- leap_assert(False,
- "Don't know how to handle this state: %s"
- % (req.event))
-
- self._set_long_mail_status(ext_status)
-
- def _mail_handle_imap_events(self, req):
- """
- Callback for the IMAP events
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- self._imap_event.emit(req)
-
- def _mail_handle_imap_events_slot(self, req):
- """
- SLOT
- TRIGGER: _mail_handle_imap_events
-
- Reacts to an IMAP event
-
- :param req: Request type
- :type req: leap.common.events.events_pb2.SignalRequest
- """
- ext_status = None
-
- if req.event == proto.IMAP_SERVICE_STARTED:
- ext_status = self.tr("IMAP has started...")
- self._imap_started = True
- if self._smtp_started and self._imap_started:
- self._set_mail_status(self.tr("ON"), ready=True)
- ext_status = ""
- elif req.event == proto.IMAP_SERVICE_FAILED_TO_START:
- ext_status = self.tr("IMAP failed to start, check the logs.")
- self._set_mail_status(self.tr("Failed"))
- elif req.event == proto.IMAP_UNREAD_MAIL:
- if self._smtp_started and self._imap_started:
- self.ui.lblUnread.setText(
- self.tr("%s Unread Emails") % (req.content))
- self.ui.lblUnread.setVisible(req.content != "0")
- self._set_mail_status(self.tr("ON"), ready=True)
- else:
- leap_assert(False, # XXX ???
- "Don't know how to handle this state: %s"
- % (req.event))
-
- if ext_status is not None:
- self._set_long_mail_status(ext_status)
-
- def _set_long_mail_status(self, ext_status):
- self.ui.lblLongMailStatus.setText(ext_status)
- self.ui.grpMailStatus.setVisible(len(ext_status) > 0)