Task: Conversion of modified fields to TW Cli args is TW-specific, move to backend

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

diff --git a/tasklib/backends.py b/tasklib/backends.py
index ad5bd6bd27f7b84425067ea28e01eef8e3e0d1f7..38b88b1ba042401a908f2116f4ac0cacb1189cd2 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,26 @@ 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 annotate_task(self, task, annotation):
+        pass
+
+    @abc.abstractmethod
+    def denotate_task(self, task, annotation):
+        pass
+
     @abc.abstractmethod
     def sync(self):
         """Syncs the backend database with the taskd server"""
@@ -97,6 +121,43 @@ class TaskWarrior(object):
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
+    def _get_modified_task_fields_as_args(self, task):
+        args = []
+
+        def add_field(field):
+            # Add the output of format_field method to args list (defaults to
+            # field:value)
+            serialized_value = task._serialize(field, task._data[field])
+
+            # Empty values should not be enclosed in quotation marks, see
+            # TW-1510
+            if serialized_value is '':
+                escaped_serialized_value = ''
+            else:
+                escaped_serialized_value = six.u("'{0}'").format(serialized_value)
+
+            format_default = lambda: six.u("{0}:{1}").format(field,
+                                                      escaped_serialized_value)
+
+            format_func = getattr(task, 'format_{0}'.format(field),
+                                  format_default)
+
+            args.append(format_func())
+
+        # If we're modifying saved task, simply pass on all modified fields
+        if task.saved:
+            for field in task._modified_fields:
+                add_field(field)
+        # For new tasks, pass all fields that make sense
+        else:
+            for field in task._data.keys():
+                if field in task.read_only_fields:
+                    continue
+                add_field(field)
+
+        return args
+
+
     def get_config(self):
         raw_output = self.execute_command(
                 ['show'],
@@ -174,7 +235,7 @@ class TaskWarrior(object):
         """Save a task into TaskWarrior database using add/modify call"""
 
         args = [task['uuid'], 'modify'] if task.saved else ['add']
-        args.extend(task._get_modified_fields_as_args())
+        args.extend(self._get_modified_task_fields_as_args(task))
         output = self.execute_command(args)
 
         # Parse out the new ID, if the task is being added for the first time
@@ -201,3 +262,68 @@ class TaskWarrior(object):
         # altering the data before saving
         task.refresh(after_save=True)
 
+    def delete_task(self, task):
+        self.execute_command([task['uuid'], 'delete'])
+
+    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 annotate_task(self, task, annotation):
+        args = [task['uuid'], 'annotate', annotation]
+        self.execute_command(args)
+
+    def denotate_task(self, task, annotation):
+        args = [task['uuid'], 'denotate', annotation]
+        self.execute_command(args)
+
+    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'])