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