avoid using abbreviations that look like spelling errors

contrib/check-code.py

@@ -1,450 +1,450
 #!/usr/bin/env python
 #
 # check-code - a style and portability checker for Mercurial
 #
 # Copyright 2010 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import re, glob, os, sys
 import keyword
 import optparse
 
 def repquote(m):
     t = re.sub(r"\w", "x", m.group('text'))
     t = re.sub(r"[^\s\nx]", "o", t)
     return m.group('quote') + t + m.group('quote')
 
 def reppython(m):
     comment = m.group('comment')
     if comment:
         return "#" * len(comment)
     return repquote(m)
 
 def repcomment(m):
     return m.group(1) + "#" * len(m.group(2))
 
 def repccomment(m):
     t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
     return m.group(1) + t + "*/"
 
 def repcallspaces(m):
     t = re.sub(r"\n\s+", "\n", m.group(2))
     return m.group(1) + t
 
 def repinclude(m):
     return m.group(1) + "<foo>"
 
 def rephere(m):
     t = re.sub(r"\S", "x", m.group(2))
     return m.group(1) + t
 
 
 testpats = [
   [
     (r'pushd|popd', "don't use 'pushd' or 'popd', use 'cd'"),
     (r'\W\$?\(\([^\)\n]*\)\)', "don't use (()) or $(()), use 'expr'"),
     (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
     (r'sed.*-i', "don't use 'sed -i', use a temporary file"),
     (r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),
     (r'echo -n', "don't use 'echo -n', use printf"),
     (r'(^| )wc[^|]*$\n(?!.*\(re\))', "filter wc output"),
     (r'head -c', "don't use 'head -c', use 'dd'"),
     (r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),
     (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
     (r'printf.*\\([1-9]|0\d)', "don't use 'printf \NNN', use Python"),
     (r'printf.*\\x', "don't use printf \\x, use Python"),
     (r'\$\(.*\)', "don't use $(expr), use `expr`"),
     (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
     (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
      "use egrep for extended grep syntax"),
     (r'/bin/', "don't use explicit paths for tools"),
     (r'[^\n]\Z', "no trailing newline"),
     (r'export.*=', "don't export and assign at once"),
     (r'^source\b', "don't use 'source', use '.'"),
     (r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),
     (r'ls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),
     (r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),
     (r'^stop\(\)', "don't use 'stop' as a shell function name"),
     (r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),
     (r'^alias\b.*=', "don't use alias, use a function"),
     (r'if\s*!', "don't use '!' to negate exit status"),
     (r'/dev/u?random', "don't use entropy, use /dev/zero"),
     (r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),
     (r'^( *)\t', "don't use tabs to indent"),
   ],
   # warnings
   [
     (r'^function', "don't use 'function', use old style"),
     (r'^diff.*-\w*N', "don't use 'diff -N'"),
     (r'\$PWD', "don't use $PWD, use `pwd`"),
     (r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),
   ]
 ]
 
 testfilters = [
     (r"( *)(#([^\n]*\S)?)", repcomment),
     (r"<<(\S+)((.|\n)*?\n\1)", rephere),
 ]
 
 uprefix = r"^  \$ "
 utestpats = [
   [
     (r'^(\S.*||  [$>] .*)[ \t]\n', "trailing whitespace on non-output"),
     (uprefix + r'.*\|\s*sed[^|>\n]*\n',
      "use regex test output patterns instead of sed"),
     (uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),
     (uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),
     (uprefix + r'.*\|\| echo.*(fail|error)',
      "explicit exit code checks unnecessary"),
     (uprefix + r'set -e', "don't use set -e"),
     (uprefix + r'\s', "don't indent commands, use > for continued lines"),
     (r'^  saved backup bundle to \$TESTTMP.*\.hg$',
      "use (glob) to match Windows paths too"),
   ],
   # warnings
   []
 ]
 
 for i in [0, 1]:
     for p, m in testpats[i]:
         if p.startswith(r'^'):
             p = r"^  [$>] (%s)" % p[1:]
         else:
             p = r"^  [$>] .*(%s)" % p
         utestpats[i].append((p, m))
 
 utestfilters = [
     (r"( *)(#([^\n]*\S)?)", repcomment),
 ]
 
 pypats = [
   [
     (r'^\s*def\s*\w+\s*\(.*,\s*\(',
      "tuple parameter unpacking not available in Python 3+"),
     (r'lambda\s*\(.*,.*\)',
      "tuple parameter unpacking not available in Python 3+"),
     (r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),
     (r'\breduce\s*\(.*', "reduce is not available in Python 3+"),
     (r'\.has_key\b', "dict.has_key is not available in Python 3+"),
     (r'^\s*\t', "don't use tabs"),
     (r'\S;\s*\n', "semicolon"),
     (r'[^_]_\("[^"]+"\s*%', "don't use % inside _()"),
     (r"[^_]_\('[^']+'\s*%", "don't use % inside _()"),
     (r'\w,\w', "missing whitespace after ,"),
     (r'\w[+/*\-<>]\w', "missing whitespace in expression"),
     (r'^\s+\w+=\w+[^,)\n]$', "missing whitespace in assignment"),
     (r'(\s+)try:\n((?:\n|\1\s.*\n)+?)\1except.*?:\n'
-     r'((?:\n|\1\s.*\n)+?)\1finally:', 'no try/except/finally in Py2.4'),
+     r'((?:\n|\1\s.*\n)+?)\1finally:', 'no try/except/finally in Python 2.4'),
     (r'.{81}', "line too long"),
     (r' x+[xo][\'"]\n\s+[\'"]x', 'string join across lines with no space'),
     (r'[^\n]\Z', "no trailing newline"),
     (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
 #    (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',
 #     "don't use underbars in identifiers"),
     (r'^\s+(self\.)?[A-za-z][a-z0-9]+[A-Z]\w* = ',
      "don't use camelcase in identifiers"),
     (r'^\s*(if|while|def|class|except|try)\s[^[\n]*:\s*[^\\n]#\s]+',
      "linebreak after :"),
     (r'class\s[^( \n]+:', "old-style class, use class foo(object)"),
     (r'class\s[^( \n]+\(\):',
      "class foo() not available in Python 2.4, use class foo(object)"),
     (r'\b(%s)\(' % '|'.join(keyword.kwlist),
      "Python keyword is not a function"),
     (r',]', "unneeded trailing ',' in list"),
 #    (r'class\s[A-Z][^\(]*\((?!Exception)',
 #     "don't capitalize non-exception classes"),
 #    (r'in range\(', "use xrange"),
 #    (r'^\s*print\s+', "avoid using print in core and extensions"),
     (r'[\x80-\xff]', "non-ASCII character literal"),
     (r'("\')\.format\(', "str.format() not available in Python 2.4"),
     (r'^\s*with\s+', "with not available in Python 2.4"),
     (r'\.isdisjoint\(', "set.isdisjoint not available in Python 2.4"),
     (r'^\s*except.* as .*:', "except as not available in Python 2.4"),
     (r'^\s*os\.path\.relpath', "relpath not available in Python 2.4"),
     (r'(?<!def)\s+(any|all|format)\(',
      "any/all/format not available in Python 2.4"),
     (r'(?<!def)\s+(callable)\(',
      "callable not available in Python 3, use getattr(f, '__call__', None)"),
     (r'if\s.*\selse', "if ... else form not available in Python 2.4"),
     (r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),
      "gratuitous whitespace after Python keyword"),
     (r'([\(\[][ \t]\S)|(\S[ \t][\)\]])', "gratuitous whitespace in () or []"),
 #    (r'\s\s=', "gratuitous whitespace before ="),
     (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
      "missing whitespace around operator"),
     (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',
      "missing whitespace around operator"),
     (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
      "missing whitespace around operator"),
     (r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',
      "wrong whitespace around ="),
     (r'raise Exception', "don't raise generic exceptions"),
     (r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),
     (r' [=!]=\s+(True|False|None)',
      "comparison with singleton, use 'is' or 'is not' instead"),
     (r'^\s*(while|if) [01]:',
      "use True/False for constant Boolean expression"),
     (r'(?:(?<!def)\s+|\()hasattr',
      'hasattr(foo, bar) is broken, use util.safehasattr(foo, bar) instead'),
     (r'opener\([^)]*\).read\(',
      "use opener.read() instead"),
-    (r'BaseException', 'not in Py2.4, use Exception'),
-    (r'os\.path\.relpath', 'os.path.relpath is not in Py2.5'),
+    (r'BaseException', 'not in Python 2.4, use Exception'),
+    (r'os\.path\.relpath', 'os.path.relpath is not in Python 2.5'),
     (r'opener\([^)]*\).write\(',
      "use opener.write() instead"),
     (r'[\s\(](open|file)\([^)]*\)\.read\(',
      "use util.readfile() instead"),
     (r'[\s\(](open|file)\([^)]*\)\.write\(',
      "use util.readfile() instead"),
     (r'^[\s\(]*(open(er)?|file)\([^)]*\)',
      "always assign an opened file to a variable, and close it afterwards"),
     (r'[\s\(](open|file)\([^)]*\)\.',
      "always assign an opened file to a variable, and close it afterwards"),
     (r'(?i)descendent', "the proper spelling is descendAnt"),
     (r'\.debug\(\_', "don't mark debug messages for translation"),
     (r'\.strip\(\)\.split\(\)', "no need to strip before splitting"),
     (r'^\s*except\s*:', "warning: naked except clause", r'#.*re-raises'),
     (r':\n(    )*( ){1,3}[^ ]', "must indent 4 spaces"),
   ],
   # warnings
   [
     (r'ui\.(status|progress|write|note|warn)\([\'\"]x',
      "warning: unwrapped ui message"),
   ]
 ]
 
 pyfilters = [
     (r"""(?msx)(?P<comment>\#.*?$)|
          ((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))
           (?P<text>(([^\\]|\\.)*?))
           (?P=quote))""", reppython),
 ]
 
 cpats = [
   [
     (r'//', "don't use //-style comments"),
     (r'^  ', "don't use spaces to indent"),
     (r'\S\t', "don't use tabs except for indent"),
     (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
     (r'.{81}', "line too long"),
     (r'(while|if|do|for)\(', "use space after while/if/do/for"),
     (r'return\(', "return is not a function"),
     (r' ;', "no space before ;"),
     (r'\w+\* \w+', "use int *foo, not int* foo"),
     (r'\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
     (r'\w+ (\+\+|--)', "use foo++, not foo ++"),
     (r'\w,\w', "missing whitespace after ,"),
     (r'^[^#]\w[+/*]\w', "missing whitespace in expression"),
     (r'^#\s+\w', "use #foo, not # foo"),
     (r'[^\n]\Z', "no trailing newline"),
     (r'^\s*#import\b', "use only #include in standard C code"),
   ],
   # warnings
   []
 ]
 
 cfilters = [
     (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
     (r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),
     (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
     (r'(\()([^)]+\))', repcallspaces),
 ]
 
 inutilpats = [
   [
     (r'\bui\.', "don't use ui in util"),
   ],
   # warnings
   []
 ]
 
 inrevlogpats = [
   [
     (r'\brepo\.', "don't use repo in revlog"),
   ],
   # warnings
   []
 ]
 
 checks = [
     ('python', r'.*\.(py|cgi)$', pyfilters, pypats),
     ('test script', r'(.*/)?test-[^.~]*$', testfilters, testpats),
     ('c', r'.*\.c$', cfilters, cpats),
     ('unified test', r'.*\.t$', utestfilters, utestpats),
     ('layering violation repo in revlog', r'mercurial/revlog\.py', pyfilters,
      inrevlogpats),
     ('layering violation ui in util', r'mercurial/util\.py', pyfilters,
      inutilpats),
 ]
 
 class norepeatlogger(object):
     def __init__(self):
         self._lastseen = None
 
     def log(self, fname, lineno, line, msg, blame):
         """print error related a to given line of a given file.
 
         The faulty line will also be printed but only once in the case
         of multiple errors.
 
         :fname: filename
         :lineno: line number
         :line: actual content of the line
         :msg: error message
         """
         msgid = fname, lineno, line
         if msgid != self._lastseen:
             if blame:
                 print "%s:%d (%s):" % (fname, lineno, blame)
             else:
                 print "%s:%d:" % (fname, lineno)
             print " > %s" % line
             self._lastseen = msgid
         print " " + msg
 
 _defaultlogger = norepeatlogger()
 
 def getblame(f):
     lines = []
     for l in os.popen('hg annotate -un %s' % f):
         start, line = l.split(':', 1)
         user, rev = start.split()
         lines.append((line[1:-1], user, rev))
     return lines
 
 def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,
               blame=False, debug=False, lineno=True):
     """checks style and portability of a given file
 
     :f: filepath
     :logfunc: function used to report error
               logfunc(filename, linenumber, linecontent, errormessage)
     :maxerr: number of error to display before aborting.
              Set to false (default) to report all errors
 
     return True if no error is found, False otherwise.
     """
     blamecache = None
     result = True
     for name, match, filters, pats in checks:
         if debug:
             print name, f
         fc = 0
         if not re.match(match, f):
             if debug:
                 print "Skipping %s for %s it doesn't match %s" % (
                        name, match, f)
             continue
         fp = open(f)
         pre = post = fp.read()
         fp.close()
         if "no-" + "check-code" in pre:
             if debug:
                 print "Skipping %s for %s it has no- and check-code" % (
                        name, f)
             break
         for p, r in filters:
             post = re.sub(p, r, post)
         if warnings:
             pats = pats[0] + pats[1]
         else:
             pats = pats[0]
         # print post # uncomment to show filtered version
 
         if debug:
             print "Checking %s for %s" % (name, f)
 
         prelines = None
         errors = []
         for pat in pats:
             if len(pat) == 3:
                 p, msg, ignore = pat
             else:
                 p, msg = pat
                 ignore = None
 
             # fix-up regexes for multi-line searches
             po = p
             # \s doesn't match \n
             p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)
             # [^...] doesn't match newline
             p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)
 
             #print po, '=>', p
 
             pos = 0
             n = 0
             for m in re.finditer(p, post, re.MULTILINE):
                 if prelines is None:
                     prelines = pre.splitlines()
                     postlines = post.splitlines(True)
 
                 start = m.start()
                 while n < len(postlines):
                     step = len(postlines[n])
                     if pos + step > start:
                         break
                     pos += step
                     n += 1
                 l = prelines[n]
 
                 if "check-code" + "-ignore" in l:
                     if debug:
                         print "Skipping %s for %s:%s (check-code -ignore)" % (
                             name, f, n)
                     continue
                 elif ignore and re.search(ignore, l, re.MULTILINE):
                     continue
                 bd = ""
                 if blame:
                     bd = 'working directory'
                     if not blamecache:
                         blamecache = getblame(f)
                     if n < len(blamecache):
                         bl, bu, br = blamecache[n]
                         if bl == l:
                             bd = '%s@%s' % (bu, br)
                 errors.append((f, lineno and n + 1, l, msg, bd))
                 result = False
 
         errors.sort()
         for e in errors:
             logfunc(*e)
             fc += 1
             if maxerr and fc >= maxerr:
                 print " (too many errors, giving up)"
                 break
 
     return result
 
 if __name__ == "__main__":
     parser = optparse.OptionParser("%prog [options] [files]")
     parser.add_option("-w", "--warnings", action="store_true",
                       help="include warning-level checks")
     parser.add_option("-p", "--per-file", type="int",
                       help="max warnings per file")
     parser.add_option("-b", "--blame", action="store_true",
                       help="use annotate to generate blame info")
     parser.add_option("", "--debug", action="store_true",
                       help="show debug information")
     parser.add_option("", "--nolineno", action="store_false",
                       dest='lineno', help="don't show line numbers")
 
     parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,
                         lineno=True)
     (options, args) = parser.parse_args()
 
     if len(args) == 0:
         check = glob.glob("*")
     else:
         check = args
 
     ret = 0
     for f in check:
         if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,
                          blame=options.blame, debug=options.debug,
                          lineno=options.lineno):
             ret = 1
     sys.exit(ret)

hgext/win32mbcs.py

@@ -1,167 +1,167
 # win32mbcs.py -- MBCS filename support for Mercurial
 #
 # Copyright (c) 2008 Shun-ichi Goto <[e-mail]>
 #
 # Version: 0.3
 # Author:  Shun-ichi Goto <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 #
 
 '''allow the use of MBCS paths with problematic encodings
 
 Some MBCS encodings are not good for some path operations (i.e.
 splitting path, case conversion, etc.) with its encoded bytes. We call
 such a encoding (i.e. shift_jis and big5) as "problematic encoding".
 This extension can be used to fix the issue with those encodings by
 wrapping some functions to convert to Unicode string before path
 operation.
 
 This extension is useful for:
 
 - Japanese Windows users using shift_jis encoding.
 - Chinese Windows users using big5 encoding.
 - All users who use a repository with one of problematic encodings on
   case-insensitive file system.
 
 This extension is not needed for:
 
 - Any user who use only ASCII chars in path.
 - Any user who do not use any of problematic encodings.
 
 Note that there are some limitations on using this extension:
 
 - You should use single encoding in one repository.
 - If the repository path ends with 0x5c, .hg/hgrc cannot be read.
 - win32mbcs is not compatible with fixutf8 extension.
 
 By default, win32mbcs uses encoding.encoding decided by Mercurial.
 You can specify the encoding by config option::
 
  [win32mbcs]
  encoding = sjis
 
 It is useful for the users who want to commit with UTF-8 log message.
 '''
 
 import os, sys
 from mercurial.i18n import _
 from mercurial import util, encoding
 testedwith = 'internal'
 
 _encoding = None                                # see extsetup
 
 def decode(arg):
     if isinstance(arg, str):
         uarg = arg.decode(_encoding)
         if arg == uarg.encode(_encoding):
             return uarg
         raise UnicodeError("Not local encoding")
     elif isinstance(arg, tuple):
         return tuple(map(decode, arg))
     elif isinstance(arg, list):
         return map(decode, arg)
     elif isinstance(arg, dict):
         for k, v in arg.items():
             arg[k] = decode(v)
     return arg
 
 def encode(arg):
     if isinstance(arg, unicode):
         return arg.encode(_encoding)
     elif isinstance(arg, tuple):
         return tuple(map(encode, arg))
     elif isinstance(arg, list):
         return map(encode, arg)
     elif isinstance(arg, dict):
         for k, v in arg.items():
             arg[k] = encode(v)
     return arg
 
 def appendsep(s):
     # ensure the path ends with os.sep, appending it if necessary.
     try:
         us = decode(s)
     except UnicodeError:
         us = s
     if us and us[-1] not in ':/\\':
         s += os.sep
     return s
 
 def wrapper(func, args, kwds):
     # check argument is unicode, then call original
     for arg in args:
         if isinstance(arg, unicode):
             return func(*args, **kwds)
 
     try:
         # convert arguments to unicode, call func, then convert back
         return encode(func(*decode(args), **decode(kwds)))
     except UnicodeError:
         raise util.Abort(_("[win32mbcs] filename conversion failed with"
                          " %s encoding\n") % (_encoding))
 
 def wrapperforlistdir(func, args, kwds):
     # Ensure 'path' argument ends with os.sep to avoids
     # misinterpreting last 0x5c of MBCS 2nd byte as path separator.
     if args:
         args = list(args)
         args[0] = appendsep(args[0])
     if 'path' in kwds:
         kwds['path'] = appendsep(kwds['path'])
     return func(*args, **kwds)
 
 def wrapname(name, wrapper):
     module, name = name.rsplit('.', 1)
     module = sys.modules[module]
     func = getattr(module, name)
     def f(*args, **kwds):
         return wrapper(func, args, kwds)
     try:
-        f.__name__ = func.__name__                # fail with python23
+        f.__name__ = func.__name__ # fails with Python 2.3
     except Exception:
         pass
     setattr(module, name, f)
 
 # List of functions to be wrapped.
 # NOTE: os.path.dirname() and os.path.basename() are safe because
 #       they use result of os.path.split()
 funcs = '''os.path.join os.path.split os.path.splitext
  os.path.normpath os.makedirs
  mercurial.util.endswithsep mercurial.util.splitpath mercurial.util.checkcase
  mercurial.util.fspath mercurial.util.pconvert mercurial.util.normpath
  mercurial.util.checkwinfilename mercurial.util.checkosfilename'''
 
 # List of Windows specific functions to be wrapped.
 winfuncs = '''os.path.splitunc'''
 
 # codec and alias names of sjis and big5 to be faked.
 problematic_encodings = '''big5 big5-tw csbig5 big5hkscs big5-hkscs
  hkscs cp932 932 ms932 mskanji ms-kanji shift_jis csshiftjis shiftjis
  sjis s_jis shift_jis_2004 shiftjis2004 sjis_2004 sjis2004
  shift_jisx0213 shiftjisx0213 sjisx0213 s_jisx0213 950 cp950 ms950 '''
 
 def extsetup(ui):
     # TODO: decide use of config section for this extension
     if ((not os.path.supports_unicode_filenames) and
         (sys.platform != 'cygwin')):
         ui.warn(_("[win32mbcs] cannot activate on this platform.\n"))
         return
     # determine encoding for filename
     global _encoding
     _encoding = ui.config('win32mbcs', 'encoding', encoding.encoding)
     # fake is only for relevant environment.
     if _encoding.lower() in problematic_encodings.split():
         for f in funcs.split():
             wrapname(f, wrapper)
         if os.name == 'nt':
             for f in winfuncs.split():
                 wrapname(f, wrapper)
         wrapname("mercurial.osutil.listdir", wrapperforlistdir)
         # Check sys.args manually instead of using ui.debug() because
         # command line options is not yet applied when
         # extensions.loadall() is called.
         if '--debug' in sys.argv:
             ui.write("[win32mbcs] activated with encoding: %s\n"
                      % _encoding)

hgext/zeroconf/Zeroconf.py

@@ -1,1581 +1,1580
 """ Multicast DNS Service Discovery for Python, v0.12
     Copyright (C) 2003, Paul Scott-Murphy
 
     This module provides a framework for the use of DNS Service Discovery
     using IP multicast.  It has been tested against the JRendezvous
     implementation from <a href="http://strangeberry.com">StrangeBerry</a>,
     and against the mDNSResponder from Mac OS X 10.3.8.
 
     This library 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 2.1 of the License, or (at your option) any later version.
 
     This library 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 library; if not, see
     <http://www.gnu.org/licenses/>.
 
 """
 
 """0.12 update - allow selection of binding interface
 		 typo fix - Thanks A. M. Kuchlingi
 		 removed all use of word 'Rendezvous' - this is an API change"""
 
 """0.11 update - correction to comments for addListener method
                  support for new record types seen from OS X
 				  - IPv6 address
 				  - hostinfo
 				 ignore unknown DNS record types
 				 fixes to name decoding
 				 works alongside other processes using port 5353 (e.g. on Mac OS X)
 				 tested against Mac OS X 10.3.2's mDNSResponder
 				 corrections to removal of list entries for service browser"""
 
 """0.10 update - Jonathon Paisley contributed these corrections:
                  always multicast replies, even when query is unicast
 				 correct a pointer encoding problem
 				 can now write records in any order
 				 traceback shown on failure
 				 better TXT record parsing
 				 server is now separate from name
 				 can cancel a service browser
 
 				 modified some unit tests to accommodate these changes"""
 
 """0.09 update - remove all records on service unregistration
                  fix DOS security problem with readName"""
 
 """0.08 update - changed licensing to LGPL"""
 
 """0.07 update - faster shutdown on engine
                  pointer encoding of outgoing names
 				 ServiceBrowser now works
 				 new unit tests"""
 
 """0.06 update - small improvements with unit tests
                  added defined exception types
 				 new style objects
 				 fixed hostname/interface problem
 				 fixed socket timeout problem
 				 fixed addServiceListener() typo bug
 				 using select() for socket reads
 				 tested on Debian unstable with Python 2.2.2"""
 
 """0.05 update - ensure case insensitivity on domain names
                  support for unicast DNS queries"""
 
 """0.04 update - added some unit tests
                  added __ne__ adjuncts where required
 				 ensure names end in '.local.'
 				 timeout on receiving socket for clean shutdown"""
 
 __author__ = "Paul Scott-Murphy"
 __email__ = "paul at scott dash murphy dot com"
 __version__ = "0.12"
 
 import string
 import time
 import struct
 import socket
 import threading
 import select
 import traceback
 
 __all__ = ["Zeroconf", "ServiceInfo", "ServiceBrowser"]
 
 # hook for threads
 
 globals()['_GLOBAL_DONE'] = 0
 
 # Some timing constants
 
 _UNREGISTER_TIME = 125
 _CHECK_TIME = 175
 _REGISTER_TIME = 225
 _LISTENER_TIME = 200
 _BROWSER_TIME = 500
 
 # Some DNS constants
 
 _MDNS_ADDR = '224.0.0.251'
 _MDNS_PORT = 5353;
 _DNS_PORT = 53;
 _DNS_TTL = 60 * 60; # one hour default TTL
 
 _MAX_MSG_TYPICAL = 1460 # unused
 _MAX_MSG_ABSOLUTE = 8972
 
 _FLAGS_QR_MASK = 0x8000 # query response mask
 _FLAGS_QR_QUERY = 0x0000 # query
 _FLAGS_QR_RESPONSE = 0x8000 # response
 
 _FLAGS_AA = 0x0400 # Authoritative answer
 _FLAGS_TC = 0x0200 # Truncated
 _FLAGS_RD = 0x0100 # Recursion desired
 _FLAGS_RA = 0x8000 # Recursion available
 
 _FLAGS_Z = 0x0040 # Zero
 _FLAGS_AD = 0x0020 # Authentic data
 _FLAGS_CD = 0x0010 # Checking disabled
 
 _CLASS_IN = 1
 _CLASS_CS = 2
 _CLASS_CH = 3
 _CLASS_HS = 4
 _CLASS_NONE = 254
 _CLASS_ANY = 255
 _CLASS_MASK = 0x7FFF
 _CLASS_UNIQUE = 0x8000
 
 _TYPE_A = 1
 _TYPE_NS = 2
 _TYPE_MD = 3
 _TYPE_MF = 4
 _TYPE_CNAME = 5
 _TYPE_SOA = 6
 _TYPE_MB = 7
 _TYPE_MG = 8
 _TYPE_MR = 9
 _TYPE_NULL = 10
 _TYPE_WKS = 11
 _TYPE_PTR = 12
 _TYPE_HINFO = 13
 _TYPE_MINFO = 14
 _TYPE_MX = 15
 _TYPE_TXT = 16
 _TYPE_AAAA = 28
 _TYPE_SRV = 33
 _TYPE_ANY =  255
 
 # Mapping constants to names
 
 _CLASSES = { _CLASS_IN : "in",
 			 _CLASS_CS : "cs",
 			 _CLASS_CH : "ch",
 			 _CLASS_HS : "hs",
 			 _CLASS_NONE : "none",
 			 _CLASS_ANY : "any" }
 
 _TYPES = { _TYPE_A : "a",
 		   _TYPE_NS : "ns",
 		   _TYPE_MD : "md",
 		   _TYPE_MF : "mf",
 		   _TYPE_CNAME : "cname",
 		   _TYPE_SOA : "soa",
 		   _TYPE_MB : "mb",
 		   _TYPE_MG : "mg",
 		   _TYPE_MR : "mr",
 		   _TYPE_NULL : "null",
 		   _TYPE_WKS : "wks",
 		   _TYPE_PTR : "ptr",
 		   _TYPE_HINFO : "hinfo",
 		   _TYPE_MINFO : "minfo",
 		   _TYPE_MX : "mx",
 		   _TYPE_TXT : "txt",
 		   _TYPE_AAAA : "quada",
 		   _TYPE_SRV : "srv",
 		   _TYPE_ANY : "any" }
 
 # utility functions
 
 def currentTimeMillis():
 	"""Current system time in milliseconds"""
 	return time.time() * 1000
 
 # Exceptions
 
 class NonLocalNameException(Exception):
 	pass
 
 class NonUniqueNameException(Exception):
 	pass
 
 class NamePartTooLongException(Exception):
 	pass
 
 class AbstractMethodException(Exception):
 	pass
 
 class BadTypeInNameException(Exception):
 	pass
 
 class BadDomainName(Exception):
 	def __init__(self, pos):
 		Exception.__init__(self, "at position %s" % pos)
 
 class BadDomainNameCircular(BadDomainName):
 	pass
 
 # implementation classes
 
 class DNSEntry(object):
 	"""A DNS entry"""
 
 	def __init__(self, name, type, clazz):
 		self.key = string.lower(name)
 		self.name = name
 		self.type = type
 		self.clazz = clazz & _CLASS_MASK
 		self.unique = (clazz & _CLASS_UNIQUE) != 0
 
 	def __eq__(self, other):
 		"""Equality test on name, type, and class"""
 		if isinstance(other, DNSEntry):
 			return self.name == other.name and self.type == other.type and self.clazz == other.clazz
 		return 0
 
 	def __ne__(self, other):
 		"""Non-equality test"""
 		return not self.__eq__(other)
 
 	def getClazz(self, clazz):
 		"""Class accessor"""
 		try:
 			return _CLASSES[clazz]
 		except KeyError:
 			return "?(%s)" % (clazz)
 
 	def getType(self, type):
 		"""Type accessor"""
 		try:
 			return _TYPES[type]
 		except KeyError:
 			return "?(%s)" % (type)
 
 	def toString(self, hdr, other):
 		"""String representation with additional information"""
 		result = "%s[%s,%s" % (hdr, self.getType(self.type), self.getClazz(self.clazz))
 		if self.unique:
 			result += "-unique,"
 		else:
 			result += ","
 		result += self.name
 		if other is not None:
 			result += ",%s]" % (other)
 		else:
 			result += "]"
 		return result
 
 class DNSQuestion(DNSEntry):
 	"""A DNS question entry"""
 
 	def __init__(self, name, type, clazz):
 		if not name.endswith(".local."):
 			raise NonLocalNameException(name)
 		DNSEntry.__init__(self, name, type, clazz)
 
 	def answeredBy(self, rec):
 		"""Returns true if the question is answered by the record"""
 		return self.clazz == rec.clazz and (self.type == rec.type or self.type == _TYPE_ANY) and self.name == rec.name
 
 	def __repr__(self):
 		"""String representation"""
 		return DNSEntry.toString(self, "question", None)
 
 
 class DNSRecord(DNSEntry):
 	"""A DNS record - like a DNS entry, but has a TTL"""
 
 	def __init__(self, name, type, clazz, ttl):
 		DNSEntry.__init__(self, name, type, clazz)
 		self.ttl = ttl
 		self.created = currentTimeMillis()
 
 	def __eq__(self, other):
 		"""Tests equality as per DNSRecord"""
 		if isinstance(other, DNSRecord):
 			return DNSEntry.__eq__(self, other)
 		return 0
 
 	def suppressedBy(self, msg):
 		"""Returns true if any answer in a message can suffice for the
 		information held in this record."""
 		for record in msg.answers:
 			if self.suppressedByAnswer(record):
 				return 1
 		return 0
 
 	def suppressedByAnswer(self, other):
 		"""Returns true if another record has same name, type and class,
 		and if its TTL is at least half of this record's."""
 		if self == other and other.ttl > (self.ttl / 2):
 			return 1
 		return 0
 
 	def getExpirationTime(self, percent):
 		"""Returns the time at which this record will have expired
 		by a certain percentage."""
 		return self.created + (percent * self.ttl * 10)
 
 	def getRemainingTTL(self, now):
 		"""Returns the remaining TTL in seconds."""
 		return max(0, (self.getExpirationTime(100) - now) / 1000)
 
 	def isExpired(self, now):
 		"""Returns true if this record has expired."""
 		return self.getExpirationTime(100) <= now
 
 	def isStale(self, now):
 		"""Returns true if this record is at least half way expired."""
 		return self.getExpirationTime(50) <= now
 
 	def resetTTL(self, other):
 		"""Sets this record's TTL and created time to that of
 		another record."""
 		self.created = other.created
 		self.ttl = other.ttl
 
 	def write(self, out):
 		"""Abstract method"""
 		raise AbstractMethodException
 
 	def toString(self, other):
 		"""String representation with additional information"""
 		arg = "%s/%s,%s" % (self.ttl, self.getRemainingTTL(currentTimeMillis()), other)
 		return DNSEntry.toString(self, "record", arg)
 
 class DNSAddress(DNSRecord):
 	"""A DNS address record"""
 
 	def __init__(self, name, type, clazz, ttl, address):
 		DNSRecord.__init__(self, name, type, clazz, ttl)
 		self.address = address
 
 	def write(self, out):
 		"""Used in constructing an outgoing packet"""
 		out.writeString(self.address, len(self.address))
 
 	def __eq__(self, other):
 		"""Tests equality on address"""
 		if isinstance(other, DNSAddress):
 			return self.address == other.address
 		return 0
 
 	def __repr__(self):
 		"""String representation"""
 		try:
 			return socket.inet_ntoa(self.address)
 		except Exception:
 			return self.address
 
 class DNSHinfo(DNSRecord):
 	"""A DNS host information record"""
 
 	def __init__(self, name, type, clazz, ttl, cpu, os):
 		DNSRecord.__init__(self, name, type, clazz, ttl)
 		self.cpu = cpu
 		self.os = os
 
 	def write(self, out):
 		"""Used in constructing an outgoing packet"""
 		out.writeString(self.cpu, len(self.cpu))
 		out.writeString(self.os, len(self.os))
 
 	def __eq__(self, other):
 		"""Tests equality on cpu and os"""
 		if isinstance(other, DNSHinfo):
 			return self.cpu == other.cpu and self.os == other.os
 		return 0
 
 	def __repr__(self):
 		"""String representation"""
 		return self.cpu + " " + self.os
 
 class DNSPointer(DNSRecord):
 	"""A DNS pointer record"""
 
 	def __init__(self, name, type, clazz, ttl, alias):
 		DNSRecord.__init__(self, name, type, clazz, ttl)
 		self.alias = alias
 
 	def write(self, out):
 		"""Used in constructing an outgoing packet"""
 		out.writeName(self.alias)
 
 	def __eq__(self, other):
 		"""Tests equality on alias"""
 		if isinstance(other, DNSPointer):
 			return self.alias == other.alias
 		return 0
 
 	def __repr__(self):
 		"""String representation"""
 		return self.toString(self.alias)
 
 class DNSText(DNSRecord):
 	"""A DNS text record"""
 
 	def __init__(self, name, type, clazz, ttl, text):
 		DNSRecord.__init__(self, name, type, clazz, ttl)
 		self.text = text
 
 	def write(self, out):
 		"""Used in constructing an outgoing packet"""
 		out.writeString(self.text, len(self.text))
 
 	def __eq__(self, other):
 		"""Tests equality on text"""
 		if isinstance(other, DNSText):
 			return self.text == other.text
 		return 0
 
 	def __repr__(self):
 		"""String representation"""
 		if len(self.text) > 10:
 			return self.toString(self.text[:7] + "...")
 		else:
 			return self.toString(self.text)
 
 class DNSService(DNSRecord):
 	"""A DNS service record"""
 
 	def __init__(self, name, type, clazz, ttl, priority, weight, port, server):
 		DNSRecord.__init__(self, name, type, clazz, ttl)
 		self.priority = priority
 		self.weight = weight
 		self.port = port
 		self.server = server
 
 	def write(self, out):
 		"""Used in constructing an outgoing packet"""
 		out.writeShort(self.priority)
 		out.writeShort(self.weight)
 		out.writeShort(self.port)
 		out.writeName(self.server)
 
 	def __eq__(self, other):
 		"""Tests equality on priority, weight, port and server"""
 		if isinstance(other, DNSService):
 			return self.priority == other.priority and self.weight == other.weight and self.port == other.port and self.server == other.server
 		return 0
 
 	def __repr__(self):
 		"""String representation"""
 		return self.toString("%s:%s" % (self.server, self.port))
 
 class DNSIncoming(object):
 	"""Object representation of an incoming DNS packet"""
 
 	def __init__(self, data):
 		"""Constructor from string holding bytes of packet"""
 		self.offset = 0
 		self.data = data
 		self.questions = []
 		self.answers = []
 		self.numQuestions = 0
 		self.numAnswers = 0
 		self.numAuthorities = 0
 		self.numAdditionals = 0
 
 		self.readHeader()
 		self.readQuestions()
 		self.readOthers()
 
 	def readHeader(self):
 		"""Reads header portion of packet"""
 		format = '!HHHHHH'
 		length = struct.calcsize(format)
 		info = struct.unpack(format, self.data[self.offset:self.offset+length])
 		self.offset += length
 
 		self.id = info[0]
 		self.flags = info[1]
 		self.numQuestions = info[2]
 		self.numAnswers = info[3]
 		self.numAuthorities = info[4]
 		self.numAdditionals = info[5]
 
 	def readQuestions(self):
 		"""Reads questions section of packet"""
 		format = '!HH'
 		length = struct.calcsize(format)
 		for i in range(0, self.numQuestions):
 			name = self.readName()
 			info = struct.unpack(format, self.data[self.offset:self.offset+length])
 			self.offset += length
 
 			try:
 				question = DNSQuestion(name, info[0], info[1])
 				self.questions.append(question)
 			except NonLocalNameException:
 				pass
 
 	def readInt(self):
 		"""Reads an integer from the packet"""
 		format = '!I'
 		length = struct.calcsize(format)
 		info = struct.unpack(format, self.data[self.offset:self.offset+length])
 		self.offset += length
 		return info[0]
 
 	def readCharacterString(self):
 		"""Reads a character string from the packet"""
 		length = ord(self.data[self.offset])
 		self.offset += 1
 		return self.readString(length)
 
 	def readString(self, len):
 		"""Reads a string of a given length from the packet"""
 		format = '!' + str(len) + 's'
 		length =  struct.calcsize(format)
 		info = struct.unpack(format, self.data[self.offset:self.offset+length])
 		self.offset += length
 		return info[0]
 
 	def readUnsignedShort(self):
 		"""Reads an unsigned short from the packet"""
 		format = '!H'
 		length = struct.calcsize(format)
 		info = struct.unpack(format, self.data[self.offset:self.offset+length])
 		self.offset += length
 		return info[0]
 
 	def readOthers(self):
 		"""Reads the answers, authorities and additionals section of the packet"""
 		format = '!HHiH'
 		length = struct.calcsize(format)
 		n = self.numAnswers + self.numAuthorities + self.numAdditionals
 		for i in range(0, n):
 			domain = self.readName()
 			info = struct.unpack(format, self.data[self.offset:self.offset+length])
 			self.offset += length
 
 			rec = None
 			if info[0] == _TYPE_A:
 				rec = DNSAddress(domain, info[0], info[1], info[2], self.readString(4))
 			elif info[0] == _TYPE_CNAME or info[0] == _TYPE_PTR:
 				rec = DNSPointer(domain, info[0], info[1], info[2], self.readName())
 			elif info[0] == _TYPE_TXT:
 				rec = DNSText(domain, info[0], info[1], info[2], self.readString(info[3]))
 			elif info[0] == _TYPE_SRV:
 				rec = DNSService(domain, info[0], info[1], info[2], self.readUnsignedShort(), self.readUnsignedShort(), self.readUnsignedShort(), self.readName())
 			elif info[0] == _TYPE_HINFO:
 				rec = DNSHinfo(domain, info[0], info[1], info[2], self.readCharacterString(), self.readCharacterString())
 			elif info[0] == _TYPE_AAAA:
 				rec = DNSAddress(domain, info[0], info[1], info[2], self.readString(16))
 			else:
 				# Try to ignore types we don't know about
 				# this may mean the rest of the name is
 				# unable to be parsed, and may show errors
 				# so this is left for debugging.  New types
 				# encountered need to be parsed properly.
 				#
 				#print "UNKNOWN TYPE = " + str(info[0])
 				#raise BadTypeInNameException
 				self.offset += info[3]
 
 			if rec is not None:
 				self.answers.append(rec)
 
 	def isQuery(self):
 		"""Returns true if this is a query"""
 		return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_QUERY
 
 	def isResponse(self):
 		"""Returns true if this is a response"""
 		return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_RESPONSE
 
 	def readUTF(self, offset, len):
 		"""Reads a UTF-8 string of a given length from the packet"""
 		return self.data[offset:offset+len].decode('utf-8')
 
 	def readName(self):
 		"""Reads a domain name from the packet"""
 		result = ''
 		off = self.offset
 		next = -1
 		first = off
 
 		while True:
 			len = ord(self.data[off])
 			off += 1
 			if len == 0:
 				break
 			t = len & 0xC0
 			if t == 0x00:
 				result = ''.join((result, self.readUTF(off, len) + '.'))
 				off += len
 			elif t == 0xC0:
 				if next < 0:
 					next = off + 1
 				off = ((len & 0x3F) << 8) | ord(self.data[off])
 				if off >= first:
 					raise BadDomainNameCircular(off)
 				first = off
 			else:
 				raise BadDomainName(off)
 
 		if next >= 0:
 			self.offset = next
 		else:
 			self.offset = off
 
 		return result
 
 
 class DNSOutgoing(object):
 	"""Object representation of an outgoing packet"""
 
 	def __init__(self, flags, multicast = 1):
 		self.finished = 0
 		self.id = 0
 		self.multicast = multicast
 		self.flags = flags
 		self.names = {}
 		self.data = []
 		self.size = 12
 
 		self.questions = []
 		self.answers = []
 		self.authorities = []
 		self.additionals = []
 
 	def addQuestion(self, record):
 		"""Adds a question"""
 		self.questions.append(record)
 
 	def addAnswer(self, inp, record):
 		"""Adds an answer"""
 		if not record.suppressedBy(inp):
 			self.addAnswerAtTime(record, 0)
 
 	def addAnswerAtTime(self, record, now):
 		"""Adds an answer if if does not expire by a certain time"""
 		if record is not None:
 			if now == 0 or not record.isExpired(now):
 				self.answers.append((record, now))
 
 	def addAuthoritativeAnswer(self, record):
 		"""Adds an authoritative answer"""
 		self.authorities.append(record)
 
 	def addAdditionalAnswer(self, record):
 		"""Adds an additional answer"""
 		self.additionals.append(record)
 
 	def writeByte(self, value):
 		"""Writes a single byte to the packet"""
 		format = '!c'
 		self.data.append(struct.pack(format, chr(value)))
 		self.size += 1
 
 	def insertShort(self, index, value):
 		"""Inserts an unsigned short in a certain position in the packet"""
 		format = '!H'
 		self.data.insert(index, struct.pack(format, value))
 		self.size += 2
 
 	def writeShort(self, value):
 		"""Writes an unsigned short to the packet"""
 		format = '!H'
 		self.data.append(struct.pack(format, value))
 		self.size += 2
 
 	def writeInt(self, value):
 		"""Writes an unsigned integer to the packet"""
 		format = '!I'
 		self.data.append(struct.pack(format, int(value)))
 		self.size += 4
 
 	def writeString(self, value, length):
 		"""Writes a string to the packet"""
 		format = '!' + str(length) + 's'
 		self.data.append(struct.pack(format, value))
 		self.size += length
 
 	def writeUTF(self, s):
 		"""Writes a UTF-8 string of a given length to the packet"""
 		utfstr = s.encode('utf-8')
 		length = len(utfstr)
 		if length > 64:
 			raise NamePartTooLongException
 		self.writeByte(length)
 		self.writeString(utfstr, length)
 
 	def writeName(self, name):
 		"""Writes a domain name to the packet"""
 
 		try:
 			# Find existing instance of this name in packet
 			#
 			index = self.names[name]
 		except KeyError:
 			# No record of this name already, so write it
 			# out as normal, recording the location of the name
 			# for future pointers to it.
 			#
 			self.names[name] = self.size
 			parts = name.split('.')
 			if parts[-1] == '':
 				parts = parts[:-1]
 			for part in parts:
 				self.writeUTF(part)
 			self.writeByte(0)
 			return
 
 		# An index was found, so write a pointer to it
 		#
 		self.writeByte((index >> 8) | 0xC0)
 		self.writeByte(index)
 
 	def writeQuestion(self, question):
 		"""Writes a question to the packet"""
 		self.writeName(question.name)
 		self.writeShort(question.type)
 		self.writeShort(question.clazz)
 
 	def writeRecord(self, record, now):
 		"""Writes a record (answer, authoritative answer, additional) to
 		the packet"""
 		self.writeName(record.name)
 		self.writeShort(record.type)
 		if record.unique and self.multicast:
 			self.writeShort(record.clazz | _CLASS_UNIQUE)
 		else:
 			self.writeShort(record.clazz)
 		if now == 0:
 			self.writeInt(record.ttl)
 		else:
 			self.writeInt(record.getRemainingTTL(now))
 		index = len(self.data)
 		# Adjust size for the short we will write before this record
 		#
 		self.size += 2
 		record.write(self)
 		self.size -= 2
 
 		length = len(''.join(self.data[index:]))
 		self.insertShort(index, length) # Here is the short we adjusted for
 
 	def packet(self):
 		"""Returns a string containing the packet's bytes
 
 		No further parts should be added to the packet once this
 		is done."""
 		if not self.finished:
 			self.finished = 1
 			for question in self.questions:
 				self.writeQuestion(question)
 			for answer, time in self.answers:
 				self.writeRecord(answer, time)
 			for authority in self.authorities:
 				self.writeRecord(authority, 0)
 			for additional in self.additionals:
 				self.writeRecord(additional, 0)
 
 			self.insertShort(0, len(self.additionals))
 			self.insertShort(0, len(self.authorities))
 			self.insertShort(0, len(self.answers))
 			self.insertShort(0, len(self.questions))
 			self.insertShort(0, self.flags)
 			if self.multicast:
 				self.insertShort(0, 0)
 			else:
 				self.insertShort(0, self.id)
 		return ''.join(self.data)
 
 
 class DNSCache(object):
 	"""A cache of DNS entries"""
 
 	def __init__(self):
 		self.cache = {}
 
 	def add(self, entry):
 		"""Adds an entry"""
 		try:
 			list = self.cache[entry.key]
 		except KeyError:
 			list = self.cache[entry.key] = []
 		list.append(entry)
 
 	def remove(self, entry):
 		"""Removes an entry"""
 		try:
 			list = self.cache[entry.key]
 			list.remove(entry)
 		except KeyError:
 			pass
 
 	def get(self, entry):
 		"""Gets an entry by key.  Will return None if there is no
 		matching entry."""
 		try:
 			list = self.cache[entry.key]
 			return list[list.index(entry)]
 		except (KeyError, ValueError):
 			return None
 
 	def getByDetails(self, name, type, clazz):
 		"""Gets an entry by details.  Will return None if there is
 		no matching entry."""
 		entry = DNSEntry(name, type, clazz)
 		return self.get(entry)
 
 	def entriesWithName(self, name):
 		"""Returns a list of entries whose key matches the name."""
 		try:
 			return self.cache[name]
 		except KeyError:
 			return []
 
 	def entries(self):
 		"""Returns a list of all entries"""
 		def add(x, y): return x+y
 		try:
 			return reduce(add, self.cache.values())
 		except Exception:
 			return []
 
 
 class Engine(threading.Thread):
 	"""An engine wraps read access to sockets, allowing objects that
 	need to receive data from sockets to be called back when the
 	sockets are ready.
 
 	A reader needs a handle_read() method, which is called when the socket
 	it is interested in is ready for reading.
 
 	Writers are not implemented here, because we only send short
 	packets.
 	"""
 
 	def __init__(self, zeroconf):
 		threading.Thread.__init__(self)
 		self.zeroconf = zeroconf
 		self.readers = {} # maps socket to reader
 		self.timeout = 5
 		self.condition = threading.Condition()
 		self.start()
 
 	def run(self):
 		while not globals()['_GLOBAL_DONE']:
 			rs = self.getReaders()
 			if len(rs) == 0:
 				# No sockets to manage, but we wait for the timeout
 				# or addition of a socket
 				#
 				self.condition.acquire()
 				self.condition.wait(self.timeout)
 				self.condition.release()
 			else:
 				try:
 					rr, wr, er = select.select(rs, [], [], self.timeout)
 					for socket in rr:
 						try:
 							self.readers[socket].handle_read()
 						except Exception:
 							if not globals()['_GLOBAL_DONE']:
 								traceback.print_exc()
 				except Exception:
 					pass
 
 	def getReaders(self):
 		self.condition.acquire()
 		result = self.readers.keys()
 		self.condition.release()
 		return result
 
 	def addReader(self, reader, socket):
 		self.condition.acquire()
 		self.readers[socket] = reader
 		self.condition.notify()
 		self.condition.release()
 
 	def delReader(self, socket):
 		self.condition.acquire()
 		del(self.readers[socket])
 		self.condition.notify()
 		self.condition.release()
 
 	def notify(self):
 		self.condition.acquire()
 		self.condition.notify()
 		self.condition.release()
 
 class Listener(object):
 	"""A Listener is used by this module to listen on the multicast
 	group to which DNS messages are sent, allowing the implementation
 	to cache information as it arrives.
 
 	It requires registration with an Engine object in order to have
 	the read() method called when a socket is available for reading."""
 
 	def __init__(self, zeroconf):
 		self.zeroconf = zeroconf
 		self.zeroconf.engine.addReader(self, self.zeroconf.socket)
 
 	def handle_read(self):
 		data, (addr, port) = self.zeroconf.socket.recvfrom(_MAX_MSG_ABSOLUTE)
 		self.data = data
 		msg = DNSIncoming(data)
 		if msg.isQuery():
 			# Always multicast responses
 			#
 			if port == _MDNS_PORT:
 				self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT)
 			# If it's not a multicast query, reply via unicast
 			# and multicast
 			#
 			elif port == _DNS_PORT:
 				self.zeroconf.handleQuery(msg, addr, port)
 				self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT)
 		else:
 			self.zeroconf.handleResponse(msg)
 
 
 class Reaper(threading.Thread):
 	"""A Reaper is used by this module to remove cache entries that
 	have expired."""
 
 	def __init__(self, zeroconf):
 		threading.Thread.__init__(self)
 		self.zeroconf = zeroconf
 		self.start()
 
 	def run(self):
 		while True:
 			self.zeroconf.wait(10 * 1000)
 			if globals()['_GLOBAL_DONE']:
 				return
 			now = currentTimeMillis()
 			for record in self.zeroconf.cache.entries():
 				if record.isExpired(now):
 					self.zeroconf.updateRecord(now, record)
 					self.zeroconf.cache.remove(record)
 
 
 class ServiceBrowser(threading.Thread):
 	"""Used to browse for a service of a specific type.
 
 	The listener object will have its addService() and
 	removeService() methods called when this browser
 	discovers changes in the services availability."""
 
 	def __init__(self, zeroconf, type, listener):
 		"""Creates a browser for a specific type"""
 		threading.Thread.__init__(self)
 		self.zeroconf = zeroconf
 		self.type = type
 		self.listener = listener
 		self.services = {}
 		self.nextTime = currentTimeMillis()
 		self.delay = _BROWSER_TIME
 		self.list = []
 
 		self.done = 0
 
 		self.zeroconf.addListener(self, DNSQuestion(self.type, _TYPE_PTR, _CLASS_IN))
 		self.start()
 
 	def updateRecord(self, zeroconf, now, record):
 		"""Callback invoked by Zeroconf when new information arrives.
 
 		Updates information required by browser in the Zeroconf cache."""
 		if record.type == _TYPE_PTR and record.name == self.type:
 			expired = record.isExpired(now)
 			try:
 				oldrecord = self.services[record.alias.lower()]
 				if not expired:
 					oldrecord.resetTTL(record)
 				else:
 					del(self.services[record.alias.lower()])
 					callback = lambda x: self.listener.removeService(x, self.type, record.alias)
 					self.list.append(callback)
 					return
 			except Exception:
 				if not expired:
 					self.services[record.alias.lower()] = record
 					callback = lambda x: self.listener.addService(x, self.type, record.alias)
 					self.list.append(callback)
 
 			expires = record.getExpirationTime(75)
 			if expires < self.nextTime:
 				self.nextTime = expires
 
 	def cancel(self):
 		self.done = 1
 		self.zeroconf.notifyAll()
 
 	def run(self):
 		while True:
 			event = None
 			now = currentTimeMillis()
 			if len(self.list) == 0 and self.nextTime > now:
 				self.zeroconf.wait(self.nextTime - now)
 			if globals()['_GLOBAL_DONE'] or self.done:
 				return
 			now = currentTimeMillis()
 
 			if self.nextTime <= now:
 				out = DNSOutgoing(_FLAGS_QR_QUERY)
 				out.addQuestion(DNSQuestion(self.type, _TYPE_PTR, _CLASS_IN))
 				for record in self.services.values():
 					if not record.isExpired(now):
 						out.addAnswerAtTime(record, now)
 				self.zeroconf.send(out)
 				self.nextTime = now + self.delay
 				self.delay = min(20 * 1000, self.delay * 2)
 
 			if len(self.list) > 0:
 				event = self.list.pop(0)
 
 			if event is not None:
 				event(self.zeroconf)
 
 
 class ServiceInfo(object):
 	"""Service information"""
 
 	def __init__(self, type, name, address=None, port=None, weight=0, priority=0, properties=None, server=None):
 		"""Create a service description.
 
 		type: fully qualified service type name
 		name: fully qualified service name
 		address: IP address as unsigned short, network byte order
 		port: port that the service runs on
 		weight: weight of the service
 		priority: priority of the service
 		properties: dictionary of properties (or a string holding the bytes for the text field)
 		server: fully qualified name for service host (defaults to name)"""
 
 		if not name.endswith(type):
 			raise BadTypeInNameException
 		self.type = type
 		self.name = name
 		self.address = address
 		self.port = port
 		self.weight = weight
 		self.priority = priority
 		if server:
 			self.server = server
 		else:
 			self.server = name
 		self.setProperties(properties)
 
 	def setProperties(self, properties):
 		"""Sets properties and text of this info from a dictionary"""
 		if isinstance(properties, dict):
 			self.properties = properties
 			list = []
 			result = ''
 			for key in properties:
 				value = properties[key]
 				if value is None:
 					suffix = ''
 				elif isinstance(value, str):
 					suffix = value
 				elif isinstance(value, int):
 					if value:
 						suffix = 'true'
 					else:
 						suffix = 'false'
 				else:
 					suffix = ''
 				list.append('='.join((key, suffix)))
 			for item in list:
 				result = ''.join((result, struct.pack('!c', chr(len(item))), item))
 			self.text = result
 		else:
 			self.text = properties
 
 	def setText(self, text):
 		"""Sets properties and text given a text field"""
 		self.text = text
 		try:
 			result = {}
 			end = len(text)
 			index = 0
 			strs = []
 			while index < end:
 				length = ord(text[index])
 				index += 1
 				strs.append(text[index:index+length])
 				index += length
 
 			for s in strs:
 				eindex = s.find('=')
 				if eindex == -1:
 					# No equals sign at all
 					key = s
 					value = 0
 				else:
 					key = s[:eindex]
 					value = s[eindex+1:]
 					if value == 'true':
 						value = 1
 					elif value == 'false' or not value:
 						value = 0
 
 				# Only update non-existent properties
 				if key and result.get(key) == None:
 					result[key] = value
 
 			self.properties = result
 		except Exception:
 			traceback.print_exc()
 			self.properties = None
 
 	def getType(self):
 		"""Type accessor"""
 		return self.type
 
 	def getName(self):
 		"""Name accessor"""
 		if self.type is not None and self.name.endswith("." + self.type):
 			return self.name[:len(self.name) - len(self.type) - 1]
 		return self.name
 
 	def getAddress(self):
 		"""Address accessor"""
 		return self.address
 
 	def getPort(self):
 		"""Port accessor"""
 		return self.port
 
 	def getPriority(self):
 		"""Priority accessor"""
 		return self.priority
 
 	def getWeight(self):
 		"""Weight accessor"""
 		return self.weight
 
 	def getProperties(self):
 		"""Properties accessor"""
 		return self.properties
 
 	def getText(self):
 		"""Text accessor"""
 		return self.text
 
 	def getServer(self):
 		"""Server accessor"""
 		return self.server
 
 	def updateRecord(self, zeroconf, now, record):
 		"""Updates service information from a DNS record"""
 		if record is not None and not record.isExpired(now):
 			if record.type == _TYPE_A:
 				#if record.name == self.name:
 				if record.name == self.server:
 					self.address = record.address
 			elif record.type == _TYPE_SRV:
 				if record.name == self.name:
 					self.server = record.server
 					self.port = record.port
 					self.weight = record.weight
 					self.priority = record.priority
 					#self.address = None
 					self.updateRecord(zeroconf, now, zeroconf.cache.getByDetails(self.server, _TYPE_A, _CLASS_IN))
 			elif record.type == _TYPE_TXT:
 				if record.name == self.name:
 					self.setText(record.text)
 
 	def request(self, zeroconf, timeout):
 		"""Returns true if the service could be discovered on the
 		network, and updates this object with details discovered.
 		"""
 		now = currentTimeMillis()
 		delay = _LISTENER_TIME
 		next = now + delay
 		last = now + timeout
 		result = 0
 		try:
 			zeroconf.addListener(self, DNSQuestion(self.name, _TYPE_ANY, _CLASS_IN))
 			while self.server is None or self.address is None or self.text is None:
 				if last <= now:
 					return 0
 				if next <= now:
 					out = DNSOutgoing(_FLAGS_QR_QUERY)
 					out.addQuestion(DNSQuestion(self.name, _TYPE_SRV, _CLASS_IN))
 					out.addAnswerAtTime(zeroconf.cache.getByDetails(self.name, _TYPE_SRV, _CLASS_IN), now)
 					out.addQuestion(DNSQuestion(self.name, _TYPE_TXT, _CLASS_IN))
 					out.addAnswerAtTime(zeroconf.cache.getByDetails(self.name, _TYPE_TXT, _CLASS_IN), now)
 					if self.server is not None:
 						out.addQuestion(DNSQuestion(self.server, _TYPE_A, _CLASS_IN))
 						out.addAnswerAtTime(zeroconf.cache.getByDetails(self.server, _TYPE_A, _CLASS_IN), now)
 					zeroconf.send(out)
 					next = now + delay
 					delay = delay * 2
 
 				zeroconf.wait(min(next, last) - now)
 				now = currentTimeMillis()
 			result = 1
 		finally:
 			zeroconf.removeListener(self)
 
 		return result
 
 	def __eq__(self, other):
 		"""Tests equality of service name"""
 		if isinstance(other, ServiceInfo):
 			return other.name == self.name
 		return 0
 
 	def __ne__(self, other):
 		"""Non-equality test"""
 		return not self.__eq__(other)
 
 	def __repr__(self):
 		"""String representation"""
 		result = "service[%s,%s:%s," % (self.name, socket.inet_ntoa(self.getAddress()), self.port)
 		if self.text is None:
 			result += "None"
 		else:
 			if len(self.text) < 20:
 				result += self.text
 			else:
 				result += self.text[:17] + "..."
 		result += "]"
 		return result
 
 
 class Zeroconf(object):
 	"""Implementation of Zeroconf Multicast DNS Service Discovery
 
 	Supports registration, unregistration, queries and browsing.
 	"""
 	def __init__(self, bindaddress=None):
 		"""Creates an instance of the Zeroconf class, establishing
 		multicast communications, listening and reaping threads."""
 		globals()['_GLOBAL_DONE'] = 0
 		if bindaddress is None:
 			self.intf = socket.gethostbyname(socket.gethostname())
 		else:
 			self.intf = bindaddress
 		self.group = ('', _MDNS_PORT)
 		self.socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
 		try:
 			self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
 			self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
 		except Exception:
 			# SO_REUSEADDR should be equivalent to SO_REUSEPORT for
 			# multicast UDP sockets (p 731, "TCP/IP Illustrated,
 			# Volume 2"), but some BSD-derived systems require
 			# SO_REUSEPORT to be specified explicitly.  Also, not all
 			# versions of Python have SO_REUSEPORT available.  So
 			# if you're on a BSD-based system, and haven't upgraded
 			# to Python 2.3 yet, you may find this library doesn't
 			# work as expected.
 			#
 			pass
 		self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_TTL, 255)
 		self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_LOOP, 1)
 		try:
 			self.socket.bind(self.group)
 		except Exception:
 			# Some versions of linux raise an exception even though
