//! Structs for creating a new zip archive use compression::CompressionMethod; use types::ZipFileData; use spec; use crc32; use result::{ZipResult, ZipError}; use std::default::Default; use std::io; use std::io::prelude::*; use std::mem; use std::ascii::AsciiExt; use time; use flate2; use flate2::FlateWriteExt; use flate2::write::DeflateEncoder; use bzip2; use bzip2::writer::BzCompressor; use util; use podio::{WritePodExt, LittleEndian}; enum GenericZipWriter { Closed, Storer(W), Deflater(DeflateEncoder), Bzip2(BzCompressor), } /// Generator for ZIP files. /// /// ``` /// fn doit() -> zip::result::ZipResult<()> /// { /// use std::io::Write; /// /// // For this example we write to a buffer, but normally you should use a File /// let mut buf: &mut [u8] = &mut [0u8; 65536]; /// let mut w = std::io::Cursor::new(buf); /// let mut zip = zip::ZipWriter::new(w); /// /// try!(zip.start_file("hello_world.txt", zip::CompressionMethod::Stored)); /// try!(zip.write(b"Hello, World!")); /// /// // Optionally finish the zip. (this is also done on drop) /// try!(zip.finish()); /// /// Ok(()) /// } /// /// println!("Result: {:?}", doit()); /// ``` pub struct ZipWriter { inner: GenericZipWriter, files: Vec, stats: ZipWriterStats, } #[derive(Default)] struct ZipWriterStats { crc32: u32, start: u64, bytes_written: u64, } impl Write for ZipWriter { fn write(&mut self, buf: &[u8]) -> io::Result { if self.files.len() == 0 { return Err(io::Error::new(io::ErrorKind::Other, "No file has been started")) } self.stats.update(buf); match self.inner.ref_mut() { Some(ref mut w) => w.write(buf), None => Err(io::Error::new(io::ErrorKind::BrokenPipe, "ZipWriter was already closed")), } } fn flush(&mut self) -> io::Result<()> { match self.inner.ref_mut() { Some(ref mut w) => w.flush(), None => Err(io::Error::new(io::ErrorKind::BrokenPipe, "ZipWriter was already closed")), } } } impl ZipWriterStats { fn update(&mut self, buf: &[u8]) { self.crc32 = crc32::update(self.crc32, buf); self.bytes_written += buf.len() as u64; } } impl ZipWriter { /// Initializes the ZipWriter. /// /// Before writing to this object, the start_file command should be called. pub fn new(inner: W) -> ZipWriter { ZipWriter { inner: GenericZipWriter::Storer(inner), files: Vec::new(), stats: Default::default(), } } /// Start a new file for with the requested compression method. pub fn start_file(&mut self, name: &str, compression: CompressionMethod) -> ZipResult<()> { try!(self.finish_file()); { let writer = self.inner.get_plain(); let header_start = try!(writer.seek(io::SeekFrom::Current(0))); let mut file = ZipFileData { encrypted: false, compression_method: compression, last_modified_time: time::now(), crc32: 0, compressed_size: 0, uncompressed_size: 0, file_name: name.to_string(), file_comment: String::new(), header_start: header_start, data_start: 0, }; try!(write_local_file_header(writer, &file)); let header_end = try!(writer.seek(io::SeekFrom::Current(0))); self.stats.start = header_end; file.data_start = header_end; self.stats.bytes_written = 0; self.stats.crc32 = 0; self.files.push(file); } try!(self.inner.switch_to(compression)); Ok(()) } fn finish_file(&mut self) -> ZipResult<()> { try!(self.inner.switch_to(CompressionMethod::Stored)); let writer = self.inner.get_plain(); let file = match self.files.last_mut() { None => return Ok(()), Some(f) => f, }; file.crc32 = self.stats.crc32; file.uncompressed_size = self.stats.bytes_written; file.compressed_size = try!(writer.seek(io::SeekFrom::Current(0))) - self.stats.start; try!(update_local_file_header(writer, file)); try!(writer.seek(io::SeekFrom::End(0))); Ok(()) } /// Finish the last file and write all other zip-structures /// /// This will return the writer, but one should normally not append any data to the end of the file. /// Note that the zipfile will also be finished on drop. pub fn finish(mut self) -> ZipResult { try!(self.finalize()); let inner = mem::replace(&mut self.inner, GenericZipWriter::Closed); Ok(inner.unwrap()) } fn finalize(&mut self) -> ZipResult<()> { try!(self.finish_file()); { let writer = self.inner.get_plain(); let central_start = try!(writer.seek(io::SeekFrom::Current(0))); for file in self.files.iter() { try!(write_central_directory_header(writer, file)); } let central_size = try!(writer.seek(io::SeekFrom::Current(0))) - central_start; let footer = spec::CentralDirectoryEnd { disk_number: 0, disk_with_central_directory: 0, number_of_files_on_this_disk: self.files.len() as u16, 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(), }; try!(footer.write(writer)); } Ok(()) } } #[unsafe_destructor] impl Drop for ZipWriter { fn drop(&mut self) { if !self.inner.is_closed() { if let Err(e) = self.finalize() { let _ = write!(&mut io::stderr(), "ZipWriter drop failed: {:?}", e); } } } } impl GenericZipWriter { fn switch_to(&mut self, compression: CompressionMethod) -> ZipResult<()> { match self.current_compression() { Some(method) if method == compression => return Ok(()), None => try!(Err(io::Error::new(io::ErrorKind::BrokenPipe, "ZipWriter was already closed"))), _ => {}, } let bare = match mem::replace(self, GenericZipWriter::Closed) { GenericZipWriter::Storer(w) => w, GenericZipWriter::Deflater(w) => try!(w.finish()), GenericZipWriter::Bzip2(w) => match w.into_inner() { Ok(r) => r, Err((_, err)) => try!(Err(err)) }, GenericZipWriter::Closed => try!(Err(io::Error::new(io::ErrorKind::BrokenPipe, "ZipWriter was already closed"))), }; *self = match compression { CompressionMethod::Stored => GenericZipWriter::Storer(bare), CompressionMethod::Deflated => GenericZipWriter::Deflater(bare.deflate_encode(flate2::Compression::Default)), CompressionMethod::Bzip2 => GenericZipWriter::Bzip2(BzCompressor::new(bare, bzip2::Compress::Default)), CompressionMethod::Unsupported(..) => return Err(ZipError::UnsupportedArchive("Unsupported compression")), }; Ok(()) } fn ref_mut(&mut self) -> Option<&mut Write> { match *self { GenericZipWriter::Storer(ref mut w) => Some(w as &mut Write), GenericZipWriter::Deflater(ref mut w) => Some(w as &mut Write), GenericZipWriter::Bzip2(ref mut w) => Some(w as &mut Write), GenericZipWriter::Closed => None, } } fn is_closed(&self) -> bool { match *self { GenericZipWriter::Closed => true, _ => false, } } fn get_plain(&mut self) -> &mut W { match *self { GenericZipWriter::Storer(ref mut w) => w, _ => panic!("Should have switched to stored beforehand"), } } fn current_compression(&self) -> Option { match *self { GenericZipWriter::Storer(..) => Some(CompressionMethod::Stored), GenericZipWriter::Deflater(..) => Some(CompressionMethod::Deflated), GenericZipWriter::Bzip2(..) => Some(CompressionMethod::Bzip2), GenericZipWriter::Closed => None, } } fn unwrap(self) -> W { match self { GenericZipWriter::Storer(w) => w, _ => panic!("Should have switched to stored beforehand"), } } } fn write_local_file_header(writer: &mut T, file: &ZipFileData) -> ZipResult<()> { try!(writer.write_u32::(spec::LOCAL_FILE_HEADER_SIGNATURE)); try!(writer.write_u16::(20)); let flag = if !file.file_name.is_ascii() { 1u16 << 11 } else { 0 }; try!(writer.write_u16::(flag)); try!(writer.write_u16::(file.compression_method.to_u16())); try!(writer.write_u16::(util::tm_to_msdos_time(file.last_modified_time))); try!(writer.write_u16::(util::tm_to_msdos_date(file.last_modified_time))); try!(writer.write_u32::(file.crc32)); try!(writer.write_u32::(file.compressed_size as u32)); try!(writer.write_u32::(file.uncompressed_size as u32)); try!(writer.write_u16::(file.file_name.as_bytes().len() as u16)); let extra_field = try!(build_extra_field(file)); try!(writer.write_u16::(extra_field.len() as u16)); try!(writer.write_all(file.file_name.as_bytes())); try!(writer.write_all(&extra_field)); Ok(()) } fn update_local_file_header(writer: &mut T, file: &ZipFileData) -> ZipResult<()> { static CRC32_OFFSET : u64 = 14; try!(writer.seek(io::SeekFrom::Start(file.header_start + CRC32_OFFSET))); try!(writer.write_u32::(file.crc32)); try!(writer.write_u32::(file.compressed_size as u32)); try!(writer.write_u32::(file.uncompressed_size as u32)); Ok(()) } fn write_central_directory_header(writer: &mut T, file: &ZipFileData) -> ZipResult<()> { try!(writer.write_u32::(spec::CENTRAL_DIRECTORY_HEADER_SIGNATURE)); try!(writer.write_u16::(0x14FF)); try!(writer.write_u16::(20)); let flag = if !file.file_name.is_ascii() { 1u16 << 11 } else { 0 }; try!(writer.write_u16::(flag)); try!(writer.write_u16::(file.compression_method.to_u16())); try!(writer.write_u16::(util::tm_to_msdos_time(file.last_modified_time))); try!(writer.write_u16::(util::tm_to_msdos_date(file.last_modified_time))); try!(writer.write_u32::(file.crc32)); try!(writer.write_u32::(file.compressed_size as u32)); try!(writer.write_u32::(file.uncompressed_size as u32)); try!(writer.write_u16::(file.file_name.as_bytes().len() as u16)); let extra_field = try!(build_extra_field(file)); try!(writer.write_u16::(extra_field.len() as u16)); try!(writer.write_u16::(0)); try!(writer.write_u16::(0)); try!(writer.write_u16::(0)); try!(writer.write_u32::(0)); try!(writer.write_u32::(file.header_start as u32)); try!(writer.write_all(file.file_name.as_bytes())); try!(writer.write_all(&extra_field)); Ok(()) } fn build_extra_field(_file: &ZipFileData) -> ZipResult> { let writer = Vec::new(); // Future work Ok(writer) }