gix_config/file/includes/types.rs
1use crate::{parse, path::interpolate};
2use std::path::PathBuf;
3
4/// The error returned when following includes.
5#[derive(Debug, thiserror::Error)]
6#[allow(missing_docs)]
7pub enum Error {
8 #[error("Failed to copy configuration file into buffer")]
9 CopyBuffer(#[source] std::io::Error),
10 #[error("Could not read included configuration file at '{}'", path.display())]
11 Io { path: PathBuf, source: std::io::Error },
12 #[error(transparent)]
13 Parse(#[from] parse::Error),
14 #[error(transparent)]
15 Interpolate(#[from] interpolate::Error),
16 #[error("The maximum allowed length {} of the file include chain built by following nested resolve_includes is exceeded", .max_depth)]
17 IncludeDepthExceeded { max_depth: u8 },
18 #[error("Include paths from environment variables must not be relative as no config file paths exists as root")]
19 MissingConfigPath,
20 #[error("The git directory must be provided to support `gitdir:` conditional includes")]
21 MissingGitDir,
22 #[error(transparent)]
23 Realpath(#[from] gix_path::realpath::Error),
24}
25
26/// Options to handle includes, like `include.path` or `includeIf.<condition>.path`,
27#[derive(Clone, Copy)]
28pub struct Options<'a> {
29 /// The maximum allowed length of the file include chain built by following nested resolve_includes where base level is depth = 0.
30 pub max_depth: u8,
31 /// When max depth is exceeded while following nested includes,
32 /// return an error if true or silently stop following resolve_includes.
33 ///
34 /// Setting this value to false allows to read configuration with cycles,
35 /// which otherwise always results in an error.
36 pub err_on_max_depth_exceeded: bool,
37 /// If true, default false, failing to interpolate paths will result in an error.
38 ///
39 /// Interpolation also happens if paths in conditional includes can't be interpolated.
40 pub err_on_interpolation_failure: bool,
41 /// If true, default true, configuration not originating from a path will cause errors when trying to resolve
42 /// relative include paths (which would require the including configuration's path).
43 pub err_on_missing_config_path: bool,
44 /// Used during path interpolation, both for include paths before trying to read the file, and for
45 /// paths used in conditional `gitdir` includes.
46 pub interpolate: interpolate::Context<'a>,
47
48 /// Additional context for conditional includes to work.
49 pub conditional: conditional::Context<'a>,
50}
51
52impl<'a> Options<'a> {
53 /// Provide options to never follow include directives at all.
54 pub fn no_follow() -> Self {
55 Options {
56 max_depth: 0,
57 err_on_max_depth_exceeded: false,
58 err_on_interpolation_failure: false,
59 err_on_missing_config_path: false,
60 interpolate: Default::default(),
61 conditional: Default::default(),
62 }
63 }
64 /// Provide options to follow includes like git does, provided the required `conditional` and `interpolate` contexts
65 /// to support `gitdir` and `onbranch` based `includeIf` directives as well as standard `include.path` resolution.
66 /// Note that the follow-mode is `git`-style, following at most 10 indirections while
67 /// producing an error if the depth is exceeded.
68 pub fn follow(interpolate: interpolate::Context<'a>, conditional: conditional::Context<'a>) -> Self {
69 Options {
70 max_depth: 10,
71 err_on_max_depth_exceeded: true,
72 err_on_interpolation_failure: false,
73 err_on_missing_config_path: true,
74 interpolate,
75 conditional,
76 }
77 }
78
79 /// For use with `follow` type options, cause failure if an include path couldn't be interpolated or the depth limit is exceeded.
80 pub fn strict(mut self) -> Self {
81 self.err_on_interpolation_failure = true;
82 self.err_on_max_depth_exceeded = true;
83 self.err_on_missing_config_path = true;
84 self
85 }
86
87 /// Like [`follow`][Options::follow()], but without information to resolve `includeIf` directories as well as default
88 /// configuration to allow resolving `~username/` path. `home_dir` is required to resolve `~/` paths if set.
89 /// Note that `%(prefix)` paths cannot be interpolated with this configuration, use [`follow()`][Options::follow()]
90 /// instead for complete control.
91 pub fn follow_without_conditional(home_dir: Option<&'a std::path::Path>) -> Self {
92 Options {
93 max_depth: 10,
94 err_on_max_depth_exceeded: true,
95 err_on_interpolation_failure: false,
96 err_on_missing_config_path: true,
97 interpolate: interpolate::Context {
98 git_install_dir: None,
99 home_dir,
100 home_for_user: Some(interpolate::home_for_user),
101 },
102 conditional: Default::default(),
103 }
104 }
105
106 /// Set the context used for interpolation when interpolating paths to include as well as the paths
107 /// in `gitdir` conditional includes.
108 pub fn interpolate_with(mut self, context: interpolate::Context<'a>) -> Self {
109 self.interpolate = context;
110 self
111 }
112}
113
114impl Default for Options<'_> {
115 fn default() -> Self {
116 Self::no_follow()
117 }
118}
119
120///
121pub mod conditional {
122 /// Options to handle conditional includes like `includeIf.<condition>.path`.
123 #[derive(Clone, Copy, Default)]
124 pub struct Context<'a> {
125 /// The location of the .git directory. If `None`, `gitdir` conditions cause an error.
126 ///
127 /// Used for conditional includes, e.g. `includeIf.gitdir:…` or `includeIf:gitdir/i…`.
128 pub git_dir: Option<&'a std::path::Path>,
129 /// The name of the branch that is currently checked out. If `None`, `onbranch` conditions cause an error.
130 ///
131 /// Used for conditional includes, e.g. `includeIf.onbranch:main.…`
132 pub branch_name: Option<&'a gix_ref::FullNameRef>,
133 }
134}