fix: when called with -a, mbnames must not erase entries of other accounts

Make mbnames to work with intermediate files, one per account, in the JSON
format. The mbnames target is built from those intermediate files.

Github-Fix: https://github.com/OfflineIMAP/offlineimap/issues/66
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>

offlineimap/accounts.py

@@ -369,9 +369,7 @@ class SyncableAccount(Account):
             # wait for all threads to finish
             for thr in folderthreads:
                 thr.join()
-            # Write out mailbox names if required and not in dry-run mode
+            mbnames.writeIntermediateFile(self.name) # Write out mailbox names.
-            if not self.dryrun:
-                mbnames.write(False)
             localrepos.forgetfolders()
             remoterepos.forgetfolders()
         except:
@@ -512,9 +510,9 @@ def syncfolder(account, remotefolder, quick):
         # Load local folder.
         localfolder = account.get_local_folder(remotefolder)
 
-        # Write the mailboxes
+        # Add the folder to the mbnames mailboxes.
-        mbnames.add(account.name, localfolder.getname(),
+        mbnames.add(account.name, localrepos.getlocalroot(),
-            localrepos.getlocalroot())
+            localfolder.getname())
 
         # Load status folder.
         statusfolder = statusrepos.getfolder(remotefolder.getvisiblename().

offlineimap/globals.py

@@ -8,6 +8,6 @@ from offlineimap.utils import const
 options = const.ConstProxy()
 
 def set_options(source):
-    """ Sets the source for options variable """
+    """Sets the source for options variable."""
 
-    options.set_source (source)
+    options.set_source(source)

offlineimap/init.py

@@ -25,8 +25,7 @@ import logging
 from optparse import OptionParser
 
 import offlineimap
-from offlineimap import accounts, threadutil, folder
+from offlineimap import globals, accounts, threadutil, folder, mbnames
-from offlineimap import globals
 from offlineimap.ui import UI_LIST, setglobalui, getglobalui
 from offlineimap.CustomConfig import CustomConfigParser
 from offlineimap.utils import stacktrace
@@ -423,7 +422,7 @@ class OfflineImap(object):
             signal.signal(signal.SIGQUIT, sig_handler)
 
             # Various initializations that need to be performed:
-            offlineimap.mbnames.init(self.config, syncaccounts)
+            mbnames.init(self.config, self.ui, options.dryrun)
 
             if options.singlethreading:
                 # Singlethreaded.
@@ -440,9 +439,8 @@ class OfflineImap(object):
                 t.start()
                 threadutil.monitor()
 
-            if not options.dryrun:
+            # All sync are done.
-                offlineimap.mbnames.write(True)
+            mbnames.write()
-
             self.ui.terminate()
             return 0
         except (SystemExit):

offlineimap/mbnames.py

@@ -1,6 +1,5 @@
 # Mailbox name generator
-#
+# Copyright (C) 2002-2016 John Goerzen & contributors
-# Copyright (C) 2002-2015 John Goerzen & contributors
 #
 #    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
@@ -16,80 +15,200 @@
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 
-import os.path
+
-import re                               # for folderfilter
+import re   # For folderfilter.
+import json
 from threading import Lock
+from os import listdir, makedirs, path
+from sys import exc_info
+try:
+    import UserDict
+except ImportError:
+    # Py3
+    from collections import UserDict
 
-boxes = {}
-localroots = {}
-config = None
-accounts = None
-mblock = Lock()
 
-def init(conf, accts):
+_mbLock = Lock()
-    global config, accounts
+_mbnames = None
-    config = conf
-    accounts = accts
 
-def add(accountname, foldername, localfolders):
-    if not accountname in boxes:
-        boxes[accountname] = []
-        localroots[accountname] = localfolders
-    if not foldername in boxes[accountname]:
-        boxes[accountname].append(foldername)
 
-def write(allcomplete):
+def add(accountname, folder_root, foldername):
-    incremental = config.getdefaultboolean("mbnames", "incremental", False)
+    global _mbnames
-
+    if _mbnames is None:
-    # Skip writing if we don't want incremental writing and we're not done.
-    if not incremental and not allcomplete:
         return
 
-    # Skip writing if we want incremental writing and we're done.
+    with _mbLock:
-    if incremental and allcomplete:
+        _mbnames.addAccountFolder(accountname, folder_root, foldername)
+
+def init(conf, ui, dry_run):
+    global _mbnames
+    enabled = conf.getdefaultboolean("mbnames", "enabled", False)
+    if enabled is True and _mbnames is None:
+        _mbnames = _Mbnames(conf, ui, dry_run)
+
+def write():
+    """Write the mbnames file."""
+
+    global _mbnames
+    if _mbnames is None:
         return
 
-    # See if we're ready to write it out.
+    if _mbnames.get_incremental() is not True:
-    for account in accounts:
+        _mbnames.write()
-        if account not in boxes:
+
+def writeIntermediateFile(accountname):
+    """Write intermediate mbnames file."""
+
+    global _mbnames
+    if _mbnames is None:
         return
 
-    __genmbnames()
+    _mbnames.writeIntermediateFile(accountname)
+    if _mbnames.get_incremental() is True:
+        _mbnames.write()
 
-def __genmbnames():
-    """Takes a configparser object and a boxlist, which is a list of hashes
-    containing 'accountname' and 'foldername' keys."""
 
-    xforms = [os.path.expanduser, os.path.expandvars]
+class _IntermediateMbnames(object):
-    mblock.acquire()
+    """mbnames data for one account."""
-    try:
+
-        localeval = config.getlocaleval()
+    def __init__(self, accountname, folder_root, mbnamesdir, folderfilter,
-        if not config.getdefaultboolean("mbnames", "enabled", 0):
+            dry_run):
-            return
+
-        path = config.apply_xforms(config.get("mbnames", "filename"), xforms)
+        self._foldernames = []
-        file = open(path, "wt")
+        self._accountname = accountname
-        file.write(localeval.eval(config.get("mbnames", "header")))
+        self._folder_root = folder_root
-        folderfilter = lambda accountname, foldername: 1
+        self._folderfilter = folderfilter
-        if config.has_option("mbnames", "folderfilter"):
+        self._path = path.join(mbnamesdir, "%s.yml"% accountname)
-            folderfilter = localeval.eval(config.get("mbnames", "folderfilter"),
+        self._dryrun = dry_run
-                                          {'re': re})
+
-        mb_sort_keyfunc = lambda d: (d['accountname'], d['foldername'])
+    def add(self, foldername):
-        if config.has_option("mbnames", "sort_keyfunc"):
+        self._foldernames.append(foldername)
-            mb_sort_keyfunc = localeval.eval(config.get("mbnames", "sort_keyfunc"),
+
-                                         {'re': re})
+    def get_folder_root(self):
+        return self._folder_root
+
+    def write(self):
+        """Write intermediate mbnames file in JSON format."""
+
         itemlist = []
-        for accountname in boxes.keys():
+
-            localroot = localroots[accountname]
+        for foldername in self._foldernames:
-            for foldername in boxes[accountname]:
+            if self._folderfilter(self._accountname, foldername):
-                if folderfilter(accountname, foldername):
+                itemlist.append({
-                    itemlist.append({'accountname': accountname,
+                    'accountname': self._accountname,
                     'foldername': foldername,
-                                     'localfolders': localroot})
+                    'localfolders': self._folder_root,
-        itemlist.sort(key = mb_sort_keyfunc)
+                })
-        format_string = config.get("mbnames", "peritem", raw=1)
+
-        itemlist = [format_string % d for d in itemlist]
+        if not self._dryrun:
-        file.write(localeval.eval(config.get("mbnames", "sep")).join(itemlist))
+            with open(self._path, "wt") as intermediateFile:
-        file.write(localeval.eval(config.get("mbnames", "footer")))
+                json.dump(itemlist, intermediateFile)
-        file.close()
+
-    finally:
+
-        mblock.release()
+class _Mbnames(object):
+    def __init__(self, config, ui, dry_run):
+
+        self._config = config
+        self._dryrun = dry_run
+        self.ui = ui
+
+        # Keys: accountname, values: _IntermediateMbnames instance
+        self._intermediates = {}
+        self._incremental = None
+        self._mbnamesdir = None
+        self._path = None
+        self._folderfilter = lambda accountname, foldername: True
+        self._func_sortkey = lambda d: (d['accountname'], d['foldername'])
+        self._peritem = self._config.get("mbnames", "peritem", raw=1)
+
+        localeval = config.getlocaleval()
+        self._header = localeval.eval(config.get("mbnames", "header"))
+        self._sep = localeval.eval(config.get("mbnames", "sep"))
+        self._footer = localeval.eval(config.get("mbnames", "footer"))
+
+        mbnamesdir = path.join(config.getmetadatadir(), "mbnames")
+        try:
+            if not self._dryrun:
+                makedirs(mbnamesdir)
+        except OSError:
+            pass
+        self._mbnamesdir = mbnamesdir
+
+        xforms = [path.expanduser, path.expandvars]
+        self._path = config.apply_xforms(
+            config.get("mbnames", "filename"), xforms)
+
+        if self._config.has_option("mbnames", "sort_keyfunc"):
+            self._func_sortkey = localeval.eval(
+                self._config.get("mbnames", "sort_keyfunc"), {'re': re})
+
+        if self._config.has_option("mbnames", "folderfilter"):
+            self._folderfilter = localeval.eval(
+                self._config.get("mbnames", "folderfilter"), {'re': re})
+
+    def addAccountFolder(self, accountname, folder_root, foldername):
+        """Add foldername entry for an account."""
+
+        if accountname not in self._intermediates:
+            self._intermediates[accountname] = _IntermediateMbnames(
+                accountname,
+                folder_root,
+                self._mbnamesdir,
+                self._folderfilter,
+                self._dryrun,
+            )
+
+        self._intermediates[accountname].add(foldername)
+
+    def get_incremental(self):
+        if self._incremental is None:
+            self._incremental = self._config.getdefaultboolean(
+                "mbnames", "incremental", False)
+
+        return self._incremental
+
+    def write(self):
+        itemlist = []
+
+        try:
+            for foo in listdir(self._mbnamesdir):
+                foo = path.join(self._mbnamesdir, foo)
+                if path.isfile(foo) and foo[-5:] == '.json':
+                    try:
+                        with open(foo, 'rt') as intermediateFile:
+                            for item in json.load(intermediateFile):
+                                itemlist.append(item)
+                    except Exception as e:
+                        self.ui.error(
+                            e,
+                            exc_info()[2],
+                            "intermediate mbnames file %s not properly read"% foo
+                        )
+        except OSError:
+            pass
+
+        itemlist.sort(key=self._func_sortkey)
+        itemlist = [self._peritem % d for d in itemlist]
+
+        if not self._dryrun:
+            try:
+                with open(self._path, 'wt') as mbnamesFile:
+                    mbnamesFile.write(self._header)
+                    mbnamesFile.write(self._sep.join(itemlist))
+                    mbnamesFile.write(self._footer)
+            except (OSError, IOError) as e:
+                self.ui.error(
+                    e,
+                    exc_info()[2],
+                    "mbnames file %s not properly written"% self._path
+                )
+
+    def writeIntermediateFile(self, accountname):
+        try:
+            self._intermediates[accountname].write()
+        except (OSError, IOError) as e:
+            self.ui.error(
+                e,
+                exc_info()[2],
+                "intermediate mbnames file %s not properly written"% self._path
+            )

offlineimap/ui/UIBase.py

@@ -1,5 +1,5 @@
 # UI base class
-# Copyright (C) 2002-2015 John Goerzen & contributors
+# Copyright (C) 2002-2016 John Goerzen & contributors
 #
 #    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