1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file client.c The client program used to connect to para_server. */
9 #include "client.lsg.h"
18 #include "buffer_tree.h"
22 /** Array of error strings. */
25 static struct sched sched;
26 static struct client_task *ct;
27 static struct stdin_task sit;
28 static struct stdout_task sot;
30 static int client_loglevel = LL_ERROR;
31 DEFINE_STDERR_LOGGER(stderr_log, client_loglevel);
32 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
35 #include "interactive.h"
36 #include "server_cmd.lsg.h"
40 struct btr_node *btrn;
45 static void exec_pre_select(struct sched *s, void *context)
47 struct exec_task *et = context;
48 int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
54 static int exec_post_select(__a_unused struct sched *s, void *context)
56 struct exec_task *et = context;
57 struct btr_node *btrn = et->btrn;
62 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
65 sz = btr_next_buffer(btrn, &buf);
68 et->result_buf = para_realloc(et->result_buf, et->result_size + sz - 1);
69 memcpy(et->result_buf + et->result_size - 1, buf, sz - 1);
70 et->result_size += sz - 1;
71 et->result_buf[et->result_size - 1] = '\0';
73 btr_consume(btrn, sz);
77 /* Called from the line handler and the completers. This overwrites ct->lpr. */
78 static int create_merged_lpr(const char *line)
80 const struct lls_command *cmd = CLIENT_CMD_PTR;
82 char *cmdline, **argv, *errctx;
83 struct lls_parse_result *argv_lpr;
84 static struct lls_parse_result *orig_lpr;
89 cmdline = make_message("-- %s", line);
90 ret = create_shifted_argv(cmdline, " ", &argv);
95 if (argc == 2) { /* no words (only blanks in line) */
99 argv[0] = para_strdup("--");
101 * The original lpr for the interactive session has no non-option
102 * arguments. We create a fresh lpr from the words in "line" and merge
103 * it with the original lpr.
105 ret = lls(lls_parse(argc, argv, cmd, &argv_lpr, &errctx));
109 ret = lls(lls_merge(orig_lpr, argv_lpr, cmd, &ct->lpr, &errctx));
110 lls_free_parse_result(argv_lpr, cmd);
116 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
122 /* called from completers */
123 static int execute_client_command(const char *cmd, char **result)
126 struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
127 struct exec_task exec_task = {
128 .result_buf = para_strdup(""),
131 struct lls_parse_result *old_lpr = ct->lpr;
134 ret = create_merged_lpr(cmd);
137 exec_task.btrn = btr_new_node(&(struct btr_node_description)
138 EMBRACE(.name = "exec_collect"));
139 exec_task.task = task_register(&(struct task_info) {
140 .name = "client exec",
141 .pre_select = exec_pre_select,
142 .post_select = exec_post_select,
143 .context = &exec_task,
145 ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
148 schedule(&command_sched);
149 sched_shutdown(&command_sched);
150 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
152 *result = exec_task.result_buf;
153 btr_remove_node(&exec_task.btrn);
156 btr_remove_node(&exec_task.btrn);
158 free(exec_task.result_buf);
162 static int extract_matches_from_command(const char *word, char *cmd,
168 ret = execute_client_command(cmd, &buf);
171 ret = create_argv(buf, "\n", &sl);
175 ret = i9e_extract_completions(word, sl, matches);
180 static int complete_attributes(const char *word, char ***matches)
182 return extract_matches_from_command(word, "lsatt", matches);
185 static void complete_addblob(__a_unused const char *blob_type,
186 __a_unused struct i9e_completion_info *ci,
187 __a_unused struct i9e_completion_result *cr)
189 cr->filename_completion_desired = true;
192 static void generic_blob_complete(const char *blob_type,
193 struct i9e_completion_info *ci,
194 struct i9e_completion_result *cr)
197 sprintf(cmd, "ls%s", blob_type);
198 extract_matches_from_command(ci->word, cmd, &cr->matches);
201 static void complete_catblob(const char *blob_type,
202 struct i9e_completion_info *ci,
203 struct i9e_completion_result *cr)
205 generic_blob_complete(blob_type, ci, cr);
208 static void complete_lsblob(const char *blob_type,
209 struct i9e_completion_info *ci,
210 struct i9e_completion_result *cr)
212 char *opts[] = {LSG_SERVER_CMD_LSIMG_OPTS, NULL};
214 if (ci->word[0] == '-')
215 return i9e_complete_option(opts, ci, cr);
216 generic_blob_complete(blob_type, ci, cr);
219 static void complete_rmblob(const char *blob_type,
220 struct i9e_completion_info *ci,
221 struct i9e_completion_result *cr)
223 generic_blob_complete(blob_type, ci, cr);
226 static void complete_mvblob(const char *blob_type,
227 struct i9e_completion_info *ci,
228 struct i9e_completion_result *cr)
230 generic_blob_complete(blob_type, ci, cr);
233 /* these don't need any completions */
234 I9E_DUMMY_COMPLETER(ff);
235 I9E_DUMMY_COMPLETER(hup);
236 I9E_DUMMY_COMPLETER(jmp);
237 I9E_DUMMY_COMPLETER(next);
238 I9E_DUMMY_COMPLETER(nomore);
239 I9E_DUMMY_COMPLETER(pause);
240 I9E_DUMMY_COMPLETER(play);
241 I9E_DUMMY_COMPLETER(si);
242 I9E_DUMMY_COMPLETER(term);
243 I9E_DUMMY_COMPLETER(stop);
244 I9E_DUMMY_COMPLETER(addatt);
245 I9E_DUMMY_COMPLETER(init);
247 static struct i9e_completer completers[];
249 static void help_completer(struct i9e_completion_info *ci,
250 struct i9e_completion_result *cr)
252 char *opts[] = {LSG_SERVER_CMD_HELP_OPTS, NULL};
254 if (ci->word[0] == '-') {
255 i9e_complete_option(opts, ci, cr);
258 cr->matches = i9e_complete_commands(ci->word, completers);
261 static void stat_completer(struct i9e_completion_info *ci,
262 struct i9e_completion_result *cr)
264 char *opts[] = {LSG_SERVER_CMD_STAT_OPTS, NULL};
265 i9e_complete_option(opts, ci, cr);
268 static void version_completer(struct i9e_completion_info *ci,
269 struct i9e_completion_result *cr)
271 char *opts[] = {LSG_SERVER_CMD_VERSION_OPTS, NULL};
272 i9e_complete_option(opts, ci, cr);
275 static void sender_completer(struct i9e_completion_info *ci,
276 struct i9e_completion_result *cr)
278 char *senders[] = {"http", "dccp", "udp", NULL};
279 char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
280 char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
281 char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
285 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
286 if (ci->word_num == 0 || ci->word_num > 3)
288 if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
289 i9e_extract_completions(ci->word, senders, &cr->matches);
292 sender = ci->argv[1];
293 //PARA_CRIT_LOG("sender: %s\n", sender);
294 if (strcmp(sender, "http") == 0)
296 else if (strcmp(sender, "dccp") == 0)
298 else if (strcmp(sender, "udp") == 0)
302 i9e_extract_completions(ci->word, cmds, &cr->matches);
305 static void add_completer(struct i9e_completion_info *ci,
306 struct i9e_completion_result *cr)
308 char *opts[] = {LSG_SERVER_CMD_ADD_OPTS, NULL};
310 if (ci->word[0] == '-')
311 i9e_complete_option(opts, ci, cr);
312 cr->filename_completion_desired = true;
315 static void ls_completer(struct i9e_completion_info *ci,
316 struct i9e_completion_result *cr)
318 char *opts[] = {LSG_SERVER_CMD_LS_OPTS, NULL};
319 if (ci->word[0] == '-')
320 i9e_complete_option(opts, ci, cr);
321 cr->filename_completion_desired = true;
324 static void setatt_completer(struct i9e_completion_info *ci,
325 struct i9e_completion_result *cr)
328 int i, ret, num_atts;
330 if (ci->word_num == 0)
333 if (*ci->word == '/' || *ci->word == '\0')
334 cr->filename_completion_desired = true;
335 if (*ci->word == '/')
337 ret = execute_client_command("lsatt", &buf);
340 ret = create_argv(buf, "\n", &sl);
344 sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
345 for (i = 0; i < num_atts; i++) {
347 sl[i] = make_message("%s+", orig);
348 sl[num_atts + i] = make_message("%s-", orig);
351 sl[2 * num_atts] = NULL;
352 i9e_extract_completions(ci->word, sl, &cr->matches);
358 static void lsatt_completer(struct i9e_completion_info *ci,
359 struct i9e_completion_result *cr)
361 char *opts[] = {LSG_SERVER_CMD_LSATT_OPTS, NULL};
362 i9e_complete_option(opts, ci, cr);
365 static void mvatt_completer(struct i9e_completion_info *ci,
366 struct i9e_completion_result *cr)
368 complete_attributes(ci->word, &cr->matches);
371 static void rmatt_completer(struct i9e_completion_info *ci,
372 struct i9e_completion_result *cr)
374 complete_attributes(ci->word, &cr->matches);
377 static void check_completer(struct i9e_completion_info *ci,
378 struct i9e_completion_result *cr)
380 char *opts[] = {LSG_SERVER_CMD_CHECK_OPTS, NULL};
381 i9e_complete_option(opts, ci, cr);
384 static void rm_completer(struct i9e_completion_info *ci,
385 struct i9e_completion_result *cr)
387 char *opts[] = {LSG_SERVER_CMD_RM_OPTS, NULL};
389 if (ci->word[0] == '-') {
390 i9e_complete_option(opts, ci, cr);
393 cr->filename_completion_desired = true;
396 static void touch_completer(struct i9e_completion_info *ci,
397 struct i9e_completion_result *cr)
399 char *opts[] = {LSG_SERVER_CMD_TOUCH_OPTS, NULL};
401 if (ci->word[0] == '-')
402 i9e_complete_option(opts, ci, cr);
403 cr->filename_completion_desired = true;
406 static void cpsi_completer(struct i9e_completion_info *ci,
407 struct i9e_completion_result *cr)
409 char *opts[] = {LSG_SERVER_CMD_CPSI_OPTS, NULL};
411 if (ci->word[0] == '-')
412 i9e_complete_option(opts, ci, cr);
413 cr->filename_completion_desired = true;
416 static void select_completer(struct i9e_completion_info *ci,
417 struct i9e_completion_result *cr)
419 char *mood_buf, *pl_buf, **moods, **playlists, **mops;
420 int num_moods, num_pl, i, n, ret;
422 ret = execute_client_command("lsmood", &mood_buf);
425 ret = execute_client_command("lspl", &pl_buf);
429 ret = create_argv(mood_buf, "\n", &moods);
433 ret = create_argv(pl_buf, "\n", &playlists);
437 n = num_moods + num_pl;
438 mops = para_malloc((n + 1) * sizeof(char *));
439 for (i = 0; i < num_moods; i++)
440 mops[i] = make_message("m/%s", moods[i]);
441 for (i = 0; i < num_pl; i++)
442 mops[num_moods + i] = make_message("p/%s", playlists[i]);
444 i9e_extract_completions(ci->word, mops, &cr->matches);
446 free_argv(playlists);
455 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
456 static void cmd ## blob_type ## _completer( \
457 struct i9e_completion_info *ci, \
458 struct i9e_completion_result *cr) \
459 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
461 DEFINE_BLOB_COMPLETER(add, mood)
462 DEFINE_BLOB_COMPLETER(add, lyr)
463 DEFINE_BLOB_COMPLETER(add, img)
464 DEFINE_BLOB_COMPLETER(add, pl)
465 DEFINE_BLOB_COMPLETER(cat, mood)
466 DEFINE_BLOB_COMPLETER(cat, lyr)
467 DEFINE_BLOB_COMPLETER(cat, img)
468 DEFINE_BLOB_COMPLETER(cat, pl)
469 DEFINE_BLOB_COMPLETER(ls, mood)
470 DEFINE_BLOB_COMPLETER(ls, lyr)
471 DEFINE_BLOB_COMPLETER(ls, img)
472 DEFINE_BLOB_COMPLETER(ls, pl)
473 DEFINE_BLOB_COMPLETER(rm, mood)
474 DEFINE_BLOB_COMPLETER(rm, lyr)
475 DEFINE_BLOB_COMPLETER(rm, img)
476 DEFINE_BLOB_COMPLETER(rm, pl)
477 DEFINE_BLOB_COMPLETER(mv, mood)
478 DEFINE_BLOB_COMPLETER(mv, lyr)
479 DEFINE_BLOB_COMPLETER(mv, img)
480 DEFINE_BLOB_COMPLETER(mv, pl)
482 static int client_i9e_line_handler(char *line)
485 static bool first = true;
490 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
491 ret = create_merged_lpr(line);
494 ret = client_connect(ct, &sched, NULL, NULL);
497 i9e_attach_to_stdout(ct->btrn[0]);
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 \ref client_open(), \ref stdin.c, \ref stdout.c, para_client(1),
622 int main(int argc, char *argv[])
627 sched.default_timeout.tv_sec = 1;
629 ret = client_parse_config(argc, argv, &ct, &client_loglevel);
632 if (CLIENT_OPT_GIVEN(COMPLETE, ct->lpr))
635 interactive_session(); /* does not return */
638 * We add buffer tree nodes for stdin and stdout even though
639 * only one of them will be needed. This simplifies the code
640 * a bit wrt. to the buffer tree setup.
642 sit.btrn = btr_new_node(&(struct btr_node_description)
643 EMBRACE(.name = "stdin"));
644 ret = client_connect(ct, &sched, sit.btrn, NULL);
647 sot.btrn = btr_new_node(&(struct btr_node_description)
648 EMBRACE(.name = "stdout", .parent = ct->btrn[0]));
649 supervisor_task.task = task_register(&(struct task_info) {
650 .name = "supervisor",
651 .post_select = supervisor_post_select,
652 .context = &supervisor_task,
655 ret = schedule(&sched);
657 ret = task_status(ct->task);
660 /* these are not errors */
661 case -E_SERVER_CMD_SUCCESS:
667 default: ret = -E_SERVER_CMD_FAILURE;
671 sched_shutdown(&sched);
675 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
677 btr_remove_node(&sit.btrn);
678 btr_remove_node(&sot.btrn);
679 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;