#ifndef CONFIG_H #define CONFIG_H #include #include #include "Proxy.h" #include using std::vector; using std::string; class SslClient; class QTimer; /** * @brief Singleton class that represents client configuration
* At the first time this object is accessed config.cfg is read to * determine initial settings, server addresses, etc.
* 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
* 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
* (generic proxy records only) * @return Alphabetically sorted vector with unique country names */ vector GetCountries(); /** * @brief Get list of country states where at least one proxy available
* (generic proxy records only) * @param country name of country to get list of states for * @return Alphabetically sorted vector with unique state names.
* Resultant vector may be empty in case if there are no states in specified country */ vector GetStates(std::string &country); /** * @brief Get list of cities in particular country without states
* (generic proxy records only) * @param country name of country to get list of states for * @return Alphabetically sorted vector with unique city names */ vector GetCities(string &country); /** * @brief Get list of cities in particular country and state
* (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 with unique city names */ vector GetCities(string &country, string &state); /** * @brief Get list of proxy server addresses in particular country and city (without states)
* (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 with unique proxy names */ vector GetProxies(string &country, string &city); /** * @brief Get list of proxy server addresses in particular country, state and city
* (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 with unique proxy names */ vector 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 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.
* 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
* @param entry config file entry value, e.g.: '8.8.8.8:8080 600 60' */ ServerEntry(string entry); /** * @brief Hostname or address of server
* Note that default port is 13666 as specified in SslClient */ string host; /** * @brief Cumulative timeout value (in seconds)
* 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 genericProxy; vector staticProxy; vector firewalls; vector servers; int ReadGenericProxy(); int ReadStaticProxy(); private slots: void updateConfig(); void gotServerReply(SslClient::RequestType &type, QByteArray &confdata); }; #endif