Merge lp:~kevin-mehall/gtg/hamster-plugin into lp:~gtg/gtg/old-trunk

[Kevin Mehall]

Merge with Kevin Mehall's hamster-plugin branch

[Kevin Mehall (kevin-mehall)]

Added the ability to display related Hamster activities and time totals at the bottom of the task window. This required 2 changes to GTG core:
    - Add the ability to save arbitrary attributes with tasks
    - Add a function to the plugin API that adds a widget to the bottom of the tasks window (pcabido, please review this)

Also fixes bug #207291

[lp:~kevin-mehall/gtg/hamster-plugin]

308. By Kevin Mehall on 2009-07-31

Fix code that chooses Hamster activity

[Kevin Mehall (kevin-mehall)]

> Also fixes bug #207291
Typo: should be bug https://bugs.launchpad.net/gtg/+bug/407291

[lp:~kevin-mehall/gtg/hamster-plugin]

309. By Kevin Mehall on 2009-08-01

plugin api suggestions from pcabido

[Paulo Cabido (pcabido)]

review: Approve

=== modified file 'GTG/core/plugins/api.py'
--- GTG/core/plugins/api.py	2009-07-29 18:00:00 +0000
+++ GTG/core/plugins/api.py	2009-07-30 20:28:53 +0000
@@ -88,6 +88,13 @@
         except Exception, e:
             print "Error adding a toolbar item in to the TaskEditor: %s" % e
             
+    def add_task_window_region(self, widget):
+        "Adds a widget to the bottom of the task editor dialog"
+        v = self.__wTree.get_widget('vbox4')
+        v.pack_start(widget)
+        v.reorder_child(widget, -2)
+        widget.show_all()
+            
     # passes the requester to the plugin
     def get_requester(self):
         return self.__requester
@@ -182,4 +189,4 @@
     # add's a tid to the workview filter
     def add_task_to_workview_filter(self, tid):
         self.__workview_task_filter.append(tid)
-        
\ No newline at end of file
+        

=== modified file 'GTG/core/task.py'
--- GTG/core/task.py	2009-07-30 12:15:24 +0000
+++ GTG/core/task.py	2009-07-30 20:25:17 +0000
@@ -50,6 +50,7 @@
         self.loaded = newtask
         if self.loaded :
             self.req._task_loaded(self.tid)
+        self.attributes={}
                 
     def is_loaded(self) :
         return self.loaded
@@ -366,6 +367,24 @@
         else :
             to_return = len(self.parents)!=0
         return to_return
+        
+    def set_attribute(self, att_name, att_value, namespace=""):
+        """Set an arbitrary attribute.
+
+        @param att_name: The name of the attribute.
+        @param att_value: The value of the attribute. Will be converted to a
+            string.
+        """
+        val = unicode(str(att_value), "UTF-8")
+        self.attributes[(namespace,att_name)] = val
+        self.sync()
+        
+    def get_attribute(self, att_name, namespace=""):
+        """Get the attribute C{att_name}.
+
+        Returns C{None} if there is no attribute matching C{att_name}.
+        """
+        return self.attributes.get((namespace,att_name), None)
        
     #Method called before the task is deleted
     #This method is called by the datastore and should not be called directly

=== modified file 'GTG/plugins/hamster/hamster.py'
--- GTG/plugins/hamster/hamster.py	2009-07-30 15:43:14 +0000
+++ GTG/plugins/hamster/hamster.py	2009-07-31 15:34:47 +0000
@@ -19,15 +19,20 @@
 import gtk, pygtk
 import os
 import dbus
+import time
+from calendar import timegm
 
 class hamsterPlugin:
     PLUGIN_NAME = 'Hamster Time Tracker Integration'
     PLUGIN_AUTHORS = 'Kevin Mehall <[e-mail]>'
-    PLUGIN_VERSION = '0.1'
+    PLUGIN_VERSION = '0.2'
     PLUGIN_DESCRIPTION = 'Adds the ability to send a task to the Hamster time tracking applet'
     PLUGIN_ENABLED = False
-        
+    PLUGIN_NAMESPACE = 'hamster-plugin'
+    
+    #### Interaction with Hamster
     def sendTask(self, task):
+        """Send a gtg task to hamster-applet"""
         if task is None: return
         title=task.get_title()
         tags=task.get_tags_name()
@@ -39,22 +44,48 @@
         if len(activity_candidates)>=1:
             activity=list(activity_candidates)[0]
             #TODO: if >1, how to choose best one?
