annotate scripts/imapServer.py @ 4531:ddff9669361b

Fix matching of incoming email addresses to the alternate_addresses field... ...of a user -- this would match substrings, e.g. if the user has discuss-support@example.com as an alternate email and an incoming mail is addressed to support@example.com this would (wrongly) match. Note: I *think* I've seen this discussed somewhere but couldn't find it, neither in the tracker nor in recent discussions on the mailinglists. So if someone remembers an issue which now should be closed, please tell me :-)
author Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
date Wed, 24 Aug 2011 14:43:52 +0000
parents 67bef70ab9b9
children 939dce88cfc2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
1 #!/usr/bin/env python
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 """\
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 This script is a wrapper around the mailgw.py script that exists in roundup.
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 It runs as service instead of running as a one-time shot.
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 It also connects to a secure IMAP server. The main reasons for this script are:
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
7 1) The roundup-mailgw script isn't designed to run as a server. It
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
8 expects that you either run it by hand, and enter the password each
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
9 time, or you supply the password on the command line. I prefer to
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
10 run a server that I initialize with the password, and then it just
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
11 runs. I don't want to have to pass it on the command line, so
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
12 running through crontab isn't a possibility. (This wouldn't be a
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
13 problem on a local machine running through a mailspool.)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
14 2) mailgw.py somehow screws up SSL support so IMAP4_SSL doesn't work. So
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
15 hopefully running that work outside of the mailgw will allow it to work.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
16 3) I wanted to be able to check multiple projects at the same time.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
17 roundup-mailgw is only for 1 mailbox and 1 project.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 *TODO*:
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
21 For the first round, the program spawns a new roundup-mailgw for
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
22 each imap message that it finds and pipes the result in. In the
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
23 future it might be more practical to actually include the roundup
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
24 files and run the appropriate commands using python.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 *TODO*:
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 Look into supporting a logfile instead of using 2>/logfile
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 *TODO*:
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 Add an option for changing the uid/gid of the running process.
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 """
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
33 import getpass
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 import logging
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
35 import imaplib
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
36 import optparse
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
37 import os
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
38 import re
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
39 import time
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
40
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 logging.basicConfig()
4421
67bef70ab9b9 - more logger fixes, sorry for the noise.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3609
diff changeset
42 log = logging.getLogger('roundup.IMAPServer')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 version = '0.1.2'
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 class RoundupMailbox:
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
47 """This contains all the info about each mailbox.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
48 Username, Password, server, security, roundup database
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
49 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
50 def __init__(self, dbhome='', username=None, password=None, mailbox=None
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
51 , server=None, protocol='imaps'):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
52 self.username = username
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
53 self.password = password
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
54 self.mailbox = mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
55 self.server = server
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
56 self.protocol = protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
57 self.dbhome = dbhome
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
58
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
59 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
60 if not self.dbhome:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
61 self.dbhome = raw_input('Tracker home: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
62 if not os.path.exists(self.dbhome):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
63 raise ValueError, 'Invalid home address: ' \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
64 'directory "%s" does not exist.' % self.dbhome
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
66 if not self.server:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
67 self.server = raw_input('Server: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
68 if not self.server:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
69 raise ValueError, 'No Servername supplied'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
70 protocol = raw_input('protocol [imaps]? ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
71 self.protocol = protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
72
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
73 if not self.username:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
74 self.username = raw_input('Username: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
75 if not self.username:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
76 raise ValueError, 'Invalid Username'
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
78 if not self.password:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
79 print 'For server %s, user %s' % (self.server, self.username)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
80 self.password = getpass.getpass()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
81 # password can be empty because it could be superceeded
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
82 # by a later entry
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
84 #if self.mailbox is None:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
85 # self.mailbox = raw_input('Mailbox [INBOX]: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
86 # # We allow an empty mailbox because that will
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
87 # # select the INBOX, whatever it is called
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
89 except (KeyboardInterrupt, EOFError):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
90 raise ValueError, 'Canceled by User'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
91
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
92 def __str__(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
93 return 'Mailbox{ server:%(server)s, protocol:%(protocol)s, ' \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
94 'username:%(username)s, mailbox:%(mailbox)s, ' \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
95 'dbhome:%(dbhome)s }' % self.__dict__
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
98 # [als] class name is misleading. this is imap client, not imap server
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 class IMAPServer:
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
100
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
101 """IMAP mail gatherer.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
103 This class runs as a server process. It is configured with a list of
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
104 mailboxes to connect to, along with the roundup database directories
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
105 that correspond with each email address. It then connects to each
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
106 mailbox at a specified interval, and if there are new messages it
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
107 reads them, and sends the result to the roundup.mailgw.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
109 *TODO*:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
110 Try to be smart about how you access the mailboxes so that you can
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
111 connect once, and access multiple mailboxes and possibly multiple
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
112 usernames.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
114 *NOTE*:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
115 This assumes that if you are using the same user on the same
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
116 server, you are using the same password. (the last one supplied is
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
117 used.) Empty passwords are ignored. Only the last protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
118 supplied is used.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
119 """
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
121 def __init__(self, pidfile=None, delay=5, daemon=False):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
122 #This is sorted by servername, then username, then mailboxes
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
123 self.mailboxes = {}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
124 self.delay = float(delay)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
125 self.pidfile = pidfile
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
126 self.daemon = daemon
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
127
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
128 def setDelay(self, delay):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
129 self.delay = delay
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
130
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
131 def addMailbox(self, mailbox):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
132 """ The linkage is as follows:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
133 servers -- users - mailbox:dbhome
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
134 So there can be multiple servers, each with multiple users.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
135 Each username can be associated with multiple mailboxes.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
136 each mailbox is associated with 1 database home
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
137 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
138 log.info('Adding mailbox %s', mailbox)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
139 if not self.mailboxes.has_key(mailbox.server):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
140 self.mailboxes[mailbox.server] = {'protocol':'imaps', 'users':{}}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
141 server = self.mailboxes[mailbox.server]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
142 if mailbox.protocol:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
143 server['protocol'] = mailbox.protocol
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
145 if not server['users'].has_key(mailbox.username):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
146 server['users'][mailbox.username] = {'password':'', 'mailboxes':{}}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
147 user = server['users'][mailbox.username]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
148 if mailbox.password:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
149 user['password'] = mailbox.password
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
151 if user['mailboxes'].has_key(mailbox.mailbox):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
152 raise ValueError, 'Mailbox is already defined'
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
153
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
154 user['mailboxes'][mailbox.mailbox] = mailbox.dbhome
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
155
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
156 def _process(self, message, dbhome):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
157 """Actually process one of the email messages"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
158 child = os.popen('roundup-mailgw %s' % dbhome, 'wb')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
159 child.write(message)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
160 child.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
161 #print message
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
163 def _getMessages(self, serv, count, dbhome):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
164 """This assumes that you currently have a mailbox open, and want to
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
165 process all messages that are inside.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
166 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
167 for n in range(1, count+1):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
168 (t, data) = serv.fetch(n, '(RFC822)')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
169 if t == 'OK':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
170 self._process(data[0][1], dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
171 serv.store(n, '+FLAGS', r'(\Deleted)')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
172
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
173 def checkBoxes(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
174 """This actually goes out and does all the checking.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
175 Returns False if there were any errors, otherwise returns true.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
176 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
177 noErrors = True
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
178 for server in self.mailboxes:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
179 log.info('Connecting to server: %s', server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
180 s_vals = self.mailboxes[server]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
181
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
182 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
183 for user in s_vals['users']:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
184 u_vals = s_vals['users'][user]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
185 # TODO: As near as I can tell, you can only
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
186 # login with 1 username for each connection to a server.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
187 protocol = s_vals['protocol'].lower()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
188 if protocol == 'imaps':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
189 serv = imaplib.IMAP4_SSL(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
190 elif protocol == 'imap':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
191 serv = imaplib.IMAP4(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
192 else:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
193 raise ValueError, 'Unknown protocol %s' % protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
194
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
195 password = u_vals['password']
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
197 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
198 log.info('Connecting as user: %s', user)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
199 serv.login(user, password)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
200
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
201 for mbox in u_vals['mailboxes']:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
202 dbhome = u_vals['mailboxes'][mbox]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
203 log.info('Using mailbox: %s, home: %s',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
204 mbox, dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
205 #access a specific mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
206 if mbox:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
207 (t, data) = serv.select(mbox)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
208 else:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
209 # Select the default mailbox (INBOX)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
210 (t, data) = serv.select()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
211 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
212 nMessages = int(data[0])
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
213 except ValueError:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
214 nMessages = 0
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
215
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
216 log.info('Found %s messages', nMessages)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
217
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
218 if nMessages:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
219 self._getMessages(serv, nMessages, dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
220 serv.expunge()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
221
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
222 # We are done with this mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
223 serv.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
224 except:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
225 log.exception('Exception with server %s user %s',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
226 server, user)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
227 noErrors = False
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
228
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
229 serv.logout()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
230 serv.shutdown()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
231 del serv
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
232 except:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
233 log.exception('Exception while connecting to %s', server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
234 noErrors = False
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
235 return noErrors
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
236
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
237
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
238 def makeDaemon(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
239 """Turn this process into a daemon.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
240
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
241 - make our parent PID 1
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
242
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
243 Write our new PID to the pidfile.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
244
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
245 From A.M. Kuuchling (possibly originally Greg Ward) with
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
246 modification from Oren Tirosh, and finally a small mod from me.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
247 Originally taken from roundup.scripts.roundup_server.py
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
248 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
249 log.info('Running as Daemon')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
250 # Fork once
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
251 if os.fork() != 0:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
252 os._exit(0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
253
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
254 # Create new session
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
255 os.setsid()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
256
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
257 # Second fork to force PPID=1
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
258 pid = os.fork()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
259 if pid:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
260 if self.pidfile:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
261 pidfile = open(self.pidfile, 'w')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
262 pidfile.write(str(pid))
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
263 pidfile.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
264 os._exit(0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
265
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
266 def run(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
267 """Run email gathering daemon.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
268
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
269 This spawns itself as a daemon, and then runs continually, just
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
270 sleeping inbetween checks. It is recommended that you run
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
271 checkBoxes once first before you select run. That way you can
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
272 know if there were any failures.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
273 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
274 if self.daemon:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
275 self.makeDaemon()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
276 while True:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
277
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
278 time.sleep(self.delay * 60.0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
279 log.info('Time: %s', time.strftime('%Y-%m-%d %H:%M:%S'))
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
280 self.checkBoxes()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
281
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
282 def getItems(s):
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
283 """Parse a string looking for userame@server"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
284 myRE = re.compile(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
285 r'((?P<protocol>[^:]+)://)?'#You can supply a protocol if you like
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
286 r'(' #The username part is optional
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
287 r'(?P<username>[^:]+)' #You can supply the password as
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
288 r'(:(?P<password>.+))?' #username:password@server
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
289 r'@)?'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
290 r'(?P<server>[^/]+)'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
291 r'(/(?P<mailbox>.+))?$'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
292 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
293 m = myRE.match(s)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
294 if m:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
295 return m.groupdict()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
296 else:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
297 return None
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
298
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
299 def main():
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
300 """This is what is called if run at the prompt"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
301 parser = optparse.OptionParser(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
302 version=('%prog ' + version),
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
303 usage="""usage: %prog [options] (home server)...
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
304
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
305 So each entry has a home, and then the server configuration. Home is just
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
306 a path to the roundup issue tracker. The server is something of the form:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
307
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
308 imaps://user:password@server/mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
309
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
310 If you don't supply the protocol, imaps is assumed. Without user or
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
311 password, you will be prompted for them. The server must be supplied.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
312 Without mailbox the INBOX is used.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
313
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
314 Examples:
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
315 %prog /home/roundup/trackers/test imaps://test@imap.example.com/test
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
316 %prog /home/roundup/trackers/test imap.example.com \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
317 /home/roundup/trackers/test2 imap.example.com/test2
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
318 """
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
319 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
320 parser.add_option('-d', '--delay', dest='delay', type='float',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
321 metavar='<sec>', default=5,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
322 help="Set the delay between checks in minutes. (default 5)"
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
323 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
324 parser.add_option('-p', '--pid-file', dest='pidfile',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
325 metavar='<file>', default=None,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
326 help="The pid of the server process will be written to <file>"
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
327 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
328 parser.add_option('-n', '--no-daemon', dest='daemon',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
329 action='store_false', default=True,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
330 help="Do not fork into the background after running the first check."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
331 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
332 parser.add_option('-v', '--verbose', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
333 action='store_const', const=logging.INFO,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
334 help="Be more verbose in letting you know what is going on."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
335 " Enables informational messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
336 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
337 parser.add_option('-V', '--very-verbose', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
338 action='store_const', const=logging.DEBUG,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
339 help="Be very verbose in letting you know what is going on."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
340 " Enables debugging messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
341 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
342 parser.add_option('-q', '--quiet', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
343 action='store_const', const=logging.ERROR,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
344 help="Be less verbose. Ignores warnings, only prints errors."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
345 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
346 parser.add_option('-Q', '--very-quiet', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
347 action='store_const', const=logging.CRITICAL,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
348 help="Be much less verbose. Ignores warnings and errors."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
349 " Only print CRITICAL messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
350 )
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
351
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
352 (opts, args) = parser.parse_args()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
353 if (len(args) == 0) or (len(args) % 2 == 1):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
354 parser.error('Invalid number of arguments. '
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
355 'Each site needs a home and a server.')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
356
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
357 log.setLevel(opts.verbose)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
358 myServer = IMAPServer(delay=opts.delay, pidfile=opts.pidfile,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
359 daemon=opts.daemon)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
360 for i in range(0,len(args),2):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
361 home = args[i]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
362 server = args[i+1]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
363 if not os.path.exists(home):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
364 parser.error('Home: "%s" does not exist' % home)
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
365
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
366 info = getItems(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
367 if not info:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
368 parser.error('Invalid server string: "%s"' % server)
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
369
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
370 myServer.addMailbox(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
371 RoundupMailbox(dbhome=home, mailbox=info['mailbox']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
372 , username=info['username'], password=info['password']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
373 , server=info['server'], protocol=info['protocol']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
374 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
375 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
376
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
377 if myServer.checkBoxes():
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
378 myServer.run()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
379
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
380 if __name__ == '__main__':
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
381 main()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
382
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
383 # vim: et ft=python si sts=4 sw=4

Roundup Issue Tracker: http://roundup-tracker.org/