-			# the SO_REUSE* options have been set, so ignore it
-			#
+			# SO_REUSEADDR and SO_REUSEPORT have been set, so ignore it
 			pass
 		self.socket.setsockopt(socket.SOL_IP, socket.IP_ADD_MEMBERSHIP, socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0'))
 
 		self.listeners = []
 		self.browsers = []
 		self.services = {}
 		self.servicetypes = {}
 
 		self.cache = DNSCache()
 
 		self.condition = threading.Condition()
 
 		self.engine = Engine(self)
 		self.listener = Listener(self)
 		self.reaper = Reaper(self)
 
 	def isLoopback(self):
 		return self.intf.startswith("127.0.0.1")
 
 	def isLinklocal(self):
 		return self.intf.startswith("169.254.")
 
 	def wait(self, timeout):
 		"""Calling thread waits for a given number of milliseconds or
 		until notified."""
 		self.condition.acquire()
 		self.condition.wait(timeout/1000)
 		self.condition.release()
 
 	def notifyAll(self):
 		"""Notifies all waiting threads"""
 		self.condition.acquire()
 		self.condition.notifyAll()
 		self.condition.release()
 
 	def getServiceInfo(self, type, name, timeout=3000):
 		"""Returns network's service information for a particular
 		name and type, or None if no service matches by the timeout,
 		which defaults to 3 seconds."""
 		info = ServiceInfo(type, name)
 		if info.request(self, timeout):
 			return info
 		return None
 
 	def addServiceListener(self, type, listener):
 		"""Adds a listener for a particular service type.  This object
 		will then have its updateRecord method called when information
 		arrives for that type."""
 		self.removeServiceListener(listener)
 		self.browsers.append(ServiceBrowser(self, type, listener))
 
 	def removeServiceListener(self, listener):
 		"""Removes a listener from the set that is currently listening."""
 		for browser in self.browsers:
 			if browser.listener == listener:
 				browser.cancel()
 				del(browser)
 
 	def registerService(self, info, ttl=_DNS_TTL):
 		"""Registers service information to the network with a default TTL
 		of 60 seconds.  Zeroconf will then respond to requests for
 		information for that service.  The name of the service may be
 		changed if needed to make it unique on the network."""
 		self.checkService(info)
 		self.services[info.name.lower()] = info
 		if self.servicetypes.has_key(info.type):
 			self.servicetypes[info.type]+=1
 		else:
 			self.servicetypes[info.type]=1
 		now = currentTimeMillis()
 		nextTime = now
 		i = 0
 		while i < 3:
 			if now < nextTime:
 				self.wait(nextTime - now)
 				now = currentTimeMillis()
 				continue
 			out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 			out.addAnswerAtTime(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, ttl, info.name), 0)
 			out.addAnswerAtTime(DNSService(info.name, _TYPE_SRV, _CLASS_IN, ttl, info.priority, info.weight, info.port, info.server), 0)
 			out.addAnswerAtTime(DNSText(info.name, _TYPE_TXT, _CLASS_IN, ttl, info.text), 0)
 			if info.address:
 				out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, _CLASS_IN, ttl, info.address), 0)
 			self.send(out)
 			i += 1
 			nextTime += _REGISTER_TIME
 
 	def unregisterService(self, info):
 		"""Unregister a service."""
 		try:
 			del(self.services[info.name.lower()])
 			if self.servicetypes[info.type]>1:
 				self.servicetypes[info.type]-=1
 			else:
 				del self.servicetypes[info.type]
 		except KeyError:
 			pass
 		now = currentTimeMillis()
 		nextTime = now
 		i = 0
 		while i < 3:
 			if now < nextTime:
 				self.wait(nextTime - now)
 				now = currentTimeMillis()
 				continue
 			out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 			out.addAnswerAtTime(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, 0, info.name), 0)
 			out.addAnswerAtTime(DNSService(info.name, _TYPE_SRV, _CLASS_IN, 0, info.priority, info.weight, info.port, info.name), 0)
 			out.addAnswerAtTime(DNSText(info.name, _TYPE_TXT, _CLASS_IN, 0, info.text), 0)
 			if info.address:
 				out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, _CLASS_IN, 0, info.address), 0)
 			self.send(out)
 			i += 1
 			nextTime += _UNREGISTER_TIME
 
 	def unregisterAllServices(self):
 		"""Unregister all registered services."""
 		if len(self.services) > 0:
 			now = currentTimeMillis()
 			nextTime = now
 			i = 0
 			while i < 3:
 				if now < nextTime:
 					self.wait(nextTime - now)
 					now = currentTimeMillis()
 					continue
 				out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 				for info in self.services.values():
 					out.addAnswerAtTime(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, 0, info.name), 0)
 					out.addAnswerAtTime(DNSService(info.name, _TYPE_SRV, _CLASS_IN, 0, info.priority, info.weight, info.port, info.server), 0)
 					out.addAnswerAtTime(DNSText(info.name, _TYPE_TXT, _CLASS_IN, 0, info.text), 0)
 					if info.address:
 						out.addAnswerAtTime(DNSAddress(info.server, _TYPE_A, _CLASS_IN, 0, info.address), 0)
 				self.send(out)
 				i += 1
 				nextTime += _UNREGISTER_TIME
 
 	def checkService(self, info):
 		"""Checks the network for a unique service name, modifying the
 		ServiceInfo passed in if it is not unique."""
 		now = currentTimeMillis()
 		nextTime = now
 		i = 0
 		while i < 3:
 			for record in self.cache.entriesWithName(info.type):
 				if record.type == _TYPE_PTR and not record.isExpired(now) and record.alias == info.name:
 					if (info.name.find('.') < 0):
 						info.name = info.name + ".[" + info.address + ":" + info.port + "]." + info.type
 						self.checkService(info)
 						return
 					raise NonUniqueNameException
 			if now < nextTime:
 				self.wait(nextTime - now)
 				now = currentTimeMillis()
 				continue
 			out = DNSOutgoing(_FLAGS_QR_QUERY | _FLAGS_AA)
 			self.debug = out
 			out.addQuestion(DNSQuestion(info.type, _TYPE_PTR, _CLASS_IN))
 			out.addAuthoritativeAnswer(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, _DNS_TTL, info.name))
 			self.send(out)
 			i += 1
 			nextTime += _CHECK_TIME
 
 	def addListener(self, listener, question):
 		"""Adds a listener for a given question.  The listener will have
 		its updateRecord method called when information is available to
 		answer the question."""
 		now = currentTimeMillis()
 		self.listeners.append(listener)
 		if question is not None:
 			for record in self.cache.entriesWithName(question.name):
 				if question.answeredBy(record) and not record.isExpired(now):
 					listener.updateRecord(self, now, record)
 		self.notifyAll()
 
 	def removeListener(self, listener):
 		"""Removes a listener."""
 		try:
 			self.listeners.remove(listener)
 			self.notifyAll()
 		except Exception:
 			pass
 
 	def updateRecord(self, now, rec):
 		"""Used to notify listeners of new information that has updated
 		a record."""
 		for listener in self.listeners:
 			listener.updateRecord(self, now, rec)
 		self.notifyAll()
 
 	def handleResponse(self, msg):
 		"""Deal with incoming response packets.  All answers
 		are held in the cache, and listeners are notified."""
 		now = currentTimeMillis()
 		for record in msg.answers:
 			expired = record.isExpired(now)
 			if record in self.cache.entries():
 				if expired:
 					self.cache.remove(record)
 				else:
 					entry = self.cache.get(record)
 					if entry is not None:
 						entry.resetTTL(record)
 						record = entry
 			else:
 				self.cache.add(record)
 
 			self.updateRecord(now, record)
 
 	def handleQuery(self, msg, addr, port):
 		"""Deal with incoming query packets.  Provides a response if
 		possible."""
 		out = None
 
 		# Support unicast client responses
 		#
 		if port != _MDNS_PORT:
 			out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA, 0)
 			for question in msg.questions:
 				out.addQuestion(question)
 
 		for question in msg.questions:
 			if question.type == _TYPE_PTR:
 				if question.name == "_services._dns-sd._udp.local.":
 					for stype in self.servicetypes.keys():
 						if out is None:
 							out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 						out.addAnswer(msg, DNSPointer("_services._dns-sd._udp.local.", _TYPE_PTR, _CLASS_IN, _DNS_TTL, stype))
 				for service in self.services.values():
 					if question.name == service.type:
 						if out is None:
 							out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 						out.addAnswer(msg, DNSPointer(service.type, _TYPE_PTR, _CLASS_IN, _DNS_TTL, service.name))
 			else:
 				try:
 					if out is None:
 						out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 
 					# Answer A record queries for any service addresses we know
 					if question.type == _TYPE_A or question.type == _TYPE_ANY:
 						for service in self.services.values():
 							if service.server == question.name.lower():
 								out.addAnswer(msg, DNSAddress(question.name, _TYPE_A, _CLASS_IN | _CLASS_UNIQUE, _DNS_TTL, service.address))
 
 					service = self.services.get(question.name.lower(), None)
 					if not service: continue
 
 					if question.type == _TYPE_SRV or question.type == _TYPE_ANY:
 						out.addAnswer(msg, DNSService(question.name, _TYPE_SRV, _CLASS_IN | _CLASS_UNIQUE, _DNS_TTL, service.priority, service.weight, service.port, service.server))
 					if question.type == _TYPE_TXT or question.type == _TYPE_ANY:
 						out.addAnswer(msg, DNSText(question.name, _TYPE_TXT, _CLASS_IN | _CLASS_UNIQUE, _DNS_TTL, service.text))
 					if question.type == _TYPE_SRV:
 						out.addAdditionalAnswer(DNSAddress(service.server, _TYPE_A, _CLASS_IN | _CLASS_UNIQUE, _DNS_TTL, service.address))
 				except Exception:
 					traceback.print_exc()
 
 		if out is not None and out.answers:
 			out.id = msg.id
 			self.send(out, addr, port)
 
 	def send(self, out, addr = _MDNS_ADDR, port = _MDNS_PORT):
 		"""Sends an outgoing packet."""
 		# This is a quick test to see if we can parse the packets we generate
 		#temp = DNSIncoming(out.packet())
 		try:
 			self.socket.sendto(out.packet(), 0, (addr, port))
 		except Exception:
 			# Ignore this, it may be a temporary loss of network connection
 			pass
 
 	def close(self):
 		"""Ends the background threads, and prevent this instance from
 		servicing further queries."""
 		if globals()['_GLOBAL_DONE'] == 0:
 			globals()['_GLOBAL_DONE'] = 1
 			self.notifyAll()
 			self.engine.notify()
 			self.unregisterAllServices()
 			self.socket.setsockopt(socket.SOL_IP, socket.IP_DROP_MEMBERSHIP, socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0'))
 			self.socket.close()
 
 # Test a few module features, including service registration, service
 # query (for Zoe), and service unregistration.
 
 if __name__ == '__main__':
 	print "Multicast DNS Service Discovery for Python, version", __version__
 	r = Zeroconf()
 	print "1. Testing registration of a service..."
 	desc = {'version':'0.10','a':'test value', 'b':'another value'}
 	info = ServiceInfo("_http._tcp.local.", "My Service Name._http._tcp.local.", socket.inet_aton("127.0.0.1"), 1234, 0, 0, desc)
 	print "   Registering service..."
 	r.registerService(info)
 	print "   Registration done."
 	print "2. Testing query of service information..."
 	print "   Getting ZOE service:", str(r.getServiceInfo("_http._tcp.local.", "ZOE._http._tcp.local."))
 	print "   Query done."
 	print "3. Testing query of own service..."
 	print "   Getting self:", str(r.getServiceInfo("_http._tcp.local.", "My Service Name._http._tcp.local."))
 	print "   Query done."
 	print "4. Testing unregister of service information..."
 	r.unregisterService(info)
 	print "   Unregister done."
 	r.close()
 
 # no-check-code

mercurial/hook.py

@@ -1,188 +1,188
 # hook.py - hook support for mercurial
 #
 # Copyright 2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import _
 import os, sys
 import extensions, util
 
 def _pythonhook(ui, repo, name, hname, funcname, args, throw):
     '''call python hook. hook is callable object, looked up as
     name in python module. if callable returns "true", hook
     fails, else passes. if hook raises exception, treated as
     hook failure. exception propagates if throw is "true".
 
     reason for "true" meaning "hook failed" is so that
     unmodified commands (e.g. mercurial.commands.update) can
     be run as hooks without wrappers to convert return values.'''
 
     ui.note(_("calling hook %s: %s\n") % (hname, funcname))
     obj = funcname
     if not util.safehasattr(obj, '__call__'):
         d = funcname.rfind('.')
         if d == -1:
             raise util.Abort(_('%s hook is invalid ("%s" not in '
                                'a module)') % (hname, funcname))
         modname = funcname[:d]
         oldpaths = sys.path
         if util.mainfrozen():
             # binary installs require sys.path manipulation
             modpath, modfile = os.path.split(modname)
             if modpath and modfile:
                 sys.path = sys.path[:] + [modpath]
                 modname = modfile
         try:
             obj = __import__(modname)
         except ImportError:
             e1 = sys.exc_type, sys.exc_value, sys.exc_traceback
             try:
                 # extensions are loaded with hgext_ prefix
                 obj = __import__("hgext_%s" % modname)
             except ImportError:
                 e2 = sys.exc_type, sys.exc_value, sys.exc_traceback
                 if ui.tracebackflag:
                     ui.warn(_('exception from first failed import attempt:\n'))
                 ui.traceback(e1)
                 if ui.tracebackflag:
                     ui.warn(_('exception from second failed import attempt:\n'))
                 ui.traceback(e2)
                 raise util.Abort(_('%s hook is invalid '
                                    '(import of "%s" failed)') %
                                  (hname, modname))
         sys.path = oldpaths
         try:
             for p in funcname.split('.')[1:]:
                 obj = getattr(obj, p)
         except AttributeError:
             raise util.Abort(_('%s hook is invalid '
                                '("%s" is not defined)') %
                              (hname, funcname))
         if not util.safehasattr(obj, '__call__'):
             raise util.Abort(_('%s hook is invalid '
                                '("%s" is not callable)') %
                              (hname, funcname))
     try:
         try:
             # redirect IO descriptors to the ui descriptors so hooks
             # that write directly to these don't mess up the command
             # protocol when running through the command server
             old = sys.stdout, sys.stderr, sys.stdin
             sys.stdout, sys.stderr, sys.stdin = ui.fout, ui.ferr, ui.fin
 
             r = obj(ui=ui, repo=repo, hooktype=name, **args)
         except KeyboardInterrupt:
             raise
         except Exception, exc:
             if isinstance(exc, util.Abort):
                 ui.warn(_('error: %s hook failed: %s\n') %
                              (hname, exc.args[0]))
             else:
                 ui.warn(_('error: %s hook raised an exception: '
                                '%s\n') % (hname, exc))
             if throw:
                 raise
             ui.traceback()
             return True
     finally:
         sys.stdout, sys.stderr, sys.stdin = old
     if r:
         if throw:
             raise util.Abort(_('%s hook failed') % hname)
         ui.warn(_('warning: %s hook failed\n') % hname)
     return r
 
 def _exthook(ui, repo, name, cmd, args, throw):
     ui.note(_("running hook %s: %s\n") % (name, cmd))
 
     env = {}
     for k, v in args.iteritems():
         if util.safehasattr(v, '__call__'):
             v = v()
         if isinstance(v, dict):
             # make the dictionary element order stable across Python
             # implementations
             v = ('{' +
                  ', '.join('%r: %r' % i for i in sorted(v.iteritems())) +
                  '}')
         env['HG_' + k.upper()] = v
 
     if repo:
         cwd = repo.root
     else:
         cwd = os.getcwd()
     if 'HG_URL' in env and env['HG_URL'].startswith('remote:http'):
         r = util.system(cmd, environ=env, cwd=cwd, out=ui)
     else:
         r = util.system(cmd, environ=env, cwd=cwd, out=ui.fout)
     if r:
         desc, r = util.explainexit(r)
         if throw:
             raise util.Abort(_('%s hook %s') % (name, desc))
         ui.warn(_('warning: %s hook %s\n') % (name, desc))
     return r
 
 def _allhooks(ui):
     hooks = []
     for name, cmd in ui.configitems('hooks'):
         if not name.startswith('priority'):
             priority = ui.configint('hooks', 'priority.%s' % name, 0)
             hooks.append((-priority, len(hooks), name, cmd))
     return [(k, v) for p, o, k, v in sorted(hooks)]
 
 _redirect = False
 def redirect(state):
     global _redirect
     _redirect = state
 
 def hook(ui, repo, name, throw=False, **args):
     if not ui.callhooks:
         return False
 
     r = False
 
     oldstdout = -1
     if _redirect:
         try:
             stdoutno = sys.__stdout__.fileno()
             stderrno = sys.__stderr__.fileno()
             # temporarily redirect stdout to stderr, if possible
             if stdoutno >= 0 and stderrno >= 0:
                 sys.__stdout__.flush()
                 oldstdout = os.dup(stdoutno)
                 os.dup2(stderrno, stdoutno)
         except AttributeError:
-            # __stdout/err__ doesn't have fileno(), it's not a real file
+            # __stdout__/__stderr__ doesn't have fileno(), it's not a real file
             pass
 
     try:
         for hname, cmd in _allhooks(ui):
             if hname.split('.')[0] != name or not cmd:
                 continue
             if util.safehasattr(cmd, '__call__'):
                 r = _pythonhook(ui, repo, name, hname, cmd, args, throw) or r
             elif cmd.startswith('python:'):
                 if cmd.count(':') >= 2:
                     path, cmd = cmd[7:].rsplit(':', 1)
                     path = util.expandpath(path)
                     if repo:
                         path = os.path.join(repo.root, path)
                     try:
                         mod = extensions.loadpath(path, 'hghook.%s' % hname)
                     except Exception:
                         ui.write(_("loading %s hook failed:\n") % hname)
                         raise
                     hookfn = getattr(mod, cmd)
                 else:
                     hookfn = cmd[7:].strip()
                 r = _pythonhook(ui, repo, name, hname, hookfn, args, throw) or r
             else:
                 r = _exthook(ui, repo, hname, cmd, args, throw) or r
     finally:
         if _redirect and oldstdout >= 0:
             os.dup2(oldstdout, stdoutno)
             os.close(oldstdout)
 
     return r

mercurial/httpclient/__init__.py

@@ -1,674 +1,674
 # Copyright 2010, Google Inc.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 # copyright notice, this list of conditions and the following disclaimer
 # in the documentation and/or other materials provided with the
 # distribution.
 #     * Neither the name of Google Inc. nor the names of its
 # contributors may be used to endorse or promote products derived from
 # this software without specific prior written permission.
 
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """Improved HTTP/1.1 client library
 
 This library contains an HTTPConnection which is similar to the one in
 httplib, but has several additional features:
 
   * supports keepalives natively
   * uses select() to block for incoming data
   * notices when the server responds early to a request
   * implements ssl inline instead of in a different class
 """
 
 import cStringIO
 import errno
 import httplib
 import logging
 import rfc822
 import select
 import socket
 
 import _readers
 import socketutil
 
 logger = logging.getLogger(__name__)
 
 __all__ = ['HTTPConnection', 'HTTPResponse']
 
 HTTP_VER_1_0 = 'HTTP/1.0'
 HTTP_VER_1_1 = 'HTTP/1.1'
 
 OUTGOING_BUFFER_SIZE = 1 << 15
 INCOMING_BUFFER_SIZE = 1 << 20
 
 HDR_ACCEPT_ENCODING = 'accept-encoding'
 HDR_CONNECTION_CTRL = 'connection'
 HDR_CONTENT_LENGTH = 'content-length'
 HDR_XFER_ENCODING = 'transfer-encoding'
 
 XFER_ENCODING_CHUNKED = 'chunked'
 
 CONNECTION_CLOSE = 'close'
 
 EOL = '\r\n'
 _END_HEADERS = EOL * 2
 
 # Based on some searching around, 1 second seems like a reasonable
 # default here.
 TIMEOUT_ASSUME_CONTINUE = 1
 TIMEOUT_DEFAULT = None
 
 
 class HTTPResponse(object):
     """Response from an HTTP server.
 
     The response will continue to load as available. If you need the
     complete response before continuing, check the .complete() method.
     """
     def __init__(self, sock, timeout, method):
         self.sock = sock
         self.method = method
         self.raw_response = ''
         self._headers_len = 0
         self.headers = None
         self.will_close = False
         self.status_line = ''
         self.status = None
         self.continued = False
         self.http_version = None
         self.reason = None
         self._reader = None
 
         self._read_location = 0
         self._eol = EOL
 
         self._timeout = timeout
 
     @property
     def _end_headers(self):
         return self._eol * 2
 
     def complete(self):
         """Returns true if this response is completely loaded.
 
         Note that if this is a connection where complete means the
         socket is closed, this will nearly always return False, even
         in cases where all the data has actually been loaded.
         """
         if self._reader:
             return self._reader.done()
 
     def _close(self):
         if self._reader is not None:
             self._reader._close()
 
     def readline(self):
         """Read a single line from the response body.
 
         This may block until either a line ending is found or the
         response is complete.
         """
         # TODO: move this into the reader interface where it can be
         # smarter (and probably avoid copies)
         bytes = []
         while not bytes:
             try:
                 bytes = [self._reader.read(1)]
             except _readers.ReadNotReady:
                 self._select()
         while bytes[-1] != '\n' and not self.complete():
             self._select()
             bytes.append(self._reader.read(1))
         if bytes[-1] != '\n':
             next = self._reader.read(1)
             while next and next != '\n':
                 bytes.append(next)
                 next = self._reader.read(1)
             bytes.append(next)
         return ''.join(bytes)
 
     def read(self, length=None):
         # if length is None, unbounded read
         while (not self.complete()  # never select on a finished read
                and (not length  # unbounded, so we wait for complete()
                     or length > self._reader.available_data)):
             self._select()
         if not length:
             length = self._reader.available_data
         r = self._reader.read(length)
         if self.complete() and self.will_close:
             self.sock.close()
         return r
 
     def _select(self):
         r, _, _ = select.select([self.sock], [], [], self._timeout)
         if not r:
             # socket was not readable. If the response is not
             # complete, raise a timeout.
             if not self.complete():
                 logger.info('timed out with timeout of %s', self._timeout)
                 raise HTTPTimeoutException('timeout reading data')
         try:
             data = self.sock.recv(INCOMING_BUFFER_SIZE)
         except socket.sslerror, e:
             if e.args[0] != socket.SSL_ERROR_WANT_READ:
                 raise
-            logger.debug('SSL_WANT_READ in _select, should retry later')
+            logger.debug('SSL_ERROR_WANT_READ in _select, should retry later')
             return True
         logger.debug('response read %d data during _select', len(data))
         # If the socket was readable and no data was read, that means
         # the socket was closed. Inform the reader (if any) so it can
         # raise an exception if this is an invalid situation.
         if not data:
             if self._reader:
                 self._reader._close()
             return False
         else:
             self._load_response(data)
             return True
 
     def _load_response(self, data):
         # Being here implies we're not at the end of the headers yet,
         # since at the end of this method if headers were completely
         # loaded we replace this method with the load() method of the
         # reader we created.
         self.raw_response += data
         # This is a bogus server with bad line endings
         if self._eol not in self.raw_response:
             for bad_eol in ('\n', '\r'):
                 if (bad_eol in self.raw_response
                     # verify that bad_eol is not the end of the incoming data
                     # as this could be a response line that just got
                     # split between \r and \n.
                     and (self.raw_response.index(bad_eol) <
                          (len(self.raw_response) - 1))):
                     logger.info('bogus line endings detected, '
                                 'using %r for EOL', bad_eol)
                     self._eol = bad_eol
                     break
         # exit early if not at end of headers
         if self._end_headers not in self.raw_response or self.headers:
             return
 
         # handle 100-continue response
         hdrs, body = self.raw_response.split(self._end_headers, 1)
         http_ver, status = hdrs.split(' ', 1)
         if status.startswith('100'):
             self.raw_response = body
             self.continued = True
             logger.debug('continue seen, setting body to %r', body)
             return
 
         # arriving here means we should parse response headers
         # as all headers have arrived completely
         hdrs, body = self.raw_response.split(self._end_headers, 1)
         del self.raw_response
         if self._eol in hdrs:
             self.status_line, hdrs = hdrs.split(self._eol, 1)
         else:
             self.status_line = hdrs
             hdrs = ''
         # TODO HTTP < 1.0 support
         (self.http_version, self.status,
          self.reason) = self.status_line.split(' ', 2)
         self.status = int(self.status)
         if self._eol != EOL:
             hdrs = hdrs.replace(self._eol, '\r\n')
         headers = rfc822.Message(cStringIO.StringIO(hdrs))
         content_len = None
         if HDR_CONTENT_LENGTH in headers:
             content_len = int(headers[HDR_CONTENT_LENGTH])
         if self.http_version == HTTP_VER_1_0:
             self.will_close = True
         elif HDR_CONNECTION_CTRL in headers:
             self.will_close = (
                 headers[HDR_CONNECTION_CTRL].lower() == CONNECTION_CLOSE)
         if (HDR_XFER_ENCODING in headers
             and headers[HDR_XFER_ENCODING].lower() == XFER_ENCODING_CHUNKED):
             self._reader = _readers.ChunkedReader(self._eol)
             logger.debug('using a chunked reader')
         else:
             # HEAD responses are forbidden from returning a body, and
             # it's implausible for a CONNECT response to use
             # close-is-end logic for an OK response.
             if (self.method == 'HEAD' or
                 (self.method == 'CONNECT' and content_len is None)):
                 content_len = 0
             if content_len is not None:
                 logger.debug('using a content-length reader with length %d',
                              content_len)
                 self._reader = _readers.ContentLengthReader(content_len)
             else:
                 # Response body had no length specified and is not
                 # chunked, so the end of the body will only be
                 # identifiable by the termination of the socket by the
                 # server. My interpretation of the spec means that we
                 # are correct in hitting this case if
                 # transfer-encoding, content-length, and
                 # connection-control were left unspecified.
                 self._reader = _readers.CloseIsEndReader()
                 logger.debug('using a close-is-end reader')
                 self.will_close = True
 
         if body:
             self._reader._load(body)
         logger.debug('headers complete')
         self.headers = headers
         self._load_response = self._reader._load
 
 
 class HTTPConnection(object):
     """Connection to a single http server.
 
     Supports 100-continue and keepalives natively. Uses select() for
     non-blocking socket operations.
     """
     http_version = HTTP_VER_1_1
     response_class = HTTPResponse
 
     def __init__(self, host, port=None, use_ssl=None, ssl_validator=None,
                  timeout=TIMEOUT_DEFAULT,
                  continue_timeout=TIMEOUT_ASSUME_CONTINUE,
                  proxy_hostport=None, **ssl_opts):
         """Create a new HTTPConnection.
 
         Args:
           host: The host to which we'll connect.
           port: Optional. The port over which we'll connect. Default 80 for
                 non-ssl, 443 for ssl.
           use_ssl: Optional. Whether to use ssl. Defaults to False if port is
                    not 443, true if port is 443.
           ssl_validator: a function(socket) to validate the ssl cert
           timeout: Optional. Connection timeout, default is TIMEOUT_DEFAULT.
           continue_timeout: Optional. Timeout for waiting on an expected
                    "100 Continue" response. Default is TIMEOUT_ASSUME_CONTINUE.
           proxy_hostport: Optional. Tuple of (host, port) to use as an http
                        proxy for the connection. Default is to not use a proxy.
         """
         if port is None and host.count(':') == 1 or ']:' in host:
             host, port = host.rsplit(':', 1)
             port = int(port)
             if '[' in host:
                 host = host[1:-1]
         if use_ssl is None and port is None:
             use_ssl = False
             port = 80
         elif use_ssl is None:
             use_ssl = (port == 443)
         elif port is None:
             port = (use_ssl and 443 or 80)
         self.port = port
         if use_ssl and not socketutil.have_ssl:
             raise Exception('ssl requested but unavailable on this Python')
         self.ssl = use_ssl
         self.ssl_opts = ssl_opts
         self._ssl_validator = ssl_validator
         self.host = host
         self.sock = None
         self._current_response = None
         self._current_response_taken = False
         if proxy_hostport is None:
             self._proxy_host = self._proxy_port = None
         else:
             self._proxy_host, self._proxy_port = proxy_hostport
 
         self.timeout = timeout
         self.continue_timeout = continue_timeout
 
     def _connect(self):
         """Connect to the host and port specified in __init__."""
         if self.sock:
             return
         if self._proxy_host is not None:
             logger.info('Connecting to http proxy %s:%s',
                         self._proxy_host, self._proxy_port)
             sock = socketutil.create_connection((self._proxy_host,
                                                  self._proxy_port))
             if self.ssl:
                 # TODO proxy header support
                 data = self.buildheaders('CONNECT', '%s:%d' % (self.host,
                                                                self.port),
                                          {}, HTTP_VER_1_0)
                 sock.send(data)
                 sock.setblocking(0)
                 r = self.response_class(sock, self.timeout, 'CONNECT')
                 timeout_exc = HTTPTimeoutException(
                     'Timed out waiting for CONNECT response from proxy')
                 while not r.complete():
                     try:
                         if not r._select():
                             if not r.complete():
                                 raise timeout_exc
                     except HTTPTimeoutException:
                         # This raise/except pattern looks goofy, but
                         # _select can raise the timeout as well as the
                         # loop body. I wish it wasn't this convoluted,
                         # but I don't have a better solution
                         # immediately handy.
                         raise timeout_exc
                 if r.status != 200:
                     raise HTTPProxyConnectFailedException(
                         'Proxy connection failed: %d %s' % (r.status,
                                                             r.read()))
                 logger.info('CONNECT (for SSL) to %s:%s via proxy succeeded.',
                             self.host, self.port)
         else:
             sock = socketutil.create_connection((self.host, self.port))
         if self.ssl:
             # This is the default, but in the case of proxied SSL
             # requests the proxy logic above will have cleared
             # blocking mode, so re-enable it just to be safe.
             sock.setblocking(1)
             logger.debug('wrapping socket for ssl with options %r',
                          self.ssl_opts)
             sock = socketutil.wrap_socket(sock, **self.ssl_opts)
             if self._ssl_validator:
                 self._ssl_validator(sock)
         sock.setblocking(0)
         self.sock = sock
 
     def buildheaders(self, method, path, headers, http_ver):
         if self.ssl and self.port == 443 or self.port == 80:
             # default port for protocol, so leave it out
             hdrhost = self.host
         else:
             # include nonstandard port in header
             if ':' in self.host:  # must be IPv6
                 hdrhost = '[%s]:%d' % (self.host, self.port)
             else:
                 hdrhost = '%s:%d' % (self.host, self.port)
         if self._proxy_host and not self.ssl:
             # When talking to a regular http proxy we must send the
             # full URI, but in all other cases we must not (although
             # technically RFC 2616 says servers must accept our
             # request if we screw up, experimentally few do that
             # correctly.)
             assert path[0] == '/', 'path must start with a /'
             path = 'http://%s%s' % (hdrhost, path)
         outgoing = ['%s %s %s%s' % (method, path, http_ver, EOL)]
         headers['host'] = ('Host', hdrhost)
         headers[HDR_ACCEPT_ENCODING] = (HDR_ACCEPT_ENCODING, 'identity')
         for hdr, val in headers.itervalues():
             outgoing.append('%s: %s%s' % (hdr, val, EOL))
         outgoing.append(EOL)
         return ''.join(outgoing)
 
     def close(self):
         """Close the connection to the server.
 
         This is a no-op if the connection is already closed. The
         connection may automatically close if requested by the server
         or required by the nature of a response.
         """
         if self.sock is None:
             return
         self.sock.close()
         self.sock = None
         logger.info('closed connection to %s on %s', self.host, self.port)
 
     def busy(self):
         """Returns True if this connection object is currently in use.
 
         If a response is still pending, this will return True, even if
         the request has finished sending. In the future,
         HTTPConnection may transparently juggle multiple connections
         to the server, in which case this will be useful to detect if
         any of those connections is ready for use.
         """
         cr = self._current_response
         if cr is not None:
             if self._current_response_taken:
                 if cr.will_close:
                     self.sock = None
                     self._current_response = None
                     return False
                 elif cr.complete():
                     self._current_response = None
                     return False
             return True
         return False
 
     def request(self, method, path, body=None, headers={},
                 expect_continue=False):
         """Send a request to the server.
 
         For increased flexibility, this does not return the response
         object. Future versions of HTTPConnection that juggle multiple
         sockets will be able to send (for example) 5 requests all at
         once, and then let the requests arrive as data is
         available. Use the `getresponse()` method to retrieve the
         response.
         """
         if self.busy():
             raise httplib.CannotSendRequest(
                 'Can not send another request before '
                 'current response is read!')
         self._current_response_taken = False
 
         logger.info('sending %s request for %s to %s on port %s',
                     method, path, self.host, self.port)
         hdrs = dict((k.lower(), (k, v)) for k, v in headers.iteritems())
         if hdrs.get('expect', ('', ''))[1].lower() == '100-continue':
             expect_continue = True
         elif expect_continue:
             hdrs['expect'] = ('Expect', '100-Continue')
 
         chunked = False
         if body and HDR_CONTENT_LENGTH not in hdrs:
             if getattr(body, '__len__', False):
                 hdrs[HDR_CONTENT_LENGTH] = (HDR_CONTENT_LENGTH, len(body))
             elif getattr(body, 'read', False):
                 hdrs[HDR_XFER_ENCODING] = (HDR_XFER_ENCODING,
                                            XFER_ENCODING_CHUNKED)
                 chunked = True
             else:
                 raise BadRequestData('body has no __len__() nor read()')
 
         self._connect()
         outgoing_headers = self.buildheaders(
             method, path, hdrs, self.http_version)
         response = None
         first = True
 
         def reconnect(where):
             logger.info('reconnecting during %s', where)
             self.close()
             self._connect()
 
         while ((outgoing_headers or body)
                and not (response and response.complete())):
             select_timeout = self.timeout
             out = outgoing_headers or body
             blocking_on_continue = False
             if expect_continue and not outgoing_headers and not (
                 response and (response.headers or response.continued)):
                 logger.info(
                     'waiting up to %s seconds for'
                     ' continue response from server',
                     self.continue_timeout)
                 select_timeout = self.continue_timeout
                 blocking_on_continue = True
                 out = False
             if out:
                 w = [self.sock]
             else:
                 w = []
             r, w, x = select.select([self.sock], w, [], select_timeout)
             # if we were expecting a 100 continue and it's been long
             # enough, just go ahead and assume it's ok. This is the
             # recommended behavior from the RFC.
             if r == w == x == []:
                 if blocking_on_continue:
                     expect_continue = False
                     logger.info('no response to continue expectation from '
                                 'server, optimistically sending request body')
                 else:
                     raise HTTPTimeoutException('timeout sending data')
             was_first = first
 
             # incoming data
             if r:
                 try:
                     try:
                         data = r[0].recv(INCOMING_BUFFER_SIZE)
                     except socket.sslerror, e:
                         if e.args[0] != socket.SSL_ERROR_WANT_READ:
                             raise
                         logger.debug(
-                            'SSL_WANT_READ while sending data, retrying...')
+                            'SSL_ERROR_WANT_READ while sending data, retrying...')
                         continue
                     if not data:
                         logger.info('socket appears closed in read')
                         self.sock = None
                         self._current_response = None
                         if response is not None:
                             response._close()
                         # This if/elif ladder is a bit subtle,
                         # comments in each branch should help.
                         if response is not None and response.complete():
                             # Server responded completely and then
                             # closed the socket. We should just shut
                             # things down and let the caller get their
                             # response.
                             logger.info('Got an early response, '
                                         'aborting remaining request.')
                             break
                         elif was_first and response is None:
                             # Most likely a keepalive that got killed
                             # on the server's end. Commonly happens
                             # after getting a really large response
                             # from the server.
                             logger.info(
                                 'Connection appeared closed in read on first'
                                 ' request loop iteration, will retry.')
                             reconnect('read')
                             continue
                         else:
                             # We didn't just send the first data hunk,
                             # and either have a partial response or no
                             # response at all. There's really nothing
                             # meaningful we can do here.
                             raise HTTPStateError(
                                 'Connection appears closed after '
                                 'some request data was written, but the '
                                 'response was missing or incomplete!')
                     logger.debug('read %d bytes in request()', len(data))
                     if response is None:
                         response = self.response_class(r[0], self.timeout, method)
                     response._load_response(data)
                     # Jump to the next select() call so we load more
                     # data if the server is still sending us content.
                     continue
                 except socket.error, e:
                     if e[0] != errno.EPIPE and not was_first:
                         raise
 
             # outgoing data
             if w and out:
                 try:
                     if getattr(out, 'read', False):
                         data = out.read(OUTGOING_BUFFER_SIZE)
                         if not data:
                             continue
                         if len(data) < OUTGOING_BUFFER_SIZE:
                             if chunked:
                                 body = '0' + EOL + EOL
                             else:
                                 body = None
                         if chunked:
                             out = hex(len(data))[2:] + EOL + data + EOL
                         else:
                             out = data
                     amt = w[0].send(out)
                 except socket.error, e:
                     if e[0] == socket.SSL_ERROR_WANT_WRITE and self.ssl:
                         # This means that SSL hasn't flushed its buffer into
                         # the socket yet.
                         # TODO: find a way to block on ssl flushing its buffer
                         # similar to selecting on a raw socket.
                         continue
                     elif (e[0] not in (errno.ECONNRESET, errno.EPIPE)
                           and not first):
                         raise
                     reconnect('write')
                     amt = self.sock.send(out)
                 logger.debug('sent %d', amt)
                 first = False
                 # stash data we think we sent in case the socket breaks
                 # when we read from it
                 if was_first:
                     sent_data = out[:amt]
                 if out is body:
                     body = out[amt:]
                 else:
                     outgoing_headers = out[amt:]
 
         # close if the server response said to or responded before eating
         # the whole request
         if response is None:
             response = self.response_class(self.sock, self.timeout, method)
         complete = response.complete()
         data_left = bool(outgoing_headers or body)
         if data_left:
             logger.info('stopped sending request early, '
                          'will close the socket to be safe.')
             response.will_close = True
         if response.will_close:
             # The socket will be closed by the response, so we disown
             # the socket
             self.sock = None
         self._current_response = response
 
     def getresponse(self):
         if self._current_response is None:
             raise httplib.ResponseNotReady()
         r = self._current_response
         while r.headers is None:
             if not r._select() and not r.complete():
                 raise _readers.HTTPRemoteClosedError()
         if r.will_close:
             self.sock = None
             self._current_response = None
         elif r.complete():
             self._current_response = None
         else:
             self._current_response_taken = True
         return r
 
 
 class HTTPTimeoutException(httplib.HTTPException):
     """A timeout occurred while waiting on the server."""
 
 
 class BadRequestData(httplib.HTTPException):
     """Request body object has neither __len__ nor read."""
 
 
 class HTTPProxyConnectFailedException(httplib.HTTPException):
     """Connecting to the HTTP proxy failed."""
 
 
 class HTTPStateError(httplib.HTTPException):
     """Invalid internal state encountered."""
 
 # Forward this exception type from _readers since it needs to be part
 # of the public API.
 HTTPRemoteClosedError = _readers.HTTPRemoteClosedError
 # no-check-code

