Mercurial Repository: p/roundup/code: scripts/imapServer.py comparison

comparison scripts/imapServer.py @ 3203:eddcfee2cc19

reformat

author	Alexander Smishlajev <a1s@users.sourceforge.net>
date	Fri, 18 Feb 2005 12:31:47 +0000
parents	18ad9d702a5b
children	f2fda3e6fc8b

comparison

equal deleted inserted replaced

-:d2b1a946fdf4
+:eddcfee2cc19
-#!/usr/bin/env python2.3
+#!/usr/bin/env python
-# arch-tag: f2d1fd6e-df72-4188-a3b4-a9dbbb0807b9
-# vim: filetype=python ts=4 sw=4 noexpandtab si
 """\
 This script is a wrapper around the mailgw.py script that exists in roundup.
 It runs as service instead of running as a one-time shot.
 It also connects to a secure IMAP server. The main reasons for this script are:
-1) The roundup-mailgw script isn't designed to run as a server. It expects that you
+1) The roundup-mailgw script isn't designed to run as a server. It
-either run it by hand, and enter the password each time, or you supply the
+expects that you either run it by hand, and enter the password each
-password on the command line. I prefer to run a server that I initialize with
+time, or you supply the password on the command line. I prefer to
-the password, and then it just runs. I don't want to have to pass it on the
+run a server that I initialize with the password, and then it just
-command line, so running through crontab isn't a possibility. (This wouldn't
+runs. I don't want to have to pass it on the command line, so
-be a problem on a local machine running through a mailspool.)
+running through crontab isn't a possibility. (This wouldn't be a
-2) mailgw.py somehow screws up SSL support so IMAP4_SSL doesn't work. So hopefully
+problem on a local machine running through a mailspool.)
-running that work outside of the mailgw will allow it to work.
+2) mailgw.py somehow screws up SSL support so IMAP4_SSL doesn't work. So
-3) I wanted to be able to check multiple projects at the same time. roundup-mailgw is
+hopefully running that work outside of the mailgw will allow it to work.
-only for 1 mailbox and 1 project.
+3) I wanted to be able to check multiple projects at the same time.
+roundup-mailgw is only for 1 mailbox and 1 project.
 *TODO*:
-For the first round, the program spawns a new roundup-mailgw for each imap message
+For the first round, the program spawns a new roundup-mailgw for
-that it finds and pipes the result in. In the future it might be more practical to
+each imap message that it finds and pipes the result in. In the
-actually include the roundup files and run the appropriate commands using python.
+future it might be more practical to actually include the roundup
+files and run the appropriate commands using python.
 *TODO*:
 Look into supporting a logfile instead of using 2>/logfile
 *TODO*:
 Add an option for changing the uid/gid of the running process.
 """
+import getpass
 import logging
+import imaplib
+import optparse
+import os
+import re
+import time
 logging.basicConfig()
 log = logging.getLogger('IMAPServer')
 version = '0.1.2'
 class RoundupMailbox:
