taskwarrior/src/edit.cpp

////////////////////////////////////////////////////////////////////////////////
// task - a command line task list manager.
//
// Copyright 2006 - 2009, Paul Beckingham.
// All rights reserved.
//
// 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.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// this program; if not, write to the
//
//     Free Software Foundation, Inc.,
//     51 Franklin Street, Fifth Floor,
//     Boston, MA
//     02110-1301
//     USA
//
////////////////////////////////////////////////////////////////////////////////
#include <iostream>
#include <sstream>
#include <stdio.h>
#include <time.h>
#include <sys/types.h>
#include <unistd.h>
#include <stdlib.h>
#include <limits.h>
#include <string.h>
#include "T.h"
#include "Date.h"
#include "text.h"
#include "util.h"
#include "main.h"

extern Context context;

////////////////////////////////////////////////////////////////////////////////
static std::string findValue (
  const std::string& text,
  const std::string& name)
{
  std::string::size_type found = text.find (name);
  if (found != std::string::npos)
  {
    std::string::size_type eol = text.find ("\n", found);
    if (eol != std::string::npos)
    {
      std::string value = text.substr (
        found + name.length (),
        eol - (found + name.length ()));

      return trim (value, "\t ");
    }
  }

  return "";
}

////////////////////////////////////////////////////////////////////////////////
static std::string findDate (
  const std::string& text,
  const std::string& name)
{
  std::string::size_type found = text.find (name);
  if (found != std::string::npos)
  {
    std::string::size_type eol = text.find ("\n", found);
    if (eol != std::string::npos)
    {
      std::string value = trim (text.substr (
        found + name.length (),
        eol - (found + name.length ())), "\t ");

      if (value != "")
      {
        Date dt (value, context.config.get ("dateformat", "m/d/Y"));
        char epoch [16];
        sprintf (epoch, "%d", (int)dt.toEpoch ());
        return std::string (epoch);
      }
    }
  }

  return "";
}

////////////////////////////////////////////////////////////////////////////////
// Obsolete - use Task::statusToText
static std::string formatStatus (T& task)
{
  switch (task.getStatus ())
  {
  case T::pending:   return "Pending";   break;
  case T::completed: return "Completed"; break;
  case T::deleted:   return "Deleted";   break;
  case T::recurring: return "Recurring"; break;
  }

  return "";
}

////////////////////////////////////////////////////////////////////////////////
static std::string formatDate (
  T& task,
  const std::string& attribute)
{
  std::string value = task.getAttribute (attribute);
  if (value.length ())
  {
    Date dt (::atoi (value.c_str ()));
    value = dt.toString (context.config.get ("dateformat", "m/d/Y"));
  }

  return value;
}

