X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fserver%2Ftelnet_server.c;h=4fc71f384e26a693e9bc0dc5d538811da732065d;hp=acb57efd10b6bf06c083cdf6442182e914f19366;hb=822097a351f8aef0036359bc3f4ad3972c1ddbe3;hpb=5ba8e365d9f02b7cb4a316959e0c8b39274f9d83

diff --git a/src/server/telnet_server.c b/src/server/telnet_server.c
index acb57efd10..4fc71f384e 100644
--- a/src/server/telnet_server.c
+++ b/src/server/telnet_server.c
@@ -150,7 +150,7 @@ static void telnet_load_history(struct telnet_connection *t_con)
 
 	char *history = get_home_dir(TELNET_HISTORY);
 
-	if (history == NULL) {
+	if (!history) {
 		LOG_INFO("unable to get user home directory, telnet history will be disabled");
 		return;
 	}
@@ -159,7 +159,7 @@ static void telnet_load_history(struct telnet_connection *t_con)
 
 	if (histfp) {
 
-		while (fgets(buffer, sizeof(buffer), histfp) != NULL) {
+		while (fgets(buffer, sizeof(buffer), histfp)) {
 
 			char *p = strchr(buffer, '\n');
 			if (p)
@@ -186,7 +186,7 @@ static void telnet_save_history(struct telnet_connection *t_con)
 
 	char *history = get_home_dir(TELNET_HISTORY);
 
-	if (history == NULL) {
+	if (!history) {
 		LOG_INFO("unable to get user home directory, telnet history will be disabled");
 		return;
 	}
@@ -199,7 +199,7 @@ static void telnet_save_history(struct telnet_connection *t_con)
 		i = t_con->current_history + 1;
 		i %= TELNET_LINE_HISTORY_SIZE;
 
-		while (t_con->history[i] == NULL && num > 0) {
+		while (!t_con->history[i] && num > 0) {
 			i++;
 			i %= TELNET_LINE_HISTORY_SIZE;
 			num--;
@@ -222,9 +222,8 @@ static int telnet_new_connection(struct connection *connection)
 {
 	struct telnet_connection *telnet_connection;
 	struct telnet_service *telnet_service = connection->service->priv;
-	int i;
 
-	telnet_connection = malloc(sizeof(struct telnet_connection));
+	telnet_connection = calloc(1, sizeof(struct telnet_connection));
 
 	if (!telnet_connection) {
 		LOG_ERROR("Failed to allocate telnet connection.");
@@ -234,9 +233,6 @@ static int telnet_new_connection(struct connection *connection)
 	connection->priv = telnet_connection;
 
 	/* initialize telnet connection information */
-	telnet_connection->closed = false;
-	telnet_connection->line_size = 0;
-	telnet_connection->line_cursor = 0;
 	telnet_connection->prompt = strdup("> ");
 	telnet_connection->prompt_visible = true;
 	telnet_connection->state = TELNET_STATE_DATA;
@@ -257,11 +253,6 @@ static int telnet_new_connection(struct connection *connection)
 	telnet_write(connection, "\r", 1);
 	telnet_prompt(connection);
 
-	/* initialize history */
-	for (i = 0; i < TELNET_LINE_HISTORY_SIZE; i++)
-		telnet_connection->history[i] = NULL;
-	telnet_connection->next_history = 0;
-	telnet_connection->current_history = 0;
 	telnet_load_history(telnet_connection);
 
 	log_add_callback(telnet_log_callback, connection);
@@ -320,6 +311,32 @@ static void telnet_history_down(struct connection *connection)
 	telnet_history_go(connection, next_history);
 }
 
+static void telnet_history_add(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+
+	/* save only non-blank not repeating lines in the history */
+	char *prev_line = t_con->history[(t_con->current_history > 0) ?
+			t_con->current_history - 1 : TELNET_LINE_HISTORY_SIZE-1];
+
+	if (*t_con->line && (!prev_line || strcmp(t_con->line, prev_line))) {
+		/* if the history slot is already taken, free it */
+		free(t_con->history[t_con->next_history]);
+
+		/* add line to history */
+		t_con->history[t_con->next_history] = strdup(t_con->line);
+
+		/* wrap history at TELNET_LINE_HISTORY_SIZE */
+		t_con->next_history = (t_con->next_history + 1) % TELNET_LINE_HISTORY_SIZE;
+
+		/* current history line starts at the new entry */
+		t_con->current_history = t_con->next_history;
+
+		free(t_con->history[t_con->current_history]);
+		t_con->history[t_con->current_history] = strdup("");
+	}
+}
+
 static int telnet_history_print(struct connection *connection)
 {
 	struct telnet_connection *tc;
@@ -352,10 +369,14 @@ static int telnet_history_print(struct connection *connection)
 
 static void telnet_move_cursor(struct connection *connection, size_t pos)
 {
-	struct telnet_connection *tc;
+	struct telnet_connection *tc = connection->priv;
 	size_t tmp;
 
-	tc = connection->priv;
+	if (pos == tc->line_cursor) /* nothing to do */
+		return;
+
+	if (pos > tc->line_size) /* out of bounds */
+		return;
 
 	if (pos < tc->line_cursor) {
 		tmp = tc->line_cursor - pos;
@@ -419,6 +440,137 @@ static bool telnet_insert(struct connection *connection, const void *data, size_
 	return true;
 }
 
+static void telnet_delete_character(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+
+	if (t_con->line_cursor == 0)
+		return;
+
+	if (t_con->line_cursor != t_con->line_size) {
+		size_t i;
+		telnet_write(connection, "\b", 1);
+		t_con->line_cursor--;
+		t_con->line_size--;
+		memmove(t_con->line + t_con->line_cursor,
+				t_con->line + t_con->line_cursor + 1,
+				t_con->line_size -
+				t_con->line_cursor);
+
+		telnet_write(connection,
+				t_con->line + t_con->line_cursor,
+				t_con->line_size -
+				t_con->line_cursor);
+		telnet_write(connection, " \b", 2);
+		for (i = t_con->line_cursor; i < t_con->line_size; i++)
+			telnet_write(connection, "\b", 1);
+	} else {
+		t_con->line_size--;
+		t_con->line_cursor--;
+		/* back space: move the 'printer' head one char
+		 * back, overwrite with space, move back again */
+		telnet_write(connection, "\b \b", 3);
+	}
+}
+
+static void telnet_remove_character(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+
+	if (t_con->line_cursor < t_con->line_size) {
+		size_t i;
+		t_con->line_size--;
+		/* remove char from line buffer */
+		memmove(t_con->line + t_con->line_cursor,
+				t_con->line + t_con->line_cursor + 1,
+				t_con->line_size - t_con->line_cursor);
+
+		/* print remainder of buffer */
+		telnet_write(connection, t_con->line + t_con->line_cursor,
+				t_con->line_size - t_con->line_cursor);
+		/* overwrite last char with whitespace */
+		telnet_write(connection, " \b", 2);
+
+		/* move back to cursor position*/
+		for (i = t_con->line_cursor; i < t_con->line_size; i++)
+			telnet_write(connection, "\b", 1);
+	}
+}
+
+static int telnet_exec_line(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+	struct command_context *command_context = connection->cmd_ctx;
+	int retval;
+
+	telnet_write(connection, "\r\n\x00", 3);
+
+	if (strcmp(t_con->line, "history") == 0) {
+		retval = telnet_history_print(connection);
+
+		if (retval != ERROR_OK)
+			return retval;
+
+		return ERROR_OK;
+	}
+
+	telnet_history_add(connection);
+
+	t_con->line_size = 0;
+
+	/* to suppress prompt in log callback during command execution */
+	t_con->prompt_visible = false;
+
+	if (strcmp(t_con->line, "shutdown") == 0)
+		telnet_save_history(t_con);
+
+	retval = command_run_line(command_context, t_con->line);
+
+	t_con->line_cursor = 0;
+	t_con->prompt_visible = true;
+
+	if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
+		return ERROR_SERVER_REMOTE_CLOSED;
+
+	/* the prompt is always placed at the line beginning */
+	telnet_write(connection, "\r", 1);
+
+	retval = telnet_prompt(connection);
+	if (retval == ERROR_SERVER_REMOTE_CLOSED)
+		return ERROR_SERVER_REMOTE_CLOSED;
+
+	return ERROR_OK;
+}
+
+static void telnet_cut_line_to_end(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+
+	/* FIXME: currently this function does not save to clipboard */
+
+	if (t_con->line_cursor < t_con->line_size) {
+		/* overwrite with space, until end of line, move back */
+		for (size_t i = t_con->line_cursor; i < t_con->line_size; i++)
+			telnet_write(connection, " ", 1);
+		for (size_t i = t_con->line_cursor; i < t_con->line_size; i++)
+			telnet_write(connection, "\b", 1);
+		t_con->line[t_con->line_cursor] = '\0';
+		t_con->line_size = t_con->line_cursor;
+	}
+}
+
+static void telnet_interrupt(struct connection *connection)
+{
+	struct telnet_connection *t_con = connection->priv;
+
+	/* print '^C' at line end, and display a new command prompt */
+	telnet_move_cursor(connection, t_con->line_size);
+	telnet_write(connection, "^C\n\r", 4);
+	t_con->line_cursor = 0;
+	t_con->line_size = 0;
+	telnet_prompt(connection);
+}
+
 static void telnet_auto_complete(struct connection *connection)
 {
 	struct telnet_connection *t_con = connection->priv;
@@ -431,16 +583,30 @@ static void telnet_auto_complete(struct connection *connection)
 
 	LIST_HEAD(matches);
 
-	/* user command sequence, either at line beginning
-	 * or we start over after these characters ';', '[', '{' */
+	/* - user command sequence, either at line beginning
+	 *   or we start over after these characters ';', '[', '{'
+	 * - user variable sequence, start after the character '$'
+	 *   and do not contain white spaces */
+	bool is_variable_auto_completion = false;
+	bool have_spaces = false;
 	size_t seq_start = (t_con->line_cursor == 0) ? 0 : (t_con->line_cursor - 1);
-	while (seq_start > 0) {
+	while (1) {
 		char c = t_con->line[seq_start];
+
 		if (c == ';' || c == '[' || c == '{') {
 			seq_start++;
 			break;
+		} else if (c == ' ') {
+			have_spaces = true;
+		} else if (c == '$' && !have_spaces) {
+			is_variable_auto_completion = true;
+			seq_start++;
+			break;
 		}
 
+		if (seq_start == 0)
+			break;
+
 		seq_start--;
 	}
 
@@ -470,7 +636,12 @@ static void telnet_auto_complete(struct connection *connection)
 	query[usr_cmd_len] = '\0';
 
 	/* filter commands */
-	char *query_cmd = alloc_printf("_telnet_autocomplete_helper {%s*}", query);
+	char *query_cmd;
+
+	if (is_variable_auto_completion)
+		query_cmd = alloc_printf("lsort [info vars {%s*}]", query);
+	else
+		query_cmd = alloc_printf("_telnet_autocomplete_helper {%s*}", query);
 
 	if (!query_cmd) {
 		LOG_ERROR("Out of memory");
@@ -498,24 +669,22 @@ static void telnet_auto_complete(struct connection *connection)
 
 		/* validate the command */
 		bool ignore_cmd = false;
-		Jim_Cmd *jim_cmd = Jim_GetCommand(command_context->interp, elem, JIM_NONE);
-
-		if (!jim_cmd)
-			ignore_cmd = true;
-		else {
-			if (!jim_cmd->isproc) {
-				/* ignore commands without handler
-				 * and those with COMMAND_CONFIG mode */
-				/* FIXME it's better to use jimcmd_is_ocd_command(jim_cmd)
-				 * or command_find_from_name(command_context->interp, name) */
-				struct command *cmd = jim_cmd->u.native.privData;
-				if (!cmd)
-					ignore_cmd = true;
-				/* make Valgrind happy by checking that cmd is not NULL  */
-				else if (cmd != NULL && !cmd->handler && !cmd->jim_handler)
+		if (!is_variable_auto_completion) {
+			Jim_Cmd *jim_cmd = Jim_GetCommand(command_context->interp, elem, JIM_NONE);
+
+			if (!jim_cmd) {
+				/* Why we are here? Let's ignore it! */
+				ignore_cmd = true;
+			} else if (jimcmd_is_oocd_command(jim_cmd)) {
+				struct command *cmd = jimcmd_privdata(jim_cmd);
+
+				if (cmd && !cmd->handler && !cmd->jim_handler) {
+					/* Initial part of a multi-word command. Ignore it! */
 					ignore_cmd = true;
-				else if (cmd != NULL && cmd->mode == COMMAND_CONFIG)
+				} else if (cmd && cmd->mode == COMMAND_CONFIG) {
+					/* Not executable after config phase. Ignore it! */
 					ignore_cmd = true;
+				}
 			}
 		}
 
@@ -591,7 +760,6 @@ static int telnet_input(struct connection *connection)
 	unsigned char buffer[TELNET_BUFFER_SIZE];
 	unsigned char *buf_p;
 	struct telnet_connection *t_con = connection->priv;
-	struct command_context *command_context = connection->cmd_ctx;
 
 	bytes_read = connection_read(connection, buffer, TELNET_BUFFER_SIZE);
 
@@ -606,16 +774,16 @@ static int telnet_input(struct connection *connection)
 	while (bytes_read) {
 		switch (t_con->state) {
 			case TELNET_STATE_DATA:
-				if (*buf_p == 0xff)
+				if (*buf_p == 0xff) {
 					t_con->state = TELNET_STATE_IAC;
-				else {
+				} else {
 					if (isprint(*buf_p)) {	/* printable character */
 						telnet_insert(connection, buf_p, 1);
-					} else {	/* non-printable */
+					} else { /* non-printable */
 						if (*buf_p == 0x1b) {	/* escape */
 							t_con->state = TELNET_STATE_ESCAPE;
 							t_con->last_escape = '\x00';
-						} else if ((*buf_p == 0xd) || (*buf_p == 0xa)) {	/* CR/LF */
+						} else if ((*buf_p == 0xd) || (*buf_p == 0xa)) { /* CR/LF */
 							int retval;
 
 							/* skip over combinations with CR/LF and NUL characters */
@@ -630,124 +798,36 @@ static int telnet_input(struct connection *connection)
 							}
 							t_con->line[t_con->line_size] = 0;
 
-							telnet_write(connection, "\r\n\x00", 3);
-
-							if (strcmp(t_con->line, "history") == 0) {
-								retval = telnet_history_print(connection);
-
-								if (retval != ERROR_OK)
-									return retval;
-
-								continue;
-							}
-
-							/* save only non-blank not repeating lines in the history */
-							char *prev_line = t_con->history[(t_con->current_history > 0) ?
-									t_con->current_history - 1 : TELNET_LINE_HISTORY_SIZE-1];
-							if (*t_con->line && (prev_line == NULL ||
-									strcmp(t_con->line, prev_line))) {
-								/* if the history slot is already taken, free it */
-								free(t_con->history[t_con->next_history]);
-
-								/* add line to history */
-								t_con->history[t_con->next_history] = strdup(t_con->line);
-
-								/* wrap history at TELNET_LINE_HISTORY_SIZE */
-								t_con->next_history = (t_con->next_history + 1) %
-										TELNET_LINE_HISTORY_SIZE;
-
-								/* current history line starts at the new entry */
-								t_con->current_history =
-										t_con->next_history;
-
-								free(t_con->history[t_con->current_history]);
-								t_con->history[t_con->current_history] = strdup("");
-							}
-
-							t_con->line_size = 0;
-
-							/* to suppress prompt in log callback during command execution */
-							t_con->prompt_visible = false;
-
-							if (strcmp(t_con->line, "shutdown") == 0)
-								telnet_save_history(t_con);
-
-							retval = command_run_line(command_context, t_con->line);
-
-							t_con->line_cursor = 0;
-							t_con->prompt_visible = true;
-
-							if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
-								return ERROR_SERVER_REMOTE_CLOSED;
-
-							/* the prompt is always * placed at the line beginning */
-							telnet_write(connection, "\r", 1);
-
-							retval = telnet_prompt(connection);
-							if (retval == ERROR_SERVER_REMOTE_CLOSED)
-								return ERROR_SERVER_REMOTE_CLOSED;
-
+							retval = telnet_exec_line(connection);
+							if (retval != ERROR_OK)
+								return retval;
 						} else if ((*buf_p == 0x7f) || (*buf_p == 0x8)) {	/* delete character */
-							if (t_con->line_cursor > 0) {
-								if (t_con->line_cursor != t_con->line_size) {
-									size_t i;
-									telnet_write(connection, "\b", 1);
-									t_con->line_cursor--;
-									t_con->line_size--;
-									memmove(t_con->line + t_con->line_cursor,
-											t_con->line + t_con->line_cursor + 1,
-											t_con->line_size -
-											t_con->line_cursor);
-
-									telnet_write(connection,
-											t_con->line + t_con->line_cursor,
-											t_con->line_size -
-											t_con->line_cursor);
-									telnet_write(connection, " \b", 2);
-									for (i = t_con->line_cursor; i < t_con->line_size; i++)
-										telnet_write(connection, "\b", 1);
-								} else {
-									t_con->line_size--;
-									t_con->line_cursor--;
-									/* back space: move the 'printer' head one char
-									 * back, overwrite with space, move back again */
-									telnet_write(connection, "\b \b", 3);
-								}
-							}
-						} else if (*buf_p == 0x15) /* clear line */
+							telnet_delete_character(connection);
+						} else if (*buf_p == 0x15) {	/* clear line */
 							telnet_clear_line(connection, t_con);
-						else if (*buf_p == CTRL('B')) {	/* cursor left */
-							if (t_con->line_cursor > 0) {
-								telnet_write(connection, "\b", 1);
-								t_con->line_cursor--;
-							}
+						} else if (*buf_p == CTRL('B')) {	/* cursor left */
+							telnet_move_cursor(connection, t_con->line_cursor - 1);
 							t_con->state = TELNET_STATE_DATA;
+						} else if (*buf_p == CTRL('C')) {	/* interrupt */
+							telnet_interrupt(connection);
 						} else if (*buf_p == CTRL('F')) {	/* cursor right */
-							if (t_con->line_cursor < t_con->line_size)
-								telnet_write(connection, t_con->line + t_con->line_cursor++, 1);
+							telnet_move_cursor(connection, t_con->line_cursor + 1);
 							t_con->state = TELNET_STATE_DATA;
-						} else if (*buf_p == CTRL('P'))		/* cursor up */
+						} else if (*buf_p == CTRL('P')) {	/* cursor up */
 							telnet_history_up(connection);
-						else if (*buf_p == CTRL('N'))		/* cursor down */
+						} else if (*buf_p == CTRL('N')) {	/* cursor down */
 							telnet_history_down(connection);
-						else if (*buf_p == CTRL('A'))
+						} else if (*buf_p == CTRL('A')) {	/* move the cursor to the beginning of the line */
 							telnet_move_cursor(connection, 0);
-						else if (*buf_p == CTRL('E'))
+						} else if (*buf_p == CTRL('E')) {	/* move the cursor to the end of the line */
 							telnet_move_cursor(connection, t_con->line_size);
-						else if (*buf_p == CTRL('K')) {         /* kill line to end */
-							if (t_con->line_cursor < t_con->line_size) {
-								/* overwrite with space, until end of line, move back */
-								for (size_t i = t_con->line_cursor; i < t_con->line_size; i++)
-									telnet_write(connection, " ", 1);
-								for (size_t i = t_con->line_cursor; i < t_con->line_size; i++)
-									telnet_write(connection, "\b", 1);
-								t_con->line[t_con->line_cursor] = '\0';
-								t_con->line_size = t_con->line_cursor;
-							}
-						} else if (*buf_p == '\t')
+						} else if (*buf_p == CTRL('K')) {	/* kill line to end */
+							telnet_cut_line_to_end(connection);
+						} else if (*buf_p == '\t') {
 							telnet_auto_complete(connection);
-						else
+						} else {
 							LOG_DEBUG("unhandled nonprintable: %2.2x", *buf_p);
+						}
 					}
 				}
 				break;
@@ -780,15 +860,10 @@ static int telnet_input(struct connection *connection)
 			case TELNET_STATE_ESCAPE:
 				if (t_con->last_escape == '[') {
 					if (*buf_p == 'D') {	/* cursor left */
-						if (t_con->line_cursor > 0) {
-							telnet_write(connection, "\b", 1);
-							t_con->line_cursor--;
-						}
+						telnet_move_cursor(connection, t_con->line_cursor - 1);
 						t_con->state = TELNET_STATE_DATA;
 					} else if (*buf_p == 'C') {	/* cursor right */
-						if (t_con->line_cursor < t_con->line_size)
-							telnet_write(connection,
-									t_con->line + t_con->line_cursor++, 1);
+						telnet_move_cursor(connection, t_con->line_cursor + 1);
 						t_con->state = TELNET_STATE_DATA;
 					} else if (*buf_p == 'A') {	/* cursor up */
 						telnet_history_up(connection);
@@ -800,32 +875,15 @@ static int telnet_input(struct connection *connection)
 					} else if (*buf_p == 'H') { /* home key */
 						telnet_move_cursor(connection, 0);
 						t_con->state = TELNET_STATE_DATA;
-					} else if (*buf_p == '3')
+					} else if (*buf_p == '3') {
 						t_con->last_escape = *buf_p;
-					else
+					} else {
 						t_con->state = TELNET_STATE_DATA;
+					}
 				} else if (t_con->last_escape == '3') {
 					/* Remove character */
 					if (*buf_p == '~') {
-						if (t_con->line_cursor < t_con->line_size) {
-							size_t i;
-							t_con->line_size--;
-							/* remove char from line buffer */
-							memmove(t_con->line + t_con->line_cursor,
-									t_con->line + t_con->line_cursor + 1,
-									t_con->line_size - t_con->line_cursor);
-
-							/* print remainder of buffer */
-							telnet_write(connection, t_con->line + t_con->line_cursor,
-									t_con->line_size - t_con->line_cursor);
-							/* overwrite last char with whitespace */
-							telnet_write(connection, " \b", 2);
-
-							/* move back to cursor position*/
-							for (i = t_con->line_cursor; i < t_con->line_size; i++)
-								telnet_write(connection, "\b", 1);
-						}
-
+						telnet_remove_character(connection);
 						t_con->state = TELNET_STATE_DATA;
 					} else
 						t_con->state = TELNET_STATE_DATA;
@@ -879,6 +937,15 @@ static int telnet_connection_closed(struct connection *connection)
 	return ERROR_OK;
 }
 
+static const struct service_driver telnet_service_driver = {
+	.name = "telnet",
+	.new_connection_during_keep_alive_handler = NULL,
+	.new_connection_handler = telnet_new_connection,
+	.input_handler = telnet_input,
+	.connection_closed_handler = telnet_connection_closed,
+	.keep_client_alive_handler = NULL,
+};
+
 int telnet_init(char *banner)
 {
 	if (strcmp(telnet_port, "disabled") == 0) {
@@ -896,8 +963,7 @@ int telnet_init(char *banner)
 
 	telnet_service->banner = banner;
 
-	int ret = add_service("telnet", telnet_port, CONNECTION_LIMIT_UNLIMITED,
-		telnet_new_connection, telnet_input, telnet_connection_closed,
+	int ret = add_service(&telnet_service_driver, telnet_port, CONNECTION_LIMIT_UNLIMITED,
 		telnet_service);
 
 	if (ret != ERROR_OK) {