/*
- *
- * Bacula Director -- User Agent Commands
- * These are "dot" commands, i.e. commands preceded
- * by a period. These commands are meant to be used
- * by a program, so there is no prompting, and the
- * returned results are (supposed to be) predictable.
- *
- * Kern Sibbald, April MMII
- *
- * Version $Id$
- */
+ Bacula® - The Network Backup Solution
-/*
- Copyright (C) 2002 Kern Sibbald and John Walker
+ Copyright (C) 2002-2007 Free Software Foundation Europe e.V.
- This program is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License as
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
+ The main author of Bacula is Kern Sibbald, with contributions from
+ many others, a complete list can be found in the file AUTHORS.
+ This program is Free Software; you can redistribute it and/or
+ modify it under the terms of version two of the GNU General Public
+ License as published by the Free Software Foundation plus additions
+ that are listed in the file LICENSE.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
- You should have received a copy of the GNU General Public
- License along with this program; if not, write to the Free
- Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- MA 02111-1307, USA.
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+ Bacula® is a registered trademark of John Walker.
+ The licensor of Bacula is the Free Software Foundation Europe
+ (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+ Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ *
+ * Bacula Director -- User Agent Commands
+ * These are "dot" commands, i.e. commands preceded
+ * by a period. These commands are meant to be used
+ * by a program, so there is no prompting, and the
+ * returned results are (supposed to be) predictable.
+ *
+ * Kern Sibbald, April MMII
+ *
+ * Version $Id$
*/
#include "bacula.h"
extern int r_first;
extern int r_last;
extern struct s_res resources[];
-extern char my_name[];
/* Imported functions */
-extern int qmessagescmd(UAContext *ua, char *cmd);
-extern int quit_cmd(UAContext *ua, char *cmd);
+extern void do_messages(UAContext *ua, const char *cmd);
+extern int quit_cmd(UAContext *ua, const char *cmd);
+extern int qhelp_cmd(UAContext *ua, const char *cmd);
+extern bool dot_status_cmd(UAContext *ua, const char *cmd);
+
/* Forward referenced functions */
-static int diecmd(UAContext *ua, char *cmd);
-static int jobscmd(UAContext *ua, char *cmd);
-static int filesetscmd(UAContext *ua, char *cmd);
-static int clientscmd(UAContext *ua, char *cmd);
-static int msgscmd(UAContext *ua, char *cmd);
-static int poolscmd(UAContext *ua, char *cmd);
-static int storagecmd(UAContext *ua, char *cmd);
-static int defaultscmd(UAContext *ua, char *cmd);
-static int typescmd(UAContext *ua, char *cmd);
-static int levelscmd(UAContext *ua, char *cmd);
-
-struct cmdstruct { char *key; int (*func)(UAContext *ua, char *cmd); char *help; };
+static bool diecmd(UAContext *ua, const char *cmd);
+static bool jobscmd(UAContext *ua, const char *cmd);
+static bool filesetscmd(UAContext *ua, const char *cmd);
+static bool clientscmd(UAContext *ua, const char *cmd);
+static bool msgscmd(UAContext *ua, const char *cmd);
+static bool poolscmd(UAContext *ua, const char *cmd);
+static bool storagecmd(UAContext *ua, const char *cmd);
+static bool defaultscmd(UAContext *ua, const char *cmd);
+static bool typescmd(UAContext *ua, const char *cmd);
+static bool backupscmd(UAContext *ua, const char *cmd);
+static bool levelscmd(UAContext *ua, const char *cmd);
+static bool getmsgscmd(UAContext *ua, const char *cmd);
+
+static bool api_cmd(UAContext *ua, const char *cmd);
+static bool sql_cmd(UAContext *ua, const char *cmd);
+static bool dot_quit_cmd(UAContext *ua, const char *cmd);
+static bool dot_help_cmd(UAContext *ua, const char *cmd);
+
+struct cmdstruct { const char *key; bool (*func)(UAContext *ua, const char *cmd); const char *help; };
static struct cmdstruct commands[] = {
- { N_(".die"), diecmd, NULL},
- { N_(".jobs"), jobscmd, NULL},
- { N_(".filesets"), filesetscmd, NULL},
- { N_(".clients"), clientscmd, NULL},
- { N_(".msgs"), msgscmd, NULL},
- { N_(".pools"), poolscmd, NULL},
- { N_(".types"), typescmd, NULL},
- { N_(".levels"), levelscmd, NULL},
- { N_(".storage"), storagecmd, NULL},
- { N_(".defaults"), defaultscmd, NULL},
- { N_(".messages"), qmessagescmd, NULL},
- { N_(".quit"), quit_cmd, NULL},
- { N_(".exit"), quit_cmd, NULL}
- };
-#define comsize (sizeof(commands)/sizeof(struct cmdstruct))
+ { NT_(".api"), api_cmd, NULL},
+ { NT_(".backups"), backupscmd, NULL},
+ { NT_(".clients"), clientscmd, NULL},
+ { NT_(".defaults"), defaultscmd, NULL},
+ { NT_(".die"), diecmd, NULL},
+ { NT_(".exit"), dot_quit_cmd, NULL},
+ { NT_(".filesets"), filesetscmd, NULL},
+ { NT_(".help"), dot_help_cmd, NULL},
+ { NT_(".jobs"), jobscmd, NULL},
+ { NT_(".levels"), levelscmd, NULL},
+ { NT_(".messages"), getmsgscmd, NULL},
+ { NT_(".msgs"), msgscmd, NULL},
+ { NT_(".pools"), poolscmd, NULL},
+ { NT_(".quit"), dot_quit_cmd, NULL},
+ { NT_(".sql"), sql_cmd, NULL},
+ { NT_(".status"), dot_status_cmd, NULL},
+ { NT_(".storage"), storagecmd, NULL},
+ { NT_(".types"), typescmd, NULL}
+ };
+#define comsize ((int)(sizeof(commands)/sizeof(struct cmdstruct)))
/*
* Execute a command from the UA
*/
-int do_a_dot_command(UAContext *ua, char *cmd)
+int do_a_dot_command(UAContext *ua, const char *cmd)
{
int i;
- int len, stat;
+ int len;
+ bool ok = false;
bool found = false;
+ BSOCK *user = ua->UA_sock;
- stat = 1;
-
- Dmsg1(400, "Dot command: %s\n", ua->UA_sock->msg);
+ Dmsg1(1400, "Dot command: %s\n", user->msg);
if (ua->argc == 0) {
return 1;
}
len = strlen(ua->argk[0]);
if (len == 1) {
- return 1; /* no op */
+ if (ua->api) user->signal(BNET_CMD_BEGIN);
+ if (ua->api) user->signal(BNET_CMD_OK);
+ return 1; /* no op */
}
- for (i=0; i<(int)comsize; i++) { /* search for command */
+ for (i=0; i<comsize; i++) { /* search for command */
if (strncasecmp(ua->argk[0], _(commands[i].key), len) == 0) {
- stat = (*commands[i].func)(ua, cmd); /* go execute command */
- found = true;
- break;
+ bool gui = ua->gui;
+ /* Check if command permitted, but "quit" is always OK */
+ if (strcmp(ua->argk[0], NT_(".quit")) != 0 &&
+ !acl_access_ok(ua, Command_ACL, ua->argk[0], len)) {
+ break;
+ }
+ ua->gui = true;
+ if (ua->api) user->signal(BNET_CMD_BEGIN);
+ ok = (*commands[i].func)(ua, cmd); /* go execute command */
+ ua->gui = gui;
+ found = true;
+ break;
}
}
if (!found) {
- pm_strcat(&ua->UA_sock->msg, _(": is an illegal command\n"));
- ua->UA_sock->msglen = strlen(ua->UA_sock->msg);
- bnet_send(ua->UA_sock);
+ pm_strcat(user->msg, _(": is an invalid command.\n"));
+ user->msglen = strlen(user->msg);
+ user->send();
+ }
+ if (ua->api) user->signal(ok?BNET_CMD_OK:BNET_CMD_FAILED);
+ return 1;
+}
+
+static bool dot_quit_cmd(UAContext *ua, const char *cmd)
+{
+ quit_cmd(ua, cmd);
+ return true;
+}
+
+static bool dot_help_cmd(UAContext *ua, const char *cmd)
+{
+ qhelp_cmd(ua, cmd);
+ return true;
+}
+
+static bool getmsgscmd(UAContext *ua, const char *cmd)
+{
+ if (console_msg_pending) {
+ do_messages(ua, cmd);
}
- return stat;
+ return 1;
}
/*
- * Create segmentation fault
+ * Create segmentation fault
*/
-static int diecmd(UAContext *ua, char *cmd)
+static bool diecmd(UAContext *ua, const char *cmd)
{
JCR *jcr = NULL;
int a;
-
- bsendmsg(ua, "The Director will segment fault.\n");
+
+ ua->send_msg(_("The Director will segment fault.\n"));
a = jcr->JobId; /* ref NULL pointer */
jcr->JobId = 1000; /* another ref NULL pointer */
- return 0;
+ return true;
}
-static int jobscmd(UAContext *ua, char *cmd)
+static bool jobscmd(UAContext *ua, const char *cmd)
{
- JOB *job = NULL;
+ JOB *job;
LockRes();
- while ( (job = (JOB *)GetNextRes(R_JOB, (RES *)job)) ) {
- bsendmsg(ua, "%s\n", job->hdr.name);
+ foreach_res(job, R_JOB) {
+ if (acl_access_ok(ua, Job_ACL, job->name())) {
+ ua->send_msg("%s\n", job->name());
+ }
}
UnlockRes();
- return 1;
+ return true;
}
-static int filesetscmd(UAContext *ua, char *cmd)
+static bool filesetscmd(UAContext *ua, const char *cmd)
{
- FILESET *fs = NULL;
+ FILESET *fs;
LockRes();
- while ( (fs = (FILESET *)GetNextRes(R_FILESET, (RES *)fs)) ) {
- bsendmsg(ua, "%s\n", fs->hdr.name);
+ foreach_res(fs, R_FILESET) {
+ if (acl_access_ok(ua, FileSet_ACL, fs->name())) {
+ ua->send_msg("%s\n", fs->name());
+ }
}
UnlockRes();
- return 1;
+ return true;
}
-static int clientscmd(UAContext *ua, char *cmd)
+static bool clientscmd(UAContext *ua, const char *cmd)
{
- CLIENT *client = NULL;
+ CLIENT *client;
LockRes();
- while ( (client = (CLIENT *)GetNextRes(R_CLIENT, (RES *)client)) ) {
- bsendmsg(ua, "%s\n", client->hdr.name);
+ foreach_res(client, R_CLIENT) {
+ if (acl_access_ok(ua, Client_ACL, client->name())) {
+ ua->send_msg("%s\n", client->name());
+ }
}
UnlockRes();
- return 1;
+ return true;
}
-static int msgscmd(UAContext *ua, char *cmd)
+static bool msgscmd(UAContext *ua, const char *cmd)
{
MSGS *msgs = NULL;
LockRes();
- while ( (msgs = (MSGS *)GetNextRes(R_MSGS, (RES *)msgs)) ) {
- bsendmsg(ua, "%s\n", msgs->hdr.name);
+ foreach_res(msgs, R_MSGS) {
+ ua->send_msg("%s\n", msgs->name());
}
UnlockRes();
- return 1;
+ return true;
}
-static int poolscmd(UAContext *ua, char *cmd)
+static bool poolscmd(UAContext *ua, const char *cmd)
{
- POOL *pool = NULL;
+ POOL *pool;
LockRes();
- while ( (pool = (POOL *)GetNextRes(R_POOL, (RES *)pool)) ) {
- bsendmsg(ua, "%s\n", pool->hdr.name);
+ foreach_res(pool, R_POOL) {
+ if (acl_access_ok(ua, Pool_ACL, pool->name())) {
+ ua->send_msg("%s\n", pool->name());
+ }
}
UnlockRes();
- return 1;
+ return true;
}
-static int storagecmd(UAContext *ua, char *cmd)
+static bool storagecmd(UAContext *ua, const char *cmd)
{
- STORE *store = NULL;
+ STORE *store;
LockRes();
- while ( (store = (STORE *)GetNextRes(R_STORAGE, (RES *)store)) ) {
- bsendmsg(ua, "%s\n", store->hdr.name);
+ foreach_res(store, R_STORAGE) {
+ if (acl_access_ok(ua, Storage_ACL, store->name())) {
+ ua->send_msg("%s\n", store->name());
+ }
}
UnlockRes();
- return 1;
+ return true;
}
-static int typescmd(UAContext *ua, char *cmd)
+static bool typescmd(UAContext *ua, const char *cmd)
{
- bsendmsg(ua, "Backup\n");
- bsendmsg(ua, "Restore\n");
- bsendmsg(ua, "Admin\n");
- bsendmsg(ua, "Verify\n");
- return 1;
+ ua->send_msg("Backup\n");
+ ua->send_msg("Restore\n");
+ ua->send_msg("Admin\n");
+ ua->send_msg("Verify\n");
+ ua->send_msg("Migrate\n");
+ return true;
}
-static int levelscmd(UAContext *ua, char *cmd)
+
+/*
+ * If this command is called, it tells the director that we
+ * are a program that wants a sort of API, and hence,
+ * we will probably suppress certain output, include more
+ * error codes, and most of all send back a good number
+ * of new signals that indicate whether or not the command
+ * succeeded.
+ */
+static bool api_cmd(UAContext *ua, const char *cmd)
{
- bsendmsg(ua, "Incremental\n");
- bsendmsg(ua, "Full\n");
- bsendmsg(ua, "Differential\n");
- bsendmsg(ua, "Catalog\n");
- bsendmsg(ua, "InitCatalog\n");
- bsendmsg(ua, "VolumeToCatalog\n");
- return 1;
+ if (ua->argc == 2) {
+ ua->api = atoi(ua->argk[1]);
+ } else {
+ ua->api = 1;
+ }
+ return true;
+}
+
+static int client_backups_handler(void *ctx, int num_field, char **row)
+{
+ UAContext *ua = (UAContext *)ctx;
+ ua->send_msg("| %s | %s | %s | %s | %s | %s | %s | %s |\n",
+ row[0], row[1], row[2], row[3], row[4], row[5], row[6], row[7], row[8]);
+ return 0;
+}
+
+/*
+ * Return the backups for this client
+ *
+ * .backups client=xxx fileset=yyy
+ *
+ */
+static bool backupscmd(UAContext *ua, const char *cmd)
+{
+ if (!open_client_db(ua)) {
+ return true;
+ }
+ if (ua->argc != 3 || strcmp(ua->argk[1], "client") != 0 ||
+ strcmp(ua->argk[2], "fileset") != 0) {
+ return true;
+ }
+ if (!acl_access_ok(ua, Client_ACL, ua->argv[1]) ||
+ !acl_access_ok(ua, FileSet_ACL, ua->argv[2])) {
+ ua->error_msg(_("Access to specified Client or FileSet not allowed.\n"));
+ return true;
+ }
+ Mmsg(ua->cmd, client_backups, ua->argv[1], ua->argv[2]);
+ if (!db_sql_query(ua->db, ua->cmd, client_backups_handler, (void *)ua)) {
+ ua->error_msg(_("Query failed: %s. ERR=%s\n"), ua->cmd, db_strerror(ua->db));
+ return true;
+ }
+ return true;
}
+static int sql_handler(void *ctx, int num_field, char **row)
+{
+ UAContext *ua = (UAContext *)ctx;
+ POOL_MEM rows(PM_MESSAGE);
+ for (int i=0; num_field--; i++) {
+ if (i == 0) {
+ pm_strcpy(rows, row[0]);
+ } else {
+ pm_strcat(rows, row[i]);
+ }
+ pm_strcat(rows, "\t");
+ }
+ ua->send_msg(rows.c_str());
+ return 0;
+}
+
+static bool sql_cmd(UAContext *ua, const char *cmd)
+{
+ int index;
+ if (!open_client_db(ua)) {
+ return true;
+ }
+ index = find_arg_with_value(ua, "query");
+ if (index < 0) {
+ ua->error_msg(_("query keyword not found.\n"));
+ return true;
+ }
+ if (!db_sql_query(ua->db, ua->argv[index], sql_handler, (void *)ua)) {
+ Dmsg1(100, "Query failed: ERR=%s\n", db_strerror(ua->db));
+ ua->error_msg(_("Query failed: %s. ERR=%s\n"), ua->cmd, db_strerror(ua->db));
+ return true;
+ }
+ return true;
+}
+
+
+
+static bool levelscmd(UAContext *ua, const char *cmd)
+{
+ ua->send_msg("Incremental\n");
+ ua->send_msg("Full\n");
+ ua->send_msg("Differential\n");
+ ua->send_msg("Catalog\n");
+ ua->send_msg("InitCatalog\n");
+ ua->send_msg("VolumeToCatalog\n");
+ return true;
+}
/*
* Return default values for a job
*/
-static int defaultscmd(UAContext *ua, char *cmd)
+static bool defaultscmd(UAContext *ua, const char *cmd)
{
- JOB *job;
- if (ua->argc == 2 && strcmp(ua->argk[1], "job") == 0) {
+ JOB *job;
+ CLIENT *client;
+ STORE *storage;
+ POOL *pool;
+ char ed1[50];
+
+ if (ua->argc != 2 || !ua->argv[1]) {
+ return true;
+ }
+
+ /* Job defaults */
+ if (strcmp(ua->argk[1], "job") == 0) {
+ if (!acl_access_ok(ua, Job_ACL, ua->argv[1])) {
+ return true;
+ }
job = (JOB *)GetResWithName(R_JOB, ua->argv[1]);
if (job) {
- bsendmsg(ua, "job=%s", job->hdr.name);
- bsendmsg(ua, "pool=%s", job->pool->hdr.name);
- bsendmsg(ua, "messages=%s", job->messages->hdr.name);
- bsendmsg(ua, "client=%s", job->client->hdr.name);
- bsendmsg(ua, "storage=%s", job->storage->hdr.name);
- bsendmsg(ua, "where=%s", job->RestoreWhere?job->RestoreWhere:"");
- bsendmsg(ua, "level=%s", level_to_str(job->level));
- bsendmsg(ua, "type=%s", job_type_to_str(job->JobType));
- bsendmsg(ua, "fileset=%s", job->fileset->hdr.name);
+ USTORE store;
+ ua->send_msg("job=%s", job->name());
+ ua->send_msg("pool=%s", job->pool->name());
+ ua->send_msg("messages=%s", job->messages->name());
+ ua->send_msg("client=%s", job->client->name());
+ get_job_storage(&store, job, NULL);
+ ua->send_msg("storage=%s", store.store->name());
+ ua->send_msg("where=%s", job->RestoreWhere?job->RestoreWhere:"");
+ ua->send_msg("level=%s", level_to_str(job->JobLevel));
+ ua->send_msg("type=%s", job_type_to_str(job->JobType));
+ ua->send_msg("fileset=%s", job->fileset->name());
+ ua->send_msg("enabled=%d", job->enabled);
+ ua->send_msg("catalog=%s", job->client->catalog->name());
+ }
+ }
+ /* Client defaults */
+ else if (strcmp(ua->argk[1], "client") == 0) {
+ if (!acl_access_ok(ua, Client_ACL, ua->argv[1])) {
+ return true;
+ }
+ client = (CLIENT *)GetResWithName(R_CLIENT, ua->argv[1]);
+ if (client) {
+ ua->send_msg("client=%s", client->name());
+ ua->send_msg("address=%s", client->address);
+ ua->send_msg("fdport=%d", client->FDport);
+ ua->send_msg("file_retention=%s", edit_uint64(client->FileRetention, ed1));
+ ua->send_msg("job_retention=%s", edit_uint64(client->JobRetention, ed1));
+ ua->send_msg("autoprune=%d", client->AutoPrune);
+ ua->send_msg("catalog=%s", client->catalog->name());
}
}
- return 1;
+ /* Storage defaults */
+ else if (strcmp(ua->argk[1], "storage") == 0) {
+ if (!acl_access_ok(ua, Storage_ACL, ua->argv[1])) {
+ return true;
+ }
+ storage = (STORE *)GetResWithName(R_STORAGE, ua->argv[1]);
+ DEVICE *device;
+ if (storage) {
+ ua->send_msg("storage=%s", storage->name());
+ ua->send_msg("address=%s", storage->address);
+ ua->send_msg("enabled=%d", storage->enabled);
+ ua->send_msg("media_type=%s", storage->media_type);
+ ua->send_msg("sdport=%d", storage->SDport);
+ device = (DEVICE *)storage->device->first();
+ ua->send_msg("device=%s", device->name());
+ if (storage->device->size() > 1) {
+ while ((device = (DEVICE *)storage->device->next())) {
+ ua->send_msg(",%s", device->name());
+ }
+ }
+ }
+ }
+ /* Pool defaults */
+ else if (strcmp(ua->argk[1], "pool") == 0) {
+ if (!acl_access_ok(ua, Pool_ACL, ua->argv[1])) {
+ return true;
+ }
+ pool = (POOL *)GetResWithName(R_POOL, ua->argv[1]);
+ if (pool) {
+ ua->send_msg("pool=%s", pool->name());
+ ua->send_msg("pool_type=%s", pool->pool_type);
+ ua->send_msg("label_format=%s", pool->label_format?pool->label_format:"");
+ ua->send_msg("use_volume_once=%d", pool->use_volume_once);
+ ua->send_msg("purge_oldest_volume=%d", pool->purge_oldest_volume);
+ ua->send_msg("recycle_oldest_volume=%d", pool->recycle_oldest_volume);
+ ua->send_msg("recycle_current_volume=%d", pool->recycle_current_volume);
+ ua->send_msg("max_volumes=%d", pool->max_volumes);
+ ua->send_msg("vol_retention=%s", edit_uint64(pool->VolRetention, ed1));
+ ua->send_msg("vol_use_duration=%s", edit_uint64(pool->VolUseDuration, ed1));
+ ua->send_msg("max_vol_jobs=%d", pool->MaxVolJobs);
+ ua->send_msg("max_vol_files=%d", pool->MaxVolFiles);
+ ua->send_msg("max_vol_bytes=%s", edit_uint64(pool->MaxVolBytes, ed1));
+ ua->send_msg("auto_prune=%d", pool->AutoPrune);
+ ua->send_msg("recycle=%d", pool->Recycle);
+ }
+ }
+ return true;
}