AvailableMapsModel.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_AVAILABLEMAPSMODEL_H
#define OSMSCOUT_CLIENT_QT_AVAILABLEMAPSMODEL_H

/*
  OSMScout - a Qt backend for libosmscout and libosmscout-map
  Copyright (C) 2016 Lukas Karas

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/

#include <QAbstractListModel>
#include <QNetworkAccessManager>
#include <QNetworkDiskCache>
#include <QNetworkReply>

#include <osmscout/MapProvider.h>
#include <osmscout/Settings.h>

namespace osmscout {

class OSMSCOUT_CLIENT_QT_API AvailableMapsModelItem : public QObject {
  Q_OBJECT

  Q_PROPERTY(bool valid READ isValid() CONSTANT)
  Q_PROPERTY(QString name READ getName() CONSTANT)
  Q_PROPERTY(QStringList path READ getPath() CONSTANT)
  Q_PROPERTY(QString description READ getDescription() CONSTANT)

private:
  bool valid{false};
  QString name;
  QStringList path;
  QString description;

public:
  AvailableMapsModelItem() = default;

  AvailableMapsModelItem(const QString &name, const QStringList &path, const QString &description):
    valid(true), name(name), path(path), description(description){};

  AvailableMapsModelItem(const AvailableMapsModelItem &o):
    QObject(o.parent()),
    valid(o.valid), name(o.name), path(o.path), description(o.description){};

  ~AvailableMapsModelItem() override = default;

  AvailableMapsModelItem& operator=(const AvailableMapsModelItem &o)
  {
    valid=o.valid;
    name=o.name;
    path=o.path;
    description=o.description;
    return *this;
  }

  QString getName() const
  {
    return name;
  }

  QStringList getPath() const
  {
    return path;
  }

  QString getDescription() const
  {
    return description;
  }

  bool isValid() const
  {
    return valid;
  }

  virtual bool isDirectory() const = 0;
};

class OSMSCOUT_CLIENT_QT_API AvailableMapsModelDir : public AvailableMapsModelItem {
  Q_OBJECT

public:
  AvailableMapsModelDir(const QString &name, const QList<QString> &path, const QString &description):
    AvailableMapsModelItem(name, path, description){};

  AvailableMapsModelDir(const AvailableMapsModelDir &o) = default;

  ~AvailableMapsModelDir() override = default;

  bool isDirectory() const override
  {
    return true;
  };
};

class OSMSCOUT_CLIENT_QT_API AvailableMapsModelMap : public AvailableMapsModelItem {
  Q_OBJECT

  Q_PROPERTY(quint64 byteSize READ getSize() CONSTANT)
  Q_PROPERTY(QString size READ getSizeHuman() CONSTANT)
  Q_PROPERTY(QString serverDirectory READ getServerDirectory() CONSTANT)
  Q_PROPERTY(QDateTime time READ getCreation() CONSTANT)
  Q_PROPERTY(int version READ getVersion() CONSTANT)

private:
  MapProvider provider;
  uint64_t size{0};
  QString serverDirectory;
  QDateTime creation;
  int version{-1};

public:
  AvailableMapsModelMap() = default;

  AvailableMapsModelMap(const QString &name, const QList<QString> &path, const QString &description, const MapProvider &provider,
                               uint64_t size, const QString &serverDirectory, const QDateTime &creation, int version):
    AvailableMapsModelItem(name, path, description), provider(provider), size(size), serverDirectory(serverDirectory),
    creation(creation), version(version) {};

  AvailableMapsModelMap(const AvailableMapsModelMap &o) = default;

  ~AvailableMapsModelMap() override = default;

  bool isDirectory() const override
  {
    return false;
  };

  AvailableMapsModelMap& operator=(const AvailableMapsModelMap &o) = default;

  MapProvider getProvider() const;
  uint64_t getSize() const;
  QString getSizeHuman() const;
  QString getServerDirectory() const;
  QDateTime getCreation() const;
  int getVersion() const;
};

class OSMSCOUT_CLIENT_QT_API AvailableMapsModel : public QAbstractItemModel {
  Q_OBJECT

  Q_PROPERTY(bool loading READ isLoading NOTIFY loadingChanged)
  Q_PROPERTY(QString fetchError READ getFetchError NOTIFY loadingChanged)

signals:
  void loadingChanged();

public slots:
  void listDownloaded(const MapProvider &provider, QNetworkReply*);
  void reload();

public:
  AvailableMapsModel();

  ~AvailableMapsModel() override;

  enum Roles {
    NameRole = Qt::UserRole, // localized name
    PathRole = Qt::UserRole+1, // path in tree
    DirRole = Qt::UserRole+2, // isDir? true: false
    ServerDirectoryRole = Qt::UserRole+3, // server path for this map
    TimeRole = Qt::UserRole+4, // QTime of map creation
    VersionRole = Qt::UserRole+5,
    ByteSizeRole = Qt::UserRole+6,
    ProviderUriRole = Qt::UserRole+7,
    DescriptionRole = Qt::UserRole+8,
    SizeRole = Qt::UserRole+9,
    MapRole = Qt::UserRole+10,
  };
  Q_ENUM(Roles)

  Q_INVOKABLE int rowCount(const QModelIndex &parent = QModelIndex()) const override;
  Q_INVOKABLE int columnCount(const QModelIndex &parent = QModelIndex()) const override;
  Q_INVOKABLE QModelIndex index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const override;
  Q_INVOKABLE QModelIndex parent(const QModelIndex &index) const override;

  Q_INVOKABLE QVariant data(const QModelIndex &index, int role) const override;
  QHash<int, QByteArray> roleNames() const override;
  Q_INVOKABLE Qt::ItemFlags flags(const QModelIndex &index) const override;

  Q_INVOKABLE QVariant map(const QModelIndex &index) const;

   Q_INVOKABLE QVariant timeOfMap(QStringList path);
   Q_INVOKABLE QObject* mapByPath(QStringList path);

  bool isLoading() const{
    return requests>0;
  }

  QString getFetchError() const {
    return fetchError;
  }

private:
  void append(AvailableMapsModelItem *item);
  QList<AvailableMapsModelItem *> findChildrenByPath(QStringList dir) const;

  QNetworkAccessManager     webCtrl;
  QNetworkDiskCache         diskCache;
  QList<MapProvider>        mapProviders;
  size_t                    requests{0};
  QList<AvailableMapsModelItem*> items;
  QString                   fetchError;
};

}

Q_DECLARE_METATYPE(osmscout::AvailableMapsModelMap)

#endif  /* OSMSCOUT_CLIENT_QT_AVAILABLEMAPMODEL_H */