New: rTorrent - Don't start download automatically (#3222)

src/NzbDrone.Core.Test/Download/DownloadClientTests/RTorrentTests/RTorrentFixture.cs

@@ -54,11 +54,11 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.RTorrentTests
         protected void GivenSuccessfulDownload()
         {
             Mocker.GetMock<IRTorrentProxy>()
-                  .Setup(s => s.AddTorrentFromUrl(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<RTorrentPriority>(), It.IsAny<string>(), It.IsAny<RTorrentSettings>()))
+                  .Setup(s => s.AddTorrentFromUrl(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<RTorrentPriority>(), It.IsAny<string>(), It.IsAny<bool>(), It.IsAny<RTorrentSettings>()))
                   .Callback(PrepareClientToReturnCompletedItem);
 
             Mocker.GetMock<IRTorrentProxy>()
-                  .Setup(s => s.AddTorrentFromFile(It.IsAny<string>(), It.IsAny<byte[]>(), It.IsAny<string>(), It.IsAny<RTorrentPriority>(), It.IsAny<string>(), It.IsAny<RTorrentSettings>()))
+                  .Setup(s => s.AddTorrentFromFile(It.IsAny<string>(), It.IsAny<byte[]>(), It.IsAny<string>(), It.IsAny<RTorrentPriority>(), It.IsAny<string>(), It.IsAny<bool>(), It.IsAny<RTorrentSettings>()))
                   .Callback(PrepareClientToReturnCompletedItem);
 
 
@@ -123,4 +123,4 @@ namespace NzbDrone.Core.Test.Download.DownloadClientTests.RTorrentTests
             id.Should().NotBeNullOrEmpty();
         }
     }
-}
+}

src/NzbDrone.Core/Download/Clients/rTorrent/RTorrent.cs

@@ -43,7 +43,7 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
         {
             var priority = (RTorrentPriority)(remoteMovie.Movie.IsRecentMovie ? Settings.RecentMoviePriority : Settings.OlderMoviePriority);
 
-            _proxy.AddTorrentFromUrl(magnetLink, Settings.MovieCategory, priority, Settings.MovieDirectory, Settings);
+            _proxy.AddTorrentFromUrl(magnetLink, Settings.MovieCategory, priority, Settings.MovieDirectory, Settings.DontStartAutomatically, Settings);
 
             var tries = 10;
             var retryDelay = 500;
@@ -63,7 +63,7 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
         {
             var priority = (RTorrentPriority)(remoteMovie.Movie.IsRecentMovie ? Settings.RecentMoviePriority : Settings.OlderMoviePriority);
 
-            _proxy.AddTorrentFromFile(filename, fileContent, Settings.MovieCategory, priority, Settings.MovieDirectory, Settings);
+            _proxy.AddTorrentFromFile(filename, fileContent, Settings.MovieCategory, priority, Settings.MovieDirectory, Settings.DontStartAutomatically, Settings);
 
             var tries = 10;
             var retryDelay = 500;

src/NzbDrone.Core/Download/Clients/rTorrent/RTorrentProxy.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
@@ -13,8 +13,8 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
         string GetVersion(RTorrentSettings settings);
         List<RTorrentTorrent> GetTorrents(RTorrentSettings settings);
 
-        void AddTorrentFromUrl(string torrentUrl, string label, RTorrentPriority priority, string directory, RTorrentSettings settings);
-        void AddTorrentFromFile(string fileName, byte[] fileContent, string label, RTorrentPriority priority, string directory, RTorrentSettings settings);
+        void AddTorrentFromUrl(string torrentUrl, string label, RTorrentPriority priority, string directory, bool doNotStart, RTorrentSettings settings);
+        void AddTorrentFromFile(string fileName, byte[] fileContent, string label, RTorrentPriority priority, string directory, bool doNotStart, RTorrentSettings settings);
         void RemoveTorrent(string hash, RTorrentSettings settings);
         bool HasHashTorrent(string hash, RTorrentSettings settings);
     }
@@ -24,9 +24,15 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
         [XmlRpcMethod("d.multicall2")]
         object[] TorrentMulticall(params string[] parameters);
 
+        [XmlRpcMethod("load.normal")]
+        int Load(string target, string data, params string[] commands);
+
         [XmlRpcMethod("load.start")]
         int LoadStart(string target, string data, params string[] commands);
 
+        [XmlRpcMethod("load.raw")]
+        int LoadRaw(string target, byte[] data, params string[] commands);
+
         [XmlRpcMethod("load.raw_start")]
         int LoadRawStart(string target, byte[] data, params string[] commands);
 
@@ -102,26 +108,50 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
             return items;
         }
 
