| Tor Norbye | 3a2425a | 2013-11-04 10:16:08 -0800 | [diff] [blame^] | 1 | """An object-oriented interface to .netrc files.""" |
| 2 | |
| 3 | # Module and documentation by Eric S. Raymond, 21 Dec 1998 |
| 4 | |
| 5 | from __future__ import with_statement |
| 6 | import os, shlex |
| 7 | |
| 8 | __all__ = ["netrc", "NetrcParseError"] |
| 9 | |
| 10 | |
| 11 | class NetrcParseError(Exception): |
| 12 | """Exception raised on syntax errors in the .netrc file.""" |
| 13 | def __init__(self, msg, filename=None, lineno=None): |
| 14 | self.filename = filename |
| 15 | self.lineno = lineno |
| 16 | self.msg = msg |
| 17 | Exception.__init__(self, msg) |
| 18 | |
| 19 | def __str__(self): |
| 20 | return "%s (%s, line %s)" % (self.msg, self.filename, self.lineno) |
| 21 | |
| 22 | |
| 23 | class netrc: |
| 24 | def __init__(self, file=None): |
| 25 | if file is None: |
| 26 | try: |
| 27 | file = os.path.join(os.environ['HOME'], ".netrc") |
| 28 | except KeyError: |
| 29 | raise IOError("Could not find .netrc: $HOME is not set") |
| 30 | self.hosts = {} |
| 31 | self.macros = {} |
| 32 | with open(file) as fp: |
| 33 | self._parse(file, fp) |
| 34 | |
| 35 | def _parse(self, file, fp): |
| 36 | lexer = shlex.shlex(fp) |
| 37 | lexer.wordchars += r"""!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~""" |
| 38 | while 1: |
| 39 | # Look for a machine, default, or macdef top-level keyword |
| 40 | toplevel = tt = lexer.get_token() |
| 41 | if not tt: |
| 42 | break |
| 43 | elif tt == 'machine': |
| 44 | entryname = lexer.get_token() |
| 45 | elif tt == 'default': |
| 46 | entryname = 'default' |
| 47 | elif tt == 'macdef': # Just skip to end of macdefs |
| 48 | entryname = lexer.get_token() |
| 49 | self.macros[entryname] = [] |
| 50 | lexer.whitespace = ' \t' |
| 51 | while 1: |
| 52 | line = lexer.instream.readline() |
| 53 | if not line or line == '\012': |
| 54 | lexer.whitespace = ' \t\r\n' |
| 55 | break |
| 56 | self.macros[entryname].append(line) |
| 57 | continue |
| 58 | else: |
| 59 | raise NetrcParseError( |
| 60 | "bad toplevel token %r" % tt, file, lexer.lineno) |
| 61 | |
| 62 | # We're looking at start of an entry for a named machine or default. |
| 63 | login = '' |
| 64 | account = password = None |
| 65 | self.hosts[entryname] = {} |
| 66 | while 1: |
| 67 | tt = lexer.get_token() |
| 68 | if (tt=='' or tt == 'machine' or |
| 69 | tt == 'default' or tt =='macdef'): |
| 70 | if password: |
| 71 | self.hosts[entryname] = (login, account, password) |
| 72 | lexer.push_token(tt) |
| 73 | break |
| 74 | else: |
| 75 | raise NetrcParseError( |
| 76 | "malformed %s entry %s terminated by %s" |
| 77 | % (toplevel, entryname, repr(tt)), |
| 78 | file, lexer.lineno) |
| 79 | elif tt == 'login' or tt == 'user': |
| 80 | login = lexer.get_token() |
| 81 | elif tt == 'account': |
| 82 | account = lexer.get_token() |
| 83 | elif tt == 'password': |
| 84 | password = lexer.get_token() |
| 85 | else: |
| 86 | raise NetrcParseError("bad follower token %r" % tt, |
| 87 | file, lexer.lineno) |
| 88 | |
| 89 | def authenticators(self, host): |
| 90 | """Return a (user, account, password) tuple for given host.""" |
| 91 | if host in self.hosts: |
| 92 | return self.hosts[host] |
| 93 | elif 'default' in self.hosts: |
| 94 | return self.hosts['default'] |
| 95 | else: |
| 96 | return None |
| 97 | |
| 98 | def __repr__(self): |
| 99 | """Dump the class data in the format of a .netrc file.""" |
| 100 | rep = "" |
| 101 | for host in self.hosts.keys(): |
| 102 | attrs = self.hosts[host] |
| 103 | rep = rep + "machine "+ host + "\n\tlogin " + repr(attrs[0]) + "\n" |
| 104 | if attrs[1]: |
| 105 | rep = rep + "account " + repr(attrs[1]) |
| 106 | rep = rep + "\tpassword " + repr(attrs[2]) + "\n" |
| 107 | for macro in self.macros.keys(): |
| 108 | rep = rep + "macdef " + macro + "\n" |
| 109 | for line in self.macros[macro]: |
| 110 | rep = rep + line |
| 111 | rep = rep + "\n" |
| 112 | return rep |
| 113 | |
| 114 | if __name__ == '__main__': |
| 115 | print netrc() |