1#ifndef ENGINE_SERVER_DATABASES_CONNECTION_H
2#define ENGINE_SERVER_DATABASES_CONNECTION_H
3
4#include "connection_pool.h"
5
6#include <engine/shared/protocol.h>
7
8#include <memory>
9#include <optional>
10
11enum
12{
13 // MAX_NAME_LENGTH includes the size with \0, which is not necessary in SQL
14 MAX_NAME_LENGTH_SQL = MAX_NAME_LENGTH - 1,
15};
16
17// can hold one PreparedStatement with Results
18class IDbConnection
19{
20public:
21 IDbConnection(const char *pPrefix);
22 virtual ~IDbConnection() = default;
23 IDbConnection &operator=(const IDbConnection &) = delete;
24 virtual void Print(const char *pMode) = 0;
25
26 // returns the database prefix
27 const char *GetPrefix() const { return m_aPrefix; }
28 virtual const char *BinaryCollate() const = 0;
29 // can be inserted into queries to convert a timestamp variable to the unix timestamp
30 virtual void ToUnixTimestamp(const char *pTimestamp, char *aBuf, unsigned int BufferSize) = 0;
31 // since MySQL automatically converts timestamps to utc, meanwhile sqlite code has to
32 // explicitly convert before inserting timestamps, NOTE: CURRENT_TIMESTAMP in SQLite is UTC by
33 // default and doesn't have to be converted
34 virtual const char *InsertTimestampAsUtc() const = 0;
35 // can be used in the context of `LIKE Map`, adds `? COLLATE`
36 virtual const char *CollateNocase() const = 0;
37 // syntax to insert a row into table or ignore if it already exists
38 virtual const char *InsertIgnore() const = 0;
39 // ORDER BY RANDOM()/RAND()
40 virtual const char *Random() const = 0;
41 virtual const char *False() const = 0;
42 virtual const char *True() const = 0;
43
44 // tries to allocate the connection from the pool established
45 //
46 // returns true on success
47 virtual bool Connect(char *pError, int ErrorSize) = 0;
48 // has to be called to return the connection back to the pool
49 virtual void Disconnect() = 0;
50
51 // ? for Placeholders, connection has to be established, can overwrite previous prepared statements
52 //
53 // returns true on success
54 virtual bool PrepareStatement(const char *pStmt, char *pError, int ErrorSize) = 0;
55
56 // PrepareStatement has to be called beforehand,
57 virtual void BindString(int Idx, const char *pString) = 0;
58 virtual void BindBlob(int Idx, unsigned char *pBlob, int Size) = 0;
59 virtual void BindInt(int Idx, int Value) = 0;
60 virtual void BindInt64(int Idx, int64_t Value) = 0;
61 virtual void BindFloat(int Idx, float Value) = 0;
62 virtual void BindNull(int Idx) = 0;
63
64 // Print expanded sql statement
65 virtual void Print() = 0;
66
67 // executes the query and returns if a result row exists and selects it
68 // when called multiple times the next row is selected
69 //
70 // returns true on success
71 virtual bool Step(bool *pEnd, char *pError, int ErrorSize) = 0;
72 // executes the query and returns the number of rows affected by the update/insert/delete
73 //
74 // returns true on success
75 virtual bool ExecuteUpdate(int *pNumUpdated, char *pError, int ErrorSize) = 0;
76
77 virtual bool IsNull(int Col) = 0;
78 virtual float GetFloat(int Col) = 0;
79 virtual int GetInt(int Col) = 0;
80 virtual int64_t GetInt64(int Col) = 0;
81 // ensures that the string is null terminated
82 virtual void GetString(int Col, char *pBuffer, int BufferSize) = 0;
83 // returns number of bytes read into the buffer
84 virtual int GetBlob(int Col, unsigned char *pBuffer, int BufferSize) = 0;
85 std::optional<float> GetOptionalFloat(int Col);
86 std::optional<int> GetOptionalInt(int Col);
87 std::optional<int64_t> GetOptionalInt64(int Col);
88
89 // SQL statements, that can't be abstracted, has side effects to the result
90 virtual bool AddPoints(const char *pPlayer, int Points, char *pError, int ErrorSize) = 0;
91
92private:
93 char m_aPrefix[64];
94
95protected:
96 void FormatCreateRace(char *aBuf, unsigned int BufferSize, bool Backup) const;
97 void FormatCreateTeamrace(char *aBuf, unsigned int BufferSize, const char *pIdType, bool Backup) const;
98 void FormatCreateMaps(char *aBuf, unsigned int BufferSize) const;
99 void FormatCreateSaves(char *aBuf, unsigned int BufferSize, bool Backup) const;
100 void FormatCreatePoints(char *aBuf, unsigned int BufferSize) const;
101};
102
103bool MysqlAvailable();
104int MysqlInit();
105void MysqlUninit();
106
107std::unique_ptr<IDbConnection> CreateSqliteConnection(const char *pFilename, bool Setup);
108// Returns nullptr if MySQL support is not compiled in.
109std::unique_ptr<IDbConnection> CreateMysqlConnection(CMysqlConfig Config);
110
111#endif // ENGINE_SERVER_DATABASES_CONNECTION_H
112