cprover
mz_zip_archive.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: mz_zip library wrapper
4 
5 Author: Diffblue Ltd
6 
7 \*******************************************************************/
8 
9 #include "mz_zip_archive.h"
10 #include <stdexcept>
11 #include <string>
12 #include <vector>
13 #include <algorithm>
14 #define _LARGEFILE64_SOURCE 1
15 #include <miniz/miniz.h>
16 
17 // Original struct is an anonymous struct with a typedef, This is
18 // required to remove internals from the header file
20 {
21 public:
22  explicit mz_zip_archive_statet(const std::string &filename):
23  mz_zip_archive({ })
24  {
25  if(MZ_TRUE!=mz_zip_reader_init_file(this, filename.data(), 0))
26  throw std::runtime_error("MZT: Could not load a file: "+filename);
27  }
28 
29  mz_zip_archive_statet(const void *data, size_t size):
30  mz_zip_archive({ })
31  {
32  if(MZ_TRUE!=mz_zip_reader_init_mem(this, data, size, 0))
33  throw std::runtime_error("MZT: Could not load data from memory");
34  }
35 
41  {
42  mz_zip_reader_end(this);
43  }
44 };
45 
46 static_assert(sizeof(mz_uint)<=sizeof(size_t),
47  "size_t cannot store mz_zip file ids, choose a larger type");
48 
49 mz_zip_archivet::mz_zip_archivet(const std::string &filename):
50  m_state(new mz_zip_archive_statet(filename)) { }
51 
52 mz_zip_archivet::mz_zip_archivet(const void *data, size_t size):
53  m_state(new mz_zip_archive_statet(data, size)) { }
54 
55 // VS Compatibility
57  m_state(std::move(other.m_state)) { }
58 
59 // Has to be defined here because header is incomplete
61 
62 // VS Compatibility
64 {
65  m_state=std::move(other.m_state);
66  return *this;
67 }
68 
70 {
72 }
73 
74 std::string mz_zip_archivet::get_filename(const size_t index)
75 {
76  const auto id = static_cast<mz_uint>(index);
77  mz_uint name_size = mz_zip_reader_get_filename(m_state.get(), id, nullptr, 0);
78  if(name_size == 0)
79  return {}; // Failure
80  // It is valid to directly write to a string's buffer (see C++11 standard,
81  // basic_string general requirements [string.require], 21.4.1.5)
82  std::string buffer(name_size, '\0');
83  mz_zip_reader_get_filename(m_state.get(), id, &buffer[0], buffer.size());
84  // Buffer contains trailing \0
85  buffer.resize(name_size - 1);
86  return buffer;
87 }
88 
89 std::string mz_zip_archivet::extract(const size_t index)
90 {
91  const auto id=static_cast<mz_uint>(index);
92  mz_zip_archive_file_stat file_stat={ };
93  const mz_bool stat_ok=mz_zip_reader_file_stat(m_state.get(), id, &file_stat);
94  if(stat_ok==MZ_TRUE)
95  {
96  // It is valid to directly write to a string's buffer (see C++11 standard,
97  // basic_string general requirements [string.require], 21.4.1.5)
98  std::string buffer(file_stat.m_uncomp_size, '\0');
99  const mz_bool read_ok = mz_zip_reader_extract_to_mem(
100  m_state.get(), id, &buffer[0], buffer.size(), 0);
101  if(read_ok == MZ_TRUE)
102  return buffer;
103  }
104  throw std::runtime_error("Could not extract the file");
105 }
106 
108  const size_t index,
109  const std::string &path)
110 {
111  const auto id = static_cast<mz_uint>(index);
112  if(
113  mz_zip_reader_extract_to_file(m_state.get(), id, path.c_str(), 0) !=
114  MZ_TRUE)
115  {
116  throw std::runtime_error("Could not extract the file");
117  }
118 }
mz_zip_reader_get_num_files
mz_uint mz_zip_reader_get_num_files(mz_zip_archive *pZip)
Definition: miniz.cpp:7133
mz_zip_archivet::~mz_zip_archivet
~mz_zip_archivet()
mz_zip_archive_statet::~mz_zip_archive_statet
~mz_zip_archive_statet()
Definition: mz_zip_archive.cpp:40
mz_zip_reader_init_mem
mz_bool mz_zip_reader_init_mem(mz_zip_archive *pZip, const void *pMem, size_t size, mz_uint flags)
Definition: miniz.cpp:3774
mz_zip_reader_end
mz_bool mz_zip_reader_end(mz_zip_archive *pZip)
Definition: miniz.cpp:3742
mz_zip_archive.h
mz_bool
bool mz_bool
Definition: miniz.h:541
mz_zip_archive_statet
Definition: mz_zip_archive.cpp:20
data
Definition: kdev_t.h:24
mz_zip_reader_get_filename
mz_uint mz_zip_reader_get_filename(mz_zip_archive *pZip, mz_uint file_index, char *pFilename, mz_uint filename_buf_size)
Definition: miniz.cpp:7167
mz_zip_archive_statet::operator=
mz_zip_archive_statet & operator=(mz_zip_archive_statet &&)=delete
mz_zip_archive
Definition: miniz.h:1104
mz_zip_reader_extract_to_file
mz_bool mz_zip_reader_extract_to_file(mz_zip_archive *pZip, mz_uint file_index, const char *pDst_filename, mz_uint flags)
Definition: miniz.cpp:4695
mz_zip_archivet::mz_zip_archivet
mz_zip_archivet(const std::string &filename)
Open a zip archive.
Definition: mz_zip_archive.cpp:49
mz_zip_archive_statet::mz_zip_archive_statet
mz_zip_archive_statet(const void *data, size_t size)
Definition: mz_zip_archive.cpp:29
mz_uint
unsigned int mz_uint
Definition: miniz.h:538
mz_zip_archivet::extract
std::string extract(size_t index)
Get contents of nth file in the archive.
Definition: mz_zip_archive.cpp:89
mz_zip_reader_init_file
mz_bool mz_zip_reader_init_file(mz_zip_archive *pZip, const char *pFilename, mz_uint32 flags)
Definition: miniz.cpp:3821
mz_zip_archivet::operator=
mz_zip_archivet & operator=(const mz_zip_archivet &)=delete
mz_zip_archive_statet::mz_zip_archive_statet
mz_zip_archive_statet(const std::string &filename)
Definition: mz_zip_archive.cpp:22
mz_zip_archivet::get_num_files
size_t get_num_files()
Get number of files in the archive.
Definition: mz_zip_archive.cpp:69
miniz.h
mz_zip_archive_file_stat
Definition: miniz.h:972
mz_zip_archive_file_stat::m_uncomp_size
mz_uint64 m_uncomp_size
Definition: miniz.h:996
mz_zip_reader_extract_to_mem
mz_bool mz_zip_reader_extract_to_mem(mz_zip_archive *pZip, mz_uint file_index, void *pBuf, size_t buf_size, mz_uint flags)
Definition: miniz.cpp:4416
mz_zip_archive_statet::mz_zip_archive_statet
mz_zip_archive_statet(mz_zip_archive_statet &&)=delete
mz_zip_archive_statet::operator=
mz_zip_archive_statet & operator=(const mz_zip_archive_statet &)=delete
mz_zip_archive_statet::mz_zip_archive_statet
mz_zip_archive_statet(const mz_zip_archive_statet &)=delete
mz_zip_archivet::get_filename
std::string get_filename(size_t index)
Get file name of nth file in the archive.
Definition: mz_zip_archive.cpp:74
mz_zip_reader_file_stat
mz_bool mz_zip_reader_file_stat(mz_zip_archive *pZip, mz_uint file_index, mz_zip_archive_file_stat *pStat)
Definition: miniz.cpp:7188
mz_zip_archivet
Thin object-oriented wrapper around the MZ Zip library Zip file reader and extractor.
Definition: mz_zip_archive.h:21
mz_zip_archivet::extract_to_file
void extract_to_file(size_t index, const std::string &path)
Write contents of nth file in the archive to a file.
Definition: mz_zip_archive.cpp:107
MZ_TRUE
#define MZ_TRUE
Definition: miniz.h:544
mz_zip_archivet::m_state
std::unique_ptr< mz_zip_archive_statet > m_state
Definition: mz_zip_archive.h:61