imag/libimagstore/src/configuration.rs

322 lines
12 KiB
Rust
Raw Normal View History

use toml::Value;
2016-03-05 10:37:06 +00:00
2016-03-05 14:02:29 +00:00
/// Check whether the configuration is valid for the store
///
/// The passed `Value` _must be_ the `[store]` sub-tree of the configuration. Otherwise this will
/// fail.
///
/// It checks whether the configuration looks like the store wants it to be:
///
/// ```toml
/// [store]
/// pre-create-hook-aspects = [ "misc", "encryption", "version-control"]
///
2016-07-16 20:17:05 +00:00
/// [store.aspects.misc]
2016-03-05 14:02:29 +00:00
/// parallel = true
2016-07-16 20:17:05 +00:00
///
/// [store.aspects.encryption]
2016-03-05 14:02:29 +00:00
/// parallel = false
2016-07-16 20:17:05 +00:00
///
/// [store.aspects.version-control]
2016-03-05 14:02:29 +00:00
/// parallel = false
///
2016-07-16 20:17:05 +00:00
/// [store.hooks.gnupg]
2016-03-05 14:02:29 +00:00
/// aspect = "encryption"
/// key = "0x123456789"
///
2016-07-16 20:17:05 +00:00
/// [store.hooks.git]
2016-03-05 14:02:29 +00:00
/// aspect = "version-control"
/// ```
///
/// It checks:
/// * Whether all the maps are there (whether store, store.aspects, store.aspects.example are all
/// maps)
/// * Whether each aspect configuration has a "parallel = <Boolean>" setting
/// * Whether each hook congfiguration has a "aspect = <String>" setting
///
/// It does NOT check:
/// * Whether all aspects which are used in the hook configuration are also configured
///
2016-03-05 17:16:05 +00:00
/// No configuration is a valid configuration, as the store will use the most conservative settings
/// automatically. This has also performance impact, as all hooks run in no-parallel mode then.
/// You have been warned!
///
///
pub fn config_is_valid(config: &Option<Value>) -> bool {
2016-03-05 14:02:29 +00:00
use std::collections::BTreeMap;
use std::io::Write;
use std::io::stderr;
2016-03-05 14:02:29 +00:00
2016-03-05 17:16:05 +00:00
if config.is_none() {
return true;
}
2016-03-05 14:02:29 +00:00
fn has_key_with_string_ary(v: &BTreeMap<String, Value>, key: &str) -> bool {
v.get(key)
.map_or_else(|| {
write!(stderr(), "Required key '{}' is not in store config", key).ok();
false
}, |t| match *t {
Value::Array(ref a) => a.iter().all(|elem| {
match *elem {
Value::String(_) => true,
_ => false,
}
}),
_ => {
write!(stderr(), "Key '{}' in store config should contain an array", key)
.ok();
false
2016-03-05 14:02:29 +00:00
}
})
2016-03-05 14:02:29 +00:00
}
/// Check that
/// * the top-level configuration
/// * is a table
/// * where all entries of a key `section` (eg. "hooks" or "aspects")
/// * Are maps
/// * where each has a key `key` (eg. "aspect" or "parallel")
/// * which fullfills constraint `f` (typecheck)
fn check_all_inner_maps_have_key_with<F>(store_config: &BTreeMap<String, Value>,
section: &str,
key: &str,
f: F)
-> bool
where F: Fn(&Value) -> bool
{
store_config.get(section) // The store config has the section `section`
.map_or_else(|| {
write!(stderr(), "Store config expects section '{}' to be present, but isn't.",
section).ok();
false
}, |section_table| {
match *section_table { // which is
Value::Table(ref section_table) => // a table
2016-03-05 14:02:29 +00:00
section_table
.iter() // which has values,
.all(|(inner_key, cfg)| { // and all of these values
match *cfg {
Value::Table(ref hook_config) => { // are tables
2016-03-05 14:02:29 +00:00
hook_config.get(key) // with a key
// fullfilling this constraint
.map_or(false, |hook_aspect| f(&hook_aspect))
2016-03-05 14:02:29 +00:00
},
_ => {
write!(stderr(), "Store config expects '{}' to be in '{}.{}', but isn't.",
key, section, inner_key).ok();
false
}
2016-03-05 14:02:29 +00:00
}
}),
_ => {
write!(stderr(), "Store config expects '{}' to be a Table, but isn't.",
section).ok();
false
}
2016-03-05 14:02:29 +00:00
}
})
}
match *config {
2016-05-26 16:40:58 +00:00
Some(Value::Table(ref t)) => {
has_key_with_string_ary(t, "store-unload-hook-aspects") &&
has_key_with_string_ary(t, "pre-create-hook-aspects") &&
2016-03-05 14:02:29 +00:00
has_key_with_string_ary(t, "post-create-hook-aspects") &&
has_key_with_string_ary(t, "pre-retrieve-hook-aspects") &&
has_key_with_string_ary(t, "post-retrieve-hook-aspects") &&
has_key_with_string_ary(t, "pre-update-hook-aspects") &&
has_key_with_string_ary(t, "post-update-hook-aspects") &&
has_key_with_string_ary(t, "pre-delete-hook-aspects") &&
has_key_with_string_ary(t, "post-delete-hook-aspects") &&
// The section "hooks" has maps which have a key "aspect" which has a value of type
// String
check_all_inner_maps_have_key_with(t, "hooks", "aspect",
|asp| is_match!(asp, &Value::String(_))) &&
2016-03-05 14:02:29 +00:00
// The section "aspects" has maps which have a key "parllel" which has a value of type
// Boolean
check_all_inner_maps_have_key_with(t, "aspects", "parallel",
|asp| is_match!(asp, &Value::Boolean(_)))
2016-03-05 14:02:29 +00:00
}
_ => {
write!(stderr(), "Store config is no table").ok();
false
},
2016-03-05 14:02:29 +00:00
}
2016-03-05 10:37:06 +00:00
}
/// Checks whether the store configuration has a key "implicit-create" which maps to a boolean
/// value. If that key is present, the boolean is returned, otherwise false is returned.
pub fn config_implicit_store_create_allowed(config: Option<&Value>) -> bool {
config.map(|t| {
match *t {
Value::Table(ref t) => {
match t.get("implicit-create") {
Some(&Value::Boolean(b)) => b,
Some(_) => {
warn!("Key 'implicit-create' does not contain a Boolean value");
false
}
None => {
warn!("Key 'implicit-create' in store configuration missing");
false
},
}
}
_ => {
warn!("Store configuration seems to be no Table");
false
},
}
}).unwrap_or(false)
}
2016-05-26 16:40:58 +00:00
pub fn get_store_unload_aspect_names(value: &Option<Value>) -> Vec<String> {
get_aspect_names_for_aspect_position("store-unload-hook-aspects", value)
}
2016-03-05 17:16:05 +00:00
pub fn get_pre_create_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("pre-create-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_post_create_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("post-create-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_pre_retrieve_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("pre-retrieve-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_post_retrieve_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("post-retrieve-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_pre_update_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("pre-update-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_post_update_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("post-update-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_pre_delete_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("pre-delete-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 17:16:05 +00:00
pub fn get_post_delete_aspect_names(value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
get_aspect_names_for_aspect_position("post-delete-hook-aspects", value)
2016-03-19 14:06:10 +00:00
}
pub fn get_pre_move_aspect_names(value: &Option<Value>) -> Vec<String> {
get_aspect_names_for_aspect_position("pre-move-hook-aspects", value)
}
pub fn get_post_move_aspect_names(value: &Option<Value>) -> Vec<String> {
get_aspect_names_for_aspect_position("post-move-hook-aspects", value)
2016-03-05 10:37:06 +00:00
}
2016-03-05 15:17:07 +00:00
#[derive(Debug)]
pub struct AspectConfig {
parallel: bool,
mutable_hooks: bool,
2016-03-05 15:17:07 +00:00
config: Value,
}
impl AspectConfig {
pub fn new(init: Value) -> AspectConfig {
debug!("Trying to parse AspectConfig from: {:?}", init);
2016-03-05 15:17:07 +00:00
let parallel = AspectConfig::is_parallel(&init);
let muthooks = AspectConfig::allows_mutable_hooks(&init);
2016-03-05 15:17:07 +00:00
AspectConfig {
config: init,
mutable_hooks: muthooks,
2016-03-05 15:17:07 +00:00
parallel: parallel,
}
}
fn is_parallel(init: &Value) -> bool {
match *init {
Value::Table(ref t) =>
2016-03-05 15:17:07 +00:00
t.get("parallel")
.map_or(false, |value| {
match *value {
Value::Boolean(b) => b,
2016-03-05 15:17:07 +00:00
_ => false,
}
}),
2016-03-05 15:17:07 +00:00
_ => false,
}
}
fn allows_mutable_hooks(init: &Value) -> bool {
match *init {
Value::Table(ref t) =>
t.get("mutable_hooks")
.map_or(false, |value| {
match *value {
Value::Boolean(b) => b,
_ => false,
}
}),
_ => false,
}
}
pub fn allow_mutable_hooks(&self) -> bool {
self.mutable_hooks
}
2016-03-05 15:17:07 +00:00
/// Get the aspect configuration for an aspect.
///
/// Pass the store configuration object, this searches in `[aspects][<aspect_name>]`.
///
/// Returns `None` if one of the keys in the chain is not available
2016-03-05 17:21:27 +00:00
pub fn get_for(v: &Option<Value>, a_name: String) -> Option<AspectConfig> {
debug!("Get aspect configuration for {:?} from {:?}", a_name, v);
let res = match *v {
Some(Value::Table(ref tabl)) => {
match tabl.get("aspects") {
Some(&Value::Table(ref tabl)) => {
tabl.get(&a_name[..]).map(|asp| AspectConfig::new(asp.clone()))
},
_ => None,
}
},
2016-03-05 17:21:27 +00:00
_ => None,
};
debug!("Found aspect configuration for {:?}: {:?}", a_name, res);
res
2016-03-05 15:17:07 +00:00
}
}
2016-03-05 17:16:05 +00:00
fn get_aspect_names_for_aspect_position(config_name: &'static str, value: &Option<Value>) -> Vec<String> {
2016-03-05 15:05:31 +00:00
let mut v = vec![];
match *value {
Some(Value::Table(ref t)) => {
2016-03-05 15:05:31 +00:00
match t.get(config_name) {
Some(&Value::Array(ref a)) => {
for elem in a {
match *elem {
Value::String(ref s) => v.push(s.clone()),
2016-03-05 15:05:31 +00:00
_ => warn!("Non-String in configuration, inside '{}'", config_name),
}
}
},
_ => warn!("'{}' configuration key should contain Array, does not", config_name),
};
},
None => warn!("No store configuration, cannot get '{}'", config_name),
2016-03-05 15:05:31 +00:00
_ => warn!("Configuration is not a table"),
}
v
2016-03-05 10:37:06 +00:00
}
2016-03-05 15:05:31 +00:00