mirror/archivemail
1
0
Fork 0
mirror of https://git.code.sf.net/p/archivemail/code synced 2025-03-12 15:52:50 +00:00
Code Issues Releases Wiki Activity

Simplify the final committing of the mailbox and archive

Browse source 
* Make the finalise() methods spot if they have anything to do
* We used to create the temporary mbox files on demand in the message
  processing loop, if we needed to write to them.  Now we create them
  beforehand, but only if they might be needed (e.g. we don't create an
  archive if options.delete_old_mail is set).
* The above combined makes the final committing of the changes simpler (a
  *lot* simpler for mboxes), and we can dump the Mbox.leave_empty() method.
This commit is contained in:
Nikolaus Schulz 2008-08-09 02:56:19 +02:00
parent b37b3d627e
commit a7414319c9
2 changed files with 54 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
archivemail.py
View file

@ -407,11 +407,6 @@ class Mbox(mailbox.UnixMailbox):
os.remove(lock_name) os.remove(lock_name)
_stale.procmail_lock = None _stale.procmail_lock = None
def leave_empty(self):
"""Truncate the 'mbox' mailbox to zero-length."""
vprint("turning '%s' into a zero-length file" % self.mbox_file_name)
self.mbox_file.truncate(0)
def get_size(self): def get_size(self):
"""Return the current size of the mbox file""" """Return the current size of the mbox file"""
return os.path.getsize(self.mbox_file_name) return os.path.getsize(self.mbox_file_name)
@ -425,6 +420,9 @@ class TempMbox:
fd, filename = tempfile.mkstemp(prefix=prefix) fd, filename = tempfile.mkstemp(prefix=prefix)
self.mbox_file_name = filename self.mbox_file_name = filename
self.mbox_file = os.fdopen(fd, "w") self.mbox_file = os.fdopen(fd, "w")
# an empty gzip file is not really empty (it contains the gzip header
# and trailer), so we need to track manually if this mbox is empty
self.empty = True
def write(self, msg): def write(self, msg):
"""Write a rfc822 message object to the 'mbox' mailbox. """Write a rfc822 message object to the 'mbox' mailbox.
@ -438,6 +436,7 @@ class TempMbox:
assert(msg) assert(msg)
assert(self.mbox_file) assert(self.mbox_file)
self.empty = False
vprint("saving message to file '%s'" % self.mbox_file_name) vprint("saving message to file '%s'" % self.mbox_file_name)
unix_from = msg.unixfrom unix_from = msg.unixfrom
if unix_from: if unix_from:
@ -506,9 +505,16 @@ class RetainMbox(TempMbox):
def finalise(self): def finalise(self):
"""Overwrite the original mailbox with this temporary mailbox.""" """Overwrite the original mailbox with this temporary mailbox."""
assert(self.__final_mbox_file) assert(self.__final_mbox_file)
new_size = self.mbox_file.tell()
old_size = self.__final_mbox_file.tell()
if new_size == old_size:
vprint("no pending changes to mbox '%s'" % \
self.__final_mbox_file.name)
else:
self.close() self.close()
self.mbox_file = open(self.mbox_file_name, "r") self.mbox_file = open(self.mbox_file_name, "r")
vprint("writing back '%s' to '%s'" % (self.mbox_file_name, self.__final_mbox_file.name)) vprint("overwriting mbox '%s' with temporary mbox '%s'" % \
(self.__final_mbox_file.name, self.mbox_file_name))
self.__final_mbox_file.seek(0) self.__final_mbox_file.seek(0)
shutil.copyfileobj(self.mbox_file, self.__final_mbox_file) shutil.copyfileobj(self.mbox_file, self.__final_mbox_file)
self.__final_mbox_file.truncate() self.__final_mbox_file.truncate()
@ -552,6 +558,7 @@ class ArchiveMbox(TempMbox):
afterwards.""" afterwards."""
assert(self.__final_name) assert(self.__final_name)
self.close() self.close()
if not self.empty:
self.mbox_file = open(self.mbox_file_name, "r") self.mbox_file = open(self.mbox_file_name, "r")
final_name = self.__final_name final_name = self.__final_name
if not options.no_compress: if not options.no_compress:
@ -1113,12 +1120,17 @@ def _archive_mbox(mailbox_name, final_archive_name):
""" """
assert(mailbox_name) assert(mailbox_name)
assert(final_archive_name) assert(final_archive_name)
archive = None
retain = None
stats = Stats(mailbox_name, final_archive_name) stats = Stats(mailbox_name, final_archive_name)
original = Mbox(path=mailbox_name)
cache = IdentityCache(mailbox_name) cache = IdentityCache(mailbox_name)
original = Mbox(path=mailbox_name)
if options.dry_run or options.copy_old_mail:
retain = None
else:
retain = RetainMbox(original.mbox_file)
if options.dry_run or options.delete_old_mail:
archive = None
else:
archive = ArchiveMbox(final_archive_name)
original.procmail_lock() original.procmail_lock()
original.exclusive_lock() original.exclusive_lock()
@ -1137,42 +1149,21 @@ def _archive_mbox(mailbox_name, final_archive_name):
vprint("decision: delete message") vprint("decision: delete message")
else: else:
vprint("decision: archive message") vprint("decision: archive message")
if not options.dry_run: if archive:
if (not archive):
archive = ArchiveMbox(final_archive_name)
archive.write(msg) archive.write(msg)
else: else:
vprint("decision: retain message") vprint("decision: retain message")
if not options.dry_run and not options.copy_old_mail: if retain:
if (not retain):
retain = RetainMbox(original.mbox_file)
retain.write(msg) retain.write(msg)
msg = original.next() msg = original.next()
vprint("finished reading messages") vprint("finished reading messages")
if original.starting_size != original.get_size(): if original.starting_size != original.get_size():
unexpected_error("the mailbox '%s' changed size during reading!" % \ unexpected_error("the mailbox '%s' changed size during reading!" % \
mailbox_name) mailbox_name)
if not options.dry_run: if archive:
if options.delete_old_mail:
# we will never have an archive file
if retain:
retain.finalise()
else:
# nothing was retained - everything was deleted
original.leave_empty()
elif archive:
archive.finalise() archive.finalise()
if not options.copy_old_mail:
if retain: if retain:
retain.finalise() retain.finalise()
else:
# nothing was retained - everything was deleted
original.leave_empty()
else:
# There was nothing to archive
if retain:
# retain will be the same as original mailbox
retain.remove()
original.exclusive_unlock() original.exclusive_unlock()
original.close() original.close()
original.reset_timestamps() original.reset_timestamps()
@ -1186,8 +1177,6 @@ def _archive_dir(mailbox_name, final_archive_name, type):
assert(mailbox_name) assert(mailbox_name)
assert(final_archive_name) assert(final_archive_name)
assert(type) assert(type)
original = None
archive = None
stats = Stats(mailbox_name, final_archive_name) stats = Stats(mailbox_name, final_archive_name)
delete_queue = [] delete_queue = []
@ -1199,6 +1188,10 @@ def _archive_dir(mailbox_name, final_archive_name, type):
unexpected_error("unknown type: %s" % type) unexpected_error("unknown type: %s" % type)
cache = IdentityCache(mailbox_name) cache = IdentityCache(mailbox_name)
if options.dry_run or options.delete_old_mail:
archive = None
else:
archive = ArchiveMbox(final_archive_name)
for msg in original: for msg in original:
if not msg: if not msg:
@ -1215,9 +1208,7 @@ def _archive_dir(mailbox_name, final_archive_name, type):
vprint("decision: delete message") vprint("decision: delete message")
else: else:
vprint("decision: archive message") vprint("decision: archive message")
if not options.dry_run: if archive:
if not archive:
archive = ArchiveMbox(final_archive_name)
if type == "maildir": if type == "maildir":
add_status_headers(msg) add_status_headers(msg)
archive.write(msg) archive.write(msg)
@ -1226,9 +1217,7 @@ def _archive_dir(mailbox_name, final_archive_name, type):
else: else:
vprint("decision: retain message") vprint("decision: retain message")
vprint("finished reading messages") vprint("finished reading messages")
if not options.dry_run:
if archive: if archive:
archive.close()
archive.finalise() archive.finalise()
for file_name in delete_queue: for file_name in delete_queue:
if os.path.isfile(file_name): if os.path.isfile(file_name):
@ -1321,6 +1310,7 @@ def _archive_imap(mailbox_name, final_archive_name):
if not options.dry_run: if not options.dry_run:
if not options.delete_old_mail: if not options.delete_old_mail:
archive = ArchiveMbox(final_archive_name)
vprint("fetching messages...") vprint("fetching messages...")
for msn in message_list: for msn in message_list:
# Fetching message flags and body together always finds \Seen # Fetching message flags and body together always finds \Seen
@ -1338,11 +1328,7 @@ def _archive_imap(mailbox_name, final_archive_name):
add_status_headers_imap(msg, msg_flags) add_status_headers_imap(msg, msg_flags)
if options.warn_duplicates: if options.warn_duplicates:
cache.warn_if_dupe(msg) cache.warn_if_dupe(msg)
if not archive:
archive = ArchiveMbox(final_archive_name)
archive.write(msg) archive.write(msg)
if archive:
archive.close()
archive.finalise() archive.finalise()
if not options.copy_old_mail: if not options.copy_old_mail:
vprint("Deleting %s messages" % len(message_list)) vprint("Deleting %s messages" % len(message_list))

15
test_archivemail.py
View file

@ -99,21 +99,6 @@ class TestCaseInTempdir(unittest.TestCase):
############ Mbox Class testing ############## ############ Mbox Class testing ##############
class TestMboxLeaveEmpty(TestCaseInTempdir):
def setUp(self):
super(TestMboxLeaveEmpty, self).setUp()
self.mbox_name = make_mbox()
self.mbox_mode = os.stat(self.mbox_name)[stat.ST_MODE]
self.mbox = archivemail.Mbox(self.mbox_name)
def testLeaveEmpty(self):
"""leave_empty should leave a zero-length file"""
self.mbox.leave_empty()
assert(os.path.isfile(self.mbox_name))
self.assertEqual(os.path.getsize(self.mbox_name), 0)
new_mode = os.stat(self.mbox_name)[stat.ST_MODE]
self.assertEqual(new_mode, self.mbox_mode)
class TestMboxProcmailLock(TestCaseInTempdir): class TestMboxProcmailLock(TestCaseInTempdir):
def setUp(self): def setUp(self):
super(TestMboxProcmailLock, self).setUp() super(TestMboxProcmailLock, self).setUp()