From a5501863370579364291b93db3211d627cda2aab Mon Sep 17 00:00:00 2001 From: Mark McDowall Date: Thu, 6 Sep 2018 17:40:18 -0700 Subject: [PATCH] New: Choose extension for magnet links in Torrent Blackhole Closes #2165 --- .../Blackhole/TorrentBlackholeFixture.cs | 27 ++++++++++++++++++- .../Clients/Blackhole/TorrentBlackhole.cs | 2 +- .../Blackhole/TorrentBlackholeSettings.cs | 11 +++++--- 3 files changed, 35 insertions(+), 5 deletions(-) diff --git a/src/NzbDrone.Core.Test/Download/DownloadClientTests/Blackhole/TorrentBlackholeFixture.cs b/src/NzbDrone.Core.Test/Download/DownloadClientTests/Blackhole/TorrentBlackholeFixture.cs index a992c886e..faf33f9b0 100644 --- a/src/NzbDrone.Core.Test/Download/DownloadClientTests/Blackhole/TorrentBlackholeFixture.cs +++ b/src/NzbDrone.Core.Test/Download/DownloadClientTests/Blackhole/TorrentBlackholeFixture.cs @@ -32,7 +32,6 @@ public void Setup() _completedDownloadFolder = @"c:\blackhole\completed".AsOsAgnostic(); _blackholeFolder = @"c:\blackhole\torrent".AsOsAgnostic(); _filePath = (@"c:\blackhole\torrent\" + _title + ".torrent").AsOsAgnostic(); - _magnetFilePath = Path.ChangeExtension(_filePath, ".magnet"); Mocker.SetConstant(Mocker.Resolve()); @@ -79,6 +78,11 @@ protected void GivenCompletedItem() .Returns(1000000); } + protected void GivenMagnetFilePath(string extension = ".magnet") + { + _magnetFilePath = Path.ChangeExtension(_filePath, extension); + } + protected override RemoteEpisode CreateRemoteEpisode() { var remoteEpisode = base.CreateRemoteEpisode(); @@ -145,6 +149,7 @@ public void Download_should_download_file_if_it_doesnt_exist() [Test] public void Download_should_save_magnet_if_enabled() { + GivenMagnetFilePath(); Subject.Definition.Settings.As().SaveMagnetFiles = true; var remoteEpisode = CreateRemoteEpisode(); @@ -158,9 +163,29 @@ public void Download_should_save_magnet_if_enabled() Mocker.GetMock().Verify(c => c.DownloadFile(It.IsAny(), It.IsAny()), Times.Never()); } + [Test] + public void Download_should_save_magnet_using_specified_extension() + { + var magnetFileExtension = ".url"; + GivenMagnetFilePath(magnetFileExtension); + Subject.Definition.Settings.As().SaveMagnetFiles = true; + Subject.Definition.Settings.As().MagnetFileExtension = magnetFileExtension; + + var remoteEpisode = CreateRemoteEpisode(); + remoteEpisode.Release.DownloadUrl = null; + + Subject.Download(remoteEpisode); + + Mocker.GetMock().Verify(c => c.Get(It.Is(v => v.Url.FullUri == _downloadUrl)), Times.Never()); + Mocker.GetMock().Verify(c => c.OpenWriteStream(_filePath), Times.Never()); + Mocker.GetMock().Verify(c => c.OpenWriteStream(_magnetFilePath), Times.Once()); + Mocker.GetMock().Verify(c => c.DownloadFile(It.IsAny(), It.IsAny()), Times.Never()); + } + [Test] public void Download_should_not_save_magnet_if_disabled() { + GivenMagnetFilePath(); var remoteEpisode = CreateRemoteEpisode(); remoteEpisode.Release.DownloadUrl = null; diff --git a/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackhole.cs b/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackhole.cs index 4b2c7146a..2bb9346a3 100644 --- a/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackhole.cs +++ b/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackhole.cs @@ -49,7 +49,7 @@ protected override string AddFromMagnetLink(RemoteEpisode remoteEpisode, string 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)) diff --git a/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackholeSettings.cs b/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackholeSettings.cs index d05ee7f22..6ba138377 100644 --- a/src/NzbDrone.Core/Download/Clients/Blackhole/TorrentBlackholeSettings.cs +++ b/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 @@ public TorrentBlackholeSettingsValidator() { //Todo: Validate that the path actually exists RuleFor(c => c.TorrentFolder).IsValidPath(); + RuleFor(c => c.MagnetFileExtension).NotEmpty(); } } @@ -21,6 +22,7 @@ public class TorrentBlackholeSettings : IProviderConfig { public TorrentBlackholeSettings() { + MagnetFileExtension = ".magnet"; ReadOnly = true; } @@ -34,12 +36,15 @@ public TorrentBlackholeSettings() [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()