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. */
16 #include "client.cmdline.h"
21 #include "buffer_tree.h"
25 /** Array of error strings. */
28 static struct sched sched;
29 static struct client_task *ct;
30 static struct stdin_task sit;
31 static struct stdout_task sot;
33 static int client_loglevel = LL_ERROR;
34 DEFINE_STDERR_LOGGER(stderr_log, client_loglevel);
35 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
38 #include "interactive.h"
39 #include "server.completion.h"
40 #include "afs.completion.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 static int make_client_argv(const char *line)
85 free_argv(ct->conf.inputs);
86 ret = create_argv(line, " ", &ct->conf.inputs);
88 ct->conf.inputs_num = ret;
92 static int execute_client_command(const char *cmd, char **result)
95 struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
96 struct exec_task exec_task = {
97 .result_buf = para_strdup(""),
101 ret = make_client_argv(cmd);
104 exec_task.btrn = btr_new_node(&(struct btr_node_description)
105 EMBRACE(.name = "exec_collect"));
106 exec_task.task = task_register(&(struct task_info) {
107 .name = "client exec",
108 .pre_select = exec_pre_select,
109 .post_select = exec_post_select,
110 .context = &exec_task,
112 ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
115 schedule(&command_sched);
116 sched_shutdown(&command_sched);
117 *result = exec_task.result_buf;
118 btr_remove_node(&exec_task.btrn);
121 btr_remove_node(&exec_task.btrn);
123 free(exec_task.result_buf);
127 static int extract_matches_from_command(const char *word, char *cmd,
133 ret = execute_client_command(cmd, &buf);
136 ret = create_argv(buf, "\n", &sl);
140 ret = i9e_extract_completions(word, sl, matches);
145 static int complete_attributes(const char *word, char ***matches)
147 return extract_matches_from_command(word, "lsatt", matches);
150 static void complete_addblob(__a_unused const char *blob_type,
151 __a_unused struct i9e_completion_info *ci,
152 __a_unused struct i9e_completion_result *cr)
154 cr->filename_completion_desired = true;
157 static void generic_blob_complete(const char *blob_type,
158 struct i9e_completion_info *ci,
159 struct i9e_completion_result *cr)
162 sprintf(cmd, "ls%s", blob_type);
163 extract_matches_from_command(ci->word, cmd, &cr->matches);
166 static void complete_catblob(const char *blob_type,
167 struct i9e_completion_info *ci,
168 struct i9e_completion_result *cr)
170 generic_blob_complete(blob_type, ci, cr);
173 static void complete_lsblob(const char *blob_type,
174 struct i9e_completion_info *ci,
175 struct i9e_completion_result *cr)
177 char *opts[] = {"-i", "-l", "-r", NULL};
179 if (ci->word[0] == '-')
180 return i9e_complete_option(opts, ci, cr);
181 generic_blob_complete(blob_type, ci, cr);
184 static void complete_rmblob(const char *blob_type,
185 struct i9e_completion_info *ci,
186 struct i9e_completion_result *cr)
188 generic_blob_complete(blob_type, ci, cr);
191 static void complete_mvblob(const char *blob_type,
192 struct i9e_completion_info *ci,
193 struct i9e_completion_result *cr)
195 generic_blob_complete(blob_type, ci, cr);
198 /* these don't need any completions */
199 I9E_DUMMY_COMPLETER(ff);
200 I9E_DUMMY_COMPLETER(hup);
201 I9E_DUMMY_COMPLETER(jmp);
202 I9E_DUMMY_COMPLETER(next);
203 I9E_DUMMY_COMPLETER(nomore);
204 I9E_DUMMY_COMPLETER(pause);
205 I9E_DUMMY_COMPLETER(play);
206 I9E_DUMMY_COMPLETER(si);
207 I9E_DUMMY_COMPLETER(term);
208 I9E_DUMMY_COMPLETER(stop);
209 I9E_DUMMY_COMPLETER(addatt);
210 I9E_DUMMY_COMPLETER(init);
211 I9E_DUMMY_COMPLETER(tasks);
213 static struct i9e_completer completers[];
215 static void help_completer(struct i9e_completion_info *ci,
216 struct i9e_completion_result *result)
218 result->matches = i9e_complete_commands(ci->word, completers);
221 static void version_completer(struct i9e_completion_info *ci,
222 struct i9e_completion_result *cr)
224 char *opts[] = {"-v", NULL};
225 i9e_complete_option(opts, ci, cr);
228 static void stat_completer(struct i9e_completion_info *ci,
229 struct i9e_completion_result *cr)
231 char *opts[] = {"-n=", "-p", NULL};
232 //PARA_CRIT_LOG("word: %s\n", ci->word);
233 i9e_complete_option(opts, ci, cr);
236 static void sender_completer(struct i9e_completion_info *ci,
237 struct i9e_completion_result *cr)
239 char *senders[] = {"http", "dccp", "udp", NULL};
240 char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
241 char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
242 char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
246 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
247 if (ci->word_num == 0 || ci->word_num > 3)
249 if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
250 i9e_extract_completions(ci->word, senders, &cr->matches);
253 sender = ci->argv[1];
254 //PARA_CRIT_LOG("sender: %s\n", sender);
255 if (strcmp(sender, "http") == 0)
257 else if (strcmp(sender, "dccp") == 0)
259 else if (strcmp(sender, "udp") == 0)
263 i9e_extract_completions(ci->word, cmds, &cr->matches);
266 static void add_completer(struct i9e_completion_info *ci,
267 struct i9e_completion_result *cr)
269 char *opts[] = {"-a", "-l", "-f", "-v", "--", NULL};
271 if (ci->word[0] == '-')
272 i9e_complete_option(opts, ci, cr);
273 cr->filename_completion_desired = true;
276 static void ls_completer(struct i9e_completion_info *ci,
277 struct i9e_completion_result *cr)
280 "--", "-l", "-l=s", "-l=l", "-l=v", "-l=p", "-l=m", "-l=c",
281 "-p", "-a", "-r", "-d", "-s=p", "-s=l", "-s=s", "-s=n", "-s=f",
282 "-s=c", "-s=i", "-s=y", "-s=b", "-s=d", "-s=a", "-F", "-b", NULL
284 if (ci->word[0] == '-')
285 i9e_complete_option(opts, ci, cr);
286 cr->filename_completion_desired = true;
289 static void setatt_completer(struct i9e_completion_info *ci,
290 struct i9e_completion_result *cr)
293 int i, ret, num_atts;
295 if (ci->word_num == 0)
298 if (*ci->word == '/' || *ci->word == '\0')
299 cr->filename_completion_desired = true;
300 if (*ci->word == '/')
302 ret = execute_client_command("lsatt", &buf);
305 ret = create_argv(buf, "\n", &sl);
309 sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
310 for (i = 0; i < num_atts; i++) {
312 sl[i] = make_message("%s+", orig);
313 sl[num_atts + i] = make_message("%s-", orig);
316 sl[2 * num_atts] = NULL;
317 i9e_extract_completions(ci->word, sl, &cr->matches);
323 static void lsatt_completer(struct i9e_completion_info *ci,
324 struct i9e_completion_result *cr)
326 char *opts[] = {"-i", "-l", "-r", NULL};
327 i9e_complete_option(opts, ci, cr);
330 static void mvatt_completer(struct i9e_completion_info *ci,
331 struct i9e_completion_result *cr)
333 complete_attributes(ci->word, &cr->matches);
336 static void rmatt_completer(struct i9e_completion_info *ci,
337 struct i9e_completion_result *cr)
339 complete_attributes(ci->word, &cr->matches);
342 static void check_completer(struct i9e_completion_info *ci,
343 struct i9e_completion_result *cr)
345 char *opts[] = {"-a", "-m", "-p", NULL};
346 i9e_complete_option(opts, ci, cr);
349 static void rm_completer(struct i9e_completion_info *ci,
350 struct i9e_completion_result *cr)
352 char *opts[] = {"-v", "-f", "-p", NULL};
354 if (ci->word[0] == '-') {
355 i9e_complete_option(opts, ci, cr);
358 cr->filename_completion_desired = true;
361 static void touch_completer(struct i9e_completion_info *ci,
362 struct i9e_completion_result *cr)
364 char *opts[] = {"-n=", "-l=", "-y=", "-i=", "-a=", "-v", "-p", NULL};
366 if (ci->word[0] == '-')
367 i9e_complete_option(opts, ci, cr);
368 cr->filename_completion_desired = true;
371 static void cpsi_completer(struct i9e_completion_info *ci,
372 struct i9e_completion_result *cr)
374 char *opts[] = {"-a", "-y", "-i", "-l", "-n", "-v", NULL};
376 if (ci->word[0] == '-')
377 i9e_complete_option(opts, ci, cr);
378 cr->filename_completion_desired = true;
381 static void select_completer(struct i9e_completion_info *ci,
382 struct i9e_completion_result *cr)
384 char *mood_buf, *pl_buf, **moods, **playlists, **mops;
385 int num_moods, num_pl, i, n, ret;
387 ret = execute_client_command("lsmood", &mood_buf);
390 ret = execute_client_command("lspl", &pl_buf);
394 ret = create_argv(mood_buf, "\n", &moods);
398 ret = create_argv(pl_buf, "\n", &playlists);
402 n = num_moods + num_pl;
403 mops = para_malloc((n + 1) * sizeof(char *));
404 for (i = 0; i < num_moods; i++)
405 mops[i] = make_message("m/%s", moods[i]);
406 for (i = 0; i < num_pl; i++)
407 mops[num_moods + i] = make_message("p/%s", playlists[i]);
409 i9e_extract_completions(ci->word, mops, &cr->matches);
411 free_argv(playlists);
420 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
421 static void cmd ## blob_type ## _completer( \
422 struct i9e_completion_info *ci, \
423 struct i9e_completion_result *cr) \
424 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
426 DEFINE_BLOB_COMPLETER(add, mood)
427 DEFINE_BLOB_COMPLETER(add, lyr)
428 DEFINE_BLOB_COMPLETER(add, img)
429 DEFINE_BLOB_COMPLETER(add, pl)
430 DEFINE_BLOB_COMPLETER(cat, mood)
431 DEFINE_BLOB_COMPLETER(cat, lyr)
432 DEFINE_BLOB_COMPLETER(cat, img)
433 DEFINE_BLOB_COMPLETER(cat, pl)
434 DEFINE_BLOB_COMPLETER(ls, mood)
435 DEFINE_BLOB_COMPLETER(ls, lyr)
436 DEFINE_BLOB_COMPLETER(ls, img)
437 DEFINE_BLOB_COMPLETER(ls, pl)
438 DEFINE_BLOB_COMPLETER(rm, mood)
439 DEFINE_BLOB_COMPLETER(rm, lyr)
440 DEFINE_BLOB_COMPLETER(rm, img)
441 DEFINE_BLOB_COMPLETER(rm, pl)
442 DEFINE_BLOB_COMPLETER(mv, mood)
443 DEFINE_BLOB_COMPLETER(mv, lyr)
444 DEFINE_BLOB_COMPLETER(mv, img)
445 DEFINE_BLOB_COMPLETER(mv, pl)
447 static int client_i9e_line_handler(char *line)
451 PARA_DEBUG_LOG("line: %s\n", line);
452 ret = make_client_argv(line);
455 ret = client_connect(ct, &sched, NULL, NULL);
458 i9e_attach_to_stdout(ct->btrn[0]);
462 static struct i9e_completer completers[] = {
468 __noreturn static void interactive_session(void)
472 struct sigaction act;
473 struct i9e_client_info ici = {
475 .prompt = "para_client> ",
476 .line_handler = client_i9e_line_handler,
477 .loglevel = client_loglevel,
478 .completers = completers,
481 PARA_NOTICE_LOG("\n%s\n", version_text("client"));
482 if (ct->conf.history_file_given)
483 history_file = para_strdup(ct->conf.history_file_arg);
485 char *home = para_homedir();
486 history_file = make_message("%s/.paraslash/client.history",
490 ici.history_file = history_file;
492 act.sa_handler = i9e_signal_dispatch;
493 sigemptyset(&act.sa_mask);
495 sigaction(SIGINT, &act, NULL);
496 sched.select_function = i9e_select;
498 ret = i9e_open(&ici, &sched);
502 ret = schedule(&sched);
503 sched_shutdown(&sched);
505 para_log = stderr_log;
508 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
509 exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
513 __noreturn static void print_completions(void)
515 int ret = i9e_print_completions(completers);
516 exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
519 #else /* HAVE_READLINE */
521 __noreturn static void interactive_session(void)
523 PARA_EMERG_LOG("interactive sessions not available\n");
527 __noreturn static void print_completions(void)
529 PARA_EMERG_LOG("command completion not available\n");
533 #endif /* HAVE_READLINE */
535 struct supervisor_task {
536 bool stdout_task_started;
540 static int supervisor_post_select(struct sched *s, void *context)
542 struct supervisor_task *svt = context;
543 int ret = task_status(ct->task);
547 if (!svt->stdout_task_started && ct->status == CL_EXECUTING) {
548 stdout_task_register(&sot, s);
549 svt->stdout_task_started = true;
552 if (ct->status == CL_SENDING) {
553 stdin_task_register(&sit, s);
554 return -E_TASK_STARTED;
559 static struct supervisor_task supervisor_task;
562 * The client program to connect to para_server.
564 * \param argc Usual argument count.
565 * \param argv Usual argument vector.
567 * When called without a paraslash command, an interactive session is started.
568 * Otherwise, the client task and the supervisor task are started. The former
569 * communicates with para_server while the latter monitors whether the client
570 * task intends to read from stdin or write to stdout.
572 * Once it has been determined whether the client command corresponds to a
573 * stdin command (addmood, addimg, ..), either the stdin task or the stdout
574 * task is set up to replace the supervisor task.
576 * \return EXIT_SUCCESS or EXIT_FAILURE
578 * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
580 int main(int argc, char *argv[])
584 init_random_seed_or_die();
585 sched.default_timeout.tv_sec = 1;
587 ret = client_parse_config(argc, argv, &ct, &client_loglevel);
590 if (ct->conf.complete_given)
593 interactive_session(); /* does not return */
596 * We add buffer tree nodes for stdin and stdout even though
597 * only one of them will be needed. This simplifies the code
598 * a bit wrt. to the buffer tree setup.
600 sit.btrn = btr_new_node(&(struct btr_node_description)
601 EMBRACE(.name = "stdin"));
602 ret = client_connect(ct, &sched, sit.btrn, NULL);
605 sot.btrn = btr_new_node(&(struct btr_node_description)
606 EMBRACE(.name = "stdout", .parent = ct->btrn[0]));
607 supervisor_task.task = task_register(&(struct task_info) {
608 .name = "supervisor",
609 .post_select = supervisor_post_select,
610 .context = &supervisor_task,
613 ret = schedule(&sched);
615 ret = task_status(ct->task);
618 /* these are not errors */
619 case -E_SERVER_CMD_SUCCESS:
625 default: ret = -E_SERVER_CMD_FAILURE;
629 sched_shutdown(&sched);
632 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
634 btr_remove_node(&sit.btrn);
635 btr_remove_node(&sot.btrn);
636 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;