path: root/src/libs/sqlite/sqlitebasestatement.cpp

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "sqlitebasestatement.h"

#include "sqlitedatabase.h"
#include "sqlitedatabasebackend.h"
#include "sqliteexception.h"

#include <sqlite.h>

#include <condition_variable>
#include <mutex>

#if defined(__GNUC__)
#  pragma GCC diagnostic ignored "-Wignored-qualifiers"
#endif

#define CARRAY_INT32 0  /* Data is 32-bit signed integers */
#define CARRAY_INT64 1  /* Data is 64-bit signed integers */
#define CARRAY_DOUBLE 2 /* Data is doubles */
#define CARRAY_TEXT 3   /* Data is char* */

extern "C" int sqlite3_carray_bind(
    sqlite3_stmt *pStmt, int idx, void *aData, int nData, int mFlags, void (*xDestroy)(void *));

namespace Sqlite {

using NanotraceHR::keyValue;

BaseStatement::BaseStatement(Utils::SmallStringView sqlStatement, Database &database)
    : m_database(database)
{
    prepare(sqlStatement);
}

class UnlockNotification
{
public:
    static void unlockNotifyCallBack(void **arguments, int argumentCount)
    {
        for (int index = 0; index < argumentCount; index++) {
          UnlockNotification *unlockNotification = static_cast<UnlockNotification *>(arguments[index]);
          unlockNotification->wakeupWaitCondition();
        }
    }

    void wakeupWaitCondition()
    {
        {
            std::lock_guard<std::mutex> lock(m_mutex);
            m_fired = 1;
        }
        m_waitCondition.notify_all();
    }

    void wait()
    {
        std::unique_lock<std::mutex> lock(m_mutex);

        m_waitCondition.wait(lock, [&] () { return m_fired; });
    }

private:
    bool m_fired = false;
    std::condition_variable m_waitCondition;
    std::mutex m_mutex;
};

void BaseStatement::waitForUnlockNotify() const
{
    UnlockNotification unlockNotification;
    int resultCode = sqlite3_unlock_notify(sqliteDatabaseHandle(),
                                           UnlockNotification::unlockNotifyCallBack,
                                           &unlockNotification);

    if (resultCode == SQLITE_LOCKED)
        throw DeadLock();

    unlockNotification.wait();
}

void BaseStatement::reset() const noexcept
{
    NanotraceHR::Tracer tracer{"reset"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle())};

    sqlite3_reset(m_compiledStatement.get());
}

bool BaseStatement::next() const
{
    NanotraceHR::Tracer tracer{"next"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle())};
    int resultCode;

    do {
        resultCode = sqlite3_step(m_compiledStatement.get());
        if (resultCode == SQLITE_LOCKED) {
            waitForUnlockNotify();
            sqlite3_reset(m_compiledStatement.get());
        }

    } while (resultCode == SQLITE_LOCKED);

    if (resultCode == SQLITE_ROW)
        return true;
    else if (resultCode == SQLITE_DONE)
        return false;

    Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::step() const
{
    next();
}

void BaseStatement::bindNull(int index)
{
    NanotraceHR::Tracer tracer{"bind null"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index)};

    int resultCode = sqlite3_bind_null(m_compiledStatement.get(), index);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, NullValue)
{
    bindNull(index);
}

void BaseStatement::bind(int index, int value)
{
    NanotraceHR::Tracer tracer{"bind int"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("value", value)};

    int resultCode = sqlite3_bind_int(m_compiledStatement.get(), index, value);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, long long value)
{
    NanotraceHR::Tracer tracer{"bind long long"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("value", value)};

    int resultCode = sqlite3_bind_int64(m_compiledStatement.get(), index, value);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, double value)
{
    NanotraceHR::Tracer tracer{"bind double"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("value", value)};

    int resultCode = sqlite3_bind_double(m_compiledStatement.get(), index, value);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, void *pointer)
{
    NanotraceHR::Tracer tracer{"bind pointer"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(pointer))};

    int resultCode = sqlite3_bind_pointer(m_compiledStatement.get(), index, pointer, "carray", nullptr);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, Utils::span<const int> values)
{
    NanotraceHR::Tracer tracer{"bind int span"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(values.data())),
                               keyValue("size", values.size())};

    int resultCode = sqlite3_carray_bind(m_compiledStatement.get(),
                                         index,
                                         const_cast<int *>(values.data()),
                                         static_cast<int>(values.size()),
                                         CARRAY_INT32,
                                         SQLITE_STATIC);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, Utils::span<const long long> values)
{
    NanotraceHR::Tracer tracer{"bind long long span"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(values.data())),
                               keyValue("size", values.size())};

    int resultCode = sqlite3_carray_bind(m_compiledStatement.get(),
                                         index,
                                         const_cast<long long *>(values.data()),
                                         static_cast<int>(values.size()),
                                         CARRAY_INT64,
                                         SQLITE_STATIC);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, Utils::span<const double> values)
{
    NanotraceHR::Tracer tracer{"bind double span"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(values.data())),
                               keyValue("size", values.size())};

    int resultCode = sqlite3_carray_bind(m_compiledStatement.get(),
                                         index,
                                         const_cast<double *>(values.data()),
                                         static_cast<int>(values.size()),
                                         CARRAY_DOUBLE,
                                         SQLITE_STATIC);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, Utils::span<const char *> values)
{
    NanotraceHR::Tracer tracer{"bind const char* span"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(values.data())),
                               keyValue("size", values.size())};

    int resultCode = sqlite3_carray_bind(m_compiledStatement.get(),
                                         index,
                                         values.data(),
                                         static_cast<int>(values.size()),
                                         CARRAY_TEXT,
                                         SQLITE_STATIC);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, Utils::SmallStringView text)
{
    NanotraceHR::Tracer tracer{"bind string"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("text", text)};

    int resultCode = sqlite3_bind_text(m_compiledStatement.get(),
                                       index,
                                       text.data(),
                                       int(text.size()),
                                       SQLITE_STATIC);
    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, BlobView blobView)
{
    NanotraceHR::Tracer tracer{"bind blob"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("index", index),
                               keyValue("pointer", reinterpret_cast<std::uintptr_t>(blobView.data())),
                               keyValue("size", blobView.size())};

    int resultCode = SQLITE_OK;

    if (blobView.empty()) {
        sqlite3_bind_null(m_compiledStatement.get(), index);
    } else {
        resultCode = sqlite3_bind_blob64(m_compiledStatement.get(),
                                         index,
                                         blobView.data(),
                                         blobView.size(),
                                         SQLITE_STATIC);
    }

    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());
}

