]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/console/console.c
10b9ebcae9d90ed4078a2a781a408ffecd52bbf8
[bacula/bacula] / bacula / src / console / console.c
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
5
6    The main author of Bacula is Kern Sibbald, with contributions from
7    many others, a complete list can be found in the file AUTHORS.
8    This program is Free Software; you can redistribute it and/or
9    modify it under the terms of version two of the GNU General Public
10    License as published by the Free Software Foundation and included
11    in the file LICENSE.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23    Bacula® is a registered trademark of Kern Sibbald.
24    The licensor of Bacula is the Free Software Foundation Europe
25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26    Switzerland, email:ftf@fsfeurope.org.
27 */
28 /*
29  *
30  *   Bacula Console interface to the Director
31  *
32  *     Kern Sibbald, September MM
33  *
34  *     Version $Id$
35  */
36
37 #include "bacula.h"
38 #include "console_conf.h"
39 #include "jcr.h"
40
41
42 #ifdef HAVE_CONIO
43 #include "conio.h"
44 //#define CONIO_FIX 1
45 #else
46 #define con_init(x)
47 #define con_term()
48 #define con_set_zed_keys();
49 #define trapctlc()
50 #define clrbrk()
51 #define usrbrk() 0
52 #endif
53
54 #if defined(HAVE_WIN32)
55 #define isatty(fd) (fd==0)
56 #endif
57
58 /* Exported variables */
59
60 //extern int rl_catch_signals;
61
62 /* Imported functions */
63 int authenticate_director(JCR *jcr, DIRRES *director, CONRES *cons);
64 extern bool parse_cons_config(CONFIG *config, const char *configfile, int exit_code);
65
66 /* Forward referenced functions */
67 static void terminate_console(int sig);
68 static int check_resources();
69 int get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec);
70 static int do_outputcmd(FILE *input, BSOCK *UA_sock);
71 void senditf(const char *fmt, ...);
72 void sendit(const char *buf);
73
74 extern "C" void got_sigstop(int sig);
75 extern "C" void got_sigcontinue(int sig);
76 extern "C" void got_sigtout(int sig);
77 extern "C" void got_sigtin(int sig);
78
79
80 /* Static variables */
81 static char *configfile = NULL;
82 static BSOCK *UA_sock = NULL;
83 static DIRRES *dir = NULL;
84 static CONRES *cons = NULL;
85 static FILE *output = stdout;
86 static bool teeout = false;               /* output to output and stdout */
87 static bool stop = false;
88 static bool no_conio = false;
89 static int timeout = 0;
90 static int argc;
91 static int numdir;
92 static POOLMEM *args;
93 static char *argk[MAX_CMD_ARGS];
94 static char *argv[MAX_CMD_ARGS];
95 static CONFIG *config;
96
97
98 /* Command prototypes */
99 static int versioncmd(FILE *input, BSOCK *UA_sock);
100 static int inputcmd(FILE *input, BSOCK *UA_sock);
101 static int outputcmd(FILE *input, BSOCK *UA_sock);
102 static int teecmd(FILE *input, BSOCK *UA_sock);
103 static int quitcmd(FILE *input, BSOCK *UA_sock);
104 static int helpcmd(FILE *input, BSOCK *UA_sock);
105 static int echocmd(FILE *input, BSOCK *UA_sock);
106 static int timecmd(FILE *input, BSOCK *UA_sock);
107 static int sleepcmd(FILE *input, BSOCK *UA_sock);
108 static int execcmd(FILE *input, BSOCK *UA_sock);
109 #ifdef HAVE_READLINE
110 static int eolcmd(FILE *input, BSOCK *UA_sock);
111
112 # ifndef HAVE_REGEX_H
113 #  include "lib/bregex.h"
114 # else
115 #  include <regex.h>
116 # endif
117
118 #endif
119
120
121 #define CONFIG_FILE "bconsole.conf"   /* default configuration file */
122
123 static void usage()
124 {
125    fprintf(stderr, _(
126 PROG_COPYRIGHT
127 "\nVersion: " VERSION " (" BDATE ") %s %s %s\n\n"
128 "Usage: bconsole [-s] [-c config_file] [-d debug_level]\n"
129 "       -D <dir>    select a Director\n"
130 "       -c <file>   set configuration file to file\n"
131 "       -d <nn>     set debug level to <nn>\n"
132 "       -dt         print timestamp in debug output\n"
133 "       -n          no conio\n"
134 "       -s          no signals\n"
135 "       -u <nn>     set command execution timeout to <nn> seconds\n"
136 "       -t          test - read configuration and exit\n"
137 "       -?          print this message.\n"
138 "\n"), 2000, HOST_OS, DISTNAME, DISTVER);
139 }
140
141
142 extern "C"
143 void got_sigstop(int sig)
144 {
145    stop = true;
146 }
147
148 extern "C"
149 void got_sigcontinue(int sig)
150 {
151    stop = false;
152 }
153
154 extern "C"
155 void got_sigtout(int sig)
156 {
157 // printf("Got tout\n");
158 }
159
160 extern "C"
161 void got_sigtin(int sig)
162 {
163 // printf("Got tin\n");
164 }
165
166
167 static int zed_keyscmd(FILE *input, BSOCK *UA_sock)
168 {
169    con_set_zed_keys();
170    return 1;
171 }
172
173 /*
174  * These are the @command
175  */
176 struct cmdstruct { const char *key; int (*func)(FILE *input, BSOCK *UA_sock); const char *help; };
177 static struct cmdstruct commands[] = {
178  { N_("input"),      inputcmd,     _("input from file")},
179  { N_("output"),     outputcmd,    _("output to file")},
180  { N_("quit"),       quitcmd,      _("quit")},
181  { N_("tee"),        teecmd,       _("output to file and terminal")},
182  { N_("sleep"),      sleepcmd,     _("sleep specified time")},
183  { N_("time"),       timecmd,      _("print current time")},
184  { N_("version"),    versioncmd,   _("print Console's version")},
185  { N_("echo"),       echocmd,      _("echo command string")},
186  { N_("exec"),       execcmd,      _("execute an external command")},
187  { N_("exit"),       quitcmd,      _("exit = quit")},
188  { N_("zed_keys"),   zed_keyscmd,  _("zed_keys = use zed keys instead of bash keys")},
189  { N_("help"),       helpcmd,      _("help listing")},
190 #ifdef HAVE_READLINE
191  { N_("separator"),  eolcmd,       _("set command separator")},
192 #endif
193              };
194 #define comsize ((int)(sizeof(commands)/sizeof(struct cmdstruct)))
195
196 static int do_a_command(FILE *input, BSOCK *UA_sock)
197 {
198    unsigned int i;
199    int stat;
200    int found;
201    int len;
202    char *cmd;
203
204    found = 0;
205    stat = 1;
206
207    Dmsg1(120, "Command: %s\n", UA_sock->msg);
208    if (argc == 0) {
209       return 1;
210    }
211
212    cmd = argk[0]+1;
213    if (*cmd == '#') {                 /* comment */
214       return 1;
215    }
216    len = strlen(cmd);
217    for (i=0; i<comsize; i++) {     /* search for command */
218       if (strncasecmp(cmd,  _(commands[i].key), len) == 0) {
219          stat = (*commands[i].func)(input, UA_sock);   /* go execute command */
220          found = 1;
221          break;
222       }
223    }
224    if (!found) {
225       pm_strcat(&UA_sock->msg, _(": is an invalid command\n"));
226       UA_sock->msglen = strlen(UA_sock->msg);
227       sendit(UA_sock->msg);
228    }
229    return stat;
230 }
231
232
233 static void read_and_process_input(FILE *input, BSOCK *UA_sock)
234 {
235    const char *prompt = "*";
236    bool at_prompt = false;
237    int tty_input = isatty(fileno(input));
238    int stat;
239    btimer_t *tid=NULL;
240
241    for ( ;; ) {
242       if (at_prompt) {                /* don't prompt multiple times */
243          prompt = "";
244       } else {
245          prompt = "*";
246          at_prompt = true;
247       }
248       if (tty_input) {
249          stat = get_cmd(input, prompt, UA_sock, 30);
250          if (usrbrk() == 1) {
251             clrbrk();
252          }
253          if (usrbrk()) {
254             break;
255          }
256       } else {
257          /* Reading input from a file */
258          int len = sizeof_pool_memory(UA_sock->msg) - 1;
259          if (usrbrk()) {
260             break;
261          }
262          if (fgets(UA_sock->msg, len, input) == NULL) {
263             stat = -1;
264          } else {
265             sendit(UA_sock->msg);  /* echo to terminal */
266             strip_trailing_junk(UA_sock->msg);
267             UA_sock->msglen = strlen(UA_sock->msg);
268             stat = 1;
269          }
270       }
271       if (stat < 0) {
272          break;                       /* error or interrupt */
273       } else if (stat == 0) {         /* timeout */
274          if (strcmp(prompt, "*") == 0) {
275             tid = start_bsock_timer(UA_sock, timeout);
276             UA_sock->fsend(".messages");
277             stop_bsock_timer(tid);
278          } else {
279             continue;
280          }
281       } else {
282          at_prompt = false;
283          /* @ => internal command for us */
284          if (UA_sock->msg[0] == '@') {
285             parse_args(UA_sock->msg, &args, &argc, argk, argv, MAX_CMD_ARGS);
286             if (!do_a_command(input, UA_sock)) {
287                break;
288             }
289             continue;
290          }
291          tid = start_bsock_timer(UA_sock, timeout);
292          if (!UA_sock->send()) {   /* send command */
293             stop_bsock_timer(tid);
294             break;                    /* error */
295          }
296          stop_bsock_timer(tid);
297       }
298       if (strcmp(UA_sock->msg, ".quit") == 0 || strcmp(UA_sock->msg, ".exit") == 0) {
299          break;
300       }
301       tid = start_bsock_timer(UA_sock, timeout);
302       while ((stat = UA_sock->recv()) >= 0) {
303          if (at_prompt) {
304             if (!stop) {
305                sendit("\n");
306             }
307             at_prompt = false;
308          }
309          /* Suppress output if running in background or user hit ctl-c */
310          if (!stop && !usrbrk()) {
311             sendit(UA_sock->msg);
312          }
313       }
314       stop_bsock_timer(tid);
315       if (usrbrk() > 1) {
316          break;
317       } else {
318          clrbrk();
319       }
320       if (!stop) {
321          fflush(stdout);
322       }
323       if (is_bnet_stop(UA_sock)) {
324          break;                       /* error or term */
325       } else if (stat == BNET_SIGNAL) {
326          if (UA_sock->msglen == BNET_PROMPT) {
327             at_prompt = true;
328          }
329          Dmsg1(100, "Got poll %s\n", bnet_sig_to_ascii(UA_sock));
330       }
331    }
332 }
333
334 /*
335  * Call-back for reading a passphrase for an encrypted PEM file
336  * This function uses getpass(), 
337  *  which uses a static buffer and is NOT thread-safe.
338  */
339 static int tls_pem_callback(char *buf, int size, const void *userdata)
340 {
341 #ifdef HAVE_TLS
342    const char *prompt = (const char *)userdata;
343 # if defined(HAVE_WIN32)
344    sendit(prompt);
345    if (win32_cgets(buf, size) == NULL) {
346       buf[0] = 0;
347       return 0;
348    } else {
349       return strlen(buf);
350    }
351 # else
352    char *passwd;
353
354    passwd = getpass(prompt);
355    bstrncpy(buf, passwd, size);
356    return strlen(buf);
357 # endif
358 #else
359    buf[0] = 0;
360    return 0;
361 #endif
362 }
363
364 #ifdef HAVE_READLINE
365 #define READLINE_LIBRARY 1
366 #include "readline.h"
367 #include "history.h"
368
369 /* Get the first keyword of the line */
370 static char *
371 get_first_keyword()
372 {
373    char *ret=NULL;
374    int len;
375    char *first_space = strchr(rl_line_buffer, ' ');
376    if (first_space) {
377       len = first_space - rl_line_buffer;
378       ret = (char *) malloc((len + 1) * sizeof(char));
379       memcpy(ret, rl_line_buffer, len);
380       ret[len]=0;
381    }
382    return ret;
383 }
384
385 /*
386  * Return the command before the current point.
387  * Set nb to the number of command to skip
388  */
389 static char *
390 get_previous_keyword(int current_point, int nb)
391 {
392    int i, end=-1, start, inquotes=0;
393    char *s=NULL;
394
395    while (nb-- >= 0) {
396       /* first we look for a space before the current word */
397       for (i = current_point; i >= 0; i--) {
398          if (rl_line_buffer[i] == ' ' || rl_line_buffer[i] == '=') {
399             break;
400          }
401       }
402       
403       /* find the end of the command */
404       for (; i >= 0; i--) {
405          if (rl_line_buffer[i] != ' ') {
406             end = i;
407             break;
408          }
409       }
410       
411       /* no end of string */
412       if (end == -1) {
413          return NULL;
414       }
415       
416       /* look for the start of the command */
417       for (start = end; start > 0; start--) {
418          if (rl_line_buffer[start] == '"') {
419             inquotes = !inquotes;
420          }
421          if ((rl_line_buffer[start - 1] == ' ') && inquotes == 0) {
422             break;
423          }
424          current_point = start;
425       }
426    }
427
428    s = (char *)malloc(end - start + 2);
429    memcpy(s, rl_line_buffer + start, end - start + 1);
430    s[end - start + 1] = 0;
431
432    //  printf("=======> %i:%i <%s>\n", start, end, s);
433
434    return s;
435 }
436
437 /* Simple structure that will contain the completion list */
438 struct ItemList {
439    alist list;
440 };
441
442 static ItemList *items = NULL;
443 void init_items()
444 {
445    if (!items) {
446       items = (ItemList*) malloc(sizeof(ItemList));
447       memset(items, 0, sizeof(ItemList));
448
449    } else {
450       items->list.destroy();
451    }
452
453    items->list.init();
454 }
455
456 /* Match a regexp and add the result to the items list
457  * This function is recursive
458  */
459 static void match_kw(regex_t *preg, const char *what, int len, POOLMEM **buf)
460 {
461    int rc, size;
462    int nmatch=20;
463    regmatch_t pmatch[20];
464
465    if (len <= 0) {
466       return;
467    }
468    rc = regexec(preg, what, nmatch, pmatch, 0);
469    if (rc == 0) {
470 #if 0
471       Pmsg1(0, "\n\n%s\n0123456789012345678901234567890123456789\n        10         20         30\n", what);
472       Pmsg2(0, "%i-%i\n", pmatch[0].rm_so, pmatch[0].rm_eo);
473       Pmsg2(0, "%i-%i\n", pmatch[1].rm_so, pmatch[1].rm_eo);
474       Pmsg2(0, "%i-%i\n", pmatch[2].rm_so, pmatch[2].rm_eo);
475       Pmsg2(0, "%i-%i\n", pmatch[3].rm_so, pmatch[3].rm_eo);
476 #endif
477       size = pmatch[1].rm_eo - pmatch[1].rm_so;
478       *buf = check_pool_memory_size(*buf, size + 1);
479       memcpy(*buf, what+pmatch[1].rm_so, size);
480       (*buf)[size] = 0;
481
482       items->list.append(bstrdup(*buf));
483       /* We search for the next keyword in the line */
484       match_kw(preg, what + pmatch[1].rm_eo, len - pmatch[1].rm_eo, buf);
485    }
486 }
487
488 /* fill the items list with the output of the help command */
489 void get_arguments(const char *what)
490 {
491    regex_t preg;
492    POOLMEM *buf;
493    int rc;
494    init_items();
495
496    rc = regcomp(&preg, "(([a-z]+=)|([a-z]+)( |$))", REG_EXTENDED);
497    if (rc != 0) {
498       return;
499    }
500
501    buf = get_pool_memory(PM_MESSAGE);
502    UA_sock->fsend(".help item=%s", what);
503    while (UA_sock->recv() > 0) {
504       strip_trailing_junk(UA_sock->msg);
505       match_kw(&preg, UA_sock->msg, UA_sock->msglen, &buf);
506    }
507    free_pool_memory(buf);
508    regfree(&preg);
509 }
510
511 /* retreive a simple list (.pool, .client) and store it into items */
512 void get_items(const char *what)
513 {
514    init_items();
515
516    UA_sock->fsend("%s", what);
517    while (UA_sock->recv() > 0) {
518       strip_trailing_junk(UA_sock->msg);
519       items->list.append(bstrdup(UA_sock->msg));
520    }
521 }
522
523 typedef enum 
524 {
525    ITEM_ARG,       /* item with simple list like .job */
526    ITEM_HELP       /* use help item=xxx and detect all arguments */
527 } cpl_item_t;
528
529 /* Generator function for command completion.  STATE lets us know whether
530  * to start from scratch; without any state (i.e. STATE == 0), then we
531  * start at the top of the list. 
532  */
533 static char *item_generator(const char *text, int state, 
534                             const char *item, cpl_item_t type)
535 {
536   static int list_index, len;
537   char *name;
538
539   /* If this is a new word to complete, initialize now.  This includes
540    * saving the length of TEXT for efficiency, and initializing the index
541    *  variable to 0. 
542    */
543   if (!state)
544   {
545      list_index = 0;
546      len = strlen(text);
547      switch(type) {
548      case ITEM_ARG:
549         get_items(item);
550         break;
551      case ITEM_HELP:
552         get_arguments(item);
553         break;
554      }
555   }
556
557   /* Return the next name which partially matches from the command list. */
558   while (items && list_index < items->list.size())
559   {
560      name = (char *)items->list[list_index];
561      list_index++;
562      
563      if (strncmp(name, text, len) == 0) {
564         char *ret = (char *) actuallymalloc(strlen(name)+1);
565         strcpy(ret, name);
566         return ret;
567      }
568   }
569
570   /* If no names matched, then return NULL. */
571   return ((char *)NULL);   
572 }
573
574 /* gobal variables for the type and the item to search 
575  * the readline API doesn' permit to pass user data.
576  */
577 static const char *cpl_item;
578 static cpl_item_t cpl_type;
579
580 static char *cpl_generator(const char *text, int state)
581 {
582    return item_generator(text, state, cpl_item, cpl_type);
583 }
584
585 /* this function is used to not use the default filename completion */
586 static char *dummy_completion_function(const char *text, int state)
587 {
588    return NULL;
589 }
590
591 struct cpl_keywords_t {
592    const char *key;
593    const char *cmd;
594 };
595
596 static struct cpl_keywords_t cpl_keywords[] = {
597    {"pool=",      ".pool"          },
598    {"fileset=",   ".fileset"       },
599    {"client=",    ".client"        },
600    {"job=",       ".job"           },
601    {"level=",     ".level"         },
602    {"storage=",   ".storage"       },
603    {"schedule=",  ".schedule"      },
604    {"volume=",    ".media"         },
605    {"oldvolume=", ".media"         },
606    {"volstatus=", ".volstatus"     },
607    {"ls",         ".ls"            },
608    {"cd",         ".lsdir"         },
609    {"mark",       ".ls"            },
610    {"m",          ".ls"            },
611    {"unmark",     ".lsmark"        },
612    {"actiononpurge=", ".actiononpurge" }
613 };
614 #define key_size ((int)(sizeof(cpl_keywords)/sizeof(struct cpl_keywords_t)))
615
616 /* Attempt to complete on the contents of TEXT.  START and END bound the
617  * region of rl_line_buffer that contains the word to complete.  TEXT is
618  * the word to complete.  We can use the entire contents of rl_line_buffer
619  * in case we want to do some simple parsing.  Return the array of matches,
620  * or NULL if there aren't any. 
621  */
622 static char **readline_completion(const char *text, int start, int end)
623 {
624    bool found=false;
625    char **matches;
626    char *s, *cmd;
627    matches = (char **)NULL;
628
629    /* If this word is at the start of the line, then it is a command
630     * to complete.  Otherwise it is the name of a file in the current
631     * directory. 
632     */
633    s = get_previous_keyword(start, 0);
634    cmd = get_first_keyword();
635    if (s) {
636       for (int i=0; i < key_size; i++) {
637          if (!strcasecmp(s, cpl_keywords[i].key)) {
638             cpl_item = cpl_keywords[i].cmd;
639             cpl_type = ITEM_ARG;
640             matches = rl_completion_matches(text, cpl_generator);
641             found=true;
642             break;
643          }
644       }
645       
646       if (!found) {             /* we try to get help with the first command */
647          cpl_item = cmd;
648          cpl_type = ITEM_HELP;
649          /* we don't want to append " " at the end */
650          rl_completion_suppress_append=true; 
651          matches = rl_completion_matches(text, cpl_generator);
652       } 
653       free(s);
654    } else {                     /* nothing on the line, display all commands */
655       cpl_item = ".help all";
656       cpl_type = ITEM_ARG;
657       matches = rl_completion_matches(text, cpl_generator);
658    }
659    if (cmd) {
660       free(cmd);
661    }
662    return (matches);
663 }
664
665 static char eol = '\0';
666 static int eolcmd(FILE *input, BSOCK *UA_sock)
667 {
668    if ((argc > 1) && (strchr("!$%&'()*+,-/:;<>?[]^`{|}~", argk[1][0]) != NULL)) {
669       eol = argk[1][0];
670    } else if (argc == 1) {
671       eol = '\0';
672    } else {
673       sendit(_("Illegal separator character.\n"));
674    }
675    return 1;
676 }
677
678 int
679 get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec)
680 {
681    static char *line = NULL;
682    static char *next = NULL;
683    static int do_history = 0;
684    char *command;
685
686    if (line == NULL) {
687       do_history = 0;
688       rl_catch_signals = 0;              /* do it ourselves */
689       /* Here, readline does ***real*** malloc
690        * so, be we have to use the real free
691        */
692       line = readline((char *)prompt);   /* cast needed for old readlines */
693       if (!line) {
694          exit(1);
695       }
696       strip_trailing_junk(line);
697       command = line;
698    } else if (next) {
699       command = next + 1;
700    } else {
701      sendit(_("Command logic problem\n"));
702      sock->msglen = 0;
703      sock->msg[0] = 0;
704      return 0;
705    }
706
707    /*
708     * Split "line" into multiple commands separated by the eol character.
709     *   Each part is pointed to by "next" until finally it becomes null.
710     */
711    if (eol == '\0') {
712       next = NULL;
713    } else {
714       next = strchr(command, eol);
715       if (next) {
716          *next = '\0';
717       }
718    }
719    if (command != line && isatty(fileno(input))) {
720       senditf("%s%s\n", prompt, command);
721    }
722
723    sock->msglen = pm_strcpy(&sock->msg, command);
724    if (sock->msglen) {
725       do_history++;
726    }
727
728    if (!next) {
729       if (do_history) {
730         add_history(line);
731       }
732       actuallyfree(line);       /* allocated by readline() malloc */
733       line = NULL;
734    }
735    return 1;
736 }
737
738 #else /* no readline, do it ourselves */
739
740 #ifdef HAVE_CONIO
741 static bool bisatty(int fd)
742 {
743    if (no_conio) {
744       return false;
745    }
746    return isatty(fd);
747 }
748 #endif
749
750 /*
751  *   Returns: 1 if data available
752  *            0 if timeout
753  *           -1 if error
754  */
755 static int
756 wait_for_data(int fd, int sec)
757 {
758 #if defined(HAVE_WIN32)
759    return 1;
760 #else
761    fd_set fdset;
762    struct timeval tv;
763
764    tv.tv_sec = sec;
765    tv.tv_usec = 0;
766    for ( ;; ) {
767       FD_ZERO(&fdset);
768       FD_SET((unsigned)fd, &fdset);
769       switch(select(fd + 1, &fdset, NULL, NULL, &tv)) {
770       case 0:                         /* timeout */
771          return 0;
772       case -1:
773          if (errno == EINTR || errno == EAGAIN) {
774             continue;
775          }
776          return -1;                  /* error return */
777       default:
778          return 1;
779       }
780    }
781 #endif
782 }
783
784 /*
785  * Get next input command from terminal.
786  *
787  *   Returns: 1 if got input
788  *            0 if timeout
789  *           -1 if EOF or error
790  */
791 int
792 get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec)
793 {
794    int len;
795    if (!stop) {
796       if (output == stdout || teeout) {
797          sendit(prompt);
798       }
799    }
800 again:
801    switch (wait_for_data(fileno(input), sec)) {
802    case 0:
803       return 0;                    /* timeout */
804    case -1:
805       return -1;                   /* error */
806    default:
807       len = sizeof_pool_memory(sock->msg) - 1;
808       if (stop) {
809          sleep(1);
810          goto again;
811       }
812 #ifdef HAVE_CONIO
813       if (bisatty(fileno(input))) {
814          input_line(sock->msg, len);
815          break;
816       }
817 #endif
818 #ifdef HAVE_WIN32 /* use special console for input on win32 */
819       if (input == stdin) {
820          if (win32_cgets(sock->msg, len) == NULL) {
821             return -1;
822          }
823       }
824       else
825 #endif
826       if (fgets(sock->msg, len, input) == NULL) {
827          return -1;
828
829       }
830       break;
831    }
832    if (usrbrk()) {
833       clrbrk();
834    }
835    strip_trailing_junk(sock->msg);
836    sock->msglen = strlen(sock->msg);
837    return 1;
838 }
839
840 #endif /* ! HAVE_READLINE */
841
842
843 static int console_update_history(const char *histfile)
844 {
845    int ret=0;
846
847 #ifdef HAVE_READLINE
848 /* first, try to truncate the history file, and if it
849  * fail, the file is probably not present, and we
850  * can use write_history to create it
851  */
852
853    if (history_truncate_file(histfile, 100) == 0) {
854       ret = append_history(history_length, histfile);
855    } else {
856       ret = write_history(histfile);
857    }
858
859 #endif
860
861    return ret;
862 }
863
864 static int console_init_history(const char *histfile)
865 {
866    int ret=0;
867
868 #ifdef HAVE_READLINE
869
870    using_history();
871    ret = read_history(histfile);
872    /* Tell the completer that we want a complete . */
873    rl_completion_entry_function = dummy_completion_function;
874    rl_attempted_completion_function = readline_completion;
875    rl_filename_completion_desired = 0;
876    stifle_history(100);
877 #endif
878
879    return ret;
880 }
881
882 bool select_director(const char *director, DIRRES **ret_dir, CONRES **ret_cons)
883 {
884    int numcon=0, numdir=0;
885    int i=0, item=0;
886    BSOCK *UA_sock;
887    DIRRES *dir=NULL;
888    CONRES *cons=NULL;
889    struct sockaddr client_addr;
890    memset(&client_addr, 0, sizeof(client_addr));
891
892    *ret_cons = NULL;
893    *ret_dir = NULL;
894
895    LockRes();
896    numdir = 0;
897    foreach_res(dir, R_DIRECTOR) {
898       numdir++;
899    }
900    numcon = 0;
901    foreach_res(cons, R_CONSOLE) {
902       numcon++;
903    }
904    UnlockRes();
905
906    if (numdir == 1) {           /* No choose */
907       dir = (DIRRES *)GetNextRes(R_DIRECTOR, NULL);
908
909    } else if (director) {       /* Command line choice */
910       LockRes();
911       foreach_res(dir, R_DIRECTOR) {
912          if (bstrcmp(dir->hdr.name, director)) {
913             break;
914          }
915       }
916       UnlockRes();
917    }
918
919    if (!dir) {                  /* prompt for director */
920       UA_sock = init_bsock(NULL, 0, "", "", 0, &client_addr);
921 try_again:
922       sendit(_("Available Directors:\n"));
923       LockRes();
924       numdir = 0;
925       foreach_res(dir, R_DIRECTOR) {
926          senditf( _("%2d:  %s at %s:%d\n"), 1+numdir++, dir->hdr.name, 
927                   dir->address, dir->DIRport);
928       }
929       UnlockRes();
930       if (get_cmd(stdin, _("Select Director by entering a number: "), 
931                   UA_sock, 600) < 0) 
932       {
933          (void)WSACleanup();               /* Cleanup Windows sockets */
934          return 0;
935       }
936       if (!is_a_number(UA_sock->msg)) {
937          senditf(_("%s is not a number. You must enter a number between "
938                    "1 and %d\n"), 
939                  UA_sock->msg, numdir);
940          goto try_again;
941       }
942       item = atoi(UA_sock->msg);
943       if (item < 0 || item > numdir) {
944          senditf(_("You must enter a number between 1 and %d\n"), numdir);
945          goto try_again;
946       }
947       term_bsock(UA_sock);
948       LockRes();
949       for (i=0; i<item; i++) {
950          dir = (DIRRES *)GetNextRes(R_DIRECTOR, (RES *)dir);
951       }
952       UnlockRes();
953    }
954    LockRes();
955    /* Look for a console linked to this director */
956    for (i=0; i<numcon; i++) {
957       cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)cons);
958       if (cons->director && strcmp(cons->director, dir->hdr.name) == 0) {
959          break;
960       }
961       cons = NULL;
962    }
963    /* Look for the first non-linked console */
964    if (cons == NULL) {
965       for (i=0; i<numcon; i++) {
966          cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)cons);
967          if (cons->director == NULL)
968             break;
969          cons = NULL;
970       }
971    }
972
973    /* If no console, take first one */
974    if (!cons) {
975       cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)NULL);
976    }
977    UnlockRes();
978
979    *ret_dir = dir;
980    *ret_cons = cons;
981    
982    return 1;
983 }
984
985 /*********************************************************************
986  *
987  *         Main Bacula Console -- User Interface Program
988  *
989  */
990 int main(int argc, char *argv[])
991 {
992    int ch;
993    char *director=NULL;
994    bool no_signals = false;
995    bool test_config = false;
996    JCR jcr;
997    utime_t heart_beat;
998
999    setlocale(LC_ALL, "");
1000    bindtextdomain("bacula", LOCALEDIR);
1001    textdomain("bacula");
1002
1003    init_stack_dump();
1004    lmgr_init_thread();
1005    my_name_is(argc, argv, "bconsole");
1006    init_msg(NULL, NULL);
1007    working_directory = "/tmp";
1008    args = get_pool_memory(PM_FNAME);
1009
1010    while ((ch = getopt(argc, argv, "bc:d:nstu:D:?")) != -1) {
1011       switch (ch) {
1012       case 'D':                    /* Director */
1013          if (director) {
1014             free(director);
1015          }
1016          director = bstrdup(optarg);
1017          break;
1018
1019       case 'c':                    /* configuration file */
1020          if (configfile != NULL) {
1021             free(configfile);
1022          }
1023          configfile = bstrdup(optarg);
1024          break;
1025
1026       case 'd':
1027          if (*optarg == 't') {
1028             dbg_timestamp = true;
1029          } else {
1030             debug_level = atoi(optarg);
1031             if (debug_level <= 0) {
1032                debug_level = 1;
1033             }
1034          }
1035          break;
1036
1037       case 'n':                    /* no conio */
1038          no_conio = true;
1039          break;
1040
1041       case 's':                    /* turn off signals */
1042          no_signals = true;
1043          break;
1044
1045       case 't':
1046          test_config = true;
1047          break;
1048
1049       case 'u':
1050          timeout = atoi(optarg);
1051          break;
1052
1053       case '?':
1054       default:
1055          usage();
1056          exit(1);
1057       }
1058    }
1059    argc -= optind;
1060    argv += optind;
1061
1062    if (!no_signals) {
1063       init_signals(terminate_console);
1064    }
1065
1066
1067 #if !defined(HAVE_WIN32)
1068    /* Override Bacula default signals */
1069    signal(SIGQUIT, SIG_IGN);
1070    signal(SIGTSTP, got_sigstop);
1071    signal(SIGCONT, got_sigcontinue);
1072    signal(SIGTTIN, got_sigtin);
1073    signal(SIGTTOU, got_sigtout);
1074    trapctlc();
1075 #endif
1076
1077    OSDependentInit();
1078
1079    if (argc) {
1080       usage();
1081       exit(1);
1082    }
1083
1084    if (configfile == NULL) {
1085       configfile = bstrdup(CONFIG_FILE);
1086    }
1087
1088    config = new_config_parser();
1089    parse_cons_config(config, configfile, M_ERROR_TERM);
1090
1091    if (init_crypto() != 0) {
1092       Emsg0(M_ERROR_TERM, 0, _("Cryptography library initialization failed.\n"));
1093    }
1094
1095    if (!check_resources()) {
1096       Emsg1(M_ERROR_TERM, 0, _("Please correct configuration file: %s\n"), configfile);
1097    }
1098
1099    if (!no_conio) {
1100       con_init(stdin);
1101    }
1102
1103    if (test_config) {
1104       terminate_console(0);
1105       exit(0);
1106    }
1107
1108    memset(&jcr, 0, sizeof(jcr));
1109
1110    (void)WSA_Init();                        /* Initialize Windows sockets */
1111
1112    start_watchdog();                        /* Start socket watchdog */
1113
1114    if(!select_director(director, &dir, &cons)) {
1115       return 0;
1116    }
1117
1118    senditf(_("Connecting to Director %s:%d\n"), dir->address,dir->DIRport);
1119
1120    char buf[1024];
1121    /* Initialize Console TLS context */
1122    if (cons && (cons->tls_enable || cons->tls_require)) {
1123       /* Generate passphrase prompt */
1124       bsnprintf(buf, sizeof(buf), "Passphrase for Console \"%s\" TLS private key: ", cons->hdr.name);
1125
1126       /* Initialize TLS context:
1127        * Args: CA certfile, CA certdir, Certfile, Keyfile,
1128        * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer   
1129        */
1130       cons->tls_ctx = new_tls_context(cons->tls_ca_certfile,
1131          cons->tls_ca_certdir, cons->tls_certfile,
1132          cons->tls_keyfile, tls_pem_callback, &buf, NULL, true);
1133
1134       if (!cons->tls_ctx) {
1135          senditf(_("Failed to initialize TLS context for Console \"%s\".\n"),
1136             dir->hdr.name);
1137          terminate_console(0);
1138          return 1;
1139       }
1140    }
1141
1142    /* Initialize Director TLS context */
1143    if (dir->tls_enable || dir->tls_require) {
1144       /* Generate passphrase prompt */
1145       bsnprintf(buf, sizeof(buf), "Passphrase for Director \"%s\" TLS private key: ", dir->hdr.name);
1146
1147       /* Initialize TLS context:
1148        * Args: CA certfile, CA certdir, Certfile, Keyfile,
1149        * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer */
1150       dir->tls_ctx = new_tls_context(dir->tls_ca_certfile,
1151          dir->tls_ca_certdir, dir->tls_certfile,
1152          dir->tls_keyfile, tls_pem_callback, &buf, NULL, true);
1153
1154       if (!dir->tls_ctx) {
1155          senditf(_("Failed to initialize TLS context for Director \"%s\".\n"),
1156             dir->hdr.name);
1157          terminate_console(0);
1158          return 1;
1159       }
1160    }
1161
1162    if (dir->heartbeat_interval) {
1163       heart_beat = dir->heartbeat_interval;
1164    } else if (cons) {
1165       heart_beat = cons->heartbeat_interval;
1166    } else {
1167       heart_beat = 0;
1168    }
1169    UA_sock = bnet_connect(NULL, 5, 15, heart_beat, "Director daemon", dir->address,
1170                           NULL, dir->DIRport, 0);
1171    if (UA_sock == NULL) {
1172       terminate_console(0);
1173       return 1;
1174    }
1175    jcr.dir_bsock = UA_sock;
1176
1177    /* If cons==NULL, default console will be used */
1178    if (!authenticate_director(&jcr, dir, cons)) {
1179       terminate_console(0);
1180       return 1;
1181    }
1182
1183    Dmsg0(40, "Opened connection with Director daemon\n");
1184
1185    sendit(_("Enter a period to cancel a command.\n"));
1186
1187    /* Read/Update history file if HOME exists */
1188    POOL_MEM history_file;
1189
1190    /* Run commands in ~/.bconsolerc if any */
1191    char *env = getenv("HOME");
1192    if (env) {
1193       FILE *fd;
1194       pm_strcpy(&UA_sock->msg, env);
1195       pm_strcat(&UA_sock->msg, "/.bconsolerc");
1196       fd = fopen(UA_sock->msg, "rb");
1197       if (fd) {
1198          read_and_process_input(fd, UA_sock);
1199          fclose(fd);
1200       }
1201
1202       pm_strcpy(history_file, env);
1203       pm_strcat(history_file, "/.bconsole_history");
1204       console_init_history(history_file.c_str());
1205    }
1206
1207    read_and_process_input(stdin, UA_sock);
1208
1209    if (UA_sock) {
1210       UA_sock->signal(BNET_TERMINATE); /* send EOF */
1211       UA_sock->close();
1212    }
1213
1214    if (env) {
1215       console_update_history(history_file.c_str());
1216    }
1217
1218    terminate_console(0);
1219    return 0;
1220 }
1221
1222 /* Cleanup and then exit */
1223 static void terminate_console(int sig)
1224 {
1225
1226    static bool already_here = false;
1227
1228    if (already_here) {                /* avoid recursive temination problems */
1229       exit(1);
1230    }
1231    already_here = true;
1232    stop_watchdog();
1233    config->free_resources();
1234    free(config);
1235    config = NULL;
1236    cleanup_crypto();
1237    free_pool_memory(args);
1238    if (!no_conio) {
1239       con_term();
1240    }
1241    (void)WSACleanup();               /* Cleanup Windows sockets */
1242    lmgr_cleanup_main();
1243
1244    if (sig != 0) {
1245       exit(1);
1246    }
1247    return;
1248 }
1249
1250 /*
1251  * Make a quick check to see that we have all the
1252  * resources needed.
1253  */
1254 static int check_resources()
1255 {
1256    bool OK = true;
1257    DIRRES *director;
1258    bool tls_needed;
1259
1260    LockRes();
1261
1262    numdir = 0;
1263    foreach_res(director, R_DIRECTOR) {
1264
1265       numdir++;
1266       /* tls_require implies tls_enable */
1267       if (director->tls_require) {
1268          if (have_tls) {
1269             director->tls_enable = true;
1270          } else {
1271             Jmsg(NULL, M_FATAL, 0, _("TLS required but not configured in Bacula.\n"));
1272             OK = false;
1273             continue;
1274          }
1275       }
1276       tls_needed = director->tls_enable || director->tls_authenticate;
1277
1278       if ((!director->tls_ca_certfile && !director->tls_ca_certdir) && tls_needed) {
1279          Emsg2(M_FATAL, 0, _("Neither \"TLS CA Certificate\""
1280                              " or \"TLS CA Certificate Dir\" are defined for Director \"%s\" in %s."
1281                              " At least one CA certificate store is required.\n"),
1282                              director->hdr.name, configfile);
1283          OK = false;
1284       }
1285    }
1286    
1287    if (numdir == 0) {
1288       Emsg1(M_FATAL, 0, _("No Director resource defined in %s\n"
1289                           "Without that I don't how to speak to the Director :-(\n"), configfile);
1290       OK = false;
1291    }
1292
1293    CONRES *cons;
1294    /* Loop over Consoles */
1295    foreach_res(cons, R_CONSOLE) {
1296       /* tls_require implies tls_enable */
1297       if (cons->tls_require) {
1298          if (have_tls) {
1299             cons->tls_enable = true;
1300          } else {
1301             Jmsg(NULL, M_FATAL, 0, _("TLS required but not configured in Bacula.\n"));
1302             OK = false;
1303             continue;
1304          }
1305       }
1306       tls_needed = cons->tls_enable || cons->tls_authenticate;
1307       if ((!cons->tls_ca_certfile && !cons->tls_ca_certdir) && tls_needed) {
1308          Emsg2(M_FATAL, 0, _("Neither \"TLS CA Certificate\""
1309                              " or \"TLS CA Certificate Dir\" are defined for Console \"%s\" in %s.\n"),
1310                              cons->hdr.name, configfile);
1311          OK = false;
1312       }
1313    }
1314
1315    UnlockRes();
1316
1317    return OK;
1318 }
1319
1320 static int versioncmd(FILE *input, BSOCK *UA_sock)
1321 {
1322    senditf("Version: " VERSION " (" BDATE ") %s %s %s\n",
1323       HOST_OS, DISTNAME, DISTVER);
1324    return 1;
1325 }
1326
1327 static int inputcmd(FILE *input, BSOCK *UA_sock)
1328 {
1329    FILE *fd;
1330
1331    if (argc > 2) {
1332       sendit(_("Too many arguments on input command.\n"));
1333       return 1;
1334    }
1335    if (argc == 1) {
1336       sendit(_("First argument to input command must be a filename.\n"));
1337       return 1;
1338    }
1339    fd = fopen(argk[1], "rb");
1340    if (!fd) {
1341       berrno be;
1342       senditf(_("Cannot open file %s for input. ERR=%s\n"),
1343          argk[1], be.bstrerror());
1344       return 1;
1345    }
1346    read_and_process_input(fd, UA_sock);
1347    fclose(fd);
1348    return 1;
1349 }
1350
1351 /* Send output to both termina and specified file */
1352 static int teecmd(FILE *input, BSOCK *UA_sock)
1353 {
1354    teeout = true;
1355    return do_outputcmd(input, UA_sock);
1356 }
1357
1358 /* Send output to specified "file" */
1359 static int outputcmd(FILE *input, BSOCK *UA_sock)
1360 {
1361    teeout = false;
1362    return do_outputcmd(input, UA_sock);
1363 }
1364
1365
1366 static int do_outputcmd(FILE *input, BSOCK *UA_sock)
1367 {
1368    FILE *fd;
1369    const char *mode = "a+b";
1370
1371    if (argc > 3) {
1372       sendit(_("Too many arguments on output/tee command.\n"));
1373       return 1;
1374    }
1375    if (argc == 1) {
1376       if (output != stdout) {
1377          fclose(output);
1378          output = stdout;
1379          teeout = false;
1380       }
1381       return 1;
1382    }
1383    if (argc == 3) {
1384       mode = argk[2];
1385    }
1386    fd = fopen(argk[1], mode);
1387    if (!fd) {
1388       berrno be;
1389       senditf(_("Cannot open file %s for output. ERR=%s\n"),
1390          argk[1], be.bstrerror(errno));
1391       return 1;
1392    }
1393    output = fd;
1394    return 1;
1395 }
1396
1397 /*
1398  * exec "some-command" [wait-seconds]
1399 */
1400 static int execcmd(FILE *input, BSOCK *UA_sock)
1401 {
1402    BPIPE *bpipe;
1403    char line[5000];
1404    int stat;
1405    int wait = 0;
1406
1407    if (argc > 3) {
1408       sendit(_("Too many arguments. Enclose command in double quotes.\n"));
1409       return 1;
1410    }
1411    if (argc == 3) {
1412       wait = atoi(argk[2]);
1413    }
1414    bpipe = open_bpipe(argk[1], wait, "r");
1415    if (!bpipe) {
1416       berrno be;
1417       senditf(_("Cannot popen(\"%s\", \"r\"): ERR=%s\n"),
1418          argk[1], be.bstrerror(errno));
1419       return 1;
1420    }
1421   
1422    while (fgets(line, sizeof(line), bpipe->rfd)) {
1423       senditf("%s", line);
1424    }
1425    stat = close_bpipe(bpipe);
1426    if (stat != 0) {
1427       berrno be;
1428       be.set_errno(stat);
1429      senditf(_("Autochanger error: ERR=%s\n"), be.bstrerror());
1430    }
1431    return 1;
1432 }
1433
1434
1435 static int echocmd(FILE *input, BSOCK *UA_sock)
1436 {
1437    for (int i=1; i < argc; i++) {
1438       senditf("%s ", argk[i]);
1439    }
1440    sendit("\n");
1441    return 1;
1442 }
1443
1444 static int quitcmd(FILE *input, BSOCK *UA_sock)
1445 {
1446    return 0;
1447 }
1448
1449 static int helpcmd(FILE *input, BSOCK *UA_sock)
1450 {
1451    int i;
1452    for (i=0; i<comsize; i++) { 
1453       senditf("  %-10s %s\n", commands[i].key, commands[i].help);
1454    }
1455    return 1;   
1456 }
1457
1458
1459 static int sleepcmd(FILE *input, BSOCK *UA_sock)
1460 {
1461    if (argc > 1) {
1462       sleep(atoi(argk[1]));
1463    }
1464    return 1;
1465 }
1466
1467
1468 static int timecmd(FILE *input, BSOCK *UA_sock)
1469 {
1470    char sdt[50];
1471    time_t ttime = time(NULL);
1472    struct tm tm;
1473    (void)localtime_r(&ttime, &tm);
1474    strftime(sdt, sizeof(sdt), "%d-%b-%Y %H:%M:%S", &tm);
1475    sendit("\n");
1476    return 1;
1477 }
1478
1479 /*
1480  * Send a line to the output file and or the terminal
1481  */
1482 void senditf(const char *fmt,...)
1483 {
1484    char buf[3000];
1485    va_list arg_ptr;
1486
1487    va_start(arg_ptr, fmt);
1488    bvsnprintf(buf, sizeof(buf), (char *)fmt, arg_ptr);
1489    va_end(arg_ptr);
1490    sendit(buf);
1491 }
1492
1493 void sendit(const char *buf)
1494 {
1495 #ifdef CONIO_FIX
1496    char obuf[3000];
1497    if (output == stdout || teeout) {
1498       const char *p, *q;
1499       /*
1500        * Here, we convert every \n into \r\n because the
1501        *  terminal is in raw mode when we are using
1502        *  conio.
1503        */
1504       for (p=q=buf; (p=strchr(q, '\n')); ) {
1505          int len = p - q;
1506          if (len > 0) {
1507             memcpy(obuf, q, len);
1508          }
1509          memcpy(obuf+len, "\r\n", 3);
1510          q = ++p;                    /* point after \n */
1511          fputs(obuf, output);
1512       }
1513       if (*q) {
1514          fputs(q, output);
1515       }
1516       fflush(output);
1517    }
1518    if (output != stdout) {
1519       fputs(buf, output);
1520    }
1521 #else
1522
1523    fputs(buf, output);
1524    fflush(output);
1525    if (teeout) {
1526       fputs(buf, stdout);
1527       fflush(stdout);
1528    }
1529 #endif
1530 }