// [License]
// The Ariba-Underlay Copyright
//
// Copyright (c) 2008-2009, Institute of Telematics, Universität Karlsruhe (TH)
//
// Institute of Telematics
// Universität Karlsruhe (TH)
// Zirkel 2, 76128 Karlsruhe
// Germany
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the Institute of
// Telematics.
// [License]

#ifndef BASEOVERLAY_H_
#define BASEOVERLAY_H_

#include <map>
#include <iostream>
#include <algorithm>
#include <ctime>
#include <list>
#include <vector>
#include <deque>
#include <boost/foreach.hpp>

#include "ariba/utility/messages.h"
#include "ariba/utility/types.h"
#include "ariba/utility/misc/Helper.h"
#include "ariba/utility/misc/Demultiplexer.hpp"
#include "ariba/utility/logging/Logging.h"
#include "ariba/utility/system/Timer.h"

#include "ariba/communication/EndpointDescriptor.h"
#include "ariba/communication/BaseCommunication.h"
#include "ariba/communication/CommunicationEvents.h"

#include "ariba/overlay/modules/OverlayInterface.h"
#include "ariba/overlay/modules/OverlayFactory.h"
#include "ariba/overlay/modules/OverlayStructureEvents.h"

// forward declarations
namespace ariba {
class NodeListener;
class CommunicationListener;
class SideportListener;
namespace utility {
class OvlVis;
}
}

using std::vector;
using std::list;
using std::cout;
using std::map;
using std::make_pair;
using std::pair;
using std::find;
using std::deque;

using ariba::NodeListener;
using ariba::CommunicationListener;

// communication
using ariba::communication::EndpointDescriptor;
using ariba::communication::BaseCommunication;
using ariba::communication::CommunicationEvents;

// utilities
using ariba::utility::NodeID;
using ariba::utility::SpoVNetID;
using ariba::utility::LinkID;
using ariba::utility::Identifier;
using ariba::utility::ServiceID;
using ariba::utility::QoSParameterSet;
using ariba::utility::SecurityParameterSet;
using ariba::utility::Demultiplexer;
using ariba::utility::MessageReceiver;
using ariba::utility::MessageSender;
using ariba::utility::seqnum_t;
using ariba::utility::Timer;
using ariba::utility::OvlVis;

#define ovl OvlVis::instance()
#define ovlId OvlVis::NETWORK_ID_BASE_OVERLAY

