juce_ZipFile.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  ZipFile
{
public:
    explicit ZipFile (const File& file);
 
    //==============================================================================
    ZipFile (InputStream* inputStream, bool deleteStreamWhenDestroyed);

    explicit ZipFile (InputStream& inputStream);

    explicit ZipFile (InputSource* inputSource);

    ~ZipFile();
 
    //==============================================================================
    struct ZipEntry
    {
        String filename;

        int64 uncompressedSize;

        Time fileTime;

        bool isSymbolicLink;

        uint32 externalFileAttributes;
    };
 
    //==============================================================================
    int getNumEntries() const noexcept;

    const ZipEntry* getEntry (int index) const noexcept;

    int getIndexOfFileName (const String& fileName, bool ignoreCase = false) const noexcept;

    const ZipEntry* getEntry (const String& fileName, bool ignoreCase = false) const noexcept;

    void sortEntriesByFilename();
 
    //==============================================================================
    InputStream* createStreamForEntry (int index);

    InputStream* createStreamForEntry (const ZipEntry& entry);
 
    //==============================================================================
    Result uncompressTo (const File& targetDirectory,
                         bool shouldOverwriteFiles = true);

    Result uncompressEntry (int index,
                            const File& targetDirectory,
                            bool shouldOverwriteFiles = true);
 
    enum class OverwriteFiles { no, yes };
    enum class FollowSymlinks { no, yes };

    Result uncompressEntry (int index,
                            const File& targetDirectory,
                            OverwriteFiles overwriteFiles,
                            FollowSymlinks followSymlinks);
 
    //==============================================================================
    class JUCE_API  Builder
    {
    public:
        Builder();

        ~Builder();

        void addFile (const File& fileToAdd, int compressionLevel,
                      const String& storedPathName = String());

        void addEntry (InputStream* streamToRead, int compressionLevel,
                       const String& storedPathName, Time fileModificationTime);

        bool writeToStream (OutputStream& target, double* progress) const;
 
        //==============================================================================
    private:
        struct Item;
        OwnedArray<Item> items;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Builder)
    };
 
private:
    //==============================================================================
    struct ZipInputStream;
    struct ZipEntryHolder;
 
    OwnedArray<ZipEntryHolder> entries;
    CriticalSection lock;
    InputStream* inputStream = nullptr;
    std::unique_ptr<InputStream> streamToDelete;
    std::unique_ptr<InputSource> inputSource;
 
   #if JUCE_DEBUG
    struct OpenStreamCounter
    {
        OpenStreamCounter() = default;
        ~OpenStreamCounter();
 
        int numOpenStreams = 0;
    };
 
    OpenStreamCounter streamCounter;
   #endif
 
    void init();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ZipFile)
};
 
} // namespace juce