chore(cpn): Refactor component updates (#3218)

* Refactoring

* Fix current release id and process dlg events

* enh: Process updates dialog add select/deselect all components

* Change Expression to Pattern
This commit is contained in:
Neil Horne
2023-03-19 16:13:56 +10:00
committed by GitHub
parent fc1d6ba3a0
commit a1178f83a6
47 changed files with 3370 additions and 2813 deletions
+82 -257
View File
@@ -21,65 +21,15 @@
#pragma once
#include "repomodels.h"
#include "constants.h"
#include "progresswidget.h"
#include "appdata.h"
#include "updatestatus.h"
#include "updatenetwork.h"
#include "repo.h"
#include "updateparameters.h"
#include <QtCore>
#include <QtNetwork/QNetworkAccessManager>
#include <QtNetwork/QNetworkReply>
class UpdateParameters : public QObject
{
Q_OBJECT
public:
enum UpdateFilterType {
UFT_None,
UFT_Exact,
UFT_Startswith,
UFT_Endswith,
UFT_Contains,
UFT_Expression,
};
static QStringList updateFilterTypeList();
static QString updateFilterTypeToString(UpdateFilterType uft);
struct AssetParams {
int processes;
int flags;
UpdateFilterType filterType;
QString filter;
int maxExpected;
QString destSubDir;
UpdateFilterType copyFilterType;
QString copyFilter;
};
int flags;
int logLevel;
QString fwFlavour;
QString language;
int releaseChannel;
QString currentRelease;
QString updateRelease;
QString downloadDir;
bool decompressDirUseDwnld;
QString decompressDir;
QString sdDir;
bool updateDirUseSD;
QString updateDir;
QVector<AssetParams> assets;
UpdateParameters(QObject * parent);
virtual ~UpdateParameters() {}
AssetParams & addAsset();
QString buildFilterPattern(const UpdateFilterType filterType, const QString & filter);
};
#include <QWidget>
class UpdateInterface : public QWidget
{
@@ -87,13 +37,19 @@ class UpdateInterface : public QWidget
public:
enum DownloadDataType {
DDT_Binary,
DDT_Content,
DDT_SaveToFile,
DDT_MetaData,
// The CID is used as a key to the application settings therefore
// ids must be explicit so no renumbering if components removed
// new components must be added to the end of the enum
enum ComponentIdentity {
CID_Unknown = -1,
CID_SDCard = 0,
CID_Firmware = 1,
CID_Sounds = 2,
CID_Themes = 3,
CID_MultiProtocol = 4,
CID_Companion = 5,
};
Q_ENUM(DownloadDataType)
Q_ENUM(ComponentIdentity)
enum UpdateFlags {
UPDFLG_None = 0,
@@ -114,212 +70,81 @@ class UpdateInterface : public QWidget
};
Q_ENUM(UpdateFlags)
// The CID is used as a key to the application settings therefore
// ids must be explicit so no renumbering if components removed
// new components must be added to the end of the enum
enum ComponentIdentity {
CID_Unknown = -1,
CID_SDCard = 0,
CID_Firmware = 1,
CID_Sounds = 2,
CID_Themes = 3,
CID_MultiProtocol = 4,
CID_Companion = 5,
};
Q_ENUM(ComponentIdentity)
explicit UpdateInterface(QWidget * parent);
explicit UpdateInterface(QWidget * parent, ComponentIdentity id, QString name);
virtual ~UpdateInterface();
const int id() const { return (int)m_id; }
const QString name() const { return m_name; }
virtual void assetSettingsSave();
virtual const bool isReleaseLatest();
virtual const bool isUpdateAvailable();
virtual const bool isVersionLatest(const QString & current, const QString & latest);
virtual const QString releaseCurrent();
virtual const QString releaseLatest();
virtual const QString releaseUpdate();
virtual bool update(ProgressWidget * progress = nullptr);
virtual const QString versionCurrent();
const int id() const;
const bool isUpdateable() const;
const QString name() const;
UpdateParameters* const params() const;
void releaseClear();
const QStringList releaseList();
void resetEnvironment();
void setReleaseChannel(const int channel);
void setRunUpdate();
protected:
friend class UpdateFactories;
ReleasesMetaData *releases;
AssetsMetaData *assets;
UpdateParameters *params;
ProgressWidget *progress;
QString downloadDir;
QString decompressDir;
QString updateDir;
virtual bool update(ProgressWidget * progress = nullptr);
virtual void initAssetSettings() = 0;
virtual void loadAssetSettings();
virtual void saveAssetSettings();
virtual bool preparation();
virtual bool flagAssets();
virtual bool download();
virtual bool decompress();
virtual bool copyToDestination();
virtual bool copyAsset();
virtual bool housekeeping();
virtual void assetSettingsInit() = 0;
virtual void assetSettingsLoad();
virtual bool asyncInstall();
virtual bool copyAsset();
virtual bool copyToDestination();
virtual bool decompress();
virtual bool download();
virtual bool flagAssets();
virtual bool housekeeping();
virtual bool preparation();
virtual const bool isUpdateAvailable();
virtual const QString currentVersion();
virtual const QString currentRelease();
virtual const QString updateRelease();
virtual const bool isLatestRelease();
virtual const bool isLatestVersion(const QString & current, const QString & latest);
virtual QString latestRelease();
void clearRelease();
const QStringList getReleases();
void init(ComponentIdentity id, QString name, QString repo, QString nightly = "", int resultsPerPage = -1);
void setId(ComponentIdentity id) { m_id = id; }
void setName(QString name) { m_name = name; }
void setReleaseChannel(int channel);
void setReleaseId(QString val);
void setParamFolders();
UpdateParameters * getParams() { return params; }
void resetEnvironment();
void setRunUpdate() { params->flags |= UPDFLG_Update; }
bool isUpdateable();
bool repoReleasesMetaData();
bool repoReleaseAssetsMetaData();
bool downloadReleasesMetaData();
bool downloadReleaseLatestMetaData();
bool downloadReleaseMetaData(const int releaseId);
bool getReleaseJsonAsset(const QString assetName, QJsonDocument * json);
bool downloadReleaseAssetsMetaData(const int releaseId);
bool downloadAssetMetaData(const int assetId);
bool getSetAssets(const UpdateParameters::AssetParams & ap);
bool downloadAsset(int row);
bool downloadFlaggedAssets();
bool decompressAsset(int row);
bool decompressFlaggedAssets();
bool copyFiles();
bool copyFlaggedAssets();
bool copyStructure();
bool copyFiles();
bool saveReleaseSettings();
bool downloadAssetToBuffer(const int assetId);
bool downloadTextFileToBuffer(const QString & path);
void downloadFileToBuffer(const QString & url);
bool convertDownloadToJson(QJsonDocument * json);
bool decompressArchive(const QString & archivePath, const QString & destPath);
QByteArray * getDownloadBuffer() { return buffer; }
bool getRepoJsonFile(const QString filename, QJsonDocument * json);
void reportProgress(const QString & text, const int type = QtInfoMsg);
void progressMessage(const QString & text);
void criticalMsg(const QString & msg);
static QString downloadDataTypeToString(DownloadDataType val);
static QString updateFlagsToString(UpdateFlags val);
void setFlavourLanguage();
bool isValidSettingsIndex() { return m_id > -1 && m_id < MAX_COMPONENTS; }
private slots:
void onDownloadFinished(QNetworkReply * reply, DownloadDataType ddt, int subtype);
private:
QNetworkAccessManager manager;
QNetworkRequest request;
QNetworkReply *reply;
QByteArray *buffer;
QFile *file;
QUrl url;
int m_id;
QString m_name;
bool downloadSuccess;
bool decompressAsset(int row);
const QString decompressDir() const;
bool decompressFlaggedAssets();
const QString downloadDir() const;
bool downloadFlaggedAssets();
void init(QString repo, QString nightly = "", int resultsPerPage = -1);
const bool isSettingsIndexValid() const;
UpdateNetwork* const network() const;
Repo* const repo() const;
bool retrieveAssetsJsonFile(const QString & assetName, QJsonDocument * json);
bool retrieveRepoJsonFile(const QString & filename, QJsonDocument * json);
bool setFilteredAssets(const UpdateParameters::AssetParams & ap);
void setFirmwareFlavour();
void setLanguage();
void setParamFolders();
void setReleaseId(QString name);
UpdateStatus* const status() const;
const QString updateDir() const;
static QStringList versionToStringList(QString version);
static const QString updateFlagsToString(const int flags);
static const QString updateFlagToString(const int flag);
void initAppSettings();
bool setRunFolders();
private:
const ComponentIdentity m_id;
const QString m_name;
UpdateParameters* const m_params;
UpdateStatus* const m_status;
UpdateNetwork* const m_network;
Repo* const m_repo;
QString m_downloadDir;
QString m_decompressDir;
QString m_updateDir;
void appSettingsInit();
bool checkCreateDirectory(const QString & dirSetting, const UpdateFlags flag);
void downloadMetaData(const MetaDataType mdt, const QString & url);
void download(const DownloadDataType type, const int subtype, const QString & urlStr, const char * header, const QString & filePath);
void downloadBinaryToFile(const QString & url, const QString & filename);
void parseMetaData(int mdt);
};
class UpdateFactoryInterface
{
public:
explicit UpdateFactoryInterface() {}
virtual ~UpdateFactoryInterface() {}
virtual UpdateInterface * instance() = 0;
virtual const QString name() = 0;
virtual const int id() = 0;
};
template <class T>
class UpdateFactory : public UpdateFactoryInterface
{
public:
explicit UpdateFactory(QWidget * parent) :
UpdateFactoryInterface(),
m_instance(new T(parent)) {}
virtual ~UpdateFactory() {}
virtual UpdateInterface * instance() { return m_instance; }
virtual const QString name() { return m_instance->name(); }
virtual const int id() { return m_instance->id(); }
private:
UpdateInterface *m_instance;
};
class UpdateFactories : public QWidget
{
Q_OBJECT
public:
explicit UpdateFactories(QWidget * parent = nullptr);
virtual ~UpdateFactories();
const QString name(const int id);
void registerUpdateFactory(UpdateFactoryInterface * factory);
void registerUpdateFactories();
void unregisterUpdateFactories();
void saveAssetSettings(const int id);
UpdateParameters * const getParams(const int id);
void resetEnvironment(const int id);
void resetAllEnvironments();
void setRunUpdate(const int id);
const QMap<QString, int> sortedComponentsList(bool updateableOnly = false);
void clearRelease(const int id);
void setReleaseChannel(const int id, int channel);
void setReleaseId(const int id, QString val);
const QString currentRelease(const int id);
const QString updateRelease(const int id);
const bool isLatestRelease(const int id);
const QString latestRelease(const int id);
const QStringList releases(const int id);
bool getReleaseJsonAsset(const int id, const QString assetName, QJsonDocument * json);
bool getRepoJsonFile(const int id, const QString filename, QJsonDocument * json);
bool update(const int id, ProgressWidget * progress = nullptr);
bool updateAll(ProgressWidget * progress = nullptr);
const bool isUpdateAvailable(QMap<QString, int> & names);
private:
QVector<UpdateFactoryInterface *> registeredUpdateFactories;
UpdateInterface * getInstance(const int id);
bool decompressArchive(const QString & archivePath, const QString & destPath);
bool releaseSettingsSave();
bool setRunFolders();
};