qgsexternalstorage.h

Go to the documentation of this file.

/***************************************************************************
  qgsexternalstorage.h
  --------------------------------------
  Date                 : March 2021
  Copyright            : (C) 2021 by Julien Cabieces
  Email                : julien dot cabieces at oslandia dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSEXTERNALSTORAGE_H
#define QGSEXTERNALSTORAGE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QString>
 
class QgsExternalStorageFetchedContent;
class QgsExternalStorageStoredContent;

class CORE_EXPORT QgsExternalStorage
{
  public:
 
    virtual ~QgsExternalStorage() = default;

    virtual QString type() const = 0;

    virtual QString displayName() const = 0;

    QgsExternalStorageStoredContent *store( const QString &filePath, const QString &url, const QString &authCfg = QString(), Qgis::ActionStart storingMode = Qgis::ActionStart::Deferred ) const SIP_FACTORY;

    QgsExternalStorageFetchedContent *fetch( const QString &url, const QString &authCfg = QString(), Qgis::ActionStart fetchingMode = Qgis::ActionStart::Deferred ) const SIP_FACTORY;
 
  protected:

    virtual QgsExternalStorageStoredContent *doStore( const QString &filePath, const QString &url, const QString &authCfg = QString() ) const = 0 SIP_FACTORY;

    virtual QgsExternalStorageFetchedContent *doFetch( const QString &url, const QString &authCfg = QString() ) const = 0 SIP_FACTORY;
};

class CORE_EXPORT QgsExternalStorageContent : public QObject
{
    Q_OBJECT
 
  public:

    Qgis::ContentStatus status() const;

    const QString &errorString() const;
 
  public slots:

    virtual void cancel() {};
 
  signals:

    void errorOccurred( const QString &errorString );

    void progressChanged( double progress );

    void canceled();
 
  protected:

    void reportError( const QString &errorMsg );

    void setStatus( Qgis::ContentStatus status );
 
    QString mErrorString;
 
 
  private:
 
    Qgis::ContentStatus mStatus = Qgis::ContentStatus::NotStarted;
};

class CORE_EXPORT QgsExternalStorageFetchedContent : public QgsExternalStorageContent
{
    Q_OBJECT
 
  public:

    virtual QString filePath() const = 0;

    virtual void fetch() = 0;
 
  signals:

    void fetched();
};

class CORE_EXPORT QgsExternalStorageStoredContent : public QgsExternalStorageContent
{
    Q_OBJECT
 
  public:

    virtual QString url() const = 0;

    virtual void store() = 0;
 
  signals:

    void stored();
};
 
#endif // QGSEXTERNALSTORAGE_H