// Copyright (C) 2019-2026 Joel Rosdahl and other contributors
//
// See doc/authors.adoc for a complete list of contributors.
//
// 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 3 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 "config.hpp"

#include <ccache/core/atomicfile.hpp>
#include <ccache/core/common.hpp>
#include <ccache/core/exceptions.hpp>
#include <ccache/core/sloppiness.hpp>
#include <ccache/util/assertions.hpp>
#include <ccache/util/configreader.hpp>
#include <ccache/util/direntry.hpp>
#include <ccache/util/environment.hpp>
#include <ccache/util/expected.hpp>
#include <ccache/util/file.hpp>
#include <ccache/util/filesystem.hpp>
#include <ccache/util/format.hpp>
#include <ccache/util/path.hpp>
#include <ccache/util/string.hpp>
#include <ccache/util/tokenizer.hpp>
#include <ccache/util/umaskscope.hpp>
#include <ccache/util/wincompat.hpp>

#ifdef HAVE_PWD_H
#  include <pwd.h>
#endif

#ifdef HAVE_UNISTD_H
#  include <unistd.h>
#endif

#include <tl/expected.hpp>

#include <algorithm>
#include <cerrno>
#include <cstdlib>
#include <cstring>
#include <fstream>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>

#ifndef environ
DLLIMPORT extern char** environ;
#endif

// Make room for binary patching at install time. The extra pointer to a buffer
// is needed to prevent the compiler from assuming too much about the string,
// such as its actual length.
const char k_libexecdir_array[4096 + 1] = LIBEXECDIR;
const char* k_libexecdir = k_libexecdir_array;
const char k_sysconfdir_array[4096 + 1] = SYSCONFDIR;
const char* k_sysconfdir = k_sysconfdir_array;

namespace fs = util::filesystem;

using util::DirEntry;
using util::make_path;