mercurial/httpconnection.py

@@ -1,284 +1,284
 # httpconnection.py - urllib2 handler for new http support
 #
 # Copyright 2005, 2006, 2007, 2008 Matt Mackall <[e-mail]>
 # Copyright 2006, 2007 Alexis S. L. Carvalho <[e-mail]>
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 # Copyright 2011 Google, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 import logging
 import socket
 import urllib
 import urllib2
 import os
 
 from mercurial import httpclient
 from mercurial import sslutil
 from mercurial import util
 from mercurial.i18n import _
 
 # moved here from url.py to avoid a cycle
 class httpsendfile(object):
     """This is a wrapper around the objects returned by python's "open".
 
     Its purpose is to send file-like objects via HTTP.
     It do however not define a __len__ attribute because the length
     might be more than Py_ssize_t can handle.
     """
 
     def __init__(self, ui, *args, **kwargs):
         # We can't just "self._data = open(*args, **kwargs)" here because there
         # is an "open" function defined in this module that shadows the global
         # one
         self.ui = ui
         self._data = open(*args, **kwargs)
         self.seek = self._data.seek
         self.close = self._data.close
         self.write = self._data.write
         self.length = os.fstat(self._data.fileno()).st_size
         self._pos = 0
         self._total = self.length // 1024 * 2
 
     def read(self, *args, **kwargs):
         try:
             ret = self._data.read(*args, **kwargs)
         except EOFError:
             self.ui.progress(_('sending'), None)
         self._pos += len(ret)
         # We pass double the max for total because we currently have
         # to send the bundle twice in the case of a server that
         # requires authentication. Since we can't know until we try
         # once whether authentication will be required, just lie to
         # the user and maybe the push succeeds suddenly at 50%.
         self.ui.progress(_('sending'), self._pos // 1024,
                          unit=_('kb'), total=self._total)
         return ret
 
 # moved here from url.py to avoid a cycle
 def readauthforuri(ui, uri, user):
     # Read configuration
     config = dict()
     for key, val in ui.configitems('auth'):
         if '.' not in key:
             ui.warn(_("ignoring invalid [auth] key '%s'\n") % key)
             continue
         group, setting = key.rsplit('.', 1)
         gdict = config.setdefault(group, dict())
         if setting in ('username', 'cert', 'key'):
             val = util.expandpath(val)
         gdict[setting] = val
 
     # Find the best match
     if '://' in uri:
         scheme, hostpath = uri.split('://', 1)
     else:
