kresc.c 9.8 KB
Newer Older
1
/*  Copyright (C) 2016-2017 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
2 3 4 5 6 7 8 9 10 11 12 13 14 15

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
16
#include <arpa/inet.h>
17
#include <assert.h>
18
#include <contrib/ccan/asprintf/asprintf.h>
19
#include <editline/readline.h>
20
#include <errno.h>
21
#include <histedit.h>
22 23 24 25
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
26
#include <string.h>
27
#include <sys/socket.h>
28
#include <sys/stat.h>
29 30 31
#include <sys/types.h>
#include <sys/un.h>

32
#define HISTORY_FILE "kresc_history"
33 34
#define PROGRAM_NAME "kresc"

35 36
FILE *g_tty = NULL;		//!< connection to the daemon

37
static char *run_cmd(const char *cmd, size_t * msg_len);
38

39
const char *prompt(EditLine * e)
40 41 42 43 44 45 46 47 48 49 50
{
	return PROGRAM_NAME "> ";
}

bool starts_with(const char *a, const char *b)
{
	if (strncmp(a, b, strlen(b)) == 0)
		return 1;
	return 0;
}

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
//! Returns Lua name of type of value, NULL on error. Puts length of type in name_len;
const char *get_type_name(const char *value)
{
	if (value == NULL) {
		return NULL;
	}

	for (int i = 0; value[i]; i++) {
		if (value[i] == ')') {
			//Return NULL to prevent unexpected function call
			return NULL;
		}
	}

	char *cmd = afmt("type(%s)", value);

	if (!cmd) {
		perror("While tab-completing.");
		return NULL;
	}

	size_t name_len;
	char *type = run_cmd(cmd, &name_len);
	if (!type) {
		return NULL;
	} else {
		free(cmd);
	}

	if (starts_with(type, "[")) {
		//Return "nil" on non-valid name.
		return "nil";
	} else {
		type[(strlen(type)) - 1] = '\0';
		return type;
	}
}

89 90 91 92 93 94 95
static unsigned char complete(EditLine * el, int ch)
{
	int argc, pos;
	const char **argv;
	const LineInfo *li = el_line(el);
	Tokenizer *tok = tok_init(NULL);

96 97
	//Tokenize current line.
	int ret = tok_line(tok, li, &argc, &argv, NULL, &pos);
98

99 100 101 102 103 104 105 106 107 108 109 110 111 112
	if (ret != 0) {
		perror("While tab-completing.");
		goto complete_exit;
	}
	//Show help.
	if (argc == 0) {
		size_t help_len;
		char *help = run_cmd("help()", &help_len);
		if (help) {
			printf("\n%s", help);
			free(help);
		} else {
			perror("While communication with daemon");
		}
113 114 115
		goto complete_exit;
	}

116
	if (argc > 1) {
117 118
		goto complete_exit;
	}
119 120
	//Get name of type of current line.
	const char *type = get_type_name(argv[0]);
121

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
	if (!type) {
		goto complete_exit;
	}
	//Get position of last dot in current line (useful for parsing table).
	char *dot = strrchr(argv[0], '.');

	//Line is not a name of some table and there is no dot in it.
	if (strncmp(type, "table", 5) && !dot) {
		//Parse Lua globals.
		size_t globals_len;
		char *globals = run_cmd("_G.__orig_name_list", &globals_len);
		if (!globals) {
			perror("While tab-completing");
			goto complete_exit;
		}
		//Show possible globals.
		char *globals_tok = strdup(globals);
		free(globals);
		if (!globals_tok) {
			goto complete_exit;
		}
		char *token = strtok(globals_tok, "\n");
		int matches = 0;
		char *lastmatch;
		while (token) {
			if (argv[0] && starts_with(token, argv[0])) {
				printf("\n%s (%s)", token,
				       get_type_name(token));
				fflush(stdout);
				lastmatch = token;
152 153
				matches++;
			}
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
			token = strtok(NULL, "\n");
		}
		if (matches > 1) {
			printf("\n");
		}
		//Complete matching global.
		if (matches == 1) {
			el_deletestr(el, pos);
			el_insertstr(el, lastmatch);
			pos = strlen(lastmatch);
		}
		free(globals_tok);

		//Current line (or part of it) is a name of some table.
	} else if ((dot && !strncmp(type, "nil", 3))
		   || !strncmp(type, "table", 5)) {
		char *table = strdup(argv[0]);
		if (!table) {
			perror("While tab-completing");
			goto complete_exit;
		}
		//Get only the table name (without partial member name).
		if (dot) {
			*(table + (dot - argv[0])) = '\0';
		}
		//Insert a dot after the table name.
		if (!strncmp(type, "table", 5)) {
181
			el_insertstr(el, ".");
182
			pos++;
183
		}
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
		//Check if the substring before dot is a valid table name.
		const char *t_type = get_type_name(table);
		if (t_type && !strncmp("table", t_type, 5)) {
			//Get string of members of the table.
			char *cmd =
			    afmt
			    ("do local s=\"\"; for i in pairs(%s) do s=s..i..\"\\n\" end return(s) end",
			     table);
			if (!cmd) {
				perror("While tab-completing.");
				goto complete_exit;
			}
			size_t members_len;
			char *members = run_cmd(cmd, &members_len);
			free(cmd);
			if (!members) {
				perror("While communication with daemon");
			}
			//Split members by newline.
			char *members_tok = strdup(members);
			free(members);
			if (!members_tok) {
				goto complete_exit;
			}
			char *token = strtok(members_tok, "\n");
			int matches = 0;
			char *lastmatch;
			if (!dot || dot - argv[0] + 1 == strlen(argv[0])) {
				//Prints all members.
				while (token) {
					char *member =
					    afmt("%s.%s", table, token);
					printf("\n%s (%s)", member,
					       get_type_name(member));
					token = strtok(NULL, "\n");
					matches++;
				}
			} else {
				//Print members matching the current line.
				while (token) {
					if (argv[0]
					    && starts_with(token, dot + 1)) {
						printf("\n%s.%s (%s)", table,
						       token,
						       get_type_name(afmt
								     ("%s.%s",
								      table,
								      token)));
						lastmatch = token;
						matches++;
					}
					token = strtok(NULL, "\n");
				}

				//Complete matching member.
				if (matches == 1) {
					el_deletestr(el, pos);
					el_insertstr(el, table);
					el_insertstr(el, ".");
					el_insertstr(el, lastmatch);
					pos =
					    strlen(lastmatch) + strlen(table) +
					    1;
				}
			}
			if (matches > 1) {
				printf("\n");
			}
			free(members_tok);
		}
	} else if (!strncmp(type, "function", 8)) {
		//Add left parenthesis to function name. 
		el_insertstr(el, "(");
		pos++;
258 259 260 261 262 263 264 265
	}

complete_exit:
	tok_reset(tok);
	tok_end(tok);
	return CC_REDISPLAY;
}

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
//! Initialize connection to the daemon; return 0 on success.
static int init_tty(const char *path)
{
	int fd = socket(AF_UNIX, SOCK_STREAM, 0);
	if (fd < 0)
		return 1;

	struct sockaddr_un addr;
	addr.sun_family = AF_UNIX;
	size_t plen = strlen(path);
	if (plen + 1 > sizeof(addr.sun_path)) {
		fprintf(stderr, "Path too long\n");
		return 1;
	}
	memcpy(addr.sun_path, path, plen + 1);
	if (connect(fd, (const struct sockaddr *)&addr, sizeof(addr))) {
		perror("While connecting to daemon");
		return 1;
	}

	g_tty = fdopen(fd, "r+");
	if (!g_tty) {
		perror("While opening TTY");
		return 1;
	}
	// Switch to binary mode and consume the text "> ".
	if (fprintf(g_tty, "__binary\n") < 0 || !fread(&addr, 2, 1, g_tty)
	    || fflush(g_tty)) {
		perror("While initializing TTY");
		return 1;
	}

	return 0;
}

301 302
//! Run a command on the daemon; return the answer or NULL on failure, puts answer length to out_len.
static char *run_cmd(const char *cmd, size_t * out_len)
303 304 305 306 307 308 309 310 311 312
{
	if (!g_tty || !cmd) {
		assert(false);
		return NULL;
	}
	if (fprintf(g_tty, "%s", cmd) < 0 || fflush(g_tty))
		return NULL;
	uint32_t len;
	if (!fread(&len, sizeof(len), 1, g_tty))
		return NULL;
313
	len = ntohl(len);
314
	char *msg = malloc(1 + (size_t) len);
315 316
	if (!msg)
		return NULL;
317
	if (len && !fread(msg, len, 1, g_tty)) {
318 319 320
		free(msg);
		return NULL;
	}
321
	msg[len] = '\0';
322
	*out_len = len;
323 324 325 326 327
	return msg;
}

static int interact()
{
328 329 330 331 332 333
	EditLine *el;
	History *hist;
	int count;
	const char *line;
	HistEvent ev;
	el = el_init(PROGRAM_NAME, stdin, stdout, stderr);
334
	el_set(el, EL_PROMPT, prompt);
335 336 337 338 339 340 341 342 343 344 345 346 347
	el_set(el, EL_EDITOR, "emacs");
	el_set(el, EL_ADDFN, PROGRAM_NAME "-complete",
	       "Perform " PROGRAM_NAME " completion.", complete);
	el_set(el, EL_BIND, "^I", PROGRAM_NAME "-complete", NULL);

	hist = history_init();
	if (hist == 0) {
		perror("While initializing command history");
		return 1;
	}
	history(hist, &ev, H_SETSIZE, 800);
	el_set(el, EL_HIST, history, hist);

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	char *hist_file = NULL;

	char *data_home = getenv("XDG_DATA_HOME");

	//Check whether $XDG_DATA_HOME is set.
	if (!data_home || *data_home == '\0') {
		const char *home = getenv("HOME");	//This should be set on any POSIX compliant OS, even for nobody

		//Create necessary folders.
		char *dirs[3] =
		    { afmt("%s/.local", home), afmt("%s/.local/share", home),
			afmt("%s/.local/share/kresd/", home)
		};
		bool ok = true;
		for (int i = 0; i < 3; i++) {
			if (mkdir(dirs[i], 0755) && errno != EEXIST) {
				ok = false;
				break;
			}
		}
		if (ok) {
			hist_file =
			    afmt("%s/.local/share/kresd/" HISTORY_FILE, home);
		}
	} else {
		if (!mkdir(afmt("%s/kresd/", data_home), 0755)
		    || errno == EEXIST) {
			hist_file = afmt("%s/kresd/" HISTORY_FILE, data_home);
		}
	}

	//Load history file
	if (hist_file) {
		history(hist, &ev, H_LOAD, hist_file);
	} else {
		perror("While opening history file");
	}
385

386
	while (1) {
387 388 389
		line = el_gets(el, &count);
		if (count > 0) {
			history(hist, &ev, H_ENTER, line);
390
			size_t msg_len;
391 392 393 394 395 396 397 398 399 400 401 402
			char *msg = run_cmd(line, &msg_len);
			if (!msg) {
				perror("While communication with daemon");
				history_end(hist);
				el_end(el);
				free(msg);
				return 1;
			}
			printf("%s", msg);
			if (msg_len == 0 || msg[msg_len - 1] != '\n') {
				printf("\n");
			}
403 404 405
			if (hist_file) {
				history(hist, &ev, H_SAVE, hist_file);
			}
406
			free(msg);
407 408
		}
	}
409
	history_end(hist);
410
	free(hist_file);
411
	el_end(el);
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
	if (feof(stdin))
		return 0;
	perror("While reading input");
	return 1;
}

int main(int argc, char **argv)
{
	if (argc != 2) {
		fprintf(stderr, "Usage: %s tty/xxxxx\n", argv[0]);
		return 1;
	}

	int res = init_tty(argv[1]);

	if (!res)
		res = interact();

	if (g_tty)
		fclose(g_tty);
	return res;
}