namespace {

bool
is_under_any_safe_dir(const fs::path& dir,
                      const std::vector<std::filesystem::path>& safe_dirs)
{
  // Supported forms:
  //
  //   *                -> matches any directory
  //   /abs/path        -> matches only /abs/path
  //   /abs/path/*      -> matches subdirectories of /abs/path
  return std::ranges::any_of(safe_dirs, [&](const auto& safe_dir) {
    if (safe_dir == "*" || dir == safe_dir) {
      return true;
    }
    if (safe_dir.filename() == "*") {
      const fs::path prefix = safe_dir.parent_path();
      return !prefix.empty() && util::path_starts_with(dir, prefix)
             && dir != prefix;
    }
    return false;
  });
}

bool
is_safe_compiler_check_value(const std::string& value)
{
  return value == "none" || value == "mtime" || value == "content"
         || value.starts_with("string:");
}

enum class ConfigItem : uint8_t {
  absolute_paths_in_stderr,
  base_dir,
  cache_dir,
  ceiling_dirs,
  ceiling_markers,
  compiler,
  compiler_check,
  compiler_type,
  compression,
  compression_level,
  debug,
  debug_dir,
  debug_level,
  depend_mode,
  direct_mode,
  disable,
  extra_files_to_hash,
  file_clone,
  hard_link,
  hash_dir,
  ignore_headers_in_manifest,
  ignore_options,
  inode_cache,
  keep_comments_cpp,
  libexec_dirs,
  log_file,
  max_files,
  max_size,
  msvc_dep_prefix,
  msvc_utf8,
  namespace_,
  path,
  pch_external_checksum,
  prefix_command,
  prefix_command_cpp,
  read_only,
  read_only_direct,
  recache,
  remote_only,
  remote_storage,
  reshare,
  response_file_format,
  safe_dirs,
  sloppiness,
  stats,
  stats_log,
  temporary_dir,
  umask,
};

enum class DirConfigPolicy : uint8_t {
  allow,  // always allow
  reject, // always reject with an error
  unsafe, // allow if config is in directory matching safe_dirs, error otherwise
};

struct ConfigKeyTableEntry
{
  ConfigItem item;
  DirConfigPolicy dir_config_policy;
  std::optional<std::string_view> alias = std::nullopt;
};

using C = ConfigItem;
using DCP = DirConfigPolicy;

// clang-format off
const std::unordered_map<std::string_view, ConfigKeyTableEntry>
  k_config_key_table = {
    {"absolute_paths_in_stderr",   {C::absolute_paths_in_stderr,   DCP::allow}},
    {"base_dir",                   {C::base_dir,                   DCP::allow}},
    {"cache_dir",                  {C::cache_dir,                  DCP::reject}},
    {"ceiling_dirs",               {C::ceiling_dirs,               DCP::reject}},
    {"ceiling_markers",            {C::ceiling_markers,            DCP::reject}},
    {"compiler",                   {C::compiler,                   DCP::unsafe}},
    {"compiler_check",             {C::compiler_check,             DCP::unsafe}}, // exception: some strings allowed
    {"compiler_type",              {C::compiler_type,              DCP::allow}},
    {"compression",                {C::compression,                DCP::allow}},
    {"compression_level",          {C::compression_level,          DCP::allow}},
    {"debug",                      {C::debug,                      DCP::allow}},
    {"debug_dir",                  {C::debug_dir,                  DCP::unsafe}},
    {"debug_level",                {C::debug_level,                DCP::allow}},
    {"depend_mode",                {C::depend_mode,                DCP::allow}},
    {"direct_mode",                {C::direct_mode,                DCP::allow}},
    {"disable",                    {C::disable,                    DCP::allow}},
    {"extra_files_to_hash",        {C::extra_files_to_hash,        DCP::allow}},
    {"file_clone",                 {C::file_clone,                 DCP::allow}},
    {"hard_link",                  {C::hard_link,                  DCP::allow}},
    {"hash_dir",                   {C::hash_dir,                   DCP::allow}},
    {"ignore_headers_in_manifest", {C::ignore_headers_in_manifest, DCP::allow}},
    {"ignore_options",             {C::ignore_options,             DCP::allow}},
    {"inode_cache",                {C::inode_cache,                DCP::allow}},
    {"keep_comments_cpp",          {C::keep_comments_cpp,          DCP::allow}},
    {"libexec_dirs",               {C::libexec_dirs,               DCP::unsafe}},
    {"log_file",                   {C::log_file,                   DCP::unsafe}},
    {"max_files",                  {C::max_files,                  DCP::reject}},
    {"max_size",                   {C::max_size,                   DCP::reject}},
    {"msvc_dep_prefix",            {C::msvc_dep_prefix,            DCP::allow}},
    {"msvc_utf8",                  {C::msvc_utf8,                  DCP::allow}},
    {"namespace",                  {C::namespace_,                 DCP::allow}},
    {"path",                       {C::path,                       DCP::unsafe}},
    {"pch_external_checksum",      {C::pch_external_checksum,      DCP::allow}},
    {"prefix_command",             {C::prefix_command,             DCP::unsafe}},
    {"prefix_command_cpp",         {C::prefix_command_cpp,         DCP::unsafe}},
    {"read_only",                  {C::read_only,                  DCP::allow}},
    {"read_only_direct",           {C::read_only_direct,           DCP::allow}},
    {"recache",                    {C::recache,                    DCP::allow}},
    {"remote_only",                {C::remote_only,                DCP::allow}},
    {"remote_storage",             {C::remote_storage,             DCP::unsafe}},
    {"reshare",                    {C::reshare,                    DCP::allow}},
    {"response_file_format",       {C::response_file_format,       DCP::allow}},
    {"safe_dirs",                  {C::safe_dirs,                  DCP::reject}},
    {"secondary_storage",          {C::remote_storage,             DCP::unsafe, "remote_storage"}},
    {"sloppiness",                 {C::sloppiness,                 DCP::allow}},
    {"stats",                      {C::stats,                      DCP::allow}},
    {"stats_log",                  {C::stats_log,                  DCP::unsafe}},
    {"temporary_dir",              {C::temporary_dir,              DCP::unsafe}},
    {"umask",                      {C::umask,                      DCP::unsafe}},
};
// clang-format on

const std::unordered_map<std::string_view, std::string_view>
  k_env_variable_table = {
    {"ABSSTDERR",            "absolute_paths_in_stderr"  },
    {"BASEDIR",              "base_dir"                  },
    {"CC",                   "compiler"                  }, // Alias for CCACHE_COMPILER
    {"CEILING_DIRS",         "ceiling_dirs"              },
    {"CEILING_MARKERS",      "ceiling_markers"           },
    {"COMMENTS",             "keep_comments_cpp"         },
    {"COMPILER",             "compiler"                  },
    {"COMPILERCHECK",        "compiler_check"            },
    {"COMPILERTYPE",         "compiler_type"             },
    {"COMPRESS",             "compression"               },
    {"COMPRESSLEVEL",        "compression_level"         },
    {"DEBUG",                "debug"                     },
    {"DEBUGDIR",             "debug_dir"                 },
    {"DEBUGLEVEL",           "debug_level"               },
    {"DEPEND",               "depend_mode"               },
    {"DIR",                  "cache_dir"                 },
    {"DIRECT",               "direct_mode"               },
    {"DISABLE",              "disable"                   },
    {"EXTRAFILES",           "extra_files_to_hash"       },
    {"FILECLONE",            "file_clone"                },
    {"HARDLINK",             "hard_link"                 },
    {"HASHDIR",              "hash_dir"                  },
    {"IGNOREHEADERS",        "ignore_headers_in_manifest"},
    {"IGNOREOPTIONS",        "ignore_options"            },
    {"INODECACHE",           "inode_cache"               },
    {"LIBEXEC_DIRS",         "libexec_dirs"              },
    {"LOGFILE",              "log_file"                  },
    {"MAXFILES",             "max_files"                 },
    {"MAXSIZE",              "max_size"                  },
    {"MSVC_DEP_PREFIX",      "msvc_dep_prefix"           },
    {"MSVC_UTF8",            "msvc_utf8"                 },
    {"NAMESPACE",            "namespace"                 },
    {"PATH",                 "path"                      },
    {"PCH_EXTSUM",           "pch_external_checksum"     },
    {"PREFIX",               "prefix_command"            },
    {"PREFIX_CPP",           "prefix_command_cpp"        },
    {"READONLY",             "read_only"                 },
    {"READONLY_DIRECT",      "read_only_direct"          },
    {"RECACHE",              "recache"                   },
    {"REMOTE_ONLY",          "remote_only"               },
    {"REMOTE_STORAGE",       "remote_storage"            },
    {"RESHARE",              "reshare"                   },
    {"RESPONSE_FILE_FORMAT", "response_file_format"      },
    {"SECONDARY_STORAGE",    "remote_storage"            }, // Alias for CCACHE_REMOTE_STORAGE
    {"SAFE_DIRS",            "safe_dirs"                 },
    {"SLOPPINESS",           "sloppiness"                },
    {"STATS",                "stats"                     },
    {"STATSLOG",             "stats_log"                 },
    {"TEMPDIR",              "temporary_dir"             },
    {"UMASK",                "umask"                     },
};

util::Args::ResponseFileFormat
parse_response_file_format(const std::string& value)
{
  if (value == "posix") {
    return util::Args::ResponseFileFormat::posix;
  } else if (value == "windows") {
    return util::Args::ResponseFileFormat::windows;
  } else {
    return util::Args::ResponseFileFormat::auto_guess;
  }
}

bool
parse_bool(const std::string& value,
           const std::optional<std::string> env_var_key,
           bool negate)
{
  if (env_var_key) {
    // Special rule for boolean settings from the environment: "0", "false",
    // "disable" and "no" (case insensitive) are invalid, and all other values
    // mean true.
    //
    // Previously any value meant true, but this was surprising to users, who
    // might do something like CCACHE_DISABLE=0 and expect ccache to be
    // enabled.
    std::string lower_value = util::to_lowercase(value);
    if (value == "0" || lower_value == "false" || lower_value == "disable"
        || lower_value == "no") {
      throw core::Error(
        FMT("invalid boolean environment variable value \"{}\" (did you mean to"
            " set \"CCACHE_{}{}=true\"?)",
            value,
            negate ? "" : "NO",
            *env_var_key));
    }
    return !negate;
  } else if (value == "true") {
    return true;
  } else if (value == "false") {
    return false;
  } else {
    throw core::Error(FMT("not a boolean value: \"{}\"", value));
  }
}

std::string
format_bool(bool value)
{
  return value ? "true" : "false";
}

CompilerType
parse_compiler_type(const std::string& value)
{
  if (value == "clang") {
    return CompilerType::clang;
  } else if (value == "clang-cl") {
    return CompilerType::clang_cl;
  } else if (value == "gcc") {
    return CompilerType::gcc;
  } else if (value == "icl") {
    return CompilerType::icl;
  } else if (value == "icx") {
    return CompilerType::icx;
  } else if (value == "icx-cl") {
    return CompilerType::icx_cl;
  } else if (value == "msvc") {
    return CompilerType::msvc;
  } else if (value == "nvcc") {
    return CompilerType::nvcc;
  } else if (value == "qcc") {
    return CompilerType::qcc;
  } else if (value == "other") {
    return CompilerType::other;
  } else {
    // Allow any unknown value for forward compatibility.
    return CompilerType::auto_guess;
  }
}

core::Sloppiness
parse_sloppiness(const std::string& value)
{
  core::Sloppiness result;

  for (const auto token : util::Tokenizer(value, ", ")) {
    if (token == "clang_index_store") {
      result.insert(core::Sloppy::clang_index_store);
    } else if (token == "file_stat_matches") {
      result.insert(core::Sloppy::file_stat_matches);
    } else if (token == "file_stat_matches_ctime") {
      result.insert(core::Sloppy::file_stat_matches_ctime);
    } else if (token == "gcno_cwd") {
      result.insert(core::Sloppy::gcno_cwd);
    } else if (token == "incbin") {
      result.insert(core::Sloppy::incbin);
    } else if (token == "include_file_ctime") {
      result.insert(core::Sloppy::include_file_ctime);
    } else if (token == "include_file_mtime") {
      result.insert(core::Sloppy::include_file_mtime);
    } else if (token == "ivfsoverlay") {
      result.insert(core::Sloppy::ivfsoverlay);
    } else if (token == "locale") {
      result.insert(core::Sloppy::locale);
    } else if (token == "modules") {
      result.insert(core::Sloppy::modules);
    } else if (token == "pch_defines") {
      result.insert(core::Sloppy::pch_defines);
    } else if (token == "random_seed") {
      result.insert(core::Sloppy::random_seed);
    } else if (token == "system_headers" || token == "no_system_headers") {
      result.insert(core::Sloppy::system_headers);
    } else if (token == "time_macros") {
      result.insert(core::Sloppy::time_macros);
    } // else: ignore unknown value for forward compatibility
  }

  return result;
}

std::string
format_sloppiness(core::Sloppiness sloppiness)
{
  std::string result;
  if (sloppiness.contains(core::Sloppy::clang_index_store)) {
    result += "clang_index_store, ";
  }
  if (sloppiness.contains(core::Sloppy::file_stat_matches)) {
    result += "file_stat_matches, ";
  }
  if (sloppiness.contains(core::Sloppy::file_stat_matches_ctime)) {
    result += "file_stat_matches_ctime, ";
  }
  if (sloppiness.contains(core::Sloppy::gcno_cwd)) {
    result += "gcno_cwd, ";
  }
  if (sloppiness.contains(core::Sloppy::incbin)) {
    result += "incbin, ";
  }
  if (sloppiness.contains(core::Sloppy::include_file_ctime)) {
    result += "include_file_ctime, ";
  }
  if (sloppiness.contains(core::Sloppy::include_file_mtime)) {
    result += "include_file_mtime, ";
  }
  if (sloppiness.contains(core::Sloppy::ivfsoverlay)) {
    result += "ivfsoverlay, ";
  }
  if (sloppiness.contains(core::Sloppy::locale)) {
    result += "locale, ";
  }
  if (sloppiness.contains(core::Sloppy::modules)) {
    result += "modules, ";
  }
  if (sloppiness.contains(core::Sloppy::pch_defines)) {
    result += "pch_defines, ";
  }
  if (sloppiness.contains(core::Sloppy::random_seed)) {
    result += "random_seed, ";
  }
  if (sloppiness.contains(core::Sloppy::system_headers)) {
    result += "system_headers, ";
  }
  if (sloppiness.contains(core::Sloppy::time_macros)) {
    result += "time_macros, ";
  }
  if (!result.empty()) {
    // Strip last ", ".
    result.resize(result.size() - 2);
  }
  return result;
}

std::string
format_umask(std::optional<mode_t> umask)
{
  if (umask) {
    return FMT("{:03o}", *umask);
  } else {
    return {};
  }
}

void
verify_absolute_path(const fs::path& path)
{
  if (!path.is_absolute()) {
    throw core::Error(FMT("not an absolute path: \"{}\"", path));
  }
}

bool
parse_line(const std::string& line,
           std::string* key,
           std::string* value,
           std::string* error_message)
{
  std::string_view stripped_line = util::strip_whitespace(line);
  if (stripped_line.empty() || stripped_line[0] == '#') {
    return true;
  }
  size_t equal_pos = stripped_line.find('=');
  if (equal_pos == std::string::npos) {
    *error_message = "missing equal sign";
    return false;
  }
  *key = stripped_line.substr(0, equal_pos);
  *value = stripped_line.substr(equal_pos + 1);
  *key = util::strip_whitespace(*key);
  *value = util::strip_whitespace(*value);
  return true;
}

std::unordered_map<std::string, std::string>
create_cmdline_settings_map(const std::vector<std::string>& settings)
{
  std::unordered_map<std::string, std::string> result;
  for (const auto& setting : settings) {
    DEBUG_ASSERT(setting.find('=') != std::string::npos);
    std::string key;
    std::string value;
    std::string error_message;
    bool ok = parse_line(setting, &key, &value, &error_message);
    ASSERT(ok);
    if (!key.empty()) {
      result.insert_or_assign(std::move(key), std::move(value));
    }
  }
  return result;
}

#ifndef _WIN32

fs::path
default_cache_dir(const fs::path& home_dir)
{
#  ifdef __APPLE__
  return home_dir / "Library/Caches/ccache";
#  else
  return home_dir / ".cache/ccache";
#  endif
}

fs::path
default_config_dir(const fs::path& home_dir)
{
#  ifdef __APPLE__
  return home_dir / "Library/Preferences/ccache";
#  else
  return home_dir / ".config/ccache";
#  endif
}

#endif // !_WIN32

fs::path
home_directory()
{
#ifdef _WIN32
  auto user_profile = util::getenv_path("USERPROFILE");
  if (user_profile) {
    return *user_profile;
  }
  throw core::Fatal(
    "The USERPROFILE environment variable must be set to your user profile"
    " folder");
#else
  auto home = util::getenv_path("HOME");
  if (home) {
    return *home;
  }
#  ifdef HAVE_GETPWUID
  {
    struct passwd* pwd = getpwuid(getuid());
    if (pwd) {
      return pwd->pw_dir;
    }
  }
#  endif
  throw core::Fatal(
    "Could not determine home directory from $HOME or getpwuid(3)");
#endif
}

std::string
response_file_format_to_string(
  util::Args::ResponseFileFormat response_file_format)
{
  switch (response_file_format) {
  case util::Args::ResponseFileFormat::auto_guess:
    return "auto";
  case util::Args::ResponseFileFormat::posix:
    return "posix";
  case util::Args::ResponseFileFormat::windows:
    return "windows";
  }

  ASSERT(false);
}

} // namespace