-        # py2.4.1 doesn't provide the full URI
+        # Python 2.4.1 doesn't provide the full URI
         scheme, hostpath = 'http', uri
     bestuser = None
     bestlen = 0
     bestauth = None
     for group, auth in config.iteritems():
         if user and user != auth.get('username', user):
             # If a username was set in the URI, the entry username
             # must either match it or be unset
             continue
         prefix = auth.get('prefix')
         if not prefix:
             continue
         p = prefix.split('://', 1)
         if len(p) > 1:
             schemes, prefix = [p[0]], p[1]
         else:
             schemes = (auth.get('schemes') or 'https').split()
         if (prefix == '*' or hostpath.startswith(prefix)) and \
             (len(prefix) > bestlen or (len(prefix) == bestlen and \
                 not bestuser and 'username' in auth)) \
              and scheme in schemes:
             bestlen = len(prefix)
             bestauth = group, auth
             bestuser = auth.get('username')
             if user and not bestuser:
                 auth['username'] = user
     return bestauth
 
 # Mercurial (at least until we can remove the old codepath) requires
 # that the http response object be sufficiently file-like, so we
 # provide a close() method here.
 class HTTPResponse(httpclient.HTTPResponse):
     def close(self):
         pass
 
 class HTTPConnection(httpclient.HTTPConnection):
     response_class = HTTPResponse
     def request(self, method, uri, body=None, headers={}):
         if isinstance(body, httpsendfile):
             body.seek(0)
         httpclient.HTTPConnection.request(self, method, uri, body=body,
                                           headers=headers)
 
 
 _configuredlogging = False
 LOGFMT = '%(levelname)s:%(name)s:%(lineno)d:%(message)s'
 # Subclass BOTH of these because otherwise urllib2 "helpfully"
 # reinserts them since it notices we don't include any subclasses of
 # them.
 class http2handler(urllib2.HTTPHandler, urllib2.HTTPSHandler):
     def __init__(self, ui, pwmgr):
         global _configuredlogging
         urllib2.AbstractHTTPHandler.__init__(self)
         self.ui = ui
         self.pwmgr = pwmgr
         self._connections = {}
         loglevel = ui.config('ui', 'http2debuglevel', default=None)
         if loglevel and not _configuredlogging:
             _configuredlogging = True
             logger = logging.getLogger('mercurial.httpclient')
             logger.setLevel(getattr(logging, loglevel.upper()))
             handler = logging.StreamHandler()
             handler.setFormatter(logging.Formatter(LOGFMT))
             logger.addHandler(handler)
 
     def close_all(self):
         """Close and remove all connection objects being kept for reuse."""
         for openconns in self._connections.values():
             for conn in openconns:
                 conn.close()
         self._connections = {}
 
     # shamelessly borrowed from urllib2.AbstractHTTPHandler
     def do_open(self, http_class, req, use_ssl):
         """Return an addinfourl object for the request, using http_class.
 
         http_class must implement the HTTPConnection API from httplib.
         The addinfourl return value is a file-like object.  It also
         has methods and attributes including:
             - info(): return a mimetools.Message object for the headers
             - geturl(): return the original request URL
             - code: HTTP status code
         """
         # If using a proxy, the host returned by get_host() is
         # actually the proxy. On Python 2.6.1, the real destination
         # hostname is encoded in the URI in the urllib2 request
         # object. On Python 2.6.5, it's stored in the _tunnel_host
         # attribute which has no accessor.
         tunhost = getattr(req, '_tunnel_host', None)
         host = req.get_host()
         if tunhost:
             proxyhost = host
             host = tunhost
         elif req.has_proxy():
             proxyhost = req.get_host()
             host = req.get_selector().split('://', 1)[1].split('/', 1)[0]
         else:
             proxyhost = None
 
         if proxyhost:
             if ':' in proxyhost:
                 # Note: this means we'll explode if we try and use an
                 # IPv6 http proxy. This isn't a regression, so we
                 # won't worry about it for now.
                 proxyhost, proxyport = proxyhost.rsplit(':', 1)
             else:
                 proxyport = 3128 # squid default
             proxy = (proxyhost, proxyport)
         else:
             proxy = None
 
         if not host:
             raise urllib2.URLError('no host given')
 
         connkey = use_ssl, host, proxy
         allconns = self._connections.get(connkey, [])
         conns = [c for c in allconns if not c.busy()]
         if conns:
             h = conns[0]
         else:
             if allconns:
                 self.ui.debug('all connections for %s busy, making a new '
                               'one\n' % host)
             timeout = None
             if req.timeout is not socket._GLOBAL_DEFAULT_TIMEOUT:
                 timeout = req.timeout
             h = http_class(host, timeout=timeout, proxy_hostport=proxy)
             self._connections.setdefault(connkey, []).append(h)
 
         headers = dict(req.headers)
         headers.update(req.unredirected_hdrs)
         headers = dict(
             (name.title(), val) for name, val in headers.items())
         try:
             path = req.get_selector()
             if '://' in path:
                 path = path.split('://', 1)[1].split('/', 1)[1]
             if path[0] != '/':
                 path = '/' + path
             h.request(req.get_method(), path, req.data, headers)
             r = h.getresponse()
         except socket.error, err: # XXX what error?
             raise urllib2.URLError(err)
 
         # Pick apart the HTTPResponse object to get the addinfourl
         # object initialized properly.
         r.recv = r.read
 
         resp = urllib.addinfourl(r, r.headers, req.get_full_url())
         resp.code = r.status
         resp.msg = r.reason
         return resp
 
     # httplib always uses the given host/port as the socket connect
     # target, and then allows full URIs in the request path, which it
     # then observes and treats as a signal to do proxying instead.
     def http_open(self, req):
         if req.get_full_url().startswith('https'):
             return self.https_open(req)
         return self.do_open(HTTPConnection, req, False)
 
     def https_open(self, req):
         # req.get_full_url() does not contain credentials and we may
         # need them to match the certificates.
         url = req.get_full_url()
         user, password = self.pwmgr.find_stored_password(url)
         res = readauthforuri(self.ui, url, user)
         if res:
             group, auth = res
             self.auth = auth
             self.ui.debug("using auth.%s.* for authentication\n" % group)
         else:
             self.auth = None
         return self.do_open(self._makesslconnection, req, True)
 
     def _makesslconnection(self, host, port=443, *args, **kwargs):
         keyfile = None
         certfile = None
 
         if args: # key_file
             keyfile = args.pop(0)
         if args: # cert_file
             certfile = args.pop(0)
 
         # if the user has specified different key/cert files in
         # hgrc, we prefer these
         if self.auth and 'key' in self.auth and 'cert' in self.auth:
             keyfile = self.auth['key']
             certfile = self.auth['cert']
 
         # let host port take precedence
         if ':' in host and '[' not in host or ']:' in host:
             host, port = host.rsplit(':', 1)
             port = int(port)
             if '[' in host:
                 host = host[1:-1]
 
         if keyfile:
             kwargs['keyfile'] = keyfile
         if certfile:
             kwargs['certfile'] = certfile
 
         kwargs.update(sslutil.sslkwargs(self.ui, host))
 
         con = HTTPConnection(host, port, use_ssl=True,
                              ssl_validator=sslutil.validator(self.ui, host),
                              **kwargs)
         return con