////////////////////////////////////////////////////////////////////////////////
static std::string formatTask (T task)
{
  std::stringstream before;
  before << "# The 'task edit <id>' command allows you to modify all aspects of a task" << std::endl
         << "# using a text editor.  What is shown below is a representation of the"    << std::endl
         << "# task in all it's detail.  Modify what you wish, and if you save and"     << std::endl
         << "# quit your editor, task will read this file and try to make sense of"     << std::endl
         << "# what changed, and apply those changes.  If you quit your editor without" << std::endl
         << "# saving or making any modifications, task will do nothing."               << std::endl
         << "#"                                                                         << std::endl
         << "# Lines that begin with # represent data you cannot change, like ID."      << std::endl
         << "# If you get too 'creative' with your editing, task will dump you back "   << std::endl
         << "# into the editor to try again."                                           << std::endl
         << "#"                                                                         << std::endl
         << "# Should you find yourself in an endless Groundhog Day loop, editing and"  << std::endl
         << "# editing the same file, just quit the editor without making any changes." << std::endl
         << "# Task will notice this and stop the editing."                             << std::endl
         << "#"                                                                         << std::endl
         << "# Name               Editable details"                                     << std::endl
         << "# -----------------  ----------------------------------------------------" << std::endl
         << "# ID:                " << task.getId ()                                    << std::endl
         << "# UUID:              " << task.getUUID ()                                  << std::endl
         << "# Status:            " << formatStatus (task)                              << std::endl
         << "# Mask:              " << task.getAttribute ("mask")                       << std::endl
         << "# iMask:             " << task.getAttribute ("imask")                      << std::endl
         << "  Project:           " << task.getAttribute ("project")                    << std::endl
         << "  Priority:          " << task.getAttribute ("priority")                   << std::endl;

  std::vector <std::string> tags;
  task.getTags (tags);
  std::string allTags;
  join (allTags, " ", tags);
  before << "# Separate the tags with spaces, like this: tag1 tag2"                     << std::endl
         << "  Tags:              " << allTags                                          << std::endl
         << "# The description field is allowed to wrap and use multiple lines.  Task"  << std::endl
         << "# will combine them."                                                      << std::endl
         << "  Description:       " << task.getDescription ()                           << std::endl
         << "  Created:           " << formatDate (task, "entry")                       << std::endl
         << "  Started:           " << formatDate (task, "start")                       << std::endl
         << "  Ended:             " << formatDate (task, "end")                         << std::endl
         << "  Due:               " << formatDate (task, "due")                         << std::endl
         << "  Until:             " << formatDate (task, "until")                       << std::endl
         << "  Recur:             " << task.getAttribute ("recur")                      << std::endl
         << "  Parent:            " << task.getAttribute ("parent")                     << std::endl
         << "  Foreground color:  " << task.getAttribute ("fg")                         << std::endl
         << "  Background color:  " << task.getAttribute ("bg")                         << std::endl
         << "# Annotations look like this: <date> <text>, and there can be any number"  << std::endl
         << "# of them."                                                                << std::endl;

  std::map <time_t, std::string> annotations;
  task.getAnnotations (annotations);
  foreach (anno, annotations)
  {
    Date dt (anno->first);
    before << "  Annotation:        " << dt.toString (context.config.get ("dateformat", "m/d/Y"))
           << " "                     << anno->second                                   << std::endl;
  }

  before << "  Annotation:        "                                                     << std::endl
         << "  Annotation:        "                                                     << std::endl
         << "# End"                                                                     << std::endl;
  return before.str ();
}

