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_tracing::TracingMiddleware;
  38 use std::{env, 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     .connect_timeout(REQWEST_TIMEOUT)
 113     .build()?;
 114
 115   let client = ClientBuilder::new(reqwest_client.clone())
 116     .with(TracingMiddleware::default())
 117     .build();
 118
 119   // Pictrs cannot use the retry middleware
 120   let pictrs_client = ClientBuilder::new(reqwest_client.clone())
 121     .with(TracingMiddleware::default())
 122     .build();
 123
 124   // Schedules various cleanup tasks for the DB
 125   thread::spawn(move || {
 126     scheduled_tasks::setup(db_url, user_agent).expect("Couldn't set up scheduled_tasks");
 127   });
 128
 129   let chat_server = ChatServer::default().start();
 130
 131   // Create Http server with websocket support
 132   let settings_bind = settings.clone();
 133   HttpServer::new(move || {
 134     let context = LemmyContext::create(
 135       pool.clone(),
 136       chat_server.clone(),
 137       client.clone(),
 138       secret.clone(),
 139       rate_limit_cell.clone(),
 140     );
 141
 142     let federation_config = FederationConfig::builder()
 143       .domain(settings.hostname.clone())
 144       .app_data(context.clone())
 145       .client(client.clone())
 146       .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
 147       .worker_count(local_site.federation_worker_count as u64)
 148       .debug(cfg!(debug_assertions))
 149       .http_signature_compat(true)
 150       .url_verifier(Box::new(VerifyUrlData(context.pool().clone())))
 151       .build()
 152       .expect("configure federation");
 153
 154     App::new()
 155       .wrap(middleware::Logger::default())
 156       .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
 157       .app_data(Data::new(context))
 158       .app_data(Data::new(rate_limit_cell.clone()))
 159       .wrap(FederationMiddleware::new(federation_config))
 160       // The routes
 161       .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
 162       .configure(|cfg| {
 163         if federation_enabled {
 164           lemmy_apub::http::routes::config(cfg);
 165           webfinger::config(cfg);
 166         }
 167       })
 168       .configure(feeds::config)
 169       .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
 170       .configure(nodeinfo::config)
 171   })
 172   .bind((settings_bind.bind, settings_bind.port))?
 173   .run()
 174   .await?;
 175
 176   Ok(())
 177 }
 178
 179 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
 180   LogTracer::init()?;
 181
 182   let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
 183
 184   let targets = log_description
 185     .trim()
 186     .trim_matches('"')
 187     .parse::<Targets>()?;
 188
 189   let format_layer = tracing_subscriber::fmt::layer().with_filter(targets.clone());
 190
 191   let subscriber = Registry::default()
 192     .with(format_layer)
 193     .with(ErrorLayer::default());
 194
 195   if let Some(_url) = opentelemetry_url {
 196     #[cfg(feature = "console")]
 197     telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
 198     #[cfg(not(feature = "console"))]
 199     tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
 200   } else {
 201     set_global_default(subscriber)?;
 202   }
 203
 204   Ok(())
 205 }