3 * Bacula Director -- User Agent Output Commands
4 * I.e. messages, listing database, showing resources, ...
6 * Kern Sibbald, September MM
10 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
33 /* Imported subroutines */
34 extern void run_job(JCR *jcr);
36 /* Imported variables */
39 extern struct s_res resources[];
40 extern int console_msg_pending;
44 /* Imported functions */
46 /* Forward referenced functions */
50 * Turn auto display of console messages on/off
52 int autodisplaycmd(UAContext *ua, char *cmd)
59 switch (find_arg_keyword(ua, kw)) {
61 ua->auto_display_messages = 1;
64 ua->auto_display_messages = 0;
67 bsendmsg(ua, _("ON or OFF keyword missing.\n"));
74 struct showstruct {char *res_name; int type;};
75 static struct showstruct reses[] = {
76 {N_("directors"), R_DIRECTOR},
77 {N_("clients"), R_CLIENT},
79 {N_("storages"), R_STORAGE},
80 {N_("catalogs"), R_CATALOG},
81 {N_("schedules"), R_SCHEDULE},
82 {N_("filesets"), R_FILESET},
83 {N_("groups"), R_GROUP},
84 {N_("pools"), R_POOL},
85 {N_("messages"), R_MSGS},
96 * show <resource-keyword-name> e.g. show directors
97 * show <resource-keyword-name>=<name> e.g. show director=HeadMan
100 int showcmd(UAContext *ua, char *cmd)
107 Dmsg1(20, "show: %s\n", ua->UA_sock->msg);
110 for (i=1; i<ua->argc; i++) {
112 res_name = ua->argk[i];
113 if (!ua->argv[i]) { /* was a name given? */
114 /* No name, dump all resources of specified type */
116 len = strlen(res_name);
117 for (j=0; reses[j].res_name; j++) {
118 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
119 type = reses[j].type;
121 res = resources[type-r_first].res_head;
129 /* Dump a single resource with specified name */
131 len = strlen(res_name);
132 for (j=0; reses[j].res_name; j++) {
133 if (strncasecmp(res_name, _(reses[j].res_name), len) == 0) {
134 type = reses[j].type;
135 res = (RES *)GetResWithName(type, ua->argv[i]);
146 for (j=r_first; j<=r_last; j++) {
147 dump_resource(j, resources[j-r_first].res_head, bsendmsg, ua);
151 bsendmsg(ua, _("Keywords for the show command are:\n"));
152 for (j=0; reses[j].res_name; j++) {
153 bsendmsg(ua, "%s\n", _(reses[j].res_name));
157 bsendmsg(ua, _("%s resource %s not found.\n"), res_name, ua->argv[i]);
160 bsendmsg(ua, _("Resource %s not found\n"), res_name);
163 dump_resource(recurse?type:-type, res, bsendmsg, ua);
174 * List contents of database
176 * list jobs - lists all jobs run
177 * list jobid=nnn - list job data for jobid
178 * list job=name - list job data for job
179 * list jobmedia jobid=<nn>
180 * list jobmedia job=name
181 * list files jobid=<nn> - list files saved for job nn
182 * list files job=name
183 * list pools - list pool records
184 * list jobtotals - list totals for all jobs
185 * list media - list media for given pool
188 int listcmd(UAContext *ua, char *cmd)
200 memset(&jr, 0, sizeof(jr));
201 memset(&pr, 0, sizeof(pr));
202 memset(&mr, 0, sizeof(mr));
204 Dmsg1(20, "list: %s\n", cmd);
207 bsendmsg(ua, _("Hey! DB is NULL\n"));
210 /* Scan arguments looking for things to do */
211 for (i=1; i<ua->argc; i++) {
213 if (strcasecmp(ua->argk[i], _("jobs")) == 0) {
214 db_list_job_records(ua->db, &jr, prtit, ua);
217 } else if (strcasecmp(ua->argk[i], _("jobtotals")) == 0) {
218 db_list_job_totals(ua->db, &jr, prtit, ua);
221 } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
223 jobid = atoi(ua->argv[i]);
226 db_list_job_records(ua->db, &jr, prtit, ua);
231 } else if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
232 strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
233 jr.Job[MAX_NAME_LENGTH-1] = 0;
235 db_list_job_records(ua->db, &jr, prtit, ua);
238 } else if (strcasecmp(ua->argk[i], _("files")) == 0) {
240 for (j=i+1; j<ua->argc; j++) {
241 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
242 strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
243 jr.Job[MAX_NAME_LENGTH-1] = 0;
245 db_get_job_record(ua->db, &jr);
247 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
248 jobid = atoi(ua->argv[j]);
253 db_list_files_for_job(ua->db, jobid, prtit, ua);
258 } else if (strcasecmp(ua->argk[i], _("jobmedia")) == 0) {
260 for (j=i+1; j<ua->argc; j++) {
261 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
262 strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
263 jr.Job[MAX_NAME_LENGTH-1] = 0;
265 db_get_job_record(ua->db, &jr);
267 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
268 jobid = atoi(ua->argv[j]);
272 db_list_jobmedia_records(ua->db, jobid, prtit, ua);
276 /* List for all jobs (jobid=0) */
277 db_list_jobmedia_records(ua->db, 0, prtit, ua);
281 } else if (strcasecmp(ua->argk[i], _("pools")) == 0) {
282 db_list_pool_records(ua->db, prtit, ua);
285 } else if (strcasecmp(ua->argk[i], _("media")) == 0) {
287 for (j=i+1; j<ua->argc; j++) {
288 if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
289 strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
290 jr.Job[MAX_NAME_LENGTH-1] = 0;
292 db_get_job_record(ua->db, &jr);
294 } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
295 jobid = atoi(ua->argv[j]);
299 VolumeName = (char *) get_pool_memory(PM_FNAME);
300 n = db_get_job_volume_names(ua->db, jobid, VolumeName);
301 bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
302 free_memory(VolumeName);
305 /* if no job or jobid keyword found, then we list all media */
307 if (!get_pool_dbr(ua, &pr)) {
310 mr.PoolId = pr.PoolId;
311 db_list_media_records(ua->db, &mr, prtit, ua);
314 bsendmsg(ua, _("Unknown list keyword: %s\n"), ua->argk[i]);
320 void do_messages(UAContext *ua, char *cmd)
325 fcntl(fileno(con_fd), F_SETLKW);
327 while (fgets(msg, sizeof(msg), con_fd)) {
329 ua->UA_sock->msg = (char *) check_pool_memory_size(
330 ua->UA_sock->msg, mlen+1);
331 strcpy(ua->UA_sock->msg, msg);
332 ua->UA_sock->msglen = mlen;
333 bnet_send(ua->UA_sock);
335 ftruncate(fileno(con_fd), 0L);
336 console_msg_pending = FALSE;
337 fcntl(fileno(con_fd), F_UNLCK);
338 ua->user_notified_msg_pending = FALSE;
342 int qmessagescmd(UAContext *ua, char *cmd)
344 if (console_msg_pending && ua->auto_display_messages) {
345 do_messages(ua, cmd);
350 int messagescmd(UAContext *ua, char *cmd)
352 if (console_msg_pending) {
353 do_messages(ua, cmd);
355 bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
361 * Callback routine for "printing" database file listing
363 void prtit(void *ctx, char *msg)
365 UAContext *ua = (UAContext *)ctx;
367 bnet_fsend(ua->UA_sock, "%s", msg);
371 * Format message and send to other end.
373 * If the UA_sock is NULL, it means that there is no user
374 * agent, so we are being called from Bacula core. In
375 * that case direct the messages to the Job.
377 void bsendmsg(void *ctx, char *fmt, ...)
380 UAContext *ua = (UAContext *)ctx;
381 BSOCK *bs = ua->UA_sock;
388 msg = (char *)get_pool_memory(PM_EMSG);
392 maxlen = sizeof_pool_memory(msg) - 1;
393 va_start(arg_ptr, fmt);
394 len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
396 if (len < 0 || len >= maxlen) {
397 msg = (char *) realloc_pool_memory(msg, maxlen + 200);
404 } else { /* No UA, send to Job */
405 Jmsg(ua->jcr, M_INFO, 0, msg);