ntopng/scripts/lua/modules/user_script_templates/user_script_template.lua

--
-- (C) 2013-21 - ntop.org
--

local dirs = ntop.getDirs()
package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path

-- Import the classes library.
local classes = require "classes"

-- ##############################################

local user_script_template = classes.class()

-- ##############################################

function user_script_template:init(user_script)
   self._user_script = user_script
end

-- ##############################################

function user_script_template:parseConfig(conf)
  return true, conf
end

-- ##############################################

function user_script_template:describeConfig(hooks_conf)
  return ''
end

-- ##############################################

-- @brief Render user script HTML templates for all the available user script hooks
--        To locate an HTML template file, user script gui.input_builder variable is taken and
--        concatenated with ".template". For example, user script long_lived.lua has gui.input_builder == "long_lived"
--        will cause template "long_lived.template" to be located and then rendered.
-- @return Rendered templates in a table whose keys are hook names and whose values are rendered templates.
function user_script_template:render(hooks_conf)
   local res = {}
   local plugins_utils = require "plugins_utils"

   -- check if the input_builder is defined
   -- TODO: define empty template for the user scripts without input_builder/template
   if (isEmptyString(self._user_script.gui.input_builder)) then
      return { templates = {{hook = "all", template = ""}}, user_script = self._user_script }
   end

   -- Use ipairs on script type hooks to make sure hooks are always returned sorted and in the same order
   for _, hook in ipairs(table.merge({"all"} --[[ Hook "all" always go first --]], self._user_script.script_type.hooks)) do
      local hook_conf =  hooks_conf[hook]

      -- If the hook is among those passed as parameter, add it to the result
      if hook_conf then
	      res[#res + 1] = {
            hook = hook, -- Hook Name
            template = plugins_utils.renderTemplate(self._user_script.plugin.key, self._user_script.gui.input_builder..".template", {
               hook_conf = hook_conf,
               hook_name = hook,
               user_script = self._user_script
            }) -- Rendered Template
      }
      end
   end

   return {
      templates = res,
      user_script = self._user_script
   }
end

-- ##############################################

return user_script_template

-- ##############################################