src/lib.rs

   1 pub mod api_routes_http;
   2 pub mod code_migrations;
   3 #[cfg(feature = "prometheus-metrics")]
   4 pub mod prometheus_metrics;
   5 pub mod root_span_builder;
   6 pub mod scheduled_tasks;
   7 #[cfg(feature = "console")]
   8 pub mod telemetry;
   9
  10 use crate::{code_migrations::run_advanced_migrations, root_span_builder::QuieterRootSpanBuilder};
  11 use activitypub_federation::config::{FederationConfig, FederationMiddleware};
  12 use actix_cors::Cors;
  13 use actix_web::{
  14   middleware::{self, ErrorHandlers},
  15   web::Data,
  16   App,
  17   HttpServer,
  18   Result,
  19 };
  20 use lemmy_api_common::{
  21   context::LemmyContext,
  22   lemmy_db_views::structs::SiteView,
  23   request::build_user_agent,
  24   send_activity::MATCH_OUTGOING_ACTIVITIES,
  25   utils::{
  26     check_private_instance_and_federation_enabled,
  27     local_site_rate_limit_to_rate_limit_config,
  28   },
  29 };
  30 use lemmy_apub::{
  31   activities::{handle_outgoing_activities, match_outgoing_activities},
  32   VerifyUrlData,
  33   FEDERATION_HTTP_FETCH_LIMIT,
  34 };
  35 use lemmy_db_schema::{
  36   source::secret::Secret,
  37   utils::{build_db_pool, get_database_url, run_migrations},
  38 };
  39 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
  40 use lemmy_utils::{
  41   error::LemmyError,
  42   rate_limit::RateLimitCell,
  43   response::jsonify_plain_text_errors,
  44   settings::SETTINGS,
  45   SYNCHRONOUS_FEDERATION,
  46 };
  47 use reqwest::Client;
  48 use reqwest_middleware::ClientBuilder;
  49 use reqwest_tracing::TracingMiddleware;
  50 use std::{env, thread, time::Duration};
  51 use tracing::subscriber::set_global_default;
  52 use tracing_actix_web::TracingLogger;
  53 use tracing_error::ErrorLayer;
  54 use tracing_log::LogTracer;
  55 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
  56 use url::Url;
  57 #[cfg(feature = "prometheus-metrics")]
  58 use {
  59   actix_web_prom::PrometheusMetricsBuilder,
  60   prometheus::default_registry,
  61   prometheus_metrics::serve_prometheus,
  62 };
  63
  64 /// Max timeout for http requests
  65 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
  66
  67 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
  68 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
  69   let args: Vec<String> = env::args().collect();
  70
  71   let scheduled_tasks_enabled = args.get(1) != Some(&"--disable-scheduled-tasks".to_string());
  72
  73   let settings = SETTINGS.to_owned();
  74
  75   // Run the DB migrations
  76   let db_url = get_database_url(Some(&settings));
  77   run_migrations(&db_url);
  78
  79   // Set up the connection pool
  80   let pool = build_db_pool(&settings).await?;
  81
  82   // Run the Code-required migrations
  83   run_advanced_migrations(&mut (&pool).into(), &settings).await?;
  84
  85   // Initialize the secrets
  86   let secret = Secret::init(&mut (&pool).into())
  87     .await
  88     .expect("Couldn't initialize secrets.");
  89
  90   // Make sure the local site is set up.
  91   let site_view = SiteView::read_local(&mut (&pool).into())
  92     .await
  93     .expect("local site not set up");
  94   let local_site = site_view.local_site;
  95   let federation_enabled = local_site.federation_enabled;
  96
  97   if federation_enabled {
  98     println!("federation enabled, host is {}", &settings.hostname);
  99   }
 100
 101   check_private_instance_and_federation_enabled(&local_site)?;
 102
 103   // Set up the rate limiter
 104   let rate_limit_config =
 105     local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
 106   let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
 107
 108   println!(
 109     "Starting http server at {}:{}",
 110     settings.bind, settings.port
 111   );
 112
 113   let user_agent = build_user_agent(&settings);
 114   let reqwest_client = Client::builder()
 115     .user_agent(user_agent.clone())
 116     .timeout(REQWEST_TIMEOUT)
 117     .connect_timeout(REQWEST_TIMEOUT)
 118     .build()?;
 119
 120   let client = ClientBuilder::new(reqwest_client.clone())
 121     .with(TracingMiddleware::default())
 122     .build();
 123
 124   // Pictrs cannot use the retry middleware
 125   let pictrs_client = ClientBuilder::new(reqwest_client.clone())
 126     .with(TracingMiddleware::default())
 127     .build();
 128
 129   let context = LemmyContext::create(
 130     pool.clone(),
 131     client.clone(),
 132     secret.clone(),
 133     rate_limit_cell.clone(),
 134   );
 135
 136   if scheduled_tasks_enabled {
 137     // Schedules various cleanup tasks for the DB
 138     thread::spawn({
 139       let context = context.clone();
 140       move || {
 141         scheduled_tasks::setup(db_url, user_agent, context)
 142           .expect("Couldn't set up scheduled_tasks");
 143       }
 144     });
 145   }
 146
 147   #[cfg(feature = "prometheus-metrics")]
 148   serve_prometheus(settings.prometheus.as_ref(), context.clone());
 149
 150   let settings_bind = settings.clone();
 151
 152   let federation_config = FederationConfig::builder()
 153     .domain(settings.hostname.clone())
 154     .app_data(context.clone())
 155     .client(client.clone())
 156     .http_fetch_limit(FEDERATION_HTTP_FETCH_LIMIT)
 157     .worker_count(settings.worker_count)
 158     .retry_count(settings.retry_count)
 159     .debug(*SYNCHRONOUS_FEDERATION)
 160     .http_signature_compat(true)
 161     .url_verifier(Box::new(VerifyUrlData(context.inner_pool().clone())))
 162     .build()
 163     .await?;
 164
 165   // this must come before the HttpServer creation
 166   // creates a middleware that populates http metrics for each path, method, and status code
 167   #[cfg(feature = "prometheus-metrics")]
 168   let prom_api_metrics = PrometheusMetricsBuilder::new("lemmy_api")
 169     .registry(default_registry().clone())
 170     .build()
 171     .expect("Should always be buildable");
 172
 173   MATCH_OUTGOING_ACTIVITIES
 174     .set(Box::new(move |d, c| {
 175       Box::pin(match_outgoing_activities(d, c))
 176     }))
 177     .expect("set function pointer");
 178   let request_data = federation_config.to_request_data();
 179   let outgoing_activities_task = tokio::task::spawn(handle_outgoing_activities(request_data));
 180
 181   // Create Http server with websocket support
 182   HttpServer::new(move || {
 183     let cors_origin = env::var("LEMMY_CORS_ORIGIN");
 184     let cors_config = match (cors_origin, cfg!(debug_assertions)) {
 185       (Ok(origin), false) => Cors::default()
 186         .allowed_origin(&origin)
 187         .allowed_origin(&settings.get_protocol_and_hostname()),
 188       _ => Cors::default()
 189         .allow_any_origin()
 190         .allow_any_method()
 191         .allow_any_header()
 192         .expose_any_header()
 193         .max_age(3600),
 194     };
 195
 196     let app = App::new()
 197       .wrap(middleware::Logger::new(
 198         // This is the default log format save for the usage of %{r}a over %a to guarantee to record the client's (forwarded) IP and not the last peer address, since the latter is frequently just a reverse proxy
 199         "%{r}a '%r' %s %b '%{Referer}i' '%{User-Agent}i' %T",
 200       ))
 201       .wrap(middleware::Compress::default())
 202       .wrap(cors_config)
 203       .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
 204       .wrap(ErrorHandlers::new().default_handler(jsonify_plain_text_errors))
 205       .app_data(Data::new(context.clone()))
 206       .app_data(Data::new(rate_limit_cell.clone()))
 207       .wrap(FederationMiddleware::new(federation_config.clone()));
 208
 209     #[cfg(feature = "prometheus-metrics")]
 210     let app = app.wrap(prom_api_metrics.clone());
 211
 212     // The routes
 213     app
 214       .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
 215       .configure(|cfg| {
 216         if federation_enabled {
 217           lemmy_apub::http::routes::config(cfg);
 218           webfinger::config(cfg);
 219         }
 220       })
 221       .configure(feeds::config)
 222       .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
 223       .configure(nodeinfo::config)
 224   })
 225   .bind((settings_bind.bind, settings_bind.port))?
 226   .run()
 227   .await?;
 228
 229   // Wait for outgoing apub sends to complete
 230   outgoing_activities_task.await??;
 231
 232   Ok(())
 233 }
 234
 235 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
 236   LogTracer::init()?;
 237
 238   let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
 239
 240   let targets = log_description
 241     .trim()
 242     .trim_matches('"')
 243     .parse::<Targets>()?;
 244
 245   let format_layer = {
 246     #[cfg(feature = "json-log")]
 247     let layer = tracing_subscriber::fmt::layer().json();
 248     #[cfg(not(feature = "json-log"))]
 249     let layer = tracing_subscriber::fmt::layer();
 250
 251     layer.with_filter(targets.clone())
 252   };
 253
 254   let subscriber = Registry::default()
 255     .with(format_layer)
 256     .with(ErrorLayer::default());
 257
 258   if let Some(_url) = opentelemetry_url {
 259     #[cfg(feature = "console")]
 260     telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
 261     #[cfg(not(feature = "console"))]
 262     tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
 263   } else {
 264     set_global_default(subscriber)?;
 265   }
 266
 267   Ok(())
 268 }