summaryrefslogtreecommitdiff
path: root/src/common/sql.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/sql.h')
-rw-r--r--src/common/sql.h244
1 files changed, 94 insertions, 150 deletions
diff --git a/src/common/sql.h b/src/common/sql.h
index 898e2c778..d5a0eda2c 100644
--- a/src/common/sql.h
+++ b/src/common/sql.h
@@ -1,5 +1,6 @@
-// Copyright (c) Athena Dev Teams - Licensed under GNU GPL
-// For more information, see LICENCE in the main folder
+// Copyright (c) Hercules Dev Team, licensed under GNU GPL.
+// See the LICENSE file
+// Portions Copyright (c) Athena Dev Teams
#ifndef _COMMON_SQL_H_
#define _COMMON_SQL_H_
@@ -21,8 +22,7 @@
/// Data type identifier.
/// String, enum and blob data types need the buffer length specified.
-enum SqlDataType
-{
+enum SqlDataType {
SQLDT_NULL,
// fixed size
SQLDT_INT8,
@@ -63,149 +63,96 @@ typedef enum SqlDataType SqlDataType;
typedef struct Sql Sql;
typedef struct SqlStmt SqlStmt;
-
-/// Allocates and initializes a new Sql handle.
-struct Sql* Sql_Malloc(void);
-
-
-
-/// Establishes a connection.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_Connect(Sql* self, const char* user, const char* passwd, const char* host, uint16 port, const char* db);
-
-
-
-
-/// Retrieves the timeout of the connection.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_GetTimeout(Sql* self, uint32* out_timeout);
-
-
-
-
-/// Retrieves the name of the columns of a table into out_buf, with the separator after each name.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_GetColumnNames(Sql* self, const char* table, char* out_buf, size_t buf_len, char sep);
-
-
-
-
-/// Changes the encoding of the connection.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_SetEncoding(Sql* self, const char* encoding);
-
-
-
-/// Pings the connection.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_Ping(Sql* self);
-
-
-
-/// Escapes a string.
-/// The output buffer must be at least strlen(from)*2+1 in size.
-///
-/// @return The size of the escaped string
-size_t Sql_EscapeString(Sql* self, char* out_to, const char* from);
-
-
-
-/// Escapes a string.
-/// The output buffer must be at least from_len*2+1 in size.
-///
-/// @return The size of the escaped string
-size_t Sql_EscapeStringLen(Sql* self, char* out_to, const char* from, size_t from_len);
-
-
-
-/// Executes a query.
-/// Any previous result is freed.
-/// The query is constructed as if it was sprintf.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_Query(Sql* self, const char* query, ...);
-
-
-
-/// Executes a query.
-/// Any previous result is freed.
-/// The query is constructed as if it was svprintf.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_QueryV(Sql* self, const char* query, va_list args);
-
-
-
-/// Executes a query.
-/// Any previous result is freed.
-/// The query is used directly.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_QueryStr(Sql* self, const char* query);
-
-
-
-/// Returns the number of the AUTO_INCREMENT column of the last INSERT/UPDATE query.
-///
-/// @return Value of the auto-increment column
-uint64 Sql_LastInsertId(Sql* self);
-
-
-
-/// Returns the number of columns in each row of the result.
-///
-/// @return Number of columns
-uint32 Sql_NumColumns(Sql* self);
-
-
-
-/// Returns the number of rows in the result.
-///
-/// @return Number of rows
-uint64 Sql_NumRows(Sql* self);
-
-
-
-/// Fetches the next row.
-/// The data of the previous row is no longer valid.
-///
-/// @return SQL_SUCCESS, SQL_ERROR or SQL_NO_DATA
-int Sql_NextRow(Sql* self);
-
-
-
-/// Gets the data of a column.
-/// The data remains valid until the next row is fetched or the result is freed.
-///
-/// @return SQL_SUCCESS or SQL_ERROR
-int Sql_GetData(Sql* self, size_t col, char** out_buf, size_t* out_len);
-
-
-
-/// Frees the result of the query.
-void Sql_FreeResult(Sql* self);
-
-
+struct sql_interface {
+ /// Establishes a connection.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*Connect) (Sql* self, const char* user, const char* passwd, const char* host, uint16 port, const char* db);
+ /// Retrieves the timeout of the connection.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*GetTimeout) (Sql* self, uint32* out_timeout);
+ /// Retrieves the name of the columns of a table into out_buf, with the separator after each name.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*GetColumnNames) (Sql* self, const char* table, char* out_buf, size_t buf_len, char sep);
+ /// Changes the encoding of the connection.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*SetEncoding) (Sql* self, const char* encoding);
+ /// Pings the connection.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*Ping) (Sql* self);
+ /// Escapes a string.
+ /// The output buffer must be at least strlen(from)*2+1 in size.
+ ///
+ /// @return The size of the escaped string
+ size_t (*EscapeString) (Sql* self, char* out_to, const char* from);
+ /// Escapes a string.
+ /// The output buffer must be at least from_len*2+1 in size.
+ ///
+ /// @return The size of the escaped string
+ size_t (*EscapeStringLen) (Sql* self, char* out_to, const char* from, size_t from_len);
+ /// Executes a query.
+ /// Any previous result is freed.
+ /// The query is constructed as if it was sprintf.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*Query) (Sql* self, const char* query, ...);
+ /// Executes a query.
+ /// Any previous result is freed.
+ /// The query is constructed as if it was svprintf.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*QueryV) (Sql* self, const char* query, va_list args);
+ /// Executes a query.
+ /// Any previous result is freed.
+ /// The query is used directly.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*QueryStr) (Sql* self, const char* query);
+ /// Returns the number of the AUTO_INCREMENT column of the last INSERT/UPDATE query.
+ ///
+ /// @return Value of the auto-increment column
+ uint64 (*LastInsertId) (Sql* self);
+ /// Returns the number of columns in each row of the result.
+ ///
+ /// @return Number of columns
+ uint32 (*NumColumns) (Sql* self);
+ /// Returns the number of rows in the result.
+ ///
+ /// @return Number of rows
+ uint64 (*NumRows) (Sql* self);
+ /// Fetches the next row.
+ /// The data of the previous row is no longer valid.
+ ///
+ /// @return SQL_SUCCESS, SQL_ERROR or SQL_NO_DATA
+ int (*NextRow) (Sql* self);
+ /// Gets the data of a column.
+ /// The data remains valid until the next row is fetched or the result is freed.
+ ///
+ /// @return SQL_SUCCESS or SQL_ERROR
+ int (*GetData) (Sql* self, size_t col, char** out_buf, size_t* out_len);
+ /// Frees the result of the query.
+ void (*FreeResult) (Sql* self);
+ /// Shows debug information (last query).
+ void (*ShowDebug_) (Sql* self, const char* debug_file, const unsigned long debug_line);
+ /// Frees a Sql handle returned by Sql_Malloc.
+ void (*Free) (Sql* self);
+ /// Allocates and initializes a new Sql handle.
+ struct Sql *(*Malloc) (void);
+} sql_s;
+
+struct sql_interface *SQL;
+
+void sql_defaults(void);
#if defined(SQL_REMOVE_SHOWDEBUG)
-#define Sql_ShowDebug(self) (void)0
+ #define Sql_ShowDebug(self) (void)0
#else
-#define Sql_ShowDebug(self) Sql_ShowDebug_(self, __FILE__, __LINE__)
+ #define Sql_ShowDebug(self) SQL->ShowDebug_(self, __FILE__, __LINE__)
#endif
-/// Shows debug information (last query).
-void Sql_ShowDebug_(Sql* self, const char* debug_file, const unsigned long debug_line);
-
-
-
-/// Frees a Sql handle returned by Sql_Malloc.
-void Sql_Free(Sql* self);
-
-
///////////////////////////////////////////////////////////////////////////////
// Prepared Statements
@@ -220,8 +167,6 @@ void Sql_Free(Sql* self);
// 1) SELECT col FROM table WHERE id=?
// 2) INSERT INTO table(col1,col2) VALUES(?,?)
-
-
/// Allocates and initializes a new SqlStmt handle.
/// It uses the connection of the parent Sql handle.
/// Queries in Sql and SqlStmt are independent and don't affect each other.
@@ -238,8 +183,6 @@ struct SqlStmt* SqlStmt_Malloc(Sql* sql);
/// @return SQL_SUCCESS or SQL_ERROR
int SqlStmt_Prepare(SqlStmt* self, const char* query, ...);
-
-
/// Prepares the statement.
/// Any previous result is freed and all parameter bindings are removed.
/// The query is constructed as if it was svprintf.
@@ -324,12 +267,12 @@ int SqlStmt_NextRow(SqlStmt* self);
/// Frees the result of the statement execution.
void SqlStmt_FreeResult(SqlStmt* self);
-
+void Sql_HerculesUpdateCheck(Sql* self);
#if defined(SQL_REMOVE_SHOWDEBUG)
-#define SqlStmt_ShowDebug(self) (void)0
+ #define SqlStmt_ShowDebug(self) (void)0
#else
-#define SqlStmt_ShowDebug(self) SqlStmt_ShowDebug_(self, __FILE__, __LINE__)
+ #define SqlStmt_ShowDebug(self) SqlStmt_ShowDebug_(self, __FILE__, __LINE__)
#endif
/// Shows debug information (with statement).
void SqlStmt_ShowDebug_(SqlStmt* self, const char* debug_file, const unsigned long debug_line);
@@ -339,6 +282,7 @@ void SqlStmt_ShowDebug_(SqlStmt* self, const char* debug_file, const unsigned lo
/// Frees a SqlStmt returned by SqlStmt_Malloc.
void SqlStmt_Free(SqlStmt* self);
+void Sql_Init(void);
#endif /* _COMMON_SQL_H_ */