/*
* Copyright (C) 2005-2011 MaNGOS
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef SQLPREPAREDSTATEMENTS_H
#define SQLPREPAREDSTATEMENTS_H
#include "Common.h"
#include
#include
#include
class Database;
class SqlConnection;
class QueryResult;
union SqlStmtField
{
bool boolean;
uint8 ui8;
int8 i8;
uint16 ui16;
int16 i16;
uint32 ui32;
int32 i32;
uint64 ui64;
int64 i64;
float f;
double d;
};
enum SqlStmtFieldType
{
FIELD_BOOL,
FIELD_UI8,
FIELD_UI16,
FIELD_UI32,
FIELD_UI64,
FIELD_I8,
FIELD_I16,
FIELD_I32,
FIELD_I64,
FIELD_FLOAT,
FIELD_DOUBLE,
FIELD_STRING,
FIELD_NONE
};
//templates might be the best choice here
//but I didn't have time to play with them
class MANGOS_DLL_SPEC SqlStmtFieldData
{
public:
SqlStmtFieldData() : m_type(FIELD_NONE) { m_binaryData.ui64 = 0; }
~SqlStmtFieldData() {}
template
SqlStmtFieldData(T param) { set(param); }
template
void set(T1 param1);
//getters
bool toBool() const { MANGOS_ASSERT(m_type == FIELD_BOOL); return m_binaryData.boolean; }
uint8 toUint8() const { MANGOS_ASSERT(m_type == FIELD_UI8); return m_binaryData.ui8; }
int8 toInt8() const { MANGOS_ASSERT(m_type == FIELD_I8); return m_binaryData.i8; }
uint16 toUint16() const { MANGOS_ASSERT(m_type == FIELD_UI16); return m_binaryData.ui16; }
int16 toInt16() const { MANGOS_ASSERT(m_type == FIELD_I16); return m_binaryData.i16; }
uint32 toUint32() const { MANGOS_ASSERT(m_type == FIELD_UI32); return m_binaryData.ui32; }
int32 toInt32() const { MANGOS_ASSERT(m_type == FIELD_I32); return m_binaryData.i32; }
uint64 toUint64() const { MANGOS_ASSERT(m_type == FIELD_UI64); return m_binaryData.ui64; }
int64 toInt64() const { MANGOS_ASSERT(m_type == FIELD_I64); return m_binaryData.i64; }
float toFloat() const { MANGOS_ASSERT(m_type == FIELD_FLOAT); return m_binaryData.f; }
double toDouble() const { MANGOS_ASSERT(m_type == FIELD_DOUBLE); return m_binaryData.d; }
const char * toStr() const { MANGOS_ASSERT(m_type == FIELD_STRING); return m_szStringData.c_str(); }
//get type of data
SqlStmtFieldType type() const { return m_type; }
//get underlying buffer type
void * buff() const { return m_type == FIELD_STRING ? (void * )m_szStringData.c_str() : (void *)&m_binaryData; }
//get size of data
size_t size() const
{
switch (m_type)
{
case FIELD_NONE: return 0;
case FIELD_BOOL: return sizeof(bool);
case FIELD_UI8: return sizeof(uint8);
case FIELD_UI16: return sizeof(uint16);
case FIELD_UI32: return sizeof(uint32);
case FIELD_UI64: return sizeof(uint64);
case FIELD_I8: return sizeof(int8);
case FIELD_I16: return sizeof(int16);
case FIELD_I32: return sizeof(int32);
case FIELD_I64: return sizeof(int64);
case FIELD_FLOAT: return sizeof(float);
case FIELD_DOUBLE: return sizeof(double);
case FIELD_STRING: return m_szStringData.length();
default:
throw std::runtime_error("unrecognized type of SqlStmtFieldType obtained");
}
}
private:
SqlStmtFieldType m_type;
SqlStmtField m_binaryData;
std::string m_szStringData;
};
//template specialization
template<> inline void SqlStmtFieldData::set(bool val) { m_type = FIELD_BOOL; m_binaryData.boolean = val; }
template<> inline void SqlStmtFieldData::set(uint8 val) { m_type = FIELD_UI8; m_binaryData.ui8 = val; }
template<> inline void SqlStmtFieldData::set(int8 val) { m_type = FIELD_I8; m_binaryData.i8 = val; }
template<> inline void SqlStmtFieldData::set(uint16 val) { m_type = FIELD_UI16; m_binaryData.ui16 = val; }
template<> inline void SqlStmtFieldData::set(int16 val) { m_type = FIELD_I16; m_binaryData.i16 = val; }
template<> inline void SqlStmtFieldData::set(uint32 val) { m_type = FIELD_UI32; m_binaryData.ui32 = val; }
template<> inline void SqlStmtFieldData::set(int32 val) { m_type = FIELD_I32; m_binaryData.i32 = val; }
template<> inline void SqlStmtFieldData::set(uint64 val) { m_type = FIELD_UI64; m_binaryData.ui64 = val; }
template<> inline void SqlStmtFieldData::set(int64 val) { m_type = FIELD_I64; m_binaryData.i64 = val; }
template<> inline void SqlStmtFieldData::set(float val) { m_type = FIELD_FLOAT; m_binaryData.f = val; }
template<> inline void SqlStmtFieldData::set(double val) { m_type = FIELD_DOUBLE; m_binaryData.d = val; }
template<> inline void SqlStmtFieldData::set(const char * val) { m_type = FIELD_STRING; m_szStringData = val; }
class SqlStatement;
//prepared statement executor
class MANGOS_DLL_SPEC SqlStmtParameters
{
public:
typedef std::vector ParameterContainer;
//reserve memory to contain all input parameters of stmt
explicit SqlStmtParameters(int nParams);
~SqlStmtParameters() {}
//get amount of bound parameters
int boundParams() const { return int(m_params.size()); }
//add parameter
void addParam(const SqlStmtFieldData& data) { m_params.push_back(data); }
//empty SQL statement parameters. In case nParams > 1 - reserve memory for parameters
//should help to reuse the same object with batched SQL requests
void reset(const SqlStatement& stmt);
//swaps contents of intenral param container
void swap(SqlStmtParameters& obj);
//get bound parameters
const ParameterContainer& params() const { return m_params; }
private:
SqlStmtParameters& operator=(const SqlStmtParameters& obj);
//statement parameter holder
ParameterContainer m_params;
};
//statement ID encapsulation logic
class SqlStatementID
{
public:
SqlStatementID() : m_bInitialized(false) {}
int ID() const { return m_nIndex; }
int arguments() const { return m_nArguments; }
bool initialized() const { return m_bInitialized; }
private:
friend class Database;
void init(int nID, int nArgs) { m_nIndex = nID; m_nArguments = nArgs; m_bInitialized = true; }
int m_nIndex;
int m_nArguments;
bool m_bInitialized;
};
//statement index
class MANGOS_DLL_SPEC SqlStatement
{
public:
~SqlStatement() { delete m_pParams; }
SqlStatement(const SqlStatement& index) : m_index(index.m_index), m_pDB(index.m_pDB), m_pParams(NULL)
{
if(index.m_pParams)
m_pParams = new SqlStmtParameters(*(index.m_pParams));
}
SqlStatement& operator=(const SqlStatement& index);
int ID() const { return m_index.ID(); }
int arguments() const { return m_index.arguments(); }
bool Execute();
bool DirectExecute();
//templates to simplify 1-4 parameter bindings
template
bool PExecute(ParamType1 param1)
{
arg(param1);
return Execute();
}
template
bool PExecute(ParamType1 param1, ParamType2 param2)
{
arg(param1);
arg(param2);
return Execute();
}
template
bool PExecute(ParamType1 param1, ParamType2 param2, ParamType3 param3)
{
arg(param1);
arg(param2);
arg(param3);
return Execute();
}
template
bool PExecute(ParamType1 param1, ParamType2 param2, ParamType3 param3, ParamType4 param4)
{
arg(param1);
arg(param2);
arg(param3);
arg(param4);
return Execute();
}
//bind parameters with specified type
void addBool(bool var) { arg(var); }
void addUInt8(uint8 var) { arg(var); }
void addInt8(int8 var) { arg(var); }
void addUInt16(uint16 var) { arg(var); }
void addInt16(int16 var) { arg(var); }
void addUInt32(uint32 var) { arg(var); }
void addInt32(int32 var) { arg(var); }
void addUInt64(uint64 var) { arg(var); }
void addInt64(int64 var) { arg(var); }
void addFloat(float var) { arg(var); }
void addDouble(double var) { arg(var); }
void addString(const char * var) { arg(var); }
void addString(const std::string& var) { arg(var.c_str()); }
void addString(std::ostringstream& ss) { arg(ss.str().c_str()); ss.str(std::string()); }
protected:
//don't allow anyone except Database class to create static SqlStatement objects
friend class Database;
SqlStatement(const SqlStatementID& index, Database& db) : m_index(index), m_pDB(&db), m_pParams(NULL) {}
private:
SqlStmtParameters * get()
{
if(!m_pParams)
m_pParams = new SqlStmtParameters(arguments());
return m_pParams;
}
SqlStmtParameters * detach()
{
SqlStmtParameters * p = m_pParams ? m_pParams : new SqlStmtParameters(0);
m_pParams = NULL;
return p;
}
//helper function
//use appropriate add* functions to bind specific data type
template
void arg(ParamType val)
{
SqlStmtParameters * p = get();
p->addParam(SqlStmtFieldData(val));
}
SqlStatementID m_index;
Database * m_pDB;
SqlStmtParameters * m_pParams;
};
//base prepared statement class
class MANGOS_DLL_SPEC SqlPreparedStatement
{
public:
virtual ~SqlPreparedStatement() {}
bool isPrepared() const { return m_bPrepared; }
bool isQuery() const { return m_bIsQuery; }
uint32 params() const { return m_nParams; }
uint32 columns() const { return isQuery() ? m_nColumns : 0; }
//initialize internal structures of prepared statement
//upon success m_bPrepared should be true
virtual bool prepare() = 0;
//bind parameters for prepared statement from parameter placeholder
virtual void bind(const SqlStmtParameters& holder) = 0;
//execute statement w/o result set
virtual bool execute() = 0;
protected:
SqlPreparedStatement(const std::string& fmt, SqlConnection& conn) : m_szFmt(fmt), m_nParams(0), m_nColumns(0), m_bPrepared(false), m_bIsQuery(false), m_pConn(conn) {}
uint32 m_nParams;
uint32 m_nColumns;
bool m_bIsQuery;
bool m_bPrepared;
std::string m_szFmt;
SqlConnection& m_pConn;
};
//prepared statements via plain SQL string requests
class MANGOS_DLL_SPEC SqlPlainPreparedStatement : public SqlPreparedStatement
{
public:
SqlPlainPreparedStatement(const std::string& fmt, SqlConnection& conn);
~SqlPlainPreparedStatement() {}
//this statement is always prepared
virtual bool prepare() { return true; }
//we should replace all '?' symbols with substrings with proper format
virtual void bind(const SqlStmtParameters& holder);
virtual bool execute();
protected:
void DataToString(const SqlStmtFieldData& data, std::ostringstream& fmt);
std::string m_szPlainRequest;
};
#endif