You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
898 lines
38 KiB
898 lines
38 KiB
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Text.RegularExpressions;
|
|
using NLog;
|
|
using NzbDrone.Common.Cache;
|
|
using NzbDrone.Common.EnsureThat;
|
|
using NzbDrone.Common.Extensions;
|
|
using NzbDrone.Core.MediaFiles;
|
|
using NzbDrone.Core.MediaFiles.MediaInfo;
|
|
using NzbDrone.Core.Profiles.Releases;
|
|
using NzbDrone.Core.Qualities;
|
|
using NzbDrone.Core.Tv;
|
|
|
|
namespace NzbDrone.Core.Organizer
|
|
{
|
|
public interface IBuildFileNames
|
|
{
|
|
string BuildFileName(List<Episode> episodes, Series series, EpisodeFile episodeFile, NamingConfig namingConfig = null, List<string> preferredWords = null);
|
|
string BuildFilePath(Series series, int seasonNumber, string fileName, string extension);
|
|
string BuildSeasonPath(Series series, int seasonNumber);
|
|
BasicNamingConfig GetBasicNamingConfig(NamingConfig nameSpec);
|
|
string GetSeriesFolder(Series series, NamingConfig namingConfig = null);
|
|
string GetSeasonFolder(Series series, int seasonNumber, NamingConfig namingConfig = null);
|
|
bool RequiresEpisodeTitle(Series series, List<Episode> episodes);
|
|
bool RequiresAbsoluteEpisodeNumber(Series series, List<Episode> episodes);
|
|
}
|
|
|
|
public class FileNameBuilder : IBuildFileNames
|
|
{
|
|
private readonly INamingConfigService _namingConfigService;
|
|
private readonly IQualityDefinitionService _qualityDefinitionService;
|
|
private readonly IPreferredWordService _preferredWordService;
|
|
private readonly IUpdateMediaInfo _mediaInfoUpdater;
|
|
private readonly ICached<EpisodeFormat[]> _episodeFormatCache;
|
|
private readonly ICached<AbsoluteEpisodeFormat[]> _absoluteEpisodeFormatCache;
|
|
private readonly ICached<bool> _requiresEpisodeTitleCache;
|
|
private readonly ICached<bool> _requiresAbsoluteEpisodeNumberCache;
|
|
private readonly Logger _logger;
|
|
|
|
private static readonly Regex TitleRegex = new Regex(@"\{(?<prefix>[- ._\[(]*)(?<token>(?:[a-z0-9]+)(?:(?<separator>[- ._]+)(?:[a-z0-9]+))?)(?::(?<customFormat>[a-z0-9]+))?(?<suffix>[- ._)\]]*)\}",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex EpisodeRegex = new Regex(@"(?<episode>\{episode(?:\:0+)?})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex SeasonRegex = new Regex(@"(?<season>\{season(?:\:0+)?})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex AbsoluteEpisodeRegex = new Regex(@"(?<absolute>\{absolute(?:\:0+)?})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex SeasonEpisodePatternRegex = new Regex(@"(?<separator>(?<=})[- ._]+?)?(?<seasonEpisode>s?{season(?:\:0+)?}(?<episodeSeparator>[- ._]?[ex])(?<episode>{episode(?:\:0+)?}))(?<separator>[- ._]+?(?={))?",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex AbsoluteEpisodePatternRegex = new Regex(@"(?<separator>(?<=})[- ._]+?)?(?<absolute>{absolute(?:\:0+)?})(?<separator>[- ._]+?(?={))?",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex AirDateRegex = new Regex(@"\{Air(\s|\W|_)Date\}", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex SeriesTitleRegex = new Regex(@"(?<token>\{(?:Series)(?<separator>[- ._])(Clean)?Title(The)?(Year)?\})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex FileNameCleanupRegex = new Regex(@"([- ._])(\1)+", RegexOptions.Compiled);
|
|
private static readonly Regex TrimSeparatorsRegex = new Regex(@"[- ._]$", RegexOptions.Compiled);
|
|
|
|
private static readonly Regex ScenifyRemoveChars = new Regex(@"(?<=\s)(,|<|>|\/|\\|;|:|'|""|\||`|~|!|\?|@|$|%|^|\*|-|_|=){1}(?=\s)|('|:|\?|,)(?=(?:(?:s|m)\s)|\s|$)|(\(|\)|\[|\]|\{|\})", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
private static readonly Regex ScenifyReplaceChars = new Regex(@"[\/]", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
//TODO: Support Written numbers (One, Two, etc) and Roman Numerals (I, II, III etc)
|
|
private static readonly Regex MultiPartCleanupRegex = new Regex(@"(?:\(\d+\)|(Part|Pt\.?)\s?\d+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly char[] EpisodeTitleTrimCharacters = new[] { ' ', '.', '?' };
|
|
|
|
private static readonly Regex TitlePrefixRegex = new Regex(@"^(The|An|A) (.*?)((?: *\([^)]+\))*)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex YearRegex = new Regex(@"\(\d{4}\)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public FileNameBuilder(INamingConfigService namingConfigService,
|
|
IQualityDefinitionService qualityDefinitionService,
|
|
ICacheManager cacheManager,
|
|
IPreferredWordService preferredWordService,
|
|
IUpdateMediaInfo mediaInfoUpdater,
|
|
Logger logger)
|
|
{
|
|
_namingConfigService = namingConfigService;
|
|
_qualityDefinitionService = qualityDefinitionService;
|
|
_preferredWordService = preferredWordService;
|
|
_mediaInfoUpdater = mediaInfoUpdater;
|
|
_episodeFormatCache = cacheManager.GetCache<EpisodeFormat[]>(GetType(), "episodeFormat");
|
|
_absoluteEpisodeFormatCache = cacheManager.GetCache<AbsoluteEpisodeFormat[]>(GetType(), "absoluteEpisodeFormat");
|
|
_requiresEpisodeTitleCache = cacheManager.GetCache<bool>(GetType(), "requiresEpisodeTitle");
|
|
_requiresAbsoluteEpisodeNumberCache = cacheManager.GetCache<bool>(GetType(), "requiresAbsoluteEpisodeNumber");
|
|
_logger = logger;
|
|
}
|
|
|
|
public string BuildFileName(List<Episode> episodes, Series series, EpisodeFile episodeFile, NamingConfig namingConfig = null, List<string> preferredWords = null)
|
|
{
|
|
if (namingConfig == null)
|
|
{
|
|
namingConfig = _namingConfigService.GetConfig();
|
|
}
|
|
|
|
if (!namingConfig.RenameEpisodes)
|
|
{
|
|
return GetOriginalTitle(episodeFile);
|
|
}
|
|
|
|
if (namingConfig.StandardEpisodeFormat.IsNullOrWhiteSpace() && series.SeriesType == SeriesTypes.Standard)
|
|
{
|
|
throw new NamingFormatException("Standard episode format cannot be empty");
|
|
}
|
|
|
|
if (namingConfig.DailyEpisodeFormat.IsNullOrWhiteSpace() && series.SeriesType == SeriesTypes.Daily)
|
|
{
|
|
throw new NamingFormatException("Daily episode format cannot be empty");
|
|
}
|
|
|
|
if (namingConfig.AnimeEpisodeFormat.IsNullOrWhiteSpace() && series.SeriesType == SeriesTypes.Anime)
|
|
{
|
|
throw new NamingFormatException("Anime episode format cannot be empty");
|
|
}
|
|
|
|
var pattern = namingConfig.StandardEpisodeFormat;
|
|
var tokenHandlers = new Dictionary<string, Func<TokenMatch, string>>(FileNameBuilderTokenEqualityComparer.Instance);
|
|
|
|
episodes = episodes.OrderBy(e => e.SeasonNumber).ThenBy(e => e.EpisodeNumber).ToList();
|
|
|
|
if (series.SeriesType == SeriesTypes.Daily)
|
|
{
|
|
pattern = namingConfig.DailyEpisodeFormat;
|
|
}
|
|
|
|
if (series.SeriesType == SeriesTypes.Anime && episodes.All(e => e.AbsoluteEpisodeNumber.HasValue))
|
|
{
|
|
pattern = namingConfig.AnimeEpisodeFormat;
|
|
}
|
|
|
|
pattern = AddSeasonEpisodeNumberingTokens(pattern, tokenHandlers, episodes, namingConfig);
|
|
pattern = AddAbsoluteNumberingTokens(pattern, tokenHandlers, series, episodes, namingConfig);
|
|
|
|
UpdateMediaInfoIfNeeded(pattern, episodeFile, series);
|
|
|
|
AddSeriesTokens(tokenHandlers, series);
|
|
AddIdTokens(tokenHandlers, series);
|
|
AddEpisodeTokens(tokenHandlers, episodes);
|
|
AddEpisodeFileTokens(tokenHandlers, episodeFile);
|
|
AddQualityTokens(tokenHandlers, series, episodeFile);
|
|
AddMediaInfoTokens(tokenHandlers, episodeFile);
|
|
AddPreferredWords(tokenHandlers, series, episodeFile, preferredWords);
|
|
|
|
|
|
var fileName = ReplaceTokens(pattern, tokenHandlers, namingConfig).Trim();
|
|
fileName = FileNameCleanupRegex.Replace(fileName, match => match.Captures[0].Value[0].ToString());
|
|
fileName = TrimSeparatorsRegex.Replace(fileName, string.Empty);
|
|
|
|
return fileName;
|
|
}
|
|
|
|
public string BuildFilePath(Series series, int seasonNumber, string fileName, string extension)
|
|
{
|
|
Ensure.That(extension, () => extension).IsNotNullOrWhiteSpace();
|
|
|
|
var path = BuildSeasonPath(series, seasonNumber);
|
|
|
|
return Path.Combine(path, fileName + extension);
|
|
}
|
|
|
|
public string BuildSeasonPath(Series series, int seasonNumber)
|
|
{
|
|
var path = series.Path;
|
|
|
|
if (series.SeasonFolder)
|
|
{
|
|
if (seasonNumber == 0)
|
|
{
|
|
path = Path.Combine(path, "Specials");
|
|
}
|
|
else
|
|
{
|
|
var seasonFolder = GetSeasonFolder(series, seasonNumber);
|
|
|
|
seasonFolder = CleanFileName(seasonFolder);
|
|
|
|
path = Path.Combine(path, seasonFolder);
|
|
}
|
|
}
|
|
|
|
return path;
|
|
}
|
|
|
|
public BasicNamingConfig GetBasicNamingConfig(NamingConfig nameSpec)
|
|
{
|
|
var episodeFormat = GetEpisodeFormat(nameSpec.StandardEpisodeFormat).LastOrDefault();
|
|
|
|
if (episodeFormat == null)
|
|
{
|
|
return new BasicNamingConfig();
|
|
}
|
|
|
|
var basicNamingConfig = new BasicNamingConfig
|
|
{
|
|
Separator = episodeFormat.Separator,
|
|
NumberStyle = episodeFormat.SeasonEpisodePattern
|
|
};
|
|
|
|
var titleTokens = TitleRegex.Matches(nameSpec.StandardEpisodeFormat);
|
|
|
|
foreach (Match match in titleTokens)
|
|
{
|
|
var separator = match.Groups["separator"].Value;
|
|
var token = match.Groups["token"].Value;
|
|
|
|
if (!separator.Equals(" "))
|
|
{
|
|
basicNamingConfig.ReplaceSpaces = true;
|
|
}
|
|
|
|
if (token.StartsWith("{Series", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeSeriesTitle = true;
|
|
}
|
|
|
|
if (token.StartsWith("{Episode", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeEpisodeTitle = true;
|
|
}
|
|
|
|
if (token.StartsWith("{Quality", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeQuality = true;
|
|
}
|
|
}
|
|
|
|
return basicNamingConfig;
|
|
}
|
|
|
|
public string GetSeriesFolder(Series series, NamingConfig namingConfig = null)
|
|
{
|
|
if (namingConfig == null)
|
|
{
|
|
namingConfig = _namingConfigService.GetConfig();
|
|
}
|
|
|
|
var tokenHandlers = new Dictionary<string, Func<TokenMatch, string>>(FileNameBuilderTokenEqualityComparer.Instance);
|
|
|
|
AddSeriesTokens(tokenHandlers, series);
|
|
AddIdTokens(tokenHandlers, series);
|
|
|
|
var folderName = ReplaceTokens(namingConfig.SeriesFolderFormat, tokenHandlers, namingConfig);
|
|
return CleanFolderName(folderName);
|
|
}
|
|
|
|
public string GetSeasonFolder(Series series, int seasonNumber, NamingConfig namingConfig = null)
|
|
{
|
|
if (namingConfig == null)
|
|
{
|
|
namingConfig = _namingConfigService.GetConfig();
|
|
}
|
|
|
|
var tokenHandlers = new Dictionary<string, Func<TokenMatch, string>>(FileNameBuilderTokenEqualityComparer.Instance);
|
|
|
|
AddSeriesTokens(tokenHandlers, series);
|
|
AddIdTokens(tokenHandlers, series);
|
|
AddSeasonTokens(tokenHandlers, seasonNumber);
|
|
|
|
var folderName = ReplaceTokens(namingConfig.SeasonFolderFormat, tokenHandlers, namingConfig);
|
|
return CleanFolderName(folderName);
|
|
}
|
|
|
|
public static string CleanTitle(string title)
|
|
{
|
|
title = title.Replace("&", "and");
|
|
title = ScenifyReplaceChars.Replace(title, " ");
|
|
title = ScenifyRemoveChars.Replace(title, string.Empty);
|
|
|
|
return title;
|
|
}
|
|
|
|
public static string TitleThe(string title)
|
|
{
|
|
return TitlePrefixRegex.Replace(title, "$2, $1$3");
|
|
}
|
|
|
|
public static string TitleYear(string title, int year)
|
|
{
|
|
// Regex match incase the year in the title doesn't match the year, for whatever reason.
|
|
if (YearRegex.IsMatch(title))
|
|
{
|
|
return title;
|
|
}
|
|
|
|
return $"{title} ({year})";
|
|
}
|
|
|
|
public static string CleanFileName(string name, bool replace = true)
|
|
{
|
|
string result = name;
|
|
string[] badCharacters = { "\\", "/", "<", ">", "?", "*", ":", "|", "\"" };
|
|
string[] goodCharacters = { "+", "+", "", "", "!", "-", "-", "", "" };
|
|
|
|
for (int i = 0; i < badCharacters.Length; i++)
|
|
{
|
|
result = result.Replace(badCharacters[i], replace ? goodCharacters[i] : string.Empty);
|
|
}
|
|
|
|
return result.TrimStart(' ', '.').TrimEnd(' ');
|
|
}
|
|
|
|
public static string CleanFolderName(string name)
|
|
{
|
|
name = FileNameCleanupRegex.Replace(name, match => match.Captures[0].Value[0].ToString());
|
|
return name.Trim(' ', '.');
|
|
}
|
|
|
|
public bool RequiresEpisodeTitle(Series series, List<Episode> episodes)
|
|
{
|
|
var namingConfig = _namingConfigService.GetConfig();
|
|
var pattern = namingConfig.StandardEpisodeFormat;
|
|
|
|
if (series.SeriesType == SeriesTypes.Daily)
|
|
{
|
|
pattern = namingConfig.DailyEpisodeFormat;
|
|
}
|
|
|
|
if (series.SeriesType == SeriesTypes.Anime && episodes.All(e => e.AbsoluteEpisodeNumber.HasValue))
|
|
{
|
|
pattern = namingConfig.AnimeEpisodeFormat;
|
|
}
|
|
|
|
return _requiresEpisodeTitleCache.Get(pattern, () =>
|
|
{
|
|
var matches = TitleRegex.Matches(pattern);
|
|
|
|
foreach (Match match in matches)
|
|
{
|
|
var token = match.Groups["token"].Value;
|
|
|
|
if (FileNameBuilderTokenEqualityComparer.Instance.Equals(token, "{Episode Title}") ||
|
|
FileNameBuilderTokenEqualityComparer.Instance.Equals(token, "{Episode CleanTitle}"))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
});
|
|
}
|
|
|
|
public bool RequiresAbsoluteEpisodeNumber(Series series, List<Episode> episodes)
|
|
{
|
|
if (series.SeriesType != SeriesTypes.Anime)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var namingConfig = _namingConfigService.GetConfig();
|
|
var pattern = namingConfig.AnimeEpisodeFormat;
|
|
|
|
return _requiresAbsoluteEpisodeNumberCache.Get(pattern, () =>
|
|
{
|
|
var matches = AbsoluteEpisodeRegex.Matches(pattern);
|
|
|
|
return matches.Count > 0;
|
|
});
|
|
}
|
|
|
|
private void AddSeriesTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series)
|
|
{
|
|
tokenHandlers["{Series Title}"] = m => series.Title;
|
|
tokenHandlers["{Series CleanTitle}"] = m => CleanTitle(series.Title);
|
|
tokenHandlers["{Series CleanTitleYear}"] = m => CleanTitle(TitleYear(series.Title, series.Year));
|
|
tokenHandlers["{Series TitleThe}"] = m => TitleThe(series.Title);
|
|
tokenHandlers["{Series TitleYear}"] = m => TitleYear(series.Title, series.Year);
|
|
tokenHandlers["{Series TitleTheYear}"] = m => TitleYear(TitleThe(series.Title), series.Year);
|
|
tokenHandlers["{Series TitleFirstCharacter}"] = m => TitleThe(series.Title).Substring(0, 1).FirstCharToUpper();
|
|
}
|
|
|
|
private string AddSeasonEpisodeNumberingTokens(string pattern, Dictionary<string, Func<TokenMatch, string>> tokenHandlers, List<Episode> episodes, NamingConfig namingConfig)
|
|
{
|
|
var episodeFormats = GetEpisodeFormat(pattern).DistinctBy(v => v.SeasonEpisodePattern).ToList();
|
|
|
|
int index = 1;
|
|
foreach (var episodeFormat in episodeFormats)
|
|
{
|
|
var seasonEpisodePattern = episodeFormat.SeasonEpisodePattern;
|
|
string formatPattern;
|
|
|
|
switch ((MultiEpisodeStyle)namingConfig.MultiEpisodeStyle)
|
|
{
|
|
case MultiEpisodeStyle.Duplicate:
|
|
formatPattern = episodeFormat.Separator + episodeFormat.SeasonEpisodePattern;
|
|
seasonEpisodePattern = FormatNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Repeat:
|
|
formatPattern = episodeFormat.EpisodeSeparator + episodeFormat.EpisodePattern;
|
|
seasonEpisodePattern = FormatNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Scene:
|
|
formatPattern = "-" + episodeFormat.EpisodeSeparator + episodeFormat.EpisodePattern;
|
|
seasonEpisodePattern = FormatNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Range:
|
|
formatPattern = "-" + episodeFormat.EpisodePattern;
|
|
seasonEpisodePattern = FormatRangeNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.PrefixedRange:
|
|
formatPattern = "-" + episodeFormat.EpisodeSeparator + episodeFormat.EpisodePattern;
|
|
seasonEpisodePattern = FormatRangeNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
//MultiEpisodeStyle.Extend
|
|
default:
|
|
formatPattern = "-" + episodeFormat.EpisodePattern;
|
|
seasonEpisodePattern = FormatNumberTokens(seasonEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
}
|
|
|
|
var token = string.Format("{{Season Episode{0}}}", index++);
|
|
pattern = pattern.Replace(episodeFormat.SeasonEpisodePattern, token);
|
|
tokenHandlers[token] = m => seasonEpisodePattern;
|
|
}
|
|
|
|
AddSeasonTokens(tokenHandlers, episodes.First().SeasonNumber);
|
|
|
|
if (episodes.Count > 1)
|
|
{
|
|
tokenHandlers["{Episode}"] = m => episodes.First().EpisodeNumber.ToString(m.CustomFormat) + "-" + episodes.Last().EpisodeNumber.ToString(m.CustomFormat);
|
|
}
|
|
else
|
|
{
|
|
tokenHandlers["{Episode}"] = m => episodes.First().EpisodeNumber.ToString(m.CustomFormat);
|
|
}
|
|
|
|
return pattern;
|
|
}
|
|
|
|
private string AddAbsoluteNumberingTokens(string pattern, Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series, List<Episode> episodes, NamingConfig namingConfig)
|
|
{
|
|
var absoluteEpisodeFormats = GetAbsoluteFormat(pattern).DistinctBy(v => v.AbsoluteEpisodePattern).ToList();
|
|
|
|
int index = 1;
|
|
foreach (var absoluteEpisodeFormat in absoluteEpisodeFormats)
|
|
{
|
|
if (series.SeriesType != SeriesTypes.Anime)
|
|
{
|
|
pattern = pattern.Replace(absoluteEpisodeFormat.AbsoluteEpisodePattern, "");
|
|
continue;
|
|
}
|
|
|
|
var absoluteEpisodePattern = absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
string formatPattern;
|
|
|
|
switch ((MultiEpisodeStyle) namingConfig.MultiEpisodeStyle)
|
|
{
|
|
|
|
case MultiEpisodeStyle.Duplicate:
|
|
formatPattern = absoluteEpisodeFormat.Separator + absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
absoluteEpisodePattern = FormatAbsoluteNumberTokens(absoluteEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Repeat:
|
|
var repeatSeparator = absoluteEpisodeFormat.Separator.Trim().IsNullOrWhiteSpace() ? " " : absoluteEpisodeFormat.Separator.Trim();
|
|
|
|
formatPattern = repeatSeparator + absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
absoluteEpisodePattern = FormatAbsoluteNumberTokens(absoluteEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Scene:
|
|
formatPattern = "-" + absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
absoluteEpisodePattern = FormatAbsoluteNumberTokens(absoluteEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
|
|
case MultiEpisodeStyle.Range:
|
|
case MultiEpisodeStyle.PrefixedRange:
|
|
formatPattern = "-" + absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
var eps = new List<Episode> {episodes.First()};
|
|
|
|
if (episodes.Count > 1) eps.Add(episodes.Last());
|
|
|
|
absoluteEpisodePattern = FormatAbsoluteNumberTokens(absoluteEpisodePattern, formatPattern, eps);
|
|
break;
|
|
|
|
//MultiEpisodeStyle.Extend
|
|
default:
|
|
formatPattern = "-" + absoluteEpisodeFormat.AbsoluteEpisodePattern;
|
|
absoluteEpisodePattern = FormatAbsoluteNumberTokens(absoluteEpisodePattern, formatPattern, episodes);
|
|
break;
|
|
}
|
|
|
|
var token = string.Format("{{Absolute Pattern{0}}}", index++);
|
|
pattern = pattern.Replace(absoluteEpisodeFormat.AbsoluteEpisodePattern, token);
|
|
tokenHandlers[token] = m => absoluteEpisodePattern;
|
|
}
|
|
|
|
return pattern;
|
|
}
|
|
|
|
private void AddSeasonTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, int seasonNumber)
|
|
{
|
|
tokenHandlers["{Season}"] = m => seasonNumber.ToString(m.CustomFormat);
|
|
}
|
|
|
|
private void AddEpisodeTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, List<Episode> episodes)
|
|
{
|
|
if (!episodes.First().AirDate.IsNullOrWhiteSpace())
|
|
{
|
|
tokenHandlers["{Air Date}"] = m => episodes.First().AirDate.Replace('-', ' ');
|
|
}
|
|
else
|
|
{
|
|
tokenHandlers["{Air Date}"] = m => "Unknown";
|
|
}
|
|
|
|
tokenHandlers["{Episode Title}"] = m => GetEpisodeTitle(episodes, "+");
|
|
tokenHandlers["{Episode CleanTitle}"] = m => CleanTitle(GetEpisodeTitle(episodes, "and"));
|
|
}
|
|
|
|
private void AddEpisodeFileTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, EpisodeFile episodeFile)
|
|
{
|
|
tokenHandlers["{Original Title}"] = m => GetOriginalTitle(episodeFile);
|
|
tokenHandlers["{Original Filename}"] = m => GetOriginalFileName(episodeFile);
|
|
tokenHandlers["{Release Group}"] = m => episodeFile.ReleaseGroup ?? m.DefaultValue("Sonarr");
|
|
}
|
|
|
|
private void AddQualityTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series, EpisodeFile episodeFile)
|
|
{
|
|
var qualityTitle = _qualityDefinitionService.Get(episodeFile.Quality.Quality).Title;
|
|
var qualityProper = GetQualityProper(series, episodeFile.Quality);
|
|
var qualityReal = GetQualityReal(series, episodeFile.Quality);
|
|
|
|
tokenHandlers["{Quality Full}"] = m => String.Format("{0} {1} {2}", qualityTitle, qualityProper, qualityReal);
|
|
tokenHandlers["{Quality Title}"] = m => qualityTitle;
|
|
tokenHandlers["{Quality Proper}"] = m => qualityProper;
|
|
tokenHandlers["{Quality Real}"] = m => qualityReal;
|
|
}
|
|
|
|
private const string MediaInfoVideoDynamicRangeToken = "{MediaInfo VideoDynamicRange}";
|
|
private static readonly IDictionary<string, int> MinimumMediaInfoSchemaRevisions =
|
|
new Dictionary<string, int>(FileNameBuilderTokenEqualityComparer.Instance)
|
|
{
|
|
{MediaInfoVideoDynamicRangeToken, 5}
|
|
};
|
|
|
|
private void AddMediaInfoTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, EpisodeFile episodeFile)
|
|
{
|
|
if (episodeFile.MediaInfo == null)
|
|
{
|
|
_logger.Trace("Media info is unavailable for {0}", episodeFile);
|
|
|
|
return;
|
|
}
|
|
|
|
var sceneName = episodeFile.GetSceneOrFileName();
|
|
|
|
var videoCodec = MediaInfoFormatter.FormatVideoCodec(episodeFile.MediaInfo, sceneName);
|
|
var audioCodec = MediaInfoFormatter.FormatAudioCodec(episodeFile.MediaInfo, sceneName);
|
|
var audioChannels = MediaInfoFormatter.FormatAudioChannels(episodeFile.MediaInfo);
|
|
var audioLanguages = episodeFile.MediaInfo.AudioLanguages ?? string.Empty;
|
|
var subtitles = episodeFile.MediaInfo.Subtitles ?? string.Empty;
|
|
|
|
var mediaInfoAudioLanguages = GetLanguagesToken(audioLanguages);
|
|
if (!mediaInfoAudioLanguages.IsNullOrWhiteSpace())
|
|
{
|
|
mediaInfoAudioLanguages = $"[{mediaInfoAudioLanguages}]";
|
|
}
|
|
|
|
if (mediaInfoAudioLanguages == "[EN]")
|
|
{
|
|
mediaInfoAudioLanguages = string.Empty;
|
|
}
|
|
|
|
var mediaInfoSubtitleLanguages = GetLanguagesToken(subtitles);
|
|
if (!mediaInfoSubtitleLanguages.IsNullOrWhiteSpace())
|
|
{
|
|
mediaInfoSubtitleLanguages = $"[{mediaInfoSubtitleLanguages}]";
|
|
}
|
|
|
|
var videoBitDepth = episodeFile.MediaInfo.VideoBitDepth > 0 ? episodeFile.MediaInfo.VideoBitDepth.ToString() : string.Empty;
|
|
var audioChannelsFormatted = audioChannels > 0 ?
|
|
audioChannels.ToString("F1", CultureInfo.InvariantCulture) :
|
|
string.Empty;
|
|
|
|
tokenHandlers["{MediaInfo Video}"] = m => videoCodec;
|
|
tokenHandlers["{MediaInfo VideoCodec}"] = m => videoCodec;
|
|
tokenHandlers["{MediaInfo VideoBitDepth}"] = m => videoBitDepth;
|
|
|
|
tokenHandlers["{MediaInfo Audio}"] = m => audioCodec;
|
|
tokenHandlers["{MediaInfo AudioCodec}"] = m => audioCodec;
|
|
tokenHandlers["{MediaInfo AudioChannels}"] = m => audioChannelsFormatted;
|
|
tokenHandlers["{MediaInfo AudioLanguages}"] = m => mediaInfoAudioLanguages;
|
|
|
|
tokenHandlers["{MediaInfo SubtitleLanguages}"] = m => mediaInfoSubtitleLanguages;
|
|
|
|
tokenHandlers["{MediaInfo Simple}"] = m => $"{videoCodec} {audioCodec}";
|
|
|
|
tokenHandlers["{MediaInfo Full}"] = m => $"{videoCodec} {audioCodec}{mediaInfoAudioLanguages} {mediaInfoSubtitleLanguages}";
|
|
|
|
tokenHandlers[MediaInfoVideoDynamicRangeToken] =
|
|
m => MediaInfoFormatter.FormatVideoDynamicRange(episodeFile.MediaInfo);
|
|
}
|
|
|
|
private void AddIdTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series)
|
|
{
|
|
tokenHandlers["{ImdbId}"] = m => series.ImdbId ?? string.Empty;
|
|
tokenHandlers["{TvdbId}"] = m => series.TvdbId.ToString();
|
|
tokenHandlers["{TvMazeId}"] = m => series.TvMazeId.ToString();
|
|
}
|
|
|
|
private void AddPreferredWords(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Series series, EpisodeFile episodeFile, List<string> preferredWords = null)
|
|
{
|
|
if (preferredWords == null)
|
|
{
|
|
preferredWords = _preferredWordService.GetMatchingPreferredWords(series, episodeFile.GetSceneOrFileName(), true);
|
|
}
|
|
|
|
tokenHandlers["{Preferred Words}"] = m => string.Join(" ", preferredWords);
|
|
}
|
|
|
|
private string GetLanguagesToken(string mediaInfoLanguages)
|
|
{
|
|
List<string> tokens = new List<string>();
|
|
foreach (var item in mediaInfoLanguages.Split('/'))
|
|
{
|
|
if (!string.IsNullOrWhiteSpace(item))
|
|
tokens.Add(item.Trim());
|
|
}
|
|
|
|
var cultures = CultureInfo.GetCultures(CultureTypes.NeutralCultures);
|
|
for (int i = 0; i < tokens.Count; i++)
|
|
{
|
|
try
|
|
{
|
|
var cultureInfo = cultures.FirstOrDefault(p => p.EnglishName == tokens[i]);
|
|
|
|
if (cultureInfo != null)
|
|
tokens[i] = cultureInfo.TwoLetterISOLanguageName.ToUpper();
|
|
}
|
|
catch
|
|
{
|
|
}
|
|
}
|
|
|
|
return string.Join("+", tokens.Distinct());
|
|
}
|
|
|
|
private void UpdateMediaInfoIfNeeded(string pattern, EpisodeFile episodeFile, Series series)
|
|
{
|
|
var schemaRevision = episodeFile.MediaInfo != null ? episodeFile.MediaInfo.SchemaRevision : 0;
|
|
var matches = TitleRegex.Matches(pattern);
|
|
|
|
var shouldUpdateMediaInfo = matches.Cast<Match>()
|
|
.Select(m => MinimumMediaInfoSchemaRevisions.GetValueOrDefault(m.Value, -1))
|
|
.Any(r => schemaRevision < r);
|
|
|
|
if (shouldUpdateMediaInfo)
|
|
{
|
|
_mediaInfoUpdater.Update(episodeFile, series);
|
|
}
|
|
}
|
|
|
|
private string ReplaceTokens(string pattern, Dictionary<string, Func<TokenMatch, string>> tokenHandlers, NamingConfig namingConfig)
|
|
{
|
|
return TitleRegex.Replace(pattern, match => ReplaceToken(match, tokenHandlers, namingConfig));
|
|
}
|
|
|
|
private string ReplaceToken(Match match, Dictionary<string, Func<TokenMatch, string>> tokenHandlers, NamingConfig namingConfig)
|
|
{
|
|
var tokenMatch = new TokenMatch
|
|
{
|
|
RegexMatch = match,
|
|
Prefix = match.Groups["prefix"].Value,
|
|
Separator = match.Groups["separator"].Value,
|
|
Suffix = match.Groups["suffix"].Value,
|
|
Token = match.Groups["token"].Value,
|
|
CustomFormat = match.Groups["customFormat"].Value
|
|
};
|
|
|
|
if (tokenMatch.CustomFormat.IsNullOrWhiteSpace())
|
|
{
|
|
tokenMatch.CustomFormat = null;
|
|
}
|
|
|
|
var tokenHandler = tokenHandlers.GetValueOrDefault(tokenMatch.Token, m => string.Empty);
|
|
|
|
var replacementText = tokenHandler(tokenMatch).Trim();
|
|
|
|
if (tokenMatch.Token.All(t => !char.IsLetter(t) || char.IsLower(t)))
|
|
{
|
|
replacementText = replacementText.ToLower();
|
|
}
|
|
else if (tokenMatch.Token.All(t => !char.IsLetter(t) || char.IsUpper(t)))
|
|
{
|
|
replacementText = replacementText.ToUpper();
|
|
}
|
|
|
|
if (!tokenMatch.Separator.IsNullOrWhiteSpace())
|
|
{
|
|
replacementText = replacementText.Replace(" ", tokenMatch.Separator);
|
|
}
|
|
|
|
replacementText = CleanFileName(replacementText, namingConfig.ReplaceIllegalCharacters);
|
|
|
|
if (!replacementText.IsNullOrWhiteSpace())
|
|
{
|
|
replacementText = tokenMatch.Prefix + replacementText + tokenMatch.Suffix;
|
|
}
|
|
|
|
return replacementText;
|
|
}
|
|
|
|
private string FormatNumberTokens(string basePattern, string formatPattern, List<Episode> episodes)
|
|
{
|
|
var pattern = string.Empty;
|
|
|
|
for (int i = 0; i < episodes.Count; i++)
|
|
{
|
|
var patternToReplace = i == 0 ? basePattern : formatPattern;
|
|
|
|
pattern += EpisodeRegex.Replace(patternToReplace, match => ReplaceNumberToken(match.Groups["episode"].Value, episodes[i].EpisodeNumber));
|
|
}
|
|
|
|
return ReplaceSeasonTokens(pattern, episodes.First().SeasonNumber);
|
|
}
|
|
|
|
private string FormatAbsoluteNumberTokens(string basePattern, string formatPattern, List<Episode> episodes)
|
|
{
|
|
var pattern = string.Empty;
|
|
|
|
for (int i = 0; i < episodes.Count; i++)
|
|
{
|
|
var patternToReplace = i == 0 ? basePattern : formatPattern;
|
|
|
|
pattern += AbsoluteEpisodeRegex.Replace(patternToReplace, match => ReplaceNumberToken(match.Groups["absolute"].Value, episodes[i].AbsoluteEpisodeNumber.Value));
|
|
}
|
|
|
|
return ReplaceSeasonTokens(pattern, episodes.First().SeasonNumber);
|
|
}
|
|
|
|
private string FormatRangeNumberTokens(string seasonEpisodePattern, string formatPattern, List<Episode> episodes)
|
|
{
|
|
var eps = new List<Episode> { episodes.First() };
|
|
|
|
if (episodes.Count > 1) eps.Add(episodes.Last());
|
|
|
|
return FormatNumberTokens(seasonEpisodePattern, formatPattern, eps);
|
|
}
|
|
|
|
private string ReplaceSeasonTokens(string pattern, int seasonNumber)
|
|
{
|
|
return SeasonRegex.Replace(pattern, match => ReplaceNumberToken(match.Groups["season"].Value, seasonNumber));
|
|
}
|
|
|
|
private string ReplaceNumberToken(string token, int value)
|
|
{
|
|
var split = token.Trim('{', '}').Split(':');
|
|
if (split.Length == 1) return value.ToString("0");
|
|
|
|
return value.ToString(split[1]);
|
|
}
|
|
|
|
private EpisodeFormat[] GetEpisodeFormat(string pattern)
|
|
{
|
|
return _episodeFormatCache.Get(pattern, () => SeasonEpisodePatternRegex.Matches(pattern).OfType<Match>()
|
|
.Select(match => new EpisodeFormat
|
|
{
|
|
EpisodeSeparator = match.Groups["episodeSeparator"].Value,
|
|
Separator = match.Groups["separator"].Value,
|
|
EpisodePattern = match.Groups["episode"].Value,
|
|
SeasonEpisodePattern = match.Groups["seasonEpisode"].Value,
|
|
}).ToArray());
|
|
}
|
|
|
|
private AbsoluteEpisodeFormat[] GetAbsoluteFormat(string pattern)
|
|
{
|
|
return _absoluteEpisodeFormatCache.Get(pattern, () => AbsoluteEpisodePatternRegex.Matches(pattern).OfType<Match>()
|
|
.Select(match => new AbsoluteEpisodeFormat
|
|
{
|
|
Separator = match.Groups["separator"].Value.IsNotNullOrWhiteSpace() ? match.Groups["separator"].Value : "-",
|
|
AbsoluteEpisodePattern = match.Groups["absolute"].Value
|
|
}).ToArray());
|
|
}
|
|
|
|
private string GetEpisodeTitle(List<Episode> episodes, string separator)
|
|
{
|
|
separator = string.Format(" {0} ", separator.Trim());
|
|
|
|
if (episodes.Count == 1)
|
|
{
|
|
return episodes.First().Title.TrimEnd(EpisodeTitleTrimCharacters);
|
|
}
|
|
|
|
var titles = episodes.Select(c => c.Title.TrimEnd(EpisodeTitleTrimCharacters))
|
|
.Select(CleanupEpisodeTitle)
|
|
.Distinct()
|
|
.ToList();
|
|
|
|
if (titles.All(t => t.IsNullOrWhiteSpace()))
|
|
{
|
|
titles = episodes.Select(c => c.Title.TrimEnd(EpisodeTitleTrimCharacters))
|
|
.Distinct()
|
|
.ToList();
|
|
}
|
|
|
|
return string.Join(separator, titles);
|
|
}
|
|
|
|
private string CleanupEpisodeTitle(string title)
|
|
{
|
|
//this will remove (1),(2) from the end of multi part episodes.
|
|
return MultiPartCleanupRegex.Replace(title, string.Empty).Trim();
|
|
}
|
|
|
|
private string GetQualityProper(Series series, QualityModel quality)
|
|
{
|
|
if (quality.Revision.Version > 1)
|
|
{
|
|
if (series.SeriesType == SeriesTypes.Anime)
|
|
{
|
|
return "v" + quality.Revision.Version;
|
|
}
|
|
|
|
return "Proper";
|
|
}
|
|
|
|
return String.Empty;
|
|
}
|
|
|
|
private string GetQualityReal(Series series, QualityModel quality)
|
|
{
|
|
if (quality.Revision.Real > 0)
|
|
{
|
|
return "REAL";
|
|
}
|
|
|
|
return string.Empty;
|
|
}
|
|
|
|
private string GetOriginalTitle(EpisodeFile episodeFile)
|
|
{
|
|
if (episodeFile.SceneName.IsNullOrWhiteSpace())
|
|
{
|
|
return GetOriginalFileName(episodeFile);
|
|
}
|
|
|
|
return episodeFile.SceneName;
|
|
}
|
|
|
|
private string GetOriginalFileName(EpisodeFile episodeFile)
|
|
{
|
|
if (episodeFile.RelativePath.IsNullOrWhiteSpace())
|
|
{
|
|
return Path.GetFileNameWithoutExtension(episodeFile.Path);
|
|
}
|
|
|
|
return Path.GetFileNameWithoutExtension(episodeFile.RelativePath);
|
|
}
|
|
}
|
|
|
|
internal sealed class TokenMatch
|
|
{
|
|
public Match RegexMatch { get; set; }
|
|
public string Prefix { get; set; }
|
|
public string Separator { get; set; }
|
|
public string Suffix { get; set; }
|
|
public string Token { get; set; }
|
|
public string CustomFormat { get; set; }
|
|
|
|
public string DefaultValue(string defaultValue)
|
|
{
|
|
if (string.IsNullOrEmpty(Prefix) && string.IsNullOrEmpty(Suffix))
|
|
{
|
|
return defaultValue;
|
|
}
|
|
else
|
|
{
|
|
return string.Empty;
|
|
}
|
|
}
|
|
}
|
|
|
|
public enum MultiEpisodeStyle
|
|
{
|
|
Extend = 0,
|
|
Duplicate = 1,
|
|
Repeat = 2,
|
|
Scene = 3,
|
|
Range = 4,
|
|
PrefixedRange = 5
|
|
}
|
|
}
|