void BaseStatement::bind(int index, const Value &value)
{
    NanotraceHR::Tracer tracer{
        "bind value"_t,
        sqliteLowLevelCategory(),
        keyValue("sqlite statement", handle()),
    };

    switch (value.type()) {
    case ValueType::Integer:
        bind(index, value.toInteger());
        break;
    case ValueType::Float:
        bind(index, value.toFloat());
        break;
    case ValueType::String:
        bind(index, value.toStringView());
        break;
    case ValueType::Blob:
        bind(index, value.toBlobView());
        break;
    case ValueType::Null:
        bind(index, NullValue{});
        break;
    }
}

void BaseStatement::bind(int index, ValueView value)
{
    NanotraceHR::Tracer tracer{
        "bind value"_t,
        sqliteLowLevelCategory(),
        keyValue("sqlite statement", handle()),
    };

    switch (value.type()) {
    case ValueType::Integer:
        bind(index, value.toInteger());
        break;
    case ValueType::Float:
        bind(index, value.toFloat());
        break;
    case ValueType::String:
        bind(index, value.toStringView());
        break;
    case ValueType::Blob:
        bind(index, value.toBlobView());
        break;
    case ValueType::Null:
        bind(index, NullValue{});
        break;
    }
}

void BaseStatement::prepare(Utils::SmallStringView sqlStatement)
{
    NanotraceHR::Tracer tracer{"prepare"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sql statement", sqlStatement)};

    if (!m_database.isLocked())
        throw DatabaseIsNotLocked{};

    int resultCode;

    do {
        sqlite3_stmt *sqliteStatement = nullptr;
        resultCode = sqlite3_prepare_v2(sqliteDatabaseHandle(),
                                        sqlStatement.data(),
                                        int(sqlStatement.size()),
                                        &sqliteStatement,
                                        nullptr);
        m_compiledStatement.reset(sqliteStatement);

        if (resultCode == SQLITE_LOCKED) {
            tracer.tick("wait for unlock"_t);
            waitForUnlockNotify();
        }

    } while (resultCode == SQLITE_LOCKED);


    if (resultCode != SQLITE_OK)
        Sqlite::throwError(resultCode, sqliteDatabaseHandle());

    tracer.end(keyValue("sqlite statement", handle()));
}

sqlite3 *BaseStatement::sqliteDatabaseHandle() const
{
    return m_database.backend().sqliteDatabaseHandle();
}

void BaseStatement::checkBindingParameterCount(int bindingParameterCount) const
{
    if (bindingParameterCount != sqlite3_bind_parameter_count(m_compiledStatement.get()))
        throw WrongBindingParameterCount{};
}

void BaseStatement::checkColumnCount(int columnCount) const
{
    if (columnCount != sqlite3_column_count(m_compiledStatement.get()))
        throw WrongColumnCount{};
}

bool BaseStatement::isReadOnlyStatement() const
{
    return sqlite3_stmt_readonly(m_compiledStatement.get());
}

QString BaseStatement::columnName(int column) const
{
    return QString::fromUtf8(sqlite3_column_name(m_compiledStatement.get(), column));
}

namespace {
template<typename StringType>
StringType textForColumn(sqlite3_stmt *sqlStatment, int column)
{
    const char *text =  reinterpret_cast<const char*>(sqlite3_column_text(sqlStatment, column));
    std::size_t size = std::size_t(sqlite3_column_bytes(sqlStatment, column));

    return StringType(text, size);
}

BlobView blobForColumn(sqlite3_stmt *sqlStatment, int column)
{
    const std::byte *blob = reinterpret_cast<const std::byte *>(
        sqlite3_column_blob(sqlStatment, column));
    std::size_t size = std::size_t(sqlite3_column_bytes(sqlStatment, column));

    return {blob, size};
}

BlobView convertToBlobForColumn(sqlite3_stmt *sqlStatment, int column)
{
    int dataType = sqlite3_column_type(sqlStatment, column);
    if (dataType == SQLITE_BLOB)
        return blobForColumn(sqlStatment, column);

    return {};
}

template<typename StringType>
StringType convertToTextForColumn(sqlite3_stmt *sqlStatment, int column)
{
    int dataType = sqlite3_column_type(sqlStatment, column);
    switch (dataType) {
    case SQLITE_INTEGER:
    case SQLITE_FLOAT:
    case SQLITE3_TEXT:
        return textForColumn<StringType>(sqlStatment, column);
    case SQLITE_BLOB:
    case SQLITE_NULL:
        break;
    }

    return {};
}
} // namespace

Type BaseStatement::fetchType(int column) const
{
    NanotraceHR::Tracer tracer{"fetch type"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto dataType = sqlite3_column_type(m_compiledStatement.get(), column);

    switch (dataType) {
    case SQLITE_INTEGER:
        return Type::Integer;
    case SQLITE_FLOAT:
        return Type::Float;
    case SQLITE3_TEXT:
        return Type::Text;
    case SQLITE_BLOB:
        return Type::Blob;
    case SQLITE_NULL:
        return Type::Null;
    }

    return Type::Invalid;
}

int BaseStatement::fetchIntValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch int"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto value = sqlite3_column_int(m_compiledStatement.get(), column);

    tracer.end(keyValue("value", value));

    return value;
}

template<>
int BaseStatement::fetchValue<int>(int column) const
{
    return fetchIntValue(column);
}

long BaseStatement::fetchLongValue(int column) const
{
    return long(fetchValue<long long>(column));
}

template<>
long BaseStatement::fetchValue<long>(int column) const
{
    return fetchLongValue(column);
}

long long BaseStatement::fetchLongLongValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch long long"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto value = sqlite3_column_int64(m_compiledStatement.get(), column);

    tracer.end(keyValue("value", value));

    return value;
}

