path: root/src/plugins/geoservices/nokia_places_jsondb/qplacemanagerengine_jsondb.cpp

/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: http://www.qt-project.org/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qplacemanagerengine_jsondb.h"

#include <QtCore/QDebug>
#include <QtCore/qnumeric.h>

#include <QtAddOnJsonDb/jsondb-client.h>
#include <QtAddOnJsonDb/jsondb-error.h>

#include "detailsreply.h"
#include "reply.h"
#include "idreply.h"
#include "matchreply.h"
#include "searchreply.h"
#include "unsupportedreplies.h"

QT_USE_NAMESPACE

QPlaceManagerEngineJsonDb::QPlaceManagerEngineJsonDb(const QMap<QString, QVariant> &parameters,
                                                     QGeoServiceProvider::Error *error,
                                                     QString *errorString)
:   QPlaceManagerEngine(parameters)
{
    qRegisterMetaType<QPlaceReply::Error>();
    qRegisterMetaType<QPlaceReply *>();
    qRegisterMetaType<QPlaceCategory>();

    m_db = new JsonDbClient(this);

    connect(m_db, SIGNAL(response(int,QVariant)),
            this, SLOT(processJsonDbResponse(int,QVariant)));
    connect(m_db, SIGNAL(error(int,int,QString)),
            this, SLOT(processJsonDbError(int,int,QString)));

    m_notificationUuid = m_db->registerNotification(JsonDbClient::NotifyCreate | JsonDbClient::NotifyUpdate | JsonDbClient::NotifyRemove,
                                QString::fromLatin1("[?%1 = \"%2\" | %1 = \"%3\" ]").arg(JsonConverter::Type).arg(JsonConverter::PlaceType).arg(JsonConverter::CategoryType),
                                QString(), this, SLOT(processJsonDbNotification(QString,QtAddOn::JsonDb::JsonDbNotification)));

    *error = QGeoServiceProvider::NoError;
    errorString->clear();
}

QPlaceManagerEngineJsonDb::~QPlaceManagerEngineJsonDb()
{
    delete m_db;
}

QPlaceDetailsReply *QPlaceManagerEngineJsonDb::getPlaceDetails(const QString &placeId)
{
    DetailsReply *detailsReply = new DetailsReply(this);
    detailsReply->setPlaceId(placeId);
    detailsReply->start();
    return detailsReply;
}

QPlaceContentReply *QPlaceManagerEngineJsonDb::getPlaceContent(const QString &placeId, const QPlaceContentRequest &request)
{
    Q_UNUSED(placeId)
    Q_UNUSED(request)

    ContentReply *contentReply = new ContentReply(this);
    contentReply->triggerDone(QPlaceReply::UnsupportedError, QString::fromLatin1("Fetching content is unsupported"));
    return contentReply;
}

QPlaceSearchReply *QPlaceManagerEngineJsonDb::search(const QPlaceSearchRequest &request)
{
    SearchReply *searchReply = new SearchReply(this);
    searchReply->setRequest(request);
    searchReply->start();
    return searchReply;
}

QPlaceSearchReply *QPlaceManagerEngineJsonDb::recommendations(const QString &placeId, const QPlaceSearchRequest &request)
{
    Q_UNUSED(placeId);
    SearchReply *searchReply = new SearchReply(this);
    searchReply->setRequest(request);
    searchReply->triggerDone(QPlaceReply::UnsupportedError, QString::fromLatin1("Recommendations are unsupported"));
    return searchReply;
}

QPlaceSearchSuggestionReply *QPlaceManagerEngineJsonDb::searchSuggestions(const QPlaceSearchRequest &request)
{
    Q_UNUSED(request)

    SearchSuggestionReply *searchSuggestionReply = new SearchSuggestionReply(this);
    searchSuggestionReply->triggerDone(QPlaceReply::UnsupportedError, QString::fromLatin1("Search suggestions are unsupported"));
    return searchSuggestionReply;
}

