187 lines
9.3 KiB
Lua
187 lines
9.3 KiB
Lua
--contribtors: Mark J. Crane, James O. Rose
|
|
|
|
--set default variables
|
|
fax_retry_sleep = 30;
|
|
fax_retry_limit = 4;
|
|
fax_busy_limit = 3;
|
|
api = freeswitch.API();
|
|
|
|
-- show all channel variables
|
|
--dat = env:serialize()
|
|
--freeswitch.consoleLog("INFO","info:\n" .. dat .. "\n")
|
|
|
|
-- example channel variables relating to fax
|
|
--variable_fax_success: 0
|
|
--variable_fax_result_code: 49
|
|
--variable_fax_result_text: The%20call%20dropped%20prematurely
|
|
--variable_fax_ecm_used: off
|
|
--variable_fax_local_station_id: SpanDSP%20Fax%20Ident
|
|
--variable_fax_document_transferred_pages: 0
|
|
--variable_fax_document_total_pages: 0
|
|
--variable_fax_image_resolution: 0x0
|
|
--variable_fax_image_size: 0
|
|
--variable_fax_bad_rows: 0
|
|
--variable_fax_transfer_rate: 14400
|
|
|
|
-- set channel variables to lua variables
|
|
uuid = env:getHeader("uuid");
|
|
fax_success = env:getHeader("fax_success");
|
|
fax_result_text = env:getHeader("fax_result_text");
|
|
fax_ecm_used = env:getHeader("fax_ecm_used");
|
|
fax_retry_attempts = tonumber(env:getHeader("fax_retry_attempts"));
|
|
fax_retry_limit = tonumber(env:getHeader("fax_retry_limit"));
|
|
--fax_retry_sleep = tonumber(env:getHeader("fax_retry_sleep"));
|
|
fax_uri = env:getHeader("fax_uri");
|
|
fax_file = env:getHeader("fax_file");
|
|
fax_extension_number = env:getHeader("fax_extension_number");
|
|
origination_caller_id_name = env:getHeader("origination_caller_id_name");
|
|
origination_caller_id_number = env:getHeader("origination_caller_id_number");
|
|
|
|
bridge_hangup_cause = env:getHeader("bridge_hangup_cause");
|
|
fax_result_code = env:getHeader("fax_result_code");
|
|
fax_busy_attempts = tonumber(env:getHeader("fax_busy_attempts"));
|
|
|
|
--set default values
|
|
if (not origination_caller_id_name) then
|
|
origination_caller_id_name = '000000000000000';
|
|
end
|
|
if (not origination_caller_id_number) then
|
|
origination_caller_id_number = '000000000000000';
|
|
end
|
|
if (not fax_busy_attempts) then
|
|
fax_busy_attempts = 0;
|
|
end
|
|
|
|
--for email
|
|
email_address = env:getHeader("mailto_address");
|
|
--email_address = api:execute("system", "/bin/echo -n "..email_address.." | /bin/sed -e s/\,/\\\\,/g");
|
|
email_address = email_address:gsub(",", "\\,");
|
|
from_address = env:getHeader("mailfrom_address");
|
|
--needs to be fixed on lesser operating systems that do not have GNU utils.
|
|
number_dialed = api:execute("system", "/bin/echo -n "..fax_uri.." | sed -e s,.*/,,g");
|
|
--do not use apostrophies in message, they are not excaped and the mail will fail.
|
|
email_message_fail = "We are sorry the fax failed to go through. It has been attached. Please check the number "..number_dialed..", and if it was correct you might consider emailing it instead."
|
|
email_message_success = "We are happy to report the fax was sent successfully. It has been attached for your records."
|
|
|
|
-- send the selected variables to the console
|
|
freeswitch.consoleLog("INFO","fax_success: '" .. fax_success .. "'\n");
|
|
freeswitch.consoleLog("INFO","fax_result_text: '" .. fax_result_text .. "'\n");
|
|
freeswitch.consoleLog("INFO","fax_file: '" .. fax_file .. "'\n");
|
|
freeswitch.consoleLog("INFO","uuid: '" .. uuid .. "'\n");
|
|
freeswitch.consoleLog("INFO","fax_ecm_used: '" .. fax_ecm_used .. "'\n");
|
|
freeswitch.consoleLog("INFO","fax_retry_attempts: " .. fax_retry_attempts.. "\n");
|
|
freeswitch.consoleLog("INFO","fax_retry_limit: " .. fax_retry_limit.. "\n");
|
|
freeswitch.consoleLog("INFO","fax_retry_sleep: " .. fax_retry_sleep.. "\n");
|
|
freeswitch.consoleLog("INFO","fax_uri: '" .. fax_uri.. "'\n");
|
|
freeswitch.consoleLog("INFO","origination_caller_id_name: " .. origination_caller_id_name .. "\n");
|
|
freeswitch.consoleLog("INFO","origination_caller_id_number: " .. origination_caller_id_number .. "\n");
|
|
freeswitch.consoleLog("INFO","fax_result_code: ".. fax_result_code .."\n");
|
|
freeswitch.consoleLog("INFO","mailfrom_address: ".. from_address .."\n");
|
|
freeswitch.consoleLog("INFO","mailto_address: ".. email_address .."\n");
|
|
|
|
-- if the fax failed then try again
|
|
if (fax_success == "0") then
|
|
--DEBUG
|
|
--email_cmd = "/bin/echo '"..email_message_fail.."' | /usr/bin/mail -s 'Fax to: "..number_dialed.." FAILED' -r "..from_address.." -a "..fax_file.." "..email_address;
|
|
|
|
--to keep the originate command shorter these are things we always send. One place to adjust for all.
|
|
originate_same = "mailto_address='"..email_address.."',mailfrom_address='"..from_address.."',origination_caller_id_name='"..origination_caller_id_name.. "',origination_caller_id_number="..origination_caller_id_number..",fax_uri="..fax_uri..",fax_retry_limit="..fax_retry_limit..",fax_retry_sleep="..fax_retry_sleep..",fax_verbose=true,fax_file='"..fax_file.."'";
|
|
|
|
|
|
if (fax_retry_attempts < fax_retry_limit) then
|
|
|
|
--timed out waitng for comm or on first message (busy code?)
|
|
if (fax_result_code == "2" or fax_result_code == "3" ) then
|
|
--do nothing. don't want to increment
|
|
freeswitch.consoleLog("INFO","Last Fax was probably Busy, don't increment retry_attempts. \n");
|
|
fax_busy_attempts = fax_busy_attempts + 1;
|
|
freeswitch.msleep(fax_retry_sleep * 1000);
|
|
|
|
elseif (fax_retry_attempts < 5 ) then
|
|
freeswitch.consoleLog("INFO","Last Fax Failed, try a different way. Wait first.\n");
|
|
freeswitch.msleep(fax_retry_sleep * 500);
|
|
else
|
|
freeswitch.consoleLog("INFO","All attempts to send fax to "..number_dialed.."FAILED\n");
|
|
end
|
|
|
|
if (fax_retry_attempts == 1) then
|
|
--send t38 on ECM on
|
|
freeswitch.consoleLog("INFO","FAX TRYING ["..fax_retry_attempts.."] of [4] to: "..number_dialed.." with: t38 ON ECM ON, Fast\n");
|
|
fax_retry_attempts = fax_retry_attempts + 1;
|
|
cmd = "originate {fax_retry_attempts="..fax_retry_attempts..","..originate_same..",fax_use_ecm=true,fax_enable_t38=true,fax_enable_t38_request=true,fax_disable_v17=false,fax_busy_attempts='"..fax_busy_attempts.."',api_hangup_hook='lua fax_retry.lua'}"..fax_uri.." &txfax('"..fax_file.."')";
|
|
|
|
elseif (fax_retry_attempts == 2) then
|
|
--send t38 off, ECM on
|
|
freeswitch.consoleLog("INFO","FAX TRYING ["..fax_retry_attempts.."] of [4] to: "..number_dialed.." with: t38 OFF ECM ON, Fast\n");
|
|
fax_retry_attempts = fax_retry_attempts + 1;
|
|
cmd = "originate {fax_retry_attempts="..fax_retry_attempts..","..originate_same..",fax_use_ecm=true,fax_enable_t38=false,fax_enable_t38_request=false,fax_disable_v17=false,fax_busy_attempts='"..fax_busy_attempts.."',api_hangup_hook='lua fax_retry.lua'}"..fax_uri.." &txfax('"..fax_file.."')";
|
|
|
|
elseif (fax_retry_attempts == 3) then
|
|
--send t38 on v17 [slow] on ECM off
|
|
freeswitch.consoleLog("INFO","FAX TRYING ["..fax_retry_attempts.."] of [4] to: "..number_dialed.." with: t38 ON ECM OFF, SLOW\n");
|
|
fax_retry_attempts = fax_retry_attempts + 1;
|
|
|
|
cmd = "originate {fax_retry_attempts="..fax_retry_attempts..","..originate_same..",fax_use_ecm=false,fax_enable_t38=true,fax_enable_t38_request=true,fax_disable_v17=true,fax_busy_attempts='"..fax_busy_attempts.."',api_hangup_hook='lua fax_retry.lua'}"..fax_uri.." &txfax('"..fax_file.."')";
|
|
|
|
elseif (fax_retry_attempts == 4) then
|
|
--send t38 off v17 [slow] on ECM off
|
|
freeswitch.consoleLog("INFO","FAX TRYING ["..fax_retry_attempts.."] of [4] to: "..number_dialed.." with: t38 OFF ECM OFF, SLOW\n");
|
|
fax_retry_attempts = fax_retry_attempts + 1;
|
|
|
|
cmd = "originate {fax_retry_attempts="..fax_retry_attempts..","..originate_same..",fax_use_ecm=false,fax_enable_t38=false,fax_enable_t38_request=false,fax_disable_v17=true,fax_busy_attempts='"..fax_busy_attempts.."',api_hangup_hook='lua fax_retry.lua'}"..fax_uri.." &txfax('"..fax_file.."')";
|
|
|
|
else
|
|
--the fax failed completely. send a message
|
|
freeswitch.consoleLog("INFO","FAX_RETRY FAILED: TRIED ["..fax_retry_attempts.."] of [4]: GIVING UP\n");
|
|
freeswitch.consoleLog("INFO", "FAX_RETRY_STATS FAILURE: GATEWAY[".. fax_uri .."], tried 5 combinations without success\n");
|
|
|
|
email_address = email_address:gsub("\\,", ",");
|
|
|
|
freeswitch.email("",
|
|
"",
|
|
"To: "..email_address.."\nFrom: "..from_address.."\nSubject: Fax to: "..number_dialed.." FAILED",
|
|
email_message_fail ,
|
|
fax_file
|
|
);
|
|
|
|
fax_retry_attempts = fax_retry_attempts + 1;
|
|
|
|
|
|
|
|
|
|
end
|
|
api = freeswitch.API();
|
|
if ( not cmd ) then
|
|
freeswitch.consoleLog("INFO","Last Fallthrough (5th) of FAX_RETRY.lua: \n");
|
|
else
|
|
freeswitch.consoleLog("INFO","retry cmd: " .. cmd .. "\n");
|
|
reply = api:executeString(cmd);
|
|
end
|
|
end
|
|
|
|
else
|
|
--Huzah! Success!
|
|
if (fax_retry_attempts == 0) then
|
|
fax_trial = "fax_use_ecm=false,fax_enable_t38=true,fax_enable_t38_request=true,fax_disable_v17=default";
|
|
elseif (fax_retry_attempts == 1) then
|
|
fax_trial = "fax_use_ecm=true,fax_enable_t38=true,fax_enable_t38_request=true,fax_disable_v17=false";
|
|
elseif (fax_retry_attempts == 2) then
|
|
fax_trial = "fax_use_ecm=true,fax_enable_t38=false,fax_enable_t38_request=false,fax_disable_v17=false";
|
|
elseif (fax_retry_attempts == 3) then
|
|
fax_trial = "fax_use_ecm=true,fax_enable_t38=true,fax_enable_t38_request=true,fax_disable_v17=true";
|
|
elseif (fax_retry_attempts == 4) then
|
|
fax_trial = "fax_use_ecm=false,fax_enable_t38=false,fax_enable_t38_request=false,fax_disable_v17=false";
|
|
else
|
|
fax_trial = "fax_retry had an issue and tried more than 5 times"
|
|
end
|
|
freeswitch.consoleLog("INFO", "FAX_RETRY_STATS SUCCESS: GATEWAY[".. fax_uri .."] VARS[" .. fax_trial .. "]\n");
|
|
email_address = email_address:gsub("\\,", ",");
|
|
|
|
freeswitch.email("",
|
|
"",
|
|
"To: "..email_address.."\nFrom: "..from_address.."\nSubject: Fax to: "..number_dialed.." SENT",
|
|
email_message_success ,
|
|
fax_file
|
|
);
|
|
end
|