New: Choose extension for magnet links in Torrent Blackhole

Closes #2165

src/NzbDrone.Core.Test/Download/DownloadClientTests/Blackhole/TorrentBlackholeFixture.cs

@@ -32,7 +32,6 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.Blackhole
             _completedDownloadFolder = @"c:\blackhole\completed".AsOsAgnostic();
             _blackholeFolder = @"c:\blackhole\torrent".AsOsAgnostic();
             _filePath = (@"c:\blackhole\torrent\" + _title + ".torrent").AsOsAgnostic();
-            _magnetFilePath = Path.ChangeExtension(_filePath, ".magnet");
 
             Mocker.SetConstant<IScanWatchFolder>(Mocker.Resolve<ScanWatchFolder>());
 
@@ -79,6 +78,11 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.Blackhole
                 .Returns(1000000);
         }
 
+        protected void GivenMagnetFilePath(string extension = ".magnet")
+        {
+            _magnetFilePath = Path.ChangeExtension(_filePath, extension);
+        }
+
         protected override RemoteEpisode CreateRemoteEpisode()
         {
             var remoteEpisode = base.CreateRemoteEpisode();
@@ -145,7 +149,27 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.Blackhole
         [Test]
         public void Download_should_save_magnet_if_enabled()
         {
+            GivenMagnetFilePath();
+            Subject.Definition.Settings.As<TorrentBlackholeSettings>().SaveMagnetFiles = true;
+
+            var remoteEpisode = CreateRemoteEpisode();
+            remoteEpisode.Release.DownloadUrl = null;
+
+            Subject.Download(remoteEpisode);
+
+            Mocker.GetMock<IHttpClient>().Verify(c => c.Get(It.Is<HttpRequest>(v => v.Url.FullUri == _downloadUrl)), Times.Never());
+            Mocker.GetMock<IDiskProvider>().Verify(c => c.OpenWriteStream(_filePath), Times.Never());
+            Mocker.GetMock<IDiskProvider>().Verify(c => c.OpenWriteStream(_magnetFilePath), Times.Once());
+            Mocker.GetMock<IHttpClient>().Verify(c => c.DownloadFile(It.IsAny<string>(), It.IsAny<string>()), Times.Never());
+        }
+
+        [Test]
+        public void Download_should_save_magnet_using_specified_extension()
+        {
+            var magnetFileExtension = ".url";
+            GivenMagnetFilePath(magnetFileExtension);
             Subject.Definition.Settings.As<TorrentBlackholeSettings>().SaveMagnetFiles = true;
+            Subject.Definition.Settings.As<TorrentBlackholeSettings>().MagnetFileExtension = magnetFileExtension;
 
             var remoteEpisode = CreateRemoteEpisode();
             remoteEpisode.Release.DownloadUrl = null;
@@ -161,6 +185,7 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.Blackhole
         [Test]
         public void Download_should_not_save_magnet_if_disabled()
         {
+            GivenMagnetFilePath();
             var remoteEpisode = CreateRemoteEpisode();
             remoteEpisode.Release.DownloadUrl = null;
 

src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackhole.cs

@@ -49,7 +49,7 @@ namespace NzbDrone.Core.Download.Clients.Blackhole
 
             title = FileNameBuilder.CleanFileName(title);
 
-            var filepath = Path.Combine(Settings.TorrentFolder, string.Format("{0}.magnet", title));
+            var filepath = Path.Combine(Settings.TorrentFolder, $"{title}.{Settings.MagnetFileExtension.Trim('.')}");
 
             var fileContent = Encoding.UTF8.GetBytes(magnetLink);
             using (var stream = _diskProvider.OpenWriteStream(filepath))

src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackholeSettings.cs

@@ -1,4 +1,4 @@
-using System.ComponentModel;
+using System.ComponentModel;
 using FluentValidation;
 using Newtonsoft.Json;
 using NzbDrone.Core.Annotations;
@@ -14,6 +14,7 @@ namespace NzbDrone.Core.Download.Clients.Blackhole
         {
             //Todo: Validate that the path actually exists
             RuleFor(c => c.TorrentFolder).IsValidPath();
+            RuleFor(c => c.MagnetFileExtension).NotEmpty();
         }
     }
 
@@ -21,6 +22,7 @@ namespace NzbDrone.Core.Download.Clients.Blackhole
     {
         public TorrentBlackholeSettings()
         {
+            MagnetFileExtension = ".magnet";
             ReadOnly = true;
         }
 
@@ -34,12 +36,15 @@ namespace NzbDrone.Core.Download.Clients.Blackhole
 
         [DefaultValue(false)]
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
-        [FieldDefinition(2, Label = "Save Magnet Files", Type = FieldType.Checkbox, HelpText = "Save a .magnet file with the magnet link if no .torrent file is available (only useful if the download client supports .magnet files)")]
+        [FieldDefinition(2, Label = "Save Magnet Files", Type = FieldType.Checkbox, HelpText = "Save the magnet link if no .torrent file is available (only useful if the download client supports magnets saved to a file)")]
         public bool SaveMagnetFiles { get; set; }
 
+        [FieldDefinition(3, Label = "Save Magnet Files", Type = FieldType.Textbox, HelpText = "Extension to use for magnet links, defaults to '.magnet'")]
+        public string MagnetFileExtension { get; set; }
+
         [DefaultValue(false)]
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
-        [FieldDefinition(3, Label = "Read Only", Type = FieldType.Checkbox, HelpText = "Instead of moving files this will instruct Sonarr to Copy or Hardlink (depending on settings/system configuration)")]
+        [FieldDefinition(4, Label = "Read Only", Type = FieldType.Checkbox, HelpText = "Instead of moving files this will instruct Sonarr to Copy or Hardlink (depending on settings/system configuration)")]
         public bool ReadOnly { get; set; }
 
         public NzbDroneValidationResult Validate()