homescreenapp/hsdomainmodel/src/hsdatabase.cpp
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Mon, 03 May 2010 12:24:59 +0300
changeset 39 4e8ebe173323
parent 36 cdae8c6c3876
child 46 23b5d6a29cce
permissions -rw-r--r--
Revision: 201015 Kit: 201018

/*
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
*
*/

#include <QSqlDatabase>
#include <QSqlQuery>
#include <QSqlRecord>
#include <QVariantHash>
#include <QDir>

#include "hsdatabase.h"
#include "hsdomainmodeldatastructures.h"

namespace
{
    template<class T>
    QVariantList toVariantList(const QList<T> &list)
    {
        QVariantList vlist;
        for (int i=0; i<list.count(); ++i) {
            T item = list.at(i);
            vlist << item;
        }
        return vlist;
    }

    template<class T>
    QVariantList toVariantList(const T &item, int count)
    {
        QVariantList vlist;
        for (int i = 0; i < count; ++i) {
            vlist << item;
        }
        return vlist;
    }
}

/*!
    Constructs a new database with the given \a parent object.
*/
HsDatabase::HsDatabase(QObject *parent)
  : QObject(parent)
{
}

/*!
    Destroys this database.
*/
HsDatabase::~HsDatabase()
{
    close();
}

/*!
    Sets the connection name to \a name.
*/
void HsDatabase::setConnectionName(const QString &name)
{
    mConnectionName = name;
}
 
/*!
    Returns the connection name.
*/
QString HsDatabase::connectionName() const
{
    return mConnectionName;
}

/*!
    Sets the database name to \a name.
*/
void HsDatabase::setDatabaseName(const QString &name)
{
    mDatabaseName = QDir::toNativeSeparators(name);
}
 
/*!
    Returns the database name.
*/
QString HsDatabase::databaseName() const
{
    return mDatabaseName;
}

/*!
    Opens the database connection using the current connection
    values. Returns true on success, otherwise returns false.
*/  
bool HsDatabase::open()
{
    QSqlDatabase database;
    if (QSqlDatabase::contains(mConnectionName)) {
        database = QSqlDatabase::database(mConnectionName);
    } else {
        database = QSqlDatabase::addDatabase("QSQLITE", mConnectionName);
        database.setDatabaseName(mDatabaseName);
    }
    if (!database.isValid()) {
        close();
        return false;
    }
    if (!database.isOpen()) {
        if (!database.open()) {
            close();
            return false;
        }
    }
    return true;
}
 
/*!
    Closes the database connection.
*/
void HsDatabase::close()
{
    {
        QSqlDatabase database = QSqlDatabase::database(mConnectionName);
        if (database.isValid() && database.isOpen()) {
            database.close();
        }
    }
    QSqlDatabase::removeDatabase(mConnectionName);
}

/*!
    Begins a transaction on the database if the driver 
    supports transactions. Returns true if the operation 
    succeeded. Otherwise returns false.
*/
bool HsDatabase::transaction()
{
    return QSqlDatabase::database(mConnectionName).transaction();
}
 
/*!
    Rolls back a transaction on the database, if the driver 
    supports transactions and a transaction() has been started.
    Returns true if the operation succeeded. Otherwise returns
    false.
*/
bool HsDatabase::rollback()
{
    return QSqlDatabase::database(mConnectionName).rollback();
}
 
/*!
    Commits a transaction to the database if the driver supports 
    transactions and a transaction() has been started. Returns 
    true if the operation succeeded. Otherwise returns false.
*/
bool HsDatabase::commit()
{
    return QSqlDatabase::database(mConnectionName).commit();
}

/*!

*/
bool HsDatabase::scene(HsSceneData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT id, portraitWallpaper, landscapeWallpaper, defaultPageId, "
        "maximumPageCount, maximumWidgetHeight, maximumWidgetWidth, "
        "minimumWidgetHeight, minimumWidgetWidth "
        "FROM Scene";
    
    if (query.prepare(statement) && query.exec() && query.next()) {        
        data.id                  = query.value(0).toInt();
        data.portraitWallpaper   = query.value(1).toString();
        data.landscapeWallpaper  = query.value(2).toString();
        data.defaultPageId       = query.value(3).toInt();
        data.maximumPageCount    = query.value(4).toInt();
        data.maximumWidgetHeight = query.value(5).toInt();
        data.maximumWidgetWidth  = query.value(6).toInt();
        data.minimumWidgetHeight = query.value(7).toInt();
        data.minimumWidgetWidth  = query.value(8).toInt();
        return true;
    }
    
    return false;
}

