Merge pull request #3658 from Kingtous/master

feat: enqueue file overwrite confirm dialogs
This commit is contained in:
RustDesk 2023-03-15 17:31:57 +08:00 committed by GitHub
commit 3c9ae7cf38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
44 changed files with 247 additions and 17 deletions

View File

@ -4,7 +4,7 @@ import 'dart:io';
import 'package:flutter/material.dart';
import 'package:flutter_hbb/common.dart';
import 'package:flutter_hbb/consts.dart';
import 'package:flutter_hbb/utils/event_loop.dart';
import 'package:get/get.dart';
import 'package:path/path.dart' as path;
@ -45,6 +45,7 @@ class FileModel {
late final GetSessionID getSessionID;
String get sessionID => getSessionID();
late final FileDialogEventLoop evtLoop;
FileModel(this.parent) {
getSessionID = () => parent.target?.id ?? "";
@ -64,14 +65,17 @@ class FileModel {
jobController: jobController,
fileFetcher: fileFetcher,
getOtherSideDirectoryData: () => localController.directoryData());
evtLoop = FileDialogEventLoop();
}
Future<void> onReady() async {
await evtLoop.onReady();
await localController.onReady();
await remoteController.onReady();
}
Future<void> close() async {
await evtLoop.close();
parent.target?.dialogManager.dismissAll();
await localController.close();
await remoteController.close();
@ -90,14 +94,26 @@ class FileModel {
fileFetcher.tryCompleteTask(evt['value'], evt['is_local']);
}
void overrideFileConfirm(Map<String, dynamic> evt) async {
final resp = await showFileConfirmDialog(
translate("Overwrite"), "${evt['read_path']}", true);
Future<void> postOverrideFileConfirm(Map<String, dynamic> evt) async {
evtLoop.pushEvent(
_FileDialogEvent(WeakReference(this), FileDialogType.overwrite, evt));
}
Future<void> overrideFileConfirm(Map<String, dynamic> evt,
{bool? overrideConfirm, bool skip = false}) async {
// If `skip == true`, it means to skip this file without showing dialog.
// Because `resp` may be null after the user operation or the last remembered operation,
// and we should distinguish them.
final resp = overrideConfirm ??
(!skip
? await showFileConfirmDialog(translate("Overwrite"),
"${evt['read_path']}", true, evt['is_identical'] == "true")
: null);
final id = int.tryParse(evt['id']) ?? 0;
if (false == resp) {
final jobIndex = jobController.getJob(id);
if (jobIndex != -1) {
jobController.cancelJob(id);
await jobController.cancelJob(id);
final job = jobController.jobTable[jobIndex];
job.state = JobState.done;
jobController.jobTable.refresh();
@ -111,7 +127,11 @@ class FileModel {
// overwrite
need_override = true;
}
bind.sessionSetConfirmOverrideFile(
// Update the loop config.
if (fileConfirmCheckboxRemember) {
evtLoop.setSkip(!need_override);
}
await bind.sessionSetConfirmOverrideFile(
id: sessionID,
actId: id,
fileNum: int.parse(evt['file_num']),
@ -119,12 +139,16 @@ class FileModel {
remember: fileConfirmCheckboxRemember,
isUpload: evt['is_upload'] == "true");
}
// Update the loop config.
if (fileConfirmCheckboxRemember) {
evtLoop.setOverrideConfirm(resp);
}
}
bool fileConfirmCheckboxRemember = false;
Future<bool?> showFileConfirmDialog(
String title, String content, bool showCheckbox) async {
String title, String content, bool showCheckbox, bool isIdentical) async {
fileConfirmCheckboxRemember = false;
return await parent.target?.dialogManager.show<bool?>(
(setState, Function(bool? v) close) {
@ -149,6 +173,17 @@ class FileModel {
style: const TextStyle(fontWeight: FontWeight.bold)),
const SizedBox(height: 5),
Text(content),
Offstage(
offstage: !isIdentical,
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
const SizedBox(height: 12),
Text(translate("identical_file_tip"),
style: const TextStyle(fontWeight: FontWeight.w500))
],
),
),
showCheckbox
? CheckboxListTile(
contentPadding: const EdgeInsets.all(0),
@ -677,8 +712,8 @@ class JobController {
debugPrint("jobError $evt");
}
void cancelJob(int id) async {
bind.sessionCancelJob(id: sessionID, actId: id);
Future<void> cancelJob(int id) async {
await bind.sessionCancelJob(id: sessionID, actId: id);
}
void loadLastJob(Map<String, dynamic> evt) {
@ -1167,3 +1202,74 @@ List<Entry> _sortList(List<Entry> list, SortBy sortType, bool ascending) {
}
return [];
}
/// Define a general queue which can accepts different dialog type.
///
/// [Visibility]
/// The `_FileDialogType` and `_DialogEvent` are invisible for other models.
enum FileDialogType { overwrite, unknown }
class _FileDialogEvent extends BaseEvent<FileDialogType, Map<String, dynamic>> {
WeakReference<FileModel> fileModel;
bool? _overrideConfirm;
bool _skip = false;
_FileDialogEvent(this.fileModel, super.type, super.data);
void setOverrideConfirm(bool? confirm) {
_overrideConfirm = confirm;
}
void setSkip(bool skip) {
_skip = skip;
}
@override
EventCallback<Map<String, dynamic>>? findCallback(FileDialogType type) {
final model = fileModel.target;
if (model == null) {
return null;
}
switch (type) {
case FileDialogType.overwrite:
return (data) async {
return await model.overrideFileConfirm(data,
overrideConfirm: _overrideConfirm, skip: _skip);
};
default:
debugPrint("Unknown event type: $type with $data");
return null;
}
}
}
class FileDialogEventLoop
extends BaseEventLoop<FileDialogType, Map<String, dynamic>> {
bool? _overrideConfirm;
bool _skip = false;
@override
Future<void> onPreConsume(
BaseEvent<FileDialogType, Map<String, dynamic>> evt) async {
var event = evt as _FileDialogEvent;
event.setOverrideConfirm(_overrideConfirm);
event.setSkip(_skip);
debugPrint(
"FileDialogEventLoop: consuming<jobId:${evt.data['id']} overrideConfirm: $_overrideConfirm, skip:$_skip>");
}
@override
Future<void> onEventsClear() {
_overrideConfirm = null;
_skip = false;
return super.onEventsClear();
}
void setOverrideConfirm(bool? confirm) {
_overrideConfirm = confirm;
}
void setSkip(bool skip) {
_skip = skip;
}
}

View File

@ -173,7 +173,7 @@ class FfiModel with ChangeNotifier {
} else if (name == 'job_error') {
parent.target?.fileModel.jobController.jobError(evt);
} else if (name == 'override_file_confirm') {
parent.target?.fileModel.overrideFileConfirm(evt);
parent.target?.fileModel.postOverrideFileConfirm(evt);
} else if (name == 'load_last_job') {
parent.target?.fileModel.jobController.loadLastJob(evt);
} else if (name == 'update_folder_files') {

View File

@ -0,0 +1,79 @@
import 'dart:async';
import 'package:flutter/foundation.dart';
typedef EventCallback<Data> = Future<dynamic> Function(Data data);
abstract class BaseEvent<EventType, Data> {
EventType type;
Data data;
/// Constructor.
BaseEvent(this.type, this.data);
/// Consume this event.
@visibleForTesting
Future<dynamic> consume() async {
final cb = findCallback(type);
if (cb == null) {
return null;
} else {
return cb(data);
}
}
EventCallback<Data>? findCallback(EventType type);
}
abstract class BaseEventLoop<EventType, Data> {
final List<BaseEvent<EventType, Data>> _evts = [];
Timer? _timer;
List<BaseEvent<EventType, Data>> get evts => _evts;
Future<void> onReady() async {
// Poll every 100ms.
_timer = Timer.periodic(Duration(milliseconds: 100), _handleTimer);
}
/// An Event is about to be consumed.
Future<void> onPreConsume(BaseEvent<EventType, Data> evt) async {}
/// An Event was consumed.
Future<void> onPostConsume(BaseEvent<EventType, Data> evt) async {}
/// Events are all handled and cleared.
Future<void> onEventsClear() async {}
/// Events start to consume.
Future<void> onEventsStartConsuming() async {}
Future<void> _handleTimer(Timer timer) async {
if (_evts.isEmpty) {
return;
}
timer.cancel();
_timer = null;
// Handle the logic.
await onEventsStartConsuming();
while (_evts.isNotEmpty) {
final evt = _evts.first;
_evts.remove(evt);
await onPreConsume(evt);
await evt.consume();
await onPostConsume(evt);
}
await onEventsClear();
// Now events are all processed.
_timer = Timer.periodic(Duration(milliseconds: 100), _handleTimer);
}
Future<void> close() async {
_timer?.cancel();
}
void pushEvent(BaseEvent<EventType, Data> evt) {
_evts.add(evt);
}
void clear() {
_evts.clear();
}
}

View File

@ -301,6 +301,7 @@ message FileTransferDigest {
uint64 last_modified = 3;
uint64 file_size = 4;
bool is_upload = 5;
bool is_identical = 6;
}
message FileTransferBlock {

View File

@ -823,14 +823,19 @@ pub fn is_write_need_confirmation(
let modified_time = metadata.modified()?;
let remote_mt = Duration::from_secs(digest.last_modified);
let local_mt = modified_time.duration_since(UNIX_EPOCH)?;
// [Note]
// We decide to give the decision whether to override the existing file to users,
// which obey the behavior of the file manager in our system.
let mut is_identical = false;
if remote_mt == local_mt && digest.file_size == metadata.len() {
return Ok(DigestCheckResult::IsSame);
is_identical = true;
}
Ok(DigestCheckResult::NeedConfirm(FileTransferDigest {
id: digest.id,
file_num: digest.file_num,
last_modified: local_mt.as_secs(),
file_size: metadata.len(),
is_identical,
..Default::default()
}))
} else {

View File

@ -954,6 +954,7 @@ impl<T: InvokeUiSession> Remote<T> {
digest.file_num,
read_path,
true,
digest.is_identical
);
}
}
@ -997,6 +998,7 @@ impl<T: InvokeUiSession> Remote<T> {
digest.file_num,
write_path,
false,
digest.is_identical
);
}
}

View File

@ -420,7 +420,7 @@ impl InvokeUiSession for FlutterHandler {
// unused in flutter // TEST flutter
fn confirm_delete_files(&self, _id: i32, _i: i32, _name: String) {}
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool) {
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool, is_identical: bool) {
self.push_event(
"override_file_confirm",
vec![
@ -428,6 +428,7 @@ impl InvokeUiSession for FlutterHandler {
("file_num", &file_num.to_string()),
("read_path", &to),
("is_upload", &is_upload.to_string()),
("is_identical", &is_identical.to_string())
],
);
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "此文件与对方的一致")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Tom brugernavn"),
("Empty Password", "Tom adgangskode"),
("Me", "Mig"),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Leerer Benutzername"),
("Empty Password", "Leeres Passwort"),
("Me", "Ich"),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Κενό όνομα χρήστη"),
("Empty Password", "Κενός κωδικός πρόσβασης"),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -52,5 +52,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("empty_favorite_tip", "No favorite peers yet?\nLet's find someone to connect with and add it to your favorites!"),
("empty_lan_tip", "Oh no, it looks like we haven't discovered any peers yet."),
("empty_address_book_tip", "Oh dear, it appears that there are currently no peers listed in your address book."),
("identical_file_tip", "This file is identical with the peer's one.")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Nombre de usuario vacío"),
("Empty Password", "Contraseña vacía"),
("Me", "Yo"),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Nome Utente Vuoto"),
("Empty Password", "Password Vuota"),
("Me", "Io"),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", "Gebruikersnaam Leeg"),
("Empty Password", "Wachtwoord Leeg"),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -477,5 +477,6 @@ pub static ref T: std::collections::HashMap<&'static str, &'static str> =
("Empty Username", ""),
("Empty Password", ""),
("Me", ""),
("identical_file_tip", "")
].iter().cloned().collect();
}

View File

@ -778,12 +778,14 @@ handler.confirmDeleteFiles = function(id, i, name) {
});
}
handler.overrideFileConfirm = function(id, file_num, to, is_upload) {
handler.overrideFileConfirm = function(id, file_num, to, is_upload, is_identical) {
var jt = file_transfer.job_table;
var identical_msg = is_identical ? translate("identical_file_tip"): "";
msgbox("custom-skip", "Confirm Write Strategy", "<div .form> \
<div>" + translate('Overwrite') + translate('files') + ".</div> \
<div>" + translate('Overwrite') + " " + translate('files') + ".</div> \
<div>" + translate('This file exists, skip or overwrite this file?') + "</div> \
<div.ellipsis style=\"font-weight: bold;\" .text>" + to + "</div> \
<div>" + identical_msg + "</div> \
<div><button|checkbox(remember) {ts}>" + translate('Do this for all conflicts') + "</button></div> \
</div>", "", function(res=null) {
if (!res) {

View File

@ -197,10 +197,10 @@ impl InvokeUiSession for SciterHandler {
self.call("confirmDeleteFiles", &make_args!(id, i, name));
}
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool) {
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool, is_identical: bool) {
self.call(
"overrideFileConfirm",
&make_args!(id, file_num, to, is_upload),
&make_args!(id, file_num, to, is_upload, is_identical),
);
}

View File

@ -872,7 +872,7 @@ pub trait InvokeUiSession: Send + Sync + Clone + 'static + Sized + Default {
only_count: bool,
);
fn confirm_delete_files(&self, id: i32, i: i32, name: String);
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool);
fn override_file_confirm(&self, id: i32, file_num: i32, to: String, is_upload: bool, is_identical: bool);
fn update_block_input_state(&self, on: bool);
fn job_progress(&self, id: i32, file_num: i32, speed: f64, finished_size: f64);
fn adapt_size(&self);