networkrequestbase.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_NETWORKREQUESTBASE_H
#define LIBREPCB_CORE_NETWORKREQUESTBASE_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
#include <QtNetwork>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
/*******************************************************************************
 *  Class NetworkRequestBase
 ******************************************************************************/
 
class NetworkRequestBase : public QObject {
  Q_OBJECT
 
public:
  // Constructors / Destructor
  NetworkRequestBase() = delete;
  NetworkRequestBase(const NetworkRequestBase& other) = delete;
  NetworkRequestBase(const QUrl& url,
                     const QByteArray& postData = QByteArray()) noexcept;
  virtual ~NetworkRequestBase() noexcept;
 
  // Setters
 
  void setHeaderField(const QByteArray& name, const QByteArray& value) noexcept;
 
  void setCacheLoadControl(QNetworkRequest::CacheLoadControl value) noexcept;
 
  void setExpectedReplyContentSize(qint64 bytes) noexcept;
 
  void setMinimumCacheTime(int seconds) noexcept;
 
  // Operator Overloadings
  NetworkRequestBase& operator=(const NetworkRequestBase& rhs) = delete;
 
public slots:
 
  void start() noexcept;
 
  void abort() noexcept;
 
signals:
 
  void startRequested();
 
  void progressState(QString state);
 
  void progressPercent(int percent);
 
  void progress(qint64 bytesReceived, qint64 bytesTotal, int percent);
 
  void aborted();
 
  void succeeded();
 
  void errored(QString errorMsg);
 
  void finished(bool success);
 
public:  // Methods
  virtual void prepareRequest() = 0;
  virtual void finalizeRequest() = 0;
  virtual void emitSuccessfullyFinishedSignals() noexcept = 0;
  virtual void fetchNewData(QIODevice& device) noexcept = 0;
 
private:  // Methods
  void executeRequest() noexcept;
  void uploadProgressSlot(qint64 bytesSent, qint64 bytesTotal) noexcept;
  void replyDownloadProgressSlot(qint64 bytesReceived,
                                 qint64 bytesTotal) noexcept;
  void replyReadyReadSlot() noexcept;
  void replyErrorSlot(QNetworkReply::NetworkError code) noexcept;
  void replySslErrorsSlot(const QList<QSslError>& errors) noexcept;
  void replyFinishedSlot() noexcept;
  void finalize(const QString& errorMsg = QString()) noexcept;
  static QString formatFileSize(qint64 bytes) noexcept;
  static QString getUserAgent() noexcept;
 
protected:  // Data
  // from constructor
  QUrl mUrl;
  QByteArray mPostData;
  qint64 mExpectedContentSize;
  int mMinimumCacheTime;
 
  // internal data
  QList<QUrl> mRedirectedUrls;
  QNetworkRequest mRequest;
  QScopedPointer<QNetworkReply> mReply;
  bool mStarted;
  bool mAborted;
  bool mErrored;
  bool mFinished;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif