]> code.delx.au - offlineimap/blobdiff - head/offlineimap/folder/Maildir.py
Step 1 of converting tree to Arch layout
[offlineimap] / head / offlineimap / folder / Maildir.py
index 2ff9203c98805d53f14e93b071f5197a8aaac9fb..3b7b0554530d5840e9cfcc2ed553ec39d1b0bbda 100644 (file)
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 from Base import BaseFolder
-from imapsync import imaputil
-import os.path, os, re, time, socket
+from offlineimap import imaputil
+from offlineimap.ui import UIBase
+from threading import Lock
+import os.path, os, re, time, socket, md5
+
+foldermatchre = re.compile(',FMD5=([0-9a-f]{32})')
+uidmatchre = re.compile(',U=(\d+)')
+flagmatchre = re.compile(':.*2,([A-Z]+)')
+
+timeseq = 0
+lasttime = long(0)
+timelock = Lock()
+
+def gettimeseq():
+    global lasttime, timeseq, timelock
+    timelock.acquire()
+    try:
+        thistime = long(time.time())
+        if thistime == lasttime:
+            timeseq += 1
+            return (thistime, timeseq)
+        else:
+            lasttime = thistime
+            timeseq = 0
+            return (thistime, timeseq)
+    finally:
+        timelock.release()
 
 class MaildirFolder(BaseFolder):
-    def __init__(self, root, name):
+    def __init__(self, root, name, sep, repository, accountname):
         self.name = name
         self.root = root
-        self.sep = '.'
-        self.uidfilename = os.path.join(self.getfullname(), "imapsync.uidvalidity")
+        self.sep = sep
         self.messagelist = None
+        self.repository = repository
+        self.accountname = accountname
+        BaseFolder.__init__(self)
+
+    def getaccountname(self):
+        return self.accountname
 
     def getfullname(self):
         return os.path.join(self.getroot(), self.getname())
 
     def getuidvalidity(self):
-        if not os.path.exists(self.uidfilename):
-            return None
-        file = open(self.uidfilename, "rt")
-        retval = long(file.readline().strip())
-        file.close()
-        return retval
-
-    def saveuidvalidity(self, newval):
-        file = open(self.uidfilename, "wt")
-        file.write("%d\n", newval)
-        file.close()
+        """Maildirs have no notion of uidvalidity, so we just return a magic
+        token."""
+        return 42
 
-    def isuidvalidityok(self, remotefolder):
-        myval = self.getuidvalidity()
-        if myval != None:
-            return myval == remotefolder.getuidvalidity()
-        else:
-            self.saveuidvalidity(remotefolder.getuidvalidity())
-            
-    def cachemessagelist(self):
+    def _scanfolder(self):
         """Cache the message list.  Maildir flags are:
         R (replied)
         S (seen)
@@ -59,7 +74,7 @@ class MaildirFolder(BaseFolder):
         D (draft)
         F (flagged)
         and must occur in ASCII order."""
-        self.messagelist = {}
+        retval = {}
         files = []
         nouidcounter = -1               # Messages without UIDs get
                                         # negative UID numbers.
@@ -69,75 +84,116 @@ class MaildirFolder(BaseFolder):
                           filename in os.listdir(fulldirname)])
         for file in files:
             messagename = os.path.basename(file)
-            uidmatch = re.search(',U=(\d+)', messagename)
-            uid = None
-            if not uidmatch:
+            foldermatch = foldermatchre.search(messagename)
+            if (not foldermatch) or \
+               md5.new(self.getvisiblename()).hexdigest() \
+               != foldermatch.group(1):
+                # If there is no folder MD5 specified, or if it mismatches,
+                # assume it is a foreign (new) message and generate a
+                # negative uid for it
                 uid = nouidcounter
                 nouidcounter -= 1
-            else:
-                uid = long(uidmatch.group(1))
-            flagmatch = re.search(':.*2,([A-Z]+)')
+            else:                       # It comes from our folder.
+                uidmatch = uidmatchre.search(messagename)
+                uid = None
+                if not uidmatch:
+                    uid = nouidcounter
+                    nouidcounter -= 1
+                else:
+                    uid = long(uidmatch.group(1))
+            flagmatch = flagmatchre.search(messagename)
             flags = []
             if flagmatch:
-                flags = [f for x in flagmatch.group(1)]
+                flags = [x for x in flagmatch.group(1)]
             flags.sort()
-            self.messagelist[uid] = {'uid': uid,
-                                     'flags': flags,
-                                     'filename': messagename}
+            retval[uid] = {'uid': uid,
+                           'flags': flags,
+                           'filename': file}
+        return retval
+
+    def cachemessagelist(self):
+        self.messagelist = self._scanfolder()
             
     def getmessagelist(self):
         return self.messagelist
 
     def getmessage(self, uid):
-        filename = self.getmessagelist()[uid]['filename']
+        filename = self.messagelist[uid]['filename']
         file = open(filename, 'rt')
         retval = file.read()
         file.close()
