3 * Bacula Director -- User Agent Output Commands
4 * I.e. messages, listing database, showing resources, ...
6 * Kern Sibbald, September MM
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
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.
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.
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,
34 /* Imported subroutines */
36 /* Imported variables */
39 extern struct s_res resources[];
40 extern int console_msg_pending;
42 extern brwlock_t con_lock;
45 /* Imported functions */
47 /* Forward referenced functions */
48 static int do_list_cmd(UAContext *ua, char *cmd, e_list_type llist);
51 * Turn auto display of console messages on/off
53 int autodisplaycmd(UAContext *ua, char *cmd)
60 switch (find_arg_keyword(ua, kw)) {
62 ua->auto_display_messages = 1;
65 ua->auto_display_messages = 0;
68 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
75 struct showstruct {char *res_name; int type;};
76 static struct showstruct reses[] = {
77 {N_("directors"), R_DIRECTOR},
78 {N_("clients"), R_CLIENT},
79 {N_("counters"), R_COUNTER},
81 {N_("storages"), R_STORAGE},
82 {N_("catalogs"), R_CATALOG},
83 {N_("schedules"), R_SCHEDULE},
84 {N_("filesets"), R_FILESET},
85 {N_("pools"), R_POOL},
86 {N_("messages"), R_MSGS},
97 * show <resource-keyword-name> e.g. show directors
98 * show <resource-keyword-name>=<name> e.g. show director=HeadMan
101 int show_cmd(UAContext *ua, char *cmd)
108 Dmsg1(20, "show: %s\n", ua->UA_sock->msg);
111 for (i=1; i<ua->argc; i++) {
113 res_name = ua->argk[i];
114 if (!ua->argv[i]) { /* was a name given? */
115 /* No name, dump all resources of specified type */
117 len = strlen(res_name);
118 for (j=0; reses[j].res_name; j++) {
119 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
120 type = reses[j].type;
122 res = resources[type-r_first].res_head;
130 /* Dump a single resource with specified name */
132 len = strlen(res_name);
133 for (j=0; reses[j].res_name; j++) {
134 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
135 type = reses[j].type;
136 res = (RES *)GetResWithName(type, ua->argv[i]);
147 for (j=r_first; j<=r_last; j++) {
148 dump_resource(j, resources[j-r_first].res_head, bsendmsg, ua);
152 bsendmsg(ua, _("Keywords for the show command are:\n"));
153 for (j=0; reses[j].res_name; j++) {
154 bsendmsg(ua, "%s\n", _(reses[j].res_name));
158 bsendmsg(ua, _("%s resource %s not found.\n"), res_name, ua->argv[i]);
161 bsendmsg(ua, _("Resource %s not found\n"), res_name);
164 dump_resource(recurse?type:-type, res, bsendmsg, ua);
175 * List contents of database
177 * list jobs - lists all jobs run
178 * list jobid=nnn - list job data for jobid
179 * list job=name - list job data for job
180 * list jobmedia jobid=<nn>
181 * list jobmedia job=name
182 * list files jobid=<nn> - list files saved for job nn
183 * list files job=name
184 * list pools - list pool records
185 * list jobtotals - list totals for all jobs
186 * list media - list media for given pool (deprecated)
187 * list volumes - list Volumes
188 * list clients - list clients
189 * list nextvol job=xx - list the next vol to be used by job
190 * list nextvolume job=xx - same as above.
194 /* Do long or full listing */
195 int llist_cmd(UAContext *ua, char *cmd)
197 return do_list_cmd(ua, cmd, VERT_LIST);
200 /* Do short or summary listing */
201 int list_cmd(UAContext *ua, char *cmd)
203 return do_list_cmd(ua, cmd, HORZ_LIST);
206 static int do_list_cmd(UAContext *ua, char *cmd, e_list_type llist)
218 memset(&jr, 0, sizeof(jr));
219 memset(&pr, 0, sizeof(pr));
220 memset(&mr, 0, sizeof(mr));
222 Dmsg1(20, "list: %s\n", cmd);
225 bsendmsg(ua, _("Hey! DB is NULL\n"));
228 /* Scan arguments looking for things to do */
229 for (i=1; i<ua->argc; i++) {
231 if (strcasecmp(ua->argk[i], _("jobs")) == 0) {
232 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
235 } else if (strcasecmp(ua->argk[i], _("jobtotals")) == 0) {
236 db_list_job_totals(ua->jcr, ua->db, &jr, prtit, ua);
239 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
241 jobid = atoi(ua->argv[i]);
244 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
249 } else if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
250 bstrncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
252 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
255 } else if (strcasecmp(ua->argk[i], _("files")) == 0) {
257 for (j=i+1; j<ua->argc; j++) {
258 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
259 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
261 db_get_job_record(ua->jcr, ua->db, &jr);
263 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
264 jobid = atoi(ua->argv[j]);
269 db_list_files_for_job(ua->jcr, ua->db, jobid, prtit, ua);
274 } else if (strcasecmp(ua->argk[i], _("jobmedia")) == 0) {
276 for (j=i+1; j<ua->argc; j++) {
277 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
278 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
280 db_get_job_record(ua->jcr, ua->db, &jr);
282 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
283 jobid = atoi(ua->argv[j]);
287 db_list_jobmedia_records(ua->jcr, ua->db, jobid, prtit, ua, llist);
291 /* List for all jobs (jobid=0) */
292 db_list_jobmedia_records(ua->jcr, ua->db, 0, prtit, ua, llist);
296 } else if (strcasecmp(ua->argk[i], _("pools")) == 0) {
297 db_list_pool_records(ua->jcr, ua->db, prtit, ua, llist);
299 } else if (strcasecmp(ua->argk[i], _("clients")) == 0) {
300 db_list_client_records(ua->jcr, ua->db, prtit, ua, llist);
303 /* List MEDIA or VOLUMES */
304 } else if (strcasecmp(ua->argk[i], _("media")) == 0 ||
305 strcasecmp(ua->argk[i], _("volumes")) == 0) {
307 for (j=i+1; j<ua->argc; j++) {
308 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
309 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
311 db_get_job_record(ua->jcr, ua->db, &jr);
313 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
314 jobid = atoi(ua->argv[j]);
318 VolumeName = get_pool_memory(PM_FNAME);
319 n = db_get_job_volume_names(ua->jcr, ua->db, jobid, &VolumeName);
320 bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
321 free_pool_memory(VolumeName);
324 /* if no job or jobid keyword found, then we list all media */
328 /* Is a specific pool wanted? */
329 for (i=1; i<ua->argc; i++) {
330 if (strcasecmp(ua->argk[i], _("pool")) == 0) {
331 if (!get_pool_dbr(ua, &pr)) {
332 bsendmsg(ua, _("No Pool specified.\n"));
335 mr.PoolId = pr.PoolId;
336 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
340 /* List Volumes in all pools */
341 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
342 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"),
343 db_strerror(ua->db));
346 if (num_pools <= 0) {
349 for (i=0; i < num_pools; i++) {
351 if (db_get_pool_record(ua->jcr, ua->db, &pr)) {
352 bsendmsg(ua, _("Pool: %s\n"), pr.Name);
355 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
360 /* List a specific volume */
361 } else if (strcasecmp(ua->argk[i], _("volume")) == 0) {
363 bsendmsg(ua, _("No Volume Name specified.\n"));
366 bstrncpy(mr.VolumeName, ua->argv[i], sizeof(mr.VolumeName));
367 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
369 /* List next volume */
370 } else if (strcasecmp(ua->argk[i], _("nextvol")) == 0 ||
371 strcasecmp(ua->argk[i], _("nextvolume")) == 0) {
379 i = find_arg_with_value(ua, "job");
381 if ((job = select_job_resource(ua)) == NULL) {
385 job = (JOB *)GetResWithName(R_JOB, ua->argv[i]);
387 Jmsg(jcr, M_ERROR, 0, _("%s is not a job name.\n"), ua->argv[i]);
388 if ((job = select_job_resource(ua)) == NULL) {
393 for (run=NULL; (run = find_next_run(run, job, runtime)); ) {
394 pool = run ? run->pool : NULL;
395 if (!complete_jcr_for_job(jcr, job, pool)) {
399 if (!find_next_volume_for_append(jcr, &mr, 0)) {
400 bsendmsg(ua, _("Could not find next Volume.\n"));
402 db_close_database(jcr, jcr->db);
407 bsendmsg(ua, _("The next Volume to be used by Job \"%s\" will be %s\n"),
408 job->hdr.name, mr.VolumeName);
412 db_close_database(jcr, jcr->db);
417 db_close_database(jcr, jcr->db);
421 bsendmsg(ua, _("Could not find next Volume.\n"));
425 bsendmsg(ua, _("Unknown list keyword: %s\n"), NPRT(ua->argk[i]));
432 * For a given job, we examine all his run records
433 * to see if it is scheduled today or tomorrow.
435 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime)
437 time_t now, tomorrow;
440 int mday, wday, month, wom, tmday, twday, tmonth, twom, i, hour;
444 sched = job->schedule;
445 if (sched == NULL) { /* scheduled? */
446 return NULL; /* no nothing to report */
448 /* Break down current time into components */
450 localtime_r(&now, &tm);
451 mday = tm.tm_mday - 1;
457 /* Break down tomorrow into components */
458 tomorrow = now + 60 * 60 * 24;
459 localtime_r(&tomorrow, &tm);
460 tmday = tm.tm_mday - 1;
464 twoy = tm_woy(tomorrow);
471 for ( ; run; run=run->next) {
473 * Find runs in next 24 hours
475 tod = (bit_is_set(mday, run->mday) || bit_is_set(wday, run->wday)) &&
476 bit_is_set(month, run->month) && bit_is_set(wom, run->wom) &&
477 bit_is_set(woy, run->woy);
479 tom = (bit_is_set(tmday, run->mday) || bit_is_set(twday, run->wday)) &&
480 bit_is_set(tmonth, run->month) && bit_is_set(twom, run->wom) &&
481 bit_is_set(twoy, run->woy);
483 // Dmsg2(200, "tod=%d tom=%d\n", tod, tom);
484 // Dmsg2(200, "wom=%d twom=%d\n", wom, twom);
485 // Dmsg1(200, "bit_set_wom=%d\n", bit_is_set(wom, run->wom));
486 if (tod) { /* Jobs scheduled today (next 24 hours) */
487 /* find time (time_t) job is to be run */
488 localtime_r(&now, &tm);
490 for (i=tm.tm_hour; i < 24; i++) {
491 if (bit_is_set(i, run->hour)) {
493 tm.tm_min = run->minute;
495 runtime = mktime(&tm);
497 Dmsg2(000, "Found it level=%d %c\n", run->level, run->level);
498 return run; /* found it, return run resource */
504 // Dmsg2(200, "runtime=%d now=%d\n", runtime, now);
505 if (tom) { /* look at jobs scheduled tomorrow */
506 localtime_r(&tomorrow, &tm);
508 for (i=0; i < 24; i++) {
509 if (bit_is_set(i, run->hour)) {
515 tm.tm_min = run->minute;
517 runtime = mktime(&tm);
518 // Dmsg2(200, "truntime=%d now=%d\n", runtime, now);
519 if (runtime < tomorrow) {
520 return run; /* found it, return run resource */
523 } /* end for loop over runs */
528 * Fill in the remaining fields of the jcr as if it
529 * is going to run the job.
531 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool)
535 memset(&pr, 0, sizeof(POOL_DBR));
536 set_jcr_defaults(jcr, job);
538 jcr->pool = pool; /* override */
540 jcr->db = jcr->db=db_init_database(jcr, jcr->catalog->db_name, jcr->catalog->db_user,
541 jcr->catalog->db_password, jcr->catalog->db_address,
542 jcr->catalog->db_port, jcr->catalog->db_socket);
543 if (!jcr->db || !db_open_database(jcr, jcr->db)) {
544 Jmsg(jcr, M_FATAL, 0, _("Could not open database \"%s\".\n"),
545 jcr->catalog->db_name);
547 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
551 bstrncpy(pr.Name, jcr->pool->hdr.name, sizeof(pr.Name));
552 while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
553 /* Try to create the pool */
554 if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
555 Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
556 db_strerror(jcr->db));
558 db_close_database(jcr, jcr->db);
563 Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
566 jcr->PoolId = pr.PoolId;
567 jcr->jr.PoolId = pr.PoolId;
572 static void con_lock_release(void *arg)
577 void do_messages(UAContext *ua, char *cmd)
581 int do_truncate = FALSE;
584 pthread_cleanup_push(con_lock_release, (void *)NULL);
586 while (fgets(msg, sizeof(msg), con_fd)) {
588 ua->UA_sock->msg = check_pool_memory_size(ua->UA_sock->msg, mlen+1);
589 strcpy(ua->UA_sock->msg, msg);
590 ua->UA_sock->msglen = mlen;
591 bnet_send(ua->UA_sock);
595 ftruncate(fileno(con_fd), 0L);
597 console_msg_pending = FALSE;
598 ua->user_notified_msg_pending = FALSE;
599 pthread_cleanup_pop(0);
604 int qmessagescmd(UAContext *ua, char *cmd)
606 if (console_msg_pending && ua->auto_display_messages) {
607 do_messages(ua, cmd);
612 int messagescmd(UAContext *ua, char *cmd)
614 if (console_msg_pending) {
615 do_messages(ua, cmd);
617 bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
623 * Callback routine for "printing" database file listing
625 void prtit(void *ctx, char *msg)
627 UAContext *ua = (UAContext *)ctx;
629 bnet_fsend(ua->UA_sock, "%s", msg);
633 * Format message and send to other end.
635 * If the UA_sock is NULL, it means that there is no user
636 * agent, so we are being called from Bacula core. In
637 * that case direct the messages to the Job.
639 void bsendmsg(void *ctx, char *fmt, ...)
642 UAContext *ua = (UAContext *)ctx;
643 BSOCK *bs = ua->UA_sock;
650 msg = get_pool_memory(PM_EMSG);
654 maxlen = sizeof_pool_memory(msg) - 1;
655 va_start(arg_ptr, fmt);
656 len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
658 if (len < 0 || len >= maxlen) {
659 msg = realloc_pool_memory(msg, maxlen + maxlen/2);
667 } else { /* No UA, send to Job */
668 Jmsg(ua->jcr, M_INFO, 0, "%s", msg);
669 free_pool_memory(msg);