home *** CD-ROM | disk | FTP | other *** search
Wrap
# -*- coding: utf-8 -*- # # (c) Copyright 2001-2007 Hewlett-Packard Development Company, L.P. # # 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 2 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, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # Author: Don Welch # # Thanks to Henrique M. Holschuh <hmh@debian.org> for various security patches # from __future__ import generators # Std Lib import sys, os, fnmatch, tempfile, socket, struct, select, time import fcntl, errno, stat, string, commands import cStringIO, re import xml.parsers.expat as expat import getpass # Local from g import * from codes import * import pexpect xml_basename_pat = re.compile(r"""HPLIP-(\d*)_(\d*)_(\d*).xml""", re.IGNORECASE) def Translator(frm='', to='', delete='', keep=None): allchars = string.maketrans('','') if len(to) == 1: to = to * len(frm) trans = string.maketrans(frm, to) if keep is not None: delete = allchars.translate(allchars, keep.translate(allchars, delete)) def callable(s): return s.translate(trans, delete) return callable # For pidfile locking (must be "static" and global to the whole app) prv_pidfile = None prv_pidfile_name = "" def get_pidfile_lock (a_pidfile_name=""): """ Call this to either lock the pidfile, or to update it after a fork() Credit: Henrique M. Holschuh <hmh@debian.org> """ global prv_pidfile global prv_pidfile_name if prv_pidfile_name == "": try: prv_pidfile_name = a_pidfile_name prv_pidfile = os.fdopen(os.open(prv_pidfile_name, os.O_RDWR | os.O_CREAT, 0644), 'r+') fcntl.fcntl(prv_pidfile.fileno(), fcntl.F_SETFD, fcntl.FD_CLOEXEC) while 1: try: fcntl.flock(prv_pidfile.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB) except (OSError, IOError), e: if e.errno == errno.EINTR: continue elif e.errno == errno.EWOULDBLOCK: try: prv_pidfile.seek(0) otherpid = int(prv_pidfile.readline(), 10) sys.stderr.write ("can't lock %s, running daemon's pid may be %d\n" % (prv_pidfile_name, otherpid)) except (OSError, IOError), e: sys.stderr.write ("error reading pidfile %s: (%d) %s\n" % (prv_pidfile_name, e.errno, e.strerror)) sys.exit(1) sys.stderr.write ("can't lock %s: (%d) %s\n" % (prv_pidfile_name, e.errno, e.strerror)) sys.exit(1) break except (OSError, IOError), e: sys.stderr.write ("can't open pidfile %s: (%d) %s\n" % (prv_pidfile_name, e.errno, e.strerror)) sys.exit(1) try: prv_pidfile.seek(0) prv_pidfile.write("%d\n" % (os.getpid())) prv_pidfile.flush() prv_pidfile.truncate() except (OSError, IOError), e: log.error("can't update pidfile %s: (%d) %s\n" % (prv_pidfile_name, e.errno, e.strerror)) def daemonize (stdin='/dev/null', stdout='/dev/null', stderr='/dev/null'): """ Credit: J├╝rgen Hermann, Andy Gimblett, and Noah Spurrier http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66012 Proper pidfile support: Henrique M. Holschuh <hmh@debian.org> """ # Try to lock pidfile if not locked already if prv_pidfile_name != '' or prv_pidfile_name != "": get_pidfile_lock(prv_pidfile_name) # Do first fork. try: pid = os.fork() if pid > 0: sys.exit(0) # Exit first parent. except OSError, e: sys.stderr.write ("fork #1 failed: (%d) %s\n" % (e.errno, e.strerror)) sys.exit(1) # Decouple from parent environment. os.chdir("/") os.umask(0) os.setsid() # Do second fork. try: pid = os.fork() if pid > 0: sys.exit(0) # Exit second parent. except OSError, e: sys.stderr.write ("fork #2 failed: (%d) %s\n" % (e.errno, e.strerror)) sys.exit(1) if prv_pidfile_name != "": get_pidfile_lock() # Now I am a daemon! # Redirect standard file descriptors. si = file(stdin, 'r') so = file(stdout, 'a+') se = file(stderr, 'a+', 0) os.dup2(si.fileno(), sys.stdin.fileno()) os.dup2(so.fileno(), sys.stdout.fileno()) os.dup2(se.fileno(), sys.stderr.fileno()) def ifelse(cond, t, f): if cond: return t else: return f def to_bool_str(s, default='0'): """ Convert an arbitrary 0/1/T/F/Y/N string to a normalized string 0/1.""" if isinstance(s, str) and s: if s[0].lower() in ['1', 't', 'y']: return '1' elif s[0].lower() in ['0', 'f', 'n']: return '0' return default def to_bool(s, default=False): """ Convert an arbitrary 0/1/T/F/Y/N string to a boolean True/False value.""" if isinstance(s, str) and s: if s[0].lower() in ['1', 't', 'y']: return True elif s[0].lower() in ['0', 'f', 'n']: return False elif isinstance(s, bool): return s return default def path_exists_safely(path): """ Returns True if path exists, and points to a file with permissions at least as strict as 0755. Credit: Contributed by Henrique M. Holschuh <hmh@debian.org>""" try: pathmode = os.stat(path)[stat.ST_MODE] if pathmode & 0022 != 0: return False except (IOError,OSError): return False return True def walkFiles(root, recurse=True, abs_paths=False, return_folders=False, pattern='*', path=None): if path is None: path = root try: names = os.listdir(root) except os.error: raise StopIteration pattern = pattern or '*' pat_list = pattern.split(';') for name in names: fullname = os.path.normpath(os.path.join(root, name)) for pat in pat_list: if fnmatch.fnmatch(name, pat): if return_folders or not os.path.isdir(fullname): if abs_paths: yield fullname else: try: yield os.path.basename(fullname) except ValueError: yield fullname if os.path.islink(fullname): fullname = os.path.realpath(os.readlink(fullname)) if recurse and os.path.isdir(fullname) or os.path.islink(fullname): for f in walkFiles(fullname, recurse, abs_paths, return_folders, pattern, path): yield f def is_path_writable(path): if os.path.exists(path): s = os.stat(path) mode = s[stat.ST_MODE] & 0777 if mode & 02: return True elif s[stat.ST_GID] == os.getgid() and mode & 020: return True elif s[stat.ST_UID] == os.getuid() and mode & 0200: return True return False # Provides the TextFormatter class for formatting text into columns. # Original Author: Hamish B Lawson, 1999 # Modified by: Don Welch, 2003 class TextFormatter: LEFT = 0 CENTER = 1 RIGHT = 2 def __init__(self, colspeclist): self.columns = [] for colspec in colspeclist: self.columns.append(Column(**colspec)) def compose(self, textlist, add_newline=False): numlines = 0 textlist = list(textlist) if len(textlist) != len(self.columns): log.error("Formatter: Number of text items does not match columns") return for text, column in map(None, textlist, self.columns): column.wrap(text) numlines = max(numlines, len(column.lines)) complines = [''] * numlines for ln in range(numlines): for column in self.columns: complines[ln] = complines[ln] + column.getline(ln) if add_newline: return '\n'.join(complines) + '\n' else: return '\n'.join(complines) def bold(text): return ''.join(["\033[1m", text, "\033[0m"]) bold = staticmethod(bold) class Column: def __init__(self, width=78, alignment=TextFormatter.LEFT, margin=0): self.width = width self.alignment = alignment self.margin = margin self.lines = [] def align(self, line): if self.alignment == TextFormatter.CENTER: return line.center(self.width) elif self.alignment == TextFormatter.RIGHT: return line.rjust(self.width) else: return line.ljust(self.width) def wrap(self, text): self.lines = [] words = [] for word in text.split(): if word <= self.width: words.append(word) else: for i in range(0, len(word), self.width): words.append(word[i:i+self.width]) if not len(words): return current = words.pop(0) for word in words: increment = 1 + len(word) if len(current) + increment > self.width: self.lines.append(self.align(current)) current = word else: current = current + ' ' + word self.lines.append(self.align(current)) def getline(self, index): if index < len(self.lines): return ' '*self.margin + self.lines[index] else: return ' ' * (self.margin + self.width) class Stack: def __init__(self): self.stack = [] def pop(self): return self.stack.pop() def push(self, value): self.stack.append(value) def as_list(self): return self.stack def clear(self): self.stack = [] # RingBuffer class # Source: Python Cookbook 1st Ed., sec. 5.18, pg. 201 # Credit: Sebastien Keim # License: Modified BSD class RingBuffer: def __init__(self,size_max=50): self.max = size_max self.data = [] def append(self,x): """append an element at the end of the buffer""" self.data.append(x) if len(self.data) == self.max: self.cur = 0 self.__class__ = RingBufferFull def replace(self, x): """replace the last element instead off appending""" self.data[-1] = x def get(self): """ return a list of elements from the oldest to the newest""" return self.data class RingBufferFull: def __init__(self,n): #raise "you should use RingBuffer" pass def append(self,x): self.data[self.cur] = x self.cur = (self.cur+1) % self.max def replace(self, x): # back up 1 position to previous location self.cur = (self.cur-1) % self.max self.data[self.cur] = x # setup for next item self.cur = (self.cur+1) % self.max def get(self): return self.data[self.cur:] + self.data[:self.cur] def sort_dict_by_value(d): """ Returns the keys of dictionary d sorted by their values """ items=d.items() backitems=[[v[1],v[0]] for v in items] backitems.sort() return [backitems[i][1] for i in range(0,len(backitems))] # Copied from Gentoo Portage output.py # Copyright 1998-2003 Daniel Robbins, Gentoo Technologies, Inc. # Distributed under the GNU Public License v2 codes={} codes["reset"]="\x1b[0m" codes["bold"]="\x1b[01m" codes["teal"]="\x1b[36;06m" codes["turquoise"]="\x1b[36;01m" codes["fuscia"]="\x1b[35;01m" codes["purple"]="\x1b[35;06m" codes["blue"]="\x1b[34;01m" codes["darkblue"]="\x1b[34;06m" codes["green"]="\x1b[32;01m" codes["darkgreen"]="\x1b[32;06m" codes["yellow"]="\x1b[33;01m" codes["brown"]="\x1b[33;06m" codes["red"]="\x1b[31;01m" codes["darkred"]="\x1b[31;06m" def bold(text): return codes["bold"]+text+codes["reset"] def white(text): return bold(text) def teal(text): return codes["teal"]+text+codes["reset"] def turquoise(text): return codes["turquoise"]+text+codes["reset"] def darkteal(text): return turquoise(text) def fuscia(text): return codes["fuscia"]+text+codes["reset"] def purple(text): return codes["purple"]+text+codes["reset"] def blue(text): return codes["blue"]+text+codes["reset"] def darkblue(text): return codes["darkblue"]+text+codes["reset"] def green(text): return codes["green"]+text+codes["reset"] def darkgreen(text): return codes["darkgreen"]+text+codes["reset"] def yellow(text): return codes["yellow"]+text+codes["reset"] def brown(text): return codes["brown"]+text+codes["reset"] def darkyellow(text): return brown(text) def red(text): return codes["red"]+text+codes["reset"] def darkred(text): return codes["darkred"]+text+codes["reset"] def commafy(val): return val < 0 and '-' + commafy(abs(val)) \ or val < 1000 and str(val) \ or '%s,%03d' % (commafy(val / 1000), (val % 1000)) def format_bytes(s, show_bytes=False): if s < 1024: return ''.join([commafy(s), ' B']) elif 1024 < s < 1048576: if show_bytes: return ''.join([str(round(s/1024.0, 1)) , ' KB (', commafy(s), ')']) else: return ''.join([str(round(s/1024.0, 1)) , ' KB']) else: if show_bytes: return ''.join([str(round(s/1048576.0, 1)), ' MB (', commafy(s), ')']) else: return ''.join([str(round(s/1048576.0, 1)), ' MB']) try: make_temp_file = tempfile.mkstemp # 2.3+ except AttributeError: def make_temp_file(suffix='', prefix='', dir='', text=False): # pre-2.3 path = tempfile.mktemp(suffix) fd = os.open(path, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700) #os.unlink( path ) # TODO... make this secure return ( os.fdopen( fd, 'w+b' ), path ) #return (fd, path) def log_title(program_name, version): log.info("") log.info(bold("HP Linux Imaging and Printing System (ver. %s)" % prop.version)) log.info(bold("%s ver. %s" % (program_name, version))) log.info("") log.info("Copyright (c) 2001-7 Hewlett-Packard Development Company, LP") log.info("This software comes with ABSOLUTELY NO WARRANTY.") log.info("This is free software, and you are welcome to distribute it") log.info("under certain conditions. See COPYING file for more details.") log.info("") def which(command, return_full_path=False): path = os.getenv('PATH').split(':') # Add these paths for Fedora path.append('/sbin') path.append('/usr/sbin') path.append('/usr/local/sbin') found_path = '' for p in path: try: files = os.listdir(p) except: continue else: if command in files: found_path = p break if return_full_path: if found_path: return os.path.join(found_path, command) else: return '' else: return found_path def deviceDefaultFunctions(): cmd_print, cmd_copy, cmd_fax, \ cmd_pcard, cmd_scan, cmd_fab = \ '', '', '', '', '', '' # Print path = which('hp-print') if len(path) > 0: cmd_print = 'hp-print -p%PRINTER%' else: path = which('kprinter') if len(path) > 0: cmd_print = 'kprinter -P%PRINTER% --system cups' else: path = which('gtklp') if len(path) > 0: cmd_print = 'gtklp -P%PRINTER%' else: path = which('xpp') if len(path) > 0: cmd_print = 'xpp -P%PRINTER%' # Scan path = which('xsane') if len(path) > 0: cmd_scan = 'xsane -V %SANE_URI%' else: path = which('kooka') if len(path)>0: #cmd_scan = 'kooka -d "%SANE_URI%"' cmd_scan = 'kooka' else: path = which('xscanimage') if len(path)>0: cmd_scan = 'xscanimage' # Photo Card path = which('hp-unload') if len(path): cmd_pcard = 'hp-unload -d %DEVICE_URI%' else: cmd_pcard = 'python %HOME%/unload.py -d %DEVICE_URI%' # Copy path = which('hp-makecopies') if len(path): cmd_copy = 'hp-makecopies -d %DEVICE_URI%' else: cmd_copy = 'python %HOME%/makecopies.py -d %DEVICE_URI%' # Fax path = which('hp-sendfax') if len(path): cmd_fax = 'hp-sendfax -d %FAX_URI%' else: cmd_fax = 'python %HOME%/sendfax.py -d %FAX_URI%' # Fax Address Book path = which('hp-fab') if len(path): cmd_fab = 'hp-fab' else: cmd_fab = 'python %HOME%/fab.py' return cmd_print, cmd_scan, cmd_pcard, \ cmd_copy, cmd_fax, cmd_fab def no_qt_message_gtk(): try: import gtk w = gtk.Window() dialog = gtk.MessageDialog(w, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT, gtk.MESSAGE_WARNING, gtk.BUTTONS_OK, "PyQt not installed. GUI not available. Install \"python-qt3\" with the Synaptic Package Manager (Menu: System -> Administration -> Synaptic Package Manager) or run the command \"sudo apt-get install python-qt3\" in a terminal window.") dialog.run() dialog.destroy() except ImportError: pass def checkPyQtImport(): # PyQt try: import qt except ImportError: if os.getenv('DISPLAY') and os.getenv('STARTED_FROM_MENU'): no_qt_message_gtk() log.error("PyQt not installed. GUI not available. Exiting.") return False # check version of Qt qtMajor = int(qt.qVersion().split('.')[0]) if qtMajor < MINIMUM_QT_MAJOR_VER: log.error("Incorrect version of Qt installed. Ver. 3.0.0 or greater required.") return False #check version of PyQt try: pyqtVersion = qt.PYQT_VERSION_STR except: pyqtVersion = qt.PYQT_VERSION while pyqtVersion.count('.') < 2: pyqtVersion += '.0' (maj_ver, min_ver, pat_ver) = pyqtVersion.split('.') if pyqtVersion.find('snapshot') >= 0: log.warning("A non-stable snapshot version of PyQt is installed.") else: try: maj_ver = int(maj_ver) min_ver = int(min_ver) pat_ver = int(pat_ver) except ValueError: maj_ver, min_ver, pat_ver = 0, 0, 0 if maj_ver < MINIMUM_PYQT_MAJOR_VER or \ (maj_ver == MINIMUM_PYQT_MAJOR_VER and min_ver < MINIMUM_PYQT_MINOR_VER): log.error("This program may not function properly with the version of PyQt that is installed (%d.%d.%d)." % (maj_ver, min_ver, pat_ver)) log.error("Incorrect version of pyQt installed. Ver. %d.%d or greater required." % (MINIMUM_PYQT_MAJOR_VER, MINIMUM_PYQT_MINOR_VER)) log.error("This program will continue, but you may experience errors, crashes or other problems.") return True return True def loadTranslators(app, user_config): #from qt import * import qt loc = None if os.path.exists(user_config): # user_config contains executables we will run, so we # must make sure it is a safe file, and refuse to run # otherwise. if not path_exists_safely(user_config): log.warning("File %s has insecure permissions! File ignored." % user_config) else: config = ConfigParser.ConfigParser() config.read(user_config) if config.has_section("ui"): loc = config.get("ui", "loc") if not loc: loc = None if loc is not None: if loc.lower() == 'system': loc = str(qt.QTextCodec.locale()) if loc.lower() != 'c': log.debug("Trying to load .qm file for %s locale." % loc) dirs = [prop.home_dir, prop.data_dir, prop.i18n_dir] trans = qt.QTranslator(None) for dir in dirs: qm_file = 'hplip_%s' % loc loaded = trans.load(qm_file, dir) if loaded: app.installTranslator(trans) break else: loc = None if loc is None: log.debug("Using default 'C' locale") else: log.debug("Using locale: %s" % loc) return loc try: from string import Template # will fail in Python <= 2.3 except ImportError: # Code from Python 2.4 string.py #import re as _re class _multimap: """Helper class for combining multiple mappings. Used by .{safe_,}substitute() to combine the mapping and keyword arguments. """ def __init__(self, primary, secondary): self._primary = primary self._secondary = secondary def __getitem__(self, key): try: return self._primary[key] except KeyError: return self._secondary[key] class _TemplateMetaclass(type): pattern = r""" %(delim)s(?: (?P<escaped>%(delim)s) | # Escape sequence of two delimiters (?P<named>%(id)s) | # delimiter and a Python identifier {(?P<braced>%(id)s)} | # delimiter and a braced identifier (?P<invalid>) # Other ill-formed delimiter exprs ) """ def __init__(cls, name, bases, dct): super(_TemplateMetaclass, cls).__init__(name, bases, dct) if 'pattern' in dct: pattern = cls.pattern else: pattern = _TemplateMetaclass.pattern % { 'delim' : re.escape(cls.delimiter), 'id' : cls.idpattern, } cls.pattern = re.compile(pattern, re.IGNORECASE | re.VERBOSE) class Template: """A string class for supporting $-substitutions.""" __metaclass__ = _TemplateMetaclass delimiter = '$' idpattern = r'[_a-z][_a-z0-9]*' def __init__(self, template): self.template = template # Search for $$, $identifier, ${identifier}, and any bare $'s def _invalid(self, mo): i = mo.start('invalid') lines = self.template[:i].splitlines(True) if not lines: colno = 1 lineno = 1 else: colno = i - len(''.join(lines[:-1])) lineno = len(lines) raise ValueError('Invalid placeholder in string: line %d, col %d' % (lineno, colno)) def substitute(self, *args, **kws): if len(args) > 1: raise TypeError('Too many positional arguments') if not args: mapping = kws elif kws: mapping = _multimap(kws, args[0]) else: mapping = args[0] # Helper function for .sub() def convert(mo): # Check the most common path first. named = mo.group('named') or mo.group('braced') if named is not None: val = mapping[named] # We use this idiom instead of str() because the latter will # fail if val is a Unicode containing non-ASCII characters. return '%s' % val if mo.group('escaped') is not None: return self.delimiter if mo.group('invalid') is not None: self._invalid(mo) raise ValueError('Unrecognized named group in pattern', self.pattern) return self.pattern.sub(convert, self.template) def safe_substitute(self, *args, **kws): if len(args) > 1: raise TypeError('Too many positional arguments') if not args: mapping = kws elif kws: mapping = _multimap(kws, args[0]) else: mapping = args[0] # Helper function for .sub() def convert(mo): named = mo.group('named') if named is not None: try: # We use this idiom instead of str() because the latter # will fail if val is a Unicode containing non-ASCII return '%s' % mapping[named] except KeyError: return self.delimiter + named braced = mo.group('braced') if braced is not None: try: return '%s' % mapping[braced] except KeyError: return self.delimiter + '{' + braced + '}' if mo.group('escaped') is not None: return self.delimiter if mo.group('invalid') is not None: return self.delimiter raise ValueError('Unrecognized named group in pattern', self.pattern) return self.pattern.sub(convert, self.template) cat = lambda _ : Template(_).substitute(sys._getframe(1).f_globals, **sys._getframe(1).f_locals) identity = string.maketrans('','') unprintable = identity.translate(identity, string.printable) def printable(s): return s.translate(identity, unprintable) def any(S,f=lambda x:x): for x in S: if f(x): return True return False def all(S,f=lambda x:x): for x in S: if not f(x): return False return True def openURL(url): browsers = ['firefox', 'mozilla', 'konqueror', 'galeon', 'skipstone'] # in preferred order browser_opt = {'firefox': '-new-window', 'mozilla' : '', 'konqueror': '', 'galeon': '-w', 'skipstone': ''} for b in browsers: if which(b): cmd = """%s %s "%s" &""" % (b, browser_opt[b], url) log.debug(cmd) os.system(cmd) break else: log.warn("Unable to open URL: %s" % url) def uniqueList(input): temp = [] [temp.append(i) for i in input if not temp.count(i)] return temp def list_move_up(l, m): for i in range(1, len(l)): if l[i] == m: l[i-1],l[i] = l[i],l[i-1] def list_move_down(l, m): for i in range(len(l) - 2, 0, -1): if l[i] == m: l[i],l[i+1] = l[i+1],l[i] class XMLToDictParser: def __init__(self): self.stack = [] self.data = {} def startElement(self, name, attrs): self.stack.append(str(name).lower()) if len(attrs): for a in attrs: self.stack.append(str(a).lower()) self.addData(attrs[a]) self.stack.pop() def endElement(self, name): self.stack.pop() def charData(self, data): data = str(data).strip() if data and self.stack: self.addData(data) def addData(self, data): try: data = int(data) except ValueError: data = str(data) stack_str = '-'.join(self.stack) stack_str_0 = '-'.join([stack_str, '0']) try: self.data[stack_str] except KeyError: try: self.data[stack_str_0] except KeyError: self.data[stack_str] = data else: j = 2 while True: try: self.data['-'.join([stack_str, str(j)])] except KeyError: self.data['-'.join([stack_str, str(j)])] = data break j += 1 else: self.data[stack_str_0] = self.data[stack_str] self.data['-'.join([stack_str, '1'])] = data del self.data[stack_str] def parseXML(self, text): parser = expat.ParserCreate() parser.StartElementHandler = self.startElement parser.EndElementHandler = self.endElement parser.CharacterDataHandler = self.charData parser.Parse(text, True) return self.data # ------------------------- Usage Help USAGE_OPTIONS = ("[OPTIONS]", "", "heading", False) USAGE_LOGGING1 = ("Set the logging level:", "-l<level> or --logging=<level>", 'option', False) USAGE_LOGGING2 = ("", "<level>: none, info\*, error, warn, debug (\*default)", "option", False) USAGE_LOGGING3 = ("Run in debug mode:", "-g (same as option: -ldebug)", "option", False) USAGE_ARGS = ("[PRINTER|DEVICE-URI] (See Notes)", "", "heading", False) USAGE_DEVICE = ("To specify a device-URI:", "-d<device-uri> or --device=<device-uri>", "option", False) USAGE_PRINTER = ("To specify a CUPS printer:", "-p<printer> or --printer=<printer>", "option", False) USAGE_BUS1 = ("Bus to probe (if device not specified):", "-b<bus> or --bus=<bus>", "option", False) USAGE_BUS2 = ("", "<bus>: cups\*, usb\*, net, bt, fw, par\* (\*defaults) (Note: bt and fw not supported in this release.)", 'option', False) USAGE_HELP = ("This help information:", "-h or --help", "option", True) USAGE_SPACE = ("", "", "space", False) USAGE_EXAMPLES = ("Examples:", "", "heading", False) USAGE_NOTES = ("Notes:", "", "heading", False) USAGE_STD_NOTES1 = ("1. If device or printer is not specified, the local device bus is probed and the program enters interactive mode.", "", "note", False) USAGE_STD_NOTES2 = ("2. If -p\* is specified, the default CUPS printer will be used.", "", "note", False) USAGE_SEEALSO = ("See Also:", "", "heading", False) def ttysize(): ln1 = commands.getoutput('stty -a').splitlines()[0] vals = {'rows':None, 'columns':None} for ph in ln1.split(';'): x = ph.split() if len(x) == 2: vals[x[0]] = x[1] vals[x[1]] = x[0] try: rows, cols = int(vals['rows']), int(vals['columns']) except TypeError: rows, cols = 25, 80 return rows, cols def usage_formatter(override=0): rows, cols = ttysize() if override: col1 = override col2 = cols - col1 - 8 else: col1 = int(cols / 3) - 8 col2 = cols - col1 - 8 return TextFormatter(({'width': col1, 'margin' : 2}, {'width': col2, 'margin' : 2},)) def format_text(text_list, typ='text', title='', crumb='', version=''): """ Format usage text in multiple formats: text: for --help in the console rest: for conversion with rst2web for the website man: for manpages """ if typ == 'text': formatter = usage_formatter() for line in text_list: text1, text2, format, trailing_space = line # remove any reST/man escapes text1 = text1.replace("\\", "") text2 = text2.replace("\\", "") if format == 'summary': log.info(bold(text1)) log.info("") elif format in ('para', 'name', 'seealso'): log.info(text1) if trailing_space: log.info("") elif format in ('heading', 'header'): log.info(bold(text1)) elif format in ('option', 'example'): log.info(formatter.compose((text1, text2), trailing_space)) elif format == 'note': if text1.startswith(' '): log.info('\t' + text1.lstrip()) else: log.info(text1) elif format == 'space': log.info("") log.info("") elif typ == 'rest': colwidth1, colwidth2 = 0, 0 for line in text_list: text1, text2, format, trailing_space = line if format in ('option', 'example', 'note'): colwidth1 = max(len(text1), colwidth1) colwidth2 = max(len(text2), colwidth2) colwidth1 += 3 tablewidth = colwidth1 + colwidth2 # write the rst2web header log.info("""restindex page-title: %s crumb: %s format: rest file-extension: html encoding: utf8 /restindex\n""" % (title, crumb)) log.info("%s: %s (ver. %s)" % (crumb, title, version)) log.info("="*80) log.info("") links = [] for line in text_list: text1, text2, format, trailing_space = line if format == 'seealso': links.append(text1) text1 = "`%s`_" % text1 len1, len2 = len(text1), len(text2) if format == 'summary': log.info(''.join(["**", text1, "**"])) log.info("") elif format in ('para', 'name'): log.info("") log.info(text1) log.info("") elif format in ('heading', 'header'): log.info("") log.info("**" + text1 + "**") log.info("") log.info(".. class:: borderless") log.info("") log.info(''.join(["+", "-"*colwidth1, "+", "-"*colwidth2, "+"])) elif format in ('option', 'example', 'seealso'): if text1 and '`_' not in text1: log.info(''.join(["| *", text1, '*', " "*(colwidth1-len1-3), "|", text2, " "*(colwidth2-len2), "|"])) elif text1: log.info(''.join(["|", text1, " "*(colwidth1-len1), "|", text2, " "*(colwidth2-len2), "|"])) else: log.info(''.join(["|", " "*(colwidth1), "|", text2, " "*(colwidth2-len2), "|"])) log.info(''.join(["+", "-"*colwidth1, "+", "-"*colwidth2, "+"])) elif format == 'note': if text1.startswith(' '): log.info(''.join(["|", " "*(tablewidth+1), "|"])) log.info(''.join(["|", text1, " "*(tablewidth-len1+1), "|"])) log.info(''.join(["+", "-"*colwidth1, "+", "-"*colwidth2, "+"])) elif format == 'space': log.info("") for l in links: log.info("\n.. _`%s`: %s.html\n" % (l, l.replace('hp-', ''))) log.info("") elif typ == 'man': log.info('.TH "%s" 1 "%s" Linux "User Manuals"' % (title, version)) for line in text_list: text1, text2, format, trailing_space = line text1 = text1.replace("\\*", "*") text2 = text2.replace("\\*", "*") len1, len2 = len(text1), len(text2) if format == 'summary': log.info(".SH SYNOPSIS") log.info(".B %s" % text1) elif format == 'name': log.info(".SH NAME\n%s" % text1) elif format in ('option', 'example', 'note'): if text1: log.info('.IP "%s"\n%s' % (text1, text2)) else: log.info(text2) elif format in ('header', 'heading'): log.info(".SH %s" % text1.upper().replace(':', '').replace('[', '').replace(']', '')) elif format in ('seealso, para'): log.info(text1) log.info("") def dquote(s): return ''.join(['"', s, '"']) # Python 2.2 compatibility functions (strip() family with char argument) def xlstrip(s, chars=' '): i = 0 for c, i in zip(s, range(len(s))): if c not in chars: break return s[i:] def xrstrip(s, chars=' '): return xreverse(xlstrip(xreverse(s), chars)) def xreverse(s): l = list(s) l.reverse() return ''.join(l) def xstrip(s, chars=' '): return xreverse(xlstrip(xreverse(xlstrip(s, chars)), chars)) def getBitness(): try: import platform except ImportError: return struct.calcsize("P") << 3 else: return int(platform.architecture()[0][:-3]) BIG_ENDIAN = 0 LITTLE_ENDIAN = 1 def getEndian(): if struct.pack("@I", 0x01020304)[0] == '\x01': return BIG_ENDIAN else: return LITTLE_ENDIAN def get_password(): return getpass.getpass("Enter password: ") def run(cmd, log_output=True, password_func=get_password, timeout=1): output = cStringIO.StringIO() try: child = pexpect.spawn(cmd, timeout=timeout) except pexpect.ExceptionPexpect: return -1, '' try: while True: update_spinner() i = child.expect(["[pP]assword:", pexpect.EOF, pexpect.TIMEOUT]) if child.before: log.debug(child.before) output.write(child.before) if i == 0: # Password: if password_func is not None: child.sendline(password_func()) else: child.sendline(get_password()) elif i == 1: # EOF break elif i == 2: # TIMEOUT continue except Exception, e: print "Exception", e cleanup_spinner() child.close() return child.exitstatus, output.getvalue() def expand_range(ns): # ns -> string repr. of numeric range, e.g. "1-4, 7, 9-12" """Credit: Jean Brouwers, comp.lang.python 16-7-2004 Convert a string representation of a set of ranges into a list of ints, e.g. "1-4, 7, 9-12" --> [1,2,3,4,7,9,10,11,12] """ fs = [] for n in ns.split(','): n = n.strip() r = n.split('-') if len(r) == 2: # expand name with range h = r[0].rstrip('0123456789') # header r[0] = r[0][len(h):] # range can't be empty if not (r[0] and r[1]): raise ValueError, 'empty range: ' + n # handle leading zeros if r[0] == '0' or r[0][0] != '0': h += '%d' else: w = [len(i) for i in r] if w[1] > w[0]: raise ValueError, 'wide range: ' + n h += '%%0%dd' % max(w) # check range r = [int(i, 10) for i in r] if r[0] > r[1]: raise ValueError, 'bad range: ' + n for i in range(r[0], r[1]+1): fs.append(h % i) else: # simple name fs.append(n) # remove duplicates fs = dict([(n, i) for i, n in enumerate(fs)]).keys() # convert to ints and sort fs = [int(x) for x in fs if x] fs.sort() return fs def collapse_range(x): # x --> sorted list of ints """ Convert a list of integers into a string range representation: [1,2,3,4,7,9,10,11,12] --> "1-4, 7, 9-12" """ if not x: return "" s, c, r = [str(x[0])], x[0], False for i in x[1:]: if i == (c+1): r = True else: if r: s.append('-%s, %s' % (c,i)) r = False else: s.append(', %s' % i) c = i if r: s.append('-%s' % i) return ''.join(s)