QPlaceIdReply *QPlaceManagerEngineJsonDb::savePlace(const QPlace &place)
{
    SavePlaceReply *saveReply = new SavePlaceReply(this);
    saveReply->setPlace(place);
    saveReply->start();
    return saveReply;
}

QPlaceIdReply *QPlaceManagerEngineJsonDb::saveCategory(const QPlaceCategory &category, const QString &parentId)
{
    SaveCategoryReply *reply = new SaveCategoryReply(this);
    reply->setCategory(category);
    reply->setParentId(parentId);
    reply->start();
    return reply;
}

QPlaceIdReply *QPlaceManagerEngineJsonDb::removePlace(const QString &placeId)
{
    RemovePlaceReply *removeReply = new RemovePlaceReply(this);
    removeReply->setId(placeId);
    removeReply->start();
    return removeReply;
}

QPlaceIdReply *QPlaceManagerEngineJsonDb::removeCategory(const QString &categoryId)
{
    RemoveCategoryReply *reply = new RemoveCategoryReply(this);
    reply->setId(categoryId);
    reply->start();
    return reply;
}

QPlaceReply *QPlaceManagerEngineJsonDb::initializeCategories()
{
    Reply *reply = new Reply(this);
    reply->triggerDone();
    return reply;
}

QString QPlaceManagerEngineJsonDb::parentCategoryId(const QString &categoryId) const
{
    int reqId = m_db->query(QString("[?%1=\"%2\"][?%3 = \"%4\"]").arg(JsonConverter::Type).arg(JsonConverter::CategoryType)
                                      .arg(JsonConverter::Uuid).arg(categoryId));

    QVariantMap responseMap;
    //TODO: don't spin the event loop, instead try and have all category
    //      data cached since it shouldn't be too large.
    if (!waitForRequest(reqId, &responseMap)) {
        return QString();
    }

    if (responseMap.value(JsonConverter::Length).toInt() <= 0)
        return QString();

    return responseMap.value(JsonConverter::Data).toList()
            .first().toMap().value(JsonConverter::CategoryParentId).toString();
}

QStringList QPlaceManagerEngineJsonDb::childCategoryIds(const QString &categoryId) const
{
    QStringList result;
    QList<QPlaceCategory> children = childCategories(categoryId);
    foreach (const QPlaceCategory &child, children)
        result.append(child.categoryId());

    return result;
}

QPlaceCategory QPlaceManagerEngineJsonDb::category(const QString &categoryId) const
{
    if (categoryId.isEmpty())
        return QPlaceCategory();

    int reqId =  m_db->query(queryCategoryString(categoryId));
    QVariantMap response;
    if (!waitForRequest(reqId, &response))
        return QPlaceCategory();

    if (response.value(JsonConverter::Length).toInt() <= 0) {
        return QPlaceCategory();
    }

    return JsonConverter::convertJsonMapToCategory(response.value(JsonConverter::Data).toList().first().toMap(), this);
}

QList<QPlaceCategory> QPlaceManagerEngineJsonDb::childCategories(const QString &parentId) const
{
    int reqId = m_db->query(QString("[?%1=\"%2\"][?%3 = \"%4\"]").arg(JsonConverter::Type).arg(JsonConverter::CategoryType)
                .arg(JsonConverter::CategoryParentId).arg(parentId));

    QVariantMap responseMap;
    if (!waitForRequest(reqId, &responseMap)) {
        return QList<QPlaceCategory>();
    }

    if (responseMap.value(JsonConverter::Length).toInt() <= 0)
        return QList<QPlaceCategory>();

    return JsonConverter::convertJsonResponseToCategories(responseMap, this);
}

QList<QLocale> QPlaceManagerEngineJsonDb::locales() const
{
    return QList<QLocale>();
}

void QPlaceManagerEngineJsonDb::setLocales(const QList<QLocale> &locales)
{
    Q_UNUSED(locales);
}

