2 * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file client.c The client program used to connect to para_server. */
13 #include "client.lsg.h"
22 #include "buffer_tree.h"
26 /** Array of error strings. */
29 static struct sched sched;
30 static struct client_task *ct;
31 static struct stdin_task sit;
32 static struct stdout_task sot;
34 static int client_loglevel = LL_ERROR;
35 DEFINE_STDERR_LOGGER(stderr_log, client_loglevel);
36 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
39 #include "interactive.h"
40 #include "server_cmd.lsg.h"
44 struct btr_node *btrn;
49 static void exec_pre_select(struct sched *s, void *context)
51 struct exec_task *et = context;
52 int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
58 static int exec_post_select(__a_unused struct sched *s, void *context)
60 struct exec_task *et = context;
61 struct btr_node *btrn = et->btrn;
66 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
69 sz = btr_next_buffer(btrn, &buf);
72 et->result_buf = para_realloc(et->result_buf, et->result_size + sz - 1);
73 memcpy(et->result_buf + et->result_size - 1, buf, sz - 1);
74 et->result_size += sz - 1;
75 et->result_buf[et->result_size - 1] = '\0';
77 btr_consume(btrn, sz);
81 /* Called from the line handler and the completers. This overwrites ct->lpr. */
82 static int create_merged_lpr(const char *line)
84 const struct lls_command *cmd = CLIENT_CMD_PTR;
86 char *cmdline, **argv, *errctx;
87 struct lls_parse_result *argv_lpr;
88 static struct lls_parse_result *orig_lpr;
93 cmdline = make_message("-- %s", line);
94 ret = create_shifted_argv(cmdline, " ", &argv);
99 if (argc == 2) { /* no words (only blanks in line) */
103 argv[0] = para_strdup("--");
105 * The original lpr for the interactive session has no non-option
106 * arguments. We create a fresh lpr from the words in "line" and merge
107 * it with the orignal lpr.
109 ret = lls(lls_parse(argc, argv, cmd, &argv_lpr, &errctx));
113 ret = lls(lls_merge(orig_lpr, argv_lpr, cmd, &ct->lpr, &errctx));
114 lls_free_parse_result(argv_lpr, cmd);
120 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
126 /* called from completers */
127 static int execute_client_command(const char *cmd, char **result)
130 struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
131 struct exec_task exec_task = {
132 .result_buf = para_strdup(""),
135 struct lls_parse_result *old_lpr = ct->lpr;
138 ret = create_merged_lpr(cmd);
141 exec_task.btrn = btr_new_node(&(struct btr_node_description)
142 EMBRACE(.name = "exec_collect"));
143 exec_task.task = task_register(&(struct task_info) {
144 .name = "client exec",
145 .pre_select = exec_pre_select,
146 .post_select = exec_post_select,
147 .context = &exec_task,
149 ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
152 schedule(&command_sched);
153 sched_shutdown(&command_sched);
154 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
156 *result = exec_task.result_buf;
157 btr_remove_node(&exec_task.btrn);
160 btr_remove_node(&exec_task.btrn);
162 free(exec_task.result_buf);
166 static int extract_matches_from_command(const char *word, char *cmd,
172 ret = execute_client_command(cmd, &buf);
175 ret = create_argv(buf, "\n", &sl);
179 ret = i9e_extract_completions(word, sl, matches);
184 static int complete_attributes(const char *word, char ***matches)
186 return extract_matches_from_command(word, "lsatt", matches);
189 static void complete_addblob(__a_unused const char *blob_type,
190 __a_unused struct i9e_completion_info *ci,
191 __a_unused struct i9e_completion_result *cr)
193 cr->filename_completion_desired = true;
196 static void generic_blob_complete(const char *blob_type,
197 struct i9e_completion_info *ci,
198 struct i9e_completion_result *cr)
201 sprintf(cmd, "ls%s", blob_type);
202 extract_matches_from_command(ci->word, cmd, &cr->matches);
205 static void complete_catblob(const char *blob_type,
206 struct i9e_completion_info *ci,
207 struct i9e_completion_result *cr)
209 generic_blob_complete(blob_type, ci, cr);
212 static void complete_lsblob(const char *blob_type,
213 struct i9e_completion_info *ci,
214 struct i9e_completion_result *cr)
216 char *opts[] = {LSG_SERVER_CMD_LSIMG_OPTS, NULL};
218 if (ci->word[0] == '-')
219 return i9e_complete_option(opts, ci, cr);
220 generic_blob_complete(blob_type, ci, cr);
223 static void complete_rmblob(const char *blob_type,
224 struct i9e_completion_info *ci,
225 struct i9e_completion_result *cr)
227 generic_blob_complete(blob_type, ci, cr);
230 static void complete_mvblob(const char *blob_type,
231 struct i9e_completion_info *ci,
232 struct i9e_completion_result *cr)
234 generic_blob_complete(blob_type, ci, cr);
237 /* these don't need any completions */
238 I9E_DUMMY_COMPLETER(ff);
239 I9E_DUMMY_COMPLETER(hup);
240 I9E_DUMMY_COMPLETER(jmp);
241 I9E_DUMMY_COMPLETER(next);
242 I9E_DUMMY_COMPLETER(nomore);
243 I9E_DUMMY_COMPLETER(pause);
244 I9E_DUMMY_COMPLETER(play);
245 I9E_DUMMY_COMPLETER(si);
246 I9E_DUMMY_COMPLETER(term);
247 I9E_DUMMY_COMPLETER(stop);
248 I9E_DUMMY_COMPLETER(addatt);
249 I9E_DUMMY_COMPLETER(init);
250 I9E_DUMMY_COMPLETER(tasks);
252 static struct i9e_completer completers[];
254 static void help_completer(struct i9e_completion_info *ci,
255 struct i9e_completion_result *result)
257 result->matches = i9e_complete_commands(ci->word, completers);
260 static void stat_completer(struct i9e_completion_info *ci,
261 struct i9e_completion_result *cr)
263 char *opts[] = {LSG_SERVER_CMD_STAT_OPTS, NULL};
264 i9e_complete_option(opts, ci, cr);
267 static void version_completer(struct i9e_completion_info *ci,
268 struct i9e_completion_result *cr)
270 char *opts[] = {LSG_SERVER_CMD_VERSION_OPTS, NULL};
271 i9e_complete_option(opts, ci, cr);
274 static void sender_completer(struct i9e_completion_info *ci,
275 struct i9e_completion_result *cr)
277 char *senders[] = {"http", "dccp", "udp", NULL};
278 char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
279 char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
280 char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
284 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
285 if (ci->word_num == 0 || ci->word_num > 3)
287 if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
288 i9e_extract_completions(ci->word, senders, &cr->matches);
291 sender = ci->argv[1];
292 //PARA_CRIT_LOG("sender: %s\n", sender);
293 if (strcmp(sender, "http") == 0)
295 else if (strcmp(sender, "dccp") == 0)
297 else if (strcmp(sender, "udp") == 0)
301 i9e_extract_completions(ci->word, cmds, &cr->matches);
304 static void add_completer(struct i9e_completion_info *ci,
305 struct i9e_completion_result *cr)
307 char *opts[] = {LSG_SERVER_CMD_ADD_OPTS, NULL};
309 if (ci->word[0] == '-')
310 i9e_complete_option(opts, ci, cr);
311 cr->filename_completion_desired = true;
314 static void ls_completer(struct i9e_completion_info *ci,
315 struct i9e_completion_result *cr)
317 char *opts[] = {LSG_SERVER_CMD_LS_OPTS, NULL};
318 if (ci->word[0] == '-')
319 i9e_complete_option(opts, ci, cr);
320 cr->filename_completion_desired = true;
323 static void setatt_completer(struct i9e_completion_info *ci,
324 struct i9e_completion_result *cr)
327 int i, ret, num_atts;
329 if (ci->word_num == 0)
332 if (*ci->word == '/' || *ci->word == '\0')
333 cr->filename_completion_desired = true;
334 if (*ci->word == '/')
336 ret = execute_client_command("lsatt", &buf);
339 ret = create_argv(buf, "\n", &sl);
343 sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
344 for (i = 0; i < num_atts; i++) {
346 sl[i] = make_message("%s+", orig);
347 sl[num_atts + i] = make_message("%s-", orig);
350 sl[2 * num_atts] = NULL;
351 i9e_extract_completions(ci->word, sl, &cr->matches);
357 static void lsatt_completer(struct i9e_completion_info *ci,
358 struct i9e_completion_result *cr)
360 char *opts[] = {LSG_SERVER_CMD_LSATT_OPTS, NULL};
361 i9e_complete_option(opts, ci, cr);
364 static void mvatt_completer(struct i9e_completion_info *ci,
365 struct i9e_completion_result *cr)
367 complete_attributes(ci->word, &cr->matches);
370 static void rmatt_completer(struct i9e_completion_info *ci,
371 struct i9e_completion_result *cr)
373 complete_attributes(ci->word, &cr->matches);
376 static void check_completer(struct i9e_completion_info *ci,
377 struct i9e_completion_result *cr)
379 char *opts[] = {LSG_SERVER_CMD_CHECK_OPTS, NULL};
380 i9e_complete_option(opts, ci, cr);
383 static void rm_completer(struct i9e_completion_info *ci,
384 struct i9e_completion_result *cr)
386 char *opts[] = {LSG_SERVER_CMD_RM_OPTS, NULL};
388 if (ci->word[0] == '-') {
389 i9e_complete_option(opts, ci, cr);
392 cr->filename_completion_desired = true;
395 static void touch_completer(struct i9e_completion_info *ci,
396 struct i9e_completion_result *cr)
398 char *opts[] = {LSG_SERVER_CMD_TOUCH_OPTS, NULL};
400 if (ci->word[0] == '-')
401 i9e_complete_option(opts, ci, cr);
402 cr->filename_completion_desired = true;
405 static void cpsi_completer(struct i9e_completion_info *ci,
406 struct i9e_completion_result *cr)
408 char *opts[] = {LSG_SERVER_CMD_CPSI_OPTS, NULL};
410 if (ci->word[0] == '-')
411 i9e_complete_option(opts, ci, cr);
412 cr->filename_completion_desired = true;
415 static void select_completer(struct i9e_completion_info *ci,
416 struct i9e_completion_result *cr)
418 char *mood_buf, *pl_buf, **moods, **playlists, **mops;
419 int num_moods, num_pl, i, n, ret;
421 ret = execute_client_command("lsmood", &mood_buf);
424 ret = execute_client_command("lspl", &pl_buf);
428 ret = create_argv(mood_buf, "\n", &moods);
432 ret = create_argv(pl_buf, "\n", &playlists);
436 n = num_moods + num_pl;
437 mops = para_malloc((n + 1) * sizeof(char *));
438 for (i = 0; i < num_moods; i++)
439 mops[i] = make_message("m/%s", moods[i]);
440 for (i = 0; i < num_pl; i++)
441 mops[num_moods + i] = make_message("p/%s", playlists[i]);
443 i9e_extract_completions(ci->word, mops, &cr->matches);
445 free_argv(playlists);
454 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
455 static void cmd ## blob_type ## _completer( \
456 struct i9e_completion_info *ci, \
457 struct i9e_completion_result *cr) \
458 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
460 DEFINE_BLOB_COMPLETER(add, mood)
461 DEFINE_BLOB_COMPLETER(add, lyr)
462 DEFINE_BLOB_COMPLETER(add, img)
463 DEFINE_BLOB_COMPLETER(add, pl)
464 DEFINE_BLOB_COMPLETER(cat, mood)
465 DEFINE_BLOB_COMPLETER(cat, lyr)
466 DEFINE_BLOB_COMPLETER(cat, img)
467 DEFINE_BLOB_COMPLETER(cat, pl)
468 DEFINE_BLOB_COMPLETER(ls, mood)
469 DEFINE_BLOB_COMPLETER(ls, lyr)
470 DEFINE_BLOB_COMPLETER(ls, img)
471 DEFINE_BLOB_COMPLETER(ls, pl)
472 DEFINE_BLOB_COMPLETER(rm, mood)
473 DEFINE_BLOB_COMPLETER(rm, lyr)
474 DEFINE_BLOB_COMPLETER(rm, img)
475 DEFINE_BLOB_COMPLETER(rm, pl)
476 DEFINE_BLOB_COMPLETER(mv, mood)
477 DEFINE_BLOB_COMPLETER(mv, lyr)
478 DEFINE_BLOB_COMPLETER(mv, img)
479 DEFINE_BLOB_COMPLETER(mv, pl)
481 static int client_i9e_line_handler(char *line)
484 static bool first = true;
489 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
490 ret = create_merged_lpr(line);
493 ret = client_connect(ct, &sched, NULL, NULL);
496 i9e_attach_to_stdout(ct->btrn[0]);
500 I9E_DUMMY_COMPLETER(SUPERCOMMAND_UNAVAILABLE);
501 static struct i9e_completer completers[] = {
502 #define LSG_SERVER_CMD_CMD(_name) {.name = #_name, \
503 .completer = _name ## _completer}
504 LSG_SERVER_CMD_SUBCOMMANDS
505 #undef LSG_SERVER_CMD_CMD
509 __noreturn static void interactive_session(void)
512 struct sigaction act;
513 struct i9e_client_info ici = {
515 .prompt = "para_client> ",
516 .line_handler = client_i9e_line_handler,
517 .loglevel = client_loglevel,
518 .completers = completers,
521 PARA_NOTICE_LOG("\n%s\n", version_text("client"));
522 if (CLIENT_OPT_GIVEN(HISTORY_FILE, ct->lpr))
523 ici.history_file = para_strdup(CLIENT_OPT_STRING_VAL(
524 HISTORY_FILE, ct->lpr));
526 char *home = para_homedir();
527 ici.history_file = make_message("%s/.paraslash/client.history",
531 act.sa_handler = i9e_signal_dispatch;
532 sigemptyset(&act.sa_mask);
534 sigaction(SIGINT, &act, NULL);
535 sched.select_function = i9e_select;
537 ret = i9e_open(&ici, &sched);
541 ret = schedule(&sched);
542 sched_shutdown(&sched);
544 para_log = stderr_log;
547 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
548 exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
552 __noreturn static void print_completions(void)
556 ret = i9e_print_completions(completers);
557 exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
560 #else /* HAVE_READLINE */
562 __noreturn static void interactive_session(void)
564 PARA_EMERG_LOG("interactive sessions not available\n");
568 __noreturn static void print_completions(void)
570 PARA_EMERG_LOG("command completion not available\n");
574 #endif /* HAVE_READLINE */
576 struct supervisor_task {
577 bool stdout_task_started;
581 static int supervisor_post_select(struct sched *s, void *context)
583 struct supervisor_task *svt = context;
584 int ret = task_status(ct->task);
588 if (!svt->stdout_task_started && ct->status == CL_EXECUTING) {
589 stdout_task_register(&sot, s);
590 svt->stdout_task_started = true;
593 if (ct->status == CL_SENDING) {
594 stdin_task_register(&sit, s);
595 return -E_TASK_STARTED;
600 static struct supervisor_task supervisor_task;
603 * The client program to connect to para_server.
605 * \param argc Usual argument count.
606 * \param argv Usual argument vector.
608 * When called without a paraslash command, an interactive session is started.
609 * Otherwise, the client task and the supervisor task are started. The former
610 * communicates with para_server while the latter monitors whether the client
611 * task intends to read from stdin or write to stdout.
613 * Once it has been determined whether the client command corresponds to a
614 * stdin command (addmood, addimg, ..), either the stdin task or the stdout
615 * task is set up to replace the supervisor task.
617 * \return EXIT_SUCCESS or EXIT_FAILURE
619 * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
621 int main(int argc, char *argv[])
625 init_random_seed_or_die();
626 sched.default_timeout.tv_sec = 1;
628 ret = client_parse_config(argc, argv, &ct, &client_loglevel);
631 if (CLIENT_OPT_GIVEN(COMPLETE, ct->lpr))
634 interactive_session(); /* does not return */
637 * We add buffer tree nodes for stdin and stdout even though
638 * only one of them will be needed. This simplifies the code
639 * a bit wrt. to the buffer tree setup.
641 sit.btrn = btr_new_node(&(struct btr_node_description)
642 EMBRACE(.name = "stdin"));
643 ret = client_connect(ct, &sched, sit.btrn, NULL);
646 sot.btrn = btr_new_node(&(struct btr_node_description)
647 EMBRACE(.name = "stdout", .parent = ct->btrn[0]));
648 supervisor_task.task = task_register(&(struct task_info) {
649 .name = "supervisor",
650 .post_select = supervisor_post_select,
651 .context = &supervisor_task,
654 ret = schedule(&sched);
656 ret = task_status(ct->task);
659 /* these are not errors */
660 case -E_SERVER_CMD_SUCCESS:
666 default: ret = -E_SERVER_CMD_FAILURE;
670 sched_shutdown(&sched);
673 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
675 btr_remove_node(&sit.btrn);
676 btr_remove_node(&sot.btrn);
677 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;