1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/*
* The Mana World Server
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World 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 any later version.
*
* The Mana World 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 The Mana World; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMWSERV_DALSTORAGE_H_
#define _TMWSERV_DALSTORAGE_H_
#include <list>
#include <map>
#include "dal/dataprovider.h"
class Account;
class Character;
class ChatChannel;
class Guild;
/**
* A storage class that relies on DAL.
*/
class DALStorage
{
public:
/**
* Constructor.
*/
DALStorage();
/**
* Destructor.
*/
~DALStorage();
/**
* Connect to the database and initialize it if necessary.
*/
void open();
/**
* Disconnect from the database.
*/
void close();
/**
* Get an account by user name.
*
* @param userName the owner of the account.
*
* @return the account associated to the user name.
*/
Account *getAccount(const std::string& userName);
/**
* Get an account by ID.
*
* @param accountID the ID of the account.
*
* @return the account associated with the ID.
*/
Account *getAccount(int accountID);
/**
* Gets a character by database ID.
*
* @param id the ID of the character.
* @param owner the account the character is in.
*
* @return the character associated to the ID.
*/
Character *getCharacter(int id, Account *owner);
#if 0
/**
* Gets a character by character name.
*
* @param name of the character
*
* @return the character associated to the name
*/
Character *getCharacter(const std::string &name);
#endif
/**
* Add a new account.
*
* @param account the new account.
*/
void
addAccount(Account *account);
/**
* Delete an account.
*
* @param account the account to delete.
*/
void delAccount(Account *account);
/**
* Sets a ban on an account (hence on all its characters).
*
* @param id character identifier.
* @param duration duration in minutes.
*/
void banCharacter(int id, int duration);
#if 0
/**
* Get the list of Emails in the accounts list.
* @return the list of Email's Addresses.
*/
std::list<std::string>
getEmailList();
#endif
/**
* Tells if the user name already exists.
* @return true if the user name exists.
*/
bool doesUserNameExist(std::string const &name);
/**
* Tells if the email address already exists.
* @return true if the email address exists.
*/
bool doesEmailAddressExist(std::string const &email);
/**
* Tells if the character name already exists.
* @return true if the character name exists.
*/
bool doesCharacterNameExist(std::string const &name);
/**
* Updates the data for a single character, does not update the
* owning account or the characters name.
* Primary usage should be storing characterdata received from a
* game server.
* returns true if succefull, false otherwise.
*/
bool
updateCharacter(Character *ptr);
/**
* Gives the list of opened public channels registered in database
* @return a map of the public channels
*/
std::map<unsigned short, ChatChannel>
getChannelList();
/**
* apply channel differences from the list in memory
* to the one in db.
*/
void
updateChannels(std::map<unsigned short, ChatChannel>& channelList);
/**
* Add a new guild
*
*/
void
addGuild(Guild* guild);
/**
* Delete a guild
*
*/
void
removeGuild(Guild* guild);
/**
* Add member to guild
*
*/
void
addGuildMember(int guild_id, const std::string &member_name);
/*
* Remove member from guild
*/
void
removeGuildMember(int guildId, const std::string &memberName);
/**
* Get guild list
*@return a list of guilds
*
*/
std::list<Guild*>
getGuildList();
/**
* Save changes to the database permanently.
*
* @exception dal::DbSqlQueryExecFailure.
*/
void flushAll();
void flush(Account *);
/**
* Gets the value of a quest variable.
*/
std::string getQuestVar(int id, std::string const &);
/**
* Sets the value of a quest variable.
*/
void setQuestVar(int id, std::string const &, std::string const &);
private:
/**
* Copy constructor.
*/
DALStorage(const DALStorage& rhs);
/**
* Assignment operator.
*/
DALStorage&
operator=(const DALStorage& rhs);
/**
* Create the specified table.
*
* @param tblName the table name.
* @param sql the SQL query to execute.
*
* @exception dal::DbSqlQueryExecFailure.
*/
void
createTable(const std::string& tblName,
const std::string& sql);
/**
* Gets an account by using a SQL query string.
*
* @param query the query for the account
*
* @return the account found by the query
*/
Account *getAccountBySQL(std::string const &query);
/**
* Gets a character by character name.
*
* @param query the query for the character.
* @param owner the account the character is in.
*
* @return the character found by the query.
*/
Character *getCharacterBySQL(std::string const &query, Account *owner);
dal::DataProvider *mDb; /**< the data provider */
};
extern DALStorage *storage;
#endif // _TMWSERV_DALSTORAGE_H_
|
