moella/
config.rs

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
use crate::extension::Extension;
use crate::host::Host;
use crate::port::PortsKind;
use kvarn::prelude::{CompactString, ToCompactString};
use log::{info, warn};
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet, VecDeque};
use std::path::{Path, PathBuf};
use std::sync::Arc;

pub(crate) type Result<T> = std::result::Result<T, String>;

#[derive(Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub(crate) struct KvarnConfig {
    extensions: HashMap<String, Vec<Extension>>,
    hosts: Vec<Host>,
    host_collections: Option<HashMap<String, Vec<String>>>,
    ports: Option<PortsKind>,
    import: Option<Vec<String>>,
}

pub struct CliOptions<'a> {
    pub high_ports: bool,
    pub cache: bool,
    pub dev: bool,
    pub default_host: Option<&'a str>,
}

/// Parse config at `path`.
#[allow(clippy::or_fun_call)] // it's just as_ref()
async fn read_config(file: impl AsRef<Path>) -> Result<KvarnConfig> {
    let s = file.as_ref();
    let config_file_name = Path::new(s.file_name().unwrap_or(s.as_ref()));
    info!("Read config {}", config_file_name.display());
    let file = tokio::fs::read_to_string(s)
        .await
        .map_err(|err| format!("Failed to read config file {}: {err}", s.display()))?;
    ron::Options::default()
        .with_default_extension(ron::extensions::Extensions::UNWRAP_NEWTYPES)
        .with_default_extension(ron::extensions::Extensions::IMPLICIT_SOME)
        .with_default_extension(ron::extensions::Extensions::UNWRAP_VARIANT_NEWTYPES)
        .from_str(&file)
        .map_err(|err| {
            format!(
                "Parsing config {} failed at {} with message \"{}\"",
                config_file_name.display(),
                err.position,
                err.code
            )
        })
}
/// Read config at `path` and resolve it's contents and
/// it's imports (dependency configs).
/// Returns a [`kvarn::RunConfig`] you can [`kvarn::RunConfig::execute`].
pub async fn read_and_resolve(
    file: impl AsRef<str>,
    custom_extensions: &CustomExtensions,
    opts: &CliOptions<'_>,
) -> Result<kvarn::RunConfig> {
    #[derive(Debug)]
    enum Imported {
        File(PathBuf),
        Deserialized(KvarnConfig, PathBuf),
    }

    let file = file.as_ref();
    let root_config_dir = Path::new(file)
        .parent()
        .expect("config file is in no directory");

    let mut hosts = HashMap::new();
    let mut ports = None;
    let mut collections: HashMap<CompactString, Vec<CompactString>> = HashMap::new();
    let mut extensions = HashMap::new();

    let mut imports: VecDeque<Imported> = VecDeque::new();
    imports.push_back(Imported::File(file.to_owned().into()));
    let mut imported = HashSet::new();

    while let Some(import) = imports.pop_back() {
        let (mut cfg, import) = match import {
            Imported::File(import) => {
                if imports.is_empty() {
                    (read_config(&import).await?, import)
                } else {
                    match read_config(&import).await {
                        Ok(c) => (c, import),
                        Err(s) => {
                            if s.contains("No such file or directory") {
                                warn!("Skipping config {}: {s}", import.display());
                                continue;
                            } else {
                                return Err(s);
                            }
                        }
                    }
                }
            }
            Imported::Deserialized(cfg, file) => (cfg, file),
        };
        let imports_count = cfg.import.as_ref().map_or(0, Vec::len);
        let config_dir = Path::new(&import)
            .parent()
            .expect("config file is in no directory");
        let descendant_imports = cfg
            .import
            .take()
            .into_iter()
            .flatten()
            .map(|file| config_dir.join(file))
            .filter(|file| imported.insert(file.clone()))
            .map(Imported::File);
        // handle children first
        if imports_count > 0 {
            imports.push_front(Imported::Deserialized(cfg, import.clone()));
            imports.extend(descendant_imports);
            continue;
        } else {
            imports.extend(descendant_imports);
        }

        if let Some(ports_kind) = cfg.ports.take() {
            if let Some((_, first)) = &ports {
                return Err(format!(
                    "Two config files contain a ports parameter. \
                    You must specify exactly 1 per import tree. \
                    First ports parameter in {first:?}, \
                    second ports in {import:?}."
                ));
            }
            ports = Some((ports_kind, import.clone()))
        }
        for (name, ext) in cfg.extensions {
            if let Some((_, file)) = extensions.get(name.as_str()) {
                return Err(format!(
                    "Duplicate extension with name {name}. Second occurrence in file {import:?}. \
                    First occurrence in {file:?}.",
                ));
            }
            extensions.insert(name.to_compact_string(), (ext, import.clone()));
        }
        for host in cfg.hosts {
            let host = host
                .resolve(
                    &extensions,
                    custom_extensions,
                    config_dir,
                    root_config_dir,
                    opts.dev,
                )
                .await?;

            info!(
                "Loaded host {} from {} with extensions {:?}.",
                host.host.name,
                import.display(),
                host.exts
            );
            if let Some((_, file)) = hosts.get(&host.host.name) {
                return Err(format!(
                    "Duplicate host with name {}. Second occurrence in file {import:?}. \
                    First occurrence in {file:?}.",
                    host.host.name
                ));
            }
            hosts.insert(host.host.name.clone(), (host, import.clone()));
        }

        if let Some(collection) = cfg.host_collections {
            for (name, mut host_names) in collection {
                let entry = collections.entry(name.to_compact_string());
                let entry = entry.or_default();
                host_names.extend(entry.iter().map(|v| v.to_string()));
                *entry = host_names.into_iter().map(CompactString::from).collect();
            }
        }
    }

    if let Some(default_host) = opts.default_host {
        if !hosts.contains_key(default_host) {
            return Err(format!(
                "Your choosen default host {default_host} wasn't found. Available: {:?}",
                hosts.keys().collect::<Vec<_>>()
            ));
        }
    }

    let mut built_collections = HashMap::new();
    for (name, host_names) in collections {
        info!("Create host collection \"{name}\" with hosts {host_names:?}");
        let collection = construct_collection(
            &host_names,
            &hosts,
            &extensions,
            custom_extensions,
            opts,
            false,
        )
        .await?;
        built_collections.insert(name, (host_names, collection));
    }
    let mut rc = kvarn::RunConfig::new();
    for descriptor in ports
        .ok_or("Your config must contain a `ports` paramter.")?
        .0
        .resolve(
            &built_collections,
            &hosts,
            &extensions,
            custom_extensions,
            opts,
        )
        .await?
    {
        rc = rc.bind(descriptor);
    }

    Ok(rc)
}

