annotate scripts/imapServer.py @ 5378:35ea9b1efc14

Python 3 preparation: "raise" syntax. Changing "raise Exception, value" to "raise Exception(value)". Tool-assisted patch. Particular cases to check carefully are the one place in frontends/ZRoundup/ZRoundup.py where a string exception needed to be fixed, and the one in roundup/cgi/client.py involving raising an exception with a traceback (requires three-argument form of raise in Python 2, which as I understand it requires exec() to avoid a Python 3 syntax error).
author Joseph Myers <jsm@polyomino.org.uk>
date Tue, 24 Jul 2018 21:39:58 +0000
parents 64b05e24dbd8
children 0942fe89e82e
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
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5141
diff changeset
33 from __future__ import print_function
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
34 import getpass
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 import logging
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
36 import imaplib
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
37 import optparse
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
38 import os
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
39 import re
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
40 import time
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
41
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 logging.basicConfig()
4421
67bef70ab9b9 - more logger fixes, sorry for the noise.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3609
diff changeset
43 log = logging.getLogger('roundup.IMAPServer')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 version = '0.1.2'
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 class RoundupMailbox:
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
48 """This contains all the info about each mailbox.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
49 Username, Password, server, security, roundup database
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
50 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
51 def __init__(self, dbhome='', username=None, password=None, mailbox=None
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
52 , server=None, protocol='imaps'):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
53 self.username = username
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
54 self.password = password
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
55 self.mailbox = mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
56 self.server = server
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
57 self.protocol = protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
58 self.dbhome = dbhome
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
59
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
60 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
61 if not self.dbhome:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
62 self.dbhome = raw_input('Tracker home: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
63 if not os.path.exists(self.dbhome):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
64 raise ValueError('Invalid home address: ' \
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
65 '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
66
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
67 if not self.server:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
68 self.server = raw_input('Server: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
69 if not self.server:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
70 raise ValueError('No Servername supplied')
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
71 protocol = raw_input('protocol [imaps]? ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
72 self.protocol = protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
73
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
74 if not self.username:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
75 self.username = raw_input('Username: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
76 if not self.username:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
77 raise ValueError('Invalid Username')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
79 if not self.password:
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5141
diff changeset
80 print('For server %s, user %s' % (self.server, self.username))
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
81 self.password = getpass.getpass()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
82 # password can be empty because it could be superceeded
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
83 # by a later entry
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
85 #if self.mailbox is None:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
86 # self.mailbox = raw_input('Mailbox [INBOX]: ')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
87 # # We allow an empty mailbox because that will
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
88 # # 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
89
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
90 except (KeyboardInterrupt, EOFError):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
91 raise ValueError('Canceled by User')
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
92
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
93 def __str__(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
94 return 'Mailbox{ server:%(server)s, protocol:%(protocol)s, ' \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
95 'username:%(username)s, mailbox:%(mailbox)s, ' \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
96 'dbhome:%(dbhome)s }' % self.__dict__
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
99 # [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
100 class IMAPServer:
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
101
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
102 """IMAP mail gatherer.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
104 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
105 mailboxes to connect to, along with the roundup database directories
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
106 that correspond with each email address. It then connects to each
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
107 mailbox at a specified interval, and if there are new messages it
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
108 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
109
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
110 *TODO*:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
111 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
112 connect once, and access multiple mailboxes and possibly multiple
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
113 usernames.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
115 *NOTE*:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
116 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
117 server, you are using the same password. (the last one supplied is
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
118 used.) Empty passwords are ignored. Only the last protocol
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
119 supplied is used.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
120 """
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
122 def __init__(self, pidfile=None, delay=5, daemon=False):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
123 #This is sorted by servername, then username, then mailboxes
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
124 self.mailboxes = {}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
125 self.delay = float(delay)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
126 self.pidfile = pidfile
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
127 self.daemon = daemon
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
129 def setDelay(self, delay):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
130 self.delay = delay
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
131
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
132 def addMailbox(self, mailbox):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
133 """ The linkage is as follows:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
134 servers -- users - mailbox:dbhome
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
135 So there can be multiple servers, each with multiple users.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
136 Each username can be associated with multiple mailboxes.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
137 each mailbox is associated with 1 database home
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
138 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
139 log.info('Adding mailbox %s', mailbox)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
140 if not self.mailboxes.has_key(mailbox.server):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
141 self.mailboxes[mailbox.server] = {'protocol':'imaps', 'users':{}}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
142 server = self.mailboxes[mailbox.server]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
143 if mailbox.protocol:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
144 server['protocol'] = mailbox.protocol
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
146 if not server['users'].has_key(mailbox.username):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
147 server['users'][mailbox.username] = {'password':'', 'mailboxes':{}}
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
148 user = server['users'][mailbox.username]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
149 if mailbox.password:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
150 user['password'] = mailbox.password
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
152 if user['mailboxes'].has_key(mailbox.mailbox):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
153 raise ValueError('Mailbox is already defined')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
155 user['mailboxes'][mailbox.mailbox] = mailbox.dbhome
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
156
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
157 def _process(self, message, dbhome):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
158 """Actually process one of the email messages"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
159 child = os.popen('roundup-mailgw %s' % dbhome, 'wb')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
160 child.write(message)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
161 child.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
162 #print message
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
164 def _getMessages(self, serv, count, dbhome):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
165 """This assumes that you currently have a mailbox open, and want to
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
166 process all messages that are inside.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
167 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
168 for n in range(1, count+1):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
169 (t, data) = serv.fetch(n, '(RFC822)')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
170 if t == 'OK':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
171 self._process(data[0][1], dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
172 serv.store(n, '+FLAGS', r'(\Deleted)')
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
173
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
174 def checkBoxes(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
175 """This actually goes out and does all the checking.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
176 Returns False if there were any errors, otherwise returns true.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
177 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
178 noErrors = True
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
179 for server in self.mailboxes:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
180 log.info('Connecting to server: %s', server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
181 s_vals = self.mailboxes[server]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
182
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
183 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
184 for user in s_vals['users']:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
185 u_vals = s_vals['users'][user]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
186 # TODO: As near as I can tell, you can only
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
187 # login with 1 username for each connection to a server.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
188 protocol = s_vals['protocol'].lower()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
189 if protocol == 'imaps':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
190 serv = imaplib.IMAP4_SSL(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
191 elif protocol == 'imap':
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
192 serv = imaplib.IMAP4(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
193 else:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
194 raise ValueError('Unknown protocol %s' % protocol)
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
195
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
196 password = u_vals['password']
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
197
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
198 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
199 log.info('Connecting as user: %s', user)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
200 serv.login(user, password)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
201
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
202 for mbox in u_vals['mailboxes']:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
203 dbhome = u_vals['mailboxes'][mbox]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
204 log.info('Using mailbox: %s, home: %s',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
205 mbox, dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
206 #access a specific mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
207 if mbox:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
208 (t, data) = serv.select(mbox)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
209 else:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
210 # Select the default mailbox (INBOX)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
211 (t, data) = serv.select()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
212 try:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
213 nMessages = int(data[0])
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
214 except ValueError:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
215 nMessages = 0
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
216
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
217 log.info('Found %s messages', nMessages)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
218
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
219 if nMessages:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
220 self._getMessages(serv, nMessages, dbhome)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
221 serv.expunge()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
222
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
223 # We are done with this mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
224 serv.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
225 except:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
226 log.exception('Exception with server %s user %s',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
227 server, user)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
228 noErrors = False
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
229
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
230 serv.logout()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
231 serv.shutdown()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
232 del serv
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
233 except:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
234 log.exception('Exception while connecting to %s', server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
235 noErrors = False
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
236 return noErrors
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
237
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
238
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
239 def makeDaemon(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
240 """Turn this process into a daemon.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
241
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
242 - make our parent PID 1
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
243
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
244 Write our new PID to the pidfile.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
245
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
246 From A.M. Kuuchling (possibly originally Greg Ward) with
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
247 modification from Oren Tirosh, and finally a small mod from me.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
248 Originally taken from roundup.scripts.roundup_server.py
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
249 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
250 log.info('Running as Daemon')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
251 # Fork once
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
252 if os.fork() != 0:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
253 os._exit(0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
254
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
255 # Create new session
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
256 os.setsid()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
257
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
258 # Second fork to force PPID=1
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
259 pid = os.fork()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
260 if pid:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
261 if self.pidfile:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
262 pidfile = open(self.pidfile, 'w')
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
263 pidfile.write(str(pid))
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
264 pidfile.close()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
265 os._exit(0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
266
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
267 def run(self):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
268 """Run email gathering daemon.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
269
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
270 This spawns itself as a daemon, and then runs continually, just
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
271 sleeping inbetween checks. It is recommended that you run
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
272 checkBoxes once first before you select run. That way you can
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
273 know if there were any failures.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
274 """
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
275 if self.daemon:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
276 self.makeDaemon()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
277 while True:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
278
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
279 time.sleep(self.delay * 60.0)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
280 log.info('Time: %s', time.strftime('%Y-%m-%d %H:%M:%S'))
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
281 self.checkBoxes()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
282
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
283 def getItems(s):
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
284 """Parse a string looking for userame@server"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
285 myRE = re.compile(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
286 r'((?P<protocol>[^:]+)://)?'#You can supply a protocol if you like
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
287 r'(' #The username part is optional
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
288 r'(?P<username>[^:]+)' #You can supply the password as
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
289 r'(:(?P<password>.+))?' #username:password@server
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
290 r'@)?'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
291 r'(?P<server>[^/]+)'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
292 r'(/(?P<mailbox>.+))?$'
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
293 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
294 m = myRE.match(s)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
295 if m:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
296 return m.groupdict()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
297 else:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
298 return None
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
299
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
300 def main():
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
301 """This is what is called if run at the prompt"""
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
302 parser = optparse.OptionParser(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
303 version=('%prog ' + version),
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
304 usage="""usage: %prog [options] (home server)...
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
305
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
306 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
307 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
308
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
309 imaps://user:password@server/mailbox
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
310
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
311 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
312 password, you will be prompted for them. The server must be supplied.
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
313 Without mailbox the INBOX is used.
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
314
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
315 Examples:
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
316 %prog /home/roundup/trackers/test imaps://test@imap.example.com/test
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
317 %prog /home/roundup/trackers/test imap.example.com \
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
318 /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
319 """
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
320 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
321 parser.add_option('-d', '--delay', dest='delay', type='float',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
322 metavar='<sec>', default=5,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
323 help="Set the delay between checks in minutes. (default 5)"
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
324 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
325 parser.add_option('-p', '--pid-file', dest='pidfile',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
326 metavar='<file>', default=None,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
327 help="The pid of the server process will be written to <file>"
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
328 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
329 parser.add_option('-n', '--no-daemon', dest='daemon',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
330 action='store_false', default=True,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
331 help="Do not fork into the background after running the first check."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
332 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
333 parser.add_option('-v', '--verbose', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
334 action='store_const', const=logging.INFO,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
335 help="Be more verbose in letting you know what is going on."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
336 " Enables informational messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
337 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
338 parser.add_option('-V', '--very-verbose', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
339 action='store_const', const=logging.DEBUG,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
340 help="Be very verbose in letting you know what is going on."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
341 " Enables debugging messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
342 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
343 parser.add_option('-q', '--quiet', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
344 action='store_const', const=logging.ERROR,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
345 help="Be less verbose. Ignores warnings, only prints errors."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
346 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
347 parser.add_option('-Q', '--very-quiet', dest='verbose',
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
348 action='store_const', const=logging.CRITICAL,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
349 help="Be much less verbose. Ignores warnings and errors."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
350 " Only print CRITICAL messages."
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
351 )
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
352
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
353 (opts, args) = parser.parse_args()
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
354 if (len(args) == 0) or (len(args) % 2 == 1):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
355 parser.error('Invalid number of arguments. '
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
356 '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
357
5141
939dce88cfc2 issue2550776: fix missing intialization
John Rouillard <rouilj@ieee.org>
parents: 4421
diff changeset
358 if opts.verbose == None:
939dce88cfc2 issue2550776: fix missing intialization
John Rouillard <rouilj@ieee.org>
parents: 4421
diff changeset
359 opts.verbose = logging.WARNING
939dce88cfc2 issue2550776: fix missing intialization
John Rouillard <rouilj@ieee.org>
parents: 4421
diff changeset
360
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
361 log.setLevel(opts.verbose)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
362 myServer = IMAPServer(delay=opts.delay, pidfile=opts.pidfile,
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
363 daemon=opts.daemon)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
364 for i in range(0,len(args),2):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
365 home = args[i]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
366 server = args[i+1]
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
367 if not os.path.exists(home):
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
368 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
369
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
370 info = getItems(server)
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
371 if not info:
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
372 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
373
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
374 myServer.addMailbox(
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
375 RoundupMailbox(dbhome=home, mailbox=info['mailbox']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
376 , username=info['username'], password=info['password']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
377 , server=info['server'], protocol=info['protocol']
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
378 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
379 )
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
380
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
381 if myServer.checkBoxes():
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
382 myServer.run()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
383
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
384 if __name__ == '__main__':
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
385 main()
3176
18ad9d702a5b added "imapServer.py" script (patch [SF#934567])
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
386
3203
eddcfee2cc19 reformat
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3176
diff changeset
387 # vim: et ft=python si sts=4 sw=4

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