feat(server) user-defined storage structure (#1098)

[Breaking] newly uploaded file will conform to the default structure of `{uploadLocation}/{userId}/year/year-month-day/filename.ext`

mobile/openapi/lib/api.dart

@@ -91,6 +91,8 @@ part 'model/smart_info_response_dto.dart';
 part 'model/system_config_dto.dart';
 part 'model/system_config_f_fmpeg_dto.dart';
 part 'model/system_config_o_auth_dto.dart';
+part 'model/system_config_storage_template_dto.dart';
+part 'model/system_config_template_storage_option_dto.dart';
 part 'model/tag_response_dto.dart';
 part 'model/tag_type_enum.dart';
 part 'model/thumbnail_format.dart';

mobile/openapi/lib/api/system_config_api.dart

@@ -98,6 +98,47 @@ class SystemConfigApi {
     return null;
   }
 
+  /// Performs an HTTP 'GET /system-config/storage-template-options' operation and returns the [Response].
+  Future<Response> getStorageTemplateOptionsWithHttpInfo() async {
+    // ignore: prefer_const_declarations
+    final path = r'/system-config/storage-template-options';
+
+    // ignore: prefer_final_locals
+    Object? postBody;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    const contentTypes = <String>[];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'GET',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async {
+    final response = await getStorageTemplateOptionsWithHttpInfo();
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'SystemConfigTemplateStorageOptionDto',) as SystemConfigTemplateStorageOptionDto;
+    
+    }
+    return null;
+  }
+
   /// Performs an HTTP 'PUT /system-config' operation and returns the [Response].
   /// Parameters:
   ///

mobile/openapi/lib/api_client.dart

@@ -298,6 +298,10 @@ class ApiClient {
           return SystemConfigFFmpegDto.fromJson(value);
         case 'SystemConfigOAuthDto':
           return SystemConfigOAuthDto.fromJson(value);
+        case 'SystemConfigStorageTemplateDto':
+          return SystemConfigStorageTemplateDto.fromJson(value);
+        case 'SystemConfigTemplateStorageOptionDto':
+          return SystemConfigTemplateStorageOptionDto.fromJson(value);
         case 'TagResponseDto':
           return TagResponseDto.fromJson(value);
         case 'TagTypeEnum':

mobile/openapi/lib/model/system_config_dto.dart

@@ -15,30 +15,36 @@ class SystemConfigDto {
   SystemConfigDto({
     required this.ffmpeg,
     required this.oauth,
+    required this.storageTemplate,
   });
 
   SystemConfigFFmpegDto ffmpeg;
 
   SystemConfigOAuthDto oauth;
 
+  SystemConfigStorageTemplateDto storageTemplate;
+
   @override
   bool operator ==(Object other) => identical(this, other) || other is SystemConfigDto &&
      other.ffmpeg == ffmpeg &&
-     other.oauth == oauth;
+     other.oauth == oauth &&
+     other.storageTemplate == storageTemplate;
 
   @override
   int get hashCode =>
     // ignore: unnecessary_parenthesis
     (ffmpeg.hashCode) +
-    (oauth.hashCode);
+    (oauth.hashCode) +
+    (storageTemplate.hashCode);
 
   @override
-  String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, oauth=$oauth]';
+  String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, oauth=$oauth, storageTemplate=$storageTemplate]';
 
   Map<String, dynamic> toJson() {
     final _json = <String, dynamic>{};
       _json[r'ffmpeg'] = ffmpeg;
       _json[r'oauth'] = oauth;
+      _json[r'storageTemplate'] = storageTemplate;
     return _json;
   }
 
@@ -63,6 +69,7 @@ class SystemConfigDto {
       return SystemConfigDto(
         ffmpeg: SystemConfigFFmpegDto.fromJson(json[r'ffmpeg'])!,
         oauth: SystemConfigOAuthDto.fromJson(json[r'oauth'])!,
+        storageTemplate: SystemConfigStorageTemplateDto.fromJson(json[r'storageTemplate'])!,
       );
     }
     return null;
@@ -114,6 +121,7 @@ class SystemConfigDto {
   static const requiredKeys = <String>{
     'ffmpeg',
     'oauth',
+    'storageTemplate',
   };
 }
 

mobile/openapi/lib/model/system_config_storage_template_dto.dart

