From 856982a4e6cbb7d75ddf489ed8fe741922a57de6 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Wed, 15 Jun 2011 10:59:00 +0200 Subject: [PATCH] Throw OfflineImapError when we try to request an inexistant message During a sync run, someone might remove or move IMAP messages. As we only cache the list of UIDs in the beginning, we might be requesting UIDs that don't exist anymore. Protect folder.IMAP.getmessage() against the response that we get when we ask for unknown UIDs. Also, if the server responds with anything else than "OK", (eg. Gmail seems to be saying frequently ['NO', 'Dave I can't let you do that now'] :-) so we should also be throwing OfflineImapErrors here rather than AssertionErrors. Signed-off-by: Sebastian Spaeth Signed-off-by: Nicolas Sebrecht --- Changelog.draft.rst | 3 +++ offlineimap/folder/IMAP.py | 19 +++++++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Changelog.draft.rst b/Changelog.draft.rst index fd445ac..3d20bcf 100644 --- a/Changelog.draft.rst +++ b/Changelog.draft.rst @@ -20,6 +20,9 @@ Bug Fixes --------- +* We protect more robustly against asking for inexistent messages from the + IMAP server, when someone else deletes or moves messages while we sync. + Pending for the next major release ================================== diff --git a/offlineimap/folder/IMAP.py b/offlineimap/folder/IMAP.py index 8851b5b..62f220f 100644 --- a/offlineimap/folder/IMAP.py +++ b/offlineimap/folder/IMAP.py @@ -23,7 +23,7 @@ import re import time from copy import copy from Base import BaseFolder -from offlineimap import imaputil, imaplibutil +from offlineimap import imaputil, imaplibutil, OfflineImapError class IMAPFolder(BaseFolder): def __init__(self, imapserver, name, visiblename, accountname, repository): @@ -195,13 +195,24 @@ class IMAPFolder(BaseFolder): def getmessage(self, uid): """Retrieve message with UID from the IMAP server (incl body) - :returns: the message body + :returns: the message body or throws and OfflineImapError + (probably severity MESSAGE) if e.g. no message with + this UID could be found. """ imapobj = self.imapserver.acquireconnection() try: imapobj.select(self.getfullname(), readonly = 1) - res_type, data = imapobj.uid('fetch', '%d' % uid, '(BODY.PEEK[])') - assert res_type == 'OK', "Fetching message with UID '%d' failed" % uid + res_type, data = imapobj.uid('fetch', str(uid), '(BODY.PEEK[])') + if data == [None] or res_type != 'OK': + #IMAP server says bad request or UID does not exist + severity = OfflineImapError.ERROR.MESSAGE + reason = "IMAP server '%s' responded with '%s' to fetching "\ + "message UID '%d'" % (self.getrepository(), res_type, uid) + if data == [None]: + #IMAP server did not find a message with this UID + reason = "IMAP server '%s' does not have a message "\ + "with UID '%s'" % (self.getrepository(), uid) + raise OfflineImapError(reason, severity) # data looks now e.g. [('320 (UID 17061 BODY[] # {2565}','msgbody....')] we only asked for one message, # and that msg is in data[0]. msbody is in [0][1]