Luanti 5.19.0-dev
Loading...
Searching...
No Matches
database-sqlite3.h
Go to the documentation of this file.
1// Luanti
2// SPDX-License-Identifier: LGPL-2.1-or-later
3// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
5#pragma once
6
7#include <cstring>
8#include <string>
9#include "database.h"
10#include "exceptions.h"
11
12extern "C" {
13#include "sqlite3.h"
14}
15
16// Template class for SQLite3 based data storage
18{
19public:
20 virtual ~Database_SQLite3();
21
22 void beginSave() override;
23 void endSave() override;
24
25 bool initialized() const override { return m_initialized; }
26
28 void verifyDatabase() override;
29
30protected:
31 Database_SQLite3(const std::string &savedir, const std::string &dbname);
32
33 // Check if a specific table exists
34 bool checkTable(const char *table);
35
36 // Check if a table has a specific column
37 bool checkColumn(const char *table, const char *column);
38
39 /* Value conversion helpers */
40
41 inline void str_to_sqlite(sqlite3_stmt *s, int iCol, std::string_view str) const
42 {
43 sqlite3_vrfy(sqlite3_bind_text(s, iCol, str.data(), str.size(), NULL));
44 }
45
46 inline void blob_to_sqlite(sqlite3_stmt *s, int iCol, std::string_view str) const
47 {
48 sqlite3_vrfy(sqlite3_bind_blob(s, iCol, str.data(), str.size(), NULL));
49 }
50
51 inline void int_to_sqlite(sqlite3_stmt *s, int iCol, int val) const
52 {
53 sqlite3_vrfy(sqlite3_bind_int(s, iCol, val));
54 }
55
56 inline void int64_to_sqlite(sqlite3_stmt *s, int iCol, s64 val) const
57 {
58 sqlite3_vrfy(sqlite3_bind_int64(s, iCol, (sqlite3_int64) val));
59 }
60
61 inline void double_to_sqlite(sqlite3_stmt *s, int iCol, double val) const
62 {
63 sqlite3_vrfy(sqlite3_bind_double(s, iCol, val));
64 }
65
66 // Note that the return value is only valid until the statement is stepped or reset.
67 inline std::string_view sqlite_to_string_view(sqlite3_stmt *s, int iCol)
68 {
69 const char* text = reinterpret_cast<const char*>(sqlite3_column_text(s, iCol));
70 return text ? std::string_view(text) : std::string_view();
71 }
72
73 // Avoid using this in favor of `sqlite_to_string_view`.
74 inline std::string sqlite_to_string(sqlite3_stmt *s, int iCol)
75 {
76 return std::string(sqlite_to_string_view(s, iCol));
77 }
78
79 // Converts a BLOB-type column into a string_view (null byte safe).
80 // Note that the return value is only valid until the statement is stepped or reset.
81 inline std::string_view sqlite_to_blob(sqlite3_stmt *s, int iCol)
82 {
83 const char *data = reinterpret_cast<const char*>(sqlite3_column_blob(s, iCol));
84 if (!data)
85 return std::string_view();
86 size_t len = sqlite3_column_bytes(s, iCol);
87 return std::string_view(data, len);
88 }
89
90 inline s32 sqlite_to_int(sqlite3_stmt *s, int iCol)
91 {
92 return sqlite3_column_int(s, iCol);
93 }
94
95 inline u32 sqlite_to_uint(sqlite3_stmt *s, int iCol)
96 {
97 return (u32) sqlite3_column_int(s, iCol);
98 }
99
100 inline s64 sqlite_to_int64(sqlite3_stmt *s, int iCol)
101 {
102 return (s64) sqlite3_column_int64(s, iCol);
103 }
104
105 inline u64 sqlite_to_uint64(sqlite3_stmt *s, int iCol)
106 {
107 return (u64) sqlite3_column_int64(s, iCol);
108 }
109
110 inline float sqlite_to_float(sqlite3_stmt *s, int iCol)
111 {
112 return (float) sqlite3_column_double(s, iCol);
113 }
114
115 inline const v3f sqlite_to_v3f(sqlite3_stmt *s, int iCol)
116 {
117 return v3f(sqlite_to_float(s, iCol), sqlite_to_float(s, iCol + 1),
118 sqlite_to_float(s, iCol + 2));
119 }
120
121 // Helper for verifying result of sqlite3 calls
122 inline void sqlite3_vrfy(int s, std::string_view m = "", int r = SQLITE_OK) const
123 {
124 if (s != r) {
125 std::string msg(m);
126 if (!msg.empty())
127 msg.append(": ");
128 msg.append(sqlite3_errmsg(m_database));
129 throw DatabaseException(msg);
130 }
131 }
132
133 inline void sqlite3_vrfy(const int s, const int r, std::string_view m = "") const
134 {
135 sqlite3_vrfy(s, m, r);
136 }
137
142 inline bool sqlite3_vrfy_step(int s, std::string_view m = "") const
143 {
144 if (s == SQLITE_ROW)
145 return true;
146 sqlite3_vrfy(s, m, SQLITE_DONE);
147 return false;
148 }
149
150 // Called after opening a fresh database file. Should create tables and indices.
151 virtual void createDatabase() = 0;
152
153 // Should prepare the necessary statements.
154 virtual void initStatements() = 0;
155
156 sqlite3 *m_database = nullptr;
157
158private:
159 // Open the database
160 void openDatabase();
161
162 bool m_initialized = false;
163
164 const std::string m_savedir;
165 const std::string m_dbname;
166
167 sqlite3_stmt *m_stmt_begin = nullptr;
168 sqlite3_stmt *m_stmt_end = nullptr;
169
171
172 static int busyHandler(void *data, int count);
173};
174
175// Not sure why why we have to do this. can't C++ figure it out on its own?
176#define PARENT_CLASS_FUNCS \
177 void beginSave() { Database_SQLite3::beginSave(); } \
178 void endSave() { Database_SQLite3::endSave(); } \
179 void verifyDatabase() { Database_SQLite3::verifyDatabase(); }
180
182{
183public:
184 MapDatabaseSQLite3(const std::string &savedir);
185 virtual ~MapDatabaseSQLite3();
186
187 bool saveBlock(const v3s16 &pos, std::string_view data);
188 void loadBlock(const v3s16 &pos, std::string *block);
189 bool deleteBlock(const v3s16 &pos);
190 void listAllLoadableBlocks(std::vector<v3s16> &dst);
191
193
194protected:
195 virtual void createDatabase();
196 virtual void initStatements();
197
198private:
201 int bindPos(sqlite3_stmt *stmt, v3s16 pos, int index = 1);
202
203 bool m_new_format = false;
204
205 sqlite3_stmt *m_stmt_read = nullptr;
206 sqlite3_stmt *m_stmt_write = nullptr;
207 sqlite3_stmt *m_stmt_list = nullptr;
208 sqlite3_stmt *m_stmt_delete = nullptr;
209};
210
212{
213public:
214 PlayerDatabaseSQLite3(const std::string &savedir);
215 virtual ~PlayerDatabaseSQLite3();
216
217 void savePlayer(RemotePlayer *player);
218 bool loadPlayer(RemotePlayer *player, PlayerSAO *sao);
219 bool removePlayer(const std::string &name);
220 void listPlayers(std::vector<std::string> &res);
221
223
224protected:
225 virtual void createDatabase();
226 virtual void initStatements();
227
228private:
229 bool playerDataExists(const std::string &name);
230
231 // Players
232 sqlite3_stmt *m_stmt_player_load = nullptr;
233 sqlite3_stmt *m_stmt_player_add = nullptr;
234 sqlite3_stmt *m_stmt_player_update = nullptr;
235 sqlite3_stmt *m_stmt_player_remove = nullptr;
236 sqlite3_stmt *m_stmt_player_list = nullptr;
237 sqlite3_stmt *m_stmt_player_load_inventory = nullptr;
238 sqlite3_stmt *m_stmt_player_load_inventory_items = nullptr;
239 sqlite3_stmt *m_stmt_player_add_inventory = nullptr;
240 sqlite3_stmt *m_stmt_player_add_inventory_items = nullptr;
241 sqlite3_stmt *m_stmt_player_remove_inventory = nullptr;
243 sqlite3_stmt *m_stmt_player_metadata_load = nullptr;
244 sqlite3_stmt *m_stmt_player_metadata_remove = nullptr;
245 sqlite3_stmt *m_stmt_player_metadata_add = nullptr;
246};
247
249{
250public:
251 AuthDatabaseSQLite3(const std::string &savedir);
252 virtual ~AuthDatabaseSQLite3();
253
254 virtual bool getAuth(const std::string &name, AuthEntry &res);
255 virtual bool saveAuth(const AuthEntry &authEntry);
256 virtual bool createAuth(AuthEntry &authEntry);
257 virtual bool deleteAuth(const std::string &name);
258 virtual void listNames(std::vector<std::string> &res);
259 virtual void reload();
260
262
263protected:
264 virtual void createDatabase();
265 virtual void initStatements();
266
267private:
268 virtual void writePrivileges(const AuthEntry &authEntry);
269
270 sqlite3_stmt *m_stmt_read = nullptr;
271 sqlite3_stmt *m_stmt_write = nullptr;
272 sqlite3_stmt *m_stmt_create = nullptr;
273 sqlite3_stmt *m_stmt_delete = nullptr;
274 sqlite3_stmt *m_stmt_list_names = nullptr;
275 sqlite3_stmt *m_stmt_read_privs = nullptr;
276 sqlite3_stmt *m_stmt_write_privs = nullptr;
277 sqlite3_stmt *m_stmt_delete_privs = nullptr;
278 sqlite3_stmt *m_stmt_last_insert_rowid = nullptr;
279};
280
282{
283public:
284 ModStorageDatabaseSQLite3(const std::string &savedir);
286
287 virtual void getModEntries(const std::string &modname, StringMap *storage);
288 virtual void getModKeys(const std::string &modname, std::vector<std::string> *storage);
289 virtual bool getModEntry(const std::string &modname,
290 const std::string &key, std::string *value);
291 virtual bool hasModEntry(const std::string &modname, const std::string &key);
292 virtual bool setModEntry(const std::string &modname,
293 const std::string &key,std::string_view value);
294 virtual bool removeModEntry(const std::string &modname, const std::string &key);
295 virtual bool removeModEntries(const std::string &modname);
296 virtual void listMods(std::vector<std::string> *res);
297
299
300protected:
301 virtual void createDatabase();
302 virtual void initStatements();
303
304private:
305 sqlite3_stmt *m_stmt_get_mods = nullptr;
306 sqlite3_stmt *m_stmt_get_all = nullptr;
307 sqlite3_stmt *m_stmt_get_keys = nullptr;
308 sqlite3_stmt *m_stmt_get = nullptr;
309 sqlite3_stmt *m_stmt_has = nullptr;
310 sqlite3_stmt *m_stmt_set = nullptr;
311 sqlite3_stmt *m_stmt_remove = nullptr;
312 sqlite3_stmt *m_stmt_remove_all = nullptr;
313};
314
315#undef PARENT_CLASS_FUNCS
virtual void listNames(std::vector< std::string > &res)
Definition database-sqlite3.cpp:784
sqlite3_stmt * m_stmt_list_names
Definition database-sqlite3.h:274
virtual bool deleteAuth(const std::string &name)
Definition database-sqlite3.cpp:770
virtual void createDatabase()
Definition database-sqlite3.cpp:666
sqlite3_stmt * m_stmt_read
Definition database-sqlite3.h:270
sqlite3_stmt * m_stmt_write
Definition database-sqlite3.h:271
sqlite3_stmt * m_stmt_delete
Definition database-sqlite3.h:273
sqlite3_stmt * m_stmt_create
Definition database-sqlite3.h:272
virtual bool getAuth(const std::string &name, AuthEntry &res)
Definition database-sqlite3.cpp:707
AuthDatabaseSQLite3(const std::string &savedir)
Definition database-sqlite3.cpp:648
sqlite3_stmt * m_stmt_delete_privs
Definition database-sqlite3.h:277
virtual void reload()
Definition database-sqlite3.cpp:794
sqlite3_stmt * m_stmt_read_privs
Definition database-sqlite3.h:275
virtual bool createAuth(AuthEntry &authEntry)
Definition database-sqlite3.cpp:748
virtual void initStatements()
Definition database-sqlite3.cpp:691
virtual void writePrivileges(const AuthEntry &authEntry)
Definition database-sqlite3.cpp:799
sqlite3_stmt * m_stmt_last_insert_rowid
Definition database-sqlite3.h:278
sqlite3_stmt * m_stmt_write_privs
Definition database-sqlite3.h:276
virtual bool saveAuth(const AuthEntry &authEntry)
Definition database-sqlite3.cpp:731
Definition database.h:66
DatabaseException(const std::string &s)
Definition exceptions.h:48
bool checkColumn(const char *table, const char *column)
Definition database-sqlite3.cpp:181
std::string_view sqlite_to_blob(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:81
void openDatabase()
Definition database-sqlite3.cpp:110
sqlite3 * m_database
Definition database-sqlite3.h:156
void beginSave() override
Definition database-sqlite3.cpp:94
void str_to_sqlite(sqlite3_stmt *s, int iCol, std::string_view str) const
Definition database-sqlite3.h:41
bool initialized() const override
Definition database-sqlite3.h:25
std::string_view sqlite_to_string_view(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:67
void sqlite3_vrfy(int s, std::string_view m="", int r=SQLITE_OK) const
Definition database-sqlite3.h:122
float sqlite_to_float(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:110
virtual void initStatements()=0
void int64_to_sqlite(sqlite3_stmt *s, int iCol, s64 val) const
Definition database-sqlite3.h:56
bool checkTable(const char *table)
Definition database-sqlite3.cpp:163
const std::string m_dbname
Definition database-sqlite3.h:165
void blob_to_sqlite(sqlite3_stmt *s, int iCol, std::string_view str) const
Definition database-sqlite3.h:46
sqlite3_stmt * m_stmt_end
Definition database-sqlite3.h:168
sqlite3_stmt * m_stmt_begin
Definition database-sqlite3.h:167
std::string sqlite_to_string(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:74
s32 sqlite_to_int(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:90
u64 sqlite_to_uint64(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:105
s64 sqlite_to_int64(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:100
void double_to_sqlite(sqlite3_stmt *s, int iCol, double val) const
Definition database-sqlite3.h:61
virtual void createDatabase()=0
bool m_initialized
Definition database-sqlite3.h:162
Database_SQLite3(const std::string &savedir, const std::string &dbname)
Definition database-sqlite3.cpp:88
u32 sqlite_to_uint(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:95
void verifyDatabase() override
Definition database-sqlite3.cpp:149
void sqlite3_vrfy(const int s, const int r, std::string_view m="") const
Definition database-sqlite3.h:133
const std::string m_savedir
Definition database-sqlite3.h:164
static int busyHandler(void *data, int count)
Definition database-sqlite3.cpp:46
const v3f sqlite_to_v3f(sqlite3_stmt *s, int iCol)
Definition database-sqlite3.h:115
bool sqlite3_vrfy_step(int s, std::string_view m="") const
Helper for verifying result of sqlite3_step().
Definition database-sqlite3.h:142
void int_to_sqlite(sqlite3_stmt *s, int iCol, int val) const
Definition database-sqlite3.h:51
void endSave() override
Definition database-sqlite3.cpp:102
u64 m_busy_handler_data[2]
Definition database-sqlite3.h:170
Definition database.h:15
sqlite3_stmt * m_stmt_list
Definition database-sqlite3.h:207
sqlite3_stmt * m_stmt_write
Definition database-sqlite3.h:206
sqlite3_stmt * m_stmt_delete
Definition database-sqlite3.h:208
void listAllLoadableBlocks(std::vector< v3s16 > &dst)
Definition database-sqlite3.cpp:331
virtual void createDatabase()
Definition database-sqlite3.cpp:227
sqlite3_stmt * m_stmt_read
Definition database-sqlite3.h:205
void loadBlock(const v3s16 &pos, std::string *block)
Definition database-sqlite3.cpp:313
MapDatabaseSQLite3(const std::string &savedir)
Definition database-sqlite3.cpp:212
bool deleteBlock(const v3s16 &pos)
Definition database-sqlite3.cpp:284
virtual void initStatements()
Definition database-sqlite3.cpp:251
int bindPos(sqlite3_stmt *stmt, v3s16 pos, int index=1)
Bind block position into statement at column index.
Definition database-sqlite3.cpp:271
bool saveBlock(const v3s16 &pos, std::string_view data)
Definition database-sqlite3.cpp:300
bool m_new_format
Definition database-sqlite3.h:203
Definition database.h:28
ModStorageDatabaseSQLite3(const std::string &savedir)
Definition database-sqlite3.cpp:812
sqlite3_stmt * m_stmt_set
Definition database-sqlite3.h:310
virtual void getModEntries(const std::string &modname, StringMap *storage)
Definition database-sqlite3.cpp:859
virtual bool getModEntry(const std::string &modname, const std::string &key, std::string *value)
Definition database-sqlite3.cpp:889
sqlite3_stmt * m_stmt_get
Definition database-sqlite3.h:308
sqlite3_stmt * m_stmt_get_mods
Definition database-sqlite3.h:305
sqlite3_stmt * m_stmt_has
Definition database-sqlite3.h:309
virtual bool removeModEntries(const std::string &modname)
Definition database-sqlite3.cpp:951
sqlite3_stmt * m_stmt_get_all
Definition database-sqlite3.h:306
sqlite3_stmt * m_stmt_remove_all
Definition database-sqlite3.h:312
virtual void getModKeys(const std::string &modname, std::vector< std::string > *storage)
Definition database-sqlite3.cpp:874
sqlite3_stmt * m_stmt_remove
Definition database-sqlite3.h:311
virtual void initStatements()
Definition database-sqlite3.cpp:844
virtual bool removeModEntry(const std::string &modname, const std::string &key)
Definition database-sqlite3.cpp:936
sqlite3_stmt * m_stmt_get_keys
Definition database-sqlite3.h:307
virtual void createDatabase()
Definition database-sqlite3.cpp:829
virtual void listMods(std::vector< std::string > *res)
Definition database-sqlite3.cpp:964
virtual bool hasModEntry(const std::string &modname, const std::string &key)
Definition database-sqlite3.cpp:908
virtual bool setModEntry(const std::string &modname, const std::string &key, std::string_view value)
Definition database-sqlite3.cpp:921
Definition database.h:79
sqlite3_stmt * m_stmt_player_add_inventory
Definition database-sqlite3.h:239
sqlite3_stmt * m_stmt_player_load_inventory_items
Definition database-sqlite3.h:238
bool playerDataExists(const std::string &name)
Definition database-sqlite3.cpp:470
sqlite3_stmt * m_stmt_player_remove_inventory_items
Definition database-sqlite3.h:242
bool loadPlayer(RemotePlayer *player, PlayerSAO *sao)
Definition database-sqlite3.cpp:569
sqlite3_stmt * m_stmt_player_load_inventory
Definition database-sqlite3.h:237
bool removePlayer(const std::string &name)
Definition database-sqlite3.cpp:623
virtual void initStatements()
Definition database-sqlite3.cpp:436
void listPlayers(std::vector< std::string > &res)
Definition database-sqlite3.cpp:634
sqlite3_stmt * m_stmt_player_metadata_load
Definition database-sqlite3.h:243
sqlite3_stmt * m_stmt_player_add_inventory_items
Definition database-sqlite3.h:240
virtual void createDatabase()
Definition database-sqlite3.cpp:379
sqlite3_stmt * m_stmt_player_remove
Definition database-sqlite3.h:235
sqlite3_stmt * m_stmt_player_remove_inventory
Definition database-sqlite3.h:241
sqlite3_stmt * m_stmt_player_list
Definition database-sqlite3.h:236
sqlite3_stmt * m_stmt_player_update
Definition database-sqlite3.h:234
sqlite3_stmt * m_stmt_player_load
Definition database-sqlite3.h:232
sqlite3_stmt * m_stmt_player_metadata_add
Definition database-sqlite3.h:245
void savePlayer(RemotePlayer *player)
Definition database-sqlite3.cpp:479
sqlite3_stmt * m_stmt_player_metadata_remove
Definition database-sqlite3.h:244
PlayerDatabaseSQLite3(const std::string &savedir)
Definition database-sqlite3.cpp:354
sqlite3_stmt * m_stmt_player_add
Definition database-sqlite3.h:233
Definition database.h:46
Definition player_sao.h:58
Definition remoteplayer.h:28
#define PARENT_CLASS_FUNCS
Definition database-sqlite3.h:176
core::vector3d< s16 > v3s16
Definition irr_v3d.h:13
core::vector3df v3f
Definition irr_v3d.h:11
static std::vector< table_key > table
Definition keycode.cpp:34
std::unordered_map< std::string, std::string > StringMap
Definition string.h:69
Definition database.h:57