2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
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 plus additions
11 that are listed in the file LICENSE.
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.
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
23 Bacula® is a registered trademark of John Walker.
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.
30 * Bacula Director -- User Agent Output Commands
31 * I.e. messages, listing database, showing resources, ...
33 * Kern Sibbald, September MM
41 /* Imported subroutines */
43 /* Imported variables */
46 extern RES_TABLE resources[];
47 extern RES **res_head;
49 /* Imported functions */
51 /* Forward referenced functions */
52 static int do_list_cmd(UAContext *ua, const char *cmd, e_list_type llist);
53 static bool list_nextvol(UAContext *ua, int ndays);
56 * Turn auto display of console messages on/off
58 int autodisplay_cmd(UAContext *ua, const char *cmd)
60 static const char *kw[] = {
65 switch (find_arg_keyword(ua, kw)) {
67 ua->auto_display_messages = true;
70 ua->auto_display_messages = false;
73 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
80 * Turn GUI mode on/off
82 int gui_cmd(UAContext *ua, const char *cmd)
84 static const char *kw[] = {
89 switch (find_arg_keyword(ua, kw)) {
91 ua->jcr->gui = ua->gui = true;
94 ua->jcr->gui = ua->gui = false;
97 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
105 struct showstruct {const char *res_name; int type;};
106 static struct showstruct reses[] = {
107 {NT_("directors"), R_DIRECTOR},
108 {NT_("clients"), R_CLIENT},
109 {NT_("counters"), R_COUNTER},
110 {NT_("devices"), R_DEVICE},
111 {NT_("jobs"), R_JOB},
112 {NT_("storages"), R_STORAGE},
113 {NT_("catalogs"), R_CATALOG},
114 {NT_("schedules"), R_SCHEDULE},
115 {NT_("filesets"), R_FILESET},
116 {NT_("pools"), R_POOL},
117 {NT_("messages"), R_MSGS},
128 * show <resource-keyword-name> e.g. show directors
129 * show <resource-keyword-name>=<name> e.g. show director=HeadMan
132 int show_cmd(UAContext *ua, const char *cmd)
139 Dmsg1(20, "show: %s\n", ua->UA_sock->msg);
143 for (i=1; i<ua->argc; i++) {
145 res_name = ua->argk[i];
146 if (!ua->argv[i]) { /* was a name given? */
147 /* No name, dump all resources of specified type */
149 len = strlen(res_name);
150 for (j=0; reses[j].res_name; j++) {
151 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
152 type = reses[j].type;
154 res = res_head[type-r_first];
163 /* Dump a single resource with specified name */
165 len = strlen(res_name);
166 for (j=0; reses[j].res_name; j++) {
167 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
168 type = reses[j].type;
169 res = (RES *)GetResWithName(type, ua->argv[i]);
180 for (j=r_first; j<=r_last; j++) {
181 dump_resource(j, res_head[j-r_first], bsendmsg, ua);
185 bsendmsg(ua, _("Keywords for the show command are:\n"));
186 for (j=0; reses[j].res_name; j++) {
187 bsendmsg(ua, "%s\n", _(reses[j].res_name));
191 bsendmsg(ua, _("%s resource %s not found.\n"), res_name, ua->argv[i]);
194 bsendmsg(ua, _("Resource %s not found\n"), res_name);
197 dump_resource(recurse?type:-type, res, bsendmsg, ua);
210 * List contents of database
212 * list jobs - lists all jobs run
213 * list jobid=nnn - list job data for jobid
214 * list ujobid=uname - list job data for unique jobid
215 * list job=name - list all jobs with "name"
216 * list jobname=name - same as above
217 * list jobmedia jobid=<nn>
218 * list jobmedia job=name
219 * list files jobid=<nn> - list files saved for job nn
220 * list files job=name
221 * list pools - list pool records
222 * list jobtotals - list totals for all jobs
223 * list media - list media for given pool (deprecated)
224 * list volumes - list Volumes
225 * list clients - list clients
226 * list nextvol job=xx - list the next vol to be used by job
227 * list nextvolume job=xx - same as above.
231 /* Do long or full listing */
232 int llist_cmd(UAContext *ua, const char *cmd)
234 return do_list_cmd(ua, cmd, VERT_LIST);
237 /* Do short or summary listing */
238 int list_cmd(UAContext *ua, const char *cmd)
240 return do_list_cmd(ua, cmd, HORZ_LIST);
243 static int do_list_cmd(UAContext *ua, const char *cmd, e_list_type llist)
252 if (!open_client_db(ua))
255 memset(&jr, 0, sizeof(jr));
256 memset(&pr, 0, sizeof(pr));
257 memset(&mr, 0, sizeof(mr));
259 Dmsg1(20, "list: %s\n", cmd);
262 bsendmsg(ua, _("Hey! DB is NULL\n"));
265 /* Scan arguments looking for things to do */
266 for (i=1; i<ua->argc; i++) {
268 if (strcasecmp(ua->argk[i], NT_("jobs")) == 0) {
269 /* Apply any limit */
270 j = find_arg_with_value(ua, NT_("limit"));
272 jr.limit = atoi(ua->argv[j]);
274 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
277 } else if (strcasecmp(ua->argk[i], NT_("jobtotals")) == 0) {
278 db_list_job_totals(ua->jcr, ua->db, &jr, prtit, ua);
281 } else if (strcasecmp(ua->argk[i], NT_("jobid")) == 0) {
283 jobid = str_to_int64(ua->argv[i]);
286 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
291 } else if ((strcasecmp(ua->argk[i], NT_("job")) == 0 ||
292 strcasecmp(ua->argk[i], NT_("jobname")) == 0) && ua->argv[i]) {
293 bstrncpy(jr.Name, ua->argv[i], MAX_NAME_LENGTH);
295 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
297 /* List UJOBID=xxx */
298 } else if (strcasecmp(ua->argk[i], NT_("ujobid")) == 0 && ua->argv[i]) {
299 bstrncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
301 db_list_job_records(ua->jcr, ua->db, &jr, prtit, ua, llist);
304 } else if (strcasecmp(ua->argk[i], NT_("files")) == 0) {
306 for (j=i+1; j<ua->argc; j++) {
307 if (strcasecmp(ua->argk[j], NT_("ujobid")) == 0 && ua->argv[j]) {
308 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
310 db_get_job_record(ua->jcr, ua->db, &jr);
312 } else if (strcasecmp(ua->argk[j], NT_("jobid")) == 0 && ua->argv[j]) {
313 jobid = str_to_int64(ua->argv[j]);
318 db_list_files_for_job(ua->jcr, ua->db, jobid, prtit, ua);
323 } else if (strcasecmp(ua->argk[i], NT_("jobmedia")) == 0) {
325 for (j=i+1; j<ua->argc; j++) {
326 if (strcasecmp(ua->argk[j], NT_("ujobid")) == 0 && ua->argv[j]) {
327 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
329 db_get_job_record(ua->jcr, ua->db, &jr);
331 } else if (strcasecmp(ua->argk[j], NT_("jobid")) == 0 && ua->argv[j]) {
332 jobid = str_to_int64(ua->argv[j]);
336 db_list_jobmedia_records(ua->jcr, ua->db, jobid, prtit, ua, llist);
340 /* List for all jobs (jobid=0) */
341 db_list_jobmedia_records(ua->jcr, ua->db, 0, prtit, ua, llist);
345 } else if (strcasecmp(ua->argk[i], NT_("pool")) == 0 ||
346 strcasecmp(ua->argk[i], NT_("pools")) == 0) {
348 memset(&pr, 0, sizeof(pr));
350 bstrncpy(pr.Name, ua->argv[i], sizeof(pr.Name));
352 db_list_pool_records(ua->jcr, ua->db, &pr, prtit, ua, llist);
354 } else if (strcasecmp(ua->argk[i], NT_("clients")) == 0) {
355 db_list_client_records(ua->jcr, ua->db, prtit, ua, llist);
358 /* List MEDIA or VOLUMES */
359 } else if (strcasecmp(ua->argk[i], NT_("media")) == 0 ||
360 strcasecmp(ua->argk[i], NT_("volume")) == 0 ||
361 strcasecmp(ua->argk[i], NT_("volumes")) == 0) {
363 for (j=i+1; j<ua->argc; j++) {
364 if (strcasecmp(ua->argk[j], NT_("ujobid")) == 0 && ua->argv[j]) {
365 bstrncpy(jr.Job, ua->argv[j], MAX_NAME_LENGTH);
367 db_get_job_record(ua->jcr, ua->db, &jr);
369 } else if (strcasecmp(ua->argk[j], NT_("jobid")) == 0 && ua->argv[j]) {
370 jobid = str_to_int64(ua->argv[j]);
374 VolumeName = get_pool_memory(PM_FNAME);
375 n = db_get_job_volume_names(ua->jcr, ua->db, jobid, &VolumeName);
376 bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
377 free_pool_memory(VolumeName);
380 /* if no job or jobid keyword found, then we list all media */
384 /* List a specific volume? */
386 bstrncpy(mr.VolumeName, ua->argv[i], sizeof(mr.VolumeName));
387 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
390 /* Is a specific pool wanted? */
391 for (i=1; i<ua->argc; i++) {
392 if (strcasecmp(ua->argk[i], NT_("pool")) == 0) {
393 if (!get_pool_dbr(ua, &pr)) {
394 bsendmsg(ua, _("No Pool specified.\n"));
397 mr.PoolId = pr.PoolId;
398 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
403 /* List Volumes in all pools */
404 if (!db_get_pool_ids(ua->jcr, ua->db, &num_pools, &ids)) {
405 bsendmsg(ua, _("Error obtaining pool ids. ERR=%s\n"),
406 db_strerror(ua->db));
409 if (num_pools <= 0) {
412 for (i=0; i < num_pools; i++) {
414 if (db_get_pool_record(ua->jcr, ua->db, &pr)) {
415 bsendmsg(ua, _("Pool: %s\n"), pr.Name);
418 db_list_media_records(ua->jcr, ua->db, &mr, prtit, ua, llist);
423 /* List next volume */
424 } else if (strcasecmp(ua->argk[i], NT_("nextvol")) == 0 ||
425 strcasecmp(ua->argk[i], NT_("nextvolume")) == 0) {
427 j = find_arg_with_value(ua, NT_("days"));
429 n = atoi(ua->argv[j]);
430 if ((n < 0) || (n > 50)) {
431 bsendmsg(ua, _("Ignoring invalid value for days. Max is 50.\n"));
436 } else if (strcasecmp(ua->argk[i], NT_("limit")) == 0
437 || strcasecmp(ua->argk[i], NT_("days")) == 0) {
440 bsendmsg(ua, _("Unknown list keyword: %s\n"), NPRT(ua->argk[i]));
446 static bool list_nextvol(UAContext *ua, int ndays)
458 memset(&mr, 0, sizeof(mr));
459 int i = find_arg_with_value(ua, "job");
461 if ((job = select_job_resource(ua)) == NULL) {
465 job = (JOB *)GetResWithName(R_JOB, ua->argv[i]);
467 Jmsg(jcr, M_ERROR, 0, _("%s is not a job name.\n"), ua->argv[i]);
468 if ((job = select_job_resource(ua)) == NULL) {
473 for (run=NULL; (run = find_next_run(run, job, runtime, ndays)); ) {
474 pool = run->pool ? run->pool : NULL;
475 if (!complete_jcr_for_job(jcr, job, pool)) {
478 memset(&pr, 0, sizeof(pr));
479 pr.PoolId = jcr->jr.PoolId;
480 if (! db_get_pool_record(ua->jcr, ua->db, &pr)) {
481 bstrncpy(pr.Name, "*UnknownPool*", sizeof(pr.Name));
483 mr.PoolId = jcr->jr.PoolId;
484 get_job_storage(&store, job, run);
485 mr.StorageId = store.store->StorageId;
486 if (!find_next_volume_for_append(jcr, &mr, 1, false/*no create*/)) {
487 bsendmsg(ua, _("Could not find next Volume for Job %s (%s, %s).\n"),
488 job->hdr.name, pr.Name, level_to_str(run->level));
491 _("The next Volume to be used by Job \"%s\" (%s, %s) will be %s\n"),
492 job->hdr.name, pr.Name, level_to_str(run->level), mr.VolumeName);
495 if (jcr->db && jcr->db != ua->db) {
496 db_close_database(jcr, jcr->db);
501 bsendmsg(ua, _("Could not find next Volume for Job %s.\n"),
510 * For a given job, we examine all his run records
511 * to see if it is scheduled today or tomorrow.
513 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime, int ndays)
515 time_t now, future, endtime;
518 int mday, wday, month, wom, i;
523 sched = job->schedule;
524 if (sched == NULL) { /* scheduled? */
525 return NULL; /* no nothing to report */
528 /* Break down the time into components */
530 endtime = now + (ndays * 60 * 60 * 24);
537 for ( ; run; run=run->next) {
539 * Find runs in next 24 hours. Day 0 is today, so if
540 * ndays=1, look at today and tomorrow.
542 for (day = 0; day <= ndays; day++) {
543 future = now + (day * 60 * 60 * 24);
545 /* Break down the time into components */
546 (void)localtime_r(&future, &tm);
547 mday = tm.tm_mday - 1;
551 woy = tm_woy(future);
553 is_scheduled = bit_is_set(mday, run->mday) && bit_is_set(wday, run->wday) &&
554 bit_is_set(month, run->month) && bit_is_set(wom, run->wom) &&
555 bit_is_set(woy, run->woy);
558 Dmsg2(000, "day=%d is_scheduled=%d\n", day, is_scheduled);
559 Dmsg1(000, "bit_set_mday=%d\n", bit_is_set(mday, run->mday));
560 Dmsg1(000, "bit_set_wday=%d\n", bit_is_set(wday, run->wday));
561 Dmsg1(000, "bit_set_month=%d\n", bit_is_set(month, run->month));
562 Dmsg1(000, "bit_set_wom=%d\n", bit_is_set(wom, run->wom));
563 Dmsg1(000, "bit_set_woy=%d\n", bit_is_set(woy, run->woy));
566 if (is_scheduled) { /* Jobs scheduled on that day */
568 char buf[300], num[10];
569 bsnprintf(buf, sizeof(buf), "tm.hour=%d hour=", tm.tm_hour);
570 for (i=0; i<24; i++) {
571 if (bit_is_set(i, run->hour)) {
572 bsnprintf(num, sizeof(num), "%d ", i);
573 bstrncat(buf, num, sizeof(buf));
576 bstrncat(buf, "\n", sizeof(buf));
577 Dmsg1(000, "%s", buf);
579 /* find time (time_t) job is to be run */
580 (void)localtime_r(&future, &runtm);
581 for (i= 0; i < 24; i++) {
582 if (bit_is_set(i, run->hour)) {
584 runtm.tm_min = run->minute;
586 runtime = mktime(&runtm);
587 Dmsg2(200, "now=%d runtime=%d\n", now, runtime);
588 if ((runtime > now) && (runtime < endtime)) {
589 Dmsg2(200, "Found it level=%d %c\n", run->level, run->level);
590 return run; /* found it, return run resource */
596 } /* end for loop over runs */
602 * Fill in the remaining fields of the jcr as if it
603 * is going to run the job.
605 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool)
609 memset(&pr, 0, sizeof(POOL_DBR));
610 set_jcr_defaults(jcr, job);
612 jcr->pool = pool; /* override */
615 db_close_database(jcr, jcr->db);
618 jcr->db = jcr->db=db_init_database(jcr, jcr->catalog->db_name, jcr->catalog->db_user,
619 jcr->catalog->db_password, jcr->catalog->db_address,
620 jcr->catalog->db_port, jcr->catalog->db_socket,
621 jcr->catalog->mult_db_connections);
622 if (!jcr->db || !db_open_database(jcr, jcr->db)) {
623 Jmsg(jcr, M_FATAL, 0, _("Could not open database \"%s\".\n"),
624 jcr->catalog->db_name);
626 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
627 db_close_database(jcr, jcr->db);
632 bstrncpy(pr.Name, jcr->pool->hdr.name, sizeof(pr.Name));
633 while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
634 /* Try to create the pool */
635 if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
636 Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
637 db_strerror(jcr->db));
639 db_close_database(jcr, jcr->db);
644 Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
647 jcr->jr.PoolId = pr.PoolId;
652 static void con_lock_release(void *arg)
657 void do_messages(UAContext *ua, const char *cmd)
661 bool do_truncate = false;
664 pthread_cleanup_push(con_lock_release, (void *)NULL);
666 while (fgets(msg, sizeof(msg), con_fd)) {
668 ua->UA_sock->msg = check_pool_memory_size(ua->UA_sock->msg, mlen+1);
669 strcpy(ua->UA_sock->msg, msg);
670 ua->UA_sock->msglen = mlen;
671 bnet_send(ua->UA_sock);
675 (void)ftruncate(fileno(con_fd), 0L);
677 console_msg_pending = FALSE;
678 ua->user_notified_msg_pending = FALSE;
679 pthread_cleanup_pop(0);
684 int qmessagescmd(UAContext *ua, const char *cmd)
686 if (console_msg_pending && ua->auto_display_messages) {
687 do_messages(ua, cmd);
692 int messagescmd(UAContext *ua, const char *cmd)
694 if (console_msg_pending) {
695 do_messages(ua, cmd);
697 bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
703 * Callback routine for "printing" database file listing
705 void prtit(void *ctx, const char *msg)
707 UAContext *ua = (UAContext *)ctx;
709 bnet_fsend(ua->UA_sock, "%s", msg);
713 * Format message and send to other end.
715 * If the UA_sock is NULL, it means that there is no user
716 * agent, so we are being called from Bacula core. In
717 * that case direct the messages to the Job.
719 void bsendmsg(void *ctx, const char *fmt, ...)
722 UAContext *ua = (UAContext *)ctx;
723 BSOCK *bs = ua->UA_sock;
730 msg = get_pool_memory(PM_EMSG);
734 maxlen = sizeof_pool_memory(msg) - 1;
735 va_start(arg_ptr, fmt);
736 len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
738 if (len < 0 || len >= maxlen) {
739 msg = realloc_pool_memory(msg, maxlen + maxlen/2);
747 } else { /* No UA, send to Job */
748 Jmsg(ua->jcr, M_INFO, 0, "%s", msg);
749 free_pool_memory(msg);