crown-engine/engine/console_server.cpp

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/

#include "console_server.h"
#include "json_parser.h"
#include "temp_allocator.h"
#include "string_stream.h"
#include "log.h"
#include "device.h"
#include "proxy_allocator.h"
#include "lua_environment.h"
#include "file.h"
#include "filesystem.h"
#include "math_utils.h"
#include "memory.h"

namespace crown
{

//-----------------------------------------------------------------------------
void ConsoleServer::init(uint16_t port, bool wait)
{
	m_server.open(port);
	m_server.listen(5);

	if (wait)
	{
		AcceptResult result;
		TCPSocket client;
		do
		{
			result = m_server.accept(client);
		}
		while (result.error != AcceptResult::NO_ERROR);

		add_client(client);
	}
}

//-----------------------------------------------------------------------------
void ConsoleServer::shutdown()
{
	for (uint32_t i = 0; i < id_array::size(m_clients); i++)
	{
		m_clients[i].close();
	}

	m_server.close();
}

//-----------------------------------------------------------------------------
void ConsoleServer::log_to_all(LogSeverity::Enum severity, const char* message, ...)
{
	va_list args;
	va_start(args, message);
	log_to_all(severity, message, args);
	va_end(args);
}

//-----------------------------------------------------------------------------
void ConsoleServer::log_to_all(LogSeverity::Enum severity, const char* message, ::va_list arg)
{
	using namespace string_stream;
	static const char* stt[] = { "info", "warning", "error", "debug" };

	// Log to stdout
	va_list arg_copy;
	__va_copy(arg_copy, arg);

	char buf[1024];
	int len = vsnprintf(buf, 1024 - 2, message, arg);
	buf[len] = '\n';
	buf[len + 1] = '\0';

	for (uint32_t i = 0; i < string::strlen(message); i++)
	{
		if (buf[i] == '"')
			buf[i] = '\'';
	}

	// Log on local device
	switch (severity)
	{
		case LogSeverity::DEBUG: os::log_debug(message, arg_copy); break;
		case LogSeverity::WARN: os::log_warning(message, arg_copy); break;
		case LogSeverity::ERROR: os::log_error(message, arg_copy); break;
		case LogSeverity::INFO: os::log_info(message, arg_copy); break;
		default: break;
	}
	va_end(arg_copy);

	// Build json message
	TempAllocator2048 alloc;
	StringStream json(alloc);

	json << "{\"type\":\"message\",";
	json << "\"severity\":\"" << stt[severity] << "\",";
	json << "\"message\":\"" << buf << "\"}";

	send_to_all(c_str(json));
}

//-----------------------------------------------------------------------------
void ConsoleServer::send(TCPSocket client, const char* message)
{
	uint32_t msg_len = string::strlen(message);
	client.write((const char*) &msg_len, 4);
	client.write(message, msg_len);
}

//-----------------------------------------------------------------------------
void ConsoleServer::send_to_all(const char* message)
{
	for (uint32_t i = 0; i < id_array::size(m_clients); i++)
	{
		send(m_clients[i].socket, message);
	}
}

//-----------------------------------------------------------------------------
void ConsoleServer::update()
{
	// Check for new clients only if we have room for them
	if (id_array::size(m_clients) < CE_MAX_CONSOLE_CLIENTS - 1)
	{
		TCPSocket client;
		AcceptResult result = m_server.accept_nonblock(client);
		if (result.error == AcceptResult::NO_ERROR)
		{
			add_client(client);
		}
	}

	TempAllocator256 alloc;
	Array<Id> to_remove(alloc);

	// Update all clients
	for (uint32_t i = 0; i < id_array::size(m_clients); i++)
	{
		ReadResult rr = update_client(m_clients[i].socket);
		if (rr.error != ReadResult::NO_ERROR) array::push_back(to_remove, m_clients[i].id);
	}

	// Remove clients
	for (uint32_t i = 0; i < array::size(to_remove); i++)
	{
		id_array::get(m_clients, to_remove[i]).socket.close();
		id_array::destroy(m_clients, to_remove[i]);
	}
}

//-----------------------------------------------------------------------------
void ConsoleServer::add_client(TCPSocket socket)
{
	Client client;
	client.socket = socket;
	Id id = id_array::create(m_clients, client);
	id_array::get(m_clients, id).id = id;
}

//-----------------------------------------------------------------------------
ReadResult ConsoleServer::update_client(TCPSocket client)
{
	uint32_t msg_len = 0;
	ReadResult rr = client.read_nonblock(&msg_len, 4);

	// If no data received, return
	if (rr.error == ReadResult::NO_ERROR && rr.bytes_read == 0) return rr;
	if (rr.error == ReadResult::REMOTE_CLOSED) return rr;
	if (rr.error != ReadResult::NO_ERROR) return rr;

	// Else read the message
	Array<char> msg_buf(default_allocator());
	array::resize(msg_buf, msg_len);
	ReadResult msg_result = client.read(array::begin(msg_buf), msg_len);
	array::push_back(msg_buf, '\0');

	if (msg_result.error == ReadResult::REMOTE_CLOSED) return msg_result;
	if (msg_result.error != ReadResult::NO_ERROR) return msg_result;

	process(client, array::begin(msg_buf));
	return msg_result;
}

//-----------------------------------------------------------------------------
void ConsoleServer::process(TCPSocket client, const char* request)
{
	JSONParser parser(request);
	DynamicString type;
	parser.root().key("type").to_string(type);

	// Determine request type
	if (type == "ping") process_ping(client, request);
	else if (type == "script") process_script(client, request);
	else if (type == "stats") process_stats(client, request);
	else if (type == "command") process_command(client, request);
	else if (type == "filesystem") processs_filesystem(client, request);
	else CE_FATAL("Request unknown.");
}

//-----------------------------------------------------------------------------
void ConsoleServer::process_ping(TCPSocket client, const char* /*msg*/)
{
	send(client, "{\"type\":\"pong\"}");
}

//-----------------------------------------------------------------------------
void ConsoleServer::process_script(TCPSocket /*client*/, const char* msg)
{
	JSONParser parser(msg);
	JSONElement root = parser.root();

	DynamicString script;
	root.key("script").to_string(script);
	device()->lua_environment()->execute_string(script.c_str());
}

//-----------------------------------------------------------------------------
void ConsoleServer::process_stats(TCPSocket client, const char* /*msg*/)
{
	using namespace string_stream;

	TempAllocator2048 alloc;
	StringStream response(alloc);

	response << "{\"type\":\"response\",";
	response << "{\"allocators\":[";

	// Walk all proxy allocators
	ProxyAllocator* proxy = ProxyAllocator::begin();
	while (proxy != NULL)
	{
		response << "{";
		response << "\"name\":\"" << proxy->name() << "\",";
		response << "\"allocated_size\":\"" << proxy->allocated_size() << "\"";
		response << "},";

		proxy = ProxyAllocator::next(proxy);
	}

	response << "]" << "}";

	send(client, c_str(response));
}

//-----------------------------------------------------------------------------
void ConsoleServer::process_command(TCPSocket /*client*/, const char* msg)
{
	JSONParser parser(msg);
	JSONElement root = parser.root();
	JSONElement command = root.key("command");

	DynamicString cmd;
	command.to_string(cmd);

	if (cmd == "reload")
	{
		JSONElement type = root.key_or_nil("resource_type");
		JSONElement name = root.key_or_nil("resource_name");

		DynamicString resource_type;
		DynamicString resource_name;
		type.to_string(resource_type);
		name.to_string(resource_name);

		char t[256];
		char n[256];
		string::strncpy(t, resource_type.c_str(), 256);
		string::strncpy(n, resource_name.c_str(), 256);
		device()->reload(t, n);
	}
	else if (cmd == "pause")
	{
		device()->pause();
	}
	else if (cmd == "unpause")
	{
		device()->unpause();
	}
}

//-----------------------------------------------------------------------------
void ConsoleServer::processs_filesystem(TCPSocket client, const char* msg)
{
	using namespace string_stream;

	JSONParser parser(msg);
	JSONElement root = parser.root();
	JSONElement filesystem = root.key("filesystem");

	DynamicString cmd;
	filesystem.to_string(cmd);

	if (cmd == "size")
	{
		DynamicString file_name;
		root.key("file").to_string(file_name);

		File* file = device()->filesystem()->open(file_name.c_str(), FOM_READ);
		size_t file_size = file->size();
		device()->filesystem()->close(file);

		TempAllocator64 alloc;
		StringStream response(alloc);
		response << "{\"type\":\"file\",\"size\":" << file_size << "}";

		send(client, c_str(response));
	}
	else if (cmd == "read")
	{
		JSONElement file_position = root.key("position");
		JSONElement file_size = root.key("size");

		DynamicString file_name;
		root.key("file").to_string(file_name);

		// Read the file data
		File* file = device()->filesystem()->open(file_name.c_str(), FOM_READ);
		char* bytes = (char*) default_allocator().allocate((size_t) file_size.to_int());
		file->seek((size_t) file_position.to_int());
		file->read(bytes, (size_t) file_size.to_int());
		device()->filesystem()->close(file);

		// Encode data to base64
		size_t dummy;
		char* bytes_encoded = math::base64_encode((unsigned char*) bytes, (size_t) file_size.to_int(), &dummy);

		// Send data
		TempAllocator4096 alloc;
		StringStream response(alloc);

		response << "{\"type\":\"file\",";
		response << "\"data\":\"" << bytes_encoded << "\"}";

		send(client, c_str(response));

		// Cleanup
		default_allocator().deallocate(bytes_encoded);
		default_allocator().deallocate(bytes);
	}
}

} // namespace crown