2 * Copyright (C) 1997-2012 Andre Noll <maan@systemlinux.org>
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"
27 static struct sched sched;
28 static struct client_task *ct;
29 static struct stdin_task sit;
30 static struct stdout_task sot;
32 static int client_loglevel = LL_ERROR;
33 DEFINE_STDERR_LOGGER(stderr_log, client_loglevel);
34 __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
37 #include "interactive.h"
38 #include "server_completion.h"
39 #include "afs_completion.h"
43 struct btr_node *btrn;
48 static void exec_pre_select(struct sched *s, struct task *t)
50 struct exec_task *et = container_of(t, struct exec_task, task);
51 int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
57 static void exec_post_select(__a_unused struct sched *s, struct task *t)
59 struct exec_task *et = container_of(t, struct exec_task, task);
60 struct btr_node *btrn = et->btrn;
65 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
70 sz = btr_next_buffer(btrn, &buf);
73 et->result_buf = para_realloc(et->result_buf, et->result_size + sz - 1);
74 memcpy(et->result_buf + et->result_size - 1, buf, sz - 1);
75 et->result_size += sz - 1;
76 et->result_buf[et->result_size - 1] = '\0';
78 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 = {
98 .pre_select = exec_pre_select,
99 .post_select = exec_post_select,
100 .status = "client exec task",
102 .result_buf = para_strdup(""),
106 ret = make_client_argv(cmd);
109 exec_task.btrn = btr_new_node(&(struct btr_node_description)
110 EMBRACE(.name = "exec_collect"));
111 register_task(&command_sched, &exec_task.task);
112 ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
115 schedule(&command_sched);
116 *result = exec_task.result_buf;
117 btr_remove_node(&exec_task.btrn);
118 client_disconnect(ct);
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(version);
209 I9E_DUMMY_COMPLETER(stop);
210 I9E_DUMMY_COMPLETER(addatt);
211 I9E_DUMMY_COMPLETER(init);
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 stat_completer(struct i9e_completion_info *ci,
222 struct i9e_completion_result *cr)
224 char *opts[] = {"-n=", "-p", NULL};
225 //PARA_CRIT_LOG("word: %s\n", ci->word);
226 i9e_complete_option(opts, ci, cr);
229 static void sender_completer(struct i9e_completion_info *ci,
230 struct i9e_completion_result *cr)
232 char *senders[] = {"http", "dccp", "udp", NULL};
233 char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
234 char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
235 char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
239 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
240 if (ci->word_num == 0 || ci->word_num > 3)
242 if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
243 i9e_extract_completions(ci->word, senders, &cr->matches);
246 sender = ci->argv[1];
247 //PARA_CRIT_LOG("sender: %s\n", sender);
248 if (strcmp(sender, "http") == 0)
250 else if (strcmp(sender, "dccp") == 0)
252 else if (strcmp(sender, "udp") == 0)
256 i9e_extract_completions(ci->word, cmds, &cr->matches);
259 static void add_completer(struct i9e_completion_info *ci,
260 struct i9e_completion_result *cr)
262 char *opts[] = {"-a", "-l", "-f", "-v", "--", NULL};
264 if (ci->word[0] == '-')
265 i9e_complete_option(opts, ci, cr);
266 cr->filename_completion_desired = true;
269 static void ls_completer(struct i9e_completion_info *ci,
270 struct i9e_completion_result *cr)
273 "--", "-l", "-ls", "-ll", "-lv", "-lp", "-lm", "-lc", "-p",
274 "-a", "-r", "-d", "-sp", "-sl", "-ss", "-sn", "-sf", "-sc",
275 "-si", "-sy", "-sb", "-sd", "-sa", NULL
277 if (ci->word[0] == '-')
278 i9e_complete_option(opts, ci, cr);
279 cr->filename_completion_desired = true;
282 static void setatt_completer(struct i9e_completion_info *ci,
283 struct i9e_completion_result *cr)
286 int i, ret, num_atts;
288 if (ci->word_num == 0)
291 if (*ci->word == '/' || *ci->word == '\0')
292 cr->filename_completion_desired = true;
293 if (*ci->word == '/')
295 ret = execute_client_command("lsatt", &buf);
298 ret = create_argv(buf, "\n", &sl);
302 sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
303 for (i = 0; i < num_atts; i++) {
305 sl[i] = make_message("%s+", orig);
306 sl[num_atts + i] = make_message("%s-", orig);
309 sl[2 * num_atts] = NULL;
310 i9e_extract_completions(ci->word, sl, &cr->matches);
316 static void lsatt_completer(struct i9e_completion_info *ci,
317 struct i9e_completion_result *cr)
319 char *opts[] = {"-i", "-l", "-r", NULL};
321 if (ci->word[0] == '-')
322 i9e_complete_option(opts, ci, cr);
324 complete_attributes(ci->word, &cr->matches);
327 static void mvatt_completer(struct i9e_completion_info *ci,
328 struct i9e_completion_result *cr)
330 complete_attributes(ci->word, &cr->matches);
333 static void rmatt_completer(struct i9e_completion_info *ci,
334 struct i9e_completion_result *cr)
336 complete_attributes(ci->word, &cr->matches);
339 static void check_completer(struct i9e_completion_info *ci,
340 struct i9e_completion_result *cr)
342 char *opts[] = {"-a", "-m", "-p", NULL};
343 i9e_complete_option(opts, ci, cr);
346 static void rm_completer(struct i9e_completion_info *ci,
347 struct i9e_completion_result *cr)
349 char *opts[] = {"-v", "-f", "-p", NULL};
351 if (ci->word[0] == '-') {
352 i9e_complete_option(opts, ci, cr);
355 cr->filename_completion_desired = true;
358 static void touch_completer(struct i9e_completion_info *ci,
359 struct i9e_completion_result *cr)
361 char *opts[] = {"-n=", "-l=", "-y=", "-i=", "-a=", "-v", "-p", NULL};
363 if (ci->word[0] == '-')
364 i9e_complete_option(opts, ci, cr);
365 cr->filename_completion_desired = true;
368 static void cpsi_completer(struct i9e_completion_info *ci,
369 struct i9e_completion_result *cr)
371 char *opts[] = {"-a", "-y", "-i", "-l", "-n", "-v", NULL};
373 if (ci->word[0] == '-')
374 i9e_complete_option(opts, ci, cr);
375 cr->filename_completion_desired = true;
378 static void select_completer(struct i9e_completion_info *ci,
379 struct i9e_completion_result *cr)
381 char *mood_buf, *pl_buf, **moods, **playlists, **mops;
382 int num_moods, num_pl, i, n, ret;
384 ret = execute_client_command("lsmood", &mood_buf);
387 ret = execute_client_command("lspl", &pl_buf);
391 ret = create_argv(mood_buf, "\n", &moods);
395 ret = create_argv(pl_buf, "\n", &playlists);
399 n = num_moods + num_pl;
400 mops = para_malloc((n + 1) * sizeof(char *));
401 for (i = 0; i < num_moods; i++)
402 mops[i] = make_message("m/%s", moods[i]);
403 for (i = 0; i < num_pl; i++)
404 mops[num_moods + i] = make_message("p/%s", playlists[i]);
406 i9e_extract_completions(ci->word, mops, &cr->matches);
408 free_argv(playlists);
417 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
418 static void cmd ## blob_type ## _completer( \
419 struct i9e_completion_info *ci, \
420 struct i9e_completion_result *cr) \
421 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
423 DEFINE_BLOB_COMPLETER(add, mood)
424 DEFINE_BLOB_COMPLETER(add, lyr)
425 DEFINE_BLOB_COMPLETER(add, img)
426 DEFINE_BLOB_COMPLETER(add, pl)
427 DEFINE_BLOB_COMPLETER(cat, mood)
428 DEFINE_BLOB_COMPLETER(cat, lyr)
429 DEFINE_BLOB_COMPLETER(cat, img)
430 DEFINE_BLOB_COMPLETER(cat, pl)
431 DEFINE_BLOB_COMPLETER(ls, mood)
432 DEFINE_BLOB_COMPLETER(ls, lyr)
433 DEFINE_BLOB_COMPLETER(ls, img)
434 DEFINE_BLOB_COMPLETER(ls, pl)
435 DEFINE_BLOB_COMPLETER(rm, mood)
436 DEFINE_BLOB_COMPLETER(rm, lyr)
437 DEFINE_BLOB_COMPLETER(rm, img)
438 DEFINE_BLOB_COMPLETER(rm, pl)
439 DEFINE_BLOB_COMPLETER(mv, mood)
440 DEFINE_BLOB_COMPLETER(mv, lyr)
441 DEFINE_BLOB_COMPLETER(mv, img)
442 DEFINE_BLOB_COMPLETER(mv, pl)
444 static int client_i9e_line_handler(char *line)
448 client_disconnect(ct);
451 PARA_DEBUG_LOG("line handler: %s\n", line);
452 ret = make_client_argv(line);
455 ret = client_connect(ct, &sched, NULL, NULL);
458 i9e_attach_to_stdout(ct->btrn);
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);
504 para_log = stderr_log;
507 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
508 exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
512 __noreturn static void print_completions(void)
514 int ret = i9e_print_completions(completers);
515 exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
518 #else /* HAVE_READLINE */
520 __noreturn static void interactive_session(void)
522 PARA_EMERG_LOG("interactive sessions not available\n");
526 __noreturn static void print_completions(void)
528 PARA_EMERG_LOG("command completion not available\n");
532 #endif /* HAVE_READLINE */
534 static void supervisor_post_select(struct sched *s, struct task *t)
536 if (ct->task.error < 0) {
537 t->error = ct->task.error;
540 if (ct->status == CL_SENDING) {
541 stdin_set_defaults(&sit);
542 register_task(s, &sit.task);
543 t->error = -E_TASK_STARTED;
546 if (ct->status == CL_RECEIVING) {
547 stdout_set_defaults(&sot);
548 register_task(s, &sot.task);
549 t->error = -E_TASK_STARTED; return;
553 static struct task svt = {
554 .post_select = supervisor_post_select,
555 .status = "supervisor task"
559 * The client program to connect to para_server.
561 * \param argc Usual argument count.
562 * \param argv Usual argument vector.
564 * When called without a paraslash command, an interactive session is started.
565 * Otherwise, the client task and the supervisor task are started. The former
566 * communicates with para_server while the latter monitors whether the client
567 * task intends to read from stdin or write to stdout.
569 * Once it has been determined whether the client command corresponds to a
570 * stdin command (addmood, addimg, ..), either the stdin task or the stdout
571 * task is set up to replace the supervisor task.
573 * \return EXIT_SUCCESS or EXIT_FAILURE
575 * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
577 int main(int argc, char *argv[])
581 init_random_seed_or_die();
582 sched.default_timeout.tv_sec = 1;
584 ret = client_parse_config(argc, argv, &ct, &client_loglevel);
587 if (ct->conf.complete_given)
590 interactive_session(); /* does not return */
593 * We add buffer tree nodes for stdin and stdout even though
594 * only one of them will be needed. This simplifies the code
595 * a bit wrt. to the buffer tree setup.
597 sit.btrn = btr_new_node(&(struct btr_node_description)
598 EMBRACE(.name = "stdin"));
599 ret = client_connect(ct, &sched, sit.btrn, NULL);
602 sot.btrn = btr_new_node(&(struct btr_node_description)
603 EMBRACE(.name = "stdout", .parent = ct->btrn));
604 register_task(&sched, &svt);
605 ret = schedule(&sched);
606 if (ret >= 0 && ct->task.error < 0) {
607 switch(ct->task.error) {
608 /* these are not errors */
609 case -E_SERVER_CMD_SUCCESS:
615 default: ret = ct->task.error;
620 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
622 btr_remove_node(&sit.btrn);
623 btr_remove_node(&sot.btrn);
624 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;