path: root/client/Config.h

#ifndef CONFIG_H
#define CONFIG_H

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

using std::vector;
using std::string;

/**
 * @brief	represents client configuration<br/>
 * 			When vreated config.cfg is read to determine basic settings, server addresses, etc.<br/> 
 */
class Config
{
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	Extract and set instance variables from config line
		 */
		void Parse(string entry);
	};
	
	/**
	 * @brief	class that represent file actions that should be taken: update/delete
	 */
	class FileEntry
	{
	public:
		/**
		 * @enum	possible file action types
		 */
		enum ActionType
		{
			/**
			 * @brief	unknown file action (default)
			 */
			UnknownAction,
			/**
			 * @brief	delete file from filesystem (if it exists)
			 */
			DeleteAction,
			/**
			 * @brief	download file to filesystem (if it isn't exists)
			 */
			DownloadAction
		};
		
		FileEntry(): action(UnknownAction) {}
		
		/**
		 * @brief	action that should be taken
		 */
		ActionType action;
		
		/**
		 * @brief	file path
		 */
		string path;
		
		/**
		 * @brief	md5hash value for this file ('upload' action only)
		 */
		string md5;
		
		/**
		 * @brief	Extract and set instance variables from config line
		 */
		void Parse(string entry, ActionType action);
	};
	
	/**
	 * @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
	 * @deprecated	config is updated periodically on timer events now
	 */
	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:
	/**
	 * @brief	Class to represend 'server' record in the config file
	 */
	class ServerEntry
	{
	public:
		/**
		 * @brief	Initialize ServerEntry instance to default values
		 */
		ServerEntry(): host("127.0.0.1"), timeout(120), retryTimeout(60) {}
		
		/**
		 * @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 retryTimeout;
	};
	
	/**
	 * @brief	create new instance (not allowed for use by other classes and functions)
	 */
	Config();
	
	/**
	 * @brief	parse client configuration 
	 * @param	data	string containing configuration parameters
	 */
	void ParseConfig(string data);
	
	/**
	 * @brief	parse list of generic proxies
	 * @param	data	string containing list of ProxyEntryGeneric records
	 */
	void ParseGenericProxies(string data);
	
	/**
	 * @brief	parse list of static proxies
	 * @param	data	string containing list of ProxyEntryStatic records
	 */
	void ParseStaticPorxies(string data);
	
	/**
	 * @brief	parse firewall configuration
	 * @param	data	string containing list of FirewallEntry records
	 */
	void ParseFirewalls(string data);
	
	/**
	 * @brief	parse list of file to be deleted
	 * @param	data	string containing path to aforementioned file
	 */
	void ParseDeleteList(string data);
	
	/**
	 * @brief	parse list of files to be downloaded
	 * @param	data	string containing path to new file and it's md5 hash
	 */
	void ParseDownloadList(string data);
	
	/**
	 * @brief	time between subsequent config updates
	 */
	unsigned updateInterval;
	vector<ServerEntry> servers;	
private:
	vector<ProxyEntryGeneric> genericProxy;
	vector<ProxyEntryStatic> staticProxy;
	vector<FirewallEntry> firewalls;
	vector<FileEntry> fileActions;
	void ReadGenericProxy();
	void ReadStaticProxy();
};

#endif