From 69ad3bd2a4237516e2dc25dd9c5e7f2a8e81220e Mon Sep 17 00:00:00 2001
From: Manu Thambi <manu@meshcapital.com>
Date: Mon, 30 Dec 2019 17:42:10 -0500
Subject: [PATCH] Enable reading/writing ZIP archive comment.

---
 src/read.rs  |  7 ++++++-
 src/write.rs | 14 +++++++++++---
 2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/src/read.rs b/src/read.rs
index 9b4bad43..1b734c17 100644
--- a/src/read.rs
+++ b/src/read.rs
@@ -251,6 +251,11 @@ impl<R: Read+io::Seek> ZipArchive<R>
         self.offset
     }
 
+    /// Get the comment of the zip archive.
+    pub fn comment(&self) -> &[u8] {
+        &self.comment
+    }
+
     /// Search for a file entry by name
     pub fn by_name<'a>(&'a mut self, name: &str) -> ZipResult<ZipFile<'a>>
     {
@@ -670,7 +675,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"zip-rs");
     }
 
     #[test]
diff --git a/src/write.rs b/src/write.rs
index da3a4aae..d09accd3 100644
--- a/src/write.rs
+++ b/src/write.rs
@@ -57,6 +57,7 @@ pub struct ZipWriter<W: Write + io::Seek>
     files: Vec<ZipFileData>,
     stats: ZipWriterStats,
     writing_to_file: bool,
+    comment: String,
 }
 
 #[derive(Default)]
@@ -174,9 +175,15 @@ impl<W: Write+io::Seek> ZipWriter<W>
             files: Vec::new(),
             stats: Default::default(),
             writing_to_file: false,
+            comment: "zip-rs".into(),
         }
     }
 
+    /// Set ZIP archive comment. Defaults to 'zip-rs' if not set.
+    pub fn set_comment<S>(&mut self, comment: S) where S: Into<String> {
+        self.comment = comment.into();
+    }
+
     /// Start a new file for with the requested options.
     fn start_entry<S>(&mut self, name: S, options: FileOptions) -> ZipResult<()>
         where S: Into<String>
@@ -333,7 +340,7 @@ impl<W: Write+io::Seek> ZipWriter<W>
                 number_of_files: self.files.len() as u16,
                 central_directory_size: central_size as u32,
                 central_directory_offset: central_start as u32,
-                zip_file_comment: b"zip-rs".to_vec(),
+                zip_file_comment: self.comment.as_bytes().to_vec(),
             };
 
             footer.write(writer)?;
@@ -564,9 +571,10 @@ mod test {
     #[test]
     fn write_empty_zip() {
         let mut writer = ZipWriter::new(io::Cursor::new(Vec::new()));
+        writer.set_comment("ZIP");
         let result = writer.finish().unwrap();
-        assert_eq!(result.get_ref().len(), 28);
-        assert_eq!(*result.get_ref(), [80, 75, 5, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0, 122, 105, 112, 45, 114, 115]);
+        assert_eq!(result.get_ref().len(), 25);
+        assert_eq!(*result.get_ref(), [80, 75, 5, 6, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 90, 73, 80]);
     }
 
     #[test]