Thread `ApplyConfigOptions` through config parsing

This makes no changes to logic but makes the `ApplyConfigOptions` value
available to consumers.

Change-Id: I88cf53d38faac8472c556aee55c13d0acbd1e5db

3 files changed, 68 insertions, 58 deletions

diff --git a/src/libutil/config-impl.hh b/src/libutil/config-impl.hh
index 024018e00..748107b6e 100644
--- a/src/libutil/config-impl.hh
+++ b/src/libutil/config-impl.hh
@@ -51,14 +51,14 @@ bool BaseSetting<T>::isAppendable()
     return trait::appendable;
 }
 
-template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append);
-template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append);
-template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append);
-template<> void BaseSetting<ExperimentalFeatures>::appendOrSet(ExperimentalFeatures newValue, bool append);
-template<> void BaseSetting<DeprecatedFeatures>::appendOrSet(DeprecatedFeatures newValue, bool append);
+template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append, const ApplyConfigOptions & options);
+template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append, const ApplyConfigOptions & options);
+template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append, const ApplyConfigOptions & options);
+template<> void BaseSetting<ExperimentalFeatures>::appendOrSet(ExperimentalFeatures newValue, bool append, const ApplyConfigOptions & options);
+template<> void BaseSetting<DeprecatedFeatures>::appendOrSet(DeprecatedFeatures newValue, bool append, const ApplyConfigOptions & options);
 
 template<typename T>