template<>
long long BaseStatement::fetchValue<long long>(int column) const
{
    return fetchLongLongValue(column);
}

double BaseStatement::fetchDoubleValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch double"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto value = sqlite3_column_double(m_compiledStatement.get(), column);

    tracer.end(keyValue("value", value));

    return value;
}

BlobView BaseStatement::fetchBlobValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch blob"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    return convertToBlobForColumn(m_compiledStatement.get(), column);
}

template<>
double BaseStatement::fetchValue<double>(int column) const
{
    return fetchDoubleValue(column);
}

template<typename StringType>
StringType BaseStatement::fetchValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch string value"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto text = convertToTextForColumn<StringType>(m_compiledStatement.get(), column);

    tracer.end(keyValue("text", text));

    return text;
}

template SQLITE_EXPORT Utils::SmallStringView BaseStatement::fetchValue<Utils::SmallStringView>(
    int column) const;
template SQLITE_EXPORT Utils::SmallString BaseStatement::fetchValue<Utils::SmallString>(
    int column) const;
template SQLITE_EXPORT Utils::PathString BaseStatement::fetchValue<Utils::PathString>(
    int column) const;

Utils::SmallStringView BaseStatement::fetchSmallStringViewValue(int column) const
{
    NanotraceHR::Tracer tracer{"fetch string view"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    auto text = fetchValue<Utils::SmallStringView>(column);

    tracer.end(keyValue("text", text));

    return text;
}

ValueView BaseStatement::fetchValueView(int column) const
{
    NanotraceHR::Tracer tracer{"fetch value view"_t,
                               sqliteLowLevelCategory(),
                               keyValue("sqlite statement", handle()),
                               keyValue("column", column)};

    int dataType = sqlite3_column_type(m_compiledStatement.get(), column);
    switch (dataType) {
    case SQLITE_NULL:
        return ValueView::create(NullValue{});
    case SQLITE_INTEGER:
        return ValueView::create(fetchLongLongValue(column));
    case SQLITE_FLOAT:
        return ValueView::create(fetchDoubleValue(column));
    case SQLITE3_TEXT:
        return ValueView::create(fetchValue<Utils::SmallStringView>(column));
    case SQLITE_BLOB:
        break;
    }

    return ValueView::create(NullValue{});
}

void BaseStatement::Deleter::operator()(sqlite3_stmt *statement)
{
    NanotraceHR::Tracer tracer{
        "finalize"_t,
        sqliteLowLevelCategory(),
        keyValue("sqlite statement", reinterpret_cast<std::uintptr_t>(statement)),
    };

    sqlite3_finalize(statement);
}

} // namespace Sqlite