lemmy/src/routes/nodeinfo.rs

use actix_web::{body::Body, error::ErrorBadRequest, *};
use anyhow::anyhow;
use lemmy_api::version;
use lemmy_db::site_view::SiteView;
use lemmy_structs::blocking;
use lemmy_utils::{settings::Settings, LemmyError};
use lemmy_websocket::LemmyContext;
use serde::{Deserialize, Serialize};
use url::Url;

pub fn config(cfg: &mut web::ServiceConfig) {
  cfg
    .route("/nodeinfo/2.0.json", web::get().to(node_info))
    .route("/.well-known/nodeinfo", web::get().to(node_info_well_known));
}

async fn node_info_well_known() -> Result<HttpResponse<Body>, LemmyError> {
  let node_info = NodeInfoWellKnown {
    links: NodeInfoWellKnownLinks {
      rel: Url::parse("http://nodeinfo.diaspora.software/ns/schema/2.0")?,
      href: Url::parse(&format!(
        "{}/nodeinfo/2.0.json",
        Settings::get().get_protocol_and_hostname()
      ))?,
    },
  };
  Ok(HttpResponse::Ok().json(node_info))
}

async fn node_info(context: web::Data<LemmyContext>) -> Result<HttpResponse, Error> {
  let site_view = blocking(context.pool(), SiteView::read)
    .await?
    .map_err(|_| ErrorBadRequest(LemmyError::from(anyhow!("not_found"))))?;

  let protocols = if Settings::get().federation.enabled {
    vec!["activitypub".to_string()]
  } else {
    vec![]
  };

  let json = NodeInfo {
    version: "2.0".to_string(),
    software: NodeInfoSoftware {
      name: "lemmy".to_string(),
      version: version::VERSION.to_string(),
    },
    protocols,
    usage: NodeInfoUsage {
      users: NodeInfoUsers {
        total: site_view.number_of_users,
      },
      local_posts: site_view.number_of_posts,
      local_comments: site_view.number_of_comments,
      open_registrations: site_view.open_registration,
    },
  };

  Ok(HttpResponse::Ok().json(json))
}

#[derive(Serialize, Deserialize, Debug)]
struct NodeInfoWellKnown {
  pub links: NodeInfoWellKnownLinks,
}

#[derive(Serialize, Deserialize, Debug)]
struct NodeInfoWellKnownLinks {
  pub rel: Url,
  pub href: Url,
}

#[derive(Serialize, Deserialize, Debug)]
struct NodeInfo {
  pub version: String,
  pub software: NodeInfoSoftware,
  pub protocols: Vec<String>,
  pub usage: NodeInfoUsage,
}