void
Config::set_ceiling_dirs(const std::vector<std::filesystem::path>& value)
{
  m_ceiling_dirs.clear();
  for (const auto& path : value) {
    verify_absolute_path(path);
    m_ceiling_dirs.push_back(util::lexically_normal(path));
  }
}

void
Config::set_safe_dirs(const std::vector<std::filesystem::path>& value)
{
  m_safe_dirs.clear();
  for (const auto& path : value) {
    if (path == "*") {
      m_safe_dirs.push_back(path);
    } else {
      verify_absolute_path(path);
      m_safe_dirs.push_back(util::lexically_normal(path));
    }
  }
}

std::string
compiler_type_to_string(CompilerType compiler_type)
{
#define CASE(type)                                                             \
  case CompilerType::type:                                                     \
    return #type

  switch (compiler_type) {
  case CompilerType::auto_guess:
    return "auto";
  case CompilerType::clang_cl:
    return "clang-cl";
  case CompilerType::icx_cl:
    return "icx-cl";

    CASE(clang);
    CASE(gcc);
    CASE(icl);
    CASE(icx);
    CASE(msvc);
    CASE(nvcc);
    CASE(qcc);
    CASE(other);
  }
#undef CASE

  ASSERT(false);
}

void
Config::read(const std::vector<std::string>& cmdline_config_settings)
{
  auto cmdline_settings_map =
    create_cmdline_settings_map(cmdline_config_settings);

  const fs::path home_dir = home_directory();

  set_ceiling_dirs({home_dir});

  const util::DirEntry legacy_ccache_dir = home_dir / ".ccache";
#ifdef _WIN32
  auto env_appdata = util::getenv_path("APPDATA");
  auto env_local_appdata = util::getenv_path("LOCALAPPDATA");
#else
  auto env_xdg_cache_home = util::getenv_path("XDG_CACHE_HOME");
  auto env_xdg_config_home = util::getenv_path("XDG_CONFIG_HOME");
#endif

  auto env_ccache_configpath = util::getenv_path("CCACHE_CONFIGPATH");
  if (env_ccache_configpath) {
    set_config_path(*env_ccache_configpath);
  } else {
    // Only used for ccache tests:
    auto env_ccache_configpath2 = util::getenv_path("CCACHE_CONFIGPATH2");

    fs::path sysconfdir(k_sysconfdir);
#ifdef _WIN32
    auto program_data = util::getenv_path("ALLUSERSPROFILE");
    if (program_data) {
      sysconfdir = *program_data / "ccache";
    }
#endif

    set_system_config_path(env_ccache_configpath2 ? *env_ccache_configpath2
                                                  : sysconfdir / "ccache.conf");
    // Config priority 5: system-wide config.
    //
    // Note: A missing config file in SYSCONFDIR is OK so don't check return
    // value.
    update_from_file(system_config_path());

    auto env_ccache_dir = util::getenv_path("CCACHE_DIR");
    auto cmdline_cache_dir = cmdline_settings_map.find("cache_dir");

    fs::path config_dir;
    if (cmdline_cache_dir != cmdline_settings_map.end()) {
      config_dir = cmdline_cache_dir->second;
    } else if (env_ccache_dir && !env_ccache_dir->empty()) {
      config_dir = *env_ccache_dir;
    } else if (!cache_dir().empty() && !env_ccache_dir) {
      config_dir = cache_dir();
    } else if (legacy_ccache_dir.is_directory()) {
      config_dir = legacy_ccache_dir.path();
#ifdef _WIN32
    } else if (env_local_appdata
               && fs::exists(*env_local_appdata / "ccache/ccache.conf")) {
      config_dir = *env_local_appdata / "ccache";
    } else if (env_appdata && fs::exists(*env_appdata / "ccache/ccache.conf")) {
      config_dir = make_path(*env_appdata, "ccache");
    } else if (env_local_appdata) {
      config_dir = *env_local_appdata / "ccache";
    } else {
      throw core::Fatal(
        "could not find configuration file and the LOCALAPPDATA environment"
        " variable is not set");
    }
#else
    } else if (env_xdg_config_home) {
      config_dir = *env_xdg_config_home / "ccache";
    } else {
      config_dir = default_config_dir(home_dir);
    }
#endif
    set_config_path(config_dir / "ccache.conf");
  }

  const fs::path& cache_dir_before_config_file_was_read = cache_dir();

  // Config priority 4: cache-specific config.
  update_from_file(config_path());
  // Ignore cache_dir set in cache-specific configuration file:
  set_cache_dir(cache_dir_before_config_file_was_read);

  // Config priority 3: directory-specific config.
  //
  // We need special handling of CCACHE_CEILING_DIRS/CCACHE_CEILING_MARKERS and
  // ceiling_dirs/ceiling_markers from the command line since we want those
  // settings to be applied before other settings from the directory config, but
  // other settings in the directory config should have lower priority than
  // those from environment and command line.
  if (!env_ccache_configpath) {
    auto ceiling_dirs_entry = cmdline_settings_map.find("ceiling_dirs");
    if (ceiling_dirs_entry != cmdline_settings_map.end()) {
      set_ceiling_dirs(util::split_path_list(ceiling_dirs_entry->second));
    } else if (getenv("CCACHE_CEILING_DIRS")) {
      set_ceiling_dirs(util::getenv_path_list("CCACHE_CEILING_DIRS"));
    }
    auto ceiling_markers_entry = cmdline_settings_map.find("ceiling_markers");
    if (ceiling_markers_entry != cmdline_settings_map.end()) {
      set_ceiling_markers(util::split_path_list(ceiling_markers_entry->second));
    } else if (getenv("CCACHE_CEILING_MARKERS")) {
      set_ceiling_markers(util::getenv_path_list("CCACHE_CEILING_MARKERS"));
    }

    auto safe_dirs_entry = cmdline_settings_map.find("safe_dirs");
    if (safe_dirs_entry != cmdline_settings_map.end()) {
      set_safe_dirs(util::split_path_list(safe_dirs_entry->second));
    } else if (getenv("CCACHE_SAFE_DIRS")) {
      set_safe_dirs(util::getenv_path_list("CCACHE_SAFE_DIRS"));
    }

    auto dir_config = find_directory_config();
    if (dir_config) {
      update_from_dir_config_file(*dir_config);
      m_dir_config_path = std::move(*dir_config);
    }
  }

  // Config priority 2: environment variables.
  update_from_environment();

  // Config priority 1: command-line settings.
  update_from_map(cmdline_settings_map);

  if (cache_dir().empty()) {
    if (legacy_ccache_dir.is_directory()) {
      set_cache_dir(legacy_ccache_dir.path());
#ifdef _WIN32
    } else if (env_local_appdata) {
      set_cache_dir(*env_local_appdata / "ccache");
    } else {
      throw core::Fatal(
        "could not find cache directory and the LOCALAPPDATA environment"
        " variable is not set");
    }
#else
    } else if (env_xdg_cache_home) {
      set_cache_dir(*env_xdg_cache_home / "ccache");
    } else {
      set_cache_dir(default_cache_dir(home_dir));
    }
