git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/edit.c

   1 /*
   2  *   edit.c  edit string to ascii, and ascii to internal
   3  *
   4  *    Kern Sibbald, December MMII
   5  *
   6  *   Version $Id$
   7  */
   8
   9 /*
  10    Copyright (C) 2000-2005 Kern Sibbald
  11
  12    This program is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation; either version 2 of
  15    the License, or (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20    General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public
  23    License along with this program; if not, write to the Free
  24    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29 #include "bacula.h"
  30 #include <math.h>
  31
  32 /* We assume ASCII input and don't worry about overflow */
  33 uint64_t str_to_uint64(char *str)
  34 {
  35    register char *p = str;
  36    register uint64_t value = 0;
  37
  38    if (!p) {
  39       return 0;
  40    }
  41    while (B_ISSPACE(*p)) {
  42       p++;
  43    }
  44    if (*p == '+') {
  45       p++;
  46    }
  47    while (B_ISDIGIT(*p)) {
  48       value = value * 10 + *p - '0';
  49       p++;
  50    }
  51    return value;
  52 }
  53
  54 int64_t str_to_int64(char *str)
  55 {
  56    register char *p = str;
  57    register int64_t value;
  58    bool negative = false;
  59
  60    if (!p) {
  61       return 0;
  62    }
  63    while (B_ISSPACE(*p)) {
  64       p++;
  65    }
  66    if (*p == '+') {
  67       p++;
  68    } else if (*p == '-') {
  69       negative = true;
  70       p++;
  71    }
  72    value = str_to_uint64(p);
  73    if (negative) {
  74       value = -value;
  75    }
  76    return value;
  77 }
  78
  79
  80 /*
  81  * Edit an integer number with commas, the supplied buffer
  82  * must be at least 27 bytes long.  The incoming number
  83  * is always widened to 64 bits.
  84  */
  85 char *edit_uint64_with_commas(uint64_t val, char *buf)
  86 {
  87    /*
  88     * Replacement for sprintf(buf, "%" llu, val)
  89     */
  90    char mbuf[50];
  91    mbuf[sizeof(mbuf)-1] = 0;
  92    int i = sizeof(mbuf)-2;                 /* edit backward */
  93    if (val == 0) {
  94       mbuf[i--] = '0';
  95    } else {
  96       while (val != 0) {
  97          mbuf[i--] = "0123456789"[val%10];
  98          val /= 10;
  99       }
 100    }
 101    strcpy(buf, &mbuf[i+1]);
 102    return add_commas(buf, buf);
 103 }
 104
 105 /*
 106  * Edit an integer number, the supplied buffer
 107  * must be at least 27 bytes long.  The incoming number
 108  * is always widened to 64 bits.
 109  */
 110 char *edit_uint64(uint64_t val, char *buf)
 111 {
 112    /*
 113     * Replacement for sprintf(buf, "%" llu, val)
 114     */
 115    char mbuf[50];
 116    mbuf[sizeof(mbuf)-1] = 0;
 117    int i = sizeof(mbuf)-2;                 /* edit backward */
 118    if (val == 0) {
 119       mbuf[i--] = '0';
 120    } else {
 121       while (val != 0) {
 122          mbuf[i--] = "0123456789"[val%10];
 123          val /= 10;
 124       }
 125    }
 126    strcpy(buf, &mbuf[i+1]);
 127    return buf;
 128 }
 129
 130 char *edit_int64(int64_t val, char *buf)
 131 {
 132    /*
 133     * Replacement for sprintf(buf, "%" llu, val)
 134     */
 135    char mbuf[50];
 136    bool negative = false;
 137    mbuf[sizeof(mbuf)-1] = 0;
 138    int i = sizeof(mbuf)-2;                 /* edit backward */
 139    if (val == 0) {
 140       mbuf[i--] = '0';
 141    } else {
 142       if (val < 0) {
 143          negative = true;
 144          val = -val;
 145       }
 146       while (val != 0) {
 147          mbuf[i--] = "0123456789"[val%10];
 148          val /= 10;
 149       }
 150    }
 151    if (negative) {
 152       mbuf[i--] = '-';
 153    }
 154    strcpy(buf, &mbuf[i+1]);
 155    return buf;
 156 }
 157
 158
 159 /*
 160  * Given a string "str", separate the integer part into
 161  *   str, and the modifier into mod.
 162  */
 163 static bool get_modifier(char *str, char *num, int num_len, char *mod, int mod_len)
 164 {
 165    int i, len, num_begin, num_end, mod_begin, mod_end;
 166
 167    /*
 168     * Look for modifier by walking back looking for the first
 169     *   space or digit.
 170     */
 171    strip_trailing_junk(str);
 172    len = strlen(str);
 173
 174    for (i=0; i<len; i++) {
 175       if (!B_ISSPACE(str[i])) {
 176          break;
 177       }
 178    }
 179    num_begin = i;
 180
 181    /* Walk through integer part */
 182    for ( ; i<len; i++) {
 183       if (!B_ISDIGIT(str[i])) {
 184          break;
 185       }
 186    }
 187    num_end = i;
 188    if (num_len > (num_end - num_begin + 1)) {
 189       num_len = num_end - num_begin + 1;
 190    }
 191    if (num_len == 0) {
 192       return false;
 193    }
 194    for ( ; i<len; i++) {
 195       if (!B_ISSPACE(str[i])) {
 196          break;
 197       }
 198    }
 199    mod_begin = i;
 200    for ( ; i<len; i++) {
 201       if (!B_ISALPHA(str[i])) {
 202          break;
 203       }
 204    }
 205    mod_end = i;
 206    if (mod_len > (mod_end - mod_begin + 1)) {
 207       mod_len = mod_end - mod_begin + 1;
 208    }
 209    Dmsg5(900, "str=%s: num_beg=%d num_end=%d mod_beg=%d mod_end=%d\n",
 210       str, num_begin, num_end, mod_begin, mod_end);
 211    bstrncpy(num, &str[num_begin], num_len);
 212    bstrncpy(mod, &str[mod_begin], mod_len);
 213    if (!is_a_number(num)) {
 214       return false;
 215    }
 216    bstrncpy(str, &str[mod_end], len);
 217
 218    return true;
 219 }
 220
 221 /*
 222  * Convert a string duration to utime_t (64 bit seconds)
 223  * Returns 0: if error
 224            1: if OK, and value stored in value
 225  */
 226 int duration_to_utime(char *str, utime_t *value)
 227 {
 228    int i, mod_len;
 229    double val, total = 0.0;
 230    char mod_str[20];
 231    char num_str[50];
 232    /*
 233     * The "n" = mins and months appears before minutes so that m maps
 234     *   to months. These "kludges" make it compatible with pre 1.31
 235     *   Baculas.
 236     */
 237    static const char *mod[] = {"n", "seconds", "months", "minutes",
 238                   "hours", "days", "weeks",   "quarters",   "years", NULL};
 239    static const int32_t mult[] = {60,   1, 60*60*24*30, 60,
 240                   60*60, 60*60*24, 60*60*24*7, 60*60*24*91, 60*60*24*365};
 241
 242    while (*str) {
 243       if (!get_modifier(str, num_str, sizeof(num_str), mod_str, sizeof(mod_str))) {
 244          return 0;
 245       }
 246       /* Now find the multiplier corresponding to the modifier */
 247       mod_len = strlen(mod_str);
 248       if (mod_len == 0) {
 249          i = 1;                          /* assume seconds */
 250       } else {
 251          for (i=0; mod[i]; i++) {
 252             if (strncasecmp(mod_str, mod[i], mod_len) == 0) {
 253                break;
 254             }
 255          }
 256          if (mod[i] == NULL) {
 257             i = 1;                       /* no modifier, assume secs */
 258          }
 259       }
 260       Dmsg2(900, "str=%s: mult=%d\n", num_str, mult[i]);
 261       errno = 0;
 262       val = strtod(num_str, NULL);
 263       if (errno != 0 || val < 0) {
 264          return 0;
 265       }
 266       total += val * mult[i];
 267    }
 268    *value = (utime_t)total;
 269    return 1;
 270 }
 271
 272 /*
 273  * Edit a utime "duration" into ASCII
 274  */
 275 char *edit_utime(utime_t val, char *buf, int buf_len)
 276 {
 277    char mybuf[200];
 278    static const int32_t mult[] = {60*60*24*365, 60*60*24*30, 60*60*24, 60*60, 60};
 279    static const char *mod[]  = {"year",  "month",  "day", "hour", "min"};
 280    int i;
 281    uint32_t times;
 282
 283    *buf = 0;
 284    for (i=0; i<5; i++) {
 285       times = (uint32_t)(val / mult[i]);
 286       if (times > 0) {
 287          val = val - (utime_t)times * mult[i];
 288          bsnprintf(mybuf, sizeof(mybuf), "%d %s%s ", times, mod[i], times>1?"s":"");
 289          bstrncat(buf, mybuf, buf_len);
 290       }
 291    }
 292    if (val == 0 && strlen(buf) == 0) {
 293       bstrncat(buf, "0 secs", buf_len);
 294    } else if (val != 0) {
 295       bsnprintf(mybuf, sizeof(mybuf), "%d sec%s", (uint32_t)val, val>1?"s":"");
 296       bstrncat(buf, mybuf, buf_len);
 297    }
 298    return buf;
 299 }
 300
 301 /*
 302  * Convert a size in bytes to uint64_t
 303  * Returns 0: if error
 304            1: if OK, and value stored in value
 305  */
 306 int size_to_uint64(char *str, int str_len, uint64_t *value)
 307 {
 308    int i, mod_len;
 309    double val;
 310    char mod_str[20];
 311    char num_str[50];
 312    static const char *mod[]  = {"*", "k", "kb", "m", "mb",  "g", "gb",  NULL}; /* first item * not used */
 313    const int64_t mult[] = {1,             /* byte */
 314                            1024,          /* kilobyte */
 315                            1000,          /* kb kilobyte */
 316                            1048576,       /* megabyte */
 317                            1000000,       /* mb megabyte */
 318                            1073741824,    /* gigabyte */
 319                            1000000000};   /* gb gigabyte */
 320
 321    if (!get_modifier(str, num_str, sizeof(num_str), mod_str, sizeof(mod_str))) {
 322       return 0;
 323    }
 324    /* Now find the multiplier corresponding to the modifier */
 325    mod_len = strlen(mod_str);
 326    for (i=0; mod[i]; i++) {
 327       if (strncasecmp(mod_str, mod[i], mod_len) == 0) {
 328          break;
 329       }
 330    }
 331    if (mod[i] == NULL) {
 332       i = 0;                          /* no modifier found, assume 1 */
 333    }
 334    Dmsg2(900, "str=%s: mult=%d\n", str, mult[i]);
 335    errno = 0;
 336    val = strtod(num_str, NULL);
 337    if (errno != 0 || val < 0) {
 338       return 0;
 339    }
 340   *value = (utime_t)(val * mult[i]);
 341    return 1;
 342 }
 343
 344 /*
 345  * Check if specified string is a number or not.
 346  *  Taken from SQLite, cool, thanks.
 347  */
 348 bool is_a_number(const char *n)
 349 {
 350    bool digit_seen = false;
 351
 352    if( *n == '-' || *n == '+' ) {
 353       n++;
 354    }
 355    while (B_ISDIGIT(*n)) {
 356       digit_seen = true;
 357       n++;
 358    }
 359    if (digit_seen && *n == '.') {
 360       n++;
 361       while (B_ISDIGIT(*n)) { n++; }
 362    }
 363    if (digit_seen && (*n == 'e' || *n == 'E')
 364        && (B_ISDIGIT(n[1]) || ((n[1]=='-' || n[1] == '+') && B_ISDIGIT(n[2])))) {
 365       n += 2;                         /* skip e- or e+ or e digit */
 366       while (B_ISDIGIT(*n)) { n++; }
 367    }
 368    return digit_seen && *n==0;
 369 }
 370
 371 /*
 372  * Check if the specified string is an integer
 373  */
 374 bool is_an_integer(const char *n)
 375 {
 376    bool digit_seen = false;
 377    while (B_ISDIGIT(*n)) {
 378       digit_seen = true;
 379       n++;
 380    }
 381    return digit_seen && *n==0;
 382 }
 383
 384 /*
 385  * Check if Bacula Resoure Name is valid
 386  */
 387 /*
 388  * Check if the Volume name has legal characters
 389  * If ua is non-NULL send the message
 390  */
 391 bool is_name_valid(char *name, POOLMEM **msg)
 392 {
 393    int len;
 394    char *p;
 395    /* Special characters to accept */
 396    const char *accept = ":.-_ ";
 397
 398    /* Restrict the characters permitted in the Volume name */
 399    for (p=name; *p; p++) {
 400       if (B_ISALPHA(*p) || B_ISDIGIT(*p) || strchr(accept, (int)(*p))) {
 401          continue;
 402       }
 403       if (msg) {
 404          Mmsg(msg, _("Illegal character \"%c\" in name.\n"), *p);
 405       }
 406       return false;
 407    }
 408    len = strlen(name);
 409    if (len >= MAX_NAME_LENGTH) {
 410       if (msg) {
 411          Mmsg(msg, _("Name too long.\n"));
 412       }
 413       return false;
 414    }
 415    if (len == 0) {
 416       if (msg) {
 417          Mmsg(msg,  _("Volume name must be at least one character long.\n"));
 418       }
 419       return false;
 420    }
 421    return true;
 422 }
 423
 424
 425
 426 /*
 427  * Add commas to a string, which is presumably
 428  * a number.
 429  */
 430 char *add_commas(char *val, char *buf)
 431 {
 432    int len, nc;
 433    char *p, *q;
 434    int i;
 435
 436    if (val != buf) {
 437       strcpy(buf, val);
 438    }
 439    len = strlen(buf);
 440    if (len < 1) {
 441       len = 1;
 442    }
 443    nc = (len - 1) / 3;
 444    p = buf+len;
 445    q = p + nc;
 446    *q-- = *p--;
 447    for ( ; nc; nc--) {
 448       for (i=0; i < 3; i++) {
 449           *q-- = *p--;
 450       }
 451       *q-- = ',';
 452    }
 453    return buf;
 454 }
 455
 456 #ifdef TEST_PROGRAM
 457 void d_msg(const char*, int, int, const char*, ...)
 458 {}
 459 int main(int argc, char *argv[])
 460 {
 461    char *str[] = {"3", "3n", "3 hours", "3.5 day", "3 week", "3 m", "3 q", "3 years"};
 462    utime_t val;
 463    char buf[100];
 464    char outval[100];
 465
 466    for (int i=0; i<8; i++) {
 467       strcpy(buf, str[i]);
 468       if (!duration_to_utime(buf, &val)) {
 469          printf("Error return from duration_to_utime for in=%s\n", str[i]);
 470          continue;
 471       }
 472       edit_utime(val, outval);
 473       printf("in=%s val=%" lld " outval=%s\n", str[i], val, outval);
 474    }
 475 }
 476 #endif