From 9ed6904383473237145f40cb238c133ff79c9853 Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Tue, 16 Jun 2020 18:59:13 +0100 Subject: [PATCH 1/8] refactor: replace the podio crate with byteorder --- Cargo.toml | 2 +- src/read.rs | 17 +++++++++++------ src/spec.rs | 5 +++-- src/write.rs | 2 +- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 2fbb331d..240ee137 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,7 +15,7 @@ edition = "2018" [dependencies] flate2 = { version = "1.0", default-features = false, optional = true } time = { version = "0.1", optional = true } -podio = "0.1" +byteorder = "1.3.4" bzip2 = { version = "0.3", optional = true } crc32fast = "1.0" thiserror = "1.0" diff --git a/src/read.rs b/src/read.rs index 52fe75cf..cffd0a95 100644 --- a/src/read.rs +++ b/src/read.rs @@ -11,7 +11,7 @@ use std::io::prelude::*; use crate::cp437::FromCp437; use crate::types::{DateTime, System, ZipFileData}; -use podio::{LittleEndian, ReadPodExt}; +use byteorder::{LittleEndian, ReadBytesExt}; #[cfg(feature = "deflate")] use flate2::read::DeflateDecoder; @@ -341,9 +341,12 @@ fn central_header_to_zip_file( let _internal_file_attributes = reader.read_u16::()?; let external_file_attributes = reader.read_u32::()?; let offset = reader.read_u32::()? as u64; - let file_name_raw = ReadPodExt::read_exact(reader, file_name_length)?; - let extra_field = ReadPodExt::read_exact(reader, extra_field_length)?; - let file_comment_raw = ReadPodExt::read_exact(reader, file_comment_length)?; + let mut file_name_raw = vec![0; file_name_length]; + reader.read_exact(&mut file_name_raw)?; + let mut extra_field = vec![0; extra_field_length]; + reader.read_exact(&mut extra_field)?; + let mut file_comment_raw = vec![0; file_comment_length]; + reader.read_exact(&mut file_comment_raw)?; let file_name = match is_utf8 { true => String::from_utf8_lossy(&*file_name_raw).into_owned(), @@ -621,8 +624,10 @@ pub fn read_zipfile_from_stream<'a, R: io::Read>( let file_name_length = reader.read_u16::()? as usize; let extra_field_length = reader.read_u16::()? as usize; - let file_name_raw = ReadPodExt::read_exact(reader, file_name_length)?; - let extra_field = ReadPodExt::read_exact(reader, extra_field_length)?; + let mut file_name_raw = vec![0; file_name_length]; + reader.read_exact(&mut file_name_raw)?; + let mut extra_field = vec![0; extra_field_length]; + reader.read_exact(&mut extra_field)?; let file_name = match is_utf8 { true => String::from_utf8_lossy(&*file_name_raw).into_owned(), diff --git a/src/spec.rs b/src/spec.rs index c2ff907b..8fa8c5c1 100644 --- a/src/spec.rs +++ b/src/spec.rs @@ -1,5 +1,5 @@ use crate::result::{ZipError, ZipResult}; -use podio::{LittleEndian, ReadPodExt, WritePodExt}; +use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt}; use std::io; use std::io::prelude::*; @@ -32,7 +32,8 @@ impl CentralDirectoryEnd { let central_directory_size = reader.read_u32::()?; let central_directory_offset = reader.read_u32::()?; let zip_file_comment_length = reader.read_u16::()? as usize; - let zip_file_comment = ReadPodExt::read_exact(reader, zip_file_comment_length)?; + let mut zip_file_comment = vec![0; zip_file_comment_length]; + reader.read_exact(&mut zip_file_comment)?; Ok(CentralDirectoryEnd { disk_number, diff --git a/src/write.rs b/src/write.rs index d7ed628e..b3e9abac 100644 --- a/src/write.rs +++ b/src/write.rs @@ -4,8 +4,8 @@ use crate::compression::CompressionMethod; use crate::result::{ZipError, ZipResult}; use crate::spec; use crate::types::{DateTime, System, ZipFileData, DEFAULT_VERSION}; +use byteorder::{LittleEndian, WriteBytesExt}; use crc32fast::Hasher; -use podio::{LittleEndian, WritePodExt}; use std::default::Default; use std::io; use std::io::prelude::*; From 7ff565aacb5cb7af97c7fec998df1339c2594195 Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Wed, 17 Jun 2020 17:11:36 +0100 Subject: [PATCH 2/8] feat: loosen byteorder version requirement --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 240ee137..9bdab53e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,7 +15,7 @@ edition = "2018" [dependencies] flate2 = { version = "1.0", default-features = false, optional = true } time = { version = "0.1", optional = true } -byteorder = "1.3.4" +byteorder = "1.3" bzip2 = { version = "0.3", optional = true } crc32fast = "1.0" thiserror = "1.0" From 548db12b07026d33a9cb12192ceb6c1299ab344a Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Wed, 17 Jun 2020 17:36:34 +0100 Subject: [PATCH 3/8] docs: deprecate unnecessary API --- src/compression.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/compression.rs b/src/compression.rs index 86358b3e..bb57d690 100644 --- a/src/compression.rs +++ b/src/compression.rs @@ -14,11 +14,19 @@ pub enum CompressionMethod { #[cfg(feature = "bzip2")] Bzip2, /// Unsupported compression method + #[deprecated( + since = "0.5.7", + note = "implementation details are being removed from the public API" + )] Unsupported(u16), } impl CompressionMethod { /// Converts an u16 to its corresponding CompressionMethod + #[deprecated( + since = "0.5.7", + note = "implementation details are being removed from the public API" + )] pub fn from_u16(val: u16) -> CompressionMethod { match val { 0 => CompressionMethod::Stored, @@ -31,6 +39,10 @@ impl CompressionMethod { } /// Converts a CompressionMethod to a u16 + #[deprecated( + since = "0.5.7", + note = "implementation details are being removed from the public API" + )] pub fn to_u16(self) -> u16 { match self { CompressionMethod::Stored => 0, From e8f576e179ccd4ffd6ae7ae1bc914b811996112a Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Wed, 17 Jun 2020 18:20:40 +0100 Subject: [PATCH 4/8] chore: allow internal use of deprecated items --- src/compression.rs | 7 +++++++ src/read.rs | 6 +++++- src/write.rs | 3 +++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/compression.rs b/src/compression.rs index bb57d690..f34e2b3c 100644 --- a/src/compression.rs +++ b/src/compression.rs @@ -34,6 +34,7 @@ impl CompressionMethod { 8 => CompressionMethod::Deflated, #[cfg(feature = "bzip2")] 12 => CompressionMethod::Bzip2, + #[allow(deprecated)] v => CompressionMethod::Unsupported(v), } } @@ -50,6 +51,7 @@ impl CompressionMethod { CompressionMethod::Deflated => 8, #[cfg(feature = "bzip2")] CompressionMethod::Bzip2 => 12, + #[allow(deprecated)] CompressionMethod::Unsupported(v) => v, } } @@ -69,7 +71,9 @@ mod test { #[test] fn from_eq_to() { for v in 0..(::std::u16::MAX as u32 + 1) { + #[allow(deprecated)] let from = CompressionMethod::from_u16(v as u16); + #[allow(deprecated)] let to = from.to_u16() as u32; assert_eq!(v, to); } @@ -88,8 +92,11 @@ mod test { #[test] fn to_eq_from() { fn check_match(method: CompressionMethod) { + #[allow(deprecated)] let to = method.to_u16(); + #[allow(deprecated)] let from = CompressionMethod::from_u16(to); + #[allow(deprecated)] let back = from.to_u16(); assert_eq!(to, back); } diff --git a/src/read.rs b/src/read.rs index cffd0a95..ac721533 100644 --- a/src/read.rs +++ b/src/read.rs @@ -362,7 +362,10 @@ fn central_header_to_zip_file( system: System::from_u8((version_made_by >> 8) as u8), version_made_by: version_made_by as u8, encrypted, - compression_method: CompressionMethod::from_u16(compression_method), + compression_method: { + #[allow(deprecated)] + CompressionMethod::from_u16(compression_method) + }, last_modified_time: DateTime::from_msdos(last_mod_date, last_mod_time), crc32, compressed_size: compressed_size as u64, @@ -615,6 +618,7 @@ pub fn read_zipfile_from_stream<'a, R: io::Read>( let encrypted = flags & 1 == 1; let is_utf8 = flags & (1 << 11) != 0; let using_data_descriptor = flags & (1 << 3) != 0; + #[allow(deprecated)] let compression_method = CompressionMethod::from_u16(reader.read_u16::()?); let last_mod_time = reader.read_u16::()?; let last_mod_date = reader.read_u16::()?; diff --git a/src/write.rs b/src/write.rs index b3e9abac..a7ee92c7 100644 --- a/src/write.rs +++ b/src/write.rs @@ -408,6 +408,7 @@ impl GenericZipWriter { CompressionMethod::Bzip2 => { GenericZipWriter::Bzip2(BzEncoder::new(bare, bzip2::Compression::Default)) } + #[allow(deprecated)] CompressionMethod::Unsupported(..) => { return Err(ZipError::UnsupportedArchive("Unsupported compression")) } @@ -473,6 +474,7 @@ fn write_local_file_header(writer: &mut T, file: &ZipFileData) -> ZipR }; writer.write_u16::(flag)?; // Compression method + #[allow(deprecated)] writer.write_u16::(file.compression_method.to_u16())?; // last mod file time and last mod file date writer.write_u16::(file.last_modified_time.timepart())?; @@ -524,6 +526,7 @@ fn write_central_directory_header(writer: &mut T, file: &ZipFileData) }; writer.write_u16::(flag)?; // compression method + #[allow(deprecated)] writer.write_u16::(file.compression_method.to_u16())?; // last mod file time + date writer.write_u16::(file.last_modified_time.timepart())?; From 061a58cf7dc5f83c9324ac887229a4ee8b7448ac Mon Sep 17 00:00:00 2001 From: Jeremy Aube Date: Sun, 21 Jun 2020 11:38:39 -0400 Subject: [PATCH 5/8] Removed the default zip comment for ZipWriter to an empty string --- src/write.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/write.rs b/src/write.rs index a7ee92c7..2598f196 100644 --- a/src/write.rs +++ b/src/write.rs @@ -176,7 +176,7 @@ impl ZipWriter { files: Vec::new(), stats: Default::default(), writing_to_file: false, - comment: "zip-rs".into(), + comment: "".into(), } } From d382f04e5a2005971fda802e9920ea72d932a6be Mon Sep 17 00:00:00 2001 From: Jeremy Aube Date: Sun, 21 Jun 2020 12:38:36 -0400 Subject: [PATCH 6/8] Change default comment to String::new() and fixed tests --- src/read.rs | 2 +- src/write.rs | 9 +++++---- tests/data/mimetype.zip | Bin 159 -> 153 bytes 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/read.rs b/src/read.rs index ac721533..06d2540d 100644 --- a/src/read.rs +++ b/src/read.rs @@ -714,7 +714,7 @@ mod test { let mut v = Vec::new(); v.extend_from_slice(include_bytes!("../tests/data/mimetype.zip")); let reader = ZipArchive::new(io::Cursor::new(v)).unwrap(); - assert!(reader.comment() == b"zip-rs"); + assert!(reader.comment() == b""); } #[test] diff --git a/src/write.rs b/src/write.rs index 2598f196..f1d762dd 100644 --- a/src/write.rs +++ b/src/write.rs @@ -176,7 +176,7 @@ impl ZipWriter { files: Vec::new(), stats: Default::default(), writing_to_file: false, - comment: "".into(), + comment: String::new(), } } @@ -616,7 +616,7 @@ mod test { .write(b"writing to a directory is not allowed, and will not write any data") .is_err()); let result = writer.finish().unwrap(); - assert_eq!(result.get_ref().len(), 114); + assert_eq!(result.get_ref().len(), 108); assert_eq!( *result.get_ref(), &[ @@ -624,7 +624,7 @@ mod test { 0, 0, 5, 0, 0, 0, 116, 101, 115, 116, 47, 80, 75, 1, 2, 46, 3, 20, 0, 0, 0, 0, 0, 163, 165, 15, 77, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 237, 65, 0, 0, 0, 0, 116, 101, 115, 116, 47, 80, 75, 5, 6, 0, 0, 0, 0, 1, 0, - 1, 0, 51, 0, 0, 0, 35, 0, 0, 0, 6, 0, 122, 105, 112, 45, 114, 115 + 1, 0, 51, 0, 0, 0, 35, 0, 0, 0, 0, 0, ] as &[u8] ); } @@ -642,7 +642,8 @@ mod test { .write(b"application/vnd.oasis.opendocument.text") .unwrap(); let result = writer.finish().unwrap(); - assert_eq!(result.get_ref().len(), 159); + + assert_eq!(result.get_ref().len(), 153); let mut v = Vec::new(); v.extend_from_slice(include_bytes!("../tests/data/mimetype.zip")); assert_eq!(result.get_ref(), &v); diff --git a/tests/data/mimetype.zip b/tests/data/mimetype.zip index 78f98224e8a226a235a08304f717015dfa97aef5..2d651cbeb35f66322568234766b6b933f651dadc 100644 GIT binary patch delta 9 QcmbQwIFoV0bS4G{01poWWB>pF delta 15 WcmbQqIG=ICbPhI#s>}l2qGA9hNCedY From 6e652446dda430e5fa1988d3e057249adbedb713 Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Tue, 23 Jun 2020 15:48:50 +0100 Subject: [PATCH 7/8] feat: define the crate's MSRV --- .github/workflows/ci.yaml | 2 +- README.md | 11 +++++++++++ src/types.rs | 1 - 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 3e25bed6..1e7b3953 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -16,7 +16,7 @@ jobs: strategy: matrix: os: [ubuntu-latest, macOS-latest, windows-latest] - rust: [stable] + rust: [stable, 1.34.0] steps: - uses: actions/checkout@master diff --git a/README.md b/README.md index 8f4d219f..9a062c57 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,17 @@ The features available are: All of these are enabled by default. +MSRV +---- + +Our current Minimum Supported Rust Version is **1.34.0**. When adding features, +we will follow these guidelines: + +- We will always support the latest four minor Rust versions. This gives you a 6 + month window to upgrade your compiler. +- Any change to the MSRV will be accompanied with a **minor** version bump + - While the crate is pre-1.0, this will be a change to the PATCH version. + Examples -------- diff --git a/src/types.rs b/src/types.rs index e23fab9b..a855c923 100644 --- a/src/types.rs +++ b/src/types.rs @@ -1,6 +1,5 @@ //! Types that specify what is contained in a ZIP. -#[non_exhaustive] #[derive(Clone, Copy, Debug, PartialEq)] pub enum System { Dos = 0, From 2f0e14574e89ec4d50e2a909a2a51547f5d312db Mon Sep 17 00:00:00 2001 From: Marli Frost Date: Tue, 23 Jun 2020 16:15:21 +0100 Subject: [PATCH 8/8] refactor: make crate 1.34.0 compatible --- src/compression.rs | 6 ++++-- src/write.rs | 28 +++++++++++++++------------- tests/end_to_end.rs | 2 +- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/src/compression.rs b/src/compression.rs index f34e2b3c..3c607195 100644 --- a/src/compression.rs +++ b/src/compression.rs @@ -2,6 +2,7 @@ use std::fmt; +#[allow(deprecated)] /// Compression methods for the contents of a ZIP file. #[derive(Copy, Clone, PartialEq, Debug)] pub enum CompressionMethod { @@ -28,13 +29,14 @@ impl CompressionMethod { note = "implementation details are being removed from the public API" )] pub fn from_u16(val: u16) -> CompressionMethod { + #[allow(deprecated)] match val { 0 => CompressionMethod::Stored, #[cfg(feature = "deflate")] 8 => CompressionMethod::Deflated, #[cfg(feature = "bzip2")] 12 => CompressionMethod::Bzip2, - #[allow(deprecated)] + v => CompressionMethod::Unsupported(v), } } @@ -45,13 +47,13 @@ impl CompressionMethod { note = "implementation details are being removed from the public API" )] pub fn to_u16(self) -> u16 { + #[allow(deprecated)] match self { CompressionMethod::Stored => 0, #[cfg(feature = "deflate")] CompressionMethod::Deflated => 8, #[cfg(feature = "bzip2")] CompressionMethod::Bzip2 => 12, - #[allow(deprecated)] CompressionMethod::Unsupported(v) => v, } } diff --git a/src/write.rs b/src/write.rs index f1d762dd..5468a286 100644 --- a/src/write.rs +++ b/src/write.rs @@ -397,20 +397,22 @@ impl GenericZipWriter { } }; - *self = match compression { - CompressionMethod::Stored => GenericZipWriter::Storer(bare), - #[cfg(feature = "deflate")] - CompressionMethod::Deflated => GenericZipWriter::Deflater(DeflateEncoder::new( - bare, - flate2::Compression::default(), - )), - #[cfg(feature = "bzip2")] - CompressionMethod::Bzip2 => { - GenericZipWriter::Bzip2(BzEncoder::new(bare, bzip2::Compression::Default)) - } + *self = { #[allow(deprecated)] - CompressionMethod::Unsupported(..) => { - return Err(ZipError::UnsupportedArchive("Unsupported compression")) + match compression { + CompressionMethod::Stored => GenericZipWriter::Storer(bare), + #[cfg(feature = "deflate")] + CompressionMethod::Deflated => GenericZipWriter::Deflater(DeflateEncoder::new( + bare, + flate2::Compression::default(), + )), + #[cfg(feature = "bzip2")] + CompressionMethod::Bzip2 => { + GenericZipWriter::Bzip2(BzEncoder::new(bare, bzip2::Compression::Default)) + } + CompressionMethod::Unsupported(..) => { + return Err(ZipError::UnsupportedArchive("Unsupported compression")) + } } }; diff --git a/tests/end_to_end.rs b/tests/end_to_end.rs index cf5986bb..6268920a 100644 --- a/tests/end_to_end.rs +++ b/tests/end_to_end.rs @@ -39,7 +39,7 @@ fn read_zip_file(zip_file: &mut Cursor>) -> zip::result::ZipResult>(); assert_eq!(file_names, expected_file_names);