New: Health Check for Downloads to Root Folder

removed using localization updated ShouldBeWarning to include wikifragment check fixed linting issues slight tidy up
2026-04-22 22:14:44 -04:00 · 2021-03-30 08:58:36 +01:00
parent c5dcb22c01
commit a4755631c3
3 changed files with 169 additions and 1 deletions
@@ -0,0 +1,67 @@
+using System;
+using System.Linq;
+using NLog;
+using NzbDrone.Common.Extensions;
+using NzbDrone.Core.Datastore.Events;
+using NzbDrone.Core.Download;
+using NzbDrone.Core.Download.Clients;
+using NzbDrone.Core.RemotePathMappings;
+using NzbDrone.Core.RootFolders;
+using NzbDrone.Core.ThingiProvider.Events;
+
+namespace NzbDrone.Core.HealthCheck.Checks
+{
+    [CheckOn(typeof(ProviderAddedEvent<IDownloadClient>))]
+    [CheckOn(typeof(ProviderUpdatedEvent<IDownloadClient>))]
+    [CheckOn(typeof(ProviderDeletedEvent<IDownloadClient>))]
+    [CheckOn(typeof(ModelEvent<RootFolder>))]
+    [CheckOn(typeof(ModelEvent<RemotePathMapping>))]
+
+    public class DownloadClientRootFolderCheck : HealthCheckBase, IProvideHealthCheck
+    {
+        private readonly IProvideDownloadClient _downloadClientProvider;
+        private readonly IRootFolderService _rootFolderService;
+        private readonly Logger _logger;
+
+        public DownloadClientRootFolderCheck(IProvideDownloadClient downloadClientProvider,
+                                      IRootFolderService rootFolderService,
+                                      Logger logger)
+        {
+            _downloadClientProvider = downloadClientProvider;
+            _rootFolderService = rootFolderService;
+            _logger = logger;
+        }
+
+        public override HealthCheck Check()
+        {
+            var clients = _downloadClientProvider.GetDownloadClients();
+            var rootFolders = _rootFolderService.All();
+
+            foreach (var client in clients)
+            {
+                try
+                {
+                    var status = client.GetStatus();
+                    var folders = status.OutputRootFolders;
+                    foreach (var folder in folders)
+                    {
+                        if (rootFolders.Any(r => r.Path.PathEquals(folder.FullPath)))
+                        {
+                            return new HealthCheck(GetType(), HealthCheckResult.Warning, $"Download client {client.Definition.Name} places downloads in the root folder {folder.FullPath}. You should not download to a root folder.", "#downloads_in_root_folder");
+                        }
+                    }
+                }
+                catch (DownloadClientException ex)
+                {
+                    _logger.Debug(ex, "Unable to communicate with {0}", client.Definition.Name);
+                }
+                catch (Exception ex)
+                {
+                    _logger.Error(ex, "Unknown error occured in DownloadClientRootFolderCheck HealthCheck");
+                }
+            }
+
+            return new HealthCheck(GetType());
+        }
+    }
+}