xlnt/include/xlnt/packaging/zip_file.hpp

// Copyright (c) 2014-2015 Thomas Fussell
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file
#pragma once

#include <cstdint>
#include <iostream>
#include <memory>
#include <sstream>
#include <string>
#include <vector>

#include <xlnt/xlnt_config.hpp>

// Note: this comes from https://github.com/tfussell/miniz-cpp

struct mz_zip_archive_tag;

namespace xlnt {

/// <summary>
/// Information about a specific file in zip_file.
/// </summary>
struct XLNT_CLASS zip_info
{
    /// <summary>
    /// A struct representing a particular date and time.
    /// </summary>
    struct date_time_t
    {
        int year;
        int month;
        int day;
        int hours;
        int minutes;
        int seconds;
    };

    /// <summary>
    /// Default constructor for zip_info.
    /// </summary>
    zip_info();

    date_time_t date_time;
    std::string filename;
    std::string comment;
    std::string extra;
    uint16_t create_system;
    uint16_t create_version;
    uint16_t extract_version;
    uint16_t flag_bits;
    std::size_t volume;
    uint32_t internal_attr;
    uint32_t external_attr;
    std::size_t header_offset;
    uint32_t crc;
    std::size_t compress_size;
    std::size_t file_size;
};

/// <summary>
/// A compressed archive file that exists in memory which can read
/// or write to and from the filesystem, std::iostreams, and byte vectors.
/// </summary>
class XLNT_CLASS zip_file
{
  public:
    zip_file();
    zip_file(const std::string &filename);
    zip_file(const std::vector<unsigned char> &bytes);
    zip_file(std::istream &stream);
    ~zip_file();

    // to/from file
    void load(const std::string &filename);
    void save(const std::string &filename);

    // to/from byte vector
    void load(const std::vector<unsigned char> &bytes);
    void save(std::vector<unsigned char> &bytes);

    // to/from iostream
    void load(std::istream &stream);
    void save(std::ostream &stream);

    void reset();

    bool has_file(const std::string &name);
    bool has_file(const zip_info &name);

    zip_info getinfo(const std::string &name);

    std::vector<zip_info> infolist();
    std::vector<std::string> namelist();

    std::ostream &open(const std::string &name);
    std::ostream &open(const zip_info &name);

    void extract(const std::string &name);
    void extract(const std::string &name, const std::string &path);
    void extract(const zip_info &name);
    void extract(const zip_info &name, const std::string &path);

    void extractall();
    void extractall(const std::string &path);
    void extractall(const std::string &path, const std::vector<std::string> &members);
    void extractall(const std::string &path, const std::vector<zip_info> &members);

    void printdir();
    void printdir(std::ostream &stream);

    std::string read(const std::string &name);
    std::string read(const zip_info &name);

    std::pair<bool, std::string> testzip();

    void write(const std::string &filename);
    void write(const std::string &filename, const std::string &arcname);

    void writestr(const std::string &arcname, const std::string &bytes);
    void writestr(const zip_info &arcname, const std::string &bytes);

    std::string get_filename() const
    {
        return filename_;
    }

    std::string comment;

  private:
    void start_read();
    void start_write();

    void append_comment();
    void remove_comment();

    zip_info getinfo(int index);

    std::unique_ptr<mz_zip_archive_tag> archive_;
    std::vector<char> buffer_;
    std::stringstream open_stream_;
    std::string filename_;
};

} // namespace xlnt