Merge lp:~erigami/dockmanager/workrave_helper_improvements into lp:dockmanager

[Erigami]

I've made a couple of improvements to the workrave helper. Could they be merged in?

The changes are:
  - Hide seconds on launcher until we're under 5 min
  - Show a tooltip with the exact amount of time left for all launchers
  - remove unused variables

I've tested with both AWN and Docky.

[Erigami (erigami)]

Bump.

review: Needs Resubmitting

[Robert Dyer (psybers)]

review: Approve

[Erigami (erigami)]

Thanks!

=== modified file 'scripts/workrave_helper.py'
--- scripts/workrave_helper.py	2010-10-07 22:25:27 +0000
+++ scripts/workrave_helper.py	2010-11-13 22:28:59 +0000
@@ -35,6 +35,11 @@
     print `e`
     exit()
 
+break_names = {
+    'micro_pause' : "Micro break",
+    'rest_break' : 'Rest break',
+    'daily_limit' : 'Daily limit'
+}
 
 class Workrave:
     """Interface to Workrave."""
@@ -49,13 +54,16 @@
     def findNextEnd(self):
         """Find the next timer to go off.
 
-        Returns a tuple of (seconds-until-timer-ends, length-of-timer, name-of-timer), 
+        Returns an array of tuples. Each typle consists of 
+        (seconds-until-timer-ends, length-of-timer, time-timer-ends, name-of-timer), 
         where the timer is the next timer scheduled to end.
+
+        If there are no ticking timers, an empty array is returned. 
         """
         # Pick a really large number for the next timer
         remaining = 2 ** 18
-        remainingName = None
 
+        toReturn = []
         for (timerName, configName) in [['microbreak', 'micro_pause'], ['restbreak', 'rest_break'], ['dailylimit', 'daily_limit']]:
             if not self.workrave.IsTimerRunning(timerName):
                 continue
@@ -65,15 +73,16 @@
 
             elapsed = self.workrave.GetTimerElapsed(timerName)
             r = length - elapsed
-            remaining = min(remaining, r)
-            if r == remaining:
-                remainingName = timerName
-
-        if remainingName == None:
-            return (None, None, None)
-
-        return (remaining, length, remainingName)
-
+
+            tuple = (r, length, r + time.time(), configName)
+            toReturn.append(tuple)
+
+        def c(a, b):
+            return cmp(a[0], b[0])
+
+        toReturn.sort(c)
+
+        return toReturn
 
 
 class WorkraveWatcher:
@@ -82,16 +91,16 @@
     def __init__(self):
         self.wr = Workrave()
         self.dock_item = None
-        self.next_break = 0
         self.workrave_state = None
+        self.breaks = []
         self.timers = []
 
 
     def on_service_change(self, bus, conn):
         if "" == conn:
             # Workrave has gone away
-            self.next_break = 0
             self.workrave_state = None
+            self.breaks = []
             
             for timer in self.timers:
                 gobject.source_remove(timer)
@@ -119,49 +128,77 @@
 
     def __state_change(self, timer, progress):
         self.workrave_state = progress
-
-        if progress == 'none':
-            self.next_break = 0
+        self.__poll_workrave()
 
 
     def __poll_workrave(self):
-        (rem, length, timer) = self.wr.findNextEnd()
-        if not rem == None:
-            self.next_break = rem + time.time()
-            self.duration = length
+        self.breaks = self.wr.findNextEnd()
 
         return True
 
-
     def __update_ui(self):
         message = ""
         progress = 0
         if self.workrave_state == 'break':
             message = 'Break'
         else:
-            if self.next_break <= 0:
-                message = "(paused)"
+            next_break = 0
+            duration = 0
+            if len(self.breaks) > 0:
+                next_break = self.breaks[0][2]
+                duration = self.breaks[0][1]
+
+            if next_break <= 0:
+                message = "(pause)"
             else:
-                rem = self.next_break - time.time()
+                rem = next_break - time.time()
+                message = self.__humanize_time(rem)
                 if rem < 0:
-                    minutes = -1 * math.ceil(float(rem) / 60)
-                    seconds = (-1 * rem) % 60
-                    message = "-%i:%02i" % (minutes, seconds)
                     progress = 100
                 else:
-                    minutes = int(rem / 60)
-                    seconds = rem % 60
-                    message = "%i:%02i" % (minutes, seconds)
-            
-                    progress = 100 - int(100 * (float(rem) / float(self.duration)))
+                    progress = 100 - int(100 * (float(rem) / float(duration)))
 
         if self.dock_item:
             self.dock_item.set_message(message)
             self.dock_item.set_progress(progress)
+            self.dock_item.set_tooltip(self.__calculate_tooltip())
 
         return True
 
-
+    def __calculate_tooltip(self):
+        toReturn = ''
+
+        for timer in self.breaks:
+            if len(toReturn) > 0:
+                toReturn = toReturn + ",  "
+
+            secondsLeft = int(timer[2] - time.time())
+            msg = self.__humanize_time(secondsLeft, False)
+            toReturn = toReturn + ("%s in %s" % (break_names[timer[3]], msg))
+
+        if len(toReturn) == 0:
+            toReturn = 'Workrave'
+
+        toReturn = toReturn + "  "
+
+        return toReturn
+            
+
+    def __humanize_time(self, rem, hide_seconds=True):
+        if rem < 0:
+            minutes = -1 * math.ceil(float(rem) / 60)
+            seconds = (-1 * rem) % 60
+            message = "-%i:%02i" % (minutes, seconds)
+        else:
+            minutes = int(rem / 60)
+            seconds = rem % 60
+            if hide_seconds and minutes >= 5:
+                message = "%im" % minutes
+            else:
+                message = "%i:%02i" % (minutes, seconds)
+        
+        return message
+        
     def register_dock_item(self, item):
         self.dock_item = item
 
@@ -210,6 +247,7 @@
 
 sink = WorkraveSink()
 
+
 if __name__ == "__main__":
     bus = dbus.SessionBus()
     bus.watch_name_owner("org.workrave.Workrave", lambda x: watcher.on_service_change(bus, x))