mercurial/mail.py

@@ -1,255 +1,255
 # mail.py - mail sending bits for mercurial
 #
 # Copyright 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import _
 import util, encoding
 import os, smtplib, socket, quopri, time
 import email.Header, email.MIMEText, email.Utils
 
 _oldheaderinit = email.Header.Header.__init__
 def _unifiedheaderinit(self, *args, **kw):
     """
-    Python2.7 introduces a backwards incompatible change
+    Python 2.7 introduces a backwards incompatible change
     (Python issue1974, r70772) in email.Generator.Generator code:
     pre-2.7 code passed "continuation_ws='\t'" to the Header
     constructor, and 2.7 removed this parameter.
 
     Default argument is continuation_ws=' ', which means that the
     behaviour is different in <2.7 and 2.7
 
     We consider the 2.7 behaviour to be preferable, but need
     to have an unified behaviour for versions 2.4 to 2.7
     """
     # override continuation_ws
     kw['continuation_ws'] = ' '
     _oldheaderinit(self, *args, **kw)
 
 email.Header.Header.__dict__['__init__'] = _unifiedheaderinit
 
 def _smtp(ui):
     '''build an smtp connection and return a function to send mail'''
     local_hostname = ui.config('smtp', 'local_hostname')
     tls = ui.config('smtp', 'tls', 'none')
     # backward compatible: when tls = true, we use starttls.
     starttls = tls == 'starttls' or util.parsebool(tls)
     smtps = tls == 'smtps'
     if (starttls or smtps) and not util.safehasattr(socket, 'ssl'):
         raise util.Abort(_("can't use TLS: Python SSL support not installed"))
     if smtps:
         ui.note(_('(using smtps)\n'))
         s = smtplib.SMTP_SSL(local_hostname=local_hostname)
     else:
         s = smtplib.SMTP(local_hostname=local_hostname)
     mailhost = ui.config('smtp', 'host')
     if not mailhost:
         raise util.Abort(_('smtp.host not configured - cannot send mail'))
     mailport = util.getport(ui.config('smtp', 'port', 25))
     ui.note(_('sending mail: smtp host %s, port %s\n') %
             (mailhost, mailport))
     s.connect(host=mailhost, port=mailport)
     if starttls:
         ui.note(_('(using starttls)\n'))
         s.ehlo()
         s.starttls()
         s.ehlo()
     username = ui.config('smtp', 'username')
     password = ui.config('smtp', 'password')
     if username and not password:
         password = ui.getpass()
     if username and password:
         ui.note(_('(authenticating to mail server as %s)\n') %
                   (username))
         try:
             s.login(username, password)
         except smtplib.SMTPException, inst:
             raise util.Abort(inst)
 
     def send(sender, recipients, msg):
         try:
             return s.sendmail(sender, recipients, msg)
         except smtplib.SMTPRecipientsRefused, inst:
             recipients = [r[1] for r in inst.recipients.values()]
             raise util.Abort('\n' + '\n'.join(recipients))
         except smtplib.SMTPException, inst:
             raise util.Abort(inst)
 
     return send
 
 def _sendmail(ui, sender, recipients, msg):
     '''send mail using sendmail.'''
     program = ui.config('email', 'method')
     cmdline = '%s -f %s %s' % (program, util.email(sender),
                                ' '.join(map(util.email, recipients)))
     ui.note(_('sending mail: %s\n') % cmdline)
     fp = util.popen(cmdline, 'w')
     fp.write(msg)
     ret = fp.close()
     if ret:
         raise util.Abort('%s %s' % (
             os.path.basename(program.split(None, 1)[0]),
             util.explainexit(ret)[0]))
 
 def _mbox(mbox, sender, recipients, msg):
     '''write mails to mbox'''
     fp = open(mbox, 'ab+')
     # Should be time.asctime(), but Windows prints 2-characters day
     # of month instead of one. Make them print the same thing.
     date = time.strftime('%a %b %d %H:%M:%S %Y', time.localtime())
     fp.write('From %s %s\n' % (sender, date))
     fp.write(msg)
     fp.write('\n\n')
     fp.close()
 
 def connect(ui, mbox=None):
     '''make a mail connection. return a function to send mail.
     call as sendmail(sender, list-of-recipients, msg).'''
     if mbox:
         open(mbox, 'wb').close()
         return lambda s, r, m: _mbox(mbox, s, r, m)
     if ui.config('email', 'method', 'smtp') == 'smtp':
         return _smtp(ui)
     return lambda s, r, m: _sendmail(ui, s, r, m)
 
 def sendmail(ui, sender, recipients, msg, mbox=None):
     send = connect(ui, mbox=mbox)
     return send(sender, recipients, msg)
 
 def validateconfig(ui):
     '''determine if we have enough config data to try sending email.'''
     method = ui.config('email', 'method', 'smtp')
     if method == 'smtp':
         if not ui.config('smtp', 'host'):
             raise util.Abort(_('smtp specified as email transport, '
                                'but no smtp host configured'))
     else:
         if not util.findexe(method):
             raise util.Abort(_('%r specified as email transport, '
                                'but not in PATH') % method)
 
 def mimetextpatch(s, subtype='plain', display=False):
     '''Return MIME message suitable for a patch.
     Charset will be detected as utf-8 or (possibly fake) us-ascii.
     Transfer encodings will be used if necessary.'''
 
     cs = 'us-ascii'
     if not display:
         try:
             s.decode('us-ascii')
         except UnicodeDecodeError:
             try:
                 s.decode('utf-8')
                 cs = 'utf-8'
             except UnicodeDecodeError:
                 # We'll go with us-ascii as a fallback.
                 pass
 
     return mimetextqp(s, subtype, cs)
 
 def mimetextqp(body, subtype, charset):
     '''Return MIME message.
     Quoted-printable transfer encoding will be used if necessary.
     '''
     enc = None
     for line in body.splitlines():
         if len(line) > 950:
             body = quopri.encodestring(body)
             enc = "quoted-printable"
             break
 
     msg = email.MIMEText.MIMEText(body, subtype, charset)
     if enc:
         del msg['Content-Transfer-Encoding']
         msg['Content-Transfer-Encoding'] = enc
     return msg
 
 def _charsets(ui):
     '''Obtains charsets to send mail parts not containing patches.'''
     charsets = [cs.lower() for cs in ui.configlist('email', 'charsets')]
     fallbacks = [encoding.fallbackencoding.lower(),
                  encoding.encoding.lower(), 'utf-8']
     for cs in fallbacks: # find unique charsets while keeping order
         if cs not in charsets:
             charsets.append(cs)
     return [cs for cs in charsets if not cs.endswith('ascii')]
 
 def _encode(ui, s, charsets):
     '''Returns (converted) string, charset tuple.
     Finds out best charset by cycling through sendcharsets in descending
     order. Tries both encoding and fallbackencoding for input. Only as
     last resort send as is in fake ascii.
     Caveat: Do not use for mail parts containing patches!'''
     try:
         s.decode('ascii')
     except UnicodeDecodeError:
         sendcharsets = charsets or _charsets(ui)
         for ics in (encoding.encoding, encoding.fallbackencoding):
             try:
                 u = s.decode(ics)
             except UnicodeDecodeError:
                 continue
             for ocs in sendcharsets:
                 try:
                     return u.encode(ocs), ocs
                 except UnicodeEncodeError:
                     pass
                 except LookupError:
                     ui.warn(_('ignoring invalid sendcharset: %s\n') % ocs)
     # if ascii, or all conversion attempts fail, send (broken) ascii
     return s, 'us-ascii'
 
 def headencode(ui, s, charsets=None, display=False):
     '''Returns RFC-2047 compliant header from given string.'''
     if not display:
         # split into words?
         s, cs = _encode(ui, s, charsets)
         return str(email.Header.Header(s, cs))
     return s
 
 def _addressencode(ui, name, addr, charsets=None):
     name = headencode(ui, name, charsets)
     try:
         acc, dom = addr.split('@')
         acc = acc.encode('ascii')
         dom = dom.decode(encoding.encoding).encode('idna')
         addr = '%s@%s' % (acc, dom)
     except UnicodeDecodeError:
         raise util.Abort(_('invalid email address: %s') % addr)
     except ValueError:
         try:
             # too strict?
             addr = addr.encode('ascii')
         except UnicodeDecodeError:
             raise util.Abort(_('invalid local address: %s') % addr)
     return email.Utils.formataddr((name, addr))
 
 def addressencode(ui, address, charsets=None, display=False):
     '''Turns address into RFC-2047 compliant header.'''
     if display or not address:
         return address or ''
     name, addr = email.Utils.parseaddr(address)
     return _addressencode(ui, name, addr, charsets)
 
 def addrlistencode(ui, addrs, charsets=None, display=False):
     '''Turns a list of addresses into a list of RFC-2047 compliant headers.
     A single element of input list may contain multiple addresses, but output
     always has one address per item'''
     if display:
         return [a.strip() for a in addrs if a.strip()]
 
     result = []
     for name, addr in email.Utils.getaddresses(addrs):
         if name or addr:
             result.append(_addressencode(ui, name, addr, charsets))
     return result
 
 def mimeencode(ui, s, charsets=None, display=False):
     '''creates mime text object, encodes it if needed, and sets
     charset and transfer-encoding accordingly.'''
     cs = 'us-ascii'
     if not display:
         s, cs = _encode(ui, s, charsets)
     return mimetextqp(s, 'plain', cs)

