2 The module contains the FileIterator class.
4 Copyright (c) 2012 Intra2net AG
5 Author: Plamen Dimitrov and Thomas Jarosch
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.
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.
22 MAIL_FILENAME = re.compile("^[0-9]+\.$")
23 MBOXFILE_LINE = re.compile("^(.*?)\t(?:\d )?default[\t ](.*)$")
24 ACL_STRING = re.compile("^(.*?)[\t ](.*?)\t(.*)$")
27 """This class iterates through the e-mail files."""
30 # mailboxes created during file traversal
31 created_mailboxes = None
32 # mailboxes to update during file traversal
34 # acls retrieved from a file
38 """Creates a connection and a user session."""
40 self.created_mailboxes = []
41 self.acl_mailboxes = []
45 def _message_read(cls, filename):
46 """Retrieves a message from the message file."""
49 with open(filename, "r") as msgfile:
50 message = msgfile.read()
52 logging.warning("Could not open the e-mail file %s", filename)
57 def get_mailbox_acls(self, mailbox, original_user):
58 """Get the acls loaded from a file for a given mailbox.
59 Should be used for access of mailbox acls instead of attribute"""
61 # translate the mailbox to internal stored format
62 internal_mailbox = mailbox.replace("INBOX", "user/" + original_user)
63 internal_mailbox = internal_mailbox.replace(".", "^")
64 internal_mailbox = internal_mailbox.replace("/", ".")
65 logging.debug("Get acls for mailbox %s translated as %s", mailbox, internal_mailbox)
67 # retrieve from internal dicitonary attribute of file acls
69 mb_acls = self._file_acls[internal_mailbox]
71 # no rights for the mailbox were found and warn if acl file loaded
72 if len(self._file_acls) > 0:
73 logging.warning("Could not find the acls for mailbox %s", mailbox)
78 def load_mailbox_list(self, mboxlistfile):
79 """Load the list of mailboxes and acl rights for each from file."""
82 with open(mboxlistfile, 'r') as acl_file:
85 # read a line using regex
88 linedata = MBOXFILE_LINE.match(line).groups()
89 except AttributeError:
90 logging.warning("Illegal line in mailbox list dump: %s", line)
94 # changes acls key encoding to internal cyrus format and makes it absolute (as folder).
97 # loop through acl rights string and build dictionary of users and rights
100 acldata = ACL_STRING.match(aclstr).groups()
101 except AttributeError:
102 logging.warning("Illegal acl string in mailbox list dump: %s", line)
105 acls[acldata[0]] = acldata[1]
108 self._file_acls[key] = acls
110 logging.warning("Could not open mboxlist file %s", mboxlistfile)
112 def load_mails(self, filepath, mailpath):
113 """Loads all e-mails from file hierarchy.
114 This recursive generator always returns a tuple of
115 the next found (e-mail, mailbox to store, internaldate)."""
117 logging.debug("Entered directory %s -> %s", filepath, mailpath)
119 filepath = os.path.abspath(filepath)
122 logging.warning("Can't open the directory %s", filepath)
124 # mark mailboxes that should be created
125 self.created_mailboxes.append(mailpath)
127 subpaths = os.listdir(filepath)
128 for subpath in subpaths:
129 if subpath == "." or subpath == "..":
131 new_filepath = filepath + "/" + subpath
133 # if path is file validate name and inject
134 if (os.path.isfile(new_filepath)):
135 if os.path.getsize(new_filepath) == 0:
136 logging.info("Skipping empty file %s", subpath)
138 if MAIL_FILENAME.match(subpath):
139 logging.info("Injecting file %s", subpath)
141 message = self._message_read(new_filepath)
142 # suggest file modification date for internaldate
143 yield (message, mailpath, os.path.getmtime(new_filepath))
145 logging.warning("Could not retrieve mail from the file %s", new_filepath)
148 # if path is directory do recursive call
149 if os.path.isdir(new_filepath):
150 # cyrus ^ vs . storage replacement
151 subpath = subpath.replace("^", ".")
152 new_mailpath = mailpath + "/" + subpath
153 logging.debug("Inserting mails from directory %s into mailbox %s", new_filepath, new_mailpath)
154 # load_mails($mboxdbref, $origuser, $targetuser)
155 rcrs_generator = self.load_mails(new_filepath, new_mailpath)
156 # you enter the generator in the for loop
157 for rcr in rcrs_generator:
159 logging.debug("Done with directory %s and mailbox %s", new_filepath, new_mailpath)
161 # mark mailboxes that need acl update
162 self.acl_mailboxes.append(mailpath)