qdeclarativeplacecontentmodel.cpp

Go to the documentation of this file.

// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qdeclarativeplacecontentmodel_p.h"
#include "qdeclarativeplace_p.h"
#include "qdeclarativegeoserviceprovider_p.h"
#include "error_messages_p.h"
 
#include <QtQml/QQmlInfo>
#include <QtLocation/QGeoServiceProvider>
#include <QtLocation/QPlaceManager>
#include <QtLocation/QPlaceContentRequest>
#include <QtLocation/QPlaceUser>
 
QT_BEGIN_NAMESPACE
 
QDeclarativePlaceContentModel::QDeclarativePlaceContentModel(QPlaceContent::Type type,
                                                             QObject *parent)
    : QAbstractListModel(parent), m_type(type)
{
}
 
QDeclarativePlaceContentModel::~QDeclarativePlaceContentModel()
{
}
 
QDeclarativePlace *QDeclarativePlaceContentModel::place() const
{
    return m_place;
}
 
void QDeclarativePlaceContentModel::setPlace(QDeclarativePlace *place)
{
    if (m_place != place) {
        beginResetModel();
 
        int initialCount = m_contentCount;
        clearData();
        m_place = place;
        endResetModel();
 
        emit placeChanged();
        if (initialCount != -1)
            emit totalCountChanged();
 
        fetchMore(QModelIndex());
    }
}
 
int QDeclarativePlaceContentModel::batchSize() const
{
    return m_batchSize;
}
 
void QDeclarativePlaceContentModel::setBatchSize(int batchSize)
{
    if (m_batchSize != batchSize) {
        m_batchSize = batchSize;
        emit batchSizeChanged();
    }
}
 
int QDeclarativePlaceContentModel::totalCount() const
{
    return m_contentCount;
}
 
void QDeclarativePlaceContentModel::clearData()
{
    m_users.clear();
    m_suppliers.clear();
    m_content.clear();
 
    m_contentCount = -1;
 
    if (m_reply) {
        m_reply->abort();
        m_reply->deleteLater();
        m_reply = nullptr;
    }
 
    m_nextRequest.clear();
}
 
void QDeclarativePlaceContentModel::initializeCollection(int totalCount, const QPlaceContent::Collection &collection)
{
    beginResetModel();
 
    int initialCount = m_contentCount;
    clearData();
 
    for (auto i = collection.cbegin(), end = collection.cend(); i != end; ++i) {
        const QPlaceContent &content = i.value();
        if (content.type() != m_type)
            continue;
 
        m_content.insert(i.key(), content);
        const auto supplier = content.value(QPlaceContent::ContentSupplier)
                                     .value<QPlaceSupplier>();
        if (!m_suppliers.contains(supplier.supplierId()))
            m_suppliers.insert(supplier.supplierId(), supplier);
        const auto user = content.value(QPlaceContent::ContentUser)
                                 .value<QPlaceUser>();
        if (!m_users.contains(user.userId()))
            m_users.insert(user.userId(), user);
    }
 
    m_contentCount = totalCount;
 
    if (initialCount != totalCount)
        emit totalCountChanged();
 
    endResetModel();
}
 
int QDeclarativePlaceContentModel::rowCount(const QModelIndex &parent) const
{
    if (parent.isValid())
        return 0;
 
    return m_content.count();
}
 