-	"""This contains all the info about each mailbox.
+"""This contains all the info about each mailbox.
-	Username, Password, server, security, roundup database
+Username, Password, server, security, roundup database
-	"""
+"""
-	def __init__(self, dbhome='', username=None, password=None, mailbox=None
+def __init__(self, dbhome='', username=None, password=None, mailbox=None
-		, server=None, protocol='imaps'):
+, server=None, protocol='imaps'):
-		self.username = username
+self.username = username
-		self.password = password
+self.password = password
-		self.mailbox = mailbox
+self.mailbox = mailbox
-		self.server = server
+self.server = server
-		self.protocol = protocol
+self.protocol = protocol
-		self.dbhome = dbhome
+self.dbhome = dbhome
-		try:
+try:
-			if not self.dbhome:
+if not self.dbhome:
-				import os
+self.dbhome = raw_input('Tracker home: ')
-				self.dbhome = raw_input('Tracker home: ')
+if not os.path.exists(self.dbhome):
-				if not os.path.exists(self.dbhome):
+raise ValueError, 'Invalid home address: ' \
-					raise ValueError, 'Invalid home address directory does not exist. %s' % self.dbhome
+'directory "%s" does not exist.' % self.dbhome
-			if not self.server:
+if not self.server:
-				self.server = raw_input('Server: ')
+self.server = raw_input('Server: ')
-				if not self.server:
+if not self.server:
-					raise ValueError, 'No Servername supplied'
+raise ValueError, 'No Servername supplied'
-				protocol = raw_input('protocol [imaps]? ')
+protocol = raw_input('protocol [imaps]? ')
-				self.protocol = protocol
+self.protocol = protocol
-			if not self.username:
+if not self.username:
-				self.username = raw_input('Username: ')
+self.username = raw_input('Username: ')
-				if not self.username:
+if not self.username:
-					raise ValueError, 'Invalid Username'
+raise ValueError, 'Invalid Username'
-			if not self.password:
+if not self.password:
-				import getpass
+print 'For server %s, user %s' % (self.server, self.username)
-				print 'For server %s, user %s' % (self.server, self.username)
+self.password = getpass.getpass()
-				self.password = getpass.getpass()
+# password can be empty because it could be superceeded
-				# password can be empty because it could be superceeded by a later
+# by a later entry
-				# entry
+#if self.mailbox is None:
-			#if self.mailbox is None:
+#   self.mailbox = raw_input('Mailbox [INBOX]: ')
-			#	self.mailbox = raw_input('Mailbox [INBOX]: ')
+#   # We allow an empty mailbox because that will
-			#	# We allow an empty mailbox because that will
+#   # select the INBOX, whatever it is called
-			#	# select the INBOX, whatever it is called
+except (KeyboardInterrupt, EOFError):
-		except (KeyboardInterrupt, EOFError):
+raise ValueError, 'Canceled by User'
-			raise ValueError, 'Canceled by User'
+def __str__(self):
-	def __str__(self):
+return 'Mailbox{ server:%(server)s, protocol:%(protocol)s, ' \
-		return """Mailbox{ server:%(server)s, protocol:%(protocol)s, username:%(username)s, mailbox:%(mailbox)s, dbhome:%(dbhome)s }""" % self.__dict__
+'username:%(username)s, mailbox:%(mailbox)s, ' \
+'dbhome:%(dbhome)s }' % self.__dict__
+# [als] class name is misleading.  this is imap client, not imap server
 class IMAPServer:
