Add Full system backup feature (#13945)

5 files changed, 126 insertions, 0 deletions

diff --git a/MediaBrowser.Controller/IServerApplicationHost.cs b/MediaBrowser.Controller/IServerApplicationHost.cs
index e9c4d9e19..b76141db0 100644
--- a/MediaBrowser.Controller/IServerApplicationHost.cs
+++ b/MediaBrowser.Controller/IServerApplicationHost.cs
@@ -39,6 +39,11 @@ namespace MediaBrowser.Controller
         string FriendlyName { get; }
 
         /// <summary>
+        /// Gets or sets the path to the backup archive used to restore upon restart.
+        /// </summary>
+        string RestoreBackupPath { get; set; }
+
+        /// <summary>
         /// Gets a URL specific for the request.
         /// </summary>
         /// <param name="request">The <see cref="HttpRequest"/> instance.</param>
diff --git a/MediaBrowser.Controller/SystemBackupService/BackupManifestDto.cs b/MediaBrowser.Controller/SystemBackupService/BackupManifestDto.cs
new file mode 100644
index 000000000..b094ec275
--- /dev/null
+++ b/MediaBrowser.Controller/SystemBackupService/BackupManifestDto.cs
@@ -0,0 +1,34 @@
+using System;
+
+namespace MediaBrowser.Controller.SystemBackupService;
+
+/// <summary>
+/// Manifest type for backups internal structure.
+/// </summary>
+public class BackupManifestDto
+{
+    /// <summary>
+    /// Gets or sets the jellyfin version this backup was created with.
+    /// </summary>
+    public required Version ServerVersion { get; set; }
+
+    /// <summary>
+    /// Gets or sets the backup engine version this backup was created with.
+    /// </summary>
+    public required Version BackupEngineVersion { get; set; }
+
+    /// <summary>
+    /// Gets or sets the date this backup was created with.
+    /// </summary>
+    public required DateTimeOffset DateCreated { get; set; }
+
+    /// <summary>
+    /// Gets or sets the path to the backup on the system.
+    /// </summary>
+    public required string Path { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contents of the backup archive.
+    /// </summary>
+    public required BackupOptionsDto Options { get; set; }
+}
diff --git a/MediaBrowser.Controller/SystemBackupService/BackupOptionsDto.cs b/MediaBrowser.Controller/SystemBackupService/BackupOptionsDto.cs
new file mode 100644
index 000000000..228839a1d
--- /dev/null
+++ b/MediaBrowser.Controller/SystemBackupService/BackupOptionsDto.cs
@@ -0,0 +1,24 @@
+using System;
+
+namespace MediaBrowser.Controller.SystemBackupService;
+
+/// <summary>
+/// Defines the optional contents of the backup archive.
+/// </summary>
+public class BackupOptionsDto
+{
+    /// <summary>
+    /// Gets or sets a value indicating whether the archive contains the Metadata contents.
+    /// </summary>
+    public bool Metadata { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the archive contains the Trickplay contents.
+    /// </summary>
+    public bool Trickplay { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the archive contains the Subtitle contents.
+    /// </summary>
+    public bool Subtitles { get; set; }
+}
diff --git a/MediaBrowser.Controller/SystemBackupService/BackupRestoreRequestDto.cs b/MediaBrowser.Controller/SystemBackupService/BackupRestoreRequestDto.cs
new file mode 100644
index 000000000..263fa00c8
--- /dev/null
+++ b/MediaBrowser.Controller/SystemBackupService/BackupRestoreRequestDto.cs
@@ -0,0 +1,15 @@
+using System;
+using MediaBrowser.Common.Configuration;
+
+namespace MediaBrowser.Controller.SystemBackupService;
+
+/// <summary>
+/// Defines properties used to start a restore process.
+/// </summary>
+public class BackupRestoreRequestDto
+{
+    /// <summary>
+    /// Gets or Sets the name of the backup archive to restore from. Must be present in <see cref="IApplicationPaths.BackupPath"/>.
+    /// </summary>
+    public required string ArchiveFileName { get; set; }
+}
diff --git a/MediaBrowser.Controller/SystemBackupService/IBackupService.cs b/MediaBrowser.Controller/SystemBackupService/IBackupService.cs
new file mode 100644
index 000000000..0c586d811
--- /dev/null
+++ b/MediaBrowser.Controller/SystemBackupService/IBackupService.cs
@@ -0,0 +1,48 @@
+using System;
+using System.IO;
+using System.Threading.Tasks;
+using MediaBrowser.Controller.SystemBackupService;
+
+namespace Jellyfin.Server.Implementations.SystemBackupService;
+
+/// <summary>
+/// Defines an interface to restore and backup the jellyfin system.
+/// </summary>
+public interface IBackupService
+{
+    /// <summary>
+    /// Creates a new Backup zip file containing the current state of the application.
+    /// </summary>
+    /// <param name="backupOptions">The backup options.</param>
+    /// <returns>A task.</returns>
+    Task<BackupManifestDto> CreateBackupAsync(BackupOptionsDto backupOptions);
+
+    /// <summary>
+    /// Gets a list of backups that are available to be restored from.
+    /// </summary>
+    /// <returns>A list of backup paths.</returns>
+    Task<BackupManifestDto[]> EnumerateBackups();
+
+    /// <summary>
+    /// Gets a single backup manifest if the path defines a valid Jellyfin backup archive.
+    /// </summary>
+    /// <param name="archivePath">The path to be loaded.</param>
+    /// <returns>The containing backup manifest or null if not existing or compatiable.</returns>
+    Task<BackupManifestDto?> GetBackupManifest(string archivePath);
+
+    /// <summary>
+    /// Restores an backup zip file created by jellyfin.
+    /// </summary>
+    /// <param name="archivePath">Path to the archive.</param>
+    /// <returns>A Task.</returns>
+    /// <exception cref="FileNotFoundException">Thrown when an invalid or missing file is specified.</exception>
+    /// <exception cref="NotSupportedException">Thrown when attempt to load an unsupported backup is made.</exception>
+    /// <exception cref="InvalidOperationException">Thrown for errors during the restore.</exception>
+    Task RestoreBackupAsync(string archivePath);
+
+    /// <summary>
+    /// Schedules a Restore and restarts the server.
+    /// </summary>
+    /// <param name="archivePath">The path to the archive to restore from.</param>
+    void ScheduleRestoreAndRestartServer(string archivePath);
+}