CalvinBackup/tauri-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-07-06 15:57:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/v2' into plugin/secure-storage

Browse Source
This commit is contained in:
FabianLars
2025-10-14 17:48:38 +02:00
parent f831b003c2 6b5b1053ba
commit 1771c6ed36
143 changed files with 2632 additions and 1262 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/fs/CHANGELOG.md
+5
View File
@@ -1,5 +1,10 @@
# Changelog
## \[2.4.2]
- [`4eb36b0f`](https://github.com/tauri-apps/plugins-workspace/commit/4eb36b0ff57acb0bb1b911c583efa3bf2f56aa32) ([#2907](https://github.com/tauri-apps/plugins-workspace/pull/2907) by [@Legend-Master](https://github.com/tauri-apps/plugins-workspace/../../Legend-Master)) Fixed calling `writeFile` with `data: ReadableStream` throws `Invalid argument`
- [`515182a1`](https://github.com/tauri-apps/plugins-workspace/commit/515182a179d4439079b2b7f6927555ba5ab0b035) ([#2915](https://github.com/tauri-apps/plugins-workspace/pull/2915) by [@samhinshaw](https://github.com/tauri-apps/plugins-workspace/../../samhinshaw)) `readFile` now returns a more specific type `Promise<Uint8Array<ArrayBuffer>>` instead of the default `Promise<Uint8Array<ArrayBufferLike>`
## \[2.4.1]
- [`44a1f659`](https://github.com/tauri-apps/plugins-workspace/commit/44a1f659125a341191420e650608b0b6ff316a0e) ([#2846](https://github.com/tauri-apps/plugins-workspace/pull/2846) by [@Legend-Master](https://github.com/tauri-apps/plugins-workspace/../../Legend-Master)) Fix `writeFile` doesn't create a new file by default when the data is a `ReadableStream`
plugins/fs/Cargo.toml
+2 -2
View File
@@ -1,6 +1,6 @@
[package]
name = "tauri-plugin-fs"
version = "2.4.1"
version = "2.4.2"
description = "Access the file system."
authors = { workspace = true }
license = { workspace = true }
@@ -24,7 +24,7 @@ ios = { level = "partial", notes = "Access is restricted to Application folder b
tauri-plugin = { workspace = true, features = ["build"] }
schemars = { workspace = true }
serde = { workspace = true }
toml = "0.8"
toml = "0.9"
tauri-utils = { workspace = true, features = ["build"] }
[dependencies]
plugins/fs/api-iife.js
+1 -1
View File
File diff suppressed because one or more lines are too long
plugins/fs/guest-js/index.ts
+7 -2
View File
@@ -739,7 +739,7 @@ interface ReadFileOptions {
async function readFile(
path: string | URL,
options?: ReadFileOptions
): Promise<Uint8Array> {
): Promise<Uint8Array<ArrayBuffer>> {
if (path instanceof URL && path.protocol !== 'file:') {
throw new TypeError('Must be a file URL.')
}
@@ -1074,7 +1074,12 @@ async function writeFile(
}
if (data instanceof ReadableStream) {
const file = await open(path, { create: true, ...options })
const file = await open(path, {
read: false,
create: true,
write: true,
...options
})
const reader = data.getReader()
try {
plugins/fs/package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@tauri-apps/plugin-fs",
"version": "2.4.1",
"version": "2.4.2",
"description": "Access the file system.",
"license": "MIT OR Apache-2.0",
"authors": [
@@ -25,6 +25,6 @@
"LICENSE"
],
"dependencies": {
"@tauri-apps/api": "^2.6.0"
"@tauri-apps/api": "^2.8.0"
}
}
plugins/fs/permissions/autogenerated/reference.md
+22
View File
@@ -3748,6 +3748,28 @@ This enables all index or metadata related commands without any pre-configured a
An empty permission you can use to modify the global scope.
## Example
```json
{
"identifier": "read-documents",
"windows": ["main"],
"permissions": [
"fs:allow-read",
{
"identifier": "fs:scope",
"allow": [
"$APPDATA/documents/**/*"
],
"deny": [
"$APPDATA/documents/secret.txt"
]
}
]
}
```
</td>
</tr>
plugins/fs/permissions/schemas/schema.json
+2 -2
View File
@@ -2005,10 +2005,10 @@
"markdownDescription": "This enables all index or metadata related commands without any pre-configured accessible paths."
},
{
"description": "An empty permission you can use to modify the global scope.",
"description": "An empty permission you can use to modify the global scope.\n\n## Example\n\n```json\n{\n \"identifier\": \"read-documents\",\n \"windows\": [\"main\"],\n \"permissions\": [\n \"fs:allow-read\",\n {\n \"identifier\": \"fs:scope\",\n \"allow\": [\n \"$APPDATA/documents/**/*\"\n ],\n \"deny\": [\n \"$APPDATA/documents/secret.txt\"\n ]\n }\n ]\n}\n```\n",
"type": "string",
"const": "scope",
"markdownDescription": "An empty permission you can use to modify the global scope."
"markdownDescription": "An empty permission you can use to modify the global scope.\n\n## Example\n\n```json\n{\n \"identifier\": \"read-documents\",\n \"windows\": [\"main\"],\n \"permissions\": [\n \"fs:allow-read\",\n {\n \"identifier\": \"fs:scope\",\n \"allow\": [\n \"$APPDATA/documents/**/*\"\n ],\n \"deny\": [\n \"$APPDATA/documents/secret.txt\"\n ]\n }\n ]\n}\n```\n"
},
{
"description": "This enables all write related commands without any pre-configured accessible paths.",
plugins/fs/permissions/scope.toml
+24 -1
View File
@@ -2,4 +2,27 @@
[[permission]]
identifier = "scope"
description = "An empty permission you can use to modify the global scope."
description = """
An empty permission you can use to modify the global scope.
## Example
```json
{
"identifier": "read-documents",
"windows": ["main"],
"permissions": [
"fs:allow-read",
{
"identifier": "fs:scope",
"allow": [
"$APPDATA/documents/**/*"
],
"deny": [
"$APPDATA/documents/secret.txt"
]
}
]
}
```
"""
plugins/fs/src/commands.rs
+110 -18
View File
@@ -85,6 +85,7 @@ pub fn create<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<ResourceId> {
let resolved_path = resolve_path(
"create",
&webview,
&global_scope,
&command_scope,
@@ -119,6 +120,7 @@ pub fn open<R: Runtime>(
options: Option<OpenOptions>,
) -> CommandResult<ResourceId> {
let (file, _path) = resolve_file(
"open",
&webview,
&global_scope,
&command_scope,
@@ -167,6 +169,7 @@ pub async fn copy_file<R: Runtime>(
options: Option<CopyFileOptions>,
) -> CommandResult<()> {
let resolved_from_path = resolve_path(
"copy-file",
&webview,
&global_scope,
&command_scope,
@@ -174,6 +177,7 @@ pub async fn copy_file<R: Runtime>(
options.as_ref().and_then(|o| o.from_path_base_dir),
)?;
let resolved_to_path = resolve_path(
"copy-file",
&webview,
&global_scope,
&command_scope,
@@ -208,6 +212,7 @@ pub fn mkdir<R: Runtime>(
options: Option<MkdirOptions>,
) -> CommandResult<()> {
let resolved_path = resolve_path(
"mkdir",
&webview,
&global_scope,
&command_scope,
@@ -255,6 +260,7 @@ pub async fn read_dir<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<Vec<DirEntry>> {
let resolved_path = resolve_path(
"read-dir",
&webview,
&global_scope,
&command_scope,
@@ -331,8 +337,8 @@ pub async fn read<R: Runtime>(
Ok(tauri::ipc::Response::new(data))
}
#[tauri::command]
pub async fn read_file<R: Runtime>(
async fn read_file_inner<R: Runtime>(
permission: &str,
webview: Webview<R>,
global_scope: GlobalScope<Entry>,
command_scope: CommandScope<Entry>,
@@ -340,6 +346,7 @@ pub async fn read_file<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<tauri::ipc::Response> {
let (mut file, path) = resolve_file(
permission,
&webview,
&global_scope,
&command_scope,
@@ -367,6 +374,25 @@ pub async fn read_file<R: Runtime>(
Ok(tauri::ipc::Response::new(contents))
}
#[tauri::command]
pub async fn read_file<R: Runtime>(
webview: Webview<R>,
global_scope: GlobalScope<Entry>,
command_scope: CommandScope<Entry>,
path: SafeFilePath,
options: Option<BaseOptions>,
) -> CommandResult<tauri::ipc::Response> {
read_file_inner(
"read-file",
webview,
global_scope,
command_scope,
path,
options,
)
.await
}
// TODO, remove in v3, rely on `read_file` command instead
#[tauri::command]
pub async fn read_text_file<R: Runtime>(
@@ -376,7 +402,15 @@ pub async fn read_text_file<R: Runtime>(
path: SafeFilePath,
options: Option<BaseOptions>,
) -> CommandResult<tauri::ipc::Response> {
read_file(webview, global_scope, command_scope, path, options).await
read_file_inner(
"read-text-file",
webview,
global_scope,
command_scope,
path,
options,
)
.await
}
#[tauri::command]
@@ -388,6 +422,7 @@ pub fn read_text_file_lines<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<ResourceId> {
let resolved_path = resolve_path(
"read-text-file-lines",
&webview,
&global_scope,
&command_scope,
@@ -452,6 +487,7 @@ pub fn remove<R: Runtime>(
options: Option<RemoveOptions>,
) -> CommandResult<()> {
let resolved_path = resolve_path(
"remove",
&webview,
&global_scope,
&command_scope,
@@ -521,6 +557,7 @@ pub fn rename<R: Runtime>(
options: Option<RenameOptions>,
) -> CommandResult<()> {
let resolved_old_path = resolve_path(
"rename",
&webview,
&global_scope,
&command_scope,
@@ -528,6 +565,7 @@ pub fn rename<R: Runtime>(
options.as_ref().and_then(|o| o.old_path_base_dir),
)?;
let resolved_new_path = resolve_path(
"rename",
&webview,
&global_scope,
&command_scope,
@@ -575,6 +613,7 @@ pub async fn seek<R: Runtime>(
#[cfg(target_os = "android")]
fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Metadata>>(
permission: &str,
metadata_fn: F,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
@@ -585,6 +624,7 @@ fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Meta
match path {
SafeFilePath::Url(url) => {
let (file, path) = resolve_file(
permission,
webview,
global_scope,
command_scope,
@@ -606,6 +646,7 @@ fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Meta
})
}
SafeFilePath::Path(p) => get_fs_metadata(
permission,
metadata_fn,
webview,
global_scope,
@@ -618,6 +659,7 @@ fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Meta
#[cfg(not(target_os = "android"))]
fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Metadata>>(
permission: &str,
metadata_fn: F,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
@@ -626,6 +668,7 @@ fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Meta
options: Option<BaseOptions>,
) -> CommandResult<std::fs::Metadata> {
get_fs_metadata(
permission,
metadata_fn,
webview,
global_scope,
@@ -636,6 +679,7 @@ fn get_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Meta
}
fn get_fs_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::Metadata>>(
permission: &str,
metadata_fn: F,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
@@ -644,6 +688,7 @@ fn get_fs_metadata<R: Runtime, F: FnOnce(&PathBuf) -> std::io::Result<std::fs::M
options: Option<BaseOptions>,
) -> CommandResult<std::fs::Metadata> {
let resolved_path = resolve_path(
permission,
webview,
global_scope,
command_scope,
@@ -668,6 +713,7 @@ pub fn stat<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<FileInfo> {
let metadata = get_metadata(
"stat",
|p| std::fs::metadata(p),
&webview,
&global_scope,
@@ -688,6 +734,7 @@ pub fn lstat<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<FileInfo> {
let metadata = get_metadata(
"lstat",
|p| std::fs::symlink_metadata(p),
&webview,
&global_scope,
@@ -716,6 +763,7 @@ pub async fn truncate<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<()> {
let resolved_path = resolve_path(
"truncate",
&webview,
&global_scope,
&command_scope,
@@ -784,23 +832,13 @@ fn default_create_value() -> bool {
true
}
#[tauri::command]
pub async fn write_file<R: Runtime>(
async fn write_file_inner<R: Runtime>(
permission: &str,
webview: Webview<R>,
global_scope: GlobalScope<Entry>,
command_scope: CommandScope<Entry>,
request: tauri::ipc::Request<'_>,
) -> CommandResult<()> {
let data = match request.body() {
tauri::ipc::InvokeBody::Raw(data) => Cow::Borrowed(data),
tauri::ipc::InvokeBody::Json(serde_json::Value::Array(data)) => Cow::Owned(
data.iter()
.flat_map(|v| v.as_number().and_then(|v| v.as_u64().map(|v| v as u8)))
.collect(),
),
_ => return Err(anyhow::anyhow!("unexpected invoke body").into()),
};
let path = request
.headers()
.get("path")
@@ -811,6 +849,7 @@ pub async fn write_file<R: Runtime>(
.map_err(|_| anyhow::anyhow!("path is not a valid UTF-8").into())
})
.and_then(|p| SafeFilePath::from_str(&p).map_err(CommandError::from))?;
let options: Option<WriteFileOptions> = request
.headers()
.get("options")
@@ -818,6 +857,7 @@ pub async fn write_file<R: Runtime>(
.and_then(|opts| serde_json::from_str(opts).ok());
let (mut file, path) = resolve_file(
permission,
&webview,
&global_scope,
&command_scope,
@@ -853,6 +893,16 @@ pub async fn write_file<R: Runtime>(
},
)?;
let data = match request.body() {
tauri::ipc::InvokeBody::Raw(data) => Cow::Borrowed(data),
tauri::ipc::InvokeBody::Json(serde_json::Value::Array(data)) => Cow::Owned(
data.iter()
.flat_map(|v| v.as_number().and_then(|v| v.as_u64().map(|v| v as u8)))
.collect(),
),
_ => return Err(anyhow::anyhow!("unexpected invoke body").into()),
};
file.write_all(&data)
.map_err(|e| {
format!(
@@ -863,6 +913,16 @@ pub async fn write_file<R: Runtime>(
.map_err(Into::into)
}
#[tauri::command]
pub async fn write_file<R: Runtime>(
webview: Webview<R>,
global_scope: GlobalScope<Entry>,
command_scope: CommandScope<Entry>,
request: tauri::ipc::Request<'_>,
) -> CommandResult<()> {
write_file_inner("write-file", webview, global_scope, command_scope, request).await
}
// TODO, remove in v3, rely on `write_file` command instead
#[tauri::command]
pub async fn write_text_file<R: Runtime>(
@@ -871,7 +931,14 @@ pub async fn write_text_file<R: Runtime>(
command_scope: CommandScope<Entry>,
request: tauri::ipc::Request<'_>,
) -> CommandResult<()> {
write_file(webview, global_scope, command_scope, request).await
write_file_inner(
"write-text-file",
webview,
global_scope,
command_scope,
request,
)
.await
}
#[tauri::command]
@@ -883,6 +950,7 @@ pub fn exists<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<bool> {
let resolved_path = resolve_path(
"exists",
&webview,
&global_scope,
&command_scope,
@@ -901,6 +969,7 @@ pub async fn size<R: Runtime>(
options: Option<BaseOptions>,
) -> CommandResult<u64> {
let resolved_path = resolve_path(
"size",
&webview,
&global_scope,
&command_scope,
@@ -943,16 +1012,25 @@ fn get_dir_size(path: &PathBuf) -> CommandResult<u64> {
#[cfg(not(target_os = "android"))]
pub fn resolve_file<R: Runtime>(
permission: &str,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
command_scope: &CommandScope<Entry>,
path: SafeFilePath,
open_options: OpenOptions,
) -> CommandResult<(File, PathBuf)> {
resolve_file_in_fs(webview, global_scope, command_scope, path, open_options)
resolve_file_in_fs(
permission,
webview,
global_scope,
command_scope,
path,
open_options,
)
}
fn resolve_file_in_fs<R: Runtime>(
permission: &str,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
command_scope: &CommandScope<Entry>,
@@ -960,6 +1038,7 @@ fn resolve_file_in_fs<R: Runtime>(
open_options: OpenOptions,
) -> CommandResult<(File, PathBuf)> {
let path = resolve_path(
permission,
webview,
global_scope,
command_scope,
@@ -980,6 +1059,7 @@ fn resolve_file_in_fs<R: Runtime>(
#[cfg(target_os = "android")]
pub fn resolve_file<R: Runtime>(
permission: &str,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
command_scope: &CommandScope<Entry>,
@@ -997,6 +1077,7 @@ pub fn resolve_file<R: Runtime>(
Ok((file, path))
}
SafeFilePath::Path(path) => resolve_file_in_fs(
permission,
webview,
global_scope,
command_scope,
@@ -1007,6 +1088,7 @@ pub fn resolve_file<R: Runtime>(
}
pub fn resolve_path<R: Runtime>(
permission: &str,
webview: &Webview<R>,
global_scope: &GlobalScope<Entry>,
command_scope: &CommandScope<Entry>,
@@ -1052,7 +1134,17 @@ pub fn resolve_path<R: Runtime>(
if fs_scope.scope.is_allowed(&path) || scope.is_allowed(&path) {
Ok(path)
} else {
Err(CommandError::Plugin(Error::PathForbidden(path)))
#[cfg(not(debug_assertions))]
return Err(CommandError::Plugin(Error::PathForbidden(path)));
#[cfg(debug_assertions)]
Err(
anyhow::anyhow!(
"forbidden path: {}, maybe it is not allowed on the scope for `allow-{permission}` permission in your capability file",
path.display()
)
)
.map_err(Into::into)
}
}
plugins/fs/src/mobile.rs
+1 -1
View File
@@ -89,7 +89,7 @@ impl<R: Runtime> Fs<R> {
std::fs::File::from_raw_fd(fd)
})
} else {
todo!()
unimplemented!()
}
}
}
plugins/fs/src/watcher.rs
+1
View File
@@ -49,6 +49,7 @@ pub fn watch<R: Runtime>(
.into_iter()
.map(|path| {
resolve_path(
"watch",
&webview,
&global_scope,
&command_scope,