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
//! Configuration for the application.
use std::path::Path;
use std::{env, fs};
use config::{Config, ConfigError, File, FileFormat};
use log::warn;
use serde::{Deserialize, Serialize};
use tokio::sync::RwLock;
/// Information displayed to the user in the website.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Website {
/// The name of the website.
pub name: String,
}
impl Default for Website {
fn default() -> Self {
Self {
name: "Torrust".to_string(),
}
}
}
/// See `TrackerMode` in [`torrust-tracker-primitives`](https://docs.rs/torrust-tracker-primitives)
/// crate for more information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum TrackerMode {
// todo: use https://crates.io/crates/torrust-tracker-primitives
/// Will track every new info hash and serve every peer.
Public,
/// Will only serve authenticated peers.
Private,
/// Will only track whitelisted info hashes.
Whitelisted,
/// Will only track whitelisted info hashes and serve authenticated peers.
PrivateWhitelisted,
}
impl Default for TrackerMode {
fn default() -> Self {
Self::Public
}
}
/// Configuration for the associated tracker.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Tracker {
/// Connection string for the tracker. For example: `udp://TRACKER_IP:6969`.
pub url: String,
/// The mode of the tracker. For example: `Public`.
/// See `TrackerMode` in [`torrust-tracker-primitives`](https://docs.rs/torrust-tracker-primitives)
/// crate for more information.
pub mode: TrackerMode,
/// The url of the tracker API. For example: `http://localhost:1212`.
pub api_url: String,
/// The token used to authenticate with the tracker API.
pub token: String,
/// The amount of seconds the token is valid.
pub token_valid_seconds: u64,
}
impl Default for Tracker {
fn default() -> Self {
Self {
url: "udp://localhost:6969".to_string(),
mode: TrackerMode::default(),
api_url: "http://localhost:1212".to_string(),
token: "MyAccessToken".to_string(),
token_valid_seconds: 7_257_600,
}
}
}
/// Port number representing that the OS will choose one randomly from the available ports.
///
/// It's the port number `0`
pub const FREE_PORT: u16 = 0;
/// The the base URL for the API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Network {
/// The port to listen on. Default to `3000`.
pub port: u16,
/// The base URL for the API. For example: `http://localhost`.
/// If not set, the base URL will be inferred from the request.
pub base_url: Option<String>,
}
impl Default for Network {
fn default() -> Self {
Self {
port: 3000,
base_url: None,
}
}
}
/// Whether the email is required on signup or not.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum EmailOnSignup {
/// The email is required on signup.
Required,
/// The email is optional on signup.
Optional,
/// The email is not allowed on signup. It will only be ignored if provided.
None, // code-review: rename to `Ignored`?
}
impl Default for EmailOnSignup {
fn default() -> Self {
Self::Optional
}
}
/// Authentication options.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Auth {
/// Whether or not to require an email on signup.
pub email_on_signup: EmailOnSignup,
/// The minimum password length.
pub min_password_length: usize,
/// The maximum password length.
pub max_password_length: usize,
/// The secret key used to sign JWT tokens.
pub secret_key: String,
}
impl Default for Auth {
fn default() -> Self {
Self {
email_on_signup: EmailOnSignup::default(),
min_password_length: 6,
max_password_length: 64,
secret_key: "MaxVerstappenWC2021".to_string(),
}
}
}
/// Database configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Database {
/// The connection string for the database. For example: `sqlite://data.db?mode=rwc`.
pub connect_url: String,
}
impl Default for Database {
fn default() -> Self {
Self {
connect_url: "sqlite://data.db?mode=rwc".to_string(),
}
}
}
/// SMTP configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Mail {
/// Whether or not to enable email verification on signup.
pub email_verification_enabled: bool,
/// The email address to send emails from.
pub from: String,
/// The email address to reply to.
pub reply_to: String,
/// The username to use for SMTP authentication.
pub username: String,
/// The password to use for SMTP authentication.
pub password: String,
/// The SMTP server to use.
pub server: String,
/// The SMTP port to use.
pub port: u16,
}
impl Default for Mail {
fn default() -> Self {
Self {
email_verification_enabled: false,
from: "example@email.com".to_string(),
reply_to: "noreply@email.com".to_string(),
username: String::default(),
password: String::default(),
server: String::default(),
port: 25,
}
}
}
/// Configuration for the image proxy cache.
///
/// Users have a cache quota per period. For example: 100MB per day.
/// When users are navigating the site, they will be downloading images that are
/// embedded in the torrent description. These images will be cached in the
/// proxy. The proxy will not download new images if the user has reached the
/// quota.
#[allow(clippy::module_name_repetitions)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImageCache {
/// Maximum time in seconds to wait for downloading the image form the original source.
pub max_request_timeout_ms: u64,
/// Cache size in bytes.
pub capacity: usize,
/// Maximum size in bytes for a single image.
pub entry_size_limit: usize,
/// Users have a cache quota per period. For example: 100MB per day.
/// This is the period in seconds (1 day in seconds).
pub user_quota_period_seconds: u64,
/// Users have a cache quota per period. For example: 100MB per day.
/// This is the maximum size in bytes (100MB in bytes).
pub user_quota_bytes: usize,
}
/// Core configuration for the API
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Api {
/// The default page size for torrent lists.
pub default_torrent_page_size: u8,
/// The maximum page size for torrent lists.
pub max_torrent_page_size: u8,
}
impl Default for Api {
fn default() -> Self {
Self {
default_torrent_page_size: 10,
max_torrent_page_size: 30,
}
}
}
/// Configuration for the tracker statistics importer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TrackerStatisticsImporter {
/// The interval in seconds to get statistics from the tracker.
pub torrent_info_update_interval: u64,
}
impl Default for TrackerStatisticsImporter {
fn default() -> Self {
Self {
torrent_info_update_interval: 3600,
}
}
}
impl Default for ImageCache {
fn default() -> Self {
Self {
max_request_timeout_ms: 1000,
capacity: 128_000_000,
entry_size_limit: 4_000_000,
user_quota_period_seconds: 3600,
user_quota_bytes: 64_000_000,
}
}
}
/// The whole configuration for the backend.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct TorrustBackend {
/// Logging level. Possible values are: `Off`, `Error`, `Warn`, `Info`,
/// `Debug` and `Trace`. Default is `Info`.
pub log_level: Option<String>,
/// The website customizable values.
pub website: Website,
/// The tracker configuration.
pub tracker: Tracker,
/// The network configuration.
pub net: Network,
/// The authentication configuration.
pub auth: Auth,
/// The database configuration.
pub database: Database,
/// The SMTP configuration.
pub mail: Mail,
/// The image proxy cache configuration.
pub image_cache: ImageCache,
/// The API configuration.
pub api: Api,
/// The tracker statistics importer job configuration.
pub tracker_statistics_importer: TrackerStatisticsImporter,
}
/// The configuration service.
#[derive(Debug)]
pub struct Configuration {
/// The state of the configuration.
pub settings: RwLock<TorrustBackend>,
/// The path to the configuration file. This is `None` if the configuration
/// was loaded from the environment.
pub config_path: Option<String>,
}
impl Default for Configuration {
fn default() -> Configuration {
Configuration {
settings: RwLock::new(TorrustBackend::default()),
config_path: None,
}
}
}
impl Configuration {
/// Loads the configuration from the configuration file.
///
/// # Errors
///
/// This function will return an error no configuration in the `CONFIG_PATH` exists, and a new file is is created.
/// This function will return an error if the `config` is not a valid `TorrustConfig` document.
pub async fn load_from_file(config_path: &str) -> Result<Configuration, ConfigError> {
let config_builder = Config::builder();
#[allow(unused_assignments)]
let mut config = Config::default();
if Path::new(config_path).exists() {
config = config_builder.add_source(File::with_name(config_path)).build()?;
} else {
warn!("No config file found. Creating default config file ...");
let config = Configuration::default();
let _ = config.save_to_file(config_path).await;
return Err(ConfigError::Message(format!(
"No config file found. Created default config file in {config_path}. Edit the file and start the application."
)));
}
let torrust_config: TorrustBackend = match config.try_deserialize() {
Ok(data) => Ok(data),
Err(e) => Err(ConfigError::Message(format!("Errors while processing config: {e}."))),
}?;
Ok(Configuration {
settings: RwLock::new(torrust_config),
config_path: Some(config_path.to_string()),
})
}
/// Loads the configuration from the environment variable. The whole
/// configuration must be in the environment variable. It contains the same
/// configuration as the configuration file with the same format.
///
/// # Errors
///
/// Will return `Err` if the environment variable does not exist or has a bad configuration.
pub fn load_from_env_var(config_env_var_name: &str) -> Result<Configuration, ConfigError> {
match env::var(config_env_var_name) {
Ok(config_toml) => {
let config_builder = Config::builder()
.add_source(File::from_str(&config_toml, FileFormat::Toml))
.build()?;
let torrust_config: TorrustBackend = config_builder.try_deserialize()?;
Ok(Configuration {
settings: RwLock::new(torrust_config),
config_path: None,
})
}
Err(_) => Err(ConfigError::Message(
"Unable to load configuration from the configuration environment variable.".to_string(),
)),
}
}
/// Returns the save to file of this [`Configuration`].
pub async fn save_to_file(&self, config_path: &str) {
let settings = self.settings.read().await;
let toml_string = toml::to_string(&*settings).expect("Could not encode TOML value");
drop(settings);
fs::write(config_path, toml_string).expect("Could not write to file!");
}
/// Update the settings file based upon a supplied `new_settings`.
///
/// # Errors
///
/// Todo: Make an error if the save fails.
///
/// # Panics
///
/// Will panic if the configuration file path is not defined. That happens
/// when the configuration was loaded from the environment variable.
pub async fn update_settings(&self, new_settings: TorrustBackend) -> Result<(), ()> {
match &self.config_path {
Some(config_path) => {
let mut settings = self.settings.write().await;
*settings = new_settings;
drop(settings);
let _ = self.save_to_file(config_path).await;
Ok(())
}
None => panic!(
"Cannot update settings when the config file path is not defined. For example: when it's loaded from env var."
),
}
}
pub async fn get_all(&self) -> TorrustBackend {
let settings_lock = self.settings.read().await;
settings_lock.clone()
}
pub async fn get_public(&self) -> ConfigurationPublic {
let settings_lock = self.settings.read().await;
ConfigurationPublic {
website_name: settings_lock.website.name.clone(),
tracker_url: settings_lock.tracker.url.clone(),
tracker_mode: settings_lock.tracker.mode.clone(),
email_on_signup: settings_lock.auth.email_on_signup.clone(),
}
}
pub async fn get_site_name(&self) -> String {
let settings_lock = self.settings.read().await;
settings_lock.website.name.clone()
}
pub async fn get_api_base_url(&self) -> Option<String> {
let settings_lock = self.settings.read().await;
settings_lock.net.base_url.clone()
}
}
/// The public backend configuration.
/// There is an endpoint to get this configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConfigurationPublic {
website_name: String,
tracker_url: String,
tracker_mode: TrackerMode,
email_on_signup: EmailOnSignup,
}