| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.IO; |
| | | 4 | | using System.IO.Compression; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Text.Json; |
| | | 7 | | using System.Text.Json.Nodes; |
| | | 8 | | using System.Text.Json.Serialization; |
| | | 9 | | using System.Threading; |
| | | 10 | | using System.Threading.Tasks; |
| | | 11 | | using Jellyfin.Database.Implementations; |
| | | 12 | | using Jellyfin.Server.Implementations.StorageHelpers; |
| | | 13 | | using Jellyfin.Server.Implementations.SystemBackupService; |
| | | 14 | | using MediaBrowser.Controller; |
| | | 15 | | using MediaBrowser.Controller.Library; |
| | | 16 | | using MediaBrowser.Controller.SystemBackupService; |
| | | 17 | | using Microsoft.EntityFrameworkCore; |
| | | 18 | | using Microsoft.EntityFrameworkCore.Infrastructure; |
| | | 19 | | using Microsoft.EntityFrameworkCore.Migrations; |
| | | 20 | | using Microsoft.Extensions.Hosting; |
| | | 21 | | using Microsoft.Extensions.Logging; |
| | | 22 | | |
| | | 23 | | namespace Jellyfin.Server.Implementations.FullSystemBackup; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Contains methods for creating and restoring backups. |
| | | 27 | | /// </summary> |
| | | 28 | | public class BackupService : IBackupService |
| | | 29 | | { |
| | | 30 | | private const string ManifestEntryName = "manifest.json"; |
| | | 31 | | private readonly ILogger<BackupService> _logger; |
| | | 32 | | private readonly IDbContextFactory<JellyfinDbContext> _dbProvider; |
| | | 33 | | private readonly IServerApplicationHost _applicationHost; |
| | | 34 | | private readonly IServerApplicationPaths _applicationPaths; |
| | | 35 | | private readonly IJellyfinDatabaseProvider _jellyfinDatabaseProvider; |
| | | 36 | | private readonly IHostApplicationLifetime _hostApplicationLifetime; |
| | | 37 | | private readonly ILibraryManager _libraryManager; |
| | 0 | 38 | | private static readonly JsonSerializerOptions _serializerSettings = new JsonSerializerOptions(JsonSerializerDefaults |
| | 0 | 39 | | { |
| | 0 | 40 | | AllowTrailingCommas = true, |
| | 0 | 41 | | ReferenceHandler = ReferenceHandler.IgnoreCycles, |
| | 0 | 42 | | }; |
| | | 43 | | |
| | 22 | 44 | | private readonly Version _backupEngineVersion = new Version(0, 2, 0); |
| | | 45 | | |
| | | 46 | | /// <summary> |
| | | 47 | | /// Initializes a new instance of the <see cref="BackupService"/> class. |
| | | 48 | | /// </summary> |
| | | 49 | | /// <param name="logger">A logger.</param> |
| | | 50 | | /// <param name="dbProvider">A Database Factory.</param> |
| | | 51 | | /// <param name="applicationHost">The Application host.</param> |
| | | 52 | | /// <param name="applicationPaths">The application paths.</param> |
| | | 53 | | /// <param name="jellyfinDatabaseProvider">The Jellyfin database Provider in use.</param> |
| | | 54 | | /// <param name="applicationLifetime">The SystemManager.</param> |
| | | 55 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | | 56 | | public BackupService( |
| | | 57 | | ILogger<BackupService> logger, |
| | | 58 | | IDbContextFactory<JellyfinDbContext> dbProvider, |
| | | 59 | | IServerApplicationHost applicationHost, |
| | | 60 | | IServerApplicationPaths applicationPaths, |
| | | 61 | | IJellyfinDatabaseProvider jellyfinDatabaseProvider, |
| | | 62 | | IHostApplicationLifetime applicationLifetime, |
| | | 63 | | ILibraryManager libraryManager) |
| | | 64 | | { |
| | 22 | 65 | | _logger = logger; |
| | 22 | 66 | | _dbProvider = dbProvider; |
| | 22 | 67 | | _applicationHost = applicationHost; |
| | 22 | 68 | | _applicationPaths = applicationPaths; |
| | 22 | 69 | | _jellyfinDatabaseProvider = jellyfinDatabaseProvider; |
| | 22 | 70 | | _hostApplicationLifetime = applicationLifetime; |
| | 22 | 71 | | _libraryManager = libraryManager; |
| | 22 | 72 | | } |
| | | 73 | | |
| | | 74 | | /// <inheritdoc/> |
| | | 75 | | public void ScheduleRestoreAndRestartServer(string archivePath) |
| | | 76 | | { |
| | 0 | 77 | | _applicationHost.RestoreBackupPath = archivePath; |
| | 0 | 78 | | _applicationHost.ShouldRestart = true; |
| | 0 | 79 | | _applicationHost.NotifyPendingRestart(); |
| | 0 | 80 | | _ = Task.Run(async () => |
| | 0 | 81 | | { |
| | 0 | 82 | | await Task.Delay(500).ConfigureAwait(false); |
| | 0 | 83 | | _hostApplicationLifetime.StopApplication(); |
| | 0 | 84 | | }); |
| | 0 | 85 | | } |
| | | 86 | | |
| | | 87 | | /// <inheritdoc/> |
| | | 88 | | public async Task RestoreBackupAsync(string archivePath) |
| | | 89 | | { |
| | 0 | 90 | | _logger.LogWarning("Begin restoring system to {BackupArchive}", archivePath); // Info isn't cutting it |
| | 0 | 91 | | if (!File.Exists(archivePath)) |
| | | 92 | | { |
| | 0 | 93 | | throw new FileNotFoundException($"Requested backup file '{archivePath}' does not exist."); |
| | | 94 | | } |
| | | 95 | | |
| | 0 | 96 | | StorageHelper.TestCommonPathsForStorageCapacity(_applicationPaths, _logger); |
| | | 97 | | |
| | 0 | 98 | | var fileStream = File.OpenRead(archivePath); |
| | 0 | 99 | | await using (fileStream.ConfigureAwait(false)) |
| | | 100 | | { |
| | 0 | 101 | | using var zipArchive = new ZipArchive(fileStream, ZipArchiveMode.Read, false); |
| | 0 | 102 | | var zipArchiveEntry = zipArchive.GetEntry(ManifestEntryName); |
| | | 103 | | |
| | 0 | 104 | | if (zipArchiveEntry is null) |
| | | 105 | | { |
| | 0 | 106 | | throw new NotSupportedException($"The loaded archive '{archivePath}' does not appear to be a Jellyfin ba |
| | | 107 | | } |
| | | 108 | | |
| | | 109 | | BackupManifest? manifest; |
| | 0 | 110 | | var manifestStream = await zipArchiveEntry.OpenAsync().ConfigureAwait(false); |
| | 0 | 111 | | await using (manifestStream.ConfigureAwait(false)) |
| | | 112 | | { |
| | 0 | 113 | | manifest = await JsonSerializer.DeserializeAsync<BackupManifest>(manifestStream, _serializerSettings).Co |
| | | 114 | | } |
| | | 115 | | |
| | 0 | 116 | | if (manifest!.ServerVersion > _applicationHost.ApplicationVersion) // newer versions of Jellyfin should be a |
| | | 117 | | { |
| | 0 | 118 | | throw new NotSupportedException($"The loaded archive '{archivePath}' is made for a newer version of Jell |
| | | 119 | | } |
| | | 120 | | |
| | 0 | 121 | | if (!TestBackupVersionCompatibility(manifest.BackupEngineVersion)) |
| | | 122 | | { |
| | 0 | 123 | | throw new NotSupportedException($"The loaded archive '{archivePath}' is made for a newer version of Jell |
| | | 124 | | } |
| | | 125 | | |
| | | 126 | | void CopyDirectory(string source, string target, string[]? exclude = null) |
| | | 127 | | { |
| | | 128 | | var fullSourcePath = NormalizePathSeparator(Path.GetFullPath(source) + Path.DirectorySeparatorChar); |
| | | 129 | | var fullTargetRoot = Path.GetFullPath(target) + Path.DirectorySeparatorChar; |
| | | 130 | | var excludePaths = exclude?.Select(e => $"{source}/{e}/").ToArray(); |
| | | 131 | | foreach (var item in zipArchive.Entries) |
| | | 132 | | { |
| | | 133 | | var sourcePath = NormalizePathSeparator(Path.GetFullPath(item.FullName)); |
| | | 134 | | var targetPath = Path.GetFullPath(Path.Combine(target, Path.GetRelativePath(source, item.FullName))) |
| | | 135 | | |
| | | 136 | | if (excludePaths is not null && excludePaths.Any(e => item.FullName.StartsWith(e, StringComparison.O |
| | | 137 | | { |
| | | 138 | | continue; |
| | | 139 | | } |
| | | 140 | | |
| | | 141 | | if (!sourcePath.StartsWith(fullSourcePath, StringComparison.Ordinal) |
| | | 142 | | || !targetPath.StartsWith(fullTargetRoot, StringComparison.Ordinal) |
| | | 143 | | || Path.EndsInDirectorySeparator(item.FullName)) |
| | | 144 | | { |
| | | 145 | | continue; |
| | | 146 | | } |
| | | 147 | | |
| | | 148 | | _logger.LogInformation("Restore and override {File}", targetPath); |
| | | 149 | | |
| | | 150 | | Directory.CreateDirectory(Path.GetDirectoryName(targetPath)!); |
| | | 151 | | item.ExtractToFile(targetPath, overwrite: true); |
| | | 152 | | } |
| | | 153 | | } |
| | | 154 | | |
| | 0 | 155 | | CopyDirectory("Config", _applicationPaths.ConfigurationDirectoryPath); |
| | 0 | 156 | | CopyDirectory("Data", _applicationPaths.DataPath, exclude: ["metadata", "metadata-default"]); |
| | 0 | 157 | | CopyDirectory("Root", _applicationPaths.RootFolderPath); |
| | 0 | 158 | | CopyDirectory("Data/metadata", _applicationPaths.InternalMetadataPath); |
| | 0 | 159 | | CopyDirectory("Data/metadata-default", _applicationPaths.DefaultInternalMetadataPath); |
| | | 160 | | |
| | 0 | 161 | | if (manifest.Options.Database) |
| | | 162 | | { |
| | 0 | 163 | | _logger.LogInformation("Begin restoring Database"); |
| | 0 | 164 | | var dbContext = await _dbProvider.CreateDbContextAsync().ConfigureAwait(false); |
| | 0 | 165 | | await using (dbContext.ConfigureAwait(false)) |
| | | 166 | | { |
| | | 167 | | // restore migration history manually |
| | 0 | 168 | | var historyEntry = zipArchive.GetEntry(NormalizePathSeparator(Path.Combine("Database", $"{nameof(His |
| | 0 | 169 | | if (historyEntry is null) |
| | | 170 | | { |
| | 0 | 171 | | _logger.LogInformation("No backup of the history table in archive. This is required for Jellyfin |
| | 0 | 172 | | throw new InvalidOperationException("Cannot restore backup that has no History data."); |
| | | 173 | | } |
| | | 174 | | |
| | | 175 | | HistoryRow[] historyEntries; |
| | 0 | 176 | | var historyArchive = await historyEntry.OpenAsync().ConfigureAwait(false); |
| | 0 | 177 | | await using (historyArchive.ConfigureAwait(false)) |
| | | 178 | | { |
| | 0 | 179 | | historyEntries = await JsonSerializer.DeserializeAsync<HistoryRow[]>(historyArchive).ConfigureAw |
| | 0 | 180 | | throw new InvalidOperationException("Cannot restore backup that has no History data."); |
| | | 181 | | } |
| | | 182 | | |
| | 0 | 183 | | var historyRepository = dbContext.GetService<IHistoryRepository>(); |
| | 0 | 184 | | await historyRepository.CreateIfNotExistsAsync().ConfigureAwait(false); |
| | | 185 | | |
| | 0 | 186 | | foreach (var item in await historyRepository.GetAppliedMigrationsAsync(CancellationToken.None).Confi |
| | | 187 | | { |
| | 0 | 188 | | var insertScript = historyRepository.GetDeleteScript(item.MigrationId); |
| | 0 | 189 | | await dbContext.Database.ExecuteSqlRawAsync(insertScript).ConfigureAwait(false); |
| | | 190 | | } |
| | | 191 | | |
| | 0 | 192 | | foreach (var item in historyEntries) |
| | | 193 | | { |
| | 0 | 194 | | var insertScript = historyRepository.GetInsertScript(item); |
| | 0 | 195 | | await dbContext.Database.ExecuteSqlRawAsync(insertScript).ConfigureAwait(false); |
| | | 196 | | } |
| | | 197 | | |
| | 0 | 198 | | dbContext.ChangeTracker.QueryTrackingBehavior = QueryTrackingBehavior.NoTracking; |
| | 0 | 199 | | var entityTypes = typeof(JellyfinDbContext).GetProperties(System.Reflection.BindingFlags.Public | Sy |
| | 0 | 200 | | .Where(e => e.PropertyType.IsAssignableTo(typeof(IQueryable))) |
| | 0 | 201 | | .Select(e => (Type: e, Set: e.GetValue(dbContext) as IQueryable)) |
| | 0 | 202 | | .ToArray(); |
| | | 203 | | |
| | 0 | 204 | | var tableNames = entityTypes.Select(f => dbContext.Model.FindEntityType(f.Type.PropertyType.GetGener |
| | 0 | 205 | | _logger.LogInformation("Begin purging database"); |
| | 0 | 206 | | await _jellyfinDatabaseProvider.PurgeDatabase(dbContext, tableNames).ConfigureAwait(false); |
| | 0 | 207 | | _logger.LogInformation("Database Purged"); |
| | | 208 | | |
| | 0 | 209 | | foreach (var entityType in entityTypes) |
| | | 210 | | { |
| | 0 | 211 | | _logger.LogInformation("Read backup of {Table}", entityType.Type.Name); |
| | | 212 | | |
| | 0 | 213 | | var zipEntry = zipArchive.GetEntry(NormalizePathSeparator(Path.Combine("Database", $"{entityType |
| | 0 | 214 | | if (zipEntry is null) |
| | | 215 | | { |
| | 0 | 216 | | _logger.LogInformation("No backup of expected table {Table} is present in backup, continuing |
| | 0 | 217 | | continue; |
| | | 218 | | } |
| | | 219 | | |
| | 0 | 220 | | var zipEntryStream = await zipEntry.OpenAsync().ConfigureAwait(false); |
| | 0 | 221 | | await using (zipEntryStream.ConfigureAwait(false)) |
| | | 222 | | { |
| | 0 | 223 | | _logger.LogInformation("Restore backup of {Table}", entityType.Type.Name); |
| | 0 | 224 | | var records = 0; |
| | 0 | 225 | | await foreach (var item in JsonSerializer.DeserializeAsyncEnumerable<JsonObject>(zipEntryStr |
| | | 226 | | { |
| | 0 | 227 | | var entity = item.Deserialize(entityType.Type.PropertyType.GetGenericArguments()[0]); |
| | 0 | 228 | | if (entity is null) |
| | | 229 | | { |
| | 0 | 230 | | throw new InvalidOperationException($"Cannot deserialize entity '{item}'"); |
| | | 231 | | } |
| | | 232 | | |
| | | 233 | | try |
| | | 234 | | { |
| | 0 | 235 | | records++; |
| | 0 | 236 | | dbContext.Add(entity); |
| | 0 | 237 | | } |
| | 0 | 238 | | catch (Exception ex) |
| | | 239 | | { |
| | 0 | 240 | | _logger.LogError(ex, "Could not store entity {Entity}, continuing anyway", item); |
| | 0 | 241 | | } |
| | | 242 | | } |
| | | 243 | | |
| | 0 | 244 | | _logger.LogInformation("Prepared to restore {Number} entries for {Table}", records, entityTy |
| | | 245 | | } |
| | 0 | 246 | | } |
| | | 247 | | |
| | 0 | 248 | | _logger.LogInformation("Try restore Database"); |
| | 0 | 249 | | await dbContext.SaveChangesAsync().ConfigureAwait(false); |
| | 0 | 250 | | _logger.LogInformation("Restored database"); |
| | 0 | 251 | | } |
| | 0 | 252 | | } |
| | | 253 | | |
| | 0 | 254 | | _logger.LogInformation("Restored Jellyfin system from {Date}", manifest.DateCreated); |
| | 0 | 255 | | } |
| | 0 | 256 | | } |
| | | 257 | | |
| | | 258 | | private bool TestBackupVersionCompatibility(Version backupEngineVersion) |
| | | 259 | | { |
| | 0 | 260 | | if (backupEngineVersion == _backupEngineVersion) |
| | | 261 | | { |
| | 0 | 262 | | return true; |
| | | 263 | | } |
| | | 264 | | |
| | 0 | 265 | | return false; |
| | | 266 | | } |
| | | 267 | | |
| | | 268 | | /// <inheritdoc/> |
| | | 269 | | public async Task<BackupManifestDto> CreateBackupAsync(BackupOptionsDto backupOptions) |
| | | 270 | | { |
| | | 271 | | // Creating a backup runs a database optimization and reads the entire database under a transaction, both of |
| | | 272 | | // which heavily contend with an active library scan and could capture an inconsistent database state. |
| | 0 | 273 | | if (_libraryManager.IsScanRunning) |
| | | 274 | | { |
| | 0 | 275 | | _logger.LogWarning("Cannot create a backup while a library scan is running."); |
| | 0 | 276 | | throw new InvalidOperationException("Cannot create a backup while a library scan is running. Please try agai |
| | | 277 | | } |
| | | 278 | | |
| | 0 | 279 | | var manifest = new BackupManifest() |
| | 0 | 280 | | { |
| | 0 | 281 | | DateCreated = DateTime.UtcNow, |
| | 0 | 282 | | ServerVersion = _applicationHost.ApplicationVersion, |
| | 0 | 283 | | DatabaseTables = null!, |
| | 0 | 284 | | BackupEngineVersion = _backupEngineVersion, |
| | 0 | 285 | | Options = Map(backupOptions) |
| | 0 | 286 | | }; |
| | | 287 | | |
| | 0 | 288 | | _logger.LogInformation("Running database optimization before backup"); |
| | | 289 | | |
| | 0 | 290 | | await _jellyfinDatabaseProvider.RunScheduledOptimisation(CancellationToken.None).ConfigureAwait(false); |
| | | 291 | | |
| | 0 | 292 | | var backupFolder = Path.Combine(_applicationPaths.BackupPath); |
| | | 293 | | |
| | 0 | 294 | | if (!Directory.Exists(backupFolder)) |
| | | 295 | | { |
| | 0 | 296 | | Directory.CreateDirectory(backupFolder); |
| | | 297 | | } |
| | | 298 | | |
| | 0 | 299 | | var backupStorageSpace = StorageHelper.GetFreeSpaceOf(_applicationPaths.BackupPath); |
| | | 300 | | |
| | | 301 | | const long FiveGigabyte = 5_368_709_115; |
| | 0 | 302 | | if (backupStorageSpace.FreeSpace < FiveGigabyte) |
| | | 303 | | { |
| | 0 | 304 | | throw new InvalidOperationException($"The backup directory '{backupStorageSpace.Path}' does not have at leas |
| | | 305 | | } |
| | | 306 | | |
| | 0 | 307 | | var backupPath = Path.Combine(backupFolder, $"jellyfin-backup-{manifest.DateCreated.ToLocalTime():yyyyMMddHHmmss |
| | | 308 | | |
| | | 309 | | try |
| | | 310 | | { |
| | 0 | 311 | | _logger.LogInformation("Attempting to create a new backup at {BackupPath}", backupPath); |
| | 0 | 312 | | var fileStream = File.OpenWrite(backupPath); |
| | 0 | 313 | | await using (fileStream.ConfigureAwait(false)) |
| | 0 | 314 | | using (var zipArchive = new ZipArchive(fileStream, ZipArchiveMode.Create, false)) |
| | | 315 | | { |
| | 0 | 316 | | _logger.LogInformation("Starting backup process"); |
| | 0 | 317 | | var dbContext = await _dbProvider.CreateDbContextAsync().ConfigureAwait(false); |
| | 0 | 318 | | await using (dbContext.ConfigureAwait(false)) |
| | | 319 | | { |
| | 0 | 320 | | dbContext.ChangeTracker.QueryTrackingBehavior = QueryTrackingBehavior.NoTracking; |
| | | 321 | | |
| | | 322 | | static IAsyncEnumerable<object> GetValues(IQueryable dbSet) |
| | | 323 | | { |
| | | 324 | | var method = dbSet.GetType().GetMethod(nameof(DbSet<object>.AsAsyncEnumerable))!; |
| | | 325 | | var enumerable = method.Invoke(dbSet, null)!; |
| | | 326 | | return (IAsyncEnumerable<object>)enumerable; |
| | | 327 | | } |
| | | 328 | | |
| | | 329 | | // include the migration history as well |
| | 0 | 330 | | var historyRepository = dbContext.GetService<IHistoryRepository>(); |
| | 0 | 331 | | var migrations = await historyRepository.GetAppliedMigrationsAsync().ConfigureAwait(false); |
| | | 332 | | |
| | 0 | 333 | | ICollection<(Type Type, string SourceName, Func<IAsyncEnumerable<object>> ValueFactory)> entityTypes |
| | 0 | 334 | | [ |
| | 0 | 335 | | .. typeof(JellyfinDbContext) |
| | 0 | 336 | | .GetProperties(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Instan |
| | 0 | 337 | | .Where(e => e.PropertyType.IsAssignableTo(typeof(IQueryable))) |
| | 0 | 338 | | .Select(e => (Type: e.PropertyType, dbContext.Model.FindEntityType(e.PropertyType.GetGeneric |
| | 0 | 339 | | (Type: typeof(HistoryRow), SourceName: nameof(HistoryRow), ValueFactory: () => migrations.ToAsyn |
| | 0 | 340 | | ]; |
| | 0 | 341 | | manifest.DatabaseTables = entityTypes.Select(e => e.Type.Name).ToArray(); |
| | 0 | 342 | | var transaction = await dbContext.Database.BeginTransactionAsync().ConfigureAwait(false); |
| | | 343 | | |
| | 0 | 344 | | await using (transaction.ConfigureAwait(false)) |
| | | 345 | | { |
| | 0 | 346 | | _logger.LogInformation("Begin Database backup"); |
| | | 347 | | |
| | 0 | 348 | | foreach (var entityType in entityTypes) |
| | | 349 | | { |
| | 0 | 350 | | _logger.LogInformation("Begin backup of entity {Table}", entityType.SourceName); |
| | 0 | 351 | | var zipEntry = zipArchive.CreateEntry(NormalizePathSeparator(Path.Combine("Database", $"{ent |
| | 0 | 352 | | var entities = 0; |
| | 0 | 353 | | var zipEntryStream = await zipEntry.OpenAsync().ConfigureAwait(false); |
| | 0 | 354 | | await using (zipEntryStream.ConfigureAwait(false)) |
| | | 355 | | { |
| | 0 | 356 | | var jsonSerializer = new Utf8JsonWriter(zipEntryStream); |
| | 0 | 357 | | await using (jsonSerializer.ConfigureAwait(false)) |
| | | 358 | | { |
| | 0 | 359 | | jsonSerializer.WriteStartArray(); |
| | | 360 | | |
| | 0 | 361 | | var set = entityType.ValueFactory().ConfigureAwait(false); |
| | 0 | 362 | | await foreach (var item in set.ConfigureAwait(false)) |
| | | 363 | | { |
| | 0 | 364 | | entities++; |
| | | 365 | | try |
| | | 366 | | { |
| | 0 | 367 | | using var document = JsonSerializer.SerializeToDocument(item, _serializerSet |
| | 0 | 368 | | document.WriteTo(jsonSerializer); |
| | 0 | 369 | | } |
| | 0 | 370 | | catch (Exception ex) |
| | | 371 | | { |
| | 0 | 372 | | _logger.LogError(ex, "Could not load entity {Entity}", item); |
| | 0 | 373 | | throw; |
| | | 374 | | } |
| | | 375 | | } |
| | | 376 | | |
| | 0 | 377 | | jsonSerializer.WriteEndArray(); |
| | | 378 | | } |
| | 0 | 379 | | } |
| | | 380 | | |
| | 0 | 381 | | _logger.LogInformation("Backup of entity {Table} with {Number} created", entityType.SourceNa |
| | 0 | 382 | | } |
| | | 383 | | } |
| | 0 | 384 | | } |
| | | 385 | | |
| | 0 | 386 | | _logger.LogInformation("Backup of folder {Table}", _applicationPaths.ConfigurationDirectoryPath); |
| | 0 | 387 | | foreach (var item in Directory.EnumerateFiles(_applicationPaths.ConfigurationDirectoryPath, "*.xml", Sea |
| | 0 | 388 | | .Union(Directory.EnumerateFiles(_applicationPaths.ConfigurationDirectoryPath, "*.json", Sea |
| | | 389 | | { |
| | 0 | 390 | | await zipArchive.CreateEntryFromFileAsync(item, NormalizePathSeparator(Path.Combine("Config", Path.G |
| | | 391 | | } |
| | | 392 | | |
| | | 393 | | void CopyDirectory(string source, string target, string filter = "*") |
| | | 394 | | { |
| | | 395 | | if (!Directory.Exists(source)) |
| | | 396 | | { |
| | | 397 | | return; |
| | | 398 | | } |
| | | 399 | | |
| | | 400 | | _logger.LogInformation("Backup of folder {Table}", source); |
| | | 401 | | |
| | | 402 | | foreach (var item in Directory.EnumerateFiles(source, filter, SearchOption.AllDirectories)) |
| | | 403 | | { |
| | | 404 | | // TODO: @bond make async |
| | | 405 | | zipArchive.CreateEntryFromFile(item, NormalizePathSeparator(Path.Combine(target, Path.GetRelativ |
| | | 406 | | } |
| | | 407 | | } |
| | | 408 | | |
| | 0 | 409 | | CopyDirectory(Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "users"), Path.Combine("Config" |
| | 0 | 410 | | CopyDirectory(Path.Combine(_applicationPaths.ConfigurationDirectoryPath, "ScheduledTasks"), Path.Combine |
| | 0 | 411 | | CopyDirectory(Path.Combine(_applicationPaths.RootFolderPath), "Root"); |
| | 0 | 412 | | CopyDirectory(Path.Combine(_applicationPaths.DataPath, "collections"), Path.Combine("Data", "collections |
| | 0 | 413 | | CopyDirectory(Path.Combine(_applicationPaths.DataPath, "playlists"), Path.Combine("Data", "playlists")); |
| | 0 | 414 | | CopyDirectory(Path.Combine(_applicationPaths.DataPath, "ScheduledTasks"), Path.Combine("Data", "Schedule |
| | 0 | 415 | | if (backupOptions.Subtitles) |
| | | 416 | | { |
| | 0 | 417 | | CopyDirectory(Path.Combine(_applicationPaths.DataPath, "subtitles"), Path.Combine("Data", "subtitles |
| | | 418 | | } |
| | | 419 | | |
| | 0 | 420 | | if (backupOptions.Trickplay) |
| | | 421 | | { |
| | 0 | 422 | | CopyDirectory(Path.Combine(_applicationPaths.DataPath, "trickplay"), Path.Combine("Data", "trickplay |
| | | 423 | | } |
| | | 424 | | |
| | 0 | 425 | | if (backupOptions.Metadata) |
| | | 426 | | { |
| | 0 | 427 | | CopyDirectory(Path.Combine(_applicationPaths.InternalMetadataPath), Path.Combine("Data", "metadata") |
| | | 428 | | |
| | | 429 | | // If a custom metadata path is configured, the default location may still contain data. |
| | 0 | 430 | | if (!string.Equals( |
| | 0 | 431 | | Path.GetFullPath(_applicationPaths.DefaultInternalMetadataPath), |
| | 0 | 432 | | Path.GetFullPath(_applicationPaths.InternalMetadataPath), |
| | 0 | 433 | | StringComparison.OrdinalIgnoreCase)) |
| | | 434 | | { |
| | 0 | 435 | | CopyDirectory(Path.Combine(_applicationPaths.DefaultInternalMetadataPath), Path.Combine("Data", |
| | | 436 | | } |
| | | 437 | | } |
| | | 438 | | |
| | 0 | 439 | | var manifestStream = await zipArchive.CreateEntry(ManifestEntryName).OpenAsync().ConfigureAwait(false); |
| | 0 | 440 | | await using (manifestStream.ConfigureAwait(false)) |
| | | 441 | | { |
| | 0 | 442 | | await JsonSerializer.SerializeAsync(manifestStream, manifest).ConfigureAwait(false); |
| | | 443 | | } |
| | 0 | 444 | | } |
| | | 445 | | |
| | 0 | 446 | | _logger.LogInformation("Backup created"); |
| | 0 | 447 | | return Map(manifest, backupPath); |
| | | 448 | | } |
| | 0 | 449 | | catch (Exception ex) |
| | | 450 | | { |
| | 0 | 451 | | _logger.LogError(ex, "Failed to create backup, removing {BackupPath}", backupPath); |
| | | 452 | | try |
| | | 453 | | { |
| | 0 | 454 | | if (File.Exists(backupPath)) |
| | | 455 | | { |
| | 0 | 456 | | File.Delete(backupPath); |
| | | 457 | | } |
| | 0 | 458 | | } |
| | 0 | 459 | | catch (Exception innerEx) |
| | | 460 | | { |
| | 0 | 461 | | _logger.LogWarning(innerEx, "Unable to remove failed backup"); |
| | 0 | 462 | | } |
| | | 463 | | |
| | 0 | 464 | | throw; |
| | | 465 | | } |
| | 0 | 466 | | } |
| | | 467 | | |
| | | 468 | | /// <inheritdoc/> |
| | | 469 | | public async Task<BackupManifestDto?> GetBackupManifest(string archivePath) |
| | | 470 | | { |
| | 0 | 471 | | if (!File.Exists(archivePath)) |
| | | 472 | | { |
| | 0 | 473 | | return null; |
| | | 474 | | } |
| | | 475 | | |
| | | 476 | | BackupManifest? manifest; |
| | | 477 | | try |
| | | 478 | | { |
| | 0 | 479 | | manifest = await GetManifest(archivePath).ConfigureAwait(false); |
| | 0 | 480 | | } |
| | 0 | 481 | | catch (Exception ex) |
| | | 482 | | { |
| | 0 | 483 | | _logger.LogWarning(ex, "Tried to load manifest from archive {Path} but failed", archivePath); |
| | 0 | 484 | | return null; |
| | | 485 | | } |
| | | 486 | | |
| | 0 | 487 | | if (manifest is null) |
| | | 488 | | { |
| | 0 | 489 | | return null; |
| | | 490 | | } |
| | | 491 | | |
| | 0 | 492 | | return Map(manifest, archivePath); |
| | 0 | 493 | | } |
| | | 494 | | |
| | | 495 | | /// <inheritdoc/> |
| | | 496 | | public async Task<BackupManifestDto[]> EnumerateBackups() |
| | | 497 | | { |
| | 0 | 498 | | if (!Directory.Exists(_applicationPaths.BackupPath)) |
| | | 499 | | { |
| | 0 | 500 | | return []; |
| | | 501 | | } |
| | | 502 | | |
| | 0 | 503 | | var archives = Directory.EnumerateFiles(_applicationPaths.BackupPath, "*.zip"); |
| | 0 | 504 | | var manifests = new List<BackupManifestDto>(); |
| | 0 | 505 | | foreach (var item in archives) |
| | | 506 | | { |
| | | 507 | | try |
| | | 508 | | { |
| | 0 | 509 | | var manifest = await GetManifest(item).ConfigureAwait(false); |
| | | 510 | | |
| | 0 | 511 | | if (manifest is null) |
| | | 512 | | { |
| | 0 | 513 | | continue; |
| | | 514 | | } |
| | | 515 | | |
| | 0 | 516 | | manifests.Add(Map(manifest, item)); |
| | 0 | 517 | | } |
| | 0 | 518 | | catch (Exception ex) |
| | | 519 | | { |
| | 0 | 520 | | _logger.LogWarning(ex, "Tried to load manifest from archive {Path} but failed", item); |
| | 0 | 521 | | } |
| | 0 | 522 | | } |
| | | 523 | | |
| | 0 | 524 | | return manifests.ToArray(); |
| | 0 | 525 | | } |
| | | 526 | | |
| | | 527 | | private static async ValueTask<BackupManifest?> GetManifest(string archivePath) |
| | | 528 | | { |
| | 0 | 529 | | var archiveStream = File.OpenRead(archivePath); |
| | 0 | 530 | | await using (archiveStream.ConfigureAwait(false)) |
| | | 531 | | { |
| | 0 | 532 | | using var zipStream = new ZipArchive(archiveStream, ZipArchiveMode.Read); |
| | 0 | 533 | | var manifestEntry = zipStream.GetEntry(ManifestEntryName); |
| | 0 | 534 | | if (manifestEntry is null) |
| | | 535 | | { |
| | 0 | 536 | | return null; |
| | | 537 | | } |
| | | 538 | | |
| | 0 | 539 | | var manifestStream = await manifestEntry.OpenAsync().ConfigureAwait(false); |
| | 0 | 540 | | await using (manifestStream.ConfigureAwait(false)) |
| | | 541 | | { |
| | 0 | 542 | | return await JsonSerializer.DeserializeAsync<BackupManifest>(manifestStream, _serializerSettings).Config |
| | | 543 | | } |
| | 0 | 544 | | } |
| | 0 | 545 | | } |
| | | 546 | | |
| | | 547 | | private static BackupManifestDto Map(BackupManifest manifest, string path) |
| | | 548 | | { |
| | 0 | 549 | | return new BackupManifestDto() |
| | 0 | 550 | | { |
| | 0 | 551 | | BackupEngineVersion = manifest.BackupEngineVersion, |
| | 0 | 552 | | DateCreated = manifest.DateCreated, |
| | 0 | 553 | | ServerVersion = manifest.ServerVersion, |
| | 0 | 554 | | Path = path, |
| | 0 | 555 | | Options = Map(manifest.Options) |
| | 0 | 556 | | }; |
| | | 557 | | } |
| | | 558 | | |
| | | 559 | | private static BackupOptionsDto Map(BackupOptions options) |
| | | 560 | | { |
| | 0 | 561 | | return new BackupOptionsDto() |
| | 0 | 562 | | { |
| | 0 | 563 | | Metadata = options.Metadata, |
| | 0 | 564 | | Subtitles = options.Subtitles, |
| | 0 | 565 | | Trickplay = options.Trickplay, |
| | 0 | 566 | | Database = options.Database |
| | 0 | 567 | | }; |
| | | 568 | | } |
| | | 569 | | |
| | | 570 | | private static BackupOptions Map(BackupOptionsDto options) |
| | | 571 | | { |
| | 0 | 572 | | return new BackupOptions() |
| | 0 | 573 | | { |
| | 0 | 574 | | Metadata = options.Metadata, |
| | 0 | 575 | | Subtitles = options.Subtitles, |
| | 0 | 576 | | Trickplay = options.Trickplay, |
| | 0 | 577 | | Database = options.Database |
| | 0 | 578 | | }; |
| | | 579 | | } |
| | | 580 | | |
| | | 581 | | /// <summary> |
| | | 582 | | /// Windows is able to handle '/' as a path seperator in zip files |
| | | 583 | | /// but linux isn't able to handle '\' as a path seperator in zip files, |
| | | 584 | | /// So normalize to '/'. |
| | | 585 | | /// </summary> |
| | | 586 | | /// <param name="path">The path to normalize.</param> |
| | | 587 | | /// <returns>The normalized path. </returns> |
| | | 588 | | private static string NormalizePathSeparator(string path) |
| | 0 | 589 | | => path.Replace('\\', '/'); |
| | | 590 | | } |