src/lib.rs

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