feat: built-in automatic database backups (#13773)

mobile/openapi/lib/model/all_job_status_response_dto.dart

@@ -14,6 +14,7 @@ class AllJobStatusResponseDto {
   /// Returns a new [AllJobStatusResponseDto] instance.
   AllJobStatusResponseDto({
     required this.backgroundTask,
+    required this.backupDatabase,
     required this.duplicateDetection,
     required this.faceDetection,
     required this.facialRecognition,
@@ -31,6 +32,8 @@ class AllJobStatusResponseDto {
 
   JobStatusDto backgroundTask;
 
+  JobStatusDto backupDatabase;
+
   JobStatusDto duplicateDetection;
 
   JobStatusDto faceDetection;
@@ -60,6 +63,7 @@ class AllJobStatusResponseDto {
   @override
   bool operator ==(Object other) => identical(this, other) || other is AllJobStatusResponseDto &&
     other.backgroundTask == backgroundTask &&
+    other.backupDatabase == backupDatabase &&
     other.duplicateDetection == duplicateDetection &&
     other.faceDetection == faceDetection &&
     other.facialRecognition == facialRecognition &&
@@ -78,6 +82,7 @@ class AllJobStatusResponseDto {
   int get hashCode =>
     // ignore: unnecessary_parenthesis
     (backgroundTask.hashCode) +
+    (backupDatabase.hashCode) +
     (duplicateDetection.hashCode) +
     (faceDetection.hashCode) +
     (facialRecognition.hashCode) +
@@ -93,11 +98,12 @@ class AllJobStatusResponseDto {
     (videoConversion.hashCode);
 
   @override
-  String toString() => 'AllJobStatusResponseDto[backgroundTask=$backgroundTask, duplicateDetection=$duplicateDetection, faceDetection=$faceDetection, facialRecognition=$facialRecognition, library_=$library_, metadataExtraction=$metadataExtraction, migration=$migration, notifications=$notifications, search=$search, sidecar=$sidecar, smartSearch=$smartSearch, storageTemplateMigration=$storageTemplateMigration, thumbnailGeneration=$thumbnailGeneration, videoConversion=$videoConversion]';
+  String toString() => 'AllJobStatusResponseDto[backgroundTask=$backgroundTask, backupDatabase=$backupDatabase, duplicateDetection=$duplicateDetection, faceDetection=$faceDetection, facialRecognition=$facialRecognition, library_=$library_, metadataExtraction=$metadataExtraction, migration=$migration, notifications=$notifications, search=$search, sidecar=$sidecar, smartSearch=$smartSearch, storageTemplateMigration=$storageTemplateMigration, thumbnailGeneration=$thumbnailGeneration, videoConversion=$videoConversion]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
       json[r'backgroundTask'] = this.backgroundTask;
+      json[r'backupDatabase'] = this.backupDatabase;
       json[r'duplicateDetection'] = this.duplicateDetection;
       json[r'faceDetection'] = this.faceDetection;
       json[r'facialRecognition'] = this.facialRecognition;
@@ -124,6 +130,7 @@ class AllJobStatusResponseDto {
 
       return AllJobStatusResponseDto(
         backgroundTask: JobStatusDto.fromJson(json[r'backgroundTask'])!,
+        backupDatabase: JobStatusDto.fromJson(json[r'backupDatabase'])!,
         duplicateDetection: JobStatusDto.fromJson(json[r'duplicateDetection'])!,
         faceDetection: JobStatusDto.fromJson(json[r'faceDetection'])!,
         facialRecognition: JobStatusDto.fromJson(json[r'facialRecognition'])!,
@@ -185,6 +192,7 @@ class AllJobStatusResponseDto {
   /// The list of required keys that must be present in a JSON.
   static const requiredKeys = <String>{
     'backgroundTask',
+    'backupDatabase',
     'duplicateDetection',
     'faceDetection',
     'facialRecognition',

mobile/openapi/lib/model/database_backup_config.dart

@@ -0,0 +1,116 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class DatabaseBackupConfig {
+  /// Returns a new [DatabaseBackupConfig] instance.
+  DatabaseBackupConfig({
+    required this.cronExpression,
+    required this.enabled,
+    required this.keepLastAmount,
+  });
+
+  String cronExpression;
+
+  bool enabled;
+
+  /// Minimum value: 1
+  num keepLastAmount;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is DatabaseBackupConfig &&
+    other.cronExpression == cronExpression &&
+    other.enabled == enabled &&
+    other.keepLastAmount == keepLastAmount;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (cronExpression.hashCode) +
+    (enabled.hashCode) +
+    (keepLastAmount.hashCode);
+
+  @override
+  String toString() => 'DatabaseBackupConfig[cronExpression=$cronExpression, enabled=$enabled, keepLastAmount=$keepLastAmount]';
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+      json[r'cronExpression'] = this.cronExpression;
+      json[r'enabled'] = this.enabled;
+      json[r'keepLastAmount'] = this.keepLastAmount;
+    return json;
+  }
+
+  /// Returns a new [DatabaseBackupConfig] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static DatabaseBackupConfig? fromJson(dynamic value) {
+    upgradeDto(value, "DatabaseBackupConfig");
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      return DatabaseBackupConfig(
+        cronExpression: mapValueOfType<String>(json, r'cronExpression')!,
+        enabled: mapValueOfType<bool>(json, r'enabled')!,
+        keepLastAmount: num.parse('${json[r'keepLastAmount']}'),
+      );
+    }
+    return null;
+  }
+
+  static List<DatabaseBackupConfig> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <DatabaseBackupConfig>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = DatabaseBackupConfig.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, DatabaseBackupConfig> mapFromJson(dynamic json) {
+    final map = <String, DatabaseBackupConfig>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = DatabaseBackupConfig.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of DatabaseBackupConfig-objects as value to a dart map
+  static Map<String, List<DatabaseBackupConfig>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<DatabaseBackupConfig>>{};
+    if (json is Map && json.isNotEmpty) {
+      // ignore: parameter_assignments
+      json = json.cast<String, dynamic>();
+      for (final entry in json.entries) {
+        map[entry.key] = DatabaseBackupConfig.listFromJson(entry.value, growable: growable,);
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'cronExpression',
+    'enabled',
+    'keepLastAmount',
+  };
+}
+

mobile/openapi/lib/model/job_name.dart

@@ -37,6 +37,7 @@ class JobName {
   static const sidecar = JobName._(r'sidecar');
   static const library_ = JobName._(r'library');
   static const notifications = JobName._(r'notifications');
+  static const backupDatabase = JobName._(r'backupDatabase');
 
   /// List of all possible values in this [enum][JobName].
   static const values = <JobName>[
@@ -54,6 +55,7 @@ class JobName {
     sidecar,
     library_,
     notifications,
+    backupDatabase,
   ];
 
   static JobName? fromJson(dynamic value) => JobNameTypeTransformer().decode(value);
@@ -106,6 +108,7 @@ class JobNameTypeTransformer {
         case r'sidecar': return JobName.sidecar;
         case r'library': return JobName.library_;
         case r'notifications': return JobName.notifications;
+        case r'backupDatabase': return JobName.backupDatabase;
         default:
           if (!allowNull) {
             throw ArgumentError('Unknown enum value to decode: $data');

mobile/openapi/lib/model/system_config_backups_dto.dart

@@ -0,0 +1,99 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class SystemConfigBackupsDto {
+  /// Returns a new [SystemConfigBackupsDto] instance.
+  SystemConfigBackupsDto({
+    required this.database,
+  });
+
+  DatabaseBackupConfig database;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigBackupsDto &&
+    other.database == database;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (database.hashCode);
+
+  @override
+  String toString() => 'SystemConfigBackupsDto[database=$database]';
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+      json[r'database'] = this.database;
+    return json;
+  }
+
+  /// Returns a new [SystemConfigBackupsDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigBackupsDto? fromJson(dynamic value) {
+    upgradeDto(value, "SystemConfigBackupsDto");
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      return SystemConfigBackupsDto(
+        database: DatabaseBackupConfig.fromJson(json[r'database'])!,
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigBackupsDto> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigBackupsDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigBackupsDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigBackupsDto> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigBackupsDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigBackupsDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigBackupsDto-objects as value to a dart map
+  static Map<String, List<SystemConfigBackupsDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigBackupsDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      // ignore: parameter_assignments
+      json = json.cast<String, dynamic>();
+      for (final entry in json.entries) {
+        map[entry.key] = SystemConfigBackupsDto.listFromJson(entry.value, growable: growable,);
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'database',
+  };
+}
+

mobile/openapi/lib/model/system_config_dto.dart

@@ -13,6 +13,7 @@ part of openapi.api;
 class SystemConfigDto {
   /// Returns a new [SystemConfigDto] instance.
   SystemConfigDto({
+    required this.backup,
     required this.ffmpeg,
     required this.image,
     required this.job,
@@ -33,6 +34,8 @@ class SystemConfigDto {
     required this.user,
   });
 
+  SystemConfigBackupsDto backup;
+
   SystemConfigFFmpegDto ffmpeg;
 
   SystemConfigImageDto image;
@@ -71,6 +74,7 @@ class SystemConfigDto {
 
   @override
   bool operator ==(Object other) => identical(this, other) || other is SystemConfigDto &&
+    other.backup == backup &&
     other.ffmpeg == ffmpeg &&
     other.image == image &&
     other.job == job &&
@@ -93,6 +97,7 @@ class SystemConfigDto {
   @override
   int get hashCode =>
     // ignore: unnecessary_parenthesis
+    (backup.hashCode) +
     (ffmpeg.hashCode) +
     (image.hashCode) +
     (job.hashCode) +
@@ -113,10 +118,11 @@ class SystemConfigDto {
     (user.hashCode);
 
   @override
-  String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, image=$image, job=$job, library_=$library_, logging=$logging, machineLearning=$machineLearning, map=$map, metadata=$metadata, newVersionCheck=$newVersionCheck, notifications=$notifications, oauth=$oauth, passwordLogin=$passwordLogin, reverseGeocoding=$reverseGeocoding, server=$server, storageTemplate=$storageTemplate, theme=$theme, trash=$trash, user=$user]';
+  String toString() => 'SystemConfigDto[backup=$backup, ffmpeg=$ffmpeg, image=$image, job=$job, library_=$library_, logging=$logging, machineLearning=$machineLearning, map=$map, metadata=$metadata, newVersionCheck=$newVersionCheck, notifications=$notifications, oauth=$oauth, passwordLogin=$passwordLogin, reverseGeocoding=$reverseGeocoding, server=$server, storageTemplate=$storageTemplate, theme=$theme, trash=$trash, user=$user]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
+      json[r'backup'] = this.backup;
       json[r'ffmpeg'] = this.ffmpeg;
       json[r'image'] = this.image;
       json[r'job'] = this.job;
@@ -147,6 +153,7 @@ class SystemConfigDto {
       final json = value.cast<String, dynamic>();
 
       return SystemConfigDto(
+        backup: SystemConfigBackupsDto.fromJson(json[r'backup'])!,
         ffmpeg: SystemConfigFFmpegDto.fromJson(json[r'ffmpeg'])!,
         image: SystemConfigImageDto.fromJson(json[r'image'])!,
         job: SystemConfigJobDto.fromJson(json[r'job'])!,
@@ -212,6 +219,7 @@ class SystemConfigDto {
 
   /// The list of required keys that must be present in a JSON.
   static const requiredKeys = <String>{
+    'backup',
     'ffmpeg',
     'image',
     'job',