client.c

   1 /*
   2  * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file client.c The client program used to connect to para_server. */
   8
   9 #include <regex.h>
  10 #include <signal.h>
  11
  12 #include "para.h"
  13 #include "list.h"
  14 #include "sched.h"
  15 #include "crypt.h"
  16 #include "client.cmdline.h"
  17 #include "string.h"
  18 #include "stdin.h"
  19 #include "stdout.h"
  20 #include "client.h"
  21 #include "buffer_tree.h"
  22 #include "error.h"
  23 #include "version.h"
  24
  25 INIT_CLIENT_ERRLISTS;
  26
  27 static struct sched sched;
  28 static struct client_task *ct;
  29 static struct stdin_task sit;
  30 static struct stdout_task sot;
  31
  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;
  35
  36 #ifdef HAVE_READLINE
  37 #include "interactive.h"
  38 #include "server.completion.h"
  39 #include "afs.completion.h"
  40
  41 struct exec_task {
  42         struct task *task;
  43         struct btr_node *btrn;
  44         char *result_buf;
  45         size_t result_size;
  46 };
  47
  48 static void exec_pre_select(struct sched *s, void *context)
  49 {
  50         struct exec_task *et = context;
  51         int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
  52
  53         if (ret != 0)
  54                 sched_min_delay(s);
  55 }
  56
  57 static int exec_post_select(__a_unused struct sched *s, void *context)
  58 {
  59         struct exec_task *et = context;
  60         struct btr_node *btrn = et->btrn;
  61         char *buf;
  62         size_t sz;
  63         int ret;
  64
  65         ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
  66         if (ret <= 0)
  67                 return ret;
  68         sz = btr_next_buffer(btrn, &buf);
  69         if (sz <= 1)
  70                 goto out;
  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';
  75 out:
  76         btr_consume(btrn, sz);
  77         return 0;
  78 }
  79
  80 static int make_client_argv(const char *line)
  81 {
  82         int ret;
  83
  84         free_argv(ct->conf.inputs);
  85         ret = create_argv(line, " ", &ct->conf.inputs);
  86         if (ret >= 0)
  87                 ct->conf.inputs_num = ret;
  88         return ret;
  89 }
  90
  91 static int execute_client_command(const char *cmd, char **result)
  92 {
  93         int ret;
  94         struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
  95         struct exec_task exec_task = {
  96                 .result_buf = para_strdup(""),
  97                 .result_size = 1,
  98         };
  99         *result = NULL;
 100         ret = make_client_argv(cmd);
 101         if (ret < 0)
 102                 goto out;
 103         exec_task.btrn = btr_new_node(&(struct btr_node_description)
 104                 EMBRACE(.name = "exec_collect"));
 105         exec_task.task = task_register(&(struct task_info) {
 106                 .name = "client exec",
 107                 .pre_select = exec_pre_select,
 108                 .post_select = exec_post_select,
 109                 .context = &exec_task,
 110         }, &command_sched);
 111         ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
 112         if (ret < 0)
 113                 goto out;
 114         schedule(&command_sched);
 115         sched_shutdown(&command_sched);
 116         *result = exec_task.result_buf;
 117         btr_remove_node(&exec_task.btrn);
 118         ret = 1;
 119 out:
 120         btr_remove_node(&exec_task.btrn);
 121         if (ret < 0)
 122                 free(exec_task.result_buf);
 123         return ret;
 124 }
 125
 126 static int extract_matches_from_command(const char *word, char *cmd,
 127                 char ***matches)
 128 {
 129         char *buf, **sl;
 130         int ret;
 131
 132         ret = execute_client_command(cmd, &buf);
 133         if (ret < 0)
 134                 return ret;
 135         ret = create_argv(buf, "\n", &sl);
 136         free(buf);
 137         if (ret < 0)
 138                 return ret;
 139         ret = i9e_extract_completions(word, sl, matches);
 140         free_argv(sl);
 141         return ret;
 142 }
 143
 144 static int complete_attributes(const char *word, char ***matches)
 145 {
 146         return extract_matches_from_command(word, "lsatt", matches);
 147 }
 148
 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)
 152 {
 153         cr->filename_completion_desired = true;
 154 }
 155
 156 static void generic_blob_complete(const char *blob_type,
 157                 struct i9e_completion_info *ci,
 158                 struct i9e_completion_result *cr)
 159 {
 160         char cmd[20];
 161         sprintf(cmd, "ls%s", blob_type);
 162         extract_matches_from_command(ci->word, cmd, &cr->matches);
 163 }
 164
 165 static void complete_catblob(const char *blob_type,
 166                 struct i9e_completion_info *ci,
 167                 struct i9e_completion_result *cr)
 168 {
 169         generic_blob_complete(blob_type, ci, cr);
 170 }
 171
 172 static void complete_lsblob(const char *blob_type,
 173                 struct i9e_completion_info *ci,
 174                 struct i9e_completion_result *cr)
 175 {
 176         char *opts[] = {"-i", "-l", "-r", NULL};
 177
 178         if (ci->word[0] == '-')
 179                 return i9e_complete_option(opts, ci, cr);
 180         generic_blob_complete(blob_type, ci, cr);
 181 }
 182
 183 static void complete_rmblob(const char *blob_type,
 184                 struct i9e_completion_info *ci,
 185                 struct i9e_completion_result *cr)
 186 {
 187         generic_blob_complete(blob_type, ci, cr);
 188 }
 189
 190 static void complete_mvblob(const char *blob_type,
 191                 struct i9e_completion_info *ci,
 192                 struct i9e_completion_result *cr)
 193 {
 194         generic_blob_complete(blob_type, ci, cr);
 195 }
 196
 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(stop);
 208 I9E_DUMMY_COMPLETER(addatt);
 209 I9E_DUMMY_COMPLETER(init);
 210 I9E_DUMMY_COMPLETER(tasks);
 211
 212 static struct i9e_completer completers[];
 213
 214 static void help_completer(struct i9e_completion_info *ci,
 215                 struct i9e_completion_result *result)
 216 {
 217         result->matches = i9e_complete_commands(ci->word, completers);
 218 }
 219
 220 static void version_completer(struct i9e_completion_info *ci,
 221                 struct i9e_completion_result *cr)
 222 {
 223         char *opts[] = {"-v", NULL};
 224         i9e_complete_option(opts, ci, cr);
 225 }
 226
 227 static void stat_completer(struct i9e_completion_info *ci,
 228                 struct i9e_completion_result *cr)
 229 {
 230         char *opts[] = {"-n=", "-p", NULL};
 231         //PARA_CRIT_LOG("word: %s\n", ci->word);
 232         i9e_complete_option(opts, ci, cr);
 233 }
 234
 235 static void sender_completer(struct i9e_completion_info *ci,
 236                 struct i9e_completion_result *cr)
 237 {
 238         char *senders[] = {"http", "dccp", "udp", NULL};
 239         char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
 240         char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
 241         char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
 242         char *sender;
 243         char **cmds;
 244
 245         //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
 246         if (ci->word_num == 0 || ci->word_num > 3)
 247                 return;
 248         if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
 249                 i9e_extract_completions(ci->word, senders, &cr->matches);
 250                 return;
 251         }
 252         sender = ci->argv[1];
 253         //PARA_CRIT_LOG("sender: %s\n", sender);
 254         if (strcmp(sender, "http") == 0)
 255                 cmds = http_cmds;
 256         else if (strcmp(sender, "dccp") == 0)
 257                 cmds = dccp_cmds;
 258         else if (strcmp(sender, "udp") == 0)
 259                 cmds = udp_cmds;
 260         else
 261                 return;
 262         i9e_extract_completions(ci->word, cmds, &cr->matches);
 263 }
 264
 265 static void add_completer(struct i9e_completion_info *ci,
 266                 struct i9e_completion_result *cr)
 267 {
 268         char *opts[] = {"-a", "-l", "-f", "-v", "--", NULL};
 269
 270         if (ci->word[0] == '-')
 271                 i9e_complete_option(opts, ci, cr);
 272         cr->filename_completion_desired = true;
 273 }
 274
 275 static void ls_completer(struct i9e_completion_info *ci,
 276                 struct i9e_completion_result *cr)
 277 {
 278         char *opts[] = {
 279                 "--", "-l", "-l=s", "-l=l", "-l=v", "-l=p", "-l=m", "-l=c",
 280                 "-p", "-a", "-r", "-d", "-s=p", "-s=l", "-s=s", "-s=n", "-s=f",
 281                 "-s=c", "-s=i", "-s=y", "-s=b", "-s=d", "-s=a", NULL
 282         };
 283         if (ci->word[0] == '-')
 284                 i9e_complete_option(opts, ci, cr);
 285         cr->filename_completion_desired = true;
 286 }
 287
 288 static void setatt_completer(struct i9e_completion_info *ci,
 289                 struct i9e_completion_result *cr)
 290 {
 291         char *buf, **sl;
 292         int i, ret, num_atts;
 293
 294         if (ci->word_num == 0)
 295                 return;
 296
 297         if (*ci->word == '/' || *ci->word == '\0')
 298                 cr->filename_completion_desired = true;
 299         if (*ci->word == '/')
 300                 return;
 301         ret = execute_client_command("lsatt", &buf);
 302         if (ret < 0)
 303                 return;
 304         ret = create_argv(buf, "\n", &sl);
 305         if (ret < 0)
 306                 goto out;
 307         num_atts = ret;
 308         sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
 309         for (i = 0; i < num_atts; i++) {
 310                 char *orig = sl[i];
 311                 sl[i] = make_message("%s+", orig);
 312                 sl[num_atts + i] = make_message("%s-", orig);
 313                 free(orig);
 314         }
 315         sl[2 * num_atts] = NULL;
 316         i9e_extract_completions(ci->word, sl, &cr->matches);
 317 out:
 318         free(buf);
 319         free_argv(sl);
 320 }
 321
 322 static void lsatt_completer(struct i9e_completion_info *ci,
 323                 struct i9e_completion_result *cr)
 324 {
 325         char *opts[] = {"-i", "-l", "-r", NULL};
 326
 327         if (ci->word[0] == '-')
 328                 i9e_complete_option(opts, ci, cr);
 329         else
 330                 complete_attributes(ci->word, &cr->matches);
 331 }
 332
 333 static void mvatt_completer(struct i9e_completion_info *ci,
 334                 struct i9e_completion_result *cr)
 335 {
 336         complete_attributes(ci->word, &cr->matches);
 337 }
 338
 339 static void rmatt_completer(struct i9e_completion_info *ci,
 340                 struct i9e_completion_result *cr)
 341 {
 342         complete_attributes(ci->word, &cr->matches);
 343 }
 344
 345 static void check_completer(struct i9e_completion_info *ci,
 346                 struct i9e_completion_result *cr)
 347 {
 348         char *opts[] = {"-a", "-m", "-p", NULL};
 349         i9e_complete_option(opts, ci, cr);
 350 }
 351
 352 static void rm_completer(struct i9e_completion_info *ci,
 353                 struct i9e_completion_result *cr)
 354 {
 355         char *opts[] = {"-v", "-f", "-p", NULL};
 356
 357         if (ci->word[0] == '-') {
 358                 i9e_complete_option(opts, ci, cr);
 359                 return;
 360         }
 361         cr->filename_completion_desired = true;
 362 }
 363
 364 static void touch_completer(struct i9e_completion_info *ci,
 365                 struct i9e_completion_result *cr)
 366 {
 367         char *opts[] = {"-n=", "-l=", "-y=", "-i=", "-a=", "-v", "-p", NULL};
 368
 369         if (ci->word[0] == '-')
 370                 i9e_complete_option(opts, ci, cr);
 371         cr->filename_completion_desired = true;
 372 }
 373
 374 static void cpsi_completer(struct i9e_completion_info *ci,
 375                 struct i9e_completion_result *cr)
 376 {
 377         char *opts[] = {"-a", "-y", "-i", "-l", "-n", "-v", NULL};
 378
 379         if (ci->word[0] == '-')
 380                 i9e_complete_option(opts, ci, cr);
 381         cr->filename_completion_desired = true;
 382 }
 383
 384 static void select_completer(struct i9e_completion_info *ci,
 385                 struct i9e_completion_result *cr)
 386 {
 387         char *mood_buf, *pl_buf, **moods, **playlists, **mops;
 388         int num_moods, num_pl, i, n, ret;
 389
 390         ret = execute_client_command("lsmood", &mood_buf);
 391         if (ret < 0)
 392                 return;
 393         ret = execute_client_command("lspl", &pl_buf);
 394         if (ret < 0)
 395                 goto free_mood_buf;
 396
 397         ret = create_argv(mood_buf, "\n", &moods);
 398         if (ret < 0)
 399                 goto free_pl_buf;
 400         num_moods = ret;
 401         ret = create_argv(pl_buf, "\n", &playlists);
 402         if (ret < 0)
 403                 goto free_moods;
 404         num_pl = ret;
 405         n = num_moods + num_pl;
 406         mops = para_malloc((n + 1) * sizeof(char *));
 407         for (i = 0; i < num_moods; i++)
 408                 mops[i] = make_message("m/%s", moods[i]);
 409         for (i = 0; i < num_pl; i++)
 410                 mops[num_moods + i] = make_message("p/%s", playlists[i]);
 411         mops[n] = NULL;
 412         i9e_extract_completions(ci->word, mops, &cr->matches);
 413         free_argv(mops);
 414         free_argv(playlists);
 415 free_moods:
 416         free_argv(moods);
 417 free_pl_buf:
 418         free(pl_buf);
 419 free_mood_buf:
 420         free(mood_buf);
 421 }
 422
 423 #define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
 424         static void cmd ## blob_type ## _completer( \
 425                 struct i9e_completion_info *ci, \
 426                 struct i9e_completion_result *cr) \
 427         {complete_ ## cmd ## blob(#blob_type, ci, cr);}
 428
 429 DEFINE_BLOB_COMPLETER(add, mood)
 430 DEFINE_BLOB_COMPLETER(add, lyr)
 431 DEFINE_BLOB_COMPLETER(add, img)
 432 DEFINE_BLOB_COMPLETER(add, pl)
 433 DEFINE_BLOB_COMPLETER(cat, mood)
 434 DEFINE_BLOB_COMPLETER(cat, lyr)
 435 DEFINE_BLOB_COMPLETER(cat, img)
 436 DEFINE_BLOB_COMPLETER(cat, pl)
 437 DEFINE_BLOB_COMPLETER(ls, mood)
 438 DEFINE_BLOB_COMPLETER(ls, lyr)
 439 DEFINE_BLOB_COMPLETER(ls, img)
 440 DEFINE_BLOB_COMPLETER(ls, pl)
 441 DEFINE_BLOB_COMPLETER(rm, mood)
 442 DEFINE_BLOB_COMPLETER(rm, lyr)
 443 DEFINE_BLOB_COMPLETER(rm, img)
 444 DEFINE_BLOB_COMPLETER(rm, pl)
 445 DEFINE_BLOB_COMPLETER(mv, mood)
 446 DEFINE_BLOB_COMPLETER(mv, lyr)
 447 DEFINE_BLOB_COMPLETER(mv, img)
 448 DEFINE_BLOB_COMPLETER(mv, pl)
 449
 450 static int client_i9e_line_handler(char *line)
 451 {
 452         int ret;
 453
 454         PARA_DEBUG_LOG("line: %s\n", line);
 455         ret = make_client_argv(line);
 456         if (ret <= 0)
 457                 return ret;
 458         ret = client_connect(ct, &sched, NULL, NULL);
 459         if (ret < 0)
 460                 return ret;
 461         i9e_attach_to_stdout(ct->btrn[0]);
 462         return 1;
 463 }
 464
 465 static struct i9e_completer completers[] = {
 466         SERVER_COMPLETERS
 467         AFS_COMPLETERS
 468         {.name = NULL}
 469 };
 470
 471 __noreturn static void interactive_session(void)
 472 {
 473         int ret;
 474         char *history_file;
 475         struct sigaction act;
 476         struct i9e_client_info ici = {
 477                 .fds = {0, 1, 2},
 478                 .prompt = "para_client> ",
 479                 .line_handler = client_i9e_line_handler,
 480                 .loglevel = client_loglevel,
 481                 .completers = completers,
 482         };
 483
 484         PARA_NOTICE_LOG("\n%s\n", version_text("client"));
 485         if (ct->conf.history_file_given)
 486                 history_file = para_strdup(ct->conf.history_file_arg);
 487         else {
 488                 char *home = para_homedir();
 489                 history_file = make_message("%s/.paraslash/client.history",
 490                         home);
 491                 free(home);
 492         }
 493         ici.history_file = history_file;
 494
 495         act.sa_handler = i9e_signal_dispatch;
 496         sigemptyset(&act.sa_mask);
 497         act.sa_flags = 0;
 498         sigaction(SIGINT, &act, NULL);
 499         sched.select_function = i9e_select;
 500
 501         ret = i9e_open(&ici, &sched);
 502         if (ret < 0)
 503                 goto out;
 504         para_log = i9e_log;
 505         ret = schedule(&sched);
 506         sched_shutdown(&sched);
 507         i9e_close();
 508         para_log = stderr_log;
 509 out:
 510         if (ret < 0)
 511                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 512         exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
 513         //client_close(ct);
 514 }
 515
 516 __noreturn static void print_completions(void)
 517 {
 518         int ret = i9e_print_completions(completers);
 519         exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
 520 }
 521
 522 #else /* HAVE_READLINE */
 523
 524 __noreturn static void interactive_session(void)
 525 {
 526         PARA_EMERG_LOG("interactive sessions not available\n");
 527         exit(EXIT_FAILURE);
 528 }
 529
 530 __noreturn static void print_completions(void)
 531 {
 532         PARA_EMERG_LOG("command completion not available\n");
 533         exit(EXIT_FAILURE);
 534 }
 535
 536 #endif /* HAVE_READLINE */
 537
 538 struct supervisor_task {
 539         bool stdout_task_started;
 540         struct task *task;
 541 };
 542
 543 static int supervisor_post_select(struct sched *s, void *context)
 544 {
 545         struct supervisor_task *svt = context;
 546         int ret = task_status(ct->task);
 547
 548         if (ret < 0)
 549                 return ret;
 550         if (!svt->stdout_task_started && ct->status == CL_EXECUTING) {
 551                 stdout_task_register(&sot, s);
 552                 svt->stdout_task_started = true;
 553                 return 1;
 554         }
 555         if (ct->status == CL_SENDING) {
 556                 stdin_task_register(&sit, s);
 557                 return -E_TASK_STARTED;
 558         }
 559         return 0;
 560 }
 561
 562 static struct supervisor_task supervisor_task;
 563
 564 /**
 565  * The client program to connect to para_server.
 566  *
 567  * \param argc Usual argument count.
 568  * \param argv Usual argument vector.
 569  *
 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.
 574  *
 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.
 578  *
 579  * \return EXIT_SUCCESS or EXIT_FAILURE
 580  *
 581  * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
 582  */
 583 int main(int argc, char *argv[])
 584 {
 585         int ret;
 586
 587         init_random_seed_or_die();
 588         sched.default_timeout.tv_sec = 1;
 589
 590         ret = client_parse_config(argc, argv, &ct, &client_loglevel);
 591         if (ret < 0)
 592                 goto out;
 593         if (ct->conf.complete_given)
 594                 print_completions();
 595         if (ret == 0)
 596                 interactive_session(); /* does not return */
 597
 598         /*
 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.
 602          */
 603         sit.btrn = btr_new_node(&(struct btr_node_description)
 604                 EMBRACE(.name = "stdin"));
 605         ret = client_connect(ct, &sched, sit.btrn, NULL);
 606         if (ret < 0)
 607                 goto out;
 608         sot.btrn = btr_new_node(&(struct btr_node_description)
 609                 EMBRACE(.name = "stdout", .parent = ct->btrn[0]));
 610         supervisor_task.task = task_register(&(struct task_info) {
 611                 .name = "supervisor",
 612                 .post_select = supervisor_post_select,
 613                 .context = &supervisor_task,
 614         }, &sched);
 615
 616         ret = schedule(&sched);
 617         if (ret >= 0) {
 618                 ret = task_status(ct->task);
 619                 if (ret < 0) {
 620                         switch (ret) {
 621                         /* these are not errors */
 622                         case -E_SERVER_CMD_SUCCESS:
 623                         case -E_EOF:
 624                         case -E_SERVER_EOF:
 625                         case -E_BTR_EOF:
 626                                 ret = 0;
 627                                 break;
 628                         default: ret = -E_SERVER_CMD_FAILURE;
 629                         }
 630                 }
 631         }
 632         sched_shutdown(&sched);
 633 out:
 634         if (ret < 0)
 635                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 636         client_close(ct);
 637         btr_remove_node(&sit.btrn);
 638         btr_remove_node(&sot.btrn);
 639         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 640 }