-void BaseSetting<T>::appendOrSet(T newValue, bool append)
+void BaseSetting<T>::appendOrSet(T newValue, bool append, const ApplyConfigOptions & options)
 {
     static_assert(
         !trait::appendable,
@@ -69,14 +69,14 @@ void BaseSetting<T>::appendOrSet(T newValue, bool append)
 }
 
 template<typename T>
-void BaseSetting<T>::set(const std::string & str, bool append)
+void BaseSetting<T>::set(const std::string & str, bool append, const ApplyConfigOptions & options)
 {
     if (experimentalFeatureSettings.isEnabled(experimentalFeature)) {
-        auto parsed = parse(str);
+        auto parsed = parse(str, options);
         if (deprecated && (append || parsed != value)) {
             warn("deprecated setting '%s' found (set to '%s')", name, str);
         }
-        appendOrSet(std::move(parsed), append);
+        appendOrSet(std::move(parsed), append, options);
     } else {
         assert(experimentalFeature);
         warn("Ignoring setting '%s' because experimental feature '%s' is not enabled",
@@ -111,7 +111,7 @@ void BaseSetting<T>::convertToArg(Args & args, const std::string & category)
 }
 
 #define DECLARE_CONFIG_SERIALISER(TY) \
-    template<> TY BaseSetting< TY >::parse(const std::string & str) const; \
+    template<> TY BaseSetting< TY >::parse(const std::string & str, const ApplyConfigOptions & options) const; \
     template<> std::string BaseSetting< TY >::to_string() const;
 
 DECLARE_CONFIG_SERIALISER(std::string)
@@ -124,7 +124,7 @@ DECLARE_CONFIG_SERIALISER(ExperimentalFeatures)
 DECLARE_CONFIG_SERIALISER(DeprecatedFeatures)
 
 template<typename T>
-T BaseSetting<T>::parse(const std::string & str) const
+T BaseSetting<T>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     static_assert(std::is_integral<T>::value, "Integer required.");
 
diff --git a/src/libutil/config.cc b/src/libutil/config.cc
index 8e20f1321..333deb388 100644
--- a/src/libutil/config.cc
+++ b/src/libutil/config.cc
@@ -1,4 +1,5 @@
 #include "config.hh"
+#include "apply-config-options.hh"
 #include "args.hh"
 #include "abstract-setting-to-json.hh"
 #include "experimental-features.hh"
@@ -17,7 +18,7 @@ Config::Config(StringMap initials)
     : AbstractConfig(std::move(initials))
 { }
 
-bool Config::set(const std::string & name, const std::string & value)
+bool Config::set(const std::string & name, const std::string & value, const ApplyConfigOptions & options)
 {
     bool append = false;
     auto i = _settings.find(name);
@@ -30,7 +31,7 @@ bool Config::set(const std::string & name, const std::string & value)
         } else
             return false;
     }
-    i->second.setting->set(value, append);
+    i->second.setting->set(value, append, options);
     i->second.setting->overridden = true;
     return true;
 }
@@ -91,7 +92,7 @@ void Config::getSettings(std::map<std::string, SettingInfo> & res, bool overridd
 }
 
 
-static void applyConfigInner(const std::string & contents, const std::string & path, std::vector<std::pair<std::string, std::string>> & parsedContents) {
+static void applyConfigInner(const std::string & contents, const ApplyConfigOptions & options, std::vector<std::pair<std::string, std::string>> & parsedContents) {
     unsigned int pos = 0;
 
     while (pos < contents.size()) {
@@ -107,7 +108,7 @@ static void applyConfigInner(const std::string & contents, const std::string & p
         if (tokens.empty()) continue;
 
         if (tokens.size() < 2)
-            throw UsageError("illegal configuration line '%1%' in '%2%'", line, path);
+            throw UsageError("illegal configuration line '%1%' in '%2%'", line, options.relativeDisplay());
 
         auto include = false;
         auto ignoreMissing = false;
@@ -119,24 +120,32 @@ static void applyConfigInner(const std::string & contents, const std::string & p
         }
 
         if (include) {
-            if (tokens.size() != 2)
-                throw UsageError("illegal configuration line '%1%' in '%2%'", line, path);
-            auto p = absPath(tokens[1], dirOf(path));
-            if (pathExists(p)) {
+            if (tokens.size() != 2) {
+                throw UsageError("illegal configuration line '%1%' in '%2%'", line, options.relativeDisplay());
+            }
+            if (!options.path) {
+                throw UsageError("can only include configuration '%1%' from files", tokens[1]);
+            }
+            auto pathToInclude = absPath(tokens[1], dirOf(*options.path));
+            if (pathExists(pathToInclude)) {
+                auto includeOptions = ApplyConfigOptions {
+                    .path = pathToInclude,
+                    .home = options.home,
+                };
                 try {
-                    std::string includedContents = readFile(path);
-                    applyConfigInner(includedContents, p, parsedContents);
+                    std::string includedContents = readFile(pathToInclude);
+                    applyConfigInner(includedContents, includeOptions, parsedContents);
                 } catch (SysError &) {
                     // TODO: Do we actually want to ignore this? Or is it better to fail?
                 }
             } else if (!ignoreMissing) {
-                throw Error("file '%1%' included from '%2%' not found", p, path);
+                throw Error("file '%1%' included from '%2%' not found", pathToInclude, *options.path);
             }
             continue;
         }
 
         if (tokens[1] != "=")
-            throw UsageError("illegal configuration line '%1%' in '%2%'", line, path);
+            throw UsageError("illegal configuration line '%1%' in '%2%'", line, options.relativeDisplay());
 
         std::string name = std::move(tokens[0]);
 
@@ -150,20 +159,20 @@ static void applyConfigInner(const std::string & contents, const std::string & p
     };
 }
 
-void AbstractConfig::applyConfig(const std::string & contents, const std::string & path) {
+void AbstractConfig::applyConfig(const std::string & contents, const ApplyConfigOptions & options) {
     std::vector<std::pair<std::string, std::string>> parsedContents;
 
-    applyConfigInner(contents, path, parsedContents);
+    applyConfigInner(contents, options, parsedContents);
 
     // First apply experimental-feature related settings
     for (const auto & [name, value] : parsedContents)
         if (name == "experimental-features" || name == "extra-experimental-features")
-            set(name, value);
+            set(name, value, options);
 
     // Then apply other settings
     for (const auto & [name, value] : parsedContents)
         if (name != "experimental-features" && name != "extra-experimental-features")
-            set(name, value);
+            set(name, value, options);
 }
 
 void Config::resetOverridden()
@@ -241,7 +250,7 @@ void AbstractSetting::convertToArg(Args & args, const std::string & category)
 
 bool AbstractSetting::isOverridden() const { return overridden; }
 
-template<> std::string BaseSetting<std::string>::parse(const std::string & str) const
+template<> std::string BaseSetting<std::string>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     return str;
 }
@@ -251,7 +260,7 @@ template<> std::string BaseSetting<std::string>::to_string() const
     return value;
 }
 
-template<> std::optional<std::string> BaseSetting<std::optional<std::string>>::parse(const std::string & str) const
+template<> std::optional<std::string> BaseSetting<std::optional<std::string>>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     if (str == "")
         return std::nullopt;
@@ -264,7 +273,7 @@ template<> std::string BaseSetting<std::optional<std::string>>::to_string() cons
     return value ? *value : "";
 }
 
-template<> bool BaseSetting<bool>::parse(const std::string & str) const
+template<> bool BaseSetting<bool>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     if (str == "true" || str == "yes" || str == "1")
         return true;
@@ -297,12 +306,12 @@ template<> void BaseSetting<bool>::convertToArg(Args & args, const std::string &
     });
 }
 
-template<> Strings BaseSetting<Strings>::parse(const std::string & str) const
+template<> Strings BaseSetting<Strings>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     return tokenizeString<Strings>(str);
 }
 