@@ -0,0 +1,111 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// 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 SystemConfigStorageTemplateDto {
+  /// Returns a new [SystemConfigStorageTemplateDto] instance.
+  SystemConfigStorageTemplateDto({
+    required this.template,
+  });
+
+  String template;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigStorageTemplateDto &&
+     other.template == template;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (template.hashCode);
+
+  @override
+  String toString() => 'SystemConfigStorageTemplateDto[template=$template]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'template'] = template;
+    return _json;
+  }
+
+  /// Returns a new [SystemConfigStorageTemplateDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigStorageTemplateDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "SystemConfigStorageTemplateDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "SystemConfigStorageTemplateDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return SystemConfigStorageTemplateDto(
+        template: mapValueOfType<String>(json, r'template')!,
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigStorageTemplateDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigStorageTemplateDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigStorageTemplateDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigStorageTemplateDto> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigStorageTemplateDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigStorageTemplateDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigStorageTemplateDto-objects as value to a dart map
+  static Map<String, List<SystemConfigStorageTemplateDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigStorageTemplateDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigStorageTemplateDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'template',
+  };
+}
+

mobile/openapi/lib/model/system_config_template_storage_option_dto.dart

@@ -0,0 +1,173 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// 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 SystemConfigTemplateStorageOptionDto {
+  /// Returns a new [SystemConfigTemplateStorageOptionDto] instance.
+  SystemConfigTemplateStorageOptionDto({
+    this.yearOptions = const [],
+    this.monthOptions = const [],
+    this.dayOptions = const [],
+    this.hourOptions = const [],
+    this.minuteOptions = const [],
+    this.secondOptions = const [],
+    this.presetOptions = const [],
+  });
+
+  List<String> yearOptions;
+
+  List<String> monthOptions;
+
+  List<String> dayOptions;
+
+  List<String> hourOptions;
+
+  List<String> minuteOptions;
+
+  List<String> secondOptions;
+
+  List<String> presetOptions;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigTemplateStorageOptionDto &&
+     other.yearOptions == yearOptions &&
+     other.monthOptions == monthOptions &&
+     other.dayOptions == dayOptions &&
+     other.hourOptions == hourOptions &&
+     other.minuteOptions == minuteOptions &&
+     other.secondOptions == secondOptions &&
+     other.presetOptions == presetOptions;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (yearOptions.hashCode) +
+    (monthOptions.hashCode) +
+    (dayOptions.hashCode) +
+    (hourOptions.hashCode) +
+    (minuteOptions.hashCode) +
+    (secondOptions.hashCode) +
+    (presetOptions.hashCode);
+
+  @override
+  String toString() => 'SystemConfigTemplateStorageOptionDto[yearOptions=$yearOptions, monthOptions=$monthOptions, dayOptions=$dayOptions, hourOptions=$hourOptions, minuteOptions=$minuteOptions, secondOptions=$secondOptions, presetOptions=$presetOptions]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'yearOptions'] = yearOptions;
+      _json[r'monthOptions'] = monthOptions;
+      _json[r'dayOptions'] = dayOptions;
+      _json[r'hourOptions'] = hourOptions;
+      _json[r'minuteOptions'] = minuteOptions;
+      _json[r'secondOptions'] = secondOptions;
+      _json[r'presetOptions'] = presetOptions;
+    return _json;
+  }
+
+  /// Returns a new [SystemConfigTemplateStorageOptionDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigTemplateStorageOptionDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "SystemConfigTemplateStorageOptionDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "SystemConfigTemplateStorageOptionDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return SystemConfigTemplateStorageOptionDto(
+        yearOptions: json[r'yearOptions'] is List
+            ? (json[r'yearOptions'] as List).cast<String>()
+            : const [],
+        monthOptions: json[r'monthOptions'] is List
+            ? (json[r'monthOptions'] as List).cast<String>()
+            : const [],
+        dayOptions: json[r'dayOptions'] is List
+            ? (json[r'dayOptions'] as List).cast<String>()
+            : const [],
+        hourOptions: json[r'hourOptions'] is List
+            ? (json[r'hourOptions'] as List).cast<String>()
+            : const [],
+        minuteOptions: json[r'minuteOptions'] is List
+            ? (json[r'minuteOptions'] as List).cast<String>()
+            : const [],
+        secondOptions: json[r'secondOptions'] is List
+            ? (json[r'secondOptions'] as List).cast<String>()
+            : const [],
+        presetOptions: json[r'presetOptions'] is List
+            ? (json[r'presetOptions'] as List).cast<String>()
+            : const [],
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigTemplateStorageOptionDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigTemplateStorageOptionDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigTemplateStorageOptionDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigTemplateStorageOptionDto> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigTemplateStorageOptionDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigTemplateStorageOptionDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigTemplateStorageOptionDto-objects as value to a dart map
+  static Map<String, List<SystemConfigTemplateStorageOptionDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigTemplateStorageOptionDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigTemplateStorageOptionDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'yearOptions',
+    'monthOptions',
+    'dayOptions',
+    'hourOptions',
+    'minuteOptions',
+    'secondOptions',
+    'presetOptions',
+  };
+}
+