tl.py

#!/usr/bin/env python3
# Add a new task to the gtimelog log file.
# Propose a list of task if only the category is supplied
#
# Copyright (c) 2015 Canonical Ltd.
# Author: Louis Bouchard <louis.bouchard@ubuntu.com>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.  See http://www.gnu.org/copyleft/gpl.html for
# the full text of the license.

import argparse
import re
import sys
import time
import os

Categories = {
    'train': 'Mentoring / Edu / Training',
    'meet': 'Meetings',
    'doc': 'Documentation',
    'pers': 'Personal management',
    'pto': 'Paid Timeout',
    'cp': 'Compute Team',
    'dev': 'Non Compute development',
    'dr': 'Compute Doctor',
    'self': 'Self Training',
    'help': 'Help Out La Maison',
    }

ListLimit = 10


def import_file(import_file):
    if not os.path.dirname(import_file):
        import_file = os.curdir + '/' + import_file
    if os.path.exists(import_file):
        with open(import_file, 'rb') as infile:
            with open(LogFile, 'wb') as outfile:
                count = outfile.write(infile.read())
        print("Imported %d bytes of data" % count)


def create_logfile(newfile):
    if not os.path.exists(newfile):
        os.makedirs(os.path.dirname(newfile), exist_ok=True)
        with open(newfile, 'w') as newfile:
            newfile.write('')


def set_logfile(argfile=None):
    if argfile is not None:
        logfile = argfile[0]
    else:
        env = os.environ.get("GTIMELOG_FILE")
        if env is not None and env is not '':
            logfile = env
        else:
            home = os.path.expanduser("~")
            logfile = '%s/.local/share/gtimelog/timelog.txt' % home
    create_logfile(logfile)
    return logfile


def print_categories():
    for k in sorted(Categories):
        print(k)


def print_tasks(category, **kwargs):
    tasks = get_tasks(category)
    if "escape" in kwargs and kwargs["escape"]:
        new_tasks = [t.replace(" ", "\\ ") for t in tasks]
        tasks = new_tasks
    print("\n".join(tasks))


def show_help():
    try:
        # python3-prettytable will be used if installed
        import prettytable
        categories = prettytable.PrettyTable(["Key", "Description"],
                                             sortby="Key", padding_width=1)
        categories.align["Key"] = "l"
        categories.align["Description"] = "l"
        categories.padding_width = 1
        for keys, description in Categories.items():
            categories.add_row([keys, description])
        print(categories)
    except:
        for keys, description in Categories.items():
            print("%s : %s" % (keys, description))


def get_tasks(category):
    cases = []
    regex = re.compile(r'{}'.format(Categories[category]))
    with open(LogFile, 'r') as timelog:
        all_cases = timelog.readlines()
    all_cases.reverse()
    for line in all_cases:
        if regex.findall(line):
            case = regex.split(line)[-1].strip()
            if case.lstrip(": ") not in cases:
                cases.append(case.lstrip(": "))
    return cases


def select_tasks(category):
    cases = get_tasks(category)
    mytask = 0
    for I in cases:
        if (cases.index(I) + 1) % ListLimit:
            print("{}) {}".format(cases.index(I) + 1, I))
        else:
            # account for modulo = 0 item
            print("{}) {}".format(cases.index(I) + 1, I))
            if cases.index(I) + 1 < len(cases):
                try:
                    mytask = input("Select task (0 to exit,<CR> to continue): "
                                   )
                    if mytask == '0':
                        return(None, None)
                    if mytask == '' or not mytask.isdecimal():
                        continue
                    else:
                        mytask = int(mytask)
                        break

                except KeyboardInterrupt:
                    print("Terminated\n")
                    sys.exit(1)

    if not mytask:
        try:
            mytask = input("Select task (0 or <CR> to exit): ")
            if mytask == '0' or mytask == '' or not mytask.isdecimal():
                return(None, None)
            else:
                mytask = int(mytask)

        except KeyboardInterrupt:
            print("Terminated\n")
            sys.exit(1)

    if mytask > 0 and mytask <= len(cases):
        return(category, cases[mytask - 1])
    else:
        print("Invalid task number")
        return(None, None)


def log_activity(category, task=None):

    now = time.localtime()
    today = '{:04d}-{:02d}-{:02d} {:02d}:{:02d}'.format(
        now.tm_year, now.tm_mon, now.tm_mday,
        now.tm_hour, now.tm_min)

    with open(LogFile, 'a') as timelog:
        if task is None:
            timelog.write('{}: {}\n'.format(today, category))
        else:
            if category in Categories.keys():
                timelog.write('{}: {} : {}\n'.format(
                    today, Categories[category], task))
            else:
                timelog.write('{}: {} : {}\n'.format(
                    today, category, task))
    return 0


if __name__ == '__main__':

    parser = argparse.ArgumentParser()
    parser.add_argument('task', nargs='*',
                        help='category | category : task title')
    parser.add_argument('-c', '--list-categories',
                        help='list available task categories',
                        action='store_true')
    parser.add_argument('-t', '--list-tasks', nargs=1, metavar='CATEGORY',
                        help='list available tasks for a given category')
    parser.add_argument('-r', '--raw',
                        help='produce raw output (without pretty formatting)',
                        action='store_true')
    parser.add_argument('-l', '--logfile', nargs=1, metavar='LOGFILE',
                        help='Path to the gtimelog logfile to be use')
    parser.add_argument('-i', '--importfile', nargs=1, metavar='IMPORTFILE',
                        help='Path to a gtimelog file to import')
    args = parser.parse_args()

    if args.logfile is not None:
        LogFile = set_logfile(args.logfile)
    else:
        LogFile = set_logfile()

    if args.list_categories:
        if args.raw:
            print_categories()
        else:
            show_help()
        sys.exit(0)

    if args.list_tasks:
        print_tasks(args.list_tasks[0], escape=args.raw)
        sys.exit(0)

    if args.importfile:
        import_file(args.importfile[0])
        sys.exit(0)

    if args.task:
        if len(args.task) == 1:
            if args.task[0] == '?':
                show_help()
                sys.exit(0)
            elif args.task[0] == 'new':
                log_activity('new', 'Arrived')
            elif args.task[0] in Categories:
                (category, task) = select_tasks(args.task[0])
                if category:
                    log_activity(category, task)
            else:
                log_activity(args.task[0])
        else:
            log_activity(args.task[0], " ".join(args.task[2:]))
    else:
        parser.print_help()