DataManager.h

/***************************************************************************
 *   Copyright (C) 2019-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QQmlEngine>
#include <QStandardPaths>
 
#include "GlobalObject.h"
#include "dataManagement/Downloadable_MultiFile.h"
#include "dataManagement/Downloadable_SingleFile.h"
#include "units/ByteSize.h"
 
 
namespace DataManagement {

 
class DataManager : public GlobalObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    explicit DataManager(QObject* parent=nullptr);
 
    ~DataManager() override = default;
 
    // No default constructor, important for QML singleton
    explicit DataManager() = delete;
 
    // factory function for QML singleton
    static DataManagement::DataManager* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
    {
        return GlobalObject::dataManager();
    }
 
 
    // deferred initialization
    void deferredInitialization() override;
 
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(bool appUpdateRequired READ appUpdateRequired NOTIFY appUpdateRequiredChanged)
 
    
    Q_PROPERTY(DataManagement::Downloadable_MultiFile* aviationMaps READ aviationMaps CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* baseMapsRaster READ baseMapsRaster CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* baseMapsVector READ baseMapsVector CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* baseMaps READ baseMaps CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* databases READ databases CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* items READ items CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_SingleFile* mapList READ mapList CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* mapsAndData READ mapsAndData CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* mapSets READ mapSets CONSTANT)

    Q_PROPERTY(DataManagement::Downloadable_MultiFile* terrainMaps READ terrainMaps CONSTANT)

    Q_PROPERTY(QString whatsNew READ whatsNew NOTIFY whatsNewChanged)

    Q_PROPERTY(Units::ByteSize whatsNewHash READ whatsNewHash NOTIFY whatsNewChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] bool appUpdateRequired() const { return m_appUpdateRequired; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* aviationMaps() { return &m_aviationMaps; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* baseMaps() { return &m_baseMaps; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* baseMapsRaster() { return &m_baseMapsRaster; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* baseMapsVector() { return &m_baseMapsVector; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* databases() { return &m_databases; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* items() { return &m_items; }

    [[nodiscard]] DataManagement::Downloadable_SingleFile* mapList() { return &m_mapList; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* mapsAndData() { return &m_mapsAndData; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* mapSets() { return &m_mapSets; }

    [[nodiscard]] DataManagement::Downloadable_MultiFile* terrainMaps() { return &m_terrainMaps; }

    [[nodiscard]] QString whatsNew() const { return m_whatsNew; }

    [[nodiscard]] Units::ByteSize whatsNewHash() const { return qHash(m_whatsNew, 0); }
 
 
    //
    // Methods
    //

    Q_INVOKABLE QString import(const QString& fileName, const QString& newName);

    Q_INVOKABLE QString importOpenAir(const QString& fileName, const QString& newName);
 
public slots:
    void updateRemoteDataItemListIfOutdated();
 
signals:
    void appUpdateRequiredChanged();

    void error(const QString& message);

    void whatsNewChanged();
 
private:
    Q_DISABLE_COPY_MOVE(DataManager)
 
    // Clean the data directory.
    //
    // - delete all files with unexpected file names
    // - earlier versions of this program constructed files with names ending in
    //   ".geojson.geojson" or ".mbtiles.mbtiles". We correct those file names
    //   here.
    // - remove all empty sub directories
    void cleanDataDirectory();
 
    // This slot is called when a local file of one of the Downloadables changes
    // content or existence. If the Downloadable in question has no file
    // anymore, and has an invalid URL, it is then removed.
    void onItemFileChanged();
 
    // This slot updates the DownloadableGroups as well as the propery
    // 'whatsNew', by reading the file 'maps.json' and by checking the data
    // directory for locally installed, unsupported files.
    void updateDataItemListAndWhatsNew();
 
    // This method checks if a Downloadable item with the given url and
    // localFileName already exists in _items. If so, it returns a pointer to
    // that item. If not, then a Downloadable with the url and localFileName is
    // created and added to _items. Depending on localFileName, it will also be
    // added to _aviationMap, _baseMaps, or _databases. A pointer to that item is
    // then returned.
    DataManagement::Downloadable_SingleFile* createOrRecycleItem(const QUrl& url, const QString& localFileName, const QGeoRectangle& bBox);
 
    bool m_appUpdateRequired {false};
 
    // Full path name of data directory, without trailing slash
    QString m_dataDirectory {QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + "/aviation_maps"};
 
    // The current whats new string from _aviationMaps.
    QString m_whatsNew;
 
    // This Downloadable object manages the central text file that describes the
    // remotely available aviation maps.
    DataManagement::Downloadable_SingleFile m_mapList { QUrl(QStringLiteral("https://enroute-data.akaflieg-freiburg.de/enroute-GeoJSONv003/maps.json")), QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + "/maps.json" };
 
    // List of geographic maps
    DataManagement::Downloadable_MultiFile m_aviationMaps {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_baseMaps {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_baseMapsRaster {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_baseMapsVector {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_databases {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_items {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_mapsAndData {DataManagement::Downloadable_MultiFile::SingleUpdate};
    DataManagement::Downloadable_MultiFile m_terrainMaps {DataManagement::Downloadable_MultiFile::SingleUpdate};
 
    // List of geographic map sets
    DataManagement::Downloadable_MultiFile m_mapSets  {DataManagement::Downloadable_MultiFile::SingleUpdate};
};
 
} // namespace DataManagement