git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_output.c

   1 /*
   2  *
   3  *   Bacula Director -- User Agent Output Commands
   4  *     I.e. messages, listing database, showing resources, ...
   5  *
   6  *     Kern Sibbald, September MM
   7  *
   8  *   Version $Id$
   9  */
  10
  11 /*
  12    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of
  17    the License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public
  25    License along with this program; if not, write to the Free
  26    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31 #include "bacula.h"
  32 #include "dird.h"
  33 #include "ua.h"
  34
  35 /* Imported subroutines */
  36 extern void run_job(JCR *jcr);
  37
  38 /* Imported variables */
  39 extern int r_first;
  40 extern int r_last;
  41 extern struct s_res resources[];
  42 extern int console_msg_pending;
  43 extern FILE *con_fd;
  44 extern brwlock_t con_lock;
  45
  46
  47 /* Imported functions */
  48
  49 /* Forward referenced functions */
  50
  51
  52 /*
  53  * Turn auto display of console messages on/off
  54  */
  55 int autodisplaycmd(UAContext *ua, char *cmd)
  56 {
  57    static char *kw[] = {
  58       N_("on"),
  59       N_("off"),
  60       NULL};
  61
  62    switch (find_arg_keyword(ua, kw)) {
  63       case 0:
  64          ua->auto_display_messages = 1;
  65          break;
  66       case 1:
  67          ua->auto_display_messages = 0;
  68          break;
  69       default:
  70          bsendmsg(ua, _("ON or OFF keyword missing.\n"));
  71          break;
  72    }
  73    return 1;
  74 }
  75
  76
  77 struct showstruct {char *res_name; int type;};
  78 static struct showstruct reses[] = {
  79    {N_("directors"),  R_DIRECTOR},
  80    {N_("clients"),    R_CLIENT},
  81    {N_("jobs"),       R_JOB},
  82    {N_("storages"),   R_STORAGE},
  83    {N_("catalogs"),   R_CATALOG},
  84    {N_("schedules"),  R_SCHEDULE},
  85    {N_("filesets"),   R_FILESET},
  86    {N_("groups"),     R_GROUP},
  87    {N_("pools"),      R_POOL},
  88    {N_("messages"),   R_MSGS},
  89    {N_("all"),        -1},
  90    {N_("help"),       -2},
  91    {NULL,           0}
  92 };
  93
  94
  95 /*
  96  *  Displays Resources
  97  *
  98  *  show all
  99  *  show <resource-keyword-name>  e.g. show directors
 100  *  show <resource-keyword-name>=<name> e.g. show director=HeadMan
 101  *
 102  */
 103 int showcmd(UAContext *ua, char *cmd)
 104 {
 105    int i, j, type, len;
 106    int recurse;
 107    char *res_name;
 108    RES *res = NULL;
 109
 110    Dmsg1(20, "show: %s\n", ua->UA_sock->msg);
 111
 112
 113    for (i=1; i<ua->argc; i++) {
 114       type = 0;
 115       res_name = ua->argk[i];
 116       if (!ua->argv[i]) {             /* was a name given? */
 117          /* No name, dump all resources of specified type */
 118          recurse = 1;
 119          len = strlen(res_name);
 120          for (j=0; reses[j].res_name; j++) {
 121             if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
 122                type = reses[j].type;
 123                if (type > 0) {
 124                   res = resources[type-r_first].res_head;
 125                } else {
 126                   res = NULL;
 127                }
 128                break;
 129             }
 130          }
 131       } else {
 132          /* Dump a single resource with specified name */
 133          recurse = 0;
 134          len = strlen(res_name);
 135          for (j=0; reses[j].res_name; j++) {
 136             if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
 137                type = reses[j].type;
 138                res = (RES *)GetResWithName(type, ua->argv[i]);
 139                if (!res) {
 140                   type = -3;
 141                }
 142                break;
 143             }
 144          }
 145       }
 146
 147       switch (type) {
 148       case -1:                           /* all */
 149          for (j=r_first; j<=r_last; j++) {
 150             dump_resource(j, resources[j-r_first].res_head, bsendmsg, ua);
 151          }
 152          break;
 153       case -2:
 154          bsendmsg(ua, _("Keywords for the show command are:\n"));
 155          for (j=0; reses[j].res_name; j++) {
 156             bsendmsg(ua, "%s\n", _(reses[j].res_name));
 157          }
 158          return 1;
 159       case -3:
 160          bsendmsg(ua, _("%s resource %s not found.\n"), res_name, ua->argv[i]);
 161          return 1;
 162       case 0:
 163          bsendmsg(ua, _("Resource %s not found\n"), res_name);
 164          return 1;
 165       default:
 166          dump_resource(recurse?type:-type, res, bsendmsg, ua);
 167          break;
 168       }
 169    }
 170    return 1;
 171 }
 172
 173
 174
 175
 176 /*
 177  *  List contents of database
 178  *
 179  *  list jobs           - lists all jobs run
 180  *  list jobid=nnn      - list job data for jobid
 181  *  list job=name       - list job data for job
 182  *  list jobmedia jobid=<nn>
 183  *  list jobmedia job=name
 184  *  list files jobid=<nn> - list files saved for job nn
 185  *  list files job=name
 186  *  list pools          - list pool records
 187  *  list jobtotals      - list totals for all jobs
 188  *  list media          - list media for given pool
 189  *  list clients        - list clients
 190  *
 191  */
 192 int listcmd(UAContext *ua, char *cmd)
 193 {
 194    POOLMEM *VolumeName;
 195    int jobid, n;
 196    int i, j;
 197    JOB_DBR jr;
 198    POOL_DBR pr;
 199    MEDIA_DBR mr;
 200
 201    if (!open_db(ua))
 202       return 1;
 203
 204    memset(&jr, 0, sizeof(jr));
 205    memset(&pr, 0, sizeof(pr));
 206    memset(&mr, 0, sizeof(mr));
 207
 208    Dmsg1(20, "list: %s\n", cmd);
 209
 210    if (!ua->db) {
 211       bsendmsg(ua, _("Hey! DB is NULL\n"));
 212    }
 213
 214    /* Scan arguments looking for things to do */
 215    for (i=1; i<ua->argc; i++) {
 216       /* List JOBS */
 217       if (strcasecmp(ua->argk[i], _("jobs")) == 0) {
 218          db_list_job_records(ua->db, &jr, prtit, ua);
 219
 220          /* List JOBTOTALS */
 221       } else if (strcasecmp(ua->argk[i], _("jobtotals")) == 0) {
 222          db_list_job_totals(ua->db, &jr, prtit, ua);
 223
 224       /* List JOBID */
 225       } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
 226          if (ua->argv[i]) {
 227             jobid = atoi(ua->argv[i]);
 228             if (jobid > 0) {
 229                jr.JobId = jobid;
 230                db_list_job_records(ua->db, &jr, prtit, ua);
 231             }
 232          }
 233
 234       /* List JOB */
 235       } else if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
 236          strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
 237          jr.Job[MAX_NAME_LENGTH-1] = 0;
 238          jr.JobId = 0;
 239          db_list_job_records(ua->db, &jr, prtit, ua);
 240
 241       /* List FILES */
 242       } else if (strcasecmp(ua->argk[i], _("files")) == 0) {
 243
 244          for (j=i+1; j<ua->argc; j++) {
 245             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
 246                strncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
 247                jr.Job[MAX_NAME_LENGTH-1] = 0;
 248                jr.JobId = 0;
 249                db_get_job_record(ua->db, &jr);
 250                jobid = jr.JobId;
 251             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
 252                jobid = atoi(ua->argv[j]);
 253             } else {
 254                continue;
 255             }
 256             if (jobid > 0) {
 257                db_list_files_for_job(ua->db, jobid, prtit, ua);
 258             }
 259          }
 260
 261       /* List JOBMEDIA */
 262       } else if (strcasecmp(ua->argk[i], _("jobmedia")) == 0) {
 263          int done = FALSE;
 264          for (j=i+1; j<ua->argc; j++) {
 265             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
 266                strncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
 267                jr.Job[MAX_NAME_LENGTH-1] = 0;
 268                jr.JobId = 0;
 269                db_get_job_record(ua->db, &jr);
 270                jobid = jr.JobId;
 271             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
 272                jobid = atoi(ua->argv[j]);
 273             } else {
 274                continue;
 275             }
 276             db_list_jobmedia_records(ua->db, jobid, prtit, ua);
 277             done = TRUE;
 278          }
 279          if (!done) {
 280             /* List for all jobs (jobid=0) */
 281             db_list_jobmedia_records(ua->db, 0, prtit, ua);
 282          }
 283
 284       /* List POOLS */
 285       } else if (strcasecmp(ua->argk[i], _("pools")) == 0) {
 286          db_list_pool_records(ua->db, prtit, ua);
 287
 288       } else if (strcasecmp(ua->argk[i], _("clients")) == 0) {
 289          db_list_client_records(ua->db, prtit, ua);
 290
 291
 292       /* List MEDIA or VOLUMES */
 293       } else if (strcasecmp(ua->argk[i], _("media")) == 0 ||
 294                  strcasecmp(ua->argk[i], _("volumes")) == 0) {
 295          int done = FALSE;
 296          for (j=i+1; j<ua->argc; j++) {
 297             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
 298                strncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
 299                jr.Job[MAX_NAME_LENGTH-1] = 0;
 300                jr.JobId = 0;
 301                db_get_job_record(ua->db, &jr);
 302                jobid = jr.JobId;
 303             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
 304                jobid = atoi(ua->argv[j]);
 305             } else {
 306                continue;
 307             }
 308             VolumeName = get_pool_memory(PM_FNAME);
 309             n = db_get_job_volume_names(ua->db, jobid, &VolumeName);
 310             bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
 311             free_pool_memory(VolumeName);
 312             done = TRUE;
 313          }
 314          /* if no job or jobid keyword found, then we list all media */
 315          if (!done) {
 316             if (!get_pool_dbr(ua, &pr)) {
 317                return 1;
 318             }
 319             mr.PoolId = pr.PoolId;
 320             db_list_media_records(ua->db, &mr, prtit, ua);
 321          }
 322       } else {
 323          bsendmsg(ua, _("Unknown list keyword: %s\n"), NPRT(ua->argk[i]));
 324       }
 325    }
 326    return 1;
 327 }
 328
 329 static void con_lock_release(void *arg)
 330 {
 331    Vw(con_lock);
 332 }
 333
 334 void do_messages(UAContext *ua, char *cmd)
 335 {
 336    char msg[2000];
 337    int mlen;
 338    int do_truncate = FALSE;
 339
 340    Pw(con_lock);
 341    pthread_cleanup_push(con_lock_release, (void *)NULL);
 342    rewind(con_fd);
 343    while (fgets(msg, sizeof(msg), con_fd)) {
 344       mlen = strlen(msg);
 345       ua->UA_sock->msg = check_pool_memory_size(ua->UA_sock->msg, mlen+1);
 346       strcpy(ua->UA_sock->msg, msg);
 347       ua->UA_sock->msglen = mlen;
 348       bnet_send(ua->UA_sock);
 349       do_truncate = TRUE;
 350    }
 351    if (do_truncate) {
 352       ftruncate(fileno(con_fd), 0L);
 353    }
 354    console_msg_pending = FALSE;
 355    ua->user_notified_msg_pending = FALSE;
 356    pthread_cleanup_pop(0);
 357    Vw(con_lock);
 358 }
 359
 360
 361 int qmessagescmd(UAContext *ua, char *cmd)
 362 {
 363    if (console_msg_pending && ua->auto_display_messages) {
 364       do_messages(ua, cmd);
 365    }
 366    return 1;
 367 }
 368
 369 int messagescmd(UAContext *ua, char *cmd)
 370 {
 371    if (console_msg_pending) {
 372       do_messages(ua, cmd);
 373    } else {
 374       bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
 375    }
 376    return 1;
 377 }
 378
 379 /*
 380  * Callback routine for "printing" database file listing
 381  */
 382 void prtit(void *ctx, char *msg)
 383 {
 384    UAContext *ua = (UAContext *)ctx;
 385
 386    bnet_fsend(ua->UA_sock, "%s", msg);
 387 }
 388
 389 /*
 390  * Format message and send to other end.
 391
 392  * If the UA_sock is NULL, it means that there is no user
 393  * agent, so we are being called from Bacula core. In
 394  * that case direct the messages to the Job.
 395  */
 396 void bsendmsg(void *ctx, char *fmt, ...)
 397 {
 398    va_list arg_ptr;
 399    UAContext *ua = (UAContext *)ctx;
 400    BSOCK *bs = ua->UA_sock;
 401    int maxlen, len;
 402    POOLMEM *msg;
 403
 404    if (bs) {
 405       msg = bs->msg;
 406    } else {
 407       msg = get_pool_memory(PM_EMSG);
 408    }
 409
 410 again:
 411    maxlen = sizeof_pool_memory(msg) - 1;
 412    va_start(arg_ptr, fmt);
 413    len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
 414    va_end(arg_ptr);
 415    if (len < 0 || len >= maxlen) {
 416       msg = realloc_pool_memory(msg, maxlen + 200);
 417       goto again;
 418    }
 419
 420    if (bs) {
 421       bs->msglen = len;
 422       bnet_send(bs);
 423    } else {                           /* No UA, send to Job */
 424       Jmsg(ua->jcr, M_INFO, 0, msg);
 425       free_pool_memory(msg);
 426    }
 427
 428 }