Logo Search packages:      
Sourcecode: bacula version File versions

console.c

/*
 *
 *   Bacula Console interface to the Director
 *
 *     Kern Sibbald, September MM
 *
 *     Version $Id: console.c,v 1.53.6.1 2005/02/25 09:47:06 kerns Exp $
 */

/*
   Copyright (C) 2000-2004 Kern Sibbald and John Walker

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
   MA 02111-1307, USA.

 */

#include "bacula.h"
#include "console_conf.h"
#include "jcr.h"

#ifdef HAVE_CONIO
#include "conio.h"
#else
#define con_init(x)
#define con_term()
#define con_set_zed_keys();
#define trapctlc()
#define clrbrk()
#define usrbrk() 0
#endif

#ifdef HAVE_WIN32
#include <windows.h>
#define isatty(fd) (fd==0)
DWORD  g_platform_id = VER_PLATFORM_WIN32_WINDOWS;
#endif

/* Exported variables */

#ifdef HAVE_CYGWIN
int rl_catch_signals;
#else
extern int rl_catch_signals;
#endif

/* Imported functions */
int authenticate_director(JCR *jcr, DIRRES *director, CONRES *cons);



/* Forward referenced functions */
static void terminate_console(int sig);
int get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec);
static int do_outputcmd(FILE *input, BSOCK *UA_sock);
void senditf(const char *fmt, ...);
void sendit(const char *buf);

extern "C" void got_sigstop(int sig);
extern "C" void got_sigcontinue(int sig);
extern "C" void got_sigtout(int sig);
extern "C" void got_sigtin(int sig);


/* Static variables */
static char *configfile = NULL;
static BSOCK *UA_sock = NULL;
static DIRRES *dir;
static FILE *output = stdout;
static bool tee = false;              /* output to output and stdout */
static bool stop = false;
static int argc;
static POOLMEM *args;
static char *argk[MAX_CMD_ARGS];
static char *argv[MAX_CMD_ARGS];


/* Command prototypes */
static int versioncmd(FILE *input, BSOCK *UA_sock);
static int inputcmd(FILE *input, BSOCK *UA_sock);
static int outputcmd(FILE *input, BSOCK *UA_sock);
static int teecmd(FILE *input, BSOCK *UA_sock);
static int quitcmd(FILE *input, BSOCK *UA_sock);
static int timecmd(FILE *input, BSOCK *UA_sock);
static int sleepcmd(FILE *input, BSOCK *UA_sock);


#define CONFIG_FILE "./bconsole.conf"   /* default configuration file */

static void usage()
{
   fprintf(stderr, _(
"Copyright (C) 2000-2004 Kern Sibbald and John Walker\n"
"\nVersion: " VERSION " (" BDATE ") %s %s %s\n\n"
"Usage: bconsole [-s] [-c config_file] [-d debug_level]\n"
"       -c <file>   set configuration file to file\n"
"       -dnn        set debug level to nn\n"
"       -s          no signals\n"
"       -t          test - read configuration and exit\n"
"       -?          print this message.\n"
"\n"), HOST_OS, DISTNAME, DISTVER);
}


extern "C"
void got_sigstop(int sig)
{
   stop = true;
}

extern "C"
void got_sigcontinue(int sig)
{
   stop = false;
}

extern "C"
void got_sigtout(int sig)
{
// printf("Got tout\n");
}

extern "C"
void got_sigtin(int sig)
{
// printf("Got tin\n");
}


static int zed_keyscmd(FILE *input, BSOCK *UA_sock)
{
   con_set_zed_keys();
   return 1;
}

/*
 * These are the @command
 */
