Ref T125, UI component to download and install XSwiftBus

* currently working only for alpha directory
* 1st version, maybe currently too much logic (download etc.) in an UI component

src/blackgui/components/installxswiftbuscomponent.cpp

@@ -0,0 +1,255 @@
+/* Copyright (C) 2017
+ * swift project Community / Contributors
+ *
+ * This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+#include "installxswiftbuscomponent.h"
+#include "ui_installxswiftbuscomponent.h"
+#include "blackgui/guiapplication.h"
+#include "blackgui/overlaymessagesframe.h"
+#include "blackmisc/simulation/xplane/xplaneutil.h"
+#include "blackmisc/logmessage.h"
+#include "blackmisc/directoryutils.h"
+#include "blackmisc/fileutils.h"
+
+#include <QMessageBox>
+#include <QFileDialog>
+#include <QStandardPaths>
+#include <QTimer>
+#include <QDesktopServices>
+
+using namespace BlackMisc;
+using namespace BlackMisc::Network;
+using namespace BlackMisc::Simulation;
+using namespace BlackMisc::Simulation::Settings;
+using namespace BlackMisc::Simulation::XPlane;
+
+namespace BlackGui
+{
+    namespace Components
+    {
+        CInstallXSwiftBusComponent::CInstallXSwiftBusComponent(QWidget *parent) :
+            COverlayMessagesFrame(parent),
+            CLoadIndicatorEnabled(this),
+            ui(new Ui::CInstallXSwiftBusComponent)
+        {
+            ui->setupUi(this);
+
+            ui->le_XSwiftBusPluginDir->setText(this->getXPlanePluginDirectory());
+            ui->le_DownloadDir->setText(QStandardPaths::writableLocation(QStandardPaths::DownloadLocation));
+            ui->cb_DownloadFile->setEnabled(false);
+
+            connect(ui->pb_DialogInstallDir, &QPushButton::pressed, this, &CInstallXSwiftBusComponent::selectPluginDirectory);
+            connect(ui->pb_DialogDownloadDir, &QPushButton::pressed, this, &CInstallXSwiftBusComponent::selectDownloadDirectory);
+            connect(ui->pb_Download, &QPushButton::pressed, this, &CInstallXSwiftBusComponent::triggerDownloadingOfXSwiftBusFile);
+            connect(ui->pb_OpenDownloadDir, &QPushButton::pressed, this, &CInstallXSwiftBusComponent::openDownloadDir);
+            connect(ui->pb_OpenInstallDir, &QPushButton::pressed, this, &CInstallXSwiftBusComponent::openInstallDir);
+
+            // lod metadata
+            this->triggerLoadingXSwiftBusFileInfo();
+        }
+
+        CInstallXSwiftBusComponent::~CInstallXSwiftBusComponent()
+        { }
+
+        void CInstallXSwiftBusComponent::selectPluginDirectory()
+        {
+            QString xPlanePluginDir = ui->le_XSwiftBusPluginDir->text().trimmed();
+            xPlanePluginDir = QFileDialog::getExistingDirectory(parentWidget(),
+                              tr("Choose your X-Plane plugin directory"), xPlanePluginDir, m_fileDialogOptions);
+
+            if (xPlanePluginDir.isEmpty()) { return; } // canceled
+            if (!QDir(xPlanePluginDir).exists())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).warning("'%1' is not a valid X-Plane plugin directory") << xPlanePluginDir;
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+            ui->le_XSwiftBusPluginDir->setText(xPlanePluginDir);
+        }
+
+        void CInstallXSwiftBusComponent::selectDownloadDirectory()
+        {
+            QString downloadDir = ui->le_DownloadDir->text().trimmed();
+            downloadDir = QFileDialog::getExistingDirectory(parentWidget(),
+                          tr("Choose your X-Plane plugin directory"), downloadDir, m_fileDialogOptions);
+
+            if (downloadDir.isEmpty()) { return; } // canceled
+            if (!QDir(downloadDir).exists())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).warning("'%1' is not a valid download directory") << downloadDir;
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+            ui->le_DownloadDir->setText(downloadDir);
+        }
+
+        void CInstallXSwiftBusComponent::installXSwiftBus()
+        {
+            const CRemoteFile rf = this->getRemoteFileSelected();
+            const QString sourceFileName = CFileUtils::appendFilePaths(ui->le_DownloadDir->text(), rf.getName());
+            const QFile sourceFile(sourceFileName);
+            if (!sourceFile.exists())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("Cannot read downloaded file '%1'") << sourceFileName;
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+            const QString destFileName = CFileUtils::appendFilePaths(ui->le_XSwiftBusPluginDir->text(), rf.getName());
+            bool moved = QDir().rename(sourceFileName, destFileName);
+            if (moved)
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).info("Installed '%1'") << destFileName;
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+            }
+            else
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("Cannot move '%1' to '%2'") << sourceFileName << destFileName;
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+            }
+        }
+
+        void CInstallXSwiftBusComponent::triggerLoadingXSwiftBusFileInfo()
+        {
+            if (!sGui || !sGui->hasWebDataServices() || sGui->isShuttingDown()) { return; }
+            const CUrl url = sGui->getGlobalSetup().getAlphaXSwiftBusFilesServiceUrl();
+            if (url.isEmpty()) { return; }
+            sGui->getFromNetwork(url, { this, &CInstallXSwiftBusComponent::loadedXSwiftBusFileInfo });
+            CLogMessage(this).info("Trigger loading XSwiftBus file info from '%1'") << url.getHost();
+        }
+
+        void CInstallXSwiftBusComponent::loadedXSwiftBusFileInfo(QNetworkReply *reply)
+        {
+            QScopedPointer<QNetworkReply, QScopedPointerDeleteLater> nwReply(reply); // clean up reply afterwards
+            if (sGui && sGui->isShuttingDown()) { return; }
+            m_remoteFiles.clear();
+
+            if (nwReply->error() == QNetworkReply::NoError)
+            {
+                const QString json = reply->readAll();
+                if (!json.isEmpty())
+                {
+                    const CRemoteFileList remoteFiles = CRemoteFileList::fromDatabaseJson(json);
+                    m_remoteFiles = remoteFiles;
+                    CLogMessage(this).info("Loaded %1 XSwiftBus file info entries from '%2'") << remoteFiles.size() << nwReply->url().toString();
+                }
+            }
+            else if (sGui && !sGui->isShuttingDown())
+            {
+                QTimer::singleShot(30 * 1000, this, &CInstallXSwiftBusComponent::triggerLoadingXSwiftBusFileInfo);
+            }
+
+            ui->cb_DownloadFile->clear();
+            if (!m_remoteFiles.isEmpty())
+            {
+                QStringList xSWiftBusFiles(m_remoteFiles.getNamesPlusSize(true));
+                std::reverse(xSWiftBusFiles.begin(), xSWiftBusFiles.end()); // latest on top
+                ui->cb_DownloadFile->addItems(xSWiftBusFiles);
+                ui->cb_DownloadFile->setCurrentText(m_remoteFiles.backOrDefault().getNameAndSize()); // latest version
+            }
+            ui->cb_DownloadFile->setEnabled(!m_remoteFiles.isEmpty());
+        }
+
+        void CInstallXSwiftBusComponent::triggerDownloadingOfXSwiftBusFile()
+        {
+            if (!sGui || !sGui->hasWebDataServices() || sGui->isShuttingDown()) { return; }
+            if (m_remoteFiles.isEmpty())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("No remote file information");
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                this->triggerLoadingXSwiftBusFileInfo(); // try to reload
+                return;
+            }
+            if (!this->existsDownloadDir())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("Invalid download directory");
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+
+            const CRemoteFile rf = this->getRemoteFileSelected();
+            const CUrl download = rf.getUrl();
+            if (download.isEmpty())
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("No download URL for file name '%1'") << rf.getNameAndSize();
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+
+            const QString saveAsFile = CFileUtils::appendFilePaths(ui->le_DownloadDir->text(), rf.getName());
+            const QNetworkReply *r = sGui->downloadFromNetwork(download, saveAsFile, { this, &CInstallXSwiftBusComponent::downloadedXSwiftBusFile});
+            if (r)
+            {
+                CLogMessage(this).info("Triggered downloading of XSwiftBus file from '%1'") << download.getHost();
+                this->showLoading(10 * 1000);
+            }
+            else
+            {
+                const CStatusMessage msg = CStatusMessage(this, CLogCategory::validation()).error("Starting download for '%1' failed") << download.getFullUrl();
+                this->showOverlayMessage(msg, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+            }
+        }
+
+        void CInstallXSwiftBusComponent::downloadedXSwiftBusFile(const CStatusMessage &status)
+        {
+            this->hideLoading();
+            if (sGui && sGui->isShuttingDown()) { return; }
+            if (status.isWarningOrAbove() || !this->existsXSwiftBusPluginDir())
+            {
+                this->showOverlayMessage(status, CInstallXSwiftBusComponent::OverlayMsgTimeoutMs);
+                return;
+            }
+            static const QString confirm("Install in '%1'?");
+            this->showOverlayMessagesWithConfirmation(status, confirm.arg(ui->le_XSwiftBusPluginDir->text()), [ = ] { this->installXSwiftBus(); });
+        }
+
+        CRemoteFile CInstallXSwiftBusComponent::getRemoteFileSelected() const
+        {
+            const QString fileNameAndSize = ui->cb_DownloadFile->currentText();
+            return m_remoteFiles.findFirstMatchingNameOrDefault(fileNameAndSize);
+        }
+
+        bool CInstallXSwiftBusComponent::existsDownloadDir() const
+        {
+            if (ui->le_DownloadDir->text().isEmpty()) { return false; }
+            const QDir dir(ui->le_DownloadDir->text());
+            return dir.exists() && dir.isReadable();
+        }
+
+        bool CInstallXSwiftBusComponent::existsXSwiftBusPluginDir() const
+        {
+            if (ui->le_XSwiftBusPluginDir->text().isEmpty()) { return false; }
+            const QDir dir(ui->le_XSwiftBusPluginDir->text());
+            return dir.exists() && dir.isReadable();
+        }
+
+        QString CInstallXSwiftBusComponent::getXPlanePluginDirectory() const
+        {
+            const CSimulatorSettings settings = m_simulatorSettings.getSettings(CSimulatorInfo::XPLANE);
+            if (!settings.hasSimulatorDirectory()) { return CXPlaneUtil::xplanePluginDir(); }
+            const QString dir = CFileUtils::appendFilePaths(settings.getSimulatorDirectory(), CXPlaneUtil::xplanePluginPath());
+            return dir;
+        }
+
+        void CInstallXSwiftBusComponent::openInstallDir()
+        {
+            if (!this->existsXSwiftBusPluginDir()) { return; }
+            QDesktopServices::openUrl(QUrl::fromLocalFile(ui->le_XSwiftBusPluginDir->text()));
+        }
+
+        void CInstallXSwiftBusComponent::openDownloadDir()
+        {
+            if (!this->existsDownloadDir()) { return; }
+            QDesktopServices::openUrl(QUrl::fromLocalFile(ui->le_DownloadDir->text()));
+        }
+
+        bool CInstallXSwiftBusWizardPage::validatePage()
+        {
+            return true;
+        }
+    } // ns
+} // ns

src/blackgui/components/installxswiftbuscomponent.h

@@ -0,0 +1,115 @@
+/* Copyright (C) 2017
+ * swift project Community / Contributors
+ *
+ * This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \file
+
+#ifndef BLACKGUI_COMPONENTS_INSTALLXSWIFTBUSCOMPONENT_H
+#define BLACKGUI_COMPONENTS_INSTALLXSWIFTBUSCOMPONENT_H
+
+#include "blackgui/overlaymessagesframe.h"
+#include "blackgui/loadindicator.h"
+#include "blackcore/application/applicationsettings.h"
+#include "blackmisc/simulation/settings/simulatorsettings.h"
+#include "blackmisc/network/remotefilelist.h"
+#include <QNetworkReply>
+#include <QFileDialog>
+#include <QWizard>
+#include <QScopedPointer>
+
+namespace Ui { class CInstallXSwiftBusComponent; }
+namespace BlackGui
+{
+    namespace Components
+    {
+        /**
+         * Download and install XSwiftBus
+         */
+        class CInstallXSwiftBusComponent :
+            public COverlayMessagesFrame,
+            public CLoadIndicatorEnabled
+        {
+            Q_OBJECT
+
+        public:
+            //! Default constructor
+            explicit CInstallXSwiftBusComponent(QWidget *parent = nullptr);
+
+            //! Dtor
+            virtual ~CInstallXSwiftBusComponent();
+
+        private:
+            QScopedPointer<Ui::CInstallXSwiftBusComponent> ui;
+            BlackMisc::CSettingReadOnly<BlackCore::Application::TEnabledSimulators> m_enabledSimulators { this };
+            BlackMisc::Simulation::Settings::CMultiSimulatorSettings m_simulatorSettings { this };
+            BlackMisc::Network::CRemoteFileList m_remoteFiles;
+            const QFileDialog::Options m_fileDialogOptions { QFileDialog::ShowDirsOnly | QFileDialog::ReadOnly | QFileDialog::DontResolveSymlinks };
+
+            static constexpr int OverlayMsgTimeoutMs = 5000; //!< how long overlay is displayed
+
+            //! Select X-Plane plugin directory
+            void selectPluginDirectory();
+
+            //! Select download directory
+            void selectDownloadDirectory();
+
+            //! Install from download directory to X-Plane directory
+            void installXSwiftBus();
+
+            //! Trigger loading of XSwiftBus file info
+            void triggerLoadingXSwiftBusFileInfo();
+
+            //! Received info about XSwiftBus download files
+            void loadedXSwiftBusFileInfo(QNetworkReply *reply);
+
+            //! Trigger downloading of XSwiftBusFile
+            void triggerDownloadingOfXSwiftBusFile();
+
+            //! Downloaded XSwiftBus file
+            void downloadedXSwiftBusFile(const BlackMisc::CStatusMessage &status);
+
+            //! Full filename + path for the downloaded XSwiftBus file
+            BlackMisc::Network::CRemoteFile getRemoteFileSelected() const;
+
+            //! Is the download dir existing?
+            bool existsDownloadDir() const;
+
+            //! Is the install dir existing?
+            bool existsXSwiftBusPluginDir() const;
+
+            //! X-Plane directory from settings of default directory
+            QString getXPlanePluginDirectory() const;
+
+            //! Show install dir
+            void openInstallDir();
+
+            //! Show download dir
+            void openDownloadDir();
+        };
+
+        /**
+         * Wizard page for CInstallXSwiftBusWizardPage
+         */
+        class CInstallXSwiftBusWizardPage : public QWizardPage
+        {
+        public:
+            //! Constructors
+            using QWizardPage::QWizardPage;
+
+            //! Set config
+            void setConfigComponent(CInstallXSwiftBusComponent *config) { m_config = config; }
+
+            //! \copydoc QWizardPage::validatePage
+            virtual bool validatePage() override;
+
+        private:
+            CInstallXSwiftBusComponent *m_config = nullptr;
+        };
+    } // ns
+} // ns
+#endif // guard

