trustbridge: ui/downloader.h annotate

annotate ui/downloader.h @ 1093:153af47456d0

Add option "USE_REAL_RESOURCES" to avoid the if 1 dance for test/release builds. If the option is not set the download resource is trustbridge-development.*

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Mon, 15 Sep 2014 10:17:17 +0200
parents	78798d3af8f0
children	2a1aa9df8f11

rev	line source
404 17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	1 /* Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	2 * Software engineering by Intevation GmbH
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	3 *
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	4 * This file is Free Software under the GNU GPL (v>=2)
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY!
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	6 * See LICENSE.txt for details.
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 54 diff changeset	7 */
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	8 #ifndef DOWNLOADER_H
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	9 #define DOWNLOADER_H
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	10 /**
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	11 * @file downloader.h
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	12 * @brief High level API to download necessary data.
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	13 *
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	14 */
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	15
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	16 #include <QThread>
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	17 #include <QDateTime>
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	18 #include <QString>
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	19 #include <QByteArray>
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	20
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	21 #include "sslconnection.h"
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	22
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	23 class Downloader: public QThread
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	24 {
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	25 Q_OBJECT
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	26
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	27 public:
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	28 /**
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	29 * @brief Construct a downloader with a specific certificate
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	30 *
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	31 * The downloader will check the last-modified date of the
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	32 * certificate list / sw on the server at the specified url
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	33 * and download those accordingly. If newestSW or newestList is
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	34 * are valid datetimes only files modified after the respective date
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	35 * are downloaded.
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	36 *
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	37 * Downloaded files are placed in QStandardPaths::DataLocation
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	38 *
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	39 * @param[in] parent the parent object.
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	40 * @param[in] url the Url to download data from
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	41 * @param[in] certificate optional certificate to validate https connection
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	42 * @param[in] newestSW datetime after which software should be downloaded
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	43 * @param[in] newestList datetime after which the list should be downloaded
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	44 * @param[in] resourceSW the path where the software is to be found
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	45 * @param[in] resourceList the path where the list is to be found
1053 78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 990 diff changeset	46 * @param[in] downloadSW TODO
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	47 */
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	48 Downloader(QObject* parent, const QString& url,
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	49 const QByteArray& certificate = QByteArray(),
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	50 const QDateTime& newestSW = QDateTime(),
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	51 const QDateTime& newestList = QDateTime(),
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	52 const QString& resourceSW = QString(),
460 f8bed9008362 Added switch to download new available software. Raimund Renkert <rrenkert@intevation.de> parents: 404 diff changeset	53 const QString& resourceList = QString(),
f8bed9008362 Added switch to download new available software. Raimund Renkert <rrenkert@intevation.de> parents: 404 diff changeset	54 bool downloadSW = true);
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	55
27 62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	56 ~Downloader();
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	57
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	58 /**
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	59 * @brief get the directory where the downloader saves data
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	60 *
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	61 * If the directory does not exist this function ensures that it
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	62 * is created.
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	63 *
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	64 * @returns The directory in which downloaded files are placed.
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	65 **/
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	66 QString getDataDirectory();
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	67
27 62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	68 /**
62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	69 * @brief get the current error state
62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	70 *
62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	71 * @returns The current error state.
62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	72 **/
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	73 SSLConnection::ErrorCode getErrorState();
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	74
990 2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	75
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	76 /**
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	77 * @brief forward the setCiphersuites call to the sslconnection
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	78 *
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	79 * see sslconnection.h for details.
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	80 */
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	81 void setCiphersuites(int suites[]);
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	82
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	83 protected:
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	84 void run();
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	85
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	86 private:
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	87 QDateTime mLastModSW;
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	88 QDateTime mLastModList;
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	89
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	90 QString mResourceSW;
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	91 QString mResourceList;
27 62cd56cea09b Start on polarssl Downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 15 diff changeset	92
460 f8bed9008362 Added switch to download new available software. Raimund Renkert <rrenkert@intevation.de> parents: 404 diff changeset	93 bool mDownloadSW;
f8bed9008362 Added switch to download new available software. Raimund Renkert <rrenkert@intevation.de> parents: 404 diff changeset	94
908 d1c951b3012d Curl based implementation of sslconnection Andre Heinecke <andre.heinecke@intevation.de> parents: 485 diff changeset	95 SSLConnection *mSSLConnection;
32 d8e93fa1fc93 Downloader logic Andre Heinecke <andre.heinecke@intevation.de> parents: 27 diff changeset	96
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	97 Q_SIGNALS:
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	98 /**
15 95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	99 * @brief software update is available
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	100 */
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	101 void newSoftwareAvailable(const QString &fileName,
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	102 const QDateTime &lastMod);
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	103
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	104 /**
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	105 * @brief new certificate list available
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	106 */
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	107 void newListAvailable(const QString &fileName, const QDateTime &lastMod);
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	108
95e1b6edf2fc Implement more downloader functionality for Windows Andre Heinecke <aheinecke@intevation.de> parents: 10 diff changeset	109 /**
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	110 * @brief Some progress has been made.
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	111 *
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	112 * @param[out] message: A message to show. Can be empty.
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	113 * @param[out] current: Value of current progress.
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	114 * @param[out] total: Total value of possible progress
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	115 */
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	116 void progress(const QString &message, int current, int total);
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	117
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	118 /**
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	119 * @brief An error happened
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	120 *
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	121 * @param[out] message: A message to show. Can be empty.
1053 78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 990 diff changeset	122 * @param[out] error: ErrorCode of this error.
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	123 */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: 32 diff changeset	124 void error(const QString &message, SSLConnection::ErrorCode error);
485 5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	125
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	126 /**
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	127 * @brief Found the last modified date for software.
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	128 *
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	129 * @param[out] date The last modified date.
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	130 */
5834b340c54c Emit a signal for last modified date in downloader. Raimund Renkert <rrenkert@intevation.de> parents: 460 diff changeset	131 void lastModifiedDate(const QDateTime &date);
10 fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	132 };
fe39d93f1261 Start on Downloader component Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	133 #endif

Mercurial > trustbridge

annotate ui/downloader.h @ 1093:153af47456d0