3 * Bacula Console interface to the Director
5 * Kern Sibbald, September MM
11 Copyright (C) 2000-2003 Kern Sibbald and John Walker
13 This library is free software; you can redistribute it and/or
14 modify it under the terms of the GNU Lesser General Public
15 License as published by the Free Software Foundation; either
16 version 2.1 of the License, or (at your option) any later version.
18 This library is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public
24 License along with this library; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31 #include "console_conf.h"
39 #define con_set_zed_keys();
45 /* Exported variables */
50 extern int rl_catch_signals;
53 /* Imported functions */
54 int authenticate_director(JCR *jcr, DIRRES *director);
58 /* Forward referenced functions */
59 static void terminate_console(int sig);
60 int get_cmd(FILE *input, char *prompt, BSOCK *sock, int sec);
61 static int do_outputcmd(FILE *input, BSOCK *UA_sock);
62 void senditf(char *fmt, ...);
63 void sendit(char *buf);
65 /* Static variables */
66 static char *configfile = NULL;
67 static BSOCK *UA_sock = NULL;
69 static FILE *output = stdout;
70 static bool tee = false; /* output to output and stdout */
71 static bool stop = false;
74 static char *argk[MAX_CMD_ARGS];
75 static char *argv[MAX_CMD_ARGS];
78 /* Command prototypes */
79 static int versioncmd(FILE *input, BSOCK *UA_sock);
80 static int inputcmd(FILE *input, BSOCK *UA_sock);
81 static int outputcmd(FILE *input, BSOCK *UA_sock);
82 static int teecmd(FILE *input, BSOCK *UA_sock);
83 static int quitcmd(FILE *input, BSOCK *UA_sock);
84 static int timecmd(FILE *input, BSOCK *UA_sock);
85 static int sleepcmd(FILE *input, BSOCK *UA_sock);
88 #define CONFIG_FILE "./bconsole.conf" /* default configuration file */
93 "\nVersion: " VERSION " (" BDATE ") %s %s %s\n\n"
94 "Usage: bconsole [-s] [-c config_file] [-d debug_level] [config_file]\n"
95 " -c <file> set configuration file to file\n"
96 " -dnn set debug level to nn\n"
98 " -t test - read configuration and exit\n"
99 " -? print this message.\n"
100 "\n"), HOST_OS, DISTNAME, DISTVER);
103 void got_sigstop(int sig)
108 void got_sigcontinue(int sig)
113 void got_sigtout(int sig)
115 // printf("Got tout\n");
118 void got_sigtin(int sig)
120 // printf("Got tin\n");
123 static int zed_keyscmd(FILE *input, BSOCK *UA_sock)
130 * These are the @command
132 struct cmdstruct { char *key; int (*func)(FILE *input, BSOCK *UA_sock); char *help; };
133 static struct cmdstruct commands[] = {
134 { N_("input"), inputcmd, _("input from file")},
135 { N_("output"), outputcmd, _("output to file")},
136 { N_("quit"), quitcmd, _("quit")},
137 { N_("tee"), teecmd, _("output to file and terminal")},
138 { N_("sleep"), sleepcmd, _("sleep specified time")},
139 { N_("time"), timecmd, _("print current time")},
140 { N_("version"), versioncmd, _("print Console's version")},
141 { N_("exit"), quitcmd, _("exit = quit")},
142 { N_("zed_keyst"), zed_keyscmd, _("zed_keys = use zed keys instead of bash keys")},
144 #define comsize (sizeof(commands)/sizeof(struct cmdstruct))
146 static int do_a_command(FILE *input, BSOCK *UA_sock)
157 Dmsg1(120, "Command: %s\n", UA_sock->msg);
163 if (*cmd == '#') { /* comment */
167 for (i=0; i<comsize; i++) { /* search for command */
168 if (strncasecmp(cmd, _(commands[i].key), len) == 0) {
169 stat = (*commands[i].func)(input, UA_sock); /* go execute command */
175 pm_strcat(&UA_sock->msg, _(": is an illegal command\n"));
176 UA_sock->msglen = strlen(UA_sock->msg);
177 sendit(UA_sock->msg);
183 static void read_and_process_input(FILE *input, BSOCK *UA_sock)
186 bool at_prompt = false;
187 int tty_input = isatty(fileno(input));
191 if (at_prompt) { /* don't prompt multiple times */
198 stat = get_cmd(input, prompt, UA_sock, 30);
201 int len = sizeof_pool_memory(UA_sock->msg) - 1;
202 if (fgets(UA_sock->msg, len, input) == NULL || usrbrk()) {
205 sendit(UA_sock->msg); /* echo to terminal */
206 strip_trailing_junk(UA_sock->msg);
207 UA_sock->msglen = strlen(UA_sock->msg);
212 break; /* error or interrupt */
213 } else if (stat == 0) { /* timeout */
214 if (strcmp(prompt, "*") == 0) {
215 bnet_fsend(UA_sock, ".messages");
221 /* @ => internal command for us */
222 if (UA_sock->msg[0] == '@') {
223 parse_args(UA_sock->msg, &args, &argc, argk, argv, MAX_CMD_ARGS);
224 if (!do_a_command(input, UA_sock)) {
229 if (!bnet_send(UA_sock)) { /* send command */
233 if (strcmp(UA_sock->msg, ".quit") == 0 || strcmp(UA_sock->msg, ".exit") == 0) {
236 while ((stat = bnet_recv(UA_sock)) >= 0) {
243 /* Suppress output if running in background or user hit ctl-c */
244 if (!stop && !usrbrk()) {
245 sendit(UA_sock->msg);
251 if (is_bnet_stop(UA_sock)) {
252 break; /* error or term */
253 } else if (stat == BNET_SIGNAL) {
254 if (UA_sock->msglen == BNET_PROMPT) {
257 Dmsg1(100, "Got poll %s\n", bnet_sig_to_ascii(UA_sock));
263 /*********************************************************************
265 * Main Bacula Console -- User Interface Program
268 int main(int argc, char *argv[])
270 int ch, i, ndir, item;
271 bool no_signals = false;
272 bool test_config = false;
276 my_name_is(argc, argv, "bconsole");
277 textdomain("bacula-console");
278 init_msg(NULL, NULL);
279 working_directory = "/tmp";
280 args = get_pool_memory(PM_FNAME);
283 while ((ch = getopt(argc, argv, "bc:d:r:st?")) != -1) {
285 case 'c': /* configuration file */
286 if (configfile != NULL) {
289 configfile = bstrdup(optarg);
293 debug_level = atoi(optarg);
294 if (debug_level <= 0) {
299 case 's': /* turn off signals */
318 init_signals(terminate_console);
321 /* Override Bacula default signals */
322 signal(SIGCHLD, SIG_IGN);
323 signal(SIGTSTP, got_sigstop);
324 signal(SIGCONT, got_sigcontinue);
325 signal(SIGTTIN, got_sigtin);
326 signal(SIGTTOU, got_sigtout);
335 if (configfile == NULL) {
336 configfile = bstrdup(CONFIG_FILE);
339 parse_config(configfile);
343 foreach_res(dir, R_DIRECTOR) {
349 Emsg1(M_ERROR_TERM, 0, _("No Director resource defined in %s\n\
350 Without that I don't how to speak to the Director :-(\n"), configfile);
354 terminate_console(0);
358 memset(&jcr, 0, sizeof(jcr));
362 UA_sock = init_bsock(NULL, 0, "", "", 0);
364 sendit(_("Available Directors:\n"));
367 foreach_res(dir, R_DIRECTOR) {
368 senditf( _("%d %s at %s:%d\n"), 1+ndir++, dir->hdr.name, dir->address,
372 if (get_cmd(stdin, _("Select Director: "), UA_sock, 600) < 0) {
375 item = atoi(UA_sock->msg);
376 if (item < 0 || item > ndir) {
377 senditf(_("You must enter a number between 1 and %d\n"), ndir);
382 for (i=0; i<item; i++) {
383 dir = (DIRRES *)GetNextRes(R_DIRECTOR, (RES *)dir);
389 dir = (DIRRES *)GetNextRes(R_DIRECTOR, NULL);
393 senditf(_("Connecting to Director %s:%d\n"), dir->address,dir->DIRport);
394 UA_sock = bnet_connect(NULL, 5, 15, "Director daemon", dir->address,
395 NULL, dir->DIRport, 0);
396 if (UA_sock == NULL) {
397 terminate_console(0);
400 jcr.dir_bsock = UA_sock;
401 if (!authenticate_director(&jcr, dir)) {
402 fprintf(stderr, "ERR=%s", UA_sock->msg);
403 terminate_console(0);
407 Dmsg0(40, "Opened connection with Director daemon\n");
409 sendit(_("Enter a period to cancel a command.\n"));
411 /* Run commands in ~/.bconsolerc if any */
412 char *env = getenv("HOME");
415 pm_strcpy(&UA_sock->msg, env);
416 pm_strcat(&UA_sock->msg, "/.bconsolerc");
417 fd = fopen(UA_sock->msg, "r");
419 read_and_process_input(fd, UA_sock);
424 read_and_process_input(stdin, UA_sock);
427 bnet_sig(UA_sock, BNET_TERMINATE); /* send EOF */
431 terminate_console(0);
436 /* Cleanup and then exit */
437 static void terminate_console(int sig)
439 static bool already_here = false;
441 if (already_here) { /* avoid recursive temination problems */
445 free_pool_memory(args);
454 #define READLINE_LIBRARY 1
456 #include "readline.h"
461 get_cmd(FILE *input, char *prompt, BSOCK *sock, int sec)
465 rl_catch_signals = 0; /* do it ourselves */
466 line = readline(prompt);
471 strip_trailing_junk(line);
472 sock->msglen = pm_strcpy(&sock->msg, line);
474 add_history(sock->msg);
480 #else /* no readline, do it ourselves */
483 * Returns: 1 if data available
488 wait_for_data(int fd, int sec)
498 switch(select(fd + 1, &fdset, NULL, NULL, &tv)) {
499 case 0: /* timeout */
502 if (errno == EINTR || errno == EAGAIN) {
505 return -1; /* error return */
513 * Get next input command from terminal.
515 * Returns: 1 if got input
520 get_cmd(FILE *input, char *prompt, BSOCK *sock, int sec)
524 if (output == stdout || tee) {
529 switch (wait_for_data(fileno(input), sec)) {
531 return 0; /* timeout */
533 return -1; /* error */
535 len = sizeof_pool_memory(sock->msg) - 1;
541 if (isatty(fileno(input))) {
542 input_line(sock->msg, len);
546 if (fgets(sock->msg, len, input) == NULL) {
551 strip_trailing_junk(sock->msg);
552 sock->msglen = strlen(sock->msg);
558 static int versioncmd(FILE *input, BSOCK *UA_sock)
560 senditf("Version: " VERSION " (" BDATE ") %s %s %s\n",
561 HOST_OS, DISTNAME, DISTVER);
565 static int inputcmd(FILE *input, BSOCK *UA_sock)
570 sendit(_("Too many arguments on input command.\n"));
574 sendit(_("First argument to input command must be a filename.\n"));
577 fd = fopen(argk[1], "r");
579 senditf(_("Cannot open file %s for input. ERR=%s\n"),
580 argk[1], strerror(errno));
583 read_and_process_input(fd, UA_sock);
588 /* Send output to both termina and specified file */
589 static int teecmd(FILE *input, BSOCK *UA_sock)
592 return do_outputcmd(input, UA_sock);
595 /* Send output to specified "file" */
596 static int outputcmd(FILE *input, BSOCK *UA_sock)
599 return do_outputcmd(input, UA_sock);
603 static int do_outputcmd(FILE *input, BSOCK *UA_sock)
609 sendit(_("Too many arguments on output/tee command.\n"));
613 if (output != stdout) {
623 fd = fopen(argk[1], mode);
625 senditf(_("Cannot open file %s for output. ERR=%s\n"),
626 argk[1], strerror(errno));
633 static int quitcmd(FILE *input, BSOCK *UA_sock)
638 static int sleepcmd(FILE *input, BSOCK *UA_sock)
641 sleep(atoi(argk[1]));
647 static int timecmd(FILE *input, BSOCK *UA_sock)
650 time_t ttime = time(NULL);
652 localtime_r(&ttime, &tm);
653 strftime(sdt, sizeof(sdt), "%d-%b-%Y %H:%M:%S", &tm);
659 * Send a line to the output file and or the terminal
661 void senditf(char *fmt,...)
666 va_start(arg_ptr, fmt);
667 bvsnprintf(buf, sizeof(buf), (char *)fmt, arg_ptr);
672 void sendit(char *buf)
675 if (output == stdout || tee) {
678 * Here, we convert every \n into \r\n because the
679 * terminal is in raw mode when we are using
682 for (p=q=buf; (p=strchr(q, '\n')); ) {
687 q = ++p; /* point after \n */
693 if (output != stdout) {