github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-08 12:35:41 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

Improve error message for Zip invalid encoding errors

Browse Source 
And refactor function implementations
This commit is contained in:
João M. Bezerra 2021-11-10 19:45:27 -03:00
parent fe6913118d
commit ed0e225219
1 changed files with 27 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/archive/zip.rs
View File

@ -12,9 +12,13 @@ use zip::{self, read::ZipFile, ZipArchive};
use self::utf8::get_invalid_utf8_paths; use self::utf8::get_invalid_utf8_paths;
use crate::{ use crate::{
error::FinalError,
info, info,
list::FileInArchive, list::FileInArchive,
utils::{self, dir_is_empty, strip_cur_dir, Bytes}, utils::{
cd_into_same_dir_as, concatenate_os_str_list, dir_is_empty, strip_cur_dir, to_utf, user_wants_to_overwrite,
Bytes,
},
QuestionPolicy, QuestionPolicy,
}; };
@ -36,7 +40,7 @@ where
}; };
let file_path = into.join(file_path); let file_path = into.join(file_path);
if file_path.exists() && !utils::user_wants_to_overwrite(&file_path, question_policy)? { if file_path.exists() && !user_wants_to_overwrite(&file_path, question_policy)? {
continue; continue;
} }
@ -110,13 +114,16 @@ where
// Vec of any filename that failed the UTF-8 check // Vec of any filename that failed the UTF-8 check
let invalid_unicode_filenames = get_invalid_utf8_paths(input_filenames); let invalid_unicode_filenames = get_invalid_utf8_paths(input_filenames);
if let Some(filenames) = invalid_unicode_filenames { if !invalid_unicode_filenames.is_empty() {
// TODO: make this an error variant let error = FinalError::with_title("Cannot build zip archive")
panic!("invalid unicode filenames found, cannot be supported by Zip:\n {:#?}", filenames); .detail("Zip archives require files to have valid UTF-8 paths")
.detail(format!("Files with invalid paths: {}", concatenate_os_str_list(&invalid_unicode_filenames)));
return Err(error.into());
} }
for filename in input_filenames { for filename in input_filenames {
let previous_location = utils::cd_into_same_dir_as(filename)?; let previous_location = cd_into_same_dir_as(filename)?;
// Safe unwrap, input shall be treated before // Safe unwrap, input shall be treated before
let filename = filename.file_name().unwrap(); let filename = filename.file_name().unwrap();
@ -125,7 +132,7 @@ where
let entry = entry?; let entry = entry?;
let path = entry.path(); let path = entry.path();
info!("Compressing '{}'.", utils::to_utf(path)); info!("Compressing '{}'.", to_utf(path));
if path.is_dir() { if path.is_dir() {
if dir_is_empty(path) { if dir_is_empty(path) {
@ -134,7 +141,6 @@ where
// If a dir has files, the files are responsible for creating them. // If a dir has files, the files are responsible for creating them.
} else { } else {
writer.start_file(path.to_str().unwrap().to_owned(), options)?; writer.start_file(path.to_str().unwrap().to_owned(), options)?;
// TODO: better error messages
let file_bytes = fs::read(entry.path())?; let file_bytes = fs::read(entry.path())?;
writer.write_all(&*file_bytes)?; writer.write_all(&*file_bytes)?;
} }
@ -166,33 +172,23 @@ fn __unix_set_permissions(file_path: &Path, file: &ZipFile) -> crate::Result<()>
} }
mod utf8 { mod utf8 {
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
// Sad double reference in order to make `filter` happy in `get_invalid_utf8_paths` fn is_invalid_utf8(path: &Path) -> bool {
#[cfg(unix)] #[cfg(unix)]
fn is_invalid_utf8(path: &&Path) -> bool { {
use std::{os::unix::prelude::OsStrExt, str}; use std::{os::unix::prelude::OsStrExt, str};
// str::from_utf8 does not make any allocations
let bytes = path.as_os_str().as_bytes(); let bytes = path.as_os_str().as_bytes();
let is_invalid = str::from_utf8(bytes).is_err(); str::from_utf8(bytes).is_err()
is_invalid
} }
#[cfg(not(unix))] #[cfg(not(unix))]
fn is_invalid_utf8(path: &&Path) -> bool { {
path.to_str().is_none() path.to_str().is_none()
} }
}
pub fn get_invalid_utf8_paths(paths: &[PathBuf]) -> Option<Vec<PathBuf>> { pub fn get_invalid_utf8_paths(paths: &[PathBuf]) -> Vec<PathBuf> {
let mut invalid_paths = paths.iter().map(PathBuf::as_path).filter(is_invalid_utf8).peekable(); paths.iter().filter_map(|path| is_invalid_utf8(&path).then(|| path.clone())).collect()
let a_path_is_invalid = invalid_paths.peek().is_some();
let clone_paths = || invalid_paths.map(ToOwned::to_owned).collect();
a_path_is_invalid.then(clone_paths)
} }
} }