feat: add tauri-plugin-opener

.changes/config.json

@@ -62,6 +62,7 @@
         "dialog",
         "fs",
         "global-shortcut",
+        "opener",
         "http",
         "nfc",
         "notification",
@@ -87,6 +88,7 @@
         "dialog-js",
         "fs-js",
         "global-shortcut-js",
+        "opener-js",
         "http-js",
         "nfc-js",
         "notification-js",
@@ -186,6 +188,14 @@
       "path": "./plugins/global-shortcut",
       "manager": "javascript"
     },
+    "opener": {
+      "path": "./plugins/opener",
+      "manager": "rust"
+    },
+    "opener-js": {
+      "path": "./plugins/opener",
+      "manager": "javascript"
+    },
     "haptics": {
       "path": "./plugins/haptics",
       "manager": "rust"

.changes/opener-initial.md

@@ -0,0 +1,6 @@
+---
+"opener": "major"
+"opener-js": "major"
+---
+
+Initial Release

.github/workflows/check-generated-files.yml

@@ -53,6 +53,10 @@ jobs:
               - .github/workflows/check-generated-files.yml
               - plugins/global-shortcut/guest-js/**
               - plugins/global-shortcut/src/api-iife.js
+            opener:
+              - .github/workflows/check-generated-files.yml
+              - plugins/opener/guest-js/**
+              - plugins/opener/src/api-iife.js
             haptics:
               - .github/workflows/check-generated-files.yml
               - plugins/haptics/guest-js/**

.github/workflows/lint-rust.yml

@@ -66,6 +66,9 @@ jobs:
             tauri-plugin-global-shortcut:
               - .github/workflows/lint-rust.yml
               - plugins/global-shortcut/**
+            tauri-plugin-opener:
+              - .github/workflows/lint-rust.yml
+              - plugins/opener/**
             tauri-plugin-haptics:
               - .github/workflows/lint-rust.yml
               - plugins/haptics/**

.github/workflows/test-rust.yml

@@ -77,6 +77,10 @@ jobs:
               - .github/workflows/test-rust.yml
               - Cargo.toml
               - plugins/global-shortcut/**
+            tauri-plugin-opener:
+              - .github/workflows/test-rust.yml
+              - Cargo.toml
+              - plugins/opener/**
             tauri-plugin-haptics:
               - .github/workflows/test-rust.yml
               - Cargo.toml

Cargo.toml

@@ -21,6 +21,8 @@ url = "2"
 schemars = "0.8"
 dunce = "1"
 specta = "=2.0.0-rc.20"
+glob = "0.3"
+zbus = "4"
 #tauri-specta = "=2.0.0-rc.11"
 
 [workspace.package]

README.md

@@ -22,6 +22,7 @@ This repo and all plugins require a Rust version of at least **1.77.2**
 | [log](plugins/log)                             | Configurable logging.                                                                                                                                          | ✅  | ✅  | ✅  | ✅  | ✅  |
 | [nfc](plugins/nfc)                             | Read and write NFC tags on Android and iOS.                                                                                                                    | ?   | ?   | ?   | ✅  | ✅  |
 | [notification](plugins/notification)           | Send message notifications (brief auto-expiring OS window element) to your user. Can also be used with the Notification Web API.                               | ✅  | ✅  | ✅  | ✅  | ✅  |
+| [opener](plugins/opener)                       | Open files and URLs using their default application.                                                                                                           | ✅  | ✅  | ✅  | ?   | ?   |
 | [os](plugins/os)                               | Read information about the operating system.                                                                                                                   | ✅  | ✅  | ✅  | ✅  | ✅  |
 | [persisted-scope](plugins/persisted-scope)     | Persist runtime scope changes on the filesystem.                                                                                                               | ✅  | ✅  | ✅  | ?   | ?   |
 | [positioner](plugins/positioner)               | Move windows to common locations.                                                                                                                              | ✅  | ✅  | ✅  | ❌  | ❌  |

examples/api/package.json

@@ -19,6 +19,7 @@
     "@tauri-apps/plugin-fs": "2.0.2",
     "@tauri-apps/plugin-geolocation": "2.0.0",
     "@tauri-apps/plugin-global-shortcut": "2.0.0",
+    "@tauri-apps/plugin-opener": "1.0.0",
     "@tauri-apps/plugin-haptics": "2.0.0",
     "@tauri-apps/plugin-http": "2.0.1",
     "@tauri-apps/plugin-nfc": "2.0.0",

examples/api/src-tauri/Cargo.toml

@@ -33,6 +33,7 @@ tauri-plugin-notification = { path = "../../../plugins/notification", version =
 ] }
 tauri-plugin-os = { path = "../../../plugins/os", version = "2.0.1" }
 tauri-plugin-process = { path = "../../../plugins/process", version = "2.0.1" }
+tauri-plugin-opener = { path = "../../../plugins/opener", version = "1.0.0" }
 tauri-plugin-shell = { path = "../../../plugins/shell", version = "2.0.2" }
 tauri-plugin-store = { path = "../../../plugins/store", version = "2.1.0" }
 

examples/api/src-tauri/capabilities/base.json

@@ -80,6 +80,11 @@
       ],
       "deny": ["$APPDATA/db/*.stronghold"]
     },
-    "store:default"
+    "store:default",
+    "opener:default",
+    {
+      "identifier": "opener:allow-open-path",
+      "allow": [{ "path": "$APPDATA" }, { "path": "$APPDATA/**" }]
+    }
   ]
 }

examples/api/src-tauri/src/lib.rs

@@ -36,6 +36,7 @@ pub fn run() {
         .plugin(tauri_plugin_notification::init())
         .plugin(tauri_plugin_os::init())
         .plugin(tauri_plugin_process::init())
+        .plugin(tauri_plugin_opener::init())
         .plugin(tauri_plugin_shell::init())
         .plugin(tauri_plugin_store::Builder::default().build())
         .setup(move |app| {

examples/api/src/App.svelte

@@ -1,6 +1,5 @@
 <script>
   import { writable } from 'svelte/store'
-  import { open } from '@tauri-apps/plugin-shell'
   import { getCurrentWindow } from '@tauri-apps/api/window'
   import { getCurrentWebview } from '@tauri-apps/api/webview'
   import * as os from '@tauri-apps/plugin-os'
@@ -14,6 +13,7 @@
   import Notifications from './views/Notifications.svelte'
   import Shortcuts from './views/Shortcuts.svelte'
   import Shell from './views/Shell.svelte'
+  import Opener from './views/Opener.svelte'
   import Store from './views/Store.svelte'
   import Updater from './views/Updater.svelte'
   import Clipboard from './views/Clipboard.svelte'
@@ -92,6 +92,11 @@
       component: Shell,
       icon: 'i-codicon-terminal-bash'
     },
+    {
+      label: 'Opener',
+      component: Opener,
+      icon: 'i-codicon-link-external'
+    },
     {
       label: 'Store',
       component: Store,

examples/api/src/views/Opener.svelte

@@ -0,0 +1,66 @@
+<script>
+  import * as opener from '@tauri-apps/plugin-opener'
+
+  export let onMessage
+
+  let url = ''
+  let urlProgram = ''
+  function openUrl() {
+    opener.openUrl(url, urlProgram ? urlProgram : undefined).catch(onMessage)
+  }
+
+  let path = ''
+  let pathProgram = ''
+  function openPath() {
+    opener
+      .openPath(path, pathProgram ? pathProgram : undefined)
+      .catch(onMessage)
+  }
+
+  let revealPath = ''
+  function revealItemInDir() {
+    opener.revealItemInDir(revealPath).catch(onMessage)
+  }
+</script>
+
+<div class="flex flex-col gap-2">
+  <form
+    class="flex flex-row gap-2 items-center"
+    on:submit|preventDefault={openUrl}
+  >
+    <button class="btn" type="submit">Open URL</button>
+    <input
+      class="input grow"
+      placeholder="Type the URL to open..."
+      bind:value={url}
+    />
+    <span> with </span>
+    <input class="input" bind:value={urlProgram} />
+  </form>
+
+  <form
+    class="flex flex-row gap-2 items-center"
+    on:submit|preventDefault={openPath}
+  >
+    <button class="btn" type="submit">Open Path</button>
+    <input
+      class="input grow"
+      placeholder="Type the path to open..."
+      bind:value={path}
+    />
+    <span> with </span>
+    <input class="input" bind:value={pathProgram} />
+  </form>
+
+  <form
+    class="flex flex-row gap-2 items-center"
+    on:submit|preventDefault={revealItemInDir}
+  >
+    <button class="btn" type="submit">Reveal</button>
+    <input
+      class="input grow"
+      placeholder="Type the path to reveal..."
+      bind:value={revealPath}
+    />
+  </form>
+</div>

plugins/fs/Cargo.toml

@@ -34,7 +34,7 @@ thiserror = { workspace = true }
 url = { workspace = true }
 anyhow = "1"
 uuid = { version = "1", features = ["v4"] }
-glob = "0.3"
+glob = { workspace = true }
 # TODO: Remove `serialization-compat-6` in v3
 notify = { version = "7", optional = true, features = [
   "serde",

plugins/fs/build.rs

@@ -16,10 +16,23 @@ mod scope;
 #[serde(untagged)]
 #[allow(unused)]
 enum FsScopeEntry {
-    /// FS scope path.
+    /// A path that can be accessed by the webview when using the fs APIs.
+    /// FS scope path pattern.
+    ///
+    /// The pattern can start with a variable that resolves to a system base directory.
+    /// The variables are: `$AUDIO`, `$CACHE`, `$CONFIG`, `$DATA`, `$LOCALDATA`, `$DESKTOP`,
+    /// `$DOCUMENT`, `$DOWNLOAD`, `$EXE`, `$FONT`, `$HOME`, `$PICTURE`, `$PUBLIC`, `$RUNTIME`,
+    /// `$TEMPLATE`, `$VIDEO`, `$RESOURCE`, `$APP`, `$LOG`, `$TEMP`, `$APPCONFIG`, `$APPDATA`,
+    /// `$APPLOCALDATA`, `$APPCACHE`, `$APPLOG`.
     Value(PathBuf),
     Object {
-        /// FS scope path.
+        /// A path that can be accessed by the webview when using the fs APIs.
+        ///
+        /// The pattern can start with a variable that resolves to a system base directory.
+        /// The variables are: `$AUDIO`, `$CACHE`, `$CONFIG`, `$DATA`, `$LOCALDATA`, `$DESKTOP`,
+        /// `$DOCUMENT`, `$DOWNLOAD`, `$EXE`, `$FONT`, `$HOME`, `$PICTURE`, `$PUBLIC`, `$RUNTIME`,
+        /// `$TEMPLATE`, `$VIDEO`, `$RESOURCE`, `$APP`, `$LOG`, `$TEMP`, `$APPCONFIG`, `$APPDATA`,
+        /// `$APPLOCALDATA`, `$APPCACHE`, `$APPLOG`.
         path: PathBuf,
     },
 }

plugins/opener/Cargo.toml

@@ -0,0 +1,65 @@
+[package]
+name = "tauri-plugin-opener"
+version = "1.0.0"
+description = "Open files and URLs using their default application."
+edition = { workspace = true }
+authors = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+links = "tauri-plugin-opener"
+
+[package.metadata.docs.rs]
+rustc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs"]
+
+# Platforms supported by the plugin
+# Support levels are "full", "partial", "none", "unknown"
+# Details of the support level are left to plugin maintainer
+[package.metadata.platforms]
+windows = { level = "full", notes = "" }
+linux = { level = "full", notes = "" }
+macos = { level = "full", notes = "" }
+android = { level = "partial", notes = "Only allows to open URLs via `open`" }
+ios = { level = "partial", notes = "Only allows to open URLs via `open`" }
+
+
+[build-dependencies]
+tauri-plugin = { workspace = true, features = ["build"] }
+schemars = { workspace = true }
+serde = { workspace = true }
+
+[dependencies]
+serde = { workspace = true }
+serde_json = { workspace = true }
+tauri = { workspace = true }
+thiserror = { workspace = true }
+open = { version = "5", features = ["shellexecute-on-windows"] }
+glob = { workspace = true }
+
+[target."cfg(windows)".dependencies]
+dunce = { workspace = true }
+
+[target."cfg(windows)".dependencies.windows]
+version = "0.58"
+features = [
+  "Win32_Foundation",
+  "Win32_UI_Shell_Common",
+  "Win32_UI_WindowsAndMessaging",
+  "Win32_System_Com",
+  "Win32_System_Registry",
+]
+
+[target."cfg(any(target_os = \"linux\", target_os = \"dragonfly\", target_os = \"freebsd\", target_os = \"netbsd\", target_os = \"openbsd\"))".dependencies]
+zbus = { workspace = true }
+url = { workspace = true }
+
+[target."cfg(target_os = \"macos\")".dependencies.objc2-app-kit]
+version = "0.2"
+features = ["NSWorkspace"]
+
+[target."cfg(target_os = \"macos\")".dependencies.objc2-foundation]
+version = "0.2"
+features = ["NSURL", "NSArray", "NSString"]
+
+[target.'cfg(target_os = "ios")'.dependencies]
+tauri = { workspace = true, features = ["wry"] }

plugins/opener/LICENSE.spdx

@@ -0,0 +1,20 @@
+SPDXVersion: SPDX-2.1
+DataLicense: CC0-1.0
+PackageName: tauri
+DataFormat: SPDXRef-1
+PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
+PackageHomePage: https://tauri.app
+PackageLicenseDeclared: Apache-2.0
+PackageLicenseDeclared: MIT
+PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
+PackageSummary: <text>Tauri is a rust project that enables developers to make secure
+and small desktop applications using a web frontend.
+                </text>
+PackageComment: <text>The package includes the following libraries; see
+Relationship information.
+                </text>
+Created: 2019-05-20T09:00:00Z
+PackageDownloadLocation: git://github.com/tauri-apps/tauri
+PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
+PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
+Creator: Person: Daniel Thompson-Yvetot