Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmfiledownloader.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : October 2017
       5                 :            :     copyright            : (C) 2017 by Etienne Trimaille
       6                 :            :     email                : etienne at kartoza dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSALGORITHMFILEDOWNLOADER_H
      19                 :            : #define QGSALGORITHMFILEDOWNLOADER_H
      20                 :            : 
      21                 :            : #define SIP_NO_FILE
      22                 :            : 
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgsprocessingalgorithm.h"
      25                 :            : 
      26                 :            : class QgsProcessingFeedback;
      27                 :            : 
      28                 :            : ///@cond PRIVATE
      29                 :            : 
      30                 :            : /**
      31                 :            :  * Native file downloader algorithm.
      32                 :            :  */
      33                 :            : class QgsFileDownloaderAlgorithm : public QObject, public QgsProcessingAlgorithm
      34                 :            : {
      35                 :          0 :     Q_OBJECT
      36                 :            : 
      37                 :            :   public:
      38                 :          0 :     QgsFileDownloaderAlgorithm() = default;
      39                 :            :     void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
      40                 :            :     QString name() const override;
      41                 :            :     QString displayName() const override;
      42                 :            :     QStringList tags() const override;
      43                 :            :     QString group() const override;
      44                 :            :     QString groupId() const override;
      45                 :            :     QString shortHelpString() const override;
      46                 :            :     QgsFileDownloaderAlgorithm *createInstance() const override SIP_FACTORY;
      47                 :            : 
      48                 :            :   protected:
      49                 :            : 
      50                 :            :     QVariantMap processAlgorithm( const QVariantMap &parameters,
      51                 :            :                                   QgsProcessingContext &context, QgsProcessingFeedback * ) override;
      52                 :            : 
      53                 :            :   private:
      54                 :            :     QString mTotal;
      55                 :            :     QString mReceived;
      56                 :          0 :     QgsProcessingFeedback *mFeedback = nullptr;
      57                 :            :     QString mLastReport;
      58                 :            :     void reportErrors( const QStringList &errors );
      59                 :            :     void receiveProgressFromDownloader( qint64 bytesReceived, qint64 bytesTotal );
      60                 :            :     void sendProgressFeedback();
      61                 :            : };
      62                 :            : 
      63                 :            : ///@endcond PRIVATE
      64                 :            : 
      65                 :            : #endif // QGSALGORITHMFILEDOWNLOADER_H