libball1.4-dev 1.4.1+20111206-3 / usr / include / BALL / SYSTEM / simpleDownloader.h

#ifndef BALL_SYSTEM_SIMPLEDOWNLOADER_H
#define BALL_SYSTEM_SIMPLEDOWNLOADER_H

#ifndef BALL_DATATYPE_STRING_H
	#include <BALL/DATATYPE/string.h>
#endif

#include <QtCore/QThread>
#include <QtCore/QFile>
#include <QtNetwork/QFtp>

#include <QtNetwork/QNetworkReply>

class QByteArray;

namespace BALL
{
	namespace SimpleDownloaderHelper
	{
		class HelperThread;
	}

	/**
	 * This class provides an interface for synchronous downloads.
	 * It currently relies on QNetworkAccessManager and thus on the existence of
	 * a QCoreApplication object. If no global instance is existing a local application
	 * object is created. For this reason you must not use this class in any thread but
	 * the main thread if you did not create a QCoreApplication object yourself.
	 *
	 * REMARK: this class is considered experimental and its interface
	 * can be a subject to redesign.
	 */
	class BALL_EXPORT SimpleDownloader
		: public QObject
	{
		Q_OBJECT

		public:
			/*
			 * Default Constructor.
			 *
			 * @param url The URL to download.
			 * @param timeout The maximum number of milliseconds the download is allowed to take.
			 *                default: infinite
			 */
			SimpleDownloader(const String& url, unsigned int timeout = UINT_MAX);

			/*
			 * Default Constructor.
			 *
			 * @param url The URL to download.
			 * @param timeout The maximum number of milliseconds the download is allowed to take.
			 *                default: infinite
			 */
			SimpleDownloader(const QUrl& url, unsigned int timeout = UINT_MAX);

			/**
			 * If the content of the download should be kept in memory you can use this function
			 * that stores the received bytes in the provides vector. Any previous content is overwritten.
			 *
			 * @param buffer The buffer vector to use.
			 * @return Non-zero if an error occurred while downloading
			 */
			int downloadToBuffer(std::vector<char>& buffer);

			/**
			 * Download the url and store the contents to a file.
			 *
			 * @param path The path to the file the content is stored in.
			 * @return Non-zero if an error occurred while downloading
			 */
			int downloadToFile(const String& path);

			/**
			 * Upload the passed string to the specified URL and save the response
			 * to the specified buffer
			 *
			 * @param data the string which is uploaded
			 * @param response the response of the server
			 * @return Non-zero if an error occured while uploading
			 */
			int uploadStringToBuffer(const String& data, std::vector<char>& response);

			/**
			 * Upload the passed string to the specified URL and save the response
			 * to the specified file
			 *
			 * @param data the string which is uploaded
			 * @param response the file the response is saved to
			 * @return Non-zero if an error occured while uploading
			 */
			int uploadStringToFile(const String& data, const String& response);

			/**
			 * Upload the passed string to the specified URL and save the response
			 * to the specified file
			 *
			 * @param path the path of the file to upload
			 * @param response the response of the server
			 * @return Non-zero if an error occured while uploading
			 */
			int uploadFileToBuffer(const String& path, std::vector<char>& response);

			/**
			 * Upload the passed string to the specified URL and save the response
			 * to the specified file
			 *
			 * @param path the path of the file to upload
			 * @param response the file the response is saved to
			 * @return Non-zero if an error occured while uploading
			 */
			int uploadFileToFile(const String& path, const String& response);

			/**
			 * Sets the maximum amount of time a download my take. The time is specified in
			 * milliseconds.
			 *
			 * @param timeout The time in milliseconds.
			 */
			void setTimeout(unsigned int timeout);

			/**
			 * Sets the url of the download.
			 *
			 * @param url The URL to download
			 */
			void setURL(const String& url);

			/**
			 * Sets the url of the download.
			 *
			 * @param url The URL to download
			 */
			void setURL(const QUrl& url);

			/**
			 * Returns the current URL.
			 *
			 * @return The currently set URL
			 */
			const QUrl& getURL() const;

		private:
			int download_(SimpleDownloaderHelper::HelperThread& thread);
			int qftpDownloadHack_(QIODevice* iodev);

			QUrl url_;
			unsigned int timeout_;
	};

	namespace SimpleDownloaderHelper
	{
		class HelperThread : public QThread
		{
			public:
				HelperThread(const QUrl& url, QByteArray* result, SimpleDownloader* parent);
				HelperThread(const QUrl& url, const String& path, SimpleDownloader* parent);

				int getStatus();

			protected:
				virtual QNetworkReply* getReply_(QNetworkAccessManager* man) = 0;

				void run();

				int err_;
				QUrl url_;
				QByteArray* result_;
				String path_;
				SimpleDownloader* parent_;
		};

		class DLThread : public HelperThread
		{
			public:
				DLThread(const QUrl& url, QByteArray* result, SimpleDownloader* parent);
				DLThread(const QUrl& url, const String& path, SimpleDownloader* parent);

			protected:
				virtual QNetworkReply* getReply_(QNetworkAccessManager* man);
		};

		class UPThread : public HelperThread
		{
			public:
				UPThread(const QUrl& url, const QByteArray* data, QByteArray* result, SimpleDownloader* parent);
				UPThread(const QUrl& url, const QByteArray* data, const String& path, SimpleDownloader* parent);
				UPThread(const QUrl& url, QIODevice* file, QByteArray* result, SimpleDownloader* parent);
				UPThread(const QUrl& url, QIODevice* file, const String& path, SimpleDownloader* parent);

			protected:
				virtual QNetworkReply* getReply_(QNetworkAccessManager* man);

				const QByteArray* data_;
				QIODevice* file_;
		};

		class BasicHelper : public QObject
		{
			Q_OBJECT

			public:
				BasicHelper(HelperThread* caller, QNetworkReply* reply);
				virtual ~BasicHelper(){}

			public slots:
				void error(QNetworkReply::NetworkError error);
#ifndef QT_NO_OPENSSL
				void sslErrors(const QList<QSslError>& errors);
#endif
				virtual void finished() = 0;

			protected:
				HelperThread* caller_;
				QNetworkReply* reply_;
		};

		class DLArrayHelper : public BasicHelper
		{
			Q_OBJECT

			public:
				DLArrayHelper(HelperThread* caller, QNetworkReply* reply, QByteArray* result);

			public slots:
				void finished();

			private:
				QByteArray* result_;
		};

		class DLHelper : public BasicHelper
		{
			Q_OBJECT

			public:
				DLHelper(HelperThread* caller, QNetworkReply* reply, const String& path);

			public slots:
				void finished();
				void receivedData();

			private:
				QFile file_;
		};


		// We need this due to a bug in QNetworkAccessManager that basically
		// screws up the FTP download code. This should be fixed upstream with
		// the advent of Qt5

		class QFtpHackHelper;

		class QFtpHackThread : public QThread
		{
			Q_OBJECT

			public:
				QFtpHackThread(const QUrl& url, QIODevice* iodev, SimpleDownloader* parent);
				~QFtpHackThread();

			protected:
				void run();

			private:
				QFtp* ftp_;
				QFtpHackHelper* helper_;
				QUrl url_;
				QIODevice* iodev_;
				SimpleDownloader* parent_;
		};

		class QFtpHackHelper : public QObject
		{
			Q_OBJECT

			public:
				QFtpHackHelper(QFtpHackThread* th);

			public slots:
				void done(bool error);

			private:
				QFtpHackThread* th_;
		};

	}
}

#endif //BALL_SYSTEM_SIMPLEDOWNLOADER_H