wifiradar/misc.py

   1 #!/usr/bin/python
   2 # -*- coding: utf-8 -*-
   3 #
   4 #   misc.py - collection of miscellaneous functions and classes
   5 #
   6 #   Part of WiFi Radar: A utility for managing WiFi profiles on GNU/Linux.
   7 #
   8 #   Copyright (C) 2004-2005 Ahmad Baitalmal <ahmad@baitalmal.com>
   9 #   Copyright (C) 2005 Nicolas Brouard <nicolas.brouard@mandrake.org>
  10 #   Copyright (C) 2005-2009 Brian Elliott Finley <brian@thefinleys.com>
  11 #   Copyright (C) 2006 David Decotigny <com.d2@free.fr>
  12 #   Copyright (C) 2006 Simon Gerber <gesimu@gmail.com>
  13 #   Copyright (C) 2006-2007 Joey Hurst <jhurst@lucubrate.org>
  14 #   Copyright (C) 2006, 2009 Ante Karamatic <ivoks@ubuntu.com>
  15 #   Copyright (C) 2009-2010,2014 Sean Robinson <robinson@tuxfamily.org>
  16 #   Copyright (C) 2010 Prokhor Shuchalov <p@shuchalov.ru>
  17 #
  18 #   This program is free software; you can redistribute it and/or modify
  19 #   it under the terms of the GNU General Public License as published by
  20 #   the Free Software Foundation; version 2 of the License.
  21 #
  22 #   This program is distributed in the hope that it will be useful,
  23 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 #   GNU General Public License in LICENSE.GPL for more details.
  26 #
  27 #   You should have received a copy of the GNU General Public License
  28 #   along with this program; if not, write to:
  29 #      Free Software Foundation, Inc.
  30 #      51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  31 #
  32
  33
  34 import errno
  35 import gettext
  36 import logging
  37 import os
  38 import sys
  39
  40 from subprocess import check_call, Popen, PIPE, STDOUT
  41
  42 WIFI_RADAR_VERSION = "0.0.0"
  43
  44 # create a logger
  45 logger = logging.getLogger(__name__)
  46
  47 __all__ = ["_", "PYVERSION", "WIFI_RADAR_VERSION", "DeviceError",
  48            "NoDeviceError", "PipeError", "get_new_profile", "shellcmd"]
  49
  50 PYVERSION = sys.version_info[0]
  51
  52 # Look for string translations in the default location, then in the po
  53 # directory under the current directory.  This second location is useful
  54 # during development.
  55 for locale_dir in [gettext.bindtextdomain(None), os.path.realpath('./po/')]:
  56     try:
  57         trans = gettext.translation('wifi-radar', locale_dir)
  58     except IOError as e:
  59         logger.warning("{EXC} in '{DIR}'".format(EXC=e, DIR=locale_dir))
  60     else:
  61         logger.info("Translation file found in '{DIR}'".format(DIR=locale_dir))
  62         break
  63 else:
  64     logger.warning('Translation disabled.  Please report this '
  65         'at http://wifi-radar.tuxfamily.org/')
  66     trans = gettext.NullTranslations()
  67 # Return a reference to the unicode version of gettext, no matter
  68 # the Python version.
  69 if PYVERSION < 3:
  70     _ = trans.ugettext
  71 else:
  72     _ = trans.gettext
  73
  74 class DeviceError(EnvironmentError):
  75     """ DeviceError will be raised when a problem is found while changing
  76         a wireless device's configuration (e.g. when 'ifconfig wlan0 up'
  77         fails).
  78     """
  79     pass
  80
  81
  82 class NoDeviceError(EnvironmentError):
  83     """ NoDeviceError will be raised when a wireless device cannot be
  84         found.
  85     """
  86     pass
  87
  88
  89 class PipeError(IOError):
  90     """ PipeError is raised when a communication Pipe closes unexpectedly.
  91     """
  92     pass
  93
  94 def get_new_profile():
  95     """ Return a blank profile.
  96
  97     Parameters:
  98
  99         none
 100
 101     Returns:
 102
 103         dictionary -- An AP profile with defaults set.
 104     """
 105     return { 'known': False,
 106              'available': False,
 107              'encrypted': False,
 108              'essid': '',
 109              'bssid': '',
 110              'roaming': False,
 111              'protocol': 'g',
 112              'signal': -193,
 113              'channel': 'auto',
 114              'con_prescript': '',
 115              'con_postscript': '',
 116              'dis_prescript': '',
 117              'dis_postscript': '',
 118              'key': '',
 119              'mode': 'auto',
 120              'security': 'none',
 121              'wep_mode': '',
 122              'wpa_psk': '',
 123              'use_dhcp': True,
 124              'ip': '',
 125              'netmask': '',
 126              'gateway': '',
 127              'domain': '',
 128              'dns1': '',
 129              'dns2': ''
 130             }
 131
 132 def shellcmd(command, environment=None):
 133     """ Run 'command' through the shell, where 'command' is a tuple of
 134         the program to execute and its arguments.  'environment' is a
 135         dictionary of shell environment variables (as keys) and their
 136         values.  Returns 0 on success, otherwise, it raises
 137         CalledProcessError.
 138     """
 139     env_tmp = os.environ
 140     env_tmp.update(environment)
 141     return check_call(command, shell=True, env=env_tmp)
 142
 143
 144 # Make so we can be imported
 145 if __name__ == "__main__":
 146     pass
 147