mirror of https://git.meli.delivery/meli/meli
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
830 lines
25 KiB
Rust
830 lines
25 KiB
Rust
/*
|
|
* meli - configuration module.
|
|
*
|
|
* Copyright 2017 Manos Pitsidianakis
|
|
*
|
|
* This file is part of meli.
|
|
*
|
|
* meli is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* meli is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with meli. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/*! Configuration logic and `config.toml` interfaces. */
|
|
|
|
extern crate bincode;
|
|
extern crate serde;
|
|
extern crate toml;
|
|
extern crate xdg;
|
|
|
|
pub mod composing;
|
|
pub mod notifications;
|
|
pub mod pager;
|
|
pub mod pgp;
|
|
pub mod tags;
|
|
#[macro_use]
|
|
pub mod shortcuts;
|
|
mod listing;
|
|
pub mod terminal;
|
|
mod themes;
|
|
pub use themes::*;
|
|
|
|
pub mod accounts;
|
|
pub use self::accounts::Account;
|
|
pub use self::composing::*;
|
|
pub use self::pgp::*;
|
|
pub use self::shortcuts::*;
|
|
pub use self::tags::*;
|
|
|
|
use self::default_vals::*;
|
|
use self::listing::{ListingSettings, ListingSettingsOverride};
|
|
use self::notifications::{NotificationsSettings, NotificationsSettingsOverride};
|
|
use self::terminal::TerminalSettings;
|
|
use crate::pager::{PagerSettings, PagerSettingsOverride};
|
|
use crate::plugins::Plugin;
|
|
use melib::conf::{AccountSettings, MailboxConf, ToggleFlag};
|
|
use melib::error::*;
|
|
|
|
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
|
|
|
|
use std::collections::HashMap;
|
|
use std::env;
|
|
use std::fs::OpenOptions;
|
|
use std::io::{self, BufRead, Write};
|
|
use std::os::unix::fs::PermissionsExt;
|
|
use std::path::{Path, PathBuf};
|
|
|
|
#[macro_export]
|
|
macro_rules! split_command {
|
|
($cmd:expr) => {{
|
|
$cmd.split_whitespace().collect::<Vec<&str>>()
|
|
}};
|
|
}
|
|
|
|
#[macro_export]
|
|
macro_rules! mailbox_acc_settings {
|
|
($context:ident[$account_idx:expr].$setting:ident.$field:ident) => {{
|
|
$context.accounts[$account_idx]
|
|
.settings
|
|
.conf_override
|
|
.$setting
|
|
.$field
|
|
.as_ref()
|
|
.unwrap_or(&$context.settings.$setting.$field)
|
|
}};
|
|
}
|
|
#[macro_export]
|
|
macro_rules! mailbox_settings {
|
|
($context:ident[$account_idx:expr][$mailbox_path:expr].$setting:ident.$field:ident) => {{
|
|
$context.accounts[$account_idx][$mailbox_path]
|
|
.conf
|
|
.conf_override
|
|
.$setting
|
|
.$field
|
|
.as_ref()
|
|
.or($context.accounts[$account_idx]
|
|
.settings
|
|
.conf_override
|
|
.$setting
|
|
.$field
|
|
.as_ref())
|
|
.unwrap_or(&$context.settings.$setting.$field)
|
|
}};
|
|
}
|
|
|
|
#[macro_export]
|
|
macro_rules! override_def {
|
|
($override_name:ident,
|
|
$(#[$outer:meta])*
|
|
pub struct $name:ident { $( $(#[$fouter:meta])* $fname:ident : $ft:ty),*,
|
|
}) => {
|
|
$(#[$outer])*
|
|
pub struct $name {
|
|
$(
|
|
$(#[$fouter])*
|
|
pub $fname : $ft
|
|
),*
|
|
}
|
|
$(#[$outer])*
|
|
pub struct $override_name {
|
|
$(
|
|
$(#[$fouter])*
|
|
pub $fname : Option<$ft>
|
|
),*
|
|
}
|
|
impl Default for $override_name {
|
|
fn default() -> Self {
|
|
$override_name {
|
|
$(
|
|
$fname : None
|
|
),*
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
|
|
pub struct MailUIConf {
|
|
#[serde(default)]
|
|
pub pager: PagerSettingsOverride,
|
|
#[serde(default)]
|
|
pub listing: ListingSettingsOverride,
|
|
#[serde(default)]
|
|
pub notifications: NotificationsSettingsOverride,
|
|
#[serde(default)]
|
|
pub shortcuts: ShortcutsOverride,
|
|
#[serde(default)]
|
|
pub composing: ComposingSettingsOverride,
|
|
#[serde(default)]
|
|
pub identity: Option<String>,
|
|
#[serde(default)]
|
|
pub tags: TagsSettingsOverride,
|
|
#[serde(default)]
|
|
pub themes: Option<Themes>,
|
|
#[serde(default)]
|
|
pub pgp: PGPSettingsOverride,
|
|
}
|
|
|
|
#[serde(default)]
|
|
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
|
|
pub struct FileMailboxConf {
|
|
#[serde(flatten)]
|
|
pub conf_override: MailUIConf,
|
|
#[serde(flatten)]
|
|
pub mailbox_conf: MailboxConf,
|
|
}
|
|
|
|
impl FileMailboxConf {
|
|
pub fn conf_override(&self) -> &MailUIConf {
|
|
&self.conf_override
|
|
}
|
|
|
|
pub fn mailbox_conf(&self) -> &MailboxConf {
|
|
&self.mailbox_conf
|
|
}
|
|
}
|
|
|
|
use crate::conf::deserializers::extra_settings;
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
pub struct FileAccount {
|
|
root_mailbox: String,
|
|
format: String,
|
|
identity: String,
|
|
#[serde(default = "none")]
|
|
display_name: Option<String>,
|
|
|
|
#[serde(default = "false_val")]
|
|
read_only: bool,
|
|
#[serde(default)]
|
|
subscribed_mailboxes: Vec<String>,
|
|
#[serde(default)]
|
|
mailboxes: HashMap<String, FileMailboxConf>,
|
|
#[serde(default)]
|
|
cache_type: CacheType,
|
|
#[serde(default = "false_val")]
|
|
pub manual_refresh: bool,
|
|
#[serde(default = "none")]
|
|
pub refresh_command: Option<String>,
|
|
#[serde(flatten)]
|
|
pub conf_override: MailUIConf,
|
|
#[serde(flatten)]
|
|
#[serde(deserialize_with = "extra_settings")]
|
|
pub extra: HashMap<String, String>, /* use custom deserializer to convert any given value (eg bool, number, etc) to string */
|
|
}
|
|
|
|
impl From<FileAccount> for AccountConf {
|
|
fn from(x: FileAccount) -> Self {
|
|
let format = x.format.to_lowercase();
|
|
let root_mailbox = x.root_mailbox.clone();
|
|
let identity = x.identity.clone();
|
|
let display_name = x.display_name.clone();
|
|
let mailboxes = x
|
|
.mailboxes
|
|
.iter()
|
|
.map(|(k, v)| (k.clone(), v.mailbox_conf.clone()))
|
|
.collect();
|
|
|
|
let acc = AccountSettings {
|
|
name: String::new(),
|
|
root_mailbox,
|
|
format,
|
|
identity,
|
|
read_only: x.read_only,
|
|
display_name,
|
|
subscribed_mailboxes: x.subscribed_mailboxes.clone(),
|
|
mailboxes,
|
|
manual_refresh: x.manual_refresh,
|
|
extra: x.extra.clone(),
|
|
};
|
|
|
|
let mailbox_confs = x.mailboxes.clone();
|
|
AccountConf {
|
|
account: acc,
|
|
conf_override: x.conf_override.clone(),
|
|
conf: x,
|
|
mailbox_confs,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl FileAccount {
|
|
pub fn mailboxes(&self) -> &HashMap<String, FileMailboxConf> {
|
|
&self.mailboxes
|
|
}
|
|
|
|
pub fn mailbox(&self) -> &str {
|
|
&self.root_mailbox
|
|
}
|
|
|
|
pub fn cache_type(&self) -> &CacheType {
|
|
&self.cache_type
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
pub struct FileSettings {
|
|
pub accounts: HashMap<String, FileAccount>,
|
|
#[serde(default)]
|
|
pub pager: PagerSettings,
|
|
#[serde(default)]
|
|
pub listing: ListingSettings,
|
|
#[serde(default)]
|
|
pub notifications: NotificationsSettings,
|
|
#[serde(default)]
|
|
pub shortcuts: Shortcuts,
|
|
pub composing: ComposingSettings,
|
|
#[serde(default)]
|
|
pub tags: TagsSettings,
|
|
#[serde(default)]
|
|
pub pgp: PGPSettings,
|
|
#[serde(default)]
|
|
pub terminal: TerminalSettings,
|
|
#[serde(default)]
|
|
pub plugins: HashMap<String, Plugin>,
|
|
#[serde(default)]
|
|
pub log: LogSettings,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default)]
|
|
pub struct AccountConf {
|
|
pub(crate) account: AccountSettings,
|
|
pub(crate) conf: FileAccount,
|
|
pub conf_override: MailUIConf,
|
|
pub(crate) mailbox_confs: HashMap<String, FileMailboxConf>,
|
|
}
|
|
|
|
impl AccountConf {
|
|
pub fn account(&self) -> &AccountSettings {
|
|
&self.account
|
|
}
|
|
pub fn account_mut(&mut self) -> &mut AccountSettings {
|
|
&mut self.account
|
|
}
|
|
pub fn conf(&self) -> &FileAccount {
|
|
&self.conf
|
|
}
|
|
pub fn conf_mut(&mut self) -> &mut FileAccount {
|
|
&mut self.conf
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default)]
|
|
pub struct Settings {
|
|
pub accounts: HashMap<String, AccountConf>,
|
|
pub pager: PagerSettings,
|
|
pub listing: ListingSettings,
|
|
pub notifications: NotificationsSettings,
|
|
pub shortcuts: Shortcuts,
|
|
pub tags: TagsSettings,
|
|
pub composing: ComposingSettings,
|
|
pub pgp: PGPSettings,
|
|
pub terminal: TerminalSettings,
|
|
pub plugins: HashMap<String, Plugin>,
|
|
pub log: LogSettings,
|
|
}
|
|
|
|
pub fn get_config_file() -> Result<PathBuf> {
|
|
let xdg_dirs = xdg::BaseDirectories::with_prefix("meli").map_err(|err| {
|
|
MeliError::new(format!(
|
|
"Could not detect XDG directories for user: {}",
|
|
err
|
|
))
|
|
.set_source(Some(std::sync::Arc::new(Box::new(err))))
|
|
})?;
|
|
match env::var("MELI_CONFIG") {
|
|
Ok(path) => Ok(PathBuf::from(path)),
|
|
Err(_) => Ok(xdg_dirs
|
|
.place_config_file("config.toml")
|
|
.chain_err_summary(|| {
|
|
format!(
|
|
"Cannot create configuration directory in {}",
|
|
xdg_dirs.get_config_home().display()
|
|
)
|
|
})?),
|
|
}
|
|
}
|
|
|
|
impl FileSettings {
|
|
pub fn new() -> Result<FileSettings> {
|
|
let config_path = get_config_file()?;
|
|
if !config_path.exists() {
|
|
println!(
|
|
"No configuration found. Would you like to generate one in {}? [Y/n]",
|
|
config_path.display()
|
|
);
|
|
let mut buffer = String::new();
|
|
let stdin = io::stdin();
|
|
let mut handle = stdin.lock();
|
|
|
|
loop {
|
|
buffer.clear();
|
|
handle
|
|
.read_line(&mut buffer)
|
|
.expect("Could not read from stdin.");
|
|
|
|
match buffer.trim() {
|
|
"Y" | "y" | "yes" | "YES" | "Yes" => {
|
|
create_config_file(&config_path)?;
|
|
return Err(MeliError::new(
|
|
"Edit the sample configuration and relaunch meli.",
|
|
));
|
|
}
|
|
"n" | "N" | "no" | "No" | "NO" => {
|
|
return Err(MeliError::new("No configuration file found."));
|
|
}
|
|
_ => {
|
|
println!(
|
|
"No configuration found. Would you like to generate one in {}? [Y/n]",
|
|
config_path.display()
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
FileSettings::validate(config_path)
|
|
}
|
|
|
|
pub fn validate(path: PathBuf) -> Result<Self> {
|
|
let s = pp::pp(&path)?;
|
|
let mut s: FileSettings = toml::from_str(&s).map_err(|e| {
|
|
MeliError::new(format!(
|
|
"{}:\nConfig file contains errors: {}",
|
|
path.display(),
|
|
e.to_string()
|
|
))
|
|
})?;
|
|
let mut backends = melib::backends::Backends::new();
|
|
let plugin_manager = crate::plugins::PluginManager::new();
|
|
for (_, p) in s.plugins.clone() {
|
|
if crate::plugins::PluginKind::Backend == p.kind() {
|
|
crate::plugins::backend::PluginBackend::register(
|
|
plugin_manager.listener(),
|
|
p.clone(),
|
|
&mut backends,
|
|
);
|
|
}
|
|
}
|
|
|
|
let Themes {
|
|
light: default_light,
|
|
dark: default_dark,
|
|
..
|
|
} = Themes::default();
|
|
for (k, v) in default_light.keys.into_iter() {
|
|
if !s.terminal.themes.light.contains_key(&k) {
|
|
s.terminal.themes.light.insert(k, v);
|
|
}
|
|
}
|
|
for theme in s.terminal.themes.other_themes.values_mut() {
|
|
for (k, v) in default_dark.keys.clone().into_iter() {
|
|
if !theme.contains_key(&k) {
|
|
theme.insert(k, v);
|
|
}
|
|
}
|
|
}
|
|
for (k, v) in default_dark.keys.into_iter() {
|
|
if !s.terminal.themes.dark.contains_key(&k) {
|
|
s.terminal.themes.dark.insert(k, v);
|
|
}
|
|
}
|
|
match s.terminal.theme.as_str() {
|
|
"dark" | "light" => {}
|
|
t if s.terminal.themes.other_themes.contains_key(t) => {}
|
|
t => {
|
|
return Err(MeliError::new(format!("Theme `{}` was not found.", t)));
|
|
}
|
|
}
|
|
|
|
s.terminal.themes.validate()?;
|
|
for (name, acc) in &s.accounts {
|
|
let FileAccount {
|
|
root_mailbox,
|
|
format,
|
|
identity,
|
|
read_only,
|
|
display_name,
|
|
subscribed_mailboxes,
|
|
mailboxes,
|
|
extra,
|
|
manual_refresh,
|
|
refresh_command: _,
|
|
cache_type: _,
|
|
conf_override: _,
|
|
} = acc.clone();
|
|
|
|
let lowercase_format = format.to_lowercase();
|
|
let s = AccountSettings {
|
|
name: name.to_string(),
|
|
root_mailbox,
|
|
format: format.clone(),
|
|
identity,
|
|
read_only,
|
|
display_name,
|
|
subscribed_mailboxes,
|
|
manual_refresh,
|
|
mailboxes: mailboxes
|
|
.into_iter()
|
|
.map(|(k, v)| (k, v.mailbox_conf))
|
|
.collect(),
|
|
extra,
|
|
};
|
|
backends.validate_config(&lowercase_format, &s)?;
|
|
}
|
|
|
|
Ok(s)
|
|
}
|
|
}
|
|
|
|
impl Settings {
|
|
pub fn new() -> Result<Settings> {
|
|
let fs = FileSettings::new()?;
|
|
let mut s: HashMap<String, AccountConf> = HashMap::new();
|
|
|
|
for (id, x) in fs.accounts {
|
|
let mut ac = AccountConf::from(x);
|
|
ac.account.set_name(id.clone());
|
|
|
|
s.insert(id, ac);
|
|
}
|
|
|
|
if let Some(ref log_path) = fs.log.log_file {
|
|
melib::change_log_dest(log_path.into());
|
|
}
|
|
if fs.log.maximum_level != melib::LoggingLevel::default() {
|
|
melib::change_log_level(fs.log.maximum_level);
|
|
}
|
|
|
|
Ok(Settings {
|
|
accounts: s,
|
|
pager: fs.pager,
|
|
listing: fs.listing,
|
|
notifications: fs.notifications,
|
|
shortcuts: fs.shortcuts,
|
|
tags: fs.tags,
|
|
composing: fs.composing,
|
|
pgp: fs.pgp,
|
|
terminal: fs.terminal,
|
|
plugins: fs.plugins,
|
|
log: fs.log,
|
|
})
|
|
}
|
|
}
|
|
|
|
#[derive(Copy, Debug, Clone, Hash, PartialEq)]
|
|
pub enum IndexStyle {
|
|
Plain,
|
|
Threaded,
|
|
Compact,
|
|
Conversations,
|
|
}
|
|
|
|
impl Default for IndexStyle {
|
|
fn default() -> Self {
|
|
IndexStyle::Compact
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Deserialize default functions
|
|
*/
|
|
|
|
mod default_vals {
|
|
pub(in crate::conf) fn false_val<T: std::convert::From<bool>>() -> T {
|
|
false.into()
|
|
}
|
|
|
|
pub(in crate::conf) fn true_val<T: std::convert::From<bool>>() -> T {
|
|
true.into()
|
|
}
|
|
|
|
pub(in crate::conf) fn zero_val<T: std::convert::From<usize>>() -> T {
|
|
0.into()
|
|
}
|
|
|
|
pub(in crate::conf) fn eighty_val<T: std::convert::From<usize>>() -> T {
|
|
80.into()
|
|
}
|
|
|
|
pub(in crate::conf) fn none<T>() -> Option<T> {
|
|
None
|
|
}
|
|
|
|
pub(in crate::conf) fn internal_value_false<T: std::convert::From<super::ToggleFlag>>() -> T {
|
|
super::ToggleFlag::InternalVal(false).into()
|
|
}
|
|
|
|
pub(in crate::conf) fn internal_value_true<T: std::convert::From<super::ToggleFlag>>() -> T {
|
|
super::ToggleFlag::InternalVal(true).into()
|
|
}
|
|
}
|
|
|
|
mod deserializers {
|
|
use serde::{Deserialize, Deserializer};
|
|
pub(in crate::conf) fn non_empty_string<'de, D, T: std::convert::From<Option<String>>>(
|
|
deserializer: D,
|
|
) -> std::result::Result<T, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let s = <String>::deserialize(deserializer)?;
|
|
if s.is_empty() {
|
|
Ok(None.into())
|
|
} else {
|
|
Ok(Some(s).into())
|
|
}
|
|
}
|
|
|
|
use toml::Value;
|
|
fn any_of<'de, D>(deserializer: D) -> std::result::Result<String, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let v: Value = Deserialize::deserialize(deserializer)?;
|
|
let mut ret = v.to_string();
|
|
if ret.starts_with('"') && ret.ends_with('"') {
|
|
ret.drain(0..1).count();
|
|
ret.drain(ret.len() - 1..).count();
|
|
}
|
|
Ok(ret)
|
|
}
|
|
|
|
use std::collections::HashMap;
|
|
pub(in crate::conf) fn extra_settings<'de, D>(
|
|
deserializer: D,
|
|
) -> std::result::Result<HashMap<String, String>, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
/* Why is this needed? If the user gives a configuration value such as key = true, the
|
|
* parsing will fail since it expects string values. We want to accept key = true as well
|
|
* as key = "true". */
|
|
#[derive(Deserialize)]
|
|
struct Wrapper(#[serde(deserialize_with = "any_of")] String);
|
|
|
|
let v = <HashMap<String, Wrapper>>::deserialize(deserializer)?;
|
|
Ok(v.into_iter().map(|(k, Wrapper(v))| (k, v)).collect())
|
|
}
|
|
}
|
|
|
|
impl<'de> Deserialize<'de> for IndexStyle {
|
|
fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let s = <String>::deserialize(deserializer)?;
|
|
match s.as_str() {
|
|
"Plain" | "plain" => Ok(IndexStyle::Plain),
|
|
"Threaded" | "threaded" => Ok(IndexStyle::Threaded),
|
|
"Compact" | "compact" => Ok(IndexStyle::Compact),
|
|
"Conversations" | "conversations" => Ok(IndexStyle::Conversations),
|
|
_ => Err(de::Error::custom("invalid `index_style` value")),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Serialize for IndexStyle {
|
|
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
match self {
|
|
IndexStyle::Plain => serializer.serialize_str("plain"),
|
|
IndexStyle::Threaded => serializer.serialize_str("threaded"),
|
|
IndexStyle::Compact => serializer.serialize_str("compact"),
|
|
IndexStyle::Conversations => serializer.serialize_str("conversations"),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub enum CacheType {
|
|
None,
|
|
#[cfg(feature = "sqlite3")]
|
|
Sqlite3,
|
|
}
|
|
|
|
impl Default for CacheType {
|
|
fn default() -> Self {
|
|
#[cfg(feature = "sqlite3")]
|
|
{
|
|
CacheType::Sqlite3
|
|
}
|
|
#[cfg(not(feature = "sqlite3"))]
|
|
{
|
|
CacheType::None
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'de> Deserialize<'de> for CacheType {
|
|
fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let s = <String>::deserialize(deserializer)?;
|
|
match s.as_str() {
|
|
#[cfg(feature = "sqlite3")]
|
|
"sqlite3" => Ok(CacheType::Sqlite3),
|
|
"nothing" | "none" | "" => Ok(CacheType::None),
|
|
_ => Err(de::Error::custom("invalid `index_cache` value")),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Serialize for CacheType {
|
|
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
match self {
|
|
#[cfg(feature = "sqlite3")]
|
|
CacheType::Sqlite3 => serializer.serialize_str("sqlite3"),
|
|
CacheType::None => serializer.serialize_str("none"),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn create_config_file(p: &Path) -> Result<()> {
|
|
let mut file = OpenOptions::new()
|
|
.write(true)
|
|
.create_new(true)
|
|
.open(p)
|
|
.expect("Could not create config file.");
|
|
file.write_all(include_bytes!("../samples/sample-config.toml"))
|
|
.expect("Could not write to config file.");
|
|
println!("Written example configuration to {}", p.display());
|
|
let metadata = file.metadata()?;
|
|
let mut permissions = metadata.permissions();
|
|
|
|
permissions.set_mode(0o600); // Read/write for owner only.
|
|
file.set_permissions(permissions)?;
|
|
Ok(())
|
|
}
|
|
|
|
mod pp {
|
|
//! Preprocess configuration files by unfolding `include` macros.
|
|
use melib::{
|
|
error::{MeliError, Result},
|
|
parsec::*,
|
|
ShellExpandTrait,
|
|
};
|
|
use std::io::Read;
|
|
use std::path::{Path, PathBuf};
|
|
|
|
/// Try to parse line into a path to be included.
|
|
fn include_directive<'a>() -> impl Parser<'a, Option<&'a str>> {
|
|
move |input: &'a str| {
|
|
enum State {
|
|
Start,
|
|
Path,
|
|
}
|
|
use State::*;
|
|
let mut state = State::Start;
|
|
|
|
let mut i = 0;
|
|
while i < input.len() {
|
|
match (&state, input.as_bytes()[i]) {
|
|
(Start, b'#') => {
|
|
return Ok(("", None));
|
|
}
|
|
(Start, b) if (b as char).is_whitespace() => { /* consume */ }
|
|
(Start, _) if input.as_bytes()[i..].starts_with(b"include(") => {
|
|
i += "include(".len();
|
|
state = Path;
|
|
continue;
|
|
}
|
|
(Start, _) => {
|
|
return Ok(("", None));
|
|
}
|
|
(Path, b'"') | (Path, b'\'') | (Path, b'`') => {
|
|
let mut end = i + 1;
|
|
while end < input.len() && input.as_bytes()[end] != input.as_bytes()[i] {
|
|
end += 1;
|
|
}
|
|
if end == input.len() {
|
|
return Err(input);
|
|
}
|
|
let ret = &input[i + 1..end];
|
|
end += 1;
|
|
if end < input.len() && input.as_bytes()[end] != b')' {
|
|
/* Nothing else allowed in line */
|
|
return Err(input);
|
|
}
|
|
end += 1;
|
|
while end < input.len() {
|
|
if !(input.as_bytes()[end] as char).is_whitespace() {
|
|
/* Nothing else allowed in line */
|
|
return Err(input);
|
|
}
|
|
end += 1;
|
|
}
|
|
return Ok(("", Some(ret)));
|
|
}
|
|
(Path, _) => return Err(input),
|
|
}
|
|
i += 1;
|
|
}
|
|
return Ok(("", None));
|
|
}
|
|
}
|
|
|
|
/// Expands `include` macros in path.
|
|
fn pp_helper(path: &Path, level: u8) -> Result<String> {
|
|
if level > 7 {
|
|
return Err(MeliError::new(format!("Maximum recursion limit reached while unfolding include directives in {}. Have you included a config file within itself?", path.display())));
|
|
}
|
|
let mut contents = String::new();
|
|
let mut file = std::fs::File::open(path)?;
|
|
file.read_to_string(&mut contents)?;
|
|
let mut ret = String::with_capacity(contents.len());
|
|
|
|
for (i, l) in contents.lines().enumerate() {
|
|
if let (_, Some(sub_path)) = include_directive().parse(l).map_err(|l| {
|
|
MeliError::new(format!(
|
|
"Malformed include directive in line {} of file {}: {}\nConfiguration uses the standard m4 macro include(`filename`).",
|
|
i,
|
|
path.display(),
|
|
l
|
|
))
|
|
})? {
|
|
let mut p = Path::new(sub_path).expand();
|
|
if p.is_relative() {
|
|
/* We checked that path is ok above so we can do unwrap here */
|
|
debug!(path);
|
|
let prefix = path.parent().unwrap();
|
|
debug!(prefix);
|
|
p = prefix.join(p)
|
|
}
|
|
|
|
ret.extend(pp_helper(&p, level + 1)?.chars());
|
|
} else {
|
|
ret.push_str(l);
|
|
ret.push('\n');
|
|
}
|
|
}
|
|
|
|
Ok(ret)
|
|
}
|
|
|
|
/// Expands `include` macros in configuration file and other configuration files (eg. themes)
|
|
/// in the filesystem.
|
|
pub fn pp<P: AsRef<Path>>(path: P) -> Result<String> {
|
|
let p_buf: PathBuf = if path.as_ref().is_relative() {
|
|
path.as_ref().expand().canonicalize()?
|
|
} else {
|
|
path.as_ref().expand()
|
|
};
|
|
|
|
let mut ret = pp_helper(&p_buf, 0)?;
|
|
drop(p_buf);
|
|
if let Ok(xdg_dirs) = xdg::BaseDirectories::with_prefix("meli") {
|
|
for theme_mailbox in xdg_dirs.find_config_files("themes") {
|
|
let read_dir = std::fs::read_dir(theme_mailbox)?;
|
|
for theme in read_dir {
|
|
ret.extend(pp_helper(&theme?.path(), 0)?.chars());
|
|
}
|
|
}
|
|
}
|
|
Ok(ret)
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
|
pub struct LogSettings {
|
|
#[serde(default)]
|
|
log_file: Option<PathBuf>,
|
|
#[serde(default)]
|
|
maximum_level: melib::LoggingLevel,
|
|
}
|