mercurial/manifest.py

@@ -1,204 +1,204
 # manifest.py - manifest revision class for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import _
 import mdiff, parsers, error, revlog, util
 import array, struct
 
 class manifestdict(dict):
     def __init__(self, mapping=None, flags=None):
         if mapping is None:
             mapping = {}
         if flags is None:
             flags = {}
         dict.__init__(self, mapping)
         self._flags = flags
     def flags(self, f):
         return self._flags.get(f, "")
     def withflags(self):
         return set(self._flags.keys())
     def set(self, f, flags):
         self._flags[f] = flags
     def copy(self):
         return manifestdict(self, dict.copy(self._flags))
 
 class manifest(revlog.revlog):
     def __init__(self, opener):
         self._mancache = None
         revlog.revlog.__init__(self, opener, "00manifest.i")
 
     def parse(self, lines):
         mfdict = manifestdict()
         parsers.parse_manifest(mfdict, mfdict._flags, lines)
         return mfdict
 
     def readdelta(self, node):
         r = self.rev(node)
         return self.parse(mdiff.patchtext(self.revdiff(self.deltaparent(r), r)))
 
     def readfast(self, node):
         '''use the faster of readdelta or read'''
         r = self.rev(node)
         deltaparent = self.deltaparent(r)
         if deltaparent != revlog.nullrev and deltaparent in self.parentrevs(r):
             return self.readdelta(node)
         return self.read(node)
 
     def read(self, node):
         if node == revlog.nullid:
             return manifestdict() # don't upset local cache
         if self._mancache and self._mancache[0] == node:
             return self._mancache[1]
         text = self.revision(node)
         arraytext = array.array('c', text)
         mapping = self.parse(text)
         self._mancache = (node, mapping, arraytext)
         return mapping
 
     def _search(self, m, s, lo=0, hi=None):
         '''return a tuple (start, end) that says where to find s within m.
 
         If the string is found m[start:end] are the line containing
         that string.  If start == end the string was not found and
         they indicate the proper sorted insertion point.
 
         m should be a buffer or a string
         s is a string'''
         def advance(i, c):
             while i < lenm and m[i] != c:
                 i += 1
             return i
         if not s:
             return (lo, lo)
         lenm = len(m)
         if not hi:
             hi = lenm
         while lo < hi:
             mid = (lo + hi) // 2
             start = mid
             while start > 0 and m[start - 1] != '\n':
                 start -= 1
             end = advance(start, '\0')
             if m[start:end] < s:
                 # we know that after the null there are 40 bytes of sha1
                 # this translates to the bisect lo = mid + 1
                 lo = advance(end + 40, '\n') + 1
             else:
                 # this translates to the bisect hi = mid
                 hi = start
         end = advance(lo, '\0')
         found = m[lo:end]
         if s == found:
             # we know that after the null there are 40 bytes of sha1
             end = advance(end + 40, '\n')
             return (lo, end + 1)
         else:
             return (lo, lo)
 
     def find(self, node, f):
         '''look up entry for a single file efficiently.
         return (node, flags) pair if found, (None, None) if not.'''
         if self._mancache and self._mancache[0] == node:
             return self._mancache[1].get(f), self._mancache[1].flags(f)
         text = self.revision(node)
         start, end = self._search(text, f)
         if start == end:
             return None, None
         l = text[start:end]
         f, n = l.split('\0')
         return revlog.bin(n[:40]), n[40:-1]
 
     def add(self, map, transaction, link, p1=None, p2=None,
             changed=None):
         # apply the changes collected during the bisect loop to our addlist
         # return a delta suitable for addrevision
         def addlistdelta(addlist, x):
             # start from the bottom up
             # so changes to the offsets don't mess things up.
             for start, end, content in reversed(x):
                 if content:
                     addlist[start:end] = array.array('c', content)
                 else:
                     del addlist[start:end]
             return "".join(struct.pack(">lll", start, end, len(content))
                            + content for start, end, content in x)
 
         def checkforbidden(l):
             for f in l:
                 if '\n' in f or '\r' in f:
                     raise error.RevlogError(
                         _("'\\n' and '\\r' disallowed in filenames: %r") % f)
 
         # if we're using the cache, make sure it is valid and
         # parented by the same node we're diffing against
         if not (changed and self._mancache and p1 and self._mancache[0] == p1):
             files = sorted(map)
             checkforbidden(files)
 
             # if this is changed to support newlines in filenames,
             # be sure to check the templates/ dir again (especially *-raw.tmpl)
             hex, flags = revlog.hex, map.flags
             text = ''.join("%s\0%s%s\n" % (f, hex(map[f]), flags(f))
                            for f in files)
             arraytext = array.array('c', text)
             cachedelta = None
         else:
             added, removed = changed
             addlist = self._mancache[2]
 
             checkforbidden(added)
             # combine the changed lists into one list for sorting
             work = [(x, False) for x in added]
             work.extend((x, True) for x in removed)
