pilotclient/src/blackcore/setupreader.h

/* Copyright (C) 2015
 * 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 BLACKCORE_SETUPREADER_H
#define BLACKCORE_SETUPREADER_H

#include "blackcore/blackcoreexport.h"
#include "blackcore/data/globalsetup.h"
#include "blackcore/data/updateinfo.h"
#include "blackmisc/datacache.h"
#include "blackmisc/network/urllist.h"
#include "blackmisc/statusmessagelist.h"

#include <QCommandLineOption>
#include <QCoreApplication>
#include <QJsonObject>
#include <QList>
#include <QObject>
#include <QString>
#include <atomic>

class QNetworkReply;

namespace BlackMisc { class CLogCategoryList; }
namespace BlackCore
{
    //! Read the central URLs / locations of our data / setup.
    //!
    //! \details This class should be only used in BlackCore::CApplication. It will also trigger reading
    //!          update information.
    //!
    //! \note This class is no(!) BlackCore::CThreadedReader as it will be loaded once during startup
    //!       and reading setup data is fast. The read file is also called "bootstrap" file as it tells
    //!       swift which data are located where. Without that file we cannot start. Once the file is in place (ie in the cache)
    //!       it can be automatically updated.
    //!
    //! \sa BlackCore::Data::TGlobalSetup
    //! \sa BlackCore::Data::TUpdateInfo
    class BLACKCORE_EXPORT CSetupReader : public QObject
    {
        Q_OBJECT
        friend class CApplication; //!< only using class

    public:
        //! Categories
        static const BlackMisc::CLogCategoryList &getLogCategories();

        //! Has a given cmd line argument for bootstrap URL
        bool hasCmdLineBootstrapUrl() const;

        //! CMD line argument for bootstrap URL
        QString getCmdLineBootstrapUrl() const;

        //! Current setup (reader URLs, DB location, crash server)
        //! \remarks aka "bootstrap file"
        //! \threadsafe
        BlackCore::Data::CGlobalSetup getSetup() const;

        //! Update info (version, updates, download URLs)
        //! \threadsafe
        BlackCore::Data::CUpdateInfo getUpdateInfo() const;

        //! Last setup parsing error messages (if any)
        BlackMisc::CStatusMessageList getLastSetupReadErrorMessages() const;

    signals:
        //! Setup fetched or failed (from web, cache, or local file)
        void setupHandlingCompleted(bool available);

        //! Setup avialable (from web, cache
        void updateInfoAvailable(bool available);

    protected:
        //! Constructor
        explicit CSetupReader(QObject *parent);

        //! Load the data
        BlackMisc::CStatusMessageList asyncLoad();

        //! Parse cmd line arguments
        bool parseCmdLineArguments();

        //! Add cmd line arguments to BlackCore::CApplication
        QList<QCommandLineOption> getCmdLineOptions() const;

        //! Terminate
        void gracefulShutdown();

        //! Setup available?
        //! \threadsafe
        bool isSetupAvailable() const { return m_setupAvailable; }

        //! Version info available?
        //! \threadsafe
        bool isUpdateInfoAvailable() const { return m_updateInfoAvailable; }

    private slots:
        //! Setup has been read (aka bootstrap file)
        void ps_parseSetupFile(QNetworkReply *nwReply);

        //! Update info has been read
        void ps_parseUpdateInfoFile(QNetworkReply *nwReplyPtr);

        //! Do reading
        void ps_readSetup();

        //! Do reading
        void ps_readUpdateInfo();

        //! Setup has been changed
        void ps_setupChanged();

    private:
        //! Bootstrap mode
        enum BootstrapMode
        {
            Implicit,
            Explicit,
            CacheOnly
        };

        bool m_shutdown = false;
        std::atomic<bool> m_setupAvailable { false };
        std::atomic<bool> m_updateInfoAvailable { false };
        QString m_localSetupFileValue;                         //! Local file for setup, passed by cmd line arguments
        QString m_bootstrapUrlFileValue;                       //! Bootstrap URL if not local
        BootstrapMode m_bootstrapMode = Explicit;              //! How to bootstrap
        BlackMisc::Network::CFailoverUrlList m_bootstrapUrls;  //!< location of setup files
        BlackMisc::Network::CFailoverUrlList m_updateInfoUrls; //!< location of info files
        QCommandLineOption m_cmdBootstrapUrl;                  //!< bootstrap URL
        QCommandLineOption m_cmdBootstrapMode;                 //!< bootstrap mode
        mutable QReadWriteLock m_lockSetup;                    //!< lock for setup
        BlackMisc::CStatusMessageList m_setupReadErrorMsgs;    //!< last parsing error messages
        BlackMisc::CData<BlackCore::Data::TGlobalSetup> m_setup {this, &CSetupReader::ps_setupChanged};  //!< data cache setup
        BlackMisc::CData<BlackCore::Data::TUpdateInfo>  m_updateInfo {this};                             //!< data cache update info

        //! Read by local individual file and update cache from that
        BlackMisc::CStatusMessageList readLocalBootstrapFile(QString &fileName);

        //! Trigger reading
        BlackMisc::CStatusMessageList triggerReadSetup();

        //! Emit the availability signal and state and trigger follow up actions
        //! \threadsafe
        BlackMisc::CStatusMessageList manageSetupAvailability(bool webRead, bool localRead = false);

        //! Emit the available signal
        //! \threadsafe
        void manageUpdateAvailability(bool webRead);

        //! Set last setup parsing messages
        void setLastSetupReadErrorMessages(const BlackMisc::CStatusMessageList &messages);

        //! Convert string to mode
        static BootstrapMode stringToEnum(const QString &s);

        //! Bootsrap URL used for unit tests
        static const QString &unitTestBootstrapUrl();
    };
} // ns

#endif // guard