feat: dialog add destroy_path method

Author: nashaofu

plugins/dialog/build.rs

@@ -2,7 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-const COMMANDS: &[&str] = &["open", "save", "message", "ask", "confirm"];
+const COMMANDS: &[&str] = &[
+    "open",
+    "save",
+    "destroy_path",
+    "message",
+    "ask",
+    "confirm",
+];
 
 fn main() {
     let result = tauri_plugin::Builder::new(COMMANDS)

plugins/dialog/guest-js/index.ts

@@ -4,6 +4,31 @@
 
 import { invoke } from '@tauri-apps/api/core'
 
+class Path {
+  public path: string
+  constructor(path: string) {
+    this.path = path
+  }
+
+  destroy() {
+    return invoke('plugin:dialog|destroy_path', { path: this.path })
+  }
+
+  toPath() {
+    return this.path
+  }
+
+  toString() {
+    return this.toPath()
+  }
+
+  toJSON() {
+    return {
+      path: this.path
+    }
+  }
+}
+
 /**
  * Extension filters for the file dialog.
  *
@@ -224,13 +249,7 @@ interface ConfirmDialogOptions {
   cancelLabel?: string
 }
 
-type OpenDialogReturn<T extends OpenDialogOptions> = T['directory'] extends true
-  ? T['multiple'] extends true
-    ? string[] | null
-    : string | null
-  : T['multiple'] extends true
-    ? string[] | null
-    : string | null
+type OpenDialogReturn<T extends OpenDialogOptions> = T['multiple'] extends true ? Path[] | null : Path | null
 
 /**
  * Open a file/directory selection dialog.
@@ -295,7 +314,17 @@ async function open<T extends OpenDialogOptions>(
     Object.freeze(options)
   }
 
-  return await invoke('plugin:dialog|open', { options })
+  const path = await invoke<string[] | string | null>('plugin:dialog|open', { options })
+
+  if (Array.isArray(path)) {
+    return path.map((p) => new Path(p))
+  }
+
+  if (!path) {
+    return null
+  }
+
+  return new Path(path)
 }
 
 /**
@@ -326,12 +355,18 @@ async function open<T extends OpenDialogOptions>(
  *
  * @since 2.0.0
  */
-async function save(options: SaveDialogOptions = {}): Promise<string | null> {
+async function save(options: SaveDialogOptions = {}): Promise<Path | null> {
   if (typeof options === 'object') {
     Object.freeze(options)
   }
 
-  return await invoke('plugin:dialog|save', { options })
+  const path = await invoke<string | null>('plugin:dialog|save', { options })
+
+  if (!path) {
+    return null
+  }
+
+  return new Path(path)
 }
 
 /**

plugins/dialog/ios/Sources/DialogPlugin.swift

@@ -39,6 +39,10 @@ struct SaveFileDialogOptions: Decodable {
   var defaultPath: String?
 }
 
+struct StopAccessingPathOptions: Decodable {
+  var path: URL
+}
+
 class DialogPlugin: Plugin {
 
   var filePickerController: FilePickerController!
@@ -75,6 +79,7 @@ class DialogPlugin: Plugin {
     onFilePickerResult = { (event: FilePickerEvent) -> Void in
       switch event {
       case .selected(let urls):
+        urls.forEach { $0.startAccessingSecurityScopedResource() }
         invoke.resolve(["files": urls])
       case .cancelled:
         invoke.resolve(["files": nil])
@@ -150,6 +155,8 @@ class DialogPlugin: Plugin {
     onFilePickerResult = { (event: FilePickerEvent) -> Void in
       switch event {
       case .selected(let urls):
+        Logger.info("picked file to save: \(urls.first!)")
+        urls.first!.startAccessingSecurityScopedResource()
         invoke.resolve(["file": urls.first!])
       case .cancelled:
         invoke.resolve(["file": nil])
@@ -169,6 +176,12 @@ class DialogPlugin: Plugin {
     }
   }
 
+  @objc public func stopAccessingPath(_ invoke: Invoke) throws {
+    let args = try invoke.parseArgs(StopAccessingPathOptions.self)
+    args.path.stopAccessingSecurityScopedResource()
+    invoke.resolve()
+  }
+
   private func presentViewController(_ viewControllerToPresent: UIViewController) {
     self.manager.viewController?.present(viewControllerToPresent, animated: true, completion: nil)
   }

plugins/dialog/permissions/autogenerated/commands/destroy_path.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-destroy-path"
+description = "Enables the destroy_path command without any pre-configured scope."
+commands.allow = ["destroy_path"]
+
+[[permission]]
+identifier = "deny-destroy-path"
+description = "Denies the destroy_path command without any pre-configured scope."
+commands.deny = ["destroy_path"]

plugins/dialog/permissions/autogenerated/reference.md

@@ -14,6 +14,7 @@ All dialog types are enabled.
 - `allow-message`
 - `allow-save`
 - `allow-open`
+- `allow-destroy-path`
 
 ## Permission Table
 
@@ -79,6 +80,32 @@ Denies the confirm command without any pre-configured scope.
 <tr>
 <td>
 
+`dialog:allow-destroy-path`
+
+</td>
+<td>
+
+Enables the destroy_path command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`dialog:deny-destroy-path`
+
+</td>
+<td>
+
+Denies the destroy_path command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
 `dialog:allow-message`
 
 </td>

plugins/dialog/permissions/default.toml

@@ -17,4 +17,5 @@ permissions = [
   "allow-message",
   "allow-save",
   "allow-open",
+  "allow-destroy-path"
 ]

plugins/dialog/permissions/schemas/schema.json

@@ -318,6 +318,18 @@
           "const": "deny-confirm",
           "markdownDescription": "Denies the confirm command without any pre-configured scope."
         },
+        {
+          "description": "Enables the destroy_path command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-destroy-path",
+          "markdownDescription": "Enables the destroy_path command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the destroy_path command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-destroy-path",
+          "markdownDescription": "Denies the destroy_path command without any pre-configured scope."
+        },
         {
           "description": "Enables the message command without any pre-configured scope.",
           "type": "string",
@@ -355,10 +367,10 @@
           "markdownDescription": "Denies the save command without any pre-configured scope."
         },
         {
-          "description": "This permission set configures the types of dialogs\navailable from the dialog plugin.\n\n#### Granted Permissions\n\nAll dialog types are enabled.\n\n\n\n#### This default permission set includes:\n\n- `allow-ask`\n- `allow-confirm`\n- `allow-message`\n- `allow-save`\n- `allow-open`",
+          "description": "This permission set configures the types of dialogs\navailable from the dialog plugin.\n\n#### Granted Permissions\n\nAll dialog types are enabled.\n\n\n\n#### This default permission set includes:\n\n- `allow-ask`\n- `allow-confirm`\n- `allow-message`\n- `allow-save`\n- `allow-open`\n- `allow-destroy-path`",
           "type": "string",
           "const": "default",
-          "markdownDescription": "This permission set configures the types of dialogs\navailable from the dialog plugin.\n\n#### Granted Permissions\n\nAll dialog types are enabled.\n\n\n\n#### This default permission set includes:\n\n- `allow-ask`\n- `allow-confirm`\n- `allow-message`\n- `allow-save`\n- `allow-open`"
+          "markdownDescription": "This permission set configures the types of dialogs\navailable from the dialog plugin.\n\n#### Granted Permissions\n\nAll dialog types are enabled.\n\n\n\n#### This default permission set includes:\n\n- `allow-ask`\n- `allow-confirm`\n- `allow-message`\n- `allow-save`\n- `allow-open`\n- `allow-destroy-path`"
         }
       ]
     }

plugins/dialog/src/commands.rs

@@ -241,6 +241,11 @@ pub(crate) async fn save<R: Runtime>(
     Ok(path.map(|p| p.simplified()))
 }
 
+#[command]
+pub fn destroy_path(_path: String) -> bool {
+    true
+}
+
 fn message_dialog<R: Runtime>(
     #[allow(unused_variables)] window: Window<R>,
     dialog: State<'_, Dialog<R>>,

plugins/dialog/src/desktop.rs

@@ -211,6 +211,10 @@ pub fn save_file<R: Runtime, F: FnOnce(Option<FilePath>) + Send + 'static>(
     });
 }
 
+pub fn destroy_path<R: Runtime>(_dialog: FileDialogBuilder<R>, _path: String) -> bool {
+    true
+}
+
 /// Shows a message dialog
 pub fn show_message_dialog<R: Runtime, F: FnOnce(MessageDialogResult) + Send + 'static>(
     dialog: MessageDialogBuilder<R>,

plugins/dialog/src/lib.rs

@@ -180,6 +180,7 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
         .invoke_handler(tauri::generate_handler![
             commands::open,
             commands::save,
+            commands::destroy_path,
             commands::message,
             commands::ask,
             commands::confirm
@@ -611,6 +612,10 @@ impl<R: Runtime> FileDialogBuilder<R> {
     pub fn save_file<F: FnOnce(Option<FilePath>) + Send + 'static>(self, f: F) {
         save_file(self, f)
     }
+
+    pub fn destroy_path(self, path: String) -> bool {
+        destroy_path(self, path)
+    }
 }
 
 /// Blocking APIs.
@@ -723,4 +728,8 @@ impl<R: Runtime> FileDialogBuilder<R> {
     pub fn blocking_save_file(self) -> Option<FilePath> {
         blocking_fn!(self, save_file)
     }
+
+    pub fn blocking_destroy_path(self, path: String) -> bool {
+        self.destroy_path(path)
+    }
 }