use std::{collections::HashSet, marker::PhantomData, net::SocketAddr, str::FromStr, sync::Arc}; use anyhow::Context; use buffers::ByteBufOwned; use dht::{DhtStats, Id20}; use http::StatusCode; use librqbit_core::torrent_metainfo::{FileDetailsAttrs, TorrentMetaV1Info}; use serde::{Deserialize, Serialize}; use tokio::sync::mpsc::UnboundedSender; use tracing::warn; use crate::{ api_error::{ApiError, ApiErrorExt}, session::{ AddTorrent, AddTorrentOptions, AddTorrentResponse, ListOnlyResponse, Session, TorrentId, }, session_stats::snapshot::SessionStatsSnapshot, torrent_state::{ peer::stats::snapshot::{PeerStatsFilter, PeerStatsSnapshot}, FileStream, ManagedTorrentHandle, }, }; #[cfg(feature = "tracing-subscriber-utils")] use crate::tracing_subscriber_config_utils::LineBroadcast; #[cfg(feature = "tracing-subscriber-utils")] use futures::Stream; #[cfg(feature = "tracing-subscriber-utils")] use tokio_stream::wrappers::{errors::BroadcastStreamRecvError, BroadcastStream}; pub use crate::torrent_state::stats::{LiveStats, TorrentStats}; pub type Result = std::result::Result; /// Library API for use in different web frameworks. /// Contains all methods you might want to expose with (de)serializable inputs/outputs. #[derive(Clone)] pub struct Api { session: Arc, rust_log_reload_tx: Option>, #[cfg(feature = "tracing-subscriber-utils")] line_broadcast: Option, } #[derive(Debug, Clone, Copy)] pub enum TorrentIdOrHash { Id(TorrentId), Hash(Id20), } impl Serialize for TorrentIdOrHash { fn serialize(&self, serializer: S) -> std::result::Result where S: serde::Serializer, { match self { TorrentIdOrHash::Id(id) => id.serialize(serializer), TorrentIdOrHash::Hash(h) => h.as_string().serialize(serializer), } } } impl<'de> Deserialize<'de> for TorrentIdOrHash { fn deserialize(deserializer: D) -> std::result::Result where D: serde::Deserializer<'de>, { #[derive(Default)] struct V<'de> { p: PhantomData<&'de ()>, } macro_rules! visit_int { ($v:expr) => {{ let tid: TorrentId = $v.try_into().map_err(|e| E::custom(format!("{e:#}")))?; Ok(TorrentIdOrHash::from(tid)) }}; } impl<'de> serde::de::Visitor<'de> for V<'de> { type Value = TorrentIdOrHash; fn expecting(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { f.write_str("integer or 40 byte info hash") } fn visit_i64(self, v: i64) -> std::result::Result where E: serde::de::Error, { visit_int!(v) } fn visit_i128(self, v: i128) -> std::result::Result where E: serde::de::Error, { visit_int!(v) } fn visit_u128(self, v: u128) -> std::result::Result where E: serde::de::Error, { visit_int!(v) } fn visit_u64(self, v: u64) -> std::result::Result where E: serde::de::Error, { visit_int!(v) } fn visit_str(self, v: &str) -> std::result::Result where E: serde::de::Error, { TorrentIdOrHash::parse(v).map_err(|e| { E::custom(format!( "expected integer or 40 byte info hash, couldn't parse string: {e:#}" )) }) } } deserializer.deserialize_any(V::default()) } } impl std::fmt::Display for TorrentIdOrHash { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { TorrentIdOrHash::Id(id) => write!(f, "{}", id), TorrentIdOrHash::Hash(h) => write!(f, "{:?}", h), } } } impl From for TorrentIdOrHash { fn from(value: TorrentId) -> Self { TorrentIdOrHash::Id(value) } } impl From for TorrentIdOrHash { fn from(value: Id20) -> Self { TorrentIdOrHash::Hash(value) } } impl<'a> TryFrom<&'a str> for TorrentIdOrHash { type Error = anyhow::Error; fn try_from(value: &'a str) -> std::result::Result { Self::parse(value) } } impl TorrentIdOrHash { pub fn parse(s: &str) -> anyhow::Result { if s.len() == 40 { let id = Id20::from_str(s)?; return Ok(id.into()); } let id: TorrentId = s.parse()?; Ok(id.into()) } } #[derive(Deserialize, Default)] pub struct ApiTorrentListOpts { #[serde(default)] pub with_stats: bool, } impl Api { pub fn new( session: Arc, rust_log_reload_tx: Option>, #[cfg(feature = "tracing-subscriber-utils")] line_broadcast: Option, ) -> Self { Self { session, rust_log_reload_tx, #[cfg(feature = "tracing-subscriber-utils")] line_broadcast, } } pub fn session(&self) -> &Arc { &self.session } pub fn mgr_handle(&self, idx: TorrentIdOrHash) -> Result { self.session .get(idx) .ok_or(ApiError::torrent_not_found(idx)) } pub fn api_torrent_list(&self) -> TorrentListResponse { self.api_torrent_list_ext(ApiTorrentListOpts { with_stats: false }) } pub fn api_torrent_list_ext(&self, opts: ApiTorrentListOpts) -> TorrentListResponse { let items = self.session.with_torrents(|torrents| { torrents .map(|(id, mgr)| { let mut r = TorrentDetailsResponse { id: Some(id), info_hash: mgr.shared().info_hash.as_string(), name: mgr.name(), output_folder: mgr .shared() .options .output_folder .to_string_lossy() .into_owned(), // These will be filled in /details and /stats endpoints files: None, stats: None, }; if opts.with_stats { r.stats = Some(mgr.stats()); } r }) .collect() }); TorrentListResponse { torrents: items } } pub fn api_torrent_details(&self, idx: TorrentIdOrHash) -> Result { let handle = self.mgr_handle(idx)?; let info_hash = handle.shared().info_hash; let only_files = handle.only_files(); let output_folder = handle .shared() .options .output_folder .to_string_lossy() .into_owned() .to_string(); make_torrent_details( Some(handle.id()), &info_hash, handle.metadata.load().as_ref().map(|r| &r.info), handle.name().as_deref(), only_files.as_deref(), output_folder, ) } pub fn api_session_stats(&self) -> SessionStatsSnapshot { self.session().stats_snapshot() } pub fn torrent_file_mime_type( &self, idx: TorrentIdOrHash, file_idx: usize, ) -> Result<&'static str> { let handle = self.mgr_handle(idx)?; handle.with_metadata(|r| torrent_file_mime_type(&r.info, file_idx))? } pub fn api_peer_stats( &self, idx: TorrentIdOrHash, filter: PeerStatsFilter, ) -> Result { let handle = self.mgr_handle(idx)?; Ok(handle .live() .context("not live")? .per_peer_stats_snapshot(filter)) } pub async fn api_torrent_action_pause( &self, idx: TorrentIdOrHash, ) -> Result { let handle = self.mgr_handle(idx)?; self.session() .pause(&handle) .await .context("error pausing torrent") .with_error_status_code(StatusCode::BAD_REQUEST)?; Ok(Default::default()) } pub async fn api_torrent_action_start( &self, idx: TorrentIdOrHash, ) -> Result { let handle = self.mgr_handle(idx)?; self.session .unpause(&handle) .await .context("error unpausing torrent") .with_error_status_code(StatusCode::BAD_REQUEST)?; Ok(Default::default()) } pub async fn api_torrent_action_forget( &self, idx: TorrentIdOrHash, ) -> Result { self.session .delete(idx, false) .await .context("error forgetting torrent")?; Ok(Default::default()) } pub async fn api_torrent_action_delete( &self, idx: TorrentIdOrHash, ) -> Result { self.session .delete(idx, true) .await .context("error deleting torrent with files")?; Ok(Default::default()) } pub async fn api_torrent_action_update_only_files( &self, idx: TorrentIdOrHash, only_files: &HashSet, ) -> Result { let handle = self.mgr_handle(idx)?; self.session .update_only_files(&handle, only_files) .await .context("error updating only_files")?; Ok(Default::default()) } pub fn api_set_rust_log(&self, new_value: String) -> Result { let tx = self .rust_log_reload_tx .as_ref() .context("rust_log_reload_tx was not set")?; tx.send(new_value) .context("noone is listening to RUST_LOG changes")?; Ok(Default::default()) } #[cfg(feature = "tracing-subscriber-utils")] pub fn api_log_lines_stream( &self, ) -> Result< impl Stream> + Send + Sync + 'static, > { Ok(self .line_broadcast .as_ref() .map(|sender| BroadcastStream::new(sender.subscribe())) .context("line_rx wasn't set")?) } pub async fn api_add_torrent( &self, add: AddTorrent<'_>, opts: Option, ) -> Result { let response = match self .session .add_torrent(add, opts) .await .context("error adding torrent") .with_error_status_code(StatusCode::BAD_REQUEST)? { AddTorrentResponse::AlreadyManaged(id, handle) => { let details = make_torrent_details( Some(id), &handle.info_hash(), handle.metadata.load().as_ref().map(|r| &r.info), handle.name().as_deref(), handle.only_files().as_deref(), handle .shared() .options .output_folder .to_string_lossy() .into_owned(), ) .context("error making torrent details")?; ApiAddTorrentResponse { id: Some(id), details, seen_peers: None, output_folder: handle .shared() .options .output_folder .to_string_lossy() .into_owned(), } } AddTorrentResponse::ListOnly(ListOnlyResponse { info_hash, info, only_files, seen_peers, output_folder, .. }) => ApiAddTorrentResponse { id: None, output_folder: output_folder.to_string_lossy().into_owned(), seen_peers: Some(seen_peers), details: make_torrent_details( None, &info_hash, Some(&info), None, only_files.as_deref(), output_folder.to_string_lossy().into_owned().to_string(), ) .context("error making torrent details")?, }, AddTorrentResponse::Added(id, handle) => { let details = make_torrent_details( Some(id), &handle.info_hash(), handle.metadata.load().as_ref().map(|r| &r.info), handle.name().as_deref(), handle.only_files().as_deref(), handle .shared() .options .output_folder .to_string_lossy() .into_owned(), ) .context("error making torrent details")?; ApiAddTorrentResponse { id: Some(id), details, seen_peers: None, output_folder: handle .shared() .options .output_folder .to_string_lossy() .into_owned(), } } }; Ok(response) } pub fn api_dht_stats(&self) -> Result { self.session .get_dht() .as_ref() .map(|d| d.stats()) .ok_or(ApiError::dht_disabled()) } pub fn api_dht_table(&self) -> Result { let dht = self.session.get_dht().ok_or(ApiError::dht_disabled())?; Ok(dht.with_routing_table(|r| r.clone())) } pub fn api_stats_v0(&self, idx: TorrentIdOrHash) -> Result { let mgr = self.mgr_handle(idx)?; let live = mgr.live().context("torrent not live")?; Ok(LiveStats::from(&*live)) } pub fn api_stats_v1(&self, idx: TorrentIdOrHash) -> Result { let mgr = self.mgr_handle(idx)?; Ok(mgr.stats()) } pub fn api_dump_haves(&self, idx: TorrentIdOrHash) -> Result { let mgr = self.mgr_handle(idx)?; Ok(mgr.with_chunk_tracker(|chunks| format!("{:?}", chunks.get_have_pieces().as_slice()))?) } pub fn api_stream(&self, idx: TorrentIdOrHash, file_id: usize) -> Result { let mgr = self.mgr_handle(idx)?; Ok(mgr.stream(file_id)?) } } #[derive(Serialize)] pub struct TorrentListResponse { pub torrents: Vec, } #[derive(Serialize, Deserialize)] pub struct TorrentDetailsResponseFile { pub name: String, pub components: Vec, pub length: u64, pub included: bool, pub attributes: FileDetailsAttrs, } #[derive(Default, Serialize)] pub struct EmptyJsonResponse {} #[derive(Serialize, Deserialize)] pub struct TorrentDetailsResponse { #[serde(skip_serializing_if = "Option::is_none")] pub id: Option, pub info_hash: String, pub name: Option, pub output_folder: String, #[serde(skip_serializing_if = "Option::is_none")] pub files: Option>, #[serde(skip_serializing_if = "Option::is_none", skip_deserializing)] pub stats: Option, } #[derive(Serialize, Deserialize)] pub struct ApiAddTorrentResponse { pub id: Option, pub details: TorrentDetailsResponse, pub output_folder: String, pub seen_peers: Option>, } fn make_torrent_details( id: Option, info_hash: &Id20, info: Option<&TorrentMetaV1Info>, name: Option<&str>, only_files: Option<&[usize]>, output_folder: String, ) -> Result { let files = match info { Some(info) => info .iter_file_details() .context("error iterating filenames and lengths")? .enumerate() .map(|(idx, d)| { let name = match d.filename.to_string() { Ok(s) => s, Err(err) => { warn!("error reading filename: {:?}", err); "".to_string() } }; let components = d.filename.to_vec().unwrap_or_default(); let included = only_files.map(|o| o.contains(&idx)).unwrap_or(true); TorrentDetailsResponseFile { name, components, length: d.len, included, attributes: d.attrs(), } }) .collect(), None => Default::default(), }; Ok(TorrentDetailsResponse { id, info_hash: info_hash.as_string(), name: name .map(|s| s.to_owned()) .or_else(|| info.and_then(|i| i.name.as_ref().map(|b| b.to_string()))), files: Some(files), output_folder, stats: None, }) } fn torrent_file_mime_type( info: &TorrentMetaV1Info, file_idx: usize, ) -> Result<&'static str> { info.iter_file_details()? .nth(file_idx) .and_then(|d| { d.filename .iter_components() .last() .and_then(|r| r.ok()) .and_then(|s| mime_guess::from_path(s).first_raw()) }) .ok_or_else(|| { ApiError::new_from_text( StatusCode::INTERNAL_SERVER_ERROR, "cannot determine mime type for file", ) }) }