Implement progress bars and fix a few bugs.

[hermes] / package / src / org / maemo / hermes / engine / hermes.py

diff --git a/package/src/org/maemo/hermes/engine/hermes.py b/package/src/org/maemo/hermes/engine/hermes.py
index fd19358..d60849e 100644 (file)
--- a/package/src/org/maemo/hermes/engine/hermes.py
+++ b/package/src/org/maemo/hermes/engine/hermes.py
@@ -16,13 +16,13 @@ class Hermes:
 
     
     # -----------------------------------------------------------------------
-    def __init__(self, services, gui_progress):
-        """Constructor. Passed a list of services, and a callback method
-           which must implement the following API.
-                              
-             progress(i, j) - the application is currently processing friend 'i' of
-                              'j'. Should be used to provide the user a progress bar.
-        """
+    def __init__(self, services, gui_progress=None):
+        """Constructor. Passed a list of services, and a            
+           method which will be invoked with three arguments:
+                str    Name of current step
+                int    Current position
+                int    Maximum value of position."""
+
         
         # -- These fields are currently part of the API...
         #
@@ -35,7 +35,7 @@ class Hermes:
         # -- Other initialisation...
         #
         self._services = services
-        self._progress = gui_progress
+        self._progress = gui_progress or (lambda msg, i, j: None)
     
     
     # -----------------------------------------------------------------------
@@ -43,7 +43,7 @@ class Hermes:
         """Load information on the authenticated user's friends. Synchronise Facebook
            profiles to contact database. If resync is false, no existing information
            will be overwritten."""
-
+           
         class FakeContact():
             def get_name(self):
                 return "Fredrik Wendt"
@@ -65,20 +65,31 @@ class Hermes:
     
     # -----------------------------------------------------------------------
     def run_alt(self, overwrite_existing_fields=False):
+        self._progress("Reading contacts...", 1, 10000)
+        
         contacts = []
         self.addresses = evolution.ebook.open_addressbook('default')
         for contact in self.addresses.get_all_contacts():
             contacts.append(Contact(self.addresses, contact))
 
+        # work out progress bar info
+        total_contacts = len(contacts) * len(self._services)
+        total_ticks    = 6 * total_contacts # Number of distinct loops below
+
         # warm up
+        current_tick = 1
         for service in self._services:
             print "pre-process:", service.get_id()
             for contact in contacts:
+                self._progress("Pre-processing contacts...", current_tick, total_ticks)
+                current_tick += 1
                 service.pre_process_contact(contact)
                 
         # fetch data
         for service in self._services:
             print "process_friends:", service.get_id()
+            self._progress("Reading friends...", current_tick, total_ticks)
+            current_tick += len(contacts)
             service.process_friends()
         
         # combine results into one friend
@@ -86,6 +97,8 @@ class Hermes:
             result = Friend()
             for service in self._services:
                 print "process_contact:", service.get_id()
+                self._progress("Processing contacts...", current_tick, total_ticks)
+                current_tick += 1
                 friend = service.process_contact(contact)
                 if friend:
                     contact.add_mapping(service.get_id())
@@ -99,18 +112,31 @@ class Hermes:
         # give services a chance to create new contacts
         for service in self._services:
             print "create_contacts:", service.get_id()
-            for friend in service.create_contacts():
+            to_create = service.get_friends_to_create_contacts_for()
+            tick_increment = len(contacts) / (len(to_create) or 1)
+            print tick_increment, to_create
+            for friend in to_create:
+                self._progress("Creating contacts...", current_tick, total_ticks)
+                current_tick += tick_increment
                 self.create_contact_from_friend(friend)
                 
         # finalisation
         for service in self._services:
             print "finalize:", service.get_id()
+            self._progress("Finalising...", current_tick, total_ticks)
+            current_tick += len(contacts)
             service.finalise(self.updated, overwrite_existing_fields)
             
         # commit changes
+        tick_increment = total_contacts / (len(self.updated) or 1)
+        print tick_increment, self.updated
         for contact in self.updated:
             print "committing changes to:", contact.get_name(), contact
+            self._progress("Saving changes...", current_tick, total_ticks)
+            current_tick += tick_increment
             self.addresses.commit_contact(contact.get_econtact())
+            
+        self._progress('Finished', 1, -1)
         
 
     # -----------------------------------------------------------------------
@@ -132,7 +158,7 @@ class Hermes:
         econtact.props.family_name = friend['last_name']
         contact = Contact(self.addresses, econtact)
                 
-        self.addresses.add_contact(contact)
+        self.addresses.add_contact(contact.get_econtact())
         self.update_contact(contact, friend)
         
         print "Created [%s]" % (contact.get_name())