struct cmdstruct { const char *key; int (*func)(FILE *input, BSOCK *UA_sock); const char *help; };
static struct cmdstruct commands[] = {
 { N_("input"),      inputcmd,     _("input from file")},
 { N_("output"),     outputcmd,    _("output to file")},
 { N_("quit"),       quitcmd,      _("quit")},
 { N_("tee"),        teecmd,       _("output to file and terminal")},
 { N_("sleep"),      sleepcmd,     _("sleep specified time")},
 { N_("time"),       timecmd,      _("print current time")},
 { N_("version"),    versioncmd,   _("print Console's version")},
 { N_("exit"),       quitcmd,      _("exit = quit")},
 { N_("zed_keyst"),  zed_keyscmd,  _("zed_keys = use zed keys instead of bash keys")},
           };
#define comsize (sizeof(commands)/sizeof(struct cmdstruct))

static int do_a_command(FILE *input, BSOCK *UA_sock)
{
   unsigned int i;
   int stat;
   int found;
   int len;
   char *cmd;

   found = 0;
   stat = 1;

   Dmsg1(120, "Command: %s\n", UA_sock->msg);
   if (argc == 0) {
      return 1;
   }

   cmd = argk[0]+1;
   if (*cmd == '#') {                 /* comment */
      return 1;
   }
   len = strlen(cmd);
   for (i=0; i<comsize; i++) {         /* search for command */
      if (strncasecmp(cmd,  _(commands[i].key), len) == 0) {
       stat = (*commands[i].func)(input, UA_sock);   /* go execute command */
       found = 1;
       break;
      }
   }
   if (!found) {
      pm_strcat(&UA_sock->msg, _(": is an illegal command\n"));
      UA_sock->msglen = strlen(UA_sock->msg);
      sendit(UA_sock->msg);
   }
   return stat;
}


static void read_and_process_input(FILE *input, BSOCK *UA_sock)
{
   const char *prompt = "*";
   bool at_prompt = false;
   int tty_input = isatty(fileno(input));
   int stat;

   for ( ;; ) {
      if (at_prompt) {                /* don't prompt multiple times */
       prompt = "";
      } else {
       prompt = "*";
       at_prompt = true;
      }
      if (tty_input) {
       stat = get_cmd(input, prompt, UA_sock, 30);
       if (usrbrk() == 1) {
          clrbrk();
       }
       if (usrbrk()) {
          break;
       }
      } else {
       /* Reading input from a file */
       int len = sizeof_pool_memory(UA_sock->msg) - 1;
       if (usrbrk()) {
          break;
       }
       if (fgets(UA_sock->msg, len, input) == NULL) {
          stat = -1;
       } else {
          sendit(UA_sock->msg);  /* echo to terminal */
          strip_trailing_junk(UA_sock->msg);
          UA_sock->msglen = strlen(UA_sock->msg);
          stat = 1;
       }
      }
      if (stat < 0) {
       break;                 /* error or interrupt */
      } else if (stat == 0) {       /* timeout */
       if (strcmp(prompt, "*") == 0) {
          bnet_fsend(UA_sock, ".messages");
       } else {
          continue;
       }
      } else {
       at_prompt = FALSE;
       /* @ => internal command for us */
       if (UA_sock->msg[0] == '@') {
          parse_args(UA_sock->msg, &args, &argc, argk, argv, MAX_CMD_ARGS);
          if (!do_a_command(input, UA_sock)) {
             break;
          }
          continue;
       }
       if (!bnet_send(UA_sock)) {   /* send command */
          break;              /* error */
       }
      }
      if (strcmp(UA_sock->msg, ".quit") == 0 || strcmp(UA_sock->msg, ".exit") == 0) {
       break;
      }
      while ((stat = bnet_recv(UA_sock)) >= 0) {
       if (at_prompt) {
          if (!stop) {
             sendit("\n");
          }
          at_prompt = false;
       }
       /* Suppress output if running in background or user hit ctl-c */
       if (!stop && !usrbrk()) {
          sendit(UA_sock->msg);
       }
      }
      if (usrbrk() > 1) {
       break;
      } else {
       clrbrk();
      }
      if (!stop) {
       fflush(stdout);
      }
      if (is_bnet_stop(UA_sock)) {
       break;                 /* error or term */
      } else if (stat == BNET_SIGNAL) {
       if (UA_sock->msglen == BNET_PROMPT) {
          at_prompt = true;
       }
       Dmsg1(100, "Got poll %s\n", bnet_sig_to_ascii(UA_sock));
      }
   }
}


