path: root/client/Proxifier.h

#ifndef PROXIFIER_CONFIG
#define PROXIFIER_CONFIG

#include <vector>
#include <string>
#include <QDomElement>
#include <QString>
#include "Proxy.h"


using namespace std;


class QDomDocument;
class Proxy;

/**
 * @brief	Special class that represents proxifier's configuration file
 * @note	All operation that turn on/off and add/remove proxies and chain will apply to "Default" rule
 * 			All proxies are put into "Client" chain event if it's only one proxy
 */
class Proxifier
{
public:
	/**
	 * @brief	Get application-wide singleton instance of Proxifier class
	 * @return	pointer to Proxifier singleton
	 */
	static Proxifier* GetInstance();
	/**
	 * @brief	Chack if the current config is valid
	 * @return	true if the config is valid or false otherwise
	 * @note	you may wish to try ReadConfig() before but if it doesn't help
	 */
	bool IsValid();
	/**
	 * @brief	Check if certain server is turned on in Proxifier's tules and list
	 */
	bool IsOn(string& addr, short port);
	/**
	 * @brief	Get list of proxies that is being used by Proxifier right now
	 * @return	list of active Proxy records
	 */
	vector<Proxy> GetActiveProxies();
	/**
	 * @brief	turn proxy on, all traffic will go throught this proxy
	 * @param	proxy	Proxy class that represents particular proxy
	 * @return	true on success or false otherwise
	 * @note	adds specified proxy to Proxifier's Proxy list and in "Client" chain<br/>
	 * 			Also adds "Client" chain to "Default" rule if its not there
	 */
	bool TurnProxyOn(Proxy& proxy);
	/**
	 * @brief	turn proxy off
	 * @param	proxy	Proxy class that represents particular proxy
	 * @return	true on success or false otherwise<br/>
	 *			alse true will be returned even if proxy is not exist in config
	 * @note	removes specified proxy from "Client" chain and from Proxy list<br/>
	 * 			If its the last proxy in client chain then "Default" rule will be resetted to<br/>
	 * 			send all traffic directly to servers
	 */
	bool TurnProxyOff(Proxy& proxy);
	
private:
	/**
	 * @brief	class representing Proxifier's proxy setting
	 */
	class ProxifierProxy: public Proxy
	{
	public:
		int id;
		short option;
		bool useAuth;		// whether to authenticate on server
		bool emptyAuth;		// self-closing auth (for Proxifier it means to use current login+pass)
		
		ProxifierProxy();
	};

	/**
	 * @brief	class representing Proxifier's proxy chain
	 */
	class Chain
	{
	public:
		/**
		 * @brief	chain id
		 */
		int id;
		/**
		 * @brief	chain name
		 */
		string name;
		/**
		 * @brief	associative array of proxies in the chain - [id: isEnabled]
		 */
		map<int, bool> proxies;

		Chain();
	};

	class Rule
	{
	public:
		/**
		 * @brief	indicates if the rule is enabled
		 */
		bool isEnabled;
		/**
		 * @brief	rule name
		 */
		string name;
		/**
		 * @brief	list of applications the rule affects
		 */
		string apps;
		/**
		 * @brief	rule targets (list of hosts separeted w ';')
		 */
		string targets;
		/**
		 * @brief	rule ports (e.g.: 80; 8000-9000; 8080)
		 */
		string ports;
		/**
		 * @brief	rule action (one of: 'Direct', 'Block', 'Chain', 'Proxy')
		 */
		string action;
		/**
		 * @brief	action parameter (applicable only to 'Chain' and 'Proxy' actions)
		 */
		int actId;

		Rule();
	};
	/**
	 * @brief	XML indentation level
	 */
	static const int indent = 4;
	/**
	 * @brief	default chain name to add proxies to
	 */
	static string defaultChain;
	/**
	 * @brief	default rule name to add proxies to
	 */
	static string defaultRule;
	/**
	 * @brief	pointer to sigleton instance
	 */
	static Proxifier *instance;
	/**
	 * @brief	XML file name to read data from
	 */
	QString filename;
	/**
	 * @brief	indicates whether config valid or not
	 */
	bool valid;
	vector<ProxifierProxy> proxyList;
	vector<Chain> chainList;
	vector<Rule> ruleList;
	
