Merge branch '4943-conf-line-continuation' into ai_server

Author: connortechnology

scripts/ZoneMinder/lib/ZoneMinder/Config.pm.in

@@ -128,12 +128,27 @@ require ZoneMinder::Database;
     }
     open( my $CONFIG, '<', $config_file )
       or croak("Can't open config file '$config_file': $!");
-    foreach my $str ( <$CONFIG> ) {
-      next if ( $str =~ /^\s*$/ );
-      next if ( $str =~ /^\s*#/ );
-      my ( $name, $value ) = $str =~ /^\s*([^=\s]+)\s*=\s*[\'"]*(.*?)[\'"]*\s*$/;
+    my $logical = '';
+    while ( my $str = <$CONFIG> ) {
+      $str =~ s/\r?\n\z//;
+      # A trailing backslash (with optional whitespace before the newline)
+      # means the value continues on the next physical line. Continuation
+      # lines have their leading whitespace stripped so users can indent.
+      if ( $logical ne '' ) {
+        $str =~ s/^[ \t]+//;
+      }
+      if ( $str =~ s/\\[ \t]*\z// ) {
+        $logical .= $str;
+        next;
+      }
+      $logical .= $str;
+      my $line = $logical;
+      $logical = '';
+      next if ( $line =~ /^\s*$/ );
+      next if ( $line =~ /^\s*#/ );
+      my ( $name, $value ) = $line =~ /^\s*([^=\s]+)\s*=\s*[\'"]*(.*?)[\'"]*\s*$/;
       if ( !$name ) {
-        print(STDERR "Warning, bad line in $config_file: $str\n");
+        print(STDERR "Warning, bad line in $config_file: $line\n");
         next;
       } # end if
       $name = uc $name;
@@ -143,7 +158,7 @@ require ZoneMinder::Database;
       #print(STDERR "Warning, known config option name $name in $config_file\n");
       #}
       $Config{$name} = $value;
-    } # end foreach config line
+    } # end while config line
     close($CONFIG);
   } # end sub process_configfile
 

src/zm_config.cpp

@@ -25,7 +25,10 @@
 #include <cerrno>
 #include <cstring>
 #include <dirent.h>
+#include <fstream>
 #include <glob.h>
+#include <string>
+#include <vector>
 
 // Note that Error and Debug calls won't actually go anywhere unless you
 // set the relevant ENV vars because the logger gets it's setting from the
@@ -105,18 +108,34 @@ void zmLoadDBConfig() {
 }
 
 void process_configfile(char const *configFile) {
-  FILE *cfg;
-  char line[512];
-  if ( (cfg = fopen(configFile, "r")) == nullptr ) {
+  std::ifstream cfg(configFile);
+  if ( !cfg.is_open() ) {
     Fatal("Can't open %s: %s", configFile, strerror(errno));
     return;
   }
-  while ( fgets(line, sizeof(line), cfg) != nullptr ) {
-    char *line_ptr = line;
+  std::string raw;
+  while ( std::getline(cfg, raw) ) {
+    // Tolerate Windows line endings.
+    if ( !raw.empty() && raw.back() == '\r' ) raw.pop_back();
+
+    // Backslash before the newline means the value continues on the next
+    // physical line. Trailing whitespace before the '\' is allowed.
+    // Continuation lines have their leading whitespace stripped so callers
+    // can indent for readability without it leaking into the value.
+    while ( true ) {
+      size_t last_non_ws = raw.find_last_not_of(" \t");
+      if ( last_non_ws == std::string::npos || raw[last_non_ws] != '\\' ) break;
+      raw.erase(last_non_ws);
+      std::string next;
+      if ( !std::getline(cfg, next) ) break;
+      if ( !next.empty() && next.back() == '\r' ) next.pop_back();
+      size_t lead = next.find_first_not_of(" \t");
+      if ( lead != std::string::npos ) raw.append(next, lead, std::string::npos);
+    }
 
-    // Trim off any cr/lf line endings
-    int chomp_len = strcspn(line_ptr, "\r\n");
-    line_ptr[chomp_len] = '\0';
+    std::vector<char> line(raw.begin(), raw.end());
+    line.push_back('\0');
+    char *line_ptr = line.data();
 
     // Remove leading white space
     int white_len = strspn(line_ptr, " \t");
@@ -135,7 +154,7 @@ void process_configfile(char const *configFile) {
     // Now look for the '=' in the middle of the line
     temp_ptr = strchr(line_ptr, '=');
     if ( !temp_ptr ) {
-      Warning("Invalid data in %s: '%s'", configFile, line);
+      Warning("Invalid data in %s: '%s'", configFile, line.data());
       continue;
     }
 
@@ -204,7 +223,6 @@ void process_configfile(char const *configFile) {
       // Warning( "Invalid parameter '%s' in %s", name_ptr, ZM_CONFIG );
     }
   } // end foreach line of the config
-  fclose(cfg);
 }
 
 StaticConfig staticConfig;

tests/CMakeLists.txt

@@ -12,6 +12,7 @@
 include(Catch)
 
 set(TEST_SOURCES
+  zm_config.cpp
   zm_db_schema.cpp
   zm_box.cpp
   zm_comms.cpp

tests/zm_config.cpp

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the ZoneMinder Project. See AUTHORS file for Copyright information
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "zm_catch2.h"
+
+#include "zm_config.h"
+
+#include <cstdio>
+#include <cstdlib>
+#include <fstream>
+#include <string>
+#include <unistd.h>
+
+namespace {
+
+// Writes `body` to a fresh /tmp file and returns its path; caller unlinks.
+std::string WriteTempConf(const std::string &body) {
+  char path[] = "/tmp/zm_conf_test_XXXXXX";
+  int fd = mkstemp(path);
+  REQUIRE(fd >= 0);
+  ssize_t n = write(fd, body.data(), body.size());
+  REQUIRE(n == static_cast<ssize_t>(body.size()));
+  close(fd);
+  return std::string(path);
+}
+
+}  // namespace
+
+TEST_CASE("process_configfile: backslash continuation joins lines") {
+  const std::string body =
+      "ZM_SERVER_NAME = first\\\n"
+      "    second\\\n"
+      "    third\n";
+  std::string path = WriteTempConf(body);
+
+  staticConfig.SERVER_NAME.clear();
+  process_configfile(path.c_str());
+  unlink(path.c_str());
+
+  // Leading whitespace on continuation lines is trimmed.
+  REQUIRE(staticConfig.SERVER_NAME == "firstsecondthird");
+}
+
+TEST_CASE("process_configfile: bare backslash inside value is preserved") {
+  // No newline after the backslash, so it is not a continuation marker.
+  const std::string body = "ZM_DIR_EXPORTS = C:\\Users\\zm\n";
+  std::string path = WriteTempConf(body);
+
+  staticConfig.DIR_EXPORTS.clear();
+  process_configfile(path.c_str());
+  unlink(path.c_str());
+
+  REQUIRE(staticConfig.DIR_EXPORTS == "C:\\Users\\zm");
+}
+
+TEST_CASE("process_configfile: lines longer than the legacy 512-byte cap survive") {
+  // A 1500-byte value would have been truncated by the old fgets() buffer.
+  std::string long_value(1500, 'a');
+  const std::string body = "ZM_DB_HOST = " + long_value + "\n";
+  std::string path = WriteTempConf(body);
+
+  staticConfig.DB_HOST.clear();
+  process_configfile(path.c_str());
+  unlink(path.c_str());
+
+  REQUIRE(staticConfig.DB_HOST == long_value);
+}

web/includes/config.php.in

@@ -304,14 +304,30 @@ function process_configfile($configFile) {
   $config = array();
   if (is_readable($configFile)) {
     $cfg = fopen($configFile, 'r') or error_log('Could not open config file: '.$configFile);
+    $logical = '';
     while ( !feof($cfg) ) {
-      $str = fgets($cfg, 512);
-      if ( preg_match('/^\s*(#.*)?$/', $str) ) {
+      $str = fgets($cfg);
+      if ($str === false) break;
+      $str = preg_replace('/\r?\n\z/', '', $str);
+      // Trailing backslash (with optional whitespace) continues the value on
+      // the next physical line. Leading whitespace on continuation lines is
+      // stripped so users can indent for readability.
+      if ($logical !== '') {
+        $str = ltrim($str, " \t");
+      }
+      if (preg_match('/^(.*?)\\\\[ \t]*$/', $str, $m)) {
+        $logical .= $m[1];
+        continue;
+      }
+      $logical .= $str;
+      $line = $logical;
+      $logical = '';
+      if ( preg_match('/^\s*(#.*)?$/', $line) ) {
         continue;
-      } else if ( preg_match('/^\s*([^=\s]+)\s*=\s*[\'"]*(.*?)[\'"]*\s*$/', $str, $matches) ) {
+      } else if ( preg_match('/^\s*([^=\s]+)\s*=\s*[\'"]*(.*?)[\'"]*\s*$/', $line, $matches) ) {
         $config[$matches[1]] = ['Name'=>$matches[1], 'Value'=>$matches[2]];
 			} else {
-				error_log("Malformed line in config $configFile\n$str");
+				error_log("Malformed line in config $configFile\n$line");
 			}
     }
     fclose($cfg);