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

   1 /*
   2  *   util.c  miscellaneous utility subroutines for Bacula
   3  *
   4  *    Kern Sibbald, MM
   5  *
   6  *   Version $Id$
   7  */
   8
   9 /*
  10    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  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 "jcr.h"
  31 #include "findlib/find.h"
  32
  33 /*
  34  * Various Bacula Utility subroutines
  35  *
  36  */
  37
  38 /* Return true of buffer has all zero bytes */
  39 int is_buf_zero(char *buf, int len)
  40 {
  41    uint64_t *ip = (uint64_t *)buf;
  42    char *p;
  43    int i, len64, done, rem;
  44
  45    /* Optimize by checking uint64_t for zero */
  46    len64 = len >> sizeof(uint64_t);
  47    for (i=0; i < len64; i++) {
  48       if (ip[i] != 0) {
  49          return 0;
  50       }
  51    }
  52    done = len64 << sizeof(uint64_t);  /* bytes already checked */
  53    p = buf + done;
  54    rem = len - done;
  55    for (i = 0; i < rem; i++) {
  56       if (p[i] != 0) {
  57          return 0;
  58       }
  59    }
  60    return 1;
  61 }
  62
  63
  64 /* Convert a string in place to lower case */
  65 void lcase(char *str)
  66 {
  67    while (*str) {
  68       if (B_ISUPPER(*str))
  69          *str = tolower((int)(*str));
  70        str++;
  71    }
  72 }
  73
  74 /* Convert spaces to non-space character.
  75  * This makes scanf of fields containing spaces easier.
  76  */
  77 void
  78 bash_spaces(char *str)
  79 {
  80    while (*str) {
  81       if (*str == ' ')
  82          *str = 0x1;
  83       str++;
  84    }
  85 }
  86
  87 /* Convert non-space characters (0x1) back into spaces */
  88 void
  89 unbash_spaces(char *str)
  90 {
  91    while (*str) {
  92      if (*str == 0x1)
  93         *str = ' ';
  94      str++;
  95    }
  96 }
  97
  98 /* Strip any trailing junk from the command */
  99 void strip_trailing_junk(char *cmd)
 100 {
 101    char *p;
 102    p = cmd + strlen(cmd) - 1;
 103
 104    /* strip trailing junk from command */
 105    while ((p >= cmd) && (*p == '\n' || *p == '\r' || *p == ' '))
 106       *p-- = 0;
 107 }
 108
 109 /* Strip any trailing slashes from a directory path */
 110 void strip_trailing_slashes(char *dir)
 111 {
 112    char *p;
 113    p = dir + strlen(dir) - 1;
 114
 115    /* strip trailing slashes */
 116    while ((p >= dir) && (*p == '/'))
 117       *p-- = 0;
 118 }
 119
 120 /*
 121  * Skip spaces
 122  *  Returns: 0 on failure (EOF)
 123  *           1 on success
 124  *           new address in passed parameter
 125  */
 126 int skip_spaces(char **msg)
 127 {
 128    char *p = *msg;
 129    if (!p) {
 130       return 0;
 131    }
 132    while (*p && *p == ' ') {
 133       p++;
 134    }
 135    *msg = p;
 136    return *p ? 1 : 0;
 137 }
 138
 139 /*
 140  * Skip nonspaces
 141  *  Returns: 0 on failure (EOF)
 142  *           1 on success
 143  *           new address in passed parameter
 144  */
 145 int skip_nonspaces(char **msg)
 146 {
 147    char *p = *msg;
 148
 149    if (!p) {
 150       return 0;
 151    }
 152    while (*p && *p != ' ') {
 153       p++;
 154    }
 155    *msg = p;
 156    return *p ? 1 : 0;
 157 }
 158
 159 /* folded search for string - case insensitive */
 160 int
 161 fstrsch(char *a, char *b)   /* folded case search */
 162 {
 163    register char *s1,*s2;
 164    register char c1, c2;
 165
 166    s1=a;
 167    s2=b;
 168    while (*s1) {                      /* do it the fast way */
 169       if ((*s1++ | 0x20) != (*s2++ | 0x20))
 170          return 0;                    /* failed */
 171    }
 172    while (*a) {                       /* do it over the correct slow way */
 173       if (B_ISUPPER(c1 = *a)) {
 174          c1 = tolower((int)c1);
 175       }
 176       if (B_ISUPPER(c2 = *b)) {
 177          c2 = tolower((int)c2);
 178       }
 179       if (c1 != c2) {
 180          return 0;
 181       }
 182       a++;
 183       b++;
 184    }
 185    return 1;
 186 }
 187
 188
 189 char *encode_time(time_t time, char *buf)
 190 {
 191    struct tm tm;
 192    int n = 0;
 193
 194    if (localtime_r(&time, &tm)) {
 195       n = sprintf(buf, "%04d-%02d-%02d %02d:%02d:%02d",
 196                    tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
 197                    tm.tm_hour, tm.tm_min, tm.tm_sec);
 198    }
 199    return buf+n;
 200 }
 201
 202 /*
 203  * Concatenate a string (str) onto a pool memory buffer pm
 204  */
 205 void pm_strcat(POOLMEM **pm, char *str)
 206 {
 207    int pmlen = strlen(*pm);
 208    int len = strlen(str) + 1;
 209
 210    *pm = check_pool_memory_size(*pm, pmlen + len);
 211    memcpy(*pm+pmlen, str, len);
 212 }
 213
 214
 215 /*
 216  * Copy a string (str) into a pool memory buffer pm
 217  */
 218 void pm_strcpy(POOLMEM **pm, char *str)
 219 {
 220    int len = strlen(str) + 1;
 221
 222    *pm = check_pool_memory_size(*pm, len);
 223    memcpy(*pm, str, len);
 224 }
 225
 226
 227 /*
 228  * Convert a JobStatus code into a human readable form
 229  */
 230 void jobstatus_to_ascii(int JobStatus, char *msg, int maxlen)
 231 {
 232    char *termstat, jstat[2];
 233
 234    switch (JobStatus) {
 235       case JS_Terminated:
 236          termstat = _("OK");
 237          break;
 238      case JS_FatalError:
 239      case JS_ErrorTerminated:
 240          termstat = _("Error");
 241          break;
 242      case JS_Error:
 243          termstat = _("Non-fatal error");
 244          break;
 245      case JS_Cancelled:
 246          termstat = _("Cancelled");
 247          break;
 248      case JS_Differences:
 249          termstat = _("Verify differences");
 250          break;
 251      default:
 252          jstat[0] = last_job.JobStatus;
 253          jstat[1] = 0;
 254          termstat = jstat;
 255          break;
 256    }
 257    bstrncpy(msg, termstat, maxlen);
 258 }
 259
 260 /*
 261  * Convert Job Termination Status into a string
 262  */
 263 char *job_status_to_str(int stat)
 264 {
 265    char *str;
 266
 267    switch (stat) {
 268    case JS_Terminated:
 269       str = _("OK");
 270       break;
 271    case JS_ErrorTerminated:
 272    case JS_Error:
 273       str = _("Error");
 274       break;
 275    case JS_FatalError:
 276       str = _("Fatal Error");
 277       break;
 278    case JS_Cancelled:
 279       str = _("Cancelled");
 280       break;
 281    case JS_Differences:
 282       str = _("Differences");
 283       break;
 284    default:
 285       str = _("Unknown term code");
 286       break;
 287    }
 288    return str;
 289 }
 290
 291
 292 /*
 293  * Convert Job Type into a string
 294  */
 295 char *job_type_to_str(int type)
 296 {
 297    char *str;
 298
 299    switch (type) {
 300    case JT_BACKUP:
 301       str = _("Backup");
 302       break;
 303    case JT_VERIFY:
 304       str = _("Verify");
 305       break;
 306    case JT_RESTORE:
 307       str = _("Restore");
 308       break;
 309    case JT_ADMIN:
 310       str = _("Admin");
 311       break;
 312    default:
 313       str = _("Unknown Type");
 314       break;
 315    }
 316    return str;
 317 }
 318
 319 /*
 320  * Convert Job Level into a string
 321  */
 322 char *job_level_to_str(int level)
 323 {
 324    char *str;
 325
 326    switch (level) {
 327    case L_FULL:
 328       str = _("Full");
 329       break;
 330    case L_INCREMENTAL:
 331       str = _("Incremental");
 332       break;
 333    case L_DIFFERENTIAL:
 334       str = _("Differential");
 335       break;
 336    case L_SINCE:
 337       str = _("Since");
 338       break;
 339    case L_VERIFY_CATALOG:
 340       str = _("Verify Catalog");
 341       break;
 342    case L_VERIFY_INIT:
 343       str = _("Verify Init Catalog");
 344       break;
 345    case L_VERIFY_VOLUME_TO_CATALOG:
 346       str = _("Verify Volume to Catalog");
 347       break;
 348    case L_VERIFY_DATA:
 349       str = _("Verify Data");
 350       break;
 351    default:
 352       str = _("Unknown Job Level");
 353       break;
 354    }
 355    return str;
 356 }
 357
 358
 359 /***********************************************************************
 360  * Encode the mode bits into a 10 character string like LS does
 361  ***********************************************************************/
 362
 363 char *encode_mode(mode_t mode, char *buf)
 364 {
 365   char *cp = buf;
 366
 367   *cp++ = S_ISDIR(mode) ? 'd' : S_ISBLK(mode) ? 'b' : S_ISCHR(mode) ? 'c' :
 368           S_ISLNK(mode) ? 'l' : '-';
 369   *cp++ = mode & S_IRUSR ? 'r' : '-';
 370   *cp++ = mode & S_IWUSR ? 'w' : '-';
 371   *cp++ = (mode & S_ISUID
 372                ? (mode & S_IXUSR ? 's' : 'S')
 373                : (mode & S_IXUSR ? 'x' : '-'));
 374   *cp++ = mode & S_IRGRP ? 'r' : '-';
 375   *cp++ = mode & S_IWGRP ? 'w' : '-';
 376   *cp++ = (mode & S_ISGID
 377                ? (mode & S_IXGRP ? 's' : 'S')
 378                : (mode & S_IXGRP ? 'x' : '-'));
 379   *cp++ = mode & S_IROTH ? 'r' : '-';
 380   *cp++ = mode & S_IWOTH ? 'w' : '-';
 381   *cp++ = (mode & S_ISVTX
 382                ? (mode & S_IXOTH ? 't' : 'T')
 383                : (mode & S_IXOTH ? 'x' : '-'));
 384   *cp = '\0';
 385   return cp;
 386 }
 387
 388
 389 int do_shell_expansion(char *name)
 390 {
 391 /*  ****FIXME***** this should work for Win32 too */
 392 #define UNIX
 393 #ifdef UNIX
 394 #ifndef PATH_MAX
 395 #define PATH_MAX 512
 396 #endif
 397
 398    int pid, wpid, stat;
 399    int waitstatus;
 400    char *shellcmd;
 401    void (*istat)(int), (*qstat)(int);
 402    int i;
 403    char echout[PATH_MAX + 256];
 404    int pfd[2];
 405    static char meta[] = "~\\$[]*?`'<>\"";
 406    int found = FALSE;
 407    int len;
 408
 409    /* Check if any meta characters are present */
 410    len = strlen(meta);
 411    for (i = 0; i < len; i++) {
 412       if (strchr(name, meta[i])) {
 413          found = TRUE;
 414          break;
 415       }
 416    }
 417    stat = 0;
 418    if (found) {
 419 #ifdef nt
 420        /* If the filename appears to be a DOS filename,
 421           convert all backward slashes \ to Unix path
 422           separators / and insert a \ infront of spaces. */
 423        len = strlen(name);
 424        if (len >= 3 && name[1] == ':' && name[2] == '\\') {
 425           for (i=2; i<len; i++)
 426              if (name[i] == '\\')
 427                 name[i] = '/';
 428        }
 429 #else
 430        /* Pass string off to the shell for interpretation */
 431        if (pipe(pfd) == -1)
 432           return 0;
 433        switch(pid = fork()) {
 434        case -1:
 435           break;
 436
 437        case 0:                            /* child */
 438           /* look for shell */
 439           if ((shellcmd = getenv("SHELL")) == NULL)
 440              shellcmd = "/bin/sh";
 441           close(1); dup(pfd[1]);          /* attach pipes to stdin and stdout */
 442           close(2); dup(pfd[1]);
 443           for (i = 3; i < 32; i++)        /* close everything else */
 444              close(i);
 445           strcpy(echout, "echo ");        /* form echo command */
 446           strcat(echout, name);
 447           execl(shellcmd, shellcmd, "-c", echout, NULL); /* give to shell */
 448           exit(127);                      /* shouldn't get here */
 449
 450        default:                           /* parent */
 451           /* read output from child */
 452           i = read(pfd[0], echout, sizeof echout);
 453           echout[--i] = 0;                /* set end of string */
 454           /* look for first word or first line. */
 455           while (--i >= 0) {
 456              if (echout[i] == ' ' || echout[i] == '\n')
 457                 echout[i] = 0;            /* keep only first one */
 458           }
 459           istat = signal(SIGINT, SIG_IGN);
 460           qstat = signal(SIGQUIT, SIG_IGN);
 461           /* wait for child to exit */
 462           while ((wpid = wait(&waitstatus)) != pid && wpid != -1)
 463              { ; }
 464           signal(SIGINT, istat);
 465           signal(SIGQUIT, qstat);
 466           strcpy(name, echout);
 467           stat = 1;
 468           break;
 469        }
 470        close(pfd[0]);                     /* close pipe */
 471        close(pfd[1]);
 472 #endif /* nt */
 473    }
 474    return stat;
 475
 476 #endif /* UNIX */
 477
 478 #if  MSC | MSDOS | __WATCOMC__
 479
 480    char prefix[100], *env, *getenv();
 481
 482    /* Home directory reference? */
 483    if (*name == '~' && (env=getenv("HOME"))) {
 484       strcpy(prefix, env);            /* copy HOME directory name */
 485       name++;                         /* skip over ~ in name */
 486       strcat(prefix, name);
 487       name--;                         /* get back to beginning */
 488       strcpy(name, prefix);           /* move back into name */
 489    }
 490    return 1;
 491 #endif
 492
 493 }
 494
 495
 496 /*  MAKESESSIONKEY  --  Generate session key with optional start
 497                         key.  If mode is TRUE, the key will be
 498                         translated to a string, otherwise it is
 499                         returned as 16 binary bytes.
 500
 501     from SpeakFreely by John Walker */
 502
 503 void makeSessionKey(char *key, char *seed, int mode)
 504 {
 505      int j, k;
 506      struct MD5Context md5c;
 507      unsigned char md5key[16], md5key1[16];
 508      char s[1024];
 509
 510      s[0] = 0;
 511      if (seed != NULL) {
 512         strcat(s, seed);
 513      }
 514
 515      /* The following creates a seed for the session key generator
 516         based on a collection of volatile and environment-specific
 517         information unlikely to be vulnerable (as a whole) to an
 518         exhaustive search attack.  If one of these items isn't
 519         available on your machine, replace it with something
 520         equivalent or, if you like, just delete it. */
 521
 522      sprintf(s + strlen(s), "%lu", (unsigned long) getpid());
 523      sprintf(s + strlen(s), "%lu", (unsigned long) getppid());
 524      getcwd(s + strlen(s), 256);
 525      sprintf(s + strlen(s), "%lu", (unsigned long) clock());
 526      sprintf(s + strlen(s), "%lu", (unsigned long) time(NULL));
 527 #ifdef Solaris
 528      sysinfo(SI_HW_SERIAL,s + strlen(s), 12);
 529 #endif
 530 #ifdef HAVE_GETHOSTID
 531      sprintf(s + strlen(s), "%lu", (unsigned long) gethostid());
 532 #endif
 533 #ifdef HAVE_GETDOMAINNAME
 534      getdomainname(s + strlen(s), 256);
 535 #endif
 536      gethostname(s + strlen(s), 256);
 537      sprintf(s + strlen(s), "%u", (unsigned)getuid());
 538      sprintf(s + strlen(s), "%u", (unsigned)getgid());
 539      MD5Init(&md5c);
 540      MD5Update(&md5c, (unsigned char *)s, strlen(s));
 541      MD5Final(md5key, &md5c);
 542      sprintf(s + strlen(s), "%lu", (unsigned long) ((time(NULL) + 65121) ^ 0x375F));
 543      MD5Init(&md5c);
 544      MD5Update(&md5c, (unsigned char *)s, strlen(s));
 545      MD5Final(md5key1, &md5c);
 546 #define nextrand    (md5key[j] ^ md5key1[j])
 547      if (mode) {
 548         for (j = k = 0; j < 16; j++) {
 549             unsigned char rb = nextrand;
 550
 551 #define Rad16(x) ((x) + 'A')
 552             key[k++] = Rad16((rb >> 4) & 0xF);
 553             key[k++] = Rad16(rb & 0xF);
 554 #undef Rad16
 555             if (j & 1) {
 556                  key[k++] = '-';
 557             }
 558         }
 559         key[--k] = 0;
 560      } else {
 561         for (j = 0; j < 16; j++) {
 562             key[j] = nextrand;
 563         }
 564      }
 565 }
 566 #undef nextrand