diff options
Diffstat (limited to 'MediaBrowser.Server.Implementations/FileOrganization/TvFileSorter.cs')
| -rw-r--r-- | MediaBrowser.Server.Implementations/FileOrganization/TvFileSorter.cs | 482 |
1 files changed, 482 insertions, 0 deletions
diff --git a/MediaBrowser.Server.Implementations/FileOrganization/TvFileSorter.cs b/MediaBrowser.Server.Implementations/FileOrganization/TvFileSorter.cs new file mode 100644 index 000000000..24e2c094b --- /dev/null +++ b/MediaBrowser.Server.Implementations/FileOrganization/TvFileSorter.cs @@ -0,0 +1,482 @@ +using MediaBrowser.Common.IO; +using MediaBrowser.Controller.Entities.TV; +using MediaBrowser.Controller.FileOrganization; +using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Providers; +using MediaBrowser.Controller.Resolvers; +using MediaBrowser.Model.Configuration; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.FileOrganization; +using MediaBrowser.Model.Logging; +using System; +using System.Collections.Generic; +using System.Globalization; +using System.IO; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Server.Implementations.FileOrganization +{ + public class TvFileSorter + { + private readonly ILibraryManager _libraryManager; + private readonly ILogger _logger; + private readonly IFileSystem _fileSystem; + private readonly IFileOrganizationService _iFileSortingRepository; + + private static readonly CultureInfo UsCulture = new CultureInfo("en-US"); + + public TvFileSorter(ILibraryManager libraryManager, ILogger logger, IFileSystem fileSystem, IFileOrganizationService iFileSortingRepository) + { + _libraryManager = libraryManager; + _logger = logger; + _fileSystem = fileSystem; + _iFileSortingRepository = iFileSortingRepository; + } + + public async Task Sort(TvFileOrganizationOptions options, CancellationToken cancellationToken, IProgress<double> progress) + { + var minFileBytes = options.MinFileSizeMb * 1024 * 1024; + + var watchLocations = options.WatchLocations.ToList(); + + var eligibleFiles = watchLocations.SelectMany(GetFilesToSort) + .OrderBy(_fileSystem.GetCreationTimeUtc) + .Where(i => EntityResolutionHelper.IsVideoFile(i.FullName) && i.Length >= minFileBytes) + .ToList(); + + progress.Report(10); + + if (eligibleFiles.Count > 0) + { + var allSeries = _libraryManager.RootFolder + .RecursiveChildren.OfType<Series>() + .Where(i => i.LocationType == LocationType.FileSystem) + .ToList(); + + var numComplete = 0; + + foreach (var file in eligibleFiles) + { + await SortFile(file.FullName, options, allSeries).ConfigureAwait(false); + + numComplete++; + double percent = numComplete; + percent /= eligibleFiles.Count; + + progress.Report(10 + (89 * percent)); + } + } + + cancellationToken.ThrowIfCancellationRequested(); + progress.Report(99); + + if (!options.EnableTrialMode) + { + foreach (var path in watchLocations) + { + if (options.LeftOverFileExtensionsToDelete.Length > 0) + { + DeleteLeftOverFiles(path, options.LeftOverFileExtensionsToDelete); + } + + if (options.DeleteEmptyFolders) + { + DeleteEmptyFolders(path); + } + } + } + + progress.Report(100); + } + + /// <summary> + /// Gets the eligible files. + /// </summary> + /// <param name="path">The path.</param> + /// <returns>IEnumerable{FileInfo}.</returns> + private IEnumerable<FileInfo> GetFilesToSort(string path) + { + try + { + return new DirectoryInfo(path) + .EnumerateFiles("*", SearchOption.AllDirectories) + .ToList(); + } + catch (IOException ex) + { + _logger.ErrorException("Error getting files from {0}", ex, path); + + return new List<FileInfo>(); + } + } + + /// <summary> + /// Sorts the file. + /// </summary> + /// <param name="path">The path.</param> + /// <param name="options">The options.</param> + /// <param name="allSeries">All series.</param> + private Task SortFile(string path, TvFileOrganizationOptions options, IEnumerable<Series> allSeries) + { + _logger.Info("Sorting file {0}", path); + + var result = new FileOrganizationResult + { + Date = DateTime.UtcNow, + OriginalPath = path + }; + + var seriesName = TVUtils.GetSeriesNameFromEpisodeFile(path); + + if (!string.IsNullOrEmpty(seriesName)) + { + var season = TVUtils.GetSeasonNumberFromEpisodeFile(path); + + if (season.HasValue) + { + // Passing in true will include a few extra regex's + var episode = TVUtils.GetEpisodeNumberFromFile(path, true); + + if (episode.HasValue) + { + _logger.Debug("Extracted information from {0}. Series name {1}, Season {2}, Episode {3}", path, seriesName, season, episode); + + SortFile(path, seriesName, season.Value, episode.Value, options, allSeries, result); + } + else + { + var msg = string.Format("Unable to determine episode number from {0}", path); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = msg; + _logger.Warn(msg); + } + } + else + { + var msg = string.Format("Unable to determine season number from {0}", path); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = msg; + _logger.Warn(msg); + } + } + else + { + var msg = string.Format("Unable to determine series name from {0}", path); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = msg; + _logger.Warn(msg); + } + + return LogResult(result); + } + + /// <summary> + /// Sorts the file. + /// </summary> + /// <param name="path">The path.</param> + /// <param name="seriesName">Name of the series.</param> + /// <param name="seasonNumber">The season number.</param> + /// <param name="episodeNumber">The episode number.</param> + /// <param name="options">The options.</param> + /// <param name="allSeries">All series.</param> + /// <param name="result">The result.</param> + private void SortFile(string path, string seriesName, int seasonNumber, int episodeNumber, TvFileOrganizationOptions options, IEnumerable<Series> allSeries, FileOrganizationResult result) + { + var series = GetMatchingSeries(seriesName, allSeries); + + if (series == null) + { + var msg = string.Format("Unable to find series in library matching name {0}", seriesName); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = msg; + _logger.Warn(msg); + return; + } + + _logger.Info("Sorting file {0} into series {1}", path, series.Path); + + // Proceed to sort the file + var newPath = GetNewPath(path, series, seasonNumber, episodeNumber, options); + + if (string.IsNullOrEmpty(newPath)) + { + var msg = string.Format("Unable to sort {0} because target path could not be determined.", path); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = msg; + _logger.Warn(msg); + return; + } + + _logger.Info("Sorting file {0} to new path {1}", path, newPath); + result.TargetPath = newPath; + + if (options.EnableTrialMode) + { + result.Status = FileSortingStatus.SkippedTrial; + return; + } + + var targetExists = File.Exists(result.TargetPath); + if (!options.OverwriteExistingEpisodes && targetExists) + { + result.Status = FileSortingStatus.SkippedExisting; + return; + } + + PerformFileSorting(options, result, targetExists); + } + + /// <summary> + /// Performs the file sorting. + /// </summary> + /// <param name="options">The options.</param> + /// <param name="result">The result.</param> + /// <param name="copy">if set to <c>true</c> [copy].</param> + private void PerformFileSorting(TvFileOrganizationOptions options, FileOrganizationResult result, bool copy) + { + try + { + if (copy) + { + File.Copy(result.OriginalPath, result.TargetPath, true); + } + else + { + File.Move(result.OriginalPath, result.TargetPath); + } + } + catch (Exception ex) + { + var errorMsg = string.Format("Failed to move file from {0} to {1}", result.OriginalPath, result.TargetPath); + result.Status = FileSortingStatus.Failure; + result.ErrorMessage = errorMsg; + _logger.ErrorException(errorMsg, ex); + return; + } + + if (copy) + { + try + { + File.Delete(result.OriginalPath); + } + catch (Exception ex) + { + _logger.ErrorException("Error deleting {0}", ex, result.OriginalPath); + } + } + } + + /// <summary> + /// Logs the result. + /// </summary> + /// <param name="result">The result.</param> + /// <returns>Task.</returns> + private Task LogResult(FileOrganizationResult result) + { + return _iFileSortingRepository.SaveResult(result, CancellationToken.None); + } + + /// <summary> + /// Gets the new path. + /// </summary> + /// <param name="sourcePath">The source path.</param> + /// <param name="series">The series.</param> + /// <param name="seasonNumber">The season number.</param> + /// <param name="episodeNumber">The episode number.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + private string GetNewPath(string sourcePath, Series series, int seasonNumber, int episodeNumber, TvFileOrganizationOptions options) + { + var currentEpisodes = series.RecursiveChildren.OfType<Episode>() + .Where(i => i.IndexNumber.HasValue && i.IndexNumber.Value == episodeNumber && i.ParentIndexNumber.HasValue && i.ParentIndexNumber.Value == seasonNumber) + .ToList(); + + if (currentEpisodes.Count == 0) + { + return null; + } + + var newPath = currentEpisodes + .Where(i => i.LocationType == LocationType.FileSystem) + .Select(i => i.Path) + .FirstOrDefault(); + + if (string.IsNullOrEmpty(newPath)) + { + newPath = GetSeasonFolderPath(series, seasonNumber, options); + + var episode = currentEpisodes.First(); + + var episodeFileName = GetEpisodeFileName(sourcePath, series.Name, seasonNumber, episodeNumber, episode.Name, options); + + newPath = Path.Combine(newPath, episodeFileName); + } + + return newPath; + } + + private string GetEpisodeFileName(string sourcePath, string seriesName, int seasonNumber, int episodeNumber, string episodeTitle, TvFileOrganizationOptions options) + { + seriesName = _fileSystem.GetValidFilename(seriesName); + episodeTitle = _fileSystem.GetValidFilename(episodeTitle); + + var sourceExtension = (Path.GetExtension(sourcePath) ?? string.Empty).TrimStart('.'); + + return options.EpisodeNamePattern.Replace("%sn", seriesName) + .Replace("%s.n", seriesName.Replace(" ", ".")) + .Replace("%s_n", seriesName.Replace(" ", "_")) + .Replace("%s", seasonNumber.ToString(UsCulture)) + .Replace("%0s", seasonNumber.ToString("00", UsCulture)) + .Replace("%00s", seasonNumber.ToString("000", UsCulture)) + .Replace("%ext", sourceExtension) + .Replace("%en", episodeTitle) + .Replace("%e.n", episodeTitle.Replace(" ", ".")) + .Replace("%e_n", episodeTitle.Replace(" ", "_")) + .Replace("%e", episodeNumber.ToString(UsCulture)) + .Replace("%0e", episodeNumber.ToString("00", UsCulture)) + .Replace("%00e", episodeNumber.ToString("000", UsCulture)); + } + + /// <summary> + /// Gets the season folder path. + /// </summary> + /// <param name="series">The series.</param> + /// <param name="seasonNumber">The season number.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + private string GetSeasonFolderPath(Series series, int seasonNumber, TvFileOrganizationOptions options) + { + // If there's already a season folder, use that + var season = series + .RecursiveChildren + .OfType<Season>() + .FirstOrDefault(i => i.LocationType == LocationType.FileSystem && i.IndexNumber.HasValue && i.IndexNumber.Value == seasonNumber); + + if (season != null) + { + return season.Path; + } + + var path = series.Path; + + if (series.ContainsEpisodesWithoutSeasonFolders) + { + return path; + } + + if (seasonNumber == 0) + { + return Path.Combine(path, _fileSystem.GetValidFilename(options.SeasonZeroFolderName)); + } + + var seasonFolderName = options.SeasonFolderPattern + .Replace("%s", seasonNumber.ToString(UsCulture)) + .Replace("%0s", seasonNumber.ToString("00", UsCulture)) + .Replace("%00s", seasonNumber.ToString("000", UsCulture)); + + return Path.Combine(path, _fileSystem.GetValidFilename(seasonFolderName)); + } + + /// <summary> + /// Gets the matching series. + /// </summary> + /// <param name="seriesName">Name of the series.</param> + /// <param name="allSeries">All series.</param> + /// <returns>Series.</returns> + private Series GetMatchingSeries(string seriesName, IEnumerable<Series> allSeries) + { + int? yearInName; + var nameWithoutYear = seriesName; + NameParser.ParseName(nameWithoutYear, out nameWithoutYear, out yearInName); + + return allSeries.Select(i => GetMatchScore(nameWithoutYear, yearInName, i)) + .Where(i => i.Item2 > 0) + .OrderByDescending(i => i.Item2) + .Select(i => i.Item1) + .FirstOrDefault(); + } + + private Tuple<Series, int> GetMatchScore(string sortedName, int? year, Series series) + { + var score = 0; + + // TODO: Improve this - should ignore spaces, periods, underscores, most likely all symbols and + // possibly remove sorting words like "the", "and", etc. + if (string.Equals(sortedName, series.Name, StringComparison.OrdinalIgnoreCase)) + { + score++; + + if (year.HasValue && series.ProductionYear.HasValue) + { + if (year.Value == series.ProductionYear.Value) + { + score++; + } + else + { + // Regardless of name, return a 0 score if the years don't match + return new Tuple<Series, int>(series, 0); + } + } + } + + return new Tuple<Series, int>(series, score); + } + + /// <summary> + /// Deletes the left over files. + /// </summary> + /// <param name="path">The path.</param> + /// <param name="extensions">The extensions.</param> + private void DeleteLeftOverFiles(string path, IEnumerable<string> extensions) + { + var eligibleFiles = new DirectoryInfo(path) + .EnumerateFiles("*", SearchOption.AllDirectories) + .Where(i => extensions.Contains(i.Extension, StringComparer.OrdinalIgnoreCase)) + .ToList(); + + foreach (var file in eligibleFiles) + { + try + { + File.Delete(file.FullName); + } + catch (IOException ex) + { + _logger.ErrorException("Error deleting file {0}", ex, file.FullName); + } + } + } + + /// <summary> + /// Deletes the empty folders. + /// </summary> + /// <param name="path">The path.</param> + private void DeleteEmptyFolders(string path) + { + try + { + foreach (var d in Directory.EnumerateDirectories(path)) + { + DeleteEmptyFolders(d); + } + + var entries = Directory.EnumerateFileSystemEntries(path); + + if (!entries.Any()) + { + try + { + Directory.Delete(path); + } + catch (UnauthorizedAccessException) { } + catch (DirectoryNotFoundException) { } + } + } + catch (UnauthorizedAccessException) { } + } + } +} |