src/lib/scan.cc

/*
   BAREOS® - Backup Archiving REcovery Open Sourced

   Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
   Copyright (C) 2016-2016 Planets Communications B.V.
   Copyright (C) 2016-2016 Bareos GmbH & Co. KG

   This program is Free Software; you can redistribute it and/or
   modify it under the terms of version three of the GNU Affero General Public
   License as published by the Free Software Foundation and included
   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
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero 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.
*/
/*
 * scan.c -- scanning routines for BAREOS
 *
 * Kern Sibbald, MM  separated from util.c MMIII
 */

#include "include/bareos.h"
#include "jcr.h"

/*
 * Strip leading space from command line arguments
 */
void StripLeadingSpace(char* str)
{
  char* p = str;

  while (B_ISSPACE(*p)) { p++; }
  if (p != str) { bstrinlinecpy(str, p); }
}

/*
 * Strip any trailing junk from the command
 */
void StripTrailingJunk(char* cmd)
{
  char* p;

  /*
   * Strip trailing junk from command
   */
  p = cmd + strlen(cmd) - 1;
  while ((p >= cmd) && (*p == '\n' || *p == '\r' || *p == ' ')) { *p-- = 0; }
}

/*
 * Strip any trailing newline characters from the string
 */
void StripTrailingNewline(char* cmd)
{
  char* p;

  p = cmd + strlen(cmd) - 1;
  while ((p >= cmd) && (*p == '\n' || *p == '\r')) { *p-- = 0; }
}

/*
 * Strip any trailing slashes from a directory path
 */
void StripTrailingSlashes(char* dir)
{
  char* p;

  /*
   * Strip trailing slashes
   */
  p = dir + strlen(dir) - 1;
  while (p >= dir && IsPathSeparator(*p)) { *p-- = 0; }
}

/*
 * Skip spaces
 *  Returns: 0 on failure (EOF)
 *           1 on success
 *           new address in passed parameter
 */
bool SkipSpaces(char** msg)
{
  char* p = *msg;
  if (!p) { return false; }
  while (*p && B_ISSPACE(*p)) { p++; }
  *msg = p;
  return *p ? true : false;
}

/*
 * Skip nonspaces
 *  Returns: 0 on failure (EOF)
 *           1 on success
 *           new address in passed parameter
 */
bool SkipNonspaces(char** msg)
{
  char* p = *msg;

  if (!p) { return false; }
  while (*p && !B_ISSPACE(*p)) { p++; }
  *msg = p;
  return *p ? true : false;
}

/*
 * Folded search for string - case insensitive
 */
int fstrsch(const char* a, const char* b) /* folded case search */
{
  const char *s1, *s2;
  char c1, c2;

  s1 = a;
  s2 = b;
  while (*s1) {                                     /* do it the fast way */
    if ((*s1++ | 0x20) != (*s2++ | 0x20)) return 0; /* failed */
  }
  while (*a) { /* do it over the correct slow way */
    if (B_ISUPPER(c1 = *a)) { c1 = tolower((int)c1); }
    if (B_ISUPPER(c2 = *b)) { c2 = tolower((int)c2); }
    if (c1 != c2) { return 0; }
    a++;
    b++;
  }
  return 1;
}

/*
 * Return next argument from command line.  Note, this
 *   routine is destructive because it stored 0 at the end
 *   of each argument.
 * Called with pointer to pointer to command line. This
 *   pointer is updated to point to the remainder of the
 *   command line.
 *
 * Returns pointer to next argument -- don't store the result
 *   in the pointer you passed as an argument ...
 *   The next argument is terminated by a space unless within
 *   quotes. Double quote characters (unless preceded by a \) are
 *   stripped.
 *
 */
char* next_arg(char** s)
{
  char *p, *q, *n;
  bool in_quote = false;

  /* skip past spaces to next arg */
  for (p = *s; *p && B_ISSPACE(*p);) { p++; }
  Dmsg1(900, "Next arg=%s\n", p);
  for (n = q = p; *p;) {
    if (*p == '\\') { /* slash? */
      p++;            /* yes, skip it */
      if (*p) {
        *q++ = *p++;
      } else {
        *q++ = *p;
      }
      continue;
    }
    if (*p == '"') { /* start or end of quote */
      p++;
      in_quote = !in_quote; /* change state */
      continue;
    }
    if (!in_quote && B_ISSPACE(*p)) { /* end of field */
      p++;
      break;
    }
    *q++ = *p++;
  }
  *q = 0;
  *s = p;
  Dmsg2(900, "End arg=%s next=%s\n", n, p);
  return n;
}

