vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-08-10 08:53:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
ntopng/scripts/lua/modules/menu_definition.lua
Manuel Ceroni d7bf806ae3
Some checks are pending
Build / build (push) Waiting to run
Details
CIFuzz / Fuzzing (address) (push) Waiting to run
Details
CodeQL / Analyze-1 (push) Waiting to run
Details
CodeQL / Analyze (push) Waiting to run
Details
Added the hard_hidden parameter for menu entries (#10680)
2026-08-03 12:36:16 +02:00

466 lines
18 KiB
Lua
Raw Blame History

--
-- (C) 2013-26 - ntop.org
--
-- Community menu definition.
-- Returns a function(f) where f is the flags table from ntopng_menu_visibility.
-- Pro/nEdge entries live in pro/scripts/lua/modules/menu_definition_pro.lua.
--
-- Sections with matching keys from the pro definition get their entries
-- appended to the community entries. New pro-only sections declare
-- after = "section_key" to control where they are inserted.
--
-- NOTE: To add a new flag, update scripts/lua/modules/ntopng_menu_visibility.lua
--
-- Each section/entry carries:
-- hard_hidden = <lua boolean expr> -- optional, structural: ALWAYS dropped
-- hidden = <lua boolean expr>
-- reason = { menu_visibility.reason(badge, reason_key, suggestion_key), ... } -- optional
-- menu_visibility.resolve(item) is the single place deciding what these
-- mean: hard_hidden drops the item outright, while `hidden` drops it only
-- when no fixable reason is attached, otherwise keeps it dimmed+tooltip.
--
-- Structural conditions (system interface vs traffic interface, nEdge vs
-- ntopng, Windows vs Unix) go in `hard_hidden`, NOT in `hidden`: they are
-- not fixable, and leaving them in `hidden` makes the item survive as a
-- dimmed row as soon as any fixable reason happens to be in the list.
-- Every reason() call must be guarded by the condition it describes
-- (`cond and reason(...) or nil`), otherwise it describes something that
-- is not actually true.
--
local menu_visibility = require "ntopng_menu_visibility"
local reason = menu_visibility.reason
return function(f)
return {
{
key = "dashboard",
i18n = "index_page.dashboard",
icon = "fas fa-tachometer-alt",
hard_hidden = f.is_system_interface,
hidden = f.is_pcap_dump or f.is_db_view_interface,
reason = {
f.is_pcap_dump and reason("iface", "menu.reason.is_pcap_dump", "menu.suggestion.is_pcap_dump") or nil,
f.is_db_view_interface and reason("iface", "menu.reason.is_db_view_interface", "menu.suggestion.is_db_view_interface") or nil,
},
entries = {{
key = "traffic_dashboard",
i18n = "dashboard.traffic_dashboard",
icon = "fas fa-chart-area",
url = "/lua/index.lua"
} -- pro entries appended by menu_definition_pro: assets_dashboard, gateways_users, traffic_report, hr_chart
}
},
{
key = "monitoring",
i18n = "monitoring",
icon = "fas fa-eye",
hard_hidden = f.is_system_interface,
hidden = f.no_admin,
reason = { reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") },
entries = {{
key = "active_monitoring",
i18n = "active_monitoring_stats.active_monitoring",
icon = "fas fa-heartbeat",
url = "/lua/active_monitoring.lua",
hidden = f.is_windows,
reason = { reason("platform", "menu.reason.is_windows", "menu.suggestion.is_windows") }
}, {
key = "network_discovery",
i18n = "discover.network_discovery",
icon = "fas fa-search",
url = "/lua/discover.lua",
hard_hidden = f.no_discoverable_interface or f.is_windows or f.is_loopback_interface,
hidden = f.limit_resource_usage or f.infrastructure_view,
reason = {
f.limit_resource_usage and reason("feature", "menu.reason.limit_resource_usage", "menu.suggestion.limit_resource_usage") or nil,
f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil,
}
}, {
key = "vulnerability_scan",
i18n = "scan_hosts",
icon = "fas fa-shield-alt",
url = "/lua/vulnerability_scan.lua",
hard_hidden = f.is_zmq_interface,
hidden = f.no_vs_utils,
reason = { reason("feature", "menu.reason.no_vs_utils", "menu.suggestion.no_vs_utils") }
} -- pro entries appended by menu_definition_pro: infrastructure_dashboard, snmp_monitoring
}
},
{
key = "alerts",
i18n = "details.alerts",
icon = "fas fa-exclamation-triangle",
hard_hidden = f.is_db_view_interface,
hidden = f.alerts_disabled or f.no_alerts_cap or f.infrastructure_view,
reason = {
f.alerts_disabled and reason("feature", "menu.reason.alerts_disabled", "menu.suggestion.alerts_disabled") or nil,
f.no_alerts_cap and reason("perm", "menu.reason.no_alerts_cap", "menu.suggestion.no_alerts_cap") or nil,
f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil,
},
entries = {{
key = "alerts_list",
i18n = "details.alerts_list",
icon = "fas fa-list",
url = "/lua/alert_stats.lua"
}, -- pro entries appended by menu_definition_pro: alerts_graph, alerts_analysis
{
key = "divider",
i18n = "menu_group.notifications",
is_divider = true
}, {
key = "notifications",
i18n = "endpoint_notifications.notifications",
icon = "fas fa-bell",
url = "/lua/admin/endpoint_notifications_list.lua",
hidden = f.no_admin or f.is_pcap_dump,
reason = { f.no_admin and reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") or nil }
}}
},
{
key = "flows",
i18n = "flows",
icon = "fas fa-stream",
hard_hidden = f.is_system_interface or f.is_nedge or f.is_asn_mode_enabled,
hidden = f.infrastructure_view,
reason = { f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil },
entries = {{
key = "active_flows",
i18n = "active_flows",
icon = "fas fa-water",
url = "/lua/flows_stats.lua"
} -- pro entries appended by menu_definition_pro: db_explorer, server_ports, bgp_looking_glass
}
},
{
key = "hosts",
i18n = "hosts",
icon = "fas fa-laptop",
hard_hidden = f.is_system_interface or f.is_viewed or f.is_nedge or f.is_asn_mode_enabled,
hidden = f.infrastructure_view,
reason = { f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil },
entries = {{
key = "hosts",
i18n = "hosts",
icon = "fas fa-laptop",
url = "/lua/hosts_stats.lua"
}, {
key = "devices",
i18n = "layer_2",
icon = "fas fa-hdd",
url = "/lua/macs_stats.lua",
hidden = f.no_macs,
reason = { reason("feature", "menu.reason.no_macs", "menu.suggestion.no_macs") }
} -- pro entries appended by menu_definition_pro: inventory divider + assets
}
}, {
key = "maps",
after = "collection",
i18n = "maps",
icon = "fas fa-map",
hard_hidden = f.is_system_interface or f.is_viewed,
hidden = f.infrastructure_view,
reason = { f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil },
entries = {{
key = "geo_map",
i18n = "geo_map.geo_map",
icon = "fas fa-globe",
url = "/lua/hosts_geomap.lua",
hidden = f.is_loopback_interface or f.no_geoip,
reason = { f.no_geoip and reason("feature", "menu.reason.no_geoip", "menu.suggestion.no_geoip") or nil }
}}
}, {
key = "if_stats",
i18n = "interface",
icon = "fas fa-ethernet",
hard_hidden = f.is_system_interface,
hidden = f.infrastructure_view,
reason = { f.infrastructure_view and reason("iface", "menu.reason.infrastructure_view", "menu.suggestion.infrastructure_view") or nil },
entries = {{
key = "interface",
i18n = "interface_details",
icon = "fas fa-info-circle",
url = "/lua/if_stats.lua"
}, {
key = "divider",
i18n = "menu_group.segments",
is_divider = true
}, {
key = "networks",
i18n = "networks",
icon = "fas fa-network-wired",
url = "/lua/network_stats.lua",
-- Superseded by Sites Dashboard on Pro+, not a license gate:
-- structural, so it must never show up as a dimmed "upgrade" row.
hard_hidden = f.is_pro,
hidden = f.is_viewed_interface,
reason = { reason("iface", "menu.reason.is_viewed", "menu.suggestion.is_viewed") }
}, {
key = "host_pools",
i18n = "host_pools.host_pools",
icon = "fas fa-layer-group",
url = "/lua/pool_stats.lua",
hard_hidden = f.is_nedge
}, {
key = "autonomous_systems",
i18n = "as_stats.autonomous_systems",
icon = "fas fa-globe",
url = "/lua/as_stats.lua",
hidden = f.no_geoip or f.is_viewed_interface,
reason = {
f.no_geoip and reason("feature", "menu.reason.no_geoip", "menu.suggestion.no_geoip") or nil,
f.is_viewed_interface and reason("iface", "menu.reason.is_viewed", "menu.suggestion.is_viewed") or nil,
}
}, {
key = "countries",
i18n = "countries",
icon = "fas fa-flag",
url = "/lua/country_stats.lua",
hidden = f.no_geoip or f.is_viewed_interface,
reason = {
f.no_geoip and reason("feature", "menu.reason.no_geoip", "menu.suggestion.no_geoip") or nil,
f.is_viewed_interface and reason("iface", "menu.reason.is_viewed", "menu.suggestion.is_viewed") or nil,
}
}, {
key = "vlans",
i18n = "vlan_stats.vlans",
icon = "fas fa-tags",
url = "/lua/vlan_stats.lua",
hidden = f.no_vlans or f.is_viewed_interface,
reason = {
f.no_vlans and reason("feature", "menu.reason.no_vlans", "menu.suggestion.no_vlans") or nil,
f.is_viewed_interface and reason("iface", "menu.reason.is_viewed", "menu.suggestion.is_viewed") or nil,
}
}, {
key = "divider",
i18n = "menu_group.containers",
is_divider = true
}, {
key = "pods",
i18n = "pods",
icon = "fab fa-docker",
url = "/lua/pods_stats.lua",
hidden = f.no_pods
}, {
key = "containers",
i18n = "containers",
icon = "fas fa-cube",
url = "/lua/containers_stats.lua",
hidden = f.no_containers
}}
},
{
key = "health",
i18n = "health",
icon = "fas fa-heartbeat",
-- System-interface-only section: structural, never dimmed elsewhere.
hard_hidden = f.no_system_interface,
entries = {{
key = "system_status",
i18n = "system_status",
icon = "fas fa-server",
url = "/lua/system_stats.lua"
}, {
key = "interfaces_status",
i18n = "system_interfaces_status",
icon = "fas fa-ethernet",
url = "/lua/system_interfaces_stats.lua"
}, {
key = "divider",
i18n = "menu_group.storage",
is_divider = true
}, {
key = "influxdb_status",
i18n = "InfluxDB",
icon = "fas fa-database",
url = "/lua/monitor/influxdb_monitor.lua",
hidden = f.no_influxdb,
reason = { reason("feature", "menu.reason.no_influxdb", "menu.suggestion.no_influxdb") }
}, {
key = "redis_status",
i18n = "Redis",
icon = "fas fa-memory",
url = "/lua/monitor/redis_monitor.lua"
} -- pro entry appended by menu_definition_pro: clickhouse_status
}
},
{
key = "admin",
i18n = "settings",
icon = "fas fa-cog",
hidden = f.no_admin,
reason = { reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") },
entries = {{
key = "divider",
i18n = "menu_group.users",
is_divider = true
}, {
key = "manage_users",
i18n = "manage_users.manage_users",
icon = "fas fa-user-cog",
url = "/lua/admin/users.lua",
hidden = f.no_local_auth_or_local_user,
reason = { reason("perm", "menu.reason.no_local_auth_or_local_user", "menu.suggestion.no_local_auth_or_local_user") }
}, {
key = "divider",
i18n = "menu_group.configuration",
is_divider = true
}, {
key = "preferences",
i18n = "prefs.preferences",
icon = "fas fa-sliders-h",
url = "/lua/admin/prefs.lua"
}, {
key = "tags",
i18n = "tags_page.tags",
icon = "fas fa-tag",
url = "/lua/tags.lua"
}, {
key = "category_lists",
i18n = "category_lists.category_lists",
icon = "fas fa-list",
url = "/lua/admin/blacklists.lua?enabled_status=enabled"
}, {
key = "manage_configurations",
i18n = "manage_configurations.manage_configurations",
icon = "fas fa-file-export",
url = "/lua/admin/manage_configurations.lua",
hidden = f.no_dump_cache,
reason = { reason("feature", "menu.reason.no_dump_cache", "menu.suggestion.no_dump_cache") }
}, {
key = "divider",
i18n = "menu_group.customization",
is_divider = true
}, {
key = "categories",
i18n = "custom_categories.apps_and_categories",
icon = "fas fa-th-large",
url = "/lua/admin/edit_categories.lua"
} -- nEdge entries appended by menu_definition_pro: nedge_users, divider_nedge_admin, conf_backup, conf_restore
}
},
{
key = "dev",
i18n = "developer",
icon = "fas fa-code",
hidden = f.is_oem or f.no_developer_cap or f.no_developer_menu,
entries = {{
key = "rest_api",
i18n = "swagger_api",
icon = "fas fa-plug",
url = "/lua/swagger.lua"
}, {
key = "analyze_pcap",
i18n = "upload_pcap",
icon = "fas fa-file-upload",
url = "/lua/upload_pcap.lua"
}, {
key = "manage_data",
i18n = "manage_data.manage_data",
icon = "fas fa-database",
url = "/lua/manage_data.lua",
hidden = f.no_admin,
reason = { reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") }
}, {
key = "divider",
i18n = "menu_group.internals",
is_divider = true
}, {
key = "checks_dev",
i18n = "about.checks",
icon = "fas fa-check-square",
url = "/lua/checks_overview.lua"
}, {
key = "alert_definitions",
i18n = "about.alert_defines",
icon = "fas fa-exclamation-circle",
url = "/lua/defs_overview.lua"
}, {
key = "ts_definitions",
i18n = "about.ts_definitions",
icon = "fas fa-chart-line",
url = "/lua/ts_overview.lua"
}, {
key = "directories",
i18n = "about.directories",
icon = "fas fa-folder-open",
url = "/lua/directories.lua"
}, {
key = "divider",
i18n = "menu_group.documentation",
is_divider = true
}, {
key = "api",
i18n = "about.api_reference",
icon = "fas fa-book-open",
url = "https://www.ntop.org/guides/ntopng/api/",
is_external = true
}}
},
{
key = "about",
i18n = "help",
icon = "fas fa-info-circle",
hidden = f.is_oem or f.no_help_menu,
entries = {{
key = "about",
i18n = "about.about",
icon = "fas fa-info",
url = "/lua/about.lua"
}, {
key = "license",
i18n = "license_page.license",
icon = "fas fa-id-card",
url = "/lua/license.lua",
hidden = f.pro_forced_community or f.no_admin,
reason = {
f.pro_forced_community and reason("pro", "menu.reason.pro_forced_community", "menu.suggestion.pro_forced_community") or nil,
f.no_admin and reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") or nil,
}
}, {
key = "limits",
i18n = "limits_page.limits",
icon = "fas fa-tachometer-alt",
url = "/lua/limits.lua",
hidden = f.no_admin,
reason = { reason("perm", "menu.reason.no_admin", "menu.suggestion.no_admin") }
}, {
key = "divider",
i18n = "menu_group.community",
is_divider = true
}, {
key = "blog",
i18n = "about.ntop_blog",
icon = "fas fa-rss",
url = "http://blog.ntop.org/",
is_external = true
}, {
key = "telegram",
i18n = "about.telegram",
icon = "fab fa-telegram-plane",
url = "https://t.me/ntop_community",
is_external = true
}, {
key = "manual",
i18n = "about.user_manual",
icon = "fas fa-book",
url = "https://www.ntop.org/guides/ntopng/",
is_external = true
}, {
key = "divider",
i18n = "menu_group.support",
is_divider = true
}, {
key = "report_issue",
i18n = "about.report_issue",
icon = "fas fa-bug",
url = "https://github.com/ntop/ntopng/issues",
is_external = true
}, {
key = "suggest_feature",
i18n = "about.suggest_feature",
icon = "fas fa-lightbulb",
url = "https://www.ntop.org/support/need-help-2/contact-us/",
is_external = true
}}
}}
end
Reference in a new issue View git blame Copy permalink