src/lib/util.cc

/*
   BAREOS® - Backup Archiving REcovery Open Sourced

   Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
   Copyright (C) 2016-2018 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.
*/
/*
 * util.c  miscellaneous utility subroutines for BAREOS
 *
 * Kern Sibbald, MM
 */

#include "include/bareos.h"
#include "include/jcr.h"
#include "lib/edit.h"
#include "lib/ascii_control_characters.h"
#include "lib/bstringlist.h"
#include "lib/qualified_resource_name_type_converter.h"
#include "include/version_numbers.h"

#include <algorithm>
#include <string>

/*
 * Various BAREOS Utility subroutines
 */

/*
 * Escape special characters in bareos configuration strings
 * needed for dumping config strings
 */
void EscapeString(PoolMem& snew, const char* old, int len)
{
  char* n;
  const char* o;

  snew.check_size(len * 2);
  n = snew.c_str();
  o = old;
  while (len--) {
    switch (*o) {
      case '\'':
        *n++ = '\'';
        *n++ = '\'';
        o++;
        break;
      case '\\':
        *n++ = '\\';
        *n++ = '\\';
        o++;
        break;
      case 0:
        *n++ = '\\';
        *n++ = 0;
        o++;
        break;
      case '(':
      case ')':
      case '<':
      case '>':
      case '"':
        *n++ = '\\';
        *n++ = *o++;
        break;
      default:
        *n++ = *o++;
        break;
    }
  }
  *n = 0;
}

/*
 * Return true of buffer has all zero bytes
 */
bool IsBufZero(char* buf, int len)
{
  uint64_t* ip;
  char* p;
  int i, len64, done, rem;

  if (buf[0] != 0) { return false; }
  ip = (uint64_t*)buf;

  /*
   * Optimize by checking uint64_t for zero
   */
  len64 = len / sizeof(uint64_t);
  for (i = 0; i < len64; i++) {
    if (ip[i] != 0) { return false; }
  }
  done = len64 * sizeof(uint64_t); /* bytes already checked */
  p = buf + done;
  rem = len - done;
  for (i = 0; i < rem; i++) {
    if (p[i] != 0) { return false; }
  }
  return true;
}


/*
 * Convert a string in place to lower case
 */
void lcase(char* str)
{
  while (*str) {
    if (B_ISUPPER(*str)) { *str = tolower((int)(*str)); }
    str++;
  }
}

/*
 * Convert spaces to non-space character.
 * This makes scanf of fields containing spaces easier.
 */
void BashSpaces(char* str)
{
  while (*str) {
    if (*str == ' ') *str = 0x1;
    str++;
  }
}

void BashSpaces(std::string& str)
{
  std::replace(str.begin(), str.end(), ' ', static_cast<char>(0x1));
}

void BashSpaces(PoolMem& pm)
{
  char* str = pm.c_str();
  while (*str) {
    if (*str == ' ') *str = 0x1;
    str++;
  }
}

/*
 * Convert non-space characters (0x1) back into spaces
 */
void UnbashSpaces(char* str)
{
  while (*str) {
    if (*str == 0x1) *str = ' ';
    str++;
  }
}

/*
 * Convert non-space characters (0x1) back into spaces
 */
void UnbashSpaces(PoolMem& pm)
{
  char* str = pm.c_str();
  while (*str) {
    if (*str == 0x1) *str = ' ';
    str++;
  }
}

struct HelloInformation {
  std::string hello_string;
  std::string resource_type_string;
  uint32_t position_of_name;
  int32_t position_of_version;
};

using SizeTypeOfHelloList = std::vector<std::string>::size_type;

static std::list<HelloInformation> hello_list{
    /* this order is important */
    {"Hello Storage calling Start Job", "R_JOB", 5, -1},
    {"Hello Start Storage Job", "R_JOB", 4, -1},
    {"Hello Start Job", "R_JOB", 3, -1},
    {"Hello Director", "R_DIRECTOR", 2, -1},
    {"Hello Storage", "R_STORAGE", 2, -1},
    {"Hello Client", "R_CLIENT", 2, -1},
    {"Hello", "R_CONSOLE", 1, 4} /* "Hello %s calling version %s" */
};

