2002-06-19 07:22:21 +02:00
|
|
|
# IMAP folder support
|
2007-07-04 19:51:57 +02:00
|
|
|
# Copyright (C) 2002-2007 John Goerzen
|
2002-06-19 07:22:21 +02:00
|
|
|
# <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
|
2003-04-16 21:23:45 +02:00
|
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
|
|
# (at your option) any later version.
|
2002-06-19 07:22:21 +02:00
|
|
|
#
|
|
|
|
# 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
|
2002-06-19 07:22:21 +02:00
|
|
|
|
2011-03-12 14:05:28 +01:00
|
|
|
import email
|
2010-12-22 12:35:41 +01:00
|
|
|
import random
|
|
|
|
import binascii
|
|
|
|
import re
|
2011-01-05 19:31:08 +01:00
|
|
|
import time
|
2011-09-06 13:19:26 +02:00
|
|
|
from sys import exc_info
|
2010-12-22 12:35:41 +01:00
|
|
|
from Base import BaseFolder
|
2011-06-15 10:59:00 +02:00
|
|
|
from offlineimap import imaputil, imaplibutil, OfflineImapError
|
2011-08-16 12:16:46 +02:00
|
|
|
try: # python 2.6 has set() built in
|
|
|
|
set
|
|
|
|
except NameError:
|
|
|
|
from sets import Set as set
|
|
|
|
|
2002-07-18 02:51:03 +02:00
|
|
|
|
2002-06-19 07:22:21 +02:00
|
|
|
class IMAPFolder(BaseFolder):
|
2002-08-20 22:54:02 +02:00
|
|
|
def __init__(self, imapserver, name, visiblename, accountname, repository):
|
2002-11-12 22:36:34 +01:00
|
|
|
self.config = imapserver.config
|
2003-04-18 04:18:34 +02:00
|
|
|
self.expunge = repository.getexpunge()
|
2002-06-19 07:22:21 +02:00
|
|
|
self.name = imaputil.dequote(name)
|
2002-07-20 09:03:21 +02:00
|
|
|
self.root = None # imapserver.root
|
2002-06-19 07:22:21 +02:00
|
|
|
self.sep = imapserver.delim
|
|
|
|
self.imapserver = imapserver
|
2002-06-20 08:26:28 +02:00
|
|
|
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
|
2002-08-20 22:54:02 +02:00
|
|
|
self.repository = repository
|
2003-04-18 04:18:34 +02:00
|
|
|
self.randomgenerator = random.Random()
|
|
|
|
BaseFolder.__init__(self)
|
2011-01-05 17:00:57 +01:00
|
|
|
#self.ui is set in BaseFolder
|
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.
|
2011-05-07 18:39:13 +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
|
|
|
Prefer SELECT to EXAMINE if we can, since some servers
|
|
|
|
(Courier) do not stabilize UID validity until the folder is
|
2011-05-07 18:39:13 +02:00
|
|
|
selected.
|
|
|
|
.. todo: Still valid? Needs verification
|
|
|
|
|
|
|
|
:returns: raises :exc:`OfflineImapError` severity FOLDER on error"""
|
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
|
|
|
try:
|
|
|
|
imapobj.select(self.getfullname())
|
|
|
|
except imapobj.readonly:
|
|
|
|
imapobj.select(self.getfullname(), readonly = 1)
|
|
|
|
|
2003-01-06 00:07:58 +01:00
|
|
|
def getaccountname(self):
|
|
|
|
return self.accountname
|
|
|
|
|
2002-07-04 03:35:05 +02:00
|
|
|
def suggeststhreads(self):
|
|
|
|
return 1
|
|
|
|
|
|
|
|
def waitforthread(self):
|
|
|
|
self.imapserver.connectionwait()
|
|
|
|
|
2002-07-04 05:59:19 +02:00
|
|
|
def getcopyinstancelimit(self):
|
2003-04-18 04:18:34 +02:00
|
|
|
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
|
2002-06-20 08:26:28 +02:00
|
|
|
|
|
|
|
def getuidvalidity(self):
|
2002-07-04 03:35:05 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
|
|
|
try:
|
2002-07-11 05:31:39 +02:00
|
|
|
# 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)
|
Update to match semantics of new imaplib2
The biggest change here is that imapobj.untagged_responses is no
longer a dictionary, but a list. To access it, I use the semi-private
_get_untagged_response method.
* offlineimap/folder/IMAP.py (IMAPFolder.quickchanged,
IMAPFolder.cachemessagelist): imaplib2 now explicitly removes its
EXISTS response on select(), so instead we use the return values from
select() to get the number of messages.
* offlineimap/imapserver.py (UsefulIMAPMixIn.select): imaplib2 now
stores untagged_responses for different mailboxes, which confuses us
because it seems like our mailboxes are "still" in read-only mode when
we just re-opened them. Additionally, we have to return the value
from imaplib2's select() so that the above thing works.
* offlineimap/imapserver.py (UsefulIMAPMixIn._mesg): imaplib2 now
calls _mesg with the name of a thread, so we display this
information in debug output. This requires a corresponding change to
imaplibutil.new_mesg.
* offlineimap/imaplibutil.py: We override IMAP4_SSL.open, whose
default arguments have changed, so update the default arguments. We
also subclass imaplib.IMAP4 in a few different places, which now
relies on having a read_fd file descriptor to poll on.
Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-10 21:36:20 +01:00
|
|
|
return long(imapobj._get_untagged_response('UIDVALIDITY', True)[0])
|
2002-07-04 03:35:05 +02:00
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
2011-04-11 18:33:11 +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 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
|
Update to match semantics of new imaplib2
The biggest change here is that imapobj.untagged_responses is no
longer a dictionary, but a list. To access it, I use the semi-private
_get_untagged_response method.
* offlineimap/folder/IMAP.py (IMAPFolder.quickchanged,
IMAPFolder.cachemessagelist): imaplib2 now explicitly removes its
EXISTS response on select(), so instead we use the return values from
select() to get the number of messages.
* offlineimap/imapserver.py (UsefulIMAPMixIn.select): imaplib2 now
stores untagged_responses for different mailboxes, which confuses us
because it seems like our mailboxes are "still" in read-only mode when
we just re-opened them. Additionally, we have to return the value
from imaplib2's select() so that the above thing works.
* offlineimap/imapserver.py (UsefulIMAPMixIn._mesg): imaplib2 now
calls _mesg with the name of a thread, so we display this
information in debug output. This requires a corresponding change to
imaplibutil.new_mesg.
* offlineimap/imaplibutil.py: We override IMAP4_SSL.open, whose
default arguments have changed, so update the default arguments. We
also subclass imaplib.IMAP4 in a few different places, which now
relies on having a read_fd file descriptor to poll on.
Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-10 21:36:20 +01:00
|
|
|
imaptype, imapdata = imapobj.select(self.getfullname(), readonly = 1, force = 1)
|
|
|
|
# 1. Some mail servers do not return an EXISTS response
|
|
|
|
# if the folder is empty. 2. ZIMBRA servers can return
|
|
|
|
# multiple EXISTS replies in the form 500, 1000, 1500,
|
|
|
|
# 1623 so check for potentially multiple replies.
|
|
|
|
if imapdata == [None]:
|
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
|
|
|
return True
|
Update to match semantics of new imaplib2
The biggest change here is that imapobj.untagged_responses is no
longer a dictionary, but a list. To access it, I use the semi-private
_get_untagged_response method.
* offlineimap/folder/IMAP.py (IMAPFolder.quickchanged,
IMAPFolder.cachemessagelist): imaplib2 now explicitly removes its
EXISTS response on select(), so instead we use the return values from
select() to get the number of messages.
* offlineimap/imapserver.py (UsefulIMAPMixIn.select): imaplib2 now
stores untagged_responses for different mailboxes, which confuses us
because it seems like our mailboxes are "still" in read-only mode when
we just re-opened them. Additionally, we have to return the value
from imaplib2's select() so that the above thing works.
* offlineimap/imapserver.py (UsefulIMAPMixIn._mesg): imaplib2 now
calls _mesg with the name of a thread, so we display this
information in debug output. This requires a corresponding change to
imaplibutil.new_mesg.
* offlineimap/imaplibutil.py: We override IMAP4_SSL.open, whose
default arguments have changed, so update the default arguments. We
also subclass imaplib.IMAP4 in a few different places, which now
relies on having a read_fd file descriptor to poll on.
Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-10 21:36:20 +01:00
|
|
|
maxmsgid = 0
|
|
|
|
for msgid in imapdata:
|
|
|
|
maxmsgid = max(long(msgid), maxmsgid)
|
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
|
|
|
|
|
|
|
# Different number of messages than last time?
|
2011-03-28 16:19:20 +02:00
|
|
|
if maxmsgid != statusfolder.getmessagecount():
|
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
|
|
|
return True
|
|
|
|
|
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
|
|
|
return False
|
|
|
|
|
2002-06-20 08:26:28 +02:00
|
|
|
def cachemessagelist(self):
|
2011-08-18 09:08:54 +02:00
|
|
|
maxage = self.config.getdefaultint("Account %s" % self.accountname,
|
|
|
|
"maxage", -1)
|
|
|
|
maxsize = self.config.getdefaultint("Account %s" % self.accountname,
|
|
|
|
"maxsize", -1)
|
2002-07-11 05:31:39 +02:00
|
|
|
self.messagelist = {}
|
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
2002-07-04 03:35:05 +02:00
|
|
|
try:
|
2011-08-18 09:08:55 +02:00
|
|
|
res_type, imapdata = imapobj.select(self.getfullname(), True)
|
2011-09-07 15:23:28 +02:00
|
|
|
if imapdata == [None] or imapdata[0] == '0':
|
|
|
|
# Empty folder, no need to populate message list
|
|
|
|
return
|
2011-08-18 09:08:55 +02:00
|
|
|
# By default examine all UIDs in this folder
|
|
|
|
msgsToFetch = '1:*'
|
2009-08-16 14:42:39 +02:00
|
|
|
|
|
|
|
if (maxage != -1) | (maxsize != -1):
|
2011-08-18 09:08:54 +02:00
|
|
|
search_cond = "(";
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
if(maxage != -1):
|
|
|
|
#find out what the oldest message is that we should look at
|
|
|
|
oldest_struct = time.gmtime(time.time() - (60*60*24*maxage))
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
#format months manually - otherwise locales cause problems
|
|
|
|
monthnames = ["Jan", "Feb", "Mar", "Apr", "May", \
|
|
|
|
"Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
month = monthnames[oldest_struct[1]-1]
|
|
|
|
daystr = "%(day)02d" % {'day' : oldest_struct[2]}
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
search_cond += "SINCE %s-%s-%s" % (daystr, month,
|
|
|
|
oldest_struct[0])
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
if(maxsize != -1):
|
|
|
|
if(maxage != -1): # There are two conditions, add space
|
|
|
|
search_cond += " "
|
|
|
|
search_cond += "SMALLER %d" % maxsize
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
search_cond += ")"
|
2009-08-16 14:42:39 +02:00
|
|
|
|
2011-08-18 09:08:54 +02:00
|
|
|
res_type, res_data = imapobj.search(None, search_cond)
|
2011-08-18 09:08:56 +02:00
|
|
|
if res_type != 'OK':
|
|
|
|
raise OfflineImapError("SEARCH in folder [%s]%s failed. "
|
|
|
|
"Search string was '%s'. Server responded '[%s] %s'" % (
|
|
|
|
self.getrepository(), self,
|
|
|
|
search_cond, res_type, res_data),
|
|
|
|
OfflineImapError.ERROR.FOLDER)
|
|
|
|
|
|
|
|
# Result UIDs are seperated by space, coalesce into ranges
|
2011-09-07 18:21:46 +02:00
|
|
|
msgsToFetch = imaputil.uid_sequence(res_data[0].split())
|
2011-08-18 09:08:56 +02:00
|
|
|
if not msgsToFetch:
|
2011-08-18 09:08:54 +02:00
|
|
|
return # No messages to sync
|
|
|
|
|
2011-08-18 09:08:55 +02:00
|
|
|
# Get the flags and UIDs for these. single-quotes prevent
|
|
|
|
# imaplib2 from quoting the sequence.
|
|
|
|
res_type, response = imapobj.fetch("'%s'" % msgsToFetch,
|
|
|
|
'(FLAGS UID)')
|
2011-08-18 09:08:56 +02:00
|
|
|
if res_type != 'OK':
|
|
|
|
raise OfflineImapError("FETCHING UIDs in folder [%s]%s failed. "
|
|
|
|
"Server responded '[%s] %s'" % (
|
|
|
|
self.getrepository(), self,
|
|
|
|
res_type, response),
|
|
|
|
OfflineImapError.ERROR.FOLDER)
|
2002-07-04 03:35:05 +02:00
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
2011-08-18 09:08:55 +02:00
|
|
|
|
2002-06-20 08:26:28 +02:00
|
|
|
for messagestr in response:
|
2011-09-05 14:03:09 +02:00
|
|
|
# looks like: '1 (FLAGS (\\Seen Old) UID 4807)' or None if no msg
|
2011-08-16 12:16:46 +02:00
|
|
|
# Discard initial message number.
|
2011-09-05 14:03:09 +02:00
|
|
|
if messagestr == None:
|
|
|
|
continue
|
2011-01-31 15:50:18 +01:00
|
|
|
messagestr = messagestr.split(' ', 1)[1]
|
2002-06-20 08:26:28 +02:00
|
|
|
options = imaputil.flags2hash(messagestr)
|
2002-10-30 05:26:49 +01:00
|
|
|
if not options.has_key('UID'):
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.warn('No UID in message with options %s' %\
|
2002-10-30 05:26:49 +01:00
|
|
|
str(options),
|
|
|
|
minor = 1)
|
|
|
|
else:
|
|
|
|
uid = long(options['UID'])
|
|
|
|
flags = imaputil.flagsimap2maildir(options['FLAGS'])
|
2007-07-04 19:51:57 +02:00
|
|
|
rtime = imaplibutil.Internaldate2epoch(messagestr)
|
2006-08-22 03:09:36 +02:00
|
|
|
self.messagelist[uid] = {'uid': uid, 'flags': flags, 'time': rtime}
|
2002-06-20 09:40:29 +02:00
|
|
|
|
|
|
|
def getmessagelist(self):
|
|
|
|
return self.messagelist
|
|
|
|
|
2002-06-20 13:39:27 +02:00
|
|
|
def getmessage(self, uid):
|
2011-04-26 15:18:54 +02:00
|
|
|
"""Retrieve message with UID from the IMAP server (incl body)
|
|
|
|
|
2011-06-15 10:59:00 +02:00
|
|
|
:returns: the message body or throws and OfflineImapError
|
|
|
|
(probably severity MESSAGE) if e.g. no message with
|
|
|
|
this UID could be found.
|
2011-04-26 15:18:54 +02:00
|
|
|
"""
|
2002-07-04 03:35:05 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
|
|
|
try:
|
2011-09-05 10:27:47 +02:00
|
|
|
fails_left = 2 # retry on dropped connection
|
|
|
|
while fails_left:
|
|
|
|
try:
|
|
|
|
imapobj.select(self.getfullname(), readonly = 1)
|
|
|
|
res_type, data = imapobj.uid('fetch', str(uid),
|
|
|
|
'(BODY.PEEK[])')
|
|
|
|
fails_left = 0
|
|
|
|
except imapobj.abort(), e:
|
|
|
|
# Release dropped connection, and get a new one
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
|
|
|
imapobj = self.imapserver.acquireconnection()
|
|
|
|
self.ui.error(e, exc_info()[2])
|
|
|
|
fails_left -= 1
|
|
|
|
if not fails_left:
|
|
|
|
raise e
|
2011-06-15 10:59:00 +02:00
|
|
|
if data == [None] or res_type != 'OK':
|
|
|
|
#IMAP server says bad request or UID does not exist
|
|
|
|
severity = OfflineImapError.ERROR.MESSAGE
|
2011-08-15 11:00:07 +02:00
|
|
|
reason = "IMAP server '%s' failed to fetch message UID '%d'."\
|
|
|
|
"Server responded: %s %s" % (self.getrepository(), uid,
|
|
|
|
res_type, data)
|
2011-06-15 10:59:00 +02:00
|
|
|
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)
|
2011-05-08 22:46:08 +02:00
|
|
|
# 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]
|
|
|
|
data = data[0][1].replace("\r\n", "\n")
|
|
|
|
|
|
|
|
if len(data)>200:
|
|
|
|
dbg_output = "%s...%s" % (str(data)[:150],
|
|
|
|
str(data)[-50:])
|
|
|
|
else:
|
|
|
|
dbg_output = data
|
|
|
|
self.ui.debug('imap', "Returned object from fetching %d: '%s'" %
|
|
|
|
(uid, dbg_output))
|
2002-07-04 03:35:05 +02:00
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
2011-05-08 22:46:08 +02:00
|
|
|
return data
|
2006-08-22 03:09:36 +02:00
|
|
|
|
|
|
|
def getmessagetime(self, uid):
|
|
|
|
return self.messagelist[uid]['time']
|
2011-04-11 18:33:11 +02:00
|
|
|
|
2002-06-20 13:39:27 +02:00
|
|
|
def getmessageflags(self, uid):
|
2002-07-04 03:35:05 +02:00
|
|
|
return self.messagelist[uid]['flags']
|
2003-04-18 04:18:34 +02:00
|
|
|
|
2011-03-04 17:34:20 +01:00
|
|
|
def generate_randomheader(self, content):
|
|
|
|
"""Returns a unique X-OfflineIMAP header
|
|
|
|
|
|
|
|
Generate an 'X-OfflineIMAP' mail header which contains a random
|
|
|
|
unique value (which is based on the mail content, and a random
|
|
|
|
number). This header allows us to fetch a mail after APPENDing
|
|
|
|
it to an IMAP server and thus find out the UID that the server
|
|
|
|
assigned it.
|
|
|
|
|
|
|
|
:returns: (headername, headervalue) tuple, consisting of strings
|
|
|
|
headername == 'X-OfflineIMAP' and headervalue will be a
|
|
|
|
random string
|
|
|
|
"""
|
2010-10-07 12:33:27 +02:00
|
|
|
headername = 'X-OfflineIMAP'
|
2011-03-04 17:34:20 +01:00
|
|
|
# We need a random component too. If we ever upload the same
|
|
|
|
# mail twice (e.g. in different folders), we would still need to
|
|
|
|
# get the UID for the correct one. As we won't have too many
|
|
|
|
# mails with identical content, the randomness requirements are
|
|
|
|
# not extremly critial though.
|
|
|
|
|
|
|
|
# compute unsigned crc32 of 'content' as unique hash
|
|
|
|
# NB: crc32 returns unsigned only starting with python 3.0
|
|
|
|
headervalue = str( binascii.crc32(content) & 0xffffffff ) + '-'
|
|
|
|
headervalue += str(self.randomgenerator.randint(0,9999999999))
|
2003-04-18 04:18:34 +02:00
|
|
|
return (headername, headervalue)
|
|
|
|
|
2011-03-04 17:34:22 +01:00
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def savemessage_addheader(self, content, headername, headervalue):
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap',
|
2003-05-06 20:41:13 +02:00
|
|
|
'savemessage_addheader: called to add %s: %s' % (headername,
|
|
|
|
headervalue))
|
2011-07-26 10:59:53 +02:00
|
|
|
insertionpoint = content.find("\r\n\r\n")
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_addheader: insertionpoint = %d' % insertionpoint)
|
2004-06-15 16:43:14 +02:00
|
|
|
leader = content[0:insertionpoint]
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_addheader: leader = %s' % repr(leader))
|
2004-06-15 16:43:14 +02:00
|
|
|
if insertionpoint == 0 or insertionpoint == -1:
|
|
|
|
newline = ''
|
|
|
|
insertionpoint = 0
|
2003-05-06 20:41:13 +02:00
|
|
|
else:
|
2004-06-15 16:43:14 +02:00
|
|
|
newline = "\r\n"
|
|
|
|
newline += "%s: %s" % (headername, headervalue)
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_addheader: newline = ' + repr(newline))
|
2004-06-15 16:43:14 +02:00
|
|
|
trailer = content[insertionpoint:]
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_addheader: trailer = ' + repr(trailer))
|
2004-06-15 16:43:14 +02:00
|
|
|
return leader + newline + trailer
|
2003-04-18 04:18:34 +02:00
|
|
|
|
2011-03-04 17:34:22 +01:00
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def savemessage_searchforheader(self, imapobj, headername, headervalue):
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_searchforheader called for %s: %s' % \
|
2003-05-06 20:41:13 +02:00
|
|
|
(headername, headervalue))
|
2003-04-18 04:18:34 +02:00
|
|
|
# Now find the UID it got.
|
|
|
|
headervalue = imapobj._quote(headervalue)
|
|
|
|
try:
|
2006-05-01 21:40:55 +02:00
|
|
|
matchinguids = imapobj.uid('search', 'HEADER', headername, headervalue)[1][0]
|
2006-05-15 04:51:12 +02:00
|
|
|
except imapobj.error, err:
|
2003-04-18 04:18:34 +02:00
|
|
|
# IMAP server doesn't implement search or had a problem.
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', "savemessage_searchforheader: got IMAP error '%s' while attempting to UID SEARCH for message with header %s" % (err, headername))
|
2006-05-16 04:34:46 +02:00
|
|
|
return 0
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_searchforheader got initial matchinguids: ' + repr(matchinguids))
|
2006-05-15 04:51:12 +02:00
|
|
|
|
|
|
|
if matchinguids == '':
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', "savemessage_searchforheader: UID SEARCH for message with header %s yielded no results" % headername)
|
2006-05-16 04:34:46 +02:00
|
|
|
return 0
|
2006-05-15 04:51:12 +02:00
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
matchinguids = matchinguids.split(' ')
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage_searchforheader: matchinguids now ' + \
|
2003-05-06 20:41:13 +02:00
|
|
|
repr(matchinguids))
|
2003-04-18 04:18:34 +02:00
|
|
|
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])
|
|
|
|
|
2011-08-16 10:55:14 +02:00
|
|
|
def savemessage_fetchheaders(self, imapobj, headername, headervalue):
|
|
|
|
""" We fetch all new mail headers and search for the right
|
|
|
|
X-OfflineImap line by hand. The response from the server has form:
|
|
|
|
(
|
|
|
|
'OK',
|
|
|
|
[
|
|
|
|
(
|
|
|
|
'185 (RFC822.HEADER {1789}',
|
|
|
|
'... mail headers ...'
|
|
|
|
),
|
|
|
|
' UID 2444)',
|
|
|
|
(
|
|
|
|
'186 (RFC822.HEADER {1789}',
|
|
|
|
'... 2nd mail headers ...'
|
|
|
|
),
|
|
|
|
' UID 2445)'
|
|
|
|
]
|
|
|
|
)
|
|
|
|
We need to locate the UID just after mail headers containing our
|
|
|
|
X-OfflineIMAP line.
|
|
|
|
|
|
|
|
Returns UID when found, 0 when not found.
|
|
|
|
"""
|
|
|
|
self.ui.debug('imap', 'savemessage_fetchheaders called for %s: %s' % \
|
|
|
|
(headername, headervalue))
|
|
|
|
|
|
|
|
# run "fetch X:* rfc822.header"
|
|
|
|
# since we stored the mail we are looking for just recently, it would
|
|
|
|
# not be optimal to fetch all messages. So we'll find highest message
|
|
|
|
# UID in our local messagelist and search from there (exactly from
|
|
|
|
# UID+1). That works because UIDs are guaranteed to be unique and
|
|
|
|
# ascending.
|
|
|
|
|
|
|
|
if self.getmessagelist():
|
|
|
|
start = 1+max(self.getmessagelist().keys())
|
|
|
|
else:
|
|
|
|
# Folder was empty - start from 1
|
|
|
|
start = 1
|
|
|
|
|
|
|
|
# Imaplib quotes all parameters of a string type. That must not happen
|
|
|
|
# with the range X:*. So we use bytearray to stop imaplib from getting
|
|
|
|
# in our way
|
|
|
|
|
|
|
|
result = imapobj.uid('FETCH', bytearray('%d:*' % start), 'rfc822.header')
|
|
|
|
if result[0] != 'OK':
|
|
|
|
raise OfflineImapError('Error fetching mail headers: ' + '. '.join(result[1]),
|
|
|
|
OfflineImapError.ERROR.MESSAGE)
|
|
|
|
|
|
|
|
result = result[1]
|
|
|
|
|
|
|
|
found = 0
|
|
|
|
for item in result:
|
|
|
|
if found == 0 and type(item) == type( () ):
|
|
|
|
# Walk just tuples
|
|
|
|
if re.search("(?:^|\\r|\\n)%s:\s*%s(?:\\r|\\n)" % (headername, headervalue),
|
|
|
|
item[1], flags=re.IGNORECASE):
|
|
|
|
found = 1
|
|
|
|
elif found == 1:
|
|
|
|
if type(item) == type (""):
|
|
|
|
uid = re.search("UID\s+(\d+)", item, flags=re.IGNORECASE)
|
|
|
|
if uid:
|
|
|
|
return int(uid.group(1))
|
|
|
|
else:
|
|
|
|
self.ui.warn("Can't parse FETCH response, can't find UID: %s", result.__repr__())
|
|
|
|
else:
|
|
|
|
self.ui.warn("Can't parse FETCH response, we awaited string: %s", result.__repr__())
|
|
|
|
|
|
|
|
return 0
|
2011-03-04 17:34:21 +01:00
|
|
|
|
|
|
|
def getmessageinternaldate(self, content, rtime=None):
|
|
|
|
"""Parses mail and returns an INTERNALDATE string
|
|
|
|
|
|
|
|
It will use information in the following order, falling back as an attempt fails:
|
|
|
|
- rtime parameter
|
|
|
|
- Date header of email
|
|
|
|
|
|
|
|
We return None, if we couldn't find a valid date. In this case
|
|
|
|
the IMAP server will use the server local time when appening
|
|
|
|
(per RFC).
|
|
|
|
|
|
|
|
Note, that imaplib's Time2Internaldate is inherently broken as
|
|
|
|
it returns localized date strings which are invalid for IMAP
|
|
|
|
servers. However, that function is called for *every* append()
|
|
|
|
internally. So we need to either pass in `None` or the correct
|
|
|
|
string (in which case Time2Internaldate() will do nothing) to
|
|
|
|
append(). The output of this function is designed to work as
|
|
|
|
input to the imapobj.append() function.
|
|
|
|
|
|
|
|
TODO: We should probably be returning a bytearray rather than a
|
|
|
|
string here, because the IMAP server will expect plain
|
|
|
|
ASCII. However, imaplib.Time2INternaldate currently returns a
|
|
|
|
string so we go with the same for now.
|
|
|
|
|
|
|
|
:param rtime: epoch timestamp to be used rather than analyzing
|
|
|
|
the email.
|
|
|
|
:returns: string in the form of "DD-Mmm-YYYY HH:MM:SS +HHMM"
|
|
|
|
(including double quotes) or `None` in case of failure
|
|
|
|
(which is fine as value for append)."""
|
|
|
|
if rtime is None:
|
2011-03-12 14:05:28 +01:00
|
|
|
message = email.message_from_string(content)
|
2011-03-04 17:34:21 +01:00
|
|
|
# parsedate returns a 9-tuple that can be passed directly to
|
|
|
|
# time.mktime(); Will be None if missing or not in a valid
|
|
|
|
# format. Note that indexes 6, 7, and 8 of the result tuple are
|
|
|
|
# not usable.
|
2011-03-12 14:05:28 +01:00
|
|
|
datetuple = email.utils.parsedate(message.get('Date'))
|
2011-03-04 17:34:21 +01:00
|
|
|
if datetuple is None:
|
|
|
|
#could not determine the date, use the local time.
|
|
|
|
return None
|
2011-03-12 14:05:28 +01:00
|
|
|
#make it a real struct_time, so we have named attributes
|
|
|
|
datetuple = time.struct_time(datetuple)
|
2011-03-04 17:34:21 +01:00
|
|
|
else:
|
|
|
|
#rtime is set, use that instead
|
|
|
|
datetuple = time.localtime(rtime)
|
|
|
|
|
|
|
|
try:
|
|
|
|
# Check for invalid dates
|
|
|
|
if datetuple[0] < 1981:
|
|
|
|
raise ValueError
|
|
|
|
|
|
|
|
# Check for invalid dates
|
|
|
|
datetuple_check = time.localtime(time.mktime(datetuple))
|
|
|
|
if datetuple[:2] != datetuple_check[:2]:
|
|
|
|
raise ValueError
|
|
|
|
|
|
|
|
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.
|
2011-03-27 00:43:37 +01:00
|
|
|
self.ui.debug('imap', "Message with invalid date %s. Server will use local time." \
|
2011-03-12 14:05:28 +01:00
|
|
|
% datetuple)
|
2011-03-04 17:34:21 +01:00
|
|
|
return None
|
|
|
|
|
|
|
|
#produce a string representation of datetuple that works as
|
|
|
|
#INTERNALDATE
|
|
|
|
num2mon = {1:'Jan', 2:'Feb', 3:'Mar', 4:'Apr', 5:'May', 6:'Jun',
|
|
|
|
7:'Jul', 8:'Aug', 9:'Sep', 10:'Oct', 11:'Nov', 12:'Dec'}
|
|
|
|
|
2011-03-12 14:05:28 +01:00
|
|
|
#tm_isdst coming from email.parsedate is not usable, we still use it here, mhh
|
2011-03-04 17:34:21 +01:00
|
|
|
if datetuple.tm_isdst == '1':
|
|
|
|
zone = -time.altzone
|
|
|
|
else:
|
|
|
|
zone = -time.timezone
|
|
|
|
offset_h, offset_m = divmod(zone//60, 60)
|
|
|
|
|
|
|
|
internaldate = '"%02d-%s-%04d %02d:%02d:%02d %+03d%02d"' \
|
|
|
|
% (datetuple.tm_mday, num2mon[datetuple.tm_mon], datetuple.tm_year, \
|
|
|
|
datetuple.tm_hour, datetuple.tm_min, datetuple.tm_sec, offset_h, offset_m)
|
|
|
|
|
|
|
|
return internaldate
|
|
|
|
|
2006-08-22 03:09:36 +02:00
|
|
|
def savemessage(self, uid, content, flags, rtime):
|
2011-03-04 17:34:21 +01:00
|
|
|
"""Save the message on the Server
|
|
|
|
|
|
|
|
This backend always assigns a new uid, so the uid arg is ignored.
|
|
|
|
|
|
|
|
This function will update the self.messagelist dict to contain
|
|
|
|
the new message after sucessfully saving it.
|
|
|
|
|
2011-03-04 17:34:23 +01:00
|
|
|
:param rtime: A timestamp to be used as the mail date
|
2011-07-26 10:59:54 +02:00
|
|
|
:returns: the UID of the new message as assigned by the server. If the
|
|
|
|
message is saved, but it's UID can not be found, it will
|
|
|
|
return 0. If the message can't be written (folder is
|
|
|
|
read-only for example) it will return -1."""
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.debug('imap', 'savemessage: called')
|
2011-03-04 17:34:21 +01:00
|
|
|
|
2011-03-16 16:03:35 +01:00
|
|
|
# already have it, just save modified flags
|
2011-03-28 16:19:20 +02:00
|
|
|
if uid > 0 and self.uidexists(uid):
|
2011-03-16 16:03:35 +01:00
|
|
|
self.savemessageflags(uid, flags)
|
|
|
|
return uid
|
|
|
|
|
2011-09-06 13:19:26 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
2002-07-04 03:35:05 +02:00
|
|
|
try:
|
2011-09-06 13:19:26 +02:00
|
|
|
success = False # succeeded in APPENDING?
|
|
|
|
while not success:
|
|
|
|
|
|
|
|
# UIDPLUS extension provides us with an APPENDUID response.
|
|
|
|
use_uidplus = 'UIDPLUS' in imapobj.capabilities
|
|
|
|
|
|
|
|
# get the date of the message, so we can pass it to the server.
|
|
|
|
date = self.getmessageinternaldate(content, rtime)
|
|
|
|
content = re.sub("(?<!\r)\n", "\r\n", content)
|
|
|
|
|
|
|
|
if not use_uidplus:
|
|
|
|
# insert a random unique header that we can fetch later
|
|
|
|
(headername, headervalue) = self.generate_randomheader(
|
|
|
|
content)
|
|
|
|
self.ui.debug('imap', 'savemessage: header is: %s: %s' %\
|
|
|
|
(headername, headervalue))
|
|
|
|
content = self.savemessage_addheader(content, headername,
|
|
|
|
headervalue)
|
|
|
|
if len(content)>200:
|
|
|
|
dbg_output = "%s...%s" % (content[:150], content[-50:])
|
|
|
|
else:
|
|
|
|
dbg_output = content
|
|
|
|
self.ui.debug('imap', "savemessage: date: %s, content: '%s'" %
|
|
|
|
(date, dbg_output))
|
2011-03-04 17:34:23 +01:00
|
|
|
|
2011-09-06 13:19:26 +02:00
|
|
|
try:
|
|
|
|
# Select folder for append and make the box READ-WRITE
|
|
|
|
imapobj.select(self.getfullname())
|
|
|
|
except imapobj.readonly:
|
|
|
|
# readonly exception. Return original uid to notify that
|
|
|
|
# we did not save the message. (see savemessage in Base.py)
|
|
|
|
self.ui.msgtoreadonly(self, uid, content, flags)
|
|
|
|
return uid
|
|
|
|
|
|
|
|
#Do the APPEND
|
|
|
|
try:
|
|
|
|
(typ, dat) = imapobj.append(self.getfullname(),
|
2002-07-04 03:35:05 +02:00
|
|
|
imaputil.flagsmaildir2imap(flags),
|
2011-03-04 17:34:22 +01:00
|
|
|
date, content)
|
2011-09-06 13:19:26 +02:00
|
|
|
success = True
|
|
|
|
except imapobj.abort, e:
|
|
|
|
# connection has been reset, release connection and retry.
|
|
|
|
self.ui.error(e, exc_info()[2])
|
|
|
|
self.imapserver.releaseconnection(imapobj, True)
|
|
|
|
imapobj = self.imapserver.acquireconnection()
|
|
|
|
except imapobj.error, e:
|
|
|
|
# If the server responds with 'BAD', append() raise()s directly.
|
|
|
|
# So we need to prepare a response ourselves.
|
|
|
|
typ, dat = 'BAD', str(e)
|
|
|
|
if typ != 'OK': #APPEND failed
|
|
|
|
raise OfflineImapError("Saving msg in folder '%s', repository "
|
|
|
|
"'%s' failed. Server reponded; %s %s\nMessage content was:"
|
|
|
|
" %s" % (self, self.getrepository(), typ, dat, dbg_output),
|
|
|
|
OfflineImapError.ERROR.MESSAGE)
|
2011-08-11 12:22:36 +02:00
|
|
|
# Checkpoint. Let it write out stuff, etc. Eg searches for
|
|
|
|
# just uploaded messages won't work if we don't do this.
|
2011-03-04 17:34:22 +01:00
|
|
|
(typ,dat) = imapobj.check()
|
|
|
|
assert(typ == 'OK')
|
2003-04-18 04:18:34 +02:00
|
|
|
|
2011-03-25 10:19:30 +01:00
|
|
|
# get the new UID. Test for APPENDUID response even if the
|
|
|
|
# server claims to not support it, as e.g. Gmail does :-(
|
|
|
|
if use_uidplus or imapobj._get_untagged_response('APPENDUID', True):
|
2011-03-04 17:34:23 +01:00
|
|
|
# get the new UID from the APPENDUID response, it could look like
|
|
|
|
# OK [APPENDUID 38505 3955] APPEND completed
|
|
|
|
# with 38505 bein folder UIDvalidity and 3955 the new UID
|
Update to match semantics of new imaplib2
The biggest change here is that imapobj.untagged_responses is no
longer a dictionary, but a list. To access it, I use the semi-private
_get_untagged_response method.
* offlineimap/folder/IMAP.py (IMAPFolder.quickchanged,
IMAPFolder.cachemessagelist): imaplib2 now explicitly removes its
EXISTS response on select(), so instead we use the return values from
select() to get the number of messages.
* offlineimap/imapserver.py (UsefulIMAPMixIn.select): imaplib2 now
stores untagged_responses for different mailboxes, which confuses us
because it seems like our mailboxes are "still" in read-only mode when
we just re-opened them. Additionally, we have to return the value
from imaplib2's select() so that the above thing works.
* offlineimap/imapserver.py (UsefulIMAPMixIn._mesg): imaplib2 now
calls _mesg with the name of a thread, so we display this
information in debug output. This requires a corresponding change to
imaplibutil.new_mesg.
* offlineimap/imaplibutil.py: We override IMAP4_SSL.open, whose
default arguments have changed, so update the default arguments. We
also subclass imaplib.IMAP4 in a few different places, which now
relies on having a read_fd file descriptor to poll on.
Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-10 21:36:20 +01:00
|
|
|
if not imapobj._get_untagged_response('APPENDUID', True):
|
|
|
|
self.ui.warn("Server supports UIDPLUS but got no APPENDUID "
|
|
|
|
"appending a message.")
|
2011-03-04 17:34:23 +01:00
|
|
|
return 0
|
Update to match semantics of new imaplib2
The biggest change here is that imapobj.untagged_responses is no
longer a dictionary, but a list. To access it, I use the semi-private
_get_untagged_response method.
* offlineimap/folder/IMAP.py (IMAPFolder.quickchanged,
IMAPFolder.cachemessagelist): imaplib2 now explicitly removes its
EXISTS response on select(), so instead we use the return values from
select() to get the number of messages.
* offlineimap/imapserver.py (UsefulIMAPMixIn.select): imaplib2 now
stores untagged_responses for different mailboxes, which confuses us
because it seems like our mailboxes are "still" in read-only mode when
we just re-opened them. Additionally, we have to return the value
from imaplib2's select() so that the above thing works.
* offlineimap/imapserver.py (UsefulIMAPMixIn._mesg): imaplib2 now
calls _mesg with the name of a thread, so we display this
information in debug output. This requires a corresponding change to
imaplibutil.new_mesg.
* offlineimap/imaplibutil.py: We override IMAP4_SSL.open, whose
default arguments have changed, so update the default arguments. We
also subclass imaplib.IMAP4 in a few different places, which now
relies on having a read_fd file descriptor to poll on.
Signed-off-by: Ethan Glasser-Camp <ethan@betacantrips.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-10 21:36:20 +01:00
|
|
|
uid = long(imapobj._get_untagged_response('APPENDUID', True)[-1].split(' ')[1])
|
2011-03-04 17:34:23 +01:00
|
|
|
|
|
|
|
else:
|
|
|
|
# we don't support UIDPLUS
|
2003-04-18 04:18:34 +02:00
|
|
|
uid = self.savemessage_searchforheader(imapobj, headername,
|
|
|
|
headervalue)
|
2011-03-04 17:34:23 +01:00
|
|
|
# See docs for savemessage in Base.py for explanation of this and other return values
|
|
|
|
if uid == 0:
|
2011-08-16 10:55:14 +02:00
|
|
|
self.ui.debug('imap', 'savemessage: first attempt to get new UID failed. \
|
|
|
|
Going to run a NOOP and try again.')
|
2011-03-04 17:34:23 +01:00
|
|
|
assert(imapobj.noop()[0] == 'OK')
|
|
|
|
uid = self.savemessage_searchforheader(imapobj, headername,
|
|
|
|
headervalue)
|
2011-08-16 10:55:14 +02:00
|
|
|
if uid == 0:
|
|
|
|
self.ui.debug('imap', 'savemessage: second attempt to get new UID failed. \
|
|
|
|
Going to try search headers manually')
|
|
|
|
uid = self.savemessage_fetchheaders(imapobj, headername, headervalue)
|
2011-03-04 17:34:23 +01:00
|
|
|
|
2002-07-04 03:35:05 +02:00
|
|
|
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
|
|
|
|
2011-03-04 17:34:23 +01:00
|
|
|
self.ui.debug('imap', 'savemessage: returning new UID %d' % uid)
|
2003-04-18 04:18:34 +02:00
|
|
|
return uid
|
|
|
|
|
2011-03-04 17:34:23 +01:00
|
|
|
|
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()
|
2002-07-04 03:35:05 +02:00
|
|
|
try:
|
2002-08-08 03:57:17 +02:00
|
|
|
try:
|
|
|
|
imapobj.select(self.getfullname())
|
|
|
|
except imapobj.readonly:
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.flagstoreadonly(self, [uid], flags)
|
2002-08-08 03:57:17 +02:00
|
|
|
return
|
2002-07-04 03:35:05 +02:00
|
|
|
result = imapobj.uid('store', '%d' % uid, 'FLAGS',
|
2002-07-12 15:20:09 +02:00
|
|
|
imaputil.flagsmaildir2imap(flags))
|
2011-07-26 10:59:55 +02:00
|
|
|
assert result[0] == 'OK', 'Error with store: ' + '. '.join(result[1])
|
2002-07-04 03:35:05 +02:00
|
|
|
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
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def addmessagesflags_noconvert(self, uidlist, flags):
|
2003-01-09 03:16:07 +01:00
|
|
|
self.processmessagesflags('+', uidlist, flags)
|
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
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)
|
|
|
|
|
2003-01-09 03:16:07 +01:00
|
|
|
def deletemessageflags(self, uid, flags):
|
|
|
|
self.deletemessagesflags([uid], flags)
|
|
|
|
|
|
|
|
def deletemessagesflags(self, uidlist, flags):
|
|
|
|
self.processmessagesflags('-', uidlist, flags)
|
|
|
|
|
|
|
|
def processmessagesflags(self, operation, uidlist, flags):
|
2004-11-16 23:41:09 +01:00
|
|
|
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
|
2011-04-11 18:33:11 +02:00
|
|
|
|
2002-07-04 04:14:07 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
2002-07-04 03:35:05 +02:00
|
|
|
try:
|
2002-08-08 03:57:17 +02:00
|
|
|
try:
|
|
|
|
imapobj.select(self.getfullname())
|
|
|
|
except imapobj.readonly:
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.flagstoreadonly(self, uidlist, flags)
|
2008-03-04 04:20:53 +01:00
|
|
|
return
|
2002-07-04 03:35:05 +02:00
|
|
|
r = imapobj.uid('store',
|
2011-08-22 12:21:11 +02:00
|
|
|
imaputil.uid_sequence(uidlist),
|
2003-01-09 03:16:07 +01:00
|
|
|
operation + 'FLAGS',
|
2002-07-12 01:35:51 +02:00
|
|
|
imaputil.flagsmaildir2imap(flags))
|
2007-07-07 05:51:02 +02:00
|
|
|
assert r[0] == 'OK', 'Error with store: ' + '. '.join(r[1])
|
2002-07-12 01:35:51 +02:00
|
|
|
r = r[1]
|
2002-07-04 03:35:05 +02:00
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
2002-07-12 01:35:51 +02:00
|
|
|
# Some IMAP servers do not always return a result. Therefore,
|
|
|
|
# only update the ones that it talks about, and manually fix
|
|
|
|
# the others.
|
2011-09-06 13:27:48 +02:00
|
|
|
needupdate = list(uidlist)
|
2002-07-03 07:05:49 +02:00
|
|
|
for result in r:
|
2002-07-12 01:35:51 +02:00
|
|
|
if result == None:
|
2002-07-12 04:04:04 +02:00
|
|
|
# Compensate for servers that don't return anything from
|
|
|
|
# STORE.
|
2002-07-12 01:35:51 +02:00
|
|
|
continue
|
2002-07-12 04:04:04 +02:00
|
|
|
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
|
2011-08-16 12:16:46 +02:00
|
|
|
flagstr = attributehash['FLAGS']
|
2002-07-12 04:04:04 +02:00
|
|
|
uid = long(attributehash['UID'])
|
2011-08-16 12:16:46 +02:00
|
|
|
self.messagelist[uid]['flags'] = imaputil.flagsimap2maildir(flagstr)
|
2002-07-12 01:35:51 +02:00
|
|
|
try:
|
|
|
|
needupdate.remove(uid)
|
|
|
|
except ValueError: # Let it slide if it's not in the list
|
|
|
|
pass
|
|
|
|
for uid in needupdate:
|
2003-01-09 03:16:07 +01:00
|
|
|
if operation == '+':
|
2011-08-16 12:16:46 +02:00
|
|
|
self.messagelist[uid]['flags'] |= flags
|
2003-01-09 03:16:07 +01:00
|
|
|
elif operation == '-':
|
2011-08-16 12:16:46 +02:00
|
|
|
self.messagelist[uid]['flags'] -= flags
|
2002-07-03 07:05:49 +02:00
|
|
|
|
2002-06-21 03:55:06 +02:00
|
|
|
def deletemessage(self, uid):
|
2003-04-18 04:18:34 +02:00
|
|
|
self.deletemessages_noconvert([uid])
|
2002-07-03 07:05:49 +02:00
|
|
|
|
2002-07-03 07:16:56 +02:00
|
|
|
def deletemessages(self, uidlist):
|
2003-04-18 04:18:34 +02:00
|
|
|
self.deletemessages_noconvert(uidlist)
|
|
|
|
|
|
|
|
def deletemessages_noconvert(self, uidlist):
|
2002-07-03 07:05:49 +02:00
|
|
|
# Weed out ones not in self.messagelist
|
2011-05-07 11:11:20 +02:00
|
|
|
uidlist = [uid for uid in uidlist if self.uidexists(uid)]
|
2002-07-03 07:05:49 +02:00
|
|
|
if not len(uidlist):
|
2011-04-11 18:33:11 +02:00
|
|
|
return
|
2002-07-04 03:35:05 +02:00
|
|
|
|
2011-08-16 12:16:46 +02:00
|
|
|
self.addmessagesflags_noconvert(uidlist, set('T'))
|
2002-07-04 03:35:05 +02:00
|
|
|
imapobj = self.imapserver.acquireconnection()
|
|
|
|
try:
|
2008-03-04 15:13:48 +01:00
|
|
|
try:
|
|
|
|
imapobj.select(self.getfullname())
|
|
|
|
except imapobj.readonly:
|
2011-01-05 17:00:57 +01:00
|
|
|
self.ui.deletereadonly(self, uidlist)
|
2002-08-08 03:57:17 +02:00
|
|
|
return
|
2002-11-12 22:36:34 +01:00
|
|
|
if self.expunge:
|
|
|
|
assert(imapobj.expunge()[0] == 'OK')
|
2002-07-04 03:35:05 +02:00
|
|
|
finally:
|
|
|
|
self.imapserver.releaseconnection(imapobj)
|
2002-07-03 07:05:49 +02:00
|
|
|
for uid in uidlist:
|
2002-07-12 01:35:51 +02:00
|
|
|
del self.messagelist[uid]
|
2011-04-11 18:33:11 +02:00
|
|
|
|
|
|
|
|