Migrates alerts to an object-oriented implementation

scripts/lua/modules/alert_definitions/alert_host_log.lua

@@ -1,47 +1,61 @@
 --
--- (C) 2020 - ntop.org
+-- (C) 2019-20 - ntop.org
 --
 
+-- ##############################################
+
 local alert_keys = require "alert_keys"
 local alert_creators = require "alert_creators"
+-- Import the classes library.
+local classes = require "classes"
+-- Make sure to import the Superclass!
+local alert = require "alert"
 
-local function formatHostLogAlert(ifid, alert, info)
+-- ##############################################
+
+local alert_host_log = classes.class(alert)
+
+-- ##############################################
+
+alert_host_log.meta = {
+  alert_key = alert_keys.ntopng.alert_host_log,
+  i18n_title = "alerts_dashboard.host_log",
+  icon = "fa fa-file-text-o",
+}
+
+-- ##############################################
+-- @brief Prepare an alert table used to generate the alert
+-- @param host The string with the name or ip address of the host
+-- @return A table with the alert built
+function alert_host_log:init(host, level, facility, message)
+   -- Call the paren constructor
+   self.super:init()
+
+   self.alert_type_params = {
+    host = host,
+    facility = facility,
+    message = message,
+   }
+end
+
+-- #######################################################
+
+-- @brief Format an alert into a human-readable string
+-- @param ifid The integer interface id of the generated alert
+-- @param alert The alert description table, including alert data such as the generating entity, timestamp, granularity, type
+-- @param alert_type_params Table `alert_type_params` as built in the `:init` method
+-- @return A human-readable string
+function alert_host_log.format(ifid, alert, alert_type_params)
   local hostinfo = hostkey2hostinfo(alert.alert_entity_val)
 
   return(i18n("alert_messages.host_log", {
-    host = info.host,
+    host = alert_type_params.host,
     url = getHostUrl(hostinfo["host"], hostinfo["vlan"]),
-    facility = info.facility,
-    line = info.message,
+    facility = alert_type_params.facility,
+    line = alert_type_params.message,
   }))
 end
 
 -- #######################################################
 
--- @brief Prepare an alert table used to generate the alert
--- @param alert_severity A severity as defined in `alert_severities`
--- @param host The string with the name or ip address of the host
--- @return A table with the alert built
-local function createHostLogAlert(subtype, severity, host, level, facility, message)
-  local built = {
-    alert_severity = severity,
-    alert_subtype = subtype,
-    alert_type_params = {
-       host = host,
-       facility = facility,
-       message = message,
-    },
-  }
-
-  return built
-end
-
--- #######################################################
-
-return {
-  alert_key = alert_keys.ntopng.alert_host_log,
-  i18n_title = "alerts_dashboard.host_log",
-  i18n_description = formatHostLogAlert,
-  icon = "fa fa-file-text-o",
-  creator = createHostLogAlert,
-}
+return alert_host_log