-        else:
+        elif len(activity_candidates)>0:
             #TODO: is there anything more reasonable that can be done?
             activity=tags[0]
+        else:
+            activity = "Other"
             
-        self.hamster.AddFact('%s,%s'%(activity, title), 0, 0)
-
-    def hamsterError(self):
-        d=gtk.MessageDialog(buttons=gtk.BUTTONS_CANCEL)
-        d.set_markup("<big>Error loading plugin</big>")
-        d.format_secondary_markup("This plugin requires hamster-applet 2.27.3 or greater\n\
-Please install hamster-applet and make sure the applet is added to the panel")
-        d.run()
-        d.destroy()
-
-    # plugin engine methods    
+        hamster_id=self.hamster.AddFact('%s,%s'%(activity, title), 0, 0)
+        
+        ids=self.get_hamster_ids(task)
+        ids.append(str(hamster_id))
+        self.set_hamster_ids(task, ids)
+        
+    def get_records(self, task):
+        """Get a list of hamster facts for a task"""
+        ids = self.get_hamster_ids(task)
+        records=[]
+        modified=False
+        valid_ids=[]
+        for i in ids:
+            d=self.hamster.GetFactById(i)
+            if d.get("id", None): # check if fact still exists
+                records.append(d)
+                valid_ids.append(i)
+            else:
+                modified=True
+                print "Removing invalid fact", i
+        if modified:
+            self.set_hamster_ids(task, valid_ids)
+        return records
+    
+    #### Datastore  
+    def get_hamster_ids(self, task):
+        a = task.get_attribute("id-list", namespace=self.PLUGIN_NAMESPACE)
+        if not a: return []
+        else: return a.split(',')
+        
+    def set_hamster_ids(self, task, ids):
+        task.set_attribute("id-list", ",".join(ids), namespace=self.PLUGIN_NAMESPACE)
+
+    #### Plugin api methods   
     def activate(self, plugin_api):
+        # connect to hamster-applet
         try:
             self.hamster=dbus.SessionBus().get_object('org.gnome.Hamster', '/org/gnome/Hamster')
             self.hamster.GetActivities()
@@ -62,25 +93,22 @@
             self.hamsterError()
             return False
         
+        # add menu item
         self.menu_item = gtk.MenuItem("Start task in Hamster")
         self.menu_item.connect('activate', self.browser_cb, plugin_api)
+        plugin_api.add_menu_item(self.menu_item)
         
+        # and button
         self.button=gtk.ToolButton()
         self.button.set_label("Start")
         self.button.set_icon_name('hamster-applet')
         self.button.set_tooltip_text("Start a new activity in Hamster Time Tracker based on the selected task")
         self.button.connect('clicked', self.browser_cb, plugin_api)
-        
-        # add a menu item to the menu bar
-        plugin_api.add_menu_item(self.menu_item)
-                
-        # saves the separator's index to later remove it
-        self.separator = plugin_api.add_toolbar_item(gtk.SeparatorToolItem())
-        # add a item (button) to the ToolBar
+        self.separator = plugin_api.add_toolbar_item(gtk.SeparatorToolItem()) # saves the separator's index to later remove it
         plugin_api.add_toolbar_item(self.button)
 
     def onTaskOpened(self, plugin_api):
-        # add a item (button) to the ToolBar
+        # add button
         self.taskbutton = gtk.ToolButton()
         self.taskbutton.set_label("Start")
         self.taskbutton.set_icon_name('hamster-applet')
@@ -89,6 +117,54 @@
         plugin_api.add_task_toolbar_item(gtk.SeparatorToolItem())
         plugin_api.add_task_toolbar_item(self.taskbutton)
         