-	"""This class runs as a server process. It is configured with a list of
-	mailboxes to connect to, along with the roundup database directories that correspond
+"""IMAP mail gatherer.
-	with each email address.
-	It then connects to each mailbox at a specified interval, and if there are new messages
+This class runs as a server process. It is configured with a list of
-	it reads them, and sends the result to the roundup.mailgw.
+mailboxes to connect to, along with the roundup database directories
+that correspond with each email address.  It then connects to each
-	*TODO*:
+mailbox at a specified interval, and if there are new messages it
-	  Try to be smart about how you access the mailboxes so that you can connect once, and
+reads them, and sends the result to the roundup.mailgw.
-	  access multiple mailboxes and possibly multiple usernames.
+*TODO*:
-	*NOTE*:
+Try to be smart about how you access the mailboxes so that you can
-	  This assumes that if you are using the same user on the same server, you are using
+connect once, and access multiple mailboxes and possibly multiple
-	  the same password. (the last one supplied is used.) Empty passwords are ignored.
+usernames.
-	  Only the last protocol supplied is used.
-	"""
+*NOTE*:
+This assumes that if you are using the same user on the same
-	def __init__(self, pidfile=None, delay=5, daemon=False):
+server, you are using the same password. (the last one supplied is
-		#This is sorted by servername, then username, then mailboxes
+used.) Empty passwords are ignored.  Only the last protocol
-		self.mailboxes = {}
+supplied is used.
-		self.delay = float(delay)
+"""
-		self.pidfile = pidfile
-		self.daemon = daemon
+def __init__(self, pidfile=None, delay=5, daemon=False):
+#This is sorted by servername, then username, then mailboxes
-	def setDelay(self, delay):
+self.mailboxes = {}
-		self.delay = delay
+self.delay = float(delay)
+self.pidfile = pidfile
-	def addMailbox(self, mailbox):
+self.daemon = daemon
-		""" The linkage is as follows:
-		servers -- users - mailbox:dbhome
+def setDelay(self, delay):
-		So there can be multiple servers, each with multiple users.
+self.delay = delay
-		Each username can be associated with multiple mailboxes.
-		each mailbox is associated with 1 database home
+def addMailbox(self, mailbox):
-		"""
+""" The linkage is as follows:
-		log.info('Adding mailbox %s', mailbox)
+servers -- users - mailbox:dbhome
-		if not self.mailboxes.has_key(mailbox.server):
+So there can be multiple servers, each with multiple users.
-			self.mailboxes[mailbox.server] = {'protocol':'imaps', 'users':{}}
+Each username can be associated with multiple mailboxes.
-		server = self.mailboxes[mailbox.server]
+each mailbox is associated with 1 database home
-		if mailbox.protocol:
+"""
-			server['protocol'] = mailbox.protocol
+log.info('Adding mailbox %s', mailbox)
+if not self.mailboxes.has_key(mailbox.server):
-		if not server['users'].has_key(mailbox.username):
+self.mailboxes[mailbox.server] = {'protocol':'imaps', 'users':{}}
-			server['users'][mailbox.username] = {'password':'', 'mailboxes':{}}
+server = self.mailboxes[mailbox.server]
-		user = server['users'][mailbox.username]
+if mailbox.protocol:
-		if mailbox.password:
+server['protocol'] = mailbox.protocol
-			user['password'] = mailbox.password
+if not server['users'].has_key(mailbox.username):
-		if user['mailboxes'].has_key(mailbox.mailbox):
+server['users'][mailbox.username] = {'password':'', 'mailboxes':{}}
-			raise ValueError, 'Mailbox is already defined'
+user = server['users'][mailbox.username]
+if mailbox.password:
-		user['mailboxes'][mailbox.mailbox] = mailbox.dbhome
+user['password'] = mailbox.password
-	def _process(self, message, dbhome):
+if user['mailboxes'].has_key(mailbox.mailbox):
-		"""Actually process one of the email messages"""
+raise ValueError, 'Mailbox is already defined'
-		import os, sys
-		child = os.popen('roundup-mailgw %s' % dbhome, 'wb')
+user['mailboxes'][mailbox.mailbox] = mailbox.dbhome
-		child.write(message)
-		child.close()
+def _process(self, message, dbhome):
-		#print message
+"""Actually process one of the email messages"""
+child = os.popen('roundup-mailgw %s' % dbhome, 'wb')
-	def _getMessages(self, serv, count, dbhome):
+child.write(message)
-		"""This assumes that you currently have a mailbox open, and want to
+child.close()
-		process all messages that are inside.
+#print message
-		"""
-		for n in range(1, count+1):
+def _getMessages(self, serv, count, dbhome):
-			(t, data) = serv.fetch(n, '(RFC822)')
+"""This assumes that you currently have a mailbox open, and want to
-			if t == 'OK':
+process all messages that are inside.
-				self._process(data[0][1], dbhome)
+"""
-				serv.store(n, '+FLAGS', r'(\Deleted)')
+for n in range(1, count+1):
+(t, data) = serv.fetch(n, '(RFC822)')
-	def checkBoxes(self):
+if t == 'OK':
-		"""This actually goes out and does all the checking.
+self._process(data[0][1], dbhome)
-		Returns False if there were any errors, otherwise returns true.
+serv.store(n, '+FLAGS', r'(\Deleted)')
-		"""
-		import imaplib
+def checkBoxes(self):
-		noErrors = True
+"""This actually goes out and does all the checking.
-		for server in self.mailboxes:
+Returns False if there were any errors, otherwise returns true.
-			log.info('Connecting to server: %s', server)
+"""
-			s_vals = self.mailboxes[server]
+noErrors = True
+for server in self.mailboxes:
-			try:
+log.info('Connecting to server: %s', server)
-				for user in s_vals['users']:
+s_vals = self.mailboxes[server]
-					u_vals = s_vals['users'][user]
-					# TODO: As near as I can tell, you can only
+try:
-					# login with 1 username for each connection to a server.
+for user in s_vals['users']:
-					protocol = s_vals['protocol'].lower()
+u_vals = s_vals['users'][user]
-					if protocol == 'imaps':
+# TODO: As near as I can tell, you can only
-						serv = imaplib.IMAP4_SSL(server)
+# login with 1 username for each connection to a server.
-					elif protocol == 'imap':
+protocol = s_vals['protocol'].lower()
-						serv = imaplib.IMAP4(server)
+if protocol == 'imaps':
-					else:
+serv = imaplib.IMAP4_SSL(server)
-						raise ValueError, 'Unknown protocol %s' % protocol
+elif protocol == 'imap':
+serv = imaplib.IMAP4(server)
-					password = u_vals['password']
+else:
+raise ValueError, 'Unknown protocol %s' % protocol
-					try:
-						log.info('Connecting as user: %s', user)
+password = u_vals['password']
-						serv.login(user, password)
+try:
-						for mbox in u_vals['mailboxes']:
+log.info('Connecting as user: %s', user)
-							dbhome = u_vals['mailboxes'][mbox]
+serv.login(user, password)
-							log.info('Using mailbox: %s, home: %s', mbox, dbhome)
-							#access a specific mailbox
+for mbox in u_vals['mailboxes']:
-							if mbox:
+dbhome = u_vals['mailboxes'][mbox]
-								(t, data) = serv.select(mbox)
+log.info('Using mailbox: %s, home: %s',
-							else:
+mbox, dbhome)
-								# Select the default mailbox (INBOX)
+#access a specific mailbox
-								(t, data) = serv.select()
+if mbox:
-							try:
+(t, data) = serv.select(mbox)
-								nMessages = int(data[0])
+else:
-							except ValueError:
+# Select the default mailbox (INBOX)
-								nMessages = 0
+(t, data) = serv.select()
+try:
-							log.info('Found %s messages', nMessages)
+nMessages = int(data[0])
+except ValueError:
-							if nMessages:
+nMessages = 0
-								self._getMessages(serv, nMessages, dbhome)
-								serv.expunge()
+log.info('Found %s messages', nMessages)
-							# We are done with this mailbox
+if nMessages:
-							serv.close()
+self._getMessages(serv, nMessages, dbhome)
-					except:
+serv.expunge()
-						log.exception('Exception with server %s user %s', server, user)
-						noErrors = False
+# We are done with this mailbox
+serv.close()
-					serv.logout()
+except:
-					serv.shutdown()
+log.exception('Exception with server %s user %s',
-					del serv
+server, user)
-			except:
+noErrors = False
-				log.exception('Exception while connecting to %s', server)
-				noErrors = False
+serv.logout()
-		return noErrors
+serv.shutdown()
+del serv
+except:
-	def makeDaemon(self):
+log.exception('Exception while connecting to %s', server)
-		"""This forks a couple of times, and otherwise makes this run as a daemon."""
+noErrors = False
-		''' Turn this process into a daemon.
+return noErrors
-			- make our parent PID 1
-			Write our new PID to the pidfile.
+def makeDaemon(self):
+"""Turn this process into a daemon.
-			From A.M. Kuuchling (possibly originally Greg Ward) with
-			modification from Oren Tirosh, and finally a small mod from me.
+- make our parent PID 1
-			Originally taken from roundup.scripts.roundup_server.py
-		'''
+Write our new PID to the pidfile.
-		log.info('Running as Daemon')
-		import os
+From A.M. Kuuchling (possibly originally Greg Ward) with
-		# Fork once
+modification from Oren Tirosh, and finally a small mod from me.
-		if os.fork() != 0:
+Originally taken from roundup.scripts.roundup_server.py
-			os._exit(0)
+"""
+log.info('Running as Daemon')
-		# Create new session
+# Fork once
-		os.setsid()
+if os.fork() != 0:
+os._exit(0)
-		# Second fork to force PPID=1
-		pid = os.fork()
+# Create new session
-		if pid:
+os.setsid()
-			if self.pidfile:
-				pidfile = open(self.pidfile, 'w')
+# Second fork to force PPID=1
-				pidfile.write(str(pid))
+pid = os.fork()
-				pidfile.close()
+if pid:
-			os._exit(0)
+if self.pidfile:
+pidfile = open(self.pidfile, 'w')
-		#os.chdir("/")
+pidfile.write(str(pid))
-		#os.umask(0)
+pidfile.close()
+os._exit(0)
-	def run(self):
-		"""This spawns itself as a daemon, and then runs continually, just sleeping inbetween checks.
+#os.chdir("/")
-		It is recommended that you run checkBoxes once first before you select run. That way you can
+#os.umask(0)
-		know if there were any failures.
-		"""
+def run(self):
-		import time
+"""Run email gathering daemon.
-		if self.daemon:
-			self.makeDaemon()
+This spawns itself as a daemon, and then runs continually, just
-		while True:
+sleeping inbetween checks.  It is recommended that you run
+checkBoxes once first before you select run. That way you can
-			time.sleep(self.delay * 60.0)
+know if there were any failures.
-			log.info('Time: %s', time.strftime('%Y-%m-%d %H:%M:%S'))
+"""
-			self.checkBoxes()
+if self.daemon:
+self.makeDaemon()
+while True:
+time.sleep(self.delay * 60.0)
+log.info('Time: %s', time.strftime('%Y-%m-%d %H:%M:%S'))
+self.checkBoxes()
 def getItems(s):
-	"""Parse a string looking for userame@server"""
+"""Parse a string looking for userame@server"""
-	import re
+myRE = re.compile(
-	myRE = re.compile(
+r'((?P<protocol>[^:]+)://)?'#You can supply a protocol if you like
-		r'((?P<proto>[^:]+)://)?'#You can supply a protocol if you like
+r'('                        #The username part is optional
-		r'('					#The username part is optional
+r'(?P<username>[^:]+)'     #You can supply the password as
-		 r'(?P<user>[^:]+)'		#You can supply the password as
+r'(:(?P<password>.+))?'    #username:password@server
-		 r'(:(?P<pass>.+))?'	#username:password@server
+r'@)?'
-		r'@)?'
+r'(?P<server>[^/]+)'
-		r'(?P<server>[^/]+)'
+r'(/(?P<mailbox>.+))?$'
-		r'(/(?P<mailbox>.+))?$'
+)
-	)
+m = myRE.match(s)
-	m = myRE.match(s)
+if m:
-	if m:
+return m.groupdict()
-		return {'username':m.group('user'), 'password':m.group('pass')
+else:
-			, 'server':m.group('server'), 'protocol':m.group('proto')
+return None
-			, 'mailbox':m.group('mailbox')
-			}
 def main():
-	"""This is what is called if run at the prompt"""
+"""This is what is called if run at the prompt"""
-	import optparse, os
+parser = optparse.OptionParser(
-	parser = optparse.OptionParser(
+version=('%prog ' + version),
-		version=('%prog ' + version)
+usage="""usage: %prog [options] (home server)...
-		, usage="""usage: %prog [options] (home server)...
-So each entry has a home, and then the server configuration. home is just a path to the
+So each entry has a home, and then the server configuration. Home is just
-roundup issue tracker. The server is something of the form:
+a path to the roundup issue tracker. The server is something of the form:
-	imaps://user:password@server/mailbox
-If you don't supply the protocol, imaps is assumed. Without user or password, you will be
+imaps://user:password@server/mailbox
-prompted for them. The server must be supplied. Without mailbox the INBOX is used.
+If you don't supply the protocol, imaps is assumed. Without user or
+password, you will be prompted for them. The server must be supplied.
+Without mailbox the INBOX is used.
 Examples:
 %prog /home/roundup/trackers/test imaps://test@imap.example.com/test
-%prog /home/roundup/trackers/test imap.example.com /home/roundup/trackers/test2 imap.example.com/test2
+%prog /home/roundup/trackers/test imap.example.com \
+/home/roundup/trackers/test2 imap.example.com/test2
 """