type CustomExtensionFn = Box<
    dyn for<'a> Fn(
        &'a mut kvarn::Extensions,
        ron::Value,
        PathBuf,
    ) -> kvarn::extensions::RetSyncFut<'a, Result<()>>,
>;
type CustomExtensionsInner = HashMap<String, CustomExtensionFn>;
pub struct CustomExtensions(pub(crate) CustomExtensionsInner);
impl CustomExtensions {
    pub fn empty() -> Self {
        Self(HashMap::new())
    }
    /// Same as [`Self::insert_without_data`], but without access to the config dir
    /// (for usage with other extensions in Mölla).
    pub fn insert_without_data_or_config_dir(
        &mut self,
        name: impl Into<String>,
        extension: impl Fn(&mut kvarn::Extensions) -> kvarn::extensions::RetSyncFut<Result<()>>
            + Send
            + Sync
            + 'static,
    ) {
        self.insert_without_data(name, move |ext, _| extension(ext))
    }
    /// Same as [`Self::insert`], but without getting any config data specified after the extension
    /// name.
    pub fn insert_without_data(
        &mut self,
        name: impl Into<String>,
        extension: impl Fn(&mut kvarn::Extensions, PathBuf) -> kvarn::extensions::RetSyncFut<Result<()>>
            + Send
            + Sync
            + 'static,
    ) {
        self.insert::<()>(name, move |ext, (), config_dir| extension(ext, config_dir));
    }
    pub fn insert<T: DeserializeOwned + Sync + Send + 'static>(
        &mut self,
        name: impl Into<String>,
        extension: impl Fn(&mut kvarn::Extensions, T, PathBuf) -> kvarn::extensions::RetSyncFut<Result<()>>
            + Send
            + Sync
            + 'static,
    ) {
        let extension = Arc::new(extension);
        let f: CustomExtensionFn = Box::new(move |exts, value: ron::Value, config_dir: PathBuf| {
            let extension = Arc::clone(&extension);
            Box::pin(async move {
                let config = value
                    .into_rust()
                    .map_err(|err| format!("Custom extension data has invalid format: {err}"))?;
                extension(exts, config, config_dir).await?;
                Ok::<(), String>(())
            })
        });
        self.0.insert(name.into(), f);
    }
}
impl Default for CustomExtensions {
    fn default() -> Self {
        Self::empty()
    }
}

pub async fn construct_collection(
    host_names: impl AsRef<[CompactString]>,
    hosts: &Hosts,
    exts: &ExtensionBundles,
    custom_exts: &CustomExtensions,
    opts: &CliOptions<'_>,
    execute_extensions_addons: bool,
) -> Result<Arc<kvarn::host::Collection>> {
    let mut b = kvarn::host::Collection::builder();
    let mut se = vec![];
    let mut cert_collection_senders = Vec::new();
    for host in host_names.as_ref() {
        let mut host = hosts
            .get(host)
            .ok_or_else(|| format!("Didn't find a host with name {host}."))?
            .0
            .clone_with_extensions(exts, custom_exts, execute_extensions_addons, opts.dev)
            .await?;
        for se_handle in host.search_engine_handles {
            se.push((host.host.name.clone(), se_handle))
        }
        cert_collection_senders.extend(host.cert_collection_senders);
        if !opts.cache {
            host.host.disable_client_cache().disable_server_cache();
        }
        if opts
            .default_host
            .map_or(false, |default| default == host.host.name)
        {
            b = b.default(host.host);
        } else {
            b = b.insert(host.host);
        }
    }
    let collection = b.build();

    for cert_collection_sender in cert_collection_senders {
        cert_collection_sender.send(collection.clone()).unwrap();
    }
    for (host, se) in se {
        // assume we'll watch for the rest of time
        core::mem::forget(
            se.watch(host, collection.clone())
                .await
                .map_err(|err| format!("Failed to start search engine watch: {err:?}"))?,
        );
    }
    Ok(collection)
}

pub type HostCollections =
    HashMap<CompactString, (Vec<CompactString>, Arc<kvarn::host::Collection>)>;
pub type Hosts = HashMap<CompactString, (crate::host::CloneableHost, PathBuf)>;
pub type ExtensionBundles = HashMap<CompactString, (Vec<crate::extension::Extension>, PathBuf)>;