bool GetNameAndResourceTypeAndVersionFromHello(
    const std::string& input,
    std::string& name,
    std::string& r_type_str,
    BareosVersionNumber& bareos_version)
{
  std::list<HelloInformation>::const_iterator hello = hello_list.cbegin();

  bool found = false;
  while (hello != hello_list.cend()) {
    uint32_t size = hello->hello_string.size();
    uint32_t input_size = input.size();
    if (input_size >= size) {
      if (!input.compare(0, size, hello->hello_string)) {
        found = true;
        break;
      }
    }
    hello++;
  }

  if (!found) {
    Dmsg1(100, "Client information not found: %s", input.c_str());
    return false;
  }

  BStringList arguments_of_hello_string(input, ' '); /* split at blanks */

  bool ok = false;
  if (arguments_of_hello_string.size() > hello->position_of_name) {
    name = arguments_of_hello_string[hello->position_of_name];
    std::replace(name.begin(), name.end(), (char)0x1, ' ');
    r_type_str = hello->resource_type_string;
    ok = true;
  } else {
    Dmsg0(100, "Failed to retrieve the name from hello message\n");
  }

  if (ok) {
    bareos_version = BareosVersionNumber::kUndefined;
    if (hello->position_of_version >= 0) {
      if (arguments_of_hello_string.size() >
          static_cast<SizeTypeOfHelloList>(hello->position_of_version)) {
        std::string version_str =
            arguments_of_hello_string[hello->position_of_version];
        if (!version_str.empty()) {
          ok = false;
          BStringList splittet_version(version_str, '.');
          if (splittet_version.size() > 1) {
            uint32_t v;
            try {
              v = std::stoul(splittet_version[0]) * 100;
              v += std::stoul(splittet_version[1]);
              bareos_version = static_cast<BareosVersionNumber>(v);
              ok = true;
            } catch (const std::exception& e) {
              Dmsg0(100, "Could not read out any version from hello message\n");
            }
          }
        }
      }
    }
  }

  return ok;
}

/*
 * Parameter:
 *   resultbuffer: one line string
 *   mutlilinestring: multiline string (separated by "\n")
 *   separator: separator string
 *
 * multilinestring should be indented according to resultbuffer.
 *
 * return:
 *   resultbuffer: multilinestring will be added to resultbuffer.
 *
 * Example:
 *   resultbuffer="initial string"
 *   mutlilinestring="line1\nline2\nline3"
 *   separator="->"
 * Result:
 *   initial string->line1
 *                 ->line2
 *                 ->line3
 */
const char* IndentMultilineString(PoolMem& resultbuffer,
                                  const char* multilinestring,
                                  const char* separator)
{
  PoolMem multiline(multilinestring);
  PoolMem indent(PM_MESSAGE);
  char* p1 = multiline.c_str();
  char* p2 = NULL;
  bool line1 = true;
  size_t len;

  /* create indentation string */
  for (len = resultbuffer.strlen(); len > 0; len--) { indent.strcat(" "); }
  indent.strcat(separator);

  resultbuffer.strcat(separator);

  while ((p2 = strchr(p1, '\n')) != NULL) {
    *p2 = 0;
    if (!line1) { resultbuffer.strcat(indent); }
    resultbuffer.strcat(p1);
    resultbuffer.strcat("\n");
    p1 = p2 + 1;
    line1 = false;
  }

  if (!line1) { resultbuffer.strcat(indent); }
  resultbuffer.strcat(p1);

  return resultbuffer.c_str();
}

char* encode_time(utime_t utime, char* buf)
{
  struct tm tm;
  int n = 0;
  time_t time = utime;

#if defined(HAVE_WIN32)
  /*
   * Avoid a seg fault in Microsoft's CRT localtime_r(),
   * which incorrectly references a NULL returned from gmtime() if
   * time is negative before or after the timezone adjustment.
   */
  struct tm* gtm;

  if ((gtm = gmtime(&time)) == NULL) { return buf; }

  if (gtm->tm_year == 1970 && gtm->tm_mon == 1 && gtm->tm_mday < 3) {
    return buf;
  }
#endif

  Blocaltime(&time, &tm);
  n = sprintf(buf, "%04d-%02d-%02d %02d:%02d:%02d", tm.tm_year + 1900,
              tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec);

  return buf + n;
}