-	)
+)
-	parser.add_option('-d', '--delay', dest='delay', type='float', metavar='<sec>'
+parser.add_option('-d', '--delay', dest='delay', type='float',
-		, default=5
+metavar='<sec>', default=5,
-		, help="Set the delay between checks in minutes. (default 5)"
+help="Set the delay between checks in minutes. (default 5)"
-	)
+)
-	parser.add_option('-p', '--pid-file', dest='pidfile', metavar='<file>'
+parser.add_option('-p', '--pid-file', dest='pidfile',
-		, default=None
+metavar='<file>', default=None,
-		, help="The pid of the server process will be written to <file>"
+help="The pid of the server process will be written to <file>"
-	)
+)
-	parser.add_option('-n', '--no-daemon', dest='daemon', action='store_false'
+parser.add_option('-n', '--no-daemon', dest='daemon',
-		, default=True
+action='store_false', default=True,
-		, help="Do not fork into the background after running the first check."
+help="Do not fork into the background after running the first check."
-	)
+)
-	parser.add_option('-v', '--verbose', dest='verbose', action='store_const'
+parser.add_option('-v', '--verbose', dest='verbose',
-		, const=logging.INFO
+action='store_const', const=logging.INFO,
-		, help="Be more verbose in letting you know what is going on."
+help="Be more verbose in letting you know what is going on."
-		" Enables informational messages."
+" Enables informational messages."
-	)
+)
-	parser.add_option('-V', '--very-verbose', dest='verbose', action='store_const'
+parser.add_option('-V', '--very-verbose', dest='verbose',
-		, const=logging.DEBUG
+action='store_const', const=logging.DEBUG,
-		, help="Be very verbose in letting you know what is going on."
+help="Be very verbose in letting you know what is going on."
-		" Enables debugging messages."
+" Enables debugging messages."
-	)
+)
-	parser.add_option('-q', '--quiet', dest='verbose', action='store_const'
+parser.add_option('-q', '--quiet', dest='verbose',
-		, const=logging.ERROR
+action='store_const', const=logging.ERROR,
-		, help="Be less verbose. Ignores warnings, only prints errors."
+help="Be less verbose. Ignores warnings, only prints errors."
-	)
+)
-	parser.add_option('-Q', '--very-quiet', dest='verbose', action='store_const'
+parser.add_option('-Q', '--very-quiet', dest='verbose',
-		, const=logging.CRITICAL
+action='store_const', const=logging.CRITICAL,
-		, help="Be much less verbose. Ignores warnings and errors."
+help="Be much less verbose. Ignores warnings and errors."
-		" Only print CRITICAL messages."
+" Only print CRITICAL messages."
-	)
+)
-	(opts, args) = parser.parse_args()
+(opts, args) = parser.parse_args()
-	if (len(args) == 0) or (len(args) % 2 == 1):
+if (len(args) == 0) or (len(args) % 2 == 1):
-		parser.error('Invalid number of arguments. Each site needs a home and a server.')
+parser.error('Invalid number of arguments. '
+'Each site needs a home and a server.')
-	log.setLevel(opts.verbose)
-	myServer = IMAPServer(delay=opts.delay, pidfile=opts.pidfile, daemon=opts.daemon)
+log.setLevel(opts.verbose)
-	for i in range(0,len(args),2):
+myServer = IMAPServer(delay=opts.delay, pidfile=opts.pidfile,
-		home = args[i]
+daemon=opts.daemon)
-		server = args[i+1]
+for i in range(0,len(args),2):
-		if not os.path.exists(home):
+home = args[i]
-			parser.error('Home: "%s" does not exist' % home)
+server = args[i+1]
+if not os.path.exists(home):
-		info = getItems(server)
+parser.error('Home: "%s" does not exist' % home)
-		if not info:
-			parser.error('Invalid server string: "%s"' % server)
+info = getItems(server)
+if not info:
-		myServer.addMailbox(
+parser.error('Invalid server string: "%s"' % server)
-			RoundupMailbox(dbhome=home, mailbox=info['mailbox']
-			, username=info['username'], password=info['password']
+myServer.addMailbox(
-			, server=info['server'], protocol=info['protocol']
+RoundupMailbox(dbhome=home, mailbox=info['mailbox']
-			)
+, username=info['username'], password=info['password']
-		)
+, server=info['server'], protocol=info['protocol']
+)
-	if myServer.checkBoxes():
+)
-		myServer.run()
+if myServer.checkBoxes():
+myServer.run()
 if __name__ == '__main__':
-	main()
+main()
+# vim: et ft=python si sts=4 sw=4

Mercurial > p > roundup > code

comparison scripts/imapServer.py @ 3203:eddcfee2cc19