| | | 1 | | #pragma warning disable CA5351 // Do Not Use Broken Cryptographic Algorithms |
| | | 2 | | |
| | | 3 | | using System; |
| | | 4 | | using System.Collections.Generic; |
| | | 5 | | using System.Diagnostics; |
| | | 6 | | using System.Globalization; |
| | | 7 | | using System.IO; |
| | | 8 | | using System.Linq; |
| | | 9 | | using System.Security.Cryptography; |
| | | 10 | | using System.Text; |
| | | 11 | | using System.Threading; |
| | | 12 | | using System.Threading.Tasks; |
| | | 13 | | using Jellyfin.Data.Enums; |
| | | 14 | | using Jellyfin.Database.Implementations; |
| | | 15 | | using Jellyfin.Database.Implementations.Entities; |
| | | 16 | | using Jellyfin.Server.ServerSetupApp; |
| | | 17 | | using MediaBrowser.Common.Configuration; |
| | | 18 | | using MediaBrowser.Common.Extensions; |
| | | 19 | | using MediaBrowser.Controller.IO; |
| | | 20 | | using MediaBrowser.Model.IO; |
| | | 21 | | using Microsoft.EntityFrameworkCore; |
| | | 22 | | using Microsoft.Extensions.Logging; |
| | | 23 | | |
| | | 24 | | namespace Jellyfin.Server.Migrations.Routines; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Migration to move extracted files to the new directories. |
| | | 28 | | /// </summary> |
| | | 29 | | [JellyfinMigration("2025-04-20T21:00:00", nameof(MoveExtractedFiles))] |
| | | 30 | | public class MoveExtractedFiles : IAsyncMigrationRoutine |
| | | 31 | | { |
| | | 32 | | private readonly IApplicationPaths _appPaths; |
| | | 33 | | private readonly ILogger _logger; |
| | | 34 | | private readonly IDbContextFactory<JellyfinDbContext> _dbProvider; |
| | | 35 | | private readonly IPathManager _pathManager; |
| | | 36 | | private readonly IFileSystem _fileSystem; |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Initializes a new instance of the <see cref="MoveExtractedFiles"/> class. |
| | | 40 | | /// </summary> |
| | | 41 | | /// <param name="appPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param> |
| | | 42 | | /// <param name="logger">The logger.</param> |
| | | 43 | | /// <param name="startupLogger">The startup logger for Startup UI intigration.</param> |
| | | 44 | | /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param> |
| | | 45 | | /// <param name="pathManager">Instance of the <see cref="IPathManager"/> interface.</param> |
| | | 46 | | /// <param name="dbProvider">Instance of the <see cref="IDbContextFactory{JellyfinDbContext}"/> interface.</param> |
| | | 47 | | public MoveExtractedFiles( |
| | | 48 | | IApplicationPaths appPaths, |
| | | 49 | | ILogger<MoveExtractedFiles> logger, |
| | | 50 | | IStartupLogger<MoveExtractedFiles> startupLogger, |
| | | 51 | | IPathManager pathManager, |
| | | 52 | | IFileSystem fileSystem, |
| | | 53 | | IDbContextFactory<JellyfinDbContext> dbProvider) |
| | | 54 | | { |
| | 0 | 55 | | _appPaths = appPaths; |
| | 0 | 56 | | _logger = startupLogger.With(logger); |
| | 0 | 57 | | _pathManager = pathManager; |
| | 0 | 58 | | _fileSystem = fileSystem; |
| | 0 | 59 | | _dbProvider = dbProvider; |
| | 0 | 60 | | } |
| | | 61 | | |
| | 0 | 62 | | private string SubtitleCachePath => Path.Combine(_appPaths.DataPath, "subtitles"); |
| | | 63 | | |
| | 0 | 64 | | private string AttachmentCachePath => Path.Combine(_appPaths.DataPath, "attachments"); |
| | | 65 | | |
| | | 66 | | /// <inheritdoc /> |
| | | 67 | | public async Task PerformAsync(CancellationToken cancellationToken) |
| | | 68 | | { |
| | | 69 | | const int Limit = 5000; |
| | 0 | 70 | | int itemCount = 0; |
| | | 71 | | |
| | 0 | 72 | | var sw = Stopwatch.StartNew(); |
| | | 73 | | |
| | 0 | 74 | | using var context = _dbProvider.CreateDbContext(); |
| | 0 | 75 | | var records = context.BaseItems.Count(b => b.MediaType == MediaType.Video.ToString() && !b.IsVirtualItem && !b.I |
| | 0 | 76 | | _logger.LogInformation("Checking {Count} items for movable extracted files.", records); |
| | | 77 | | |
| | | 78 | | // Make sure directories exist |
| | 0 | 79 | | Directory.CreateDirectory(SubtitleCachePath); |
| | 0 | 80 | | Directory.CreateDirectory(AttachmentCachePath); |
| | | 81 | | |
| | 0 | 82 | | await foreach (var result in context.BaseItems |
| | 0 | 83 | | .Include(e => e.MediaStreams!.Where(s => s.StreamType == MediaStreamTypeEntity.Subtitle && !s. |
| | 0 | 84 | | .Where(b => b.MediaType == MediaType.Video.ToString() && !b.IsVirtualItem && !b.IsFolder) |
| | 0 | 85 | | .Select(b => new |
| | 0 | 86 | | { |
| | 0 | 87 | | b.Id, |
| | 0 | 88 | | b.Path, |
| | 0 | 89 | | b.MediaStreams |
| | 0 | 90 | | }) |
| | 0 | 91 | | .OrderBy(e => e.Id) |
| | 0 | 92 | | .WithPartitionProgress((partition) => _logger.LogInformation("Checked: {Count} - Moved: {Items |
| | 0 | 93 | | .PartitionEagerAsync(Limit, cancellationToken) |
| | 0 | 94 | | .WithCancellation(cancellationToken) |
| | 0 | 95 | | .ConfigureAwait(false)) |
| | | 96 | | { |
| | 0 | 97 | | if (MoveSubtitleAndAttachmentFiles(result.Id, result.Path, result.MediaStreams, context)) |
| | | 98 | | { |
| | 0 | 99 | | itemCount++; |
| | | 100 | | } |
| | | 101 | | } |
| | | 102 | | |
| | 0 | 103 | | _logger.LogInformation("Moved files for {Count} items in {Time}", itemCount, sw.Elapsed); |
| | | 104 | | |
| | | 105 | | // Get all subdirectories with 1 character names (those are the legacy directories) |
| | | 106 | | var subdirectories = Directory.GetDirectories(SubtitleCachePath, "*", SearchOption.AllDirectories).Where(s => s. |
| | | 107 | | subdirectories.AddRange(Directory.GetDirectories(AttachmentCachePath, "*", SearchOption.AllDirectories).Where(s |
| | | 108 | | |
| | | 109 | | // Remove all legacy subdirectories |
| | 0 | 110 | | foreach (var subdir in subdirectories) |
| | | 111 | | { |
| | 0 | 112 | | Directory.Delete(subdir, true); |
| | | 113 | | } |
| | | 114 | | |
| | | 115 | | // Remove old cache path |
| | 0 | 116 | | var attachmentCachePath = Path.Join(_appPaths.CachePath, "attachments"); |
| | 0 | 117 | | if (Directory.Exists(attachmentCachePath)) |
| | | 118 | | { |
| | 0 | 119 | | Directory.Delete(attachmentCachePath, true); |
| | | 120 | | } |
| | | 121 | | |
| | 0 | 122 | | _logger.LogInformation("Cleaned up left over subtitles and attachments."); |
| | 0 | 123 | | } |
| | | 124 | | |
| | | 125 | | private bool MoveSubtitleAndAttachmentFiles(Guid id, string? path, ICollection<MediaStreamInfo>? mediaStreams, Jelly |
| | | 126 | | { |
| | 0 | 127 | | var itemIdString = id.ToString("N", CultureInfo.InvariantCulture); |
| | 0 | 128 | | var modified = false; |
| | 0 | 129 | | if (mediaStreams is not null) |
| | | 130 | | { |
| | 0 | 131 | | foreach (var mediaStream in mediaStreams) |
| | | 132 | | { |
| | 0 | 133 | | if (mediaStream.Codec is null) |
| | | 134 | | { |
| | | 135 | | continue; |
| | | 136 | | } |
| | | 137 | | |
| | 0 | 138 | | var mediaStreamIndex = mediaStream.StreamIndex; |
| | 0 | 139 | | var extension = GetSubtitleExtension(mediaStream.Codec); |
| | 0 | 140 | | var oldSubtitleCachePath = GetOldSubtitleCachePath(path, mediaStreamIndex, extension); |
| | 0 | 141 | | if (string.IsNullOrEmpty(oldSubtitleCachePath) || !File.Exists(oldSubtitleCachePath)) |
| | | 142 | | { |
| | | 143 | | continue; |
| | | 144 | | } |
| | | 145 | | |
| | 0 | 146 | | var newSubtitleCachePath = _pathManager.GetSubtitlePath(itemIdString, mediaStreamIndex, extension); |
| | 0 | 147 | | if (newSubtitleCachePath is null) |
| | | 148 | | { |
| | | 149 | | continue; |
| | | 150 | | } |
| | | 151 | | |
| | 0 | 152 | | if (File.Exists(newSubtitleCachePath)) |
| | | 153 | | { |
| | 0 | 154 | | File.Delete(oldSubtitleCachePath); |
| | | 155 | | } |
| | | 156 | | else |
| | | 157 | | { |
| | 0 | 158 | | var newDirectory = Path.GetDirectoryName(newSubtitleCachePath); |
| | 0 | 159 | | if (newDirectory is not null) |
| | | 160 | | { |
| | 0 | 161 | | Directory.CreateDirectory(newDirectory); |
| | 0 | 162 | | File.Move(oldSubtitleCachePath, newSubtitleCachePath, false); |
| | 0 | 163 | | _logger.LogDebug("Moved subtitle {Index} for {Item} from {Source} to {Destination}", mediaStream |
| | | 164 | | |
| | 0 | 165 | | modified = true; |
| | | 166 | | } |
| | | 167 | | } |
| | | 168 | | } |
| | | 169 | | } |
| | | 170 | | |
| | | 171 | | #pragma warning disable CA1309 // Use ordinal string comparison |
| | 0 | 172 | | var attachments = context.AttachmentStreamInfos.Where(a => a.ItemId.Equals(id) && !string.Equals(a.Codec, "mjpeg |
| | | 173 | | #pragma warning restore CA1309 // Use ordinal string comparison |
| | 0 | 174 | | var shouldExtractOneByOne = attachments.Any(a => !string.IsNullOrEmpty(a.Filename) |
| | 0 | 175 | | && (a.Filename.Contains('/', StringCompari |
| | 0 | 176 | | foreach (var attachment in attachments) |
| | | 177 | | { |
| | 0 | 178 | | var attachmentIndex = attachment.Index; |
| | 0 | 179 | | var oldAttachmentPath = GetOldAttachmentDataPath(path, attachmentIndex); |
| | 0 | 180 | | if (string.IsNullOrEmpty(oldAttachmentPath) || !File.Exists(oldAttachmentPath)) |
| | | 181 | | { |
| | 0 | 182 | | oldAttachmentPath = GetOldAttachmentCachePath(itemIdString, attachment, shouldExtractOneByOne); |
| | 0 | 183 | | if (string.IsNullOrEmpty(oldAttachmentPath) || !File.Exists(oldAttachmentPath)) |
| | | 184 | | { |
| | | 185 | | continue; |
| | | 186 | | } |
| | | 187 | | } |
| | | 188 | | |
| | 0 | 189 | | var newAttachmentPath = _pathManager.GetAttachmentPath(itemIdString, attachment.Filename ?? attachmentIndex. |
| | 0 | 190 | | if (newAttachmentPath is null) |
| | | 191 | | { |
| | | 192 | | continue; |
| | | 193 | | } |
| | | 194 | | |
| | 0 | 195 | | if (File.Exists(newAttachmentPath)) |
| | | 196 | | { |
| | 0 | 197 | | File.Delete(oldAttachmentPath); |
| | | 198 | | } |
| | | 199 | | else |
| | | 200 | | { |
| | 0 | 201 | | var newDirectory = Path.GetDirectoryName(newAttachmentPath); |
| | 0 | 202 | | if (newDirectory is not null) |
| | | 203 | | { |
| | 0 | 204 | | Directory.CreateDirectory(newDirectory); |
| | 0 | 205 | | File.Move(oldAttachmentPath, newAttachmentPath, false); |
| | 0 | 206 | | _logger.LogDebug("Moved attachment {Index} for {Item} from {Source} to {Destination}", attachmentInd |
| | | 207 | | |
| | 0 | 208 | | modified = true; |
| | | 209 | | } |
| | | 210 | | } |
| | | 211 | | } |
| | | 212 | | |
| | 0 | 213 | | return modified; |
| | | 214 | | } |
| | | 215 | | |
| | | 216 | | private string? GetOldAttachmentDataPath(string? mediaPath, int attachmentStreamIndex) |
| | | 217 | | { |
| | 0 | 218 | | if (mediaPath is null) |
| | | 219 | | { |
| | 0 | 220 | | return null; |
| | | 221 | | } |
| | | 222 | | |
| | | 223 | | string filename; |
| | 0 | 224 | | if (_fileSystem.IsPathFile(mediaPath)) |
| | | 225 | | { |
| | | 226 | | DateTime? date; |
| | | 227 | | try |
| | | 228 | | { |
| | 0 | 229 | | date = File.GetLastWriteTimeUtc(mediaPath); |
| | 0 | 230 | | } |
| | 0 | 231 | | catch (IOException e) |
| | | 232 | | { |
| | 0 | 233 | | _logger.LogDebug("Skipping attachment at index {Index} for {Path}: {Exception}", attachmentStreamIndex, |
| | | 234 | | |
| | 0 | 235 | | return null; |
| | | 236 | | } |
| | 0 | 237 | | catch (UnauthorizedAccessException e) |
| | | 238 | | { |
| | 0 | 239 | | _logger.LogDebug("Skipping subtitle at index {Index} for {Path}: {Exception}", attachmentStreamIndex, me |
| | | 240 | | |
| | 0 | 241 | | return null; |
| | | 242 | | } |
| | 0 | 243 | | catch (ArgumentOutOfRangeException e) |
| | | 244 | | { |
| | 0 | 245 | | _logger.LogDebug("Skipping attachment at index {Index} for {Path}: {Exception}", attachmentStreamIndex, |
| | | 246 | | |
| | 0 | 247 | | return null; |
| | | 248 | | } |
| | | 249 | | |
| | 0 | 250 | | filename = (mediaPath + attachmentStreamIndex.ToString(CultureInfo.InvariantCulture) + "_" + date.Value.Tick |
| | | 251 | | } |
| | | 252 | | else |
| | | 253 | | { |
| | 0 | 254 | | filename = (mediaPath + attachmentStreamIndex.ToString(CultureInfo.InvariantCulture)).GetMD5().ToString("D", |
| | | 255 | | } |
| | | 256 | | |
| | 0 | 257 | | return Path.Join(_appPaths.DataPath, "attachments", filename[..1], filename); |
| | 0 | 258 | | } |
| | | 259 | | |
| | | 260 | | private string? GetOldAttachmentCachePath(string mediaSourceId, AttachmentStreamInfo attachment, bool shouldExtractO |
| | | 261 | | { |
| | 0 | 262 | | var attachmentFolderPath = Path.Join(_appPaths.CachePath, "attachments", mediaSourceId); |
| | 0 | 263 | | if (shouldExtractOneByOne) |
| | | 264 | | { |
| | 0 | 265 | | return Path.Join(attachmentFolderPath, attachment.Index.ToString(CultureInfo.InvariantCulture)); |
| | | 266 | | } |
| | | 267 | | |
| | 0 | 268 | | if (string.IsNullOrEmpty(attachment.Filename)) |
| | | 269 | | { |
| | 0 | 270 | | return null; |
| | | 271 | | } |
| | | 272 | | |
| | 0 | 273 | | return Path.Join(attachmentFolderPath, attachment.Filename); |
| | | 274 | | } |
| | | 275 | | |
| | | 276 | | private string? GetOldSubtitleCachePath(string? path, int streamIndex, string outputSubtitleExtension) |
| | | 277 | | { |
| | 0 | 278 | | if (path is null) |
| | | 279 | | { |
| | 0 | 280 | | return null; |
| | | 281 | | } |
| | | 282 | | |
| | | 283 | | DateTime? date; |
| | | 284 | | try |
| | | 285 | | { |
| | 0 | 286 | | date = File.GetLastWriteTimeUtc(path); |
| | 0 | 287 | | } |
| | 0 | 288 | | catch (ArgumentOutOfRangeException e) |
| | | 289 | | { |
| | 0 | 290 | | _logger.LogDebug("Skipping subtitle at index {Index} for {Path}: {Exception}", streamIndex, path, e.Message) |
| | | 291 | | |
| | 0 | 292 | | return null; |
| | | 293 | | } |
| | 0 | 294 | | catch (UnauthorizedAccessException e) |
| | | 295 | | { |
| | 0 | 296 | | _logger.LogDebug("Skipping subtitle at index {Index} for {Path}: {Exception}", streamIndex, path, e.Message) |
| | | 297 | | |
| | 0 | 298 | | return null; |
| | | 299 | | } |
| | 0 | 300 | | catch (IOException e) |
| | | 301 | | { |
| | 0 | 302 | | _logger.LogDebug("Skipping subtitle at index {Index} for {Path}: {Exception}", streamIndex, path, e.Message) |
| | | 303 | | |
| | 0 | 304 | | return null; |
| | | 305 | | } |
| | | 306 | | |
| | 0 | 307 | | var ticksParam = string.Empty; |
| | 0 | 308 | | ReadOnlySpan<char> filename = new Guid(MD5.HashData(Encoding.Unicode.GetBytes(path + "_" + streamIndex.ToString( |
| | | 309 | | |
| | 0 | 310 | | return Path.Join(SubtitleCachePath, filename[..1], filename); |
| | 0 | 311 | | } |
| | | 312 | | |
| | | 313 | | private static string GetSubtitleExtension(string codec) |
| | | 314 | | { |
| | 0 | 315 | | if (codec.ToLower(CultureInfo.InvariantCulture).Equals("ass", StringComparison.OrdinalIgnoreCase) |
| | 0 | 316 | | || codec.ToLower(CultureInfo.InvariantCulture).Equals("ssa", StringComparison.OrdinalIgnoreCase)) |
| | | 317 | | { |
| | 0 | 318 | | return "." + codec; |
| | | 319 | | } |
| | 0 | 320 | | else if (codec.Contains("pgs", StringComparison.OrdinalIgnoreCase)) |
| | | 321 | | { |
| | 0 | 322 | | return ".sup"; |
| | | 323 | | } |
| | | 324 | | else |
| | | 325 | | { |
| | 0 | 326 | | return ".srt"; |
| | | 327 | | } |
| | | 328 | | } |
| | | 329 | | } |