RetroShare/libretroshare/src/pqi/p3peermgr.h

/*
 * libretroshare/src/pqi: p3peermgr.h
 *
 * 3P/PQI network interface for RetroShare.
 *
 * Copyright 2007-2011 by Robert Fernie.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License Version 2 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 *
 * Please report all bugs and problems to "retroshare@lunamutt.com".
 *
 */

#ifndef MRK_PQI_PEER_MANAGER_HEADER
#define MRK_PQI_PEER_MANAGER_HEADER

#include "pqi/pqimonitor.h"
#include "pqi/pqiipset.h"
#include "pqi/pqiassist.h"

#include "pqi/p3cfgmgr.h"

#include "util/rsthreads.h"

	/* RS_VIS_STATE_XXXX
	 * determines how public this peer wants to be...
	 *
	 * STD = advertise to Peers / DHT checking etc 
	 * GRAY = share with friends / but not DHT 
	 * DARK = hidden from all 
	 * BROWN? = hidden from friends / but on DHT
	 */

const uint32_t RS_VIS_STATE_NODISC = 0x0001;
const uint32_t RS_VIS_STATE_NODHT  = 0x0002;

const uint32_t RS_VIS_STATE_STD    = 0x0000;
const uint32_t RS_VIS_STATE_GRAY   = RS_VIS_STATE_NODHT;
const uint32_t RS_VIS_STATE_DARK   = RS_VIS_STATE_NODISC | RS_VIS_STATE_NODHT;
const uint32_t RS_VIS_STATE_BROWN  = RS_VIS_STATE_NODISC;



	/* Startup Modes (confirmed later) */
const uint32_t RS_NET_MODE_TRYMODE =    0x00f0;

const uint32_t RS_NET_MODE_TRY_EXT  =   0x0010;
const uint32_t RS_NET_MODE_TRY_UPNP =   0x0020;
const uint32_t RS_NET_MODE_TRY_UDP  =   0x0040;

	/* Actual State */
const uint32_t RS_NET_MODE_ACTUAL =      0x000f;

const uint32_t RS_NET_MODE_UNKNOWN =     0x0000;
const uint32_t RS_NET_MODE_EXT =         0x0001;
const uint32_t RS_NET_MODE_UPNP =        0x0002;
const uint32_t RS_NET_MODE_UDP =         0x0004;
const uint32_t RS_NET_MODE_UNREACHABLE = 0x0008;




/* flags of peerStatus */
const uint32_t RS_NET_FLAGS_USE_DISC		= 0x0001;
const uint32_t RS_NET_FLAGS_USE_DHT		= 0x0002;
const uint32_t RS_NET_FLAGS_ONLINE		= 0x0004;
const uint32_t RS_NET_FLAGS_EXTERNAL_ADDR	= 0x0008;
const uint32_t RS_NET_FLAGS_STABLE_UDP		= 0x0010;
const uint32_t RS_NET_FLAGS_TRUSTS_ME 		= 0x0020;

const uint32_t RS_TCP_STD_TIMEOUT_PERIOD	= 5; /* 5 seconds! */

class peerState
{
	public:
	peerState(); /* init */

	std::string id;
	std::string gpg_id;

	uint32_t netMode; /* EXT / UPNP / UDP / INVALID */
	uint32_t visState; /* STD, GRAY, DARK */	

	struct sockaddr_in localaddr, serveraddr;

        //used to store current ip (for config and connection management)
	struct sockaddr_in currentlocaladdr;             /* Mandatory */
	struct sockaddr_in currentserveraddr;            /* Mandatory */
	std::string dyndns;

	time_t lastcontact; 

	/* list of addresses from various sources */
	pqiIpAddrSet ipAddrs;

	/***** Below here not stored permanently *****/

	std::string name;
	std::string location;

	//uint32_t connecttype;  // RS_NET_CONN_TCP_ALL / RS_NET_CONN_UDP_ALL
	//time_t lastavailable;
	//time_t lastattempt;


	//uint32_t    state;
	//uint32_t    actions;

