Commit | Line | Data |
---|---|---|
67e2ec02 PD |
1 | ''' |
2 | restore-mail-inject.py - Tool to inject mails via IMAP | |
3 | ||
4 | Copyright (c) 2012 Intra2net AG | |
20760d94 PD |
5 | Author: Plamen Dimitrov and Thomas Jarosch |
6 | ||
7 | This program is free software: you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation, either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
67e2ec02 PD |
16 | ''' |
17 | ||
5737b10e | 18 | import os |
67e2ec02 | 19 | import re |
f797b0fd | 20 | import logging |
67e2ec02 PD |
21 | |
22 | MAIL_FILENAME = re.compile("^[0-9]+\.$") | |
e42bd6a5 PD |
23 | MBOXFILE_LINE = re.compile("^(.*?)\t(?:\d )?default[\t ](.*)$") |
24 | ACL_STRING = re.compile("^(.*?)[\t ](.*?)\t(.*)$") | |
67e2ec02 PD |
25 | |
26 | class FileIterator: | |
27 | """This class iterates through the e-mail files.""" | |
28 | ||
29 | # class attributes | |
67e2ec02 PD |
30 | # mailboxes created during file traversal |
31 | created_mailboxes = None | |
32 | # mailboxes to update during file traversal | |
33 | acl_mailboxes = None | |
ed8dc19f PD |
34 | # acls retrieved from a file |
35 | file_acls = None | |
67e2ec02 | 36 | |
e42bd6a5 | 37 | def __init__(self): |
67e2ec02 | 38 | """Creates a connection and a user session.""" |
0cf4dc33 | 39 | |
e42bd6a5 PD |
40 | self.created_mailboxes = [] |
41 | self.acl_mailboxes = [] | |
ed8dc19f | 42 | self.file_acls = {} |
67e2ec02 | 43 | |
38f15e57 PD |
44 | @classmethod |
45 | def _message_read(cls, filename): | |
67e2ec02 | 46 | """Retrieves a message from the message file.""" |
0cf4dc33 | 47 | |
67e2ec02 PD |
48 | try: |
49 | with open(filename, "r") as msgfile: | |
50 | message = msgfile.read() | |
f797b0fd PD |
51 | except IOError: |
52 | logging.warning("Could not open the e-mail file %s", filename) | |
53 | raise | |
0cf4dc33 | 54 | |
67e2ec02 PD |
55 | return message |
56 | ||
ed8dc19f | 57 | def load_mailbox_list(self, mboxlistfile, original_user): |
0cf4dc33 PD |
58 | """Load the list of mailboxes and acl rights for each from file.""" |
59 | ||
ed8dc19f PD |
60 | try: |
61 | with open(mboxlistfile, 'r') as acl_file: | |
62 | for line in acl_file: | |
63 | ||
64 | # read a line using regex | |
65 | acls = {} | |
66 | try: | |
67 | linedata = MBOXFILE_LINE.match(line).groups() | |
68 | except AttributeError: | |
69 | logging.warning("Illegal line in mailbox list dump: %s", line) | |
70 | continue | |
71 | aclstr = linedata[1] | |
72 | ||
73 | # changes acls key encoding to internal cyrus format and makes it absolute (as folder). | |
74 | key = linedata[0].replace("INBOX/", "user/" + original_user + "/") | |
75 | key = key.replace(".", "^") | |
76 | key = key.replace("/", ".") | |
77 | ||
78 | # loop through acl rights string and build dictionary of users and rights | |
79 | while(aclstr != ""): | |
79c28101 | 80 | try: |
ed8dc19f | 81 | acldata = ACL_STRING.match(aclstr).groups() |
79c28101 | 82 | except AttributeError: |
ed8dc19f PD |
83 | logging.warning("Illegal acl string in mailbox list dump: %s", line) |
84 | aclstr = "" | |
f797b0fd | 85 | continue |
ed8dc19f PD |
86 | aclstr = acldata[2] |
87 | acls[acldata[0]] = acldata[1] | |
88 | ||
89 | self.acl_mailboxes[key] = acls | |
90 | except IOError: | |
91 | logging.warning("Could not open mboxlist file %s", mboxlistfile) | |
e42bd6a5 | 92 | |
67e2ec02 PD |
93 | def load_mails(self, filepath, mailpath): |
94 | """Loads all e-mails from file hierarchy. | |
95 | This recursive generator always returns a tuple of | |
96 | the next found (e-mail, mailbox to store, internaldate).""" | |
0cf4dc33 | 97 | |
38f15e57 | 98 | logging.debug("Entered directory %s -> %s", filepath, mailpath) |
67e2ec02 PD |
99 | try: |
100 | filepath = os.path.abspath(filepath) | |
101 | os.chdir(filepath) | |
102 | except OSError: | |
38f15e57 | 103 | logging.warning("Can't open the directory %s", filepath) |
67e2ec02 PD |
104 | return |
105 | # mark mailboxes that should be created | |
106 | self.created_mailboxes.append(mailpath) | |
20760d94 | 107 | |
67e2ec02 PD |
108 | subpaths = os.listdir(filepath) |
109 | for subpath in subpaths: | |
e42bd6a5 | 110 | if subpath == "." or subpath == "..": |
67e2ec02 PD |
111 | continue |
112 | new_filepath = filepath + "/" + subpath | |
20760d94 PD |
113 | |
114 | # if path is file validate name and inject | |
67e2ec02 | 115 | if (os.path.isfile(new_filepath)): |
e42bd6a5 | 116 | if os.path.getsize(new_filepath) == 0: |
38f15e57 | 117 | logging.info("Skipping empty file %s", subpath) |
67e2ec02 | 118 | else: |
e42bd6a5 | 119 | if MAIL_FILENAME.match(subpath): |
38f15e57 | 120 | logging.info("Injecting file %s", subpath) |
67e2ec02 PD |
121 | try: |
122 | message = self._message_read(new_filepath) | |
123 | # suggest file modification date for internaldate | |
124 | yield (message, mailpath, os.path.getmtime(new_filepath)) | |
f797b0fd | 125 | except IOError: |
38f15e57 | 126 | logging.warning("Could not retrieve mail from the file %s", new_filepath) |
67e2ec02 | 127 | else: |
20760d94 PD |
128 | |
129 | # if path is directory do recursive call | |
e42bd6a5 | 130 | if os.path.isdir(new_filepath): |
67e2ec02 PD |
131 | # cyrus ^ vs . storage replacement |
132 | subpath = subpath.replace("^", ".") | |
133 | new_mailpath = mailpath + "/" + subpath | |
38f15e57 | 134 | logging.debug("Inserting mails from directory %s into mailbox %s", new_filepath, new_mailpath) |
67e2ec02 PD |
135 | # load_mails($mboxdbref, $origuser, $targetuser) |
136 | rcrs_generator = self.load_mails(new_filepath, new_mailpath) | |
137 | # you enter the generator in the for loop | |
138 | for rcr in rcrs_generator: | |
139 | yield rcr | |
38f15e57 | 140 | logging.debug("Done with directory %s and mailbox %s", new_filepath, new_mailpath) |
20760d94 | 141 | |
67e2ec02 PD |
142 | # mark mailboxes that need acl update |
143 | self.acl_mailboxes.append(mailpath) |