QVariant QDeclarativePlaceContentModel::data(const QModelIndex &index, int role) const
{
    if (!index.isValid())
        return QVariant();
 
    if (index.row() >= rowCount(index.parent()) || index.row() < 0)
        return QVariant();
 
    const QPlaceContent &content = m_content.value(index.row());
    if (content.type() != m_type)
        return QVariant();
 
    switch (role) {
    case ContentSupplierRole:
        return QVariant::fromValue(m_suppliers.value(content.value(QPlaceContent::ContentSupplier)
                                              .value<QPlaceSupplier>().supplierId()));
    case ContentUserRole:
        return QVariant::fromValue(m_users.value(content.value(QPlaceContent::ContentUser)
                                          .value<QPlaceUser>().userId()));
    case ContentAttributionRole:
        return content.value(QPlaceContent::ContentAttribution);
    case ImageUrlRole:
        return content.value(QPlaceContent::ImageUrl);
    case ImageIdRole:
        return content.value(QPlaceContent::ImageId);
    case ImageMimeTypeRole:
        return content.value(QPlaceContent::ImageMimeType);
 
    case EditorialTextRole:
        return content.value(QPlaceContent::EditorialText);
    case EditorialTitleRole:
        return content.value(QPlaceContent::EditorialTitle);
    case EditorialLanguageRole:
        return content.value(QPlaceContent::EditorialLanguage);
 
    case ReviewDateTimeRole:
        return content.value(QPlaceContent::ReviewDateTime);
    case ReviewTextRole:
        return content.value(QPlaceContent::ReviewText);
    case ReviewLanguageRole:
        return content.value(QPlaceContent::ReviewLanguage);
    case ReviewRatingRole:
        return content.value(QPlaceContent::ReviewRating);
    case ReviewIdRole:
        return content.value(QPlaceContent::ReviewId);
    case ReviewTitleRole:
        return content.value(QPlaceContent::ReviewTitle);
    default:
        return QVariant();
    }
}
 
QHash<int, QByteArray> QDeclarativePlaceContentModel::roleNames() const
{
    QHash<int, QByteArray> roles = QAbstractListModel::roleNames();
    roles.insert(ContentSupplierRole, "supplier");
    roles.insert(ContentUserRole, "user");
    roles.insert(ContentAttributionRole, "attribution");
 
    switch (m_type) {
    case QPlaceContent::EditorialType:
        roles.insert(EditorialTextRole, "text");
        roles.insert(EditorialTitleRole, "title");
        roles.insert(EditorialLanguageRole, "language");
        break;
    case QPlaceContent::ImageType:
        roles.insert(ImageUrlRole, "url");
        roles.insert(ImageIdRole, "imageId");
        roles.insert(ImageMimeTypeRole, "mimeType");
        break;
    case QPlaceContent::ReviewType:
        roles.insert(ReviewDateTimeRole, "dateTime");
        roles.insert(ReviewTextRole, "text");
        roles.insert(ReviewLanguageRole, "language");
        roles.insert(ReviewRatingRole, "rating");
        roles.insert(ReviewIdRole, "reviewId");
        roles.insert(ReviewTitleRole, "title");
        break;
    default:
        break;
    }
    return roles;
}
 
bool QDeclarativePlaceContentModel::canFetchMore(const QModelIndex &parent) const
{
    if (parent.isValid())
        return false;
 
    if (!m_place)
        return false;
 
    if (m_contentCount == -1)
        return true;
 
    return m_content.count() != m_contentCount;
}
 
void QDeclarativePlaceContentModel::fetchMore(const QModelIndex &parent)
{
    if (parent.isValid())
        return;
 
    if (!m_place)
        return;
 
    if (m_reply)
        return;
 
    if (!m_place->plugin())
        return;
 
    QDeclarativeGeoServiceProvider *plugin = m_place->plugin();
 
    QGeoServiceProvider *serviceProvider = plugin->sharedGeoServiceProvider();
    if (!serviceProvider)
        return;
 
    QPlaceManager *placeManager = serviceProvider->placeManager();
    if (!placeManager)
        return;
 
    if (m_nextRequest == QPlaceContentRequest()) {
        QPlaceContentRequest request;
        request.setContentType(m_type);
        request.setPlaceId(m_place->place().placeId());
        request.setLimit(m_batchSize);
 
        m_reply = placeManager->getPlaceContent(request);
    } else {
        m_reply = placeManager->getPlaceContent(m_nextRequest);
    }
 
    connect(m_reply, &QPlaceReply::finished,
            this, &QDeclarativePlaceContentModel::fetchFinished, Qt::QueuedConnection);
}
 
