1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
// Copyright (c) 2021-2022 Miguel Barreto and others
//
// 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.
//! Module that defines helper functions to process YAML configuration sources.
extern crate strict_yaml_rust;
use std::{path::Path, str::FromStr, vec};
use crate::{
error::{fold_until_first_err, DotfilesError, ErrorType},
settings::{parse_setting, Setting, Settings},
};
use strict_yaml_rust::{StrictYaml, StrictYamlLoader};
/// Executes the `process_function` on each of the items in the `yaml_hash`. The yaml hash is
/// assumed to be string keyed. It stops execution if any of the process functions returns an Error,
/// and returns said error.
pub fn process_yaml_hash_until_first_err<F>(
yaml_hash: &StrictYaml,
mut process_function: F,
) -> Result<(), DotfilesError>
where
F: FnMut(String, &StrictYaml) -> Result<(), DotfilesError>,
{
if let StrictYaml::Hash(hash) = yaml_hash {
hash.into_iter().try_for_each(|(key, value)| {
parse_as_string(key)
.map(|key_str| (key_str, value))
.and_then(|(key, val)| process_function(key, val))
})
} else {
Err(DotfilesError::from_wrong_yaml(
"Expected a yaml hash, got something else".to_owned(),
yaml_hash.to_owned(),
StrictYaml::Hash(Default::default()),
))
}
}
/// Gets the value for a specified key in a yaml hash and does something with it.
///
/// Returns the result of the process function being applied to the value in question.
///
/// # Errors
///
/// * Will return an error that happens during the process_function application.
/// * Will return a [ErrorType::UnexpectedYamlTypeError] if the value is not a hash or if the hash
/// doesn't have string-based keys.
/// * Will return a [ErrorType::IncompleteConfigurationError] if the key is not found in the hash.
pub fn process_value_from_yaml_hash<T, F>(
key: &str,
yaml_hash: &StrictYaml,
mut process: F,
) -> Result<T, DotfilesError>
where
F: FnMut(&StrictYaml) -> Result<T, DotfilesError>,
{
if let StrictYaml::Hash(inner_hash) = yaml_hash {
match inner_hash.get(&StrictYaml::String(key.into())) {
Some(yaml) => process(yaml),
None => Err(DotfilesError::from(
format!("Hash does not contain key {}", key.to_owned()),
ErrorType::IncompleteConfigurationError {
missing_field: key.into(),
},
)),
}
} else {
Err(DotfilesError::from_wrong_yaml(
"process_value_from_yaml_hash expects a hash, but got something else".into(),
yaml_hash.to_owned(),
StrictYaml::Hash(Default::default()),
))
}
}
/// Calls a processing function on all elements of an array, will fail if any of the elements fail
/// to process.
///
/// # Errors
///
/// * Any error that happens in the processing function.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml passed is not an array
pub fn map_yaml_array<T, F>(yaml_array: &StrictYaml, process: F) -> Result<Vec<T>, DotfilesError>
where
F: FnMut(&StrictYaml) -> Result<T, DotfilesError>,
{
if let StrictYaml::Array(inner_vec) = yaml_array {
inner_vec.iter().map(process).collect()
} else {
Err(DotfilesError::from_wrong_yaml(
"map_yaml_array expects a yaml array, but got something else".into(),
yaml_array.to_owned(),
StrictYaml::Array(vec![]),
))
}
}
/// Gets a specific setting from a yaml hash
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type does not match the `setting_type`.
/// * [ErrorType::IncompleteConfigurationError] if the hash does not contain the requested key
pub fn get_setting_from_yaml_hash(
name: &str,
setting_type: &Setting,
yaml: &StrictYaml,
) -> Result<Setting, DotfilesError> {
process_value_from_yaml_hash(name, yaml, |value_for_name| {
parse_setting(setting_type, value_for_name)
})
}
/// Gets a specific boolean setting from a yaml hash
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type is not boolean.
/// * [ErrorType::IncompleteConfigurationError] if the hash does not contain the requested key
pub fn get_boolean_from_yaml_hash(name: &str, yaml: &StrictYaml) -> Result<bool, DotfilesError> {
process_value_from_yaml_hash(name, yaml, |value_for_name| {
parse_as_boolean(value_for_name)
})
}
/// Gets a specific integer setting from a yaml hash
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type is not integer.
/// * [ErrorType::IncompleteConfigurationError] if the hash does not contain the requested key
pub fn get_integer_from_yaml_hash(name: &str, yaml: &StrictYaml) -> Result<i64, DotfilesError> {
process_value_from_yaml_hash(name, yaml, |value_for_name| {
parse_as_integer(value_for_name)
})
}
/// Gets a specific string setting from a yaml hash
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type is not string.
/// * [ErrorType::IncompleteConfigurationError] if the hash does not contain the requested key
pub fn get_string_from_yaml_hash(name: &str, yaml: &StrictYaml) -> Result<String, DotfilesError> {
process_value_from_yaml_hash(name, yaml, parse_as_string)
}
/// Gets a specific string array setting from a yaml hash
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type is not array, or some of its values
/// are not string.
/// * [ErrorType::IncompleteConfigurationError] if the hash does not contain the requested key
pub fn get_string_array_from_yaml_hash(
name: &str,
yaml: &StrictYaml,
) -> Result<Vec<String>, DotfilesError> {
process_value_from_yaml_hash(name, yaml, |value_for_name| {
parse_as_string_array(value_for_name)
})
}
/// Gets a specific string array setting from a yaml hash, but if it is not found it returns an
/// empty array.
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml is not a hash.
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml does not have string keys.
/// * [ErrorType::UnexpectedYamlTypeError] if the value's type is not array, or some of its values
/// are not string.
pub fn get_optional_string_array_from_yaml_hash(
name: &str,
yaml: &StrictYaml,
) -> Result<Vec<String>, DotfilesError> {
get_string_array_from_yaml_hash(name, yaml).or_else(|err| {
if err.is_missing_config(name) {
Ok(vec![])
} else {
Err(err)
}
})
}
/// Gets a boolean value for the setting named `name`.
///
/// First it tries to find a value for the setting in the `context_settings`
/// argument, if it doesn't contain any it falls back to `directive-defaults`.
///
/// Returns an error if no such setting was found in either setting collection.
pub fn get_boolean_setting_from_context(
name: &str,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<bool, DotfilesError> {
if let Setting::Boolean(b) = get_setting_from_context(name, context_settings, directive_defaults)?
{
Ok(b)
} else {
Err(DotfilesError::from(
format!("Setting {name} was found in directive defaults but is not boolean",),
ErrorType::CoreError,
))
}
}
/// Gets a String value for the setting named `name`.
///
/// First it tries to find a value for the setting in the `context_settings`
/// argument, if it doesn't contain any it falls back to `directive-defaults`.
///
/// Returns an error if no such setting was found in either setting collection.
pub fn get_string_setting(
name: &str,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<String, DotfilesError> {
if let Setting::String(s) = get_setting_from_context(name, context_settings, directive_defaults)?
{
Ok(s)
} else {
Err(DotfilesError::from(
format!("Setting {name} was found in directive defaults but is not a string",),
ErrorType::CoreError,
))
}
}
/// Gets a Int value for the setting named `name`.
///
/// First it tries to find a value for the setting in the `context_settings`
/// argument, if it doesn't contain any it falls back to `directive-defaults`.
///
/// Returns an error if no such setting was found in either setting collection.
pub fn get_integer_setting(
name: &str,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<i64, DotfilesError> {
if let Setting::Integer(x) = get_setting_from_context(name, context_settings, directive_defaults)?
{
Ok(x)
} else {
Err(DotfilesError::from(
format!("Setting {name} was found in directive defaults but is not an integer",),
ErrorType::CoreError,
))
}
}
/// Gets a String value for the setting named `name`.
///
/// First it tries to find a value for the setting in the `context_settings`
/// argument, if it doesn't contain any it falls back to `directive-defaults`
///
/// Returns an error if no such setting was found in either setting collection.
pub fn get_setting_from_context(
name: &str,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<Setting, DotfilesError> {
if let Some(setting) = context_settings.get(name) {
Ok(setting.clone())
} else if let Some(setting) = directive_defaults.get(name) {
Ok(setting.clone())
} else {
Err(DotfilesError::from(
format!("Setting {name} couldn't be found in context or defaults"),
ErrorType::CoreError,
))
}
}
/// Gets a Boolean value from YAML or context.
///
/// First it tries to find a value in `yaml`, if it can't find one then it
/// falls back to `context_settings` or finally `default_settings`.
///
/// # Errors
/// - Found a setting in YAML but that couldn't be parsed as a boolean.
/// - Didn't find a setting matching this name anywhere
pub fn get_boolean_setting_from_yaml_or_context(
name: &str,
yaml: &StrictYaml,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<bool, DotfilesError> {
get_boolean_from_yaml_hash(name, yaml)
.or_else(|_| get_boolean_setting_from_context(name, context_settings, directive_defaults))
}
/// Gets a Integer value from YAML or context.
///
/// First it tries to find a value in `yaml`, if it can't find one then it
/// falls back to `context_settings` or finally `default_settings`.
///
/// # Errors
/// - Found a setting in YAML but that couldn't be parsed.
/// - Didn't find a setting matching this name anywhere
pub fn get_integer_setting_from_yaml_or_context(
name: &str,
yaml: &StrictYaml,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<i64, DotfilesError> {
get_integer_from_yaml_hash(name, yaml)
.or_else(|_| get_integer_setting(name, context_settings, directive_defaults))
}
/// Gets a String value from YAML or context.
///
/// First itb tries to find a value in `yaml`, if it can't find one then it
/// falls back to `context_settings` or finally `default_settings`.
///
/// # Errors
/// - Found a setting in YAML but that couldn't be parsed.
/// - Didn't find a setting matching this name anywhere
pub fn get_string_setting_from_yaml_or_context(
name: &str,
yaml: &StrictYaml,
context_settings: &Settings,
directive_defaults: &Settings,
) -> Result<String, DotfilesError> {
process_value_from_yaml_hash(name, yaml, parse_as_string)
.or_else(|_| get_string_setting(name, context_settings, directive_defaults))
}
/// Gets the content of this YAML node or the value for a specific key in it.
///
/// If the StrictYaml node passed is a String node then it returns its contents,
/// if the StrictYaml node is a Hash then it returns the string content of the
/// value corresponding to the optional Key.
///
/// # Errors
/// - `yaml` is neither a String nor a Hash
/// - `yaml` is a hash but it does not contain a value for `key`
/// - `yaml` is a hash but the value for `key` is not a String.
pub fn get_string_content_or_keyed_value(
yaml: &StrictYaml,
key: Option<&str>,
) -> Result<String, DotfilesError> {
parse_as_string(yaml).or_else(|err| {
if let Some(key_str) = key {
get_string_from_yaml_hash(key_str, yaml)
} else {
Err(err)
}
})
}
/// Gets a native `Vec<String>` from a StrictYaml::Array. It errors out if the passed yaml is not an
/// array or if not all the items in the array are plain StrictYaml Strings
pub fn parse_as_string_array(yaml: &StrictYaml) -> Result<Vec<String>, DotfilesError> {
map_yaml_array(yaml, parse_as_string)
}
/// Parse a yaml element as string, will convert booleans and integers to string if necessary.
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if yaml is neither string, boolean or integer and thus
/// cannot be parsed as string losslessly.
pub fn parse_as_string(yaml_to_parse: &StrictYaml) -> Result<String, DotfilesError> {
match yaml_to_parse {
StrictYaml::String(s) => Ok(s.to_owned()),
_ => Err(DotfilesError::from_wrong_yaml(
"Expected StrictYaml String and got something else".into(),
yaml_to_parse.clone(),
StrictYaml::String("".into()),
)),
}
}
/// Parse a yaml element as boolean.
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if yaml is not of type Boolean
pub fn parse_as_boolean(yaml: &StrictYaml) -> Result<bool, DotfilesError> {
if let StrictYaml::String(b) = yaml {
FromStr::from_str(b).map_err(|_| {
DotfilesError::from_wrong_yaml(
format!("Got a Yaml String that can't be parsed as boolean: `{b}`"),
yaml.to_owned(),
StrictYaml::String("true".into()),
)
})
} else {
Err(DotfilesError::from_wrong_yaml(
"Expected StrictYaml string containing a boolean and got something else".into(),
yaml.clone(),
StrictYaml::String("false".into()),
))
}
}
/// Parse a yaml element as Integer.
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if yaml is not of type Integer
pub fn parse_as_integer(yaml: &StrictYaml) -> Result<i64, DotfilesError> {
if let StrictYaml::String(i) = yaml {
FromStr::from_str(i).map_err(|_| {
DotfilesError::from_wrong_yaml(
format!("Got a Yaml String that can't be parsed as integer: `{i}`"),
yaml.to_owned(),
StrictYaml::String("11111".into()),
)
})
} else {
Err(DotfilesError::from_wrong_yaml(
"Expected StrictYaml String and got something else".into(),
yaml.clone(),
StrictYaml::String("0".into()),
))
}
}
/// Parse a yaml element as an array.
///
/// # Errors
/// * [ErrorType::UnexpectedYamlTypeError] if yaml is not of type array
pub fn parse_as_array(yaml: &StrictYaml) -> Result<Vec<StrictYaml>, DotfilesError> {
if let Some(v) = yaml.as_vec() {
Ok(v.to_owned())
} else {
Err(DotfilesError::from_wrong_yaml(
"Expected StrictYaml Array and got something else".into(),
yaml.clone(),
StrictYaml::Array(vec![]),
))
}
}
/// Reads a StrictYaml File. Returns Error in case of a syntax error.
pub fn read_yaml_file(file: &Path) -> Result<Vec<StrictYaml>, DotfilesError> {
let contents = std::fs::read_to_string(file).map_err(DotfilesError::from_io_error)?;
StrictYamlLoader::load_from_str(&contents).map_err(|err| {
DotfilesError::from(
format!("yaml syntax error in file `{:?}`", file.as_os_str()),
ErrorType::YamlParseError { scan_error: err },
)
})
}
/// Process each element of the hash with the `process_function` and then fold them all using into a
/// single result using `fold_function`, for an initial value of `init`. Returns the first error
/// that happens in either processing or folding.
///
/// # Errors
///
/// * [ErrorType::UnexpectedYamlTypeError] if the yaml passed in is not a hash
/// * [ErrorType::UnexpectedYamlTypeError] if the hash contains keys that cannot be parsed as
/// strings.
/// * Any errors from the fold_function or process function.
pub fn fold_hash_until_first_err<T, P, Processed, F>(
yaml: &StrictYaml,
init: Result<T, DotfilesError>,
mut process_function: P,
fold_function: F,
) -> Result<T, DotfilesError>
where
P: FnMut(String, &StrictYaml) -> Result<Processed, DotfilesError>,
F: FnMut(T, Processed) -> Result<T, DotfilesError>,
{
if let StrictYaml::Hash(hash) = yaml {
fold_until_first_err(
hash.into_iter(),
init,
|(yaml_key, yaml_value)| process_function(parse_as_string(yaml_key)?, yaml_value),
fold_function,
)
} else {
Err(DotfilesError::from_wrong_yaml(
"Expected StrictYaml Hash, got wrong type".to_owned(),
yaml.to_owned(),
StrictYaml::Hash(Default::default()),
))
}
}