src/lib.rs

   1 pub mod api_routes_http;
   2 pub mod api_routes_websocket;
   3 pub mod code_migrations;
   4 pub mod root_span_builder;
   5 pub mod scheduled_tasks;
   6 #[cfg(feature = "console")]
   7 pub mod telemetry;
   8
   9 use crate::{code_migrations::run_advanced_migrations, root_span_builder::QuieterRootSpanBuilder};
  10 use activitypub_federation::config::{FederationConfig, FederationMiddleware};
  11 use actix_web::{middleware, web::Data, App, HttpServer, Result};
  12 use doku::json::{AutoComments, CommentsStyle, Formatting, ObjectsStyle};
  13 use lemmy_api_common::{
  14   context::LemmyContext,
  15   lemmy_db_views::structs::SiteView,
  16   request::build_user_agent,
  17   utils::{
  18     check_private_instance_and_federation_enabled,
  19     local_site_rate_limit_to_rate_limit_config,
  20   },
  21   websocket::chat_server::ChatServer,
  22 };
  23 use lemmy_apub::{VerifyUrlData, FEDERATION_HTTP_FETCH_LIMIT};
  24 use lemmy_db_schema::{
  25   source::secret::Secret,
  26   utils::{build_db_pool, get_database_url, run_migrations},
  27 };
  28 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
  29 use lemmy_utils::{
  30   error::LemmyError,
  31   rate_limit::RateLimitCell,
  32   settings::{structs::Settings, SETTINGS},
  33 };
  34 use reqwest::Client;
  35 use reqwest_middleware::ClientBuilder;
  36 use reqwest_retry::{policies::ExponentialBackoff, RetryTransientMiddleware};
  37 use reqwest_tracing::TracingMiddleware;
  38 use std::{env, sync::Arc, thread, time::Duration};
  39 use tracing::subscriber::set_global_default;
  40 use tracing_actix_web::TracingLogger;
  41 use tracing_error::ErrorLayer;
  42 use tracing_log::LogTracer;
  43 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
  44 use url::Url;
  45
  46 /// Max timeout for http requests
  47 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
  48
  49 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
  50 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
  51   let args: Vec<String> = env::args().collect();
  52   if args.get(1) == Some(&"--print-config-docs".to_string()) {
  53     let fmt = Formatting {
  54       auto_comments: AutoComments::none(),
  55       comments_style: CommentsStyle {
  56         separator: "#".to_owned(),
  57       },
  58       objects_style: ObjectsStyle {
  59         surround_keys_with_quotes: false,
  60         use_comma_as_separator: false,
  61       },
  62       ..Default::default()
  63     };
  64     println!("{}", doku::to_json_fmt_val(&fmt, &Settings::default()));
  65     return Ok(());
  66   }
  67
  68   let settings = SETTINGS.to_owned();
  69
  70   // Run the DB migrations
  71   let db_url = get_database_url(Some(&settings));
  72   run_migrations(&db_url);
  73
  74   // Set up the connection pool
  75   let pool = build_db_pool(&settings).await?;
  76
  77   // Run the Code-required migrations
  78   run_advanced_migrations(&pool, &settings).await?;
  79
  80   // Initialize the secrets
  81   let secret = Secret::init(&pool)
  82     .await
  83     .expect("Couldn't initialize secrets.");
  84
  85   // Make sure the local site is set up.
  86   let site_view = SiteView::read_local(&pool)
  87     .await
  88     .expect("local site not set up");
  89   let local_site = site_view.local_site;
  90   let federation_enabled = local_site.federation_enabled;
  91
  92   if federation_enabled {
  93     println!("federation enabled, host is {}", &settings.hostname);
  94   }
  95
  96   check_private_instance_and_federation_enabled(&local_site)?;
  97
  98   // Set up the rate limiter
  99   let rate_limit_config =
 100     local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
 101   let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
 102
 103   println!(
 104     "Starting http server at {}:{}",
 105     settings.bind, settings.port
 106   );
 107
 108   let user_agent = build_user_agent(&settings);
 109   let reqwest_client = Client::builder()
 110     .user_agent(user_agent.clone())
 111     .timeout(REQWEST_TIMEOUT)
 112     .build()?;
 113
 114   let retry_policy = ExponentialBackoff {
 115     max_n_retries: 3,
 116     max_retry_interval: REQWEST_TIMEOUT,
 117     min_retry_interval: Duration::from_millis(100),
 118     backoff_exponent: 2,
 119   };
 120
 121   let client = ClientBuilder::new(reqwest_client.clone())
 122     .with(TracingMiddleware::default())
 123     .with(RetryTransientMiddleware::new_with_policy(retry_policy))
 124     .build();
 125
 126   // Pictrs cannot use the retry middleware
 127   let pictrs_client = ClientBuilder::new(reqwest_client.clone())
 128     .with(TracingMiddleware::default())
 129     .build();
 130
 131   // Schedules various cleanup tasks for the DB
 132   thread::spawn(move || {
 133     scheduled_tasks::setup(db_url, user_agent).expect("Couldn't set up scheduled_tasks");
 134   });
 135
 136   let chat_server = Arc::new(ChatServer::startup());
 137
 138   // Create Http server with websocket support
 139   let settings_bind = settings.clone();
 140   HttpServer::new(move || {
 141     let context = LemmyContext::create(
 142       pool.clone(),
 143       chat_server.clone(),
 144       client.clone(),
 145       secret.clone(),
 146       rate_limit_cell.clone(),
 147     );
 148
 149     let federation_config = FederationConfig::builder()
 150       .domain(settings.hostname.clone())
 151       .app_data(context.clone())
 152       .client(client.clone())
 153       .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
 154       .worker_count(local_site.federation_worker_count as u64)
 155       .debug(cfg!(debug_assertions))
 156       .http_signature_compat(true)
 157       .url_verifier(Box::new(VerifyUrlData(context.pool().clone())))
 158       .build()
 159       .expect("configure federation");
 160
 161     App::new()
 162       .wrap(middleware::Logger::default())
 163       .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
 164       .app_data(Data::new(context))
 165       .app_data(Data::new(rate_limit_cell.clone()))
 166       .wrap(FederationMiddleware::new(federation_config))
 167       // The routes
 168       .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
 169       .configure(|cfg| {
 170         if federation_enabled {
 171           lemmy_apub::http::routes::config(cfg);
 172           webfinger::config(cfg);
 173         }
 174       })
 175       .configure(feeds::config)
 176       .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
 177       .configure(nodeinfo::config)
 178   })
 179   .bind((settings_bind.bind, settings_bind.port))?
 180   .run()
 181   .await?;
 182
 183   Ok(())
 184 }
 185
 186 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
 187   LogTracer::init()?;
 188
 189   let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
 190
 191   let targets = log_description
 192     .trim()
 193     .trim_matches('"')
 194     .parse::<Targets>()?;
 195
 196   let format_layer = tracing_subscriber::fmt::layer().with_filter(targets.clone());
 197
 198   let subscriber = Registry::default()
 199     .with(format_layer)
 200     .with(ErrorLayer::default());
 201
 202   if let Some(_url) = opentelemetry_url {
 203     #[cfg(feature = "console")]
 204     telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
 205     #[cfg(not(feature = "console"))]
 206     tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
 207   } else {
 208     set_global_default(subscriber)?;
 209   }
 210
 211   Ok(())
 212 }