use std::{ borrow::Cow, collections::{HashMap, HashSet}, io::Read, net::SocketAddr, path::{Path, PathBuf}, sync::{atomic::AtomicUsize, Arc}, time::Duration, }; use crate::{ api::TorrentIdOrHash, bitv_factory::{BitVFactory, NonPersistentBitVFactory}, dht_utils::{read_metainfo_from_peer_receiver, ReadMetainfoResult}, limits::{Limits, LimitsConfig}, merge_streams::merge_streams, peer_connection::PeerConnectionOptions, read_buf::ReadBuf, session_persistence::{json::JsonSessionPersistenceStore, SessionPersistenceStore}, session_stats::SessionStats, spawn_utils::BlockingSpawner, storage::{ filesystem::FilesystemStorageFactory, BoxStorageFactory, StorageFactoryExt, TorrentStorage, }, stream_connect::{SocksProxyConfig, StreamConnector}, torrent_state::{ initializing::TorrentStateInitializing, ManagedTorrentHandle, ManagedTorrentLocked, ManagedTorrentOptions, ManagedTorrentState, TorrentMetadata, TorrentStateLive, }, type_aliases::{DiskWorkQueueSender, PeerStream}, FileInfos, ManagedTorrent, ManagedTorrentShared, }; use anyhow::{bail, Context}; use arc_swap::ArcSwapOption; use bencode::bencode_serialize_to_writer; use buffers::{ByteBuf, ByteBufOwned, ByteBufT}; use bytes::Bytes; use clone_to_owned::CloneToOwned; use dht::{Dht, DhtBuilder, DhtConfig, Id20, PersistentDht, PersistentDhtConfig}; use futures::{ future::BoxFuture, stream::{BoxStream, FuturesUnordered}, FutureExt, Stream, StreamExt, TryFutureExt, }; use itertools::Itertools; use librqbit_core::{ constants::CHUNK_SIZE, directories::get_configuration_directory, magnet::Magnet, peer_id::generate_peer_id, spawn_utils::spawn_with_cancel, torrent_metainfo::{TorrentMetaV1Info, TorrentMetaV1Owned}, }; use parking_lot::RwLock; use peer_binary_protocol::Handshake; use serde::{Deserialize, Serialize}; use tokio::{ net::{TcpListener, TcpStream}, sync::Notify, }; use tokio_util::sync::{CancellationToken, DropGuard}; use tracing::{debug, error, error_span, info, trace, warn, Instrument, Span}; use tracker_comms::TrackerComms; pub const SUPPORTED_SCHEMES: [&str; 3] = ["http:", "https:", "magnet:"]; pub type TorrentId = usize; struct ParsedTorrentFile { info: TorrentMetaV1Owned, info_bytes: Bytes, torrent_bytes: Bytes, } fn torrent_from_bytes(bytes: Bytes) -> anyhow::Result { trace!( "all fields in torrent: {:#?}", bencode::dyn_from_bytes::(&bytes) ); let parsed = librqbit_core::torrent_metainfo::torrent_from_bytes_ext::(&bytes)?; Ok(ParsedTorrentFile { info: parsed.meta.clone_to_owned(Some(&bytes)), info_bytes: parsed.info_bytes.clone_to_owned(Some(&bytes)).0, torrent_bytes: bytes, }) } #[derive(Default)] pub struct SessionDatabase { torrents: HashMap, } impl SessionDatabase { fn add_torrent(&mut self, torrent: ManagedTorrentHandle, id: TorrentId) { self.torrents.insert(id, torrent); } } pub struct Session { // Core state and services pub(crate) db: RwLock, next_id: AtomicUsize, pub(crate) bitv_factory: Arc, spawner: BlockingSpawner, // Network peer_id: Id20, tcp_listen_port: Option, dht: Option, pub(crate) connector: Arc, reqwest_client: reqwest::Client, // Lifecycle management cancellation_token: CancellationToken, _cancellation_token_drop_guard: DropGuard, // Runtime settings output_folder: PathBuf, peer_opts: PeerConnectionOptions, default_storage_factory: Option, persistence: Option>, disk_write_tx: Option, // Limits and throttling pub(crate) concurrent_initialize_semaphore: Arc, pub(crate) ratelimits: Limits, // Monitoring / tracing / logging pub(crate) stats: SessionStats, root_span: Option, // Feature flags #[cfg(feature = "disable-upload")] _disable_upload: bool, } async fn torrent_from_url( reqwest_client: &reqwest::Client, url: &str, ) -> anyhow::Result { let response = reqwest_client .get(url) .send() .await .context("error downloading torrent metadata")?; if !response.status().is_success() { bail!("GET {} returned {}", url, response.status()) } let b = response .bytes() .await .with_context(|| format!("error reading response body from {url}"))?; torrent_from_bytes(b).context("error decoding torrent") } fn compute_only_files_regex>( torrent: &TorrentMetaV1Info, filename_re: &str, ) -> anyhow::Result> { let filename_re = regex::Regex::new(filename_re).context("filename regex is incorrect")?; let mut only_files = Vec::new(); for (idx, fd) in torrent.iter_file_details()?.enumerate() { let full_path = fd .filename .to_pathbuf() .with_context(|| format!("filename of file {idx} is not valid utf8"))?; if filename_re.is_match(full_path.to_str().unwrap()) { only_files.push(idx); } } if only_files.is_empty() { bail!("none of the filenames match the given regex") } Ok(only_files) } fn compute_only_files( info: &TorrentMetaV1Info, only_files: Option>, only_files_regex: Option, list_only: bool, ) -> anyhow::Result>> { match (only_files, only_files_regex) { (Some(_), Some(_)) => { bail!("only_files and only_files_regex are mutually exclusive"); } (Some(only_files), None) => { let total_files = info.iter_file_lengths()?.count(); for id in only_files.iter().copied() { if id >= total_files { bail!("file id {} is out of range", id); } } Ok(Some(only_files)) } (None, Some(filename_re)) => { let only_files = compute_only_files_regex(info, &filename_re)?; for (idx, fd) in info.iter_file_details()?.enumerate() { if !only_files.contains(&idx) { continue; } if !list_only { info!(filename=?fd.filename, "will download"); } } Ok(Some(only_files)) } (None, None) => Ok(None), } } fn merge_two_optional_streams( s1: Option + Unpin + Send + 'static>, s2: Option + Unpin + Send + 'static>, ) -> Option> { match (s1, s2) { (Some(s1), None) => Some(Box::pin(s1)), (None, Some(s2)) => Some(Box::pin(s2)), (Some(s1), Some(s2)) => Some(Box::pin(merge_streams(s1, s2))), (None, None) => None, } } /// Options for adding new torrents to the session. // // Serialize/deserialize is for Tauri. #[derive(Default, Serialize, Deserialize)] pub struct AddTorrentOptions { /// Start in paused state. #[serde(default)] pub paused: bool, /// A regex to only download files matching it. pub only_files_regex: Option, /// An explicit list of file IDs to download. /// To see the file indices, run with "list_only". pub only_files: Option>, /// Allow writing on top of existing files, including when resuming a torrent. /// You probably want to set it, however for safety it's not default. #[serde(default)] pub overwrite: bool, /// Only list the files in the torrent without starting it. #[serde(default)] pub list_only: bool, /// The output folder for the torrent. If not set, the session's default one will be used. pub output_folder: Option, /// Sub-folder within session's default output folder. Will error if "output_folder" if also set. /// By default, multi-torrent files are downloaded to a sub-folder. pub sub_folder: Option, /// Peer connection options, timeouts etc. If not set, session's defaults will be used. pub peer_opts: Option, /// Force a refresh interval for polling trackers. pub force_tracker_interval: Option, #[serde(default)] pub disable_trackers: bool, #[serde(default)] pub ratelimits: LimitsConfig, /// Initial peers to start of with. pub initial_peers: Option>, /// This is used to restore the session from serialized state. pub preferred_id: Option, #[serde(skip)] pub storage_factory: Option, // If true, will write to disk in separate threads. The downside is additional allocations. // May be useful if the disk is slow. pub defer_writes: Option, // Custom trackers pub trackers: Option>, } pub struct ListOnlyResponse { pub info_hash: Id20, pub info: TorrentMetaV1Info, pub only_files: Option>, pub output_folder: PathBuf, pub seen_peers: Vec, pub torrent_bytes: Bytes, } #[allow(clippy::large_enum_variant)] pub enum AddTorrentResponse { AlreadyManaged(TorrentId, ManagedTorrentHandle), ListOnly(ListOnlyResponse), Added(TorrentId, ManagedTorrentHandle), } impl AddTorrentResponse { pub fn into_handle(self) -> Option { match self { Self::AlreadyManaged(_, handle) => Some(handle), Self::ListOnly(_) => None, Self::Added(_, handle) => Some(handle), } } } pub fn read_local_file_including_stdin(filename: &str) -> anyhow::Result> { let mut buf = Vec::new(); if filename == "-" { std::io::stdin() .read_to_end(&mut buf) .context("error reading stdin")?; } else { std::fs::File::open(filename) .context("error opening")? .read_to_end(&mut buf) .context("error reading")?; } Ok(buf) } pub enum AddTorrent<'a> { Url(Cow<'a, str>), TorrentFileBytes(Bytes), } impl<'a> AddTorrent<'a> { // Don't call this from HTTP API. #[inline(never)] pub fn from_cli_argument(path: &'a str) -> anyhow::Result { if SUPPORTED_SCHEMES.iter().any(|s| path.starts_with(s)) { return Ok(Self::Url(Cow::Borrowed(path))); } if path.len() == 40 && !Path::new(path).exists() && Magnet::parse(path).is_ok() { return Ok(Self::Url(Cow::Borrowed(path))); } Self::from_local_filename(path) } pub fn from_url(url: impl Into>) -> Self { Self::Url(url.into()) } pub fn from_bytes(bytes: impl Into) -> Self { Self::TorrentFileBytes(bytes.into()) } // Don't call this from HTTP API. #[inline(never)] pub fn from_local_filename(filename: &str) -> anyhow::Result { let file = read_local_file_including_stdin(filename) .with_context(|| format!("error reading local file {filename:?}"))?; Ok(Self::TorrentFileBytes(file.into())) } pub fn into_bytes(self) -> Bytes { match self { Self::Url(s) => s.into_owned().into_bytes().into(), Self::TorrentFileBytes(b) => b, } } } pub enum SessionPersistenceConfig { /// The filename for persistence. By default uses an OS-specific folder. Json { folder: Option }, #[cfg(feature = "postgres")] Postgres { connection_string: String }, } impl SessionPersistenceConfig { pub fn default_json_persistence_folder() -> anyhow::Result { let dir = get_configuration_directory("session")?; Ok(dir.data_dir().to_owned()) } } #[derive(Default)] pub struct SessionOptions { /// Turn on to disable DHT. pub disable_dht: bool, /// Turn on to disable DHT persistence. By default it will re-use stored DHT /// configuration, including the port it listens on. pub disable_dht_persistence: bool, /// Pass in to configure DHT persistence filename. This can be used to run multiple /// librqbit instances at a time. pub dht_config: Option, /// Enable fastresume, to restore state quickly after restart. pub fastresume: bool, /// Turn on to dump session contents into a file periodically, so that on next start /// all remembered torrents will continue where they left off. pub persistence: Option, /// The peer ID to use. If not specified, a random one will be generated. pub peer_id: Option, /// Configure default peer connection options. Can be overriden per torrent. pub peer_opts: Option, pub listen_port_range: Option>, pub enable_upnp_port_forwarding: bool, // If you set this to something, all writes to disk will happen in background and be // buffered in memory up to approximately the given number of megabytes. pub defer_writes_up_to: Option, pub default_storage_factory: Option, // socks5://[username:password@]host:port pub socks_proxy_url: Option, pub cancellation_token: Option, // how many concurrent torrent initializations can happen pub concurrent_init_limit: Option, // the root span to use. If not set will be None. pub root_span: Option, pub ratelimits: LimitsConfig, #[cfg(feature = "disable-upload")] pub disable_upload: bool, } async fn create_tcp_listener( port_range: std::ops::Range, ) -> anyhow::Result<(TcpListener, u16)> { for port in port_range.clone() { match TcpListener::bind(("0.0.0.0", port)).await { Ok(l) => return Ok((l, port)), Err(e) => { debug!("error listening on port {port}: {e:#}") } } } bail!("no free TCP ports in range {port_range:?}"); } fn torrent_file_from_info_bytes(info_bytes: &[u8], trackers: &[String]) -> anyhow::Result { #[derive(Serialize)] struct Tmp<'a> { announce: &'a str, #[serde(rename = "announce-list")] announce_list: &'a [&'a [String]], info: bencode::raw_value::RawValue<&'a [u8]>, } let mut w = Vec::new(); let v = Tmp { info: bencode::raw_value::RawValue(info_bytes), announce: trackers.first().map(|s| s.as_str()).unwrap_or(""), announce_list: &[trackers], }; bencode_serialize_to_writer(&v, &mut w)?; Ok(w.into()) } pub(crate) struct CheckedIncomingConnection { pub addr: SocketAddr, pub stream: tokio::net::TcpStream, pub read_buf: ReadBuf, pub handshake: Handshake, } struct InternalAddResult { info_hash: Id20, metadata: Option, trackers: Vec, name: Option, } impl Session { /// Create a new session with default options. /// The passed in folder will be used as a default unless overriden per torrent. /// It will run a DHT server/client, a TCP listener and . #[inline(never)] pub fn new(default_output_folder: PathBuf) -> BoxFuture<'static, anyhow::Result>> { Self::new_with_opts(default_output_folder, SessionOptions::default()) } pub fn cancellation_token(&self) -> &CancellationToken { &self.cancellation_token } /// Create a new session with options. #[inline(never)] pub fn new_with_opts( default_output_folder: PathBuf, mut opts: SessionOptions, ) -> BoxFuture<'static, anyhow::Result>> { async move { let peer_id = opts.peer_id.unwrap_or_else(generate_peer_id); let token = opts.cancellation_token.take().unwrap_or_default(); #[cfg(feature = "disable-upload")] if opts.disable_upload { warn!("uploading disabled"); } let (tcp_listener, tcp_listen_port) = if let Some(port_range) = opts.listen_port_range.clone() { let (l, p) = create_tcp_listener(port_range) .await .context("error listening on TCP")?; info!("Listening on 0.0.0.0:{p} for incoming peer connections"); (Some(l), Some(p)) } else { (None, None) }; let dht = if opts.disable_dht { None } else { let dht = if opts.disable_dht_persistence { DhtBuilder::with_config(DhtConfig { cancellation_token: Some(token.child_token()), ..Default::default() }) .await .context("error initializing DHT")? } else { let pdht_config = opts.dht_config.take().unwrap_or_default(); PersistentDht::create(Some(pdht_config), Some(token.clone())) .await .context("error initializing persistent DHT")? }; Some(dht) }; let peer_opts = opts.peer_opts.unwrap_or_default(); async fn persistence_factory( opts: &SessionOptions, ) -> anyhow::Result<( Option>, Arc, )> { macro_rules! make_result { ($store:expr) => { if opts.fastresume { Ok((Some($store.clone()), $store)) } else { Ok((Some($store), Arc::new(NonPersistentBitVFactory {}))) } }; } match &opts.persistence { Some(SessionPersistenceConfig::Json { folder }) => { let folder = match folder.as_ref() { Some(f) => f.clone(), None => SessionPersistenceConfig::default_json_persistence_folder()?, }; let s = Arc::new( JsonSessionPersistenceStore::new(folder) .await .context("error initializing JsonSessionPersistenceStore")?, ); make_result!(s) } #[cfg(feature = "postgres")] Some(SessionPersistenceConfig::Postgres { connection_string }) => { use crate::session_persistence::postgres::PostgresSessionStorage; let p = Arc::new(PostgresSessionStorage::new(connection_string).await?); make_result!(p) } None => Ok((None, Arc::new(NonPersistentBitVFactory {}))), } } let (persistence, bitv_factory) = persistence_factory(&opts) .await .context("error initializing session persistence store")?; let spawner = BlockingSpawner::default(); let (disk_write_tx, disk_write_rx) = opts .defer_writes_up_to .map(|mb| { const DISK_WRITE_APPROX_WORK_ITEM_SIZE: usize = CHUNK_SIZE as usize + 300; let count = mb * 1024 * 1024 / DISK_WRITE_APPROX_WORK_ITEM_SIZE; let (tx, rx) = tokio::sync::mpsc::channel(count); (Some(tx), Some(rx)) }) .unwrap_or_default(); let proxy_config = match opts.socks_proxy_url.as_ref() { Some(pu) => Some( SocksProxyConfig::parse(pu) .with_context(|| format!("error parsing proxy url {}", pu))?, ), None => None, }; let reqwest_client = { let builder = if let Some(proxy_url) = opts.socks_proxy_url.as_ref() { let proxy = reqwest::Proxy::all(proxy_url) .context("error creating socks5 proxy for HTTP")?; reqwest::Client::builder().proxy(proxy) } else { reqwest::Client::builder() }; builder.build().context("error building HTTP(S) client")? }; let stream_connector = Arc::new(StreamConnector::from(proxy_config)); let session = Arc::new(Self { persistence, bitv_factory, peer_id, dht, peer_opts, spawner, output_folder: default_output_folder, next_id: AtomicUsize::new(0), db: RwLock::new(Default::default()), _cancellation_token_drop_guard: token.clone().drop_guard(), cancellation_token: token, tcp_listen_port, disk_write_tx, default_storage_factory: opts.default_storage_factory, reqwest_client, connector: stream_connector, root_span: opts.root_span, stats: SessionStats::new(), concurrent_initialize_semaphore: Arc::new(tokio::sync::Semaphore::new( opts.concurrent_init_limit.unwrap_or(3), )), ratelimits: Limits::new(opts.ratelimits), #[cfg(feature = "disable-upload")] _disable_upload: opts.disable_upload, }); if let Some(mut disk_write_rx) = disk_write_rx { session.spawn( error_span!(parent: session.rs(), "disk_writer"), async move { while let Some(work) = disk_write_rx.recv().await { trace!(disk_write_rx_queue_len = disk_write_rx.len()); spawner.spawn_block_in_place(work); } Ok(()) }, ); } if let Some(tcp_listener) = tcp_listener { session.spawn( error_span!(parent: session.rs(), "tcp_listen", port = tcp_listen_port), session.clone().task_tcp_listener(tcp_listener), ); } if let Some(listen_port) = tcp_listen_port { if opts.enable_upnp_port_forwarding { session.spawn( error_span!(parent: session.rs(), "upnp_forward", port = listen_port), Self::task_upnp_port_forwarder(listen_port), ); } } if let Some(persistence) = session.persistence.as_ref() { info!("will use {persistence:?} for session persistence"); let mut ps = persistence.stream_all().await?; let mut added_all = false; let mut futs = FuturesUnordered::new(); while !added_all || !futs.is_empty() { // NOTE: this closure exists purely to workaround rustfmt screwing up when inlining it. let add_torrent_span = |info_hash: &Id20| -> tracing::Span { error_span!(parent: session.rs(), "add_torrent", info_hash=?info_hash) }; tokio::select! { Some(res) = futs.next(), if !futs.is_empty() => { if let Err(e) = res { error!("error adding torrent to session: {e:#}"); } } st = ps.next(), if !added_all => { match st { Some(st) => { let (id, st) = st?; let span = add_torrent_span(st.info_hash()); let (add_torrent, mut opts) = st.into_add_torrent()?; opts.preferred_id = Some(id); let fut = session.add_torrent(add_torrent, Some(opts)); let fut = fut.instrument(span); futs.push(fut); }, None => added_all = true }; } }; } } session.start_speed_estimator_updater(); Ok(session) } .boxed() } async fn check_incoming_connection( self: Arc, addr: SocketAddr, mut stream: TcpStream, ) -> anyhow::Result<(Arc, CheckedIncomingConnection)> { let rwtimeout = self .peer_opts .read_write_timeout .unwrap_or_else(|| Duration::from_secs(10)); let mut read_buf = ReadBuf::new(); let h = read_buf .read_handshake(&mut stream, rwtimeout) .await .context("error reading handshake")?; trace!("received handshake from {addr}: {:?}", h); if h.peer_id == self.peer_id.0 { bail!("seems like we are connecting to ourselves, ignoring"); } for (id, torrent) in self.db.read().torrents.iter() { if torrent.info_hash().0 != h.info_hash { continue; } let live = match torrent.live() { Some(live) => live, None => { bail!("torrent {id} is not live, ignoring connection"); } }; let handshake = h.clone_to_owned(None); return Ok(( live, CheckedIncomingConnection { addr, stream, handshake, read_buf, }, )); } bail!( "didn't find a matching torrent for {:?}", Id20::new(h.info_hash) ) } async fn task_tcp_listener(self: Arc, l: TcpListener) -> anyhow::Result<()> { let mut futs = FuturesUnordered::new(); let session = Arc::downgrade(&self); drop(self); loop { tokio::select! { r = l.accept() => { match r { Ok((stream, addr)) => { trace!("accepted connection from {addr}"); let session = session.upgrade().context("session is dead")?; let span = error_span!(parent: session.rs(), "incoming", addr=%addr); futs.push( session.check_incoming_connection(addr, stream) .map_err(|e| { debug!("error checking incoming connection: {e:#}"); e }) .instrument(span) ); } Err(e) => { error!("error accepting: {e:#}"); continue; } } }, Some(Ok((live, checked))) = futs.next(), if !futs.is_empty() => { if let Err(e) = live.add_incoming_peer(checked) { warn!("error handing over incoming connection: {e:#}"); } }, } } } async fn task_upnp_port_forwarder(port: u16) -> anyhow::Result<()> { let pf = librqbit_upnp::UpnpPortForwarder::new(vec![port], None)?; pf.run_forever().await } pub fn get_dht(&self) -> Option<&Dht> { self.dht.as_ref() } fn merge_peer_opts(&self, other: Option) -> PeerConnectionOptions { let other = match other { Some(o) => o, None => self.peer_opts, }; PeerConnectionOptions { connect_timeout: other.connect_timeout.or(self.peer_opts.connect_timeout), read_write_timeout: other .read_write_timeout .or(self.peer_opts.read_write_timeout), keep_alive_interval: other .keep_alive_interval .or(self.peer_opts.keep_alive_interval), } } /// Spawn a task in the context of the session. #[track_caller] pub fn spawn( &self, span: tracing::Span, fut: impl std::future::Future> + Send + 'static, ) { spawn_with_cancel(span, self.cancellation_token.clone(), fut); } pub(crate) fn rs(&self) -> Option { self.root_span.as_ref().and_then(|s| s.id()) } /// Stop the session and all managed tasks. pub async fn stop(&self) { let torrents = self .db .read() .torrents .values() .cloned() .collect::>(); for torrent in torrents { if let Err(e) = torrent.pause() { debug!("error pausing torrent: {e:#}"); } } self.cancellation_token.cancel(); // this sucks, but hopefully will be enough tokio::time::sleep(Duration::from_secs(1)).await; } /// Run a callback given the currently managed torrents. pub fn with_torrents( &self, callback: impl Fn(&mut dyn Iterator) -> R, ) -> R { callback(&mut self.db.read().torrents.iter().map(|(id, t)| (*id, t))) } /// Add a torrent to the session. #[inline(never)] pub fn add_torrent<'a>( self: &'a Arc, add: AddTorrent<'a>, opts: Option, ) -> BoxFuture<'a, anyhow::Result> { async move { let mut opts = opts.unwrap_or_default(); let add_res = match add { AddTorrent::Url(magnet) if magnet.starts_with("magnet:") || magnet.len() == 40 => { let magnet = Magnet::parse(&magnet) .context("provided path is not a valid magnet URL")?; let info_hash = magnet .as_id20() .context("magnet link didn't contain a BTv1 infohash")?; if let Some(so) = magnet.get_select_only() { // Only overwrite opts.only_files if user didn't specify if opts.only_files.is_none() { opts.only_files = Some(so); } } InternalAddResult { info_hash, trackers: magnet.trackers, metadata: None, name: magnet.name, } } other => { let torrent = match other { AddTorrent::Url(url) if url.starts_with("http://") || url.starts_with("https://") => { torrent_from_url(&self.reqwest_client, &url).await? } AddTorrent::Url(url) => { bail!( "unsupported URL {:?}. Supporting magnet:, http:, and https", url ) } AddTorrent::TorrentFileBytes(bytes) => { torrent_from_bytes(bytes).context("error decoding torrent")? } }; let mut trackers = torrent .info .iter_announce() .unique() .filter_map(|tracker| match std::str::from_utf8(tracker.as_ref()) { Ok(url) => Some(url.to_owned()), Err(_) => { warn!("cannot parse tracker url as utf-8, ignoring"); None } }) .collect::>(); if let Some(custom_trackers) = opts.trackers.clone() { trackers.extend(custom_trackers); } InternalAddResult { info_hash: torrent.info.info_hash, metadata: Some(TorrentMetadata::new( torrent.info.info, torrent.torrent_bytes, torrent.info_bytes, )?), trackers, name: None, } } }; self.add_torrent_internal(add_res, opts).await } .instrument(error_span!(parent: self.rs(), "add_torrent")) .boxed() } fn get_default_subfolder_for_torrent( &self, info: &TorrentMetaV1Info, magnet_name: Option<&str>, ) -> anyhow::Result> { let files = info .iter_file_details()? .map(|fd| Ok((fd.filename.to_pathbuf()?, fd.len))) .collect::>>()?; if files.len() < 2 { return Ok(None); } fn check_valid(name: &str) -> anyhow::Result<()> { if name.contains("/") || name.contains("\\") || name.contains("..") { bail!("path traversal in torrent name detected") } Ok(()) } if let Some(name) = &info.name { let s = std::str::from_utf8(name.as_slice()).context("invalid UTF-8 in torrent name")?; check_valid(s)?; return Ok(Some(PathBuf::from(s))); }; if let Some(name) = magnet_name { check_valid(name)?; return Ok(Some(PathBuf::from(name))); } // Let the subfolder name be the longest filename let longest = files .iter() .max_by_key(|(_, l)| l) .unwrap() .0 .file_stem() .context("can't determine longest filename")?; Ok::<_, anyhow::Error>(Some(PathBuf::from(longest))) } async fn add_torrent_internal( self: &Arc, add_res: InternalAddResult, mut opts: AddTorrentOptions, ) -> anyhow::Result { let InternalAddResult { info_hash, metadata, trackers, name, } = add_res; let private = metadata.as_ref().map_or(false, |m| m.info.private); let make_peer_rx = || { self.make_peer_rx( info_hash, trackers.clone(), !opts.paused && !opts.list_only, opts.force_tracker_interval, opts.initial_peers.clone().unwrap_or_default(), private, ) }; let mut seen_peers = Vec::new(); let (metadata, peer_rx) = { match metadata { Some(metadata) => { let mut peer_rx = None; if !opts.paused && !opts.list_only { peer_rx = make_peer_rx(); } (metadata, peer_rx) } None => { let peer_rx = make_peer_rx().context( "no known way to resolve peers (no DHT, no trackers, no initial_peers)", )?; let resolved_magnet = self .resolve_magnet(info_hash, peer_rx, &trackers, opts.peer_opts) .await?; // Add back seen_peers into the peer stream, as we consumed some peers // while resolving the magnet. seen_peers = resolved_magnet.seen_peers.clone(); let peer_rx = Some( merge_streams( resolved_magnet.peer_rx, futures::stream::iter(resolved_magnet.seen_peers), ) .boxed(), ); (resolved_magnet.metadata, peer_rx) } } }; trace!("Torrent metadata: {:#?}", &metadata.info); let only_files = compute_only_files( &metadata.info, opts.only_files, opts.only_files_regex, opts.list_only, )?; let output_folder = match (opts.output_folder, opts.sub_folder) { (None, None) => self.output_folder.join( self.get_default_subfolder_for_torrent(&metadata.info, name.as_deref())? .unwrap_or_default(), ), (Some(o), None) => PathBuf::from(o), (Some(_), Some(_)) => { bail!("you can't provide both output_folder and sub_folder") } (None, Some(s)) => self.output_folder.join(s), }; if opts.list_only { return Ok(AddTorrentResponse::ListOnly(ListOnlyResponse { info_hash, info: metadata.info, only_files, output_folder, seen_peers, torrent_bytes: metadata.torrent_bytes, })); } let storage_factory = opts .storage_factory .take() .or_else(|| self.default_storage_factory.as_ref().map(|f| f.clone_box())) .unwrap_or_else(|| FilesystemStorageFactory::default().boxed()); let id = if let Some(id) = opts.preferred_id { id } else if let Some(p) = self.persistence.as_ref() { p.next_id().await? } else { self.next_id .fetch_add(1, std::sync::atomic::Ordering::Relaxed) }; let (managed_torrent, metadata) = { let mut g = self.db.write(); if let Some((id, handle)) = g.torrents.iter().find_map(|(eid, t)| { if t.info_hash() == info_hash || *eid == id { Some((*eid, t.clone())) } else { None } }) { return Ok(AddTorrentResponse::AlreadyManaged(id, handle)); } let span = error_span!(parent: self.rs(), "torrent", id); let peer_opts = self.merge_peer_opts(opts.peer_opts); let metadata = Arc::new(metadata); let minfo = Arc::new(ManagedTorrentShared { id, span, info_hash, trackers: trackers.into_iter().collect(), spawner: self.spawner, peer_id: self.peer_id, storage_factory, options: ManagedTorrentOptions { force_tracker_interval: opts.force_tracker_interval, peer_connect_timeout: peer_opts.connect_timeout, peer_read_write_timeout: peer_opts.read_write_timeout, allow_overwrite: opts.overwrite, output_folder, disk_write_queue: self.disk_write_tx.clone(), ratelimits: opts.ratelimits, initial_peers: opts.initial_peers.clone().unwrap_or_default(), #[cfg(feature = "disable-upload")] _disable_upload: self._disable_upload, }, connector: self.connector.clone(), session: Arc::downgrade(self), magnet_name: name, }); let initializing = Arc::new(TorrentStateInitializing::new( minfo.clone(), metadata.clone(), only_files.clone(), minfo.storage_factory.create_and_init(&minfo, &metadata)?, false, )); let handle = Arc::new(ManagedTorrent { locked: RwLock::new(ManagedTorrentLocked { paused: opts.paused, state: ManagedTorrentState::Initializing(initializing), only_files, }), state_change_notify: Notify::new(), shared: minfo, metadata: ArcSwapOption::new(Some(metadata.clone())), }); g.add_torrent(handle.clone(), id); (handle, metadata) }; if let Some(p) = self.persistence.as_ref() { if let Err(e) = p.store(id, &managed_torrent).await { self.db.write().torrents.remove(&id); return Err(e); } } let _e = managed_torrent.shared.span.clone().entered(); managed_torrent .start(peer_rx, opts.paused) .context("error starting torrent")?; if let Some(name) = metadata.info.name.as_ref() { info!(?name, "added torrent"); } Ok(AddTorrentResponse::Added(id, managed_torrent)) } pub fn get(&self, id: TorrentIdOrHash) -> Option { match id { TorrentIdOrHash::Id(id) => self.db.read().torrents.get(&id).cloned(), TorrentIdOrHash::Hash(id) => self.db.read().torrents.iter().find_map(|(_, v)| { if v.info_hash() == id { Some(v.clone()) } else { None } }), } } pub async fn delete(&self, id: TorrentIdOrHash, delete_files: bool) -> anyhow::Result<()> { let id = match id { TorrentIdOrHash::Id(id) => id, TorrentIdOrHash::Hash(h) => self .db .read() .torrents .values() .find_map(|v| { if v.info_hash() == h { Some(v.id()) } else { None } }) .context("no such torrent in db")?, }; let removed = self .db .write() .torrents .remove(&id) .with_context(|| format!("torrent with id {} did not exist", id))?; if let Err(e) = removed.pause() { debug!("error pausing torrent before deletion: {e:#}") } let metadata = removed.metadata.load_full().expect("TODO"); let storage = removed .with_state_mut(|s| match s.take() { ManagedTorrentState::Initializing(p) => p.files.take().ok(), ManagedTorrentState::Paused(p) => Some(p.files), ManagedTorrentState::Live(l) => l .pause() // inspect_err not available in 1.75 .map_err(|e| { warn!("error pausing torrent: {e:#}"); e }) .ok() .map(|p| p.files), _ => None, }) .map(Ok) .unwrap_or_else(|| { removed .shared .storage_factory .create(removed.shared(), &metadata) }); if let Some(p) = self.persistence.as_ref() { if let Err(e) = p.delete(id).await { error!(error=?e, "error deleting torrent from persistence database"); } else { debug!(?id, "deleted torrent from persistence database") } } match (storage, delete_files) { (Err(e), true) => return Err(e).context("torrent deleted, but could not delete files"), (Ok(storage), true) => { debug!("will delete files"); remove_files_and_dirs(&metadata.file_infos, &storage); if removed.shared().options.output_folder != self.output_folder { if let Err(e) = storage.remove_directory_if_empty(Path::new("")) { warn!( "error removing {:?}: {e:#}", removed.shared().options.output_folder ) } } } (_, false) => { debug!("not deleting files") } }; info!(id, "deleted torrent"); Ok(()) } pub fn make_peer_rx_managed_torrent( self: &Arc, t: &Arc, announce: bool, ) -> Option { let is_private = t.with_metadata(|m| m.info.private).unwrap_or(false); self.make_peer_rx( t.info_hash(), t.shared().trackers.iter().cloned().collect(), announce, t.shared().options.force_tracker_interval, t.shared().options.initial_peers.clone(), is_private, ) } // Get a peer stream from both DHT and trackers. fn make_peer_rx( self: &Arc, info_hash: Id20, mut trackers: Vec, announce: bool, force_tracker_interval: Option, initial_peers: Vec, is_private: bool, ) -> Option { let announce_port = if announce { self.tcp_listen_port } else { None }; let dht_rx = if is_private { None } else { self.dht .as_ref() .map(|dht| dht.get_peers(info_hash, announce_port)) }; if is_private && trackers.len() > 1 { warn!("private trackers are not fully implemented, so using only the first tracker"); trackers.resize_with(1, Default::default); } let tracker_rx_stats = PeerRxTorrentInfo { info_hash, session: self.clone(), }; let tracker_rx = TrackerComms::start( info_hash, self.peer_id, trackers, Box::new(tracker_rx_stats), force_tracker_interval, announce_port, self.reqwest_client.clone(), ); let initial_peers_rx = if initial_peers.is_empty() { None } else { Some(futures::stream::iter(initial_peers)) }; merge_two_optional_streams( merge_two_optional_streams(dht_rx, tracker_rx), initial_peers_rx, ) } async fn try_update_persistence_metadata(&self, handle: &ManagedTorrentHandle) { if let Some(p) = self.persistence.as_ref() { if let Err(e) = p.update_metadata(handle.id(), handle).await { warn!(storage=?p, error=?e, "error updating metadata") } } } pub async fn pause(&self, handle: &ManagedTorrentHandle) -> anyhow::Result<()> { handle.pause()?; self.try_update_persistence_metadata(handle).await; Ok(()) } pub async fn unpause(self: &Arc, handle: &ManagedTorrentHandle) -> anyhow::Result<()> { let peer_rx = self.make_peer_rx_managed_torrent(handle, true); handle.start(peer_rx, false)?; self.try_update_persistence_metadata(handle).await; Ok(()) } pub async fn update_only_files( self: &Arc, handle: &ManagedTorrentHandle, only_files: &HashSet, ) -> anyhow::Result<()> { handle.update_only_files(only_files)?; self.try_update_persistence_metadata(handle).await; Ok(()) } pub fn tcp_listen_port(&self) -> Option { self.tcp_listen_port } async fn resolve_magnet( self: &Arc, info_hash: Id20, peer_rx: PeerStream, trackers: &[String], peer_opts: Option, ) -> anyhow::Result { match read_metainfo_from_peer_receiver( self.peer_id, info_hash, Default::default(), peer_rx, Some(self.merge_peer_opts(peer_opts)), self.connector.clone(), ) .await { ReadMetainfoResult::Found { info, info_bytes, rx, seen, } => { trace!(?info, "received result from DHT"); Ok(ResolveMagnetResult { metadata: TorrentMetadata::new( info, torrent_file_from_info_bytes(&info_bytes, trackers)?, info_bytes.0, )?, peer_rx: rx, seen_peers: { let seen = seen.into_iter().collect_vec(); for peer in &seen { trace!(?peer, "seen") } seen }, }) } ReadMetainfoResult::ChannelClosed { .. } => { bail!("input address stream exhausted, no way to discover torrent metainfo") } } } } pub(crate) struct ResolveMagnetResult { pub metadata: TorrentMetadata, pub peer_rx: PeerStream, pub seen_peers: Vec, } fn remove_files_and_dirs(infos: &FileInfos, files: &dyn TorrentStorage) { let mut all_dirs = HashSet::new(); for (id, fi) in infos.iter().enumerate() { let mut fname = &*fi.relative_filename; if let Err(e) = files.remove_file(id, fname) { warn!(?fi.relative_filename, error=?e, "could not delete file"); } else { debug!(?fi.relative_filename, "deleted the file") } while let Some(parent) = fname.parent() { if parent != Path::new("") { all_dirs.insert(parent); } fname = parent; } } let all_dirs = { let mut v = all_dirs.into_iter().collect::>(); v.sort_unstable_by_key(|p| std::cmp::Reverse(p.as_os_str().len())); v }; for dir in all_dirs { if let Err(e) = files.remove_directory_if_empty(dir) { warn!("error removing {dir:?}: {e:#}"); } else { debug!("removed {dir:?}") } } } // Ad adapter for converting stats into the format that tracker_comms accepts. struct PeerRxTorrentInfo { info_hash: Id20, session: Arc, } impl tracker_comms::TorrentStatsProvider for PeerRxTorrentInfo { fn get(&self) -> tracker_comms::TrackerCommsStats { let mt = self.session.with_torrents(|torrents| { for (_, mt) in torrents { if mt.info_hash() == self.info_hash { return Some(mt.clone()); } } None }); let mt = match mt { Some(mt) => mt, None => { trace!(info_hash=?self.info_hash, "can't find torrent in the session, using default stats"); return Default::default(); } }; let stats = mt.stats(); use crate::torrent_state::stats::TorrentStatsState as TS; use tracker_comms::TrackerCommsStatsState as S; tracker_comms::TrackerCommsStats { downloaded_bytes: stats.progress_bytes, total_bytes: stats.total_bytes, uploaded_bytes: stats.uploaded_bytes, torrent_state: match stats.state { TS::Initializing => S::Initializing, TS::Live => S::Live, TS::Paused => S::Paused, TS::Error => S::None, }, } } } #[cfg(test)] mod tests { use buffers::ByteBuf; use itertools::Itertools; use librqbit_core::torrent_metainfo::{torrent_from_bytes_ext, TorrentMetaV1}; use super::torrent_file_from_info_bytes; #[test] fn test_torrent_file_from_info_and_bytes() { fn get_trackers(info: &TorrentMetaV1) -> Vec { info.iter_announce() .filter_map(|t| std::str::from_utf8(t.as_ref()).ok().map(|t| t.to_owned())) .collect_vec() } let orig_full_torrent = include_bytes!("../resources/ubuntu-21.04-desktop-amd64.iso.torrent"); let parsed = torrent_from_bytes_ext::(&orig_full_torrent[..]).unwrap(); let parsed_trackers = get_trackers(&parsed.meta); let generated_torrent = torrent_file_from_info_bytes(parsed.info_bytes.as_ref(), &parsed_trackers).unwrap(); let generated_parsed = torrent_from_bytes_ext::(generated_torrent.as_ref()).unwrap(); assert_eq!(parsed.meta.info_hash, generated_parsed.meta.info_hash); assert_eq!(parsed.meta.info, generated_parsed.meta.info); assert_eq!(parsed.info_bytes, generated_parsed.info_bytes); assert_eq!(parsed_trackers, get_trackers(&generated_parsed.meta)); } }