/*
- * edit.c edit string to ascii, and ascii to internal
- *
- * Kern Sibbald, December MMII
- *
- * Version $Id$
- */
+ Bacula(R) - The Network Backup Solution
-/*
- Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+ Copyright (C) 2000-2016 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.
+*/
+/*
+ * edit.c edit string to ascii, and ascii to internal
+ *
+ * Kern Sibbald, December MMII
+ *
*/
#include "bacula.h"
#include <math.h>
/* We assume ASCII input and don't worry about overflow */
-uint64_t str_to_uint64(char *str)
+uint64_t str_to_uint64(char *str)
{
register char *p = str;
register uint64_t value = 0;
+ if (!p) {
+ return 0;
+ }
while (B_ISSPACE(*p)) {
p++;
}
if (*p == '+') {
p++;
}
- while (B_ISDIGIT(*p)) {
- value = value * 10 + *p - '0';
- p++;
+ if (*p == '0' && *(p+1) == 'x') {
+ p = p + 2; /* skip 0x */
+
+ while (B_ISXDIGIT(*p)) {
+ if (B_ISDIGIT(*p)) {
+ value = (value<<4) + (*p - '0');
+
+ } else {
+ value = (value<<4) + (tolower(*p) - 'a' + 10);
+ }
+ p++;
+ }
+ } else {
+ while (B_ISDIGIT(*p)) {
+ value = B_TIMES10(value) + *p - '0';
+ p++;
+ }
}
return value;
}
-int64_t str_to_int64(char *str)
+int64_t str_to_int64(char *str)
{
register char *p = str;
register int64_t value;
- int negative = FALSE;
+ bool negative = false;
+ if (!p) {
+ return 0;
+ }
while (B_ISSPACE(*p)) {
p++;
}
if (*p == '+') {
p++;
} else if (*p == '-') {
- negative = TRUE;
+ negative = true;
p++;
}
value = str_to_uint64(p);
}
-
/*
* Edit an integer number with commas, the supplied buffer
* must be at least 27 bytes long. The incoming number
*/
char *edit_uint64_with_commas(uint64_t val, char *buf)
{
- sprintf(buf, "%" lld, val);
+ edit_uint64(val, buf);
return add_commas(buf, buf);
}
+/*
+ * Edit an integer into "human-readable" format with four or fewer
+ * significant digits followed by a suffix that indicates the scale
+ * factor. The buf array inherits a 27 byte minimim length
+ * requirement from edit_unit64_with_commas(), although the output
+ * string is limited to eight characters.
+ */
+char *edit_uint64_with_suffix(uint64_t val, char *buf)
+{
+ int commas = 0;
+ char *c, mbuf[50];
+ const char *suffix[] =
+ { "", "K", "M", "G", "T", "P", "E", "Z", "Y", "FIX ME" };
+ int suffixes = sizeof(suffix) / sizeof(*suffix);
+
+ edit_uint64_with_commas(val, mbuf);
+
+ if ((c = strchr(mbuf, ',')) != NULL) {
+ commas++;
+ *c++ = '.';
+ while ((c = strchr(c, ',')) != NULL) {
+ commas++;
+ *c++ = '\0';
+ }
+ mbuf[5] = '\0'; // drop this to get '123.456 TB' rather than '123.4 TB'
+ }
+
+ if (commas >= suffixes)
+ commas = suffixes - 1;
+ bsnprintf(buf, 27, "%s %s", mbuf, suffix[commas]);
+ return buf;
+}
+
/*
* Edit an integer number, the supplied buffer
* must be at least 27 bytes long. The incoming number
*/
char *edit_uint64(uint64_t val, char *buf)
{
- sprintf(buf, "%" lld, val);
+ /*
+ * Replacement for sprintf(buf, "%" llu, val)
+ */
+ char mbuf[50];
+ mbuf[sizeof(mbuf)-1] = 0;
+ int i = sizeof(mbuf)-2; /* edit backward */
+ if (val == 0) {
+ mbuf[i--] = '0';
+ } else {
+ while (val != 0) {
+ mbuf[i--] = "0123456789"[val%10];
+ val /= 10;
+ }
+ }
+ bstrncpy(buf, &mbuf[i+1], 27);
+ return buf;
+}
+
+char *edit_int64(int64_t val, char *buf)
+{
+ /*
+ * Replacement for sprintf(buf, "%" llu, val)
+ */
+ char mbuf[50];
+ bool negative = false;
+ mbuf[sizeof(mbuf)-1] = 0;
+ int i = sizeof(mbuf)-2; /* edit backward */
+ if (val == 0) {
+ mbuf[i--] = '0';
+ } else {
+ if (val < 0) {
+ negative = true;
+ val = -val;
+ }
+ while (val != 0) {
+ mbuf[i--] = "0123456789"[val%10];
+ val /= 10;
+ }
+ }
+ if (negative) {
+ mbuf[i--] = '-';
+ }
+ bstrncpy(buf, &mbuf[i+1], 27);
return buf;
}
+/*
+ * Edit an integer number with commas, the supplied buffer
+ * must be at least 27 bytes long. The incoming number
+ * is always widened to 64 bits.
+ */
+char *edit_int64_with_commas(int64_t val, char *buf)
+{
+ edit_int64(val, buf);
+ return add_commas(buf, buf);
+}
/*
- * Convert a string duration to utime_t (64 bit seconds)
- * Returns 0: if error
- 1: if OK, and value stored in value
+ * Given a string "str", separate the numeric part into
+ * str, and the modifier into mod.
*/
-int duration_to_utime(char *str, utime_t *value)
+static bool get_modifier(char *str, char *num, int num_len, char *mod, int mod_len)
{
- int i, ch, len;
- double val;
- /* Default to 1 day if no modifier given */
- static int mod[] = {'*', 's', 'n', 'h', 'd', 'w', 'm', 'q', 'y', 0};
- static int mult[] = {60*60*24, 1, 60, 60*60, 60*60*24, 60*60*24*7, 60*60*24*30,
- 60*60*24*91, 60*60*24*365};
+ int i, len, num_begin, num_end, mod_begin, mod_end;
- /* Look for modifier */
+ strip_trailing_junk(str);
len = strlen(str);
- ch = str[len - 1];
- i = 0;
- if (B_ISALPHA(ch)) {
- if (B_ISUPPER(ch)) {
- ch = tolower(ch);
+
+ for (i=0; i<len; i++) {
+ if (!B_ISSPACE(str[i])) {
+ break;
}
- while (mod[++i] != 0) {
- if (ch == mod[i]) {
- len--;
- str[len] = 0; /* strip modifier */
- break;
- }
+ }
+ num_begin = i;
+
+ /* Walk through integer part */
+ for ( ; i<len; i++) {
+ if (!B_ISDIGIT(str[i]) && str[i] != '.') {
+ break;
}
}
- if (mod[i] == 0 || !is_a_number(str)) {
- return 0;
+ num_end = i;
+ if (num_len > (num_end - num_begin + 1)) {
+ num_len = num_end - num_begin + 1;
}
- errno = 0;
- val = strtod(str, NULL);
- if (errno != 0 || val < 0) {
- return 0;
+ if (num_len == 0) {
+ return false;
}
- *value = (utime_t)(val * mult[i]);
- return 1;
+ /* Eat any spaces in front of modifier */
+ for ( ; i<len; i++) {
+ if (!B_ISSPACE(str[i])) {
+ break;
+ }
+ }
+ mod_begin = i;
+ for ( ; i<len; i++) {
+ if (!B_ISALPHA(str[i])) {
+ break;
+ }
+ }
+ mod_end = i;
+ if (mod_len > (mod_end - mod_begin + 1)) {
+ mod_len = mod_end - mod_begin + 1;
+ }
+ Dmsg5(900, "str=%s: num_beg=%d num_end=%d mod_beg=%d mod_end=%d\n",
+ str, num_begin, num_end, mod_begin, mod_end);
+ bstrncpy(num, &str[num_begin], num_len);
+ bstrncpy(mod, &str[mod_begin], mod_len);
+ if (!is_a_number(num)) {
+ return false;
+ }
+ bstrncpy(str, &str[mod_end], len);
+ Dmsg2(900, "num=%s mod=%s\n", num, mod);
+
+ return true;
+}
+
+/*
+ * Convert a string duration to utime_t (64 bit seconds)
+ * Returns false: if error
+ true: if OK, and value stored in value
+ */
+bool duration_to_utime(char *str, utime_t *value)
+{
+ int i, mod_len;
+ double val, total = 0.0;
+ char mod_str[20];
+ char num_str[50];
+ /*
+ * The "n" = mins and months appears before minutes so that m maps
+ * to months. These "kludges" make it compatible with pre 1.31
+ * Baculas.
+ */
+ static const char *mod[] = {"n", "seconds", "months", "minutes", "mins",
+ "hours", "days", "weeks", "quarters", "years", NULL};
+ static const int32_t mult[] = {60, 1, 60*60*24*30, 60, 60,
+ 3600, 3600*24, 3600*24*7, 3600*24*91, 3600*24*365};
+ while (*str) {
+ if (!get_modifier(str, num_str, sizeof(num_str), mod_str, sizeof(mod_str))) {
+ return false;
+ }
+ /* Now find the multiplier corresponding to the modifier */
+ mod_len = strlen(mod_str);
+ if (mod_len == 0) {
+ i = 1; /* default to seconds */
+ } else {
+ for (i=0; mod[i]; i++) {
+ if (strncasecmp(mod_str, mod[i], mod_len) == 0) {
+ break;
+ }
+ }
+ if (mod[i] == NULL) {
+ return false;
+ }
+ }
+ Dmsg2(900, "str=%s: mult=%d\n", num_str, mult[i]);
+ errno = 0;
+ val = strtod(num_str, NULL);
+ if (errno != 0 || val < 0) {
+ return false;
+ }
+ total += val * mult[i];
+ }
+ *value = (utime_t)total;
+ return true;
}
/*
* Edit a utime "duration" into ASCII
*/
-char *edit_utime(utime_t val, char *buf)
+char *edit_utime(utime_t val, char *buf, int buf_len)
{
- char mybuf[30];
- static int mult[] = {60*60*24*365, 60*60*24*30, 60*60*24, 60*60, 60};
- static char *mod[] = {"year", "month", "day", "hour", "min"};
+ char mybuf[200];
+ static const int32_t mult[] = {60*60*24*365, 60*60*24*30, 60*60*24, 60*60, 60};
+ static const char *mod[] = {"year", "month", "day", "hour", "min"};
int i;
uint32_t times;
*buf = 0;
for (i=0; i<5; i++) {
- times = val / mult[i];
+ times = (uint32_t)(val / mult[i]);
if (times > 0) {
- val = val - (utime_t)times * mult[i];
- sprintf(mybuf, "%d %s%s ", times, mod[i], times>1?"s":"");
- strcat(buf, mybuf);
+ val = val - (utime_t)times * mult[i];
+ bsnprintf(mybuf, sizeof(mybuf), "%d %s%s ", times, mod[i], times>1?"s":"");
+ bstrncat(buf, mybuf, buf_len);
}
}
- if (val == 0 && strlen(buf) == 0) {
- strcat(buf, "0 secs");
+ if (val == 0 && strlen(buf) == 0) {
+ bstrncat(buf, "0 secs", buf_len);
} else if (val != 0) {
- sprintf(mybuf, "%d sec%s", (uint32_t)val, val>1?"s":"");
- strcat(buf, mybuf);
+ bsnprintf(mybuf, sizeof(mybuf), "%d sec%s", (uint32_t)val, val>1?"s":"");
+ bstrncat(buf, mybuf, buf_len);
}
return buf;
}
-/*
- * Convert a size size in bytes to uint64_t
- * Returns 0: if error
- 1: if OK, and value stored in value
- */
-int size_to_uint64(char *str, int str_len, uint64_t *rtn_value)
+static bool strunit_to_uint64(char *str, int str_len, uint64_t *value,
+ const char **mod)
{
- int i, ch;
- double value;
- int mod[] = {'*', 'k', 'm', 'g', 0}; /* first item * not used */
- uint64_t mult[] = {1, /* byte */
- 1024, /* kilobyte */
- 1048576, /* megabyte */
- 1073741824}; /* gigabyte */
-
-#ifdef we_have_a_compiler_that_works
- int mod[] = {'*', 'k', 'm', 'g', 't', 0};
- uint64_t mult[] = {1, /* byte */
- 1024, /* kilobyte */
- 1048576, /* megabyte */
- 1073741824, /* gigabyte */
- 1099511627776};/* terabyte */
-#endif
-
- Dmsg1(400, "Enter sized to uint64 str=%s\n", str);
+ int i, mod_len;
+ double val;
+ char mod_str[20];
+ char num_str[50];
+ const int64_t mult[] = {1, /* byte */
+ 1024, /* kilobyte */
+ 1000, /* kb kilobyte */
+ 1048576, /* megabyte */
+ 1000000, /* mb megabyte */
+ 1073741824, /* gigabyte */
+ 1000000000}; /* gb gigabyte */
- /* Look for modifier */
- ch = str[str_len - 1];
- i = 0;
- if (B_ISALPHA(ch)) {
- if (B_ISUPPER(ch)) {
- ch = tolower(ch);
+ if (!get_modifier(str, num_str, sizeof(num_str), mod_str, sizeof(mod_str))) {
+ return 0;
+ }
+ /* Now find the multiplier corresponding to the modifier */
+ mod_len = strlen(mod_str);
+ if (mod_len == 0) {
+ i = 0; /* default with no modifier = 1 */
+ } else {
+ for (i=0; mod[i]; i++) {
+ if (strncasecmp(mod_str, mod[i], mod_len) == 0) {
+ break;
+ }
}
- while (mod[++i] != 0) {
- if (ch == mod[i]) {
- str_len--;
- str[str_len] = 0; /* strip modifier */
- break;
- }
+ if (mod[i] == NULL) {
+ return false;
}
}
- if (mod[i] == 0 || !is_a_number(str)) {
- return 0;
- }
- Dmsg3(400, "size str=:%s: %lf i=%d\n", str, strtod(str, NULL), i);
-
+ Dmsg2(900, "str=%s: mult=%d\n", str, mult[i]);
errno = 0;
- value = strtod(str, NULL);
- if (errno != 0 || value < 0) {
- return 0;
+ val = strtod(num_str, NULL);
+ if (errno != 0 || val < 0) {
+ return false;
}
- *rtn_value = (uint64_t)(value * mult[i]);
- Dmsg2(400, "Full value = %lf %" lld "\n", value * mult[i],
- (uint64_t)(value * mult[i]));
- return 1;
+ *value = (utime_t)(val * mult[i]);
+ return true;
+}
+
+/*
+ * Convert a size in bytes to uint64_t
+ * Returns false: if error
+ true: if OK, and value stored in value
+ */
+bool size_to_uint64(char *str, int str_len, uint64_t *value)
+{
+ /* first item * not used */
+ static const char *mod[] = {"*", "k", "kb", "m", "mb", "g", "gb", NULL};
+ return strunit_to_uint64(str, str_len, value, mod);
+}
+
+/*
+ * Convert a speed in bytes/s to uint64_t
+ * Returns false: if error
+ true: if OK, and value stored in value
+ */
+bool speed_to_uint64(char *str, int str_len, uint64_t *value)
+{
+ /* first item * not used */
+ static const char *mod[] = {"*", "k/s", "kb/s", "m/s", "mb/s", NULL};
+ return strunit_to_uint64(str, str_len, value, mod);
}
/*
* Check if specified string is a number or not.
* Taken from SQLite, cool, thanks.
*/
-int is_a_number(const char *n)
+bool is_a_number(const char *n)
{
bool digit_seen = false;
+ if (n == NULL) {
+ return false;
+ }
+
if( *n == '-' || *n == '+' ) {
n++;
}
}
if (digit_seen && (*n == 'e' || *n == 'E')
&& (B_ISDIGIT(n[1]) || ((n[1]=='-' || n[1] == '+') && B_ISDIGIT(n[2])))) {
- n += 2; /* skip e- or e+ or e digit */
+ n += 2; /* skip e- or e+ or e digit */
while (B_ISDIGIT(*n)) { n++; }
}
return digit_seen && *n==0;
}
/*
- * Check if the specified string is an integer
+ * Check if specified string is a list of numbers or not
+ */
+bool is_a_number_list(const char *n)
+{
+ bool previous_digit = false;
+ bool digit_seen = false;
+ if (n == NULL) {
+ return false;
+ }
+ while (*n) {
+ if (B_ISDIGIT(*n)) {
+ previous_digit=true;
+ digit_seen = true;
+ } else if (*n == ',' && previous_digit) {
+ previous_digit = false;
+ } else {
+ return false;
+ }
+ n++;
+ }
+ return digit_seen && *n==0;
+}
+
+/*
+ * Check if the specified string is an integer
*/
-int is_an_integer(const char *n)
+bool is_an_integer(const char *n)
{
bool digit_seen = false;
+ if (n == NULL) {
+ return false;
+ }
while (B_ISDIGIT(*n)) {
digit_seen = true;
n++;
return digit_seen && *n==0;
}
+/*
+ * Check if Bacula Resoure Name is valid
+ */
+/*
+ * Check if the Volume name has legal characters
+ * If ua is non-NULL send the message
+ */
+bool is_name_valid(const char *name, POOLMEM **msg)
+{
+ int len;
+ const char *p;
+ /* Special characters to accept */
+ const char *accept = ":.-_ ";
+
+ /* No name is invalid */
+ if (!name) {
+ if (msg) {
+ Mmsg(msg, _("Empty name not allowed.\n"));
+ }
+ return false;
+ }
+ /* Restrict the characters permitted in the Volume name */
+ for (p=name; *p; p++) {
+ if (B_ISALPHA(*p) || B_ISDIGIT(*p) || strchr(accept, (int)(*p))) {
+ continue;
+ }
+ if (msg) {
+ Mmsg(msg, _("Illegal character \"%c\" in name.\n"), *p);
+ }
+ return false;
+ }
+ len = p - name;
+ if (len >= MAX_NAME_LENGTH) {
+ if (msg) {
+ Mmsg(msg, _("Name too long.\n"));
+ }
+ return false;
+ }
+ if (len == 0) {
+ if (msg) {
+ Mmsg(msg, _("Volume name must be at least one character long.\n"));
+ }
+ return false;
+ }
+ return true;
+}
+
+
+
/*
* Add commas to a string, which is presumably
- * a number.
+ * a number.
*/
char *add_commas(char *val, char *buf)
{
*q-- = *p--;
for ( ; nc; nc--) {
for (i=0; i < 3; i++) {
- *q-- = *p--;
+ *q-- = *p--;
}
*q-- = ',';
- }
+ }
return buf;
}
+
+#ifdef TEST_PROGRAM
+void d_msg(const char*, int, int, const char*, ...)
+{}
+int main(int argc, char *argv[])
+{
+ char *str[] = {"3", "3n", "3 hours", "3.5 day", "3 week", "3 m", "3 q", "3 years"};
+ utime_t val;
+ char buf[100];
+ char outval[100];
+
+ for (int i=0; i<8; i++) {
+ strcpy(buf, str[i]);
+ if (!duration_to_utime(buf, &val)) {
+ printf("Error return from duration_to_utime for in=%s\n", str[i]);
+ continue;
+ }
+ edit_utime(val, outval);
+ printf("in=%s val=%" lld " outval=%s\n", str[i], val, outval);
+ }
+}
+#endif
projects / bacula / bacula / blobdiff