2002-06-19 06:39:00 +02:00
|
|
|
# Base repository support
|
2012-02-05 12:49:08 +01:00
|
|
|
# Copyright (C) 2002-2012 John Goerzen & contributors
|
2002-06-19 06:39:00 +02:00
|
|
|
#
|
|
|
|
# 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 06:39:00 +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 06:39:00 +02:00
|
|
|
|
2011-08-29 15:08:26 +02:00
|
|
|
import re
|
2003-04-18 04:18:34 +02:00
|
|
|
import os.path
|
2011-01-28 01:46:29 +01:00
|
|
|
import traceback
|
2011-08-14 13:38:54 +02:00
|
|
|
from sys import exc_info
|
2011-03-03 11:05:15 +01:00
|
|
|
from offlineimap import CustomConfig
|
|
|
|
from offlineimap.ui import getglobalui
|
2011-08-14 13:38:54 +02:00
|
|
|
from offlineimap.error import OfflineImapError
|
2003-04-18 04:18:34 +02:00
|
|
|
|
2012-02-05 12:49:08 +01:00
|
|
|
class BaseRepository(CustomConfig.ConfigHelperMixin, object):
|
2011-09-16 10:54:23 +02:00
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def __init__(self, reposname, account):
|
2011-03-03 11:43:22 +01:00
|
|
|
self.ui = getglobalui()
|
2003-04-18 04:18:34 +02:00
|
|
|
self.account = account
|
|
|
|
self.config = account.getconfig()
|
|
|
|
self.name = reposname
|
|
|
|
self.localeval = account.getlocaleval()
|
2011-09-16 10:54:23 +02:00
|
|
|
self._accountname = self.account.getname()
|
2012-05-08 16:31:19 +02:00
|
|
|
self._readonly = self.getconfboolean('readonly', False)
|
2003-04-18 04:18:34 +02:00
|
|
|
self.uiddir = os.path.join(self.config.getmetadatadir(), 'Repository-' + self.name)
|
|
|
|
if not os.path.exists(self.uiddir):
|
2012-02-05 11:31:54 +01:00
|
|
|
os.mkdir(self.uiddir, 0o700)
|
2003-04-18 04:18:34 +02:00
|
|
|
self.mapdir = os.path.join(self.uiddir, 'UIDMapping')
|
|
|
|
if not os.path.exists(self.mapdir):
|
2012-02-05 11:31:54 +01:00
|
|
|
os.mkdir(self.mapdir, 0o700)
|
2003-04-18 04:18:34 +02:00
|
|
|
self.uiddir = os.path.join(self.uiddir, 'FolderValidity')
|
|
|
|
if not os.path.exists(self.uiddir):
|
2012-02-05 11:31:54 +01:00
|
|
|
os.mkdir(self.uiddir, 0o700)
|
2003-04-18 04:18:34 +02:00
|
|
|
|
2011-08-29 15:08:26 +02:00
|
|
|
self.nametrans = lambda foldername: foldername
|
|
|
|
self.folderfilter = lambda foldername: 1
|
|
|
|
self.folderincludes = []
|
2012-02-06 17:33:50 +01:00
|
|
|
self.foldersort = None
|
2011-08-29 15:08:26 +02:00
|
|
|
if self.config.has_option(self.getsection(), 'nametrans'):
|
|
|
|
self.nametrans = self.localeval.eval(
|
|
|
|
self.getconf('nametrans'), {'re': re})
|
|
|
|
if self.config.has_option(self.getsection(), 'folderfilter'):
|
|
|
|
self.folderfilter = self.localeval.eval(
|
|
|
|
self.getconf('folderfilter'), {'re': re})
|
|
|
|
if self.config.has_option(self.getsection(), 'folderincludes'):
|
|
|
|
self.folderincludes = self.localeval.eval(
|
|
|
|
self.getconf('folderincludes'), {'re': re})
|
|
|
|
if self.config.has_option(self.getsection(), 'foldersort'):
|
|
|
|
self.foldersort = self.localeval.eval(
|
|
|
|
self.getconf('foldersort'), {'re': re})
|
|
|
|
|
New restoreatime patch from Ben Kibbey
From: Ben Kibbey
Subject: Re: Removed restoratime from OfflineIMAP
On Wed, May 03, 2006 at 10:08:35PM -0500, John Goerzen wrote:
> Hi Ben,
>
> Thanks for your restoreatime patch.
>
> However, I have received this bug report:
>
> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=365933
>
> After looking at the problem, here's what's going on.
>
> The person is using IMAP as the local repository as well.
>
> You really need to move the atime save and restore code from accounts.py
> into the repository/Maildir.py. Then, for any new call you add to the
> Maildir repository (that will be called from outside Maildir.py), you
> need to add a corresponding default function to repository/Base.py, and
> also make sure that on folders (such as IMAP) where atime restoration
> makes no sense, no error is generated.
>
> Let me know if that doesn't make sense to you. If you get it fixed, I'd
> be happy to re-apply it to a future version of OfflineIMAP.
>
> -- John Goerzen
>
Attached is a new diff that should work though not really tested
(v4.0.14). In repository/Base.py restore_atime() will call
self.restore_folder_atimes() only if the folder type is Maildir. Let me
know if it has any more problems.
2006-09-06 03:33:07 +02:00
|
|
|
def restore_atime(self):
|
2011-09-15 15:06:30 +02:00
|
|
|
"""Sets folders' atime back to their values after a sync
|
New restoreatime patch from Ben Kibbey
From: Ben Kibbey
Subject: Re: Removed restoratime from OfflineIMAP
On Wed, May 03, 2006 at 10:08:35PM -0500, John Goerzen wrote:
> Hi Ben,
>
> Thanks for your restoreatime patch.
>
> However, I have received this bug report:
>
> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=365933
>
> After looking at the problem, here's what's going on.
>
> The person is using IMAP as the local repository as well.
>
> You really need to move the atime save and restore code from accounts.py
> into the repository/Maildir.py. Then, for any new call you add to the
> Maildir repository (that will be called from outside Maildir.py), you
> need to add a corresponding default function to repository/Base.py, and
> also make sure that on folders (such as IMAP) where atime restoration
> makes no sense, no error is generated.
>
> Let me know if that doesn't make sense to you. If you get it fixed, I'd
> be happy to re-apply it to a future version of OfflineIMAP.
>
> -- John Goerzen
>
Attached is a new diff that should work though not really tested
(v4.0.14). In repository/Base.py restore_atime() will call
self.restore_folder_atimes() only if the folder type is Maildir. Let me
know if it has any more problems.
2006-09-06 03:33:07 +02:00
|
|
|
|
2011-09-15 15:06:30 +02:00
|
|
|
Controlled by the 'restoreatime' config parameter (default
|
|
|
|
False), applies only to local Maildir mailboxes and does nothing
|
|
|
|
on all other repository types."""
|
|
|
|
pass
|
New restoreatime patch from Ben Kibbey
From: Ben Kibbey
Subject: Re: Removed restoratime from OfflineIMAP
On Wed, May 03, 2006 at 10:08:35PM -0500, John Goerzen wrote:
> Hi Ben,
>
> Thanks for your restoreatime patch.
>
> However, I have received this bug report:
>
> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=365933
>
> After looking at the problem, here's what's going on.
>
> The person is using IMAP as the local repository as well.
>
> You really need to move the atime save and restore code from accounts.py
> into the repository/Maildir.py. Then, for any new call you add to the
> Maildir repository (that will be called from outside Maildir.py), you
> need to add a corresponding default function to repository/Base.py, and
> also make sure that on folders (such as IMAP) where atime restoration
> makes no sense, no error is generated.
>
> Let me know if that doesn't make sense to you. If you get it fixed, I'd
> be happy to re-apply it to a future version of OfflineIMAP.
>
> -- John Goerzen
>
Attached is a new diff that should work though not really tested
(v4.0.14). In repository/Base.py restore_atime() will call
self.restore_folder_atimes() only if the folder type is Maildir. Let me
know if it has any more problems.
2006-09-06 03:33:07 +02:00
|
|
|
|
2007-07-05 06:04:14 +02:00
|
|
|
def connect(self):
|
|
|
|
"""Establish a connection to the remote, if necessary. This exists
|
|
|
|
so that IMAP connections can all be established up front, gathering
|
|
|
|
passwords as needed. It was added in order to support the
|
|
|
|
error recovery -- we need to connect first outside of the error
|
|
|
|
trap in order to validate the password, and that's the point of
|
|
|
|
this function."""
|
|
|
|
pass
|
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def holdordropconnections(self):
|
|
|
|
pass
|
|
|
|
|
|
|
|
def dropconnections(self):
|
|
|
|
pass
|
|
|
|
|
|
|
|
def getaccount(self):
|
|
|
|
return self.account
|
|
|
|
|
|
|
|
def getname(self):
|
|
|
|
return self.name
|
|
|
|
|
2011-04-27 12:15:51 +02:00
|
|
|
def __str__(self):
|
|
|
|
return self.name
|
|
|
|
|
2011-09-16 10:54:23 +02:00
|
|
|
@property
|
|
|
|
def accountname(self):
|
|
|
|
"""Account name as string"""
|
|
|
|
return self._accountname
|
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def getuiddir(self):
|
|
|
|
return self.uiddir
|
|
|
|
|
|
|
|
def getmapdir(self):
|
|
|
|
return self.mapdir
|
|
|
|
|
|
|
|
def getsection(self):
|
|
|
|
return 'Repository ' + self.name
|
|
|
|
|
|
|
|
def getconfig(self):
|
|
|
|
return self.config
|
|
|
|
|
2012-05-08 16:31:19 +02:00
|
|
|
@property
|
|
|
|
def readonly(self):
|
|
|
|
"""Is the repository readonly?"""
|
|
|
|
return self._readonly
|
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def getlocaleval(self):
|
|
|
|
return self.account.getlocaleval()
|
|
|
|
|
2002-06-19 06:39:00 +02:00
|
|
|
def getfolders(self):
|
|
|
|
"""Returns a list of ALL folders on this server."""
|
|
|
|
return []
|
2002-06-19 08:16:19 +02:00
|
|
|
|
2007-07-06 18:46:29 +02:00
|
|
|
def forgetfolders(self):
|
|
|
|
"""Forgets the cached list of folders, if any. Useful to run
|
|
|
|
after a sync run."""
|
|
|
|
pass
|
|
|
|
|
2002-06-19 08:16:19 +02:00
|
|
|
def getsep(self):
|
|
|
|
raise NotImplementedError
|
|
|
|
|
2012-05-08 16:41:21 +02:00
|
|
|
def get_create_folders(self):
|
|
|
|
"""Is folder creation enabled on this repository?
|
|
|
|
|
|
|
|
It is disabled by either setting the whole repository
|
|
|
|
'readonly' or by using the 'createfolders' setting."""
|
|
|
|
return self._readonly or self.getconfboolean('createfolders', True)
|
|
|
|
|
2002-06-20 04:55:24 +02:00
|
|
|
def makefolder(self, foldername):
|
2011-09-15 15:37:52 +02:00
|
|
|
"""Create a new folder"""
|
2002-06-19 08:16:19 +02:00
|
|
|
raise NotImplementedError
|
|
|
|
|
2002-06-20 04:55:24 +02:00
|
|
|
def deletefolder(self, foldername):
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
def getfolder(self, foldername):
|
2002-06-19 08:16:19 +02:00
|
|
|
raise NotImplementedError
|
2012-01-05 14:05:51 +01:00
|
|
|
|
|
|
|
def sync_folder_structure(self, dst_repo, status_repo):
|
2002-06-19 08:16:19 +02:00
|
|
|
"""Syncs the folders in this repository to those in dest.
|
2008-03-03 05:17:45 +01:00
|
|
|
|
2011-08-14 13:38:54 +02:00
|
|
|
It does NOT sync the contents of those folders. nametrans rules
|
|
|
|
in both directions will be honored, but there are NO checks yet
|
|
|
|
that forward and backward nametrans actually match up!
|
|
|
|
Configuring nametrans on BOTH repositories therefore could lead
|
|
|
|
to infinite folder creation cycles."""
|
2012-05-08 16:41:21 +02:00
|
|
|
if not self.get_create_folders() and not dst_repo.get_create_folders():
|
|
|
|
# quick exit if no folder creation is enabled on either side.
|
|
|
|
return
|
|
|
|
|
2011-08-29 16:00:11 +02:00
|
|
|
src_repo = self
|
|
|
|
src_folders = src_repo.getfolders()
|
|
|
|
dst_folders = dst_repo.getfolders()
|
2011-09-30 08:58:08 +02:00
|
|
|
# Do we need to refresh the folder list afterwards?
|
|
|
|
src_haschanged, dst_haschanged = False, False
|
2002-06-19 08:16:19 +02:00
|
|
|
# Create hashes with the names, but convert the source folders
|
|
|
|
# to the dest folder's sep.
|
2011-08-29 16:00:11 +02:00
|
|
|
src_hash = {}
|
|
|
|
for folder in src_folders:
|
|
|
|
src_hash[folder.getvisiblename().replace(
|
|
|
|
src_repo.getsep(), dst_repo.getsep())] = folder
|
|
|
|
dst_hash = {}
|
|
|
|
for folder in dst_folders:
|
2012-02-16 11:45:18 +01:00
|
|
|
dst_hash[folder.getvisiblename().replace(
|
|
|
|
dst_repo.getsep(), src_repo.getsep())] = folder
|
2002-06-19 08:16:19 +02:00
|
|
|
|
2011-08-14 13:38:54 +02:00
|
|
|
# Find new folders on src_repo.
|
2012-02-16 11:12:07 +01:00
|
|
|
for src_name_t, src_folder in src_hash.iteritems():
|
2012-01-05 14:05:51 +01:00
|
|
|
# Don't create on dst_repo, if it is readonly
|
2012-05-08 16:41:21 +02:00
|
|
|
if not dst_repo.get_create_folders():
|
2012-01-05 14:05:51 +01:00
|
|
|
break
|
2012-02-16 11:12:07 +01:00
|
|
|
if src_folder.sync_this and not src_name_t in dst_folders:
|
Patch for error handling / separation of accounts etc.
Dear All,
I have made the attached patch to try and make offlineimap a bit more
stable in challenging situations. It's extremely useful in slow
connection environments - but sometimes if one account had the wrong
password or the connection went down then unfortunately the whole
program would crash.
I have tested this on our connection and tried throwing at it just about
every situation - connection, up down, up, down again, change password,
error whilst copying one message, etc. I have been running this patch
for the last 5 days or so syncing 6 accounts at the moment... It seems
to work and stay alive nicely (even if your connection does not)...
Hope that this can go in for the next release... Please let me know if
anyone notices any problems with this...
Regards,
-Mike
-- Attached file included as plaintext by Ecartis --
-- File: submit
From 1d6777cab23637eb830031c7cab0ae9b8589afd6 Mon Sep 17 00:00:00 2001
From: mike <mike@mikelaptop.(none)>
Date: Mon, 24 Aug 2009 19:37:59 +0430
Subject: [PATCH] This patch attempts to introduce a little more error handling - e.g.
if one account has an error because of a changed password or something
that should not affect the other accounts.
Specifically:
If one sync run has an issue this is in a try-except clause - if it
has an auto refresh period the thread will sleep and try again - this
could be quite useful in the event of the connection going down for a
little while, changed password etc.
If one folder cannot be created an error message will be displayed through
the UI and the program will continue (e.g. permission denied to create a folder)
If one message does not want to copy for whatever resaon an error message
will be displayed through the UI and at least the other messages will
be copied
If one folder run has an exception then the others will still run
2009-08-24 17:17:57 +02:00
|
|
|
try:
|
2012-02-16 11:12:07 +01:00
|
|
|
dst_repo.makefolder(src_name_t)
|
2011-09-30 08:58:08 +02:00
|
|
|
dst_haschanged = True # Need to refresh list
|
2012-02-05 10:14:23 +01:00
|
|
|
except OfflineImapError as e:
|
2011-08-14 13:38:54 +02:00
|
|
|
self.ui.error(e, exc_info()[2],
|
|
|
|
"Creating folder %s on repository %s" %\
|
2012-02-16 11:12:07 +01:00
|
|
|
(src_name_t, dst_repo))
|
2011-01-12 11:15:09 +01:00
|
|
|
raise
|
2012-02-16 11:12:07 +01:00
|
|
|
status_repo.makefolder(src_name_t.replace(dst_repo.getsep(),
|
2011-08-14 13:38:54 +02:00
|
|
|
status_repo.getsep()))
|
|
|
|
# Find new folders on dst_repo.
|
2012-02-16 11:45:18 +01:00
|
|
|
for dst_name_t, dst_folder in dst_hash.iteritems():
|
2012-05-08 16:41:21 +02:00
|
|
|
if not src_repo.get_create_folders():
|
2012-01-05 14:05:51 +01:00
|
|
|
# Don't create missing folder on readonly repo.
|
|
|
|
break
|
|
|
|
|
2012-02-16 11:45:18 +01:00
|
|
|
if dst_folder.sync_this and not dst_name_t in src_folders:
|
2011-09-19 14:01:48 +02:00
|
|
|
# nametrans sanity check!
|
|
|
|
# Does nametrans back&forth lead to identical names?
|
2012-02-16 11:45:18 +01:00
|
|
|
# 1) would src repo filter out the new folder name? In this
|
2011-09-19 21:25:50 +02:00
|
|
|
# case don't create it on it:
|
2012-02-16 11:45:18 +01:00
|
|
|
if not self.folderfilter(dst_name_t):
|
2011-09-19 21:25:50 +02:00
|
|
|
self.ui.debug('', "Not creating folder '%s' (repository '%s"
|
|
|
|
"') as it would be filtered out on that repository." %
|
2012-02-16 11:45:18 +01:00
|
|
|
(dst_name_t, self))
|
2011-09-19 21:25:50 +02:00
|
|
|
continue
|
2012-02-16 11:45:18 +01:00
|
|
|
# get IMAPFolder and see if the reverse nametrans
|
|
|
|
# works fine TODO: getfolder() works only because we
|
|
|
|
# succeed in getting inexisting folders which I would
|
|
|
|
# like to change. Take care!
|
|
|
|
folder = self.getfolder(dst_name_t)
|
2011-09-20 22:25:45 +02:00
|
|
|
# apply reverse nametrans to see if we end up with the same name
|
2011-08-14 13:38:54 +02:00
|
|
|
newdst_name = folder.getvisiblename().replace(
|
2011-09-19 14:01:48 +02:00
|
|
|
src_repo.getsep(), dst_repo.getsep())
|
2012-02-16 11:45:18 +01:00
|
|
|
if dst_folder.name != newdst_name:
|
2011-09-19 14:01:48 +02:00
|
|
|
raise OfflineImapError("INFINITE FOLDER CREATION DETECTED! "
|
|
|
|
"Folder '%s' (repository '%s') would be created as fold"
|
2011-09-19 20:07:56 +02:00
|
|
|
"er '%s' (repository '%s'). The latter becomes '%s' in "
|
|
|
|
"return, leading to infinite folder creation cycles.\n "
|
2011-09-19 21:06:54 +02:00
|
|
|
"SOLUTION: 1) Do set your nametrans rules on both repos"
|
|
|
|
"itories so they lead to identical names if applied bac"
|
|
|
|
"k and forth. 2) Use folderfilter settings on a reposit"
|
|
|
|
"ory to prevent some folders from being created on the "
|
2012-02-16 11:45:18 +01:00
|
|
|
"other side." % (dst_folder.name, dst_repo, dst_name_t,
|
2011-09-19 21:06:54 +02:00
|
|
|
src_repo, newdst_name),
|
2011-09-19 14:01:48 +02:00
|
|
|
OfflineImapError.ERROR.REPO)
|
2011-08-14 13:38:54 +02:00
|
|
|
# end sanity check, actually create the folder
|
|
|
|
try:
|
2012-02-16 11:45:18 +01:00
|
|
|
src_repo.makefolder(dst_name_t)
|
2011-09-30 08:58:08 +02:00
|
|
|
src_haschanged = True # Need to refresh list
|
2012-02-05 10:14:23 +01:00
|
|
|
except OfflineImapError as e:
|
2011-10-05 18:41:38 +02:00
|
|
|
self.ui.error(e, exc_info()[2], "Creating folder %s on "
|
2012-02-16 11:45:18 +01:00
|
|
|
"repository %s" % (dst_name_t, src_repo))
|
2011-08-14 13:38:54 +02:00
|
|
|
raise
|
2012-02-16 11:45:18 +01:00
|
|
|
status_repo.makefolder(dst_name_t.replace(
|
2011-09-20 22:25:45 +02:00
|
|
|
src_repo.getsep(), status_repo.getsep()))
|
2002-06-19 08:16:19 +02:00
|
|
|
# Find deleted folders.
|
2011-09-30 08:58:08 +02:00
|
|
|
# TODO: We don't delete folders right now.
|
|
|
|
|
|
|
|
#Forget old list of cached folders so we get new ones if needed
|
|
|
|
if src_haschanged:
|
|
|
|
self.forgetfolders()
|
|
|
|
if dst_haschanged:
|
|
|
|
dst_repo.forgetfolders()
|
2002-06-19 08:16:19 +02:00
|
|
|
|
2003-04-18 04:18:34 +02:00
|
|
|
def startkeepalive(self):
|
|
|
|
"""The default implementation will do nothing."""
|
|
|
|
pass
|
|
|
|
|
2008-08-03 00:04:32 +02:00
|
|
|
def stopkeepalive(self):
|
|
|
|
"""Stop keep alive, but don't bother waiting
|
2003-04-18 04:18:34 +02:00
|
|
|
for the threads to terminate."""
|
|
|
|
pass
|
2011-10-27 16:56:18 +02:00
|
|
|
|