Migrates alerts to an object-oriented implementation

scripts/lua/modules/alert_definitions/alert_flows_flood.lua

@@ -2,17 +2,55 @@
 -- (C) 2019-20 - ntop.org
 --
 
+-- ##############################################
+
 local alert_keys = require "alert_keys"
+package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path
+
 local alert_creators = require "alert_creators"
 local format_utils = require "format_utils"
 local json = require("dkjson")
+-- Import the classes library.
+local classes = require "classes"
+-- Make sure to import the Superclass!
+local alert = require "alert"
+
+-- ##############################################
+
+local alert_flows_flood = classes.class(alert)
+
+-- ##############################################
+
+alert_flows_flood.meta = {
+  alert_key = alert_keys.ntopng.alert_flows_flood,
+  i18n_title = "alerts_dashboard.flows_flood",
+  icon = "fas fa-life-ring",
+}
+
+-- ##############################################
+
+-- @brief Prepare an alert table used to generate the alert
+-- @param one_param The first alert param
+-- @param another_param The second alert param
+-- @return A table with the alert built
+function alert_flows_flood:init(metric, value, operator, threshold)
+   -- Call the paren constructor
+   self.super:init()
+
+   self.alert_type_params = alert_creators.createThresholdCross(metric, value, operator, threshold)
+end
 
 -- #######################################################
 
-local function formatFlowsFlood(ifid, alert, threshold_info)
+-- @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_flows_flood.format(ifid, alert, alert_type_params)
   local alert_consts = require("alert_consts")
   local entity = alert_consts.formatAlertEntity(ifid, alert_consts.alertEntityRaw(alert["alert_entity"]), alert["alert_entity_val"])
-  local value = threshold_info.value
+  local value = alert_type_params.value
 
   if(value == nil) then value = 0 end
   
@@ -21,24 +59,18 @@ local function formatFlowsFlood(ifid, alert, threshold_info)
       entity = firstToUpper(entity),
       host_category = format_utils.formatAddressCategory((json.decode(alert.alert_json)).alert_generation.host_info),
       value = string.format("%u", math.ceil(value)),
-      threshold = threshold_info.threshold,
+      threshold = alert_type_params.threshold,
     })
   else
     return i18n("alert_messages.flow_flood_victim", {
       entity = firstToUpper(entity),
       host_category = format_utils.formatAddressCategory((json.decode(alert.alert_json)).alert_generation.host_info),
       value = string.format("%u", math.ceil(value)),
-      threshold = threshold_info.threshold,
+      threshold = alert_type_params.threshold,
     })
   end
 end
 
 -- #######################################################
 
-return {
-  alert_key = alert_keys.ntopng.alert_flows_flood,
-  i18n_title = "alerts_dashboard.flows_flood",
-  i18n_description = formatFlowsFlood,
-  icon = "fas fa-life-ring",
-  creator = alert_creators.createThresholdCross,
-}
+return alert_flows_flood