-            # this could use heapq.merge() (from python2.6+) or equivalent
+            # this could use heapq.merge() (from Python 2.6+) or equivalent
             # since the lists are already sorted
             work.sort()
 
             delta = []
             dstart = None
             dend = None
             dline = [""]
             start = 0
             # zero copy representation of addlist as a buffer
             addbuf = util.buffer(addlist)
 
             # start with a readonly loop that finds the offset of
             # each line and creates the deltas
             for f, todelete in work:
                 # bs will either be the index of the item or the insert point
                 start, end = self._search(addbuf, f, start)
                 if not todelete:
                     l = "%s\0%s%s\n" % (f, revlog.hex(map[f]), map.flags(f))
                 else:
                     if start == end:
                         # item we want to delete was not found, error out
                         raise AssertionError(
                                 _("failed to remove %s from manifest") % f)
                     l = ""
                 if dstart is not None and dstart <= start and dend >= start:
                     if dend < end:
                         dend = end
                     if l:
                         dline.append(l)
                 else:
                     if dstart is not None:
                         delta.append([dstart, dend, "".join(dline)])
                     dstart = start
                     dend = end
                     dline = [l]
 
             if dstart is not None:
                 delta.append([dstart, dend, "".join(dline)])
             # apply the delta to the addlist, and get a delta for addrevision
             cachedelta = (self.rev(p1), addlistdelta(addlist, delta))
             arraytext = addlist
             text = util.buffer(arraytext)
 
         n = self.addrevision(text, transaction, link, p1, p2, cachedelta)
         self._mancache = (n, map, arraytext)
 
         return n

mercurial/url.py

@@ -1,474 +1,475
 # url.py - HTTP handling for mercurial
 #
 # Copyright 2005, 2006, 2007, 2008 Matt Mackall <[e-mail]>
 # Copyright 2006, 2007 Alexis S. L. Carvalho <[e-mail]>
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import urllib, urllib2, httplib, os, socket, cStringIO
 from i18n import _
 import keepalive, util, sslutil
 import httpconnection as httpconnectionmod
 
 class passwordmgr(urllib2.HTTPPasswordMgrWithDefaultRealm):
     def __init__(self, ui):
         urllib2.HTTPPasswordMgrWithDefaultRealm.__init__(self)
         self.ui = ui
 
     def find_user_password(self, realm, authuri):
         authinfo = urllib2.HTTPPasswordMgrWithDefaultRealm.find_user_password(
             self, realm, authuri)
         user, passwd = authinfo
         if user and passwd:
             self._writedebug(user, passwd)
             return (user, passwd)
 
         if not user or not passwd:
             res = httpconnectionmod.readauthforuri(self.ui, authuri, user)
             if res:
                 group, auth = res
                 user, passwd = auth.get('username'), auth.get('password')
                 self.ui.debug("using auth.%s.* for authentication\n" % group)
         if not user or not passwd:
             if not self.ui.interactive():
                 raise util.Abort(_('http authorization required'))
 
             self.ui.write(_("http authorization required\n"))
             self.ui.write(_("realm: %s\n") % realm)
             if user:
                 self.ui.write(_("user: %s\n") % user)
             else:
                 user = self.ui.prompt(_("user:"), default=None)
 
             if not passwd:
                 passwd = self.ui.getpass()
 
         self.add_password(realm, authuri, user, passwd)
         self._writedebug(user, passwd)
         return (user, passwd)
 
     def _writedebug(self, user, passwd):
         msg = _('http auth: user %s, password %s\n')
         self.ui.debug(msg % (user, passwd and '*' * len(passwd) or 'not set'))
 
     def find_stored_password(self, authuri):
         return urllib2.HTTPPasswordMgrWithDefaultRealm.find_user_password(
             self, None, authuri)
 
 class proxyhandler(urllib2.ProxyHandler):
     def __init__(self, ui):
         proxyurl = ui.config("http_proxy", "host") or os.getenv('http_proxy')
         # XXX proxyauthinfo = None
 
         if proxyurl:
             # proxy can be proper url or host[:port]
             if not (proxyurl.startswith('http:') or
                     proxyurl.startswith('https:')):
                 proxyurl = 'http://' + proxyurl + '/'
             proxy = util.url(proxyurl)
             if not proxy.user:
                 proxy.user = ui.config("http_proxy", "user")
                 proxy.passwd = ui.config("http_proxy", "passwd")
 
             # see if we should use a proxy for this url
             no_list = ["localhost", "127.0.0.1"]
             no_list.extend([p.lower() for
                             p in ui.configlist("http_proxy", "no")])
             no_list.extend([p.strip().lower() for
                             p in os.getenv("no_proxy", '').split(',')
                             if p.strip()])
             # "http_proxy.always" config is for running tests on localhost
             if ui.configbool("http_proxy", "always"):
                 self.no_list = []
             else:
                 self.no_list = no_list
 
             proxyurl = str(proxy)
             proxies = {'http': proxyurl, 'https': proxyurl}
             ui.debug('proxying through http://%s:%s\n' %
                       (proxy.host, proxy.port))
         else:
             proxies = {}
 
         # urllib2 takes proxy values from the environment and those
         # will take precedence if found. So, if there's a config entry
         # defining a proxy, drop the environment ones
         if ui.config("http_proxy", "host"):
             for env in ["HTTP_PROXY", "http_proxy", "no_proxy"]:
                 try:
                     if env in os.environ:
                         del os.environ[env]
                 except OSError:
                     pass
 
         urllib2.ProxyHandler.__init__(self, proxies)
         self.ui = ui
 
     def proxy_open(self, req, proxy, type_):
         host = req.get_host().split(':')[0]
         if host in self.no_list:
             return None
 
         # work around a bug in Python < 2.4.2
         # (it leaves a "\n" at the end of Proxy-authorization headers)
         baseclass = req.__class__
         class _request(baseclass):
             def add_header(self, key, val):
                 if key.lower() == 'proxy-authorization':
                     val = val.strip()
                 return baseclass.add_header(self, key, val)
         req.__class__ = _request
 
         return urllib2.ProxyHandler.proxy_open(self, req, proxy, type_)
 
 def _gen_sendfile(orgsend):
     def _sendfile(self, data):
         # send a file
         if isinstance(data, httpconnectionmod.httpsendfile):
             # if auth required, some data sent twice, so rewind here
             data.seek(0)
             for chunk in util.filechunkiter(data):
                 orgsend(self, chunk)
         else:
             orgsend(self, data)
     return _sendfile
 
 has_https = util.safehasattr(urllib2, 'HTTPSHandler')
 if has_https:
     try:
         _create_connection = socket.create_connection
     except AttributeError:
         _GLOBAL_DEFAULT_TIMEOUT = object()
 
         def _create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT,
                                source_address=None):
             # lifted from Python 2.6
 
             msg = "getaddrinfo returns an empty list"
             host, port = address
             for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
                 af, socktype, proto, canonname, sa = res
                 sock = None
                 try:
                     sock = socket.socket(af, socktype, proto)
                     if timeout is not _GLOBAL_DEFAULT_TIMEOUT:
                         sock.settimeout(timeout)
                     if source_address:
                         sock.bind(source_address)
                     sock.connect(sa)
                     return sock
 
                 except socket.error, msg:
                     if sock is not None:
                         sock.close()
 
             raise socket.error, msg
 
 class httpconnection(keepalive.HTTPConnection):
     # must be able to send big bundle as stream.
     send = _gen_sendfile(keepalive.HTTPConnection.send)
 
     def connect(self):
         if has_https and self.realhostport: # use CONNECT proxy
             self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             self.sock.connect((self.host, self.port))
             if _generic_proxytunnel(self):
                 # we do not support client X.509 certificates
                 self.sock = sslutil.ssl_wrap_socket(self.sock, None, None)
         else:
             keepalive.HTTPConnection.connect(self)
 
     def getresponse(self):
         proxyres = getattr(self, 'proxyres', None)
         if proxyres:
             if proxyres.will_close:
                 self.close()
             self.proxyres = None
             return proxyres
         return keepalive.HTTPConnection.getresponse(self)
 
 # general transaction handler to support different ways to handle
 # HTTPS proxying before and after Python 2.6.3.
 def _generic_start_transaction(handler, h, req):
     tunnel_host = getattr(req, '_tunnel_host', None)
     if tunnel_host:
         if tunnel_host[:7] not in ['http://', 'https:/']:
             tunnel_host = 'https://' + tunnel_host
         new_tunnel = True
     else:
         tunnel_host = req.get_selector()
         new_tunnel = False
 
     if new_tunnel or tunnel_host == req.get_full_url(): # has proxy
         u = util.url(tunnel_host)
         if new_tunnel or u.scheme == 'https': # only use CONNECT for HTTPS
             h.realhostport = ':'.join([u.host, (u.port or '443')])
             h.headers = req.headers.copy()
             h.headers.update(handler.parent.addheaders)
             return
 
     h.realhostport = None
     h.headers = None
 
 def _generic_proxytunnel(self):
     proxyheaders = dict(
             [(x, self.headers[x]) for x in self.headers
              if x.lower().startswith('proxy-')])
     self._set_hostport(self.host, self.port)
     self.send('CONNECT %s HTTP/1.0\r\n' % self.realhostport)
     for header in proxyheaders.iteritems():
         self.send('%s: %s\r\n' % header)
     self.send('\r\n')
 
     # majority of the following code is duplicated from
     # httplib.HTTPConnection as there are no adequate places to
     # override functions to provide the needed functionality
     res = self.response_class(self.sock,
                               strict=self.strict,
                               method=self._method)
 
     while True:
         version, status, reason = res._read_status()
         if status != httplib.CONTINUE:
             break
         while True:
             skip = res.fp.readline().strip()
             if not skip:
                 break
     res.status = status
     res.reason = reason.strip()
 
     if res.status == 200:
         while True:
             line = res.fp.readline()
             if line == '\r\n':
                 break
         return True
 
     if version == 'HTTP/1.0':
         res.version = 10
     elif version.startswith('HTTP/1.'):
         res.version = 11
     elif version == 'HTTP/0.9':
         res.version = 9
     else:
         raise httplib.UnknownProtocol(version)
 
     if res.version == 9:
         res.length = None
         res.chunked = 0
         res.will_close = 1
         res.msg = httplib.HTTPMessage(cStringIO.StringIO())
         return False
 
     res.msg = httplib.HTTPMessage(res.fp)
     res.msg.fp = None
 
     # are we using the chunked-style of transfer encoding?
     trenc = res.msg.getheader('transfer-encoding')
     if trenc and trenc.lower() == "chunked":
         res.chunked = 1
         res.chunk_left = None
     else:
         res.chunked = 0
 
     # will the connection close at the end of the response?
     res.will_close = res._check_close()
 
     # do we have a Content-Length?
-    # NOTE: RFC 2616, S4.4, #3 says we ignore this if tr_enc is "chunked"
+    # NOTE: RFC 2616, section 4.4, #3 says we ignore this if
+    # transfer-encoding is "chunked"
     length = res.msg.getheader('content-length')
     if length and not res.chunked:
         try:
             res.length = int(length)
         except ValueError:
             res.length = None
         else:
             if res.length < 0:  # ignore nonsensical negative lengths
                 res.length = None
     else:
         res.length = None
 
     # does the body have a fixed length? (of zero)
     if (status == httplib.NO_CONTENT or status == httplib.NOT_MODIFIED or
         100 <= status < 200 or # 1xx codes
         res._method == 'HEAD'):
         res.length = 0
 
     # if the connection remains open, and we aren't using chunked, and
     # a content-length was not provided, then assume that the connection
     # WILL close.
     if (not res.will_close and
        not res.chunked and
        res.length is None):
         res.will_close = 1
 
     self.proxyres = res
 
     return False
 
 class httphandler(keepalive.HTTPHandler):
     def http_open(self, req):
         return self.do_open(httpconnection, req)
 
     def _start_transaction(self, h, req):
         _generic_start_transaction(self, h, req)
         return keepalive.HTTPHandler._start_transaction(self, h, req)
 
 if has_https:
     class httpsconnection(httplib.HTTPSConnection):
         response_class = keepalive.HTTPResponse
         # must be able to send big bundle as stream.
         send = _gen_sendfile(keepalive.safesend)
         getresponse = keepalive.wrapgetresponse(httplib.HTTPSConnection)
 
         def connect(self):
             self.sock = _create_connection((self.host, self.port))
 
             host = self.host
             if self.realhostport: # use CONNECT proxy
                 _generic_proxytunnel(self)
                 host = self.realhostport.rsplit(':', 1)[0]
             self.sock = sslutil.ssl_wrap_socket(
                 self.sock, self.key_file, self.cert_file,
                 **sslutil.sslkwargs(self.ui, host))
             sslutil.validator(self.ui, host)(self.sock)
 
     class httpshandler(keepalive.KeepAliveHandler, urllib2.HTTPSHandler):
         def __init__(self, ui):
             keepalive.KeepAliveHandler.__init__(self)
             urllib2.HTTPSHandler.__init__(self)
             self.ui = ui
             self.pwmgr = passwordmgr(self.ui)
 
         def _start_transaction(self, h, req):
             _generic_start_transaction(self, h, req)
             return keepalive.KeepAliveHandler._start_transaction(self, h, req)
 
         def https_open(self, req):
             # req.get_full_url() does not contain credentials and we may
             # need them to match the certificates.
             url = req.get_full_url()
             user, password = self.pwmgr.find_stored_password(url)
             res = httpconnectionmod.readauthforuri(self.ui, url, user)
             if res:
                 group, auth = res
                 self.auth = auth
                 self.ui.debug("using auth.%s.* for authentication\n" % group)
             else:
                 self.auth = None
             return self.do_open(self._makeconnection, req)
 
         def _makeconnection(self, host, port=None, *args, **kwargs):
             keyfile = None
             certfile = None
 
             if len(args) >= 1: # key_file
                 keyfile = args[0]
             if len(args) >= 2: # cert_file
                 certfile = args[1]
             args = args[2:]
 
             # if the user has specified different key/cert files in
             # hgrc, we prefer these
             if self.auth and 'key' in self.auth and 'cert' in self.auth:
                 keyfile = self.auth['key']
                 certfile = self.auth['cert']
 
             conn = httpsconnection(host, port, keyfile, certfile, *args,
                                    **kwargs)
             conn.ui = self.ui
             return conn
 
 class httpdigestauthhandler(urllib2.HTTPDigestAuthHandler):
     def __init__(self, *args, **kwargs):
         urllib2.HTTPDigestAuthHandler.__init__(self, *args, **kwargs)
         self.retried_req = None
 
     def reset_retry_count(self):
         # Python 2.6.5 will call this on 401 or 407 errors and thus loop
         # forever. We disable reset_retry_count completely and reset in
         # http_error_auth_reqed instead.
         pass
 
     def http_error_auth_reqed(self, auth_header, host, req, headers):
         # Reset the retry counter once for each request.
         if req is not self.retried_req:
             self.retried_req = req
             self.retried = 0
         # In python < 2.5 AbstractDigestAuthHandler raises a ValueError if
         # it doesn't know about the auth type requested. This can happen if
         # somebody is using BasicAuth and types a bad password.
         try:
             return urllib2.HTTPDigestAuthHandler.http_error_auth_reqed(
                         self, auth_header, host, req, headers)
         except ValueError, inst:
             arg = inst.args[0]
             if arg.startswith("AbstractDigestAuthHandler doesn't know "):
                 return
             raise
 
 class httpbasicauthhandler(urllib2.HTTPBasicAuthHandler):
     def __init__(self, *args, **kwargs):
         urllib2.HTTPBasicAuthHandler.__init__(self, *args, **kwargs)
         self.retried_req = None
 
     def reset_retry_count(self):
         # Python 2.6.5 will call this on 401 or 407 errors and thus loop
         # forever. We disable reset_retry_count completely and reset in
         # http_error_auth_reqed instead.
         pass
 
     def http_error_auth_reqed(self, auth_header, host, req, headers):
         # Reset the retry counter once for each request.
         if req is not self.retried_req:
             self.retried_req = req
             self.retried = 0
         return urllib2.HTTPBasicAuthHandler.http_error_auth_reqed(
                         self, auth_header, host, req, headers)
 
 handlerfuncs = []
 
 def opener(ui, authinfo=None):
     '''
     construct an opener suitable for urllib2
     authinfo will be added to the password manager
     '''
     if ui.configbool('ui', 'usehttp2', False):
         handlers = [httpconnectionmod.http2handler(ui, passwordmgr(ui))]
     else:
         handlers = [httphandler()]
         if has_https:
             handlers.append(httpshandler(ui))
 
     handlers.append(proxyhandler(ui))
 
     passmgr = passwordmgr(ui)
     if authinfo is not None:
         passmgr.add_password(*authinfo)
         user, passwd = authinfo[2:4]
         ui.debug('http auth: user %s, password %s\n' %
                  (user, passwd and '*' * len(passwd) or 'not set'))
 
     handlers.extend((httpbasicauthhandler(passmgr),
                      httpdigestauthhandler(passmgr)))
     handlers.extend([h(ui, passmgr) for h in handlerfuncs])
     opener = urllib2.build_opener(*handlers)
 
     # 1.0 here is the _protocol_ version
     opener.addheaders = [('User-agent', 'mercurial/proto-1.0')]
     opener.addheaders.append(('Accept', 'application/mercurial-0.1'))
     return opener
 
 def open(ui, url_, data=None):
     u = util.url(url_)
     if u.scheme:
         u.scheme = u.scheme.lower()
         url_, authinfo = u.authinfo()
     else:
         path = util.normpath(os.path.abspath(url_))
         url_ = 'file://' + urllib.pathname2url(path)
         authinfo = None
     return opener(ui, authinfo).open(url_, data)

mercurial/win32.py

