Adding the source code (now that I've removed my hard coded credentials)
[doneit] / src / gtk_rtmilk.py
diff --git a/src/gtk_rtmilk.py b/src/gtk_rtmilk.py
new file mode 100644 (file)
index 0000000..e92c0fb
--- /dev/null
@@ -0,0 +1,322 @@
+import webbrowser
+import datetime
+import urlparse
+
+import gobject
+import gtk
+
+import toolbox
+import gtk_toolbox
+import rtmilk
+import rtmapi
+
+
+def abbreviate(text, expectedLen):
+       singleLine = " ".join(text.split("\n"))
+       lineLen = len(singleLine)
+       if lineLen <= expectedLen:
+               return singleLine
+
+       abbrev = "..."
+
+       leftLen = expectedLen // 2 - 1
+       rightLen = max(expectedLen - leftLen - len(abbrev) + 1, 1)
+
+       abbrevText =  singleLine[0:leftLen] + abbrev + singleLine[-rightLen:-1]
+       assert len(abbrevText) <= expectedLen, "Too long: '%s'" % abbrevText
+       return abbrevText
+
+
+def abbreviate_url(url, domainLength, pathLength):
+       urlParts = urlparse.urlparse(url)
+
+       netloc = urlParts.netloc
+       path = urlParts.path
+
+       pathLength += max(domainLength - len(netloc), 0)
+       domainLength += max(pathLength - len(path), 0)
+
+       netloc = abbreviate(netloc, domainLength)
+       path = abbreviate(path, pathLength)
+       return netloc + path
+
+
+def get_token(username, apiKey, secret):
+       token = None
+       rtm = rtmapi.RTMapi(username, apiKey, secret, token)
+
+       authURL = rtm.getAuthURL()
+       webbrowser.open(authURL)
+       mb = gtk_toolbox.MessageBox2("You need to authorize DoneIt with\nRemember The Milk.\nClick OK after you authorize.")
+       mb.run()
+
+       token = rtm.getToken()
+       return token
+
+
+class GtkRtMilk(object):
+
+       ID_IDX = 0
+       COMPLETION_IDX = 1
+       NAME_IDX = 2
+       PRIORITY_IDX = 3
+       DUE_IDX = 4
+       FUZZY_IDX = 5
+       LINK_IDX = 6
+       NOTES_IDX = 7
+
+       def __init__(self, widgetTree):
+               """
+               @note Thread agnostic
+               """
+               self._clipboard = gtk.clipboard_get()
+
+               self._showCompleted = False
+               self._showIncomplete = True
+
+               self._editDialog = gtk_toolbox.EditTaskDialog(widgetTree)
+
+               self._projectsList = gtk.ListStore(gobject.TYPE_STRING)
+               self._projectsCombo = widgetTree.get_widget("projectsCombo")
+               self._onListActivateId = 0
+
+               self._itemList = gtk.ListStore(
+                       gobject.TYPE_STRING, # id
+                       gobject.TYPE_BOOLEAN,   # is complete
+                       gobject.TYPE_STRING, # name
+                       gobject.TYPE_STRING, # priority
+                       gobject.TYPE_STRING, # due
+                       gobject.TYPE_STRING, # fuzzy due
+                       gobject.TYPE_STRING, # Link
+                       gobject.TYPE_STRING, # Notes
+               )
+               self._completionColumn = gtk.TreeViewColumn('') # Complete?
+               self._completionCell = gtk.CellRendererToggle()
+               self._completionCell.set_property("activatable", True)
+               self._completionCell.connect("toggled", self._on_completion_change)
+               self._completionColumn.pack_start(self._completionCell, False)
+               self._completionColumn.set_attributes(self._completionCell, active=self.COMPLETION_IDX)
+               self._priorityColumn = gtk.TreeViewColumn('') # Priority
+               self._priorityCell = gtk.CellRendererText()
+               self._priorityColumn.pack_start(self._priorityCell, False)
+               self._priorityColumn.set_attributes(self._priorityCell, text=self.PRIORITY_IDX)
+               self._nameColumn = gtk.TreeViewColumn('Name')
+               self._nameCell = gtk.CellRendererText()
+               self._nameColumn.pack_start(self._nameCell, True)
+               self._nameColumn.set_attributes(self._nameCell, text=self.NAME_IDX)
+               self._dueColumn = gtk.TreeViewColumn('Due')
+               self._dueCell = gtk.CellRendererText()
+               self._dueColumn.pack_start(self._nameCell, False)
+               self._dueColumn.set_attributes(self._nameCell, text=self.DUE_IDX)
+               self._linkColumn = gtk.TreeViewColumn('') # Link
+               self._linkCell = gtk.CellRendererText()
+               self._linkColumn.pack_start(self._nameCell, False)
+               self._linkColumn.set_attributes(self._nameCell, text=self.LINK_IDX)
+               self._notesColumn = gtk.TreeViewColumn('') # Notes
+               self._notesCell = gtk.CellRendererText()
+               self._notesColumn.pack_start(self._nameCell, False)
+               self._notesColumn.set_attributes(self._nameCell, text=self.NOTES_IDX)
+
+               self._todoItemTree = widgetTree.get_widget("todoItemTree")
+               self._onItemSelectId = 0
+
+               self._taskNameEntry = widgetTree.get_widget("add-taskNameEntry")
+               self._addTaskButton = widgetTree.get_widget("add-addTaskButton")
+               self._pasteTaskNameButton = widgetTree.get_widget("add-pasteTaskNameButton")
+               self._clearTaskNameButton = widgetTree.get_widget("add-clearTaskNameButton")
+               self._onAddId = None
+               self._onAddClickedId = None
+               self._onAddReleasedId = None
+               self._addToEditTimerId = None
+               self._onClearId = None
+               self._onPasteId = None
+
+               self._credentials = gtk_toolbox.LoginWindow(widgetTree)
+               self._manager = None
+
+       @staticmethod
+       def name():
+               return "Remember The Milk"
+
+       def start_session(self):
+               username, password = self._credentials.request_credentials()
+               token = get_token(username, rtmilk.RtMilkManager.API_KEY, rtmilk.RtMilkManager.SECRET)
+               return rtmilk.RtMilkManager(username, password, token)
+
+       def enable(self):
+               """
+               @note UI Thread
+               """
+               self._manager = self.start_session()
+
+               self._projectsList.clear()
+               self._populate_projects()
+
+               self._itemList.clear()
+               self._todoItemTree.append_column(self._completionColumn)
+               self._todoItemTree.append_column(self._priorityColumn)
+               self._todoItemTree.append_column(self._nameColumn)
+               self._todoItemTree.append_column(self._dueColumn)
+               self._todoItemTree.append_column(self._linkColumn)
+               self._todoItemTree.append_column(self._notesColumn)
+               self._reset_task_list()
+
+               self._todoItemTree.set_headers_visible(False)
+               self._nameColumn.set_expand(True)
+
+               self._editDialog.enable(self._manager)
+
+               self._onListActivateId = self._projectsCombo.connect("changed", self._on_list_activate)
+               self._onItemSelectId = self._todoItemTree.connect("row-activated", self._on_item_select)
+               self._onAddId = self._addTaskButton.connect("clicked", self._on_add)
+               self._onAddClickedId = self._addTaskButton.connect("pressed", self._on_add_pressed)
+               self._onAddReleasedId = self._addTaskButton.connect("released", self._on_add_released)
+               self._onPasteId = self._pasteTaskNameButton.connect("clicked", self._on_paste)
+               self._onClearId = self._clearTaskNameButton.connect("clicked", self._on_clear)
+
+       def disable(self):
+               """
+               @note UI Thread
+               """
+               self._projectsCombo.disconnect(self._onListActivateId)
+               self._todoItemTree.disconnect(self._onItemSelectId)
+               self._addTaskButton.disconnect(self._onAddId)
+               self._addTaskButton.disconnect(self._onAddClickedId)
+               self._addTaskButton.disconnect(self._onAddReleasedId)
+               self._pasteTaskNameButton.disconnect(self._onPasteId)
+               self._clearTaskNameButton.disconnect(self._onClearId)
+
+               self._editDialog.disable()
+
+               self._projectsList.clear()
+               self._projectsCombo.set_model(None)
+               self._projectsCombo.disconnect("changed", self._on_list_activate)
+
+               self._todoItemTree.remove_column(self._completionColumn)
+               self._todoItemTree.remove_column(self._priorityColumn)
+               self._todoItemTree.remove_column(self._nameColumn)
+               self._todoItemTree.remove_column(self._dueColumn)
+               self._todoItemTree.remove_column(self._linkColumn)
+               self._todoItemTree.remove_column(self._notesColumn)
+               self._itemList.clear()
+               self._itemList.set_model(None)
+
+               self._manager = None
+
+       def _populate_projects(self):
+               for project in self._manager.get_projects():
+                       projectName = project["name"]
+                       isVisible = project["isVisible"]
+                       row = (projectName, )
+                       if isVisible:
+                               self._projectsList.append(row)
+               self._projectsCombo.set_model(self._projectsList)
+               cell = gtk.CellRendererText()
+               self._projectsCombo.pack_start(cell, True)
+               self._projectsCombo.add_attribute(cell, 'text', 0)
+               self._projectsCombo.set_active(0)
+
+       def _reset_task_list(self):
+               currentProject = self._get_project()
+               projId = self._manager.lookup_project(currentProject)["id"]
+               isMeta = self._manager.get_project(projId)["isMeta"]
+               # @todo RTM handles this by defaulting to a specific list
+               self._addTaskButton.set_sensitive(not isMeta)
+
+               self._itemList.clear()
+               self._populate_items()
+
+       def _get_project(self):
+               currentProjectName = self._projectsCombo.get_active_text()
+               return currentProjectName
+
+       def _populate_items(self):
+               currentProject = self._get_project()
+               projId = self._manager.lookup_project(currentProject)["id"]
+               for taskDetails in self._manager.get_tasks_with_details(projId):
+                       show = self._showCompleted if taskDetails["isCompleted"] else self._showIncomplete
+                       if not show:
+                               continue
+                       id = taskDetails["id"]
+                       isCompleted = taskDetails["isCompleted"]
+                       name = abbreviate(taskDetails["name"], 100)
+                       priority = taskDetails["priority"]
+                       dueDescription = taskDetails["dueDate"]
+                       if dueDescription:
+                               dueDate = datetime.datetime.strptime(dueDescription, "%Y-%m-%dT%H:%M:%SZ")
+                               fuzzyDue = toolbox.to_fuzzy_date(dueDate)
+                       else:
+                               fuzzyDue = ""
+
+                       linkDisplay = taskDetails["url"]
+                       linkDisplay = abbreviate_url(linkDisplay, 20, 10)
+
+                       notes = taskDetails["notes"]
+                       notesDisplay = "%d Notes" % len(notes) if notes else ""
+
+                       row = (id, isCompleted, name, priority, dueDescription, fuzzyDue, linkDisplay, notesDisplay)
+                       self._itemList.append(row)
+               self._todoItemTree.set_model(self._itemList)
+
+       def _on_list_activate(self, *args):
+               self._reset_task_list()
+
+       def _on_item_select(self, treeView, path, viewColumn):
+               taskId = self._itemList[path[0]][self.ID_IDX]
+
+               if viewColumn is self._priorityColumn:
+                       pass
+               elif viewColumn is self._nameColumn:
+                       self._editDialog.request_task(self._manager, taskId)
+                       self._reset_task_list()
+               elif viewColumn is self._dueColumn:
+                       self._editDialog.request_task(self._manager, taskId)
+                       self._reset_task_list()
+               elif viewColumn is self._linkColumn:
+                       webbrowser.open(self._manager.get_task_details(taskId)["url"])
+               elif viewColumn is self._notesColumn:
+                       pass
+
+       def _on_add(self, *args):
+               name = self._taskNameEntry.get_text()
+
+               currentProject = self._get_project()
+               projId = self._manager.lookup_project(currentProject)["id"]
+               taskId = self._manager.add_task(projId, name)
+
+               self._taskNameEntry.set_text("")
+               self._reset_task_list()
+
+       def _on_add_edit(self, *args):
+               name = self._taskNameEntry.get_text()
+
+               currentProject = self._get_project()
+               projId = self._manager.lookup_project(currentProject)["id"]
+               taskId = self._manager.add_task(projId, name)
+
+               try:
+                       self._editDialog.request_task(self._manager, taskId)
+               finally:
+                       self._taskNameEntry.set_text("")
+                       self._reset_task_list()
+
+       def _on_add_pressed(self, widget):
+               self._addToEditTimerId = gobject.timeout_add(1000, self._on_add_edit)
+
+       def _on_add_released(self, widget):
+               if self._addToEditTimerId is not None:
+                       gobject.source_remove(self._addToEditTimerId)
+               self._addToEditTimerId = None
+
+       def _on_paste(self, *args):
+               entry = self._taskNameEntry.get_text()
+               entry += self._clipboard.wait_for_text()
+               self._taskNameEntry.set_text(entry)
+
+       def _on_clear(self, *args):
+               self._taskNameEntry.set_text("")
+
+       def _on_completion_change(self, cell, path):
+               taskId = self._itemList[path[0]][self.ID_IDX]
+               self._manager.complete_task(taskId)
+               self._reset_task_list()