EpisodeFileOrganizer.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. using MediaBrowser.Common.IO;
  2. using MediaBrowser.Controller.Configuration;
  3. using MediaBrowser.Controller.Entities.TV;
  4. using MediaBrowser.Controller.FileOrganization;
  5. using MediaBrowser.Controller.Library;
  6. using MediaBrowser.Controller.Providers;
  7. using MediaBrowser.Model.Entities;
  8. using MediaBrowser.Model.Extensions;
  9. using MediaBrowser.Model.FileOrganization;
  10. using MediaBrowser.Model.Logging;
  11. using MediaBrowser.Server.Implementations.Library;
  12. using MediaBrowser.Server.Implementations.Logging;
  13. using System;
  14. using System.Collections.Generic;
  15. using System.Globalization;
  16. using System.IO;
  17. using System.Linq;
  18. using System.Threading;
  19. using System.Threading.Tasks;
  20. using CommonIO;
  21. namespace MediaBrowser.Server.Implementations.FileOrganization
  22. {
  23. public class EpisodeFileOrganizer
  24. {
  25. private readonly ILibraryMonitor _libraryMonitor;
  26. private readonly ILibraryManager _libraryManager;
  27. private readonly ILogger _logger;
  28. private readonly IFileSystem _fileSystem;
  29. private readonly IFileOrganizationService _organizationService;
  30. private readonly IServerConfigurationManager _config;
  31. private readonly IProviderManager _providerManager;
  32. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  33. public EpisodeFileOrganizer(IFileOrganizationService organizationService, IServerConfigurationManager config, IFileSystem fileSystem, ILogger logger, ILibraryManager libraryManager, ILibraryMonitor libraryMonitor, IProviderManager providerManager)
  34. {
  35. _organizationService = organizationService;
  36. _config = config;
  37. _fileSystem = fileSystem;
  38. _logger = logger;
  39. _libraryManager = libraryManager;
  40. _libraryMonitor = libraryMonitor;
  41. _providerManager = providerManager;
  42. }
  43. public Task<FileOrganizationResult> OrganizeEpisodeFile(string path, CancellationToken cancellationToken)
  44. {
  45. var options = _config.GetAutoOrganizeOptions();
  46. return OrganizeEpisodeFile(path, options, false, cancellationToken);
  47. }
  48. public async Task<FileOrganizationResult> OrganizeEpisodeFile(string path, AutoOrganizeOptions options, bool overwriteExisting, CancellationToken cancellationToken)
  49. {
  50. _logger.Info("Sorting file {0}", path);
  51. var result = new FileOrganizationResult
  52. {
  53. Date = DateTime.UtcNow,
  54. OriginalPath = path,
  55. OriginalFileName = Path.GetFileName(path),
  56. Type = FileOrganizerType.Episode,
  57. FileSize = new FileInfo(path).Length
  58. };
  59. if (_libraryMonitor.IsPathLocked(path))
  60. {
  61. result.Status = FileSortingStatus.Failure;
  62. result.StatusMessage = "Path is locked by other processes. Please try again later.";
  63. return result;
  64. }
  65. var namingOptions = ((LibraryManager)_libraryManager).GetNamingOptions();
  66. var resolver = new Naming.TV.EpisodeResolver(namingOptions, new PatternsLogger());
  67. var episodeInfo = resolver.Resolve(path, false) ??
  68. new Naming.TV.EpisodeInfo();
  69. var seriesName = episodeInfo.SeriesName;
  70. if (!string.IsNullOrEmpty(seriesName))
  71. {
  72. var seasonNumber = episodeInfo.SeasonNumber;
  73. result.ExtractedSeasonNumber = seasonNumber;
  74. // Passing in true will include a few extra regex's
  75. var episodeNumber = episodeInfo.EpisodeNumber;
  76. result.ExtractedEpisodeNumber = episodeNumber;
  77. var premiereDate = episodeInfo.IsByDate ?
  78. new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value) :
  79. (DateTime?)null;
  80. if (episodeInfo.IsByDate || (seasonNumber.HasValue && episodeNumber.HasValue))
  81. {
  82. if (episodeInfo.IsByDate)
  83. {
  84. _logger.Debug("Extracted information from {0}. Series name {1}, Date {2}", path, seriesName, premiereDate.Value);
  85. }
  86. else
  87. {
  88. _logger.Debug("Extracted information from {0}. Series name {1}, Season {2}, Episode {3}", path, seriesName, seasonNumber, episodeNumber);
  89. }
  90. var endingEpisodeNumber = episodeInfo.EndingEpsiodeNumber;
  91. result.ExtractedEndingEpisodeNumber = endingEpisodeNumber;
  92. await OrganizeEpisode(path,
  93. seriesName,
  94. seasonNumber,
  95. episodeNumber,
  96. endingEpisodeNumber,
  97. premiereDate,
  98. options,
  99. overwriteExisting,
  100. false,
  101. result,
  102. cancellationToken).ConfigureAwait(false);
  103. }
  104. else
  105. {
  106. var msg = string.Format("Unable to determine episode number from {0}", path);
  107. result.Status = FileSortingStatus.Failure;
  108. result.StatusMessage = msg;
  109. _logger.Warn(msg);
  110. }
  111. }
  112. else
  113. {
  114. var msg = string.Format("Unable to determine series name from {0}", path);
  115. result.Status = FileSortingStatus.Failure;
  116. result.StatusMessage = msg;
  117. _logger.Warn(msg);
  118. }
  119. var previousResult = _organizationService.GetResultBySourcePath(path);
  120. if (previousResult != null)
  121. {
  122. // Don't keep saving the same result over and over if nothing has changed
  123. if (previousResult.Status == result.Status && previousResult.StatusMessage == result.StatusMessage && result.Status != FileSortingStatus.Success)
  124. {
  125. return previousResult;
  126. }
  127. }
  128. await _organizationService.SaveResult(result, CancellationToken.None).ConfigureAwait(false);
  129. return result;
  130. }
  131. public async Task<FileOrganizationResult> OrganizeWithCorrection(EpisodeFileOrganizationRequest request, AutoOrganizeOptions options, CancellationToken cancellationToken)
  132. {
  133. var result = _organizationService.GetResult(request.ResultId);
  134. Series series = null;
  135. if (request.NewSeriesProviderIds.Count > 0)
  136. {
  137. // We're having a new series here
  138. SeriesInfo seriesRequest = new SeriesInfo();
  139. seriesRequest.ProviderIds = request.NewSeriesProviderIds;
  140. var refreshOptions = new MetadataRefreshOptions(_fileSystem);
  141. series = new Series();
  142. series.Id = Guid.NewGuid();
  143. series.Name = request.NewSeriesName;
  144. int year;
  145. if (int.TryParse(request.NewSeriesYear, out year))
  146. {
  147. series.ProductionYear = year;
  148. }
  149. var seriesFolderName = series.Name;
  150. if (series.ProductionYear.HasValue)
  151. {
  152. seriesFolderName = string.Format("{0} ({1})", seriesFolderName, series.ProductionYear);
  153. }
  154. series.Path = Path.Combine(request.TargetFolder, seriesFolderName);
  155. series.ProviderIds = request.NewSeriesProviderIds;
  156. await series.RefreshMetadata(refreshOptions, cancellationToken);
  157. }
  158. if (series == null)
  159. {
  160. // Existing Series
  161. series = (Series)_libraryManager.GetItemById(new Guid(request.SeriesId));
  162. }
  163. await OrganizeEpisode(result.OriginalPath,
  164. series,
  165. request.SeasonNumber,
  166. request.EpisodeNumber,
  167. request.EndingEpisodeNumber,
  168. null,
  169. options,
  170. true,
  171. request.RememberCorrection,
  172. result,
  173. cancellationToken).ConfigureAwait(false);
  174. await _organizationService.SaveResult(result, CancellationToken.None).ConfigureAwait(false);
  175. return result;
  176. }
  177. private Task OrganizeEpisode(string sourcePath,
  178. string seriesName,
  179. int? seasonNumber,
  180. int? episodeNumber,
  181. int? endingEpiosdeNumber,
  182. DateTime? premiereDate,
  183. AutoOrganizeOptions options,
  184. bool overwriteExisting,
  185. bool rememberCorrection,
  186. FileOrganizationResult result,
  187. CancellationToken cancellationToken)
  188. {
  189. var series = GetMatchingSeries(seriesName, result, options);
  190. if (series == null)
  191. {
  192. var msg = string.Format("Unable to find series in library matching name {0}", seriesName);
  193. result.Status = FileSortingStatus.Failure;
  194. result.StatusMessage = msg;
  195. _logger.Warn(msg);
  196. return Task.FromResult(true);
  197. }
  198. return OrganizeEpisode(sourcePath,
  199. series,
  200. seasonNumber,
  201. episodeNumber,
  202. endingEpiosdeNumber,
  203. premiereDate,
  204. options,
  205. overwriteExisting,
  206. rememberCorrection,
  207. result,
  208. cancellationToken);
  209. }
  210. private async Task OrganizeEpisode(string sourcePath,
  211. Series series,
  212. int? seasonNumber,
  213. int? episodeNumber,
  214. int? endingEpiosdeNumber,
  215. DateTime? premiereDate,
  216. AutoOrganizeOptions options,
  217. bool overwriteExisting,
  218. bool rememberCorrection,
  219. FileOrganizationResult result,
  220. CancellationToken cancellationToken)
  221. {
  222. _logger.Info("Sorting file {0} into series {1}", sourcePath, series.Path);
  223. var originalExtractedSeriesString = result.ExtractedName;
  224. // Proceed to sort the file
  225. var newPath = await GetNewPath(sourcePath, series, seasonNumber, episodeNumber, endingEpiosdeNumber, premiereDate, options.TvOptions, cancellationToken).ConfigureAwait(false);
  226. if (string.IsNullOrEmpty(newPath))
  227. {
  228. var msg = string.Format("Unable to sort {0} because target path could not be determined.", sourcePath);
  229. result.Status = FileSortingStatus.Failure;
  230. result.StatusMessage = msg;
  231. _logger.Warn(msg);
  232. return;
  233. }
  234. _logger.Info("Sorting file {0} to new path {1}", sourcePath, newPath);
  235. result.TargetPath = newPath;
  236. var fileExists = _fileSystem.FileExists(result.TargetPath);
  237. var otherDuplicatePaths = GetOtherDuplicatePaths(result.TargetPath, series, seasonNumber, episodeNumber, endingEpiosdeNumber);
  238. if (!overwriteExisting)
  239. {
  240. if (options.TvOptions.CopyOriginalFile && fileExists && IsSameEpisode(sourcePath, newPath))
  241. {
  242. _logger.Info("File {0} already copied to new path {1}, stopping organization", sourcePath, newPath);
  243. result.Status = FileSortingStatus.SkippedExisting;
  244. result.StatusMessage = string.Empty;
  245. return;
  246. }
  247. if (fileExists || otherDuplicatePaths.Count > 0)
  248. {
  249. result.Status = FileSortingStatus.SkippedExisting;
  250. result.StatusMessage = string.Empty;
  251. result.DuplicatePaths = otherDuplicatePaths;
  252. return;
  253. }
  254. }
  255. PerformFileSorting(options.TvOptions, result);
  256. if (overwriteExisting)
  257. {
  258. var hasRenamedFiles = false;
  259. foreach (var path in otherDuplicatePaths)
  260. {
  261. _logger.Debug("Removing duplicate episode {0}", path);
  262. _libraryMonitor.ReportFileSystemChangeBeginning(path);
  263. var renameRelatedFiles = !hasRenamedFiles &&
  264. string.Equals(Path.GetDirectoryName(path), Path.GetDirectoryName(result.TargetPath), StringComparison.OrdinalIgnoreCase);
  265. if (renameRelatedFiles)
  266. {
  267. hasRenamedFiles = true;
  268. }
  269. try
  270. {
  271. DeleteLibraryFile(path, renameRelatedFiles, result.TargetPath);
  272. }
  273. catch (IOException ex)
  274. {
  275. _logger.ErrorException("Error removing duplicate episode", ex, path);
  276. }
  277. finally
  278. {
  279. _libraryMonitor.ReportFileSystemChangeComplete(path, true);
  280. }
  281. }
  282. }
  283. if (rememberCorrection)
  284. {
  285. SaveSmartMatchString(originalExtractedSeriesString, series, options);
  286. }
  287. }
  288. private void SaveSmartMatchString(string matchString, Series series, AutoOrganizeOptions options)
  289. {
  290. SmartMatchInfo info = options.SmartMatchInfos.FirstOrDefault(i => string.Equals(i.ItemName, series.Name, StringComparison.OrdinalIgnoreCase));
  291. if (info == null)
  292. {
  293. info = new SmartMatchInfo();
  294. info.ItemName = series.Name;
  295. info.OrganizerType = FileOrganizerType.Episode;
  296. info.DisplayName = series.Name;
  297. var list = options.SmartMatchInfos.ToList();
  298. list.Add(info);
  299. options.SmartMatchInfos = list.ToArray();
  300. }
  301. if (!info.MatchStrings.Contains(matchString, StringComparer.OrdinalIgnoreCase))
  302. {
  303. var list = info.MatchStrings.ToList();
  304. list.Add(matchString);
  305. info.MatchStrings = list.ToArray();
  306. _config.SaveAutoOrganizeOptions(options);
  307. }
  308. }
  309. private void DeleteLibraryFile(string path, bool renameRelatedFiles, string targetPath)
  310. {
  311. _fileSystem.DeleteFile(path);
  312. if (!renameRelatedFiles)
  313. {
  314. return;
  315. }
  316. // Now find other files
  317. var originalFilenameWithoutExtension = Path.GetFileNameWithoutExtension(path);
  318. var directory = Path.GetDirectoryName(path);
  319. if (!string.IsNullOrWhiteSpace(originalFilenameWithoutExtension) && !string.IsNullOrWhiteSpace(directory))
  320. {
  321. // Get all related files, e.g. metadata, images, etc
  322. var files = _fileSystem.GetFilePaths(directory)
  323. .Where(i => (Path.GetFileNameWithoutExtension(i) ?? string.Empty).StartsWith(originalFilenameWithoutExtension, StringComparison.OrdinalIgnoreCase))
  324. .ToList();
  325. var targetFilenameWithoutExtension = Path.GetFileNameWithoutExtension(targetPath);
  326. foreach (var file in files)
  327. {
  328. directory = Path.GetDirectoryName(file);
  329. var filename = Path.GetFileName(file);
  330. filename = filename.Replace(originalFilenameWithoutExtension, targetFilenameWithoutExtension,
  331. StringComparison.OrdinalIgnoreCase);
  332. var destination = Path.Combine(directory, filename);
  333. _fileSystem.MoveFile(file, destination);
  334. }
  335. }
  336. }
  337. private List<string> GetOtherDuplicatePaths(string targetPath,
  338. Series series,
  339. int? seasonNumber,
  340. int? episodeNumber,
  341. int? endingEpisodeNumber)
  342. {
  343. // TODO: Support date-naming?
  344. if (!seasonNumber.HasValue || !episodeNumber.HasValue)
  345. {
  346. return new List<string>();
  347. }
  348. var episodePaths = series.GetRecursiveChildren()
  349. .OfType<Episode>()
  350. .Where(i =>
  351. {
  352. var locationType = i.LocationType;
  353. // Must be file system based and match exactly
  354. if (locationType != LocationType.Remote &&
  355. locationType != LocationType.Virtual &&
  356. i.ParentIndexNumber.HasValue &&
  357. i.ParentIndexNumber.Value == seasonNumber &&
  358. i.IndexNumber.HasValue &&
  359. i.IndexNumber.Value == episodeNumber)
  360. {
  361. if (endingEpisodeNumber.HasValue || i.IndexNumberEnd.HasValue)
  362. {
  363. return endingEpisodeNumber.HasValue && i.IndexNumberEnd.HasValue &&
  364. endingEpisodeNumber.Value == i.IndexNumberEnd.Value;
  365. }
  366. return true;
  367. }
  368. return false;
  369. })
  370. .Select(i => i.Path)
  371. .ToList();
  372. var folder = Path.GetDirectoryName(targetPath);
  373. var targetFileNameWithoutExtension = _fileSystem.GetFileNameWithoutExtension(targetPath);
  374. try
  375. {
  376. var filesOfOtherExtensions = _fileSystem.GetFilePaths(folder)
  377. .Where(i => _libraryManager.IsVideoFile(i) && string.Equals(_fileSystem.GetFileNameWithoutExtension(i), targetFileNameWithoutExtension, StringComparison.OrdinalIgnoreCase));
  378. episodePaths.AddRange(filesOfOtherExtensions);
  379. }
  380. catch (DirectoryNotFoundException)
  381. {
  382. // No big deal. Maybe the season folder doesn't already exist.
  383. }
  384. return episodePaths.Where(i => !string.Equals(i, targetPath, StringComparison.OrdinalIgnoreCase))
  385. .Distinct(StringComparer.OrdinalIgnoreCase)
  386. .ToList();
  387. }
  388. private void PerformFileSorting(TvFileOrganizationOptions options, FileOrganizationResult result)
  389. {
  390. _libraryMonitor.ReportFileSystemChangeBeginning(result.TargetPath);
  391. _fileSystem.CreateDirectory(Path.GetDirectoryName(result.TargetPath));
  392. var targetAlreadyExists = _fileSystem.FileExists(result.TargetPath);
  393. try
  394. {
  395. if (targetAlreadyExists || options.CopyOriginalFile)
  396. {
  397. _fileSystem.CopyFile(result.OriginalPath, result.TargetPath, true);
  398. }
  399. else
  400. {
  401. _fileSystem.MoveFile(result.OriginalPath, result.TargetPath);
  402. }
  403. result.Status = FileSortingStatus.Success;
  404. result.StatusMessage = string.Empty;
  405. }
  406. catch (Exception ex)
  407. {
  408. var errorMsg = string.Format("Failed to move file from {0} to {1}", result.OriginalPath, result.TargetPath);
  409. result.Status = FileSortingStatus.Failure;
  410. result.StatusMessage = errorMsg;
  411. _logger.ErrorException(errorMsg, ex);
  412. return;
  413. }
  414. finally
  415. {
  416. _libraryMonitor.ReportFileSystemChangeComplete(result.TargetPath, true);
  417. }
  418. if (targetAlreadyExists && !options.CopyOriginalFile)
  419. {
  420. try
  421. {
  422. _fileSystem.DeleteFile(result.OriginalPath);
  423. }
  424. catch (Exception ex)
  425. {
  426. _logger.ErrorException("Error deleting {0}", ex, result.OriginalPath);
  427. }
  428. }
  429. }
  430. private Series GetMatchingSeries(string seriesName, FileOrganizationResult result, AutoOrganizeOptions options)
  431. {
  432. var parsedName = _libraryManager.ParseName(seriesName);
  433. var yearInName = parsedName.Year;
  434. var nameWithoutYear = parsedName.Name;
  435. result.ExtractedName = nameWithoutYear;
  436. result.ExtractedYear = yearInName;
  437. var series = _libraryManager.RootFolder.GetRecursiveChildren(i => i is Series)
  438. .Cast<Series>()
  439. .Select(i => NameUtils.GetMatchScore(nameWithoutYear, yearInName, i))
  440. .Where(i => i.Item2 > 0)
  441. .OrderByDescending(i => i.Item2)
  442. .Select(i => i.Item1)
  443. .FirstOrDefault();
  444. if (series == null)
  445. {
  446. SmartMatchInfo info = options.SmartMatchInfos.FirstOrDefault(e => e.MatchStrings.Contains(seriesName, StringComparer.OrdinalIgnoreCase));
  447. if (info != null)
  448. {
  449. series = _libraryManager.RootFolder
  450. .GetRecursiveChildren(i => i is Series)
  451. .Cast<Series>()
  452. .FirstOrDefault(i => string.Equals(i.Name, info.ItemName, StringComparison.OrdinalIgnoreCase));
  453. }
  454. }
  455. return series;
  456. }
  457. /// <summary>
  458. /// Gets the new path.
  459. /// </summary>
  460. /// <param name="sourcePath">The source path.</param>
  461. /// <param name="series">The series.</param>
  462. /// <param name="seasonNumber">The season number.</param>
  463. /// <param name="episodeNumber">The episode number.</param>
  464. /// <param name="endingEpisodeNumber">The ending episode number.</param>
  465. /// <param name="premiereDate">The premiere date.</param>
  466. /// <param name="options">The options.</param>
  467. /// <param name="cancellationToken">The cancellation token.</param>
  468. /// <returns>System.String.</returns>
  469. private async Task<string> GetNewPath(string sourcePath,
  470. Series series,
  471. int? seasonNumber,
  472. int? episodeNumber,
  473. int? endingEpisodeNumber,
  474. DateTime? premiereDate,
  475. TvFileOrganizationOptions options,
  476. CancellationToken cancellationToken)
  477. {
  478. var episodeInfo = new EpisodeInfo
  479. {
  480. IndexNumber = episodeNumber,
  481. IndexNumberEnd = endingEpisodeNumber,
  482. MetadataCountryCode = series.GetPreferredMetadataCountryCode(),
  483. MetadataLanguage = series.GetPreferredMetadataLanguage(),
  484. ParentIndexNumber = seasonNumber,
  485. SeriesProviderIds = series.ProviderIds,
  486. PremiereDate = premiereDate
  487. };
  488. var searchResults = await _providerManager.GetRemoteSearchResults<Episode, EpisodeInfo>(new RemoteSearchQuery<EpisodeInfo>
  489. {
  490. SearchInfo = episodeInfo
  491. }, cancellationToken).ConfigureAwait(false);
  492. var episode = searchResults.FirstOrDefault();
  493. if (episode == null)
  494. {
  495. var msg = string.Format("No provider metadata found for {0} season {1} episode {2}", series.Name, seasonNumber, episodeNumber);
  496. _logger.Warn(msg);
  497. return null;
  498. }
  499. var episodeName = episode.Name;
  500. //if (string.IsNullOrWhiteSpace(episodeName))
  501. //{
  502. // var msg = string.Format("No provider metadata found for {0} season {1} episode {2}", series.Name, seasonNumber, episodeNumber);
  503. // _logger.Warn(msg);
  504. // return null;
  505. //}
  506. seasonNumber = seasonNumber ?? episode.ParentIndexNumber;
  507. episodeNumber = episodeNumber ?? episode.IndexNumber;
  508. var newPath = GetSeasonFolderPath(series, seasonNumber.Value, options);
  509. // MAX_PATH - trailing <NULL> charachter - drive component: 260 - 1 - 3 = 256
  510. // Usually newPath would include the drive component, but use 256 to be sure
  511. var maxFilenameLength = 256 - newPath.Length;
  512. if (!newPath.EndsWith(@"\"))
  513. {
  514. // Remove 1 for missing backslash combining path and filename
  515. maxFilenameLength--;
  516. }
  517. // Remove additional 4 chars to prevent PathTooLongException for downloaded subtitles (eg. filename.ext.eng.srt)
  518. maxFilenameLength -= 4;
  519. var episodeFileName = GetEpisodeFileName(sourcePath, series.Name, seasonNumber.Value, episodeNumber.Value, endingEpisodeNumber, episodeName, options, maxFilenameLength);
  520. if (string.IsNullOrEmpty(episodeFileName))
  521. {
  522. // cause failure
  523. return string.Empty;
  524. }
  525. newPath = Path.Combine(newPath, episodeFileName);
  526. return newPath;
  527. }
  528. /// <summary>
  529. /// Gets the season folder path.
  530. /// </summary>
  531. /// <param name="series">The series.</param>
  532. /// <param name="seasonNumber">The season number.</param>
  533. /// <param name="options">The options.</param>
  534. /// <returns>System.String.</returns>
  535. private string GetSeasonFolderPath(Series series, int seasonNumber, TvFileOrganizationOptions options)
  536. {
  537. // If there's already a season folder, use that
  538. var season = series
  539. .GetRecursiveChildren(i => i is Season && i.LocationType == LocationType.FileSystem && i.IndexNumber.HasValue && i.IndexNumber.Value == seasonNumber)
  540. .FirstOrDefault();
  541. if (season != null)
  542. {
  543. return season.Path;
  544. }
  545. var path = series.Path;
  546. if (series.ContainsEpisodesWithoutSeasonFolders)
  547. {
  548. return path;
  549. }
  550. if (seasonNumber == 0)
  551. {
  552. return Path.Combine(path, _fileSystem.GetValidFilename(options.SeasonZeroFolderName));
  553. }
  554. var seasonFolderName = options.SeasonFolderPattern
  555. .Replace("%s", seasonNumber.ToString(_usCulture))
  556. .Replace("%0s", seasonNumber.ToString("00", _usCulture))
  557. .Replace("%00s", seasonNumber.ToString("000", _usCulture));
  558. return Path.Combine(path, _fileSystem.GetValidFilename(seasonFolderName));
  559. }
  560. private string GetEpisodeFileName(string sourcePath, string seriesName, int seasonNumber, int episodeNumber, int? endingEpisodeNumber, string episodeTitle, TvFileOrganizationOptions options, int? maxLength)
  561. {
  562. seriesName = _fileSystem.GetValidFilename(seriesName).Trim();
  563. if (string.IsNullOrWhiteSpace(episodeTitle))
  564. {
  565. episodeTitle = string.Empty;
  566. }
  567. else
  568. {
  569. episodeTitle = _fileSystem.GetValidFilename(episodeTitle).Trim();
  570. }
  571. var sourceExtension = (Path.GetExtension(sourcePath) ?? string.Empty).TrimStart('.');
  572. var pattern = endingEpisodeNumber.HasValue ? options.MultiEpisodeNamePattern : options.EpisodeNamePattern;
  573. var result = pattern.Replace("%sn", seriesName)
  574. .Replace("%s.n", seriesName.Replace(" ", "."))
  575. .Replace("%s_n", seriesName.Replace(" ", "_"))
  576. .Replace("%s", seasonNumber.ToString(_usCulture))
  577. .Replace("%0s", seasonNumber.ToString("00", _usCulture))
  578. .Replace("%00s", seasonNumber.ToString("000", _usCulture))
  579. .Replace("%ext", sourceExtension)
  580. .Replace("%en", "%#1")
  581. .Replace("%e.n", "%#2")
  582. .Replace("%e_n", "%#3");
  583. if (endingEpisodeNumber.HasValue)
  584. {
  585. result = result.Replace("%ed", endingEpisodeNumber.Value.ToString(_usCulture))
  586. .Replace("%0ed", endingEpisodeNumber.Value.ToString("00", _usCulture))
  587. .Replace("%00ed", endingEpisodeNumber.Value.ToString("000", _usCulture));
  588. }
  589. result = result.Replace("%e", episodeNumber.ToString(_usCulture))
  590. .Replace("%0e", episodeNumber.ToString("00", _usCulture))
  591. .Replace("%00e", episodeNumber.ToString("000", _usCulture));
  592. if (maxLength.HasValue && result.Contains("%#"))
  593. {
  594. // Substract 3 for the temp token length (%#1, %#2 or %#3)
  595. int maxRemainingTitleLength = maxLength.Value - result.Length + 3;
  596. string shortenedEpisodeTitle = string.Empty;
  597. if (maxRemainingTitleLength > 5)
  598. {
  599. // A title with fewer than 5 letters wouldn't be of much value
  600. shortenedEpisodeTitle = episodeTitle.Substring(0, Math.Min(maxRemainingTitleLength, episodeTitle.Length));
  601. }
  602. result = result.Replace("%#1", shortenedEpisodeTitle)
  603. .Replace("%#2", shortenedEpisodeTitle.Replace(" ", "."))
  604. .Replace("%#3", shortenedEpisodeTitle.Replace(" ", "_"));
  605. }
  606. if (maxLength.HasValue && result.Length > maxLength.Value)
  607. {
  608. // There may be cases where reducing the title length may still not be sufficient to
  609. // stay below maxLength
  610. var msg = string.Format("Unable to generate an episode file name shorter than {0} characters to constrain to the max path limit", maxLength);
  611. _logger.Warn(msg);
  612. return string.Empty;
  613. }
  614. return result;
  615. }
  616. private bool IsSameEpisode(string sourcePath, string newPath)
  617. {
  618. try
  619. {
  620. var sourceFileInfo = new FileInfo(sourcePath);
  621. var destinationFileInfo = new FileInfo(newPath);
  622. if (sourceFileInfo.Length == destinationFileInfo.Length)
  623. {
  624. return true;
  625. }
  626. }
  627. catch (FileNotFoundException)
  628. {
  629. return false;
  630. }
  631. catch (DirectoryNotFoundException)
  632. {
  633. return false;
  634. }
  635. return false;
  636. }
  637. }
  638. }