torcdb.cpp

Go to the documentation of this file.

/* Class TorcDB
*
* This file is part of the Torc project.
*
* Copyright (C) Mark Kendall 2012-18
*
* 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 2 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
* USA.
*/

// Qt
#include <QtSql>
#include <QThread>
#include <QHash>

// Torc
#include "torclogging.h"
#include "torcdb.h"

TorcDB::TorcDB(const QString &DatabaseName, const QString &DatabaseType)
  : m_databaseValid(false),
    m_databaseName(DatabaseName),
    m_databaseType(DatabaseType),
    m_lock(QMutex::Recursive),
    m_connectionMap()
{
}

TorcDB::~TorcDB()
{
    QMutexLocker locker(&m_lock);
    m_databaseValid = false;
    CloseConnections();
}

bool TorcDB::IsValid(void)
{
    QMutexLocker locker(&m_lock);
    return m_databaseValid;
}

void TorcDB::CloseConnections(void)
{
    QMutexLocker locker(&m_lock);

    CloseThreadConnection();

    if (m_connectionMap.isEmpty())
        return;

    LOG(VB_GENERAL, LOG_WARNING, QStringLiteral("%1 open connections.").arg(m_connectionMap.size()));

    QHashIterator<QThread*,QString> it(m_connectionMap);
    while (it.hasNext())
    {
        it.next();
        QString name = it.value();
        LOG(VB_GENERAL, LOG_INFO, QStringLiteral("Removing connection '%1'").arg(name));
        QSqlDatabase::removeDatabase(name);
    }
    m_connectionMap.clear();
}

void TorcDB::CloseThreadConnection(void)
{
    QThread* thread = QThread::currentThread();
    QMutexLocker locker(&m_lock);
    if (m_connectionMap.contains(thread))
    {
        QString name = m_connectionMap.value(thread);
        LOG(VB_GENERAL, LOG_INFO, QStringLiteral("Removing connection '%1'").arg(name));
        QSqlDatabase::removeDatabase(name);
        m_connectionMap.remove(thread);
    }
}

QString TorcDB::GetThreadConnection(void)
{
    QThread* thread = QThread::currentThread();

    {
        QMutexLocker locker(&m_lock);
        if (m_connectionMap.contains(thread))
            return m_connectionMap.value(thread);
    }

    if (thread->objectName().isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Database access is only available from TorcQThread"));
        return QString();
    }

    QString name = QStringLiteral("%1-%2").arg(thread->objectName(), QString::number((unsigned long long)thread));
    QSqlDatabase newdb = QSqlDatabase::addDatabase(m_databaseType, name);

    if (m_databaseType == QStringLiteral("QSQLITE"))
        newdb.setConnectOptions(QStringLiteral("QSQLITE_BUSY_TIMEOUT=1"));
    newdb.setDatabaseName(m_databaseName);

    {
        QMutexLocker locker(&m_lock);
        m_connectionMap.insert(thread, name);
        LOG(VB_GENERAL, LOG_INFO, QStringLiteral("New connection '%1'").arg(name));
    }

    return name;
}

bool TorcDB::DebugError(QSqlQuery *Query)
{
    if (!Query)
        return true;

    QSqlError error = Query->lastError();

    if (error.type() == QSqlError::NoError)
        return false;

    if (!error.databaseText().isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Database Error: %1")
            .arg(error.databaseText()));
        return true;
    }

    if (!error.driverText().isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Driver Error: %1")
            .arg(error.driverText()));
    }

    return true;
}

bool TorcDB::DebugError(QSqlDatabase *Database)
{
    if (!Database)
        return true;

    QSqlError error = Database->lastError();

    if (error.type() == QSqlError::NoError)
        return false;

    if (!error.databaseText().isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Database Error: %1")
            .arg(error.databaseText()));
        return true;
    }

    if (!error.driverText().isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Driver Error: %1")
            .arg(error.driverText()));
    }

    return true;
}

void TorcDB::LoadSettings(QMap<QString, QString> &Settings)
{
    QMutexLocker locker(&m_lock);
    QSqlDatabase db = QSqlDatabase::database(GetThreadConnection());
    DebugError(&db);
    if (!db.isValid() || !db.isOpen())
        return;

    QSqlQuery query(QStringLiteral("SELECT name, value from settings;"), db);
    DebugError(&query);

    while (query.next())
    {
        LOG(VB_GENERAL, LOG_DEBUG, QStringLiteral("'%1' : '%2'").arg(query.value(0).toString(), query.value(1).toString()));
        Settings.insert(query.value(0).toString(), query.value(1).toString());
    }
}

void TorcDB::SetSetting(const QString &Name, const QString &Value)
{
    QMutexLocker locker(&m_lock);
    if (Name.isEmpty())
        return;

    QSqlDatabase db = QSqlDatabase::database(GetThreadConnection());
    DebugError(&db);
    if (!db.isValid() || !db.isOpen())
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Failed to open database connection."));
        return;
    }

    QSqlQuery query(db);
    query.prepare(QStringLiteral("DELETE FROM settings where name=:NAME;"));
    query.bindValue(QStringLiteral(":NAME"), Name);
    query.exec();
    DebugError(&query);

    query.prepare(QStringLiteral("INSERT INTO settings (name, value) VALUES (:NAME, :VALUE);"));
    query.bindValue(QStringLiteral(":NAME"), Name);
    query.bindValue(QStringLiteral(":VALUE"), Value);
    query.exec();
    DebugError(&query);
}