Merge pull request #1248 from miguelpruivo/feature/#989-prompt-to-con…

…firm-overwrite-if-file-already-exists #989: save file on Windows: prompt user for confirmation when selecting an already existing file
miguelpruivo · Apr 4, 2023 · b060f04 · b060f04
2 parents acb4deb + a314b5b
commit b060f04
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 30 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -18,7 +18,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - uses: subosito/flutter-action@v1
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable'

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 5.2.7
+### Desktop (Windows)
+Fixes the behavior of the `saveFile()` dialog on Windows. Now, when the user selects an already existing file, then Windows prompts the user to confirm overwriting this file. This change makes the dialog behave the same on all desktop platforms (macOS, Linux, and Windows). Previously, Windows would not have asked the user for confirmation ([#989](https://github.com/miguelpruivo/flutter_file_picker/issues/989)).
+
 ## 5.2.6
 ### Web
 - Increase time to wait on js result

diff --git a/README.md b/README.md
@@ -37,10 +37,10 @@ If you have any feature that you want to see in this package, please feel free t
 
 | API                   | Android            | iOS                | Linux              | macOS              | Windows            | Web                |
 | --------------------- | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
-| clearTemporaryFiles() | :white_check_mark: | :white_check_mark: | :x:                | :x:                | :x:                | :x:                |
-| getDirectoryPath()    | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x:                |
-| pickFiles()           | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| saveFile()            | :x:                | :x:                | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x:                |
+| clearTemporaryFiles() | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:                | :x:                | :x:                |
+| getDirectoryPath()    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
+| pickFiles()           | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| saveFile()            | :x:                | :x:                | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
 
 See the [API section of the File Picker Wiki](https://github.com/miguelpruivo/flutter_file_picker/wiki/api) or the [official API reference on pub.dev](https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html) for further details.
 

diff --git a/lib/src/windows/file_picker_windows.dart b/lib/src/windows/file_picker_windows.dart
@@ -67,8 +67,8 @@ class FilePickerWindows extends FilePicker {
     final comdlg32 = DynamicLibrary.open('comdlg32.dll');
 
     final getOpenFileNameW =
-    comdlg32.lookupFunction<GetOpenFileNameW, GetOpenFileNameWDart>(
-        'GetOpenFileNameW');
+        comdlg32.lookupFunction<GetOpenFileNameW, GetOpenFileNameWDart>(
+            'GetOpenFileNameW');
 
     final Pointer<OPENFILENAMEW> openFileNameW = _instantiateOpenFileNameW(
       allowMultiple: allowMultiple,
@@ -184,13 +184,15 @@ class FilePickerWindows extends FilePicker {
     await Isolate.spawn(
         _callSaveFile,
         _OpenSaveFileArgs(
-            port: port.sendPort,
-            fileName: fileName,
-            dialogTitle: dialogTitle,
-            initialDirectory: initialDirectory,
-            type: type,
-            allowedExtensions: allowedExtensions,
-            lockParentWindow: lockParentWindow));
+          port: port.sendPort,
+          fileName: fileName,
+          dialogTitle: dialogTitle,
+          initialDirectory: initialDirectory,
+          type: type,
+          allowedExtensions: allowedExtensions,
+          lockParentWindow: lockParentWindow,
+          confirmOverwrite: true,
+        ));
     return (await port.first) as String?;
   }
 
@@ -205,8 +207,8 @@ class FilePickerWindows extends FilePicker {
     final comdlg32 = DynamicLibrary.open('comdlg32.dll');
 
     final getSaveFileNameW =
-    comdlg32.lookupFunction<GetSaveFileNameW, GetSaveFileNameWDart>(
-        'GetSaveFileNameW');
+        comdlg32.lookupFunction<GetSaveFileNameW, GetSaveFileNameWDart>(
+            'GetSaveFileNameW');
 
     final Pointer<OPENFILENAMEW> openFileNameW = _instantiateOpenFileNameW(
       allowedExtensions: allowedExtensions,
@@ -310,6 +312,7 @@ class FilePickerWindows extends FilePicker {
     List<String>? allowedExtensions,
     FileType type = FileType.any,
     bool lockParentWindow = false,
+    bool confirmOverwrite = false,
   }) {
     final lpstrFileBufferSize = 8192 * maximumPathLength;
     final Pointer<OPENFILENAMEW> openFileNameW = calloc<OPENFILENAMEW>();
@@ -333,6 +336,10 @@ class FilePickerWindows extends FilePicker {
       openFileNameW.ref.flags |= ofnAllowMultiSelect;
     }
 
+    if (confirmOverwrite) {
+      openFileNameW.ref.flags |= ofnOverwritePrompt;
+    }
+
     if (defaultFileName != null) {
       validateFileName(defaultFileName);
 
@@ -373,7 +380,6 @@ class FilePickerWindows extends FilePicker {
     calloc.free(openFileNameW);
   }
 
-
   static void _callPickFiles(_OpenSaveFileArgs args) {
     final impl = FilePickerWindows();
     args.port.send(impl._pickFiles(
@@ -396,7 +402,6 @@ class FilePickerWindows extends FilePicker {
         allowedExtensions: args.allowedExtensions,
         lockParentWindow: args.lockParentWindow));
   }
-
 }
 
 class _OpenSaveFileArgs {
@@ -409,15 +414,18 @@ class _OpenSaveFileArgs {
   final bool allowCompression;
   final bool allowMultiple;
   final bool lockParentWindow;
-
-  _OpenSaveFileArgs(
-      {required this.port,
-        this.dialogTitle,
-        this.fileName,
-        this.initialDirectory,
-        this.type = FileType.any,
-        this.allowedExtensions,
-        this.allowCompression = true,
-        this.allowMultiple = false,
-        this.lockParentWindow = false});
+  final bool confirmOverwrite;
+
+  _OpenSaveFileArgs({
+    required this.port,
+    this.dialogTitle,
+    this.fileName,
+    this.initialDirectory,
+    this.type = FileType.any,
+    this.allowedExtensions,
+    this.allowCompression = true,
+    this.allowMultiple = false,
+    this.lockParentWindow = false,
+    this.confirmOverwrite = false,
+  });
 }
diff --git a/lib/src/windows/file_picker_windows_ffi_types.dart b/lib/src/windows/file_picker_windows_ffi_types.dart
@@ -219,3 +219,6 @@ const ofnFileMustExist = 0x00001000;
 
 /// Hides the Read Only check box.
 const ofnHideReadOnly = 0x00000004;
+
+/// Causes the Save As dialog box to generate a message box if the selected file already exists. The user must confirm whether to overwrite the file.
+const ofnOverwritePrompt = 0x00000002;
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -3,7 +3,7 @@ description: A package that allows you to use a native file explorer to pick sin
 homepage: https://github.com/miguelpruivo/plugins_flutter_file_picker
 repository: https://github.com/miguelpruivo/flutter_file_picker
 issue_tracker: https://github.com/miguelpruivo/flutter_file_picker/issues
-version: 5.2.6
+version: 5.2.7
 
 dependencies:
   flutter: