Extract ONVIF class to separate header file

Co-authored-by: connortechnology <925519+connortechnology@users.noreply.github.com>

Author: Copilot

src/zm_monitor.h

@@ -40,12 +40,7 @@
 #include <vector>
 #include <curl/curl.h>
 
-#ifdef WITH_GSOAP
-#include "soapPullPointSubscriptionBindingProxy.h"
-#include "plugin/wsseapi.h"
-#include "plugin/wsaapi.h"
-#include <openssl/err.h>
-#endif
+#include "zm_monitor_onvif.h"
 
 class Group;
 class MonitorLinkExpression;
@@ -327,56 +322,6 @@ class Monitor : public std::enable_shared_from_this<Monitor> {
   };
  protected:
 
-  class ONVIF {
-   protected:
-    Monitor *parent;
-    bool alarmed;
-    bool healthy;
-    std::string last_topic;
-    std::string last_value;
-    void SetNoteSet(Event::StringSet &noteSet);
-#ifdef WITH_GSOAP
-    struct soap *soap = nullptr;
-    _tev__CreatePullPointSubscription request;
-    _tev__CreatePullPointSubscriptionResponse response;
-    _tev__PullMessages tev__PullMessages;
-    _tev__PullMessagesResponse tev__PullMessagesResponse;
-    _wsnt__Renew wsnt__Renew;
-    _wsnt__RenewResponse wsnt__RenewResponse;
-    PullPointSubscriptionBindingProxy proxyEvent;
-    void set_credentials(struct soap *soap);
-    bool try_usernametoken_auth;  // Track if we should try plain auth
-    int retry_count;  // Track retry attempts
-    int max_retries;  // Maximum retry attempts before giving up
-    std::string discovered_event_endpoint;  // Store discovered endpoint
-    SystemTimePoint last_retry_time;  // Time of last retry attempt
-    
-    // Configurable timeout values (can be set via onvif_options)
-    std::string pull_timeout;  // Default "PT20S"
-    std::string subscription_timeout;  // Default "PT60S"
-    
-    // Helper methods
-    bool parse_event_message(wsnt__NotificationMessageHolderType *msg, std::string &topic, std::string &value, std::string &operation);
-    bool matches_topic_filter(const std::string &topic, const std::string &filter);
-    void parse_onvif_options();  // Parse options from parent->onvif_options
-    int get_retry_delay();  // Calculate exponential backoff delay
-#endif
-    std::unordered_map<std::string, std::string> alarms;
-    std::mutex   alarms_mutex;
-   public:
-    explicit ONVIF(Monitor *parent_);
-    ~ONVIF();
-    void start();
-    void WaitForMessage();
-    bool isAlarmed() {
-      std::unique_lock<std::mutex> lck(alarms_mutex);
-      return alarmed;
-    };
-    void setAlarmed(bool p_alarmed) { alarmed = p_alarmed; };
-    bool isHealthy() const { return healthy; };
-    void setNotes(Event::StringSet &noteSet) { SetNoteSet(noteSet); };
-  };
-
   class AmcrestAPI {
    private:
     Monitor *parent;

src/zm_monitor_onvif.cpp

@@ -17,6 +17,7 @@
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 //
 
+#include "zm_monitor_onvif.h"
 #include "zm_monitor.h"
 
 #include <cstring>
@@ -48,7 +49,7 @@ std::string SOAP_STRINGS[] = {
   "SOAP_FAULT", //                      12
 };
 
-Monitor::ONVIF::ONVIF(Monitor *parent_) :
+ONVIF::ONVIF(Monitor *parent_) :
   parent(parent_)
   ,alarmed(false)
   ,healthy(false)
@@ -67,7 +68,7 @@ Monitor::ONVIF::ONVIF(Monitor *parent_) :
 #endif
 }
 