#endif
  }
  // else: cache_dir was set explicitly via environment or via system config.
}

const char*
Config::libexec_dir()
{
  return k_libexecdir;
}

const char*
Config::sysconf_dir()
{
  return k_sysconfdir;
}

const fs::path&
Config::config_path() const
{
  return m_config_path;
}

const fs::path&
Config::dir_config_path() const
{
  return m_dir_config_path;
}

const fs::path&
Config::system_config_path() const
{
  return m_system_config_path;
}

void
Config::set_base_dirs(const std::vector<std::filesystem::path>& value)
{
  m_base_dirs.clear();
  for (const auto& path : value) {
    verify_absolute_path(path);
    m_base_dirs.push_back(util::lexically_normal(path));
  }
}

void
Config::set_config_path(const fs::path& path)
{
  m_config_path = util::lexically_normal(path);
}

void
Config::set_system_config_path(const fs::path& path)
{
  m_system_config_path = util::lexically_normal(path);
}

bool
Config::update_from_file(const fs::path& path)
{
  auto config_content = util::read_file<std::string>(path);
  if (!config_content) {
    return false;
  }

  util::ConfigReader reader(*config_content);

  while (true) {
    auto item_result = reader.read_next_item();
    if (!item_result) {
      throw core::Error(FMT("{}:{}: {}",
                            path,
                            item_result.error().line_number,
                            item_result.error().message));
    }

    auto& item = *item_result;
    if (!item) {
      break; // EOF
    }

    try {
      set_item(item->key, item->value, std::nullopt, false, util::pstr(path));
    } catch (const core::Error& e) {
      throw core::Error(FMT("{}:{}: {}", path, item->line_number, e.what()));
    }
  }

  return true;
}