+        task = plugin_api.get_task()
+        records = self.get_records(task)
+        
+        if len(records):
+            # add section to bottom of window
+            vbox = gtk.VBox()
+            inner_table = gtk.Table(rows=len(records), columns=2)
+            if len(records)>8:
+                s = gtk.ScrolledWindow()
+                s.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
+                v=gtk.Viewport()
+                v.add(inner_table)
+                s.add(v)
+                v.set_shadow_type(gtk.SHADOW_NONE)
+                s.set_size_request(-1, 150)
+            else:
+                s=inner_table
+            
+            outer_table = gtk.Table(rows=1, columns=2)
+            vbox.pack_start(s)
+            vbox.pack_start(outer_table)
+            vbox.pack_end(gtk.HSeparator())
+            
+            total = 0
+            
+            def add(w, a, b, offset):
+                dateLabel=gtk.Label(a)
+                dateLabel.set_use_markup(True)
+                dateLabel.set_alignment(xalign=0.0, yalign=0.5)
+                dateLabel.set_size_request(200, -1)
+                w.attach(dateLabel, left_attach=0, right_attach=1, top_attach=offset, 
+                    bottom_attach=offset+1, xoptions=gtk.FILL, xpadding=20, yoptions=0)
+                
+                durLabel=gtk.Label(b)
+                durLabel.set_use_markup(True)
+                durLabel.set_alignment(xalign=0.0, yalign=0.5)
+                w.attach(durLabel, left_attach=1, right_attach=2, top_attach=offset, 
+                bottom_attach=offset+1, xoptions=gtk.FILL, yoptions=0)
+            
+            for offset,i in enumerate(records):
+                t = calc_duration(i)    
+                total += t
+                add(inner_table, format_date(i), format_duration(t), offset)
+                
+            add(outer_table, "<big><b>Total</b></big>", "<big><b>%s</b></big>"%format_duration(total), 1)
+            
+            plugin_api.add_task_window_region(vbox)
+        
     def deactivate(self, plugin_api):
         plugin_api.remove_menu_item(self.menu_item)
         plugin_api.remove_toolbar_item(self.button)
@@ -99,5 +175,48 @@
         
     def task_cb(self, widget, plugin_api):
         self.sendTask(plugin_api.get_task())
-           
-    
+        
+    def hamsterError(self):
+        """Display error dialog"""
+        d=gtk.MessageDialog(buttons=gtk.BUTTONS_CANCEL)
+        d.set_markup("<big>Error loading plugin</big>")
+        d.format_secondary_markup("This plugin requires hamster-applet 2.27.3 or greater\n\
+Please install hamster-applet and make sure the applet is added to the panel")
+        d.run()
+        d.destroy()
+        
+#### Helper Functions  
+def format_date(task):
+    return time.strftime("<b>%A, %b %e</b> %l:%M %p", time.gmtime(task['start_time']))
+    
+def calc_duration(fact):
+    start=fact['start_time']
+    end=fact['end_time']
+    if not end: end=timegm(time.localtime())
+    return end-start
+
+def format_duration(seconds):
+    # Based on hamster-applet code -  hamster/stuff.py   
+    """formats duration in a human readable format."""
+    
+    minutes = seconds / 60
+        
+    if not minutes:
+        return "0min"
+    
+    hours = minutes / 60
+    minutes = minutes % 60
+    formatted_duration = ""
+    
+    if minutes % 60 == 0:
+        # duration in round hours
+        formatted_duration += "%dh" % (hours)
+    elif hours == 0:
+        # duration less than hour
+        formatted_duration += "%dmin" % (minutes % 60.0)
+    else:
+        # x hours, y minutes
+        formatted_duration += "%dh %dmin" % (hours, minutes % 60)
+
+    return formatted_duration
+   

=== modified file 'GTG/tools/taskxml.py'
--- GTG/tools/taskxml.py	2009-03-01 14:09:12 +0000
+++ GTG/tools/taskxml.py	2009-07-31 15:52:52 +0000
@@ -35,6 +35,15 @@
     for s in sub_list :
         sub_tid = s.childNodes[0].nodeValue
         cur_task.add_subtask(sub_tid)
+    attr_list = xmlnode.getElementsByTagName("attribute")
+    for a in attr_list:
+        if len(a.childNodes):
+            content = a.childNodes[0].nodeValue
+        else:
+            content = ""
+        key = a.getAttribute("key")
+        namespace = a.getAttribute("namespace")
+        cur_task.set_attribute(key, content, namespace=namespace)
     tasktext = xmlnode.getElementsByTagName("content")
     if len(tasktext) > 0 :
         if tasktext[0].firstChild :
@@ -67,6 +76,14 @@
     childs = task.get_subtasks_tid()
     for c in childs :
         cleanxml.addTextNode(doc,t_xml,"subtask",c)
+    for a in task.attributes:
+        namespace,key=a
+        content=task.attributes[a]
+        element = doc.createElement('attribute')
+        element.setAttribute("namespace", namespace)
+        element.setAttribute("key", key)
+        element.appendChild(doc.createTextNode(content))
+        t_xml.appendChild(element)
     tex = task.get_text()
     if tex :
         #We take the xml text and convert it to a string