mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-06-02 21:49:22 +00:00
af5175a282
With this attribute, Lemmy will throw an error and exit if any invalid entry is found in the config file. I think can be useful to notice typos or keys that were removed or renamed in an upgrade. Currently you wouldnt notice these at all unless you manually compare the config file with settings that are listed in documentation. This should be considered a breaking change. Co-authored-by: Dessalines <dessalines@users.noreply.github.com>
106 lines
3 KiB
Rust
106 lines
3 KiB
Rust
use crate::{
|
|
error::LemmyError,
|
|
location_info,
|
|
settings::structs::{PictrsConfig, Settings},
|
|
};
|
|
use anyhow::{anyhow, Context};
|
|
use deser_hjson::from_str;
|
|
use once_cell::sync::Lazy;
|
|
use percent_encoding::{utf8_percent_encode, NON_ALPHANUMERIC};
|
|
use regex::Regex;
|
|
use std::{env, fs, io::Error};
|
|
|
|
pub mod structs;
|
|
|
|
static DEFAULT_CONFIG_FILE: &str = "config/config.hjson";
|
|
|
|
pub static SETTINGS: Lazy<Settings> = Lazy::new(|| {
|
|
Settings::init().expect("Failed to load settings file, see documentation (https://join-lemmy.org/docs/en/administration/configuration.html)")
|
|
});
|
|
static WEBFINGER_REGEX: Lazy<Regex> = Lazy::new(|| {
|
|
Regex::new(&format!(
|
|
"^acct:([a-zA-Z0-9_]{{3,}})@{}$",
|
|
SETTINGS.hostname
|
|
))
|
|
.expect("compile webfinger regex")
|
|
});
|
|
|
|
impl Settings {
|
|
/// Reads config from configuration file.
|
|
///
|
|
/// Note: The env var `LEMMY_DATABASE_URL` is parsed in
|
|
/// `lemmy_db_schema/src/lib.rs::get_database_url_from_env()`
|
|
/// Warning: Only call this once.
|
|
pub(crate) fn init() -> Result<Self, LemmyError> {
|
|
// Read the config file
|
|
let config = from_str::<Settings>(&Self::read_config_file()?)?;
|
|
|
|
if config.hostname == "unset" {
|
|
return Err(anyhow!("Hostname variable is not set!").into());
|
|
}
|
|
|
|
Ok(config)
|
|
}
|
|
|
|
pub fn get_database_url(&self) -> String {
|
|
let conf = &self.database;
|
|
format!(
|
|
"postgres://{}:{}@{}:{}/{}",
|
|
utf8_percent_encode(&conf.user, NON_ALPHANUMERIC),
|
|
utf8_percent_encode(&conf.password, NON_ALPHANUMERIC),
|
|
conf.host,
|
|
conf.port,
|
|
utf8_percent_encode(&conf.database, NON_ALPHANUMERIC),
|
|
)
|
|
}
|
|
|
|
fn get_config_location() -> String {
|
|
env::var("LEMMY_CONFIG_LOCATION").unwrap_or_else(|_| DEFAULT_CONFIG_FILE.to_string())
|
|
}
|
|
|
|
fn read_config_file() -> Result<String, Error> {
|
|
fs::read_to_string(Self::get_config_location())
|
|
}
|
|
|
|
/// Returns either "http" or "https", depending on tls_enabled setting
|
|
pub fn get_protocol_string(&self) -> &'static str {
|
|
if self.tls_enabled {
|
|
"https"
|
|
} else {
|
|
"http"
|
|
}
|
|
}
|
|
|
|
/// Returns something like `http://localhost` or `https://lemmy.ml`,
|
|
/// with the correct protocol and hostname.
|
|
pub fn get_protocol_and_hostname(&self) -> String {
|
|
format!("{}://{}", self.get_protocol_string(), self.hostname)
|
|
}
|
|
|
|
/// When running the federation test setup in `api_tests/` or `docker/federation`, the `hostname`
|
|
/// variable will be like `lemmy-alpha:8541`. This method removes the port and returns
|
|
/// `lemmy-alpha` instead. It has no effect in production.
|
|
pub fn get_hostname_without_port(&self) -> Result<String, anyhow::Error> {
|
|
Ok(
|
|
(*self
|
|
.hostname
|
|
.split(':')
|
|
.collect::<Vec<&str>>()
|
|
.first()
|
|
.context(location_info!())?)
|
|
.to_string(),
|
|
)
|
|
}
|
|
|
|
pub fn webfinger_regex(&self) -> Regex {
|
|
WEBFINGER_REGEX.clone()
|
|
}
|
|
|
|
pub fn pictrs_config(&self) -> Result<PictrsConfig, LemmyError> {
|
|
self
|
|
.pictrs
|
|
.clone()
|
|
.ok_or_else(|| anyhow!("images_disabled").into())
|
|
}
|
|
}
|