From c8dbd705467ed6d15bc443939c06997fcee5b91b Mon Sep 17 00:00:00 2001
From: Charles Haley <>
Date: Sun, 26 Sep 2010 13:48:30 +0100
Subject: [PATCH] metadata backup that gets metadata on the GUI thread,
 computes the OPF on a separate thread, then writes the file on the GUI
 thread.

---
 src/calibre/gui2/library/models.py |  1 +
 src/calibre/library/caches.py      | 26 ++++++++++++++++++--------
 src/calibre/library/database2.py   | 23 +++++++++++++++++++++++
 3 files changed, 42 insertions(+), 8 deletions(-)

diff --git a/src/calibre/gui2/library/models.py b/src/calibre/gui2/library/models.py
index ef251a884a..b908019bcb 100644
--- a/src/calibre/gui2/library/models.py
+++ b/src/calibre/gui2/library/models.py
@@ -89,6 +89,7 @@ class BooksModel(QAbstractTableModel): # {{{
         self.alignment_map = {}
         self.buffer_size = buffer
         self.cover_cache = None
+        self.metadata_backup = None
         self.bool_yes_icon = QIcon(I('ok.png'))
         self.bool_no_icon = QIcon(I('list_remove.png'))
         self.bool_blank_icon = QIcon(I('blank.png'))
diff --git a/src/calibre/library/caches.py b/src/calibre/library/caches.py
index 8d449974a5..7d8a8624a9 100644
--- a/src/calibre/library/caches.py
+++ b/src/calibre/library/caches.py
@@ -19,6 +19,7 @@ from calibre.utils.date import parse_date, now, UNDEFINED_DATE
 from calibre.utils.search_query_parser import SearchQueryParser
 from calibre.utils.pyparsing import ParseException
 from calibre.ebooks.metadata import title_sort
+from calibre.ebooks.metadata.opf2 import metadata_to_opf
 from calibre import fit_image, prints
 
 class MetadataBackup(Thread): # {{{
@@ -36,6 +37,8 @@ class MetadataBackup(Thread): # {{{
         self.keep_running = True
         from calibre.gui2 import FunctionDispatcher
         self.do_write = FunctionDispatcher(self.write)
+        self.get_metadata_for_dump = FunctionDispatcher(db.get_metadata_for_dump)
+        self.clear_dirtied = FunctionDispatcher(db.clear_dirtied)
 
     def stop(self):
         self.keep_running = False
@@ -43,6 +46,7 @@ class MetadataBackup(Thread): # {{{
     def run(self):
         while self.keep_running:
             try:
+                time.sleep(0.5) # Limit to two per second
                 id_ = self.db.dirtied_queue.get(True, 2)
             except Empty:
                 continue
@@ -50,25 +54,27 @@ class MetadataBackup(Thread): # {{{
                 # Happens during interpreter shutdown
                 break
 
-            dump = []
             try:
-                self.db.dump_metadata([id_], dump_to=dump)
+                path, mi = self.get_metadata_for_dump(id_)
             except:
                 prints('Failed to get backup metadata for id:', id_, 'once')
                 import traceback
                 traceback.print_exc()
                 time.sleep(2)
-                dump = []
                 try:
-                    self.db.dump_metadata([id_], dump_to=dump)
+                    path, mi = self.get_metadata_for_dump(id_)
                 except:
                     prints('Failed to get backup metadata for id:', id_, 'again, giving up')
                     traceback.print_exc()
                     continue
             try:
-                path, raw = dump[0]
+                print 'now do metadata'
+                raw = metadata_to_opf(mi)
             except:
-                break
+                prints('Failed to convert to opf for id:', id_)
+                traceback.print_exc()
+                continue
+
             try:
                 self.do_write(path, raw)
             except:
@@ -79,8 +85,12 @@ class MetadataBackup(Thread): # {{{
                 except:
                     prints('Failed to write backup metadata for id:', id_,
                             'again, giving up')
+                    continue
 
-            time.sleep(0.5) # Limit to two per second
+            try:
+                self.clear_dirtied([id_])
+            except:
+                prints('Failed to clear dirtied for id:', id_)
 
     def write(self, path, raw):
         with open(path, 'wb') as f:
@@ -106,7 +116,6 @@ class CoverCache(Thread): # {{{
         self.keep_running = False
 
     def _image_for_id(self, id_):
-        time.sleep(0.050) # Limit 20/second to not overwhelm the GUI
         img = self.cover_func(id_, index_is_id=True, as_image=True)
         if img is None:
             img = QImage()
@@ -122,6 +131,7 @@ class CoverCache(Thread): # {{{
     def run(self):
         while self.keep_running:
             try:
+                time.sleep(0.050) # Limit 20/second to not overwhelm the GUI
                 id_ = self.load_queue.get(True, 2)
             except Empty:
                 continue
diff --git a/src/calibre/library/database2.py b/src/calibre/library/database2.py
index a6f3f286bc..e6587f06a2 100644
--- a/src/calibre/library/database2.py
+++ b/src/calibre/library/database2.py
@@ -566,6 +566,24 @@ class LibraryDatabase2(LibraryDatabase, SchemaUpgrade, CustomColumns):
     def metadata_for_field(self, key):
         return self.field_metadata[key]
 
+    def clear_dirtied(self, book_ids=None):
+        '''
+        Clear the dirtied indicator for the books. This is used when fetching
+        metadata, creating an OPF, and writing a file are separated into steps.
+        The last step is clearing the indicator
+        '''
+        for book_id in book_ids:
+            if not self.data.has_id(book_id):
+                continue
+            self.conn.execute('DELETE FROM metadata_dirtied WHERE book=?',
+                    (book_id,))
+            # if a later exception prevents the commit, then the dirtied
+            # table will still have the book. No big deal, because the OPF
+            # is there and correct. We will simply do it again on next
+            # start
+            self.dirtied_cache.discard(book_id)
+        self.conn.commit()
+
     def dump_metadata(self, book_ids=None, remove_from_dirtied=True,
             commit=True, dump_to=None):
         '''
@@ -638,6 +656,11 @@ class LibraryDatabase2(LibraryDatabase, SchemaUpgrade, CustomColumns):
         self.dirtied_cache = set()
         self.dirtied(book_ids)
 
+    def get_metadata_for_dump(self, idx):
+        path = os.path.join(self.abspath(idx, index_is_id=True), 'metadata.opf')
+        mi = self.get_metadata(idx, index_is_id=True)
+        return ((path, mi))
+
     def get_metadata(self, idx, index_is_id=False, get_cover=False):
         '''
         Convenience method to return metadata as a :class:`Metadata` object.