////////////////////////////////////////////////////////////////////////////////
static void parseTask (T& task, const std::string& after)
{
  // project
  std::string value = findValue (after, "Project:");
  if (task.getAttribute ("project") != value)
  {
    if (value != "")
    {
      std::cout << "Project modified." << std::endl;
      task.setAttribute ("project", value);
    }
    else
    {
      std::cout << "Project deleted." << std::endl;
      task.removeAttribute ("project");
    }
  }

  // priority
  value = findValue (after, "Priority:");
  if (task.getAttribute ("priority") != value)
  {
    if (value != "")
    {
      if (validPriority (value))
      {
        std::cout << "Priority modified." << std::endl;
        task.setAttribute ("priority", value);
      }
    }
    else
    {
      std::cout << "Priority deleted." << std::endl;
      task.removeAttribute ("priority");
    }
  }

  // tags
  value = findValue (after, "Tags:");
  std::vector <std::string> tags;
  split (tags, value, ' ');
  task.removeTags ();
  task.addTags (tags);

  // description.
  value = findValue (after, "Description: ");
  if (task.getDescription () != value)
  {
    if (value != "")
    {
      std::cout << "Description modified." << std::endl;
      task.setDescription (value);
    }
    else
      throw std::string ("Cannot remove description.");
  }

  // entry
  value = findDate (after, "Created:");
  if (value != "")
  {
    Date edited (::atoi (value.c_str ()));

    Date original (::atoi (task.getAttribute ("entry").c_str ()));
    if (!original.sameDay (edited))
    {
      std::cout << "Creation date modified." << std::endl;
      task.setAttribute ("entry", value);
    }
  }
  else
    throw std::string ("Cannot remove creation date");

  // start
  value = findDate (after, "Started:");
  if (value != "")
  {
    Date edited (::atoi (value.c_str ()));

    if (task.getAttribute ("start") != "")
    {
      Date original (::atoi (task.getAttribute ("start").c_str ()));
      if (!original.sameDay (edited))
      {
        std::cout << "Start date modified." << std::endl;
        task.setAttribute ("start", value);
      }
    }
    else
    {
      std::cout << "Start date modified." << std::endl;
      task.setAttribute ("start", value);
    }
  }
  else
  {
    if (task.getAttribute ("start") != "")
    {
      std::cout << "Start date removed." << std::endl;
      task.removeAttribute ("start");
    }
  }

  // end
  value = findDate (after, "Ended:");
  if (value != "")
  {
    Date edited (::atoi (value.c_str ()));

    if (task.getAttribute ("end") != "")
    {
      Date original (::atoi (task.getAttribute ("end").c_str ()));
      if (!original.sameDay (edited))
      {
        std::cout << "Done date modified." << std::endl;
        task.setAttribute ("end", value);
      }
    }
    else if (task.getStatus () != T::deleted)
      throw std::string ("Cannot set a done date on a pending task.");
  }
  else
  {
    if (task.getAttribute ("end") != "")
    {
      std::cout << "Done date removed." << std::endl;
      task.setStatus (T::pending);
      task.removeAttribute ("end");
    }
  }

  // due
  value = findDate (after, "Due:");
  if (value != "")
  {
    Date edited (::atoi (value.c_str ()));

    if (task.getAttribute ("due") != "")
    {
      Date original (::atoi (task.getAttribute ("due").c_str ()));
      if (!original.sameDay (edited))
      {
        std::cout << "Due date modified." << std::endl;
        task.setAttribute ("due", value);
      }
    }
    else
    {
      std::cout << "Due date modified." << std::endl;
      task.setAttribute ("due", value);
    }
  }
  else
  {
    if (task.getAttribute ("due") != "")
    {
      if (task.getStatus () == T::recurring ||
          task.getAttribute ("parent") != "")
      {
        std::cout << "Cannot remove a due date from a recurring task." << std::endl;
      }
      else
      {
        std::cout << "Due date removed." << std::endl;
        task.removeAttribute ("due");
      }
    }
  }

  // until
  value = findDate (after, "Until:");
  if (value != "")
  {
    Date edited (::atoi (value.c_str ()));

    if (task.getAttribute ("until") != "")
    {
      Date original (::atoi (task.getAttribute ("until").c_str ()));
      if (!original.sameDay (edited))
      {
        std::cout << "Until date modified." << std::endl;
        task.setAttribute ("until", value);
      }
    }
    else
    {
      std::cout << "Until date modified." << std::endl;
      task.setAttribute ("until", value);
    }
  }
  else
  {
    if (task.getAttribute ("until") != "")
    {
      std::cout << "Until date removed." << std::endl;
      task.removeAttribute ("until");
    }
  }

  // recur
  value = findValue (after, "Recur:");
  if (value != task.getAttribute ("recur"))
  {
    if (value != "")
    {
      if (validDuration (value))
      {
        std::cout << "Recurrence modified." << std::endl;
        if (task.getAttribute ("due") != "")
        {
          task.setAttribute ("recur", value);
          task.setStatus (T::recurring);
        }
        else
          throw std::string ("A recurring task must have a due date.");
      }
      else
        throw std::string ("Not a valid recurrence duration.");
    }
    else
    {
      std::cout << "Recurrence removed." << std::endl;
      task.setStatus (T::pending);
      task.removeAttribute ("recur");
      task.removeAttribute ("until");
      task.removeAttribute ("mask");
      task.removeAttribute ("imask");
    }
  }

  // parent
  value = findValue (after, "Parent:");
  if (value != task.getAttribute ("parent"))
  {
    if (value != "")
    {
      std::cout << "Parent UUID modified." << std::endl;
      task.setAttribute ("parent", value);
    }
    else
    {
      std::cout << "Parent UUID removed." << std::endl;
      task.removeAttribute ("parent");
    }
  }

  // fg
  value = findValue (after, "Foreground color:");
  if (value != task.getAttribute ("fg"))
  {
    if (value != "")
    {
      std::cout << "Foreground color modified." << std::endl;
      task.setAttribute ("fg", value);
    }
    else
    {
      std::cout << "Foreground color removed." << std::endl;
      task.removeAttribute ("fg");
    }
  }

  // bg
  value = findValue (after, "Background color:");
  if (value != task.getAttribute ("bg"))
  {
    if (value != "")
    {
      std::cout << "Background color modified." << std::endl;
      task.setAttribute ("bg", value);
    }
    else
    {
      std::cout << "Background color removed." << std::endl;
      task.removeAttribute ("bg");
    }
  }

  // Annotations
  std::map <time_t, std::string> annotations;
  std::string::size_type found = 0;
  while ((found = after.find ("Annotation:", found)) != std::string::npos)
  {
    found += 11;

    std::string::size_type eol = after.find ("\n", found);
    if (eol != std::string::npos)
    {
      std::string value = trim (after.substr (
        found,
        eol - found), "\t ");

      std::string::size_type gap = value.find (" ");
      if (gap != std::string::npos)
      {
        Date when (value.substr (0, gap));
        std::string text = trim (value.substr (gap, std::string::npos), "\t ");
        annotations[when.toEpoch ()] = text;
      }
    }
  }

  task.setAnnotations (annotations);
}