bool ConvertTimeoutToTimespec(timespec& timeout, int timeout_in_seconds)
{
  struct timeval tv;
  struct timezone tz;

  gettimeofday(&tv, &tz);
  timeout.tv_nsec = tv.tv_usec * 1000;
  timeout.tv_sec = tv.tv_sec + timeout_in_seconds;

  return true;
}

/*
 * Convert a JobStatus code into a human readable form
 */
void JobstatusToAscii(int JobStatus, char* msg, int maxlen)
{
  const char* jobstat;
  char buf[100];

  switch (JobStatus) {
    case JS_Created:
      jobstat = _("Created");
      break;
    case JS_Running:
      jobstat = _("Running");
      break;
    case JS_Blocked:
      jobstat = _("Blocked");
      break;
    case JS_Terminated:
      jobstat = _("OK");
      break;
    case JS_Incomplete:
      jobstat = _("Error: incomplete job");
      break;
    case JS_FatalError:
      jobstat = _("Fatal Error");
      break;
    case JS_ErrorTerminated:
      jobstat = _("Error");
      break;
    case JS_Error:
      jobstat = _("Non-fatal error");
      break;
    case JS_Warnings:
      jobstat = _("OK -- with warnings");
      break;
    case JS_Canceled:
      jobstat = _("Canceled");
      break;
    case JS_Differences:
      jobstat = _("Verify differences");
      break;
    case JS_WaitFD:
      jobstat = _("Waiting on FD");
      break;
    case JS_WaitSD:
      jobstat = _("Wait on SD");
      break;
    case JS_WaitMedia:
      jobstat = _("Wait for new Volume");
      break;
    case JS_WaitMount:
      jobstat = _("Waiting for mount");
      break;
    case JS_WaitStoreRes:
      jobstat = _("Waiting for Storage resource");
      break;
    case JS_WaitJobRes:
      jobstat = _("Waiting for Job resource");
      break;
    case JS_WaitClientRes:
      jobstat = _("Waiting for Client resource");
      break;
    case JS_WaitMaxJobs:
      jobstat = _("Waiting on Max Jobs");
      break;
    case JS_WaitStartTime:
      jobstat = _("Waiting for Start Time");
      break;
    case JS_WaitPriority:
      jobstat = _("Waiting on Priority");
      break;
    case JS_DataCommitting:
      jobstat = _("SD committing Data");
      break;
    case JS_DataDespooling:
      jobstat = _("SD despooling Data");
      break;
    case JS_AttrDespooling:
      jobstat = _("SD despooling Attributes");
      break;
    case JS_AttrInserting:
      jobstat = _("Dir inserting Attributes");
      break;
    default:
      if (JobStatus == 0) {
        buf[0] = 0;
      } else {
        Bsnprintf(buf, sizeof(buf), _("Unknown Job termination status=%d"),
                  JobStatus);
      }
      jobstat = buf;
      break;
  }
  bstrncpy(msg, jobstat, maxlen);
}

/*
 * Convert a JobStatus code into a human readable form - gui version
 */
void JobstatusToAsciiGui(int JobStatus, char* msg, int maxlen)
{
  const char* cnv = NULL;
  switch (JobStatus) {
    case JS_Terminated:
      cnv = _("Completed successfully");
      break;
    case JS_Warnings:
      cnv = _("Completed with warnings");
      break;
    case JS_ErrorTerminated:
      cnv = _("Terminated with errors");
      break;
    case JS_FatalError:
      cnv = _("Fatal error");
      break;
    case JS_Created:
      cnv = _("Created, not yet running");
      break;
    case JS_Canceled:
      cnv = _("Canceled by user");
      break;
    case JS_Differences:
      cnv = _("Verify found differences");
      break;
    case JS_WaitFD:
      cnv = _("Waiting for File daemon");
      break;
    case JS_WaitSD:
      cnv = _("Waiting for Storage daemon");
      break;
    case JS_WaitPriority:
      cnv = _("Waiting for higher priority jobs");
      break;
    case JS_AttrInserting:
      cnv = _("Batch inserting file records");
      break;
  }

  if (cnv) {
    bstrncpy(msg, cnv, maxlen);
  } else {
    JobstatusToAscii(JobStatus, msg, maxlen);
  }
}

/*
 * Convert Job Termination Status into a string
 */
