taskwarrior/src/commands/CmdConfig.cpp

////////////////////////////////////////////////////////////////////////////////
//
// Copyright 2006 - 2021, Tomas Babej, 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
//
////////////////////////////////////////////////////////////////////////////////

#include <cmake.h>
// cmake.h include header must come first

#include <CmdConfig.h>
#include <Context.h>
#include <JSON.h>
#include <format.h>
#include <shared.h>

#include <algorithm>
#include <sstream>

////////////////////////////////////////////////////////////////////////////////
CmdConfig::CmdConfig() {
  _keyword = "config";
  _usage = "task          config [name [value | '']]";
  _description = "Change settings in the task configuration";
  _read_only = true;
  _displays_id = false;
  _needs_gc = false;
  _needs_recur_update = false;
  _uses_context = false;
  _accepts_filter = false;
  _accepts_modifications = false;
  _accepts_miscellaneous = true;
  _category = Command::Category::config;
}

////////////////////////////////////////////////////////////////////////////////
bool CmdConfig::setConfigVariable(const std::string& name, const std::string& value,
                                  bool confirmation /* = false */) {
  // Read .taskrc (or equivalent)
  std::vector<std::string> contents;
  File::read(Context::getContext().config.file(), contents);

  auto found = false;
  auto change = false;

  for (auto& line : contents) {
    // Get l-trimmed version of the line
    auto trimmed_line = trim(line, " ");

    // If there is a comment on the line, it must follow the pattern.
    auto comment = line.find('#');
    auto pos = trimmed_line.find(name + '=');

    // TODO: Use std::regex here
    if (pos == 0) {
      found = true;
      if (!confirmation ||
          confirm(format("Are you sure you want to change the value of '{1}' from '{2}' to '{3}'?",
                         name, Context::getContext().config.get(name), value))) {
        auto new_line = line.substr(0, pos + name.length() + 1) + json::encode(value);

        // Preserve the comment
        if (comment != std::string::npos) new_line += "  " + line.substr(comment);

        // Rewrite the line
        line = new_line;
        change = true;
      }
    }
  }

  // Not found, so append instead.
  if (!found &&
      (!confirmation ||
       confirm(format("Are you sure you want to add '{1}' with a value of '{2}'?", name, value)))) {
    contents.push_back(name + '=' + json::encode(value));
    change = true;
  }

  if (change)
    if (!File::write(Context::getContext().config.file(), contents))
      throw format("Could not write to '{1}'.", Context::getContext().config.file());

  return change;
}

////////////////////////////////////////////////////////////////////////////////
int CmdConfig::unsetConfigVariable(const std::string& name, bool confirmation /* = false */) {
  // Read .taskrc (or equivalent)
  std::vector<std::string> contents;
  File::read(Context::getContext().config.file(), contents);

  auto found = false;
  auto change = false;

  for (auto line = contents.begin(); line != contents.end();) {
    auto lineDeleted = false;

    // Get l-trimmed version of the line

    // If there is a comment on the line, it must follow the pattern.
    auto pos = trim(*line, " ").find(name + '=');

    // TODO: Use std::regex here
    if (pos == 0) {
      found = true;

      // Remove name
      if (!confirmation || confirm(format("Are you sure you want to remove '{1}'?", name))) {
        // vector::erase method returns a valid iterator to the next object
        line = contents.erase(line);
        lineDeleted = true;
        change = true;
      }
    }

    if (!lineDeleted) line++;
  }

  if (change)
    if (!File::write(Context::getContext().config.file(), contents))
      throw format("Could not write to '{1}'.", Context::getContext().config.file());

  if (change && found)
    return 0;
  else if (found)
    return 1;
  else
    return 2;
}

////////////////////////////////////////////////////////////////////////////////
int CmdConfig::execute(std::string& output) {
  auto rc = 0;
  std::stringstream out;

  // Get the non-attribute, non-fancy command line arguments.
  std::vector<std::string> words = Context::getContext().cli2.getWords();

  // Support:
  //   task config name value    # set name to value
  //   task config name ""       # set name to blank
  //   task config name          # remove name
  if (words.size()) {
    auto confirmation = Context::getContext().config.getBoolean("confirmation");
    auto found = false;

    auto name = words[0];
    std::string value = "";

    // Join the remaining words into config variable's value
    if (words.size() > 1) {
      for (unsigned int i = 1; i < words.size(); ++i) {
        if (i > 1) value += ' ';

        value += words[i];
      }
    }

    if (name != "") {
      auto change = false;

      // task config name value
      // task config name ""
      if (words.size() > 1) change = setConfigVariable(name, value, confirmation);

      // task config name
      else {
        rc = unsetConfigVariable(name, confirmation);
        if (rc == 0) {
          change = true;
          found = true;
        } else if (rc == 1)
          found = true;

        if (!found) throw format("No entry named '{1}' found.", name);
      }

      // Show feedback depending on whether .taskrc has been rewritten
      if (change) {
        out << format("Config file {1} modified.", Context::getContext().config.file()) << '\n';
      } else
        out << "No changes made.\n";
    } else
      throw std::string("Specify the name of a config variable to modify.");

    output = out.str();
  } else
    throw std::string("Specify the name of a config variable to modify.");

  return rc;
}

////////////////////////////////////////////////////////////////////////////////
CmdCompletionConfig::CmdCompletionConfig() {
  _keyword = "_config";
  _usage = "task          _config";
  _description = "Lists all supported configuration variables, for completion purposes";
  _read_only = true;
  _displays_id = false;
  _needs_gc = false;
  _needs_recur_update = false;
  _uses_context = false;
  _accepts_filter = false;
  _accepts_modifications = false;
  _accepts_miscellaneous = false;
  _category = Command::Category::internal;
}

////////////////////////////////////////////////////////////////////////////////
int CmdCompletionConfig::execute(std::string& output) {
  auto configs = Context::getContext().config.all();
  std::sort(configs.begin(), configs.end());

  for (const auto& config : configs) output += config + '\n';

  return 0;
}

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