paraslash 0.7.3
[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
247 static struct i9e_completer completers[];
248
249 static void help_completer(struct i9e_completion_info *ci,
250                 struct i9e_completion_result *cr)
251 {
252         char *opts[] = {LSG_SERVER_CMD_HELP_OPTS, NULL};
253
254         if (ci->word[0] == '-') {
255                 i9e_complete_option(opts, ci, cr);
256                 return;
257         }
258         cr->matches = i9e_complete_commands(ci->word, completers);
259 }
260
261 static void stat_completer(struct i9e_completion_info *ci,
262                 struct i9e_completion_result *cr)
263 {
264         char *opts[] = {LSG_SERVER_CMD_STAT_OPTS, NULL};
265         i9e_complete_option(opts, ci, cr);
266 }
267
268 static void version_completer(struct i9e_completion_info *ci,
269                 struct i9e_completion_result *cr)
270 {
271         char *opts[] = {LSG_SERVER_CMD_VERSION_OPTS, NULL};
272         i9e_complete_option(opts, ci, cr);
273 }
274
275 static void sender_completer(struct i9e_completion_info *ci,
276                 struct i9e_completion_result *cr)
277 {
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};
282         char *sender;
283         char **cmds;
284
285         //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
286         if (ci->word_num == 0 || ci->word_num > 3)
287                 return;
288         if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
289                 i9e_extract_completions(ci->word, senders, &cr->matches);
290                 return;
291         }
292         sender = ci->argv[1];
293         //PARA_CRIT_LOG("sender: %s\n", sender);
294         if (strcmp(sender, "http") == 0)
295                 cmds = http_cmds;
296         else if (strcmp(sender, "dccp") == 0)
297                 cmds = dccp_cmds;
298         else if (strcmp(sender, "udp") == 0)
299                 cmds = udp_cmds;
300         else
301                 return;
302         i9e_extract_completions(ci->word, cmds, &cr->matches);
303 }
304
305 static void add_completer(struct i9e_completion_info *ci,
306                 struct i9e_completion_result *cr)
307 {
308         char *opts[] = {LSG_SERVER_CMD_ADD_OPTS, NULL};
309
310         if (ci->word[0] == '-')
311                 i9e_complete_option(opts, ci, cr);
312         cr->filename_completion_desired = true;
313 }
314
315 static void ls_completer(struct i9e_completion_info *ci,
316                 struct i9e_completion_result *cr)
317 {
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;
322 }
323
324 static void setatt_completer(struct i9e_completion_info *ci,
325                 struct i9e_completion_result *cr)
326 {
327         char *buf, **sl;
328         int i, ret, num_atts;
329
330         if (ci->word_num == 0)
331                 return;
332
333         if (*ci->word == '/' || *ci->word == '\0')
334                 cr->filename_completion_desired = true;
335         if (*ci->word == '/')
336                 return;
337         ret = execute_client_command("lsatt", &buf);
338         if (ret < 0)
339                 return;
340         ret = create_argv(buf, "\n", &sl);
341         if (ret < 0)
342                 goto out;
343         num_atts = ret;
344         sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
345         for (i = 0; i < num_atts; i++) {
346                 char *orig = sl[i];
347                 sl[i] = make_message("%s+", orig);
348                 sl[num_atts + i] = make_message("%s-", orig);
349                 free(orig);
350         }
351         sl[2 * num_atts] = NULL;
352         i9e_extract_completions(ci->word, sl, &cr->matches);
353 out:
354         free(buf);
355         free_argv(sl);
356 }
357
358 static void lsatt_completer(struct i9e_completion_info *ci,
359                 struct i9e_completion_result *cr)
360 {
361         char *opts[] = {LSG_SERVER_CMD_LSATT_OPTS, NULL};
362         i9e_complete_option(opts, ci, cr);
363 }
364
365 static void mvatt_completer(struct i9e_completion_info *ci,
366                 struct i9e_completion_result *cr)
367 {
368         complete_attributes(ci->word, &cr->matches);
369 }
370
371 static void rmatt_completer(struct i9e_completion_info *ci,
372                 struct i9e_completion_result *cr)
373 {
374         complete_attributes(ci->word, &cr->matches);
375 }
376
377 static void check_completer(struct i9e_completion_info *ci,
378                 struct i9e_completion_result *cr)
379 {
380         char *opts[] = {LSG_SERVER_CMD_CHECK_OPTS, NULL};
381         i9e_complete_option(opts, ci, cr);
382 }
383
384 static void rm_completer(struct i9e_completion_info *ci,
385                 struct i9e_completion_result *cr)
386 {
387         char *opts[] = {LSG_SERVER_CMD_RM_OPTS, NULL};
388
389         if (ci->word[0] == '-') {
390                 i9e_complete_option(opts, ci, cr);
391                 return;
392         }
393         cr->filename_completion_desired = true;
394 }
395
396 static void touch_completer(struct i9e_completion_info *ci,
397                 struct i9e_completion_result *cr)
398 {
399         char *opts[] = {LSG_SERVER_CMD_TOUCH_OPTS, NULL};
400
401         if (ci->word[0] == '-')
402                 i9e_complete_option(opts, ci, cr);
403         cr->filename_completion_desired = true;
404 }
405
406 static void cpsi_completer(struct i9e_completion_info *ci,
407                 struct i9e_completion_result *cr)
408 {
409         char *opts[] = {LSG_SERVER_CMD_CPSI_OPTS, NULL};
410
411         if (ci->word[0] == '-')
412                 i9e_complete_option(opts, ci, cr);
413         cr->filename_completion_desired = true;
414 }
415
416 static void select_completer(struct i9e_completion_info *ci,
417                 struct i9e_completion_result *cr)
418 {
419         char *mood_buf, *pl_buf, **moods, **playlists, **mops;
420         int num_moods, num_pl, i, n, ret;
421
422         ret = execute_client_command("lsmood", &mood_buf);
423         if (ret < 0)
424                 return;
425         ret = execute_client_command("lspl", &pl_buf);
426         if (ret < 0)
427                 goto free_mood_buf;
428
429         ret = create_argv(mood_buf, "\n", &moods);
430         if (ret < 0)
431                 goto free_pl_buf;
432         num_moods = ret;
433         ret = create_argv(pl_buf, "\n", &playlists);
434         if (ret < 0)
435                 goto free_moods;
436         num_pl = ret;
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]);
443         mops[n] = NULL;
444         i9e_extract_completions(ci->word, mops, &cr->matches);
445         free_argv(mops);
446         free_argv(playlists);
447 free_moods:
448         free_argv(moods);
449 free_pl_buf:
450         free(pl_buf);
451 free_mood_buf:
452         free(mood_buf);
453 }
454
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);}
460
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)
481
482 static int client_i9e_line_handler(char *line)
483 {
484         int ret;
485         static bool first = true;
486
487         if (first)
488                 first = false;
489         else
490                 lls_free_parse_result(ct->lpr, CLIENT_CMD_PTR);
491         ret = create_merged_lpr(line);
492         if (ret <= 0)
493                 return ret;
494         ret = client_connect(ct, &sched, NULL, NULL);
495         if (ret < 0)
496                 return ret;
497         i9e_attach_to_stdout(ct->btrn[0]);
498         return 1;
499 }
500
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
506         {.name = NULL}
507 };
508
509 __noreturn static void interactive_session(void)
510 {
511         int ret;
512         struct sigaction act;
513         struct i9e_client_info ici = {
514                 .fds = {0, 1, 2},
515                 .prompt = "para_client> ",
516                 .line_handler = client_i9e_line_handler,
517                 .loglevel = client_loglevel,
518                 .completers = completers,
519         };
520
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));
525         else {
526                 char *home = para_homedir();
527                 ici.history_file = make_message("%s/.paraslash/client.history",
528                         home);
529                 free(home);
530         }
531         act.sa_handler = i9e_signal_dispatch;
532         sigemptyset(&act.sa_mask);
533         act.sa_flags = 0;
534         sigaction(SIGINT, &act, NULL);
535         sched.select_function = i9e_select;
536
537         ret = i9e_open(&ici, &sched);
538         if (ret < 0)
539                 goto out;
540         para_log = i9e_log;
541         ret = schedule(&sched);
542         sched_shutdown(&sched);
543         i9e_close();
544         para_log = stderr_log;
545 out:
546         if (ret < 0)
547                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
548         exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
549         //client_close(ct);
550 }
551
552 __noreturn static void print_completions(void)
553 {
554         int ret;
555
556         ret = i9e_print_completions(completers);
557         exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
558 }
559
560 #else /* HAVE_READLINE */
561
562 __noreturn static void interactive_session(void)
563 {
564         PARA_EMERG_LOG("interactive sessions not available\n");
565         exit(EXIT_FAILURE);
566 }
567
568 __noreturn static void print_completions(void)
569 {
570         PARA_EMERG_LOG("command completion not available\n");
571         exit(EXIT_FAILURE);
572 }
573
574 #endif /* HAVE_READLINE */
575
576 struct supervisor_task {
577         bool stdout_task_started;
578         struct task *task;
579 };
580
581 static int supervisor_post_select(struct sched *s, void *context)
582 {
583         struct supervisor_task *svt = context;
584         int ret = task_status(ct->task);
585
586         if (ret < 0)
587                 return ret;
588         if (!svt->stdout_task_started && ct->status == CL_EXECUTING) {
589                 stdout_task_register(&sot, s);
590                 svt->stdout_task_started = true;
591                 return 1;
592         }
593         if (ct->status == CL_SENDING) {
594                 stdin_task_register(&sit, s);
595                 return -E_TASK_STARTED;
596         }
597         return 0;
598 }
599
600 static struct supervisor_task supervisor_task;
601
602 /**
603  * The client program to connect to para_server.
604  *
605  * \param argc Usual argument count.
606  * \param argv Usual argument vector.
607  *
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.
612  *
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.
616  *
617  * \return EXIT_SUCCESS or EXIT_FAILURE
618  *
619  * \sa \ref client_open(), \ref stdin.c, \ref stdout.c, para_client(1),
620  * para_server(1).
621  */
622 int main(int argc, char *argv[])
623 {
624         int ret;
625
626         crypt_init();
627         sched.default_timeout.tv_sec = 1;
628
629         ret = client_parse_config(argc, argv, &ct, &client_loglevel);
630         if (ret < 0)
631                 goto out;
632         if (CLIENT_OPT_GIVEN(COMPLETE, ct->lpr))
633                 print_completions();
634         if (ret == 0)
635                 interactive_session(); /* does not return */
636
637         /*
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.
641          */
642         sit.btrn = btr_new_node(&(struct btr_node_description)
643                 EMBRACE(.name = "stdin"));
644         ret = client_connect(ct, &sched, sit.btrn, NULL);
645         if (ret < 0)
646                 goto out;
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,
653         }, &sched);
654
655         ret = schedule(&sched);
656         if (ret >= 0) {
657                 ret = task_status(ct->task);
658                 if (ret < 0) {
659                         switch (ret) {
660                         /* these are not errors */
661                         case -E_SERVER_CMD_SUCCESS:
662                         case -E_EOF:
663                         case -E_SERVER_EOF:
664                         case -E_BTR_EOF:
665                                 ret = 0;
666                                 break;
667                         default: ret = -E_SERVER_CMD_FAILURE;
668                         }
669                 }
670         }
671         sched_shutdown(&sched);
672         crypt_shutdown();
673 out:
674         if (ret < 0)
675                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
676         client_close(ct);
677         btr_remove_node(&sit.btrn);
678         btr_remove_node(&sot.btrn);
679         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
680 }