task-timewarrior-hook/on-modify.timewarrior
Dennis Schridde 9f8a4c8161 Fix on-modify.timewarrior hook for tasks with multi line description
If the description contained multiple lines, it would be formatted as a
bytes object, including Python's `b""` marker for byte literals and any
newlines.  This would then be passed literally to `timew`, which would
then choke on it, because it would record the newlines in its database.

This patch simply gets rid of the string join/split operations and the
encoding, which solves the issue.

Since we pass arrays instead of strings to `subprocess.call`, we are not
subject to command injection security vulnerabilities.

Fixes: 0b6dbf7e12d30fc791a524501e3483989a092a8c
2021-05-10 21:43:26 +02:00

80 lines
2.6 KiB
Python
Executable file

#!/usr/bin/env python
###############################################################################
#
# Copyright 2015 - 2016, Paul Beckingham, Federico Hernandez.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# https://www.opensource.org/licenses/mit-license.php
#
###############################################################################
from __future__ import print_function
import sys
import json
import subprocess
# Hook should extract all of the following for use as Timewarrior tags:
# UUID
# Project
# Tags
# Description
# UDAs
# Make no changes to the task, simply observe.
old = json.loads(sys.stdin.readline())
new = json.loads(sys.stdin.readline())
print(json.dumps(new))
def extract_timew_tags_from(json_obj):
# Extract attributes for use as tags.
tags = [json_obj['description']]
if 'project' in json_obj:
tags.append(json_obj['project'])
if 'tags' in json_obj:
tags.extend(json_obj['tags'])
return tags
start_or_stop = ''
# Started task.
if 'start' in new and 'start' not in old:
start_or_stop = 'start'
# Stopped task.
elif 'start' not in new and 'start' in old:
start_or_stop = 'stop'
if start_or_stop:
combined = extract_timew_tags_from(new)
subprocess.call(['timew', start_or_stop] + combined + [':yes'])
# Modifications to task other than start/stop
elif 'start' in new and 'start' in old:
old_combined = extract_timew_tags_from(old)
new_combined = extract_timew_tags_from(new)
if old_combined != new_combined:
subprocess.call(['timew', 'untag', '@1'] + old_combined + [':yes'])
subprocess.call(['timew', 'tag', '@1'] + new_combined + [':yes'])