zip_container.h

Go to the documentation of this file.

/* * NRP Core - Backend infrastructure to synchronize simulations
 *
 * Copyright 2020-2023 NRP Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This project has received funding from the European Union’s Horizon 2020
 * Framework Programme for Research and Innovation under the Specific Grant
 * Agreement No. 945539 (Human Brain Project SGA3).
 */
 
#ifndef ZIP_CONTAINER_H
#define ZIP_CONTAINER_H
 
#include <filesystem>
#include <string>
#include <vector>
#include <zip.h>
 
class ZipContainer
{
        struct ZipErrorT : public zip_error_t
        {
            ZipErrorT();
 
            ZipErrorT(int ze);
 
            ~ZipErrorT();
        };
 
        struct ZipFileWrapper
        {
            ZipFileWrapper(zip_file_t *zFile);
            ~ZipFileWrapper();
 
            operator zip_file_t*();
 
            private:
                zip_file_t *_zFile = nullptr;
        };
 
        static constexpr zip_uint64_t BuffCopySize = 1024;
 
    public:
        ZipContainer(std::string &&data);
 
        ZipContainer(std::vector<uint8_t> &&data);
 
        ZipContainer(const std::string &path, bool readOnly, bool saveOnDestruct);
 
        ~ZipContainer() noexcept;
 
        static ZipContainer compressPath(const std::filesystem::path &path, bool keepRelDirStruct = false);
 
        std::vector<uint8_t> getCompressedData() const;
 
        void extractZipFiles(std::string path) const;
 
        void saveToDestination(const std::string &dest) const;
 
    private:
        zip_t *_data;
 
        bool _saveOnDesctruct = false;
 
        static zip_t *createZip(const void *data, zip_uint64_t length);
 
        static zip_t *openZipArchive(const std::string &path, bool readOnly);
 
        static void addZipToZip(zip_t *dest, zip_t *src);
 
        ZipContainer(zip_t *data, bool saveOnDestruct);
};
 
#endif // ZIP_CONTAINER_H