Skip to content

FilePicker and Multipart data uploader APIs for plugins #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
deevroman wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

FilePicker and Multipart data uploader APIs for plugins #1034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 130 additions & 0 deletions lib/plugins/bindings/plugins/interface.eval.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import 'package:every_door/plugins/bindings/plugins/preferences.eval.dart';
import 'package:every_door/plugins/bindings/plugins/providers.eval.dart';
import 'package:every_door/plugins/bindings/plugins/events.eval.dart';
import 'package:flutter_map_eval/logging/logging_eval.dart';
import 'package:flutter_map_eval/http/http_eval.dart';
import 'package:every_door/plugins/bindings/screens/modes/definitions/base.eval.dart';
import 'package:every_door/plugins/bindings/helpers/auth/controller.eval.dart';

Expand Down Expand Up @@ -347,6 +348,82 @@ class $EveryDoorApp implements $Instance {
],
),
),
'pickFile': BridgeMethodDef(
BridgeFunctionDef(
returns: BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.future, [
BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.string),
nullable: true,
),
]),
),
namedParams: [],
params: [
BridgeParameter(
'allowedExtensions',
BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.list, [
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string)),
]),
),
false,
),
],
),
),
'uploadMultipartRequest': BridgeMethodDef(
BridgeFunctionDef(
returns: BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.future, [
BridgeTypeAnnotation(
BridgeTypeRef(
BridgeTypeSpec('package:http/src/response.dart', 'Response'),
[],
),
),
]),
),
namedParams: [],
params: [
BridgeParameter(
'endpoint',
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string, [])),
false,
),
BridgeParameter(
'filePath',
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string, [])),
false,
),
BridgeParameter(
'uploadPath',
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string, [])),
false,
),
BridgeParameter(
'headers',
BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.map, [
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string)),
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string)),
]),
),
false,
),
BridgeParameter(
'fields',
BridgeTypeAnnotation(
BridgeTypeRef(CoreTypes.map, [
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string)),
BridgeTypeAnnotation(BridgeTypeRef(CoreTypes.string)),
]),
),
false,
),
],
),
),
},
getters: {
'ref': BridgeMethodDef(
Expand Down Expand Up @@ -528,6 +605,12 @@ class $EveryDoorApp implements $Instance {

case 'addEditorButton':
return __addEditorButton;

case 'pickFile':
return __pickFile;

case 'uploadMultipartRequest':
return __uploadMultipartRequest;
}
return _superclass.$getProperty(runtime, identifier);
}
Expand Down Expand Up @@ -638,6 +721,53 @@ class $EveryDoorApp implements $Instance {
return null;
}

static const $Function __pickFile = $Function(_pickFile);

static $Value? _pickFile(
Runtime runtime,
$Value? target,
List<$Value?> args,
) {
final self = target! as $EveryDoorApp;
final List<String> allowedExtensions = <String>[];
for (final dynamic value in (runtime.args[1] as $Value).$value as List) {
allowedExtensions.add(value.$value as String);
}
return $Future.wrap(
self.$value.pickFile(allowedExtensions).then((value) => $String(value)),
);
}

static const $Function __uploadMultipartRequest =
$Function(_uploadMultipartRequest);

static Map<String, String> _unwrapStringMapArg(dynamic value) {
final Map<String, String> result = <String, String>{};
for (final entry in value.entries) {
result[entry.key!.$value] = entry.value!.$value;
}
return result;
}

static $Value? _uploadMultipartRequest(
Runtime runtime,
$Value? target,
List args,
) {
final self = target! as $EveryDoorApp;
return $Future.wrap(
self.$value
.uploadMultipartRequest(
runtime.args[1] as String,
runtime.args[2] as String,
runtime.args[3] as String,
_unwrapStringMapArg(runtime.args[4]),
_unwrapStringMapArg(runtime.args[5]),
)
.then((value) => $Response.wrap(value)),
);
}

@override
void $setProperty(Runtime runtime, String identifier, $Value value) {
return _superclass.$setProperty(runtime, identifier, value);
Expand Down
72 changes: 72 additions & 0 deletions lib/plugins/interface.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// Copyright 2022-2025 Ilya Zverev
// This file is a part of Every Door, distributed under GPL v3 or later version.
// Refer to LICENSE file and https://www.gnu.org/licenses/gpl-3.0.html for details.
import 'dart:io' show File;

import 'package:eval_annotation/eval_annotation.dart';
import 'package:file_picker/file_picker.dart';
import 'package:every_door/helpers/auth/controller.dart';
import 'package:every_door/helpers/auth/provider.dart';
import 'package:every_door/models/field.dart';
Expand All @@ -18,6 +21,7 @@ import 'package:every_door/providers/auth.dart';
import 'package:every_door/providers/overlays.dart';
import 'package:every_door/screens/modes/definitions/base.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:http/http.dart' as http;
import 'package:logging/logging.dart';

/// This class is used by plugins to interact with the app.
Expand Down Expand Up @@ -133,4 +137,72 @@ class EveryDoorApp {
void addEditorButton(EditorButton button) {
_ref.read(editorButtonsProvider.notifier).add(plugin.id, button);
}

/// Opens file picker on the host side and returns selected file path.
Future<String> pickFile(List<String> allowedExtensions) async {
const String fn = 'pickFile';

try {
logger.info('[$fn] opening file picker');
final FilePickerResult? result = await FilePicker.platform.pickFiles(
type: allowedExtensions.isEmpty ? FileType.any : FileType.custom,
allowedExtensions: allowedExtensions.isEmpty ? null : allowedExtensions,
allowMultiple: false,
withData: false,
);
if (result != null && result.files.isNotEmpty) {
final String? path = result.files.first.path;
if (path != null && path.isNotEmpty) {
logger.info('[$fn] file picker path: $path');
final f = File(path);
if (await f.exists()) {
logger.info('[$fn] file path exists');
return path;
}
}
} else {
logger.info('[$fn] file picker cancelled by user');
return "";
}
} catch (error) {
logger.warning('[$fn] file picker error: $error');
}

return "";
}

/// Sends a multipart request through host runtime to avoid dart_eval
/// limitations around binary multipart assembly.
Future<http.Response> uploadMultipartRequest(
String endpoint,
String filePath,
String uploadPath,
Map<String, String> headers,
Map<String, String> fields,
) async {
try {
final List<String> pathParts = filePath.split('/');

final Uri uploadUri = Uri.https(endpoint, uploadPath);
logger.info('upload uri: $uploadUri');
final request = http.MultipartRequest('POST', uploadUri);
request.headers.addAll(headers);
request.fields.addAll(fields);
logger.info('upload headers: ${request.headers}');
logger.info('upload fields: ${request.fields}');
request.files.add(
await http.MultipartFile.fromPath(
'file',
filePath,
filename: pathParts.isEmpty ? filePath : pathParts.last,
),
);

return await http.Response.fromStream(await request.send());
} catch (error, stackTrace) {
logger.warning('[uploadMultipartRequest] upload exception: $error');
logger.warning('[uploadMultipartRequest] $stackTrace');
return http.Response('', 0);
}
}
}
Loading