3 * Bacula Director -- User Agent Output Commands
4 * I.e. messages, listing database, showing resources, ...
6 * Kern Sibbald, September MM
12 Copyright (C) 2000-2004 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 RES_TABLE resources[];
40 extern RES **res_head;
41 extern int console_msg_pending;
43 extern brwlock_t con_lock;
46 /* Imported functions */
48 /* Forward referenced functions */
49 static int do_list_cmd(UAContext *ua, const char *cmd, e_list_type llist);
52 * Turn auto display of console messages on/off
54 int autodisplay_cmd(UAContext *ua, const char *cmd)
56 static const char *kw[] = {
61 switch (find_arg_keyword(ua, kw)) {
63 ua->auto_display_messages = 1;
66 ua->auto_display_messages = 0;
69 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
76 * Turn gui processing on/off
78 int gui_cmd(UAContext *ua, const char *cmd)
80 static const char *kw[] = {
85 switch (find_arg_keyword(ua, kw)) {
93 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
101 struct showstruct {const char *res_name; int type;};
102 static struct showstruct reses[] = {
103 {N_("directors"), R_DIRECTOR},
104 {N_("clients"), R_CLIENT},
105 {N_("counters"), R_COUNTER},
107 {N_("storages"), R_STORAGE},
108 {N_("catalogs"), R_CATALOG},
109 {N_("schedules"), R_SCHEDULE},
110 {N_("filesets"), R_FILESET},
111 {N_("pools"), R_POOL},
112 {N_("messages"), R_MSGS},
123 * show <resource-keyword-name> e.g. show directors
124 * show <resource-keyword-name>=<name> e.g. show director=HeadMan
127 int show_cmd(UAContext *ua, const char *cmd)
134 Dmsg1(20, "show: %s\n", ua->UA_sock->msg);
138 for (i=1; i<ua->argc; i++) {
140 res_name = ua->argk[i];
141 if (!ua->argv[i]) { /* was a name given? */
142 /* No name, dump all resources of specified type */
144 len = strlen(res_name);
145 for (j=0; reses[j].res_name; j++) {
146 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
147 type = reses[j].type;
149 res = res_head[type-r_first];
150 // res = resources[type-r_first].res_head;
159 /* Dump a single resource with specified name */
161 len = strlen(res_name);
162 for (j=0; reses[j].res_name; j++) {
163 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
164 type = reses[j].type;
165 res = (RES *)GetResWithName(type, ua->argv[i]);
176 for (j=r_first; j<=r_last; j++) {
177 dump_resource(j, res_head[j-r_first], bsendmsg, ua);
178 // dump_resource(j, resources[j-r_first].res_head, bsendmsg, ua);
182 bsendmsg(ua, _("Keywords for the show command are:\n"));
183 for (j=0; reses[j].res_name; j++) {
184 bsendmsg(ua, "%s\n", _(reses[j].res_name));
188 bsendmsg(ua, _("%s resource %s not found.\n"), res_name, ua->argv[i]);
191 bsendmsg(ua, _("Resource %s not found\n"), res_name);
194 dump_resource(recurse?type:-type, res, bsendmsg, ua);
207 * List contents of database
209 * list jobs - lists all jobs run
210 * list jobid=nnn - list job data for jobid
211 * list job=name - list job data for job
212 * list jobmedia jobid=<nn>
213 * list jobmedia job=name
214 * list files jobid=<nn> - list files saved for job nn
215 * list files job=name
216 * list pools - list pool records
217 * list jobtotals - list totals for all jobs
218 * list media - list media for given pool (deprecated)
219 * list volumes - list Volumes
220 * list clients - list clients
221 * list nextvol job=xx - list the next vol to be used by job
222 * list nextvolume job=xx - same as above.
226 /* Do long or full listing */
227 int llist_cmd(UAContext *ua, const char *cmd)
229 return do_list_cmd(ua, cmd, VERT_LIST);
232 /* Do short or summary listing */
233 int list_cmd(UAContext *ua, const char *cmd)
235 return do_list_cmd(ua, cmd, HORZ_LIST);
238 static int do_list_cmd(UAContext *ua, const char *cmd, e_list_type llist)
250 memset(&jr, 0, sizeof(jr));
251 memset(&pr, 0, sizeof(pr));
252 memset(&mr, 0, sizeof(mr));
254 Dmsg1(20, "list: %s\n", cmd);
257 bsendmsg(ua, _("Hey! DB is NULL\n"));
260 /* Scan arguments looking for things to do */
261 for (i=1; i<ua->argc; i++) {
263 if (strcasecmp(ua->argk[i], _("jobs")) == 0) {
264 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
267 } else if (strcasecmp(ua->argk[i], _("jobtotals")) == 0) {
268 db_list_job_totals(ua->jcr, ua->db, &jr, prtit, ua);
271 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
273 jobid = atoi(ua->argv[i]);
276 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
281 } else if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
282 bstrncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
284 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
287 } else if (strcasecmp(ua->argk[i], _("files")) == 0) {
289 for (j=i+1; j<ua->argc; j++) {
290 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
291 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
293 db_get_job_record(ua->jcr, ua->db, &jr);
295 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
296 jobid = atoi(ua->argv[j]);
301 db_list_files_for_job(ua->jcr, ua->db, jobid, prtit, ua);
306 } else if (strcasecmp(ua->argk[i], _("jobmedia")) == 0) {
308 for (j=i+1; j<ua->argc; j++) {
309 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
310 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
312 db_get_job_record(ua->jcr, ua->db, &jr);
314 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
315 jobid = atoi(ua->argv[j]);
319 db_list_jobmedia_records(ua->jcr, ua->db, jobid, prtit, ua, llist);
323 /* List for all jobs (jobid=0) */
324 db_list_jobmedia_records(ua->jcr, ua->db, 0, prtit, ua, llist);
328 } else if (strcasecmp(ua->argk[i], _("pools")) == 0) {
329 db_list_pool_records(ua->jcr, ua->db, prtit, ua, llist);
331 } else if (strcasecmp(ua->argk[i], _("clients")) == 0) {
332 db_list_client_records(ua->jcr, ua->db, prtit, ua, llist);
335 /* List MEDIA or VOLUMES */
336 } else if (strcasecmp(ua->argk[i], _("media")) == 0 ||
337 strcasecmp(ua->argk[i], _("volumes")) == 0) {
339 for (j=i+1; j<ua->argc; j++) {
340 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
341 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
343 db_get_job_record(ua->jcr, ua->db, &jr);
345 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
346 jobid = atoi(ua->argv[j]);
350 VolumeName = get_pool_memory(PM_FNAME);
351 n = db_get_job_volume_names(ua->jcr, ua->db, jobid, &VolumeName);
352 bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
353 free_pool_memory(VolumeName);
356 /* if no job or jobid keyword found, then we list all media */
360 /* Is a specific pool wanted? */
361 for (i=1; i<ua->argc; i++) {
362 if (strcasecmp(ua->argk[i], _("pool")) == 0) {
363 if (!get_pool_dbr(ua, &pr)) {
364 bsendmsg(ua, _("No Pool specified.\n"));
367 mr.PoolId = pr.PoolId;
368 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
372 /* List Volumes in all pools */
373 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
374 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"),
375 db_strerror(ua->db));
378 if (num_pools <= 0) {
381 for (i=0; i < num_pools; i++) {
383 if (db_get_pool_record(ua->jcr, ua->db, &pr)) {
384 bsendmsg(ua, _("Pool: %s\n"), pr.Name);
387 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
392 /* List a specific volume */
393 } else if (strcasecmp(ua->argk[i], _("volume")) == 0) {
395 bsendmsg(ua, _("No Volume Name specified.\n"));
398 bstrncpy(mr.VolumeName, ua->argv[i], sizeof(mr.VolumeName));
399 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
401 /* List next volume */
402 } else if (strcasecmp(ua->argk[i], _("nextvol")) == 0 ||
403 strcasecmp(ua->argk[i], _("nextvolume")) == 0) {
411 i = find_arg_with_value(ua, "job");
413 if ((job = select_job_resource(ua)) == NULL) {
417 job = (JOB *)GetResWithName(R_JOB, ua->argv[i]);
419 Jmsg(jcr, M_ERROR, 0, _("%s is not a job name.\n"), ua->argv[i]);
420 if ((job = select_job_resource(ua)) == NULL) {
425 for (run=NULL; (run = find_next_run(run, job, runtime)); ) {
426 pool = run ? run->pool : NULL;
427 if (!complete_jcr_for_job(jcr, job, pool)) {
431 if (!find_next_volume_for_append(jcr, &mr, 0)) {
432 bsendmsg(ua, _("Could not find next Volume.\n"));
434 db_close_database(jcr, jcr->db);
439 bsendmsg(ua, _("The next Volume to be used by Job \"%s\" will be %s\n"),
440 job->hdr.name, mr.VolumeName);
444 db_close_database(jcr, jcr->db);
449 db_close_database(jcr, jcr->db);
453 bsendmsg(ua, _("Could not find next Volume.\n"));
457 bsendmsg(ua, _("Unknown list keyword: %s\n"), NPRT(ua->argk[i]));
464 * For a given job, we examine all his run records
465 * to see if it is scheduled today or tomorrow.
467 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime)
469 time_t now, tomorrow;
472 int mday, wday, month, wom, tmday, twday, tmonth, twom, i;
476 sched = job->schedule;
477 if (sched == NULL) { /* scheduled? */
478 return NULL; /* no nothing to report */
480 /* Break down current time into components */
482 localtime_r(&now, &tm);
483 mday = tm.tm_mday - 1;
489 /* Break down tomorrow into components */
490 tomorrow = now + 60 * 60 * 24;
491 localtime_r(&tomorrow, &tm);
492 tmday = tm.tm_mday - 1;
496 twoy = tm_woy(tomorrow);
503 for ( ; run; run=run->next) {
505 * Find runs in next 24 hours
507 tod = bit_is_set(mday, run->mday) && bit_is_set(wday, run->wday) &&
508 bit_is_set(month, run->month) && bit_is_set(wom, run->wom) &&
509 bit_is_set(woy, run->woy);
511 tom = bit_is_set(tmday, run->mday) && bit_is_set(twday, run->wday) &&
512 bit_is_set(tmonth, run->month) && bit_is_set(twom, run->wom) &&
513 bit_is_set(twoy, run->woy);
516 Dmsg2(000, "tod=%d tom=%d\n", tod, tom);
517 Dmsg1(000, "bit_set_mday=%d\n", bit_is_set(mday, run->mday));
518 Dmsg1(000, "bit_set_wday=%d\n", bit_is_set(wday, run->wday));
519 Dmsg1(000, "bit_set_month=%d\n", bit_is_set(month, run->month));
520 Dmsg1(000, "bit_set_wom=%d\n", bit_is_set(wom, run->wom));
521 Dmsg1(000, "bit_set_woy=%d\n", bit_is_set(woy, run->woy));
523 if (tod) { /* Jobs scheduled today (next 24 hours) */
525 char buf[300], num[10];
526 bsnprintf(buf, sizeof(buf), "tm.hour=%d hour=", tm.tm_hour);
527 for (i=0; i<24; i++) {
528 if (bit_is_set(i, run->hour)) {
529 bsnprintf(num, sizeof(num), "%d ", i);
530 bstrncat(buf, num, sizeof(buf));
533 bstrncat(buf, "\n", sizeof(buf));
534 Dmsg1(000, "%s", buf);
536 /* find time (time_t) job is to be run */
537 localtime_r(&now, &tm);
538 for (i=tm.tm_hour; i < 24; i++) {
539 if (bit_is_set(i, run->hour)) {
541 tm.tm_min = run->minute;
543 runtime = mktime(&tm);
544 Dmsg2(200, "now=%d runtime=%d\n", now, runtime);
546 Dmsg2(200, "Found it level=%d %c\n", run->level, run->level);
547 return run; /* found it, return run resource */
553 // Dmsg2(200, "runtime=%d now=%d\n", runtime, now);
554 if (tom) { /* look at jobs scheduled tomorrow */
555 localtime_r(&tomorrow, &tm);
556 for (i=0; i < 24; i++) {
557 if (bit_is_set(i, run->hour)) {
559 tm.tm_min = run->minute;
561 runtime = mktime(&tm);
562 Dmsg2(200, "now=%d runtime=%d\n", now, runtime);
563 if (runtime < tomorrow) {
564 Dmsg2(200, "Found it level=%d %c\n", run->level, run->level);
565 return run; /* found it, return run resource */
570 } /* end for loop over runs */
575 * Fill in the remaining fields of the jcr as if it
576 * is going to run the job.
578 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool)
582 memset(&pr, 0, sizeof(POOL_DBR));
583 set_jcr_defaults(jcr, job);
585 jcr->pool = pool; /* override */
587 jcr->db = jcr->db=db_init_database(jcr, jcr->catalog->db_name, jcr->catalog->db_user,
588 jcr->catalog->db_password, jcr->catalog->db_address,
589 jcr->catalog->db_port, jcr->catalog->db_socket);
590 if (!jcr->db || !db_open_database(jcr, jcr->db)) {
591 Jmsg(jcr, M_FATAL, 0, _("Could not open database \"%s\".\n"),
592 jcr->catalog->db_name);
594 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
598 bstrncpy(pr.Name, jcr->pool->hdr.name, sizeof(pr.Name));
599 while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
600 /* Try to create the pool */
601 if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
602 Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
603 db_strerror(jcr->db));
605 db_close_database(jcr, jcr->db);
610 Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
613 jcr->PoolId = pr.PoolId;
614 jcr->jr.PoolId = pr.PoolId;
619 static void con_lock_release(void *arg)
624 void do_messages(UAContext *ua, const char *cmd)
628 int do_truncate = FALSE;
631 pthread_cleanup_push(con_lock_release, (void *)NULL);
633 while (fgets(msg, sizeof(msg), con_fd)) {
635 ua->UA_sock->msg = check_pool_memory_size(ua->UA_sock->msg, mlen+1);
636 strcpy(ua->UA_sock->msg, msg);
637 ua->UA_sock->msglen = mlen;
638 bnet_send(ua->UA_sock);
642 ftruncate(fileno(con_fd), 0L);
644 console_msg_pending = FALSE;
645 ua->user_notified_msg_pending = FALSE;
646 pthread_cleanup_pop(0);
651 int qmessagescmd(UAContext *ua, const char *cmd)
653 if (console_msg_pending && ua->auto_display_messages) {
654 do_messages(ua, cmd);
659 int messagescmd(UAContext *ua, const char *cmd)
661 if (console_msg_pending) {
662 do_messages(ua, cmd);
664 bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
670 * Callback routine for "printing" database file listing
672 void prtit(void *ctx, const char *msg)
674 UAContext *ua = (UAContext *)ctx;
676 bnet_fsend(ua->UA_sock, "%s", msg);
680 * Format message and send to other end.
682 * If the UA_sock is NULL, it means that there is no user
683 * agent, so we are being called from Bacula core. In
684 * that case direct the messages to the Job.
686 void bsendmsg(void *ctx, const char *fmt, ...)
689 UAContext *ua = (UAContext *)ctx;
690 BSOCK *bs = ua->UA_sock;
697 msg = get_pool_memory(PM_EMSG);
701 maxlen = sizeof_pool_memory(msg) - 1;
702 va_start(arg_ptr, fmt);
703 len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
705 if (len < 0 || len >= maxlen) {
706 msg = realloc_pool_memory(msg, maxlen + maxlen/2);
714 } else { /* No UA, send to Job */
715 Jmsg(ua->jcr, M_INFO, 0, "%s", msg);
716 free_pool_memory(msg);