const char* job_status_to_str(int stat)
{
  const char* str;

  switch (stat) {
    case JS_Terminated:
      str = _("OK");
      break;
    case JS_Warnings:
      str = _("OK -- with warnings");
      break;
    case JS_ErrorTerminated:
    case JS_Error:
      str = _("Error");
      break;
    case JS_FatalError:
      str = _("Fatal Error");
      break;
    case JS_Canceled:
      str = _("Canceled");
      break;
    case JS_Differences:
      str = _("Differences");
      break;
    default:
      str = _("Unknown term code");
      break;
  }
  return str;
}

/*
 * Convert Job Type into a string
 */
const char* job_type_to_str(int type)
{
  const char* str = NULL;

  switch (type) {
    case JT_BACKUP:
      str = _("Backup");
      break;
    case JT_MIGRATED_JOB:
      str = _("Migrated Job");
      break;
    case JT_VERIFY:
      str = _("Verify");
      break;
    case JT_RESTORE:
      str = _("Restore");
      break;
    case JT_CONSOLE:
      str = _("Console");
      break;
    case JT_SYSTEM:
      str = _("System or Console");
      break;
    case JT_ADMIN:
      str = _("Admin");
      break;
    case JT_ARCHIVE:
      str = _("Archive");
      break;
    case JT_JOB_COPY:
      str = _("Job Copy");
      break;
    case JT_COPY:
      str = _("Copy");
      break;
    case JT_MIGRATE:
      str = _("Migrate");
      break;
    case JT_SCAN:
      str = _("Scan");
      break;
    case JT_CONSOLIDATE:
      str = _("Consolidate");
      break;
  }
  if (!str) { str = _("Unknown Type"); }
  return str;
}

/*
 * Convert ActionOnPurge to string (Truncate, Erase, Destroy)
 */
char* action_on_purge_to_string(int aop, PoolMem& ret)
{
  if (aop & ON_PURGE_TRUNCATE) { PmStrcpy(ret, _("Truncate")); }
  if (!aop) { PmStrcpy(ret, _("None")); }
  return ret.c_str();
}

/*
 * Convert Job Level into a string
 */
const char* job_level_to_str(int level)
{
  const char* str;

  switch (level) {
    case L_BASE:
      str = _("Base");
      break;
    case L_FULL:
      str = _("Full");
      break;
    case L_INCREMENTAL:
      str = _("Incremental");
      break;
    case L_DIFFERENTIAL:
      str = _("Differential");
      break;
    case L_SINCE:
      str = _("Since");
      break;
    case L_VERIFY_CATALOG:
      str = _("Verify Catalog");
      break;
    case L_VERIFY_INIT:
      str = _("Verify Init Catalog");
      break;
    case L_VERIFY_VOLUME_TO_CATALOG:
      str = _("Verify Volume to Catalog");
      break;
    case L_VERIFY_DISK_TO_CATALOG:
      str = _("Verify Disk to Catalog");
      break;
    case L_VERIFY_DATA:
      str = _("Verify Data");
      break;
    case L_VIRTUAL_FULL:
      str = _("Virtual Full");
      break;
    case L_NONE:
      str = " ";
      break;
    default:
      str = _("Unknown Job Level");
      break;
  }
  return str;
}

const char* volume_status_to_str(const char* status)
{
  int pos;
  const char* vs[] = {NT_("Append"), _("Append"),      NT_("Archive"),
                      _("Archive"),  NT_("Disabled"),  _("Disabled"),
                      NT_("Full"),   _("Full"),        NT_("Used"),
                      _("Used"),     NT_("Cleaning"),  _("Cleaning"),
                      NT_("Purged"), _("Purged"),      NT_("Recycle"),
                      _("Recycle"),  NT_("Read-Only"), _("Read-Only"),
                      NT_("Error"),  _("Error"),       NULL,
                      NULL};

  if (status) {
    for (pos = 0; vs[pos]; pos += 2) {
      if (bstrcmp(vs[pos], status)) { return vs[pos + 1]; }
    }
  }

  return _("Invalid volume status");
}


/*
 * Encode the mode bits into a 10 character string like LS does
 */