	//uint32_t		source; /* most current source */
	//peerAddrInfo		dht;
	//peerAddrInfo		disc;
	//peerAddrInfo		peer;

	/* a list of connect attempts to make (in order) */
	//bool inConnAttempt;
	//peerConnectAddress currentConnAddrAttempt;
	//std::list<peerConnectAddress> connAddrs;


};

class RsPeerGroupItem;
class RsGroupInfo;

std::string textPeerState(peerState &state);


class p3PeerMgr: public pqiConnectCb, public p3Config
{
	public:

        p3PeerMgr();

void 	tick();

	/*************** External Control ****************/
bool	shutdown(); /* blocking shutdown call */

void 	setOwnNetConfig(uint32_t netMode, uint32_t visState);
bool 	setLocalAddress(const std::string &id, struct sockaddr_in addr);
bool 	setExtAddress(const std::string &id, struct sockaddr_in addr);
bool    setDynDNS(const std::string &id, const std::string &dyndns);
bool    updateAddressList(const std::string& id, const pqiIpAddrSet &addrs);

bool 	setNetworkMode(const std::string &id, uint32_t netMode);
bool 	setVisState(const std::string &id, uint32_t visState);

bool    setLocation(const std::string &pid, const std::string &location);//location is shown in the gui to differentiate ssl certs

	/* add/remove friends */
bool 	addFriend(const std::string &ssl_id, const std::string &gpg_id, uint32_t netMode = RS_NET_MODE_UDP,
	   uint32_t visState = RS_VIS_STATE_STD , time_t lastContact = 0);

bool	removeFriend(const std::string &ssl_id);
bool	addNeighbour(const std::string&);

	/*************** External Control ****************/

	/* access to network details (called through Monitor) */
const std::string getOwnId();
bool	getOwnNetStatus(peerState &state);

bool	isFriend(const std::string &ssl_id);
bool	isOnline(const std::string &ssl_id);
bool	getFriendNetStatus(const std::string &id, peerState &state);
bool	getOthersNetStatus(const std::string &id, peerState &state);

void	getOnlineList(std::list<std::string> &ssl_peers);
void	getFriendList(std::list<std::string> &ssl_peers);
//void	getOthersList(std::list<std::string> &peers); /deprecated
bool    getPeerCount (unsigned int *pnFriendCount, unsigned int *pnOnlineCount, bool ssl);


	/**************** handle monitors *****************/
void	addMonitor(pqiMonitor *mon);
void	removeMonitor(pqiMonitor *mon);

	/******************** Groups **********************/
bool    addGroup(RsGroupInfo &groupInfo);
bool    editGroup(const std::string &groupId, RsGroupInfo &groupInfo);
bool    removeGroup(const std::string &groupId);
bool    getGroupInfo(const std::string &groupId, RsGroupInfo &groupInfo);
bool    getGroupInfoList(std::list<RsGroupInfo> &groupInfoList);
bool    assignPeersToGroup(const std::string &groupId, const std::list<std::string> &peerIds, bool assign);


protected:

	/* Internal Functions */
void 	statusTick();

	/* monitor control */
void 	tickMonitors();

	protected:
/*****************************************************************/
/***********************  p3config  ******************************/
        /* Key Functions to be overloaded for Full Configuration */
	virtual RsSerialiser *setupSerialiser();
	virtual bool saveList(bool &cleanup, std::list<RsItem *>&);
	virtual void saveDone();
	virtual bool    loadList(std::list<RsItem *>& load);
/*****************************************************************/

private:
	RsMutex mPeerMtx; /* protects below */

	bool     mStatusChanged;

	std::list<pqiMonitor *> clients;

	peerState mOwnState;

	std::map<std::string, peerState> mFriendList;
	std::map<std::string, peerState> mOthersList;

	std::list<RsPeerGroupItem *> groupList;
	uint32_t lastGroupId;

	std::list<RsItem *> saveCleanupList; /* TEMPORARY LIST WHEN SAVING */
};

#endif // MRK_PQI_PEER_MANAGER_HEADER