qgsarchive.h

Go to the documentation of this file.

/***************************************************************************
                            qgsarchive.h
                          ----------------

    begin                : July 07, 2017
    copyright            : (C) 2017 by Paul Blottiere
    email                : [email protected]
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSARCHIVE_H
#define QGSARCHIVE_H

#include "qgis_core.h"
#include <QStringList>
#include <QTemporaryFile>
#include <QTemporaryDir>
#include <memory>

class CORE_EXPORT QgsArchive
{
  public:

    QgsArchive();

    QgsArchive( const QgsArchive &other );

    QgsArchive &operator=( const QgsArchive &other );

    virtual ~QgsArchive() = default;

    bool zip( const QString &zipFilename );

    virtual bool unzip( const QString &zipFilename );

    void clear();

    void addFile( const QString &filename );

    bool removeFile( const QString &filename );

    QStringList files() const;

    QString dir() const;

  private:
    // content of the archive
    QStringList mFiles;

    // used when unzip is performed
    std::unique_ptr<QTemporaryDir> mDir;
};

class  CORE_EXPORT QgsProjectArchive : public QgsArchive
{
  public:

    bool unzip( const QString &zipFilename ) override;

    QString projectFile() const;

    bool clearProjectFile();

    QString auxiliaryStorageFile() const;
};

#endif