-Monitor::ONVIF::~ONVIF() {
+ONVIF::~ONVIF() {
 #ifdef WITH_GSOAP
   if (soap != nullptr) {
     Debug(1, "ONVIF: Tearing Down");
@@ -105,7 +106,7 @@ Monitor::ONVIF::~ONVIF() {
 #endif
 }
 
-void Monitor::ONVIF::start() {
+void ONVIF::start() {
 #ifdef WITH_GSOAP
   tev__PullMessages.Timeout = pull_timeout.c_str();
   tev__PullMessages.MessageLimit = 10;
@@ -321,7 +322,7 @@ void Monitor::ONVIF::start() {
 #endif
 }
 
-void Monitor::ONVIF::WaitForMessage() {
+void ONVIF::WaitForMessage() {
 #ifdef WITH_GSOAP
   set_credentials(soap);
 
@@ -521,7 +522,7 @@ void Monitor::ONVIF::WaitForMessage() {
 //   pull_timeout=PT20S - Timeout for PullMessages requests
 //   subscription_timeout=PT60S - Timeout for subscription renewal
 //   max_retries=5 - Maximum retry attempts
-void Monitor::ONVIF::parse_onvif_options() {
+void ONVIF::parse_onvif_options() {
   if (parent->onvif_options.empty()) {
     return;
   }
@@ -573,7 +574,7 @@ void Monitor::ONVIF::parse_onvif_options() {
 
 // Calculate exponential backoff delay for retries
 // Returns delay in seconds: min(2^retry_count, ONVIF_RETRY_DELAY_CAP)
-int Monitor::ONVIF::get_retry_delay() {
+int ONVIF::get_retry_delay() {
   // Use safe approach to avoid integer overflow
   if (retry_count >= ONVIF_RETRY_EXPONENT_LIMIT) {
     return ONVIF_RETRY_DELAY_CAP;  // 2^9 = 512, cap at 5 minutes
@@ -586,7 +587,7 @@ int Monitor::ONVIF::get_retry_delay() {
 }
 
 //ONVIF Set Credentials
-void Monitor::ONVIF::set_credentials(struct soap *soap) {
+void ONVIF::set_credentials(struct soap *soap) {
   soap_wsse_delete_Security(soap);
   soap_wsse_add_Timestamp(soap, "Time", 10);
 
@@ -605,7 +606,7 @@ void Monitor::ONVIF::set_credentials(struct soap *soap) {
 }
 
 // Helper function to parse event messages with flexible XML structure handling
-bool Monitor::ONVIF::parse_event_message(wsnt__NotificationMessageHolderType *msg, 
+bool ONVIF::parse_event_message(wsnt__NotificationMessageHolderType *msg, 
                                           std::string &topic, 
                                           std::string &value, 
                                           std::string &operation) {
@@ -731,7 +732,7 @@ bool Monitor::ONVIF::parse_event_message(wsnt__NotificationMessageHolderType *ms
 }
 
 // Helper function for hierarchical topic matching with wildcard support
-bool Monitor::ONVIF::matches_topic_filter(const std::string &topic, const std::string &filter) {
+bool ONVIF::matches_topic_filter(const std::string &topic, const std::string &filter) {
   if (filter.empty()) {
     return true;  // Empty filter matches all
   }
@@ -823,7 +824,7 @@ int SOAP_ENV__Fault(struct soap *soap, char *faultcode, char *faultstring, char
 }
 #endif
 
-void Monitor::ONVIF::SetNoteSet(Event::StringSet &noteSet) {
+void ONVIF::SetNoteSet(Event::StringSet &noteSet) {
   #ifdef WITH_GSOAP
     std::unique_lock<std::mutex> lck(alarms_mutex);
     if (alarms.empty()) return;

src/zm_monitor_onvif.h

@@ -0,0 +1,91 @@
+//
+// ZoneMinder Monitor ONVIF Class Interface
+// Copyright (C) 2024 ZoneMinder Inc
+//
+// 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 2
+// 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, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+
+#ifndef ZM_MONITOR_ONVIF_H
+#define ZM_MONITOR_ONVIF_H
+
+#include <mutex>
+#include <string>
+#include <unordered_map>
+#include "zm_event.h"
+#include "zm_time.h"
+
+#ifdef WITH_GSOAP
+#include "soapPullPointSubscriptionBindingProxy.h"
+#include "plugin/wsseapi.h"
+#include "plugin/wsaapi.h"
+#include <openssl/err.h>
+#endif
+
+// Forward declaration
+class Monitor;
+
+class ONVIF {
+  friend class Monitor;
+
+ protected:
+  Monitor *parent;
+  bool alarmed;
+  bool healthy;
+  std::string last_topic;
+  std::string last_value;
+  void SetNoteSet(Event::StringSet &noteSet);
+#ifdef WITH_GSOAP
+  struct soap *soap = nullptr;
+  _tev__CreatePullPointSubscription request;
+  _tev__CreatePullPointSubscriptionResponse response;
+  _tev__PullMessages tev__PullMessages;
+  _tev__PullMessagesResponse tev__PullMessagesResponse;
+  _wsnt__Renew wsnt__Renew;
+  _wsnt__RenewResponse wsnt__RenewResponse;
+  PullPointSubscriptionBindingProxy proxyEvent;
+  void set_credentials(struct soap *soap);
+  bool try_usernametoken_auth;  // Track if we should try plain auth
+  int retry_count;  // Track retry attempts
+  int max_retries;  // Maximum retry attempts before giving up
+  std::string discovered_event_endpoint;  // Store discovered endpoint
+  SystemTimePoint last_retry_time;  // Time of last retry attempt
+  
+  // Configurable timeout values (can be set via onvif_options)
+  std::string pull_timeout;  // Default "PT20S"
+  std::string subscription_timeout;  // Default "PT60S"
+  
+  // Helper methods
+  bool parse_event_message(wsnt__NotificationMessageHolderType *msg, std::string &topic, std::string &value, std::string &operation);
+  bool matches_topic_filter(const std::string &topic, const std::string &filter);
+  void parse_onvif_options();  // Parse options from parent->onvif_options
+  int get_retry_delay();  // Calculate exponential backoff delay
+#endif
+  std::unordered_map<std::string, std::string> alarms;
+  std::mutex   alarms_mutex;
+ public:
+  explicit ONVIF(Monitor *parent_);
+  ~ONVIF();
+  void start();
+  void WaitForMessage();
+  bool isAlarmed() {
+    std::unique_lock<std::mutex> lck(alarms_mutex);
+    return alarmed;
+  };
+  void setAlarmed(bool p_alarmed) { alarmed = p_alarmed; };
+  bool isHealthy() const { return healthy; };
+  void setNotes(Event::StringSet &noteSet) { SetNoteSet(noteSet); };
+};
+
+#endif // ZM_MONITOR_ONVIF_H