void QDeclarativePlaceContentModel::classBegin()
{
}
 
void QDeclarativePlaceContentModel::componentComplete()
{
    m_complete = true;
    fetchMore(QModelIndex());
}
 
void QDeclarativePlaceContentModel::fetchFinished()
{
    if (!m_reply)
        return;
 
    QPlaceContentReply *reply = m_reply;
    m_reply = nullptr;
 
    m_nextRequest = reply->nextPageRequest();
 
    if (m_contentCount != reply->totalCount()) {
        m_contentCount = reply->totalCount();
        emit totalCountChanged();
    }
 
    if (!reply->content().isEmpty()) {
        QPlaceContent::Collection contents = reply->content();
 
        //find out which indexes are new and which ones have changed.
        QList<int> changedIndexes;
        QList<int> newIndexes;
        for (auto it = contents.cbegin(), end = contents.cend(); it != end; ++it) {
            if (!m_content.contains(it.key()))
                newIndexes.append(it.key());
            else if (it.value() != m_content.value(it.key()))
                changedIndexes.append(it.key());
        }
 
        //insert new indexes in blocks where within each
        //block, the indexes are consecutive.
        int startIndex = -1;
        for (auto it = newIndexes.cbegin(), end = newIndexes.cend(); it != end; ++it) {
            int currentIndex = *it;
            if (startIndex == -1)
                startIndex = currentIndex;
 
            auto next = std::next(it);
            if (next == end || *next > (currentIndex + 1)) {
                beginInsertRows(QModelIndex(),startIndex,currentIndex);
                for (int i = startIndex; i <= currentIndex; ++i) {
                    const QPlaceContent &content = contents.value(i);
 
                    m_content.insert(i, content);
                    const auto supplier = content.value(QPlaceContent::ContentSupplier)
                                                 .value<QPlaceSupplier>();
                    if (!m_suppliers.contains(supplier.supplierId()))
                        m_suppliers.insert(supplier.supplierId(), supplier);
                    const auto user = content.value(QPlaceContent::ContentUser)
                                             .value<QPlaceUser>();
                    if (!m_users.contains(user.userId()))
                        m_users.insert(user.userId(), user);
                }
                endInsertRows();
                startIndex = -1;
            }
        }
 
        //modify changed indexes in blocks where within each
        //block, the indexes are consecutive.
        startIndex = -1;
        for (auto it = changedIndexes.cbegin(), end = changedIndexes.cend(); it != end; ++it) {
            int currentIndex = *it;
            if (startIndex == -1)
                startIndex = currentIndex;
 
            auto next = std::next(it);
            if (next == end || *next > (currentIndex + 1)) {
                for (int i = startIndex; i <= currentIndex; ++i) {
                    const QPlaceContent &content = contents.value(i);
                    m_content.insert(i, content);
                    const auto supplier = content.value(QPlaceContent::ContentSupplier)
                                                 .value<QPlaceSupplier>();
                    if (!m_suppliers.contains(supplier.supplierId()))
                        m_suppliers.insert(supplier.supplierId(), supplier);
                    const auto user = content.value(QPlaceContent::ContentUser)
                                             .value<QPlaceUser>();
                    if (!m_users.contains(user.userId()))
                        m_users.insert(user.userId(), user);
                }
                emit dataChanged(index(startIndex),index(currentIndex));
                startIndex = -1;
            }
        }
 
        // The fetch didn't add any new content and we haven't fetched all content yet. This is
        // likely due to the model being prepopulated by Place::getDetails(). Keep fetching more
        // data until new content is available.
        if (newIndexes.isEmpty() && m_content.count() != m_contentCount)
            fetchMore(QModelIndex());
    }
 
    reply->deleteLater();
}
 
QT_END_NAMESPACE