bool
Config::update_from_dir_config_file(const fs::path& path)
{
  auto config_content = util::read_file<std::string>(path);
  if (!config_content) {
    return false;
  }

  util::ConfigReader reader(*config_content);

  const fs::path dir = path.parent_path();
  const bool allow_unsafe = is_under_any_safe_dir(dir, m_safe_dirs);

  while (true) {
    auto item_result = reader.read_next_item();
    if (!item_result) {
      throw core::Error(FMT("{}:{}: {}",
                            path,
                            item_result.error().line_number,
                            item_result.error().message));
    }

    auto& item = *item_result;
    if (!item) {
      break; // EOF
    }

    const auto it = k_config_key_table.find(item->key);
    if (it == k_config_key_table.end()) {
      throw core::Error(FMT("{}:{}: unknown configuration option \"{}\"",
                            path,
                            item->line_number,
                            item->key));
    }

    const auto policy = it->second.dir_config_policy;
    if (policy == DirConfigPolicy::reject) {
      throw core::Error(
        FMT("{}:{}: configuration option \"{}\" is not allowed in directory"
            " configuration files",
            path,
            item->line_number,
            item->key));
    }

    if (policy == DirConfigPolicy::unsafe && !allow_unsafe) {
      if (it->second.item == ConfigItem::compiler_check) {
        // Value-dependent exception: allow compiler_check as long as it doesn't
        // invoke a command.
        auto expanded_value = util::expand_environment_variables(item->value);
        if (!expanded_value) {
          throw core::Error(
            FMT("{}:{}: {}", path, item->line_number, expanded_value.error()));
        }
        if (!is_safe_compiler_check_value(*expanded_value)) {
          throw core::Error(FMT(
            "{}:{}: configuration option \"{}\" is considered unsafe when it"
            " invokes a command and is only allowed in directory configuration"
            " files located under safe_dirs",
            path,
            item->line_number,
            item->key));
        }
      } else {
        throw core::Error(FMT(
          "{}:{}: configuration option \"{}\" is considered unsafe and is only"
          " allowed in directory configuration files located under safe_dirs",
          path,
          item->line_number,
          item->key));
      }
    }

    try {
      set_item(item->key, item->value, std::nullopt, false, util::pstr(path));
    } catch (const core::Error& e) {
      throw core::Error(FMT("{}:{}: {}", path, item->line_number, e.what()));
    }
  }

  return true;
}

