Orthanc/OrthancFramework/Sources/Compression/HierarchicalZipWriter.h
2025-06-23 19:07:37 +05:30

128 lines
3.1 KiB
C++

/**
* Orthanc - A Lightweight, RESTful DICOM Store
* Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
* Department, University Hospital of Liege, Belgium
* Copyright (C) 2017-2023 Osimis S.A., Belgium
* Copyright (C) 2024-2025 Orthanc Team SRL, Belgium
* Copyright (C) 2021-2025 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
**/
#pragma once
#include "ZipWriter.h"
#include <map>
#include <list>
#include <boost/lexical_cast.hpp>
#if ORTHANC_BUILD_UNIT_TESTS == 1
# include <gtest/gtest_prod.h>
#endif
namespace Orthanc
{
class ORTHANC_PUBLIC HierarchicalZipWriter : public boost::noncopyable
{
#if ORTHANC_BUILD_UNIT_TESTS == 1
FRIEND_TEST(HierarchicalZipWriter, Index);
FRIEND_TEST(HierarchicalZipWriter, Filenames);
#endif
private:
class ORTHANC_PUBLIC Index
{
private:
struct Directory
{
typedef std::map<std::string, unsigned int> Content;
std::string name_;
Content content_;
};
typedef std::list<Directory*> Stack;
Stack stack_;
std::string EnsureUniqueFilename(const char* filename);
public:
Index();
~Index();
bool IsRoot() const;
std::string OpenFile(const char* name);
void OpenDirectory(const char* name);
void CloseDirectory();
std::string GetCurrentDirectoryPath() const;
static std::string KeepAlphanumeric(const std::string& source);
};
Index indexer_;
ZipWriter writer_;
public:
explicit HierarchicalZipWriter(const char* path);
HierarchicalZipWriter(ZipWriter::IOutputStream* stream, // transfers ownership
bool isZip64);
~HierarchicalZipWriter();
void SetZip64(bool isZip64);
bool IsZip64() const;
void SetCompressionLevel(uint8_t level);
uint8_t GetCompressionLevel() const;
void SetAppendToExisting(bool append);
bool IsAppendToExisting() const;
void OpenFile(const char* name);
void OpenDirectory(const char* name);
void CloseDirectory();
std::string GetCurrentDirectoryPath() const;
void Write(const void* data, size_t length);
void Write(const std::string& data);
// The lifetime of the "target" buffer must be larger than that of HierarchicalZipWriter
static HierarchicalZipWriter* CreateToMemory(std::string& target,
bool isZip64);
void CancelStream();
void Close();
uint64_t GetArchiveSize() const;
};
}