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
300
301
302
303
304
305
306
307
|
/*
* Copyright (C) 2004-2012 Savoir-Faire Linux Inc.
* Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program 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 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Additional permission under GNU GPL version 3 section 7:
*
* If you modify this program, or any covered work, by linking or
* combining it with the OpenSSL project's OpenSSL library (or a
* modified version of that library), containing parts covered by the
* terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
* grants you additional permission to convey the resulting work.
* Corresponding Source for a non-source form of such a combination
* shall include the source code for the parts of OpenSSL used as well
* as that of the covered work.
*/
#ifndef ACCOUNT_H
#define ACCOUNT_H
#include <string>
#include <vector>
#include "noncopyable.h"
#include "config/sfl_config.h"
#include "config/serializable.h"
#include "registration_states.h"
class Account;
class VoIPLink;
/** Define a type for a AccountMap container */
typedef std::map<std::string, Account*> AccountMap;
/**
* @file account.h
* @brief Interface to protocol account (SIPAccount, IAXAccount)
* It can be enable on loading or activate after.
* It contains account, configuration, VoIP Link and Calls (inside the VoIPLink)
*/
class Account : public Serializable {
public:
Account(const std::string& accountID);
/**
* Virtual destructor
*/
virtual ~Account();
virtual void setAccountDetails(std::map<std::string, std::string> details) = 0;
virtual std::map<std::string, std::string> getAccountDetails() const = 0;
/**
* Load the settings for this account.
*/
virtual void loadConfig() = 0;
/**
* Get the account ID
* @return constant account id
*/
std::string getAccountID() const {
return accountID_;
}
/**
* Get the voiplink pointer
* @return VoIPLink* the pointer or 0
*/
virtual VoIPLink* getVoIPLink() = 0;
/**
* Register the underlying VoIPLink. Launch the event listener.
* This should update the getRegistrationState() return value.
*/
virtual void registerVoIPLink() = 0;
/**
* Unregister the underlying VoIPLink. Stop the event listener.
* This should update the getRegistrationState() return value.
*/
virtual void unregisterVoIPLink() = 0;
/**
* Tell if the account is enable or not.
* @return true if enabled
* false otherwise
*/
bool isEnabled() const {
return enabled_;
}
void setEnabled(bool enable) {
enabled_ = enable;
}
/**
* Set the registration state of the specified link
* @param state The registration state of underlying VoIPLink
*/
void setRegistrationState(const RegistrationState &state);
/* They should be treated like macro definitions by the C++ compiler */
std::string getUsername() const {
return username_;
}
std::string getHostname() const {
return hostname_;
}
void setHostname(const std::string &hostname) {
hostname_ = hostname;
}
std::string getAlias() const {
return alias_;
}
void setAlias(const std::string &alias) {
alias_ = alias;
}
std::vector<std::map<std::string, std::string> >
getAllVideoCodecs() const;
std::vector<std::map<std::string, std::string> >
getActiveVideoCodecs() const;
static std::vector<int> getDefaultAudioCodecs();
/* Accessor to data structures
* @return The list that reflects the user's choice
*/
std::vector<int> getActiveAudioCodecs() const {
return audioCodecList_;
}
/**
* Update both the codec order structure and the codec string used for
* SDP offer and configuration respectively
*/
void setActiveAudioCodecs(const std::vector<std::string>& list);
void setVideoCodecs(const std::vector<std::map<std::string, std::string> > &codecs);
std::string getRingtonePath() const {
return ringtonePath_;
}
void setRingtonePath(const std::string &path) {
ringtonePath_ = path;
}
bool getRingtoneEnabled() const {
return ringtoneEnabled_;
}
void setRingtoneEnabled(bool enable) {
ringtoneEnabled_ = enable;
}
std::string getDisplayName() const {
return displayName_;
}
void setDisplayName(const std::string &name) {
displayName_ = name;
}
std::string getMailBox() const {
return mailBox_;
}
void setMailBox(const std::string &mb) {
mailBox_ = mb;
}
static std::vector<std::string>
split_string(std::string s);
static const char * const VIDEO_CODEC_ENABLED;
static const char * const VIDEO_CODEC_NAME;
static const char * const VIDEO_CODEC_PARAMETERS;
static const char * const VIDEO_CODEC_BITRATE;
private:
NON_COPYABLE(Account);
/**
* Helper function used to load the default codec order from the codec factory
*/
void loadDefaultCodecs();
protected:
friend class ConfigurationTest;
// General configuration keys for accounts
static const char * const AUDIO_CODECS_KEY;
static const char * const VIDEO_CODECS_KEY;
static const char * const RINGTONE_PATH_KEY;
static const char * const RINGTONE_ENABLED_KEY;
static const char * const DISPLAY_NAME_KEY;
static const char * const ALIAS_KEY;
static const char * const TYPE_KEY;
static const char * const ID_KEY;
static const char * const USERNAME_KEY;
static const char * const AUTHENTICATION_USERNAME_KEY;
static const char * const PASSWORD_KEY;
static const char * const HOSTNAME_KEY;
static const char * const ACCOUNT_ENABLE_KEY;
static const char * const ACCOUNT_AUTOANSWER_KEY;
static const char * const MAILBOX_KEY;
static std::string mapStateNumberToString(RegistrationState state);
/**
* Account ID are assign in constructor and shall not changed
*/
const std::string accountID_;
/**
* Account login information: username
*/
std::string username_;
/**
* Account login information: hostname
*/
std::string hostname_;
/**
* Account login information: Alias
*/
std::string alias_;
/**
* Tells if the link is enabled, active.
* This implies the link will be initialized on startup.
* Modified by the configuration (key: ENABLED)
*/
bool enabled_;
/* If true, automatically answer calls to this account */
bool autoAnswerEnabled_;
/*
* The general, protocol neutral registration
* state of the account
*/
RegistrationState registrationState_;
/**
* Vector containing the order of the codecs
*/
std::vector<int> audioCodecList_;
/**
* Vector containing the video codecs in order
*/
std::vector<std::map<std::string, std::string> > videoCodecList_;
/**
* List of audio codecs obtained when parsing configuration and used
* to generate codec order list
*/
std::string audioCodecStr_;
/**
* Ringtone .au file used for this account
*/
std::string ringtonePath_;
/**
* Play ringtone when receiving a call
*/
bool ringtoneEnabled_;
/**
* Display name when calling
*/
std::string displayName_;
/**
* Useragent used for registration
*/
std::string userAgent_;
/**
* Account mail box
*/
std::string mailBox_;
};
#endif
|