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

Reformat offlineimap/folder/LocalStatusSQLite.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:45:15 +02:00
parent cb95bc87b0
commit 265de25460
1 changed files with 29 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
offlineimap/folder/LocalStatusSQLite.py
View File

@ -69,22 +69,22 @@ class LocalStatusSQLiteFolder(BaseFolder):
# Current version of our db format. # Current version of our db format.
cur_version = 2 cur_version = 2
# Keep track on how many threads need access to the database. # Keep track on how many threads need access to the database.
locks = {} # Key: filename, value: DatabaseFileLock instance. locks = {} # Key: filename, value: DatabaseFileLock instance.
def __init__(self, name, repository): def __init__(self, name, repository):
self.sep = '.' # Needs to be set before super().__init__(). self.sep = '.' # Needs to be set before super().__init__().
super(LocalStatusSQLiteFolder, self).__init__(name, repository) super(LocalStatusSQLiteFolder, self).__init__(name, repository)
self.root = repository.root self.root = repository.root
self.filename = os.path.join(self.getroot(), self.getfolderbasename()) self.filename = os.path.join(self.getroot(), self.getfolderbasename())
self._newfolder = False # Flag if the folder is new. self._newfolder = False # Flag if the folder is new.
dirname = os.path.dirname(self.filename) dirname = os.path.dirname(self.filename)
if not os.path.exists(dirname): if not os.path.exists(dirname):
os.makedirs(dirname) os.makedirs(dirname)
if not os.path.isdir(dirname): if not os.path.isdir(dirname):
raise UserWarning("SQLite database path '%s' is not a directory."% raise UserWarning("SQLite database path '%s' is not a directory." %
dirname) dirname)
self.connection = None self.connection = None
# The lock serialize the writing/open/close of database accross threads. # The lock serialize the writing/open/close of database accross threads.
@ -121,7 +121,7 @@ class LocalStatusSQLiteFolder(BaseFolder):
UserWarning( UserWarning(
"cannot open database file '%s': %s.\nYou might" "cannot open database file '%s': %s.\nYou might"
" want to check the rights to that file and if " " want to check the rights to that file and if "
"it cleanly opens with the 'sqlite<3>' command"% "it cleanly opens with the 'sqlite<3>' command" %
(self.filename, e)), (self.filename, e)),
exc_info()[2]) exc_info()[2])
@ -144,8 +144,8 @@ class LocalStatusSQLiteFolder(BaseFolder):
try: try:
os.unlink(self.filename) os.unlink(self.filename)
except OSError as e: except OSError as e:
self.ui.debug('', "could not remove file %s: %s"% self.ui.debug('', "could not remove file %s: %s" %
(self.filename, e)) (self.filename, e))
def storesmessages(self): def storesmessages(self):
return False return False
@ -197,15 +197,15 @@ class LocalStatusSQLiteFolder(BaseFolder):
"""Upgrade the sqlite format from version 'from_ver' to current""" """Upgrade the sqlite format from version 'from_ver' to current"""
if self.connection is not None: if self.connection is not None:
self.connection.close() # Close old connections first. self.connection.close() # Close old connections first.
self.connection = sqlite.connect(self.filename, self.connection = sqlite.connect(self.filename,
check_same_thread=False) check_same_thread=False)
# Upgrade from database version 1 to version 2 # Upgrade from database version 1 to version 2
# This change adds labels and mtime columns, to be used by Gmail IMAP and Maildir folders. # This change adds labels and mtime columns, to be used by Gmail IMAP and Maildir folders.
if from_ver <= 1: if from_ver <= 1:
self.ui._msg('Upgrading LocalStatus cache from version 1 to version 2 for %s:%s'% self.ui._msg('Upgrading LocalStatus cache from version 1 to version 2 for %s:%s' %
(self.repository, self)) (self.repository, self))
self.connection.executescript("""ALTER TABLE status ADD mtime INTEGER DEFAULT 0; self.connection.executescript("""ALTER TABLE status ADD mtime INTEGER DEFAULT 0;
ALTER TABLE status ADD labels VARCHAR(256) DEFAULT ''; ALTER TABLE status ADD labels VARCHAR(256) DEFAULT '';
UPDATE metadata SET value='2' WHERE key='db_version'; UPDATE metadata SET value='2' WHERE key='db_version';
@ -216,13 +216,12 @@ class LocalStatusSQLiteFolder(BaseFolder):
# if from_ver <= 2: ... #upgrade from 2 to 3 # if from_ver <= 2: ... #upgrade from 2 to 3
# if from_ver <= 3: ... #upgrade from 3 to 4 # if from_ver <= 3: ... #upgrade from 3 to 4
def __create_db(self): def __create_db(self):
"""Create a new db file. """Create a new db file.
self.connection must point to the opened and valid SQlite self.connection must point to the opened and valid SQlite
database connection.""" database connection."""
self.ui._msg('Creating new Local Status db for %s:%s'% self.ui._msg('Creating new Local Status db for %s:%s' %
(self.repository, self)) (self.repository, self))
self.connection.executescript(""" self.connection.executescript("""
CREATE TABLE metadata (key VARCHAR(50) PRIMARY KEY, value VARCHAR(128)); CREATE TABLE metadata (key VARCHAR(50) PRIMARY KEY, value VARCHAR(128));
@ -232,12 +231,10 @@ class LocalStatusSQLiteFolder(BaseFolder):
self.connection.commit() self.connection.commit()
self._newfolder = True self._newfolder = True
# Interface from BaseFolder # Interface from BaseFolder
def msglist_item_initializer(self, uid): def msglist_item_initializer(self, uid):
return {'uid': uid, 'flags': set(), 'labels': set(), 'time': 0, 'mtime': 0} return {'uid': uid, 'flags': set(), 'labels': set(), 'time': 0, 'mtime': 0}
# Interface from BaseFolder # Interface from BaseFolder
def cachemessagelist(self): def cachemessagelist(self):
self.dropmessagelistcache() self.dropmessagelistcache()
@ -248,7 +245,7 @@ class LocalStatusSQLiteFolder(BaseFolder):
flags = set(row[1]) flags = set(row[1])
try: try:
labels = set([lb.strip() for lb in labels = set([lb.strip() for lb in
row[3].split(',') if len(lb.strip()) > 0]) row[3].split(',') if len(lb.strip()) > 0])
except AttributeError: except AttributeError:
# FIXME: This except clause was introduced because row[3] from # FIXME: This except clause was introduced because row[3] from
# database can be found of unexpected type NoneType. See # database can be found of unexpected type NoneType. See
@ -291,9 +288,8 @@ class LocalStatusSQLiteFolder(BaseFolder):
data.append((uid, flags, mtime, labels)) data.append((uid, flags, mtime, labels))
self.__sql_write('INSERT OR REPLACE INTO status ' self.__sql_write('INSERT OR REPLACE INTO status '
'(id,flags,mtime,labels) VALUES (?,?,?,?)', '(id,flags,mtime,labels) VALUES (?,?,?,?)',
data, executemany=True) data, executemany=True)
# Following some pure SQLite functions, where we chose to use # Following some pure SQLite functions, where we chose to use
# BaseFolder() methods instead. Doing those on the in-memory list is # BaseFolder() methods instead. Doing those on the in-memory list is
@ -301,14 +297,14 @@ class LocalStatusSQLiteFolder(BaseFolder):
# maintain the in-memory list anymore, these might come in handy # maintain the in-memory list anymore, these might come in handy
# in the future though. # in the future though.
# #
#def uidexists(self,uid): # def uidexists(self,uid):
# conn, cursor = self.get_cursor() # conn, cursor = self.get_cursor()
# with conn: # with conn:
# cursor.execute('SELECT id FROM status WHERE id=:id',{'id': uid}) # cursor.execute('SELECT id FROM status WHERE id=:id',{'id': uid})
# return cursor.fetchone() # return cursor.fetchone()
# This would be the pure SQLite solution, use BaseFolder() method, # This would be the pure SQLite solution, use BaseFolder() method,
# to avoid threading with sqlite... # to avoid threading with sqlite...
#def getmessageuidlist(self): # def getmessageuidlist(self):
# conn, cursor = self.get_cursor() # conn, cursor = self.get_cursor()
# with conn: # with conn:
# cursor.execute('SELECT id from status') # cursor.execute('SELECT id from status')
@ -316,12 +312,12 @@ class LocalStatusSQLiteFolder(BaseFolder):
# for row in cursor: # for row in cursor:
# r.append(row[0]) # r.append(row[0])
# return r # return r
#def getmessagecount(self): # def getmessagecount(self):
# conn, cursor = self.get_cursor() # conn, cursor = self.get_cursor()
# with conn: # with conn:
# cursor.execute('SELECT count(id) from status'); # cursor.execute('SELECT count(id) from status');
# return cursor.fetchone()[0] # return cursor.fetchone()[0]
#def getmessageflags(self, uid): # def getmessageflags(self, uid):
# conn, cursor = self.get_cursor() # conn, cursor = self.get_cursor()
# with conn: # with conn:
# cursor.execute('SELECT flags FROM status WHERE id=:id', # cursor.execute('SELECT flags FROM status WHERE id=:id',
@ -331,7 +327,6 @@ class LocalStatusSQLiteFolder(BaseFolder):
# return flags # return flags
# assert False,"getmessageflags() called on non-existing message" # assert False,"getmessageflags() called on non-existing message"
# Interface from BaseFolder # Interface from BaseFolder
def savemessage(self, uid, content, flags, rtime, mtime=0, labels=set()): def savemessage(self, uid, content, flags, rtime, mtime=0, labels=set()):
"""Writes a new message, with the specified uid. """Writes a new message, with the specified uid.
@ -344,7 +339,7 @@ class LocalStatusSQLiteFolder(BaseFolder):
# We cannot assign a uid. # We cannot assign a uid.
return uid return uid
if self.uidexists(uid): # Already have it. if self.uidexists(uid): # Already have it.
self.savemessageflags(uid, flags) self.savemessageflags(uid, flags)
return uid return uid
@ -354,37 +349,33 @@ class LocalStatusSQLiteFolder(BaseFolder):
labels = ', '.join(sorted(labels)) labels = ', '.join(sorted(labels))
try: try:
self.__sql_write('INSERT INTO status (id,flags,mtime,labels) VALUES (?,?,?,?)', self.__sql_write('INSERT INTO status (id,flags,mtime,labels) VALUES (?,?,?,?)',
(uid,flags,mtime,labels)) (uid, flags, mtime, labels))
except Exception as e: except Exception as e:
six.reraise(UserWarning, six.reraise(UserWarning,
UserWarning("%s while inserting UID %s"% UserWarning("%s while inserting UID %s" %
(str(e), str(uid))), (str(e), str(uid))),
exc_info()[2]) exc_info()[2])
return uid return uid
# Interface from BaseFolder # Interface from BaseFolder
def savemessageflags(self, uid, flags): def savemessageflags(self, uid, flags):
assert self.uidexists(uid) assert self.uidexists(uid)
self.messagelist[uid]['flags'] = flags self.messagelist[uid]['flags'] = flags
flags = ''.join(sorted(flags)) flags = ''.join(sorted(flags))
self.__sql_write('UPDATE status SET flags=? WHERE id=?',(flags,uid)) self.__sql_write('UPDATE status SET flags=? WHERE id=?', (flags, uid))
def getmessageflags(self, uid): def getmessageflags(self, uid):
return self.messagelist[uid]['flags'] return self.messagelist[uid]['flags']
def savemessagelabels(self, uid, labels, mtime=None): def savemessagelabels(self, uid, labels, mtime=None):
self.messagelist[uid]['labels'] = labels self.messagelist[uid]['labels'] = labels
if mtime: self.messagelist[uid]['mtime'] = mtime if mtime: self.messagelist[uid]['mtime'] = mtime
labels = ', '.join(sorted(labels)) labels = ', '.join(sorted(labels))
if mtime: if mtime:
self.__sql_write('UPDATE status SET labels=?, mtime=? WHERE id=?',(labels,mtime,uid)) self.__sql_write('UPDATE status SET labels=?, mtime=? WHERE id=?', (labels, mtime, uid))
else: else:
self.__sql_write('UPDATE status SET labels=? WHERE id=?',(labels,uid)) self.__sql_write('UPDATE status SET labels=? WHERE id=?', (labels, uid))
def savemessageslabelsbulk(self, labels): def savemessageslabelsbulk(self, labels):
""" """
@ -396,7 +387,6 @@ class LocalStatusSQLiteFolder(BaseFolder):
for uid, l in list(labels.items()): for uid, l in list(labels.items()):
self.messagelist[uid]['labels'] = l self.messagelist[uid]['labels'] = l
def addmessageslabels(self, uids, labels): def addmessageslabels(self, uids, labels):
data = [] data = []
for uid in uids: for uid in uids:
@ -406,7 +396,6 @@ class LocalStatusSQLiteFolder(BaseFolder):
for uid in uids: for uid in uids:
self.messagelist[uid]['labels'] = self.messagelist[uid]['labels'] | labels self.messagelist[uid]['labels'] = self.messagelist[uid]['labels'] | labels
def deletemessageslabels(self, uids, labels): def deletemessageslabels(self, uids, labels):
data = [] data = []
for uid in uids: for uid in uids:
@ -416,11 +405,9 @@ class LocalStatusSQLiteFolder(BaseFolder):
for uid in uids: for uid in uids:
self.messagelist[uid]['labels'] = self.messagelist[uid]['labels'] - labels self.messagelist[uid]['labels'] = self.messagelist[uid]['labels'] - labels
def getmessagelabels(self, uid): def getmessagelabels(self, uid):
return self.messagelist[uid]['labels'] return self.messagelist[uid]['labels']
def savemessagesmtimebulk(self, mtimes): def savemessagesmtimebulk(self, mtimes):
"""Saves mtimes from the mtimes dictionary in a single database operation.""" """Saves mtimes from the mtimes dictionary in a single database operation."""
@ -429,17 +416,15 @@ class LocalStatusSQLiteFolder(BaseFolder):
for uid, mt in list(mtimes.items()): for uid, mt in list(mtimes.items()):
self.messagelist[uid]['mtime'] = mt self.messagelist[uid]['mtime'] = mt
def getmessagemtime(self, uid): def getmessagemtime(self, uid):
return self.messagelist[uid]['mtime'] return self.messagelist[uid]['mtime']
# Interface from BaseFolder # Interface from BaseFolder
def deletemessage(self, uid): def deletemessage(self, uid):
if not uid in self.messagelist: if not uid in self.messagelist:
return return
self.__sql_write('DELETE FROM status WHERE id=?', (uid, )) self.__sql_write('DELETE FROM status WHERE id=?', (uid,))
del(self.messagelist[uid]) del (self.messagelist[uid])
# Interface from BaseFolder # Interface from BaseFolder
def deletemessages(self, uidlist): def deletemessages(self, uidlist):
@ -456,4 +441,4 @@ class LocalStatusSQLiteFolder(BaseFolder):
# arg2 needs to be an iterable of 1-tuples [(1,),(2,),...] # arg2 needs to be an iterable of 1-tuples [(1,),(2,),...]
self.__sql_write('DELETE FROM status WHERE id=?', list(zip(uidlist, )), True) self.__sql_write('DELETE FROM status WHERE id=?', list(zip(uidlist, )), True)
for uid in uidlist: for uid in uidlist:
del(self.messagelist[uid]) del (self.messagelist[uid])