-        public void AddTorrentFromUrl(string torrentUrl, string label, RTorrentPriority priority, string directory, RTorrentSettings settings)
+        public void AddTorrentFromUrl(string torrentUrl, string label, RTorrentPriority priority, string directory, bool doNotStart, RTorrentSettings settings)
         {
-            _logger.Debug("Executing remote method: load.normal");
+            _logger.Debug("Adding Torrent From URL");
 
             var client = BuildClient(settings);
 
-            var response = client.LoadStart("", torrentUrl, GetCommands(label, priority, directory));
+            var response = -1;
+
+            if (doNotStart)
+            {
+                _logger.Debug("Executing remote method load.normal");
+                response = client.Load("", torrentUrl, GetCommands(label, priority, directory));
+            }
+            else
+            {
+                _logger.Debug("Executing remote method load.start");
+                response = client.LoadStart("", torrentUrl, GetCommands(label, priority, directory));
+            }
+
             if (response != 0)
             {
                 throw new DownloadClientException("Could not add torrent: {0}.", torrentUrl);
             }
         }
 
-        public void AddTorrentFromFile(string fileName, byte[] fileContent, string label, RTorrentPriority priority, string directory, RTorrentSettings settings)
+        public void AddTorrentFromFile(string fileName, byte[] fileContent, string label, RTorrentPriority priority, string directory, bool doNotStart, RTorrentSettings settings)
         {
-            _logger.Debug("Executing remote method: load.raw");
+            _logger.Debug("Loading Torrent from File");
 
             var client = BuildClient(settings);
 
-            var response = client.LoadRawStart("", fileContent, GetCommands(label, priority, directory));
+            var response = -1;
+
+            if (doNotStart)
+            {
+                _logger.Debug("Executing remote method load.raw");
+                response = client.LoadRaw("", fileContent, GetCommands(label, priority, directory));
+            }
+            else
+            {
+                _logger.Debug("Executing remote method load.raw_start");
+                response = client.LoadRawStart("", fileContent, GetCommands(label, priority, directory));
+            }
+
             if (response != 0)
             {
                 throw new DownloadClientException("Could not add torrent: {0}.", fileName);
@@ -202,4 +232,4 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
             return client;
         }
     }
-}
+}

src/NzbDrone.Core/Download/Clients/rTorrent/RTorrentSettings.cs

@@ -59,6 +59,9 @@ namespace NzbDrone.Core.Download.Clients.RTorrent
         [FieldDefinition(9, Label = "Older Priority", Type = FieldType.Select, SelectOptions = typeof(RTorrentPriority), HelpText = "Priority to use when grabbing movies that released over 21 days ago")]
         public int OlderMoviePriority { get; set; }
 
+        [FieldDefinition(10, Label = "Don't start download automatically", Type = FieldType.Checkbox, Advanced = true, HelpText = "Add Download in a stopped state. This is useful for letting a Queue manager like pyrotorque automatically start the download.")]
+        public bool DontStartAutomatically { get; set; }
+
         public NzbDroneValidationResult Validate()
         {
             return new NzbDroneValidationResult(Validator.Validate(this));