ZipArchiveFile.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Justin Sing $
// $Authors: Justin Sing $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <OpenMS/SYSTEM/File.h>
#include <OpenMS/SYSTEM/TempFiles.h>
 
#include <memory>
#include <string>
#include <vector>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI ZipArchiveFile
  {
  public:
    static void zipDirectory(const std::string& directory_path, const std::string& output_zip);
 
    static std::string unzipDirectory(const std::string& input_path, std::unique_ptr<TempDir>& temp_dir);
 
    static void addOrReplaceFromFile(const std::string& archive_path, const std::string& entry_name, const std::string& source_file_path);
 
    static std::vector<std::string> listEntries(const std::string& archive_path);
 
    static bool listEntries(const std::string& archive_path, std::vector<std::string>& entries);
 
    static void writeSidecarIndex(const std::string& archive_path);
 
    static std::string extractEntryToTempFile(const std::string& archive_path, const std::string& entry_name, std::unique_ptr<TempDir>& temp_dir);
 
    static std::string findSingleEntry(const std::string& archive_path, const std::string& extension);
 
  };
 
} // namespace OpenMS