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 "qgis_core.h"
#include "qgshttpheaders.h"
#include "qgsnetworkcontentfetchertask.h"
#include "qgstaskmanager.h"
 
#include <QFile>
#include <QMap>
#include <QMutex>
#include <QNetworkReply>
#include <QObject>
#include <QPointer>
#include <QTemporaryFile>

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

    explicit QgsFetchedContent( const QString &url, QTemporaryFile *file SIP_TRANSFER = nullptr, ContentStatus status = NotStarted,
                                const QString &authConfig = QString(), const QgsHttpHeaders &headers = QgsHttpHeaders() )
      : mUrl( url )
      , mFile( file )
      , mStatus( status )
      , mAuthConfig( authConfig )
      , mHeaders( headers )
    {}
 
    ~QgsFetchedContent() override
    {
      if ( mFile )
        mFile->close();
 
    }
 
 
#ifndef SIP_RUN
    QFile *file() const {return mFile.get();}
#endif

    const QString filePath() const {return mFilePath;}

    ContentStatus status() const {return mStatus;}

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

    QString authConfig() const {return mAuthConfig;}
 
  public slots:

    void download( bool redownload = false );

    void cancel();
 
  signals:
    void fetched();

    void errorOccurred( QNetworkReply::NetworkError code, const QString &errorMsg );
 
  private slots:
    void taskCompleted();
 
  private:
    QString mUrl;
    std::unique_ptr<QTemporaryFile> mFile;
    QString mFilePath;
    QPointer< QgsNetworkContentFetcherTask > mFetchingTask;
    ContentStatus mStatus = NotStarted;
    QNetworkReply::NetworkError mError = QNetworkReply::NoError;
    QString mAuthConfig;
    QString mErrorString;
    QgsHttpHeaders mHeaders;
};

class CORE_EXPORT QgsNetworkContentFetcherRegistry : public QObject
{
    Q_OBJECT
  public:

    explicit QgsNetworkContentFetcherRegistry() = default;
 
    ~QgsNetworkContentFetcherRegistry() override;

    QgsFetchedContent *fetch( const QString &url, Qgis::ActionStart fetchingMode = Qgis::ActionStart::Deferred, const QString &authConfig = QString(), const QgsHttpHeaders &headers = QgsHttpHeaders() );
 
#ifndef SIP_RUN

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

    QString localPath( const QString &filePathOrUrl );
 
  private:
    QMap<QString, QgsFetchedContent *> mFileRegistry;
 
};
 
#endif // QGSNETWORKCONTENTFETCHERREGISTRY_H