#[derive(Serialize, Deserialize, Debug)]
struct NodeInfoSoftware {
  pub name: String,
  pub version: String,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
struct NodeInfoUsage {
  pub users: NodeInfoUsers,
  pub local_posts: i64,
  pub local_comments: i64,
  pub open_registrations: bool,
}

#[derive(Serialize, Deserialize, Debug)]
struct NodeInfoUsers {
  pub total: i64,
}
Rework imports 2020-05-16 14:04:08 +00:00			`use actix_web::{body::Body, error::ErrorBadRequest, *};`
Migrate from failure to anyhow and thiserror (#1042) * Migrate from failure to anyhow and thiserror * Replace 'format_err!' to 'anyhow!' 2020-08-01 14:04:42 +00:00			`use anyhow::anyhow;`
Move websocket code into workspace (#107) Adjust dockerfiles, fix cargo.toml and remove unused deps Merge branch 'main' into move-websocket-to-workspace Move api code into workspace Move apub to separate workspace Move websocket code into separate workspace Some code cleanup Remove websocket dependency on API Co-authored-by: Felix Ableitner <me@nutomic.com> Reviewed-on: https://yerbamate.dev/LemmyNet/lemmy/pulls/107 2020-09-24 13:53:21 +00:00			`use lemmy_api::version;`
Split code into cargo workspaces (#67) More fixes - fixed docker builds - fixed mentions regex test - fixed DATABASE_URL stuff - change schema path in diesel.toml Address review comments - add jsonb column back into activity table - remove authors field from cargo.toml - adjust LEMMY_DATABASE_URL env var usage - rename all occurences of LEMMY_DATABASE_URL to DATABASE_URL Decouple utils and db Split code into cargo workspaces Co-authored-by: Felix Ableitner <me@nutomic.com> Reviewed-on: https://yerbamate.dev/LemmyNet/lemmy/pulls/67 2020-07-10 18:15:41 +00:00			`use lemmy_db::site_view::SiteView;`
Running cargo fmt. 2020-09-16 13:31:30 +00:00			`use lemmy_structs::blocking;`
Remove hardcoded usage of https (fixes #1126) 2020-09-25 15:33:00 +00:00			`use lemmy_utils::{settings::Settings, LemmyError};`
Move websocket code into workspace (#107) Adjust dockerfiles, fix cargo.toml and remove unused deps Merge branch 'main' into move-websocket-to-workspace Move api code into workspace Move apub to separate workspace Move websocket code into separate workspace Some code cleanup Remove websocket dependency on API Co-authored-by: Felix Ableitner <me@nutomic.com> Reviewed-on: https://yerbamate.dev/LemmyNet/lemmy/pulls/107 2020-09-24 13:53:21 +00:00			`use lemmy_websocket::LemmyContext;`
Rework imports 2020-05-16 14:04:08 +00:00			`use serde::{Deserialize, Serialize};`
			`use url::Url;`
got it working 2019-11-15 02:08:25 +00:00
Use actix config to handle routes in seperate folders (#378) 2019-12-31 12:55:33 +00:00			`pub fn config(cfg: &mut web::ServiceConfig) {`
			`cfg`
			`.route("/nodeinfo/2.0.json", web::get().to(node_info))`
			`.route("/.well-known/nodeinfo", web::get().to(node_info_well_known));`
			`}`

Federation async (#848) * Asyncify more * I guess these changed * Clean PR a bit * Convert more away from failure error * config changes for testing federation * It was DNS So actix-web's client relies on TRust DNS Resolver to figure out where to send data, but TRust DNS Resolver seems to not play nice with docker, which expressed itself as not resolving the name to an IP address _the first time_ when making a request. The fix was literally to make the request again (which I limited to 3 times total, and not exceeding the request timeout in total) * Only retry for connecterror Since TRust DNS Resolver was causing ConnectError::Timeout, this change limits the retry to only this error, returning immediately for any other error * Use http sig norm 0.4.0-alpha for actix-web 3.0 support * Blocking function, retry http requests * cargo +nightly fmt * Only create one pictrs dir * Don't yarn build * cargo +nightly fmt 2020-07-01 12:54:29 +00:00			`async fn node_info_well_known() -> Result<HttpResponse<Body>, LemmyError> {`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`let node_info = NodeInfoWellKnown {`
			`links: NodeInfoWellKnownLinks {`
Use Url instead of String 2020-04-08 12:37:05 +00:00			`rel: Url::parse("http://nodeinfo.diaspora.software/ns/schema/2.0")?,`
			`href: Url::parse(&format!(`
Remove hardcoded usage of https (fixes #1126) 2020-09-25 15:33:00 +00:00			`"{}/nodeinfo/2.0.json",`
			`Settings::get().get_protocol_and_hostname()`
Use Url instead of String 2020-04-08 12:37:05 +00:00			`))?,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`},`
			`};`
Use Url instead of String 2020-04-08 12:37:05 +00:00			`Ok(HttpResponse::Ok().json(node_info))`
got it working 2019-11-15 02:08:25 +00:00			`}`

Implement context (#86) Implement context Co-authored-by: Felix Ableitner <me@nutomic.com> Reviewed-on: https://yerbamate.dev/LemmyNet/lemmy/pulls/86 2020-08-18 13:43:50 +00:00			`async fn node_info(context: web::Data<LemmyContext>) -> Result<HttpResponse, Error> {`
			`let site_view = blocking(context.pool(), SiteView::read)`
Federation async (#848) * Asyncify more * I guess these changed * Clean PR a bit * Convert more away from failure error * config changes for testing federation * It was DNS So actix-web's client relies on TRust DNS Resolver to figure out where to send data, but TRust DNS Resolver seems to not play nice with docker, which expressed itself as not resolving the name to an IP address _the first time_ when making a request. The fix was literally to make the request again (which I limited to 3 times total, and not exceeding the request timeout in total) * Only retry for connecterror Since TRust DNS Resolver was causing ConnectError::Timeout, this change limits the retry to only this error, returning immediately for any other error * Use http sig norm 0.4.0-alpha for actix-web 3.0 support * Blocking function, retry http requests * cargo +nightly fmt * Only create one pictrs dir * Don't yarn build * cargo +nightly fmt 2020-07-01 12:54:29 +00:00			`.await?`
Migrate from failure to anyhow and thiserror (#1042) * Migrate from failure to anyhow and thiserror * Replace 'format_err!' to 'anyhow!' 2020-08-01 14:04:42 +00:00			`.map_err(\|_\| ErrorBadRequest(LemmyError::from(anyhow!("not_found"))))?;`
Federation async (#848) * Asyncify more * I guess these changed * Clean PR a bit * Convert more away from failure error * config changes for testing federation * It was DNS So actix-web's client relies on TRust DNS Resolver to figure out where to send data, but TRust DNS Resolver seems to not play nice with docker, which expressed itself as not resolving the name to an IP address _the first time_ when making a request. The fix was literally to make the request again (which I limited to 3 times total, and not exceeding the request timeout in total) * Only retry for connecterror Since TRust DNS Resolver was causing ConnectError::Timeout, this change limits the retry to only this error, returning immediately for any other error * Use http sig norm 0.4.0-alpha for actix-web 3.0 support * Blocking function, retry http requests * cargo +nightly fmt * Only create one pictrs dir * Don't yarn build * cargo +nightly fmt 2020-07-01 12:54:29 +00:00
			`let protocols = if Settings::get().federation.enabled {`
			`vec!["activitypub".to_string()]`
			`} else {`
			`vec![]`
			`};`

			`let json = NodeInfo {`
			`version: "2.0".to_string(),`
			`software: NodeInfoSoftware {`
			`name: "lemmy".to_string(),`
			`version: version::VERSION.to_string(),`
			`},`
			`protocols,`
			`usage: NodeInfoUsage {`
			`users: NodeInfoUsers {`
			`total: site_view.number_of_users,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`},`
Federation async (#848) * Asyncify more * I guess these changed * Clean PR a bit * Convert more away from failure error * config changes for testing federation * It was DNS So actix-web's client relies on TRust DNS Resolver to figure out where to send data, but TRust DNS Resolver seems to not play nice with docker, which expressed itself as not resolving the name to an IP address _the first time_ when making a request. The fix was literally to make the request again (which I limited to 3 times total, and not exceeding the request timeout in total) * Only retry for connecterror Since TRust DNS Resolver was causing ConnectError::Timeout, this change limits the retry to only this error, returning immediately for any other error * Use http sig norm 0.4.0-alpha for actix-web 3.0 support * Blocking function, retry http requests * cargo +nightly fmt * Only create one pictrs dir * Don't yarn build * cargo +nightly fmt 2020-07-01 12:54:29 +00:00			`local_posts: site_view.number_of_posts,`
			`local_comments: site_view.number_of_comments,`
			`open_registrations: site_view.open_registration,`
			`},`
			`};`

			`Ok(HttpResponse::Ok().json(json))`
got it working 2019-11-15 02:08:25 +00:00			`}`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfoWellKnown {`
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`pub links: NodeInfoWellKnownLinks,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`

Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfoWellKnownLinks {`
Use Url instead of String 2020-04-08 12:37:05 +00:00			`pub rel: Url,`
			`pub href: Url,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`

Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfo {`
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`pub version: String,`
			`pub software: NodeInfoSoftware,`
			`pub protocols: Vec<String>,`
			`pub usage: NodeInfoUsage,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`

Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfoSoftware {`
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`pub name: String,`
			`pub version: String,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`

Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`#[serde(rename_all = "camelCase")]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfoUsage {`
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`pub users: NodeInfoUsers,`
			`pub local_posts: i64,`
			`pub local_comments: i64,`
			`pub open_registrations: bool,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`

Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`#[derive(Serialize, Deserialize, Debug)]`
Reduce visibility of some structs and methods (replaces #1266) 2020-11-16 15:44:04 +00:00			`struct NodeInfoUsers {`
Read remote nodeinfo before doing anything 2020-03-18 15:08:08 +00:00			`pub total: i64,`
Use actual structs for nodeinfo 2020-01-19 11:32:02 +00:00			`}`