sources/interface.cpp

/*
	Copyright 2014 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.
*/

#include <string.h>
#include "interface.h"
#include "network/rconsession.h"
#include "network/ipaddress.h"
#include "coloredline.h"

static const int g_pageSize = 10;

enum InputState
{
	INPUTSTATE_NORMAL,
	INPUTSTATE_ADDRESS,
	INPUTSTATE_PASSWORD,
	INPUTSTATE_CONFIRM_DISCONNECTION,
};

static StringList g_input;
static int g_inputCursor = 0;
static int g_cursor = 0;
static int g_pan = 0;
static bool g_needRefresh = false;
static bool g_needStatusBarRender = false;
static bool g_needInputRender = false;
static bool g_needOutputRender = false;
static bool g_needNicklistRender = false;
static struct { char ch; int x; } g_cursorChar;
static Vector<ColoredLine> g_output;;
static int g_outputScroll = 0;
static String g_title;
static InputState g_inputState = INPUTSTATE_NORMAL;
static Function<void (void)> g_disconnectConfirmFunction = nullptr;
static IPAddress g_address;
static String g_statusBarText;
static StringList g_playerNames;

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_color_pair (Color fg, Color bg) -> int
{
	return COLOR_PAIR ((int (fg) * NUM_COLORS) + int (bg));
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
current_input() -> const String&
{
	return g_input[g_inputCursor];
}

// -------------------------------------------------------------------------------------------------
//
// Makes current_input() the lastmost input (so that we won't modify history)
//
static FUNCTION
detach_input() -> void
{
	if (g_inputCursor > 0)
	{
		g_input[0] = current_input();
		g_inputCursor = 0;
	}
}

// -------------------------------------------------------------------------------------------------
// A version of current_input() that allows changing the contents of it.
//
static FUNCTION
mutable_current_input() -> String&
{
	detach_input();
	return g_input[g_inputCursor];
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
move_input_cursor (int delta) -> void
{
	// No input history when inputting addresses or passwords
	if (g_inputState != INPUTSTATE_NORMAL)
	{
		g_inputCursor = 0;
		return;
	}

	int oldcursor = g_inputCursor;
	g_inputCursor = clamp (g_inputCursor + delta, 0, g_input.size() - 1);

	if (g_inputCursor != oldcursor)
	{
		g_cursor = current_input().length();
		g_needInputRender = true;
	}
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_prompt_string() -> String
{
	String prompt;

	switch (g_inputState)
	{
	case INPUTSTATE_NORMAL: prompt = ">"; break;
	case INPUTSTATE_ADDRESS: prompt = "address:"; break;
	case INPUTSTATE_PASSWORD: prompt = "password:"; break;
	case INPUTSTATE_CONFIRM_DISCONNECTION: break;
	}

	return prompt;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
set_input_state (InputState newstate) -> void
{
	// Clear the input row (unless going to or from confirm state)
	if (newstate != INPUTSTATE_CONFIRM_DISCONNECTION
		and g_inputState != INPUTSTATE_CONFIRM_DISCONNECTION)
	{
		g_inputCursor = 0;
		mutable_current_input().clear();
	}

	switch (newstate)
	{
	case INPUTSTATE_ADDRESS:
		if (g_address.host != 0)
			mutable_current_input() = g_address.to_string (IP_WITH_PORT);
		break;

	default:
		break;
	}

	g_inputState = newstate;
	g_needInputRender = true;
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::initialize() -> void
{
	::initscr();
	::start_color();
	::raw();
	::keypad (stdscr, true);
	::noecho();
	::refresh();
	::timeout (0);
	::use_default_colors();
	g_input.clear();
	g_input << "";
	g_output.clear();
	g_output << ColoredLine();
	g_title = format (APPNAME " %1 (%2)", full_version_string(), changeset_date_string());

	for (int i = 0; i < NUM_COLORS; ++i)
	for (int j = 0; j < NUM_COLORS; ++j)
	{
		init_pair ((i * NUM_COLORS + j),
			(i == DEFAULT) ? -1 : i,
			(j == DEFAULT) ? -1 : j);
	}

	render_full();
	refresh();
	g_needRefresh = false;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_render_titlebar() -> void
{
	if (g_title.length() <= COLS)
	{
		int pair = interface_color_pair (WHITE, BLUE);
		int startx = (COLS - g_title.length()) / 2;
		int endx = startx + g_title.length();
		attron (pair);
		mvprintw (0, startx, "%s", g_title.chars());
		mvhline (0, 0, ' ', startx);
		mvhline (0, endx, ' ', COLS - endx);
		attroff (pair);
	}

	g_needRefresh = true;
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::set_title (const String& title) -> void
{
	g_title = title;
	interface_render_titlebar();
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
safe_disconnect (Function<void()> afterwards) -> void
{
	if (RCONSession::get_session()->is_active())
	{
		g_disconnectConfirmFunction = afterwards;
		set_input_state (INPUTSTATE_CONFIRM_DISCONNECTION);
	}
	else
		afterwards();
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
inteface_nicklist_width() -> int
{
	// Allocate at least 12 characters, at most 24 characters, for the nicklist. If we cannot
	// afford that (o_O) then we probably shouldn't draw the nicklist at all I think.
	int nicklistWidth = COLS / 4;

	if (nicklistWidth < 12)
		return 0;

	return min (nicklistWidth, 24);
}

// -------------------------------------------------------------------------------------------------
// Renders the given colored line onto the screen. Will wrap if allowWrap is true. Returns the
// 'y' value for the next line.
//
static FUNCTION
interface_render_colorline (int y, int x0, int width,
	const ColoredLine& line, bool allowWrap) -> int
{
	int x = x0;

	for (int byte : line.data())
	{
		if (x == x0 + width)
		{
			if (not allowWrap)
				return y;

			x = x0;
			++y;
		}

		if (isprint (byte))
		{
			mvaddch (y, x, char (byte));
			++x;
		}
		else switch (byte)
		{
		case RLINE_ON_BLACK:
		case RLINE_ON_GREEN:
		case RLINE_ON_YELLOW:
		case RLINE_ON_BLUE:
		case RLINE_ON_MAGENTA:
		case RLINE_ON_CYAN:
		case RLINE_ON_WHITE:
			attron (interface_color_pair (Color (byte - RLINE_ON_BLACK), DEFAULT));
			break;

		case RLINE_OFF_BLACK:
		case RLINE_OFF_GREEN:
		case RLINE_OFF_YELLOW:
		case RLINE_OFF_BLUE:
		case RLINE_OFF_MAGENTA:
		case RLINE_OFF_CYAN:
		case RLINE_OFF_WHITE:
			attroff (interface_color_pair (Color (byte - RLINE_OFF_BLACK), DEFAULT));
			break;

		case RLINE_ON_BOLD:
			attron (A_BOLD);
			break;

		case RLINE_OFF_BOLD:
			attroff (A_BOLD);
			break;
		}
	}

	return y + 1;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_render_output() -> void
{
	if (g_output.size() == 1)
		return;

	g_outputScroll = clamp (g_outputScroll, 0, g_output.size() - 1);

	int height = LINES - 3;
	int width = COLS - inteface_nicklist_width();
	int printOffset = 0;
	int end = g_output.size() - 1 - g_outputScroll;
	int start = end;
	int usedHeight = 0;
	int y = 1;
	bool tightFit = false;

	// Where to start?
	while (start > 0)
	{
		int rows = g_output[start - 1].rows (width);

		if (usedHeight + rows > height)
		{
			// This line won't fit anymore.
			tightFit = true;
			break;
		}

		start--;
		usedHeight += rows;
	}

	// See if there's any more rows to use (end may be too small)
	if (not tightFit)
	{
		while (end < g_output.size())
		{
			int rows = g_output[end].rows (width);

			if (usedHeight + rows > height)
			{
				tightFit = true;
				break;
			}

			end++;
			usedHeight += rows;
		}
	}

	if (start > 0)
		printOffset = height - usedHeight;

	g_outputScroll = g_output.size() - 1 - end;

	if (start < 0 or start == end or printOffset >= height)
		return;

	assert (start <= end and start - end <= height);

	// Clear the display
	for (int i = y; i < y + height; ++i)
		mvhline (i, 0, ' ', width);

	// Print the lines
	y += printOffset;

	for (int i = start; i < end; ++i)
		y = interface_render_colorline (y, 0, width, g_output[i], true);

	g_needOutputRender = false;
	g_needRefresh = true;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_render_nicklist() -> void
{
	int width = inteface_nicklist_width();
	int height = LINES- 3;
	int y = 1;
	int x = COLS - width;

	if (width == 0)
		return;

	for (int i = 0; i < height; ++i)
	{
		mvhline (y, x, ' ', width);

		if (i < g_playerNames.size())
		{
			String displaynick = g_playerNames[i];

			if (displaynick.length() > width)
			{
				displaynick = displaynick.mid (0, width - 3);
				displaynick += "...";
			}

			mvprintw (y, x, "%s", displaynick.chars());
		}

		y++;
	}

	g_needNicklistRender = false;
	g_needRefresh = true;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_render_input() -> void
{
	int promptColor = interface_color_pair (WHITE, BLUE);

	// If we're asking the user if they want to disconnect, we don't render any input strings,
	// just the confirmation message.
	if (g_inputState == INPUTSTATE_CONFIRM_DISCONNECTION)
	{
		attron (promptColor);
		mvhline (LINES - 2, 0, ' ', COLS);
		mvprintw (LINES - 2, 0, "Are you sure you want to disconnect? y/n");
		attroff (promptColor);
		g_needRefresh = true;
		return;
	}

	String prompt = interface_prompt_string();
	int displayLength = COLS - prompt.length() - 2;
	String displayString = current_input();
	int y = LINES - 2;

	// If we're inputting a password, replace it with asterisks
	if (g_inputState == INPUTSTATE_PASSWORD)
	{
		for (char& ch : displayString)
			ch = '*';
	}

	// Ensure the cursor is within bounds
	g_cursor = clamp (g_cursor, 0, displayString.length());

	// Ensure that the cursor is always in view, adjust panning if this is not the case
	if (g_cursor > g_pan + displayLength)
		g_pan = g_cursor - displayLength; // cursor went too far right
	else if (g_cursor < g_pan)
		g_pan = g_cursor; // cursor went past the pan value to the left

	// What part of the string to draw?
	int start = g_pan;
	int end = min<int> (displayString.length(), start + displayLength);
	assert (g_cursor >= start and g_cursor <= end);

	// Render the input string
	mvhline (LINES - 2, 0, ' ', COLS);
	mvprintw (y, prompt.length() + 1, "%s", displayString.chars());

	// Render the prompt
	attron (promptColor);
	mvprintw (y, 0, "%s", prompt.chars());
	attroff (promptColor);

	// Store in memory where the cursor is now (so that we can re-draw it to position the terminal
	// cursor).
	g_cursorChar.ch = g_cursor != 0 ? displayString[g_cursor - 1] : '\0';
	g_cursorChar.x = prompt.length() + (g_cursor - g_pan);
	g_needRefresh = true;
	g_needInputRender = false;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_render_statusbar() -> void
{
	int color = interface_color_pair (WHITE, BLUE);
	int y = LINES - 1;
	attron (color);
	mvhline (y, 0, ' ', COLS);
	mvprintw (y, 0, "%s", g_statusBarText.chars());
	attroff (color);
	g_needRefresh = true;
	g_needStatusBarRender = false;
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::update_statusbar() -> void
{
	String text;
	RCONSession* session = RCONSession::get_session();

	switch (session->state())
	{
	case RCON_DISCONNECTED:
		text = "Disconnected.";
		break;

	case RCON_CONNECTING:
	case RCON_AUTHENTICATING:
		text = "Connecting to " + session->address().to_string (IP_WITH_PORT) + "...";
		break;

	case RCON_CONNECTED:
		{
			String adminText = (session->num_admins() == 0) ? "No other admins"
				: format ("%1 other admin%s1", session->num_admins());
			text = format ("%1 | %2 | %3", session->address().to_string (IP_WITH_PORT),
				session->level(), adminText);
		}
		break;
	}

	if (not text.is_empty())
		text += " | ";

	text += "^N to connect, ^Q to quit";

	if (text != g_statusBarText)
	{
		g_statusBarText = text;
		g_needStatusBarRender = true;
	}
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::render_full() -> void
{
	update_statusbar();
	interface_render_titlebar();
	interface_render_output();
	interface_render_statusbar();
	interface_render_input();
	interface_render_nicklist();
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_position_cursor() -> void
{
	// This is only relevant if the input string is being drawn
	if (g_inputState == INPUTSTATE_CONFIRM_DISCONNECTION)
		return;

	int y = LINES - 2;

	if (g_cursorChar.ch != '\0')
		mvprintw (y, g_cursorChar.x, "%c", g_cursorChar.ch);
	else
		mvprintw (y, interface_prompt_string().length(), " ");
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_find_previous_word() -> int
{
	const String& input = current_input();
	int pos = g_cursor;

	// Move past whitespace
	while (pos > 0 and isspace (input[pos - 1]))
		pos--;

	// Move past the word
	while (pos > 0 and not isspace (input[pos - 1]))
		pos--;

	return pos;
}

// -------------------------------------------------------------------------------------------------
//
static FUNCTION
interface_find_next_word() -> int
{
	const String& input = current_input();
	int pos = g_cursor;

	// Move past current whitespace
	while (pos < input.length() and isspace (input[pos]))
		pos++;

	// Move past the word
	while (input[pos] != '\0' and not isspace (input[pos]))
		pos++;

	return pos;
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::handle_input() -> void
{
	int ch = ::getch();

	if (ch == KEY_RESIZE)
	{
		::clear();
		render_full();
		return;
	}

	if (g_inputState == INPUTSTATE_CONFIRM_DISCONNECTION)
	{
		if (ch == 'y' or ch == 'Y')
		{
			RCONSession::get_session()->disconnect();
			g_disconnectConfirmFunction();
		}
		else if (ch == 'n' or ch == 'N')
			set_input_state (INPUTSTATE_NORMAL);

		return;
	}

	if (ch >= 0x20 and ch <= 0x7E)
	{
		mutable_current_input().insert (g_cursor++, char (ch));
		g_needInputRender = true;
	}
	else switch (ch)
	{
	case 'Q' - 'A' + 1: // ^Q
		switch (g_inputState)
		{
		case INPUTSTATE_CONFIRM_DISCONNECTION:
			break;

		case INPUTSTATE_NORMAL:
			safe_disconnect ([]()
			{
				RCONSession* session = RCONSession::get_session();

				if (session->is_active())
				{
					session->disconnect();
					set_input_state (INPUTSTATE_NORMAL);
				}
				else
				{
					endwin();
					throw Exitception();
				}
			});
			break;

		case INPUTSTATE_PASSWORD:
			set_input_state (INPUTSTATE_ADDRESS);
			break;

		case INPUTSTATE_ADDRESS:
			set_input_state (INPUTSTATE_NORMAL);
		}
		break;

	case KEY_LEFT:
	case 'B' - 'A' + 1: // readline ^B
		if (g_cursor > 0)
		{
			g_cursor--;
			g_needInputRender = true;
		}
		break;

	case KEY_RIGHT:
	case 'F' - 'A' + 1: // readline ^F
		if (g_cursor < current_input().length())
		{
			g_cursor++;
			g_needInputRender = true;
		}
		break;

	case KEY_DOWN:
	case KEY_UP:
		move_input_cursor (ch == KEY_DOWN ? -1 : 1);
		break;

	case KEY_HOME:
	case 'A' - 'A' + 1: // readline ^A
		if (g_cursor != 0)
		{
			g_cursor = 0;
			g_needInputRender = true;
		}
		break;

	case KEY_END:
	case 'E' - 'A' + 1: // readline ^E
		if (g_cursor != current_input().length())
		{
			g_cursor = current_input().length();
			g_needInputRender = true;
		}
		break;

	case KEY_BACKSPACE:
		if (g_cursor > 0)
		{
			mutable_current_input().remove_at (--g_cursor);
			g_needInputRender = true;
		}
		break;

	case KEY_DC:
	case 'D' - 'A' + 1: // readline ^D
		if (g_cursor < current_input().length())
		{
			mutable_current_input().remove_at (g_cursor);
			g_needInputRender = true;
		}
		break;

	case KEY_PPAGE:
		g_outputScroll += min (g_pageSize, LINES / 2);
		g_needOutputRender = true;
		break;

	case KEY_NPAGE:
		g_outputScroll -= min (g_pageSize, LINES / 2);
		g_needOutputRender = true;
		break;

	case 'U' - 'A' + 1: // readline ^U - delete from start to cursor
		if (g_cursor > 0)
		{
			mutable_current_input().remove (0, g_cursor);
			g_cursor = 0;
			g_needInputRender = true;
		}
		break;

	case 'K' - 'A' + 1: // readline ^K - delete from cursor to end
		if (g_cursor < current_input().length())
		{
			String& input = mutable_current_input();
			input.remove (g_cursor, input.length() - g_cursor);
			g_needInputRender = true;
		}
		break;

	case 'W' - 'A' + 1: // readline ^W - delete from previous word bounary to current
		{
			int start = interface_find_previous_word();

			if (start != g_cursor)
			{
				mutable_current_input().remove (start, g_cursor - start);
				g_cursor = start;
				g_needInputRender = true;
			}
		}
		break;

	case '\n':
	case KEY_ENTER:
		switch (g_inputState)
		{
		case INPUTSTATE_CONFIRM_DISCONNECTION:
			break; // handled above

		case INPUTSTATE_ADDRESS:
			try
			{
				g_address = IPAddress::from_string (current_input());
			}
			catch (std::exception& e)
			{
				print (e.what());
				return;
			}

			if (g_address.port == 0)
				g_address.port = 10666;

			set_input_state (INPUTSTATE_PASSWORD);
			break;

		case INPUTSTATE_PASSWORD:
			if (g_inputState == INPUTSTATE_PASSWORD and not current_input().is_empty())
			{
				RCONSession* session = RCONSession::new_session();
				session->set_password (current_input());
				session->connect (g_address);
				set_input_state (INPUTSTATE_NORMAL);
			}
			break;

		case INPUTSTATE_NORMAL:
			if (RCONSession::get_session()->send_command (current_input()))
			{
				g_input.insert (0, "");
				g_needInputRender = true;
			}
			break;
		}
		break;

	case 'N' - 'A' + 1: // ^N
		if (g_inputState == INPUTSTATE_NORMAL)
			safe_disconnect ([]() {set_input_state (INPUTSTATE_ADDRESS);});
		break;

	case '\e': // Escape
		// We may have an alt key coming
		ch = ::getch();

		if (ch != ERR)
		{
			switch (ch)
			{
			case 'b':
			case 'B':
				// readline alt-b - move one word to the left
				g_cursor = interface_find_previous_word();
				g_needInputRender = true;
				break;

			case 'f':
			case 'F':
				// readline alt-f - move one word to the right
				g_cursor = interface_find_next_word();
				g_needInputRender = true;
				break;

			case 'd':
			case 'D':
				// readline alt-d - delete from here till next word boundary
				mutable_current_input().remove (g_cursor, interface_find_next_word() - g_cursor);
				g_needInputRender = true;
				break;
			}
		}
		else
		{
			// No alt-key, handle pure escape
			if (g_inputState == INPUTSTATE_PASSWORD)
				set_input_state (INPUTSTATE_ADDRESS);
			else if (g_inputState == INPUTSTATE_ADDRESS)
				set_input_state (INPUTSTATE_NORMAL);
		}
		break;
	}
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::render() -> void
{
	if (g_needStatusBarRender) interface_render_statusbar();
	if (g_needInputRender) interface_render_input();
	if (g_needOutputRender) interface_render_output();
	if (g_needNicklistRender) interface_render_nicklist();

	if (g_needRefresh)
	{
		interface_position_cursor();
		refresh();
		g_needRefresh = false;
	}
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION print_to_console (String a) -> void
{
	// Zandronum is retarded and SOMETIMES sends color codes as "\\c" and sometimes as "\x1C".
	// Let's correct that on our end and HOPE this won't cause conflicts.
	a.replace ("\\c", "\x1C");

	for (char ch : a)
	{
		if (ch == '\n')
		{
			g_output[g_output.size() - 1].finalize();
			g_output << ColoredLine();
			continue;
		}

		g_output[g_output.size() - 1].add_char (ch);
	}

	g_needOutputRender = true;
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::connect (String address, String password) -> void
{
	try
	{
		g_address = IPAddress::from_string (address);
	}
	catch (std::exception& e)
	{
		print (e.what());
		return;
	}

	if (g_address.port == 0)
		g_address.port = 10666;

	RCONSession* session = RCONSession::new_session();
	session->set_password (password);
	session->connect (g_address);
}

// -------------------------------------------------------------------------------------------------
//
FUNCTION
Interface::set_player_names (const StringList& names) -> void
{
	g_playerNames = names;
	g_needNicklistRender = true;
}