// 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 operations. #[cfg(feature = "fs-extract-api")] mod extract; mod file_move; use std::{ fs, path::{Display, Path}, }; #[cfg(feature = "fs-extract-api")] pub use extract::*; pub use file_move::*; use serde::{de::Error as DeError, Deserialize, Deserializer}; #[derive(Clone, Debug)] pub(crate) struct SafePathBuf(std::path::PathBuf); impl SafePathBuf { pub fn new(path: std::path::PathBuf) -> Result { if path .components() .any(|x| matches!(x, std::path::Component::ParentDir)) { Err("cannot traverse directory, rewrite the path without the use of `../`") } else { Ok(Self(path)) } } #[allow(dead_code)] pub unsafe fn new_unchecked(path: std::path::PathBuf) -> Self { Self(path) } #[allow(dead_code)] pub fn display(&self) -> Display<'_> { self.0.display() } } impl AsRef for SafePathBuf { fn as_ref(&self) -> &Path { self.0.as_ref() } } impl<'de> Deserialize<'de> for SafePathBuf { fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { let path = std::path::PathBuf::deserialize(deserializer)?; SafePathBuf::new(path).map_err(DeError::custom) } } /// Reads the entire contents of a file into a string. pub fn read_string>(file: P) -> crate::api::Result { fs::read_to_string(file).map_err(Into::into) } /// Reads the entire contents of a file into a bytes vector. pub fn read_binary>(file: P) -> crate::api::Result> { fs::read(file).map_err(Into::into) } #[cfg(test)] mod test { use super::*; use crate::api::Error; use quickcheck::{Arbitrary, Gen}; use std::path::PathBuf; impl Arbitrary for super::SafePathBuf { fn arbitrary(g: &mut Gen) -> Self { Self(PathBuf::arbitrary(g)) } fn shrink(&self) -> Box> { Box::new(self.0.shrink().map(SafePathBuf)) } } #[test] fn check_read_string() { let file = String::from("test/api/test.txt"); let res = read_string(file); assert!(res.is_ok()); if let Ok(s) = res { assert_eq!(s, "This is a test doc!".to_string()); } } #[test] fn check_read_string_fail() { let file = String::from("test/api/"); let res = read_string(file); assert!(res.is_err()); #[cfg(not(windows))] if let Error::Io(e) = res.unwrap_err() { #[cfg(not(windows))] assert_eq!(e.to_string(), "Is a directory (os error 21)".to_string()); } } #[test] fn check_read_binary() { let file = String::from("test/api/test_binary"); let expected_vec = vec![ 71, 73, 70, 56, 57, 97, 1, 0, 1, 0, 128, 0, 0, 255, 255, 255, 0, 0, 0, 33, 249, 4, 1, 0, 0, 0, 0, 44, 0, 0, 0, 0, 1, 0, 1, 0, 0, 2, 2, 68, 1, 0, 59, ]; let res = read_binary(file); assert!(res.is_ok()); if let Ok(vec) = res { assert_eq!(vec, expected_vec); } } #[test] fn check_read_binary_fail() { let file = String::from("test/api/"); let res = read_binary(file); assert!(res.is_err()); #[cfg(not(windows))] if let Error::Io(e) = res.unwrap_err() { #[cfg(not(windows))] assert_eq!(e.to_string(), "Is a directory (os error 21)".to_string()); } } }