]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_output.c
Implement GZIP, new tape format, -- see kes03Jun02
[bacula/bacula] / 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 pthread_mutex_t con_mutex;
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;
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  *
190  */
191 int listcmd(UAContext *ua, char *cmd) 
192 {
193    POOLMEM *VolumeName;
194    int jobid, n;
195    int i, j;
196    JOB_DBR jr;
197    POOL_DBR pr;
198    MEDIA_DBR mr;
199
200    if (!open_db(ua))
201       return 1;
202
203    memset(&jr, 0, sizeof(jr));
204    memset(&pr, 0, sizeof(pr));
205    memset(&mr, 0, sizeof(mr));
206
207    Dmsg1(20, "list: %s\n", cmd);
208
209    if (!ua->db) {
210       bsendmsg(ua, _("Hey! DB is NULL\n"));
211    }
212
213    /* Scan arguments looking for things to do */
214    for (i=1; i<ua->argc; i++) {
215       /* List JOBS */
216       if (strcasecmp(ua->argk[i], _("jobs")) == 0) {
217          db_list_job_records(ua->db, &jr, prtit, ua);
218
219          /* List JOBTOTALS */
220       } else if (strcasecmp(ua->argk[i], _("jobtotals")) == 0) {
221          db_list_job_totals(ua->db, &jr, prtit, ua);
222
223       /* List JOBID */
224       } else if (strcasecmp(ua->argk[i], _("jobid")) == 0) {
225          if (ua->argv[i]) {
226             jobid = atoi(ua->argv[i]);
227             if (jobid > 0) {
228                jr.JobId = jobid;
229                db_list_job_records(ua->db, &jr, prtit, ua);
230             }
231          }
232
233       /* List JOB */
234       } else if (strcasecmp(ua->argk[i], _("job")) == 0 && ua->argv[i]) {
235          strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
236          jr.Job[MAX_NAME_LENGTH-1] = 0;
237          jr.JobId = 0;
238          db_list_job_records(ua->db, &jr, prtit, ua);
239
240       /* List FILES */
241       } else if (strcasecmp(ua->argk[i], _("files")) == 0) {
242
243          for (j=i+1; j<ua->argc; j++) {
244             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
245                strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
246                jr.Job[MAX_NAME_LENGTH-1] = 0;
247                jr.JobId = 0;
248                db_get_job_record(ua->db, &jr);
249                jobid = jr.JobId;
250             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
251                jobid = atoi(ua->argv[j]);
252             } else {
253                continue;
254             }
255             if (jobid > 0) {
256                db_list_files_for_job(ua->db, jobid, prtit, ua);
257             }
258          }
259       
260       /* List JOBMEDIA */
261       } else if (strcasecmp(ua->argk[i], _("jobmedia")) == 0) {
262          int done = FALSE;
263          for (j=i+1; j<ua->argc; j++) {
264             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
265                strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
266                jr.Job[MAX_NAME_LENGTH-1] = 0;
267                jr.JobId = 0;
268                db_get_job_record(ua->db, &jr);
269                jobid = jr.JobId;
270             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
271                jobid = atoi(ua->argv[j]);
272             } else {
273                continue;
274             }
275             db_list_jobmedia_records(ua->db, jobid, prtit, ua);
276             done = TRUE;
277          }
278          if (!done) {
279             /* List for all jobs (jobid=0) */
280             db_list_jobmedia_records(ua->db, 0, prtit, ua);
281          }
282
283       /* List POOLS */
284       } else if (strcasecmp(ua->argk[i], _("pools")) == 0) {
285          db_list_pool_records(ua->db, prtit, ua);
286
287       /* List MEDIA or VOLUMES */
288       } else if (strcasecmp(ua->argk[i], _("media")) == 0 ||
289                  strcasecmp(ua->argk[i], _("volumes")) == 0) {
290          int done = FALSE;
291          for (j=i+1; j<ua->argc; j++) {
292             if (strcasecmp(ua->argk[j], _("job")) == 0 && ua->argv[j]) {
293                strncpy(jr.Job, ua->argv[i], MAX_NAME_LENGTH);
294                jr.Job[MAX_NAME_LENGTH-1] = 0;
295                jr.JobId = 0;
296                db_get_job_record(ua->db, &jr);
297                jobid = jr.JobId;
298             } else if (strcasecmp(ua->argk[j], _("jobid")) == 0 && ua->argv[j]) {
299                jobid = atoi(ua->argv[j]);
300             } else {
301                continue;
302             }
303             VolumeName = get_pool_memory(PM_FNAME);
304             n = db_get_job_volume_names(ua->db, jobid, VolumeName);
305             bsendmsg(ua, _("Jobid %d used %d Volume(s): %s\n"), jobid, n, VolumeName);
306             free_memory(VolumeName);
307             done = TRUE;
308          }
309          /* if no job or jobid keyword found, then we list all media */
310          if (!done) {
311             if (!get_pool_dbr(ua, &pr)) {
312                return 1;
313             }
314             mr.PoolId = pr.PoolId;
315             db_list_media_records(ua->db, &mr, prtit, ua);
316          }
317       } else {
318          bsendmsg(ua, _("Unknown list keyword: %s\n"), ua->argk[i]);
319       }
320    }
321    return 1;
322 }
323
324 void do_messages(UAContext *ua, char *cmd)
325 {
326    char msg[2000];
327    int mlen; 
328
329    P(con_mutex);
330    rewind(con_fd);
331    while (fgets(msg, sizeof(msg), con_fd)) {
332       mlen = strlen(msg);
333       ua->UA_sock->msg = check_pool_memory_size(ua->UA_sock->msg, mlen+1);
334       strcpy(ua->UA_sock->msg, msg);
335       ua->UA_sock->msglen = mlen;
336       bnet_send(ua->UA_sock);
337    }
338    ftruncate(fileno(con_fd), 0L);
339    console_msg_pending = FALSE;
340    ua->user_notified_msg_pending = FALSE;
341    V(con_mutex);
342 }
343
344
345 int qmessagescmd(UAContext *ua, char *cmd)
346 {
347    if (console_msg_pending && ua->auto_display_messages) {
348       do_messages(ua, cmd);
349    }
350    return 1;
351 }
352
353 int messagescmd(UAContext *ua, char *cmd)
354 {
355    if (console_msg_pending) {
356       do_messages(ua, cmd);
357    } else {
358       bnet_fsend(ua->UA_sock, _("You have no messages.\n"));
359    }
360    return 1;
361 }
362
363 /*
364  * Callback routine for "printing" database file listing
365  */
366 void prtit(void *ctx, char *msg)
367 {
368    UAContext *ua = (UAContext *)ctx;
369  
370    bnet_fsend(ua->UA_sock, "%s", msg);
371 }
372
373 /* 
374  * Format message and send to other end.  
375
376  * If the UA_sock is NULL, it means that there is no user
377  * agent, so we are being called from Bacula core. In
378  * that case direct the messages to the Job.
379  */
380 void bsendmsg(void *ctx, char *fmt, ...)
381 {
382    va_list arg_ptr;
383    UAContext *ua = (UAContext *)ctx;
384    BSOCK *bs = ua->UA_sock;
385    int maxlen, len;
386    POOLMEM *msg;
387
388    if (bs) {
389       msg = bs->msg;
390    } else {
391       msg = get_pool_memory(PM_EMSG);
392    }
393
394 again:
395    maxlen = sizeof_pool_memory(msg) - 1;
396    va_start(arg_ptr, fmt);
397    len = bvsnprintf(msg, maxlen, fmt, arg_ptr);
398    va_end(arg_ptr);
399    if (len < 0 || len >= maxlen) {
400       msg = realloc_pool_memory(msg, maxlen + 200);
401       goto again;
402    }
403
404    if (bs) {
405       bs->msglen = len;
406       bnet_send(bs);
407    } else {                           /* No UA, send to Job */
408       Jmsg(ua->jcr, M_INFO, 0, msg);
409       free_pool_memory(msg);
410    }
411
412 }