afs: Document ->lpr of struct afs_callback_arg.
[paraslash.git] / client.c
1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file client.c The client program used to connect to para_server. */
4
5 #include <regex.h>
6 #include <signal.h>
7 #include <lopsub.h>
8
9 #include "client.lsg.h"
10 #include "para.h"
11 #include "list.h"
12 #include "sched.h"
13 #include "crypt.h"
14 #include "string.h"
15 #include "stdin.h"
16 #include "stdout.h"
17 #include "client.h"
18 #include "buffer_tree.h"
19 #include "error.h"
20 #include "version.h"
21
22 /** Array of error strings. */
23 DEFINE_PARA_ERRLIST;
24
25 static struct sched sched;
26 static struct client_task *ct;
27 static struct stdin_task sit;
28 static struct stdout_task sot;
29
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;
33
34 #ifdef HAVE_READLINE
35 #include "interactive.h"
36 #include "server_cmd.lsg.h"
37
38 struct exec_task {
39 struct task *task;
40 struct btr_node *btrn;
41 char *result_buf;
42 size_t result_size;
43 };
44
45 static void exec_pre_select(struct sched *s, void *context)
46 {
47 struct exec_task *et = context;
48 int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
49
50 if (ret != 0)
51 sched_min_delay(s);
52 }
53
54 static int exec_post_select(__a_unused struct sched *s, void *context)
55 {
56 struct exec_task *et = context;
57 struct btr_node *btrn = et->btrn;
58 char *buf;
59 size_t sz;
60 int ret;
61
62 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
63 if (ret <= 0)
64 return ret;
65 sz = btr_next_buffer(btrn, &buf);
66 if (sz <= 1)
67 goto out;
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';
72 out:
73 btr_consume(btrn, sz);
74 return 0;
75 }
76
77 /* Called from the line handler and the completers. This overwrites ct->lpr. */
78 static int create_merged_lpr(const char *line)
79 {
80 const struct lls_command *cmd = CLIENT_CMD_PTR;
81 int argc, ret;
82 char *cmdline, **argv, *errctx;
83 struct lls_parse_result *argv_lpr;
84 static struct lls_parse_result *orig_lpr;
85
86 if (!orig_lpr)
87 orig_lpr = ct->lpr;
88 ct->lpr = NULL;
89 cmdline = make_message("-- %s", line);
90 ret = create_shifted_argv(cmdline, " ", &argv);
91 free(cmdline);
92 if (ret < 0)
93 return ret;
94 argc = ret;
95 if (argc == 2) { /* no words (only blanks in line) */
96 free_argv(argv);
97 return 0;
98 }
99 argv[0] = para_strdup("--");
100 /*
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 orignal lpr.
104 */
105 ret = lls(lls_parse(argc, argv, cmd, &argv_lpr, &errctx));
106 free_argv(argv);
107 if (ret < 0)
108 goto fail;
109 ret = lls(lls_merge(orig_lpr, argv_lpr, cmd, &ct->lpr, &errctx));
110 lls_free_parse_result(argv_lpr, cmd);
111 if (ret < 0)
112 goto fail;
113 return 1;
114 fail:
115 if (errctx)
116 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
117 free(errctx);
118 assert(ret < 0);
119 return ret;
120 }
121
122 /* called from completers */
123 static int execute_client_command(const char *cmd, char **result)
124 {
125 int ret;
126 struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
127 struct exec_task exec_task = {
128 .result_buf = para_strdup(""),
129 .result_size = 1,
130 };
131 struct lls_parse_result *old_lpr = ct->lpr;
132
133 *result = NULL;
134 ret = create_merged_lpr(cmd);
135 if (ret <= 0)
136 goto out;
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,
144 }, &command_sched);
145 ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
146 if (ret < 0)
147 goto out;
148 schedule(&command_sched);
149 sched_shutdown(&command_sched);
150 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
151 ct->lpr = old_lpr;
152 *result = exec_task.result_buf;
153 btr_remove_node(&exec_task.btrn);
154 ret = 1;
155 out:
156 btr_remove_node(&exec_task.btrn);
157 if (ret < 0)
158 free(exec_task.result_buf);
159 return ret;
160 }
161
162 static int extract_matches_from_command(const char *word, char *cmd,
163 char ***matches)
164 {
165 char *buf, **sl;
166 int ret;
167
168 ret = execute_client_command(cmd, &buf);
169 if (ret < 0)
170 return ret;
171 ret = create_argv(buf, "\n", &sl);
172 free(buf);
173 if (ret < 0)
174 return ret;
175 ret = i9e_extract_completions(word, sl, matches);
176 free_argv(sl);
177 return ret;
178 }
179
180 static int complete_attributes(const char *word, char ***matches)
181 {
182 return extract_matches_from_command(word, "lsatt", matches);
183 }
184
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)
188 {
189 cr->filename_completion_desired = true;
190 }
191
192 static void generic_blob_complete(const char *blob_type,
193 struct i9e_completion_info *ci,
194 struct i9e_completion_result *cr)
195 {
196 char cmd[20];
197 sprintf(cmd, "ls%s", blob_type);
198 extract_matches_from_command(ci->word, cmd, &cr->matches);
199 }
200
201 static void complete_catblob(const char *blob_type,
202 struct i9e_completion_info *ci,
203 struct i9e_completion_result *cr)
204 {
205 generic_blob_complete(blob_type, ci, cr);
206 }
207
208 static void complete_lsblob(const char *blob_type,
209 struct i9e_completion_info *ci,
210 struct i9e_completion_result *cr)
211 {
212 char *opts[] = {LSG_SERVER_CMD_LSIMG_OPTS, NULL};
213
214 if (ci->word[0] == '-')
215 return i9e_complete_option(opts, ci, cr);
216 generic_blob_complete(blob_type, ci, cr);
217 }
218
219 static void complete_rmblob(const char *blob_type,
220 struct i9e_completion_info *ci,
221 struct i9e_completion_result *cr)
222 {
223 generic_blob_complete(blob_type, ci, cr);
224 }
225
226 static void complete_mvblob(const char *blob_type,
227 struct i9e_completion_info *ci,
228 struct i9e_completion_result *cr)
229 {
230 generic_blob_complete(blob_type, ci, cr);
231 }
232
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);
246 I9E_DUMMY_COMPLETER(tasks);
247
248 static struct i9e_completer completers[];
249
250 static void help_completer(struct i9e_completion_info *ci,
251 struct i9e_completion_result *result)
252 {
253 result->matches = i9e_complete_commands(ci->word, completers);
254 }
255
256 static void stat_completer(struct i9e_completion_info *ci,
257 struct i9e_completion_result *cr)
258 {
259 char *opts[] = {LSG_SERVER_CMD_STAT_OPTS, NULL};
260 i9e_complete_option(opts, ci, cr);
261 }
262
263 static void version_completer(struct i9e_completion_info *ci,
264 struct i9e_completion_result *cr)
265 {
266 char *opts[] = {LSG_SERVER_CMD_VERSION_OPTS, NULL};
267 i9e_complete_option(opts, ci, cr);
268 }
269
270 static void sender_completer(struct i9e_completion_info *ci,
271 struct i9e_completion_result *cr)
272 {
273 char *senders[] = {"http", "dccp", "udp", NULL};
274 char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
275 char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
276 char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
277 char *sender;
278 char **cmds;
279
280 //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
281 if (ci->word_num == 0 || ci->word_num > 3)
282 return;
283 if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
284 i9e_extract_completions(ci->word, senders, &cr->matches);
285 return;
286 }
287 sender = ci->argv[1];
288 //PARA_CRIT_LOG("sender: %s\n", sender);
289 if (strcmp(sender, "http") == 0)
290 cmds = http_cmds;
291 else if (strcmp(sender, "dccp") == 0)
292 cmds = dccp_cmds;
293 else if (strcmp(sender, "udp") == 0)
294 cmds = udp_cmds;
295 else
296 return;
297 i9e_extract_completions(ci->word, cmds, &cr->matches);
298 }
299
300 static void add_completer(struct i9e_completion_info *ci,
301 struct i9e_completion_result *cr)
302 {
303 char *opts[] = {LSG_SERVER_CMD_ADD_OPTS, NULL};
304
305 if (ci->word[0] == '-')
306 i9e_complete_option(opts, ci, cr);
307 cr->filename_completion_desired = true;
308 }
309
310 static void ls_completer(struct i9e_completion_info *ci,
311 struct i9e_completion_result *cr)
312 {
313 char *opts[] = {LSG_SERVER_CMD_LS_OPTS, NULL};
314 if (ci->word[0] == '-')
315 i9e_complete_option(opts, ci, cr);
316 cr->filename_completion_desired = true;
317 }
318
319 static void setatt_completer(struct i9e_completion_info *ci,
320 struct i9e_completion_result *cr)
321 {
322 char *buf, **sl;
323 int i, ret, num_atts;
324
325 if (ci->word_num == 0)
326 return;
327
328 if (*ci->word == '/' || *ci->word == '\0')
329 cr->filename_completion_desired = true;
330 if (*ci->word == '/')
331 return;
332 ret = execute_client_command("lsatt", &buf);
333 if (ret < 0)
334 return;
335 ret = create_argv(buf, "\n", &sl);
336 if (ret < 0)
337 goto out;
338 num_atts = ret;
339 sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
340 for (i = 0; i < num_atts; i++) {
341 char *orig = sl[i];
342 sl[i] = make_message("%s+", orig);
343 sl[num_atts + i] = make_message("%s-", orig);
344 free(orig);
345 }
346 sl[2 * num_atts] = NULL;
347 i9e_extract_completions(ci->word, sl, &cr->matches);
348 out:
349 free(buf);
350 free_argv(sl);
351 }
352
353 static void lsatt_completer(struct i9e_completion_info *ci,
354 struct i9e_completion_result *cr)
355 {
356 char *opts[] = {LSG_SERVER_CMD_LSATT_OPTS, NULL};
357 i9e_complete_option(opts, ci, cr);
358 }
359
360 static void mvatt_completer(struct i9e_completion_info *ci,
361 struct i9e_completion_result *cr)
362 {
363 complete_attributes(ci->word, &cr->matches);
364 }
365
366 static void rmatt_completer(struct i9e_completion_info *ci,
367 struct i9e_completion_result *cr)
368 {
369 complete_attributes(ci->word, &cr->matches);
370 }
371
372 static void check_completer(struct i9e_completion_info *ci,
373 struct i9e_completion_result *cr)
374 {
375 char *opts[] = {LSG_SERVER_CMD_CHECK_OPTS, NULL};
376 i9e_complete_option(opts, ci, cr);
377 }
378
379 static void rm_completer(struct i9e_completion_info *ci,
380 struct i9e_completion_result *cr)
381 {
382 char *opts[] = {LSG_SERVER_CMD_RM_OPTS, NULL};
383
384 if (ci->word[0] == '-') {
385 i9e_complete_option(opts, ci, cr);
386 return;
387 }
388 cr->filename_completion_desired = true;
389 }
390
391 static void touch_completer(struct i9e_completion_info *ci,
392 struct i9e_completion_result *cr)
393 {
394 char *opts[] = {LSG_SERVER_CMD_TOUCH_OPTS, NULL};
395
396 if (ci->word[0] == '-')
397 i9e_complete_option(opts, ci, cr);
398 cr->filename_completion_desired = true;
399 }
400
401 static void cpsi_completer(struct i9e_completion_info *ci,
402 struct i9e_completion_result *cr)
403 {
404 char *opts[] = {LSG_SERVER_CMD_CPSI_OPTS, NULL};
405
406 if (ci->word[0] == '-')
407 i9e_complete_option(opts, ci, cr);
408 cr->filename_completion_desired = true;
409 }
410
411 static void select_completer(struct i9e_completion_info *ci,
412 struct i9e_completion_result *cr)
413 {
414 char *mood_buf, *pl_buf, **moods, **playlists, **mops;
415 int num_moods, num_pl, i, n, ret;
416
417 ret = execute_client_command("lsmood", &mood_buf);
418 if (ret < 0)
419 return;
420 ret = execute_client_command("lspl", &pl_buf);
421 if (ret < 0)
422 goto free_mood_buf;
423
424 ret = create_argv(mood_buf, "\n", &moods);
425 if (ret < 0)
426 goto free_pl_buf;
427 num_moods = ret;
428 ret = create_argv(pl_buf, "\n", &playlists);
429 if (ret < 0)
430 goto free_moods;
431 num_pl = ret;
432 n = num_moods + num_pl;
433 mops = para_malloc((n + 1) * sizeof(char *));
434 for (i = 0; i < num_moods; i++)
435 mops[i] = make_message("m/%s", moods[i]);
436 for (i = 0; i < num_pl; i++)
437 mops[num_moods + i] = make_message("p/%s", playlists[i]);
438 mops[n] = NULL;
439 i9e_extract_completions(ci->word, mops, &cr->matches);
440 free_argv(mops);
441 free_argv(playlists);
442 free_moods:
443 free_argv(moods);
444 free_pl_buf:
445 free(pl_buf);
446 free_mood_buf:
447 free(mood_buf);
448 }
449
450 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
451 static void cmd ## blob_type ## _completer( \
452 struct i9e_completion_info *ci, \
453 struct i9e_completion_result *cr) \
454 {complete_ ## cmd ## blob(#blob_type, ci, cr);}
455
456 DEFINE_BLOB_COMPLETER(add, mood)
457 DEFINE_BLOB_COMPLETER(add, lyr)
458 DEFINE_BLOB_COMPLETER(add, img)
459 DEFINE_BLOB_COMPLETER(add, pl)
460 DEFINE_BLOB_COMPLETER(cat, mood)
461 DEFINE_BLOB_COMPLETER(cat, lyr)
462 DEFINE_BLOB_COMPLETER(cat, img)
463 DEFINE_BLOB_COMPLETER(cat, pl)
464 DEFINE_BLOB_COMPLETER(ls, mood)
465 DEFINE_BLOB_COMPLETER(ls, lyr)
466 DEFINE_BLOB_COMPLETER(ls, img)
467 DEFINE_BLOB_COMPLETER(ls, pl)
468 DEFINE_BLOB_COMPLETER(rm, mood)
469 DEFINE_BLOB_COMPLETER(rm, lyr)
470 DEFINE_BLOB_COMPLETER(rm, img)
471 DEFINE_BLOB_COMPLETER(rm, pl)
472 DEFINE_BLOB_COMPLETER(mv, mood)
473 DEFINE_BLOB_COMPLETER(mv, lyr)
474 DEFINE_BLOB_COMPLETER(mv, img)
475 DEFINE_BLOB_COMPLETER(mv, pl)
476
477 static int client_i9e_line_handler(char *line)
478 {
479 int ret;
480 static bool first = true;
481
482 if (first)
483 first = false;
484 else
485 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
486 ret = create_merged_lpr(line);
487 if (ret <= 0)
488 return ret;
489 ret = client_connect(ct, &sched, NULL, NULL);
490 if (ret < 0)
491 return ret;
492 i9e_attach_to_stdout(ct->btrn[0]);
493 return 1;
494 }
495
496 static struct i9e_completer completers[] = {
497 #define LSG_SERVER_CMD_CMD(_name) {.name = #_name, \
498 .completer = _name ## _completer}
499 LSG_SERVER_CMD_SUBCOMMANDS
500 #undef LSG_SERVER_CMD_CMD
501 {.name = NULL}
502 };
503
504 __noreturn static void interactive_session(void)
505 {
506 int ret;
507 struct sigaction act;
508 struct i9e_client_info ici = {
509 .fds = {0, 1, 2},
510 .prompt = "para_client> ",
511 .line_handler = client_i9e_line_handler,
512 .loglevel = client_loglevel,
513 .completers = completers,
514 };
515
516 PARA_NOTICE_LOG("\n%s\n", version_text("client"));
517 if (CLIENT_OPT_GIVEN(HISTORY_FILE, ct->lpr))
518 ici.history_file = para_strdup(CLIENT_OPT_STRING_VAL(
519 HISTORY_FILE, ct->lpr));
520 else {
521 char *home = para_homedir();
522 ici.history_file = make_message("%s/.paraslash/client.history",
523 home);
524 free(home);
525 }
526 act.sa_handler = i9e_signal_dispatch;
527 sigemptyset(&act.sa_mask);
528 act.sa_flags = 0;
529 sigaction(SIGINT, &act, NULL);
530 sched.select_function = i9e_select;
531
532 ret = i9e_open(&ici, &sched);
533 if (ret < 0)
534 goto out;
535 para_log = i9e_log;
536 ret = schedule(&sched);
537 sched_shutdown(&sched);
538 i9e_close();
539 para_log = stderr_log;
540 out:
541 if (ret < 0)
542 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
543 exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
544 //client_close(ct);
545 }
546
547 __noreturn static void print_completions(void)
548 {
549 int ret;
550
551 ret = i9e_print_completions(completers);
552 exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
553 }
554
555 #else /* HAVE_READLINE */
556
557 __noreturn static void interactive_session(void)
558 {
559 PARA_EMERG_LOG("interactive sessions not available\n");
560 exit(EXIT_FAILURE);
561 }
562
563 __noreturn static void print_completions(void)
564 {
565 PARA_EMERG_LOG("command completion not available\n");
566 exit(EXIT_FAILURE);
567 }
568
569 #endif /* HAVE_READLINE */
570
571 struct supervisor_task {
572 bool stdout_task_started;
573 struct task *task;
574 };
575
576 static int supervisor_post_select(struct sched *s, void *context)
577 {
578 struct supervisor_task *svt = context;
579 int ret = task_status(ct->task);
580
581 if (ret < 0)
582 return ret;
583 if (!svt->stdout_task_started && ct->status == CL_EXECUTING) {
584 stdout_task_register(&sot, s);
585 svt->stdout_task_started = true;
586 return 1;
587 }
588 if (ct->status == CL_SENDING) {
589 stdin_task_register(&sit, s);
590 return -E_TASK_STARTED;
591 }
592 return 0;
593 }
594
595 static struct supervisor_task supervisor_task;
596
597 /**
598 * The client program to connect to para_server.
599 *
600 * \param argc Usual argument count.
601 * \param argv Usual argument vector.
602 *
603 * When called without a paraslash command, an interactive session is started.
604 * Otherwise, the client task and the supervisor task are started. The former
605 * communicates with para_server while the latter monitors whether the client
606 * task intends to read from stdin or write to stdout.
607 *
608 * Once it has been determined whether the client command corresponds to a
609 * stdin command (addmood, addimg, ..), either the stdin task or the stdout
610 * task is set up to replace the supervisor task.
611 *
612 * \return EXIT_SUCCESS or EXIT_FAILURE
613 *
614 * \sa \ref client_open(), \ref stdin.c, \ref stdout.c, para_client(1),
615 * para_server(1).
616 */
617 int main(int argc, char *argv[])
618 {
619 int ret;
620
621 init_random_seed_or_die();
622 sched.default_timeout.tv_sec = 1;
623
624 ret = client_parse_config(argc, argv, &ct, &client_loglevel);
625 if (ret < 0)
626 goto out;
627 if (CLIENT_OPT_GIVEN(COMPLETE, ct->lpr))
628 print_completions();
629 if (ret == 0)
630 interactive_session(); /* does not return */
631
632 /*
633 * We add buffer tree nodes for stdin and stdout even though
634 * only one of them will be needed. This simplifies the code
635 * a bit wrt. to the buffer tree setup.
636 */
637 sit.btrn = btr_new_node(&(struct btr_node_description)
638 EMBRACE(.name = "stdin"));
639 ret = client_connect(ct, &sched, sit.btrn, NULL);
640 if (ret < 0)
641 goto out;
642 sot.btrn = btr_new_node(&(struct btr_node_description)
643 EMBRACE(.name = "stdout", .parent = ct->btrn[0]));
644 supervisor_task.task = task_register(&(struct task_info) {
645 .name = "supervisor",
646 .post_select = supervisor_post_select,
647 .context = &supervisor_task,
648 }, &sched);
649
650 ret = schedule(&sched);
651 if (ret >= 0) {
652 ret = task_status(ct->task);
653 if (ret < 0) {
654 switch (ret) {
655 /* these are not errors */
656 case -E_SERVER_CMD_SUCCESS:
657 case -E_EOF:
658 case -E_SERVER_EOF:
659 case -E_BTR_EOF:
660 ret = 0;
661 break;
662 default: ret = -E_SERVER_CMD_FAILURE;
663 }
664 }
665 }
666 sched_shutdown(&sched);
667 out:
668 if (ret < 0)
669 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
670 client_close(ct);
671 btr_remove_node(&sit.btrn);
672 btr_remove_node(&sot.btrn);
673 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
674 }