-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
path.rs
253 lines (226 loc) · 7.3 KB
/
path.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
//! Types and functions related to file system path operations.
use std::{
env,
path::{Component, Path, PathBuf},
};
use crate::{Config, PackageInfo};
use serde_repr::{Deserialize_repr, Serialize_repr};
/// A base directory to be used in [`resolve_path`].
///
/// The base directory is the optional root of a file system operation.
/// If informed by the API call, all paths will be relative to the path of the given directory.
///
/// For more information, check the [`dirs_next` documentation](https://docs.rs/dirs_next/).
#[derive(Serialize_repr, Deserialize_repr, Clone, Debug)]
#[repr(u16)]
#[non_exhaustive]
pub enum BaseDirectory {
/// The Audio directory.
Audio = 1,
/// The Cache directory.
Cache,
/// The Config directory.
Config,
/// The Data directory.
Data,
/// The LocalData directory.
LocalData,
/// The Desktop directory.
Desktop,
/// The Document directory.
Document,
/// The Download directory.
Download,
/// The Executable directory.
Executable,
/// The Font directory.
Font,
/// The Home directory.
Home,
/// The Picture directory.
Picture,
/// The Public directory.
Public,
/// The Runtime directory.
Runtime,
/// The Template directory.
Template,
/// The Video directory.
Video,
/// The Resource directory.
Resource,
/// The default App config directory.
/// Resolves to [`BaseDirectory::Config`].
App,
/// The current working directory.
Current,
/// The Log directory.
/// Resolves to [`BaseDirectory::Home/Library/Logs/{bundle_identifier}`] on macOS
/// and [`BaseDirectory::Config/{bundle_identifier}/logs`] on linux and windows.
Log,
}
/// Resolves the path with the optional base directory.
///
/// # Example
/// ```
/// use tauri::{api::path::{resolve_path, BaseDirectory}, PackageInfo};
/// // we use the default config and a mock PackageInfo, but in an actual app you should get the
/// // Config created from `tauri.conf.json` and the app's PackageInfo instance.
/// let path = resolve_path(
/// &Default::default(),
/// &PackageInfo {
/// name: "app".into(),
/// version: "1.0.0".into(),
/// },
/// "path/to/something",
/// Some(BaseDirectory::Config)
/// ).expect("failed to resolve path");
/// // path is equal to "/home/${whoami}/.config/path/to/something" on Linux
/// ```
pub fn resolve_path<P: AsRef<Path>>(
config: &Config,
package_info: &PackageInfo,
path: P,
dir: Option<BaseDirectory>,
) -> crate::api::Result<PathBuf> {
if let Some(base_dir) = dir {
let resolve_resource = matches!(base_dir, BaseDirectory::Resource);
let base_dir_path = match base_dir {
BaseDirectory::Audio => audio_dir(),
BaseDirectory::Cache => cache_dir(),
BaseDirectory::Config => config_dir(),
BaseDirectory::Data => data_dir(),
BaseDirectory::LocalData => local_data_dir(),
BaseDirectory::Desktop => desktop_dir(),
BaseDirectory::Document => document_dir(),
BaseDirectory::Download => download_dir(),
BaseDirectory::Executable => executable_dir(),
BaseDirectory::Font => font_dir(),
BaseDirectory::Home => home_dir(),
BaseDirectory::Picture => picture_dir(),
BaseDirectory::Public => public_dir(),
BaseDirectory::Runtime => runtime_dir(),
BaseDirectory::Template => template_dir(),
BaseDirectory::Video => video_dir(),
BaseDirectory::Resource => resource_dir(package_info),
BaseDirectory::App => app_dir(config),
BaseDirectory::Current => Some(env::current_dir()?),
BaseDirectory::Log => log_dir(config),
};
if let Some(mut base_dir_path_value) = base_dir_path {
// use the same path resolution mechanism as the bundler's resource injection algorithm
if resolve_resource {
let mut resource_path = PathBuf::new();
for component in path.as_ref().components() {
match component {
Component::Prefix(_) => {}
Component::RootDir => resource_path.push("_root_"),
Component::CurDir => {}
Component::ParentDir => resource_path.push("_up_"),
Component::Normal(p) => resource_path.push(p),
}
}
base_dir_path_value.push(resource_path);
} else {
base_dir_path_value.push(path);
}
Ok(base_dir_path_value)
} else {
Err(crate::api::Error::Path(
"unable to determine base dir path".to_string(),
))
}
} else {
let mut dir_path = PathBuf::new();
dir_path.push(path);
Ok(dir_path)
}
}
/// Returns the path to the user's audio directory.
pub fn audio_dir() -> Option<PathBuf> {
dirs_next::audio_dir()
}
/// Returns the path to the user's cache directory.
pub fn cache_dir() -> Option<PathBuf> {
dirs_next::cache_dir()
}
/// Returns the path to the user's config directory.
pub fn config_dir() -> Option<PathBuf> {
dirs_next::config_dir()
}
/// Returns the path to the user's data directory.
pub fn data_dir() -> Option<PathBuf> {
dirs_next::data_dir()
}
/// Returns the path to the user's local data directory.
pub fn local_data_dir() -> Option<PathBuf> {
dirs_next::data_local_dir()
}
/// Returns the path to the user's desktop directory.
pub fn desktop_dir() -> Option<PathBuf> {
dirs_next::desktop_dir()
}
/// Returns the path to the user's document directory.
pub fn document_dir() -> Option<PathBuf> {
dirs_next::document_dir()
}
/// Returns the path to the user's download directory.
pub fn download_dir() -> Option<PathBuf> {
dirs_next::download_dir()
}
/// Returns the path to the user's executable directory.
pub fn executable_dir() -> Option<PathBuf> {
dirs_next::executable_dir()
}
/// Returns the path to the user's font directory.
pub fn font_dir() -> Option<PathBuf> {
dirs_next::font_dir()
}
/// Returns the path to the user's home directory.
pub fn home_dir() -> Option<PathBuf> {
dirs_next::home_dir()
}
/// Returns the path to the user's picture directory.
pub fn picture_dir() -> Option<PathBuf> {
dirs_next::picture_dir()
}
/// Returns the path to the user's public directory.
pub fn public_dir() -> Option<PathBuf> {
dirs_next::public_dir()
}
/// Returns the path to the user's runtime directory.
pub fn runtime_dir() -> Option<PathBuf> {
dirs_next::runtime_dir()
}
/// Returns the path to the user's template directory.
pub fn template_dir() -> Option<PathBuf> {
dirs_next::template_dir()
}
/// Returns the path to the user's video dir
pub fn video_dir() -> Option<PathBuf> {
dirs_next::video_dir()
}
/// Returns the path to the resource directory of this app.
pub fn resource_dir(package_info: &PackageInfo) -> Option<PathBuf> {
crate::utils::platform::resource_dir(package_info).ok()
}
/// Returns the path to the suggested directory for your app config files.
pub fn app_dir(config: &Config) -> Option<PathBuf> {
dirs_next::config_dir().map(|dir| dir.join(&config.tauri.bundle.identifier))
}
/// Returns the path to the log directory.
pub fn log_dir(config: &Config) -> Option<PathBuf> {
#[cfg(target_os = "macos")]
let path = dirs_next::home_dir().map(|dir| {
dir
.join("Library/Logs")
.join(&config.tauri.bundle.identifier)
});
#[cfg(not(target_os = "macos"))]
let path =
dirs_next::config_dir().map(|dir| dir.join(&config.tauri.bundle.identifier).join("logs"));
path
}