vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-04-29 07:29:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

add bubble widget and removed old code

Browse source
This commit is contained in:
gabryon99 2021-03-01 15:49:02 +01:00
parent 8f1ff91c43
commit 2bb5be7bf6
11 changed files with 209 additions and 234 deletions
Download patch file Download diff file Expand all files Collapse all files

171
scripts/lua/modules/widgets_utils.lua
View file

@ -10,172 +10,6 @@ local rest_utils = require "rest_utils"
local datasources_utils = require("datasources_utils")
local datasource_keys = require "datasource_keys"
-- Widget Element Model:
-- name: the widget name
-- key: the string which identify the widget
-- type: the default type to render a widget
local REDIS_BASE_KEY = "ntopng.widgets"
local WIDGET_TYPES = {
pie = {
i18n = "Pie"
},
donut = {
i18n = "Donut"
},
table = {
i18n = "Table"
},
multibar = {
i18n = "Multibar"
}
}
local function create_hash_widget(name, ds_hash)
return ntop.md5(name .. ds_hash)
end
local function check_widget_params(name, ds_hash, widget_type, params)
if (isEmptyString(name)) then
return false, "The widget name cannot be empty!"
end
if (isEmptyString(ds_hash)) then
return false, "The associated datasource hash cannot be empty!"
end
-- Check if the passed ds hash is valid
if (not datasources_utils.is_hash_valid(ds_hash)) then
return false, "The passed hash is not valid!"
end
if (isEmptyString(widget_type) or WIDGET_TYPES[widget_type] == nil) then
return false, "The passed widget type is not valid!"
end
if (params == nil) then
return false, "The params are not valid!"
end
return true, nil
end
function widgets_utils.get_widget_types()
return WIDGET_TYPES
end
-------------------------------------------------------------------------------
-- Create a new widget and save it to redis.
-- @return The function returns `true` if the passed
-- arguments meet the precondition, otherwise `false`
-------------------------------------------------------------------------------
function widgets_utils.add_widget(name, ds_hash, widget_type, params)
local args_are_valid, message = check_widget_params(name, ds_hash, widget_type, params)
if (not args_are_valid) then
return args_are_valid, message
end
local key_widget = create_hash_widget(name, ds_hash)
local new_widget = {
key = key_widget,
name = name,
ds_hash = ds_hash,
params = params,
type = widget_type
}
ntop.setHashCache(REDIS_BASE_KEY, key_widget, json.encode(new_widget))
return true, key_widget
end
-------------------------------------------------------------------------------
-- Edit the data source
-- @return True if the edit was successful, false otherwise
-------------------------------------------------------------------------------
function widgets_utils.edit_widget(widget_key, name, ds_hash, widget_type, params)
local args_are_valid, message = check_widget_params(name, ds_hash, widget_type, params)
if (not args_are_valid) then
return args_are_valid, message
end
local json_widget = ntop.getHashCache(REDIS_BASE_KEY, widget_key)
if (isEmptyString(json_widget)) then
return false, "The widget was not found!"
end
local widget = json.decode(json_widget)
widget.name = name
widget.ds_hash = ds_hash
widget.type = widget_type
widget.params = params
ntop.delHashCache(REDIS_BASE_KEY, widget_key)
ntop.setHashCache(REDIS_BASE_KEY, widget_key, json.encode(widget))
return true, widget_key
end
-------------------------------------------------------------------------------
-- Delete the widget from redis
-- @param widget_key The key of the widget to be removed (not nil)
-- @return True if the delete was successful, false otherwise
-------------------------------------------------------------------------------
function widgets_utils.delete_widget(widget_key)
if (isEmptyString(widget_key)) then
return false, "The widget key cannot be empty!"
end
if (isEmptyString(ntop.getHashCache(REDIS_BASE_KEY, widget_key))) then
return false, "The widget to be removed was not found!"
end
ntop.delHashCache(REDIS_BASE_KEY, widget_key)
return true, widget_key
end
-------------------------------------------------------------------------------
-- Get all widgets stored in redis
-- @return An array of widgets stored in redis, if no any widgets was found
-- it returns an empty array
-------------------------------------------------------------------------------
function widgets_utils.get_all_widgets()
local widgets = ntop.getHashAllCache(REDIS_BASE_KEY)
if (widgets == nil) then
return {}
end
local all_widgets = {}
for _, json_source in pairs(widgets) do
all_widgets[#all_widgets + 1] = json.decode(json_source)
end
return all_widgets
end
-------------------------------------------------------------------------------
-- Get a widget stored in redis
-- @return The searched widget if the key is valid, otherwise a nil value
-------------------------------------------------------------------------------
function widgets_utils.get_widget(widget_key)
local widget = ntop.getHashCache(REDIS_BASE_KEY, widget_key)
if isEmptyString(widget) then return nil end
return json.decode(widget)
end
-------------------------------------------------------------------------------
-- Answer to a widget request
-- @param widget Is a widget defined above
@ -269,7 +103,10 @@ function widgets_utils.rest_response()
}
end
rest_utils.answer(rest_utils.consts.success.ok, datasources_data)
rest_utils.answer(rest_utils.consts.success.ok, {
datasources = datasources_data,
axes = {}
})
end
return widgets_utils