Merge pull request #3119 from Carbenium/fmt

Add fmt library for type-safe string formatting

.cirrus.yml

@@ -6,8 +6,8 @@ task:
       - image_family: freebsd-13-0
 
   prepare_script:
-    - pkg install -yq git cmake pkgconf jpeg-turbo mysql80-client ffmpeg libvncserver libjwt catch p5-DBI p5-DBD-mysql p5-Date-Manip p5-Test-LWP-UserAgent p5-Sys-Mmap v4l_compat
-
+    - pkg install -yq git cmake pkgconf jpeg-turbo mysql80-client ffmpeg libvncserver libjwt libfmt catch p5-DBI p5-DBD-mysql p5-Date-Manip p5-Test-LWP-UserAgent p5-Sys-Mmap v4l_compat
+    
   configure_script:
     - git submodule update --init --recursive
     - mkdir build

.github/workflows/codeql-analysis.yml

@@ -52,9 +52,11 @@ jobs:
         git submodule init
         git submodule update --init --recursive
         sudo apt-get update
+
         sudo apt-get install libavcodec-dev libavformat-dev libavutil-dev libswresample-dev libswscale-dev libjwt-gnutls-dev
         sudo apt-get install libbz2-dev libcurl4-gnutls-dev libjpeg-turbo8-dev libturbojpeg0-dev
-        sudo apt-get install default-libmysqlclient-dev libpcre3-dev libpolkit-gobject-1-dev libv4l-dev libvlc-dev
+        sudo apt-get install default-libmysqlclient-dev libpcre3-dev libpolkit-gobject-1-dev libv4l-dev libvlc-dev libfmt-dev
+
         sudo apt-get install libdate-manip-perl libdbd-mysql-perl libphp-serialization-perl libsys-mmap-perl
         sudo apt-get install libwww-perl libdata-uuid-perl libssl-dev libcrypt-eksblowfish-perl libdata-entropy-perl
         

CMakeLists.txt

@@ -536,6 +536,8 @@ else()
   set(HAVE_RTSP_SERVER 0)
 endif()
 
+find_package(fmt REQUIRED)
+
 #
 # *** END OF LIBRARY CHECKS ***
 

distros/redhat/zoneminder.spec

@@ -93,6 +93,7 @@ BuildRequires: libv4l-devel
 BuildRequires: desktop-file-utils
 BuildRequires: gzip
 BuildRequires: zlib-devel
+BuildRequires: fmt-devel
 
 # ZoneMinder looks for and records the location of the ffmpeg binary during build
 BuildRequires: ffmpeg
@@ -141,6 +142,7 @@ Requires: perl(Net::FTP)
 Requires: perl(LWP::Protocol::https)
 Requires: ca-certificates
 Requires: zip
+Requires: fmt
 %{?systemd_requires}
 
 Requires(post): %{_bindir}/gpasswd

distros/ubuntu2004/control

@@ -29,8 +29,10 @@ Build-Depends: debhelper (>= 11), sphinx-doc, python3-sphinx, dh-linktree, dh-ap
               ,libcrypt-eksblowfish-perl
               ,libdata-entropy-perl
               ,libvncserver-dev
+              ,libfmt-dev
               ,libjwt-gnutls-dev|libjwt-dev
               ,libgsoap-dev
+
 Standards-Version: 4.5.0
 Homepage: https://www.zoneminder.com/
 
@@ -74,8 +76,10 @@ Depends: ${shlibs:Depends}, ${misc:Depends}, ${perl:Depends}
         ,libcrypt-eksblowfish-perl
         ,libdata-entropy-perl
         ,libvncclient1|libvncclient0
+        ,libfmt
         ,libjwt-gnutls0|libjwt0
         ,libgsoap-2.8.104|libgsoap-2.8.91|libgsoap-2.8.75|libgsoap-2.8.60|libgsoap10
+
 Recommends: ${misc:Recommends}
            ,libapache2-mod-php | php-fpm
            ,default-mysql-server | mariadb-server | virtual-mysql-server

src/CMakeLists.txt

@@ -192,6 +192,7 @@ target_link_libraries(zmc
   PRIVATE
     zm-core-interface
     zm
+    fmt::fmt
     ${ZM_EXTRA_LIBS}
     ${CMAKE_DL_LIBS})
 
@@ -213,6 +214,7 @@ target_link_libraries(zmbenchmark
   PRIVATE
     zm-core-interface
     zm
+    fmt::fmt
     ${ZM_EXTRA_LIBS}
     ${CMAKE_DL_LIBS})
 

