Merge pull request #19 from mark-monteiro/integrate-fx-cop

Integrate FxCop Analyzer

Author: dkanada

Emby.AutoOrganize/Api/FileOrganizationService.cs

@@ -1,11 +1,11 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using Emby.AutoOrganize.Core;
 using Emby.AutoOrganize.Model;
 using MediaBrowser.Controller.Net;
 using MediaBrowser.Model.Dto;
 using MediaBrowser.Model.Querying;
-using MediaBrowser.Model.Serialization;
 using MediaBrowser.Model.Services;
 
 namespace Emby.AutoOrganize.Api
@@ -82,6 +82,7 @@ public class OrganizeEpisode
         public bool RememberCorrection { get; set; }
 
         [ApiMember(Name = "NewSeriesProviderIds", Description = "A list of provider IDs identifying a new series.", IsRequired = false, DataType = "Dictionary<string, string>", ParameterType = "query", Verb = "POST")]
+        [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "ServiceStack cannot deserialize readonly dictionaries.")]
         public Dictionary<string, string> NewSeriesProviderIds { get; set; }
 
         [ApiMember(Name = "NewSeriesName", Description = "Name of a series to add.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
@@ -104,6 +105,7 @@ public class OrganizeMovie
         public string MovieId { get; set; }
 
         [ApiMember(Name = "NewMovieProviderIds", Description = "A list of provider IDs identifying a new movie.", IsRequired = false, DataType = "Dictionary<string, string>", ParameterType = "query", Verb = "POST")]
+        [SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "ServiceStack cannot deserialize readonly dictionaries.")]
         public Dictionary<string, string> NewMovieProviderIds { get; set; }
 
         [ApiMember(Name = "NewMovieName", Description = "Name of a movie to add.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
@@ -138,7 +140,7 @@ public class GetSmartMatchInfos : IReturn<QueryResult<SmartMatchInfo>>
     public class DeleteSmartMatchEntry
     {
         [ApiMember(Name = "Entries", Description = "SmartMatch Entry", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
-        public List<NameValuePair> Entries { get; set; }
+        public IReadOnlyList<NameValuePair> Entries { get; set; }
     }
 
     [Authenticated(Roles = "Admin")]
@@ -176,14 +178,15 @@ public void Delete(DeleteOriginalFile request)
             Task.WaitAll(task);
         }
 
+        [SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", Justification = "Parameter is used to define an API route.")]
         public void Delete(ClearOrganizationLog request)
         {
             var task = InternalFileOrganizationService.ClearLog();
 
             Task.WaitAll(task);
         }
 
-
+        [SuppressMessage("Microsoft.Usage", "CA1801:ReviewUnusedParameters", Justification = "Parameter is used to define an API route.")]
         public void Delete(ClearOrganizationCompletedLog request)
         {
             var task = InternalFileOrganizationService.ClearCompleted();
@@ -204,13 +207,6 @@ public void Post(PerformOrganization request)
 
         public void Post(OrganizeEpisode request)
         {
-            var dicNewProviderIds = new Dictionary<string, string>();
-
-            if (request.NewSeriesProviderIds != null)
-            {
-                dicNewProviderIds = request.NewSeriesProviderIds;
-            }
-
             // Don't await this
             var task = InternalFileOrganizationService.PerformOrganization(new EpisodeFileOrganizationRequest
             {
@@ -222,7 +218,7 @@ public void Post(OrganizeEpisode request)
                 SeriesId = request.SeriesId,
                 NewSeriesName = request.NewSeriesName,
                 NewSeriesYear = request.NewSeriesYear,
-                NewSeriesProviderIds = dicNewProviderIds,
+                NewSeriesProviderIds = request.NewSeriesProviderIds ?? new Dictionary<string, string>(),
                 TargetFolder = request.TargetFolder
             });
 
@@ -233,21 +229,14 @@ public void Post(OrganizeEpisode request)
 
         public void Post(OrganizeMovie request)
         {
-            var dicNewProviderIds = new Dictionary<string, string>();
-
-            if (request.NewMovieProviderIds != null)
-            {
-                dicNewProviderIds = request.NewMovieProviderIds;
-            }
-
             // Don't await this
             var task = InternalFileOrganizationService.PerformOrganization(new MovieFileOrganizationRequest
             {
                 ResultId = request.Id,
                 MovieId = request.MovieId,
                 NewMovieName = request.NewMovieName,
                 NewMovieYear = request.NewMovieYear,
-                NewMovieProviderIds = dicNewProviderIds,
+                NewMovieProviderIds = request.NewMovieProviderIds ?? new Dictionary<string, string>(),
                 TargetFolder = request.TargetFolder
             });
 

Emby.AutoOrganize/Core/EpisodeFileOrganizer.cs

@@ -30,22 +30,19 @@ public class EpisodeFileOrganizer
         private readonly ILogger _logger;
         private readonly IFileSystem _fileSystem;
         private readonly IFileOrganizationService _organizationService;
-        private readonly IServerConfigurationManager _config;
         private readonly IProviderManager _providerManager;
 
         private readonly CultureInfo _usCulture = new CultureInfo("en-US");
 
         public EpisodeFileOrganizer(
             IFileOrganizationService organizationService,
-            IServerConfigurationManager config,
             IFileSystem fileSystem,
             ILogger logger,
             ILibraryManager libraryManager,
             ILibraryMonitor libraryMonitor,
             IProviderManager providerManager)
         {
             _organizationService = organizationService;
-            _config = config;
             _fileSystem = fileSystem;
             _logger = logger;
             _libraryManager = libraryManager;
@@ -167,15 +164,15 @@ await OrganizeEpisode(path,
                     }
                     else
                     {
-                        var msg = string.Format("Unable to determine episode number from {0}", path);
+                        var msg = "Unable to determine episode number from " + path;
                         result.Status = FileSortingStatus.Failure;
                         result.StatusMessage = msg;
                         _logger.LogWarning(msg);
                     }
                 }
                 else
                 {
-                    var msg = string.Format("Unable to determine series name from {0}", path);
+                    var msg = "Unable to determine series name from " + path;
                     result.Status = FileSortingStatus.Failure;
                     result.StatusMessage = msg;
                     _logger.LogWarning(msg);
@@ -228,16 +225,13 @@ private async Task<Series> AutoDetectSeries(
                     Year = seriesYear
                 };
 
-                var searchResultsTask = await _providerManager.GetRemoteSearchResults<Series, SeriesInfo>(new RemoteSearchQuery<SeriesInfo>
-                {
-                    SearchInfo = seriesInfo
-
-                }, cancellationToken);
+                var searchQuery = new RemoteSearchQuery<SeriesInfo> { SearchInfo = seriesInfo };
+                var searchResults = await _providerManager.GetRemoteSearchResults<Series, SeriesInfo>(searchQuery, cancellationToken).ConfigureAwait(false);
 
                 #endregion
 
                 // Group series by name and year (if 2 series with the exact same name, the same year ...)
-                var groupedResult = searchResultsTask.GroupBy(p => new { p.Name, p.ProductionYear },
+                var groupedResult = searchResults.GroupBy(p => new { p.Name, p.ProductionYear },
                     p => p,
                     (key, g) => new { Key = key, Result = g.ToList() }).ToList();
 
@@ -307,7 +301,7 @@ private async Task<Series> CreateNewSeries(
                     // Create the folder
                     Directory.CreateDirectory(series.Path);
 
-                    series.ProviderIds = request.NewSeriesProviderIds;
+                    series.ProviderIds = request.NewSeriesProviderIds.ToDictionary(x => x.Key, x => x.Value);
                 }
             }
 
@@ -388,7 +382,7 @@ private Task OrganizeEpisode(string sourcePath,
 
                 if (series == null)
                 {
-                    var msg = string.Format("Unable to find series in library matching name {0}", seriesName);
+                    var msg = "Unable to find series in library matching name " + seriesName;
                     result.Status = FileSortingStatus.Failure;
                     result.StatusMessage = msg;
                     _logger.LogWarning(msg);
@@ -418,7 +412,6 @@ private Task OrganizeEpisode(string sourcePath,
         /// <param name="endingEpiosdeNumber"></param>
         /// <param name="premiereDate"></param>
         /// <param name="options"></param>
-        /// <param name="smartMatch"></param>
         /// <param name="rememberCorrection"></param>
         /// <param name="result"></param>
         /// <param name="cancellationToken"></param>
@@ -434,29 +427,38 @@ private async Task OrganizeEpisode(string sourcePath,
             FileOrganizationResult result,
             CancellationToken cancellationToken)
         {
-            var episode = await GetMatchingEpisode(series, seasonNumber, episodeNumber, endingEpiosdeNumber, result, premiereDate, cancellationToken);
+            var episode = await GetMatchingEpisode(
+                series,
+                seasonNumber,
+                episodeNumber,
+                endingEpiosdeNumber,
+                result,
+                premiereDate,
+                cancellationToken).ConfigureAwait(false);
 
             Season season;
             season = !string.IsNullOrEmpty(episode.Season?.Path)
                 ? episode.Season
-                : GetMatchingSeason(series, episode, options, cancellationToken);
+                : GetMatchingSeason(series, episode, options);
 
             // Now we can check the episode Path
             if (string.IsNullOrEmpty(episode.Path))
             {
                 SetEpisodeFileName(sourcePath, series, season, episode, options);
             }
 
-            await OrganizeEpisode(sourcePath,
+            await OrganizeEpisode(
+                sourcePath,
                 series,
                 episode,
                 options,
                 rememberCorrection,
                 result,
-                cancellationToken);
+                cancellationToken).ConfigureAwait(false);
         }
 
-        private async Task OrganizeEpisode(string sourcePath,
+        private Task OrganizeEpisode(
+            string sourcePath,
             Series series,
             Episode episode,
             TvFileOrganizationOptions options,
@@ -487,7 +489,7 @@ private async Task OrganizeEpisode(string sourcePath,
 
                 if (string.IsNullOrEmpty(newPath))
                 {
-                    var msg = string.Format("Unable to sort {0} because target path could not be determined.", sourcePath);
+                    var msg = $"Unable to sort {sourcePath} because target path could not be determined.";
                     throw new OrganizationException(msg);
                 }
 
@@ -501,31 +503,31 @@ private async Task OrganizeEpisode(string sourcePath,
                 {
                     if (options.CopyOriginalFile && fileExists && IsSameEpisode(sourcePath, newPath))
                     {
-                        var msg = string.Format("File '{0}' already copied to new path '{1}', stopping organization", sourcePath, newPath);
+                        var msg = $"File '{sourcePath}' already copied to new path '{newPath}', stopping organization";
                         _logger.LogInformation(msg);
                         result.Status = FileSortingStatus.SkippedExisting;
                         result.StatusMessage = msg;
-                        return;
+                        return Task.CompletedTask;
                     }
 
                     if (fileExists)
                     {
-                        var msg = string.Format("File '{0}' already exists as '{1}', stopping organization", sourcePath, newPath);
+                        var msg = $"File '{sourcePath}' already exists as '{newPath}', stopping organization";
                         _logger.LogInformation(msg);
                         result.Status = FileSortingStatus.SkippedExisting;
                         result.StatusMessage = msg;
                         result.TargetPath = newPath;
-                        return;
+                        return Task.CompletedTask;
                     }
 
                     if (otherDuplicatePaths.Count > 0)
                     {
-                        var msg = string.Format("File '{0}' already exists as these:'{1}'. Stopping organization", sourcePath, string.Join("', '", otherDuplicatePaths));
+                        var msg = $"File '{sourcePath}' already exists as these:'{string.Join("', '", otherDuplicatePaths)}'. Stopping organization";
                         _logger.LogInformation(msg);
                         result.Status = FileSortingStatus.SkippedExisting;
                         result.StatusMessage = msg;
                         result.DuplicatePaths = otherDuplicatePaths;
-                        return;
+                        return Task.CompletedTask;
                     }
                 }
 
@@ -569,7 +571,7 @@ private async Task OrganizeEpisode(string sourcePath,
                 result.Status = FileSortingStatus.Failure;
                 result.StatusMessage = ex.Message;
                 _logger.LogError(ex, "Caught a generic exception while organizing an episode");
-                return;
+                return Task.CompletedTask;
             }
             finally
             {
@@ -580,6 +582,8 @@ private async Task OrganizeEpisode(string sourcePath,
             {
                 SaveSmartMatchString(originalExtractedSeriesString, series, cancellationToken);
             }
+
+            return Task.CompletedTask;
         }
 
         private void SaveSmartMatchString(string matchString, Series series, CancellationToken cancellationToken)
@@ -734,7 +738,7 @@ private void PerformFileSorting(TvFileOrganizationOptions options, FileOrganizat
             }
             catch (Exception ex)
             {
-                var errorMsg = string.Format("Failed to move file from {0} to {1}: {2}", result.OriginalPath, result.TargetPath, ex.Message);
+                var errorMsg = $"Failed to move file from {result.OriginalPath} to {result.TargetPath}: {ex.Message}";
 
                 result.Status = FileSortingStatus.Failure;
                 result.StatusMessage = errorMsg;
@@ -784,7 +788,7 @@ private async Task<Episode> GetMatchingEpisode(Series series,
             return episode;
         }
 
-        private Season GetMatchingSeason(Series series, Episode episode, TvFileOrganizationOptions options, CancellationToken cancellationToken)
+        private Season GetMatchingSeason(Series series, Episode episode, TvFileOrganizationOptions options)
         {
             var season = episode.Season;
 
@@ -799,8 +803,7 @@ private Season GetMatchingSeason(Series series, Episode episode, TvFileOrganizat
                 {
                     if (!episode.ParentIndexNumber.HasValue)
                     {
-                        var msg = string.Format("No season found for {0} season {1} episode {2}", series.Name,
-                            episode.ParentIndexNumber, episode.IndexNumber);
+                        var msg = $"No season found for {series.Name} season {episode.ParentIndexNumber} episode {episode.IndexNumber}.";
                         _logger.LogWarning(msg);
                         throw new OrganizationException(msg);
                     }
@@ -843,7 +846,7 @@ private Series GetMatchingSeries(string seriesName, int? seriesYear, string targ
                 .Where(i => i.Item2 > 0)
                 .OrderByDescending(i => i.Item2)
                 .Select(i => i.Item1)
-                .FirstOrDefault(s => s.Path.StartsWith(targetFolder));
+                .FirstOrDefault(s => s.Path.StartsWith(targetFolder, StringComparison.Ordinal));
 
             if (series == null)
             {
@@ -858,7 +861,7 @@ private Series GetMatchingSeries(string seriesName, int? seriesYear, string targ
                         Name = info.ItemName,
                         DtoOptions = new DtoOptions(true)
 
-                    }).Cast<Series>().FirstOrDefault(s => s.Path.StartsWith(targetFolder));
+                    }).Cast<Series>().FirstOrDefault(s => s.Path.StartsWith(targetFolder, StringComparison.Ordinal));
                 }
             }
 
@@ -878,7 +881,7 @@ private string GetSeriesDirectoryName(Series series, TvFileOrganizationOptions o
             var seriesFullName = seriesName;
             if (series.ProductionYear.HasValue)
             {
-                seriesFullName = string.Format("{0} ({1})", seriesFullName, series.ProductionYear);
+                seriesFullName = $"{seriesFullName} ({series.ProductionYear})";
             }
 
             var seasonFolderName = options.SeriesFolderPattern.
@@ -930,7 +933,7 @@ private async Task<Episode> CreateNewEpisode(
 
             if (episodeSearch == null)
             {
-                var msg = string.Format("No provider metadata found for {0} season {1} episode {2}", series.Name, seasonNumber, episodeNumber);
+                var msg = $"No provider metadata found for {series.Name} season {seasonNumber} episode {episodeNumber}";
                 _logger.LogWarning(msg);
                 throw new OrganizationException(msg);
             }

Emby.AutoOrganize/Core/Extensions.cs

@@ -19,13 +19,14 @@ public static void Convert(this IConfigurationManager manager, IFileOrganization
 
                 foreach (SmartMatchInfo optionsSmartMatchInfo in options.SmartMatchInfos)
                 {
-                    service.SaveResult(new SmartMatchResult
+                    var result = new SmartMatchResult
                     {
                         DisplayName = optionsSmartMatchInfo.DisplayName,
                         ItemName = optionsSmartMatchInfo.ItemName,
                         OrganizerType = optionsSmartMatchInfo.OrganizerType,
-                        MatchStrings = optionsSmartMatchInfo.MatchStrings.ToList(),
-                    }, CancellationToken.None);
+                    };
+                    result.MatchStrings.AddRange(optionsSmartMatchInfo.MatchStrings);
+                    service.SaveResult(result, CancellationToken.None);
                 }
 
                 manager.SaveAutoOrganizeOptions(options);