qt-creator/src/libs/sqlite/sqlstatementbuilder.cpp

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "sqlstatementbuilder.h"

#include "sqlstatementbuilderexception.h"
#include "utf8stringvector.h"

#include <algorithm>

SqlStatementBuilder::SqlStatementBuilder(const Utf8String &sqlTemplate)
    : sqlTemplate(sqlTemplate)
{
}

void SqlStatementBuilder::bindEmptyText(const Utf8String &name)
{
    clearSqlStatement();
    checkIfPlaceHolderExists(name);
    changeBinding(name, Utf8String());
}

void SqlStatementBuilder::bind(const Utf8String &name, const Utf8String &text)
{
    clearSqlStatement();
    checkBindingTextIsNotEmpty(text);
    checkIfPlaceHolderExists(name);
    changeBinding(name, text);
}

void SqlStatementBuilder::bind(const Utf8String &name, const Utf8StringVector &textVector)
{
    clearSqlStatement();
    checkBindingTextVectorIsNotEmpty(textVector);
    checkIfPlaceHolderExists(name);
    changeBinding(name, textVector.join(Utf8StringLiteral(", ")));
}

void SqlStatementBuilder::bind(const Utf8String &name, int value)
{
    clearSqlStatement();
    checkIfPlaceHolderExists(name);
    changeBinding(name, Utf8String::number(value));
}

void SqlStatementBuilder::bind(const Utf8String &name, const QVector<int> &integerVector)
{
    clearSqlStatement();
    checkBindingIntegerVectorIsNotEmpty(integerVector);
    checkIfPlaceHolderExists(name);
    changeBinding(name, Utf8StringVector::fromIntegerVector(integerVector).join(Utf8StringLiteral(", ")));
}

void SqlStatementBuilder::bindWithInsertTemplateParameters(const Utf8String &name, const Utf8StringVector &columns)
{
    clearSqlStatement();
    checkBindingTextVectorIsNotEmpty(columns);
    checkIfPlaceHolderExists(name);
    changeBinding(name, insertTemplateParameters(columns));
}

void SqlStatementBuilder::bindWithUpdateTemplateParameters(const Utf8String &name, const Utf8StringVector &columns)
{
    clearSqlStatement();
    checkBindingTextVectorIsNotEmpty(columns);
    checkIfPlaceHolderExists(name);
    changeBinding(name, updateTemplateParameters(columns));
}

void SqlStatementBuilder::bindWithUpdateTemplateNames(const Utf8String &name, const Utf8StringVector &columns)
{
    clearSqlStatement();
    checkBindingTextVectorIsNotEmpty(columns);
    checkIfPlaceHolderExists(name);
    changeBinding(name, updateTemplateNames(columns));
}

void SqlStatementBuilder::clear()
{
    bindings.clear();
    sqlStatement_.clear();
}

const Utf8String SqlStatementBuilder::insertTemplateParameters(const Utf8StringVector &columns)
{
    const Utf8StringVector templateParamters(columns.count(), Utf8StringLiteral("?"));

    return templateParamters.join(Utf8StringLiteral(", "));
}

const Utf8String SqlStatementBuilder::updateTemplateParameters(const Utf8StringVector &columns)
{
    Utf8String templateParamters = columns.join(Utf8StringLiteral("=?, "));
    templateParamters.append(Utf8StringLiteral("=?"));

    return templateParamters;
}

const Utf8String SqlStatementBuilder::updateTemplateNames(const Utf8StringVector &columns)
{
    Utf8StringVector templateNames;

    foreach (const Utf8String &columnName, columns)
        templateNames.append(columnName+Utf8StringLiteral("=@")+columnName);

    return templateNames.join(Utf8StringLiteral(", "));
}

void SqlStatementBuilder::sortBindings() const
{
    std::sort(bindings.begin(), bindings.end(), [] (const BindingPair &lhs,const BindingPair &rhs)
    {
        return lhs.first.byteSize() == rhs.first.byteSize() ? lhs.first.toByteArray() < rhs.first.toByteArray() : lhs.first.byteSize() > rhs.first.byteSize();
    });
}

Utf8String SqlStatementBuilder::sqlStatement() const
{
    if (!isBuild())
        generateSqlStatement();

    return sqlStatement_;
}

bool SqlStatementBuilder::isBuild() const
{
    return sqlStatement_.hasContent();
}

Utf8String SqlStatementBuilder::columnTypeToString(ColumnType columnType)
{
    switch (columnType) {
        case ColumnType::Numeric: return Utf8StringLiteral("NUMERIC");
        case ColumnType::Integer: return Utf8StringLiteral("INTEGER");
        case ColumnType::Real: return Utf8StringLiteral("REAL");
        case ColumnType::Text: return Utf8StringLiteral("TEXT");
        case ColumnType::None: return Utf8String();
    }

    Q_UNREACHABLE();
}

void SqlStatementBuilder::generateSqlStatement() const
{
    sqlStatement_ = sqlTemplate;

    sortBindings();

    auto bindingIterator = bindings.cbegin();
    while (bindingIterator != bindings.cend()) {
        const Utf8String &placeHolderToken = bindingIterator->first;
        const Utf8String &replacementToken = bindingIterator->second;
        sqlStatement_.replace(placeHolderToken, replacementToken);
        ++bindingIterator;
    }

    checkIfNoPlaceHoldersAynmoreExists();
}

void SqlStatementBuilder::changeBinding(const Utf8String &name, const Utf8String &text)
{

    auto findBindingIterator = std::find_if(bindings.begin(), bindings.end(), [name] (const BindingPair &binding) {
        return binding.first == name;
    });

    if (findBindingIterator == bindings.end())
        bindings.push_back(std::make_pair(name, text));
    else
        findBindingIterator->second = text;
}

void SqlStatementBuilder::clearSqlStatement()
{
    sqlStatement_.clear();
}

void SqlStatementBuilder::checkIfPlaceHolderExists(const Utf8String &name) const
{
    if (name.byteSize() < 2 || !name.startsWith('$') || !sqlTemplate.contains(name))
        throwException("SqlStatementBuilder::bind: placeholder name does not exists!", name.constData());
}

void SqlStatementBuilder::checkIfNoPlaceHoldersAynmoreExists() const
{
    if (sqlStatement_.contains('$'))
        throwException("SqlStatementBuilder::bind: there are still placeholder in the sql statement!", sqlTemplate.constData());
}

void SqlStatementBuilder::checkBindingTextIsNotEmpty(const Utf8String &text) const
{
    if (text.isEmpty())
        throwException("SqlStatementBuilder::bind: binding text it empty!", sqlTemplate.constData());
}

void SqlStatementBuilder::checkBindingTextVectorIsNotEmpty(const Utf8StringVector &textVector) const
{
    if (textVector.isEmpty())
        throwException("SqlStatementBuilder::bind: binding text vector it empty!", sqlTemplate.constData());
}

void SqlStatementBuilder::checkBindingIntegerVectorIsNotEmpty(const QVector<int> &integerVector) const
{
    if (integerVector.isEmpty())
        throwException("SqlStatementBuilder::bind: binding integer vector it empty!", sqlTemplate.constData());
}

void SqlStatementBuilder::throwException(const char *whatHasHappened, const char *errorMessage)
{
    throw SqlStatementBuilderException(whatHasHappened, errorMessage);
}