-template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append)
+template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append, const ApplyConfigOptions & options)
 {
     if (!append) value.clear();
     value.insert(value.end(), std::make_move_iterator(newValue.begin()),
@@ -314,12 +323,12 @@ template<> std::string BaseSetting<Strings>::to_string() const
     return concatStringsSep(" ", value);
 }
 
-template<> StringSet BaseSetting<StringSet>::parse(const std::string & str) const
+template<> StringSet BaseSetting<StringSet>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     return tokenizeString<StringSet>(str);
 }
 
-template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append)
+template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append, const ApplyConfigOptions & options)
 {
     if (!append) value.clear();
     value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
@@ -330,7 +339,7 @@ template<> std::string BaseSetting<StringSet>::to_string() const
     return concatStringsSep(" ", value);
 }
 
-template<> ExperimentalFeatures BaseSetting<ExperimentalFeatures>::parse(const std::string & str) const
+template<> ExperimentalFeatures BaseSetting<ExperimentalFeatures>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     ExperimentalFeatures res{};
     for (auto & s : tokenizeString<StringSet>(str)) {
@@ -342,7 +351,7 @@ template<> ExperimentalFeatures BaseSetting<ExperimentalFeatures>::parse(const s
     return res;
 }
 
-template<> void BaseSetting<ExperimentalFeatures>::appendOrSet(ExperimentalFeatures newValue, bool append)
+template<> void BaseSetting<ExperimentalFeatures>::appendOrSet(ExperimentalFeatures newValue, bool append, const ApplyConfigOptions & options)
 {
     if (append)
         value = value | newValue;
@@ -359,7 +368,7 @@ template<> std::string BaseSetting<ExperimentalFeatures>::to_string() const
     return concatStringsSep(" ", stringifiedXpFeatures);
 }
 
-template<> DeprecatedFeatures BaseSetting<DeprecatedFeatures>::parse(const std::string & str) const
+template<> DeprecatedFeatures BaseSetting<DeprecatedFeatures>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     DeprecatedFeatures res{};
     for (auto & s : tokenizeString<StringSet>(str)) {
@@ -371,7 +380,7 @@ template<> DeprecatedFeatures BaseSetting<DeprecatedFeatures>::parse(const std::
     return res;
 }
 
-template<> void BaseSetting<DeprecatedFeatures>::appendOrSet(DeprecatedFeatures newValue, bool append)
+template<> void BaseSetting<DeprecatedFeatures>::appendOrSet(DeprecatedFeatures newValue, bool append, const ApplyConfigOptions & options)
 {
     if (append)
         value = value | newValue;
@@ -388,7 +397,7 @@ template<> std::string BaseSetting<DeprecatedFeatures>::to_string() const
     return concatStringsSep(" ", stringifiedDpFeatures);
 }
 
-template<> StringMap BaseSetting<StringMap>::parse(const std::string & str) const
+template<> StringMap BaseSetting<StringMap>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     StringMap res;
     for (const auto & s : tokenizeString<Strings>(str)) {
@@ -399,7 +408,7 @@ template<> StringMap BaseSetting<StringMap>::parse(const std::string & str) cons
     return res;
 }
 
-template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append)
+template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append, const ApplyConfigOptions & options)
 {
     if (!append) value.clear();
     value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
@@ -426,7 +435,7 @@ template class BaseSetting<StringMap>;
 template class BaseSetting<ExperimentalFeatures>;
 template class BaseSetting<DeprecatedFeatures>;
 
-static Path parsePath(const AbstractSetting & s, const std::string & str)
+static Path parsePath(const AbstractSetting & s, const std::string & str, const ApplyConfigOptions & options)
 {
     if (str == "")
         throw UsageError("setting '%s' is a path and paths cannot be empty", s.name);
@@ -434,26 +443,26 @@ static Path parsePath(const AbstractSetting & s, const std::string & str)
         return canonPath(str);
 }
 
-template<> Path PathsSetting<Path>::parse(const std::string & str) const
+template<> Path PathsSetting<Path>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
-    return parsePath(*this, str);
+    return parsePath(*this, str, options);
 }
 
-template<> std::optional<Path> PathsSetting<std::optional<Path>>::parse(const std::string & str) const
+template<> std::optional<Path> PathsSetting<std::optional<Path>>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     if (str == "")
         return std::nullopt;
     else
