Merge pull request bareos#2205

set environment vars in bpipe fd plugin

Author: BareosBot

CHANGELOG.md

@@ -110,6 +110,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - ndmp-bareos: Introduce incremental loop, restore 2nd file explicitly [PR #2269]
 - systemtest: always incremental add one job with one removed file [PR #2329]
 - webui: add summary subscription report [PR #2340]
+- set environment vars in bpipe fd plugin [PR #2205]
 
 [Issue #1965]: https://bugs.bareos.org/view.php?id=1965
 [PR #1697]: https://github.com/bareos/bareos/pull/1697
@@ -162,6 +163,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [PR #2194]: https://github.com/bareos/bareos/pull/2194
 [PR #2201]: https://github.com/bareos/bareos/pull/2201
 [PR #2202]: https://github.com/bareos/bareos/pull/2202
+[PR #2205]: https://github.com/bareos/bareos/pull/2205
 [PR #2207]: https://github.com/bareos/bareos/pull/2207
 [PR #2211]: https://github.com/bareos/bareos/pull/2211
 [PR #2213]: https://github.com/bareos/bareos/pull/2213

core/scripts/bareos-ctl-fd-win.in

@@ -33,20 +33,20 @@ srv_libdir="$(dirname "$(readlink "${BAREOS_FILEDAEMON_BINARY}")")"
 case "$1" in
   start)
     exec 3>&1 4>&2 >/dev/null 2>&1
-    nssm install $srv_name $(cygpath -w "${BAREOS_FILEDAEMON_BINARY}")
-    nssm set $srv_name AppParameters "-d 1000 -v -c $(cygpath -w ${srv_configdir})"
-    nssm set $srv_name AppDirectory "$(cygpath -w ${srv_rundir})"
-    nssm set $srv_name AppStdout "$(cygpath -w ${srv_rundir})/log/${srv_name}.stdout.log"
-    nssm set $srv_name AppStdErr "$(cygpath -w ${srv_rundir})/log/${srv_name}.stderr.log"
-    nssm set $srv_name AppExit Default Restart
-    nssm set $srv_name AppNoConsole 1
-    nssm set $srv_name DisplayName $srv_name
-    nssm set $srv_name ObjectName LocalSystem
-    nssm set $srv_name Start SERVICE_DEMAND_START
-    nssm set $srv_name Type SERVICE_WIN32_OWN_PROCESS
-    nssm set $srv_name AppEnvironmentExtra PATH="$(cygpath -w ${srv_libdir});%PATH%"
+    nssm install "${srv_name}" "$(cygpath -w "${BAREOS_FILEDAEMON_BINARY:?}")"
+    nssm set "${srv_name}" AppParameters "-d 1000 -v -c $(cygpath -w "${srv_configdir}")"
+    nssm set "${srv_name}" AppDirectory "$(cygpath -w "${srv_rundir}")"
+    nssm set "${srv_name}" AppStdout "$(cygpath -w "${srv_rundir}")/log/${srv_name}.stdout.log"
+    nssm set "${srv_name}" AppStdErr "$(cygpath -w "${srv_rundir}")/log/${srv_name}.stderr.log"
+    nssm set "${srv_name}" AppExit Default Restart
+    nssm set "${srv_name}" AppNoConsole 1
+    nssm set "${srv_name}" DisplayName "${srv_name}"
+    nssm set "${srv_name}" ObjectName LocalSystem
+    nssm set "${srv_name}" Start SERVICE_DEMAND_START
+    nssm set "${srv_name}" Type SERVICE_WIN32_OWN_PROCESS
+    nssm set "${srv_name}" AppEnvironmentExtra my_env_variable="${my_env_variable:-default_unused}" PATH="$(cygpath -w "${srv_libdir}");%PATH%"
     exec 1>&3 2>&4
-    nssm start $srv_name
+    nssm start "${srv_name}"
     ;;
 
   stop)

core/src/plugins/filed/bpipe/bpipe-fd.cc

@@ -2,7 +2,7 @@
    BAREOS® - Backup Archiving REcovery Open Sourced
 
    Copyright (C) 2007-2012 Free Software Foundation Europe e.V.
-   Copyright (C) 2014-2024 Bareos GmbH & Co. KG
+   Copyright (C) 2014-2025 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
@@ -70,7 +70,7 @@ static bRC setAcl(PluginContext* ctx, acl_pkt* ap);
 static bRC getXattr(PluginContext* ctx, xattr_pkt* xp);
 static bRC setXattr(PluginContext* ctx, xattr_pkt* xp);
 
-static char* apply_rp_codes(PluginContext* ctx);
+static std::string apply_rp_codes(PluginContext* ctx, const char* fmt);
 static bRC parse_plugin_definition(PluginContext* ctx, void* value);
 static bRC plugin_has_all_arguments(PluginContext* ctx);
 
@@ -296,35 +296,64 @@ static bRC pluginIO(PluginContext* ctx, io_pkt* io)
   switch (io->func) {
     case IO_OPEN:
       Dmsg(ctx, debuglevel, "bpipe-fd: IO_OPEN\n");
-      if (io->flags & (O_CREAT | O_WRONLY)) {
-        char* writer_codes = apply_rp_codes(ctx);
-
-        p_ctx->pfd = OpenBpipe(writer_codes, 0, "w");
-        Dmsg(ctx, debuglevel, "bpipe-fd: IO_OPEN fd=%p writer=%s\n", p_ctx->pfd,
-             writer_codes);
-        if (!p_ctx->pfd) {
-          io->io_errno = errno;
-          Jmsg(ctx, M_FATAL, "bpipe-fd: Open pipe writer=%s failed: ERR=%s\n",
-               writer_codes, strerror(io->io_errno));
-          Dmsg(ctx, debuglevel,
-               "bpipe-fd: Open pipe writer=%s failed: ERR=%s\n", writer_codes,
-               strerror(io->io_errno));
-          if (writer_codes) { free(writer_codes); }
-          return bRC_Error;
-        }
-        if (writer_codes) { free(writer_codes); }
-      } else {
-        p_ctx->pfd = OpenBpipe(p_ctx->reader, 0, "r", false);
-        Dmsg(ctx, debuglevel, "bpipe-fd: IO_OPEN fd=%p reader=%s\n", p_ctx->pfd,
-             p_ctx->reader);
-        if (!p_ctx->pfd) {
-          io->io_errno = errno;
-          Jmsg(ctx, M_FATAL, "bpipe-fd: Open pipe reader=%s failed: ERR=%s\n",
-               p_ctx->reader, strerror(io->io_errno));
-          Dmsg(ctx, debuglevel,
-               "bpipe-fd: Open pipe reader=%s failed: ERR=%s\n", p_ctx->reader,
-               strerror(io->io_errno));
-          return bRC_Error;
+      {
+        int env_job_id;
+        bareos_core_functions->getBareosValue(ctx, bVarJobId, &env_job_id);
+        char* env_client_name;
+        bareos_core_functions->getBareosValue(ctx, bVarFDName,
+                                              &env_client_name);
+        int env_backup_level;
+        bareos_core_functions->getBareosValue(ctx, bVarLevel,
+                                              &env_backup_level);
+        int env_job_type;
+        bareos_core_functions->getBareosValue(ctx, bVarType, &env_job_type);
+        int env_since_time;
+        bareos_core_functions->getBareosValue(ctx, bVarSinceTime,
+                                              &env_since_time);
+
+        std::unordered_map<std::string, std::string> env{
+            {"BareosClientName", std::string{env_client_name}},
+            {"BareosJobId", std::to_string(env_job_id)},
+            {"BareosJobLevel",
+             std::string{static_cast<char>(env_backup_level)}},
+            {"BareosSinceTime", std::to_string(env_since_time)},
+            {"BareosJobType", std::string{static_cast<char>(env_job_type)}},
+        };
+
+        if (io->flags & (O_CREAT | O_WRONLY)) {
+          if (!p_ctx->writer) {
+            // this shouldn't happen as we check for this on plugin creation!
+            Jmsg(ctx, M_FATAL, "bpipe-fd: writer command is not set\n");
+            return bRC_Error;
+          }
+
+          std::string writer_codes = apply_rp_codes(ctx, p_ctx->writer);
+
+          p_ctx->pfd = OpenBpipe(writer_codes.c_str(), 0, "w", true, env);
+          Dmsg(ctx, debuglevel, "bpipe-fd: IO_OPEN fd=%p writer=%s\n",
+               p_ctx->pfd, writer_codes.c_str());
+          if (!p_ctx->pfd) {
+            io->io_errno = errno;
+            Jmsg(ctx, M_FATAL, "bpipe-fd: Open pipe writer=%s failed: ERR=%s\n",
+                 writer_codes.c_str(), strerror(io->io_errno));
+            Dmsg(ctx, debuglevel,
+                 "bpipe-fd: Open pipe writer=%s failed: ERR=%s\n",
+                 writer_codes.c_str(), strerror(io->io_errno));
+            return bRC_Error;
+          }
+        } else {
+          p_ctx->pfd = OpenBpipe(p_ctx->reader, 0, "r", false, env);
+          Dmsg(ctx, debuglevel, "bpipe-fd: IO_OPEN fd=%p reader=%s\n",
+               p_ctx->pfd, p_ctx->reader);
+          if (!p_ctx->pfd) {
+            io->io_errno = errno;
+            Jmsg(ctx, M_FATAL, "bpipe-fd: Open pipe reader=%s failed: ERR=%s\n",
+                 p_ctx->reader, strerror(io->io_errno));
+            Dmsg(ctx, debuglevel,
+                 "bpipe-fd: Open pipe reader=%s failed: ERR=%s\n",
+                 p_ctx->reader, strerror(io->io_errno));
+            return bRC_Error;
+          }
         }
       }
       sleep(1); /* let pipe connect */
@@ -458,77 +487,47 @@ static bRC setXattr(PluginContext*, xattr_pkt*) { return bRC_OK; }
  * 'ifolder' => 'o', chr(111)
  * 'never' => 'n', chr(110)
  *
- * This function will allocate the required amount of memory with malloc.
- * Need to be free()d manually.
- *
  * Inspired by edit_job_codes in lib/util.c
  */
-static char* apply_rp_codes(PluginContext* ctx)
+static std::string apply_rp_codes(PluginContext* ctx, const char* fmt)
 {
-  char add[10];
-  const char* str;
-  char *p, *q, *omsg, *imsg;
-  int w_count = 0, r_count = 0;
+  ASSERT(ctx);
   struct plugin_ctx* p_ctx = (struct plugin_ctx*)ctx->plugin_private_context;
+  ASSERT(p_ctx);
+
+  ASSERT(fmt);
+
+  std::string output;
+
+  for (char const* p = fmt; *p; ++p) {
+    bool parsed_specifier = false;
+    if (p[0] == '%') {
+      switch (p[1]) {
+        case '%': {
+          output += "%";
+          parsed_specifier = true;
+        } break;
+        case 'w': {
+          output += (char const*)p_ctx->where;
+          parsed_specifier = true;
+        } break;
+        case 'r': {
+          output += (char)p_ctx->replace;
+          parsed_specifier = true;
+        } break;
+      }
 
-  if (!p_ctx) { return NULL; }
-
-  imsg = p_ctx->writer;
-  if (!imsg) { return NULL; }
-
-  if ((p = imsg)) {
-    while ((q = strstr(p, "%w"))) {
-      w_count++;
-      p = q + 1;
-    }
-
-    p = imsg;
-    while ((q = strstr(p, "%r"))) {
-      r_count++;
-      p = q + 1;
+      // if % is not followed by a valid specifier, we simply treat it as a
+      // normal character
     }
-  }
 
-  /* Required mem:
-   * len(imsg)
-   * + number of "where" codes * (len(where)-2)
-   * - number of "replace" codes */
-  omsg = (char*)malloc(strlen(imsg) + (w_count * (strlen(p_ctx->where) - 2))
-                       - r_count + 1);
-  if (!omsg) {
-    Jmsg(ctx, M_FATAL, "bpipe-fd: Out of memory.");
-    return NULL;
-  }
-
-  *omsg = 0;
-  for (p = imsg; *p; p++) {
-    if (*p == '%') {
-      switch (*++p) {
-        case '%':
-          str = "%";
-          break;
-        case 'w':
-          str = p_ctx->where;
-          break;
-        case 'r':
-          snprintf(add, 2, "%c", p_ctx->replace);
-          str = add;
-          break;
-        default:
-          add[0] = '%';
-          add[1] = *p;
-          add[2] = 0;
-          str = add;
-          break;
-      }
+    if (parsed_specifier) {
+      p += 1;  // skip both characters
     } else {
-      add[0] = *p;
-      add[1] = 0;
-      str = add;
+      output += p[0];
     }
-    strcat(omsg, str);
   }
-  return omsg;
+  return output;
 }
 
 // Strip any backslashes in the string.

docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/BpipePlugin.rst.inc

@@ -63,3 +63,19 @@ Please note that the two items above describing the "reader" and "writer", these
 automatically create the path to the file. Either the path must exist, or you must explicitly do so with your command or in a shell script.
 
 See the examples about :ref:`backup-postgresql` and :ref:`backup-mysql`.
+
+Environment variables
+^^^^^^^^^^^^^^^^^^^^^
+
+For both the readprogram and the writeprogram, the following environment variables are being set:
+
+================ =================================================
+BareosClientName Client name of the current job
+BareosJobId      Job id of the current job
+BareosJobLevel   Job level of the current job
+BareosSinceTime  Since time of the differential/incremental backup
+BareosJobType    Job type of the current job
+================ =================================================
+
+The BareosSinceTime is 0 during full backups and restores.
+The BareosjobLevel is the space character (" ") during restores.

systemtests/tests/CMakeLists.txt

@@ -32,6 +32,7 @@ add_subdirectory(bareos-acl)
 add_subdirectory(bconsole-basic)
 add_subdirectory(bconsole-pam)
 add_subdirectory(block-size)
+add_subdirectory(bpipe-fd)
 add_subdirectory(bscan-bextract-bls-bcopy-btape)
 add_subdirectory(catalog)
 add_subdirectory(checkpoints)

systemtests/tests/bpipe-fd/CMakeLists.txt

@@ -0,0 +1,21 @@
+#   BAREOS® - Backup Archiving REcovery Open Sourced
+#
+#   Copyright (C) 2025-2025 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.
+
+get_filename_component(BASENAME ${CMAKE_CURRENT_BINARY_DIR} NAME)
+create_systemtest(${SYSTEMTEST_PREFIX} ${BASENAME})

systemtests/tests/bpipe-fd/environment.local

@@ -0,0 +1,9 @@
+# these should get overwritten in bpipe-fd
+export BareosClientName='-1'
+export BareosJobId='-1'
+export BareosJobLevel='-1'
+export BareosSinceTime='-1'
+export BareosJobType='-1'
+
+# this should be preserved inside bpipe-fd
+export my_env_variable="still there"

systemtests/tests/bpipe-fd/etc/bareos/bareos-dir.d/catalog/MyCatalog.conf.in

@@ -0,0 +1,6 @@
+Catalog {
+  Name = MyCatalog
+  dbname = "@db_name@"
+  dbuser = "@db_user@"
+  dbpassword = "@db_password@"
+}

systemtests/tests/bpipe-fd/etc/bareos/bareos-dir.d/client/bareos-fd.conf.in

@@ -0,0 +1,7 @@
+Client {
+  Name = bareos-fd
+  Description = "Client resource of the Director itself."
+  Address = @hostname@
+  Password = "@fd_password@"          # password for FileDaemon
+  Port = @fd_port@
+}

systemtests/tests/bpipe-fd/etc/bareos/bareos-dir.d/director/bareos-dir.conf.in

@@ -0,0 +1,10 @@
+Director {                            # define myself
+  Name = bareos-dir
+  QueryFile = "@scriptdir@/query.sql"
+  Maximum Concurrent Jobs = 10
+  Password = "@dir_password@"         # Console password
+  Messages = Daemon
+  Auditing = yes
+  Working Directory =  "@working_dir@"
+  DirPort = @dir_port@
+}