client supervisor: Switch to the alternative post select method.
[paraslash.git] / client.c
index ebe33898bc0154665f7ae037e0102f163903b4ba..89171a23b7f0b22b1940e3e54e74d000d36f7245 100644 (file)
--- a/client.c
+++ b/client.c
@@ -1,13 +1,13 @@
 /*
- * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file client.c the client program used to connect to para_server */
+/** \file client.c The client program used to connect to para_server. */
 
 #include <regex.h>
-#include <openssl/rc4.h>
+#include <signal.h>
 
 #include "para.h"
 #include "list.h"
 #include "stdin.h"
 #include "stdout.h"
 #include "client.h"
+#include "buffer_tree.h"
 #include "error.h"
+#include "version.h"
 
 INIT_CLIENT_ERRLISTS;
 
+static struct sched sched;
 static struct client_task *ct;
 static struct stdin_task sit;
 static struct stdout_task sot;
 
-static void supervisor_post_select(__a_unused struct sched *s, struct task *t)
+static int client_loglevel = LL_ERROR;
+DEFINE_STDERR_LOGGER(stderr_log, client_loglevel);
+__printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
+
+#ifdef HAVE_READLINE
+#include "interactive.h"
+#include "server_completion.h"
+#include "afs_completion.h"
+
+struct exec_task {
+       struct task task;
+       struct btr_node *btrn;
+       char *result_buf;
+       size_t result_size;
+};
+
+static void exec_pre_select(struct sched *s, struct task *t)
+{
+       struct exec_task *et = container_of(t, struct exec_task, task);
+       int ret = btr_node_status(et->btrn, 0, BTR_NT_LEAF);
+
+       if (ret != 0)
+               sched_min_delay(s);
+}
+
+static int exec_post_select(__a_unused struct sched *s, struct task *t)
+{
+       struct exec_task *et = container_of(t, struct exec_task, task);
+       struct btr_node *btrn = et->btrn;
+       char *buf;
+       size_t sz;
+       int ret;
+
+       ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
+       if (ret <= 0)
+               return ret;
+       sz = btr_next_buffer(btrn, &buf);
+       if (sz <= 1)
+               goto out;
+       et->result_buf = para_realloc(et->result_buf, et->result_size + sz - 1);
+       memcpy(et->result_buf + et->result_size - 1, buf, sz -  1);
+       et->result_size += sz - 1;
+       et->result_buf[et->result_size - 1] = '\0';
+out:
+       btr_consume(btrn, sz);
+       return 0;
+}
+
+static int make_client_argv(const char *line)
+{
+       int ret;
+
+       free_argv(ct->conf.inputs);
+       ret = create_argv(line, " ", &ct->conf.inputs);
+       if (ret >= 0)
+               ct->conf.inputs_num = ret;
+       return ret;
+}
+
+static int execute_client_command(const char *cmd, char **result)
+{
+       int ret;
+       struct sched command_sched = {.default_timeout = {.tv_sec = 1}};
+       struct exec_task exec_task = {
+               .task = {
+                       .pre_select = exec_pre_select,
+                       .new_post_select = exec_post_select,
+                       .post_select = NULL,
+                       .status = "client exec task",
+               },
+               .result_buf = para_strdup(""),
+               .result_size = 1,
+       };
+       *result = NULL;
+       ret = make_client_argv(cmd);
+       if (ret < 0)
+               goto out;
+       exec_task.btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "exec_collect"));
+       register_task(&command_sched, &exec_task.task);
+       ret = client_connect(ct, &command_sched, NULL, exec_task.btrn);
+       if (ret < 0)
+               goto out;
+       schedule(&command_sched);
+       *result = exec_task.result_buf;
+       btr_remove_node(&exec_task.btrn);
+       client_disconnect(ct);
+       ret = 1;
+out:
+       btr_remove_node(&exec_task.btrn);
+       if (ret < 0)
+               free(exec_task.result_buf);
+       return ret;
+}
+
+static int extract_matches_from_command(const char *word, char *cmd,
+               char ***matches)
+{
+       char *buf, **sl;
+       int ret;
+
+       ret = execute_client_command(cmd, &buf);
+       if (ret < 0)
+               return ret;
+       ret = create_argv(buf, "\n", &sl);
+       free(buf);
+       if (ret < 0)
+               return ret;
+       ret = i9e_extract_completions(word, sl, matches);
+       free_argv(sl);
+       return ret;
+}
+
+static int complete_attributes(const char *word, char ***matches)
+{
+       return extract_matches_from_command(word, "lsatt", matches);
+}
+
+static void complete_addblob(__a_unused const char *blob_type,
+               __a_unused struct i9e_completion_info *ci,
+               __a_unused struct i9e_completion_result *cr)
+{
+       cr->filename_completion_desired = true;
+}
+
+static void generic_blob_complete(const char *blob_type,
+               struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char cmd[20];
+       sprintf(cmd, "ls%s", blob_type);
+       extract_matches_from_command(ci->word, cmd, &cr->matches);
+}
+
+static void complete_catblob(const char *blob_type,
+               struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       generic_blob_complete(blob_type, ci, cr);
+}
+
+static void complete_lsblob(const char *blob_type,
+               struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-i", "-l", "-r", NULL};
+
+       if (ci->word[0] == '-')
+               return i9e_complete_option(opts, ci, cr);
+       generic_blob_complete(blob_type, ci, cr);
+}
+
+static void complete_rmblob(const char *blob_type,
+               struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       generic_blob_complete(blob_type, ci, cr);
+}
+
+static void complete_mvblob(const char *blob_type,
+               struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       generic_blob_complete(blob_type, ci, cr);
+}
+
+/* these don't need any completions */
+I9E_DUMMY_COMPLETER(ff);
+I9E_DUMMY_COMPLETER(hup);
+I9E_DUMMY_COMPLETER(jmp);
+I9E_DUMMY_COMPLETER(next);
+I9E_DUMMY_COMPLETER(nomore);
+I9E_DUMMY_COMPLETER(pause);
+I9E_DUMMY_COMPLETER(play);
+I9E_DUMMY_COMPLETER(si);
+I9E_DUMMY_COMPLETER(term);
+I9E_DUMMY_COMPLETER(version);
+I9E_DUMMY_COMPLETER(stop);
+I9E_DUMMY_COMPLETER(addatt);
+I9E_DUMMY_COMPLETER(init);
+
+static struct i9e_completer completers[];
+
+static void help_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *result)
+{
+       result->matches = i9e_complete_commands(ci->word, completers);
+}
+
+static void stat_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-n=", "-p", NULL};
+       //PARA_CRIT_LOG("word: %s\n", ci->word);
+       i9e_complete_option(opts, ci, cr);
+}
+
+static void sender_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *senders[] = {"http", "dccp", "udp", NULL};
+       char *http_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
+       char *dccp_cmds[] = {"on", "off", "allow", "deny", "help", NULL};
+       char *udp_cmds[] ={"on", "off", "add", "delete", "help", NULL};
+       char *sender;
+       char **cmds;
+
+       //PARA_CRIT_LOG("wn: %d\n", ci->word_num);
+       if (ci->word_num == 0 || ci->word_num > 3)
+               return;
+       if (ci->word_num == 1 || (ci->word_num == 2 && *ci->word != '\0')) {
+               i9e_extract_completions(ci->word, senders, &cr->matches);
+               return;
+       }
+       sender = ci->argv[1];
+       //PARA_CRIT_LOG("sender: %s\n", sender);
+       if (strcmp(sender, "http") == 0)
+               cmds = http_cmds;
+       else if (strcmp(sender, "dccp") == 0)
+               cmds = dccp_cmds;
+       else if (strcmp(sender, "udp") == 0)
+               cmds = udp_cmds;
+       else
+               return;
+       i9e_extract_completions(ci->word, cmds, &cr->matches);
+}
+
+static void add_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-a", "-l", "-f", "-v", "--", NULL};
+
+       if (ci->word[0] == '-')
+               i9e_complete_option(opts, ci, cr);
+       cr->filename_completion_desired = true;
+}
+
+static void ls_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
 {
-       if (ct->task.error < 0) {
-               t->error = ct->task.error;
+       char *opts[] = {
+               "--", "-l", "-ls", "-ll", "-lv", "-lp", "-lm", "-lc", "-p",
+               "-a", "-r", "-d", "-sp", "-sl", "-ss", "-sn", "-sf", "-sc",
+               "-si", "-sy", "-sb", "-sd", "-sa", NULL
+       };
+       if (ci->word[0] == '-')
+               i9e_complete_option(opts, ci, cr);
+       cr->filename_completion_desired = true;
+}
+
+static void setatt_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *buf, **sl;
+       int i, ret, num_atts;
+
+       if (ci->word_num == 0)
+               return;
+
+       if (*ci->word == '/' || *ci->word == '\0')
+               cr->filename_completion_desired = true;
+       if (*ci->word == '/')
+               return;
+       ret = execute_client_command("lsatt", &buf);
+       if (ret < 0)
                return;
+       ret = create_argv(buf, "\n", &sl);
+       if (ret < 0)
+               goto out;
+       num_atts = ret;
+       sl = para_realloc(sl, (2 * num_atts + 1) * sizeof(char *));
+       for (i = 0; i < num_atts; i++) {
+               char *orig = sl[i];
+               sl[i] = make_message("%s+", orig);
+               sl[num_atts + i] = make_message("%s-", orig);
+               free(orig);
        }
+       sl[2 * num_atts] = NULL;
+       i9e_extract_completions(ci->word, sl, &cr->matches);
+out:
+       free(buf);
+       free_argv(sl);
+}
+
+static void lsatt_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-i", "-l", "-r", NULL};
+
+       if (ci->word[0] == '-')
+               i9e_complete_option(opts, ci, cr);
+       else
+               complete_attributes(ci->word, &cr->matches);
+}
+
+static void mvatt_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       complete_attributes(ci->word, &cr->matches);
+}
+
+static void rmatt_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       complete_attributes(ci->word, &cr->matches);
+}
+
+static void check_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-a", "-m", "-p", NULL};
+       i9e_complete_option(opts, ci, cr);
+}
+
+static void rm_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-v", "-f", "-p", NULL};
+
+       if (ci->word[0] == '-') {
+               i9e_complete_option(opts, ci, cr);
+               return;
+       }
+       cr->filename_completion_desired = true;
+}
+
+static void touch_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-n=", "-l=", "-y=", "-i=", "-a=", "-v", "-p", NULL};
+
+       if (ci->word[0] == '-')
+               i9e_complete_option(opts, ci, cr);
+       cr->filename_completion_desired = true;
+}
+
+static void cpsi_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *opts[] = {"-a", "-y", "-i", "-l", "-n", "-v", NULL};
+
+       if (ci->word[0] == '-')
+               i9e_complete_option(opts, ci, cr);
+       cr->filename_completion_desired = true;
+}
+
+static void select_completer(struct i9e_completion_info *ci,
+               struct i9e_completion_result *cr)
+{
+       char *mood_buf, *pl_buf, **moods, **playlists, **mops;
+       int num_moods, num_pl, i, n, ret;
+
+       ret = execute_client_command("lsmood", &mood_buf);
+       if (ret < 0)
+               return;
+       ret = execute_client_command("lspl", &pl_buf);
+       if (ret < 0)
+               goto free_mood_buf;
+
+       ret = create_argv(mood_buf, "\n", &moods);
+       if (ret < 0)
+               goto free_pl_buf;
+       num_moods = ret;
+       ret = create_argv(pl_buf, "\n", &playlists);
+       if (ret < 0)
+               goto free_moods;
+       num_pl = ret;
+       n = num_moods + num_pl;
+       mops = para_malloc((n + 1) * sizeof(char *));
+       for (i = 0; i < num_moods; i++)
+               mops[i] = make_message("m/%s", moods[i]);
+       for (i = 0; i < num_pl; i++)
+               mops[num_moods + i] = make_message("p/%s", playlists[i]);
+       mops[n] = NULL;
+       i9e_extract_completions(ci->word, mops, &cr->matches);
+       free_argv(mops);
+       free_argv(playlists);
+free_moods:
+       free_argv(moods);
+free_pl_buf:
+       free(pl_buf);
+free_mood_buf:
+       free(mood_buf);
+}
+
+#define DEFINE_BLOB_COMPLETER(cmd, blob_type) \
+       static void cmd ## blob_type ## _completer( \
+               struct i9e_completion_info *ci, \
+               struct i9e_completion_result *cr) \
+       {complete_ ## cmd ## blob(#blob_type, ci, cr);}
+
+DEFINE_BLOB_COMPLETER(add, mood)
+DEFINE_BLOB_COMPLETER(add, lyr)
+DEFINE_BLOB_COMPLETER(add, img)
+DEFINE_BLOB_COMPLETER(add, pl)
+DEFINE_BLOB_COMPLETER(cat, mood)
+DEFINE_BLOB_COMPLETER(cat, lyr)
+DEFINE_BLOB_COMPLETER(cat, img)
+DEFINE_BLOB_COMPLETER(cat, pl)
+DEFINE_BLOB_COMPLETER(ls, mood)
+DEFINE_BLOB_COMPLETER(ls, lyr)
+DEFINE_BLOB_COMPLETER(ls, img)
+DEFINE_BLOB_COMPLETER(ls, pl)
+DEFINE_BLOB_COMPLETER(rm, mood)
+DEFINE_BLOB_COMPLETER(rm, lyr)
+DEFINE_BLOB_COMPLETER(rm, img)
+DEFINE_BLOB_COMPLETER(rm, pl)
+DEFINE_BLOB_COMPLETER(mv, mood)
+DEFINE_BLOB_COMPLETER(mv, lyr)
+DEFINE_BLOB_COMPLETER(mv, img)
+DEFINE_BLOB_COMPLETER(mv, pl)
+
+static int client_i9e_line_handler(char *line)
+{
+       int ret;
+
+       client_disconnect(ct);
+       if (!line || !*line)
+               return 0;
+       PARA_DEBUG_LOG("line handler: %s\n", line);
+       ret = make_client_argv(line);
+       if (ret < 0)
+               return ret;
+       ret = client_connect(ct, &sched, NULL, NULL);
+       if (ret < 0)
+               return ret;
+       i9e_attach_to_stdout(ct->btrn);
+       return 1;
+}
+
+static struct i9e_completer completers[] = {
+       SERVER_COMPLETERS
+       AFS_COMPLETERS
+       {.name = NULL}
+};
+
+__noreturn static void interactive_session(void)
+{
+       int ret;
+       char *history_file;
+       struct sigaction act;
+       struct i9e_client_info ici = {
+               .fds = {0, 1, 2},
+               .prompt = "para_client> ",
+               .line_handler = client_i9e_line_handler,
+               .loglevel = client_loglevel,
+               .completers = completers,
+       };
+
+       PARA_NOTICE_LOG("\n%s\n", VERSION_TEXT("client"));
+       if (ct->conf.history_file_given)
+               history_file = para_strdup(ct->conf.history_file_arg);
+       else {
+               char *home = para_homedir();
+               history_file = make_message("%s/.paraslash/client.history",
+                       home);
+               free(home);
+       }
+       ici.history_file = history_file;
+
+       act.sa_handler = i9e_signal_dispatch;
+       sigemptyset(&act.sa_mask);
+       act.sa_flags = 0;
+       sigaction(SIGINT, &act, NULL);
+       sched.select_function = i9e_select;
+
+       ret = i9e_open(&ici, &sched);
+       if (ret < 0)
+               goto out;
+       para_log = i9e_log;
+       ret = schedule(&sched);
+       i9e_close();
+       para_log = stderr_log;
+out:
+       if (ret < 0)
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+       exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
+       //client_close(ct);
+}
+
+__noreturn static void print_completions(void)
+{
+       int ret = i9e_print_completions(completers);
+       exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
+}
+
+#else /* HAVE_READLINE */
+
+__noreturn static void interactive_session(void)
+{
+       PARA_EMERG_LOG("interactive sessions not available\n");
+       exit(EXIT_FAILURE);
+}
+
+__noreturn static void print_completions(void)
+{
+       PARA_EMERG_LOG("command completion not available\n");
+       exit(EXIT_FAILURE);
+}
+
+#endif /* HAVE_READLINE */
+
+static int supervisor_post_select(struct sched *s, __a_unused struct task *t)
+{
+       if (ct->task.error < 0)
+               return ct->task.error;
        if (ct->status == CL_SENDING) {
                stdin_set_defaults(&sit);
-               sit.buf = para_malloc(sit.bufsize),
-               register_task(&sit.task);
-               ct->inbuf = sit.buf;
-               ct->in_loaded = &sit.loaded;
-               ct->in_error = &sit.task.error;
-               t->error = -E_TASK_STARTED;
-               return;
+               register_task(s, &sit.task);
+               return -E_TASK_STARTED;
        }
        if (ct->status == CL_RECEIVING) {
                stdout_set_defaults(&sot);
-               sot.bufp = &ct->buf;
-               sot.loaded = &ct->loaded;
-               sot.input_error = &ct->task.error;
-               register_task(&sot.task);
-               t->error = -E_TASK_STARTED;
-               return;
+               register_task(s, &sot.task);
+               return -E_TASK_STARTED;
        }
+       return 0;
 }
 
 static struct task svt = {
-       .post_select = supervisor_post_select,
+       .new_post_select = supervisor_post_select,
+       .post_select = NULL,
        .status = "supervisor task"
 };
 
-static int client_loglevel; /* loglevel */
-INIT_STDERR_LOGGING(client_loglevel);
-
-
 /**
  * The client program to connect to para_server.
  *
  * \param argc Usual argument count.
  * \param argv Usual argument vector.
  *
- * It registers two tasks: The client task that communicates with para_server
- * and the standard out task that writes any output produced by the client task
- * to standard out.
+ * When called without a paraslash command, an interactive session is started.
+ * Otherwise, the client task and the supervisor task are started. The former
+ * communicates with para_server while the latter monitors whether the client
+ * task intends to read from stdin or write to stdout.
+ *
+ * Once it has been determined whether the client command corresponds to a
+ * stdin command (addmood, addimg, ..), either the stdin task or the stdout
+ * task is set up to replace the supervisor task.
  *
  * \return EXIT_SUCCESS or EXIT_FAILURE
  *
- * \sa client_open(), stdout.c, stdout.h, para_client(1), para_server(1)
+ * \sa client_open(), stdin.c, stdout.c, para_client(1), para_server(1)
  */
 int main(int argc, char *argv[])
 {
-
        int ret;
-       static struct sched s;
 
        init_random_seed_or_die();
-       s.default_timeout.tv_sec = 1;
-       s.default_timeout.tv_usec = 0;
-       ret = client_open(argc, argv, &ct, &client_loglevel);
-       if (ret < 0) /* can not use PARA_LOG here because ct is NULL */
-               exit(EXIT_FAILURE);
-       register_task(&svt);
-       ret = schedule(&s);
+       sched.default_timeout.tv_sec = 1;
+
+       ret = client_parse_config(argc, argv, &ct, &client_loglevel);
+       if (ret < 0)
+               goto out;
+       if (ct->conf.complete_given)
+               print_completions();
+       if (ret == 0)
+               interactive_session(); /* does not return */
+
+       /*
+        * We add buffer tree nodes for stdin and stdout even though
+        * only one of them will be needed. This simplifies the code
+        * a bit wrt. to the buffer tree setup.
+        */
+       sit.btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "stdin"));
+       ret = client_connect(ct, &sched, sit.btrn, NULL);
+       if (ret < 0)
+               goto out;
+       sot.btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "stdout", .parent = ct->btrn));
+       register_task(&sched, &svt);
+       ret = schedule(&sched);
+       if (ret >= 0 && ct->task.error < 0) {
+               switch(ct->task.error) {
+               /* these are not errors */
+               case -E_SERVER_CMD_SUCCESS:
+               case -E_EOF:
+               case -E_SERVER_EOF:
+               case -E_BTR_EOF:
+                       ret = 0;
+                       break;
+               default: ret = -E_SERVER_CMD_FAILURE;
+               }
+       }
+out:
        if (ret < 0)
                PARA_ERROR_LOG("%s\n", para_strerror(-ret));
        client_close(ct);
-       return ret >= 0? EXIT_SUCCESS: EXIT_FAILURE;
+       btr_remove_node(&sit.btrn);
+       btr_remove_node(&sot.btrn);
+       return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 }