char* encode_mode(mode_t mode, char* buf)
{
  char* cp = buf;

  *cp++ =
      S_ISDIR(mode)
          ? 'd'
          : S_ISBLK(mode)
                ? 'b'
                : S_ISCHR(mode)
                      ? 'c'
                      : S_ISLNK(mode)
                            ? 'l'
                            : S_ISFIFO(mode) ? 'f' : S_ISSOCK(mode) ? 's' : '-';
  *cp++ = mode & S_IRUSR ? 'r' : '-';
  *cp++ = mode & S_IWUSR ? 'w' : '-';
  *cp++ = (mode & S_ISUID ? (mode & S_IXUSR ? 's' : 'S')
                          : (mode & S_IXUSR ? 'x' : '-'));
  *cp++ = mode & S_IRGRP ? 'r' : '-';
  *cp++ = mode & S_IWGRP ? 'w' : '-';
  *cp++ = (mode & S_ISGID ? (mode & S_IXGRP ? 's' : 'S')
                          : (mode & S_IXGRP ? 'x' : '-'));
  *cp++ = mode & S_IROTH ? 'r' : '-';
  *cp++ = mode & S_IWOTH ? 'w' : '-';
  *cp++ = (mode & S_ISVTX ? (mode & S_IXOTH ? 't' : 'T')
                          : (mode & S_IXOTH ? 'x' : '-'));
  *cp = '\0';
  return cp;
}

#if defined(HAVE_WIN32)
int DoShellExpansion(char* name, int name_len)
{
  char* src = strdup(name);

  ExpandEnvironmentStrings(src, name, name_len);

  free(src);

  return 1;
}
#else
int DoShellExpansion(char* name, int name_len)
{
  static char meta[] = "~\\$[]*?`'<>\"";
  bool found = false;
  int len, i, status;
  POOLMEM *cmd, *line;
  Bpipe* bpipe;
  const char* shellcmd;

  /*
   * Check if any meta characters are present
   */
  len = strlen(meta);
  for (i = 0; i < len; i++) {
    if (strchr(name, meta[i])) {
      found = true;
      break;
    }
  }
  if (found) {
    cmd = GetPoolMemory(PM_FNAME);
    line = GetPoolMemory(PM_FNAME);
    /*
     * Look for shell
     */
    if ((shellcmd = getenv("SHELL")) == NULL) { shellcmd = "/bin/sh"; }
    PmStrcpy(cmd, shellcmd);
    PmStrcat(cmd, " -c \"echo ");
    PmStrcat(cmd, name);
    PmStrcat(cmd, "\"");
    Dmsg1(400, "Send: %s\n", cmd);
    if ((bpipe = OpenBpipe(cmd, 0, "r"))) {
      bfgets(line, bpipe->rfd);
      StripTrailingJunk(line);
      status = CloseBpipe(bpipe);
      Dmsg2(400, "status=%d got: %s\n", status, line);
    } else {
      status = 1; /* error */
    }
    FreePoolMemory(cmd);
    FreePoolMemory(line);
    if (status == 0) { bstrncpy(name, line, name_len); }
  }
  return 1;
}
#endif

/*
 * MAKESESSIONKEY  --  Generate session key with optional start
 *                     key.  If mode is TRUE, the key will be
 *                     translated to a string, otherwise it is
 *                     returned as 16 binary bytes.
 *
 *  from SpeakFreely by John Walker
 */
void MakeSessionKey(char* key, char* seed, int mode)
{
  int j, k;
  MD5_CTX md5c;
  unsigned char md5key[16], md5key1[16];
  char s[1024];

#define ss sizeof(s)

  s[0] = 0;
  if (seed != NULL) { bstrncat(s, seed, sizeof(s)); }

  /*
   * The following creates a seed for the session key generator
   * based on a collection of volatile and environment-specific
   * information unlikely to be vulnerable (as a whole) to an
   * exhaustive search attack.  If one of these items isn't
   * available on your machine, replace it with something
   * equivalent or, if you like, just delete it.
   */
#if defined(HAVE_WIN32)
  {
    LARGE_INTEGER li;
    DWORD length;
    FILETIME ft;

    Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)GetCurrentProcessId());
    (void)getcwd(s + strlen(s), 256);
    Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)GetTickCount());
    QueryPerformanceCounter(&li);
    Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)li.LowPart);
    GetSystemTimeAsFileTime(&ft);
    Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)ft.dwLowDateTime);
    Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)ft.dwHighDateTime);
    length = 256;
    GetComputerName(s + strlen(s), &length);
    length = 256;
    GetUserName(s + strlen(s), &length);
  }