void
Config::update_from_map(const std::unordered_map<std::string, std::string>& map)
{
  for (const auto& [key, value] : map) {
    try {
      set_item(key, value, std::nullopt, false, "command line");
    } catch (core::Error& e) {
      throw core::Error(
        FMT("when parsing command line config \"{}\": {}", key, e.what()));
    }
  }
}

void
Config::update_from_environment()
{
  for (char** env = environ; *env; ++env) {
    std::string setting = *env;
    const std::string prefix = "CCACHE_";
    if (!setting.starts_with(prefix)) {
      continue;
    }
    size_t equal_pos = setting.find('=');
    if (equal_pos == std::string::npos) {
      continue;
    }

    std::string key = setting.substr(prefix.size(), equal_pos - prefix.size());
    std::string value = setting.substr(equal_pos + 1);
    bool negate = key.starts_with("NO");
    if (negate) {
      key = key.substr(2);
    }

    auto it = k_env_variable_table.find(key);
    if (it == k_env_variable_table.end()) {
      // Ignore unknown keys.
      continue;
    }
    const auto& config_key = it->second;

    try {
      set_item(config_key, value, key, negate, "environment");
    } catch (const core::Error& e) {
      throw core::Error(
        FMT("CCACHE_{}{}: {}", negate ? "NO" : "", key, e.what()));
    }
  }
}

std::string
Config::get_string_value(const std::string& key) const
{
  auto it = k_config_key_table.find(key);
  if (it == k_config_key_table.end()) {
    throw core::Error(FMT("unknown configuration option \"{}\"", key));
  }

  switch (it->second.item) {
  case ConfigItem::absolute_paths_in_stderr:
    return format_bool(m_absolute_paths_in_stderr);

  case ConfigItem::base_dir:
    return util::join_path_list(m_base_dirs);

  case ConfigItem::cache_dir:
    return m_cache_dir.string();

  case ConfigItem::ceiling_dirs:
    return util::join_path_list(m_ceiling_dirs);

  case ConfigItem::ceiling_markers:
    return util::join_path_list(m_ceiling_markers);

  case ConfigItem::compiler:
    return m_compiler;

  case ConfigItem::compiler_check:
    return m_compiler_check;

  case ConfigItem::compiler_type:
    return compiler_type_to_string(m_compiler_type);

  case ConfigItem::compression:
    return format_bool(m_compression);

  case ConfigItem::compression_level:
    return FMT("{}", m_compression_level);

  case ConfigItem::debug:
    return format_bool(m_debug);

  case ConfigItem::debug_dir:
    return m_debug_dir.string();

  case ConfigItem::debug_level:
    return FMT("{}", m_debug_level);

  case ConfigItem::depend_mode:
    return format_bool(m_depend_mode);

  case ConfigItem::direct_mode:
    return format_bool(m_direct_mode);

  case ConfigItem::disable:
    return format_bool(m_disable);

  case ConfigItem::extra_files_to_hash:
    return m_extra_files_to_hash;

  case ConfigItem::file_clone:
    return format_bool(m_file_clone);

  case ConfigItem::hard_link:
    return format_bool(m_hard_link);

  case ConfigItem::hash_dir:
    return format_bool(m_hash_dir);

  case ConfigItem::ignore_headers_in_manifest:
    return m_ignore_headers_in_manifest;

  case ConfigItem::ignore_options:
    return m_ignore_options;

  case ConfigItem::inode_cache:
    return format_bool(m_inode_cache);

  case ConfigItem::keep_comments_cpp:
    return format_bool(m_keep_comments_cpp);

  case ConfigItem::libexec_dirs:
    return util::join_path_list(m_libexec_dirs);

  case ConfigItem::log_file:
    return m_log_file.string();

  case ConfigItem::max_files:
    return FMT("{}", m_max_files);

  case ConfigItem::max_size: {
    auto result =
      util::format_human_readable_size(m_max_size, m_size_prefix_type);
    if (result.ends_with(" bytes")) {
      // Special case to make the output parsable by util::parse_size.
      result.resize(result.size() - 6);
    }
    return result;
  }

  case ConfigItem::msvc_dep_prefix:
    return m_msvc_dep_prefix;

  case ConfigItem::msvc_utf8:
    return format_bool(m_msvc_utf8);

  case ConfigItem::namespace_:
    return m_namespace;

  case ConfigItem::path:
    return m_path;

  case ConfigItem::pch_external_checksum:
    return format_bool(m_pch_external_checksum);

  case ConfigItem::prefix_command:
    return m_prefix_command;

  case ConfigItem::prefix_command_cpp:
    return m_prefix_command_cpp;

  case ConfigItem::read_only:
    return format_bool(m_read_only);

  case ConfigItem::read_only_direct:
    return format_bool(m_read_only_direct);

  case ConfigItem::recache:
    return format_bool(m_recache);

  case ConfigItem::remote_only:
    return format_bool(m_remote_only);

  case ConfigItem::remote_storage:
    return m_remote_storage;

  case ConfigItem::reshare:
    return format_bool(m_reshare);

  case ConfigItem::response_file_format:
    return response_file_format_to_string(m_response_file_format);

  case ConfigItem::safe_dirs:
    return util::join_path_list(m_safe_dirs);

  case ConfigItem::sloppiness:
    return format_sloppiness(m_sloppiness);

  case ConfigItem::stats:
    return format_bool(m_stats);

  case ConfigItem::stats_log:
    return m_stats_log.string();

  case ConfigItem::temporary_dir:
    return m_temporary_dir.string();

  case ConfigItem::umask:
    return format_umask(m_umask);
  }

  ASSERT(false); // Never reached
}