/*********************************************************************
 *
 *       Main Bacula Console -- User Interface Program
 *
 */
int main(int argc, char *argv[])
{
   int ch, i, ndir, item;
   bool no_signals = false;
   bool test_config = false;
   JCR jcr;

   init_stack_dump();
   my_name_is(argc, argv, "bconsole");
   textdomain("bacula");
   init_msg(NULL, NULL);
   working_directory = "/tmp";
   args = get_pool_memory(PM_FNAME);
   con_init(stdin);

   while ((ch = getopt(argc, argv, "bc:d:r:st?")) != -1) {
      switch (ch) {
      case 'c':                    /* configuration file */
       if (configfile != NULL) {
          free(configfile);
       }
       configfile = bstrdup(optarg);
       break;

      case 'd':
       debug_level = atoi(optarg);
       if (debug_level <= 0) {
          debug_level = 1;
       }
       break;

      case 's':                    /* turn off signals */
       no_signals = true;
       break;

      case 't':
       test_config = true;
       break;

      case '?':
      default:
       usage();
       con_term();
       exit(1);
      }
   }
   argc -= optind;
   argv += optind;

   if (!no_signals) {
      init_signals(terminate_console);
   }

#if !defined(HAVE_WIN32)
   /* Override Bacula default signals */
   signal(SIGCHLD, SIG_IGN);
   signal(SIGQUIT, SIG_IGN);
   signal(SIGTSTP, got_sigstop);
   signal(SIGCONT, got_sigcontinue);
   signal(SIGTTIN, got_sigtin);
   signal(SIGTTOU, got_sigtout);
   trapctlc();
#endif

   if (argc) {
      usage();
      con_term();
      exit(1);
   }

   if (configfile == NULL) {
      configfile = bstrdup(CONFIG_FILE);
   }

   parse_config(configfile);

   LockRes();
   ndir = 0;
   foreach_res(dir, R_DIRECTOR) {
      ndir++;
   }
   UnlockRes();
   if (ndir == 0) {
      con_term();
      Emsg1(M_ERROR_TERM, 0, _("No Director resource defined in %s\n"
"Without that I don't how to speak to the Director :-(\n"), configfile);
   }

   if (test_config) {
      terminate_console(0);
      exit(0);
   }

   memset(&jcr, 0, sizeof(jcr));

   (void)WSA_Init();                    /* Initialize Windows sockets */

   if (ndir > 1) {
      struct sockaddr client_addr;
      memset(&client_addr, 0, sizeof(client_addr));
      UA_sock = init_bsock(NULL, 0, "", "", 0, &client_addr);
try_again:
      sendit(_("Available Directors:\n"));
      LockRes();
      ndir = 0;
      foreach_res(dir, R_DIRECTOR) {
       senditf( _("%d  %s at %s:%d\n"), 1+ndir++, dir->hdr.name, dir->address,
          dir->DIRport);
      }
      UnlockRes();
      if (get_cmd(stdin, _("Select Director: "), UA_sock, 600) < 0) {
       (void)WSACleanup();             /* Cleanup Windows sockets */
       return 1;
      }
      item = atoi(UA_sock->msg);
      if (item < 0 || item > ndir) {
       senditf(_("You must enter a number between 1 and %d\n"), ndir);
       goto try_again;
      }
      LockRes();
      dir = NULL;
      for (i=0; i<item; i++) {
       dir = (DIRRES *)GetNextRes(R_DIRECTOR, (RES *)dir);
      }
      UnlockRes();
      term_bsock(UA_sock);
   } else {
      LockRes();
      dir = (DIRRES *)GetNextRes(R_DIRECTOR, NULL);
      UnlockRes();
   }

   senditf(_("Connecting to Director %s:%d\n"), dir->address,dir->DIRport);
   UA_sock = bnet_connect(NULL, 5, 15, "Director daemon", dir->address,
                    NULL, dir->DIRport, 0);
   if (UA_sock == NULL) {
      terminate_console(0);
      return 1;
   }
   jcr.dir_bsock = UA_sock;

   LockRes();
   CONRES *cons = (CONRES *)GetNextRes(R_CONSOLE, (RES *)NULL);
   UnlockRes();
   /* If cons==NULL, default console will be used */
   if (!authenticate_director(&jcr, dir, cons)) {
      fprintf(stderr, "ERR=%s", UA_sock->msg);
      terminate_console(0);
      return 1;
   }

   Dmsg0(40, "Opened connection with Director daemon\n");

   sendit(_("Enter a period to cancel a command.\n"));

   /* Run commands in ~/.bconsolerc if any */
   char *env = getenv("HOME");
   if (env) {
      FILE *fd;
      pm_strcpy(&UA_sock->msg, env);
      pm_strcat(&UA_sock->msg, "/.bconsolerc");
      fd = fopen(UA_sock->msg, "r");
      if (fd) {
       read_and_process_input(fd, UA_sock);
       fclose(fd);
      }
   }

   read_and_process_input(stdin, UA_sock);

   if (UA_sock) {
      bnet_sig(UA_sock, BNET_TERMINATE); /* send EOF */
      bnet_close(UA_sock);
   }

   terminate_console(0);
   return 0;
}