/*!

*/
bool HsDatabase::updateScene(const HsSceneData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "UPDATE Scene "
        "SET portraitWallpaper = ?, landscapeWallpaper = ? "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.portraitWallpaper);
        query.addBindValue(data.landscapeWallpaper);    
        query.addBindValue(data.id);
        return  query.exec();
    }
    
    return false;
}

/*!

*/
bool HsDatabase::pages(QList<HsPageData> &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT id, indexPosition "
        "FROM Pages "
        "ORDER BY indexPosition";

    if (query.prepare(statement) && query.exec()) {
        data.clear();
        while (query.next()) {
            HsPageData d;
            d.id            = query.value(0).toInt();
            d.indexPosition = query.value(1).toInt();
            data.append(d);
        }
        return true;
    }

    return false;
}

/*!

*/
bool HsDatabase::page(HsPageData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT indexPosition "
        "FROM Pages "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.id);
        if (query.exec() && query.next()) {
            data.indexPosition = query.value(0).toInt();
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::insertPage(HsPageData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "INSERT INTO Pages "
        "(indexPosition) "
        "VALUES "
        "(?)";

    if (query.prepare(statement)) {
        query.addBindValue(data.indexPosition);
        if (query.exec()) {
            data.id = query.lastInsertId().toInt();
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::updatePage(const HsPageData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "UPDATE Pages "
        "SET indexPosition = ? "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.indexPosition);
        query.addBindValue(data.id);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::deletePage(int id)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "DELETE FROM Pages "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(id);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::widgets(int pageId, QList<HsWidgetData> &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT id, uri "
        "FROM Widgets "
        "WHERE pageId = ?";

    if (query.prepare(statement)) {
        query.addBindValue(pageId);
        if (query.exec()) {
            data.clear();
            while (query.next()) {
                HsWidgetData d;
                d.id     = query.value(0).toInt();
                d.uri    = query.value(1).toString();
                d.pageId = pageId;
                data.append(d);
            }
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::widgets(const QString &uri, QList<HsWidgetData> &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT id, pageId "
        "FROM Widgets "
        "WHERE uri = ?";

    if (query.prepare(statement)) {
        query.addBindValue(uri);
        if (query.exec()) {
            data.clear();
            while (query.next()) {
                HsWidgetData d;
                d.id     = query.value(0).toInt();
                d.uri    = uri;
                d.pageId = query.value(1).toInt();
                data.append(d);
            }
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::widget(HsWidgetData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT uri, pageId "
        "FROM Widgets "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.id);
        if (query.exec() && query.next()) {
            data.uri    = query.value(0).toString();
            data.pageId = query.value(1).toInt();
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::insertWidget(HsWidgetData &data)
{
    if (!checkConnection()) {
        return false;
    }
    if (data.uri.isEmpty()) {
        return false;
    }
    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "INSERT INTO Widgets "
        "(uri, pageId) "
        "VALUES "
        "(?, ?)";

    if (query.prepare(statement)) {
        query.addBindValue(data.uri);
        query.addBindValue(data.pageId);
        if (query.exec()) {
            data.id = query.lastInsertId().toInt();
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::updateWidget(const HsWidgetData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "UPDATE Widgets "
        "SET uri = ?, pageId = ? "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.uri);
        query.addBindValue(data.pageId);
        query.addBindValue(data.id);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::deleteWidget(int id)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "DELETE FROM Widgets "
        "WHERE id = ?";

    if (query.prepare(statement)) {
        query.addBindValue(id);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::deleteWidgets(const QString &uri)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "DELETE FROM Widgets "
        "WHERE uri = ?";

    if (query.prepare(statement)) {
        query.addBindValue(uri);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::widgetPresentation(HsWidgetPresentationData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT x, y, zValue "
        "FROM WidgetPresentations "
        "WHERE key = ? AND widgetId = ?";

    if (query.prepare(statement)) {
        query.addBindValue(data.key);
        query.addBindValue(data.widgetId);
        if (query.exec() && query.next()) {
            data.x      = query.value(0).toReal();
            data.y      = query.value(1).toReal();
            data.zValue = query.value(2).toReal();
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::setWidgetPresentation(const HsWidgetPresentationData &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "REPLACE INTO WidgetPresentations "
        "(key, x, y, zValue, widgetId) "
        "VALUES (?, ?, ?, ?, ?)";

    if (query.prepare(statement)) {
        query.addBindValue(data.key);
        query.addBindValue(data.x);
        query.addBindValue(data.y);
        query.addBindValue(data.zValue);
        query.addBindValue(data.widgetId);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::deleteWidgetPresentation(int widgetId, const QString &key)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "DELETE FROM WidgetPresentations "
        "WHERE key = ? AND widgetId = ?";

    if (query.prepare(statement)) {
        query.addBindValue(key);
        query.addBindValue(widgetId);
        return query.exec();
    }

    return false;
}

/*!

*/
bool HsDatabase::widgetPreferences(int widgetId, QVariantHash &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT key, value "
        "FROM WidgetPreferences "
        "WHERE widgetId = ?";

    if (query.prepare(statement)) {
        query.addBindValue(widgetId);
        if (query.exec()) {
            data.clear();
            while (query.next()) {
                data.insert(query.value(0).toString(), 
                            query.value(1));
            }
            return true;
        }
    }

    return false;
}

/*!

*/
bool HsDatabase::widgetPreference(int widgetId, const QString &key, QVariant &value)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QString statement =
        "SELECT value "
        "FROM WidgetPreferences "
        "WHERE key = ? AND widgetId = ?";

    if (query.prepare(statement)) {
        query.addBindValue(key);
        query.addBindValue(widgetId);
        if (query.exec() && query.next()) {
            value = query.value(0);
            return true;
        }
    }

    return false;
}
 
/*!

*/
bool HsDatabase::setWidgetPreferences(int widgetId, const QVariantHash &data)
{
    if (!checkConnection()) {
        return false;
    }

    QSqlQuery query(QSqlDatabase::database(mConnectionName));

    QList<QString> deleteKeys = data.keys(QVariant());
    QVariantHash insertOrReplaceData(data);
    for (int i=0; i<deleteKeys.count(); ++i) {
        insertOrReplaceData.remove(deleteKeys.at(i));
    }

    if (!deleteKeys.isEmpty()) {
        QString statement = 
            "DELETE FROM WidgetPreferences "
            "WHERE key = ? AND widgetId = ?";
        
        if (query.prepare(statement)) {
            query.addBindValue(toVariantList(deleteKeys));
            query.addBindValue(toVariantList(widgetId, deleteKeys.count()));
            if (!query.execBatch()) {
                return false;
            }
        } else {
            return false;
        }
    }

    if (!insertOrReplaceData.isEmpty()) {
        QString statement = 
            "REPLACE INTO WidgetPreferences "
            "(key, value, widgetId) "
            "VALUES (?, ?, ?)";
            
        if (query.prepare(statement)) {
            query.addBindValue(toVariantList(insertOrReplaceData.keys()));
            query.addBindValue(toVariantList(insertOrReplaceData.values()));
            query.addBindValue(toVariantList(widgetId, insertOrReplaceData.count()));
            if (!query.execBatch()) {
                return false;
            }
        } else {
            return false;
        }
    }

    return true;
}
 
/*!
    Sets the database instance. The existing instance
    will be deleted.
*/
void HsDatabase::setInstance(HsDatabase *instance)
{
    mInstance.reset(instance);
}

/*!
    Returns the database instance.
*/
HsDatabase *HsDatabase::instance()
{
    return mInstance.data();
}

/*!
    Returns the current database instance. Callers of this 
    function take ownership of the instance. The current 
    database instance will be reset to null.    
*/
HsDatabase *HsDatabase::takeInstance()
{
    return mInstance.take();
}
  
/*!
    Checks the connection validity. Returns true if the 
    connection is valid.
*/
bool HsDatabase::checkConnection() const
{
    return QSqlDatabase::database(mConnectionName).isValid();
}

/*!
    Points to the database instance.
*/
QScopedPointer<HsDatabase> HsDatabase::mInstance(0);