docker-offlineimap/offlineimap/folder/IMAP.py

439 lines
18 KiB
Python
Raw Normal View History

# IMAP folder support
# Copyright (C) 2002-2007 John Goerzen
# <jgoerzen@complete.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
2006-08-12 06:15:55 +02:00
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
from Base import BaseFolder
from offlineimap import imaplib2, imaputil, imaplibutil
from offlineimap.ui import UIBase
from offlineimap.version import versionstr
import rfc822, time, string, random, binascii, re
2002-06-21 03:22:40 +02:00
from StringIO import StringIO
from copy import copy
class IMAPFolder(BaseFolder):
def __init__(self, imapserver, name, visiblename, accountname, repository):
self.config = imapserver.config
self.expunge = repository.getexpunge()
self.name = imaputil.dequote(name)
self.root = None # imapserver.root
self.sep = imapserver.delim
self.imapserver = imapserver
self.messagelist = None
2002-06-21 08:51:21 +02:00
self.visiblename = visiblename
2002-07-04 05:59:19 +02:00
self.accountname = accountname
self.repository = repository
self.randomgenerator = random.Random()
BaseFolder.__init__(self)
2002-06-21 08:51:21 +02:00
Daniel Jacobowitz patches fixes deb#433732 Date: Sun, 30 Sep 2007 13:54:56 -0400 From: Daniel Jacobowitz <drow@false.org> To: offlineimap@complete.org Subject: Assorted patches Here's the result of a lazy Sunday hacking on offlineimap. Sorry for not breaking this into multiple patches. They're mostly logically independent so just ask if that would make a difference. First, a new -q (quick) option. The quick option means to only update folders that seem to have had significant changes. For Maildir, any change to any message UID or flags is significant, because checking the flags doesn't add a significant cost. For IMAP, only a change to the total number of messages or a change in the UID of the most recent message is significant. This should catch everything except for flags changes. The difference in bandwidth is astonishing: a quick sync takes 80K instead of 5.3MB, and 28 seconds instead of 90. There's a configuration variable that lets you say every tenth sync should update flags, but let all the intervening ones be lighter. Second, a fix to the UID validity problems many people have been reporting with Courier. As discussed in Debian bug #433732, I changed the UID validity check to use SELECT unless the server complains that the folder is read-only. This avoids the Courier bug (see the Debian log for more details). This won't fix existing validity errors, you need to remove the local status and validity files by hand and resync. Third, some speedups in Maildir checking. It's still pretty slow due to a combination of poor performance in os.listdir (never reads more than 4K of directory entries at a time) and some semaphore that leads to lots of futex wake operations, but at least this saves 20% or so of the CPU time running offlineimap on a single folder: Time with quick refresh and md5 in loop: 4.75s user 0.46s system 12% cpu 41.751 total Time with quick refresh and md5 out of loop: 4.38s user 0.50s system 14% cpu 34.799 total Time using string compare to check folder: 4.11s user 0.47s system 13% cpu 34.788 total And fourth, some display fixes for Curses.Blinkenlights. I made warnings more visible, made the new quick sync message cyan, and made all not explicitly colored messages grey. That last one was really bugging me. Any time OfflineIMAP printed a warning in this UI, it had even odds of coming out black on black! Anyway, I hope these are useful. I'm happy to revise them if you see a problem. -- Daniel Jacobowitz CodeSourcery
2007-10-01 23:20:37 +02:00
def selectro(self, imapobj):
"""Select this folder when we do not need write access.
Prefer SELECT to EXAMINE if we can, since some servers
(Courier) do not stabilize UID validity until the folder is
selected."""
try:
imapobj.select(self.getfullname())
except imapobj.readonly:
imapobj.select(self.getfullname(), readonly = 1)
def getaccountname(self):
return self.accountname
def suggeststhreads(self):
return 1
def waitforthread(self):
self.imapserver.connectionwait()
2002-07-04 05:59:19 +02:00
def getcopyinstancelimit(self):
return 'MSGCOPY_' + self.repository.getname()
2002-07-04 05:59:19 +02:00
2002-06-21 08:51:21 +02:00
def getvisiblename(self):
return self.visiblename
def getuidvalidity(self):
imapobj = self.imapserver.acquireconnection()
try:
# Primes untagged_responses
Daniel Jacobowitz patches fixes deb#433732 Date: Sun, 30 Sep 2007 13:54:56 -0400 From: Daniel Jacobowitz <drow@false.org> To: offlineimap@complete.org Subject: Assorted patches Here's the result of a lazy Sunday hacking on offlineimap. Sorry for not breaking this into multiple patches. They're mostly logically independent so just ask if that would make a difference. First, a new -q (quick) option. The quick option means to only update folders that seem to have had significant changes. For Maildir, any change to any message UID or flags is significant, because checking the flags doesn't add a significant cost. For IMAP, only a change to the total number of messages or a change in the UID of the most recent message is significant. This should catch everything except for flags changes. The difference in bandwidth is astonishing: a quick sync takes 80K instead of 5.3MB, and 28 seconds instead of 90. There's a configuration variable that lets you say every tenth sync should update flags, but let all the intervening ones be lighter. Second, a fix to the UID validity problems many people have been reporting with Courier. As discussed in Debian bug #433732, I changed the UID validity check to use SELECT unless the server complains that the folder is read-only. This avoids the Courier bug (see the Debian log for more details). This won't fix existing validity errors, you need to remove the local status and validity files by hand and resync. Third, some speedups in Maildir checking. It's still pretty slow due to a combination of poor performance in os.listdir (never reads more than 4K of directory entries at a time) and some semaphore that leads to lots of futex wake operations, but at least this saves 20% or so of the CPU time running offlineimap on a single folder: Time with quick refresh and md5 in loop: 4.75s user 0.46s system 12% cpu 41.751 total Time with quick refresh and md5 out of loop: 4.38s user 0.50s system 14% cpu 34.799 total Time using string compare to check folder: 4.11s user 0.47s system 13% cpu 34.788 total And fourth, some display fixes for Curses.Blinkenlights. I made warnings more visible, made the new quick sync message cyan, and made all not explicitly colored messages grey. That last one was really bugging me. Any time OfflineIMAP printed a warning in this UI, it had even odds of coming out black on black! Anyway, I hope these are useful. I'm happy to revise them if you see a problem. -- Daniel Jacobowitz CodeSourcery
2007-10-01 23:20:37 +02:00
self.selectro(imapobj)
return long(imapobj.untagged_responses['UIDVALIDITY'][0])
finally:
self.imapserver.releaseconnection(imapobj)
Daniel Jacobowitz patches fixes deb#433732 Date: Sun, 30 Sep 2007 13:54:56 -0400 From: Daniel Jacobowitz <drow@false.org> To: offlineimap@complete.org Subject: Assorted patches Here's the result of a lazy Sunday hacking on offlineimap. Sorry for not breaking this into multiple patches. They're mostly logically independent so just ask if that would make a difference. First, a new -q (quick) option. The quick option means to only update folders that seem to have had significant changes. For Maildir, any change to any message UID or flags is significant, because checking the flags doesn't add a significant cost. For IMAP, only a change to the total number of messages or a change in the UID of the most recent message is significant. This should catch everything except for flags changes. The difference in bandwidth is astonishing: a quick sync takes 80K instead of 5.3MB, and 28 seconds instead of 90. There's a configuration variable that lets you say every tenth sync should update flags, but let all the intervening ones be lighter. Second, a fix to the UID validity problems many people have been reporting with Courier. As discussed in Debian bug #433732, I changed the UID validity check to use SELECT unless the server complains that the folder is read-only. This avoids the Courier bug (see the Debian log for more details). This won't fix existing validity errors, you need to remove the local status and validity files by hand and resync. Third, some speedups in Maildir checking. It's still pretty slow due to a combination of poor performance in os.listdir (never reads more than 4K of directory entries at a time) and some semaphore that leads to lots of futex wake operations, but at least this saves 20% or so of the CPU time running offlineimap on a single folder: Time with quick refresh and md5 in loop: 4.75s user 0.46s system 12% cpu 41.751 total Time with quick refresh and md5 out of loop: 4.38s user 0.50s system 14% cpu 34.799 total Time using string compare to check folder: 4.11s user 0.47s system 13% cpu 34.788 total And fourth, some display fixes for Curses.Blinkenlights. I made warnings more visible, made the new quick sync message cyan, and made all not explicitly colored messages grey. That last one was really bugging me. Any time OfflineIMAP printed a warning in this UI, it had even odds of coming out black on black! Anyway, I hope these are useful. I'm happy to revise them if you see a problem. -- Daniel Jacobowitz CodeSourcery
2007-10-01 23:20:37 +02:00
def quickchanged(self, statusfolder):
# An IMAP folder has definitely changed if the number of
# messages or the UID of the last message have changed. Otherwise
# only flag changes could have occurred.
imapobj = self.imapserver.acquireconnection()
try:
# Primes untagged_responses
imapobj.select(self.getfullname(), readonly = 1, force = 1)
try:
# Some mail servers do not return an EXISTS response if
# the folder is empty.
maxmsgid = long(imapobj.untagged_responses['EXISTS'][0])
except KeyError:
return True
# Different number of messages than last time?
if maxmsgid != len(statusfolder.getmessagelist()):
return True
if maxmsgid < 1:
# No messages; return
return False
# Now, get the UID for the last message.
response = imapobj.fetch('%d' % maxmsgid, '(UID)')[1]
finally:
self.imapserver.releaseconnection(imapobj)
# Discard the message number.
messagestr = string.split(response[0], maxsplit = 1)[1]
options = imaputil.flags2hash(messagestr)
if not options.has_key('UID'):
return True
uid = long(options['UID'])
saveduids = statusfolder.getmessagelist().keys()
saveduids.sort()
if uid != saveduids[-1]:
return True
return False
def cachemessagelist(self):
imapobj = self.imapserver.acquireconnection()
self.messagelist = {}
try:
# Primes untagged_responses
imapobj.select(self.getfullname(), readonly = 1, force = 1)
try:
# Some mail servers do not return an EXISTS response if
# the folder is empty.
maxmsgid = long(imapobj.untagged_responses['EXISTS'][0])
except KeyError:
return
if maxmsgid < 1:
# No messages; return
return
# Now, get the flags and UIDs for these.
# We could conceivably get rid of maxmsgid and just say
# '1:*' here.
response = imapobj.fetch('1:%d' % maxmsgid, '(FLAGS UID INTERNALDATE)')[1]
finally:
self.imapserver.releaseconnection(imapobj)
for messagestr in response:
# Discard the message number.
messagestr = string.split(messagestr, maxsplit = 1)[1]
options = imaputil.flags2hash(messagestr)
2002-10-30 05:26:49 +01:00
if not options.has_key('UID'):
UIBase.getglobalui().warn('No UID in message with options %s' %\
str(options),
minor = 1)
else:
uid = long(options['UID'])
flags = imaputil.flagsimap2maildir(options['FLAGS'])
rtime = imaplibutil.Internaldate2epoch(messagestr)
self.messagelist[uid] = {'uid': uid, 'flags': flags, 'time': rtime}
2002-06-20 09:40:29 +02:00
def getmessagelist(self):
return self.messagelist
def getmessage(self, uid):
ui = UIBase.getglobalui()
imapobj = self.imapserver.acquireconnection()
try:
imapobj.select(self.getfullname(), readonly = 1)
initialresult = imapobj.uid('fetch', '%d' % uid, '(BODY.PEEK[])')
ui.debug('imap', 'Returned object from fetching %d: %s' % \
(uid, str(initialresult)))
return initialresult[1][0][1].replace("\r\n", "\n")
finally:
self.imapserver.releaseconnection(imapobj)
def getmessagetime(self, uid):
return self.messagelist[uid]['time']
def getmessageflags(self, uid):
return self.messagelist[uid]['flags']
def savemessage_getnewheader(self, content):
headername = 'X-OfflineIMAP-%s-' % str(binascii.crc32(content)).replace('-', 'x')
headername += binascii.hexlify(self.repository.getname()) + '-'
headername += binascii.hexlify(self.getname())
headervalue= '%d-' % long(time.time())
headervalue += str(self.randomgenerator.random()).replace('.', '')
headervalue += '-v' + versionstr
return (headername, headervalue)
def savemessage_addheader(self, content, headername, headervalue):
ui = UIBase.getglobalui()
ui.debug('imap',
'savemessage_addheader: called to add %s: %s' % (headername,
headervalue))
insertionpoint = content.find("\r\n")
ui.debug('imap', 'savemessage_addheader: insertionpoint = %d' % insertionpoint)
leader = content[0:insertionpoint]
ui.debug('imap', 'savemessage_addheader: leader = %s' % repr(leader))
if insertionpoint == 0 or insertionpoint == -1:
newline = ''
insertionpoint = 0
else:
newline = "\r\n"
newline += "%s: %s" % (headername, headervalue)
ui.debug('imap', 'savemessage_addheader: newline = ' + repr(newline))
trailer = content[insertionpoint:]
ui.debug('imap', 'savemessage_addheader: trailer = ' + repr(trailer))
return leader + newline + trailer
def savemessage_searchforheader(self, imapobj, headername, headervalue):
if imapobj.untagged_responses.has_key('APPENDUID'):
return long(imapobj.untagged_responses['APPENDUID'][-1].split(' ')[1])
ui = UIBase.getglobalui()
ui.debug('imap', 'savemessage_searchforheader called for %s: %s' % \
(headername, headervalue))
# Now find the UID it got.
headervalue = imapobj._quote(headervalue)
try:
matchinguids = imapobj.uid('search', 'HEADER', headername, headervalue)[1][0]
except imapobj.error, err:
# IMAP server doesn't implement search or had a problem.
2006-05-16 05:27:57 +02:00
ui.debug('imap', "savemessage_searchforheader: got IMAP error '%s' while attempting to UID SEARCH for message with header %s" % (err, headername))
return 0
ui.debug('imap', 'savemessage_searchforheader got initial matchinguids: ' + repr(matchinguids))
if matchinguids == '':
ui.debug('imap', "savemessage_searchforheader: UID SEARCH for message with header %s yielded no results" % headername)
return 0
matchinguids = matchinguids.split(' ')
ui.debug('imap', 'savemessage_searchforheader: matchinguids now ' + \
repr(matchinguids))
if len(matchinguids) != 1 or matchinguids[0] == None:
raise ValueError, "While attempting to find UID for message with header %s, got wrong-sized matchinguids of %s" % (headername, str(matchinguids))
matchinguids.sort()
return long(matchinguids[0])
def savemessage(self, uid, content, flags, rtime):
imapobj = self.imapserver.acquireconnection()
ui = UIBase.getglobalui()
ui.debug('imap', 'savemessage: called')
try:
try:
imapobj.select(self.getfullname()) # Needed for search
except imapobj.readonly:
ui.msgtoreadonly(self, uid, content, flags)
# Return indicating message taken, but no UID assigned.
# Fudge it.
return 0
# This backend always assigns a new uid, so the uid arg is ignored.
# In order to get the new uid, we need to save off the message ID.
message = rfc822.Message(StringIO(content))
datetuple_msg = rfc822.parsedate(message.getheader('Date'))
# Will be None if missing or not in a valid format.
# If time isn't known
if rtime == None and datetuple_msg == None:
datetuple = time.localtime()
elif rtime == None:
datetuple = datetuple_msg
else:
datetuple = time.localtime(rtime)
try:
if datetuple[0] < 1981:
raise ValueError
# Check for invalid date
datetuple_check = time.localtime(time.mktime(datetuple))
if datetuple[:2] != datetuple_check[:2]:
raise ValueError
# This could raise a value error if it's not a valid format.
date = imaplib2.Time2Internaldate(datetuple)
except (ValueError, OverflowError):
# Argh, sometimes it's a valid format but year is 0102
# or something. Argh. It seems that Time2Internaldate
# will rause a ValueError if the year is 0102 but not 1902,
# but some IMAP servers nonetheless choke on 1902.
date = imaplib2.Time2Internaldate(time.localtime())
ui.debug('imap', 'savemessage: using date ' + str(date))
content = re.sub("(?<!\r)\n", "\r\n", content)
ui.debug('imap', 'savemessage: initial content is: ' + repr(content))
(headername, headervalue) = self.savemessage_getnewheader(content)
ui.debug('imap', 'savemessage: new headers are: %s: %s' % \
(headername, headervalue))
content = self.savemessage_addheader(content, headername,
headervalue)
ui.debug('imap', 'savemessage: new content is: ' + repr(content))
ui.debug('imap', 'savemessage: new content length is ' + \
str(len(content)))
assert(imapobj.append(self.getfullname(),
imaputil.flagsmaildir2imap(flags),
date, content)[0] == 'OK')
# Checkpoint. Let it write out the messages, etc.
assert(imapobj.check()[0] == 'OK')
# Keep trying until we get the UID.
ui.debug('imap', 'savemessage: first attempt to get new UID')
uid = self.savemessage_searchforheader(imapobj, headername,
headervalue)
2006-05-16 05:40:23 +02:00
# See docs for savemessage in Base.py for explanation of this and other return values
if uid <= 0:
ui.debug('imap', 'savemessage: first attempt to get new UID failed. Going to run a NOOP and try again.')
assert(imapobj.noop()[0] == 'OK')
uid = self.savemessage_searchforheader(imapobj, headername,
headervalue)
finally:
self.imapserver.releaseconnection(imapobj)
2002-06-21 03:22:40 +02:00
2006-05-16 05:40:23 +02:00
if uid: # avoid UID FETCH 0 crash happening later on
2006-05-16 05:31:44 +02:00
self.messagelist[uid] = {'uid': uid, 'flags': flags}
2006-05-16 05:40:23 +02:00
ui.debug('imap', 'savemessage: returning %d' % uid)
return uid
2002-06-21 03:55:06 +02:00
def savemessageflags(self, uid, flags):
2002-07-04 05:59:19 +02:00
imapobj = self.imapserver.acquireconnection()
try:
try:
imapobj.select(self.getfullname())
except imapobj.readonly:
UIBase.getglobalui().flagstoreadonly(self, [uid], flags)
return
result = imapobj.uid('store', '%d' % uid, 'FLAGS',
2002-07-12 15:20:09 +02:00
imaputil.flagsmaildir2imap(flags))
assert result[0] == 'OK', 'Error with store: ' + '. '.join(r[1])
finally:
self.imapserver.releaseconnection(imapobj)
2002-07-12 15:20:09 +02:00
result = result[1][0]
if not result:
self.messagelist[uid]['flags'] = flags
else:
flags = imaputil.flags2hash(imaputil.imapsplit(result)[1])['FLAGS']
self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(flags)
def addmessageflags(self, uid, flags):
self.addmessagesflags([uid], flags)
2002-06-21 03:55:06 +02:00
def addmessagesflags_noconvert(self, uidlist, flags):
self.processmessagesflags('+', uidlist, flags)
def addmessagesflags(self, uidlist, flags):
"""This is here for the sake of UIDMaps.py -- deletemessages must
add flags and get a converted UID, and if we don't have noconvert,
then UIDMaps will try to convert it twice."""
self.addmessagesflags_noconvert(uidlist, flags)
def deletemessageflags(self, uid, flags):
self.deletemessagesflags([uid], flags)
def deletemessagesflags(self, uidlist, flags):
self.processmessagesflags('-', uidlist, flags)
def processmessagesflags(self, operation, uidlist, flags):
if len(uidlist) > 101:
# Hack for those IMAP ervers with a limited line length
self.processmessagesflags(operation, uidlist[:100], flags)
self.processmessagesflags(operation, uidlist[100:], flags)
return
2002-07-04 04:14:07 +02:00
imapobj = self.imapserver.acquireconnection()
try:
try:
imapobj.select(self.getfullname())
except imapobj.readonly:
UIBase.getglobalui().flagstoreadonly(self, uidlist, flags)
return
r = imapobj.uid('store',
imaputil.listjoin(uidlist),
operation + 'FLAGS',
imaputil.flagsmaildir2imap(flags))
assert r[0] == 'OK', 'Error with store: ' + '. '.join(r[1])
r = r[1]
finally:
self.imapserver.releaseconnection(imapobj)
# Some IMAP servers do not always return a result. Therefore,
# only update the ones that it talks about, and manually fix
# the others.
needupdate = copy(uidlist)
for result in r:
if result == None:
# Compensate for servers that don't return anything from
# STORE.
continue
attributehash = imaputil.flags2hash(imaputil.imapsplit(result)[1])
if not ('UID' in attributehash and 'FLAGS' in attributehash):
# Compensate for servers that don't return a UID attribute.
continue
Fix handling of servers that return UIDs in some FETCH responses closes #22 from pistore in OfflineIMAP #22: When an IMAP flag update is performed for multiple messages, some IMAP servers (e.g. Exchange) return the UID attribute only for some of the FETCH untagged responses, as shown in the following log: 21:19.04 > DCKF8 UID STORE 66050,50613,52164,40043,40055,25874 +FLAGS (\Deleted) 21:19.36 < * 35 FETCH (FLAGS (\Seen \Deleted) UID 25874) 21:19.36 < * 321 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 322 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 560 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 581 FETCH (FLAGS (\Seen \Deleted) UID 52164) 21:19.62 < * 1022 FETCH (FLAGS (\Seen \Deleted)) 21:19.62 < DCKF8 OK STORE completed. Function IMAPFolder.processmessagesflags is able to manage the servers which return the UID and the servers which do not return it, but is not able to deal with the mixed behavior shown above. The problem is that the fragment of function IMAPFolder.processmessagesflags that handles the responses with UID attribute uses variable flags to store the list of flags of the message in the IMAP format ("flags = attributehashFLAGS?"), while the fragment that handles the responses without UID expects variable "flags" to contain the list of modified flags passed to the function in Maildir format ("self.messagelist[uid]flags?.append(flag)"). As a consequence, the wrong list of flags is used for the messages without UID, leading to the addition of "strange" flags to the Maildir messages: Syncing messages IMAP[INBOX] -> Maildir[.] Adding flags to 4 messages on Maildir[.] Adding flags e to 4 messages on Maildir[.] Adding flags d to 4 messages on Maildir[.] Adding flags ) to 4 messages on Maildir[.] Adding flags ( to 4 messages on Maildir[.] Adding flags l to 4 messages on Maildir[.] Adding flags n to 4 messages on Maildir[.] Adding flags t to 4 messages on Maildir[.] Adding flags \ to 4 messages on Maildir[.] Adding flags D to 4 messages on Maildir[.] Deleting flags T to 4 messages on Maildir[.] Adding flags to 4 messages on LocalStatus[.] Adding flags e to 4 messages on LocalStatus[.] Adding flags d to 4 messages on LocalStatus[.] Adding flags ) to 4 messages on LocalStatus[.] Adding flags ( to 4 messages on LocalStatus[.] Adding flags l to 4 messages on LocalStatus[.] Adding flags n to 4 messages on LocalStatus[.] Adding flags t to 4 messages on LocalStatus[.] Adding flags \ to 4 messages on LocalStatus[.] Adding flags D to 4 messages on LocalStatus[.] Deleting flags T to 4 messages on LocalStatus[.] Fix: use a different variable to store IMAP flags when managing messages corresponding to responses with UID attribute, e.g.: *** IMAP.py.orig Wed Aug 22 18:23:17 2007 --- IMAP.py Wed Aug 22 18:22:38 2007 *************** class IMAPFolder(BaseFolder): *** 340,348 **** if not ('UID' in attributehash and 'FLAGS' in attributehash): # Compensate for servers that don't return a UID attribute. continue ! flags = attributehash['FLAGS'] uid = long(attributehash['UID']) ! self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(flags) try: needupdate.remove(uid) except ValueError: # Let it slide if it's not in the list --- 340,348 ---- if not ('UID' in attributehash and 'FLAGS' in attributehash): # Compensate for servers that don't return a UID attribute. continue ! lflags = attributehash['FLAGS'] uid = long(attributehash['UID']) ! self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(lflags) try: needupdate.remove(uid) except ValueError: # Let it slide if it's not in the list 02/03/08 14:04:35 changed by js * attachment flags-fix.patch added. Delete 02/03/08 14:05:24 changed by js Unfortunately I have to fetch some of my mail from an Exchange server (Microsoft Exchange Server 2003 IMAP4rev1 server version 6.5.7638.1) and I can confirm that the analysis of the problem is correct, and the patch given here fixes the problem. Looking at the code of the processmessagesflags() method I think it generally is a bug that the "flags" parameter is reused as a local variable, since the final "for uid in needupdate:" loop needs the original value of "flags". This only worked by accident. I'm attaching a unidiff version of the patch which applies cleanly against Debian unstable's offlineimap 5.99.4.
2008-03-03 05:25:05 +01:00
lflags = attributehash['FLAGS']
uid = long(attributehash['UID'])
Fix handling of servers that return UIDs in some FETCH responses closes #22 from pistore in OfflineIMAP #22: When an IMAP flag update is performed for multiple messages, some IMAP servers (e.g. Exchange) return the UID attribute only for some of the FETCH untagged responses, as shown in the following log: 21:19.04 > DCKF8 UID STORE 66050,50613,52164,40043,40055,25874 +FLAGS (\Deleted) 21:19.36 < * 35 FETCH (FLAGS (\Seen \Deleted) UID 25874) 21:19.36 < * 321 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 322 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 560 FETCH (FLAGS (\Seen \Deleted)) 21:19.57 < * 581 FETCH (FLAGS (\Seen \Deleted) UID 52164) 21:19.62 < * 1022 FETCH (FLAGS (\Seen \Deleted)) 21:19.62 < DCKF8 OK STORE completed. Function IMAPFolder.processmessagesflags is able to manage the servers which return the UID and the servers which do not return it, but is not able to deal with the mixed behavior shown above. The problem is that the fragment of function IMAPFolder.processmessagesflags that handles the responses with UID attribute uses variable flags to store the list of flags of the message in the IMAP format ("flags = attributehashFLAGS?"), while the fragment that handles the responses without UID expects variable "flags" to contain the list of modified flags passed to the function in Maildir format ("self.messagelist[uid]flags?.append(flag)"). As a consequence, the wrong list of flags is used for the messages without UID, leading to the addition of "strange" flags to the Maildir messages: Syncing messages IMAP[INBOX] -> Maildir[.] Adding flags to 4 messages on Maildir[.] Adding flags e to 4 messages on Maildir[.] Adding flags d to 4 messages on Maildir[.] Adding flags ) to 4 messages on Maildir[.] Adding flags ( to 4 messages on Maildir[.] Adding flags l to 4 messages on Maildir[.] Adding flags n to 4 messages on Maildir[.] Adding flags t to 4 messages on Maildir[.] Adding flags \ to 4 messages on Maildir[.] Adding flags D to 4 messages on Maildir[.] Deleting flags T to 4 messages on Maildir[.] Adding flags to 4 messages on LocalStatus[.] Adding flags e to 4 messages on LocalStatus[.] Adding flags d to 4 messages on LocalStatus[.] Adding flags ) to 4 messages on LocalStatus[.] Adding flags ( to 4 messages on LocalStatus[.] Adding flags l to 4 messages on LocalStatus[.] Adding flags n to 4 messages on LocalStatus[.] Adding flags t to 4 messages on LocalStatus[.] Adding flags \ to 4 messages on LocalStatus[.] Adding flags D to 4 messages on LocalStatus[.] Deleting flags T to 4 messages on LocalStatus[.] Fix: use a different variable to store IMAP flags when managing messages corresponding to responses with UID attribute, e.g.: *** IMAP.py.orig Wed Aug 22 18:23:17 2007 --- IMAP.py Wed Aug 22 18:22:38 2007 *************** class IMAPFolder(BaseFolder): *** 340,348 **** if not ('UID' in attributehash and 'FLAGS' in attributehash): # Compensate for servers that don't return a UID attribute. continue ! flags = attributehash['FLAGS'] uid = long(attributehash['UID']) ! self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(flags) try: needupdate.remove(uid) except ValueError: # Let it slide if it's not in the list --- 340,348 ---- if not ('UID' in attributehash and 'FLAGS' in attributehash): # Compensate for servers that don't return a UID attribute. continue ! lflags = attributehash['FLAGS'] uid = long(attributehash['UID']) ! self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(lflags) try: needupdate.remove(uid) except ValueError: # Let it slide if it's not in the list 02/03/08 14:04:35 changed by js * attachment flags-fix.patch added. Delete 02/03/08 14:05:24 changed by js Unfortunately I have to fetch some of my mail from an Exchange server (Microsoft Exchange Server 2003 IMAP4rev1 server version 6.5.7638.1) and I can confirm that the analysis of the problem is correct, and the patch given here fixes the problem. Looking at the code of the processmessagesflags() method I think it generally is a bug that the "flags" parameter is reused as a local variable, since the final "for uid in needupdate:" loop needs the original value of "flags". This only worked by accident. I'm attaching a unidiff version of the patch which applies cleanly against Debian unstable's offlineimap 5.99.4.
2008-03-03 05:25:05 +01:00
self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(lflags)
try:
needupdate.remove(uid)
except ValueError: # Let it slide if it's not in the list
pass
for uid in needupdate:
if operation == '+':
for flag in flags:
if not flag in self.messagelist[uid]['flags']:
self.messagelist[uid]['flags'].append(flag)
self.messagelist[uid]['flags'].sort()
elif operation == '-':
for flag in flags:
if flag in self.messagelist[uid]['flags']:
self.messagelist[uid]['flags'].remove(flag)
2002-06-21 03:55:06 +02:00
def deletemessage(self, uid):
self.deletemessages_noconvert([uid])
def deletemessages(self, uidlist):
self.deletemessages_noconvert(uidlist)
def deletemessages_noconvert(self, uidlist):
# Weed out ones not in self.messagelist
uidlist = [uid for uid in uidlist if uid in self.messagelist]
if not len(uidlist):
return
self.addmessagesflags_noconvert(uidlist, ['T'])
imapobj = self.imapserver.acquireconnection()
try:
try:
imapobj.select(self.getfullname())
except imapobj.readonly:
UIBase.getglobalui().deletereadonly(self, uidlist)
return
if self.expunge:
assert(imapobj.expunge()[0] == 'OK')
finally:
self.imapserver.releaseconnection(imapobj)
for uid in uidlist:
del self.messagelist[uid]
2002-06-21 03:55:06 +02:00
2002-06-21 03:22:40 +02:00