void
Config::set_value_in_file(const std::string& path,
                          const std::string& key,
                          const std::string& value) const
{
  util::UmaskScope umask_scope(m_umask);

  if (k_config_key_table.find(key) == k_config_key_table.end()) {
    throw core::Error(FMT("unknown configuration option \"{}\"", key));
  }

  // Verify that the value is valid; set_item will throw if not.
  Config dummy_config;
  dummy_config.set_item(key, value, std::nullopt, false, "");

  const fs::path resolved_path = fs::canonical(path).value_or(path);
  if (!fs::is_regular_file(resolved_path)) {
    core::ensure_dir_exists(resolved_path.parent_path());
    util::throw_on_error<core::Error>(
      util::write_file(resolved_path, ""),
      FMT("failed to write to {}: ", resolved_path));
  }

  auto config_content = util::read_file<std::string>(path);
  if (!config_content) {
    throw core::Error(FMT("failed to read {}: {}", path, strerror(errno)));
  }

  std::string result;
  result.reserve(config_content->size() + key.size() + 3 + value.size() + 1);
  bool key_found = false;

  util::ConfigReader reader(*config_content);
  while (true) {
    auto item_result = reader.read_next_raw_item();
    if (!item_result) {
      throw core::Error(FMT("failed to read {}: {}:{}",
                            path,
                            item_result.error().line_number,
                            item_result.error().message));
    }

    auto& item = *item_result;
    if (!item) {
      break; // EOF
    }

    if (item->key == key) {
      // Copy everything before this entry
      result.append(*config_content, 0, item->value_start_pos);
      result.append(value);
      result.append(*config_content,
                    item->value_start_pos + item->value_length);
      key_found = true;
      break;
    }
  }

  if (!key_found) {
    result = std::move(*config_content);
    if (!result.empty() && result.back() != '\n') {
      result += '\n';
    }
    result += FMT("{} = {}\n", key, value);
  }

  core::AtomicFile output(resolved_path, core::AtomicFile::Mode::text);
  output.write(result);
  output.commit();
}

void
Config::visit_items(const ItemVisitor& item_visitor) const
{
  std::vector<std::string> keys;
  keys.reserve(k_config_key_table.size());

  for (const auto& [key, entry] : k_config_key_table) {
    if (!entry.alias) {
      keys.emplace_back(key);
    }
  }
  std::sort(keys.begin(), keys.end());
  for (const auto& key : keys) {
    auto it = m_origins.find(key);
    std::string origin = it != m_origins.end() ? it->second : "default";
    item_visitor(key, get_string_value(key), origin);
  }
}

