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
288
289
290
291
292
293
294
295
296
297
298
299
|
/*
* 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_STORAGE_H_
#define _TMWSERV_STORAGE_H_
#include <list>
#include <map>
#include "account-server/account.hpp"
#include "chat-server/chatchannel.hpp"
/**
* Data type for the list of accounts.
*/
typedef std::map<unsigned, AccountPtr> Accounts;
/**
* A storage to load and persist dynamic data.
*
* Notes:
* - this class implements the singleton design pattern.
* - destroy() must be called at least once before the application
* exits or else there will be a memory leak.
*/
class Storage
{
public:
/**
* Create a named instance of Storage.
*
* @param name the name of the storage.
*
* @return the unique instance of Storage.
*
* @exception std::bad_alloc if the instance cannot be created.
*
* Notes:
* - it is up to the underlying implementation of Storage to
* decide about what to do with the name, it could serve as the
* name of the database or the name of the file into which the
* storage will be dumped to.
* - the name of the storage is saved only when it's the first
* invocation of instance() or only when instance() is invoked
* after destroy().
*/
static Storage&
instance(const std::string& name);
/**
* Delete the storage.
*/
static void
destroy(void);
/**
* Open the storage for read/write access.
*
* Depending on the underlying implementation of Storage, opening
* a storage would mean either opening a file or connecting to a
* database.
*/
virtual void
open(void) = 0;
/**
* Close the storage.
*
* Depending on the underlying implementation of Storage, closing
* a storage would mean either closing a file or disconnecting from
* a database.
*/
virtual void
close(void) = 0;
/**
* Check if the storage is open.
*
* @return true if the storage is open.
*/
bool
isOpen(void) const;
/**
* Get the storage name.
*
* @return the storage name.
*/
const std::string&
getName(void) const;
/**
* Set a user name for the storage.
*
* Depending on the underlying implementation of Storage, setting
* the user name may have no effect (e.g. DALStorage running on
* SQLite).
*
* @param userName the user name.
*/
void
setUser(const std::string& userName);
/**
* Get the user name.
*
* @return the user name (it may be an empty string if not set
* previously).
*/
const std::string&
getUser(void) const;
/**
* Set a user password for the storage.
*
* Depending on the underlying implementation of Storage, setting
* the user password may have no effect (e.g. DALStorage running on
* SQLite).
*
* @param password the user password.
*/
void
setPassword(const std::string& password);
/**
* Get the user password.
*
* @return the user password (it may be an empty string if not set
* previously).
*/
const std::string&
getPassword(void) const;
/**
* Get an account by user name.
*
* @param userName the owner of the account.
*
* @return the account associated to the user name.
*/
virtual AccountPtr
getAccount(const std::string& userName) = 0;
/**
* Gets a character by database ID.
*
* @param id the ID of the character.
*
* @return the character associated to the ID.
*/
virtual PlayerPtr getCharacter(int id) = 0;
/**
* Add a new account.
*
* @param account the new account.
*/
virtual void
addAccount(const AccountPtr& account) = 0;
/**
* Delete an account.
*
* @param account the account to delete.
*/
virtual void
delAccount(AccountPtr const &account) = 0;
/**
* Flush and unload an account.
*
* @param account the account to unload.
*/
virtual void
unloadAccount(AccountPtr const &account) = 0;
/**
* Get the list of Emails in the accounts list.
* @return the list of Email's Addresses.
*
* @deprecated The only purpose of using this list inside the server is
* for checking for existing email addresses, which is
* covered by Storage::getSameEmailNumber().
* It could later be used for mailing list announcement.
*/
virtual
std::list<std::string> getEmailList() = 0;
/**
* Tells if the email address already exists.
* @return true if the email address exists.
*/
virtual bool doesEmailAddressExist(std::string const &email) = 0;
/**
* Tells if the character's name already exists
* @return true if character's name exists.
*/
virtual bool doesCharacterNameExist(std::string const &name) = 0;
/**
* Gives the list of opened public channels registered in database
* @return a map of the public channels
*/
virtual std::map<short, ChatChannel>
getChannelList() = 0;
/**
* apply channel differences from the list in memory
* to the one in db.
*/
virtual void
updateChannels(std::map<short, ChatChannel>& channelList) = 0;
/**
* Saves the changes to all the accounts permanently.
*/
virtual void flushAll() = 0;
/**
* Saves the changes to one account permanently.
*/
virtual void flush(AccountPtr const &account) = 0;
protected:
/**
* Default constructor.
*/
Storage(void)
throw();
/**
* Destructor.
*/
virtual
~Storage(void)
throw();
/**
* Copy constructor.
*/
Storage(const Storage& rhs);
/**
* Assignment operator.
*/
Storage&
operator=(const Storage& rhs);
protected:
Accounts mAccounts; /**< list of accounts in memory */
Players mCharacters; /**< the loaded characters */
bool mIsOpen; /**< flag is true if the storage is open */
private:
static Storage* mInstance; /**< the unique instance of Storage */
static std::string mName; /**< the name of the storage */
static std::string mUser; /**< the user name */
static std::string mPassword; /**< the user password */
};
#endif // _TMWSERV_STORAGE_H_
|