QPlace QPlaceManagerEngineJsonDb::compatiblePlace(const QPlace &original) const
{
    QPlace place;
    place.setName(original.name());

    QGeoLocation location = original.location();
    QGeoCoordinate coord = original.location().coordinate();
    coord.setAltitude(qQNaN());
    location.setCoordinate(coord);
    location.setBoundingBox(QGeoBoundingBox());
    place.setLocation(location);

    QList<QPlaceContactDetail> details;
    foreach (const QString &contactType, original.contactTypes())
        place.setContactDetails(contactType, original.contactDetails(contactType));

    place.setVisibility(QtLocation::UnspecifiedVisibility);

    QStringList attributeTypes = original.extendedAttributeTypes();
    foreach (const QString &attributeType, attributeTypes) {
        if (attributeType.startsWith(QLatin1String("x_id")))
            place.setExtendedAttribute(attributeType, original.extendedAttribute(attributeType));
    }

    if (attributeTypes.contains(QLatin1String("x_provider")) && !original.extendedAttribute(QLatin1String("x_provider")).text().isEmpty()) {
        QPlaceAttribute alternativeId;
        alternativeId.setText(original.placeId());
        place.setExtendedAttribute(QString::fromLatin1("x_id_") + original.extendedAttribute(QLatin1String("x_provider")).text(),
                                   alternativeId);
    }

    QVariantMap parameters;
    QPlaceIcon originalIcon = original.icon();
    if (!originalIcon.isEmpty()) {
        if (originalIcon.parameters().contains(QPlaceIcon::SingleUrl)) {
            parameters.insert(Icon::MediumSource, originalIcon.url(Icon::MediumSize));
        } else if (originalIcon.manager()) {
            if (!originalIcon.url(Icon::SmallSize).isEmpty())
                parameters.insert(Icon::SmallSource, originalIcon.url(Icon::SmallSize));
            if (!originalIcon.url(Icon::MediumSize).isEmpty())
                parameters.insert(Icon::MediumSource, originalIcon.url(Icon::MediumSize));
            if (!originalIcon.url(Icon::LargeSize).isEmpty())
                parameters.insert(Icon::LargeSource, originalIcon.url(Icon::LargeSize));
        }
    }

    if (!parameters.isEmpty()) {
        QPlaceIcon icon;
        icon.setParameters(parameters);
        icon.setManager(manager());
        place.setIcon(icon);
    }

    return place;
}


QUrl QPlaceManagerEngineJsonDb::constructIconUrl(const QPlaceIcon &icon, const QSize &size) const
{
    QList<QPair<int, QUrl> > candidates;
    //TODO: possible optimizations
    QMap<QString, QSize> sizeDictionary;
    sizeDictionary.insert(Icon::SmallDestination, Icon::SmallSize);

    sizeDictionary.insert(Icon::MediumDestination, Icon::MediumSize);
    sizeDictionary.insert(Icon::LargeDestination, Icon::LargeSize);
    sizeDictionary.insert(Icon::FullscreenDestination, Icon::FullscreenSize);

    QStringList sizeKeys;
    sizeKeys << "small" <<  "medium" << "large"
             << "fullscreen";

    foreach (const QString &sizeKey, sizeKeys) {
        if (icon.parameters().contains(sizeKey + QLatin1String("Url"))) {
            QSize destSize = icon.parameters().value(sizeKey + QLatin1String("Size")).toSize();
            if (destSize.isEmpty()) {
                candidates.append(QPair<int, QUrl>(sizeDictionary.value(sizeKey + QLatin1String("Url")).height(),
                                                   icon.parameters().value(sizeKey + QLatin1String("Url")).toUrl()));
            } else {
                candidates.append(QPair<int, QUrl>(destSize.height(),
                                                   icon.parameters().value(sizeKey + QLatin1String("Url")).toUrl()));
            }
        }
    }

    if (candidates.isEmpty())
        return QUrl();
    else if (candidates.count() == 1) {
        return candidates.first().second;
    } else {
        //we assume icons are squarish so we can use height to
        //determine which particular icon to return
        int requestedHeight = size.height();

        for (int i = 0; i < candidates.count() - 1; ++i) {
            int thresholdHeight = (candidates.at(i).first + candidates.at(i+1).first) / 2;
            if (requestedHeight < thresholdHeight)
                return candidates.at(i).second;
        }
        return candidates.last().second;
    }
}

