3 * Bacula Director -- User Agent Commands
4 * These are "dot" commands, i.e. commands preceded
5 * by a period. These commands are meant to be used
6 * by a program, so there is no prompting, and the
7 * returned results are (supposed to be) predictable.
9 * Kern Sibbald, April MMII
15 Copyright (C) 2002-2004 Kern Sibbald and John Walker
17 This program is free software; you can redistribute it and/or
18 modify it under the terms of the GNU General Public License as
19 published by the Free Software Foundation; either version 2 of
20 the License, or (at your option) any later version.
22 This program is distributed in the hope that it will be useful,
23 but WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 General Public License for more details.
27 You should have received a copy of the GNU General Public
28 License along with this program; if not, write to the Free
29 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /* Imported variables */
40 extern struct s_res resources[];
41 extern char my_name[];
42 extern const char *client_backups;
44 /* Imported functions */
45 extern int qmessagescmd(UAContext *ua, const char *cmd);
46 extern int quit_cmd(UAContext *ua, const char *cmd);
47 extern int qhelp_cmd(UAContext *ua, const char *cmd);
48 extern int qstatus_cmd(UAContext *ua, const char *cmd);
50 /* Forward referenced functions */
51 static int diecmd(UAContext *ua, const char *cmd);
52 static int jobscmd(UAContext *ua, const char *cmd);
53 static int filesetscmd(UAContext *ua, const char *cmd);
54 static int clientscmd(UAContext *ua, const char *cmd);
55 static int msgscmd(UAContext *ua, const char *cmd);
56 static int poolscmd(UAContext *ua, const char *cmd);
57 static int storagecmd(UAContext *ua, const char *cmd);
58 static int defaultscmd(UAContext *ua, const char *cmd);
59 static int typescmd(UAContext *ua, const char *cmd);
60 static int backupscmd(UAContext *ua, const char *cmd);
61 static int levelscmd(UAContext *ua, const char *cmd);
63 struct cmdstruct { const char *key; int (*func)(UAContext *ua, const char *cmd); const char *help; };
64 static struct cmdstruct commands[] = {
65 { N_(".die"), diecmd, NULL},
66 { N_(".jobs"), jobscmd, NULL},
67 { N_(".filesets"), filesetscmd, NULL},
68 { N_(".clients"), clientscmd, NULL},
69 { N_(".msgs"), msgscmd, NULL},
70 { N_(".pools"), poolscmd, NULL},
71 { N_(".types"), typescmd, NULL},
72 { N_(".backups"), backupscmd, NULL},
73 { N_(".levels"), levelscmd, NULL},
74 { N_(".status"), qstatus_cmd, NULL},
75 { N_(".storage"), storagecmd, NULL},
76 { N_(".defaults"), defaultscmd, NULL},
77 { N_(".messages"), qmessagescmd, NULL},
78 { N_(".help"), qhelp_cmd, NULL},
79 { N_(".quit"), quit_cmd, NULL},
80 { N_(".exit"), quit_cmd, NULL}
82 #define comsize (sizeof(commands)/sizeof(struct cmdstruct))
85 * Execute a command from the UA
87 int do_a_dot_command(UAContext *ua, const char *cmd)
95 Dmsg1(400, "Dot command: %s\n", ua->UA_sock->msg);
100 len = strlen(ua->argk[0]);
102 return 1; /* no op */
104 for (i=0; i<(int)comsize; i++) { /* search for command */
105 if (strncasecmp(ua->argk[0], _(commands[i].key), len) == 0) {
106 stat = (*commands[i].func)(ua, cmd); /* go execute command */
112 pm_strcat(ua->UA_sock->msg, _(": is an illegal command\n"));
113 ua->UA_sock->msglen = strlen(ua->UA_sock->msg);
114 bnet_send(ua->UA_sock);
120 * Create segmentation fault
122 static int diecmd(UAContext *ua, const char *cmd)
127 bsendmsg(ua, "The Director will segment fault.\n");
128 a = jcr->JobId; /* ref NULL pointer */
129 jcr->JobId = 1000; /* another ref NULL pointer */
133 static int jobscmd(UAContext *ua, const char *cmd)
137 while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
138 bsendmsg(ua, "%s\n", job->hdr.name);
144 static int filesetscmd(UAContext *ua, const char *cmd)
148 while ( (fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs)) ) {
149 bsendmsg(ua, "%s\n", fs->hdr.name);
155 static int clientscmd(UAContext *ua, const char *cmd)
157 CLIENT *client = NULL;
159 while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
160 bsendmsg(ua, "%s\n", client->hdr.name);
166 static int msgscmd(UAContext *ua, const char *cmd)
170 while ( (msgs = (MSGS *)GetNextRes(R_MSGS, (RES *)msgs)) ) {
171 bsendmsg(ua, "%s\n", msgs->hdr.name);
177 static int poolscmd(UAContext *ua, const char *cmd)
181 while ( (pool = (POOL *)GetNextRes(R_POOL, (RES *)pool)) ) {
182 bsendmsg(ua, "%s\n", pool->hdr.name);
188 static int storagecmd(UAContext *ua, const char *cmd)
192 while ( (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)) ) {
193 bsendmsg(ua, "%s\n", store->hdr.name);
200 static int typescmd(UAContext *ua, const char *cmd)
202 bsendmsg(ua, "Backup\n");
203 bsendmsg(ua, "Restore\n");
204 bsendmsg(ua, "Admin\n");
205 bsendmsg(ua, "Verify\n");
209 static int client_backups_handler(void *ctx, int num_field, char **row)
211 UAContext *ua = (UAContext *)ctx;
212 bsendmsg(ua, "| %s | %s | %s | %s | %s | %s | %s |\n",
213 row[0], row[1], row[2], row[3], row[4], row[5], row[6], row[7]);
217 static int backupscmd(UAContext *ua, const char *cmd)
222 if (ua->argc == 2 && strcmp(ua->argk[1], "client") != 0) {
225 Mmsg(ua->cmd, client_backups, ua->argv[1]);
226 if (!db_sql_query(ua->db, ua->cmd, client_backups_handler, (void *)ua)) {
227 bsendmsg(ua, _("Query failed: %s. ERR=%s\n"), ua->cmd, db_strerror(ua->db));
234 static int levelscmd(UAContext *ua, const char *cmd)
236 bsendmsg(ua, "Incremental\n");
237 bsendmsg(ua, "Full\n");
238 bsendmsg(ua, "Differential\n");
239 bsendmsg(ua, "Catalog\n");
240 bsendmsg(ua, "InitCatalog\n");
241 bsendmsg(ua, "VolumeToCatalog\n");
248 * Return default values for a job
250 static int defaultscmd(UAContext *ua, const char *cmd)
253 if (ua->argc == 2 && strcmp(ua->argk[1], "job") == 0) {
254 job = (JOB *)GetResWithName(R_JOB, ua->argv[1]);
257 bsendmsg(ua, "job=%s", job->hdr.name);
258 bsendmsg(ua, "pool=%s", job->pool->hdr.name);
259 bsendmsg(ua, "messages=%s", job->messages->hdr.name);
260 bsendmsg(ua, "client=%s", job->client->hdr.name);
261 store = (STORE *)job->storage[0]->first();
262 bsendmsg(ua, "storage=%s", store->hdr.name);
263 bsendmsg(ua, "where=%s", job->RestoreWhere?job->RestoreWhere:"");
264 bsendmsg(ua, "level=%s", level_to_str(job->JobLevel));
265 bsendmsg(ua, "type=%s", job_type_to_str(job->JobType));
266 bsendmsg(ua, "fileset=%s", job->fileset->hdr.name);