ntopng/scripts/lua/modules/label_badge_utils.lua

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

require "ntop_utils"

local label_badge_utils = {}

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

-- Built-in host labels (bits 0-31).
-- Keep in sync with include/ntop_defines.h
label_badge_utils.builtin_labels = {
    [0]  = { i18n = "asset_details.dns_server"      }, -- HOST_LABEL_DNS_SERVER
    [1]  = { i18n = "asset_details.ntp_server"      }, -- HOST_LABEL_NTP_SERVER
    [2]  = { i18n = "asset_details.dhcp_server"     }, -- HOST_LABEL_DHCP_SERVER
    [3]  = { i18n = "asset_details.smtp_server"     }, -- HOST_LABEL_SMTP_SERVER
    [4]  = { i18n = "asset_details.network_gateway" }, -- HOST_LABEL_NETWORK_GATEWAY
    [5]  = { i18n = "asset_details.imap_server"     }, -- HOST_LABEL_IMAP_SERVER
    [6]  = { i18n = "asset_details.pop_server"      }, -- HOST_LABEL_POP_SERVER
    [7]  = { i18n = "asset_details.http_server"     }, -- HOST_LABEL_HTTP_SERVER
    [8]  = { i18n = "asset_details.ssh_server"      }, -- HOST_LABEL_SSH_SERVER
    [9]  = { i18n = "asset_details.rdp_server"      }, -- HOST_LABEL_RDP_SERVER
    [10] = { i18n = "asset_details.modbus_server"   }, -- HOST_LABEL_MODBUS_SERVER
    [11] = { i18n = "asset_details.s7comm_server"   }, -- HOST_LABEL_S7COMM_SERVER
    [12] = { i18n = "asset_details.profinet_server" }, -- HOST_LABEL_PROFINET_SERVER
}

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

local function get_redis_key()
    return "ntopng.prefs.labels"
end

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

local function get_default_labels_table()
    local labels = {}

    -- Bits 0-31: ntop built-in labels (read-only, auto-assigned by ntopng)
    for id, entry in pairs(label_badge_utils.builtin_labels) do
        local name = i18n(entry.i18n)
        if name == nil then
            traceError(TRACE_WARNING, TRACE_CONSOLE,
                "label_badge_utils: i18n key not found: " .. entry.i18n)
        end
        labels[id] = {
            id          = id,
            color       = "#0d6efd",
            description = "",
            name        = name,
            reserved    = "true"
        }
    end

    -- Bits 32-63: user-customizable labels
    for i = 32, 63 do
        labels[i] = {
            id          = i,
            color       = "#000000",
            description = "",
            name        = "Customizable_Label_" .. i,
            reserved    = "false"
        }
    end
    return labels
end

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

local function get_labels_from_cache()
    return ntop.getHashAllCache(get_redis_key()) or {}
end

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

local function get_labels()
    local json = require "dkjson"
    local labels = get_default_labels_table()
    local existing_labels = get_labels_from_cache()
    for _, label_json in pairs(existing_labels) do
        local label = json.decode(label_json)
        if label then
            labels[label.id] = label
        end
    end
    return labels
end

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

-- Returns all the labels
function label_badge_utils.getLabels()
    local labels = get_labels()

    local result = {}
    for _,label in pairs(labels) do
        local record = {}
        record["id"] = label.id
        record["name"] = label.name
        record["color"] = label.color
        record["description"] = label.description
        record["reserved"] = label.reserved
        result[#result + 1] = label
    end
    table.sort(result, function(a, b)
        return (tonumber(a.id) or 0) < (tonumber(b.id) or 0)
    end)
    return result
end

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

-- Updates the label passed as a parameter
-- id: id of the label to update 
-- name: new name of the label to update
-- color: new color of the label to update (string containing a HEX value)
-- description: new description of the label to update
function label_badge_utils.editLabel(id, name, color, description, reserved)
    local json = require "dkjson"
    local label = {
        id = id, 
        name = name, 
        color = color,
        description = description, 
        reserved = reserved
    }
    ntop.setHashCache(get_redis_key(), id, json.encode(label))
    --tprint(old_name .. " " .. name .. " " .. color .. " " .. description)
end

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

function label_badge_utils.deleteLabel(id)
    local labels = get_labels_from_cache()

    -- Validate and normalize ID
    if id then
        id = tostring(id)
    else
        return false, "Invalid ID"
    end
    -- Check if label exists before deletion
    if labels[id] then
        -- Remove label from Redis
        ntop.delHashCache(get_redis_key(), id)
    else
        return false, "Invalid Site"
    end

    local success_msg = "Label deleted successfully"
    return true, success_msg
end

return label_badge_utils