Downloadable_MultiFile.h

/***************************************************************************
 *   Copyright (C) 2022-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 "dataManagement/Downloadable_Abstract.h"
 
namespace DataManagement {
 

 
class Downloadable_MultiFile : public Downloadable_Abstract {
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
 
public:
    enum UpdatePolicy : quint8{
        SingleUpdate, 
        MultiUpdate   
    };
    Q_ENUM(UpdatePolicy)
 
    
    explicit Downloadable_MultiFile(DataManagement::Downloadable_MultiFile::UpdatePolicy updatePolicy, QObject *parent = nullptr);
 
    // Standard destructor
    ~Downloadable_MultiFile() override;
 
 
    //
    // PROPERTIES
    //
 
    // Repeated from Downloadable_Abstract to keep QML happy
    Q_PROPERTY(bool downloading READ downloading NOTIFY downloadingChanged)
    Q_PROPERTY(QStringList files READ files NOTIFY filesChanged)
    Q_PROPERTY(bool hasFile READ hasFile BINDABLE bindableHasFile NOTIFY hasFileChanged)
    Q_PROPERTY(Units::ByteSize updateSize READ updateSize NOTIFY updateSizeChanged)

    Q_PROPERTY(QVector<DataManagement::Downloadable_Abstract*> downloadables READ downloadables NOTIFY downloadablesChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto description() -> QString override;

    [[nodiscard]] QVector<DataManagement::Downloadable_Abstract*> downloadables();

    [[nodiscard]] auto downloading() -> bool override { return m_downloading; }

    [[nodiscard]] auto files() -> QStringList override { return m_files; }

    [[nodiscard]] auto infoText() -> QString override;

    [[nodiscard]] auto remoteFileSize() -> qint64 override { return m_remoteFileSize; }

    [[nodiscard]] auto updateSize() -> Units::ByteSize override { return m_updateSize; }
 
 
 
    //
    // Methods
    //

    Q_INVOKABLE void add(DataManagement::Downloadable_Abstract* map);

    Q_INVOKABLE void add(const QVector<DataManagement::Downloadable_Abstract*>& maps);

    Q_INVOKABLE void clear();

    Q_INVOKABLE void deleteFiles() override;

    [[nodiscard]] Q_INVOKABLE QList<DataManagement::Downloadable_Abstract*> downloadables4Location(const QGeoCoordinate& location);

    [[nodiscard]] Q_INVOKABLE QList<DataManagement::Downloadable_Abstract*> downloadablesByDistance(const QGeoCoordinate& location);

    Q_INVOKABLE void remove(DataManagement::Downloadable_Abstract* map);

    Q_INVOKABLE void startDownload() override;

    Q_INVOKABLE void stopDownload() override;

    Q_INVOKABLE void update() override;
 
signals:
    void downloadablesChanged();
 
private:
    // Re-evaluate members when the properties of a member changes
    bool computeHasFile();
    void evaluateDownloading();
    void evaluateFiles();
    void evaluateRemoteFileSize();
    void evaluateUpdateSize();
 
    // Similar to 'add', but does not emit any notifier signals
    // Returns 'true' if item has actually been added.
    bool rawAdd(DataManagement::Downloadable_Abstract* map);
 
    bool m_downloading {false};
    QStringList m_files;
    qint64 m_remoteFileSize {-1};
    qint64 m_updateSize {0};
 
    QProperty<QVector<QPointer<DataManagement::Downloadable_Abstract>>> m_downloadables;
    DataManagement::Downloadable_MultiFile::UpdatePolicy m_updatePolicy;
};
 
} // namespace DataManagement