summaryrefslogtreecommitdiff
path: root/src/dalstorage.h
blob: 637dfa39e91231392669e0593b4f35522799d285 (plain) (blame)
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
/*
 *  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 <vector>

#include "dal/dataproviderfactory.h"
#include "dalstoragesql.h"
#include "storage.h"


namespace tmwserv
{


/**
 * A storage class that relies on DAL.
 *
 * Notes:
 *     - this class cannot be instanciated nor duplicated in order to force
 *       a user class to use the Storage singleton.
 */
class DALStorage: public Storage
{
    // friend so that Storage can call the constructor.
    friend class Storage;


    public:
        /**
         * Connect to the database and initialize it if necessary.
         */
        void
        open(void);


        /**
         * Disconnect from the database.
         */
        void
        close(void);


        /**
         * 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);


        /**
         * Add a new account.
         *
         * @param account the new account.
         */
        void
        addAccount(const AccountPtr& account);


        /**
         * Delete an account.
         *
         * @param userName the owner of the account.
         */
        void
        delAccount(const std::string& userName);


        /**
         * Save changes to the database permanently.
         *
         * @exception tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        flush(void);


    private:
        /**
         * Constructor.
         */
        DALStorage(void);


        /**
         * Destructor.
         */
        ~DALStorage(void)
            throw();


        /**
         * 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 tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        createTable(const std::string& tblName,
                    const std::string& sql);


        /**
         * Add an account to the database.
         *
         * @param account the account to add.
         *
         * @exeception tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        _addAccount(const AccountPtr& account);


        /**
         * Update an account from the database.
         *
         * @param account the account to update.
         *
         * @exception tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        _updAccount(const AccountPtr& account);


        /**
         * Delete an account and its associated data from the database.
         *
         * @param account the account to update.
         *
         * @exception tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        _delAccount(const AccountPtr& account);


        /**
         * Delete an account and its associated data from the database.
         *
         * @param userName the owner of the account.
         *
         * @exeception tmwserv::dal::DbSqlQueryExecFailure.
         */
        void
        _delAccount(const std::string& userName);


    private:
        std::auto_ptr<dal::DataProvider> mDb; /**< the data provider */
};


} // namespace tmwserv


#endif // _TMWSERV_DALSTORAGE_H_