////////////////////////////////////////////////////////////////////////////////
// Introducing the Silver Bullet.  This feature is the catch-all fixative for
// various other ills.  This is like opening up the hood and going in with a
// wrench.  To be used sparingly.
std::string handleEdit ()
{
  std::stringstream out;
/*
  std::vector <T> all;
  tdb.allPendingT (all);

  filterSequence (all, task);
  foreach (seq, all)
  {
    // Check for file permissions.
    std::string dataLocation = expandPath (context.config.get ("data.location"));
    if (access (dataLocation.c_str (), X_OK))
      throw std::string ("Your data.location directory is not writable.");

    // Create a temp file name in data.location.
    std::stringstream pattern;
    pattern << dataLocation << "/task." << seq->getId () << ".XXXXXX";
    char cpattern [PATH_MAX];
    strcpy (cpattern, pattern.str ().c_str ());
    mkstemp (cpattern);
    char* file = cpattern;

    // Format the contents, T -> text, write to a file.
    std::string before = formatTask (*seq);
    spit (file, before);

    // Determine correct editor: .taskrc:editor > $VISUAL > $EDITOR > vi
    std::string editor = context.config.get ("editor", "");
    char* peditor = getenv ("VISUAL");
    if (editor == "" && peditor) editor = std::string (peditor);
    peditor = getenv ("EDITOR");
    if (editor == "" && peditor) editor = std::string (peditor);
    if (editor == "") editor = "vi";

    // Complete the command line.
    editor += " ";
    editor += file;

ARE_THESE_REALLY_HARMFUL:
    // Launch the editor.
    std::cout << "Launching '" << editor << "' now..." << std::endl;
    system (editor.c_str ());
    std::cout << "Editing complete." << std::endl;

    // Slurp file.
    std::string after;
    slurp (file, after, false);

    // TODO Remove this debugging code.
    //spit ("./before", before);
    //spit ("./after",  after);

    // Update seq based on what can be parsed back out of the file, but only
    // if changes were made.
    if (before != after)
    {
      std::cout << "Edits were detected." << std::endl;
      std::string problem = "";
      bool oops = false;

      try
      {
        parseTask (*seq, after);
        tdb.modifyT (*seq);
      }

      catch (std::string& e)
      {
        problem = e;
        oops = true;
      }

      if (oops)
      {
        std::cout << "Error: " << problem << std::endl;

        // Preserve the edits.
        before = after;
        spit (file, before);

        if (confirm ("Task couldn't handle your edits.  Would you like to try again?"))
          goto ARE_THESE_REALLY_HARMFUL;
      }
    }
    else
      std::cout << "No edits were detected." << std::endl;

    // Cleanup.
    unlink (file);
  }

*/
  return out.str ();
}

////////////////////////////////////////////////////////////////////////////////