src/tools/sysdb/input.c

   1 /*
   2  * SysDB - src/tools/sysdb/input.c
   3  * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /*
  29  * This module implements the core of the command line tool. It handles all
  30  * input from the user and the remote server, interacting with the scanner and
  31  * command handling as needed.
  32  *
  33  * The main loop is managed by the flex scanner which parses the user input.
  34  * It will call into this module (using sdb_input_readline()) whenever it
  35  * needs further input to continue parsing. Whenever it finds a full query
  36  * (terminated by a semicolon), it will hand the query back to this module
  37  * (using sdb_input_exec_query()) which will then execute it.
  38  *
  39  * Most of the process life-time will be spend waiting for input. User input
  40  * and (asynchronous) server replies are handled at the same time.
  41  */
  42
  43 #if HAVE_CONFIG_H
  44 #       include "config.h"
  45 #endif /* HAVE_CONFIG_H */
  46
  47 #include "tools/sysdb/input.h"
  48 #include "tools/sysdb/command.h"
  49
  50 #include "utils/error.h"
  51 #include "utils/strbuf.h"
  52
  53 #include <errno.h>
  54
  55 #include <sys/select.h>
  56
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59
  60 #include <string.h>
  61
  62 #include <termios.h>
  63 #include <unistd.h>
  64
  65 #if HAVE_EDITLINE_READLINE_H
  66 #       include <editline/readline.h>
  67 #       if HAVE_EDITLINE_HISTORY_H
  68 #               include <editline/history.h>
  69 #       endif
  70 #elif HAVE_READLINE_READLINE_H
  71 #       include <readline/readline.h>
  72 #       if HAVE_READLINE_HISTORY_H
  73 #               include <readline/history.h>
  74 #       endif
  75 #elif HAVE_READLINE_H
  76 #       include <readline.h>
  77 #       if HAVE_HISTORY_H
  78 #               include <history.h>
  79 #       endif
  80 #endif /* READLINEs */
  81
  82 extern int yylex(void);
  83
  84 /*
  85  * public variables
  86  */
  87
  88 sdb_input_t *sysdb_input = NULL;
  89
  90 /*
  91  * private variables
  92  */
  93
  94 static struct termios orig_term_attrs;
  95 static bool have_orig_term_attrs;
  96
  97 /*
  98  * private helper functions
  99  */
 100
 101 static void
 102 reset_term_attrs(void)
 103 {
 104         tcsetattr(STDIN_FILENO, TCSANOW, &orig_term_attrs);
 105 } /* reset_term_attrs */
 106
 107 static void
 108 term_rawmode(void)
 109 {
 110         struct termios attrs;
 111
 112         if (! have_orig_term_attrs) {
 113                 memset(&orig_term_attrs, 0, sizeof(orig_term_attrs));
 114                 tcgetattr(STDIN_FILENO, &orig_term_attrs);
 115                 atexit(reset_term_attrs);
 116                 have_orig_term_attrs = 1;
 117         }
 118
 119         /* setup terminal to operate in non-canonical mode
 120          * and single character input */
 121         memset(&attrs, 0, sizeof(attrs));
 122         tcgetattr(STDIN_FILENO, &attrs);
 123         attrs.c_lflag &= (tcflag_t)(~ICANON);
 124         attrs.c_cc[VMIN] = 1;
 125         tcsetattr(STDIN_FILENO, TCSANOW, &attrs);
 126 } /* term_rawmode */
 127
 128 static void
 129 handle_input(char *line)
 130 {
 131         if (! line) {
 132                 sysdb_input->eof = 1;
 133                 return;
 134         }
 135
 136         sdb_strbuf_append(sysdb_input->input, "%s\n", line);
 137         free(line);
 138
 139         if (sysdb_input->interactive)
 140                 rl_callback_handler_remove();
 141 } /* handle_input */
 142
 143 /* wait for a new line of data to be available */
 144 static ssize_t
 145 input_readline(void)
 146 {
 147         size_t len;
 148
 149         fd_set fds;
 150         int client_fd;
 151
 152         const char *prompt = "sysdb=> ";
 153
 154         len = sdb_strbuf_len(sysdb_input->input);
 155
 156         if (! sysdb_input->interactive) {
 157                 char *line = readline("");
 158                 handle_input(line);
 159                 return (ssize_t)(sdb_strbuf_len(sysdb_input->input) - len);
 160         }
 161
 162         if (sysdb_input->query_len)
 163                 prompt = "sysdb-> ";
 164
 165         rl_callback_handler_install(prompt, handle_input);
 166         client_fd = sdb_client_sockfd(sysdb_input->client);
 167         while ((sdb_strbuf_len(sysdb_input->input) == len)
 168                         && (! sysdb_input->eof)) {
 169                 int n;
 170
 171                 /* XXX: some versions of libedit don't properly reset the terminal in
 172                  * rl_callback_read_char(); detect those versions */
 173                 term_rawmode();
 174
 175                 FD_ZERO(&fds);
 176                 FD_SET(STDIN_FILENO, &fds);
 177                 FD_SET(client_fd, &fds);
 178
 179                 n = select(client_fd + 1, &fds, NULL, NULL, /* timeout = */ NULL);
 180                 if (n < 0)
 181                         return (ssize_t)n;
 182                 else if (! n)
 183                         continue;
 184
 185                 /* handle user input with highest priority */
 186                 if (FD_ISSET(STDIN_FILENO, &fds)) {
 187                         rl_callback_read_char();
 188                         continue;
 189                 }
 190
 191                 if (! FD_ISSET(client_fd, &fds))
 192                         continue;
 193
 194                 if (sdb_client_eof(sysdb_input->client)) {
 195                         /* XXX: try to reconnect */
 196                         printf("\n");
 197                         sdb_log(SDB_LOG_ERR, "Remote side closed the connection.");
 198                         /* return EOF */
 199                         return 0;
 200                 }
 201
 202                 /* some response / error message from the server pending */
 203                 /* XXX: clear current line */
 204                 printf("\n");
 205                 sdb_command_print_reply(sysdb_input->client);
 206                 rl_forced_update_display();
 207         }
 208
 209         /* new data available */
 210         return (ssize_t)(sdb_strbuf_len(sysdb_input->input) - len);
 211 } /* input_readline */
 212
 213 /*
 214  * public API
 215  */
 216
 217 int
 218 sdb_input_init(sdb_input_t *input)
 219 {
 220         /* register input handler */
 221         sysdb_input = input;
 222
 223         input->interactive = isatty(STDIN_FILENO) != 0;
 224         errno = 0;
 225         if (input->interactive)
 226                 term_rawmode();
 227         return 0;
 228 } /* sdb_input_init */
 229
 230 int
 231 sdb_input_mainloop(void)
 232 {
 233         yylex();
 234         return 0;
 235 } /* sdb_input_mainloop */
 236
 237 ssize_t
 238 sdb_input_readline(char *buf, size_t *n_chars, size_t max_chars)
 239 {
 240         const char *data;
 241         size_t len;
 242
 243         len = sdb_strbuf_len(sysdb_input->input) - sysdb_input->tokenizer_pos;
 244
 245         if (! len) {
 246                 ssize_t n = input_readline();
 247                 if (n <= 0) {
 248                         *n_chars = 0; /* YY_NULL */
 249                         return n;
 250                 }
 251                 len += (size_t)n;
 252         }
 253
 254         len = (len < max_chars) ? len : max_chars;
 255         data = sdb_strbuf_string(sysdb_input->input);
 256         data += sysdb_input->tokenizer_pos;
 257         strncpy(buf, data, len);
 258
 259         sysdb_input->tokenizer_pos += len;
 260         *n_chars = (int)len;
 261         return (ssize_t)len;
 262 } /* sdb_input_readline */
 263
 264 int
 265 sdb_input_exec_query(void)
 266 {
 267         char *query = sdb_command_exec(sysdb_input);
 268
 269         HIST_ENTRY *current_hist;
 270         const char *hist_line = NULL;
 271
 272         if (! query)
 273                 return -1;
 274
 275         current_hist = current_history();
 276         if (current_hist)
 277                 hist_line = current_hist->line;
 278
 279         if (*query != ' ')
 280                 if ((! hist_line) || strcmp(hist_line, query))
 281                         add_history(query);
 282         free(query);
 283         return 0;
 284 } /* sdb_input_exec_query */
 285
 286 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 287