TaskWarrior: Implement sync method

[etc/taskwarrior.git] / tasklib / backends.py

diff --git a/tasklib/backends.py b/tasklib/backends.py
index a4d074e508aa4f25db367cf2e3df6e942375c159..80928f1648c25cb1a6099cceb078beeb88c6f6f4 100644 (file)
--- a/tasklib/backends.py
+++ b/tasklib/backends.py
@@ -1,8 +1,10 @@
 import abc
+import json
 import os
 import re
 import subprocess
 
+from tasklib.task import TaskFilter
 
 VERSION_2_1_0 = six.u('2.1.0')
 VERSION_2_2_0 = six.u('2.2.0')
@@ -17,6 +19,8 @@ VERSION_2_4_5 = six.u('2.4.5')
 
 class Backend(object):
 
+    filter_class = TaskFilter
+
     @abc.abstractmethod
     def filter_tasks(self, filter_obj):
         """Returns a list of Task objects matching the given filter"""
@@ -38,6 +42,18 @@ class Backend(object):
     def stop_task(self, task):
         pass
 
+    @abc.abstractmethod
+    def complete_task(self, task):
+        pass
+
+    @abc.abstractmethod
+    def refresh_task(self, task, after_save=False):
+        """
+        Refreshes the given task. Returns new data dict with serialized
+        attributes.
+        """
+        pass
+
     @abc.abstractmethod
     def sync(self):
         """Syncs the backend database with the taskd server"""
@@ -144,6 +160,17 @@ class TaskWarrior(object):
         if self.version < VERSION_2_4_2:
             self.execute_command(['next'], allow_failure=False)
 
+    def merge_with(self, path, push=False):
+        path = path.rstrip('/') + '/'
+        self.execute_command(['merge', path], config_override={
+            'merge.autopush': 'yes' if push else 'no',
+        })
+
+    def undo(self):
+        self.execute_command(['undo'])
+
+    # Backend interface implementation
+
     def filter_tasks(self, filter_obj):
         self.enforce_recurrence()
         args = ['export', '--'] + filter_obj.get_filter_params()
@@ -190,11 +217,60 @@ class TaskWarrior(object):
         # altering the data before saving
         task.refresh(after_save=True)
 
-    def merge_with(self, path, push=False):
-        path = path.rstrip('/') + '/'
-        self.execute_command(['merge', path], config_override={
-            'merge.autopush': 'yes' if push else 'no',
-        })
+    def delete_task(self, task):
+        self.execute_command([task['uuid'], 'delete'])
 
-    def undo(self):
-        self.execute_command(['undo'])
+    def start_task(self, task):
+        self.execute_command([task['uuid'], 'start'])
+
+    def stop_task(self, task):
+        self.execute_command([task['uuid'], 'stop'])
+
+    def complete_task(self, task):
+        # Older versions of TW do not stop active task at completion
+        if self.version < VERSION_2_4_0 and task.active:
+            task.stop()
+
+        self.execute_command([task['uuid'], 'done'])
+
+    def refresh_task(self, task, after_save=False):
+        # We need to use ID as backup for uuid here for the refreshes
+        # of newly saved tasks. Any other place in the code is fine
+        # with using UUID only.
+        args = [task['uuid'] or task['id'], 'export']
+        output = self.execute_command(args)
+
+        def valid(output):
+            return len(output) == 1 and output[0].startswith('{')
+
+        # For older TW versions attempt to uniquely locate the task
+        # using the data we have if it has been just saved.
+        # This can happen when adding a completed task on older TW versions.
+        if (not valid(output) and self.version < VERSION_2_4_5
+                and after_save):
+
+            # Make a copy, removing ID and UUID. It's most likely invalid
+            # (ID 0) if it failed to match a unique task.
+            data = copy.deepcopy(task._data)
+            data.pop('id', None)
+            data.pop('uuid', None)
+
+            taskfilter = self.filter_class(self)
+            for key, value in data.items():
+                taskfilter.add_filter_param(key, value)
+
+            output = self.execute_command(['export', '--'] +
+                taskfilter.get_filter_params())
+
+        # If more than 1 task has been matched still, raise an exception
+        if not valid(output):
+            raise TaskWarriorException(
+                "Unique identifiers {0} with description: {1} matches "
+                "multiple tasks: {2}".format(
+                task['uuid'] or task['id'], task['description'], output)
+            )
+
+        return json.loads(output[0])
+
+    def sync(self):
+        self.execute_command(['sync'])