SSID and Quality OK (issue #937)

conf/glances.conf

@@ -111,6 +111,10 @@ critical=90
 #wlan0_tx_critical=1000000
 #wlan0_tx_log=True
 
+#[wifi]
+# Define the list of hidden wireless network interfaces (comma-separated regexp)
+#hide=docker.*,lo
+
 #[diskio]
 # Define the list of hidden disks (comma-separated regexp)
 #hide=sda2,sda5,loop.*

glances/main.py

@@ -113,6 +113,8 @@ Start the client browser (browser mode):\n\
                             dest='disable_load', help='disable load module')
         parser.add_argument('--disable-network', action='store_true', default=False,
                             dest='disable_network', help='disable network module')
+        parser.add_argument('--disable-wifi', action='store_true', default=False,
+                            dest='disable_wifi', help='disable wifi module')
         parser.add_argument('--disable-ports', action='store_true', default=False,
                             dest='disable_ports', help='disable ports scanner module')
         parser.add_argument('--disable-ip', action='store_true', default=False,

glances/outputs/glances_curses.py

@@ -444,6 +444,9 @@ class _GlancesCurses(object):
         elif self.pressedkey == ord('w'):
             # 'w' > Delete finished warning logs
             glances_logs.clean()
+        elif self.pressedkey == ord('W'):
+            # 'W' > Enable/Disable Wifi plugin
+            self.args.disable_wifi = not self.args.disable_wifi
         elif self.pressedkey == ord('x'):
             # 'x' > Delete finished warning and critical logs
             glances_logs.clean(critical=True)
@@ -540,6 +543,8 @@ class _GlancesCurses(object):
         stats_memswap = stats.get_plugin('memswap').get_stats_display(args=self.args)
         stats_network = stats.get_plugin('network').get_stats_display(
             args=self.args, max_width=plugin_max_width)
+        stats_wifi = stats.get_plugin('wifi').get_stats_display(
+            args=self.args, max_width=plugin_max_width)
         stats_irq = stats.get_plugin('irq').get_stats_display(
             args=self.args, max_width=plugin_max_width)
         try:
@@ -718,13 +723,15 @@ class _GlancesCurses(object):
         # ==================================================================
         self.init_column()
         if not (self.args.disable_network and
+                self.args.disable_wifi and
                 self.args.disable_ports and
                 self.args.disable_diskio and
                 self.args.disable_fs and
+                self.args.disable_irq and
                 self.args.disable_folder and
                 self.args.disable_raid and
                 self.args.disable_sensors) and not self.args.disable_left_sidebar:
-            for s in (stats_network, stats_ports, stats_diskio, stats_fs, stats_irq, stats_folders, stats_raid, stats_sensors, stats_now):
+            for s in (stats_network, stats_wifi, stats_ports, stats_diskio, stats_fs, stats_irq, stats_folders, stats_raid, stats_sensors, stats_now):
                 self.new_line()
                 self.display_plugin(s)
 

glances/plugins/glances_wifi.py

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Glances.
+#
+# Copyright (C) 2016 Nicolargo <nicolas@nicolargo.com>
+#
+# Glances is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Glances 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+"""Wifi plugin."""
+
+import base64
+import operator
+
+from glances.logger import logger
+from glances.timer import getTimeSinceLastUpdate
+from glances.plugins.glances_plugin import GlancesPlugin
+
+import psutil
+# Use the Wifi Python lib (https://pypi.python.org/pypi/wifi)
+# Linux-only
+try:
+    from wifi.scan import Cell
+    from wifi.exceptions import InterfaceError
+except ImportError as e:
+    logger.debug("Wifi library not found. Glances cannot grab Wifi info.")
+    wifi_tag = False
+else:
+    wifi_tag = True
+
+
+class Plugin(GlancesPlugin):
+
+    """Glances Wifi plugin.
+    Get stats of the current Wifi hotspots.
+    """
+
+    def __init__(self, args=None):
+        """Init the plugin."""
+        super(Plugin, self).__init__(args=args)
+
+        # We want to display the stat in the curse interface
+        self.display_curse = True
+
+        # Init the stats
+        self.reset()
+
+    def get_key(self):
+        """Return the key of the list.
+
+        :returns: string -- SSID is the dict key
+        """
+        return 'ssid'
+
+    def reset(self):
+        """Reset/init the stats to an empty list.
+
+        :returns: None
+        """
+        self.stats = []
+
+    @GlancesPlugin._check_decorator
+    @GlancesPlugin._log_result_decorator
+    def update(self):
+        """Update Wifi stats using the input method.
+
+        Stats is a list of dict (one dict per hotspot)
+
+        :returns: list -- Stats is a list of dict (hotspot)
+        """
+        # Reset stats
+        self.reset()
+
+        # Exist if we can not grab the stats
+        if not wifi_tag:
+            return self.stats
+
+        if self.input_method == 'local':
+            # Update stats using the standard system lib
+
+            # Grab network interface stat using the PsUtil net_io_counter method
+            try:
+                netiocounters = psutil.net_io_counters(pernic=True)
+            except UnicodeDecodeError:
+                return self.stats
+
+            for net in netiocounters:
+                # Do not take hidden interface into account
+                if self.is_hide(net):
+                    continue
+
+                # Grab the stats using the Wifi Python lib
+                try:
+                    wifi_cells = Cell.all(net)
+                except InterfaceError:
+                    # Not a Wifi interface
+                    pass
+                else:
+                    for wifi_cell in wifi_cells:
+                        hotspot = {
+                            'key': self.get_key(),
+                            'ssid': wifi_cell.ssid,
+                            'signal': wifi_cell.signal,
+                            'quality': wifi_cell.quality,
+                            'encrypted': wifi_cell.encrypted,
+                            'encryption_type': wifi_cell.encryption_type if wifi_cell.encrypted else None
+                        }
+                        # Add the hotspot to the list
+                        self.stats.append(hotspot)
+
+        elif self.input_method == 'snmp':
+            # Update stats using SNMP
+
+            # Not implemented yet
+            pass
+
+        # Update the view
+        self.update_views()
+
+        return self.stats
+
+    def update_views(self):
+        """Update stats views."""
+        # Call the father's method
+        super(Plugin, self).update_views()
+
+        # Add specifics informations
+        # Alert
+        # for i in self.stats:
+        #     ifrealname = i['interface_name'].split(':')[0]
+        #     self.views[i[self.get_key()]]['rx']['decoration'] = self.get_alert(int(i['rx'] // i['time_since_update'] * 8),
+        #                                                                        header=ifrealname + '_rx')
+        #     self.views[i[self.get_key()]]['tx']['decoration'] = self.get_alert(int(i['tx'] // i['time_since_update'] * 8),
+        #                                                                        header=ifrealname + '_tx')
+
+    def msg_curse(self, args=None, max_width=None):
+        """Return the dict to display in the curse interface."""
+        # Init the return message
+        ret = []
+
+        # Only process if stats exist and display plugin enable...
+        if not self.stats or args.disable_wifi or not wifi_tag:
+            return ret
+
+        # Max size for the interface name
+        if max_width is not None and max_width >= 23:
+            # Interface size name = max_width - space for interfaces bitrate
+            ifname_max_width = max_width - 14
+        else:
+            ifname_max_width = 9
+
+        # Build the string message
+        # Header
+        msg = '{:{width}}'.format('WIFI', width=ifname_max_width)
+        ret.append(self.curse_add_line(msg, "TITLE"))
+        msg = '{:>14}'.format('Quality')
+        ret.append(self.curse_add_line(msg))
+        ret.append(self.curse_new_line())
+
+        # Hotspot list (sorted by name)
+        for i in sorted(self.stats, key=operator.itemgetter(self.get_key())):
+            # Do not display hotspot with no name (/ssid)
+            if i['ssid'] == '':
+                continue
+            # New hotspot
+            hotspotname = i['ssid']
+            if len(hotspotname) > ifname_max_width:
+                # Cut hotspotname if it is too long
+                hotspotname = '_' + hotspotname[-ifname_max_width + 1:]
+            msg = '{:{width}}'.format(hotspotname, width=ifname_max_width)
+            ret.append(self.curse_add_line(msg))
+            msg = '{:>14}'.format(i['quality'], width=ifname_max_width)
+            ret.append(self.curse_add_line(msg))
+
+        return ret