build: Bump dependencies to support patch option values (#1431)

Co-authored-by: oSumAtrIX <johan.melkonyan1@web.de>

android/app/build.gradle

@@ -85,7 +85,7 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 
     // ReVanced
-    implementation "app.revanced:revanced-patcher:17.0.0"
+    implementation "app.revanced:revanced-patcher:19.0.0"
 
     // Signing & aligning
     implementation("org.bouncycastle:bcpkix-jdk15on:1.70")

android/app/src/main/kotlin/app/revanced/manager/flutter/MainActivity.kt

@@ -15,7 +15,9 @@ import app.revanced.patcher.patch.PatchResult
 import io.flutter.embedding.android.FlutterActivity
 import io.flutter.embedding.engine.FlutterEngine
 import io.flutter.plugin.common.MethodChannel
+import kotlinx.coroutines.InternalCoroutinesApi
 import kotlinx.coroutines.cancel
+import kotlinx.coroutines.flow.FlowCollector
 import kotlinx.coroutines.runBlocking
 import org.json.JSONArray
 import org.json.JSONObject
@@ -25,6 +27,7 @@ import java.io.StringWriter
 import java.util.logging.LogRecord
 import java.util.logging.Logger
 
+
 class MainActivity : FlutterActivity() {
     private val handler = Handler(Looper.getMainLooper())
     private lateinit var installerChannel: MethodChannel
@@ -131,24 +134,34 @@ class MainActivity : FlutterActivity() {
                                 })
                                 put("options", JSONArray().apply {
                                     it.options.values.forEach { option ->
-                                        val optionJson = JSONObject().apply option@{
+                                        JSONObject().apply {
                                             put("key", option.key)
                                             put("title", option.title)
                                             put("description", option.description)
                                             put("required", option.required)
 
-                                            when (val value = option.value) {
+                                            fun JSONObject.putValue(
-                                                null -> put("value", null)
+                                                value: Any?,
-                                                is Array<*> -> put("value", JSONArray().apply {
+                                                key: String = "value"
-
+                                            ) = if (value is Array<*>) put(
+                                                key,
+                                                JSONArray().apply {
                                                     value.forEach { put(it) }
                                                 })
-                                                else -> put("value", option.value)
+                                            else put(key, value)
-                                            }
 
-                                            put("optionClassType", option::class.simpleName)
+                                            putValue(option.default)
+
+                                            option.values?.let { values ->
+                                                put("values",
+                                                    JSONObject().apply {
+                                                        values.forEach { (key, value) ->
+                                                            putValue(value, key)
                                                         }
-                                        put(optionJson)
+                                                    })
+                                            } ?: put("values", null)
+                                            put("valueType", option.valueType)
+                                        }.let(::put)
                                     }
                                 })
                             }.let(::put)
@@ -161,6 +174,7 @@ class MainActivity : FlutterActivity() {
         }
     }
 
+    @OptIn(InternalCoroutinesApi::class)
     private fun runPatcher(
         result: MethodChannel.Result,
         originalFilePath: String,
@@ -283,12 +297,12 @@ class MainActivity : FlutterActivity() {
                     acceptPatches(patches)
 
                     runBlocking {
-                        apply(false).collect { patchResult: PatchResult ->
+                        apply(false).collect(FlowCollector { patchResult: PatchResult ->
                             if (cancel) {
                                 handler.post { stopResult!!.success(null) }
                                 this.cancel()
                                 this@apply.close()
-                                return@collect
+                                return@FlowCollector
                             }
 
                             val msg = patchResult.exception?.let {
@@ -301,7 +315,7 @@ class MainActivity : FlutterActivity() {
 
                             updateProgress(progress, "", msg)
                             progress += progressStep
-                        }
+                        })
                     }
                 }
 

assets/i18n/en_US.json

@@ -135,6 +135,7 @@
         "setRequiredOption": "Some patches require options to be set:\n\n{patches}\n\nPlease set them before continuing."
     },
     "patchOptionsView": {
+        "customValue": "Custom value",
         "resetOptionsTooltip": "Reset patch options",
         "viewTitle": "Patch options",
         "saveOptions": "Save",

lib/models/patch.dart

@@ -13,12 +13,15 @@ class Patch {
   });
 
   factory Patch.fromJson(Map<String, dynamic> json) {
-    // See: https://github.com/ReVanced/revanced-manager/issues/1364#issuecomment-1760414618
+    _migrateV16ToV17(json);
+
+    return _$PatchFromJson(json);
+  }
+
+  static void _migrateV16ToV17(Map<String, dynamic> json) {
     if (json['options'] == null) {
       json['options'] = [];
     }
-
-    return _$PatchFromJson(json);
   }
 
   final String name;
@@ -57,18 +60,34 @@ class Option {
     required this.title,
     required this.description,
     required this.value,
+    required this.values,
     required this.required,
-    required this.optionClassType,
+    required this.valueType,
   });
 
-  factory Option.fromJson(Map<String, dynamic> json) => _$OptionFromJson(json);
+  factory Option.fromJson(Map<String, dynamic> json) {
+    _migrateV17ToV19(json);
+
+    return _$OptionFromJson(json);
+  }
+
+  static void _migrateV17ToV19(Map<String, dynamic> json) {
+    if (json['valueType'] == null) {
+      json['valueType'] = json['optionClassType']
+          .replace('PatchOption', '')
+          .replace('List', 'Array');
+
+      json['optionClassType'] = null;
+    }
+  }
 
   final String key;
   final String title;
   final String description;
-  dynamic value;
+  final dynamic value;
+  final Map<String, dynamic>? values;
   final bool required;
-  final String optionClassType;
+  final String valueType;
 
   Map toJson() => _$OptionToJson(this);
 }

lib/ui/views/patch_options/patch_options_view.dart

@@ -61,8 +61,8 @@ class PatchOptionsView extends StatelessWidget {
                   child: Column(
                     children: [
                       for (final Option option in model.visibleOptions)
-                        if (option.optionClassType == 'StringPatchOption' ||
+                        if (option.valueType == 'String' ||
-                            option.optionClassType == 'IntPatchOption')
+                            option.valueType == 'Int')
                           IntAndStringPatchOption(
                             patchOption: option,
                             removeOption: (option) {
@@ -72,7 +72,7 @@ class PatchOptionsView extends StatelessWidget {
                               model.modifyOptions(value, option);
                             },
                           )
-                        else if (option.optionClassType == 'BooleanPatchOption')
+                        else if (option.valueType == 'Boolean')
                           BooleanPatchOption(
                             patchOption: option,
                             removeOption: (option) {
@@ -82,10 +82,10 @@ class PatchOptionsView extends StatelessWidget {
                               model.modifyOptions(value, option);
                             },
                           )
-                        else if (option.optionClassType ==
+                        else if (option.valueType ==
-                                'StringListPatchOption' ||
+                                'StringArray' ||
-                            option.optionClassType == 'IntListPatchOption' ||
+                            option.valueType == 'IntArray' ||
-                            option.optionClassType == 'LongListPatchOption')
+                            option.valueType == 'LongArray')
                           IntStringLongListPatchOption(
                             patchOption: option,
                             removeOption: (option) {

lib/ui/views/patch_options/patch_options_viewmodel.dart

@@ -62,7 +62,10 @@ class PatchOptionsViewModel extends BaseViewModel {
     for (final Option option in options) {
       if (!visibleOptions.any((vOption) => vOption.key == option.key)) {
         _managerAPI.clearPatchOption(
-            selectedApp, _managerAPI.selectedPatch!.name, option.key);
+          selectedApp,
+          _managerAPI.selectedPatch!.name,
+          option.key,
+        );
       }
     }
     for (final Option option in visibleOptions) {
@@ -70,7 +73,10 @@ class PatchOptionsViewModel extends BaseViewModel {
         requiredNullOptions.add(option);
       } else {
         _managerAPI.setPatchOption(
-            option, _managerAPI.selectedPatch!.name, selectedApp);
+          option,
+          _managerAPI.selectedPatch!.name,
+          selectedApp,
+        );
       }
     }
     if (requiredNullOptions.isNotEmpty) {
@@ -89,7 +95,8 @@ class PatchOptionsViewModel extends BaseViewModel {
     final Option modifiedOption = Option(
       title: option.title,
       description: option.description,
-      optionClassType: option.optionClassType,
+      values: option.values,
+      valueType: option.valueType,
       value: value,
       required: option.required,
       key: option.key,
@@ -107,7 +114,8 @@ class PatchOptionsViewModel extends BaseViewModel {
       final Option defaultOption = Option(
         title: option.title,
         description: option.description,
-        optionClassType: option.optionClassType,
+        values: option.values,
+        valueType: option.valueType,
         value: option.value is List ? option.value.toList() : option.value,
         required: option.required,
         key: option.key,
@@ -172,6 +180,9 @@ class PatchOptionsViewModel extends BaseViewModel {
               },
               child: Padding(
                 padding: const EdgeInsets.all(8.0),
+                child: Row(
+                  children: [
+                    Expanded(
                       child: Column(
                         crossAxisAlignment: CrossAxisAlignment.start,
                         children: [
@@ -192,6 +203,9 @@ class PatchOptionsViewModel extends BaseViewModel {
                         ],
                       ),
                     ),
+                  ],
+                ),
+              ),
             );
           }).toList(),
         ),
@@ -229,7 +243,10 @@ Future<void> showRequiredOptionNullDialog(
               locator<PatcherViewModel>().notifyListeners();
               for (final option in options) {
                 managerAPI.clearPatchOption(
-                    selectedApp, managerAPI.selectedPatch!.name, option.key);
+                  selectedApp,
+                  managerAPI.selectedPatch!.name,
+                  option.key,
+                );
               }
               Navigator.of(context)
                 ..pop()

lib/ui/widgets/patchesSelectorView/patch_options_fields.dart

@@ -59,13 +59,27 @@ class IntAndStringPatchOption extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     final ValueNotifier patchOptionValue = ValueNotifier(patchOption.value);
+    String getKey() {
+      if (patchOption.value != null && patchOption.values != null) {
+        final List values = patchOption.values!.entries
+            .where((e) => e.value == patchOption.value)
+            .toList();
+        if (values.isNotEmpty) {
+          return values.first.key;
+        }
+      }
+      return '';
+    }
+
     return PatchOption(
       widget: Column(
         crossAxisAlignment: CrossAxisAlignment.start,
         children: [
           TextFieldForPatchOption(
             value: patchOption.value,
-            optionType: patchOption.optionClassType,
+            values: patchOption.values,
+            optionType: patchOption.valueType,
+            selectedKey: getKey(),
             onChanged: (value) {
               patchOptionValue.value = value;
               onChanged(value, patchOption);
@@ -119,17 +133,41 @@ class IntStringLongListPatchOption extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    final String type = patchOption.optionClassType;
+    final List<dynamic> values = List.from(patchOption.value ?? []);
-    final List<dynamic> values = patchOption.value ?? [];
     final ValueNotifier patchOptionValue = ValueNotifier(values);
+    final String type = patchOption.valueType;
+
+    String getKey(dynamic value) {
+      if (value != null && patchOption.values != null) {
+        final List values = patchOption.values!.entries
+            .where((e) => e.value.toString() == value)
+            .toList();
+        if (values.isNotEmpty) {
+          return values.first.key;
+        }
+      }
+      return '';
+    }
+
+    bool isCustomValue() {
+      if (values.length == 1 && patchOption.values != null) {
+        if (getKey(values[0]) != '') {
+          return false;
+        }
+      }
+      return true;
+    }
+
+    bool isTextFieldVisible = isCustomValue();
+
     return PatchOption(
-      widget: Column(
+      widget: ValueListenableBuilder(
-        crossAxisAlignment: CrossAxisAlignment.start,
-        children: [
-          ValueListenableBuilder(
         valueListenable: patchOptionValue,
         builder: (context, value, child) {
-              return ListView.builder(
+          return Column(
+            crossAxisAlignment: CrossAxisAlignment.start,
+            children: [
+              ListView.builder(
                 shrinkWrap: true,
                 itemCount: value.length,
                 physics: const NeverScrollableScrollPhysics(),
@@ -137,16 +175,42 @@ class IntStringLongListPatchOption extends StatelessWidget {
                   final e = values[index];
                   return TextFieldForPatchOption(
                     value: e.toString(),
+                    values: patchOption.values,
                     optionType: type,
+                    selectedKey: value.length > 1 ? '' : getKey(e),
+                    showDropdown: index == 0,
                     onChanged: (newValue) {
-                      values[index] = type == 'StringListPatchOption'
+                      if (newValue is List) {
+                        values.clear();
+                        isTextFieldVisible = false;
+                        values.add(newValue.toString());
+                      } else {
+                        isTextFieldVisible = true;
+                        if (values.length == 1 &&
+                            values[0].toString().startsWith('[') &&
+                            type.contains('Array')) {
+                          values.clear();
+                          values.addAll(patchOption.value);
+                        } else {
+                          values[index] = type == 'StringArray'
                               ? newValue
-                          : type == 'IntListPatchOption'
+                              : type == 'IntArray'
-                              ? int.parse(newValue)
+                                  ? int.parse(
-                              : num.parse(newValue);
+                                      newValue.toString().isEmpty
+                                          ? '0'
+                                          : newValue.toString(),
+                                    )
+                                  : num.parse(
+                                      newValue.toString().isEmpty
+                                          ? '0'
+                                          : newValue.toString(),
+                                    );
+                        }
+                      }
+                      patchOptionValue.value = List.from(values);
                       onChanged(values, patchOption);
                     },
-                    removeValue: (value) {
+                    removeValue: () {
                       patchOptionValue.value = List.from(patchOptionValue.value)
                         ..removeAt(index);
                       values.removeAt(index);
@@ -154,21 +218,20 @@ class IntStringLongListPatchOption extends StatelessWidget {
                     },
                   );
                 },
-              );
-            },
               ),
+              if (isTextFieldVisible) ...[
                 const SizedBox(height: 4),
                 Align(
                   alignment: Alignment.centerLeft,
                   child: TextButton(
                     onPressed: () {
-                if (type == 'StringListPatchOption') {
+                      if (type == 'StringArray') {
-                  patchOptionValue.value = List.from(patchOptionValue.value)
+                        patchOptionValue.value =
-                    ..add('');
+                            List.from(patchOptionValue.value)..add('');
                         values.add('');
                       } else {
-                  patchOptionValue.value = List.from(patchOptionValue.value)
+                        patchOptionValue.value =
-                    ..add(0);
+                            List.from(patchOptionValue.value)..add(0);
                         values.add(0);
                       }
                       onChanged(values, patchOption);
@@ -192,6 +255,9 @@ class IntStringLongListPatchOption extends StatelessWidget {
                   ),
                 ),
               ],
+            ],
+          );
+        },
       ),
       patchOption: patchOption,
       removeOption: (Option option) {
@@ -203,6 +269,7 @@ class IntStringLongListPatchOption extends StatelessWidget {
 
 class UnsupportedPatchOption extends StatelessWidget {
   const UnsupportedPatchOption({super.key, required this.patchOption});
+
   final Option patchOption;
 
   @override
@@ -302,14 +369,20 @@ class TextFieldForPatchOption extends StatefulWidget {
   const TextFieldForPatchOption({
     super.key,
     required this.value,
+    required this.values,
     this.removeValue,
     required this.onChanged,
     required this.optionType,
+    required this.selectedKey,
+    this.showDropdown = true,
   });
 
   final String? value;
+  final Map<String, dynamic>? values;
   final String optionType;
-  final void Function(dynamic value)? removeValue;
+  final String selectedKey;
+  final bool showDropdown;
+  final void Function()? removeValue;
   final void Function(dynamic value) onChanged;
 
   @override
@@ -319,12 +392,89 @@ class TextFieldForPatchOption extends StatefulWidget {
 
 class _TextFieldForPatchOptionState extends State<TextFieldForPatchOption> {
   final TextEditingController controller = TextEditingController();
+  String? selectedKey;
+  String? defaultValue;
+
   @override
   Widget build(BuildContext context) {
     final bool isStringOption = widget.optionType.contains('String');
-    final bool isListOption = widget.optionType.contains('List');
+    final bool isArrayOption = widget.optionType.contains('Array');
-    controller.text = widget.value ?? '';
+    selectedKey ??= widget.selectedKey;
-    return TextFormField(
+    controller.text = !isStringOption && isArrayOption && selectedKey == '' &&
+            (widget.value != null && widget.value.toString().startsWith('['))
+        ? ''
+        : widget.value ?? '';
+    defaultValue ??= controller.text;
+    return Column(
+      crossAxisAlignment: CrossAxisAlignment.start,
+      children: [
+        if (widget.showDropdown && (widget.values?.isNotEmpty ?? false))
+          DropdownButton<String>(
+            style: const TextStyle(
+              fontSize: 16,
+            ),
+            borderRadius: BorderRadius.circular(4),
+            dropdownColor: Theme.of(context).colorScheme.secondaryContainer,
+            isExpanded: true,
+            value: selectedKey,
+            items: widget.values!.entries
+                .map(
+                  (e) => DropdownMenuItem(
+                    value: e.key,
+                    child: RichText(
+                      text: TextSpan(
+                        text: e.key,
+                        style: const TextStyle(
+                          fontSize: 16,
+                        ),
+                        children: [
+                          TextSpan(
+                            text: ' ${e.value}',
+                            style: TextStyle(
+                              fontSize: 14,
+                              color: Theme.of(context)
+                                  .colorScheme
+                                  .onSecondaryContainer
+                                  .withOpacity(0.6),
+                            ),
+                          ),
+                        ],
+                      ),
+                    ),
+                  ),
+                )
+                .toList()
+              ..add(
+                DropdownMenuItem(
+                  value: '',
+                  child: I18nText(
+                    'patchOptionsView.customValue',
+                    child: const Text(
+                      '',
+                      style: TextStyle(
+                        fontSize: 16,
+                      ),
+                    ),
+                  ),
+                ),
+              ),
+            onChanged: (value) {
+              if (value == '') {
+                controller.text = defaultValue!;
+                widget.onChanged(controller.text);
+              } else {
+                controller.text = widget.values![value].toString();
+                widget.onChanged(
+                  isArrayOption ? widget.values![value] : controller.text,
+                );
+              }
+              setState(() {
+                selectedKey = value;
+              });
+            },
+          ),
+        if (selectedKey == '')
+          TextFormField(
             inputFormatters: [
               if (widget.optionType.contains('Int'))
                 FilteringTextInputFormatter.allow(RegExp(r'[0-9]')),
@@ -332,7 +482,8 @@ class _TextFieldForPatchOptionState extends State<TextFieldForPatchOption> {
                 FilteringTextInputFormatter.allow(RegExp(r'^[0-9]*\.?[0-9]*')),
             ],
             controller: controller,
-      keyboardType: isStringOption ? TextInputType.text : TextInputType.number,
+            keyboardType:
+                isStringOption ? TextInputType.text : TextInputType.number,
             decoration: InputDecoration(
               suffixIcon: PopupMenuButton(
                 tooltip: FlutterI18n.translate(
@@ -341,12 +492,12 @@ class _TextFieldForPatchOptionState extends State<TextFieldForPatchOption> {
                 ),
                 itemBuilder: (BuildContext context) {
                   return [
-              if (isListOption)
+                    if (isArrayOption)
                       PopupMenuItem(
                         value: 'remove',
                         child: I18nText('remove'),
                       ),
-              if (isStringOption && !isListOption) ...[
+                    if (isStringOption) ...[
                       PopupMenuItem(
                         value: 'patchOptionsView.selectFilePath',
                         child: I18nText('patchOptionsView.selectFilePath'),
@@ -368,14 +519,15 @@ class _TextFieldForPatchOptionState extends State<TextFieldForPatchOption> {
                       }
                       break;
                     case 'patchOptionsView.selectFolder':
-                final result = await FilePicker.platform.getDirectoryPath();
+                      final result =
+                          await FilePicker.platform.getDirectoryPath();
                       if (result != null) {
                         controller.text = result;
                         widget.onChanged(controller.text);
                       }
                       break;
                     case 'remove':
-                widget.removeValue!(widget.value);
+                      widget.removeValue!();
                       break;
                   }
                 },
@@ -388,6 +540,8 @@ class _TextFieldForPatchOptionState extends State<TextFieldForPatchOption> {
             onChanged: (String value) {
               widget.onChanged(value);
             },
+          ),
+      ],
     );
   }
 }

lib/utils/check_for_supported_patch.dart

@@ -17,12 +17,12 @@ bool isPatchSupported(Patch patch) {
 bool hasUnsupportedRequiredOption(List<Option> options, Patch patch) {
   final List<String> requiredOptionsType = [];
   final List<String> supportedOptionsType = [
-    'StringPatchOption',
+    'String',
-    'BooleanPatchOption',
+    'Boolean',
-    'IntPatchOption',
+    'Int',
-    'StringListPatchOption',
+    'StringArray',
-    'IntListPatchOption',
+    'IntArray',
-    'LongListPatchOption',
+    'LongArray',
   ];
   for (final Option option in options) {
     if (option.required &&
@@ -33,7 +33,7 @@ bool hasUnsupportedRequiredOption(List<Option> options, Patch patch) {
                   patch.name,
                   option.key,
                 ) == null) {
-      requiredOptionsType.add(option.optionClassType);
+      requiredOptionsType.add(option.valueType);
     }
   }
   for (final String optionType in requiredOptionsType) {