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

Reworks REST API to return i18n success/error messages

Browse source 
Implements #4300
This commit is contained in:
Simone Mainardi 2020-08-17 19:18:13 +02:00
parent 398e25c022
commit 16db3cda67
34 changed files with 175 additions and 171 deletions
Download patch file Download diff file Expand all files Collapse all files

115
scripts/lua/modules/rest_utils.lua
View file

@ -9,67 +9,64 @@ package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path
require "lua_utils"
local json = require ("dkjson")
local rest_utils = {}
rest_utils.consts_ok = 0
rest_utils.consts_not_found = -1
rest_utils.consts_invalid_interface = -2
rest_utils.consts_not_granted = -3
rest_utils.consts_invalid_host = -4
rest_utils.consts_invalid_args = -5
rest_utils.consts_internal_error = -6
rest_utils.consts_bad_format = -7
rest_utils.consts_bad_content = -8
rest_utils.consts_resolution_failed = -9
rest_utils.consts_snmp_device_already_added = -10
rest_utils.consts_snmp_device_unreachable = -11
rest_utils.consts_snmp_device_no_device_discovered = -12
rest_utils.consts_add_pool_failed = -13
rest_utils.consts_edit_pool_failed = -14
rest_utils.consts_delete_pool_failed = -15
rest_utils.consts_pool_not_found = -16
rest_utils.consts_bind_pool_member_failed = -17
rest_utils.consts_bind_pool_member_already_bound = -18
rest_utils.consts_password_mismatch = -19
rest_utils.consts_add_user_failed = -20
rest_utils.consts_delete_user_failed = -21
rest_utils.consts_snmp_unknown_device = -22
rest_utils.consts_user_already_existing = -23
rest_utils.consts_user_does_not_exist = -24
rest_utils.consts_edit_user_failed = -25
local rc_str_consts = {
[rest_utils.consts_ok] = "OK",
[rest_utils.consts_not_found] = "NOT_FOUND",
[rest_utils.consts_invalid_interface] = "INVALID_INTERFACE",
[rest_utils.consts_not_granted] = "NOT_GRANTED",
[rest_utils.consts_invalid_host] = "INVALID_HOST",
[rest_utils.consts_invalid_args] = "INVALID_ARGUMENTS",
[rest_utils.consts_internal_error] = "INTERNAL_ERROR",
[rest_utils.consts_bad_format] = "BAD_FORMAT",
[rest_utils.consts_bad_content] = "BAD_CONTENT",
[rest_utils.consts_resolution_failed] = "NAME_RESOLUTION_FAILED",
[rest_utils.consts_snmp_device_already_added] = "SNMP_DEVICE_ALREADY_ADDED",
[rest_utils.consts_snmp_device_unreachable] = "SNMP_DEVICE_UNREACHABLE",
[rest_utils.consts_snmp_device_no_device_discovered] = "NO_SNMP_DEVICE_DISCOVERED",
[rest_utils.consts_add_pool_failed] = "ADD_POOL_FAILED",
[rest_utils.consts_edit_pool_failed] = "EDIT_POOL_FAILED",
[rest_utils.consts_delete_pool_failed] = "DELETE_POOL_FAILED",
[rest_utils.consts_pool_not_found] = "POOL_NOT_FOUND",
[rest_utils.consts_bind_pool_member_failed] = "BIND_POOL_MEMBER_FAILED",
[rest_utils.consts_bind_pool_member_already_bound] = "BIND_POOL_MEMBER_ALREADY_BOUND",
[rest_utils.consts_password_mismatch] = "PASSWORD_MISMATCH",
[rest_utils.consts_add_user_failed] = "ADD_USER_FAILED",
[rest_utils.consts_delete_user_failed] = "DELETE_USER_FAILED",
[rest_utils.consts_snmp_unknown_device] = "SNMP_UNKNOWN_DEVICE",
[rest_utils.consts_user_already_existing] = "USER_ALREADY_EXISTING",
[rest_utils.consts_user_does_not_exist] = "USER_DOES_NOT_EXIST",
[rest_utils.consts_edit_user_failed] = "EDIT_USER_FAILED"
local rest_utils = {
consts = {
success = {
ok = {rc = 0, str = "OK"},
snmp_device_deleted = {rc = 0, str = "SNMP_DEVICE_DELETED_SUCCESSFULLY"},
snmp_device_added = {rc = 0, str = "SNMP_DEVICE_ADDED_SUCCESSFULLY"},
snmp_device_edited = {rc = 0, str = "SNMP_DEVICE_EDITED_SUCCESSFULLY"},
pool_deleted = {rc = 0, str = "POOL_DELETED_SUCCESSFULLY"},
pool_added = {rc = 0, str = "POOL_ADDED_SUCCESSFULLY"},
pool_edited = {rc = 0, str = "POOL_EDITED_SUCCESSFULLY"},
pool_member_bound = {rc = 0, str = "POOL_MEMBER_BOUND_SUCCESSFULLY"},
},
err = {
not_found = {rc = -1, str = "NOT_FOUND"},
invalid_interface = {rc = -2, str = "INVALID_INTERFACE"},
not_granted = {rc = -3, str = "NOT_GRANTED"},
invalid_host = {rc = -4, str = "INVALID_HOST"},
invalid_args = {rc = -5, str = "INVALID_ARGUMENTS"},
internal_error = {rc = -6, str = "INTERNAL_ERROR"},
bad_format = {rc = -7, str = "BAD_FORMAT"},
bad_content = {rc = -8, str = "BAD_CONTENT"},
resolution_failed = {rc = -9, str = "NAME_RESOLUTION_FAILED"},
snmp_device_already_added = {rc = -10, str = "SNMP_DEVICE_ALREADY_ADDED"},
snmp_device_unreachable = {rc = -11, str = "SNMP_DEVICE_UNREACHABLE"},
snmp_device_no_device_discovered = {rc = -12, str = "NO_SNMP_DEVICE_DISCOVERED"},
add_pool_failed = {rc = -13, str = "ADD_POOL_FAILED"},
edit_pool_failed = {rc = -14, str = "EDIT_POOL_FAILED"},
delete_pool_failed = {rc = -15, str = "DELETE_POOL_FAILED"},
pool_not_found = {rc = -16, str = "POOL_NOT_FOUND"},
bind_pool_member_failed = {rc = -17, str = "BIND_POOL_MEMBER_FAILED"},
bind_pool_member_already_bound = {rc = -18, str = "BIND_POOL_MEMBER_ALREADY_BOUND"},
password_mismatch = {rc = -19, str = "PASSWORD_MISMATCH"},
add_user_failed = {rc = -20, str = "ADD_USER_FAILED"},
delete_user_failed = {rc = -21, str = "DELETE_USER_FAILED"},
snmp_unknown_device = {rc = -22, str = "SNMP_UNKNOWN_DEVICE"},
user_already_existing = {rc = -23, str = "USER_ALREADY_EXISTING"},
user_does_not_exist = {rc = -24, str = "USER_DOES_NOT_EXIST"},
edit_user_failed = {rc = -25, str = "EDIT_USER_FAILED"},
},
}
}
function rest_utils.rc(ret_code, response)
local client_rsp = { rc = ret_code, rc_str = rc_str_consts[ret_code], rsp = response or {} }
return(json.encode(client_rsp))
function rest_utils.rc(ret_const, response)
local ret_code = ret_const.rc
local rc_str = ret_const.str -- String associated to the return code
local rc_str_hr -- String associated to the retrun code, human readable
-- Prepare the human readable string
rc_str_hr = i18n("rest_consts."..rc_str) or "Unknown"
local client_rsp = {
rc = ret_code,
rc_str = rc_str,
rc_str_hr = rc_str_hr,
rsp = response or {}
}
return json.encode(client_rsp)
end