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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

#![allow(unused_imports)]

use crate::{api::path::BaseDirectory, Runtime};
#[cfg(path_all)]
use crate::{Env, Manager};
use std::path::PathBuf;
#[cfg(path_all)]
use std::path::{Component, Path, MAIN_SEPARATOR};

use super::InvokeContext;
use serde::Deserialize;
use tauri_macros::{command_enum, module_command_handler, CommandModule};

/// The API descriptor.
#[command_enum]
#[derive(Deserialize, CommandModule)]
#[serde(tag = "cmd", rename_all = "camelCase")]
pub enum Cmd {
  #[cmd(path_all, "path > all")]
  ResolvePath {
    path: String,
    directory: Option<BaseDirectory>,
  },
  #[cmd(path_all, "path > all")]
  Resolve { paths: Vec<String> },
  #[cmd(path_all, "path > all")]
  Normalize { path: String },
  #[cmd(path_all, "path > all")]
  Join { paths: Vec<String> },
  #[cmd(path_all, "path > all")]
  Dirname { path: String },
  #[cmd(path_all, "path > all")]
  Extname { path: String },
  #[cmd(path_all, "path > all")]
  Basename { path: String, ext: Option<String> },
  #[cmd(path_all, "path > all")]
  IsAbsolute { path: String },
}

impl Cmd {
  #[module_command_handler(path_all)]
  fn resolve_path<R: Runtime>(
    context: InvokeContext<R>,
    path: String,
    directory: Option<BaseDirectory>,
  ) -> super::Result<PathBuf> {
    crate::api::path::resolve_path(
      &context.config,
      &context.package_info,
      context.window.state::<Env>().inner(),
      path,
      directory,
    )
    .map_err(Into::into)
  }

  #[module_command_handler(path_all)]
  fn resolve<R: Runtime>(_context: InvokeContext<R>, paths: Vec<String>) -> super::Result<PathBuf> {
    // Start with current directory then start adding paths from the vector one by one using `PathBuf.push()` which
    // will ensure that if an absolute path is encountered in the iteration, it will be used as the current full path.
    //
    // examples:
    // 1. `vec!["."]` or `vec![]` will be equal to `std::env::current_dir()`
    // 2. `vec!["/foo/bar", "/tmp/file", "baz"]` will be equal to `PathBuf::from("/tmp/file/baz")`
    let mut path = std::env::current_dir()?;
    for p in paths {
      path.push(p);
    }
    Ok(normalize_path(&path))
  }

  #[module_command_handler(path_all)]
  fn normalize<R: Runtime>(_context: InvokeContext<R>, path: String) -> super::Result<String> {
    let mut p = normalize_path_no_absolute(Path::new(&path))
      .to_string_lossy()
      .to_string();
    Ok(
      // Node.js behavior is to return `".."` for `normalize("..")`
      // and `"."` for `normalize("")` or `normalize(".")`
      if p.is_empty() && path == ".." {
        "..".into()
      } else if p.is_empty() && path == "." {
        ".".into()
      } else {
        // Add a trailing separator if the path passed to this functions had a trailing separator. That's how Node.js behaves.
        if (path.ends_with('/') || path.ends_with('\\'))
          && (!p.ends_with('/') || !p.ends_with('\\'))
        {
          p.push(MAIN_SEPARATOR);
        }
        p
      },
    )
  }

  #[module_command_handler(path_all)]
  fn join<R: Runtime>(_context: InvokeContext<R>, mut paths: Vec<String>) -> super::Result<String> {
    let path = PathBuf::from(
      paths
        .iter_mut()
        .map(|p| {
          // Add a `MAIN_SEPARATOR` if it doesn't already have one.
          // Doing this to ensure that the vector elements are separated in
          // the resulting string so path.components() can work correctly when called
          // in `normalize_path_no_absolute()` later on.
          if !p.ends_with('/') && !p.ends_with('\\') {
            p.push(MAIN_SEPARATOR);
          }
          p.to_string()
        })
        .collect::<String>(),
    );

    let p = normalize_path_no_absolute(&path)
      .to_string_lossy()
      .to_string();
    Ok(if p.is_empty() { ".".into() } else { p })
  }

  #[module_command_handler(path_all)]
  fn dirname<R: Runtime>(_context: InvokeContext<R>, path: String) -> super::Result<PathBuf> {
    match Path::new(&path).parent() {
      Some(p) => Ok(p.to_path_buf()),
      None => Err(crate::error::into_anyhow(crate::api::Error::Path(
        "Couldn't get the parent directory".into(),
      ))),
    }
  }

