mirror of
https://github.com/Readarr/Readarr.git
synced 2026-04-23 22:25:09 -04:00
ta264
442 lines
18 KiB
C#
442 lines
18 KiB
C#
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.Music;
|
|
using NzbDrone.Core.Profiles.Releases;
|
|
using NzbDrone.Core.Qualities;
|
|
|
|
namespace NzbDrone.Core.Organizer
|
|
{
|
|
public interface IBuildFileNames
|
|
{
|
|
string BuildTrackFileName(Author artist, Book album, BookFile trackFile, NamingConfig namingConfig = null, List<string> preferredWords = null);
|
|
string BuildTrackFilePath(Author artist, Book album, string fileName, string extension);
|
|
string BuildAlbumPath(Author artist, Book album);
|
|
BasicNamingConfig GetBasicNamingConfig(NamingConfig nameSpec);
|
|
string GetArtistFolder(Author artist, NamingConfig namingConfig = null);
|
|
}
|
|
|
|
public class FileNameBuilder : IBuildFileNames
|
|
{
|
|
private readonly INamingConfigService _namingConfigService;
|
|
private readonly IQualityDefinitionService _qualityDefinitionService;
|
|
private readonly IPreferredWordService _preferredWordService;
|
|
private readonly ICached<TrackFormat[]> _trackFormatCache;
|
|
private readonly ICached<AbsoluteTrackFormat[]> _absoluteTrackFormatCache;
|
|
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);
|
|
|
|
public static readonly Regex TrackRegex = new Regex(@"(?<track>\{track(?:\:0+)?})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
private static readonly Regex MediumRegex = new Regex(@"(?<medium>\{medium(?:\: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 ReleaseDateRegex = new Regex(@"\{Release(\s|\W|_)Year\}", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex ArtistNameRegex = new Regex(@"(?<token>\{(?:Artist)(?<separator>[- ._])(Clean)?Name(The)?\})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex AlbumTitleRegex = new Regex(@"(?<token>\{(?:Album)(?<separator>[- ._])(Clean)?Title(The)?\})",
|
|
RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public static readonly Regex TrackTitleRegex = new Regex(@"(?<token>\{(?:Track)(?<separator>[- ._])(Clean)?Title(The)?\})",
|
|
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[] TrackTitleTrimCharacters = new[] { ' ', '.', '?' };
|
|
|
|
private static readonly Regex TitlePrefixRegex = new Regex(@"^(The|An|A) (.*?)((?: *\([^)]+\))*)$", RegexOptions.Compiled | RegexOptions.IgnoreCase);
|
|
|
|
public FileNameBuilder(INamingConfigService namingConfigService,
|
|
IQualityDefinitionService qualityDefinitionService,
|
|
ICacheManager cacheManager,
|
|
IPreferredWordService preferredWordService,
|
|
Logger logger)
|
|
{
|
|
_namingConfigService = namingConfigService;
|
|
_qualityDefinitionService = qualityDefinitionService;
|
|
_preferredWordService = preferredWordService;
|
|
_trackFormatCache = cacheManager.GetCache<TrackFormat[]>(GetType(), "trackFormat");
|
|
_absoluteTrackFormatCache = cacheManager.GetCache<AbsoluteTrackFormat[]>(GetType(), "absoluteTrackFormat");
|
|
_logger = logger;
|
|
}
|
|
|
|
public string BuildTrackFileName(Author artist, Book album, BookFile trackFile, NamingConfig namingConfig = null, List<string> preferredWords = null)
|
|
{
|
|
if (namingConfig == null)
|
|
{
|
|
namingConfig = _namingConfigService.GetConfig();
|
|
}
|
|
|
|
if (!namingConfig.RenameTracks)
|
|
{
|
|
return GetOriginalFileName(trackFile);
|
|
}
|
|
|
|
if (namingConfig.StandardTrackFormat.IsNullOrWhiteSpace())
|
|
{
|
|
throw new NamingFormatException("File name format cannot be empty");
|
|
}
|
|
|
|
var pattern = namingConfig.StandardTrackFormat;
|
|
|
|
var subFolders = pattern.Split(new[] { '/', '\\' }, StringSplitOptions.RemoveEmptyEntries);
|
|
var safePattern = subFolders.Aggregate("", (current, folderLevel) => Path.Combine(current, folderLevel));
|
|
|
|
var tokenHandlers = new Dictionary<string, Func<TokenMatch, string>>(FileNameBuilderTokenEqualityComparer.Instance);
|
|
|
|
AddArtistTokens(tokenHandlers, artist);
|
|
AddAlbumTokens(tokenHandlers, album);
|
|
AddTrackFileTokens(tokenHandlers, trackFile);
|
|
AddQualityTokens(tokenHandlers, artist, trackFile);
|
|
AddMediaInfoTokens(tokenHandlers, trackFile);
|
|
AddPreferredWords(tokenHandlers, artist, trackFile, preferredWords);
|
|
|
|
var fileName = ReplaceTokens(safePattern, tokenHandlers, namingConfig).Trim();
|
|
fileName = FileNameCleanupRegex.Replace(fileName, match => match.Captures[0].Value[0].ToString());
|
|
fileName = TrimSeparatorsRegex.Replace(fileName, string.Empty);
|
|
|
|
return fileName;
|
|
}
|
|
|
|
public string BuildTrackFilePath(Author artist, Book album, string fileName, string extension)
|
|
{
|
|
Ensure.That(extension, () => extension).IsNotNullOrWhiteSpace();
|
|
|
|
var path = BuildAlbumPath(artist, album);
|
|
|
|
return Path.Combine(path, fileName + extension);
|
|
}
|
|
|
|
public string BuildAlbumPath(Author artist, Book album)
|
|
{
|
|
var path = artist.Path;
|
|
|
|
return path;
|
|
}
|
|
|
|
public BasicNamingConfig GetBasicNamingConfig(NamingConfig nameSpec)
|
|
{
|
|
var trackFormat = GetTrackFormat(nameSpec.StandardTrackFormat).LastOrDefault();
|
|
|
|
if (trackFormat == null)
|
|
{
|
|
return new BasicNamingConfig();
|
|
}
|
|
|
|
var basicNamingConfig = new BasicNamingConfig
|
|
{
|
|
Separator = trackFormat.Separator
|
|
};
|
|
|
|
var titleTokens = TitleRegex.Matches(nameSpec.StandardTrackFormat);
|
|
|
|
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("{Artist", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeArtistName = true;
|
|
}
|
|
|
|
if (token.StartsWith("{Album", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeAlbumTitle = true;
|
|
}
|
|
|
|
if (token.StartsWith("{Quality", StringComparison.InvariantCultureIgnoreCase))
|
|
{
|
|
basicNamingConfig.IncludeQuality = true;
|
|
}
|
|
}
|
|
|
|
return basicNamingConfig;
|
|
}
|
|
|
|
public string GetArtistFolder(Author artist, NamingConfig namingConfig = null)
|
|
{
|
|
if (namingConfig == null)
|
|
{
|
|
namingConfig = _namingConfigService.GetConfig();
|
|
}
|
|
|
|
var tokenHandlers = new Dictionary<string, Func<TokenMatch, string>>(FileNameBuilderTokenEqualityComparer.Instance);
|
|
|
|
AddArtistTokens(tokenHandlers, artist);
|
|
|
|
return CleanFolderName(ReplaceTokens(namingConfig.ArtistFolderFormat, tokenHandlers, namingConfig));
|
|
}
|
|
|
|
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 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.Trim();
|
|
}
|
|
|
|
public static string CleanFolderName(string name)
|
|
{
|
|
name = FileNameCleanupRegex.Replace(name, match => match.Captures[0].Value[0].ToString());
|
|
return name.Trim(' ', '.');
|
|
}
|
|
|
|
private void AddArtistTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Author artist)
|
|
{
|
|
tokenHandlers["{Artist Name}"] = m => artist.Name;
|
|
tokenHandlers["{Artist CleanName}"] = m => CleanTitle(artist.Name);
|
|
tokenHandlers["{Artist NameThe}"] = m => TitleThe(artist.Name);
|
|
|
|
if (artist.Metadata.Value.Disambiguation != null)
|
|
{
|
|
tokenHandlers["{Artist Disambiguation}"] = m => artist.Metadata.Value.Disambiguation;
|
|
}
|
|
}
|
|
|
|
private void AddAlbumTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Book album)
|
|
{
|
|
tokenHandlers["{Album Title}"] = m => album.Title;
|
|
tokenHandlers["{Album CleanTitle}"] = m => CleanTitle(album.Title);
|
|
tokenHandlers["{Album TitleThe}"] = m => TitleThe(album.Title);
|
|
|
|
if (album.Disambiguation != null)
|
|
{
|
|
tokenHandlers["{Album Disambiguation}"] = m => album.Disambiguation;
|
|
}
|
|
|
|
if (album.ReleaseDate.HasValue)
|
|
{
|
|
tokenHandlers["{Release Year}"] = m => album.ReleaseDate.Value.Year.ToString();
|
|
}
|
|
else
|
|
{
|
|
tokenHandlers["{Release Year}"] = m => "Unknown";
|
|
}
|
|
}
|
|
|
|
private void AddTrackFileTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, BookFile trackFile)
|
|
{
|
|
tokenHandlers["{Original Title}"] = m => GetOriginalTitle(trackFile);
|
|
tokenHandlers["{Original Filename}"] = m => GetOriginalFileName(trackFile);
|
|
tokenHandlers["{Release Group}"] = m => trackFile.ReleaseGroup ?? m.DefaultValue("Readarr");
|
|
}
|
|
|
|
private void AddQualityTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Author artist, BookFile trackFile)
|
|
{
|
|
var qualityTitle = _qualityDefinitionService.Get(trackFile.Quality.Quality).Title;
|
|
var qualityProper = GetQualityProper(trackFile.Quality);
|
|
|
|
//var qualityReal = GetQualityReal(artist, trackFile.Quality);
|
|
tokenHandlers["{Quality Full}"] = m => string.Format("{0}", qualityTitle);
|
|
tokenHandlers["{Quality Title}"] = m => qualityTitle;
|
|
tokenHandlers["{Quality Proper}"] = m => qualityProper;
|
|
|
|
//tokenHandlers["{Quality Real}"] = m => qualityReal;
|
|
}
|
|
|
|
private void AddMediaInfoTokens(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, BookFile trackFile)
|
|
{
|
|
if (trackFile.MediaInfo == null)
|
|
{
|
|
_logger.Trace("Media info is unavailable for {0}", trackFile);
|
|
|
|
return;
|
|
}
|
|
|
|
var audioCodec = MediaInfoFormatter.FormatAudioCodec(trackFile.MediaInfo);
|
|
var audioChannels = MediaInfoFormatter.FormatAudioChannels(trackFile.MediaInfo);
|
|
var audioChannelsFormatted = audioChannels > 0 ?
|
|
audioChannels.ToString("F1", CultureInfo.InvariantCulture) :
|
|
string.Empty;
|
|
|
|
tokenHandlers["{MediaInfo AudioCodec}"] = m => audioCodec;
|
|
tokenHandlers["{MediaInfo AudioChannels}"] = m => audioChannelsFormatted;
|
|
tokenHandlers["{MediaInfo AudioBitRate}"] = m => MediaInfoFormatter.FormatAudioBitrate(trackFile.MediaInfo);
|
|
tokenHandlers["{MediaInfo AudioBitsPerSample}"] = m => MediaInfoFormatter.FormatAudioBitsPerSample(trackFile.MediaInfo);
|
|
tokenHandlers["{MediaInfo AudioSampleRate}"] = m => MediaInfoFormatter.FormatAudioSampleRate(trackFile.MediaInfo);
|
|
}
|
|
|
|
private void AddPreferredWords(Dictionary<string, Func<TokenMatch, string>> tokenHandlers, Author artist, BookFile trackFile, List<string> preferredWords = null)
|
|
{
|
|
if (preferredWords == null)
|
|
{
|
|
preferredWords = _preferredWordService.GetMatchingPreferredWords(artist, trackFile.GetSceneOrFileName());
|
|
}
|
|
|
|
tokenHandlers["{Preferred Words}"] = m => string.Join(" ", preferredWords);
|
|
}
|
|
|
|
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 TrackFormat[] GetTrackFormat(string pattern)
|
|
{
|
|
return _trackFormatCache.Get(pattern, () => SeasonEpisodePatternRegex.Matches(pattern).OfType<Match>()
|
|
.Select(match => new TrackFormat
|
|
{
|
|
TrackSeparator = match.Groups["episodeSeparator"].Value,
|
|
Separator = match.Groups["separator"].Value,
|
|
TrackPattern = match.Groups["episode"].Value,
|
|
}).ToArray());
|
|
}
|
|
|
|
private string GetQualityProper(QualityModel quality)
|
|
{
|
|
if (quality.Revision.Version > 1)
|
|
{
|
|
if (quality.Revision.IsRepack)
|
|
{
|
|
return "Repack";
|
|
}
|
|
|
|
return "Proper";
|
|
}
|
|
|
|
return string.Empty;
|
|
}
|
|
|
|
private string GetOriginalTitle(BookFile trackFile)
|
|
{
|
|
if (trackFile.SceneName.IsNullOrWhiteSpace())
|
|
{
|
|
return GetOriginalFileName(trackFile);
|
|
}
|
|
|
|
return trackFile.SceneName;
|
|
}
|
|
|
|
private string GetOriginalFileName(BookFile trackFile)
|
|
{
|
|
return Path.GetFileNameWithoutExtension(trackFile.Path);
|
|
}
|
|
}
|
|
|
|
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
|
|
}
|
|
}
|