/*
 * This routine parses the input command line.
 * It makes a copy in args, then builds an
 *  argc, argk, argv list where:
 *
 *  argc = count of arguments
 *  argk[i] = argument keyword (part preceding =)
 *  argv[i] = argument value (part after =)
 *
 *  example:  arg1 arg2=abc arg3=
 *
 *  argc = c
 *  argk[0] = arg1
 *  argv[0] = NULL
 *  argk[1] = arg2
 *  argv[1] = abc
 *  argk[2] = arg3
 *  argv[2] =
 */
int ParseArgs(POOLMEM* cmd,
              POOLMEM*& args,
              int* argc,
              char** argk,
              char** argv,
              int max_args)
{
  char* p;

  ParseArgsOnly(cmd, args, argc, argk, argv, max_args);

  /* Separate keyword and value */
  for (int i = 0; i < *argc; i++) {
    p = strchr(argk[i], '=');
    if (p) { *p++ = 0; /* Terminate keyword and point to value */ }
    argv[i] = p; /* save ptr to value or NULL */
  }
  return 1;
}


/*
 * This routine parses the input command line.
 *   It makes a copy in args, then builds an
 *   argc, argk, but no argv (values).
 *   This routine is useful for scanning command lines where the data
 *   is a filename and no keywords are expected.  If we scan a filename
 *   for keywords, any = in the filename will be interpreted as the
 *   end of a keyword, and this is not good.
 *
 *  argc = count of arguments
 *  argk[i] = argument keyword (part preceding =)
 *  argv[i] = NULL
 *
 *  example:  arg1 arg2=abc arg3=
 *
 *  argc = c
 *  argk[0] = arg1
 *  argv[0] = NULL
 *  argk[1] = arg2=abc
 *  argv[1] = NULL
 *  argk[2] = arg3
 *  argv[2] =
 */
int ParseArgsOnly(POOLMEM* cmd,
                  POOLMEM*& args,
                  int* argc,
                  char** argk,
                  char** argv,
                  int max_args)
{
  char *p, *n;

  PmStrcpy(args, cmd);
  StripTrailingJunk(args);
  p = args;
  *argc = 0;
  /*
   * Pick up all arguments
   */
  while (*argc < max_args) {
    n = next_arg(&p);
    if (*n) {
      argk[*argc] = n;
      argv[(*argc)++] = NULL;
    } else {
      break;
    }
  }
  return 1;
}

/*
 * Given a full filename, split it into its path and filename parts.
 * They are returned in pool memory in the arguments provided.
 */
void SplitPathAndFilename(const char* fname,
                          POOLMEM*& path,
                          int* pnl,
                          POOLMEM*& file,
                          int* fnl)
{
  const char* f;
  int slen;
  int len = slen = strlen(fname);

  /*
   * Find path without the filename.
   * I.e. everything after the last / is a "filename".
   * OK, maybe it is a directory name, but we treat it like
   * a filename. If we don't find a / then the whole name
   * must be a path name (e.g. c:).
   */
  f = fname + len - 1;
  /* "strip" any trailing slashes */
  while (slen > 1 && IsPathSeparator(*f)) {
    slen--;
    f--;
  }
  /* Walk back to last slash -- begin of filename */
  while (slen > 0 && !IsPathSeparator(*f)) {
    slen--;
    f--;
  }
  if (IsPathSeparator(*f)) { /* did we find a slash? */
    f++;                     /* yes, point to filename */
  } else {                   /* no, whole thing must be path name */
    f = fname;
  }
  Dmsg2(200, "after strip len=%d f=%s\n", len, f);
  *fnl = fname - f + len;
  if (*fnl > 0) {
    file = CheckPoolMemorySize(file, *fnl + 1);
    memcpy(file, f, *fnl); /* copy filename */
  }
  file[*fnl] = '\0';

  *pnl = f - fname;
  if (*pnl > 0) {
    path = CheckPoolMemorySize(path, *pnl + 1);
    memcpy(path, fname, *pnl);
  }
  path[*pnl] = '\0';

  Dmsg2(200, "pnl=%d fnl=%d\n", *pnl, *fnl);
  Dmsg3(200, "split fname=%s path=%s file=%s\n", fname, path, file);
}