src/blackgui/components/installxswiftbuscomponent.ui

@@ -0,0 +1,195 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>CInstallXSwiftBusComponent</class>
+ <widget class="QFrame" name="CInstallXSwiftBusComponent">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>600</width>
+    <height>400</height>
+   </rect>
+  </property>
+  <property name="minimumSize">
+   <size>
+    <width>600</width>
+    <height>400</height>
+   </size>
+  </property>
+  <property name="windowTitle">
+   <string>Install XSwiftBus</string>
+  </property>
+  <layout class="QVBoxLayout" name="vl_XSwiftBusComponent">
+   <item>
+    <widget class="QFrame" name="fr_Info">
+     <layout class="QHBoxLayout" name="hl_XSwiftBusIndo" stretch="1,2">
+      <property name="spacing">
+       <number>10</number>
+      </property>
+      <property name="leftMargin">
+       <number>6</number>
+      </property>
+      <property name="topMargin">
+       <number>6</number>
+      </property>
+      <property name="rightMargin">
+       <number>6</number>
+      </property>
+      <property name="bottomMargin">
+       <number>6</number>
+      </property>
+      <item>
+       <widget class="QLabel" name="lbl_XplaneIcon">
+        <property name="text">
+         <string>&lt;html&gt;&lt;img src=&quot;:/simulators/icons/simulators/XPlane.png&quot; width=200&gt;&lt;/html&gt;</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLabel" name="lbl_Explaination">
+        <property name="text">
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-size:9pt; font-style:italic;&quot;&gt;XSwiftBus&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; is an X-Plane plugin that allows X-Plane and &lt;/span&gt;&lt;span style=&quot; font-size:9pt; font-style:italic;&quot;&gt;swift&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; to communicate with each other. If you want to use &lt;/span&gt;&lt;span style=&quot; font-size:9pt; font-style:italic;&quot;&gt;swift&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; with X-Plane you will need to install &lt;/span&gt;&lt;span style=&quot; font-size:9pt; font-style:italic;&quot;&gt;XSwiftBus&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;. Download &lt;/span&gt;&lt;span style=&quot; font-size:9pt; font-style:italic;&quot;&gt;XSwiftBus&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; and extract it into the &lt;/span&gt;&lt;span style=&quot; font-size:9pt; text-decoration: underline;&quot;&gt;X-Plane/Resources/plugins&lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; folder.&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+        </property>
+        <property name="textFormat">
+         <enum>Qt::RichText</enum>
+        </property>
+        <property name="wordWrap">
+         <bool>true</bool>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <widget class="QGroupBox" name="gb_DownloadAndInstall">
+     <property name="title">
+      <string>Download and install XSwiftBus</string>
+     </property>
+     <layout class="QGridLayout" name="gridLayout">
+      <item row="0" column="1">
+       <widget class="QLineEdit" name="le_XSwiftBusPluginDir">
+        <property name="placeholderText">
+         <string>X-Plane/Resources/plugins</string>
+        </property>
+       </widget>
+      </item>
+      <item row="2" column="1">
+       <widget class="QComboBox" name="cb_DownloadFile"/>
+      </item>
+      <item row="2" column="0">
+       <widget class="QLabel" name="lbl_Version">
+        <property name="text">
+         <string>Version:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="0">
+       <widget class="QLabel" name="lbl_XSwiftBusPluginDir">
+        <property name="text">
+         <string>Install directory:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="1">
+       <widget class="QLineEdit" name="le_DownloadDir"/>
+      </item>
+      <item row="1" column="0">
+       <widget class="QLabel" name="lbl_DownloadDirectory">
+        <property name="text">
+         <string>Download directory:</string>
+        </property>
+       </widget>
+      </item>
+      <item row="2" column="2" colspan="2">
+       <widget class="QPushButton" name="pb_Download">
+        <property name="toolTip">
+         <string>download and install</string>
+        </property>
+        <property name="text">
+         <string> download</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="3">
+       <widget class="QPushButton" name="pb_DialogDownloadDir">
+        <property name="text">
+         <string>...</string>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="3">
+       <widget class="QPushButton" name="pb_DialogInstallDir">
+        <property name="text">
+         <string>...</string>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="2">
+       <widget class="QPushButton" name="pb_OpenInstallDir">
+        <property name="text">
+         <string>open</string>
+        </property>
+       </widget>
+      </item>
+      <item row="1" column="2">
+       <widget class="QPushButton" name="pb_OpenDownloadDir">
+        <property name="text">
+         <string>open</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <widget class="QGroupBox" name="gb_XSwiftBusSettings">
+     <property name="title">
+      <string>XSwiftBusSettings</string>
+     </property>
+     <layout class="QVBoxLayout" name="verticalLayout_2">
+      <item>
+       <widget class="BlackGui::Components::CSettingsXSwiftBusComponent" name="comp_SettingsXSwiftBus">
+        <property name="minimumSize">
+         <size>
+          <width>0</width>
+          <height>25</height>
+         </size>
+        </property>
+        <property name="frameShape">
+         <enum>QFrame::StyledPanel</enum>
+        </property>
+        <property name="frameShadow">
+         <enum>QFrame::Raised</enum>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <spacer name="vs_XSwiftBusComponent">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>40</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+  </layout>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>BlackGui::Components::CSettingsXSwiftBusComponent</class>
+   <extends>QFrame</extends>
+   <header>blackgui/components/settingsxswiftbuscomponent.h</header>
+   <container>1</container>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections/>
+</ui>