barrier/server/CServer.h

#ifndef CSERVER_H
#define CSERVER_H

#include "CConfig.h"
#include "CClipboard.h"
#include "ClipboardTypes.h"
#include "KeyTypes.h"
#include "MouseTypes.h"
#include "CNetworkAddress.h"
#include "CCondVar.h"
#include "CMutex.h"
#include "CThread.h"
#include "stdlist.h"
#include "stdmap.h"

class CThread;
class IServerProtocol;
class ISocketFactory;
class ISecurityFactory;
class IPrimaryScreen;
class CHTTPServer;

class CServer {
public:
	CServer(const CString& serverName);
	~CServer();

	// manipulators

	// open the server's screen
	bool				open();

	// start the server.  does not return until quit() is called.
	// this must be preceeded by a successful call to open().
	void				run();

	// tell server to exit gracefully.  this may only be called
	// after a successful open().
	void				quit();

	// tell the server to shutdown.  this is called in an emergency
	// when we need to tell the server that we cannot continue.  the
	// server will attempt to clean up.
	void				shutdown();

	// update screen map.  returns true iff the new configuration was
	// accepted.
	bool				setConfig(const CConfig&);

	// handle events on server's screen.  onMouseMovePrimary() returns
	// true iff the mouse enters a jump zone and jumps.
	void				onKeyDown(KeyID, KeyModifierMask);
	void				onKeyUp(KeyID, KeyModifierMask);
	void				onKeyRepeat(KeyID, KeyModifierMask, SInt32 count);
	void				onMouseDown(ButtonID);
	void				onMouseUp(ButtonID);
	bool				onMouseMovePrimary(SInt32 x, SInt32 y);
	void				onMouseMoveSecondary(SInt32 dx, SInt32 dy);
	void				onMouseWheel(SInt32 delta);
	void				grabClipboard(ClipboardID);
	void				onScreenSaver(bool activated);

	// handle updates from primary
	void				setInfo(SInt32 xScreen, SInt32 yScreen,
							SInt32 wScreen, SInt32 hScreen,
							SInt32 zoneSize,
							SInt32 xMouse, SInt32 yMouse);

	// handle messages from clients
	void				setInfo(const CString& clientName,
							SInt32 xScreen, SInt32 yScreen,
							SInt32 wScreen, SInt32 hScreen,
							SInt32 zoneSize,
							SInt32 xMouse, SInt32 yMouse);
	void				grabClipboard(ClipboardID,
							UInt32 seqNum, const CString& clientName);
	void				setClipboard(ClipboardID,
							UInt32 seqNum, const CString& data);

	// accessors

	// returns true if the mouse should be locked to the current screen
	bool				isLockedToScreen() const;

	// get the current screen map
	void				getConfig(CConfig*) const;

	// get the primary screen's name
	CString				getPrimaryScreenName() const;

	// get the sides of the primary screen that have neighbors
	UInt32				getActivePrimarySides() const;

protected:
	bool				onCommandKey(KeyID, KeyModifierMask, bool down);

private:
	typedef std::list<CThread*> CThreadList;

	class CScreenInfo {
	public:
		CScreenInfo(const CString& name, IServerProtocol*);
		~CScreenInfo();

	public:
		// the thread handling this screen's connection.  used when
		// forcing a screen to disconnect.
		CThread			m_thread;
		CString			m_name;
		IServerProtocol* m_protocol;
		bool			m_ready;

		// screen shape and jump zone size
		SInt32			m_x, m_y;
		SInt32			m_w, m_h;
		SInt32			m_zoneSize;

		bool			m_gotClipboard[kClipboardEnd];
	};

	// handle mouse motion
	bool				onMouseMovePrimaryNoLock(SInt32 x, SInt32 y);
	void				onMouseMoveSecondaryNoLock(SInt32 dx, SInt32 dy);

	// update screen info
	void				setInfoNoLock(const CString& screenName,
							SInt32 xScreen, SInt32 yScreen,
							SInt32 wScreen, SInt32 hScreen,
							SInt32 zoneSize,
							SInt32 xMouse, SInt32 yMouse);

	// grab the clipboard
	void				grabClipboardNoLock(ClipboardID,
							UInt32 seqNum, const CString& clientName);

	// returns true iff mouse should be locked to the current screen
	bool				isLockedToScreenNoLock() const;

	// change the active screen
	void				switchScreen(CScreenInfo*,
							SInt32 x, SInt32 y, bool forScreenSaver);

	// lookup neighboring screen
	CScreenInfo*		getNeighbor(CScreenInfo*, CConfig::EDirection) const;

	// lookup neighboring screen.  given a position relative to the
	// source screen, find the screen we should move onto and where.
	// if the position is sufficiently far from the source then we
	// cross multiple screens.  if there is no suitable screen then
	// return NULL and x,y are not modified.
	CScreenInfo*		getNeighbor(CScreenInfo*,
							CConfig::EDirection,
							SInt32& x, SInt32& y) const;

	// open/close the primary screen
	void				openPrimaryScreen();
	void				closePrimaryScreen();

	// clear gotClipboard flags in all screens
	void				clearGotClipboard(ClipboardID);

	// send clipboard to the active screen if it doesn't already have it
	void				sendClipboard(ClipboardID);

	// update the clipboard if owned by the primary screen
	void				updatePrimaryClipboard(ClipboardID);

	// start a thread, adding it to the list of threads
	void				startThread(IJob* adopted);

	// cancel running threads, waiting at most timeout seconds for
	// them to finish.
	void				stopThreads(double timeout = -1.0);

	// reap threads, clearing finished threads from the thread list.
	// doReapThreads does the work on the given thread list.
	void				reapThreads();
	void				doReapThreads(CThreadList&);

	// thread method to accept incoming client connections
	void				acceptClients(void*);

	// thread method to do startup handshake with client
	void				handshakeClient(void*);

	// thread method to accept incoming HTTP connections
	void				acceptHTTPClients(void*);

	// thread method to process HTTP requests
	void				processHTTPRequest(void*);

	// connection list maintenance
	CScreenInfo*		addConnection(const CString& name, IServerProtocol*);
	void				removeConnection(const CString& name);

private:
	typedef std::map<CString, CScreenInfo*> CScreenList;
	class CClipboardInfo {
	public:
		CClipboardInfo();

	public:
		CClipboard		m_clipboard;
		CString			m_clipboardData;
		CString			m_clipboardOwner;
		UInt32			m_clipboardSeqNum;
		bool			m_clipboardReady;
	};

	CMutex				m_mutex;

	// the name of the primary screen
	CString				m_name;

	double				m_bindTimeout;

	ISocketFactory*		m_socketFactory;
	ISecurityFactory*	m_securityFactory;

	// running threads
	CThreadList			m_threads;

	// the screens
	IPrimaryScreen*		m_primary;
	CScreenList			m_screens;
	CScreenInfo*		m_active;
	CScreenInfo*		m_primaryInfo;

	// the sequence number of enter messages
	UInt32				m_seqNum;

	// current mouse position (in absolute secondary screen coordinates)
	SInt32				m_x, m_y;

	// current configuration
	CConfig				m_config;

	// clipboard cache
	CClipboardInfo		m_clipboards[kClipboardEnd];

	// state saved when screen saver activates
	CScreenInfo*		m_activeSaver;
	SInt32				m_xSaver, m_ySaver;

	// HTTP request processing stuff
	CHTTPServer*		m_httpServer;
	CCondVar<SInt32>	m_httpAvailable;
	static const SInt32	s_httpMaxSimultaneousRequests;
};

#endif