#else
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)getpid());
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)getppid());
  (void)getcwd(s + strlen(s), 256);
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)clock());
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)time(NULL));
#if defined(Solaris)
  sysinfo(SI_HW_SERIAL, s + strlen(s), 12);
#endif
#if defined(HAVE_GETHOSTID)
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)gethostid());
#endif
  gethostname(s + strlen(s), 256);
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)getuid());
  Bsnprintf(s + strlen(s), ss, "%lu", (uint32_t)getgid());
#endif
  MD5_Init(&md5c);
  MD5_Update(&md5c, (uint8_t*)s, strlen(s));
  MD5_Final(md5key, &md5c);
  Bsnprintf(s + strlen(s), ss, "%lu",
            (uint32_t)((time(NULL) + 65121) ^ 0x375F));
  MD5_Init(&md5c);
  MD5_Update(&md5c, (uint8_t*)s, strlen(s));
  MD5_Final(md5key1, &md5c);
#define nextrand (md5key[j] ^ md5key1[j])
  if (mode) {
    for (j = k = 0; j < 16; j++) {
      unsigned char rb = nextrand;

#define Rad16(x) ((x) + 'A')
      key[k++] = Rad16((rb >> 4) & 0xF);
      key[k++] = Rad16(rb & 0xF);
#undef Rad16
      if (j & 1) { key[k++] = '-'; }
    }
    key[--k] = 0;
  } else {
    for (j = 0; j < 16; j++) { key[j] = nextrand; }
  }
}
#undef nextrand

void EncodeSessionKey(char* encode, char* session, char* key, int maxlen)
{
  int i;

  for (i = 0; (i < maxlen - 1) && session[i]; i++) {
    if (session[i] == '-') {
      encode[i] = '-';
    } else {
      encode[i] = ((session[i] - 'A' + key[i]) & 0xF) + 'A';
    }
  }
  encode[i] = 0;
  Dmsg3(000, "Session=%s key=%s encode=%s\n", session, key, encode);
}

void DecodeSessionKey(char* decode, char* session, char* key, int maxlen)
{
  int i, x;

  for (i = 0; (i < maxlen - 1) && session[i]; i++) {
    if (session[i] == '-') {
      decode[i] = '-';
    } else {
      x = (session[i] - 'A' - key[i]) & 0xF;
      if (x < 0) { x += 16; }
      decode[i] = x + 'A';
    }
  }
  decode[i] = 0;
  Dmsg3(000, "Session=%s key=%s decode=%s\n", session, key, decode);
}

/*
 * Edit job codes into main command line
 *  %% = %
 *  %B = Job Bytes in human readable format
 *  %F = Job Files
 *  %P = Pid of daemon
 *  %b = Job Bytes
 *  %c = Client's name
 *  %d = Director's name
 *  %e = Job Exit code
 *  %i = JobId
 *  %j = Unique Job id
 *  %l = job level
 *  %n = Unadorned Job name
 *  %r = Recipients
 *  %s = Since time
 *  %t = Job type (Backup, ...)
 *  %v = Volume name(s)
 *
 *  omsg = edited output message
 *  imsg = input string containing edit codes (%x)
 *  to = recipients list
 */