QPlaceManager::ManagerFeatures QPlaceManagerEngineJsonDb::supportedFeatures() const
{
    return QPlaceManager::SavePlaceFeature |
           QPlaceManager::RemovePlaceFeature |
           QPlaceManager::SaveCategoryFeature |
           QPlaceManager::RemoveCategoryFeature |
           QPlaceManager::MatchingFeature;
}

QPlaceMatchReply * QPlaceManagerEngineJsonDb::matchingPlaces(const QPlaceMatchRequest &request)
{
    MatchReply *reply = new MatchReply(this);
    reply->setRequest(request);
    reply->start();
    return reply;
}

void QPlaceManagerEngineJsonDb::processJsonDbResponse(int id, const QVariant &data)
{
    if (m_helperMap.contains(id)) {
        m_helperMap.insert(id, data);
        m_eventLoop.exit();
    }
}

void QPlaceManagerEngineJsonDb::processJsonDbError(int id, int code, const QString &jsonDbErrorString)
{
    Q_UNUSED(code)
    Q_UNUSED(jsonDbErrorString)

    if (m_helperMap.contains(id)) {
        m_helperMap.insert(id, false);
        m_eventLoop.exit();
    }
}

void QPlaceManagerEngineJsonDb::processJsonDbNotification(const QString &notifyUuid, const QtAddOn::JsonDb::JsonDbNotification &notification)
{
    Q_ASSERT(notifyUuid == m_notificationUuid);
    QVariantMap object = notification.object();
    if (object.value(JsonConverter::Type).toString() == JsonConverter::PlaceType) {
        if (notification.action() & JsonDbClient::NotifyCreate)
            emit placeAdded(object.value(JsonConverter::Uuid).toString());
        else if (notification.action() & JsonDbClient::NotifyUpdate)
            emit placeUpdated(object.value(JsonConverter::Uuid).toString());
        else if (notification.action() & JsonDbClient::NotifyRemove)
            emit placeRemoved(object.value(JsonConverter::Uuid).toString());
    } else if (object.value(JsonConverter::Type).toString() == JsonConverter::CategoryType) {
        QPlaceCategory category = JsonConverter::convertJsonMapToCategory(object, this);
        QStringList ancestors = object.value(JsonConverter::Ancestors).toStringList();
        QString parentId;
        if (ancestors.count() >= 2) {
            ancestors.takeLast();//last element in ancestors is always the uuid of the catgory itself
            parentId = ancestors.takeLast(); //the 2nd last element must be the parent;
        }

        if (notification.action() & JsonDbClient::NotifyCreate)
            emit categoryAdded(category, parentId);
        else if (notification.action() & JsonDbClient::NotifyUpdate)
            emit categoryUpdated(category, parentId);
        else if (notification.action() & JsonDbClient::NotifyRemove)
            emit categoryRemoved(category.categoryId(), parentId);
    }
}

bool QPlaceManagerEngineJsonDb::waitForRequest(int reqId, QVariantMap *variantMap) const
{
    m_helperMap.insert(reqId, QVariant());
    m_eventLoop.exec(QEventLoop::AllEvents);

    QVariant response = m_helperMap.value(reqId);
    if (response.type() == QVariant::Bool) {
        if (variantMap)
            *variantMap = QVariantMap();
        return false;
    } else {
        if (variantMap)
            *variantMap = response.toMap();
        return true;
    }
}