From 0911ec5330e460f79daca557bb03114276def026 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 00:56:12 +0000 Subject: Clean up directory structure to be better aligned with other leap python project, add __init__.py to modules directories, and add query callback function to couchdb in alias_resolver.py for check_recipient feature. --- src/leap/mx/__init__.py | 0 src/leap/mx/alias_resolver.py | 207 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 207 insertions(+) create mode 100644 src/leap/mx/__init__.py create mode 100644 src/leap/mx/alias_resolver.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py new file mode 100644 index 0000000..3d20ff7 --- /dev/null +++ b/src/leap/mx/alias_resolver.py @@ -0,0 +1,207 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +alias_resolver.py +================= +Classes for resolving postfix aliases. + +@authors: Isis Agora Lovecruft +@version: 0.0.1-beta +@license: see included LICENSE file +@copyright: copyright 2013 Isis Agora Lovecruft +''' + +import os + +try: + from paisley import client +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +try: + from twisted.internet import address, defer, reactor + from twisted.mail import maildir, alias + from twisted.protocols import postfix +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +from leap.mx import net, log ## xxx implement log + + +class ConnectedCouchDB(client.CouchDB): + """ + Connect to a CouchDB instance. + + ## xxx will we need to open CouchDB documents and views? + ## yes, these are in a _design document + ## + + """ + def __init__(self, host, port, dbName=None, + username=None, password=None, *args, **kwargs): + """ + Connect to a CouchDB instance. + + @param host: A hostname string for the CouchDB server. + @param port: The port of the CouchDB server, as an integer. + @param dbName: (optional) The default database to connect to. + @param username: (optional) The username for authorization. + @param password: (optional) The password for authorization. + @returns: A :class:`twisted.internet.defer.Deferred` representing the + the client connection to the CouchDB instance. + """ + super(client.CouchDB, self).__init__(host, port, + dbName=dbName, + username=username, + password=password, + *args, **kwargs) + if dbName: + self.bindToDB(dbName) + else: + databases = self.listDB() + log.msg("Available databases: %s" % databases) + + def queryByEmailOrAlias(self, alias, dbDoc="User", + view="by_email_or_alias"): + """ + Check to see if a particular email or alias exists. + + @param alias: A string representing the email or alias to check. + @param dbDoc: The CouchDB document to open. + @param view: The view of the CouchDB document to use. + """ + assert isinstance(alias, str), "Email or alias queries must be string" + + ## Prepend a forward slash, in case we forgot it: + if not alias.startswith('/'): + alias = '/' + alias + + d = self.openDoc(dbDoc) + d.addCallbacks(self.openView, log.err, (view)) + d.addCallbacks(self.get, log.err, (alias)) + d.addCallbacks(self.parseResult, log.err) + + @d.addCallback + def show_answer(result): + log.msg("Query: %s" % alias) + log.msg("Answer: %s" % alias) + + return d + + def query(self, uri): + """ + Query a CouchDB instance that we are connected to. + """ + try: + self.checkURI(uri) ## xxx write checkURI() + ## xxx we might be able to use self._parseURI() + except SchemeNotSupported, sns: ## xxx where in paisley is this? + log.exception(sns) ## xxx need log.exception() + + d = self.get(uri) + @d.addCallback + def parse_answer(answer): + return answer + + return answer + + @defer.inlineCallbacks + def listUsersAndEmails(self, limit=1000, reverse=False): + """ + List all users and email addresses, up to the given limit. + """ + query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" + answer = yield self.query(query, limit=limit, reverse=reverse) + + if answer: + parsed = yield self.parseResult(answer) + if parsed: + log.msg("%s" % parsed) + else: + log.msg("No answer from database, perhaps there are no users.") + else: + log.msg("Problem querying CouchDB instance...") + log.debug("Host: %s" % host) + log.debug("Port: %d" % port) + +class PostfixAliasResolver(postfix.PostfixTCPMapServer): + """ + Resolve postfix aliases, similarly to using "$ postmap -q ". + + This class starts a simple LineReceiver server which listens for a string + specifying an alias to look up, :param:`key`, and which will be used to + query the local Postfix server. You can test it with: + + $ ./alias_resolver.py & + $ /usr/bin/postmap -q tcp:localhost:4242 + + """ + def __init__(self, *args, **kwargs): + """ + Create a local LineReceiver server which listens for Postfix aliases + to resolve. + """ + super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + + +class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): + """ + A Factory for creating PostfixAliasResolver servers, which handles inputs + and outputs, and keeps an in-memory mapping of Postfix aliases in the form + of a dict. + + xxx fill me in + + """ + protocol = PostfixAliasResolver + + def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None): + """ + Create a Factory which returns :class:`PostfixAliasResolver` servers. + + @param addr: + (optional) A string giving the IP address of the Postfix server. + Default: '127.0.0.1' + @param port: + (optional) An integer that specifies the port number of the + Postfix server. Default: 4242 + @param timeout: + (optional) An integer specifying the number of seconds to wait + until we should time out. Default: 120 + @param data: + (optional) A dict to use to initialise or update the alias + mapping. + """ + super(postfix.PostfixTCPMapDeferringDictServerFactory, + self).__init__(data=data) + self.timeout = timeout + ## xxx get config value, should be something like verbose = no + self.noisy = False + + try: + assert isinstance(port, int), "Port number must be an integer" + assert isinstance(timeout, int), "Timeout must be an integer" + except AssertionError, ae: + raise SystemExit(ae.message) + + if net.checkIPaddress(addr): + self.addr = address._IPAddress('TCP', addr, int(port)) + else: + log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) + self.addr = address._IPAddress('TCP', '127.0.0.1', int(port)) + + def buildProtocol(self): + """ + Create an instance of the :class:`PostfixAliasResolver` server. + """ + proto = self.protocol() + proto.timeout = self.timeout + proto.factory = self + return proto + + +if __name__ == "__main__": + + print "To test alias_resolver.py, please use /test/test_alias_resolver.py" -- cgit v1.2.3 From 5274edd31752e1e388add70d68128373e30a5cc2 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 16:06:28 +0000 Subject: Updated __init__.py files for new structure. --- src/leap/mx/__init__.py | 1 + 1 file changed, 1 insertion(+) (limited to 'src/leap/mx') diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index e69de29..10d8ee7 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -0,0 +1 @@ +__all__ = ['alias_resolver', 'runner', 'tests'] -- cgit v1.2.3 From 29427dbba0cde178e4440148df5dc7a10765825d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 02:37:19 +0000 Subject: Add UUID creator to alias_resolver. --- src/leap/mx/alias_resolver.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 3d20ff7..da37314 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -12,6 +12,7 @@ Classes for resolving postfix aliases. ''' import os +import uuid try: from paisley import client @@ -30,6 +31,19 @@ except ImportError: from leap.mx import net, log ## xxx implement log +def createID(alias): + """ + Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: + + >>> uuid.uuid5(uuid.NAMESPACE_URL, "isis@leap.se") + UUID('7194878e-4aea-563f-85a4-4f58519f3c4f') + + @param alias: An email address alias. + @returns: A :class:`uuid.UUID` containing attributes specifying the UUID. + """ + return uuid.uuid5(uuid.NAMESPACE_URL, str(alias)) + + class ConnectedCouchDB(client.CouchDB): """ Connect to a CouchDB instance. -- cgit v1.2.3 From 0b8c4ac523d3934762517c2b149fcfa0920e78c5 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:25:15 +0000 Subject: Separated CouchDB code into mx/couchdb.py and added fake-SMTP status codes to alias_resolver. --- src/leap/mx/alias_resolver.py | 144 +++++++++++++----------------------------- src/leap/mx/couchdb.py | 118 ++++++++++++++++++++++++++++++++++ 2 files changed, 161 insertions(+), 101 deletions(-) create mode 100644 src/leap/mx/couchdb.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index da37314..7aeeedf 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -14,12 +14,6 @@ Classes for resolving postfix aliases. import os import uuid -try: - from paisley import client -except ImportError: - print "This software requires paisley. Please see the README file" - print "for instructions on getting required dependencies." - try: from twisted.internet import address, defer, reactor from twisted.mail import maildir, alias @@ -43,104 +37,52 @@ def createID(alias): """ return uuid.uuid5(uuid.NAMESPACE_URL, str(alias)) - -class ConnectedCouchDB(client.CouchDB): - """ - Connect to a CouchDB instance. - - ## xxx will we need to open CouchDB documents and views? - ## yes, these are in a _design document - ## - +class StatusCodes(object): """ - def __init__(self, host, port, dbName=None, - username=None, password=None, *args, **kwargs): - """ - Connect to a CouchDB instance. - - @param host: A hostname string for the CouchDB server. - @param port: The port of the CouchDB server, as an integer. - @param dbName: (optional) The default database to connect to. - @param username: (optional) The username for authorization. - @param password: (optional) The password for authorization. - @returns: A :class:`twisted.internet.defer.Deferred` representing the - the client connection to the CouchDB instance. - """ - super(client.CouchDB, self).__init__(host, port, - dbName=dbName, - username=username, - password=password, - *args, **kwargs) - if dbName: - self.bindToDB(dbName) - else: - databases = self.listDB() - log.msg("Available databases: %s" % databases) - - def queryByEmailOrAlias(self, alias, dbDoc="User", - view="by_email_or_alias"): - """ - Check to see if a particular email or alias exists. - - @param alias: A string representing the email or alias to check. - @param dbDoc: The CouchDB document to open. - @param view: The view of the CouchDB document to use. - """ - assert isinstance(alias, str), "Email or alias queries must be string" + The Postfix manual states: - ## Prepend a forward slash, in case we forgot it: - if not alias.startswith('/'): - alias = '/' + alias + The request completion status is one of OK, RETRY, NOKEY (lookup + failed because the key was not found), BAD (malformed request) or DENY + (the table is not approved for proxy read or update access). - d = self.openDoc(dbDoc) - d.addCallbacks(self.openView, log.err, (view)) - d.addCallbacks(self.get, log.err, (alias)) - d.addCallbacks(self.parseResult, log.err) - - @d.addCallback - def show_answer(result): - log.msg("Query: %s" % alias) - log.msg("Answer: %s" % alias) - - return d - - def query(self, uri): - """ - Query a CouchDB instance that we are connected to. - """ - try: - self.checkURI(uri) ## xxx write checkURI() - ## xxx we might be able to use self._parseURI() - except SchemeNotSupported, sns: ## xxx where in paisley is this? - log.exception(sns) ## xxx need log.exception() - - d = self.get(uri) - @d.addCallback - def parse_answer(answer): - return answer - - return answer - - @defer.inlineCallbacks - def listUsersAndEmails(self, limit=1000, reverse=False): - """ - List all users and email addresses, up to the given limit. - """ - query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" - answer = yield self.query(query, limit=limit, reverse=reverse) - - if answer: - parsed = yield self.parseResult(answer) - if parsed: - log.msg("%s" % parsed) - else: - log.msg("No answer from database, perhaps there are no users.") - else: - log.msg("Problem querying CouchDB instance...") - log.debug("Host: %s" % host) - log.debug("Port: %d" % port) - -class PostfixAliasResolver(postfix.PostfixTCPMapServer): + Other SMTP codes: http://www.greenend.org.uk/rjk/tech/smtpreplies.html + """ + OK = "OK Others might say 'HELLA AWESOME'...but we're not convinced." + RETRY = "RETRY Server is busy plotting revolution; requests might take a while." + BAD = "BAD bad Leroy Brown, baddest man in the whole...er. Malformed request." + NOKEY = "NOKEY Couldn't find your keys, sorry. Did you check in the sofa?" + DEFER = "DEFER_IF_LOCAL xxx fill me in" + DENY = "DENY no gurlz aloud in teh tree house." + FAIL = "FAIL xxx fill me in" + + fakeSMTPCodes = { '250': OK, + '300': RETRY, + '500': BAD, + '550': NOKEY, + '552': DEFER, + '553': DENY, + '554': FAIL, } + + def __init__(self, status_code=None): + """xxx fill me in""" + if status_code: + self.get(status_code) + + def get(self, status_code=None) + """xxx fill me in""" + if status_code: + if isinstance(status_code, str): + return status_code, getattr(self, status_code.upper(), None) + elif isinstance(status_code, int): + for k, v in self.fake_smtp_codes.items(): + ## we want to return None if it's 550 + if k == str(status_code) and k != '550': + return status_code, v + log.debug("%s" % self.NOKEY) + return None, '' + + +class AliasResolver(postfix.PostfixTCPMapServer): """ Resolve postfix aliases, similarly to using "$ postmap -q ". diff --git a/src/leap/mx/couchdb.py b/src/leap/mx/couchdb.py new file mode 100644 index 0000000..b5d4127 --- /dev/null +++ b/src/leap/mx/couchdb.py @@ -0,0 +1,118 @@ +# -*- encoding: utf-8 -*- +''' +couchdb.py +========== +Classes for working with CouchDB or BigCouch instances which store email alias +maps, user UUIDs, and GPG keyIDs. + +@authors: Isis Agora Lovecruft +@version: 0.0.1-beta +@license: see included LICENSE file +''' + +try: + from paisley import client +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +try: + from twisted.internet import defer +except ImportError: + print "This software requires Twisted. Please see the README file" + print "for instructions on getting required dependencies." + +from leap.mx.util import log + + +class ConnectedCouchDB(client.CouchDB): + """ + Connect to a CouchDB instance. + + ## xxx will we need to open CouchDB documents and views? + ## yes, these are in a _design document + """ + def __init__(self, host, port, dbName=None, username=None, + password=None, *args, **kwargs): + """ + Connect to a CouchDB instance. + + @param host: A hostname string for the CouchDB server. + @param port: The port of the CouchDB server, as an integer. + @param dbName: (optional) The default database to connect to. + @param username: (optional) The username for authorization. + @param password: (optional) The password for authorization. + @returns: A :class:`twisted.internet.defer.Deferred` representing the + the client connection to the CouchDB instance. + """ + super(client.CouchDB, self).__init__(host, port, + dbName=dbName, + username=username, + password=password, + *args, **kwargs) + if dbName: + self.bindToDB(dbName) + else: + databases = self.listDB() + log.msg("Available databases: %s" % databases) + + def queryByEmailOrAlias(self, alias, dbDoc="User", + view="by_email_or_alias"): + """ + Check to see if a particular email or alias exists. + + @param alias: A string representing the email or alias to check. + @param dbDoc: The CouchDB document to open. + @param view: The view of the CouchDB document to use. + """ + assert isinstance(alias, str), "Email or alias queries must be string" + + ## Prepend a forward slash, in case we forgot it: + if not alias.startswith('/'): + alias = '/' + alias + + d = self.openDoc(dbDoc) + d.addCallbacks(self.openView, log.err, (view)) + d.addCallbacks(self.get, log.err, (alias)) + d.addCallbacks(self.parseResult, log.err) + + @d.addCallback + def show_answer(result): + log.msg("Query: %s" % alias) + log.msg("Answer: %s" % alias) + + return d + + def query(self, uri): + """ + Query a CouchDB instance that we are connected to. + """ + try: + self.checkURI(uri) ## xxx write checkURI() + ## xxx we might be able to use self._parseURI() + except SchemeNotSupported, sns: ## xxx where in paisley is this? + log.exception(sns) ## xxx need log.exception() + + d = self.get(uri) + @d.addCallback + def parse_answer(answer): + return answer + + return answer + + @defer.inlineCallbacks + def listUsersAndEmails(self, limit=1000, reverse=False): + """ + List all users and email addresses, up to the given limit. + """ + query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" + answer = yield self.query(query, limit=limit, reverse=reverse) + + if answer: + parsed = yield self.parseResult(answer) + if parsed: + log.msg("%s" % parsed) + else: + log.msg("No answer from database, perhaps there are no users.") + else: + log.msg("Problem querying CouchDB instance...") -- cgit v1.2.3 From ecd01f1d83ddd9e4ada9fbace6c98c66819428cc Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:29:49 +0000 Subject: Fix typo. --- src/leap/mx/alias_resolver.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 7aeeedf..12b29fd 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -19,7 +19,7 @@ try: from twisted.mail import maildir, alias from twisted.protocols import postfix except ImportError: - print "This software requires paisley. Please see the README file" + print "This software requires Twisted. Please see the README file" print "for instructions on getting required dependencies." from leap.mx import net, log ## xxx implement log -- cgit v1.2.3 From 136cc7ffa4e15c922debe2ca1c9aef7c0847e292 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:31:45 +0000 Subject: Renamed alias_resolver.createID() to alias_resolver.aliasToUUID(), renamed AliasResolver classes, fixed docstrings and imports. --- src/leap/mx/alias_resolver.py | 113 ++++++++++++++++++++++++++++++++---------- 1 file changed, 88 insertions(+), 25 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 12b29fd..4774d78 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -22,10 +22,10 @@ except ImportError: print "This software requires Twisted. Please see the README file" print "for instructions on getting required dependencies." -from leap.mx import net, log ## xxx implement log +from leap.mx.util import net, log, config, exceptions -def createID(alias): +def aliasToUUID(alias): """ Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: @@ -91,50 +91,113 @@ class AliasResolver(postfix.PostfixTCPMapServer): query the local Postfix server. You can test it with: $ ./alias_resolver.py & - $ /usr/bin/postmap -q tcp:localhost:4242 + $ /usr/bin/postmap -q tcp:localhost:1347 + Resources: + http://www.postfix.org/proxymap.8.html + https://www.iana.org/assignments/smtp-enhanced-status-codes/smtp-enhanced-status-codes.txt """ def __init__(self, *args, **kwargs): + """Create a server which listens for Postfix aliases to resolve.""" + super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + self.status_codes = StatusCodes() + + def sendCode(self, code, message=None): + """Send an SMTP-like code with a message.""" + if not message: + message = self.status_codes.get(code) + self.sendLine('%3.3d %s' % (code, message or '')) + + def do_get(self, key): + """Make a query to resolve an alias.""" + if key is None: + self.sendCode(500) + log.warn("Command 'get' takes one parameter.") + else: + d = defer.maybeDeferred(self.factory.get, key) + d.addCallbacks(self._cbGot, self._cbNot) + d.addErrback(log.err) + + def do_query(self, key): + """Make a query to resolve an alias.""" + self.do_get(self, key) + + @defer.inlineCallbacks + def do_put(self, keyAndValue): + """Add a key and value to the database, provided it does not exist.""" + if keyAndValue is None: + self.sendCode(500) + log.warn("Command 'put' takes two parameters.") + else: + try: + key, value = keyAndValue.split(None, 1) + except ValueError: + self.sendCode(500) + log.warn("Command 'put' takes two parameters.") + else: + alreadyThere = yield self.do_query(key) + if alreadyThere is None: + d = defer.maybeDeferred(self.factory.put, key, value) + d.addCallbacks(self._cbPut, self._cbPout) + d.addCallbacks(log.err) + else: + self.sendCode(553) + + @defer.inlineCallbacks + def do_delete(self, key): """ - Create a local LineReceiver server which listens for Postfix aliases - to resolve. + Delete an alias from the mapping database. + + xxx not sure if this is a good idea... """ - super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + raise NotImplemented + + def _cbGot(self, value): + """Callback for self.get()""" + if value is None: + self.sendCode(550) + else: + self.sendCode(250, quote(value)) + def _cbNot(self, fail): + """Errback for self.get()""" + self.sendCode(554, fail.getErrorMessage()) -class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): + def _cbPut(self, value): + """xxx fill me in""" + pass + + def _cbPout(self, fail): + """xxx fill me in""" + pass + + +class AliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): """ - A Factory for creating PostfixAliasResolver servers, which handles inputs + A Factory for creating :class:`AliasResolver` servers, which handles inputs and outputs, and keeps an in-memory mapping of Postfix aliases in the form - of a dict. + of a dictionary. xxx fill me in - """ - protocol = PostfixAliasResolver + protocol = AliasResolver def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None): """ - Create a Factory which returns :class:`PostfixAliasResolver` servers. + Create a Factory which returns :class:`AliasResolver` servers. - @param addr: - (optional) A string giving the IP address of the Postfix server. + @param addr: A string giving the IP address of this server. Default: '127.0.0.1' - @param port: - (optional) An integer that specifies the port number of the - Postfix server. Default: 4242 - @param timeout: - (optional) An integer specifying the number of seconds to wait + @param port: An integer that specifies the port number to listen + on. Default: 4242 + @param timeout: An integer specifying the number of seconds to wait until we should time out. Default: 120 - @param data: - (optional) A dict to use to initialise or update the alias - mapping. + @param data: A dict to use to initialise or update the alias mapping. """ - super(postfix.PostfixTCPMapDeferringDictServerFactory, + super(postfix.PostfixTCPMapDeferringDictServerFactory, self).__init__(data=data) self.timeout = timeout - ## xxx get config value, should be something like verbose = no - self.noisy = False + self.noisy = True if config.advanced.noisy else False try: assert isinstance(port, int), "Port number must be an integer" -- cgit v1.2.3 From fa684009c191227a6e5c05771099c956cd1985ad Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:34:11 +0000 Subject: Add TODO to alias_resolver. --- src/leap/mx/alias_resolver.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 4774d78..4867893 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -9,6 +9,19 @@ Classes for resolving postfix aliases. @version: 0.0.1-beta @license: see included LICENSE file @copyright: copyright 2013 Isis Agora Lovecruft + +TODO: + + o Look into using twisted.protocols.postfix.policies classes for + controlling concurrent connections and throttling resource consumption. + + o alias.ProcessAlias() + +## have uuid, need to get gpg keyid +## have key, make crypto + +alias.ProcessAlias('/path/to/mail_reciever', *args) + ''' import os -- cgit v1.2.3 From 2b6e5408048a458e2c7f447e44d3829cb552a737 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:36:06 +0000 Subject: Add callbacks to AliasResolverFactory, these need to be hooked to couchdb.ConnectedCouchDB(). --- src/leap/mx/alias_resolver.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 4867893..44cb44d 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -221,18 +221,35 @@ class AliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): if net.checkIPaddress(addr): self.addr = address._IPAddress('TCP', addr, int(port)) else: - log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) + log.msg("Using default address: 127.0.0.1:%s" % port) self.addr = address._IPAddress('TCP', '127.0.0.1', int(port)) + log.msg("To configure Postfix to query this alias_resolver,") + log.msg("you should do:") + log.msg(" $ postconf -e 'check_recipient_access = tcp:%s:%d" + % (addr, port)) + def buildProtocol(self): """ - Create an instance of the :class:`PostfixAliasResolver` server. + Create an instance of the :class:`AliasResolver` server. """ proto = self.protocol() proto.timeout = self.timeout proto.factory = self return proto + def get(self, *args, **kwargs): + """ + xxx connect me to the couchdb + """ + pass + + def put(self, *args, **kwargs): + """ + xxx connect me to the couchdb + """ + pass + if __name__ == "__main__": -- cgit v1.2.3 From cd8beb5798cdab1b3cd700be662e9659cbec8977 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 09:50:59 +0000 Subject: Finished check_recipient and virtual_alias_map in AliasResolver. --- src/leap/mx/alias_resolver.py | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 44cb44d..e079b80 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -17,8 +17,7 @@ TODO: o alias.ProcessAlias() -## have uuid, need to get gpg keyid -## have key, make crypto +## have uuid -> get gpg keyid alias.ProcessAlias('/path/to/mail_reciever', *args) @@ -38,7 +37,7 @@ except ImportError: from leap.mx.util import net, log, config, exceptions -def aliasToUUID(alias): +def createUUID(alias): """ Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: @@ -108,7 +107,7 @@ class AliasResolver(postfix.PostfixTCPMapServer): Resources: http://www.postfix.org/proxymap.8.html - https://www.iana.org/assignments/smtp-enhanced-status-codes/smtp-enhanced-status-codes.txt + https://www.iana.org/assignments/smtp-enhanced-status-codes/ """ def __init__(self, *args, **kwargs): """Create a server which listens for Postfix aliases to resolve.""" @@ -131,10 +130,6 @@ class AliasResolver(postfix.PostfixTCPMapServer): d.addCallbacks(self._cbGot, self._cbNot) d.addErrback(log.err) - def do_query(self, key): - """Make a query to resolve an alias.""" - self.do_get(self, key) - @defer.inlineCallbacks def do_put(self, keyAndValue): """Add a key and value to the database, provided it does not exist.""" @@ -165,6 +160,30 @@ class AliasResolver(postfix.PostfixTCPMapServer): """ raise NotImplemented + def check_recipient_access(self, key): + """Make a query to resolve an alias.""" + self.do_get(self, key) + + def virtual_alias_map(self, key): + """ + Get the Universal Unique ID for the alias address. If + virtual_transport is True, then suffix the UUID with a domain. + + xxx I don't think we actually need couchdb for this, the UUID is an + identifier, not an authenticator. And the SHA1 should always be the + same, so unless it's considered to expensive to compute (less than + querying a database, I would presume), it seems silly to do this. + + Instead, we should query CouchDB with the UUID to get the GPG keyid. + """ + ## xxx need email address parser + client_id = createUUID(key) + + if self.virtual_transport: + return client.get_urn() + '@example.com' + else: + return client.get_urn() + def _cbGot(self, value): """Callback for self.get()""" if value is None: -- cgit v1.2.3 From d486c13af17133e2e5a2bfe6e5a862bfea6736ff Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:27:53 +0000 Subject: Module directory layout changes, with corresponding __init__.py changes. --- src/leap/mx/__init__.py | 4 +- src/leap/mx/util/__init__.py | 1 + src/leap/mx/util/config.py | 172 +++++++++++++++++++++++++++++++++++++++++ src/leap/mx/util/exceptions.py | 23 ++++++ src/leap/mx/util/log.py | 154 ++++++++++++++++++++++++++++++++++++ src/leap/mx/util/net.py | 126 ++++++++++++++++++++++++++++++ src/leap/mx/util/version.py | 101 ++++++++++++++++++++++++ 7 files changed, 580 insertions(+), 1 deletion(-) create mode 100644 src/leap/mx/util/__init__.py create mode 100644 src/leap/mx/util/config.py create mode 100644 src/leap/mx/util/exceptions.py create mode 100644 src/leap/mx/util/log.py create mode 100644 src/leap/mx/util/net.py create mode 100644 src/leap/mx/util/version.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index 10d8ee7..507efee 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -1 +1,3 @@ -__all__ = ['alias_resolver', 'runner', 'tests'] +#from . import util + +__all__ = ['alias_resolver', 'runner', 'tests', 'couchdb'] diff --git a/src/leap/mx/util/__init__.py b/src/leap/mx/util/__init__.py new file mode 100644 index 0000000..c8448b0 --- /dev/null +++ b/src/leap/mx/util/__init__.py @@ -0,0 +1 @@ +__all__ = ['config', 'exceptions', 'log', 'net', 'version, storage'] diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py new file mode 100644 index 0000000..5bc5231 --- /dev/null +++ b/src/leap/mx/util/config.py @@ -0,0 +1,172 @@ +#! -*- encoding: utf-8 -*- +""" +Config file utilities. + +This module has an :attr:`config_filename`, which can be used to set the +filename outside of function calls: + + >>> from leap.mx.util import config + >>> config.config_filename = "blahblah.yaml" + +If not set anywhere, it will default to using the top level repository +directory, i.e. "/.../leap_mx/leap_mx.conf", and will create that file with +the default settings if it does not exist. + +The config file can be loaded/created with :func:`config.loadConfig`: + + >>> config.loadConfig() + +Once the config file is loaded, this module presents a highly object-oriented +interface, so that sections taken from the config file become attribute of +this module, and the name of their respective settings become attributes of +the section names. Like this: + + >>> print config.basic.postfix_port + 465 + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + +import os +import yaml + +## xxx only install/import this in *nix +from xdg import BaseDirectory + +from leap.util import log, version, Storage +from leap.util.exceptions import MissingConfig, UnsupportedOS + + +def _create_config_file(file): + """ + xxx fill me in + """ + with open(file, 'w+') as conf: + conf.write(""" +# +# mx.conf +# ======= +# Configurable options for the leap_mx encrypting mail exchange. +# +# This file follows YAML markup format: http://yaml.org/spec/1.2/spec.html +# Keep in mind that indentation matters. +# + +basic: + # Where is the spoolfile of messages to encrypt?: + spoolfile: /var/mail/encrypt_me +advanced: + # Which port on localhost should postfix send check_recipient queries to?: + check_recipient_access_port: 1347 + # Which port on localhost should postfix ask for UUIDs?: + virtual_alias_map_port: 1348 + # Enable debugging output in the logger: + debug: true + # Print enough things really fast to make you look super 1337: + noisy: false + +""") + conf.flush() + try: + assert os.path.isfile(file), "Config file %s not created!" % file + except AssertionError, ae: + raise SystemExit(ae.message) + else: + return file + +def _get_config_filename(filename=None, use_dot_config_directory=False): + """ + Get the full path and filename of the config file. + """ + platform = version.getClientPlatform()[0] + resource = version.name + + ## Oh hell, it could be said only to beguile: + ## That windoze users are capable of editing a .conf file. + ## Also, what maddened wingnut would be so fool + ## To run a mail exchange on a windoze nodule? + ## I'm ignoring these loons for now. And pardon if I seem jaded, + ## But srsly, this and that solaris sh*t should be deprecated. + if not platform.endswith('LINUX') and not platform.endswith('BSD'): + raise UnsupportedOS("Sorry, your operating system isn't supported.") + + ## If not given, default to the application's name + '.conf' + if not filename: + filename = resource + ".conf" + + where = None + if not use_dot_config_directory: + repo_dir = version.getRepoDir() + where = os.path.abspath(repo_dir) + ## Use ~/.config/ instead: + else: + dot_config_dirs = BaseDirectory.xdg_config_dirs + for dir in dot_config_dirs: + our_dir = os.path.join(dir, resource) + if os.path.isdir(our_dir): + if filename in os.listdir(our_dir): + where = os.path.abspath(our_dir) + if not where: + where = BaseDirectory.save_config_path(resource) + + conffile = os.path.join(where, filename) + try: + with open(conffile) as cf: pass + except IOError: + conffile = _create_config_file(conffile) + finally: + return conffile + +def loadConfig(filename=config_filename): + """ + Some of this is taken from OONI config code for now, and so this should be + refacotored, along with the leap_client config code, so that we have + similarly structured config files. It is perhaps desirable to also use + soledad as a backend for remote setup and maintainance, and thus this code + will need to hook into u1db (and potentially "pysqlcipher"). + + Excuse the yaml for now, I just wanted something that works. + + @param filename: (optional) If provided, use this filename. + """ + if not filename: + filename = _get_config_filename() + + if os.path.isfile(filename): + with open(filename, 'a+') as conf: + config_contents = '\n'.join(conf.readlines()) + configuration = yaml.safe_load(config_contents) + + ## These become objects with their keys loaded as attributes: + ## + ## from leap.util import config + ## config.basic.foo = bar + ## + basic = Storage() + try: + for k, v in configuration['basic'].items(): + basic[k] = v + except AttributeError: + pass + + advanced = Storage() + try: + for k, v in configuration['advanced'].items(): + advanced[k] = v + except AttributeError: + pass + + return basic, advanced + else: + raise MissingConfig("Could not load config file.") + + +## This is the name of the config file to use: +## If not set, it defaults to 'leap_mx/leap_mx.conf' +if not config_filename: + config_filename = _get_config_filename() +else: + config_filename = _get_config_filename(filename=config_filename) + diff --git a/src/leap/mx/util/exceptions.py b/src/leap/mx/util/exceptions.py new file mode 100644 index 0000000..63b946c --- /dev/null +++ b/src/leap/mx/util/exceptions.py @@ -0,0 +1,23 @@ +#! -*- encoding: utf-8 -*- +""" +Custom exceptions for leap_mx. + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +class UnsupportedOS(Exception): + """Raised when we're not *nix or *BSD.""" diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py new file mode 100644 index 0000000..ef54605 --- /dev/null +++ b/src/leap/mx/util/log.py @@ -0,0 +1,154 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +log.py +------ +Logging for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +from datetime import datetime +from functools import wraps + +import logging +import os +import sys +import time +import traceback + +from twisted.python import log as txlog +from twisted.python import util as txutil +from twisted.python.logfile import DailyLogFile +from twisted.python.failure import Failure + +from leap.util import version, config + + +class InvalidTimestampFormat(Exception): + pass + +class UnprefixedLogfile(txlog.FileLogObserver): + """Logfile with plain messages, without timestamp prefixes.""" + def emit(self, eventDict): + text = txlog.textFromEventDict(eventDict) + if text is None: + return + + txutil.untilConcludes(self.write, "%s\n" % text) + txutil.untilConcludes(self.flush) + + +def utcDateNow(): + """The current date for UTC time.""" + return datetime.utcnow() + +def utcTimeNow(): + """Seconds since epoch in UTC time, as type float.""" + return time.mktime(time.gmtime()) + +def dateToTime(date): + """Convert datetime to seconds since epoch.""" + return time.mktime(date.timetuple()) + +def prettyDateNow(): + """Pretty string for the local time.""" + return datetime.now().ctime() + +def utcPrettyDateNow(): + """Pretty string for UTC.""" + return datetime.utcnow().ctime() + +def timeToPrettyDate(time_val): + """Convert seconds since epoch to date.""" + return time.ctime(time_val) + +def start(logfile=None, application_name=None): + """ + Start logging to stdout, and optionally to a logfile as well. + + @param logfile: The filename to store logs in, which is placed in + /leap_mx/logs/. + @param application_name: The name of the running application. + """ + if not application_name: + application_name = version.name + print "application name: %s" % application_name + + daily_logfile = None + + if not logfile: + logfile = config.basic.logfile + + repo_dir = version.getRepoDir() + logfile_dir = os.path.join(repo_dir, 'log') + logfile_name = logfile + + daily_logfile = DailyLogFile(logfile_name, logfile_dir) + + txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) + txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) + txlog.msg("Starting %s on %s (%s UTC)" % (application_name, + prettyDateNow(), + utcPrettyDateNow())) + +def msg(msg, *arg, **kwarg): + """Log a message at the INFO level.""" + print "[*] %s" % msg + +def debug(msg, *arg, **kwarg): + """Log a message at the DEBUG level.""" + if config.basic.debug: + print "[d] %s" % msg + +def warn(msg, *arg, **kwarg): + """Log a message at the WARN level.""" + if config.basic.show_warnings: + txlog.logging.captureWarnings('true') + print "[#] %s" % msg + +def err(msg, *arg, **kwarg): + """Log a message at the ERROR level.""" + print "[!] %s" % msg + +def fail(*failure): + """Log a message at the CRITICAL level.""" + logging.critical(failure) + ## xxx should we take steps to exit here? + +def exception(error): + """ + Catch an exception and print only the error message, then continue normal + program execution. + + @param error: Can be error messages printed to stdout and to the + logfile, or can be a twisted.python.failure.Failure instance. + """ + if isinstance(error, Failure): + error.printTraceback() + else: + exc_type, exc_value, exc_traceback = sys.exc_info() + traceback.print_exception(exc_type, exc_value, exc_traceback) + +def catch(func): + """ + Quick wrapper to add around test methods for debugging purposes, + catches the given Exception. Use like so: + + >>> @log.catch + def foo(bar): + if bar == 'baz': + raise Exception("catch me no matter what I am") + >>> foo("baz") + [!] catch me no matter what I am + + """ + @wraps(func) + def _catch(*args, **kwargs): + try: + func(*args, **kwargs) + except Exception, exc: + exception(exc) + return _catch diff --git a/src/leap/mx/util/net.py b/src/leap/mx/util/net.py new file mode 100644 index 0000000..a4104d0 --- /dev/null +++ b/src/leap/mx/util/net.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +net.py +------- +Utilities for networking. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@license: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import ipaddr +import sys +import socket + +from random import randint + +from leap.mx.utils import log + + +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + + +class UnsupportedPlatform(Exception): + """Support for this platform is not currently available.""" + +class IfaceError(Exception): + """Could not find default network interface.""" + +class PermissionsError(SystemExit): + """This test requires admin or root privileges to run. Exiting...""" + + +def checkIPaddress(addr): + """ + Check that a given string is a valid IPv4 or IPv6 address. + + @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. + @returns: True if :param:`addr` defines a valid IPAddress, else False. + """ + import ipaddr + + try: + check = ipaddr.IPAddress(addr) + except ValueError, ve: + log.warn(ve.message) + return False + else: + return True + +def getClientPlatform(platform_name=None): + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def getPosixIfaces(): + from twisted.internet.test import _posixifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _posixifaces._interfaces() + return ifaces + +def getWindowsIfaces(): + from twisted.internet.test import _win32ifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _win32ifaces._interfaces() + return ifaces + +def getIfaces(platform_name=None): + client, test = getClientPlatform(platform_name) + if client: + if client == ('LINUX' or 'DARWIN') or client[-3:] == 'BSD': + return getPosixIfaces() + elif client == 'WINDOWS': + return getWindowsIfaces() + ## XXX fixme figure out how to get iface for Solaris + else: + raise UnsupportedPlatform + else: + raise UnsupportedPlatform + +def getRandomUnusedPort(addr=None): + free = False + while not free: + port = randint(1024, 65535) + s = socket.socket() + try: + s.bind((addr, port)) + free = True + except: + pass + s.close() + return port + +def getNonLoopbackIfaces(platform_name=None): + try: + ifaces = getIfaces(platform_name) + except UnsupportedPlatform, up: + log.err(up) + + if not ifaces: + log.msg("Unable to discover network interfaces...") + return None + else: + found = [{i[0]: i[2]} for i in ifaces if i[0] != 'lo'] + log.debug("Found non-loopback interfaces: %s" % found) + for iface in ifaces: + try: + interface = checkInterfaces(found) + except IfaceError, ie: + log.err(ie) + return None + else: + return interfaces + + +def getLocalAddress(): + default_iface = getDefaultIface() + return default_iface.ipaddr diff --git a/src/leap/mx/util/version.py b/src/leap/mx/util/version.py new file mode 100644 index 0000000..215876c --- /dev/null +++ b/src/leap/mx/util/version.py @@ -0,0 +1,101 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +version.py +---------- +Version information for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import os +import sys + +from twisted.python import versions + +name = 'leap_mx' +version = versions.Version(name, 0, 0, 1, None) +authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] +git_url = 'https://github.com/isislovecruft/leap_mx/' +website = 'https://leap.se' + +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + +def getClientPlatform(platform_name=None): + """ + Determine the client's operating system platform. Optionally, if + :param:`platform_name` is given, check that this is indeed the platform + we're operating on. + + @param platform_name: A string, upper-, lower-, or mixed case, of one of + the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. + 'Linux' or 'OPENBSD', etc. + @returns: A string specifying the platform name, and the boolean test used + to determine it. + """ + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def getVersion(): + """ + Returns a version object, with attributes authors, git_url, and website. + """ + version.authors = authors + version.git_url = git_url + version.website = website + return version + +def getRepoDir(): + """ + Get the top-level repository directory. + """ + here = os.getcwd() + base = here.rsplit(name, 1)[0] + repo = os.path.join(base, name) + return repo + +def __make_text__(extra_text=None): + splitter = "-" * len(version.__str__()) + header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] + footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] + contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] + contacts.insert(0, "Authors: ") + + with_contacts = header + contacts + + if extra_text is not None: + if isinstance(extra_text, iter): + with_contacts.extend((e for e in extra_text)) + elif isinstance(extra_text, str): + with_contacts.append(extra_text) + else: + print "Couldn't add extra text..." + + text = with_contacts + footer + return text + +def __update_version__(): + repo = getRepoDir() + version_file = os.path.join(repo, 'VERSION') + version_text = __make_text__() + + with open(version_file, 'w+') as fh: + fh.writelines((line for line in version_text)) + fh.flush() + fh.truncate() + + +if __name__ == "__main__": + print "Generating new VERSION file..." + __update_version__() + print "Done." -- cgit v1.2.3 From b32d659b85901a8e04c6c921928483fda3b3e6e0 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:36:43 +0000 Subject: Add the storage utility for parsing the config file structure in a more readable fashion. --- src/leap/mx/util/storage.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 src/leap/mx/util/storage.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/storage.py b/src/leap/mx/util/storage.py new file mode 100644 index 0000000..c4c797a --- /dev/null +++ b/src/leap/mx/util/storage.py @@ -0,0 +1,42 @@ + +class Storage(dict): + """ + A Storage object is like a dictionary except `obj.foo` can be used + in addition to `obj['foo']`. + + >>> o = Storage(a=1) + >>> o.a + 1 + >>> o['a'] + 1 + >>> o.a = 2 + >>> o['a'] + 2 + >>> del o.a + >>> o.a + None + """ + def __getattr__(self, key): + try: + return self[key] + except KeyError, k: + return None + + def __setattr__(self, key, value): + self[key] = value + + def __delattr__(self, key): + try: + del self[key] + except KeyError, k: + raise AttributeError, k + + def __repr__(self): + return '' + + def __getstate__(self): + return dict(self) + + def __setstate__(self, value): + for (k, v) in value.items(): + self[k] = v -- cgit v1.2.3 From 0ceaf9ac207e4d0716c0aa9c6bb4b5871d8d7292 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 22:57:08 +0000 Subject: Cleaned up versioning to have more easily parsable public methods. * Changed most of version.py to be in class Version, without importing any twisted code (so that runner.CheckRequirements can check for it first) and so that leap/mx/util/__init__.py can do: import version version = version.Version() to expost only the public methods. * Moved client detection platform code to leap/mx/util/config.py. --- src/leap/mx/util/__init__.py | 13 +++- src/leap/mx/util/version.py | 158 +++++++++++++++++++++---------------------- 2 files changed, 88 insertions(+), 83 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/__init__.py b/src/leap/mx/util/__init__.py index c8448b0..c4a93b8 100644 --- a/src/leap/mx/util/__init__.py +++ b/src/leap/mx/util/__init__.py @@ -1 +1,12 @@ -__all__ = ['config', 'exceptions', 'log', 'net', 'version, storage'] +#-*- encoding: utf-8 -*- +""" +leap/mx/util/__init__.py +------------------------ +Module intialization file for leap.mx.util. +""" + +import version +version = version.Version() + +__all__ = ['config', 'log', 'net', 'storage', 'version'] + diff --git a/src/leap/mx/util/version.py b/src/leap/mx/util/version.py index 215876c..c32166f 100644 --- a/src/leap/mx/util/version.py +++ b/src/leap/mx/util/version.py @@ -10,92 +10,86 @@ Version information for leap_mx. @copyright: 2013 Isis Agora Lovecruft ''' -import os +from os import getcwd +from os import path as ospath + import sys -from twisted.python import versions - -name = 'leap_mx' -version = versions.Version(name, 0, 0, 1, None) -authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] -git_url = 'https://github.com/isislovecruft/leap_mx/' -website = 'https://leap.se' - -PLATFORMS = {'LINUX': sys.platform.startswith("linux"), - 'OPENBSD': sys.platform.startswith("openbsd"), - 'FREEBSD': sys.platform.startswith("freebsd"), - 'NETBSD': sys.platform.startswith("netbsd"), - 'DARWIN': sys.platform.startswith("darwin"), - 'SOLARIS': sys.platform.startswith("sunos"), - 'WINDOWS': sys.platform.startswith("win32")} - -def getClientPlatform(platform_name=None): - """ - Determine the client's operating system platform. Optionally, if - :param:`platform_name` is given, check that this is indeed the platform - we're operating on. - - @param platform_name: A string, upper-, lower-, or mixed case, of one of - the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. - 'Linux' or 'OPENBSD', etc. - @returns: A string specifying the platform name, and the boolean test used - to determine it. - """ - for name, test in PLATFORMS.items(): - if not platform_name or platform_name.upper() == name: - if test: - return name, test - -def getVersion(): - """ - Returns a version object, with attributes authors, git_url, and website. - """ - version.authors = authors - version.git_url = git_url - version.website = website - return version - -def getRepoDir(): - """ - Get the top-level repository directory. - """ - here = os.getcwd() - base = here.rsplit(name, 1)[0] - repo = os.path.join(base, name) - return repo - -def __make_text__(extra_text=None): - splitter = "-" * len(version.__str__()) - header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] - footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] - contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] - contacts.insert(0, "Authors: ") - - with_contacts = header + contacts - - if extra_text is not None: - if isinstance(extra_text, iter): - with_contacts.extend((e for e in extra_text)) - elif isinstance(extra_text, str): - with_contacts.append(extra_text) - else: - print "Couldn't add extra text..." - - text = with_contacts + footer - return text - -def __update_version__(): - repo = getRepoDir() - version_file = os.path.join(repo, 'VERSION') - version_text = __make_text__() - - with open(version_file, 'w+') as fh: - fh.writelines((line for line in version_text)) - fh.flush() - fh.truncate() + +class Version(object): + def __init__(self): + self.name = 'leap_mx' + self.version = '0.0.2' + self.pipfile = ospath.join(self.getRepoDir(), + 'pkg/mx-requirements.pip') + self.authors = [ + ('Isis Agora Lovecruft', '', '0x2cdb8b35'), + ] + self.git_url = 'https://github.com/isislovecruft/leap_mx/' + self.website = 'https://leap.se' + + def getPackageName(self): + """Returns the application name.""" + return self.name + + def getPipfile(self): + """Returns the full path of the pip requirements.txt file.""" + return self.pipfile + + def getVersion(self): + """Returns a version the application name and version number.""" + return self.version + + def getAuthors(self): + credits = str() + for author in self.authors: + credits += " ".join(author) + return credits + + def getRepoDir(self): + """Get the top-level repository directory.""" + here = getcwd() + base = here.rsplit(self.name, 1)[0] + repo = ospath.join(base, self.name) + return repo + + def __make_text__(self, extra_text=None): + splitr = "-" * len(self.version.__str__()) + header = ["\n%s\n" % self.version.__str__(), + "%s\n" % splitr] + footer = ["Website: \t%s\n" % self.website, + "Github: \t%s\n" % self.git_url, + "\n"] + contacts = ["\t%s, %s %s\n" + % (a[0], a[1], a[2]) for a in self.authors] + contacts.insert(0, "Authors: ") + + with_contacts = header + contacts + + if extra_text is not None: + if isinstance(extra_text, iter): + with_contacts.extend((e for e in extra_text)) + elif isinstance(extra_text, str): + with_contacts.append(extra_text) + else: + print "Couldn't add extra text..." + + text = with_contacts + footer + return text + + def __update_version__(self): + repo = self.getRepoDir() + self.version_file = ospath.join(repo, 'VERSION') + version_text = self.__make_text__() + + with open(self.version_file, 'w+') as fh: + fh.writelines((line for line in version_text)) + fh.flush() + fh.truncate() if __name__ == "__main__": print "Generating new VERSION file..." - __update_version__() + vrsn = Version() + vrsn.__update_version__() print "Done." -- cgit v1.2.3 From 92ab44a213b88b510e9d86865a3630fa0b664313 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:02:26 +0000 Subject: Moved leap/mx/util/exceptions.py to leap/mx/exceptions.py. --- src/leap/mx/exceptions.py | 23 +++++++++++++++++++++++ src/leap/mx/util/exceptions.py | 23 ----------------------- 2 files changed, 23 insertions(+), 23 deletions(-) create mode 100644 src/leap/mx/exceptions.py delete mode 100644 src/leap/mx/util/exceptions.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/exceptions.py b/src/leap/mx/exceptions.py new file mode 100644 index 0000000..63b946c --- /dev/null +++ b/src/leap/mx/exceptions.py @@ -0,0 +1,23 @@ +#! -*- encoding: utf-8 -*- +""" +Custom exceptions for leap_mx. + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +class UnsupportedOS(Exception): + """Raised when we're not *nix or *BSD.""" diff --git a/src/leap/mx/util/exceptions.py b/src/leap/mx/util/exceptions.py deleted file mode 100644 index 63b946c..0000000 --- a/src/leap/mx/util/exceptions.py +++ /dev/null @@ -1,23 +0,0 @@ -#! -*- encoding: utf-8 -*- -""" -Custom exceptions for leap_mx. - -@authors: Isis Lovecruft, 0x2cdb8b35 -@version: 0.0.1 -@license: see included LICENSE file -""" - - -class MissingConfig(Exception): - """Raised when the config file cannot be found.""" - def __init__(self, message=None, config_file=None): - if message: - return - else: - self.message = "Cannot locate config file" - if config_file: - self.message += " %s" % config_file - self.message += "." - -class UnsupportedOS(Exception): - """Raised when we're not *nix or *BSD.""" -- cgit v1.2.3 From d925c51439a85d552afaca58fc1f87a8745c3c16 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:03:46 +0000 Subject: Add exceptions and util to leap/mx/__init__.py. --- src/leap/mx/__init__.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index 507efee..27fadca 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -1,3 +1,8 @@ -#from . import util +#-*- encoding: utf-8 -*- +""" +leap/mx/__init__.py +------------------- +Module intialization file for leap.mx . +""" -__all__ = ['alias_resolver', 'runner', 'tests', 'couchdb'] +__all__ = ['alias_resolver', 'couchdb', 'exceptions', 'runner', 'util'] -- cgit v1.2.3 From 73ee880147dfd2dd5f6e553069028ea32ffc1a53 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:06:24 +0000 Subject: Fix typo in leap/mx/util/net.py. --- src/leap/mx/util/net.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/net.py b/src/leap/mx/util/net.py index a4104d0..64dbc90 100644 --- a/src/leap/mx/util/net.py +++ b/src/leap/mx/util/net.py @@ -16,7 +16,7 @@ import socket from random import randint -from leap.mx.utils import log +from leap.mx.util import log PLATFORMS = {'LINUX': sys.platform.startswith("linux"), -- cgit v1.2.3 From 91d70343acecb1b2225cf94024d738c053eff4c3 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:13:08 +0000 Subject: Fix imports in leap/mx/util/config.py to not import all of os. --- src/leap/mx/util/config.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 5bc5231..5be66b1 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -29,7 +29,9 @@ the section names. Like this: @license: see included LICENSE file """ -import os +from os import path as ospath + +import sys import yaml ## xxx only install/import this in *nix -- cgit v1.2.3 From d3bc6e22b618771e02b2941f573759a8021e8752 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:15:31 +0000 Subject: Fix imports in leap/mx/util/config.py to reflect move of util/ directory, and setup default config storage.Storage() modified dictionary objects for YAML configs. --- src/leap/mx/util/config.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 5be66b1..3eb4cdb 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -34,12 +34,13 @@ from os import path as ospath import sys import yaml -## xxx only install/import this in *nix -from xdg import BaseDirectory +from leap.mx.util import version, storage +from leap.mx.exceptions import MissingConfig, UnsupportedOS -from leap.util import log, version, Storage -from leap.util.exceptions import MissingConfig, UnsupportedOS +filename = None +basic = storage.Storage() +advanced = storage.Storage() def _create_config_file(file): """ -- cgit v1.2.3 From 2773a3d35a2c87100da520b7e947d1d77f52e134 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:18:57 +0000 Subject: Moved client platform detection code to leap/mx/util/config.py. * Remove extraneous storage.Storage() initializations. * Autosetup calls to config._get_config_location based on whether config.filename has been set elsewhere. --- src/leap/mx/util/config.py | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 3eb4cdb..9bf90e8 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -42,11 +42,36 @@ filename = None basic = storage.Storage() advanced = storage.Storage() -def _create_config_file(file): +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + +def getClientPlatform(platform_name=None): + """ + Determine the client's operating system platform. Optionally, if + :param:`platform_name` is given, check that this is indeed the platform + we're operating on. + + @param platform_name: A string, upper-, lower-, or mixed case, of one + of the keys in the :attr:`leap.util.version.PLATFORMS` + dictionary. E.g. 'Linux' or 'OPENBSD', etc. + @returns: A string specifying the platform name, and the boolean test + used to determine it. + """ + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def _create_config_file(conffile): """ xxx fill me in """ - with open(file, 'w+') as conf: + with open(conffile, 'w+') as conf: conf.write(""" # # mx.conf @@ -72,12 +97,6 @@ advanced: """) conf.flush() - try: - assert os.path.isfile(file), "Config file %s not created!" % file - except AssertionError, ae: - raise SystemExit(ae.message) - else: - return file def _get_config_filename(filename=None, use_dot_config_directory=False): """ @@ -147,14 +166,12 @@ def loadConfig(filename=config_filename): ## from leap.util import config ## config.basic.foo = bar ## - basic = Storage() try: for k, v in configuration['basic'].items(): basic[k] = v except AttributeError: pass - advanced = Storage() try: for k, v in configuration['advanced'].items(): advanced[k] = v @@ -168,8 +185,7 @@ def loadConfig(filename=config_filename): ## This is the name of the config file to use: ## If not set, it defaults to 'leap_mx/leap_mx.conf' -if not config_filename: - config_filename = _get_config_filename() +if not filename: + filename = _get_config_location() else: - config_filename = _get_config_filename(filename=config_filename) - + filename = _get_config_location(config_filename=filename) -- cgit v1.2.3 From f02e6aa89d5a22182b5906ea7053eabc7d20ecb9 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:21:50 +0000 Subject: Add new parameters 'enable_logfile', 'logfile', 'debug', and 'noisy' to the default config creation template. --- src/leap/mx/util/config.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 9bf90e8..cb548f6 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -83,6 +83,10 @@ def _create_config_file(conffile): # basic: + # Whether or not to log to file: + enable_logfile: True + # The name of the logfile: + logfile: mx.log # Where is the spoolfile of messages to encrypt?: spoolfile: /var/mail/encrypt_me advanced: @@ -91,9 +95,9 @@ advanced: # Which port on localhost should postfix ask for UUIDs?: virtual_alias_map_port: 1348 # Enable debugging output in the logger: - debug: true + debug: True # Print enough things really fast to make you look super 1337: - noisy: false + noisy: False """) conf.flush() -- cgit v1.2.3 From 031a0024c4350e5fb79ffd5ed3533c6a23600749 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:23:32 +0000 Subject: Fix discovery of xdg .config directory on *nix systems, and use that path for our config file if it exists. --- src/leap/mx/util/config.py | 59 +++++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 27 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index cb548f6..e5db591 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -102,12 +102,21 @@ advanced: """) conf.flush() -def _get_config_filename(filename=None, use_dot_config_directory=False): + assert ospath.isfile(conffile), "Config file %s not created!" % conffile + +def _get_config_location(config_filename=None, + use_dot_config_directory=False): """ Get the full path and filename of the config file. """ - platform = version.getClientPlatform()[0] - resource = version.name + platform = getClientPlatform()[0] + + ## If not given, default to the application's name + '.conf' + if not config_filename: + if not filename: + config_filename = "mx.conf" + else: + config_filename = filename ## Oh hell, it could be said only to beguile: ## That windoze users are capable of editing a .conf file. @@ -118,34 +127,30 @@ def _get_config_filename(filename=None, use_dot_config_directory=False): if not platform.endswith('LINUX') and not platform.endswith('BSD'): raise UnsupportedOS("Sorry, your operating system isn't supported.") - ## If not given, default to the application's name + '.conf' - if not filename: - filename = resource + ".conf" - where = None - if not use_dot_config_directory: - repo_dir = version.getRepoDir() - where = os.path.abspath(repo_dir) - ## Use ~/.config/ instead: - else: + if use_dot_config_directory: + ## xxx only install/import this in *nix + from xdg import BaseDirectory + dot_config_dirs = BaseDirectory.xdg_config_dirs for dir in dot_config_dirs: - our_dir = os.path.join(dir, resource) - if os.path.isdir(our_dir): - if filename in os.listdir(our_dir): - where = os.path.abspath(our_dir) - if not where: - where = BaseDirectory.save_config_path(resource) - - conffile = os.path.join(where, filename) + our_dir = ospath.join(dir, package_name) + if ospath.isdir(our_dir): + if config_filename in os.listdir(our_dir): + where = ospath.abspath(our_dir) + ## Use repo dir instead: + if not where: + where = version.getRepoDir() + + conffile = ospath.join(where, config_filename) try: with open(conffile) as cf: pass except IOError: - conffile = _create_config_file(conffile) + _create_config_file(conffile) finally: return conffile -def loadConfig(filename=config_filename): +def loadConfig(file=None): """ Some of this is taken from OONI config code for now, and so this should be refacotored, along with the leap_client config code, so that we have @@ -155,13 +160,13 @@ def loadConfig(filename=config_filename): Excuse the yaml for now, I just wanted something that works. - @param filename: (optional) If provided, use this filename. + @param file: (optional) If provided, use this filename. """ - if not filename: - filename = _get_config_filename() + if not file: + file = _get_config_location() - if os.path.isfile(filename): - with open(filename, 'a+') as conf: + if ospath.isfile(file): + with open(file, 'a+') as conf: config_contents = '\n'.join(conf.readlines()) configuration = yaml.safe_load(config_contents) -- cgit v1.2.3 From 3cd39505708819a2d70dd5b91f8d1de81e89181e Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:27:18 +0000 Subject: Fix log.start() function in leap/mx/util/log.py to properly use the xdg directory if that was discovered in config setup. * Updated imports to reflect directory layout changes, again. --- src/leap/mx/util/log.py | 39 ++++++++++++++------------------------- 1 file changed, 14 insertions(+), 25 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py index ef54605..02ceddf 100644 --- a/src/leap/mx/util/log.py +++ b/src/leap/mx/util/log.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # -*- encoding: utf-8 -*- ''' log.py @@ -21,10 +20,10 @@ import traceback from twisted.python import log as txlog from twisted.python import util as txutil -from twisted.python.logfile import DailyLogFile +from twisted.python import logfile as txlogfile from twisted.python.failure import Failure -from leap.util import version, config +from leap.mx.util import version, config class InvalidTimestampFormat(Exception): @@ -65,34 +64,24 @@ def timeToPrettyDate(time_val): """Convert seconds since epoch to date.""" return time.ctime(time_val) -def start(logfile=None, application_name=None): +def start(logfilename=None, logfiledir=None): """ Start logging to stdout, and optionally to a logfile as well. - @param logfile: The filename to store logs in, which is placed in - /leap_mx/logs/. - @param application_name: The name of the running application. + @param logfile: The full path of the filename to store logs in. """ - if not application_name: - application_name = version.name - print "application name: %s" % application_name - - daily_logfile = None - - if not logfile: - logfile = config.basic.logfile - - repo_dir = version.getRepoDir() - logfile_dir = os.path.join(repo_dir, 'log') - logfile_name = logfile + txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) - daily_logfile = DailyLogFile(logfile_name, logfile_dir) + if logfilename and logfiledir: + if not os.path.isdir(logfiledir): + os.makedirs(logfiledir) + daily_logfile = txlogfile.DailyLogFile(logfilename, logfiledir) + txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) - txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) - txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) - txlog.msg("Starting %s on %s (%s UTC)" % (application_name, - prettyDateNow(), - utcPrettyDateNow())) + txlog.msg("Starting %s, version %s, on %s UTC" % (version.getPackageName(), + version.getVersion(), + utcPrettyDateNow())) + txlog.msg("Authors: %s" % version.getAuthors()) def msg(msg, *arg, **kwarg): """Log a message at the INFO level.""" -- cgit v1.2.3 From bd4b080b63493a180cb979f1cda952e7927a7c15 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:28:46 +0000 Subject: Fix a bug in log.debug() where it was checking for the config setting in the wrong section of the config. --- src/leap/mx/util/log.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py index 02ceddf..f31684d 100644 --- a/src/leap/mx/util/log.py +++ b/src/leap/mx/util/log.py @@ -89,7 +89,7 @@ def msg(msg, *arg, **kwarg): def debug(msg, *arg, **kwarg): """Log a message at the DEBUG level.""" - if config.basic.debug: + if config.advanced.debug: print "[d] %s" % msg def warn(msg, *arg, **kwarg): -- cgit v1.2.3 From bc57191ce66b66b20fd21871a136ad84721b3a7b Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:36:07 +0000 Subject: Add new version of leap/mx/util/runner.py file. --- src/leap/mx/runner.py | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 src/leap/mx/runner.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/runner.py b/src/leap/mx/runner.py new file mode 100644 index 0000000..daf956e --- /dev/null +++ b/src/leap/mx/runner.py @@ -0,0 +1,83 @@ +#-*- coding: utf-8 -*- +""" +runner +------ +A module containing application and daemon process utilities. + +@author Isis Agora Lovecruft , 0x2cdb8b35 +@version 0.0.1 + +""" + +from os import path as ospath + +import re + + +class CheckRequirements(ImportError): + """ + Raised when we're missing something from requirements.pip. + """ + def __init__(self, package_name, pipfile, message=None): + """ + Display an error message with instructions for obtaining missing + dependencies. + + @param message: A string describing the error. + @param missing: A string indicating which dependency is missing. + @param pipfile: The path and filename of the pip requirements file, + relative to the top-level repository directory. + """ + if message: + self.message = message + return self + + self.package_name = package_name + self.pipfile = pipfile + self.dependencies = self.__read_pip_requirements__() + self.missing = [] + + for package, version in self.dependencies: + pkg = package.lower() if package == "Twisted" else package + try: + __import__(pkg) + except ImportError: + self.missing.append(package) + + if len(self.missing) > 0: + self.message = self.package_name + " requires " + elif len(self.missing) <= 0: + return None + + if len(self.missing) >= 1: + for missed in self.missing[:-1]: + self.message += missed + ", " + self.message += "and " + + if len(self.missing) == 1: + self.message += self.missing[0] + "." + self.message += "\nPlease see %s for ".format(self.pipfile) + self.message += "instruction on installing dependencies." + raise self(self.message) + + def __read_pip_requirements__(self, file=None): + """ + Check the pip requirements file to determine our dependencies. + + @param file: The full path of the pip requirements.txt file. + @returns: A list of tuple(package_name, package_version). + """ + if not file: + file = self.pipfile + + requirement = re.compile('[^0-9=><]+') + dependencies = [] + + with open(file) as pipfile: + for line in pipfile.readlines(): + shortened = line.strip() + matched = requirement.match(shortened) + package_name = matched.group() + package_version = shortened.split(package_name, 1)[1] + dependencies.append((package_name, package_version)) + return dependencies -- cgit v1.2.3 From 340392e50b04d2c795e6d84d632590b26188feee Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 00:03:58 +0000 Subject: Add update mechanism to config files to allow new default configs to be pushed to the git repo later without breaking past versions. --- src/leap/mx/util/config.py | 51 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 15 deletions(-) (limited to 'src/leap/mx') diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index e5db591..f655ca9 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -38,9 +38,11 @@ from leap.mx.util import version, storage from leap.mx.exceptions import MissingConfig, UnsupportedOS -filename = None -basic = storage.Storage() -advanced = storage.Storage() +filename = None +config_version = None +basic = storage.Storage() +couch = storage.Storage() +advanced = storage.Storage() PLATFORMS = {'LINUX': sys.platform.startswith("linux"), 'OPENBSD': sys.platform.startswith("openbsd"), @@ -69,7 +71,9 @@ def getClientPlatform(platform_name=None): def _create_config_file(conffile): """ - xxx fill me in + Create the config file if it doesn't exist. + + @param conffile: The full path to the config file to write to. """ with open(conffile, 'w+') as conf: conf.write(""" @@ -89,6 +93,15 @@ basic: logfile: mx.log # Where is the spoolfile of messages to encrypt?: spoolfile: /var/mail/encrypt_me +couch: + # The couch username for authentication to a CouchDB instance: + user: admin + # The couch username's password: + passwd: passwd + # The CouchDB hostname or IP address to connect to: + host: couchdb.example.com + # The CouchDB port to connect to: + port: 7001 advanced: # Which port on localhost should postfix send check_recipient queries to?: check_recipient_access_port: 1347 @@ -98,10 +111,10 @@ advanced: debug: True # Print enough things really fast to make you look super 1337: noisy: False +config_version: 0.0.2 """) conf.flush() - assert ospath.isfile(conffile), "Config file %s not created!" % conffile def _get_config_location(config_filename=None, @@ -168,26 +181,34 @@ def loadConfig(file=None): if ospath.isfile(file): with open(file, 'a+') as conf: config_contents = '\n'.join(conf.readlines()) - configuration = yaml.safe_load(config_contents) + cfg = yaml.safe_load(config_contents) ## These become objects with their keys loaded as attributes: ## ## from leap.util import config ## config.basic.foo = bar ## - try: - for k, v in configuration['basic'].items(): + try: + for k, v in cfg['basic'].items(): basic[k] = v - except AttributeError: - pass + except (AttributeError, KeyError): pass - try: - for k, v in configuration['advanced'].items(): + try: + for k, v in cfg['advanced'].items(): advanced[k] = v - except AttributeError: - pass + except (AttributeError, KeyError): pass + + try: + for k, v in cfg['couch'].items(): + couch[k] = v + except (AttributeError, KeyError): pass + + if 'config_version' in cfg: + config_version = cfg['config_version'] + else: + config_version = 'unknown' - return basic, advanced + return basic, couch, advanced, config_version else: raise MissingConfig("Could not load config file.") -- cgit v1.2.3 From 8d2fdc800de469420005f9c5deee4c342950ccc9 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:38:14 +0000 Subject: Add an __init__.py to the leap/mx/tests module with a boilerplated tests.run() function so that the options parser doesn't choke on it. --- src/leap/mx/tests/__init__.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 src/leap/mx/tests/__init__.py (limited to 'src/leap/mx') diff --git a/src/leap/mx/tests/__init__.py b/src/leap/mx/tests/__init__.py new file mode 100644 index 0000000..0416769 --- /dev/null +++ b/src/leap/mx/tests/__init__.py @@ -0,0 +1,17 @@ +#-*- encoding: utf-8 -*- +""" +leap/mx/tests/__init__.py +------------------------- +Module intialization file for leap.mx.tests, a module containing unittesting +code, using twisted.trial, for testing leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@license: AGPLv3, see included LICENSE file +@copyright: © 2013 Isis Lovecruft, see COPYLEFT file +""" + +__all__ = ['test_alias_resolver'] + +def run(): + """xxx fill me in""" + pass -- cgit v1.2.3