--
-- (C) 2013-20 - ntop.org
--
local dirs = ntop.getDirs()
local info = ntop.getInfo()
package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path
local plugins_utils = require("plugins_utils")
local is_nedge = ntop.isnEdge()
local page_utils = {}
-- #################################
local active_section = nil
local active_entry = nil
-- #################################
page_utils.menu_sections = {
dashboard = {key = "dashboard", i18n_title = "index_page.dashboard", icon = "fas fa-tachometer-alt"},
alerts = {key = "alerts", i18n_title = "details.alerts", icon = "fas fa-exclamation-triangle"},
flows = {key = "flows", i18n_title = "flows", icon = "fas fa-stream"},
hosts = {key = "hosts", i18n_title = "hosts", icon = "fas fa-laptop"},
exporters = {key = "exporters", i18n_title = "flow_devices.exporters", icon = "fas fa-file-export"},
if_stats = {key = "if_stats", i18n_title = "interface", icon = "fas fa-ethernet"},
system_stats = {key = "system_stats", i18n_title = "system", icon = "fas fa-desktop"},
admin = {key = "admin", i18n_title = "settings", icon = "fas fa-cog"},
dev = {key = "dev", i18n_title = "developer", icon = "fas fa-code"},
about = {key = "about", i18n_title = "help", icon = "fas fa-life-ring"},
snmp = {key = "snmp", i18n_title = "prefs.snmp", icon = "fas fa-tablet"},
health = {key = "system_health", i18n_title = "health", icon = "fas fa-heartbeat"},
tools = {key = "tools", i18n_title = "tools", icon = "fas fa-cogs"},
pools = {key = "pools", i18n_title = "pools.pools", icon = "fas fa-users"},
-- nEdge
views = {key = "hosts", i18n_title = "views", icon = "fas fa-bars"},
}
-- #################################
-- visible_iface: this flag is true when the page belong to interface view
-- visible_system: this flags is true when the page belong to system view
-- if both flags are true it means the pages are shared between views
-- help_link: this variable contains the contextual link to the documentation
page_utils.menu_entries = {
-- Dashboard
traffic_dashboard = {key = "traffic_dashboard", i18n_title = "dashboard.traffic_dashboard", section = "dashboard", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/dashboard.html"},
network_discovery = {key = "network_discovery", i18n_title = "discover.network_discovery", section = "dashboard", visible_iface = true},
traffic_report = {key = "traffic_report", i18n_title = "report.traffic_report", section = "dashboard", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/report.html"},
db_explorer = {key = "db_explorer", i18n_title = "db_explorer.historical_data_explorer", section = "dashboard", visible_iface = true},
-- Alerts
detected_alerts = {key = "detected_alerts", i18n_title = "show_alerts.detected_alerts", section = "alerts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/alerts.html"},
alerts_dashboard = {key = "alerts_dashboard", i18n_title = "alerts_dashboard.alerts_dashboard", section = "alerts", visible_iface = true},
flow_alerts_explorer = {key = "flow_alerts_explorer", i18n_title = "flow_alerts_explorer.label", section = "alerts", visible_iface = true},
-- Flows
flows = {key = "flows", i18n_title = "flows", section = "flows", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/flows.html"},
flow_details = {key = "flow_details", i18n_title = "flow_details.flow_details", section = "flows", visible_iface = true},
-- Hosts
hosts = {key = "hosts", i18n_title = "hosts", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html#"},
devices = {key = "devices", i18n_title = "layer_2", section = "hosts", visible_iface = true},
networks = {key = "networks", i18n_title = "networks", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#networks"},
vlans = {key = "vlans", i18n_title = "vlan_stats.vlans", section = "hosts", visible_iface = true},
host_pools = {key = "host_pools", i18n_title = "host_pools.host_pools", section = "hosts", visible_iface = true},
autonomous_systems = {key = "autonomous_systems", i18n_title = "as_stats.autonomous_systems", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#autonomous-systems"},
countries = {key = "countries", i18n_title = "countries", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#countries"},
operating_systems = {key = "operating_systems", i18n_title = "operating_systems", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#operating-systems"},
http_servers = {key = "http_servers", i18n_title = "http_servers_stats.http_servers", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#http-servers-local"},
top_hosts = {key = "top_hosts", i18n_title = "processes_stats.top_hosts", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#top-hosts-local"},
geo_map = {key = "geo_map", i18n_title = "geo_map.geo_map", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#geo-map"},
hosts_treemap = {key = "hosts_treemap", i18n_title = "tree_map.hosts_treemap", section = "hosts", visible_iface = true},
host_explorer = {key = "host_explorer", i18n_title = "host_explorer", section = "hosts", visible_iface = true},
containers = {key = "containers", i18n_title = "containers_stats.containers", section = "hosts", visible_iface = true},
pods = {key = "pods", i18n_title = "containers_stats.pods", section = "hosts", visible_iface = true},
-- Interface
interface = {key = "interface", i18n_title = "interface_ifname", section = "if_stats", visible_iface = true},
-- SNMP
snmp = {key = "snmp", i18n_title = "prefs.snmp", section = "snmp", visible_system = true},
-- Status (Health)
system_status = {key = "status", i18n_title = "system_status", section = "system_health", visible_system = true},
interfaces_status = {key = "interfaces_status", i18n_title = "system_interfaces_status", section = "system_health", visible_system = true},
-- Exporters
event_exporters = {key = "event_exporters", i18n_title = "event_exporters.event_exporters", section = "exporters"},
sflow_exporters = {key = "sflow_exporters", i18n_title = "flows_page.sflow_devices", section = "exporters"},
flow_exporters = {key = "flow_exporters", i18n_title = "flow_devices.exporters", section = "exporters"},
-- Settings
manage_users = {key = "manage_users", i18n_title = ternary(is_nedge, "nedge.system_users", "manage_users.manage_users"), section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#manage-users"},
preferences = {key = "preferences", i18n_title = "prefs.preferences", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#preferences"},
scripts_config = {key = "scripts_config", i18n_title = "about.user_scripts", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/user_scripts.html"},
profiles = {key = "profiles", i18n_title = "traffic_profiles.traffic_profiles", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/advanced_features/traffic_profiles.html"},
categories = {key = "categories", i18n_title = "custom_categories.apps_and_categories", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/categories.html#custom-applications"},
category_lists = {key = "category_lists", i18n_title = "category_lists.category_lists", section = "admin", visible_iface = true, visible_system = true},
device_protocols = {key = "device_protocols", i18n_title = "device_protocols.device_protocols", section = "admin", visible_iface = true, visible_system = true},
conf_backup = {key = "conf_backup", i18n_title = "conf_backup.conf_backup", section = "admin", visible_iface = true, visible_system = true},
conf_restore = {key = "conf_restore", i18n_title = "conf_backup.conf_restore", section = "admin", visible_iface = true, visible_system = true},
manage_data = {key = "manage_data", i18n_title = "manage_data.manage_data", section = "admin", visible_iface = true, visible_system = false, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#manage-data"},
endpoint_notifications = {key = "endpoint_notifications", i18n_title = "endpoint_notifications.endpoint_list", section="admin", visible_iface = true, visible_system = true},
endpoint_recipients = {key = "endpoint_recipients", i18n_title = "endpoint_notifications.enpoint_recipients_list", section="admin", visible_iface = true, visible_system = true},
-- Tools
export_data = {key = "export_data", i18n_title = "manage_data.export", section = "tools"},
remote_assistance = {key = "remote_assistance", i18n_title = "remote_assistance.remote_assistance", section = "tools", help_link = "https://www.ntop.org/guides/ntopng/remote_assistance.html"},
-- Pools
pools_host = {key = "pools_host", i18n_title = "host_pools.host_pools", section = "pools", visible_iface = false, visible_system = true},
pools_interface = {key = "pools_interface", i18n_title = "pools.pool_names.interface", section = "pools", visible_iface = false, visible_system = true},
pools_snmp = {key = "pools_snmp", i18n_title = "pools.pool_names.snmp", section = "pools", visible_iface = false, visible_system = true},
pools_local_network = {key = "pools_local_network", i18n_title = "pools.pool_names.local_network", section = "pools", visible_iface = false, visible_system = true},
pools_active_monitoring = {key = "pools_active_monitoring", i18n_title = "pools.pool_names.active_monitoring", section = "pools", visible_iface = false, visible_system = true},
-- Home
live_capture = {key = "live_capture", i18n_title = "live_capture.active_live_captures", section = "home"},
-- Developer
directories = {key = "directories", i18n_title = "about.directories", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/distributing_plugins.html"},
plugins = {key = "plugins", i18n_title = "plugins", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/basic_concepts/plugins.html"},
user_scripts_dev = {key = "user_scripts_dev", i18n_title = "about.user_scripts", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/user_scripts.html"},
plugin_browser = {key = "plugin_browser", i18n_title = "plugin_browser", section = "dev", visible_iface = true, visible_system = true},
alert_definitions = {key = "alert_definitions", i18n_title = "about.alert_defines", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/alert_definitions.html"},
api = {key = "api", i18n_title = "lua_c_api", section = "dev"},
widgets_list = {key = "widgets_list", i18n_title = "developer_section.widgets_list", section = "dev"},
datasources_list = {key = "datasources_list", i18n_title = "developer_section.datasources_list", section = "dev"},
-- Help
about = {key = "about", i18n_title = "about.about", section = "about", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/help_menu.html?#about"},
telemetry = {key = "telemetry", i18n_title = "telemetry", section = "about", visible_iface = true, visible_system = true},
blog = {key = "blog", i18n_title = "about.ntop_blog", section = "about"},
telegram = {key = "telegram", i18n_title = "about.telegram", section = "about"},
report_issue = {key = "report_issue", i18n_title = "about.report_issue", section = "about"},
manual = {key = "manual", i18n_title = "about.readme_and_manual", section = "about"},
suggest_feature = {key = "suggest_feature", i18n_title = "about.suggest_feature", section = "about"},
-- Just a divider for horizontal rows in the menu
divider = {key = "divider"},
-- nEdge
gateways_users = {key = "gateways_users", i18n_title = "dashboard.gateways_users", section = "dashboard"},
nedge_flows = {key = "nedge_flows", i18n_title = "flows", section = "hosts"},
users = {key = "users", i18n_title = "users.users", section = "hosts", help_link = "https://www.ntop.org/guides/ntopng/advanced_features/authentication.html"},
system_setup = {key = "system_setup", i18n_title = "nedge.system_setup", section = "system_stats", help_link = "https://www.ntop.org/guides/nedge/get_started.html"},
dhcp_leases = {key = "dhcp_leases", i18n_title = "nedge.dhcp_leases", section = "system_stats"},
port_forwarding = {key = "port_forwarding", i18n_title = "nedge.port_forwarding", section = "system_stats"},
nedge_users = {key = "nedge_users", i18n_title = "manage_users.manage_users", section = "system_stats", help_link = "https://www.ntop.org/guides/nedge/users.html#"},
}
-- Extend the menu entries with the plugins
local menu, entries_data = plugins_utils.getMenuEntries()
page_utils.plugins_menu = menu or {}
if entries_data then
for k, v in pairs(entries_data) do
page_utils.menu_entries[k] = v
end
end
-- #################################
-- NOTE: this function must be called after page_utils.set_active_menu_entry
function page_utils.print_page_title(title)
local help_link = page_utils.menu_entries[active_entry].help_link or ""
print("")
print("".. title .." ")
if (not isEmptyString(help_link)) then
print(" ")
end
print(" ")
end
-- #################################
-- NOTE: this function is called by the web pages in order to
-- set the active entry and section and highlight it into the menu
function page_utils.set_active_menu_entry(entry, i18n_params, alt_title)
entry = entry or page_utils.menu_entries.traffic_dashboard
active_section = entry.section
active_entry = entry.key
-- check if the page belong to system view
-- or if the page belong to interface view
-- if both flags are true then it means the page
-- is visible in system view and interface view
local visible_iface = entry.visible_iface or false
local visible_system = entry.visible_system or false
if (visible_system and visible_iface) then
-- do nothing
elseif (visible_system and not page_utils.is_system_view()) then
page_utils.set_system_view(true)
elseif (visible_iface and page_utils.is_system_view()) then
page_utils.set_system_view(false)
end
page_utils.print_header(alt_title or i18n(entry.i18n_title, i18n_params) or entry.i18n_title)
end
-- #################################
function page_utils.get_active_section()
return(active_section)
end
function page_utils.get_active_entry()
return(active_entry)
end
-- #################################
-- @brief Encode the HTML entities in a string.
-- Useful when printing dissected data which may result in XSS
-- e.g., curl -u admin:admin1 "http://devel:3000/"
-- @param s The string to escape.
-- @return The string with HTML entities properly escaped
function page_utils.safe_html(s)
if not s then
return ''
end
return string.gsub(s, "[}{\">/<'&]", {
["&"] = "&",
["<"] = "<",
[">"] = ">",
['"'] = """,
["'"] = "'",
["/"] = "/"
})
end
-- #################################
function page_utils.is_dark_mode_enabled(theme)
local dark_mode
local theme = theme or ntop.getPref("ntopng.prefs.theme")
if (isEmptyString(theme)) then
dark_mode = false
else
dark_mode = (theme == "dark")
end
return dark_mode
end
-- #################################
function page_utils.print_header(title)
local http_prefix = ntop.getHttpPrefix()
local startup_epoch = ntop.getStartupEpoch()
local dark_mode = page_utils.is_dark_mode_enabled(_POST["toggle_theme"])
local page_title = i18n("welcome_to", { product=info.product })
if title ~= nil then
page_title = info.product .. " - " .. title
end
print [[
]] print(page_title) print[[
]]
if (dark_mode) then
print[[ ]]
print[[ ]]
else
print[[ ]]
end
print[[
]]
print([[
]])
end
-- #################################
function page_utils.print_header_minimal(title)
local http_prefix = ntop.getHttpPrefix()
local page_title = i18n("welcome_to", { product=info.product })
if title ~= nil then
page_title = info.product .. " - " .. title
end
print [[
]] print(page_title) print[[
]]
end
-- #################################
function page_utils.print_navbar(title, base_url, items_table, label_url)
-- label_url: is the link for navabr-brand, the default link is #
print[[
]]
if label_url == nil then
print(title)
else
print[[
]] print(title) print[[
]]
end
print[[
]]
end
-- #################################
local menubar_structure = {}
function page_utils.init_menubar()
menubar_structure = {}
end
-- #################################
function page_utils.add_menubar_section(section)
menubar_structure[#menubar_structure + 1] = section
end
-- #################################
function page_utils.print_menubar()
local logo_path = nil
if (ntop.isPro() or ntop.isnEdge()) and ntop.exists(dirs.installdir .. "/httpdocs/img/custom_logo.png") then
logo_path = ntop.getHttpPrefix().."/img/custom_logo.png"
end
local navbar_style = _POST["toggle_theme"] or ntop.getPref("ntopng.prefs.theme")
local active_page = page_utils.get_active_section()
local active_subpage = page_utils.get_active_entry()
if ((navbar_style == nil) or (navbar_style == "")) then
navbar_style = "default"
end
if (navbar_style == "default") then
navbar_style = "dark"
end
print('
]])
end
-- ##############################################
function page_utils.print_notes(notes_items)
print("" .. i18n("notes").. " ")
for _, note in ipairs(notes_items) do
print("" ..note .. " ")
end
print(" ")
end
-- ##############################################
function page_utils.is_system_view()
return ((ntop.getPref("ntopng.prefs.system_mode_enabled") == "1") and isAdministrator())
end
-- ##############################################
function page_utils.set_system_view(toggle)
local t
if toggle == "1" or toggle == true then
t = "1"
elseif toggle == "0" or toggle == false then
t = "0"
end
if t then
ntop.setPref("ntopng.prefs.system_mode_enabled", t)
end
end
-- ##############################################
return page_utils