POOLMEM* edit_job_codes(JobControlRecord* jcr,
                        char* omsg,
                        const char* imsg,
                        const char* to,
                        job_code_callback_t callback)
{
  const char* p;
  char* q;
  const char* str;
  char ed1[50];
  char add[50];
  char name[MAX_NAME_LENGTH];
  int i;

  *omsg = 0;
  Dmsg1(200, "edit_job_codes: %s\n", imsg);
  for (p = imsg; *p; p++) {
    if (*p == '%') {
      switch (*++p) {
        case '%':
          str = "%";
          break;
        case 'B': /* Job Bytes in human readable format */
          if (jcr) {
            Bsnprintf(add, sizeof(add), "%sB",
                      edit_uint64_with_suffix(jcr->JobBytes, ed1));
            str = add;
          } else {
            str = _("*None*");
          }
          break;
        case 'F': /* Job Files */
          if (jcr) {
            str = edit_uint64(jcr->JobFiles, add);
          } else {
            str = _("*None*");
          }
          break;
        case 'P': /* Process Id */
          Bsnprintf(add, sizeof(add), "%lu", (uint32_t)getpid());
          str = add;
          break;
        case 'b': /* Job Bytes */
          if (jcr) {
            str = edit_uint64(jcr->JobBytes, add);
          } else {
            str = _("*None*");
          }
          break;
        case 'c': /* Client's name */
          if (jcr && jcr->client_name) {
            str = jcr->client_name;
          } else {
            str = _("*None*");
          }
          break;
        case 'd': /* Director's name */
          str = my_name;
          break;
        case 'e': /* Job Exit code */
          if (jcr) {
            str = job_status_to_str(jcr->JobStatus);
          } else {
            str = _("*None*");
          }
          break;
        case 'i': /* JobId */
          if (jcr) {
            Bsnprintf(add, sizeof(add), "%d", jcr->JobId);
            str = add;
          } else {
            str = _("*None*");
          }
          break;
        case 'j': /* Job name */
          if (jcr) {
            str = jcr->Job;
          } else {
            str = _("*None*");
          }
          break;
        case 'l': /* Job level */
          if (jcr) {
            str = job_level_to_str(jcr->getJobLevel());
          } else {
            str = _("*None*");
          }
          break;
        case 'n': /* Unadorned Job name */
          if (jcr) {
            bstrncpy(name, jcr->Job, sizeof(name));
            /*
             * There are three periods after the Job name
             */
            for (i = 0; i < 3; i++) {
              if ((q = strrchr(name, '.')) != NULL) { *q = 0; }
            }
            str = name;
          } else {
            str = _("*None*");
          }
          break;
        case 'r': /* Recipients */
          str = to;
          break;
        case 's': /* Since time */
          if (jcr && jcr->stime) {
            str = jcr->stime;
          } else {
            str = _("*None*");
          }
          break;
        case 't': /* Job type */
          if (jcr) {
            str = job_type_to_str(jcr->getJobType());
          } else {
            str = _("*None*");
          }
          break;
        case 'v': /* Volume name(s) */
          if (jcr) {
            if (jcr->VolumeName) {
              str = jcr->VolumeName;
            } else {
              str = _("*None*");
            }
          } else {
            str = _("*None*");
          }
          break;
        default:
          str = NULL;
          if (callback != NULL) { str = callback(jcr, p); }

          if (!str) {
            add[0] = '%';
            add[1] = *p;
            add[2] = 0;
            str = add;
          }
          break;
      }
    } else {
      add[0] = *p;
      add[1] = 0;
      str = add;
    }
    Dmsg1(1200, "add_str %s\n", str);
    PmStrcat(omsg, str);
    Dmsg1(1200, "omsg=%s\n", omsg);
  }

  return omsg;
}

void SetWorkingDirectory(const char* wd)
{
  struct stat stat_buf;

  if (wd == NULL) {
    Emsg0(M_ERROR_TERM, 0,
          _("Working directory not defined. Cannot continue.\n"));
  }
  if (stat(wd, &stat_buf) != 0) {
    Emsg1(M_ERROR_TERM, 0,
          _("Working Directory: \"%s\" not found. Cannot continue.\n"), wd);
  }
  if (!S_ISDIR(stat_buf.st_mode)) {
    Emsg1(M_ERROR_TERM, 0,
          _("Working Directory: \"%s\" is not a directory. Cannot continue.\n"),
          wd);
  }
  working_directory = wd; /* set global */
}

const char* last_path_separator(const char* str)
{
  if (*str != '\0') {
    for (const char* p = &str[strlen(str) - 1]; p >= str; p--) {
      if (IsPathSeparator(*p)) { return p; }
    }
  }
  return NULL;
}

void StringToLowerCase(std::string& s)
{
  for (auto& c : s) { c = std::tolower(c); }
}

void StringToLowerCase(std::string& out, const std::string& in)
{
  out.clear();
  for (const auto& c : in) { out += std::tolower(c); }
}

void SortCaseInsensitive(std::vector<std::string>& v)
{
  if (v.empty()) { return; }

  std::sort(v.begin(), v.end(), [](const std::string& a, const std::string& b) {
    std::string x{a}, y{b};
    StringToLowerCase(x);
    StringToLowerCase(y);
    return x < y;
  });
}

std::string getenv_std_string(std::string env_var)
{
  const char* v = (std::getenv(env_var.c_str()));
  return v ? std::string(v) : std::string();
}