2 * Copyright (C) 1997-2013 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 int 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
);
68 sz
= btr_next_buffer(btrn
, &buf
);
71 et
->result_buf
= para_realloc(et
->result_buf
, et
->result_size
+ sz
- 1);
72 memcpy(et
->result_buf
+ et
->result_size
- 1, buf
, sz
- 1);
73 et
->result_size
+= sz
- 1;
74 et
->result_buf
[et
->result_size
- 1] = '\0';
76 btr_consume(btrn
, sz
);
80 static int make_client_argv(const char *line
)
84 free_argv(ct
->conf
.inputs
);
85 ret
= create_argv(line
, " ", &ct
->conf
.inputs
);
87 ct
->conf
.inputs_num
= ret
;
91 static int execute_client_command(const char *cmd
, char **result
)
94 struct sched command_sched
= {.default_timeout
= {.tv_sec
= 1}};
95 struct exec_task exec_task
= {
97 .pre_select
= exec_pre_select
,
98 .post_select
= exec_post_select
,
99 .status
= "client exec task",
101 .result_buf
= para_strdup(""),
105 ret
= make_client_argv(cmd
);
108 exec_task
.btrn
= btr_new_node(&(struct btr_node_description
)
109 EMBRACE(.name
= "exec_collect"));
110 register_task(&command_sched
, &exec_task
.task
);
111 ret
= client_connect(ct
, &command_sched
, NULL
, exec_task
.btrn
);
114 schedule(&command_sched
);
115 *result
= exec_task
.result_buf
;
116 btr_remove_node(&exec_task
.btrn
);
117 client_disconnect(ct
);
120 btr_remove_node(&exec_task
.btrn
);
122 free(exec_task
.result_buf
);
126 static int extract_matches_from_command(const char *word
, char *cmd
,
132 ret
= execute_client_command(cmd
, &buf
);
135 ret
= create_argv(buf
, "\n", &sl
);
139 ret
= i9e_extract_completions(word
, sl
, matches
);
144 static int complete_attributes(const char *word
, char ***matches
)
146 return extract_matches_from_command(word
, "lsatt", matches
);
149 static void complete_addblob(__a_unused
const char *blob_type
,
150 __a_unused
struct i9e_completion_info
*ci
,
151 __a_unused
struct i9e_completion_result
*cr
)
153 cr
->filename_completion_desired
= true;
156 static void generic_blob_complete(const char *blob_type
,
157 struct i9e_completion_info
*ci
,
158 struct i9e_completion_result
*cr
)
161 sprintf(cmd
, "ls%s", blob_type
);
162 extract_matches_from_command(ci
->word
, cmd
, &cr
->matches
);
165 static void complete_catblob(const char *blob_type
,
166 struct i9e_completion_info
*ci
,
167 struct i9e_completion_result
*cr
)
169 generic_blob_complete(blob_type
, ci
, cr
);
172 static void complete_lsblob(const char *blob_type
,
173 struct i9e_completion_info
*ci
,
174 struct i9e_completion_result
*cr
)
176 char *opts
[] = {"-i", "-l", "-r", NULL
};
178 if (ci
->word
[0] == '-')
179 return i9e_complete_option(opts
, ci
, cr
);
180 generic_blob_complete(blob_type
, ci
, cr
);
183 static void complete_rmblob(const char *blob_type
,
184 struct i9e_completion_info
*ci
,
185 struct i9e_completion_result
*cr
)
187 generic_blob_complete(blob_type
, ci
, cr
);
190 static void complete_mvblob(const char *blob_type
,
191 struct i9e_completion_info
*ci
,
192 struct i9e_completion_result
*cr
)
194 generic_blob_complete(blob_type
, ci
, cr
);
197 /* these don't need any completions */
198 I9E_DUMMY_COMPLETER(ff
);
199 I9E_DUMMY_COMPLETER(hup
);
200 I9E_DUMMY_COMPLETER(jmp
);
201 I9E_DUMMY_COMPLETER(next
);
202 I9E_DUMMY_COMPLETER(nomore
);
203 I9E_DUMMY_COMPLETER(pause
);
204 I9E_DUMMY_COMPLETER(play
);
205 I9E_DUMMY_COMPLETER(si
);
206 I9E_DUMMY_COMPLETER(term
);
207 I9E_DUMMY_COMPLETER(version
);
208 I9E_DUMMY_COMPLETER(stop
);
209 I9E_DUMMY_COMPLETER(addatt
);
210 I9E_DUMMY_COMPLETER(init
);
212 static struct i9e_completer completers
[];
214 static void help_completer(struct i9e_completion_info
*ci
,
215 struct i9e_completion_result
*result
)
217 result
->matches
= i9e_complete_commands(ci
->word
, completers
);
220 static void stat_completer(struct i9e_completion_info
*ci
,
221 struct i9e_completion_result
*cr
)
223 char *opts
[] = {"-n=", "-p", NULL
};
224 //PARA_CRIT_LOG("word: %s\n", ci->word);
225 i9e_complete_option(opts
, ci
, cr
);
228 static void sender_completer(struct i9e_completion_info
*ci
,
229 struct i9e_completion_result
*cr
)
231 char *senders
[] = {"http", "dccp", "udp", NULL
};
232 char *http_cmds
[] = {"on", "off", "allow", "deny", "help", NULL
};
233 char *dccp_cmds
[] = {"on", "off", "allow", "deny", "help", NULL
};
234 char *udp_cmds
[] ={"on", "off", "add", "delete", "help", NULL
};
238 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
239 if (ci
->word_num
== 0 || ci
->word_num
> 3)
241 if (ci
->word_num
== 1 || (ci
->word_num
== 2 && *ci
->word
!= '\0')) {
242 i9e_extract_completions(ci
->word
, senders
, &cr
->matches
);
245 sender
= ci
->argv
[1];
246 //PARA_CRIT_LOG("sender: %s\n", sender);
247 if (strcmp(sender
, "http") == 0)
249 else if (strcmp(sender
, "dccp") == 0)
251 else if (strcmp(sender
, "udp") == 0)
255 i9e_extract_completions(ci
->word
, cmds
, &cr
->matches
);
258 static void add_completer(struct i9e_completion_info
*ci
,
259 struct i9e_completion_result
*cr
)
261 char *opts
[] = {"-a", "-l", "-f", "-v", "--", NULL
};
263 if (ci
->word
[0] == '-')
264 i9e_complete_option(opts
, ci
, cr
);
265 cr
->filename_completion_desired
= true;
268 static void ls_completer(struct i9e_completion_info
*ci
,
269 struct i9e_completion_result
*cr
)
272 "--", "-l", "-ls", "-ll", "-lv", "-lp", "-lm", "-lc", "-p",
273 "-a", "-r", "-d", "-sp", "-sl", "-ss", "-sn", "-sf", "-sc",
274 "-si", "-sy", "-sb", "-sd", "-sa", NULL
276 if (ci
->word
[0] == '-')
277 i9e_complete_option(opts
, ci
, cr
);
278 cr
->filename_completion_desired
= true;
281 static void setatt_completer(struct i9e_completion_info
*ci
,
282 struct i9e_completion_result
*cr
)
285 int i
, ret
, num_atts
;
287 if (ci
->word_num
== 0)
290 if (*ci
->word
== '/' || *ci
->word
== '\0')
291 cr
->filename_completion_desired
= true;
292 if (*ci
->word
== '/')
294 ret
= execute_client_command("lsatt", &buf
);
297 ret
= create_argv(buf
, "\n", &sl
);
301 sl
= para_realloc(sl
, (2 * num_atts
+ 1) * sizeof(char *));
302 for (i
= 0; i
< num_atts
; i
++) {
304 sl
[i
] = make_message("%s+", orig
);
305 sl
[num_atts
+ i
] = make_message("%s-", orig
);
308 sl
[2 * num_atts
] = NULL
;
309 i9e_extract_completions(ci
->word
, sl
, &cr
->matches
);
315 static void lsatt_completer(struct i9e_completion_info
*ci
,
316 struct i9e_completion_result
*cr
)
318 char *opts
[] = {"-i", "-l", "-r", NULL
};
320 if (ci
->word
[0] == '-')
321 i9e_complete_option(opts
, ci
, cr
);
323 complete_attributes(ci
->word
, &cr
->matches
);
326 static void mvatt_completer(struct i9e_completion_info
*ci
,
327 struct i9e_completion_result
*cr
)
329 complete_attributes(ci
->word
, &cr
->matches
);
332 static void rmatt_completer(struct i9e_completion_info
*ci
,
333 struct i9e_completion_result
*cr
)
335 complete_attributes(ci
->word
, &cr
->matches
);
338 static void check_completer(struct i9e_completion_info
*ci
,
339 struct i9e_completion_result
*cr
)
341 char *opts
[] = {"-a", "-m", "-p", NULL
};
342 i9e_complete_option(opts
, ci
, cr
);
345 static void rm_completer(struct i9e_completion_info
*ci
,
346 struct i9e_completion_result
*cr
)
348 char *opts
[] = {"-v", "-f", "-p", NULL
};
350 if (ci
->word
[0] == '-') {
351 i9e_complete_option(opts
, ci
, cr
);
354 cr
->filename_completion_desired
= true;
357 static void touch_completer(struct i9e_completion_info
*ci
,
358 struct i9e_completion_result
*cr
)
360 char *opts
[] = {"-n=", "-l=", "-y=", "-i=", "-a=", "-v", "-p", NULL
};
362 if (ci
->word
[0] == '-')
363 i9e_complete_option(opts
, ci
, cr
);
364 cr
->filename_completion_desired
= true;
367 static void cpsi_completer(struct i9e_completion_info
*ci
,
368 struct i9e_completion_result
*cr
)
370 char *opts
[] = {"-a", "-y", "-i", "-l", "-n", "-v", NULL
};
372 if (ci
->word
[0] == '-')
373 i9e_complete_option(opts
, ci
, cr
);
374 cr
->filename_completion_desired
= true;
377 static void select_completer(struct i9e_completion_info
*ci
,
378 struct i9e_completion_result
*cr
)
380 char *mood_buf
, *pl_buf
, **moods
, **playlists
, **mops
;
381 int num_moods
, num_pl
, i
, n
, ret
;
383 ret
= execute_client_command("lsmood", &mood_buf
);
386 ret
= execute_client_command("lspl", &pl_buf
);
390 ret
= create_argv(mood_buf
, "\n", &moods
);
394 ret
= create_argv(pl_buf
, "\n", &playlists
);
398 n
= num_moods
+ num_pl
;
399 mops
= para_malloc((n
+ 1) * sizeof(char *));
400 for (i
= 0; i
< num_moods
; i
++)
401 mops
[i
] = make_message("m/%s", moods
[i
]);
402 for (i
= 0; i
< num_pl
; i
++)
403 mops
[num_moods
+ i
] = make_message("p/%s", playlists
[i
]);
405 i9e_extract_completions(ci
->word
, mops
, &cr
->matches
);
407 free_argv(playlists
);
416 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
417 static void cmd ## blob_type ## _completer( \
418 struct i9e_completion_info *ci, \
419 struct i9e_completion_result *cr) \
420 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
422 DEFINE_BLOB_COMPLETER(add
, mood
)
423 DEFINE_BLOB_COMPLETER(add
, lyr
)
424 DEFINE_BLOB_COMPLETER(add
, img
)
425 DEFINE_BLOB_COMPLETER(add
, pl
)
426 DEFINE_BLOB_COMPLETER(cat
, mood
)
427 DEFINE_BLOB_COMPLETER(cat
, lyr
)
428 DEFINE_BLOB_COMPLETER(cat
, img
)
429 DEFINE_BLOB_COMPLETER(cat
, pl
)
430 DEFINE_BLOB_COMPLETER(ls
, mood
)
431 DEFINE_BLOB_COMPLETER(ls
, lyr
)
432 DEFINE_BLOB_COMPLETER(ls
, img
)
433 DEFINE_BLOB_COMPLETER(ls
, pl
)
434 DEFINE_BLOB_COMPLETER(rm
, mood
)
435 DEFINE_BLOB_COMPLETER(rm
, lyr
)
436 DEFINE_BLOB_COMPLETER(rm
, img
)
437 DEFINE_BLOB_COMPLETER(rm
, pl
)
438 DEFINE_BLOB_COMPLETER(mv
, mood
)
439 DEFINE_BLOB_COMPLETER(mv
, lyr
)
440 DEFINE_BLOB_COMPLETER(mv
, img
)
441 DEFINE_BLOB_COMPLETER(mv
, pl
)
443 static int client_i9e_line_handler(char *line
)
447 client_disconnect(ct
);
448 PARA_DEBUG_LOG("line: %s\n", line
);
449 ret
= make_client_argv(line
);
452 ret
= client_connect(ct
, &sched
, NULL
, NULL
);
455 i9e_attach_to_stdout(ct
->btrn
[0]);
459 static struct i9e_completer completers
[] = {
465 __noreturn
static void interactive_session(void)
469 struct sigaction act
;
470 struct i9e_client_info ici
= {
472 .prompt
= "para_client> ",
473 .line_handler
= client_i9e_line_handler
,
474 .loglevel
= client_loglevel
,
475 .completers
= completers
,
478 PARA_NOTICE_LOG("\n%s\n", version_text("client"));
479 if (ct
->conf
.history_file_given
)
480 history_file
= para_strdup(ct
->conf
.history_file_arg
);
482 char *home
= para_homedir();
483 history_file
= make_message("%s/.paraslash/client.history",
487 ici
.history_file
= history_file
;
489 act
.sa_handler
= i9e_signal_dispatch
;
490 sigemptyset(&act
.sa_mask
);
492 sigaction(SIGINT
, &act
, NULL
);
493 sched
.select_function
= i9e_select
;
495 ret
= i9e_open(&ici
, &sched
);
499 ret
= schedule(&sched
);
501 para_log
= stderr_log
;
504 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
505 exit(ret
< 0? EXIT_FAILURE
: EXIT_SUCCESS
);
509 __noreturn
static void print_completions(void)
511 int ret
= i9e_print_completions(completers
);
512 exit(ret
<= 0? EXIT_FAILURE
: EXIT_SUCCESS
);
515 #else /* HAVE_READLINE */
517 __noreturn
static void interactive_session(void)
519 PARA_EMERG_LOG("interactive sessions not available\n");
523 __noreturn
static void print_completions(void)
525 PARA_EMERG_LOG("command completion not available\n");
529 #endif /* HAVE_READLINE */
531 struct supervisor_task
{
532 bool stdout_task_started
;
536 static int supervisor_post_select(struct sched
*s
, struct task
*t
)
538 struct supervisor_task
*svt
= container_of(t
, struct supervisor_task
,
541 if (ct
->task
.error
< 0)
542 return ct
->task
.error
;
543 if (!svt
->stdout_task_started
&& ct
->status
== CL_EXECUTING
) {
544 stdout_set_defaults(&sot
);
545 register_task(s
, &sot
.task
);
546 svt
->stdout_task_started
= true;
549 if (ct
->status
== CL_SENDING
) {
550 stdin_set_defaults(&sit
);
551 register_task(s
, &sit
.task
);
552 return -E_TASK_STARTED
;
557 static struct supervisor_task supervisor_task
= {
559 .post_select
= supervisor_post_select
,
560 .status
= "supervisor task"
565 * The client program to connect to para_server.
567 * \param argc Usual argument count.
568 * \param argv Usual argument vector.
570 * When called without a paraslash command, an interactive session is started.
571 * Otherwise, the client task and the supervisor task are started. The former
572 * communicates with para_server while the latter monitors whether the client
573 * task intends to read from stdin or write to stdout.
575 * Once it has been determined whether the client command corresponds to a
576 * stdin command (addmood, addimg, ..), either the stdin task or the stdout
577 * task is set up to replace the supervisor task.
579 * \return EXIT_SUCCESS or EXIT_FAILURE
581 * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
583 int main(int argc
, char *argv
[])
587 init_random_seed_or_die();
588 sched
.default_timeout
.tv_sec
= 1;
590 ret
= client_parse_config(argc
, argv
, &ct
, &client_loglevel
);
593 if (ct
->conf
.complete_given
)
596 interactive_session(); /* does not return */
599 * We add buffer tree nodes for stdin and stdout even though
600 * only one of them will be needed. This simplifies the code
601 * a bit wrt. to the buffer tree setup.
603 sit
.btrn
= btr_new_node(&(struct btr_node_description
)
604 EMBRACE(.name
= "stdin"));
605 ret
= client_connect(ct
, &sched
, sit
.btrn
, NULL
);
608 sot
.btrn
= btr_new_node(&(struct btr_node_description
)
609 EMBRACE(.name
= "stdout", .parent
= ct
->btrn
[0]));
610 register_task(&sched
, &supervisor_task
.task
);
611 ret
= schedule(&sched
);
612 if (ret
>= 0 && ct
->task
.error
< 0) {
613 switch(ct
->task
.error
) {
614 /* these are not errors */
615 case -E_SERVER_CMD_SUCCESS
:
621 default: ret
= -E_SERVER_CMD_FAILURE
;
626 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
628 btr_remove_node(&sit
.btrn
);
629 btr_remove_node(&sot
.btrn
);
630 return ret
< 0? EXIT_FAILURE
: EXIT_SUCCESS
;