qgsnetworkcontentfetcherregistry.h

Go to the documentation of this file.

/***************************************************************************
                       qgsnetworkcontentfetcherregistry.h
                             -------------------
    begin                : April, 2018
    copyright            : (C) 2018 by Denis Rouzaud
    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 QGSNETWORKCONTENTFETCHERREGISTRY_H
#define QGSNETWORKCONTENTFETCHERREGISTRY_H

#include <QObject>
#include <QMap>
#include <QMutex>
#include <QNetworkReply>

#include "qgis_core.h"
#include "qgstaskmanager.h"
#include "qgsnetworkcontentfetchertask.h"

class QTemporaryFile;

class CORE_EXPORT QgsFetchedContent : public QObject
{
    Q_OBJECT
  public:
    enum ContentStatus
    {
      NotStarted, 
      Downloading, 
      Finished, 
      Failed 
    };

    explicit QgsFetchedContent( const QString &url, QTemporaryFile *file = nullptr, ContentStatus status = NotStarted )
      : mUrl( url )
      , mFile( file )
      , mStatus( status )
    {}

    ~QgsFetchedContent() override
    {
      if ( mFile )
        mFile->close();
      delete mFile;
    }


#ifndef SIP_RUN
    QFile *file() const {return mFile;}
#endif

    const QString filePath() const {return mFilePath;}

    ContentStatus status() const {return mStatus;}

    QNetworkReply::NetworkError error() const {return mError;}

  public slots:

    void download( bool redownload = false );

    void cancel();

  signals:
    void fetched();

  private slots:
    void taskCompleted();

  private:
    QString mUrl;
    QTemporaryFile *mFile = nullptr;
    QString mFilePath;
    QgsNetworkContentFetcherTask *mFetchingTask = nullptr;
    ContentStatus mStatus = NotStarted;
    QNetworkReply::NetworkError mError = QNetworkReply::NoError;
};

class CORE_EXPORT QgsNetworkContentFetcherRegistry : public QObject
{
    Q_OBJECT
  public:
    enum FetchingMode
    {
      DownloadLater,       
      DownloadImmediately, 
    };
    Q_ENUM( FetchingMode )

    
    explicit QgsNetworkContentFetcherRegistry() = default;

    ~QgsNetworkContentFetcherRegistry() override;

    const QgsFetchedContent *fetch( const QString &url, FetchingMode fetchingMode = DownloadLater );

#ifndef SIP_RUN

    QFile *localFile( const QString &filePathOrUrl );
#endif

    QString localPath( const QString &filePathOrUrl );

  private:
    QMap<QString, QgsFetchedContent *> mFileRegistry;

};

#endif // QGSNETWORKCONTENTFETCHERREGISTRY_H