	Proxifier();
	/**
	 * @brief	read Proxifier config from file and parse it
	 * @note	you should check IsValid() method to get to know if the config is valid
	 */
	void ReadConfig();
	/**
	 * @brief	read ProxyList section in Proxifier's config
	 * @param	root	root DOM element
	 * @return	true on success or false otherwise
	 */
	bool ReadProxyList(QDomElement& root);
	/**
	 * @brief	read ChainList section in Proxifier's config
	 * @param	root	root DOM element
	 * @return	true on success or false otherwise
	 */	
	bool ReadChainList(QDomElement& root);
	/**
	 * @brief	read RuleList section in Proxifier's config
	 * @param	root	root DOM element
	 * @return	true on success or false otherwise
	 */	
	bool ReadRuleList(QDomElement& root);
	/**
	 * @brief	gets the next valid ID fo proxy/chain
	 * @note	this ID numbers are shared among chains and proxies
	 * @return	next valid ID number
	 */
	int GetNextId();
	/**
	 * @brief	add new proxy record to Proxifier config
	 * @param	proxy	proxy class representing Proxifier's proxy entry
	 * 			id		new proxy id will be set there
	 * @return	true on success or false otherwise
	 */
	bool AddProxy(ProxifierProxy& proxy, int* id);
	/**
	 * @brief	add new chain to proxifier config
	 * @param	name	the name of the chain
	 * 			id		new chain id
	 * @return	true on success or false otherwise
	 */
	bool AddChain(string& name, int* id);
	/**
	 * @brief	add proxy to proxy chain
	 * @param	proxyId	proxy ID to add to proxy chain
	 * 			chainId	chain ID to add proxy to
	 * @return	true on success or false otherwise
	 */
	bool AddProxyToChain(int proxyId, int chainId);
	/**
	 * @brief	remove proxy from proxy chain
	 * @param	proxyId	proxy ID to remove to proxy chain
	 * 			chainId	chain ID to remove proxy from
	 * @return	true on success or false otherwise
	 */
	bool RemoveProxyFromChain(int proxyId, int chainId);
	/**
	 * @brief	add new rule to Proxifier config
	 * @param	rule	rule class representing Proxifier's rule entry
	 * @return	true on success or false otherwise
	 */
	bool AddRule(Rule& rule);
	/**
	 * @brief	modify action on existing rule
	 * @param	name	name of the rule to modify
	 * 			action	action name to set to
	 * 			actId	id  of action target (if applicable)
	 * @return	true on success or false otherwise
	 */
	bool SetRuleAction(string& name, string& action, int actId = -1);
	/**
	 * @brief	remove rule to Proxifier config
	 * @param	name	name of the rule to remove from Rule list
	 * @return	true on success or false otherwise
	 */
	bool RemoveRule(string& name);
	/**
	 * @brief	Check if certain proxy address exists in Proxifier's Proxy list
	 * @param	addr	proxy address to check for
	 * 			port	proxy port to check for
	 * 			id		if proxy exist then there'll be it's id number otherwise this value is undetermined
	 * @return	true if proxy exist or false otherwise
	 * @note	DNS names are not resolved and not compared to IPs<br/>
	 * 			proxies are compared only by checking address and port values
	 */
	bool isProxyExists(string& addr, short port, int* id = NULL);
	/**
	 * @brief	Check if certain chain exisis in Proxifier's Chain list
	 * @param	name	chain name to check for
	 * 			id		if chain exist then there'll be it's id number otherwise this value is undetermined
	 * @return	true if chain exist or false otherwise
	 */
	bool isChainExists(string& name, int* id = NULL);
	/**
	 * @brief	Check if certain rule exists
	 * @param	name	rule name to check for
	 * @return	true if rule exist or false otherwise
	 */
	bool isRuleExists(string& name);
};

#endif