From ddc27525a8a4be38de30c13edef62397815cb8a6 Mon Sep 17 00:00:00 2001 From: FusionPBX Date: Wed, 17 Jun 2020 19:27:22 -0600 Subject: [PATCH] Combine related IVR menu XML. --- .../scripts/configuration/ivr.conf.lua | 346 +++++++++--------- 1 file changed, 180 insertions(+), 166 deletions(-) diff --git a/app/scripts/resources/scripts/app/xml_handler/resources/scripts/configuration/ivr.conf.lua b/app/scripts/resources/scripts/app/xml_handler/resources/scripts/configuration/ivr.conf.lua index d6450bcea7..22549a07da 100644 --- a/app/scripts/resources/scripts/app/xml_handler/resources/scripts/configuration/ivr.conf.lua +++ b/app/scripts/resources/scripts/app/xml_handler/resources/scripts/configuration/ivr.conf.lua @@ -1,6 +1,6 @@ -- xml_handler.lua -- Part of FusionPBX --- Copyright (C) 2016-2018 Mark J Crane +-- Copyright (C) 2016-2020 Mark J Crane -- All rights reserved. -- -- Redistribution and use in source and binary forms, with or without @@ -49,6 +49,14 @@ json = require "resources.functions.lunajson" end + --start the xml array + local xml = {} + table.insert(xml, [[]]); + table.insert(xml, [[]]); + table.insert(xml, [[
]]); + table.insert(xml, [[ ]]); + table.insert(xml, [[ ]]); + --set the sound prefix sound_prefix = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"; @@ -60,211 +68,217 @@ --get the ivr menu from the database local sql = [[SELECT * FROM v_ivr_menus - WHERE ivr_menu_uuid = :ivr_menu_uuid - AND ivr_menu_enabled = 'true' ]]; + WHERE (ivr_menu_uuid = :ivr_menu_uuid or ivr_menu_parent_uuid = :ivr_menu_uuid) + AND ivr_menu_enabled = 'true' + ORDER BY ivr_menu_parent_uuid desc + ]]; local params = {ivr_menu_uuid = ivr_menu_uuid}; if (debug["sql"]) then freeswitch.consoleLog("notice", "[ivr_menu] SQL: " .. sql .. "; params:" .. json.encode(params) .. "\n"); end dbh:query(sql, params, function(row) - domain_uuid = row["domain_uuid"]; - ivr_menu_name = row["ivr_menu_name"]; - ivr_menu_extension = row["ivr_menu_extension"]; - ivr_menu_greet_long = row["ivr_menu_greet_long"]; - ivr_menu_greet_short = row["ivr_menu_greet_short"]; - ivr_menu_invalid_sound = row["ivr_menu_invalid_sound"]; - ivr_menu_exit_sound = row["ivr_menu_exit_sound"]; - ivr_menu_confirm_macro = row["ivr_menu_confirm_macro"]; - ivr_menu_confirm_key = row["ivr_menu_confirm_key"]; - ivr_menu_tts_engine = row["ivr_menu_tts_engine"]; - ivr_menu_tts_voice = row["ivr_menu_tts_voice"]; - ivr_menu_confirm_attempts = row["ivr_menu_confirm_attempts"]; - ivr_menu_timeout = row["ivr_menu_timeout"]; - --ivr_menu_exit_app = row["ivr_menu_exit_app"]; - --ivr_menu_exit_data = row["ivr_menu_exit_data"]; - ivr_menu_inter_digit_timeout = row["ivr_menu_inter_digit_timeout"]; - ivr_menu_max_failures = row["ivr_menu_max_failures"]; - ivr_menu_max_timeouts = row["ivr_menu_max_timeouts"]; - ivr_menu_digit_len = row["ivr_menu_digit_len"]; - ivr_menu_direct_dial = row["ivr_menu_direct_dial"]; - ivr_menu_ringback = row["ivr_menu_ringback"]; - ivr_menu_cid_prefix = row["ivr_menu_cid_prefix"]; - ivr_menu_description = row["ivr_menu_description"]; - end); + --set the variables + domain_uuid = row["domain_uuid"]; + ivr_menu_name = row["ivr_menu_name"]; + ivr_menu_extension = row["ivr_menu_extension"]; + ivr_menu_greet_long = row["ivr_menu_greet_long"]; + ivr_menu_greet_short = row["ivr_menu_greet_short"]; + ivr_menu_invalid_sound = row["ivr_menu_invalid_sound"]; + ivr_menu_exit_sound = row["ivr_menu_exit_sound"]; + ivr_menu_confirm_macro = row["ivr_menu_confirm_macro"]; + ivr_menu_confirm_key = row["ivr_menu_confirm_key"]; + ivr_menu_tts_engine = row["ivr_menu_tts_engine"]; + ivr_menu_tts_voice = row["ivr_menu_tts_voice"]; + ivr_menu_confirm_attempts = row["ivr_menu_confirm_attempts"]; + ivr_menu_timeout = row["ivr_menu_timeout"]; + --ivr_menu_exit_app = row["ivr_menu_exit_app"]; + --ivr_menu_exit_data = row["ivr_menu_exit_data"]; + ivr_menu_inter_digit_timeout = row["ivr_menu_inter_digit_timeout"]; + ivr_menu_max_failures = row["ivr_menu_max_failures"]; + ivr_menu_max_timeouts = row["ivr_menu_max_timeouts"]; + ivr_menu_digit_len = row["ivr_menu_digit_len"]; + ivr_menu_direct_dial = row["ivr_menu_direct_dial"]; + ivr_menu_ringback = row["ivr_menu_ringback"]; + ivr_menu_cid_prefix = row["ivr_menu_cid_prefix"]; + ivr_menu_description = row["ivr_menu_description"]; - local settings = Settings.new(dbh, domain_name, domain_uuid) - local storage_type = settings:get('recordings', 'storage_type', 'text') - local storage_path = settings:get('recordings', 'storage_path', 'text') - if (storage_path ~= nil) then - storage_path = storage_path:gsub("${domain_name}", domain_name) - storage_path = storage_path:gsub("${domain_uuid}", domain_uuid) - end - --get the recordings from the database - ivr_menu_greet_long_is_base64 = false; - ivr_menu_greet_short_is_base64 = false; - ivr_menu_invalid_sound_is_base64 = false; - ivr_menu_exit_sound_is_base64 = false; - if (storage_type == "base64") then - --include the file io - local file = require "resources.functions.file" + --set the storage path + local settings = Settings.new(dbh, domain_name, domain_uuid) + local storage_type = settings:get('recordings', 'storage_type', 'text') + local storage_path = settings:get('recordings', 'storage_path', 'text') + if (storage_path ~= nil) then + storage_path = storage_path:gsub("${domain_name}", domain_name) + storage_path = storage_path:gsub("${domain_uuid}", domain_uuid) + end - --connect to db - local dbh = Database.new('system', 'base64/read'); + --get the recordings from the database + ivr_menu_greet_long_is_base64 = false; + ivr_menu_greet_short_is_base64 = false; + ivr_menu_invalid_sound_is_base64 = false; + ivr_menu_exit_sound_is_base64 = false; + if (storage_type == "base64") then + --include the file io + local file = require "resources.functions.file" - --base path for recordings - local base_path = recordings_dir.."/"..domain_name + --connect to db + local dbh = Database.new('system', 'base64/read'); - --function to get recording to local fs - local function load_record(name) - local path = base_path .. "/" .. name; - local is_base64 = false; + --base path for recordings + local base_path = recordings_dir.."/"..domain_name - if not file_exists(path) then - local sql = "SELECT recording_base64 FROM v_recordings " .. - "WHERE domain_uuid = :domain_uuid " .. - "AND recording_filename = :name " - local params = {domain_uuid = domain_uuid, name = name}; - if (debug["sql"]) then - freeswitch.consoleLog("notice", "[ivr_menu] SQL: "..sql.."; params:" .. json.encode(params) .. "\n"); + --function to get recording to local fs + local function load_record(name) + local path = base_path .. "/" .. name; + local is_base64 = false; + + if not file_exists(path) then + local sql = "SELECT recording_base64 FROM v_recordings " .. + "WHERE domain_uuid = :domain_uuid " .. + "AND recording_filename = :name " + local params = {domain_uuid = domain_uuid, name = name}; + if (debug["sql"]) then + freeswitch.consoleLog("notice", "[ivr_menu] SQL: "..sql.."; params:" .. json.encode(params) .. "\n"); + end + + dbh:query(sql, params, function(row) + --save the recording to the file system + if #row.recording_base64 > 32 then + is_base64 = true; + file.write_base64(path, row.recording_base64); + --add the full path and file name + name = path; + end + end); + end + return name, is_base64 end - dbh:query(sql, params, function(row) - --save the recording to the file system - if #row.recording_base64 > 32 then - is_base64 = true; - file.write_base64(path, row.recording_base64); - --add the full path and file name - name = path; - end - end); - end - return name, is_base64 + --greet long + if #ivr_menu_greet_long > 1 then + ivr_menu_greet_long, ivr_menu_greet_long_is_base64 = load_record(ivr_menu_greet_long) + end + + --greet short + if #ivr_menu_greet_short > 1 then + ivr_menu_greet_short, ivr_menu_greet_short_is_base64 = load_record(ivr_menu_greet_short) + end + + --invalid sound + if #ivr_menu_invalid_sound > 1 then + ivr_menu_invalid_sound, ivr_menu_invalid_sound_is_base64 = load_record(ivr_menu_invalid_sound) + end + + --exit sound + if #ivr_menu_exit_sound > 1 then + ivr_menu_exit_sound, ivr_menu_exit_sound_is_base64 = load_record(ivr_menu_exit_sound) + end + + dbh:release() + elseif (storage_type == "http_cache") then + --add the path to file name + ivr_menu_greet_long = storage_path.."/"..ivr_menu_greet_long; + ivr_menu_greet_short = storage_path.."/"..ivr_menu_greet_short; + ivr_menu_invalid_sound = storage_path.."/"..ivr_menu_invalid_sound; + ivr_menu_exit_sound = storage_path.."/"..ivr_menu_exit_sound; end --greet long - if #ivr_menu_greet_long > 1 then - ivr_menu_greet_long, ivr_menu_greet_long_is_base64 = load_record(ivr_menu_greet_long) + if (not ivr_menu_greet_long_is_base64 and not file_exists(ivr_menu_greet_long)) then + if (file_exists(recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_long)) then + ivr_menu_greet_long = recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_long; + elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_greet_long)) then + ivr_menu_greet_long = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_greet_long; + end end --greet short - if #ivr_menu_greet_short > 1 then - ivr_menu_greet_short, ivr_menu_greet_short_is_base64 = load_record(ivr_menu_greet_short) + if (string.len(ivr_menu_greet_short) > 1) then + if (not ivr_menu_greet_short_is_base64 and not file_exists(ivr_menu_greet_short)) then + if (file_exists(recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_short)) then + ivr_menu_greet_short = recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_short; + elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_greet_short)) then + ivr_menu_greet_short = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_greet_short; + end + end + else + ivr_menu_greet_short = ivr_menu_greet_long; end --invalid sound - if #ivr_menu_invalid_sound > 1 then - ivr_menu_invalid_sound, ivr_menu_invalid_sound_is_base64 = load_record(ivr_menu_invalid_sound) + if (not ivr_menu_invalid_sound_is_base64 and not file_exists(ivr_menu_invalid_sound)) then + if (file_exists(recordings_dir.."/"..domain_name.. "/"..ivr_menu_invalid_sound)) then + ivr_menu_invalid_sound = recordings_dir.."/"..domain_name.."/"..ivr_menu_invalid_sound; + elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_invalid_sound)) then + ivr_menu_invalid_sound = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_invalid_sound; + end end --exit sound - if #ivr_menu_exit_sound > 1 then - ivr_menu_exit_sound, ivr_menu_exit_sound_is_base64 = load_record(ivr_menu_exit_sound) + if (not ivr_menu_exit_sound_is_base64 and not file_exists(ivr_menu_exit_sound)) then + if (file_exists(recordings_dir.."/"..ivr_menu_exit_sound)) then + if (ivr_menu_exit_sound ~= nil and ivr_menu_exit_sound ~= "") then + ivr_menu_exit_sound = recordings_dir.."/"..domain_name.."/"..ivr_menu_exit_sound; + end + elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_exit_sound)) then + ivr_menu_exit_sound = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_exit_sound; + end end - dbh:release() - elseif (storage_type == "http_cache") then - --add the path to file name - ivr_menu_greet_long = storage_path.."/"..ivr_menu_greet_long; - ivr_menu_greet_short = storage_path.."/"..ivr_menu_greet_short; - ivr_menu_invalid_sound = storage_path.."/"..ivr_menu_invalid_sound; - ivr_menu_exit_sound = storage_path.."/"..ivr_menu_exit_sound; - end + --add xml to the array + table.insert(xml, [[ ]]); - --greet long - if (not ivr_menu_greet_long_is_base64 and not file_exists(ivr_menu_greet_long)) then - if (file_exists(recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_long)) then - ivr_menu_greet_long = recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_long; - elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_greet_long)) then - ivr_menu_greet_long = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_greet_long; - end - end - - --greet short - if (string.len(ivr_menu_greet_short) > 1) then - if (not ivr_menu_greet_short_is_base64 and not file_exists(ivr_menu_greet_short)) then - if (file_exists(recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_short)) then - ivr_menu_greet_short = recordings_dir.."/"..domain_name.."/"..ivr_menu_greet_short; - elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_greet_short)) then - ivr_menu_greet_short = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_greet_short; + --get the ivr menu options + local sql = [[SELECT * FROM v_ivr_menu_options WHERE ivr_menu_uuid = :ivr_menu_uuid ORDER BY ivr_menu_option_order asc ]]; + local params = {ivr_menu_uuid = ivr_menu_uuid}; + if (debug["sql"]) then + freeswitch.consoleLog("notice", "[ivr_menu] SQL: " .. sql .. "; params:" .. json.encode(params) .. "\n"); end - end - else - ivr_menu_greet_short = ivr_menu_greet_long; - end + dbh:query(sql, params, function(r) + ivr_menu_option_digits = r.ivr_menu_option_digits + ivr_menu_option_action = r.ivr_menu_option_action + ivr_menu_option_param = r.ivr_menu_option_param + ivr_menu_option_description = r.ivr_menu_option_description + table.insert(xml, [[ ]]); + end); - --invalid sound - if (not ivr_menu_invalid_sound_is_base64 and not file_exists(ivr_menu_invalid_sound)) then - if (file_exists(recordings_dir.."/"..domain_name.. "/"..ivr_menu_invalid_sound)) then - ivr_menu_invalid_sound = recordings_dir.."/"..domain_name.."/"..ivr_menu_invalid_sound; - elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_invalid_sound)) then - ivr_menu_invalid_sound = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_invalid_sound; - end - end - - --exit sound - if (not ivr_menu_exit_sound_is_base64 and not file_exists(ivr_menu_exit_sound)) then - if (file_exists(recordings_dir.."/"..ivr_menu_exit_sound)) then - if (ivr_menu_exit_sound ~= nil and ivr_menu_exit_sound ~= "") then - ivr_menu_exit_sound = recordings_dir.."/"..domain_name.."/"..ivr_menu_exit_sound; + --direct dial + if (ivr_menu_direct_dial == "true") then + table.insert(xml, [[ \n]]); + table.insert(xml, [[ \n]]); + table.insert(xml, [[ \n]]); end - elseif (file_exists(sounds_dir.."/en/us/callie/8000/"..ivr_menu_exit_sound)) then - ivr_menu_exit_sound = sounds_dir.."/${default_language}/${default_dialect}/${default_voice}/"..ivr_menu_exit_sound; - end - end - --start the xml array - local xml = {} - table.insert(xml, [[]]); - table.insert(xml, [[]]); - table.insert(xml, [[
]]); - table.insert(xml, [[ ]]); - table.insert(xml, [[ ]]); - table.insert(xml, [[ ]]); + --close the extension tag if it was left open + table.insert(xml, [[ ]]); - --get the ivr menu options - local sql = [[SELECT * FROM v_ivr_menu_options WHERE ivr_menu_uuid = :ivr_menu_uuid ORDER BY ivr_menu_option_order asc ]]; - local params = {ivr_menu_uuid = ivr_menu_uuid}; - if (debug["sql"]) then - freeswitch.consoleLog("notice", "[ivr_menu] SQL: " .. sql .. "; params:" .. json.encode(params) .. "\n"); - end - dbh:query(sql, params, function(r) - ivr_menu_option_digits = r.ivr_menu_option_digits - ivr_menu_option_action = r.ivr_menu_option_action - ivr_menu_option_param = r.ivr_menu_option_param - ivr_menu_option_description = r.ivr_menu_option_description - table.insert(xml, [[ ]]); end); - --direct dial - if (ivr_menu_direct_dial == "true") then - table.insert(xml, [[ \n]]); - table.insert(xml, [[ \n]]); - table.insert(xml, [[ \n]]); - end - - --close the extension tag if it was left open - table.insert(xml, [[
]]); + --add the xml closing tags table.insert(xml, [[ ]]); table.insert(xml, [[ ]]); table.insert(xml, [[
]]); table.insert(xml, [[]]); + + --save the xml table into a string XML_STRING = table.concat(xml, "\n"); + + --optinonal debug message if (debug["xml_string"]) then freeswitch.consoleLog("notice", "[xml_handler] XML_STRING: " .. XML_STRING .. "\n"); end