sources/network/rconsession.h

/*
	Copyright 2014 - 2016 Teemu Piippo
	All rights reserved.

	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.
	3. Neither the name of the copyright holder nor the names of its
	   contributors may be used to endorse or promote products derived from
	   this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	"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 COPYRIGHT HOLDER
	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.
*/

#pragma once
#include "ipaddress.h"
#include "udpsocket.h"
#include "bytestream.h"
BEGIN_ZFC_NAMESPACE

// -------------------------------------------------------------------------------------------------
//
enum
{
	RCON_PROTOCOL_VERSION = 5
};

// -------------------------------------------------------------------------------------------------
//
enum ServerResponse
{
	SVRC_OLDPROTOCOL = 32,
	SVRC_BANNED,
	SVRC_SALT,
	SVRC_LOGGEDIN,
	SVRC_INVALIDPASSWORD,
	SVRC_MESSAGE,
	SVRC_UPDATE,
	SVRC_TABCOMPLETE,
	SVRC_TOOMANYTABCOMPLETES,
	SVRC_WATCHINGCVAR,
	SVRC_ALREADYWATCHINGCVAR,
	SVRC_WATCHCVARNOTFOUND,
	SVRC_CVARCHANGED,
	SVRC_YOUREDISCONNECTED,
};

// -------------------------------------------------------------------------------------------------
//
enum ClientRequest
{
	CLRC_BEGINCONNECTION = 52,
	CLRC_PASSWORD,
	CLRC_COMMAND,
	CLRC_PONG,
	CLRC_DISCONNECT,
	CLRC_TABCOMPLETE,
	CLRC_WATCHCVAR,
};

// -------------------------------------------------------------------------------------------------
//
enum RCONUpdateType
{
	SVRCU_PLAYERDATA,
	SVRCU_ADMINCOUNT,
	SVRCU_MAP,
};

// -------------------------------------------------------------------------------------------------
//
enum RCONSessionState
{
	RCON_DISCONNECTED,
	RCON_CONNECTING,
	RCON_AUTHENTICATING,
	RCON_CONNECTED
};

// -------------------------------------------------------------------------------------------------
//
class RCONSession
{
public:
	RCONSession();
	~RCONSession();

	const IPAddress& address() const;
	void connect (IPAddress address);
	void disconnect();
	void handle_packet (Datagram& datagram);
	void process_server_updates (Bytestream& packet);
	int num_admins() const;
	void send (const Bytestream& packet);
	void send_hello();
	void send_password();
	void set_password (const String& password);
	UDPSocket* socket();
	void tick();
	void bump_last_ping();
	bool send_command (const String& message);
	RCONSessionState state() const;
	const String& level() const;
	bool is_active() const;
	void request_tab_complete (const String& part);
	void set_interface (class Interface* iface);
	void request_watch (const String& cvar);
	void request_watch (const StringList& cvars);

private:
	RCONSessionState m_state;
	IPAddress m_address;
	UDPSocket m_socket;
	time_t m_lastPing;
	String m_password;
	String m_salt;
	int m_serverProtocol;
	String m_hostname;
	int m_numAdmins;
	String m_level;
	String m_lastTabComplete;
	class Interface* m_interface;
};

END_ZFC_NAMESPACE