]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/console/console.c
Add completion for unmark
[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 int numcon;
93 static POOLMEM *args;
94 static char *argk[MAX_CMD_ARGS];
95 static char *argv[MAX_CMD_ARGS];
96 static CONFIG *config;
97
98
99 /* Command prototypes */
100 static int versioncmd(FILE *input, BSOCK *UA_sock);
101 static int inputcmd(FILE *input, BSOCK *UA_sock);
102 static int outputcmd(FILE *input, BSOCK *UA_sock);
103 static int teecmd(FILE *input, BSOCK *UA_sock);
104 static int quitcmd(FILE *input, BSOCK *UA_sock);
105 static int helpcmd(FILE *input, BSOCK *UA_sock);
106 static int echocmd(FILE *input, BSOCK *UA_sock);
107 static int timecmd(FILE *input, BSOCK *UA_sock);
108 static int sleepcmd(FILE *input, BSOCK *UA_sock);
109 static int execcmd(FILE *input, BSOCK *UA_sock);
110 #ifdef HAVE_READLINE
111 static int eolcmd(FILE *input, BSOCK *UA_sock);
112
113 # ifndef HAVE_REGEX_H
114 #  include "lib/bregex.h"
115 # else
116 #  include <regex.h>
117 # endif
118
119 #endif
120
121
122 #define CONFIG_FILE "bconsole.conf"   /* default configuration file */
123
124 static void usage()
125 {
126    fprintf(stderr, _(
127 PROG_COPYRIGHT
128 "\nVersion: " VERSION " (" BDATE ") %s %s %s\n\n"
129 "Usage: bconsole [-s] [-c config_file] [-d debug_level]\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             bnet_fsend(UA_sock, ".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 (!bnet_send(UA_sock)) {   /* 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 = bnet_recv(UA_sock)) >= 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 #endif
877
878    return ret;
879 }
880
881 /*********************************************************************
882  *
883  *         Main Bacula Console -- User Interface Program
884  *
885  */
886 int main(int argc, char *argv[])
887 {
888    int ch, i, item;
889    bool no_signals = false;
890    bool test_config = false;
891    JCR jcr;
892    utime_t heart_beat;
893
894    setlocale(LC_ALL, "");
895    bindtextdomain("bacula", LOCALEDIR);
896    textdomain("bacula");
897
898    init_stack_dump();
899    lmgr_init_thread();
900    my_name_is(argc, argv, "bconsole");
901    init_msg(NULL, NULL);
902    working_directory = "/tmp";
903    args = get_pool_memory(PM_FNAME);
904
905    while ((ch = getopt(argc, argv, "bc:d:nstu:?")) != -1) {
906       switch (ch) {
907       case 'c':                    /* configuration file */
908          if (configfile != NULL) {
909             free(configfile);
910          }
911          configfile = bstrdup(optarg);
912          break;
913
914       case 'd':
915          if (*optarg == 't') {
916             dbg_timestamp = true;
917          } else {
918             debug_level = atoi(optarg);
919             if (debug_level <= 0) {
920                debug_level = 1;
921             }
922          }
923          break;
924
925       case 'n':                    /* no conio */
926          no_conio = true;
927          break;
928
929       case 's':                    /* turn off signals */
930          no_signals = true;
931          break;
932
933       case 't':
934          test_config = true;
935          break;
936
937       case 'u':
938          timeout = atoi(optarg);
939          break;
940
941       case '?':
942       default:
943          usage();
944          exit(1);
945       }
946    }
947    argc -= optind;
948    argv += optind;
949
950    if (!no_signals) {
951       init_signals(terminate_console);
952    }
953
954
955 #if !defined(HAVE_WIN32)
956    /* Override Bacula default signals */
957    signal(SIGQUIT, SIG_IGN);
958    signal(SIGTSTP, got_sigstop);
959    signal(SIGCONT, got_sigcontinue);
960    signal(SIGTTIN, got_sigtin);
961    signal(SIGTTOU, got_sigtout);
962    trapctlc();
963 #endif
964
965    OSDependentInit();
966
967    if (argc) {
968       usage();
969       exit(1);
970    }
971
972    if (configfile == NULL) {
973       configfile = bstrdup(CONFIG_FILE);
974    }
975
976    config = new_config_parser();
977    parse_cons_config(config, configfile, M_ERROR_TERM);
978
979    if (init_crypto() != 0) {
980       Emsg0(M_ERROR_TERM, 0, _("Cryptography library initialization failed.\n"));
981    }
982
983    if (!check_resources()) {
984       Emsg1(M_ERROR_TERM, 0, _("Please correct configuration file: %s\n"), configfile);
985    }
986
987    if (!no_conio) {
988       con_init(stdin);
989    }
990
991    if (test_config) {
992       terminate_console(0);
993       exit(0);
994    }
995
996    memset(&jcr, 0, sizeof(jcr));
997
998    (void)WSA_Init();                        /* Initialize Windows sockets */
999
1000    start_watchdog();                        /* Start socket watchdog */
1001
1002    LockRes();
1003    numdir = 0;
1004    foreach_res(dir, R_DIRECTOR) {
1005       numdir++;
1006    }
1007    numcon = 0;
1008    foreach_res(cons, R_CONSOLE) {
1009       numcon++;
1010    }
1011    UnlockRes();
1012
1013    if (numdir > 1) {
1014       struct sockaddr client_addr;
1015       memset(&client_addr, 0, sizeof(client_addr));
1016       UA_sock = init_bsock(NULL, 0, "", "", 0, &client_addr);
1017 try_again:
1018       sendit(_("Available Directors:\n"));
1019       LockRes();
1020       numdir = 0;
1021       foreach_res(dir, R_DIRECTOR) {
1022          senditf( _("%2d:  %s at %s:%d\n"), 1+numdir++, dir->hdr.name, dir->address,
1023             dir->DIRport);
1024       }
1025       UnlockRes();
1026       if (get_cmd(stdin, _("Select Director by entering a number: "), UA_sock, 600) < 0) {
1027          (void)WSACleanup();               /* Cleanup Windows sockets */
1028          return 1;
1029       }
1030       if (!is_a_number(UA_sock->msg)) {
1031          senditf(_("%s is not a number. You must enter a number between 1 and %d\n"), 
1032                  UA_sock->msg, numdir);
1033          goto try_again;
1034       }
1035       item = atoi(UA_sock->msg);
1036       if (item < 0 || item > numdir) {
1037          senditf(_("You must enter a number between 1 and %d\n"), numdir);
1038          goto try_again;
1039       }
1040       term_bsock(UA_sock);
1041       LockRes();
1042       for (i=0; i<item; i++) {
1043          dir = (DIRRES *)GetNextRes(R_DIRECTOR, (RES *)dir);
1044       }
1045       /* Look for a console linked to this director */
1046       for (i=0; i<numcon; i++) {
1047          cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)cons);
1048          if (cons->director && strcmp(cons->director, dir->hdr.name) == 0) {
1049             break;
1050          }
1051          cons = NULL;
1052       }
1053       /* Look for the first non-linked console */
1054       if (cons == NULL) {
1055          for (i=0; i<numcon; i++) {
1056             cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)cons);
1057             if (cons->director == NULL)
1058                break;
1059             cons = NULL;
1060         }
1061       }
1062       UnlockRes();
1063    }
1064    /* If no director, take first one */
1065    if (!dir) {
1066       LockRes();
1067       dir = (DIRRES *)GetNextRes(R_DIRECTOR, NULL);
1068       UnlockRes();
1069    }
1070    /* If no console, take first one */
1071    if (!cons) {
1072       LockRes();
1073       cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)NULL);
1074       UnlockRes();
1075    }
1076
1077    senditf(_("Connecting to Director %s:%d\n"), dir->address,dir->DIRport);
1078
1079    char buf[1024];
1080    /* Initialize Console TLS context */
1081    if (cons && (cons->tls_enable || cons->tls_require)) {
1082       /* Generate passphrase prompt */
1083       bsnprintf(buf, sizeof(buf), "Passphrase for Console \"%s\" TLS private key: ", cons->hdr.name);
1084
1085       /* Initialize TLS context:
1086        * Args: CA certfile, CA certdir, Certfile, Keyfile,
1087        * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer   
1088        */
1089       cons->tls_ctx = new_tls_context(cons->tls_ca_certfile,
1090          cons->tls_ca_certdir, cons->tls_certfile,
1091          cons->tls_keyfile, tls_pem_callback, &buf, NULL, true);
1092
1093       if (!cons->tls_ctx) {
1094          senditf(_("Failed to initialize TLS context for Console \"%s\".\n"),
1095             dir->hdr.name);
1096          terminate_console(0);
1097          return 1;
1098       }
1099    }
1100
1101    /* Initialize Director TLS context */
1102    if (dir->tls_enable || dir->tls_require) {
1103       /* Generate passphrase prompt */
1104       bsnprintf(buf, sizeof(buf), "Passphrase for Director \"%s\" TLS private key: ", dir->hdr.name);
1105
1106       /* Initialize TLS context:
1107        * Args: CA certfile, CA certdir, Certfile, Keyfile,
1108        * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer */
1109       dir->tls_ctx = new_tls_context(dir->tls_ca_certfile,
1110          dir->tls_ca_certdir, dir->tls_certfile,
1111          dir->tls_keyfile, tls_pem_callback, &buf, NULL, true);
1112
1113       if (!dir->tls_ctx) {
1114          senditf(_("Failed to initialize TLS context for Director \"%s\".\n"),
1115             dir->hdr.name);
1116          terminate_console(0);
1117          return 1;
1118       }
1119    }
1120
1121    if (dir->heartbeat_interval) {
1122       heart_beat = dir->heartbeat_interval;
1123    } else if (cons) {
1124       heart_beat = cons->heartbeat_interval;
1125    } else {
1126       heart_beat = 0;
1127    }
1128    UA_sock = bnet_connect(NULL, 5, 15, heart_beat, "Director daemon", dir->address,
1129                           NULL, dir->DIRport, 0);
1130    if (UA_sock == NULL) {
1131       terminate_console(0);
1132       return 1;
1133    }
1134    jcr.dir_bsock = UA_sock;
1135
1136    /* If cons==NULL, default console will be used */
1137    if (!authenticate_director(&jcr, dir, cons)) {
1138       terminate_console(0);
1139       return 1;
1140    }
1141
1142    Dmsg0(40, "Opened connection with Director daemon\n");
1143
1144    sendit(_("Enter a period to cancel a command.\n"));
1145
1146    /* Read/Update history file if HOME exists */
1147    POOL_MEM history_file;
1148
1149    /* Run commands in ~/.bconsolerc if any */
1150    char *env = getenv("HOME");
1151    if (env) {
1152       FILE *fd;
1153       pm_strcpy(&UA_sock->msg, env);
1154       pm_strcat(&UA_sock->msg, "/.bconsolerc");
1155       fd = fopen(UA_sock->msg, "rb");
1156       if (fd) {
1157          read_and_process_input(fd, UA_sock);
1158          fclose(fd);
1159       }
1160
1161       pm_strcpy(history_file, env);
1162       pm_strcat(history_file, "/.bconsole_history");
1163       console_init_history(history_file.c_str());
1164    }
1165
1166    read_and_process_input(stdin, UA_sock);
1167
1168    if (UA_sock) {
1169       UA_sock->signal(BNET_TERMINATE); /* send EOF */
1170       UA_sock->close();
1171    }
1172
1173    if (env) {
1174       console_update_history(history_file.c_str());
1175    }
1176
1177    terminate_console(0);
1178    return 0;
1179 }
1180
1181 /* Cleanup and then exit */
1182 static void terminate_console(int sig)
1183 {
1184
1185    static bool already_here = false;
1186
1187    if (already_here) {                /* avoid recursive temination problems */
1188       exit(1);
1189    }
1190    already_here = true;
1191    stop_watchdog();
1192    config->free_resources();
1193    free(config);
1194    config = NULL;
1195    cleanup_crypto();
1196    free_pool_memory(args);
1197    if (!no_conio) {
1198       con_term();
1199    }
1200    (void)WSACleanup();               /* Cleanup Windows sockets */
1201    lmgr_cleanup_main();
1202
1203    if (sig != 0) {
1204       exit(1);
1205    }
1206    return;
1207 }
1208
1209 /*
1210  * Make a quick check to see that we have all the
1211  * resources needed.
1212  */
1213 static int check_resources()
1214 {
1215    bool OK = true;
1216    DIRRES *director;
1217    bool tls_needed;
1218
1219    LockRes();
1220
1221    numdir = 0;
1222    foreach_res(director, R_DIRECTOR) {
1223
1224       numdir++;
1225       /* tls_require implies tls_enable */
1226       if (director->tls_require) {
1227          if (have_tls) {
1228             director->tls_enable = true;
1229          } else {
1230             Jmsg(NULL, M_FATAL, 0, _("TLS required but not configured in Bacula.\n"));
1231             OK = false;
1232             continue;
1233          }
1234       }
1235       tls_needed = director->tls_enable || director->tls_authenticate;
1236
1237       if ((!director->tls_ca_certfile && !director->tls_ca_certdir) && tls_needed) {
1238          Emsg2(M_FATAL, 0, _("Neither \"TLS CA Certificate\""
1239                              " or \"TLS CA Certificate Dir\" are defined for Director \"%s\" in %s."
1240                              " At least one CA certificate store is required.\n"),
1241                              director->hdr.name, configfile);
1242          OK = false;
1243       }
1244    }
1245    
1246    if (numdir == 0) {
1247       Emsg1(M_FATAL, 0, _("No Director resource defined in %s\n"
1248                           "Without that I don't how to speak to the Director :-(\n"), configfile);
1249       OK = false;
1250    }
1251
1252    CONRES *cons;
1253    /* Loop over Consoles */
1254    foreach_res(cons, R_CONSOLE) {
1255       /* tls_require implies tls_enable */
1256       if (cons->tls_require) {
1257          if (have_tls) {
1258             cons->tls_enable = true;
1259          } else {
1260             Jmsg(NULL, M_FATAL, 0, _("TLS required but not configured in Bacula.\n"));
1261             OK = false;
1262             continue;
1263          }
1264       }
1265       tls_needed = cons->tls_enable || cons->tls_authenticate;
1266       if ((!cons->tls_ca_certfile && !cons->tls_ca_certdir) && tls_needed) {
1267          Emsg2(M_FATAL, 0, _("Neither \"TLS CA Certificate\""
1268                              " or \"TLS CA Certificate Dir\" are defined for Console \"%s\" in %s.\n"),
1269                              cons->hdr.name, configfile);
1270          OK = false;
1271       }
1272    }
1273
1274    UnlockRes();
1275
1276    return OK;
1277 }
1278
1279 static int versioncmd(FILE *input, BSOCK *UA_sock)
1280 {
1281    senditf("Version: " VERSION " (" BDATE ") %s %s %s\n",
1282       HOST_OS, DISTNAME, DISTVER);
1283    return 1;
1284 }
1285
1286 static int inputcmd(FILE *input, BSOCK *UA_sock)
1287 {
1288    FILE *fd;
1289
1290    if (argc > 2) {
1291       sendit(_("Too many arguments on input command.\n"));
1292       return 1;
1293    }
1294    if (argc == 1) {
1295       sendit(_("First argument to input command must be a filename.\n"));
1296       return 1;
1297    }
1298    fd = fopen(argk[1], "rb");
1299    if (!fd) {
1300       berrno be;
1301       senditf(_("Cannot open file %s for input. ERR=%s\n"),
1302          argk[1], be.bstrerror());
1303       return 1;
1304    }
1305    read_and_process_input(fd, UA_sock);
1306    fclose(fd);
1307    return 1;
1308 }
1309
1310 /* Send output to both termina and specified file */
1311 static int teecmd(FILE *input, BSOCK *UA_sock)
1312 {
1313    teeout = true;
1314    return do_outputcmd(input, UA_sock);
1315 }
1316
1317 /* Send output to specified "file" */
1318 static int outputcmd(FILE *input, BSOCK *UA_sock)
1319 {
1320    teeout = false;
1321    return do_outputcmd(input, UA_sock);
1322 }
1323
1324
1325 static int do_outputcmd(FILE *input, BSOCK *UA_sock)
1326 {
1327    FILE *fd;
1328    const char *mode = "a+b";
1329
1330    if (argc > 3) {
1331       sendit(_("Too many arguments on output/tee command.\n"));
1332       return 1;
1333    }
1334    if (argc == 1) {
1335       if (output != stdout) {
1336          fclose(output);
1337          output = stdout;
1338          teeout = false;
1339       }
1340       return 1;
1341    }
1342    if (argc == 3) {
1343       mode = argk[2];
1344    }
1345    fd = fopen(argk[1], mode);
1346    if (!fd) {
1347       berrno be;
1348       senditf(_("Cannot open file %s for output. ERR=%s\n"),
1349          argk[1], be.bstrerror(errno));
1350       return 1;
1351    }
1352    output = fd;
1353    return 1;
1354 }
1355
1356 /*
1357  * exec "some-command" [wait-seconds]
1358 */
1359 static int execcmd(FILE *input, BSOCK *UA_sock)
1360 {
1361    BPIPE *bpipe;
1362    char line[5000];
1363    int stat;
1364    int wait = 0;
1365
1366    if (argc > 3) {
1367       sendit(_("Too many arguments. Enclose command in double quotes.\n"));
1368       return 1;
1369    }
1370    if (argc == 3) {
1371       wait = atoi(argk[2]);
1372    }
1373    bpipe = open_bpipe(argk[1], wait, "r");
1374    if (!bpipe) {
1375       berrno be;
1376       senditf(_("Cannot popen(\"%s\", \"r\"): ERR=%s\n"),
1377          argk[1], be.bstrerror(errno));
1378       return 1;
1379    }
1380   
1381    while (fgets(line, sizeof(line), bpipe->rfd)) {
1382       senditf("%s", line);
1383    }
1384    stat = close_bpipe(bpipe);
1385    if (stat != 0) {
1386       berrno be;
1387       be.set_errno(stat);
1388      senditf(_("Autochanger error: ERR=%s\n"), be.bstrerror());
1389    }
1390    return 1;
1391 }
1392
1393
1394 static int echocmd(FILE *input, BSOCK *UA_sock)
1395 {
1396    for (int i=1; i < argc; i++) {
1397       senditf("%s ", argk[i]);
1398    }
1399    sendit("\n");
1400    return 1;
1401 }
1402
1403 static int quitcmd(FILE *input, BSOCK *UA_sock)
1404 {
1405    return 0;
1406 }
1407
1408 static int helpcmd(FILE *input, BSOCK *UA_sock)
1409 {
1410    int i;
1411    for (i=0; i<comsize; i++) { 
1412       senditf("  %-10s %s\n", commands[i].key, commands[i].help);
1413    }
1414    return 1;   
1415 }
1416
1417
1418 static int sleepcmd(FILE *input, BSOCK *UA_sock)
1419 {
1420    if (argc > 1) {
1421       sleep(atoi(argk[1]));
1422    }
1423    return 1;
1424 }
1425
1426
1427 static int timecmd(FILE *input, BSOCK *UA_sock)
1428 {
1429    char sdt[50];
1430    time_t ttime = time(NULL);
1431    struct tm tm;
1432    (void)localtime_r(&ttime, &tm);
1433    strftime(sdt, sizeof(sdt), "%d-%b-%Y %H:%M:%S", &tm);
1434    sendit("\n");
1435    return 1;
1436 }
1437
1438 /*
1439  * Send a line to the output file and or the terminal
1440  */
1441 void senditf(const char *fmt,...)
1442 {
1443    char buf[3000];
1444    va_list arg_ptr;
1445
1446    va_start(arg_ptr, fmt);
1447    bvsnprintf(buf, sizeof(buf), (char *)fmt, arg_ptr);
1448    va_end(arg_ptr);
1449    sendit(buf);
1450 }
1451
1452 void sendit(const char *buf)
1453 {
1454 #ifdef CONIO_FIX
1455    char obuf[3000];
1456    if (output == stdout || teeout) {
1457       const char *p, *q;
1458       /*
1459        * Here, we convert every \n into \r\n because the
1460        *  terminal is in raw mode when we are using
1461        *  conio.
1462        */
1463       for (p=q=buf; (p=strchr(q, '\n')); ) {
1464          int len = p - q;
1465          if (len > 0) {
1466             memcpy(obuf, q, len);
1467          }
1468          memcpy(obuf+len, "\r\n", 3);
1469          q = ++p;                    /* point after \n */
1470          fputs(obuf, output);
1471       }
1472       if (*q) {
1473          fputs(q, output);
1474       }
1475       fflush(output);
1476    }
1477    if (output != stdout) {
1478       fputs(buf, output);
1479    }
1480 #else
1481
1482    fputs(buf, output);
1483    fflush(output);
1484    if (teeout) {
1485       fputs(buf, stdout);
1486       fflush(stdout);
1487    }
1488 #endif
1489 }