  #[module_command_handler(path_all)]
  fn extname<R: Runtime>(_context: InvokeContext<R>, path: String) -> super::Result<String> {
    match Path::new(&path)
      .extension()
      .and_then(std::ffi::OsStr::to_str)
    {
      Some(p) => Ok(p.to_string()),
      None => Err(crate::error::into_anyhow(crate::api::Error::Path(
        "Couldn't get the extension of the file".into(),
      ))),
    }
  }

  #[module_command_handler(path_all)]
  fn basename<R: Runtime>(
    _context: InvokeContext<R>,
    path: String,
    ext: Option<String>,
  ) -> super::Result<String> {
    match Path::new(&path)
      .file_name()
      .and_then(std::ffi::OsStr::to_str)
    {
      Some(p) => Ok(if let Some(ext) = ext {
        p.replace(ext.as_str(), "")
      } else {
        p.to_string()
      }),
      None => Err(crate::error::into_anyhow(crate::api::Error::Path(
        "Couldn't get the basename".into(),
      ))),
    }
  }

  #[module_command_handler(path_all)]
  fn is_absolute<R: Runtime>(_context: InvokeContext<R>, path: String) -> super::Result<bool> {
    Ok(Path::new(&path).is_absolute())
  }
}

/// Normalize a path, removing things like `.` and `..`, this snippet is taken from cargo's paths util.
/// https://github.com/rust-lang/cargo/blob/46fa867ff7043e3a0545bf3def7be904e1497afd/crates/cargo-util/src/paths.rs#L73-L106
#[cfg(path_all)]
fn normalize_path(path: &Path) -> PathBuf {
  let mut components = path.components().peekable();
  let mut ret = if let Some(c @ Component::Prefix(..)) = components.peek().cloned() {
    components.next();
    PathBuf::from(c.as_os_str())
  } else {
    PathBuf::new()
  };

  for component in components {
    match component {
      Component::Prefix(..) => unreachable!(),
      Component::RootDir => {
        ret.push(component.as_os_str());
      }
      Component::CurDir => {}
      Component::ParentDir => {
        ret.pop();
      }
      Component::Normal(c) => {
        ret.push(c);
      }
    }
  }
  ret
}

/// Normalize a path, removing things like `.` and `..`, this snippet is taken from cargo's paths util but
/// slightly modified to not resolve absolute paths.
/// https://github.com/rust-lang/cargo/blob/46fa867ff7043e3a0545bf3def7be904e1497afd/crates/cargo-util/src/paths.rs#L73-L106
#[cfg(path_all)]
fn normalize_path_no_absolute(path: &Path) -> PathBuf {
  let mut components = path.components().peekable();
  let mut ret = if let Some(c @ Component::Prefix(..)) = components.peek().cloned() {
    components.next();
    PathBuf::from(c.as_os_str())
  } else {
    PathBuf::new()
  };

  for component in components {
    match component {
      Component::Prefix(..) => unreachable!(),
      Component::RootDir => {
        ret.push(component.as_os_str());
      }
      Component::CurDir => {}
      Component::ParentDir => {
        ret.pop();
      }
      Component::Normal(c) => {
        // Using PathBuf::push here will replace the whole path if an absolute path is encountered
        // which is not the intended behavior, so instead of that, convert the current resolved path
        // to a string and do simple string concatenation with the current component then convert it
        // back to a PathBuf
        let mut p = ret.to_string_lossy().to_string();
        // Only add a separator if it doesn't have one already or if current normalized path is empty,
        // this ensures it won't have an unwanted leading separator
        if !p.is_empty() && !p.ends_with('/') && !p.ends_with('\\') {
          p.push(MAIN_SEPARATOR);
        }
        if let Some(c) = c.to_str() {
          p.push_str(c);
        }
        ret = PathBuf::from(p);
      }
    }
  }
  ret
}

#[cfg(test)]
mod tests {
  use crate::api::path::BaseDirectory;

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn resolve_path(_path: String, _directory: Option<BaseDirectory>) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn resolve(_paths: Vec<String>) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn normalize(_path: String) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn join(_paths: Vec<String>) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn dirname(_path: String) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn extname(_path: String) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn basename(_path: String, _ext: Option<String>) {}

  #[tauri_macros::module_command_test(path_all, "path > all")]
  #[quickcheck_macros::quickcheck]
  fn is_absolute(_path: String) {}
}