ActivityStorageController.h

Go to the documentation of this file.

#pragma once
 
#include "JS8_Main/ActivityDB.h"
#include "JS8_Main/CallDetail.h"
 
#include <QElapsedTimer>
#include <QMap>
#include <QObject>
#include <QSet>
#include <QString>
#include <QTimer>
 
#include <functional>
#include <memory>
 
class Configuration;
class QSettings;
class QTextDocument;
class QTextEdit;

class ActivityStorageController : public QObject {
    Q_OBJECT
 
public:
    struct Context {
        Configuration const *config = nullptr;
        QSettings *settings = nullptr;
        Radio::Frequency defaultDial = 0;
        QTextEdit *rxTextEdit = nullptr;
        QMap<QString, CallDetail> *callActivity = nullptr;
        QMap<QString, int> const *inboxCounts = nullptr;
        QMap<QString, QMap<QString, CallDetail>> *callActivityBandCache =
            nullptr;
        QMap<QString, QString> const *rxTextBandCache = nullptr;
 
        std::function<void(QString const &)> showStatusMessage;
        std::function<void()> displayActivity;
        std::function<void()> clearRxFrameBlockNumbers;
        std::function<void()> clearActivityPanes;
        std::function<void()> clearRxPane;
        std::function<void()> clearCallActivityPane;
        std::function<void(QString const &)> cacheActivity;
        std::function<void(QString const &)> dropBandCache;
        std::function<void(QString const &)> restoreActivity;
        std::function<void()> clearBandCaches;
    };

    explicit ActivityStorageController(Context context,
                                       QObject *parent = nullptr);
    ~ActivityStorageController() override;
 
    // Startup

    bool importLegacyActivityIfNeeded();
    void beginStartupGrace();
    void showLegacyRxTextIfDegraded();
    void setupRxTextAutosave();
 
    // The bucket on screen

    QString currentBucket() const { return m_activityBand; }
    bool isBucketLoaded() const { return m_activityBandLoaded; }
    void bandUnchanged(QString const &band);
    void bandChanged(QString const &band);
    void bucketRestored(QString const &band, bool paneReloaded);
 
    // Writes

    void persistCallActivity(CallDetail const &d,
                             bool fallbackToCurrentBand = false);
    void adjustCallActivityOffsets(int hzDelta);
    void beginBatch();
    void endBatch();
 
    // User-facing clears

    void clearAllActivity();
    void clearRxActivity();
    void clearCallActivity();
    void removeStoredCall(QString const &call);
 
    // Shutdown

    void flushOnClose();
 
private:
    QString activityPath() const;
    ActivityDB *activityDB();
    QString activityConfigId() const;
    // single conversion pair, so a CallDetail field added later fails to
    // persist/restore loudly at the one site instead of silently in
    // hand-copied blocks
    ActivityDB::CallRecord toCallRecord(CallDetail const &) const;
    CallDetail fromCallRecord(ActivityDB::CallRecord const &) const;
    void seedActivityForBand(QString const &band);
    QString htmlBelowLegacyCopy(QTextDocument *doc) const;
    void purgeLegacyActivityIni();
    QString lastStoreError() const {
        return m_activityDB ? m_activityDB->error() : QString{};
    }
    void startActivityBatchIfPending();
    void saveRxTextForBand(QString const &band);
    void switchActivityBucket(QString const &band);
 
    Context m_ctx;
 
    std::unique_ptr<ActivityDB> m_activityDB;
    QElapsedTimer m_activityDBRetryTimer; // throttles reopen attempts
    QString m_activityBand;
    bool m_activityBandLoaded = false; // false until the first restore
    QSet<QString> m_activitySeeded;
    // Degraded start: the store was down, so readSettings showed the
    // legacy ini copy in the RX pane.
    bool m_rxTextLegacyShown = false;
    QString m_rxTextLegacyBand;
    int m_rxTextLegacyBlocks = 0;
    // Depth counter
    int m_activityBatchDepth = 0;
    bool m_activityBatchBeginFailed = false;
    QSet<QString> m_rxTextDirtyBands;
    // Set when a requested startup reset, or a clone's inherited-activity
    // copy, could not be applied
    bool m_activityStoreDisabled = false;
    // Set in flushOnClose
    bool m_activityShuttingDown = false;
    // False until the rig has actually reported a band, and set
    // unconditionally at close
    bool m_activityBandConfirmed = false;
    // Buckets the rig has actually reported this session
    QSet<QString> m_activityBandConfirmedBands;
    QElapsedTimer m_activityStartupTimer;
    QElapsedTimer m_seedRetryTimer; // throttles failed-seed retries
    QTimer m_rxTextSaveTimer; // debounces RX-text writes to activity.db3
    QTimer m_rxTextSaveMaxTimer;
    // Storage id captured at first use
    mutable QString m_activityConfigId;
    // Skip unchanged RX-text rewrites via the document's revision counter
    int m_rxTextLastSavedRevision = -1;
    QString m_rxTextLastSavedBand;
};