-        return retval
+        return retval.replace("\r\n", "\n")
 
-    def savemessage(self, uid, content):
-        if uid in self.getmessagelist():
+    def savemessage(self, uid, content, flags):
+        ui = UIBase.getglobalui()
+        ui.debug('maildir', 'savemessage: called to write with flags %s and content %s' % \
+                 (repr(flags), repr(content)))
+        if uid < 0:
+            # We cannot assign a new uid.
+            return uid
+        if uid in self.messagelist:
             # We already have it.
-            return
-        newdir = os.path.join(self.getfullname(), 'new')
+            self.savemessageflags(uid, flags)
+            return uid
+        if 'S' in flags:
+            # If a message has been seen, it goes into the cur
+            # directory.  CR debian#152482, [complete.org #4]
+            newdir = os.path.join(self.getfullname(), 'cur')
+        else:
+            newdir = os.path.join(self.getfullname(), 'new')
         tmpdir = os.path.join(self.getfullname(), 'tmp')
         messagename = None
         attempts = 0
         while 1:
             if attempts > 15:
                 raise IOError, "Couldn't write to file %s" % messagename
-            messagename = '%d.%d.%s,U=%d' % \
-                          (long(time.time()),
+            timeval, timeseq = gettimeseq()
+            messagename = '%d_%d.%d.%s,U=%d,FMD5=%s' % \
+                          (timeval,
+                           timeseq,
                            os.getpid(),
                            socket.gethostname(),
-                           uid)
+                           uid,
+                           md5.new(self.getvisiblename()).hexdigest())
             if os.path.exists(os.path.join(tmpdir, messagename)):
                 time.sleep(2)
                 attempts += 1
             else:
                 break
-        file = open(os.path.join(tmpdir, messagename), "wt")
+        tmpmessagename = messagename.split(',')[0]
+        ui.debug('maildir', 'savemessage: using temporary name %s' % tmpmessagename)
+        file = open(os.path.join(tmpdir, tmpmessagename), "wt")
         file.write(content)
         file.close()
-        os.link(os.path.join(tmpdir, messagename),
+        ui.debug('maildir', 'savemessage: moving from %s to %s' % \
+                 (tmpmessagename, messagename))
+        os.link(os.path.join(tmpdir, tmpmessagename),
                 os.path.join(newdir, messagename))
-        os.unlink(os.path.join(tmpdir, messagename))
+        os.unlink(os.path.join(tmpdir, tmpmessagename))
         self.messagelist[uid] = {'uid': uid, 'flags': [],
                                  'filename': os.path.join(newdir, messagename)}
-        
+        self.savemessageflags(uid, flags)
+        ui.debug('maildir', 'savemessage: returning uid %d' % uid)
+        return uid
         
     def getmessageflags(self, uid):
-        return self.getmessagelist()[uid]['flags']
+        return self.messagelist[uid]['flags']
 
     def savemessageflags(self, uid, flags):
-        oldfilename = self.getmessagelist()[uid]['filename']
+        oldfilename = self.messagelist[uid]['filename']
         newpath, newname = os.path.split(oldfilename)
+        if 'S' in flags:
+            # If a message has been seen, it goes into the cur
+            # directory.  CR debian#152482, [complete.org #4]
+            newpath = os.path.join(self.getfullname(), 'cur')
+        else:
+            newpath = os.path.join(self.getfullname(), 'new')
         infostr = ':'
         infomatch = re.search('(:.*)$', newname)
         if infomatch:                   # If the info string is present..
             infostr = infomatch.group(1)
             newname = newname.split(':')[0] # Strip off the info string.
-        re.sub('2,[A-Z]*', '', infostr)
+        infostr = re.sub('2,[A-Z]*', '', infostr)
         flags.sort()
         infostr += '2,' + ''.join(flags)
         newname += infostr
@@ -145,13 +201,20 @@ class MaildirFolder(BaseFolder):
         newfilename = os.path.join(newpath, newname)
         if (newfilename != oldfilename):
             os.rename(oldfilename, newfilename)
-            self.getmessagelist()[uid]['flags'] = flags
-
-    def getmessageflags(self, uid):
-        return self.getmessagelist()[uid]['flags']
+            self.messagelist[uid]['flags'] = flags
+            self.messagelist[uid]['filename'] = newfilename
 
     def deletemessage(self, uid):
-        filename = self.getmessagelist()[uid]['filename']
-        os.unlink(filename)
+        if not uid in self.messagelist:
+            return
+        filename = self.messagelist[uid]['filename']
+        try:
+            os.unlink(filename)
+        except OSError:
+            # Can't find the file -- maybe already deleted?
+            newmsglist = self._scanfolder()
+            if uid in newmsglist:       # Nope, try new filename.
+                os.unlink(newmsglist[uid]['filename'])
+            # Yep -- return.
         del(self.messagelist[uid])