ntopng/scripts/lua/modules/system_config/backup_config.lua
2024-01-12 11:44:18 +01:00

136 lines
4.3 KiB
Lua

--
-- (C) 2013-24 - ntop.org
--
--
-- This script implements the backup of ntopng configurations
--
local dirs = ntop.getDirs()
package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path
package.path = dirs.installdir .. "/scripts/lua/modules/import_export/?.lua;" .. package.path
-- ##############################################
require "lua_utils"
local all_import_export = require "all_import_export"
local import_export_rest_utils = require "import_export_rest_utils"
local rest_utils = require("rest_utils")
local json = require("dkjson")
-- ##############################################
local action = nil -- _GET["action"]
local backup_hash_key = "ntopng.cache.config_save_backup"
local backup_config = {}
local debugger = false
-- ##############################################
local function remove_last(epoch_keys)
for key, _ in pairsByKeys(epoch_keys or {}, asc) do
if debugger then
traceError(TRACE_DEBUG, TRACE_CONSOLE, "Removing the key: " .. key)
end
ntop.delHashCache(backup_hash_key, key)
break -- take the first one
end
end
-- ##############################################
-- @brief Save configurations backup.
function backup_config.save_backup()
local instances = {}
local to_ignore = { last_poll_time = true, last_poll_duration = true, num_interfaces_with_errors = true, delta_interfaces_with_errors = true }
-- Retrieve the configuration
instances["all"] = all_import_export:create()
local backup = import_export_rest_utils.export(instances, false, true)
if debugger then
traceError(TRACE_DEBUG, TRACE_CONSOLE, "START BACKUP SAVING")
end
-- Get all the keys
local key = tostring(os.time())
local saved_backups_keys = ntop.getHashKeysCache(backup_hash_key) or {}
local num_saved_backups = table.len(saved_backups_keys) or 0
-- Check the currently saved backups
if (num_saved_backups >= 7) then
remove_last(saved_backups_keys)
end
if (saved_backups_keys and num_saved_backups >= 1) then
-- Save the configuration on redis only if the configuration has some changes
-- between the last saved configuration, using the pairsByKeys just to order the
-- keys from the last added to the first one.
for item, _ in pairsByKeys(saved_backups_keys, rev) do
local last_config = json.decode(ntop.getHashCache(backup_hash_key, item)) or {}
-- Check if the last configuration is equal to the current one
if (not table.is_equal(last_config, backup, to_ignore)) then
-- tprint("CONFIGURATION CHANGED ****")
if debugger then
traceError(TRACE_DEBUG, TRACE_CONSOLE, "Saving Backup: " .. backup .. "\nUsing Redis key: " .. key)
end
ntop.setHashCache(backup_hash_key, key, json.encode(backup))
else
-- tprint("CONFIGURATION [ " .. item .."]= ****")
end
break -- take the first one
end
else
-- Save the backup
if debugger then
traceError(TRACE_DEBUG, TRACE_CONSOLE, "Saving Backup: " .. backup .. "\nUsing Redis key: " .. key)
end
ntop.setHashCache(backup_hash_key, key, json.encode(backup))
end
end
-- ##############################################
-- @brief List all configurations backup.
function backup_config.list_backup(user, order)
local saved_backups_keys = ntop.getHashKeysCache(backup_hash_key) or {}
local epoch_list = {}
local date_format = ntop.getPref("ntopng.user."..user..".date_format")
for epoch, _ in pairsByKeys(saved_backups_keys, rev) do
epoch_list[#epoch_list + 1] = {
epoch = epoch,
date_format = date_format
}
end
if order == "desc" then
table.sort(epoch_list, function(x,y) return x.epoch > y.epoch end)
else
table.sort(epoch_list, function(x,y) return x.epoch < y.epoch end)
end
return epoch_list
end
-- ##############################################
-- @brief Export configuration backup.
function backup_config.export_backup(epoch)
if (epoch == nil or isEmptyString(epoch)) then
return false, {}
end
local backup_to_restore = json.decode(ntop.getHashCache(backup_hash_key, epoch)) or {}
return true, json.encode(backup_to_restore)
end
-- ##############################################
return backup_config