/* Cleanup and then exit */
static void terminate_console(int sig)
{

   static bool already_here = false;

   if (already_here) {              /* avoid recursive temination problems */
      exit(1);
   }
   already_here = true;
   free_pool_memory(args);
   con_term();
   (void)WSACleanup();             /* Cleanup Windows sockets */
   if (sig != 0) {
      exit(1);
   }
   return;
}

#ifdef HAVE_READLINE
#define READLINE_LIBRARY 1
#undef free
#include "readline.h"
#include "history.h"


int
get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec)
{
   char *line;

   rl_catch_signals = 0;            /* do it ourselves */
   line = readline((char *)prompt);   /* cast needed for old readlines */

   if (!line) {
      exit(1);
   }
   strip_trailing_junk(line);
   sock->msglen = pm_strcpy(&sock->msg, line);
   if (sock->msglen) {
      add_history(sock->msg);
   }
   free(line);
   return 1;
}

#else /* no readline, do it ourselves */

/*
 *   Returns: 1 if data available
 *          0 if timeout
 *         -1 if error
 */
static int
wait_for_data(int fd, int sec)
{
   fd_set fdset;
   struct timeval tv;
#ifdef HAVE_WIN32
   return 1;                          /* select doesn't seem to work on Win32 */
#endif

   tv.tv_sec = sec;
   tv.tv_usec = 0;
   for ( ;; ) {
      FD_ZERO(&fdset);
      FD_SET((unsigned)fd, &fdset);
      switch(select(fd + 1, &fdset, NULL, NULL, &tv)) {
      case 0:                       /* timeout */
       return 0;
      case -1:
       if (errno == EINTR || errno == EAGAIN) {
          continue;
       }
       return -1;            /* error return */
      default:
       return 1;
      }
   }
}

/*
 * Get next input command from terminal.
 *
 *   Returns: 1 if got input
 *          0 if timeout
 *         -1 if EOF or error
 */
int
get_cmd(FILE *input, const char *prompt, BSOCK *sock, int sec)
{
   int len;
   if (!stop) {
      if (output == stdout || tee) {
       sendit(prompt);
      }
   }
again:
   switch (wait_for_data(fileno(input), sec)) {
   case 0:
      return 0;            /* timeout */
   case -1:
      return -1;           /* error */
   default:
      len = sizeof_pool_memory(sock->msg) - 1;
      if (stop) {
       sleep(1);
       goto again;
      }
#ifdef HAVE_CONIO
      if (isatty(fileno(input))) {
       input_line(sock->msg, len);
       break;
      }
#endif
      if (fgets(sock->msg, len, input) == NULL) {
       return -1;
      }
      break;
   }
   if (usrbrk()) {
      clrbrk();
   }
   strip_trailing_junk(sock->msg);
   sock->msglen = strlen(sock->msg);
   return 1;
}

