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
|
#ifndef CONFIG_H
#define CONFIG_H
#include <client.h>
#include <QObject>
#include "Proxy.h"
#include <SslClient.h>
using std::vector;
using std::string;
class SslClient;
class QTimer;
/**
* @brief Singleton class that represents client configuration<br/>
* At the first time this object is accessed config.cfg is read to
* determine initial settings, server addresses, etc.<br/>
* Then retries is made to connect to server and acqire actual config,
* firewall list, etc.
*/
class Config: public QObject
{
Q_OBJECT
public:
/**
* @brief Class to represent 'firewall' record in the config file
*/
class FirewallEntry
{
public:
FirewallEntry(): block(false), host("127.0.0.1")
{
}
/**
* @brief Firewall action: true - to block access to the host,
* false - to allow access to the host
*/
bool block;
/**
* @brief Hostname or address to allow/block access to
*/
string host;
};
/**
* @brief Retrieve application-wide instance of Config class
* @return Pointer to singleton instance of Config class
*/
static Config *CurrentConfig();
/**
* @brief Time between consecutive program updates
*/
unsigned ClientUpdateInterval;
/**
* @brief Welcome message that is displayed after program start
*/
string WelcomeMsg;
/**
* @brief Message that is shown when the config.cfg downloaded/updated
* successfully
*/
string ConfigLoadedMsg;
/**
* @brief Text that is displayed in as the top panel caption in the UI
*/
string TopPanelText;
/**
* @brief Text that is displayed in as the bottom panel caption in the UI
*/
string BottomPanelText;
/**
* @brief Determines whether proxy speed displayed in the UI or not
*/
bool IsSpeedVisible;
/**
* @brief Update client configuration
* @todo update config periodically on timer events
*/
void AcquireConfig();
/**
* @brief Check whether current confguration is valid <br/>
* It may become invalid in case if server is not reachable.
* So every time you want to access Config members or methods you should check this value
* @return true if configuration is valid and false otherwise
*/
bool IsConfigValid();
/**
* @brief Get list of country names where at least one proxy available<br/>
* (generic proxy records only)
* @return Alphabetically sorted vector<string> with unique country names
*/
vector<string> GetCountries();
/**
* @brief Get list of country states where at least one proxy available<br/>
* (generic proxy records only)
* @param country name of country to get list of states for
* @return Alphabetically sorted vector<string> with unique state names.<br/>
* Resultant vector<string> may be empty in case if there are no states in specified country
*/
vector<string> GetStates(std::string &country);
/**
* @brief Get list of cities in particular country without states<br/>
* (generic proxy records only)
* @param country name of country to get list of states for
* @return Alphabetically sorted vector<string> with unique city names
*/
vector<string> GetCities(string &country);
/**
* @brief Get list of cities in particular country and state<br/>
* (generic proxy records only)
* @param country name of country to get list of cities for
* @param state name of state to get list of cities for
* @return Alphabetically sorted vector<string> with unique city names
*/
vector<string> GetCities(string &country, string &state);
/**
* @brief Get list of proxy server addresses in particular country and city (without states)<br/>
* (generic proxy records only)
* @param country name of country to get list of proxies for
* @param city name of city to get list of proxies for
* @return Alphabetically sorted vector<string> with unique proxy names
*/
vector<string> GetProxies(string &country, string &city);
/**
* @brief Get list of proxy server addresses in particular country, state and city<br/>
* (generic proxy records only)
* @param country name of country to get list of proxies for
* @param state name of state to get list of proxies for
* @param city name of city to get list of proxies for
* @return Alphabetically sorted vector<string> with unique proxy names
*/
vector<string> GetProxies(string &country, string &state, string &city);
/**
* @brief Get list of static proxy entries
* @param line number of GUI line proxy list associated with
* @return List of static proxy entries sorted by speed in descending order
*/
vector<ProxyEntryStatic> GetStaticProxyGuiLine(unsigned line);
/**
* @brief Get number of static proxy GUI lines
* @return number of static proxy GUI lines or 0 if none
*/
unsigned GetStaticProxyGuiLines();
/**
* Static proxy speed value limit.<br/>
* This value is used to determine speed label color.
* All speed value below this constant will be red, higher values will be green
*/
const unsigned StaticProxySpeedLow;
protected:
Config();
private:
/**
* @brief Class to represend 'server' record in the config file
*/
class ServerEntry
{
public:
/**
* @brief Initialize ServerEntry instance to default values
*/
ServerEntry();
/**
* @brief initilize ServerEntry instance from config file entry<br/>
* @param entry config file entry value, e.g.: '8.8.8.8:8080 600 60'
*/
ServerEntry(string entry);
/**
* @brief Hostname or address of server<br/>
* Note that default port is 13666 as specified in SslClient
*/
string host;
/**
* @brief Cumulative timeout value (in seconds)<br/>
* When this time is expired then no further attempts is made
* to connect to this particular server
*/
unsigned timeout;
/**
* @brief Time (in seconds) between consecutive retries
*/
unsigned retry;
};
/**
* @brief Pointer to the singleton Config instance
*/
static Config *self;
/**
* @brief time interval between consequtive config updates
*/
unsigned updateInterval;
/**
* @brief SslCLient instance that connects to server and retrieves config
*/
SslClient *client;
/**
* @brief timer that is responsible on config updates
*/
QTimer *configUpdateTimer;
bool configValid;
vector<ProxyEntryGeneric> genericProxy;
vector<ProxyEntryStatic> staticProxy;
vector<FirewallEntry> firewalls;
vector<ServerEntry> servers;
int ReadGenericProxy();
int ReadStaticProxy();
private slots:
void updateConfig();
void gotServerReply(SslClient::RequestType &type, QByteArray &confdata);
};
#endif
|
