/*
- *
- * Bacula Director -- User Agent Input and scanning code
- *
- * Kern Sibbald, October MMI
- *
- * Version $Id$
- */
+ Bacula(R) - The Network Backup Solution
-/*
- Copyright (C) 2000-2004 Kern Sibbald and John Walker
+ Copyright (C) 2000-2015 Kern Sibbald
- 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 original author of Bacula is Kern Sibbald, with contributions
+ from many others, a complete list can be found in the file AUTHORS.
- 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 may use this file and others of this release according to the
+ license defined in the LICENSE file, which includes the Affero General
+ Public License, v3.0 ("AGPLv3") and some additional permissions and
+ terms pursuant to its AGPLv3 Section 7.
- 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.
+ This notice must be preserved when any source code is
+ conveyed and/or propagated.
+ Bacula(R) is a registered trademark of Kern Sibbald.
+*/
+/*
+ *
+ * Bacula Director -- User Agent Input and scanning code
+ *
+ * Kern Sibbald, October MMI
+ *
*/
#include "bacula.h"
/* Exported functions */
-int get_cmd(UAContext *ua, char *prompt)
+/*
+ * If subprompt is set, we send a BNET_SUB_PROMPT signal otherwise
+ * send a BNET_TEXT_INPUT signal.
+ */
+bool get_cmd(UAContext *ua, const char *prompt, bool subprompt)
{
BSOCK *sock = ua->UA_sock;
int stat;
ua->cmd[0] = 0;
- if (!sock) { /* No UA */
- return 0;
+ if (!sock || ua->batch) { /* No UA or batch mode */
+ return false;
+ }
+ if (!subprompt && ua->api) {
+ sock->signal(BNET_TEXT_INPUT);
+ }
+ sock->fsend("%s", prompt);
+ if (!ua->api || subprompt) {
+ sock->signal(BNET_SUB_PROMPT);
}
- bnet_fsend(sock, "%s", prompt);
- bnet_sig(sock, BNET_PROMPT); /* request more input */
for ( ;; ) {
- stat = bnet_recv(sock);
+ stat = sock->recv();
if (stat == BNET_SIGNAL) {
- continue; /* ignore signals */
+ continue; /* ignore signals */
}
- if (is_bnet_stop(sock)) {
- return 0; /* error or terminate */
+ if (sock->is_stop()) {
+ return false; /* error or terminate */
}
- pm_strcpy(&ua->cmd, sock->msg);
+ pm_strcpy(ua->cmd, sock->msg);
strip_trailing_junk(ua->cmd);
if (strcmp(ua->cmd, ".messages") == 0) {
- qmessagescmd(ua, ua->cmd);
+ qmessagescmd(ua, ua->cmd);
}
/* Lone dot => break */
if (ua->cmd[0] == '.' && ua->cmd[1] == 0) {
- return 0;
+ return false;
}
break;
}
- return 1;
+ return true;
+}
+
+/*
+ * Get a selection list
+ * We get a command from the user, scan it, then
+ * return when OK
+ * Returns true if OK
+ * false if error
+ */
+bool get_selection_list(UAContext *ua, sellist &sl,
+ const char *prompt, bool subprompt)
+{
+ for ( ;; ) {
+ if (!get_cmd(ua, prompt, subprompt)) {
+ return false;
+ }
+ if (!sl.set_string(ua->cmd, true)) {
+ ua->send_msg("%s", sl.get_errmsg());
+ continue;
+ }
+ return true;
+ }
}
-/*
+/*
* Get a positive integer
- * Returns: 0 if failure
- * 1 if success => value in ua->pint32_val
+ * Returns: false if failure
+ * true if success => value in ua->pint32_val
*/
-int get_pint(UAContext *ua, char *prompt)
+bool get_pint(UAContext *ua, const char *prompt)
{
double dval;
ua->pint32_val = 0;
+ ua->int64_val = 0;
for (;;) {
+ ua->cmd[0] = 0;
if (!get_cmd(ua, prompt)) {
- return 0;
+ return false;
+ }
+ /* Kludge for slots blank line => 0 */
+ if (ua->cmd[0] == 0 && strncmp(prompt, _("Enter slot"), strlen(_("Enter slot"))) == 0) {
+ return true;
}
if (!is_a_number(ua->cmd)) {
- bsendmsg(ua, "Expected a positive integer, got: %s\n", ua->cmd);
- continue;
+ ua->warning_msg(_("Expected a positive integer, got: %s\n"), ua->cmd);
+ continue;
}
errno = 0;
dval = strtod(ua->cmd, NULL);
if (errno != 0 || dval < 0) {
- bsendmsg(ua, "Expected a positive integer, got: %s\n", ua->cmd);
- continue;
+ ua->warning_msg(_("Expected a positive integer, got: %s\n"), ua->cmd);
+ continue;
}
ua->pint32_val = (uint32_t)dval;
- return 1;
+ ua->int64_val = (int64_t)dval;
+ return true;
}
}
-/*
+/*
+ * Test a yes or no response
+ * Returns: false if failure
+ * true if success => ret == 1 for yes
+ * ret == 0 for no
+ */
+bool is_yesno(char *val, int *ret)
+{
+ *ret = 0;
+ if ((strcasecmp(val, _("yes")) == 0) ||
+ (strcasecmp(val, NT_("yes")) == 0))
+ {
+ *ret = 1;
+ } else if ((strcasecmp(val, _("no")) == 0) ||
+ (strcasecmp(val, NT_("no")) == 0))
+ {
+ *ret = 0;
+ } else {
+ return false;
+ }
+
+ return true;
+}
+
+/*
* Gets a yes or no response
- * Returns: 0 if failure
- * 1 if success => ua->pint32_val == 1 for yes
- * ua->pint32_val == 0 for no
+ * Returns: false if failure
+ * true if success => ua->pint32_val == 1 for yes
+ * ua->pint32_val == 0 for no
*/
-int get_yesno(UAContext *ua, char *prompt)
+bool get_yesno(UAContext *ua, const char *prompt)
{
int len;
-
+ int ret;
ua->pint32_val = 0;
for (;;) {
+ if (ua->api) ua->UA_sock->signal(BNET_YESNO);
if (!get_cmd(ua, prompt)) {
- return 0;
+ return false;
}
len = strlen(ua->cmd);
if (len < 1 || len > 3) {
- continue;
+ continue;
}
- if (strncasecmp(ua->cmd, _("yes"), len) == 0) {
- ua->pint32_val = 1;
- return 1;
+ if (is_yesno(ua->cmd, &ret)) {
+ ua->pint32_val = ret;
+ return true;
}
- if (strncasecmp(ua->cmd, _("no"), len) == 0) {
- return 1;
- }
- bsendmsg(ua, _("Invalid response. You must answer yes or no.\n"));
+ ua->warning_msg(_("Invalid response. You must answer yes or no.\n"));
+ }
+}
+
+/*
+ * Gets an Enabled value => 0, 1, 2, yes, no, archived
+ * Returns: 0, 1, 2 if OK
+ * -1 on error
+ */
+int get_enabled(UAContext *ua, const char *val)
+{
+ int Enabled = -1;
+
+ if (strcasecmp(val, "yes") == 0 || strcasecmp(val, "true") == 0) {
+ Enabled = 1;
+ } else if (strcasecmp(val, "no") == 0 || strcasecmp(val, "false") == 0) {
+ Enabled = 0;
+ } else if (strcasecmp(val, "archived") == 0) {
+ Enabled = 2;
+ } else {
+ Enabled = atoi(val);
+ }
+ if (Enabled < 0 || Enabled > 2) {
+ ua->error_msg(_("Invalid Enabled value, it must be yes, no, archived, 0, 1, or 2\n"));
+ return -1;
}
+ return Enabled;
}
-
void parse_ua_args(UAContext *ua)
{
parse_args(ua->cmd, &ua->args, &ua->argc, ua->argk, ua->argv, MAX_CMD_ARGS);
}
+
+/*
+ * Check if the comment has legal characters
+ * If ua is non-NULL send the message
+ */
+bool is_comment_legal(UAContext *ua, const char *name)
+{
+ int len;
+ const char *p;
+ const char *forbid = "'<>&\\\"";
+
+ /* Restrict the characters permitted in the comment */
+ for (p=name; *p; p++) {
+ if (!strchr(forbid, (int)(*p))) {
+ continue;
+ }
+ if (ua) {
+ ua->error_msg(_("Illegal character \"%c\" in a comment.\n"), *p);
+ }
+ return 0;
+ }
+ len = strlen(name);
+ if (len >= MAX_NAME_LENGTH) {
+ if (ua) {
+ ua->error_msg(_("Comment too long.\n"));
+ }
+ return 0;
+ }
+ if (len == 0) {
+ if (ua) {
+ ua->error_msg(_("Comment must be at least one character long.\n"));
+ }
+ return 0;
+ }
+ return 1;
+}
projects / bacula / bacula / blobdiff