namespace ariba {
namespace overlay {

class BaseOverlay: public MessageReceiver, public CommunicationEvents,
	public OverlayStructureEvents, protected Timer {

private:
	friend class OneHop;
	friend class Chord;

	use_logging_h( BaseOverlay );

public:

	/**
	 * Constructs an empty non-functional base overlay instance
	 */
	BaseOverlay();

	/**
	 * Destructs a base overlay instance
	 */
	virtual ~BaseOverlay();

	/**
	 * Starts the Base Overlay instance
	 */
	void start(BaseCommunication& _basecomm, const NodeID& _nodeid);

	/**
	 * Stops the Base Overlay instance
	 */
	void stop();

	/**
	 * Starts a link establishment procedure to the specfied node
	 * for the service with id service
	 *
	 * @param node Destination node id
	 * @param service Service to connect to
	 * @param linkid Link identifier to be used with this link
	 */
	const LinkID establishLink(const NodeID& node, const ServiceID& service,
			const LinkID& linkid = LinkID::UNSPECIFIED);

	/**
	 * Starts a link establishment procedure to the specified
	 *
	 * endpoint and to the specified service
	 */
	const LinkID establishLink(const EndpointDescriptor& ep,
			const ServiceID& service, const LinkID& linkid =
					LinkID::UNSPECIFIED);

	/// drops a link
	void dropLink(const LinkID& link);

	/// sends a message over an existing link
	seqnum_t sendMessage(const Message* message, const LinkID& link);

	/// sends a message to a node and a specific service
	seqnum_t sendMessage(const Message* message, const NodeID& node,
			const ServiceID& service);

	/**
	 * Send out a message to all nodes that are known in the overlay structure.
	 * Depending on the structure of the overlay, this can be very different.
	 */
	void broadcastMessage(Message* message, const ServiceID& service);

	/**
	 * Returns the end-point descriptor of a link.
	 *
	 * @param link the link id of the requested end-point
	 * @return The end-point descriptor of the link's end-point
	 */
	const EndpointDescriptor& getEndpointDescriptor(const LinkID& link =
			LinkID::UNSPECIFIED) const;

	/**
	 * Get a list of overlay neighbors.
	 *
	 * @return A list of overlay neighbors.
	 */
	vector<NodeID> getOverlayNeighbors() const;

	/**
	 * Returns a end-endpoint descriptor of a overlay neighbor.
	 * If the node is not known -- an unspecified endpoint descriptor is
	 * returned.
	 *
	 * @param node The node identifer of a overlay neighbor.
	 * @return The end-point descriptor of the node or unspecified.
	 */
	const EndpointDescriptor& getEndpointDescriptor(const NodeID& node) const;

	// TODO: Doc
	bool bind(CommunicationListener* listener, const ServiceID& sid);

	// TODO: Doc
	bool unbind(CommunicationListener* listener, const ServiceID& sid);

	// TODO: Doc
	bool bind(NodeListener* listener);

	// TODO: Doc
	bool unbind(NodeListener* listener);

	// TODO: Doc
	bool registerSidePort(SideportListener* _sideport);

	// TODO: Doc
	bool unregisterSidePort(SideportListener* _sideport);

	/**
	 * Returns the own nodeID or the NodeID of the specified link
	 *
	 * @param lid The link identifier
	 * @return The NodeID of the link
	 */
	const NodeID& getNodeID(const LinkID& lid = LinkID::UNSPECIFIED) const;

	/**
	 * Return all Links for the specified remote nodeid, or all links when
	 * the node id given is set to unspecified
	 *
	 * @param nid The node id to request links for, or unspecified for all links
	 * @return a vector that contains all the link ids requested
	 */
	vector<LinkID> getLinkIDs(const NodeID& nid = NodeID::UNSPECIFIED) const;

	/**
	 * Join a existing sponaneous virtual network (spovnet).
	 *
	 * @param id A spovnet identifier
	 * @param boot A bootstrap node
	 */
	void joinSpoVNet(const SpoVNetID& id, const EndpointDescriptor& boot );

	/**
	 * Initiates a new spontaneous virtual network.
	 * This makes this BaseOverlay to the SpoVNet-Initiator.
	 *
	 * @param id The spovnet identifier
	 */
	void createSpoVNet(const SpoVNetID& id, const OverlayParameterSet& param =
			OverlayParameterSet::DEFAULT, const SecurityParameterSet& sec =
			SecurityParameterSet::DEFAULT, const QoSParameterSet& qos =
			QoSParameterSet::DEFAULT);

	/**
	 * Let the node leave the SpoVNet.
	 */
	void leaveSpoVNet();

protected:

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual void onLinkUp(const LinkID& id, const NetworkLocator* local,
			const NetworkLocator* remote);

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual void onLinkDown(const LinkID& id, const NetworkLocator* local,
			const NetworkLocator* remote);

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual void onLinkChanged(const LinkID& id,
			const NetworkLocator* oldlocal, const NetworkLocator* newlocal,
			const NetworkLocator* oldremote, const NetworkLocator* newremote);

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual void onLinkFail(const LinkID& id, const NetworkLocator* local,
			const NetworkLocator* remote);

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual void onLinkQoSChanged(const LinkID& id,
			const NetworkLocator* local, const NetworkLocator* remote,
			const QoSParameterSet& qos);

	/**
	 * @see ariba::communication::CommunicationEvents.h
	 */
	virtual bool onLinkRequest(const LinkID& id, const NetworkLocator* local,
			const NetworkLocator* remote);

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	/**
	 * Processes a received message.
	 *
	 * Beware: nodeid is not valid in this case! (since this class implements
	 * nodeid's in the first place *g*)
	 */
	virtual bool receiveMessage(
		const Message* message, const LinkID& link,	const NodeID&);

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	/**
	 * This method is called, when a routed message arrives from the
	 * overlay.
	 *
	 * @see OverlayStructureEvents.h
	 */
	virtual void incomingRouteMessage(Message* msg);

	/**
	 * This method is called, when a new node joined the network
	 *
	 * @see OverlayStructureEvents.h
	 */
	virtual void onNodeJoin(const NodeID& node);

	/**
	 * Timer Event method
	 */
	virtual void eventFunction();

private:
	/**
	 * The BaseCommunication the BaseOverlay
	 * communicates over
	 */
	BaseCommunication* bc;

	/**
	 * The nodeid of this BaseOverlay instance.
	 */
	NodeID nodeId;

	/**
	 * The SpoVNetID that we are joined to
	 * or that we have created.
	 */
	SpoVNetID spovnetId;

	/**
	 * TODO
	 */
	Demultiplexer<CommunicationListener*, ServiceID> communicationListeners;

	/**
	 * TODO
	 */
	typedef vector<NodeListener*> NodeListenerVector;

	/**
	 * TODO
	 */
	NodeListenerVector nodeListeners;

	/**
	 * TODO
	 */
	SideportListener* sideport;

	/**
	 * The abstract overlay interface that implements
	 * the overlay specific functionality.
	 */
	OverlayInterface* overlayInterface;

	/**
	 * The special link to the Initiator of the SpoVNet
	 * or LinkID::UNDEFINED if we are the Initiator
	 */
	LinkID initiatorLink;

	/**
	 * The state of the BaseOverlay
	 */
	typedef enum _BaseOverlayState {
		BaseOverlayStateInvalid = 0,
		BaseOverlayStateInitiator = 1,
		BaseOverlayStateJoinInitiated = 2,
		BaseOverlayStateCompleted = 3,
	} BaseOverlayState;

	/**
	 * TODO
	 */
	BaseOverlayState state;

	/**
	 * The initiator node
	 */
	NodeID spovnetInitiator;

	/**
	 * OvlVis
	 */
	NodeID min, max;
	NodeID succ, pred;
	void updateOvlVis(const NodeID& node);

	/**
	 * Link management
	 */
	class LinkItem {
	public:
		static const LinkItem UNSPECIFIED;

		LinkItem() :
			link(LinkID::UNSPECIFIED),
			node(NodeID::UNSPECIFIED),
			service(ServiceID::UNSPECIFIED),
			interface(&CommunicationListener::DEFAULT),
			autolink(false),
			lastuse(0),
			linkup(false){
		}

		LinkItem(const LinkID& _link, const NodeID& _node,
				const ServiceID& _service, CommunicationListener* _interface) :
			link(_link),
			node(_node),
			service(_service),
			interface(_interface),
			autolink(false),
			lastuse(time(NULL)),
			linkup(false){

			assert( _interface != NULL );
		}

		LinkItem(const LinkItem& rh) :
			link(rh.link),
			node(rh.node),
			service(rh.service),
			interface(rh.interface),
			autolink(rh.autolink),
			lastuse(rh.lastuse),
			linkup(rh.linkup){

			BOOST_FOREACH( Message* msg, rh.waitingmsg ){
				waitingmsg.push_back( msg );
			}
		}

		void deleteWaiting(){
			BOOST_FOREACH( Message* msg, waitingmsg ){
				delete msg;
			}
			waitingmsg.clear();
		}

		// general information about the link
		const LinkID link;
		NodeID node;
		ServiceID service;
		CommunicationListener* interface;
		bool linkup;

		// information needed for auto links
		void markused() {
			lastuse = time(NULL);
		}

		bool autolink;
		time_t lastuse;
		deque<Message*> waitingmsg;
	};

	typedef map<const LinkID, LinkItem> LinkMapping;
	typedef pair<const LinkID, LinkItem> LinkPair;
	LinkMapping linkMapping;

	// map of a link request map a nonce to a LinkID
	typedef map<const uint32_t, LinkID> PendingLinkMap;
	PendingLinkMap pendingLinks;

	/**
	 * nodes with pending joines. TODO: should be cleaned every
	 * some seconds, add timestamps to each, and check on occasion
	 */
	typedef vector<NodeID> JoiningNodes;
	JoiningNodes joiningNodes;

};

}} // namespace ariba, overlay

#endif /*BASEOVERLAY_H_*/