/*
 * Extremely simple sscanf. Handles only %(u,d,hu,hd,ld,qd,qu,lu,lld,llu,c,nns)
 */
const int BIG = 1000;
int bsscanf(const char* buf, const char* fmt, ...)
{
  va_list ap;
  int count = 0;
  void* vp;
  char* cp;
  int l = 0;
  int h = 0;
  int max_len = BIG;
  uint64_t value;
  bool error = false;
  bool negative;

  va_start(ap, fmt);
  while (*fmt && !error) {
    if (*fmt == '%') {
      fmt++;
    switch_top:
      switch (*fmt++) {
        case 'u':
          value = 0;
          while (B_ISDIGIT(*buf)) { value = B_TIMES10(value) + *buf++ - '0'; }
          vp = (void*)va_arg(ap, void*);
          if (h == 1) {
            *((uint16_t*)vp) = (int16_t)value;
          } else if (l == 0) {
            *((unsigned int*)vp) = (unsigned int)value;
          } else if (l == 1) {
            *((uint32_t*)vp) = (uint32_t)value;
          } else {
            *((uint64_t*)vp) = (uint64_t)value;
          }
          count++;
          h = 0;
          l = 0;
          break;
        case 'd':
          value = 0;
          if (*buf == '-') {
            negative = true;
            buf++;
          } else {
            negative = false;
          }
          while (B_ISDIGIT(*buf)) { value = B_TIMES10(value) + *buf++ - '0'; }
          if (negative) { value = -value; }
          vp = (void*)va_arg(ap, void*);
          if (h == 1) {
            *((int16_t*)vp) = (int16_t)value;
          } else if (l == 0) {
            *((int*)vp) = (int)value;
          } else if (l == 1) {
            *((int32_t*)vp) = (int32_t)value;
          } else {
            *((int64_t*)vp) = (int64_t)value;
          }
          count++;
          h = 0;
          l = 0;
          break;
        case 'h':
          h = 1;
          if (*fmt == 'd' || *fmt == 'u') { goto switch_top; }
          error = true;
          break;
        case 'l':
          l = 1;
          if (*fmt == 'l') {
            l++;
            fmt++;
          }
          if (*fmt == 'd' || *fmt == 'u') { goto switch_top; }
          error = true;
          break;
        case 'q':
          l = 2;
          if (*fmt == 'd' || *fmt == 'u') { goto switch_top; }
          error = true;
          break;
        case 's':
          cp = (char*)va_arg(ap, char*);
          while (*buf && !B_ISSPACE(*buf) && max_len-- > 0) { *cp++ = *buf++; }
          *cp = 0;
          count++;
          max_len = BIG;
          break;
        case 'c':
          cp = (char*)va_arg(ap, char*);
          *cp = *buf++;
          count++;
          break;
        case '%':
          if (*buf++ != '%') { error = true; }
          break;
        default:
          fmt--;
          max_len = 0;
          while (B_ISDIGIT(*fmt)) {
            max_len = B_TIMES10(max_len) + *fmt++ - '0';
          }
          if (*fmt == 's') { goto switch_top; }
          error = true;
          break; /* error: unknown format */
      }
      continue;

      /* White space eats zero or more whitespace */
    } else if (B_ISSPACE(*fmt)) {
      fmt++;
      while (B_ISSPACE(*buf)) { buf++; }
      /* Plain text must match */
    } else if (*buf++ != *fmt++) {
      //       Dmsg2(000, "Mismatch buf=%c fmt=%c\n", *--buf, *--fmt);
      error = true;
      break;
    }
  }
  va_end(ap);
  // Dmsg2(000, "Error=%d count=%d\n", error, count);
  if (error) { count = -1; }
  return count;
}