git.maemo.org Git - doneit/blob - src/gtk_rtmilk.py

   1 import webbrowser
   2 import datetime
   3 import urlparse
   4 import base64
   5
   6 import gobject
   7 import gtk
   8
   9 import toolbox
  10 import gtk_toolbox
  11 import rtmilk
  12 import rtmapi
  13
  14
  15 def abbreviate(text, expectedLen):
  16         singleLine = " ".join(text.split("\n"))
  17         lineLen = len(singleLine)
  18         if lineLen <= expectedLen:
  19                 return singleLine
  20
  21         abbrev = "..."
  22
  23         leftLen = expectedLen // 2 - 1
  24         rightLen = max(expectedLen - leftLen - len(abbrev) + 1, 1)
  25
  26         abbrevText =  singleLine[0:leftLen] + abbrev + singleLine[-rightLen:-1]
  27         assert len(abbrevText) <= expectedLen, "Too long: '%s'" % abbrevText
  28         return abbrevText
  29
  30
  31 def abbreviate_url(url, domainLength, pathLength):
  32         urlParts = urlparse.urlparse(url)
  33
  34         netloc = urlParts.netloc
  35         path = urlParts.path
  36
  37         pathLength += max(domainLength - len(netloc), 0)
  38         domainLength += max(pathLength - len(path), 0)
  39
  40         netloc = abbreviate(netloc, domainLength)
  41         path = abbreviate(path, pathLength)
  42         return netloc + path
  43
  44
  45 def get_token(username, apiKey, secret):
  46         token = None
  47         rtm = rtmapi.RTMapi(username, apiKey, secret, token)
  48
  49         authURL = rtm.getAuthURL()
  50         webbrowser.open(authURL)
  51         mb = gtk_toolbox.MessageBox2("You need to authorize DoneIt with\nRemember The Milk.\nClick OK after you authorize.")
  52         mb.run()
  53
  54         token = rtm.getToken()
  55         return token
  56
  57
  58 def get_credentials(credentialsDialog):
  59         username, password = credentialsDialog.request_credentials()
  60         token = get_token(username, rtmilk.RtMilkManager.API_KEY, rtmilk.RtMilkManager.SECRET)
  61         return username, password, token
  62
  63
  64 class GtkRtMilk(object):
  65
  66         ID_IDX = 0
  67         COMPLETION_IDX = 1
  68         NAME_IDX = 2
  69         PRIORITY_IDX = 3
  70         DUE_IDX = 4
  71         FUZZY_IDX = 5
  72         LINK_IDX = 6
  73         NOTES_IDX = 7
  74
  75         def __init__(self, widgetTree):
  76                 """
  77                 @note Thread agnostic
  78                 """
  79                 self._clipboard = gtk.clipboard_get()
  80
  81                 self._showCompleted = False
  82                 self._showIncomplete = True
  83
  84                 self._editDialog = gtk_toolbox.EditTaskDialog(widgetTree)
  85
  86                 self._projectsList = gtk.ListStore(gobject.TYPE_STRING)
  87                 self._projectsCombo = widgetTree.get_widget("projectsCombo")
  88                 self._onListActivateId = 0
  89
  90                 self._itemList = gtk.ListStore(
  91                         gobject.TYPE_STRING, # id
  92                         gobject.TYPE_BOOLEAN, # is complete
  93                         gobject.TYPE_STRING, # name
  94                         gobject.TYPE_STRING, # priority
  95                         gobject.TYPE_STRING, # due
  96                         gobject.TYPE_STRING, # fuzzy due
  97                         gobject.TYPE_STRING, # Link
  98                         gobject.TYPE_STRING, # Notes
  99                 )
 100                 self._completionColumn = gtk.TreeViewColumn('') # Complete?
 101                 self._completionCell = gtk.CellRendererToggle()
 102                 self._completionCell.set_property("activatable", True)
 103                 self._completionCell.connect("toggled", self._on_completion_change)
 104                 self._completionColumn.pack_start(self._completionCell, False)
 105                 self._completionColumn.set_attributes(self._completionCell, active=self.COMPLETION_IDX)
 106                 self._priorityColumn = gtk.TreeViewColumn('') # Priority
 107                 self._priorityCell = gtk.CellRendererText()
 108                 self._priorityColumn.pack_start(self._priorityCell, False)
 109                 self._priorityColumn.set_attributes(self._priorityCell, text=self.PRIORITY_IDX)
 110                 self._nameColumn = gtk.TreeViewColumn('Name')
 111                 self._nameCell = gtk.CellRendererText()
 112                 self._nameColumn.pack_start(self._nameCell, True)
 113                 self._nameColumn.set_attributes(self._nameCell, text=self.NAME_IDX)
 114                 self._dueColumn = gtk.TreeViewColumn('Due')
 115                 self._dueCell = gtk.CellRendererText()
 116                 self._dueColumn.pack_start(self._nameCell, False)
 117                 self._dueColumn.set_attributes(self._nameCell, text=self.FUZZY_IDX)
 118                 self._linkColumn = gtk.TreeViewColumn('') # Link
 119                 self._linkCell = gtk.CellRendererText()
 120                 self._linkColumn.pack_start(self._nameCell, False)
 121                 self._linkColumn.set_attributes(self._nameCell, text=self.LINK_IDX)
 122                 self._notesColumn = gtk.TreeViewColumn('') # Notes
 123                 self._notesCell = gtk.CellRendererText()
 124                 self._notesColumn.pack_start(self._nameCell, False)
 125                 self._notesColumn.set_attributes(self._nameCell, text=self.NOTES_IDX)
 126
 127                 self._todoItemTree = widgetTree.get_widget("todoItemTree")
 128                 self._onItemSelectId = 0
 129
 130                 self._taskNameEntry = widgetTree.get_widget("add-taskNameEntry")
 131                 self._addTaskButton = widgetTree.get_widget("add-addTaskButton")
 132                 self._pasteTaskNameButton = widgetTree.get_widget("add-pasteTaskNameButton")
 133                 self._clearTaskNameButton = widgetTree.get_widget("add-clearTaskNameButton")
 134                 self._onAddId = None
 135                 self._onAddClickedId = None
 136                 self._onAddReleasedId = None
 137                 self._addToEditTimerId = None
 138                 self._onClearId = None
 139                 self._onPasteId = None
 140
 141                 self._credentialsDialog = gtk_toolbox.LoginWindow(widgetTree)
 142                 self._credentials = "", "", ""
 143                 self._manager = None
 144
 145         @staticmethod
 146         def name():
 147                 return "Remember The Milk"
 148
 149         def load_settings(self, config):
 150                 """
 151                 @note Thread Agnostic
 152                 """
 153                 blobs = (
 154                         config.get(self.name(), "bin_blob_%i" % i)
 155                         for i in xrange(len(self._credentials))
 156                 )
 157                 creds = (
 158                         base64.b64decode(blob)
 159                         for blob in blobs
 160                 )
 161                 self._credentials = tuple(creds)
 162
 163         def save_settings(self, config):
 164                 """
 165                 @note Thread Agnostic
 166                 """
 167                 config.add_section(self.name())
 168                 for i, value in enumerate(self._credentials):
 169                         blob = base64.b64encode(value)
 170                         config.set(self.name(), "bin_blob_%i" % i, blob)
 171
 172         def login(self):
 173                 """
 174                 @note UI Thread
 175                 """
 176                 if self._manager is not None:
 177                         return
 178
 179                 credentials = self._credentials
 180                 while True:
 181                         try:
 182                                 self._manager = rtmilk.RtMilkManager(*credentials)
 183                                 self._credentials = credentials
 184                                 return # Login succeeded
 185                         except rtmapi.AuthStateMachine.NoData:
 186                                 # Login failed, grab new credentials
 187                                 credentials = get_credentials(self._credentialsDialog)
 188
 189         def logout(self):
 190                 """
 191                 @note Thread Agnostic
 192                 """
 193                 self._credentials = "", "", ""
 194                 self._manager = None
 195
 196         def enable(self):
 197                 """
 198                 @note UI Thread
 199                 """
 200                 self._projectsList.clear()
 201                 self._populate_projects()
 202
 203                 self._itemList.clear()
 204                 self._todoItemTree.append_column(self._completionColumn)
 205                 self._todoItemTree.append_column(self._priorityColumn)
 206                 self._todoItemTree.append_column(self._nameColumn)
 207                 self._todoItemTree.append_column(self._dueColumn)
 208                 self._todoItemTree.append_column(self._linkColumn)
 209                 self._todoItemTree.append_column(self._notesColumn)
 210                 self._reset_task_list()
 211
 212                 self._todoItemTree.set_headers_visible(False)
 213                 self._nameColumn.set_expand(True)
 214
 215                 self._editDialog.enable(self._manager)
 216
 217                 self._onListActivateId = self._projectsCombo.connect("changed", self._on_list_activate)
 218                 self._onItemSelectId = self._todoItemTree.connect("row-activated", self._on_item_select)
 219                 self._onAddId = self._addTaskButton.connect("clicked", self._on_add)
 220                 self._onAddClickedId = self._addTaskButton.connect("pressed", self._on_add_pressed)
 221                 self._onAddReleasedId = self._addTaskButton.connect("released", self._on_add_released)
 222                 self._onPasteId = self._pasteTaskNameButton.connect("clicked", self._on_paste)
 223                 self._onClearId = self._clearTaskNameButton.connect("clicked", self._on_clear)
 224
 225         def disable(self):
 226                 """
 227                 @note UI Thread
 228                 """
 229                 self._projectsCombo.disconnect(self._onListActivateId)
 230                 self._todoItemTree.disconnect(self._onItemSelectId)
 231                 self._addTaskButton.disconnect(self._onAddId)
 232                 self._addTaskButton.disconnect(self._onAddClickedId)
 233                 self._addTaskButton.disconnect(self._onAddReleasedId)
 234                 self._pasteTaskNameButton.disconnect(self._onPasteId)
 235                 self._clearTaskNameButton.disconnect(self._onClearId)
 236
 237                 self._editDialog.disable()
 238
 239                 self._projectsList.clear()
 240                 self._projectsCombo.set_model(None)
 241                 self._projectsCombo.disconnect("changed", self._on_list_activate)
 242
 243                 self._todoItemTree.remove_column(self._completionColumn)
 244                 self._todoItemTree.remove_column(self._priorityColumn)
 245                 self._todoItemTree.remove_column(self._nameColumn)
 246                 self._todoItemTree.remove_column(self._dueColumn)
 247                 self._todoItemTree.remove_column(self._linkColumn)
 248                 self._todoItemTree.remove_column(self._notesColumn)
 249                 self._itemList.clear()
 250                 self._itemList.set_model(None)
 251
 252                 self._manager = None
 253
 254         def _populate_projects(self):
 255                 for project in self._manager.get_projects():
 256                         projectName = project["name"]
 257                         isVisible = project["isVisible"]
 258                         row = (projectName, )
 259                         if isVisible:
 260                                 self._projectsList.append(row)
 261                 self._projectsCombo.set_model(self._projectsList)
 262                 cell = gtk.CellRendererText()
 263                 self._projectsCombo.pack_start(cell, True)
 264                 self._projectsCombo.add_attribute(cell, 'text', 0)
 265                 self._projectsCombo.set_active(0)
 266
 267         def _reset_task_list(self):
 268                 currentProject = self._get_project()
 269                 projId = self._manager.lookup_project(currentProject)["id"]
 270                 isMeta = self._manager.get_project(projId)["isMeta"]
 271                 # @todo RTM handles this by defaulting to a specific list
 272                 self._addTaskButton.set_sensitive(not isMeta)
 273
 274                 self._itemList.clear()
 275                 self._populate_items()
 276
 277         def _get_project(self):
 278                 currentProjectName = self._projectsCombo.get_active_text()
 279                 return currentProjectName
 280
 281         def _populate_items(self):
 282                 # @todo Look using a button for notes and links, and labels for all else
 283                 currentProject = self._get_project()
 284                 projId = self._manager.lookup_project(currentProject)["id"]
 285                 for taskDetails in self._manager.get_tasks_with_details(projId):
 286                         show = self._showCompleted if taskDetails["isCompleted"] else self._showIncomplete
 287                         if not show:
 288                                 continue
 289                         id = taskDetails["id"]
 290                         isCompleted = taskDetails["isCompleted"]
 291                         name = abbreviate(taskDetails["name"], 100)
 292                         priority = taskDetails["priority"]
 293                         dueDescription = taskDetails["dueDate"]
 294                         if dueDescription:
 295                                 dueDate = datetime.datetime.strptime(dueDescription, "%Y-%m-%dT%H:%M:%SZ")
 296                                 fuzzyDue = toolbox.to_fuzzy_date(dueDate)
 297                         else:
 298                                 fuzzyDue = ""
 299
 300                         linkDisplay = taskDetails["url"]
 301                         linkDisplay = abbreviate_url(linkDisplay, 20, 10)
 302
 303                         notes = taskDetails["notes"]
 304                         notesDisplay = "%d Notes" % len(notes) if notes else ""
 305
 306                         row = (id, isCompleted, name, priority, dueDescription, fuzzyDue, linkDisplay, notesDisplay)
 307                         self._itemList.append(row)
 308                 self._todoItemTree.set_model(self._itemList)
 309
 310         def _on_list_activate(self, *args):
 311                 self._reset_task_list()
 312
 313         def _on_item_select(self, treeView, path, viewColumn):
 314                 # @todo See if there is a way to get a right click / tap'n'hold for more task goodness
 315                 taskId = self._itemList[path[0]][self.ID_IDX]
 316
 317                 if viewColumn is self._priorityColumn:
 318                         pass
 319                 elif viewColumn is self._nameColumn:
 320                         self._editDialog.request_task(self._manager, taskId)
 321                         self._reset_task_list()
 322                 elif viewColumn is self._dueColumn:
 323                         self._editDialog.request_task(self._manager, taskId)
 324                         self._reset_task_list()
 325                 elif viewColumn is self._linkColumn:
 326                         webbrowser.open(self._manager.get_task_details(taskId)["url"])
 327                 elif viewColumn is self._notesColumn:
 328                         pass
 329
 330         def _on_add(self, *args):
 331                 name = self._taskNameEntry.get_text()
 332
 333                 currentProject = self._get_project()
 334                 projId = self._manager.lookup_project(currentProject)["id"]
 335                 taskId = self._manager.add_task(projId, name)
 336
 337                 self._taskNameEntry.set_text("")
 338                 self._reset_task_list()
 339
 340         def _on_add_edit(self, *args):
 341                 name = self._taskNameEntry.get_text()
 342
 343                 currentProject = self._get_project()
 344                 projId = self._manager.lookup_project(currentProject)["id"]
 345                 taskId = self._manager.add_task(projId, name)
 346
 347                 try:
 348                         self._editDialog.request_task(self._manager, taskId)
 349                 finally:
 350                         self._taskNameEntry.set_text("")
 351                         self._reset_task_list()
 352
 353         def _on_add_pressed(self, widget):
 354                 self._addToEditTimerId = gobject.timeout_add(1000, self._on_add_edit)
 355
 356         def _on_add_released(self, widget):
 357                 if self._addToEditTimerId is not None:
 358                         gobject.source_remove(self._addToEditTimerId)
 359                 self._addToEditTimerId = None
 360
 361         def _on_paste(self, *args):
 362                 entry = self._taskNameEntry.get_text()
 363                 entry += self._clipboard.wait_for_text()
 364                 self._taskNameEntry.set_text(entry)
 365
 366         def _on_clear(self, *args):
 367                 self._taskNameEntry.set_text("")
 368
 369         def _on_completion_change(self, cell, path):
 370                 taskId = self._itemList[path[0]][self.ID_IDX]
 371                 self._manager.complete_task(taskId)
 372                 self._reset_task_list()