src/zm_logger.cpp

@@ -547,14 +547,14 @@ void Logger::logPrint(bool hex, const char *filepath, int line, int level, const
   }
 }  // end logPrint
 
-void logInit(const char *name, const Logger::Options &options) {
+void logInit(const std::string &id, const Logger::Options &options) {
   if (Logger::smInstance) {
     delete Logger::smInstance;
     Logger::smInstance = nullptr;
   }
 
   Logger::smInstance = new Logger();
-  Logger::smInstance->initialise(name, options);
+  Logger::smInstance->initialise(id, options);
 }
 
 void logTerm() {

src/zm_logger.h

@@ -137,7 +137,7 @@ private:
   static void usrHandler(int sig);
 
 public:
-  friend void logInit(const char *name, const Options &options);
+  friend void logInit(const std::string &id, const Options &options);
   friend void logTerm();
 
   static Logger *fetch() {
@@ -182,7 +182,7 @@ private:
                 ...) __attribute__((format(printf, 6, 7)));
 };
 
-void logInit(const char *name, const Logger::Options &options=Logger::Options());
+void logInit(const std::string &id, const Logger::Options &options=Logger::Options());
 void logTerm();
 inline const std::string &logId() {
   return Logger::fetch()->id();

src/zmc.cpp

@@ -63,6 +63,7 @@ possible, this should run at more or less constant speed.
 #include "zm_signal.h"
 #include "zm_time.h"
 #include "zm_utils.h"
+#include <fmt/format.h>
 #include <getopt.h>
 
 void Usage() {
@@ -168,24 +169,24 @@ int main(int argc, char *argv[]) {
     exit(0);
   }
 
-  char log_id_string[32] = "";
+  std::string logId;
   if ( device[0] ) {
     const char *slash_ptr = strrchr(device, '/');
-    snprintf(log_id_string, sizeof(log_id_string), "zmc_d%s", slash_ptr?slash_ptr+1:device);
+    logId = fmt::format("zmc_d{}", slash_ptr ? slash_ptr + 1 : device);
   } else if ( host[0] ) {
-    snprintf(log_id_string, sizeof(log_id_string), "zmc_h%s", host);
+    logId = fmt::format("zmc_h{}", host);
   } else if ( file[0] ) {
     const char *slash_ptr = strrchr(file, '/');
-    snprintf(log_id_string, sizeof(log_id_string), "zmc_f%s", slash_ptr?slash_ptr+1:file);
+    logId = fmt::format("zmc_f{}", slash_ptr ? slash_ptr + 1 : file);
   } else {
-    snprintf(log_id_string, sizeof(log_id_string), "zmc_m%d", monitor_id);
+    logId = fmt::format("zmc_m{}", monitor_id);
   }
 
-  logInit(log_id_string);
+  logInit(logId);
   zmLoadStaticConfig();
   zmDbConnect();
   zmLoadDBConfig();
-  logInit(log_id_string);
+  logInit(logId);
 
   HwCapsDetect();
 
@@ -353,8 +354,7 @@ int main(int argc, char *argv[]) {
         monitor->Reload();
       }
       logTerm();
-      logInit(log_id_string);
-
+      logInit(logId);
       zm_reload = false;
     }  // end if zm_reload
   }  // end while ! zm_terminate outer connection loop

src/zms.cpp

@@ -24,6 +24,8 @@
 #include "zm_monitorstream.h"
 #include "zm_eventstream.h"
 #include "zm_fifo_stream.h"
+#include <fmt/format.h>
+
 #include <string>
 #include <unistd.h>
 
@@ -83,8 +85,7 @@ int main(int argc, const char *argv[], char **envp) {
     nph = true;
   }
 
-  char log_id_string[32] = "zms";
-  logInit(log_id_string);
+  logInit("zms");
   zmLoadStaticConfig();
   zmDbConnect();
   zmLoadDBConfig();
@@ -191,12 +192,13 @@ int main(int argc, const char *argv[], char **envp) {
     }  // end if possible parameter names
   }  // end foreach parm
 
+  std::string logId;
   if ( monitor_id ) {
-    snprintf(log_id_string, sizeof(log_id_string), "zms_m%d", monitor_id);
+    logId = fmt::format("zms_m{}", monitor_id);
   } else {
-    snprintf(log_id_string, sizeof(log_id_string), "zms_e%" PRIu64, event_id);
+    logId = fmt::format("zms_e{}", event_id);
   }
-  logInit(log_id_string);
+  logInit(logId);
 
   if ( config.opt_use_auth ) {
     User *user = nullptr;