feat: Add unknown_tracker_scheme crate feature

Author: angrynode

CHANGELOG.md

@@ -20,7 +20,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `TrackerScheme` no longer derives de/serialize because that's not actually
   used in torrent files
 - A torrent file with an invalid tracker URI (such as an unknown scheme) will now
-  fail to parse as a `DecodedTorrent` and therefore as a `TorrentFile`
+  fail to parse as a `DecodedTorrent` and therefore as a `TorrentFile`, unless the
+  `unknown_tracker_scheme` variant is enabled, in which case it will produce a
+  valid `TorrentFile` where the `TrackerScheme` is of the `Unknown` variant
 
 
 ### Added
@@ -37,6 +39,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
    a .torrent file
 - `DecodedTorrent::announce` and `DecodedTorrent::announce_list` list the
   trackers contained in the torrent file
+- `TrackerScheme::Unknown` stores unknown schemes instead of failing to parse,
+  when the tracker URL scheme is not recognized, and when the `unknown_tracker_scheme`
+  crate feature is anbled
 
 ### Fixed
 

Cargo.toml

@@ -32,9 +32,16 @@ serde_json = "1"
 
 [features]
 magnet_force_name = []
+unknown_tracker_scheme = []
 
 [[test]]
 name = "magnet_force_name"
 path = "tests/magnet_force_name.rs"
 required-features = [ "magnet_force_name" ]
 test = true
+
+[[test]]
+name = "unknown_tracker_scheme"
+path = "tests/unknown_tracker_scheme.rs"
+required-features = [ "unknown_tracker_scheme" ]
+test = true

src/torrent_file.rs

@@ -347,6 +347,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg(not(feature = "unknown_tracker_scheme"))]
     fn fail_no_torrent_scheme() {
         let slice = std::fs::read("tests/libtorrent/good/sample.torrent").unwrap();
         let res = TorrentFile::from_slice(&slice);

src/tracker.rs

@@ -88,6 +88,15 @@ pub enum TrackerScheme {
     Websocket,
     Http,
     Udp,
+    /// An unknown scheme is in the tracker URI.
+    ///
+    /// This is also the case when there is no scheme, in which
+    /// case the domain name may be parsed as a scheme.
+    ///
+    /// This is disabled by default and required the `unknown_tracker_scheme`
+    /// crate feature enabled if you really need to parse broken torrents.
+    #[cfg(feature = "unknown_tracker_scheme")]
+    Unknown(String),
 }
 
 impl FromStr for TrackerScheme {
@@ -98,6 +107,9 @@ impl FromStr for TrackerScheme {
             "http" | "https" => Ok(Self::Http),
             "ws" => Ok(Self::Websocket),
             "udp" => Ok(Self::Udp),
+            #[cfg(feature = "unknown_tracker_scheme")]
+            _ => Ok(Self::Unknown(s.to_string())),
+            #[cfg(not(feature = "unknown_tracker_scheme"))]
             _ => Err(TrackerError::InvalidScheme {
                 scheme: s.to_string(),
             }),

tests/unknown_tracker_scheme.rs

@@ -0,0 +1,31 @@
+use hightorrent::{InfoHash, TorrentContent, TorrentFile};
+
+use std::path::PathBuf;
+
+#[test]
+fn can_parse_no_scheme_tracker() {
+    // This only works when the unknown_tracker_scheme crate feature is eanbled
+    let slice = std::fs::read("tests/libtorrent/good/sample.torrent").unwrap();
+    let res = TorrentFile::from_slice(&slice);
+    println!("{:?}", res);
+    assert!(res.is_ok());
+    let torrent = res.unwrap();
+    assert_eq!(&torrent.name, "sample");
+    assert_eq!(
+        torrent.hash,
+        InfoHash::V1("58d8d15a4eb3bd9afabc9cee2564f78192777edb".to_string())
+    );
+    assert_eq!(
+        torrent.decoded.files().unwrap(),
+        vec!(
+            TorrentContent {
+                path: PathBuf::from("text_file.txt"),
+                size: 20,
+            },
+            TorrentContent {
+                path: PathBuf::from("text_file2.txt"),
+                size: 25,
+            }
+        ),
+    );
+}