UpdateChecker.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: UpdateChecker
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/SoftwareService.h>
#include <NDEVR/ItemDownloader.h>
#include <NDEVR/File.h>
#include <NDEVR/String.h>
#include <NDEVR/Time.h>
#include <NDEVR/TimeSpan.h>
#include <NDEVR/INIFactory.h>
#include <QObject>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Provides logic for checking a source, typically online, for an update to the software 
    **/
    class NDEVR_WIDGETS_API UpdateChecker : public QObject, public SoftwareService
    {
        Q_OBJECT
    public:
        enum UpdateStatus
        {
              e_need_to_check
            , e_no_new_updates
            , e_update_available_to_download
            , e_update_available_to_install
            , e_could_not_connect
        };
        enum ReleaseChannel
        {
              e_alpha = 0
            , e_beta = 1
            , e_release = 2
            , e_lts_release = 3
        };
        UpdateChecker();
        UpdateChecker(String update_version);
        virtual void requestCheckForUpdate(const String& current_version = "") = 0;
        virtual bool requstDownloadUpdate();
        virtual bool requestInstallUpdate(bool wait_for_completion = false);
        virtual bool updateSupported() const;
        virtual String updateName() const { return m_update_file_name; };
        virtual String updateVersion() const { return m_update_version; };
        virtual String updateURLPage() const = 0;
        virtual String updateURLDownload() const { return m_update_url; };
        virtual bool updateRequiresApplicationClose() const;
        UpdateStatus updateStatus() const;
        void setUpdateStatus(UpdateStatus status);
        virtual INIFactory getINI();
        virtual void createUpdateFile(const String& installer_url, File output_location);
        virtual void processUpdateString(const String& s);
        Time lastUpdateCheckTime() const;
        uint08 currentDownloadSize() const;
        uint08 totalDownloadSize() const;
        fltp08 downloadPercent() const;
        File updateFile() const;
        void showUpdateDialogIfNeeded();
        void appStartupCheck();
        void setMaxNoUpdateTime(const TimeSpan& max_no_update_check_time); 
        virtual String defaultURLPathName() const;
    signals:
        void checkForUpdateCompletedSignal(UpdateStatus update);
        void updateDownloadCompletedSignal(const File& location);
        void percentChangedSignal();
        void statusChangedSignal();
    protected slots:
        void onUpdateDownloadCompleteSlot();
        void checkForUpdateCompleteSlot();
    protected:
        virtual void onCheckForUpdateComplete(){};
    protected:
        File m_download_location;
        ItemDownloader* m_downloader;
        String m_update_version;
        String m_update_url;
        String m_current_version;
        String m_update_file_name;
        Time m_last_application_update_check;
        TimeSpan m_max_no_update_time;
    private:
        void init();
        UpdateStatus m_status = UpdateStatus::e_need_to_check;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides place to set an update checker for checking for software updates.
    **/
    class NDEVR_WIDGETS_API UpdateCheckManager : public SoftwareServiceManager
    {
    public:
        static void SetApplicationUpdateChecker(UpdateChecker* checker);
        static UpdateChecker* ApplicationUpdateChecker();
        static Time CompileTime();
    private:
        static UpdateChecker* s_app_update_checker;
    };
}