@@ -1,393 +1,393
 # win32.py - utility functions that use win32 API
 #
 # Copyright 2005-2009 Matt Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import ctypes, errno, os, subprocess, random
 
 _kernel32 = ctypes.windll.kernel32
 _advapi32 = ctypes.windll.advapi32
 _user32 = ctypes.windll.user32
 
 _BOOL = ctypes.c_long
 _WORD = ctypes.c_ushort
 _DWORD = ctypes.c_ulong
 _UINT = ctypes.c_uint
 _LONG = ctypes.c_long
 _LPCSTR = _LPSTR = ctypes.c_char_p
 _HANDLE = ctypes.c_void_p
 _HWND = _HANDLE
 
 _INVALID_HANDLE_VALUE = _HANDLE(-1).value
 
 # GetLastError
 _ERROR_SUCCESS = 0
 _ERROR_INVALID_PARAMETER = 87
 _ERROR_INSUFFICIENT_BUFFER = 122
 
 # WPARAM is defined as UINT_PTR (unsigned type)
 # LPARAM is defined as LONG_PTR (signed type)
 if ctypes.sizeof(ctypes.c_long) == ctypes.sizeof(ctypes.c_void_p):
     _WPARAM = ctypes.c_ulong
     _LPARAM = ctypes.c_long
 elif ctypes.sizeof(ctypes.c_longlong) == ctypes.sizeof(ctypes.c_void_p):
     _WPARAM = ctypes.c_ulonglong
     _LPARAM = ctypes.c_longlong
 
 class _FILETIME(ctypes.Structure):
     _fields_ = [('dwLowDateTime', _DWORD),
                 ('dwHighDateTime', _DWORD)]
 
 class _BY_HANDLE_FILE_INFORMATION(ctypes.Structure):
     _fields_ = [('dwFileAttributes', _DWORD),
                 ('ftCreationTime', _FILETIME),
                 ('ftLastAccessTime', _FILETIME),
                 ('ftLastWriteTime', _FILETIME),
                 ('dwVolumeSerialNumber', _DWORD),
                 ('nFileSizeHigh', _DWORD),
                 ('nFileSizeLow', _DWORD),
                 ('nNumberOfLinks', _DWORD),
                 ('nFileIndexHigh', _DWORD),
                 ('nFileIndexLow', _DWORD)]
 
 # CreateFile 
 _FILE_SHARE_READ = 0x00000001
 _FILE_SHARE_WRITE = 0x00000002
 _FILE_SHARE_DELETE = 0x00000004
 
 _OPEN_EXISTING = 3
 
 _FILE_FLAG_BACKUP_SEMANTICS = 0x02000000
 
 # SetFileAttributes
 _FILE_ATTRIBUTE_NORMAL = 0x80
 _FILE_ATTRIBUTE_NOT_CONTENT_INDEXED = 0x2000
 
 # Process Security and Access Rights
 _PROCESS_QUERY_INFORMATION = 0x0400
 
 # GetExitCodeProcess
 _STILL_ACTIVE = 259
 
 class _STARTUPINFO(ctypes.Structure):
     _fields_ = [('cb', _DWORD),
                 ('lpReserved', _LPSTR),
                 ('lpDesktop', _LPSTR),
                 ('lpTitle', _LPSTR),
                 ('dwX', _DWORD),
                 ('dwY', _DWORD),
                 ('dwXSize', _DWORD),
                 ('dwYSize', _DWORD),
                 ('dwXCountChars', _DWORD),
                 ('dwYCountChars', _DWORD),
                 ('dwFillAttribute', _DWORD),
                 ('dwFlags', _DWORD),
                 ('wShowWindow', _WORD),
                 ('cbReserved2', _WORD),
                 ('lpReserved2', ctypes.c_char_p),
                 ('hStdInput', _HANDLE),
                 ('hStdOutput', _HANDLE),
                 ('hStdError', _HANDLE)]
 
 class _PROCESS_INFORMATION(ctypes.Structure):
     _fields_ = [('hProcess', _HANDLE),
                 ('hThread', _HANDLE),
                 ('dwProcessId', _DWORD),
                 ('dwThreadId', _DWORD)]
 
 _CREATE_NO_WINDOW = 0x08000000
 _SW_HIDE = 0
 
 class _COORD(ctypes.Structure):
     _fields_ = [('X', ctypes.c_short),
                 ('Y', ctypes.c_short)]
 
 class _SMALL_RECT(ctypes.Structure):
     _fields_ = [('Left', ctypes.c_short),
                 ('Top', ctypes.c_short),
                 ('Right', ctypes.c_short),
                 ('Bottom', ctypes.c_short)]
 
 class _CONSOLE_SCREEN_BUFFER_INFO(ctypes.Structure):
     _fields_ = [('dwSize', _COORD),
                 ('dwCursorPosition', _COORD),
                 ('wAttributes', _WORD),
                 ('srWindow', _SMALL_RECT),
                 ('dwMaximumWindowSize', _COORD)]
 
 _STD_ERROR_HANDLE = _DWORD(-12).value
 
 # types of parameters of C functions used (required by pypy)
 
 _kernel32.CreateFileA.argtypes = [_LPCSTR, _DWORD, _DWORD, ctypes.c_void_p,
     _DWORD, _DWORD, _HANDLE]
 _kernel32.CreateFileA.restype = _HANDLE
 
 _kernel32.GetFileInformationByHandle.argtypes = [_HANDLE, ctypes.c_void_p]
 _kernel32.GetFileInformationByHandle.restype = _BOOL
 
 _kernel32.CloseHandle.argtypes = [_HANDLE]
 _kernel32.CloseHandle.restype = _BOOL
 
 try:
     _kernel32.CreateHardLinkA.argtypes = [_LPCSTR, _LPCSTR, ctypes.c_void_p]
     _kernel32.CreateHardLinkA.restype = _BOOL
 except AttributeError:
     pass
 
 _kernel32.SetFileAttributesA.argtypes = [_LPCSTR, _DWORD]
 _kernel32.SetFileAttributesA.restype = _BOOL
 
 _kernel32.OpenProcess.argtypes = [_DWORD, _BOOL, _DWORD]
 _kernel32.OpenProcess.restype = _HANDLE
 
 _kernel32.GetExitCodeProcess.argtypes = [_HANDLE, ctypes.c_void_p]
 _kernel32.GetExitCodeProcess.restype = _BOOL
 
 _kernel32.GetLastError.argtypes = []
 _kernel32.GetLastError.restype = _DWORD
 
 _kernel32.GetModuleFileNameA.argtypes = [_HANDLE, ctypes.c_void_p, _DWORD]
 _kernel32.GetModuleFileNameA.restype = _DWORD
 
 _kernel32.CreateProcessA.argtypes = [_LPCSTR, _LPCSTR, ctypes.c_void_p,
     ctypes.c_void_p, _BOOL, _DWORD, ctypes.c_void_p, _LPCSTR, ctypes.c_void_p,
     ctypes.c_void_p]
 _kernel32.CreateProcessA.restype = _BOOL
 
 _kernel32.ExitProcess.argtypes = [_UINT]
 _kernel32.ExitProcess.restype = None
 
 _kernel32.GetCurrentProcessId.argtypes = []
 _kernel32.GetCurrentProcessId.restype = _DWORD
 
 _SIGNAL_HANDLER = ctypes.WINFUNCTYPE(_BOOL, _DWORD)
 _kernel32.SetConsoleCtrlHandler.argtypes = [_SIGNAL_HANDLER, _BOOL]
 _kernel32.SetConsoleCtrlHandler.restype = _BOOL
 
 _kernel32.GetStdHandle.argtypes = [_DWORD]
 _kernel32.GetStdHandle.restype = _HANDLE
 
 _kernel32.GetConsoleScreenBufferInfo.argtypes = [_HANDLE, ctypes.c_void_p]
 _kernel32.GetConsoleScreenBufferInfo.restype = _BOOL
 
 _advapi32.GetUserNameA.argtypes = [ctypes.c_void_p, ctypes.c_void_p]
 _advapi32.GetUserNameA.restype = _BOOL
 
 _user32.GetWindowThreadProcessId.argtypes = [_HANDLE, ctypes.c_void_p]
 _user32.GetWindowThreadProcessId.restype = _DWORD
 
 _user32.ShowWindow.argtypes = [_HANDLE, ctypes.c_int]
 _user32.ShowWindow.restype = _BOOL
 
 _WNDENUMPROC = ctypes.WINFUNCTYPE(_BOOL, _HWND, _LPARAM)
 _user32.EnumWindows.argtypes = [_WNDENUMPROC, _LPARAM]
 _user32.EnumWindows.restype = _BOOL
 
 def _raiseoserror(name):
     err = ctypes.WinError()
     raise OSError(err.errno, '%s: %s' % (name, err.strerror))
 
 def _getfileinfo(name):
     fh = _kernel32.CreateFileA(name, 0,
             _FILE_SHARE_READ | _FILE_SHARE_WRITE | _FILE_SHARE_DELETE,
             None, _OPEN_EXISTING, _FILE_FLAG_BACKUP_SEMANTICS, None)
     if fh == _INVALID_HANDLE_VALUE:
         _raiseoserror(name)
     try:
         fi = _BY_HANDLE_FILE_INFORMATION()
         if not _kernel32.GetFileInformationByHandle(fh, ctypes.byref(fi)):
             _raiseoserror(name)
         return fi
     finally:
         _kernel32.CloseHandle(fh)
 
 def oslink(src, dst):
     try:
         if not _kernel32.CreateHardLinkA(dst, src, None):
             _raiseoserror(src)
     except AttributeError: # Wine doesn't support this function
         _raiseoserror(src)
 
 def nlinks(name):
     '''return number of hardlinks for the given file'''
     return _getfileinfo(name).nNumberOfLinks
 
 def samefile(path1, path2):
     '''Returns whether path1 and path2 refer to the same file or directory.'''
     res1 = _getfileinfo(path1)
     res2 = _getfileinfo(path2)
     return (res1.dwVolumeSerialNumber == res2.dwVolumeSerialNumber
         and res1.nFileIndexHigh == res2.nFileIndexHigh
         and res1.nFileIndexLow == res2.nFileIndexLow)
 
 def samedevice(path1, path2):
     '''Returns whether path1 and path2 are on the same device.'''
     res1 = _getfileinfo(path1)
     res2 = _getfileinfo(path2)
     return res1.dwVolumeSerialNumber == res2.dwVolumeSerialNumber
 
 def testpid(pid):
     '''return True if pid is still running or unable to
     determine, False otherwise'''
     h = _kernel32.OpenProcess(_PROCESS_QUERY_INFORMATION, False, pid)
     if h:
         try:
             status = _DWORD()
             if _kernel32.GetExitCodeProcess(h, ctypes.byref(status)):
                 return status.value == _STILL_ACTIVE
         finally:
             _kernel32.CloseHandle(h)
     return _kernel32.GetLastError() != _ERROR_INVALID_PARAMETER
 
 def executablepath():
     '''return full path of hg.exe'''
     size = 600
     buf = ctypes.create_string_buffer(size + 1)
     len = _kernel32.GetModuleFileNameA(None, ctypes.byref(buf), size)
     if len == 0:
         raise ctypes.WinError
     elif len == size:
         raise ctypes.WinError(_ERROR_INSUFFICIENT_BUFFER)
     return buf.value
 
 def getuser():
     '''return name of current user'''
     size = _DWORD(300)
     buf = ctypes.create_string_buffer(size.value + 1)
     if not _advapi32.GetUserNameA(ctypes.byref(buf), ctypes.byref(size)):
         raise ctypes.WinError
     return buf.value
 
 _signalhandler = []
 
 def setsignalhandler():
     '''Register a termination handler for console events including
     CTRL+C. python signal handlers do not work well with socket
     operations.
     '''
     def handler(event):
         _kernel32.ExitProcess(1)
 
     if _signalhandler:
         return # already registered
     h = _SIGNAL_HANDLER(handler)
     _signalhandler.append(h) # needed to prevent garbage collection
     if not _kernel32.SetConsoleCtrlHandler(h, True):
         raise ctypes.WinError
 
 def hidewindow():
 
     def callback(hwnd, pid):
         wpid = _DWORD()
         _user32.GetWindowThreadProcessId(hwnd, ctypes.byref(wpid))
         if pid == wpid.value:
             _user32.ShowWindow(hwnd, _SW_HIDE)
             return False # stop enumerating windows
         return True
 
     pid = _kernel32.GetCurrentProcessId()
     _user32.EnumWindows(_WNDENUMPROC(callback), pid)
 
 def termwidth():
     # cmd.exe does not handle CR like a unix console, the CR is
     # counted in the line length. On 80 columns consoles, if 80
     # characters are written, the following CR won't apply on the
     # current line but on the new one. Keep room for it.
     width = 79
     # Query stderr to avoid problems with redirections
     screenbuf = _kernel32.GetStdHandle(
                   _STD_ERROR_HANDLE) # don't close the handle returned
     if screenbuf is None or screenbuf == _INVALID_HANDLE_VALUE:
         return width
     csbi = _CONSOLE_SCREEN_BUFFER_INFO()
     if not _kernel32.GetConsoleScreenBufferInfo(
                         screenbuf, ctypes.byref(csbi)):
         return width
     width = csbi.srWindow.Right - csbi.srWindow.Left
     return width
 
 def spawndetached(args):
     # No standard library function really spawns a fully detached
     # process under win32 because they allocate pipes or other objects
     # to handle standard streams communications. Passing these objects
     # to the child process requires handle inheritance to be enabled
     # which makes really detached processes impossible.
     si = _STARTUPINFO()
     si.cb = ctypes.sizeof(_STARTUPINFO)
 
     pi = _PROCESS_INFORMATION()
 
     env = ''
     for k in os.environ:
         env += "%s=%s\0" % (k, os.environ[k])
     if not env:
         env = '\0'
     env += '\0'
 
     args = subprocess.list2cmdline(args)
-    # Not running the command in shell mode makes python26 hang when
+    # Not running the command in shell mode makes Python 2.6 hang when
     # writing to hgweb output socket.
     comspec = os.environ.get("COMSPEC", "cmd.exe")
     args = comspec + " /c " + args
 
     res = _kernel32.CreateProcessA(
         None, args, None, None, False, _CREATE_NO_WINDOW,
         env, os.getcwd(), ctypes.byref(si), ctypes.byref(pi))
     if not res:
         raise ctypes.WinError
 
     return pi.dwProcessId
 
 def unlink(f):
     '''try to implement POSIX' unlink semantics on Windows'''
 
     # POSIX allows to unlink and rename open files. Windows has serious
     # problems with doing that:
     # - Calling os.unlink (or os.rename) on a file f fails if f or any
     #   hardlinked copy of f has been opened with Python's open(). There is no
     #   way such a file can be deleted or renamed on Windows (other than
     #   scheduling the delete or rename for the next reboot).
     # - Calling os.unlink on a file that has been opened with Mercurial's
     #   posixfile (or comparable methods) will delay the actual deletion of
     #   the file for as long as the file is held open. The filename is blocked
     #   during that time and cannot be used for recreating a new file under
     #   that same name ("zombie file"). Directories containing such zombie files
     #   cannot be removed or moved.
     # A file that has been opened with posixfile can be renamed, so we rename
     # f to a random temporary name before calling os.unlink on it. This allows
     # callers to recreate f immediately while having other readers do their
     # implicit zombie filename blocking on a temporary name.
 
     for tries in xrange(10):
         temp = '%s-%08x' % (f, random.randint(0, 0xffffffff))
         try:
             os.rename(f, temp)  # raises OSError EEXIST if temp exists
             break
         except OSError, e:
             if e.errno != errno.EEXIST:
                 raise
     else:
         raise IOError, (errno.EEXIST, "No usable temporary filename found")
 
     try:
         os.unlink(temp)
     except OSError:
         # The unlink might have failed because the READONLY attribute may heave
         # been set on the original file. Rename works fine with READONLY set,
         # but not os.unlink. Reset all attributes and try again.
         _kernel32.SetFileAttributesA(temp, _FILE_ATTRIBUTE_NORMAL)
         try:
             os.unlink(temp)
         except OSError:
             # The unlink might have failed due to some very rude AV-Scanners.
             # Leaking a tempfile is the lesser evil than aborting here and
             # leaving some potentially serious inconsistencies.
             pass
 
 def makedir(path, notindexed):
     os.mkdir(path)
     if notindexed:
         _kernel32.SetFileAttributesA(path, _FILE_ATTRIBUTE_NOT_CONTENT_INDEXED)

tests/test-check-code.t

@@ -1,142 +1,142
   $ cat > correct.py <<EOF
   > def toto(arg1, arg2):
   >     del arg2
   >     return (5 + 6, 9)
   > EOF
   $ cat > wrong.py <<EOF
   > def toto( arg1, arg2):
   >     del(arg2)
   >     return ( 5+6, 9)
   > EOF
   $ cat > quote.py <<EOF
   > # let's use quote in comments
   > (''' ( 4x5 )
   > but """\\''' and finally''',
   > """let's fool checkpatch""", '1+2',
   > '"""', 42+1, """and
   > ( 4-1 ) """, "( 1+1 )\" and ")
   > a, '\\\\\\\\', "\\\\\\" x-2", "c-1"
   > EOF
   $ cat > non-py24.py <<EOF
   > # Using builtins that does not exist in Python 2.4
   > if any():
   >     x = all()
   >     y = format(x)
   > 
   > # Do not complain about our own definition
   > def any(x):
   >     pass
   > 
   > # try/except/finally block does not exist in Python 2.4
   >     try:
   >         pass
   >     except StandardError, inst:
   >         pass
   >     finally:
   >         pass
   > 
   > # nested try/finally+try/except is allowed
   >     try:
   >         try:
   >             pass
   >         except StandardError, inst:
   >             pass
   >     finally:
   >         pass
   > EOF
   $ cat > classstyle.py <<EOF
   > class newstyle_class(object):
   >     pass
   > 
   > class oldstyle_class:
   >     pass
   > 
   > class empty():
   >     pass
   > 
   > no_class = 1:
   >     pass
   > EOF
   $ check_code="$TESTDIR"/../contrib/check-code.py
   $ "$check_code" ./wrong.py ./correct.py ./quote.py ./non-py24.py ./classstyle.py
   ./wrong.py:1:
    > def toto( arg1, arg2):
    gratuitous whitespace in () or []
   ./wrong.py:2:
    >     del(arg2)
    Python keyword is not a function
   ./wrong.py:3:
    >     return ( 5+6, 9)
    gratuitous whitespace in () or []
    missing whitespace in expression
   ./quote.py:5:
    > '"""', 42+1, """and
    missing whitespace in expression
   ./non-py24.py:2:
    > if any():
    any/all/format not available in Python 2.4
   ./non-py24.py:3:
    >     x = all()
    any/all/format not available in Python 2.4
   ./non-py24.py:4:
    >     y = format(x)
    any/all/format not available in Python 2.4
   ./non-py24.py:11:
    >     try:
-   no try/except/finally in Py2.4
+   no try/except/finally in Python 2.4
   ./classstyle.py:4:
    > class oldstyle_class:
    old-style class, use class foo(object)
   ./classstyle.py:7:
    > class empty():
    class foo() not available in Python 2.4, use class foo(object)
   [1]
 
   $ cat > is-op.py <<EOF
   > # is-operator comparing number or string literal
   > x = None
   > y = x is 'foo'
   > y = x is "foo"
   > y = x is 5346
   > y = x is -6
   > y = x is not 'foo'
   > y = x is not "foo"
   > y = x is not 5346
   > y = x is not -6
   > EOF
 
   $ "$check_code" ./is-op.py
   ./is-op.py:3:
    > y = x is 'foo'
    object comparison with literal
   ./is-op.py:4:
    > y = x is "foo"
    object comparison with literal
   ./is-op.py:5:
    > y = x is 5346
    object comparison with literal
   ./is-op.py:6:
    > y = x is -6
    object comparison with literal
   ./is-op.py:7:
    > y = x is not 'foo'
    object comparison with literal
   ./is-op.py:8:
    > y = x is not "foo"
    object comparison with literal
   ./is-op.py:9:
    > y = x is not 5346
    object comparison with literal
   ./is-op.py:10:
    > y = x is not -6
    object comparison with literal
   [1]
 
   $ cat > warning.py <<EOF
   > except:
   > EOF
   $ "$check_code" warning.py --warning --nolineno
   warning.py:0:
    > except:
    warning: naked except clause
   [1]