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>
This commit is contained in:
Nicolas Sebrecht
@ -1,6 +1,5 @@
|
||||
# Mailbox name generator
|
||||
#
|
||||
# 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
|
||||
@ -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):
|
||||
global config, accounts
|
||||
config = conf
|
||||
accounts = accts
|
||||
_mbLock = Lock()
|
||||
_mbnames = None
|
||||
|
||||
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):
|
||||
incremental = config.getdefaultboolean("mbnames", "incremental", False)
|
||||
|
||||
# Skip writing if we don't want incremental writing and we're not done.
|
||||
if not incremental and not allcomplete:
|
||||
def add(accountname, folder_root, foldername):
|
||||
global _mbnames
|
||||
if _mbnames is None:
|
||||
return
|
||||
|
||||
# Skip writing if we want incremental writing and we're done.
|
||||
if incremental and allcomplete:
|
||||
with _mbLock:
|
||||
_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.
|
||||
for account in accounts:
|
||||
if account not in boxes:
|
||||
return
|
||||
if _mbnames.get_incremental() is not True:
|
||||
_mbnames.write()
|
||||
|
||||
__genmbnames()
|
||||
def writeIntermediateFile(accountname):
|
||||
"""Write intermediate mbnames file."""
|
||||
|
||||
def __genmbnames():
|
||||
"""Takes a configparser object and a boxlist, which is a list of hashes
|
||||
containing 'accountname' and 'foldername' keys."""
|
||||
global _mbnames
|
||||
if _mbnames is None:
|
||||
return
|
||||
|
||||
_mbnames.writeIntermediateFile(accountname)
|
||||
if _mbnames.get_incremental() is True:
|
||||
_mbnames.write()
|
||||
|
||||
|
||||
class _IntermediateMbnames(object):
|
||||
"""mbnames data for one account."""
|
||||
|
||||
def __init__(self, accountname, folder_root, mbnamesdir, folderfilter,
|
||||
dry_run):
|
||||
|
||||
self._foldernames = []
|
||||
self._accountname = accountname
|
||||
self._folder_root = folder_root
|
||||
self._folderfilter = folderfilter
|
||||
self._path = path.join(mbnamesdir, "%s.yml"% accountname)
|
||||
self._dryrun = dry_run
|
||||
|
||||
def add(self, foldername):
|
||||
self._foldernames.append(foldername)
|
||||
|
||||
def get_folder_root(self):
|
||||
return self._folder_root
|
||||
|
||||
def write(self):
|
||||
"""Write intermediate mbnames file in JSON format."""
|
||||
|
||||
xforms = [os.path.expanduser, os.path.expandvars]
|
||||
mblock.acquire()
|
||||
try:
|
||||
localeval = config.getlocaleval()
|
||||
if not config.getdefaultboolean("mbnames", "enabled", 0):
|
||||
return
|
||||
path = config.apply_xforms(config.get("mbnames", "filename"), xforms)
|
||||
file = open(path, "wt")
|
||||
file.write(localeval.eval(config.get("mbnames", "header")))
|
||||
folderfilter = lambda accountname, foldername: 1
|
||||
if config.has_option("mbnames", "folderfilter"):
|
||||
folderfilter = localeval.eval(config.get("mbnames", "folderfilter"),
|
||||
{'re': re})
|
||||
mb_sort_keyfunc = lambda d: (d['accountname'], d['foldername'])
|
||||
if config.has_option("mbnames", "sort_keyfunc"):
|
||||
mb_sort_keyfunc = localeval.eval(config.get("mbnames", "sort_keyfunc"),
|
||||
{'re': re})
|
||||
itemlist = []
|
||||
for accountname in boxes.keys():
|
||||
localroot = localroots[accountname]
|
||||
for foldername in boxes[accountname]:
|
||||
if folderfilter(accountname, foldername):
|
||||
itemlist.append({'accountname': accountname,
|
||||
'foldername': foldername,
|
||||
'localfolders': localroot})
|
||||
itemlist.sort(key = mb_sort_keyfunc)
|
||||
format_string = config.get("mbnames", "peritem", raw=1)
|
||||
itemlist = [format_string % d for d in itemlist]
|
||||
file.write(localeval.eval(config.get("mbnames", "sep")).join(itemlist))
|
||||
file.write(localeval.eval(config.get("mbnames", "footer")))
|
||||
file.close()
|
||||
finally:
|
||||
mblock.release()
|
||||
|
||||
for foldername in self._foldernames:
|
||||
if self._folderfilter(self._accountname, foldername):
|
||||
itemlist.append({
|
||||
'accountname': self._accountname,
|
||||
'foldername': foldername,
|
||||
'localfolders': self._folder_root,
|
||||
})
|
||||
|
||||
if not self._dryrun:
|
||||
with open(self._path, "wt") as intermediateFile:
|
||||
json.dump(itemlist, intermediateFile)
|
||||
|
||||
|
||||
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
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user