File indexing completed on 2024-04-21 14:53:22

 /* This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2002 Holger Schroeder <holger-kde@holgis.net>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
 */
 #ifndef KZIP_H
 #define KZIP_H
 
 #include <karchive.h>
 
 #include "kzipfileentry.h" // for source compat
 
 class KZipFileEntry;
 /**
  *   @class KZip zip.h KZip
  *
  *   A class for reading / writing zip archives.
  *
  *   You can use it in QIODevice::ReadOnly or in QIODevice::WriteOnly mode, and it
  *   behaves just as expected.
  *   It can also be used in QIODevice::ReadWrite mode, in this case one can
  *   append files to an existing zip archive. When you append new files, which
  *   are not yet in the zip, it works as expected, i.e. the files are appended at the end.
  *   When you append a file, which is already in the file, the reference to the
  *   old file is dropped and the new one is added to the zip - but the
  *   old data from the file itself is not deleted, it is still in the
  *   zipfile. So when you want to have a small and garbage-free zipfile,
  *   just read the contents of the appended zip file and write it to a new one
  *   in QIODevice::WriteOnly mode. This is especially important when you don't want
  *   to leak information of how intermediate versions of files in the zip
  *   were looking.
  *
  *   For more information on the zip fileformat go to
  *   http://www.pkware.com/products/enterprise/white_papers/appnote.html
  * @author Holger Schroeder <holger-kde@holgis.net>
  */
 class KARCHIVE_EXPORT KZip : public KArchive
 {
     Q_DECLARE_TR_FUNCTIONS(KZip)
 
 public:
     /**
      * Creates an instance that operates on the given filename.
      * using the compression filter associated to given mimetype.
      *
      * @param filename is a local path (e.g. "/home/holger/myfile.zip")
      */
     KZip(const QString &filename);
 
     /**
      * Creates an instance that operates on the given device.
      * The device can be compressed (KCompressionDevice) or not (QFile, etc.).
      * @warning Do not assume that giving a QFile here will decompress the file,
      * in case it's compressed!
      * @param dev the device to access
      */
     KZip(QIODevice *dev);
 
     /**
      * If the zip file is still opened, then it will be
      * closed automatically by the destructor.
      */
     ~KZip() override;
 
     /**
      * Describes the contents of the "extra field" for a given file in the Zip archive.
      */
     enum ExtraField {
         NoExtraField = 0, ///< No extra field
         ModificationTime = 1, ///< Modification time ("extended timestamp" header)
         DefaultExtraField = 1, // alias of ModificationTime
     };
 
     /**
      * Call this before writeFile or prepareWriting, to define what the next
      * file to be written should have in its extra field.
      * @param ef the type of "extra field"
      * @see extraField()
      */
     void setExtraField(ExtraField ef);
 
     /**
      * The current type of "extra field" that will be used for new files.
      * @return the current type of "extra field"
      * @see setExtraField()
      */
     ExtraField extraField() const;
 
     /**
      * Describes the compression type for a given file in the Zip archive.
      */
     enum Compression {
         NoCompression = 0, ///< Uncompressed.
         DeflateCompression = 1, ///< Deflate compression method.
     };
 
     /**
      * Call this before writeFile or prepareWriting, to define whether the next
      * files to be written should be compressed or not.
      * @param c the new compression mode
      * @see compression()
      */
     void setCompression(Compression c);
 
     /**
      * The current compression mode that will be used for new files.
      * @return the current compression mode
      * @see setCompression()
      */
     Compression compression() const;
 
     /**
      * Write data to a file that has been created using prepareWriting().
      * @param data a pointer to the data
      * @param size the size of the chunk
      * @return true if successful, false otherwise
      */
     bool writeData(const char *data, qint64 size) override;
 
 protected:
     /// Reimplemented from KArchive
     bool doWriteSymLink(const QString &name,
                         const QString &target,
                         const QString &user,
                         const QString &group,
                         mode_t perm,
                         const QDateTime &atime,
                         const QDateTime &mtime,
                         const QDateTime &ctime) override;
     /// Reimplemented from KArchive
     bool doPrepareWriting(const QString &name,
                           const QString &user,
                           const QString &group,
                           qint64 size,
                           mode_t perm,
                           const QDateTime &atime,
                           const QDateTime &mtime,
                           const QDateTime &creationTime) override;
 
     /**
      * Write data to a file that has been created using prepareWriting().
      * @param size the size of the file
      * @return true if successful, false otherwise
      */
     bool doFinishWriting(qint64 size) override;
 
     /**
      * Opens the archive for reading.
      * Parses the directory listing of the archive
      * and creates the KArchiveDirectory/KArchiveFile entries.
      * @param mode the mode of the file
      */
     bool openArchive(QIODevice::OpenMode mode) override;
 
     /// Closes the archive
     bool closeArchive() override;
 
     /// Reimplemented from KArchive
     bool doWriteDir(const QString &name,
                     const QString &user,
                     const QString &group,
                     mode_t perm,
                     const QDateTime &atime,
                     const QDateTime &mtime,
                     const QDateTime &ctime) override;
 
 protected:
     void virtual_hook(int id, void *data) override;
 
 private:
     class KZipPrivate;
     KZipPrivate *const d;
 };
 
 #endif