void
Config::set_item(const std::string_view& key,
                 const std::string& unexpanded_value,
                 const std::optional<std::string>& env_var_key,
                 bool negate,
                 const std::string& origin)
{
  auto it = k_config_key_table.find(key);
  if (it == k_config_key_table.end()) {
    // Ignore unknown keys.
    return;
  }

  std::string value = util::value_or_throw<core::Error>(
    util::expand_environment_variables(unexpanded_value));

  switch (it->second.item) {
  case ConfigItem::absolute_paths_in_stderr:
    m_absolute_paths_in_stderr = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::base_dir:
    set_base_dirs(util::split_path_list(value));
    break;

  case ConfigItem::cache_dir:
    set_cache_dir(value);
    break;

  case ConfigItem::ceiling_dirs:
    set_ceiling_dirs(util::split_path_list(value));
    break;

  case ConfigItem::ceiling_markers:
    set_ceiling_markers(util::split_path_list(value));
    break;

  case ConfigItem::compiler:
    m_compiler = value;
    break;

  case ConfigItem::compiler_check:
    m_compiler_check = value;
    break;

  case ConfigItem::compiler_type:
    m_compiler_type = parse_compiler_type(value);
    break;

  case ConfigItem::compression:
    m_compression = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::compression_level:
    m_compression_level = static_cast<int8_t>(util::value_or_throw<core::Error>(
      util::parse_signed(value, INT8_MIN, INT8_MAX, "compression_level")));
    break;

  case ConfigItem::debug:
    m_debug = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::debug_dir:
    m_debug_dir = value;
    break;

  case ConfigItem::debug_level:
    m_debug_level = static_cast<uint8_t>(util::value_or_throw<core::Error>(
      util::parse_unsigned(value, 0, UINT8_MAX, "debug level")));
    break;

  case ConfigItem::depend_mode:
    m_depend_mode = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::direct_mode:
    m_direct_mode = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::disable:
    m_disable = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::extra_files_to_hash:
    m_extra_files_to_hash = value;
    break;

  case ConfigItem::file_clone:
    m_file_clone = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::hard_link:
    m_hard_link = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::hash_dir:
    m_hash_dir = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::ignore_headers_in_manifest:
    m_ignore_headers_in_manifest = value;
    break;

  case ConfigItem::ignore_options:
    m_ignore_options = value;
    break;

  case ConfigItem::inode_cache:
    m_inode_cache = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::keep_comments_cpp:
    m_keep_comments_cpp = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::libexec_dirs:
    m_libexec_dirs = util::split_path_list(value);
    break;

  case ConfigItem::log_file:
    m_log_file = value;
    break;

  case ConfigItem::max_files:
    m_max_files = util::value_or_throw<core::Error>(
      util::parse_unsigned(value, std::nullopt, std::nullopt, "max_files"));
    break;

  case ConfigItem::max_size: {
    const auto [size, prefix_type] =
      util::value_or_throw<core::Error>(util::parse_size(value));
    m_max_size = size;
    m_size_prefix_type = prefix_type;
    break;
  }

  case ConfigItem::msvc_dep_prefix:
    m_msvc_dep_prefix = value;
    break;

  case ConfigItem::msvc_utf8:
    m_msvc_utf8 = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::namespace_:
    m_namespace = value;
    break;

  case ConfigItem::path:
    m_path = value;
    break;

  case ConfigItem::pch_external_checksum:
    m_pch_external_checksum = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::prefix_command:
    m_prefix_command = value;
    break;

  case ConfigItem::prefix_command_cpp:
    m_prefix_command_cpp = value;
    break;

  case ConfigItem::read_only:
    m_read_only = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::read_only_direct:
    m_read_only_direct = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::recache:
    m_recache = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::remote_only:
    m_remote_only = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::remote_storage:
    m_remote_storage = value;
    break;

  case ConfigItem::reshare:
    m_reshare = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::response_file_format:
    m_response_file_format = parse_response_file_format(value);
    break;

  case ConfigItem::safe_dirs:
    set_safe_dirs(util::split_path_list(value));
    break;

  case ConfigItem::sloppiness:
    m_sloppiness = parse_sloppiness(value);
    break;

  case ConfigItem::stats:
    m_stats = parse_bool(value, env_var_key, negate);
    break;

  case ConfigItem::stats_log:
    m_stats_log = value;
    break;

  case ConfigItem::temporary_dir:
    m_temporary_dir = value;
    m_temporary_dir_configured_explicitly = true;
    break;

  case ConfigItem::umask:
    if (!value.empty()) {
      m_umask = util::value_or_throw<core::Error>(util::parse_umask(value));
    }
    break;
  }

  const std::string_view& canonical_key = it->second.alias.value_or(key);
  const auto& [element, inserted] = m_origins.emplace(canonical_key, origin);
  if (!inserted) {
    element->second = origin;
  }
}

void
Config::check_key_tables_consistency()
{
  for (const auto& [key, value] : k_env_variable_table) {
    if (k_config_key_table.find(value) == k_config_key_table.end()) {
      throw core::Error(
        FMT("env var {} mapped to {} which is missing from k_config_key_table",
            key,
            value));
    }
  }
}

fs::path
Config::default_temporary_dir() const
{
  const auto dir = get_xdg_runtime_tmp_dir();
  return !dir.empty() ? dir : m_cache_dir / "tmp";
}

std::filesystem::path
Config::get_xdg_runtime_tmp_dir()
{
#ifdef _WIN32
  return {};
#else
  const char* const xdg_runtime_dir = getenv("XDG_RUNTIME_DIR");
  if (xdg_runtime_dir && DirEntry(xdg_runtime_dir).is_directory()) {
    fs::path dir = FMT("{}/ccache-tmp", xdg_runtime_dir);
    if (fs::create_directories(dir) && access(dir.c_str(), W_OK) == 0) {
      return dir;
    }
  }
  return {};
#endif
}

std::optional<std::filesystem::path>
Config::find_directory_config() const
{
  auto cwd = fs::current_path();
  if (!cwd) {
    return std::nullopt;
  }

  fs::path dir = util::lexically_normal(*cwd);

#ifndef _WIN32
  const uid_t euid = geteuid();
#endif

  DirEntry dir_entry(dir);

  while (true) {
    // Stop if dir is a ceiling dir (exclusive: don't check this dir).
    for (const auto& ceiling : m_ceiling_dirs) {
      if (dir == ceiling) {
        return std::nullopt;
      }
    }

    if (!dir_entry.is_directory()) {
      return std::nullopt;
    }

#ifndef _WIN32
    // Stop if dir is owned by another user (sanity/performance check).
    if (dir_entry.uid() != euid) {
      return std::nullopt;
    }
#endif

    // Check for a directory-specific config file.
    const fs::path candidate = dir / "ccache.conf";
    const DirEntry candidate_entry(candidate);
    if (candidate_entry.is_regular_file()) {
#ifndef _WIN32
      if (candidate_entry.uid() != euid) {
        throw core::Error(
          FMT("directory-specific configuration file {} owned by another user"
              " (owner {} != uid {})",
              candidate,
              candidate_entry.uid(),
              euid));
      }
      if (candidate_entry.mode() & S_IWOTH) {
        throw core::Error(
          FMT("directory-specific configuration file {} is world-writable",
              candidate));
      }
#endif
      return candidate;
    }

    // Stop if this dir contains a ceiling marker.
    for (const auto& marker : m_ceiling_markers) {
      if (DirEntry(dir / marker)) {
        return std::nullopt;
      }
    }

    // Stop at filesystem root or filesystem boundary.
    fs::path parent = dir.parent_path();
    if (parent == dir) {
      return std::nullopt;
    }
    DirEntry parent_entry(parent);
    if (!parent_entry.is_directory()
        || parent_entry.device() != dir_entry.device()) {
      return std::nullopt;
    }

    dir = std::move(parent);
    dir_entry = std::move(parent_entry);
  }
}