-        return parsePath(*this, str);
+        return parsePath(*this, str, options);
 }
 
-template<> Paths PathsSetting<Paths>::parse(const std::string & str) const
+template<> Paths PathsSetting<Paths>::parse(const std::string & str, const ApplyConfigOptions & options) const
 {
     auto strings = tokenizeString<Strings>(str);
     Paths parsed;
 
     for (auto str : strings) {
-        parsed.push_back(canonPath(str));
+        parsed.push_back(parsePath(*this, str, options));
     }
 
     return parsed;
@@ -464,10 +473,10 @@ template class PathsSetting<std::optional<Path>>;
 template class PathsSetting<Paths>;
 
 
-bool GlobalConfig::set(const std::string & name, const std::string & value)
+bool GlobalConfig::set(const std::string & name, const std::string & value, const ApplyConfigOptions & options)
 {
     for (auto & config : *configRegistrations)
-        if (config->set(name, value)) return true;
+        if (config->set(name, value, options)) return true;
 
     unknownSettings.emplace(name, value);
 
diff --git a/src/libutil/config.hh b/src/libutil/config.hh
index dbca4b406..59cc281c5 100644
--- a/src/libutil/config.hh
+++ b/src/libutil/config.hh
@@ -10,6 +10,7 @@
 #include "types.hh"
 #include "experimental-features.hh"
 #include "deprecated-features.hh"
+#include "apply-config-options.hh"
 
 namespace nix {
 
@@ -61,7 +62,7 @@ public:
      * Sets the value referenced by `name` to `value`. Returns true if the
      * setting is known, false otherwise.
      */
-    virtual bool set(const std::string & name, const std::string & value) = 0;
+    virtual bool set(const std::string & name, const std::string & value, const ApplyConfigOptions & options = {}) = 0;
 
     struct SettingInfo
     {
@@ -81,7 +82,7 @@ public:
      * - contents: configuration contents to be parsed and applied
      * - path: location of the configuration file
      */
-    void applyConfig(const std::string & contents, const std::string & path = "<unknown>");
+    void applyConfig(const std::string & contents, const ApplyConfigOptions & options = {});
 
     /**
      * Resets the `overridden` flag of all Settings
@@ -155,7 +156,7 @@ public:
 
     Config(StringMap initials = {});
 
-    bool set(const std::string & name, const std::string & value) override;
+    bool set(const std::string & name, const std::string & value, const ApplyConfigOptions & options = {}) override;
 
     void addSetting(AbstractSetting * setting);
 
@@ -200,7 +201,7 @@ protected:
 
     virtual ~AbstractSetting();
 
-    virtual void set(const std::string & value, bool append = false) = 0;
+    virtual void set(const std::string & value, bool append = false, const ApplyConfigOptions & options = {}) = 0;
 
     /**
      * Whether the type is appendable; i.e. whether the `append`
@@ -237,7 +238,7 @@ protected:
      *
      * Used by `set()`.
      */
-    virtual T parse(const std::string & str) const;
+    virtual T parse(const std::string & str, const ApplyConfigOptions & options) const;
 
     /**
      * Append or overwrite `value` with `newValue`.
@@ -247,7 +248,7 @@ protected:
      *
      * @param append Whether to append or overwrite.
      */
-    virtual void appendOrSet(T newValue, bool append);
+    virtual void appendOrSet(T newValue, bool append, const ApplyConfigOptions & options);
 
 public:
 
@@ -284,7 +285,7 @@ public:
      * Uses `parse()` to get the value from `str`, and `appendOrSet()`
      * to set it.
      */
-    void set(const std::string & str, bool append = false) override final;
+    void set(const std::string & str, bool append = false, const ApplyConfigOptions & options = {}) override final;
 
     /**
      * C++ trick; This is template-specialized to compile-time indicate whether
@@ -373,7 +374,7 @@ public:
         options->addSetting(this);
     }
 
-    T parse(const std::string & str) const override;
+    T parse(const std::string & str, const ApplyConfigOptions & options) const override;
 
     void operator =(const T & v) { this->assign(v); }
 };
@@ -384,7 +385,7 @@ struct GlobalConfig : public AbstractConfig
     typedef std::vector<Config*> ConfigRegistrations;
     static ConfigRegistrations * configRegistrations;
 
-    bool set(const std::string & name, const std::string & value) override;
+    bool set(const std::string & name, const std::string & value, const ApplyConfigOptions & options = {}) override;
 
     void getSettings(std::map<std::string, SettingInfo> & res, bool overriddenOnly = false) override;