#endif

static int versioncmd(FILE *input, BSOCK *UA_sock)
{
   senditf("Version: " VERSION " (" BDATE ") %s %s %s\n",
      HOST_OS, DISTNAME, DISTVER);
   return 1;
}

static int inputcmd(FILE *input, BSOCK *UA_sock)
{
   FILE *fd;

   if (argc > 2) {
      sendit(_("Too many arguments on input command.\n"));
      return 1;
   }
   if (argc == 1) {
      sendit(_("First argument to input command must be a filename.\n"));
      return 1;
   }
   fd = fopen(argk[1], "r");
   if (!fd) {
      senditf(_("Cannot open file %s for input. ERR=%s\n"),
       argk[1], strerror(errno));
      return 1;
   }
   read_and_process_input(fd, UA_sock);
   fclose(fd);
   return 1;
}

/* Send output to both termina and specified file */
static int teecmd(FILE *input, BSOCK *UA_sock)
{
   tee = true;
   return do_outputcmd(input, UA_sock);
}

/* Send output to specified "file" */
static int outputcmd(FILE *input, BSOCK *UA_sock)
{
   tee = false;
   return do_outputcmd(input, UA_sock);
}


static int do_outputcmd(FILE *input, BSOCK *UA_sock)
{
   FILE *fd;
   const char *mode = "a+";

   if (argc > 3) {
      sendit(_("Too many arguments on output/tee command.\n"));
      return 1;
   }
   if (argc == 1) {
      if (output != stdout) {
       fclose(output);
       output = stdout;
       tee = false;
      }
      return 1;
   }
   if (argc == 3) {
      mode = argk[2];
   }
   fd = fopen(argk[1], mode);
   if (!fd) {
      senditf(_("Cannot open file %s for output. ERR=%s\n"),
       argk[1], strerror(errno));
      return 1;
   }
   output = fd;
   return 1;
}

static int quitcmd(FILE *input, BSOCK *UA_sock)
{
   return 0;
}

static int sleepcmd(FILE *input, BSOCK *UA_sock)
{
   if (argc > 1) {
      sleep(atoi(argk[1]));
   }
   return 1;
}


static int timecmd(FILE *input, BSOCK *UA_sock)
{
   char sdt[50];
   time_t ttime = time(NULL);
   struct tm tm;
   localtime_r(&ttime, &tm);
   strftime(sdt, sizeof(sdt), "%d-%b-%Y %H:%M:%S", &tm);
   sendit("\n");
   return 1;
}

/*
 * Send a line to the output file and or the terminal
 */
void senditf(const char *fmt,...)
{
    char buf[3000];
    va_list arg_ptr;

    va_start(arg_ptr, fmt);
    bvsnprintf(buf, sizeof(buf), (char *)fmt, arg_ptr);
    va_end(arg_ptr);
    sendit(buf);
}

void sendit(const char *buf)
{
#ifdef xHAVE_CONIO
    if (output == stdout || tee) {
       char *p, *q;
       /*
      * Here, we convert every \n into \r\n because the
      *  terminal is in raw mode when we are using
      *  conio.
      */
       for (p=q=buf; (p=strchr(q, '\n')); ) {
        if (p-q > 0) {
           t_sendl(q, p-q);
        }
        t_sendl("\r\n", 2);
        q = ++p;                    /* point after \n */
       }
       if (*q) {
        t_send(q);
       }
    }
    if (output != stdout) {
       fputs(buf, output);
    }
#else
    fputs(buf, output);
    if (tee) {
       fputs(buf, stdout);
    }
    if (output == stdout || tee) {
       fflush(stdout);
    }
#endif
}

Generated by  Doxygen 1.6.0   Back to index