tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat offlineimap/folder/Base.py

Browse Source 
Add some spaces, remove lines,... now format is better (lintian).
This commit is contained in:
Rodolfo García Peñas (kix) 2020-08-29 19:39:31 +02:00
parent fefc3a5717
commit 9ebdbe47ee
1 changed files with 76 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
offlineimap/folder/Base.py
View File

@ -47,7 +47,7 @@ class BaseFolder(object):
if self.name == 'INBOX': if self.name == 'INBOX':
self.newmail_hook = repository.newmail_hook self.newmail_hook = repository.newmail_hook
self.have_newmail = False self.have_newmail = False
self.copy_ignoreUIDs = None # List of UIDs to ignore. self.copy_ignoreUIDs = None # List of UIDs to ignore.
self.repository = repository self.repository = repository
self.visiblename = repository.nametrans(name) self.visiblename = repository.nametrans(name)
# In case the visiblename becomes '.' or '/' (top-level) we use # In case the visiblename becomes '.' or '/' (top-level) we use
@ -78,11 +78,11 @@ class BaseFolder(object):
self.repoconfname, "dynamic_folderfilter", False) self.repoconfname, "dynamic_folderfilter", False)
self._sync_this = repository.should_sync_folder(self.ffilter_name) self._sync_this = repository.should_sync_folder(self.ffilter_name)
if self._dynamic_folderfilter: if self._dynamic_folderfilter:
self.ui.debug('', "Running dynamic folder filtering on '%s'[%s]"% self.ui.debug('', "Running dynamic folder filtering on '%s'[%s]" %
(self.ffilter_name, repository)) (self.ffilter_name, repository))
elif not self._sync_this: elif not self._sync_this:
self.ui.debug('', "Filtering out '%s'[%s] due to folderfilter"% self.ui.debug('', "Filtering out '%s'[%s] due to folderfilter" %
(self.ffilter_name, repository)) (self.ffilter_name, repository))
# Passes for syncmessagesto. # Passes for syncmessagesto.
self.syncmessagesto_passes = [ self.syncmessagesto_passes = [
@ -178,7 +178,7 @@ class BaseFolder(object):
if self.name == self.visiblename: if self.name == self.visiblename:
return self.name return self.name
else: else:
return "%s [remote name %s]"% (self.visiblename, self.name) return "%s [remote name %s]" % (self.visiblename, self.name)
def getrepository(self): def getrepository(self):
"""Returns the repository object that this folder is within.""" """Returns the repository object that this folder is within."""
@ -206,7 +206,7 @@ class BaseFolder(object):
if not self.name: if not self.name:
basename = '.' basename = '.'
else: # Avoid directory hierarchies and file names such as '/'. else: # Avoid directory hierarchies and file names such as '/'.
basename = self.name.replace('/', '.') basename = self.name.replace('/', '.')
# Replace with literal 'dot' if final path name is '.' as '.' is # Replace with literal 'dot' if final path name is '.' as '.' is
# an invalid file name. # an invalid file name.
@ -262,7 +262,7 @@ class BaseFolder(object):
uidfilename = self._getuidfilename() uidfilename = self._getuidfilename()
with open(uidfilename + ".tmp", "wt") as uidfile: with open(uidfilename + ".tmp", "wt") as uidfile:
uidfile.write("%d\n"% newval) uidfile.write("%d\n" % newval)
os.rename(uidfilename + ".tmp", uidfilename) os.rename(uidfilename + ".tmp", uidfilename)
self._base_saved_uidvalidity = newval self._base_saved_uidvalidity = newval
@ -339,63 +339,63 @@ class BaseFolder(object):
maxage is allowed to be either an integer or a date of the form maxage is allowed to be either an integer or a date of the form
YYYY-mm-dd. This returns a time_struct.""" YYYY-mm-dd. This returns a time_struct."""
maxagestr = self.config.getdefault("Account %s"% maxagestr = self.config.getdefault("Account %s" %
self.accountname, "maxage", None) self.accountname, "maxage", None)
if maxagestr is None: if maxagestr is None:
return None return None
# Is it a number? # Is it a number?
try: try:
maxage = int(maxagestr) maxage = int(maxagestr)
if maxage < 1: if maxage < 1:
raise OfflineImapError("invalid maxage value %d"% maxage, raise OfflineImapError("invalid maxage value %d" % maxage,
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
return time.gmtime(time.time() - 60*60*24*maxage) return time.gmtime(time.time() - 60 * 60 * 24 * maxage)
except ValueError: except ValueError:
pass # Maybe it was a date. pass # Maybe it was a date.
# Is it a date string? # Is it a date string?
try: try:
date = time.strptime(maxagestr, "%Y-%m-%d") date = time.strptime(maxagestr, "%Y-%m-%d")
if date[0] < 1900: if date[0] < 1900:
raise OfflineImapError("maxage led to year %d. " raise OfflineImapError("maxage led to year %d. "
"Abort syncing."% date[0], "Abort syncing." % date[0],
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
if (time.mktime(date) - time.mktime(time.localtime())) > 0: if (time.mktime(date) - time.mktime(time.localtime())) > 0:
raise OfflineImapError("maxage led to future date %s. " raise OfflineImapError("maxage led to future date %s. "
"Abort syncing."% maxagestr, "Abort syncing." % maxagestr,
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
return date return date
except ValueError: except ValueError:
raise OfflineImapError("invalid maxage value %s"% maxagestr, raise OfflineImapError("invalid maxage value %s" % maxagestr,
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
def getmaxsize(self): def getmaxsize(self):
return self.config.getdefaultint("Account %s"% return self.config.getdefaultint("Account %s" %
self.accountname, "maxsize", None) self.accountname, "maxsize", None)
def getstartdate(self): def getstartdate(self):
""" Retrieve the value of the configuration option startdate """ """ Retrieve the value of the configuration option startdate """
datestr = self.config.getdefault("Repository " + self.repository.name, datestr = self.config.getdefault("Repository " + self.repository.name,
'startdate', None) 'startdate', None)
try: try:
if not datestr: if not datestr:
return None return None
date = time.strptime(datestr, "%Y-%m-%d") date = time.strptime(datestr, "%Y-%m-%d")
if date[0] < 1900: if date[0] < 1900:
raise OfflineImapError("startdate led to year %d. " raise OfflineImapError("startdate led to year %d. "
"Abort syncing."% date[0], "Abort syncing." % date[0],
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
if (time.mktime(date) - time.mktime(time.localtime())) > 0: if (time.mktime(date) - time.mktime(time.localtime())) > 0:
raise OfflineImapError("startdate led to future date %s. " raise OfflineImapError("startdate led to future date %s. "
"Abort syncing."% datestr, "Abort syncing." % datestr,
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
return date return date
except ValueError: except ValueError:
raise OfflineImapError("invalid startdate value %s", raise OfflineImapError("invalid startdate value %s",
OfflineImapError.ERROR.MESSAGE) OfflineImapError.ERROR.MESSAGE)
def get_min_uid_file(self): def get_min_uid_file(self):
startuiddir = os.path.join(self.config.getmetadatadir(), startuiddir = os.path.join(self.config.getmetadatadir(),
'Repository-' + self.repository.name, 'StartUID') 'Repository-' + self.repository.name, 'StartUID')
if not os.path.exists(startuiddir): if not os.path.exists(startuiddir):
os.mkdir(startuiddir, 0o700) os.mkdir(startuiddir, 0o700)
return os.path.join(startuiddir, self.getfolderbasename()) return os.path.join(startuiddir, self.getfolderbasename())
@ -416,8 +416,7 @@ class BaseFolder(object):
fd.close() fd.close()
return min_uid return min_uid
except: except:
raise IOError("Can't read %s"% uidfile) raise IOError("Can't read %s" % uidfile)
def savemessage(self, uid, content, flags, rtime): def savemessage(self, uid, content, flags, rtime):
"""Writes a new message, with the specified uid. """Writes a new message, with the specified uid.
@ -634,24 +633,24 @@ class BaseFolder(object):
next line\n next line\n
""" """
self.ui.debug('', 'addmessageheader: called to add %s: %s'% self.ui.debug('', 'addmessageheader: called to add %s: %s' %
(headername, headervalue)) (headername, headervalue))
insertionpoint = content.find(linebreak * 2) insertionpoint = content.find(linebreak * 2)
if insertionpoint == -1: if insertionpoint == -1:
self.ui.debug('', 'addmessageheader: headers were missing') self.ui.debug('', 'addmessageheader: headers were missing')
else: else:
self.ui.debug('', self.ui.debug('',
'addmessageheader: headers end at position %d'% insertionpoint) 'addmessageheader: headers end at position %d' % insertionpoint)
mark = '==>EOH<==' mark = '==>EOH<=='
contextstart = max(0, insertionpoint - 100) contextstart = max(0, insertionpoint - 100)
contextend = min(len(content), insertionpoint + 100) contextend = min(len(content), insertionpoint + 100)
self.ui.debug('', 'addmessageheader: header/body transition " \ self.ui.debug('', 'addmessageheader: header/body transition " \
"context (marked by %s): %s%s%s'% ( "context (marked by %s): %s%s%s' % (
mark, repr(content[contextstart:insertionpoint]), mark, repr(content[contextstart:insertionpoint]),
mark, repr(content[insertionpoint:contextend]) mark, repr(content[insertionpoint:contextend])
)
) )
)
# Hoping for case #4. # Hoping for case #4.
prefix = linebreak prefix = linebreak
@ -674,14 +673,13 @@ class BaseFolder(object):
suffix = suffix + linebreak suffix = suffix + linebreak
self.ui.debug('', self.ui.debug('',
'addmessageheader: insertionpoint = %d'% insertionpoint) 'addmessageheader: insertionpoint = %d' % insertionpoint)
headers = content[0:insertionpoint] headers = content[0:insertionpoint]
self.ui.debug('', 'addmessageheader: headers = %s'% repr(headers)) self.ui.debug('', 'addmessageheader: headers = %s' % repr(headers))
new_header = prefix + ("%s: %s"% (headername, headervalue)) + suffix new_header = prefix + ("%s: %s" % (headername, headervalue)) + suffix
self.ui.debug('', 'addmessageheader: new_header = %s'% repr(new_header)) self.ui.debug('', 'addmessageheader: new_header = %s' % repr(new_header))
return headers + new_header + content[insertionpoint:] return headers + new_header + content[insertionpoint:]
def __find_eoh(self, content): def __find_eoh(self, content):
"""Searches for the point where mail headers end. """Searches for the point where mail headers end.
@ -698,7 +696,6 @@ class BaseFolder(object):
return eoh_cr return eoh_cr
def getmessageheader(self, content, name): def getmessageheader(self, content, name):
"""Return the value of the first occurence of the given header. """Return the value of the first occurence of the given header.
@ -711,20 +708,19 @@ class BaseFolder(object):
Returns: header value or None if no such header was found. Returns: header value or None if no such header was found.
""" """
self.ui.debug('', 'getmessageheader: called to get %s'% name) self.ui.debug('', 'getmessageheader: called to get %s' % name)
eoh = self.__find_eoh(content) eoh = self.__find_eoh(content)
self.ui.debug('', 'getmessageheader: eoh = %d'% eoh) self.ui.debug('', 'getmessageheader: eoh = %d' % eoh)
headers = content[0:eoh] headers = content[0:eoh]
self.ui.debug('', 'getmessageheader: headers = %s'% repr(headers)) self.ui.debug('', 'getmessageheader: headers = %s' % repr(headers))
m = re.search('^%s:(.*)$'% name, headers, m = re.search('^%s:(.*)$' % name, headers,
flags= re.MULTILINE | re.IGNORECASE) flags=re.MULTILINE | re.IGNORECASE)
if m: if m:
return m.group(1).strip() return m.group(1).strip()
else: else:
return None return None
def getmessageheaderlist(self, content, name): def getmessageheaderlist(self, content, name):
"""Return a list of values for the given header. """Return a list of values for the given header.
@ -735,15 +731,14 @@ class BaseFolder(object):
Returns: list of header values or empty list if no such header was found. Returns: list of header values or empty list if no such header was found.
""" """
self.ui.debug('', 'getmessageheaderlist: called to get %s'% name) self.ui.debug('', 'getmessageheaderlist: called to get %s' % name)
eoh = self.__find_eoh(content) eoh = self.__find_eoh(content)
self.ui.debug('', 'getmessageheaderlist: eoh = %d'% eoh) self.ui.debug('', 'getmessageheaderlist: eoh = %d' % eoh)
headers = content[0:eoh] headers = content[0:eoh]
self.ui.debug('', 'getmessageheaderlist: headers = %s'% repr(headers)) self.ui.debug('', 'getmessageheaderlist: headers = %s' % repr(headers))
return re.findall('^%s:(.*)$'%
name, headers, flags= re.MULTILINE | re.IGNORECASE)
return re.findall('^%s:(.*)$' %
name, headers, flags=re.MULTILINE | re.IGNORECASE)
def deletemessageheaders(self, content, header_list): def deletemessageheaders(self, content, header_list):
"""Deletes headers in the given list from the message content. """Deletes headers in the given list from the message content.
@ -756,21 +751,21 @@ class BaseFolder(object):
if type(header_list) != type([]): if type(header_list) != type([]):
header_list = [header_list] header_list = [header_list]
self.ui.debug('', 'deletemessageheaders: called to delete %s'% (header_list)) self.ui.debug('', 'deletemessageheaders: called to delete %s' % (header_list))
if not len(header_list): if not len(header_list):
return content return content
eoh = self.__find_eoh(content) eoh = self.__find_eoh(content)
self.ui.debug('', 'deletemessageheaders: end of headers = %d'% eoh) self.ui.debug('', 'deletemessageheaders: end of headers = %d' % eoh)
headers = content[0:eoh] headers = content[0:eoh]
rest = content[eoh:] rest = content[eoh:]
self.ui.debug('', 'deletemessageheaders: headers = %s'% repr(headers)) self.ui.debug('', 'deletemessageheaders: headers = %s' % repr(headers))
new_headers = [] new_headers = []
for h in headers.split('\n'): for h in headers.split('\n'):
keep_it = True keep_it = True
for trim_h in header_list: for trim_h in header_list:
if len(h) > len(trim_h) and h[0:len(trim_h)+1] == (trim_h + ":"): if len(h) > len(trim_h) and h[0:len(trim_h) + 1] == (trim_h + ":"):
keep_it = False keep_it = False
break break
if keep_it: if keep_it:
@ -778,9 +773,6 @@ class BaseFolder(object):
return '\n'.join(new_headers) + rest return '\n'.join(new_headers) + rest
def change_message_uid(self, uid, new_uid): def change_message_uid(self, uid, new_uid):
"""Change the message from existing uid to new_uid. """Change the message from existing uid to new_uid.
@ -825,7 +817,7 @@ class BaseFolder(object):
# synced to the status cache. This is only a problem with # synced to the status cache. This is only a problem with
# self.getmessage(). So, don't call self.getmessage unless # self.getmessage(). So, don't call self.getmessage unless
# really needed. # really needed.
if register: # Output that we start a new thread. if register: # Output that we start a new thread.
self.ui.registerthread(self.repository.account) self.ui.registerthread(self.repository.account)
try: try:
@ -863,17 +855,17 @@ class BaseFolder(object):
self.deletemessage(uid) self.deletemessage(uid)
else: else:
raise OfflineImapError("Trying to save msg (uid %d) on folder " raise OfflineImapError("Trying to save msg (uid %d) on folder "
"%s returned invalid uid %d"% (uid, dstfolder.getvisiblename(), "%s returned invalid uid %d" % (uid, dstfolder.getvisiblename(),
new_uid), OfflineImapError.ERROR.MESSAGE) new_uid), OfflineImapError.ERROR.MESSAGE)
except (KeyboardInterrupt): # Bubble up CTRL-C. except (KeyboardInterrupt): # Bubble up CTRL-C.
raise raise
except OfflineImapError as e: except OfflineImapError as e:
if e.severity > OfflineImapError.ERROR.MESSAGE: if e.severity > OfflineImapError.ERROR.MESSAGE:
raise # Bubble severe errors up. raise # Bubble severe errors up.
self.ui.error(e, exc_info()[2]) self.ui.error(e, exc_info()[2])
except Exception as e: except Exception as e:
self.ui.error(e, exc_info()[2], self.ui.error(e, exc_info()[2],
msg = "Copying message %s [acc: %s]"% (uid, self.accountname)) msg="Copying message %s [acc: %s]" % (uid, self.accountname))
raise # Raise on unknown errors, so we can fix those. raise # Raise on unknown errors, so we can fix those.
def __syncmessagesto_copy(self, dstfolder, statusfolder): def __syncmessagesto_copy(self, dstfolder, statusfolder):
@ -895,7 +887,7 @@ class BaseFolder(object):
threads = [] threads = []
copylist = [uid for uid in self.getmessageuidlist() copylist = [uid for uid in self.getmessageuidlist()
if not statusfolder.uidexists(uid)] if not statusfolder.uidexists(uid)]
num_to_copy = len(copylist) num_to_copy = len(copylist)
# Honor 'copy_ignore_eval' configuration option. # Honor 'copy_ignore_eval' configuration option.
@ -928,14 +920,14 @@ class BaseFolder(object):
statusfolder.savemessage(uid, None, flags, rtime) statusfolder.savemessage(uid, None, flags, rtime)
continue continue
self.ui.copyingmessage(uid, num+1, num_to_copy, self, dstfolder) self.ui.copyingmessage(uid, num + 1, num_to_copy, self, dstfolder)
# Exceptions are caught in copymessageto(). # Exceptions are caught in copymessageto().
if self.suggeststhreads(): if self.suggeststhreads():
self.waitforthread() self.waitforthread()
thread = threadutil.InstanceLimitedThread( thread = threadutil.InstanceLimitedThread(
self.getinstancelimitnamespace(), self.getinstancelimitnamespace(),
target=self.copymessageto, target=self.copymessageto,
name="Copy message from %s:%s"% (self.repository, self), name="Copy message from %s:%s" % (self.repository, self),
args=(uid, dstfolder, statusfolder) args=(uid, dstfolder, statusfolder)
) )
thread.start() thread.start()
@ -943,7 +935,7 @@ class BaseFolder(object):
else: else:
self.copymessageto(uid, dstfolder, statusfolder, register=0) self.copymessageto(uid, dstfolder, statusfolder, register=0)
for thread in threads: for thread in threads:
thread.join() # Block until all "copy" threads are done. thread.join() # Block until all "copy" threads are done.
# Execute new mail hook if we have new mail. # Execute new mail hook if we have new mail.
if self.have_newmail: if self.have_newmail:
@ -1005,8 +997,8 @@ class BaseFolder(object):
skipped_keywords = list(selfkeywords - knownkeywords) skipped_keywords = list(selfkeywords - knownkeywords)
selfkeywords &= knownkeywords selfkeywords &= knownkeywords
self.ui.warn("Unknown keywords skipped: %s\n" self.ui.warn("Unknown keywords skipped: %s\n"
"You may want to change your configuration to include " "You may want to change your configuration to include "
"those\n" % (skipped_keywords)) "those\n" % (skipped_keywords))
keywordletterset = set([keywordmap[keyw] for keyw in selfkeywords]) keywordletterset = set([keywordmap[keyw] for keyw in selfkeywords])
@ -1062,14 +1054,14 @@ class BaseFolder(object):
for flag, uids in list(addflaglist.items()): for flag, uids in list(addflaglist.items()):
self.ui.addingflags(uids, flag, dstfolder) self.ui.addingflags(uids, flag, dstfolder)
if self.repository.account.dryrun: if self.repository.account.dryrun:
continue # Don't actually add in a dryrun. continue # Don't actually add in a dryrun.
dstfolder.addmessagesflags(uids, set(flag)) dstfolder.addmessagesflags(uids, set(flag))
statusfolder.addmessagesflags(uids, set(flag)) statusfolder.addmessagesflags(uids, set(flag))
for flag, uids in list(delflaglist.items()): for flag, uids in list(delflaglist.items()):
self.ui.deletingflags(uids, flag, dstfolder) self.ui.deletingflags(uids, flag, dstfolder)
if self.repository.account.dryrun: if self.repository.account.dryrun:
continue # Don't actually remove in a dryrun. continue # Don't actually remove in a dryrun.
dstfolder.deletemessagesflags(uids, set(flag)) dstfolder.deletemessagesflags(uids, set(flag))
statusfolder.deletemessagesflags(uids, set(flag)) statusfolder.deletemessagesflags(uids, set(flag))
@ -1119,12 +1111,12 @@ class BaseFolder(object):
except OfflineImapError as e: except OfflineImapError as e:
if e.severity > OfflineImapError.ERROR.FOLDER: if e.severity > OfflineImapError.ERROR.FOLDER:
raise raise
self.ui.error(e, exc_info()[2], "while syncing %s [account %s]"% self.ui.error(e, exc_info()[2], "while syncing %s [account %s]" %
(self, self.accountname)) (self, self.accountname))
except Exception as e: except Exception as e:
self.ui.error(e, exc_info()[2], "while syncing %s [account %s]"% self.ui.error(e, exc_info()[2], "while syncing %s [account %s]" %
(self, self.accountname)) (self, self.accountname))
raise # Raise unknown Exceptions so we can fix them. raise # Raise unknown Exceptions so we can fix them.
def __eq__(self, other): def __eq__(self, other):
"""Comparisons work either on string comparing folder names or """Comparisons work either on string comparing folder names or