summaryrefslogtreecommitdiff
path: root/client/Config.h
blob: 868c8598ca0ee4c4d7c0881234c313e8b42dd5b9 (plain)
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


#ifndef CONFIG_H
#define CONFIG_H

#include <vector>
#include "Proxy.h"

class ProxyEntryGeneric;
class ProxyEntryStatic;

/**
 * @brief Singleton class that represents client configuration
 */
class Config
{
public:
	/**
	 * @brief	Retrieve application-wide instance of Config class
	 * @return	Pointer to singleton instance of Config class
	 */
	static Config *CurrentConfig();
	
	/**
	 * @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 membres 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
	 */
	std::vector<std::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
	 */
	std::vector<std::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
	 */
	std::vector<std::string> GetCities(std::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
	 */
	std::vector<std::string> GetCities(std::string &country, std::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
	 */
	std::vector<std::string> GetProxies(std::string &country, std::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
	 */
	std::vector<std::string> GetProxies(std::string &country, std::string &state, std::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 in order as they appear in config file
	 */
	std::vector<ProxyEntryStatic> GetStaticProxyGuiLine(int line);
	
	/**
	 * @brief	Get number of static proxy GUI lines
	 * @return	number of static proxy GUI lines or 0 if none
	 */ 
	unsigned GetStaticProxyGuiLines();
protected:
	Config();
private:
	static Config *self;
	bool configValid;
	std::vector<ProxyEntryGeneric> genericProxy;
	std::vector<ProxyEntryStatic> staticProxy;
	
	int ReadGenericProxy();
	int ReadStaticProxy();
};


#endif