fusionpbx/resources/install/scripts/app/ring_groups/index.lua

--	ring_groups.lua
--	Part of FusionPBX
--	Copyright (C) 2010-2014 Mark J Crane <markjcrane@fusionpbx.com>
--	All rights reserved.
--
--	Redistribution and use in source and binary forms, with or without
--	modification, are permitted provided that the following conditions are met:
--
--	1. Redistributions of source code must retain the above copyright notice,
--	   this list of conditions and the following disclaimer.
--
--	2. Redistributions in binary form must repoduce the above copyright
--	   notice, this list of conditions and the following disclaimer in the
--	   documentation and/or other materials provided with the distribution.
--
--	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
--	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
--	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
--	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
--	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
--	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
--	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
--	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
--	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
--	POSSIBILITY OF SUCH DAMAGE.
--
--	Contributor(s):
--	Mark J Crane <markjcrane@fusionpbx.com>
--	Luis Daniel Lucio Qurioz <dlucio@okay.com.mx>

--connect to the database
	dofile(scripts_dir.."/resources/functions/database_handle.lua");
	dbh = database_handle('system');

--include functions
	dofile(scripts_dir.."/resources/functions/trim.lua");
	dofile(scripts_dir.."/resources/functions/explode.lua");

--get the variables
	domain_name = session:getVariable("domain_name");
	ring_group_uuid = session:getVariable("ring_group_uuid");
	recordings_dir = session:getVariable("recordings_dir");
	sounds_dir = session:getVariable("sounds_dir");

--variables that don't require ${} when used in the dialplan conditions
	username = session:getVariable("username");
	dialplan = session:getVariable("dialplan");
	caller_id_name = session:getVariable("caller_id_name");
	caller_id_number = session:getVariable("caller_id_number");
	network_addr = session:getVariable("network_addr");
	ani = session:getVariable("ani");
	aniii = session:getVariable("aniii");
	rdnis = session:getVariable("rdnis");
	destination_number = session:getVariable("destination_number");
	source = session:getVariable("source");
	uuid = session:getVariable("uuid");
	context = session:getVariable("context");
	call_direction = session:getVariable("call_direction");

--define additional variables
	uuids = "";
	external = "false";

--set the sounds path for the language, dialect and voice
	default_language = session:getVariable("default_language");
	default_dialect = session:getVariable("default_dialect");
	default_voice = session:getVariable("default_voice");
	if (not default_language) then default_language = 'en'; end
	if (not default_dialect) then default_dialect = 'us'; end
	if (not default_voice) then default_voice = 'callie'; end

--get record_ext
	if (session:getVariable("record_ext")) then
		record_ext = session:getVariable("record_ext");
	else
		record_ext = "wav";
	end

--set the recording path
	recording_archive = recordings_dir
	if (domain_count > 1) then
		recording_archive = recording_archive.."/"..domain_name;
	end
	recording_archive = recording_archive.."/archive/"..(os.date("%Y")).."/"..(os.date("%b")).."/"..(os.date("%d"));

--prepare the api object
	api = freeswitch.API();

--define the session hangup
	--function on_hangup(s,status)
	--	freeswitch.consoleLog("NOTICE","---- on_hangup: "..status.."\n");
	--	error();
	--end

--get the ring group
	ring_group_forward_enabled = "";
	ring_group_forward_destination = "";
	sql = "SELECT * FROM v_ring_groups ";
	sql = sql .. "where ring_group_uuid = '"..ring_group_uuid.."' ";
	status = dbh:query(sql, function(row)
		domain_uuid = row["domain_uuid"];
		ring_group_forward_enabled = row["ring_group_forward_enabled"];
		ring_group_forward_destination = row["ring_group_forward_destination"];
		ring_group_cid_name_prefix = row["ring_group_cid_name_prefix"];
		ring_group_cid_number_prefix = row["ring_group_cid_number_prefix"];
	end);

--set the caller id
	if (session:ready()) then
			if (string.len(ring_group_cid_name_prefix) > 0) then
				session:execute("set", "effective_caller_id_name="..ring_group_cid_name_prefix.."#"..caller_id_name);
			end
			if (string.len(ring_group_cid_number_prefix) > 0) then
				session:execute("set", "effective_caller_id_number="..ring_group_cid_number_prefix..caller_id_number);
			end
	end

--process the ring group
	if (ring_group_forward_enabled == "true" and string.len(ring_group_forward_destination) > 0) then
		--forward the ring group
			session:execute("transfer", ring_group_forward_destination.." XML "..context);
	else
		--get the ring group destinations
			sql = 
			[[ SELECT r.ring_group_strategy, r.ring_group_timeout_app, d.destination_number, d.destination_delay, d.destination_timeout, d.destination_prompt, r.ring_group_timeout_data, r.ring_group_cid_name_prefix, r.ring_group_cid_number_prefix, r.ring_group_ringback, r.ring_group_skip_active
			FROM v_ring_groups as r, v_ring_group_destinations as d
			where d.ring_group_uuid = r.ring_group_uuid 
			and d.ring_group_uuid = ']]..ring_group_uuid..[[' 
			and r.ring_group_enabled = 'true' 
			order by d.destination_delay, d.destination_number asc ]]
			--freeswitch.consoleLog("notice", "SQL:" .. sql .. "\n");
			destinations = {};
			x = 1;
			assert(dbh:query(sql, function(row)
				if (row.destination_prompt == "1" or row.destination_prompt == "2") then
					prompt = "true";
				end

				local array = explode("@",row.destination_number);
				if (array[2] == nil) then
					-- no @
					leg_domain_name = domain_name;
				else
					leg_domain_name = array[2];
				end
				cmd = "user_exists id ".. row.destination_number .." "..leg_domain_name;
				user_exists = api:executeString(cmd);
				if (user_exists == "true") then
					row['user_exists'] = "true";
				else
					external = "true";
					row['user_exists'] = "false";
				end
				row['domain_name'] = leg_domain_name;
				destinations[x] = row;
				x = x + 1;
			end));
			--freeswitch.consoleLog("NOTICE", "[ring_group] external "..external.."\n");

		--get the dialplan data and save it to a table
			if (external) then
				sql = [[select * from v_dialplans as d, v_dialplan_details as s 
				where (d.domain_uuid = ']] .. domain_uuid .. [[' or d.domain_uuid is null)
				and d.app_uuid = '8c914ec3-9fc0-8ab5-4cda-6c9288bdc9a3' 
				and d.dialplan_enabled = 'true' 
				and d.dialplan_uuid = s.dialplan_uuid 
				order by 
				d.dialplan_order asc, 
				d.dialplan_name asc, 
				d.dialplan_uuid asc, 
				s.dialplan_detail_group asc, 
				CASE s.dialplan_detail_tag 
				WHEN 'condition' THEN 1 
				WHEN 'action' THEN 2 
				WHEN 'anti-action' THEN 3 
				ELSE 100 END, 
				s.dialplan_detail_order asc ]]
				--freeswitch.consoleLog("notice", "SQL:" .. sql .. "\n");
				dialplans = {};
				x = 1;
				assert(dbh:query(sql, function(row)
					dialplans[x] = row;
					x = x + 1;
				end));
			end

		--process the destinations
			x = 0;
			for key, row in pairs(destinations) do
				--set the values from the database as variables
					user_exists = row.user_exists;
					ring_group_strategy = row.ring_group_strategy;
					ring_group_timeout_app = row.ring_group_timeout_app;
					ring_group_timeout_data = row.ring_group_timeout_data;
					ring_group_cid_name_prefix = row.ring_group_cid_name_prefix;
					ring_group_cid_number_prefix = row.ring_group_cid_number_prefix;
					ring_group_ringback = row.ring_group_ringback;
					ring_group_skip_active = row.ring_group_skip_active;
					destination_number = row.destination_number;
					destination_delay = row.destination_delay;
					destination_timeout = row.destination_timeout;
					destination_prompt = row.destination_prompt;
					domain_name = row.domain_name;

				--set ringback
					if (ring_group_ringback == "${uk-ring}") then
						ring_group_ringback = "tone_stream://%(400,200,400,450);%(400,2200,400,450);loops=-1";
					end
					if (ring_group_ringback == "${us-ring}") then
						ring_group_ringback = "tone_stream://%(2000,4000,440.0,480.0);loops=-1";
					end
					if (ring_group_ringback == "${pt-ring}") then
						ring_group_ringback = "tone_stream://%(1000,5000,400.0,0.0);loops=-1";
					end
					if (ring_group_ringback == "${fr-ring}") then
						ring_group_ringback = "tone_stream://%(1500,3500,440.0,0.0);loops=-1";
					end
					if (ring_group_ringback == "${rs-ring}") then
						ring_group_ringback = "tone_stream://%(1000,4000,425.0,0.0);loops=-1";
					end
					if (ring_group_ringback == "${it-ring}") then
						ring_group_ringback = "tone_stream://%(1000,4000,425.0,0.0);loops=-1";
					end
					if (ring_group_ringback == "") then
						ring_group_ringback = "local_stream://default";
					end
					session:setVariable("ringback", ring_group_ringback);
					session:setVariable("transfer_ringback", ring_group_ringback);

				--setup the delimiter
					delimiter = ",";
					if (ring_group_strategy == "rollover") then
						delimiter = "|";
					end
					if (ring_group_strategy == "sequence") then
						delimiter = "|";
					end
					if (ring_group_strategy == "simultaneous") then
						delimiter = ",";
					end
					if (ring_group_strategy == "enterprise") then
						delimiter = ":_:";
					end

				--create a new uuid and add it to the uuid list
					new_uuid = api:executeString("create_uuid");
					if (string.len(uuids) == 0) then
						uuids = new_uuid;
					else
						uuids = uuids ..",".. new_uuid;
					end
					session:execute("set", "uuids="..uuids);

				--set confirm
					if (ring_group_strategy == "simultaneous" 
						or ring_group_strategy == "sequence"
						or ring_group_strategy == "rollover") then
							session:execute("set", "group_confirm_key=exec");
							session:execute("set", "group_confirm_file=lua ".. scripts_dir .."/confirm.lua");
					end

				--determine confirm prompt
					if (destination_prompt == nil) then
						group_confirm = "confirm=false,";
					elseif (destination_prompt == "1") then
						group_confirm = "group_confirm_key=exec,group_confirm_file=lua ".. scripts_dir .."/confirm.lua,confirm=true,";
					elseif (destination_prompt == "2") then
						group_confirm = "group_confirm_key=exec,group_confirm_file=lua ".. scripts_dir .."/confirm.lua,confirm=true,";
					else
						group_confirm = "confirm=false,";
					end

				--get user_record value and determine whether to record the session
					cmd = "user_data ".. destination_number .."@"..domain_name.." var user_record";
					user_record = trim(api:executeString(cmd));
					--set the record_session variable
					if (user_record == "all") then
						record_session = true;
					end
					if (user_record == "inbound" and call_direction == "inbound") then
						record_session = true;
					end
					if (user_record == "outbound" and call_direction == "outbound") then
						record_session = true;
					end
					if (user_record == "local" and call_direction == "local") then
						record_session = true;
					end

				--record the session
					if (record_session) then
						cmd = "uuid_record "..uuid.." start "..recording_archive.."/"..uuid.."."..record_ext;
						response = api:executeString(cmd);
					end

				--process according to user_exists, sip_uri, external number
					if (user_exists == "true") then
						--get the extension_uuid
						cmd = "user_data ".. destination_number .."@"..domain_name.." var extension_uuid";
						extension_uuid = trim(api:executeString(cmd));
						--send to user
						if (ring_group_skip_active ~= nil) then
							if (ring_group_skip_active == "true") then
								cmd = "show channels like "..destination_number;
								reply = trim(api:executeString(cmd));
								--freeswitch.consoleLog("notice", "[ring group] reply "..cmd.." " .. reply .. "\n");
								if (reply == "0 total.") then
									dial_string = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay..",dialed_extension=" .. row.destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. row.destination_number .. "@" .. domain_name;
								else
									if (string.find(reply, domain_name)) then
										--active call
									else
										dial_string = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay..",dialed_extension=" .. row.destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. row.destination_number .. "@" .. domain_name;
									end
								end
							else
								--look inside the reply to check for the correct domain_name
									dial_string = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay..",dialed_extension=" .. row.destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. row.destination_number .. "@" .. domain_name;
							end
						else
							dial_string = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay..",dialed_extension=" .. row.destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. row.destination_number .. "@" .. domain_name;
						end
					elseif (tonumber(destination_number) == nil) then
						--sip uri
						dial_string = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay.."]" .. row.destination_number;
					else
						--external number
						y = 0;
						previous_dialplan_uuid = '';
						for k, r in pairs(dialplans) do
							if (y > 0) then
								if (previous_dialplan_uuid ~= r.dialplan_uuid) then
									regex_match = false;
									bridge_match = false;
									square = square .. "]";
									y = 0;
								end
							end
							if (r.dialplan_detail_tag == "condition") then
								if (r.dialplan_detail_type == "destination_number") then
									if (api:execute("regex", "m:~"..destination_number.."~"..r.dialplan_detail_data) == "true") then
										--get the regex result
											destination_result = trim(api:execute("regex", "m:~"..destination_number.."~"..r.dialplan_detail_data.."~$1"));
										--set match equal to true
											regex_match = true
									end
								end
							end
							if (r.dialplan_detail_tag == "action") then
								if (regex_match) then
									--replace $1
										dialplan_detail_data = r.dialplan_detail_data:gsub("$1", destination_result);
									--if the session is set then process the actions
										if (y == 0) then
											square = "[sip_invite_domain="..domain_name..","..group_confirm.."leg_timeout="..destination_timeout..",leg_delay_start="..destination_delay..",ignore_early_media=true,";
										end
										if (r.dialplan_detail_type == "set") then
											--session:execute("eval", dialplan_detail_data);
											if (dialplan_detail_data == "sip_h_X-accountcode=${accountcode}") then
												if (session) then
													accountcode = session:getVariable("accountcode");
													if (accountcode) then
														square = square .. "sip_h_X-accountcode="..accountcode..",";
													end
												end
											elseif (dialplan_detail_data == "effective_caller_id_name=${outbound_caller_id_name}") then
											elseif (dialplan_detail_data == "effective_caller_id_number=${outbound_caller_id_number}") then
											else
												square = square .. dialplan_detail_data..",";
											end
										elseif (r.dialplan_detail_type == "bridge") then
											if (bridge_match) then
												dial_string = dial_string .. "," .. square .."]"..dialplan_detail_data;
												square = "[";
											else
												dial_string = square .."]"..dialplan_detail_data;
											end
											bridge_match = true;
										end
									--increment the value
										y = y + 1;
								end
							end
							previous_dialplan_uuid = r.dialplan_uuid;
						end
					end

				--add a delimiter between destinations
					if (dial_string ~= nil) then
						--freeswitch.consoleLog("notice", "[ring group] dial_string: " .. dial_string .. "\n");
						if (x == 0) then
							if (ring_group_strategy == "enterprise") then
								app_data = dial_string;
							else
								app_data = "{ignore_early_media=true}"..dial_string;
							end
						else
							if (app_data == nil) then
								if (ring_group_strategy == "enterprise") then
									app_data = dial_string;
								else
									app_data = "{ignore_early_media=true}"..dial_string;
								end
							else
								app_data = app_data .. delimiter .. dial_string;
							end
						end
					end

				--increment the value of x
					x = x + 1;
			end

		--session execute
			if (session:ready()) then
				--set the variables
					session:execute("set", "hangup_after_bridge=true");
					session:execute("set", "continue_on_fail=true");

				--set bind meta app
					session:execute("bind_meta_app", "1 ab s execute_extension::dx XML "..context);
					session:execute("bind_meta_app", "2 ab s record_session::"..recordings_dir.."/archive/"..os.date("%Y").."/"..os.date("%m").."/"..os.date("%d").."}/"..uuid..".wav");
					session:execute("bind_meta_app", "3 ab s execute_extension::cf XML "..context);
					session:execute("bind_meta_app", "4 ab s execute_extension::att_xfer XML "..context);

					--if the user is busy rollover to the next destination
						if (ring_group_strategy == "rollover") then
							for key, row in pairs(destinations) do
								--set the values from the database as variables
									user_exists = row.user_exists;
									destination_number = row.destination_number;
									domain_name = row.domain_name;

								--get the extension_uuid
									if (user_exists == "true") then
										cmd = "user_data ".. destination_number .."@"..domain_name.." var extension_uuid";
										extension_uuid = trim(api:executeString(cmd));
									end

								--set the timeout
									session:execute("set", "call_timeout="..row.destination_timeout);

								--check if the user is busy
									extension_status = "show channels like "..destination_number.."@"..domain_name;
									reply = trim(api:executeString(extension_status));
									if (reply == "0 total.") then
										--not found: user is available
											if (user_exists == "true") then
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name..",dialed_extension=" .. destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. destination_number .. "@" .. domain_name;
												session:execute("bridge", dial_string);
											elseif (tonumber(destination_number) == nil) then
												--sip uri
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name.."]" .. destination_number;
												session:execute("bridge", dial_string);
											else
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name.."]loopback/" .. destination_number;
												session:execute("bridge", dial_string);
											end
									else
										--look inside the reply to check for the correct domain_name
										if string.find(reply, domain_name) then
											--found: extension number is busy
										else
											--not found: user is available
											if (user_exists == "true") then
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name.."dialed_extension=" .. destination_number .. ",extension_uuid="..extension_uuid.."]user/" .. destination_number .. "@" .. domain_name;
												session:execute("bridge", dial_string);
											elseif (tonumber(destination_number) == nil) then
												--sip uri
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name.."]" .. destination_number;
												session:execute("bridge", dial_string);
											else
												dial_string = "["..group_confirm.."sip_invite_domain="..domain_name.."]loopback/" .. destination_number;
												session:execute("bridge", dial_string);
											end
										end
									end
							end
						end

					--execute the bridge
						if (app_data ~= nil) then
							if (ring_group_strategy == "enterprise") then
								app_data = app_data:gsub("%[", "{");
								app_data = app_data:gsub("%]", "}");
							end
							freeswitch.consoleLog("NOTICE", "[ring group] app_data: "..app_data.."\n");
							session:execute("bridge", app_data);
						end

					--timeout destination
						if (app_data ~= nil) then
							if (session:getVariable("originate_disposition") == "ALLOTTED_TIMEOUT" 
								or session:getVariable("originate_disposition") == "NO_ANSWER" 
								or session:getVariable("originate_disposition") == "NO_USER_RESPONSE" 
								or session:getVariable("originate_disposition") == "USER_NOT_REGISTERED" 
								or session:getVariable("originate_disposition") == "NORMAL_TEMPORARY_FAILURE" 
								or session:getVariable("originate_disposition") == "NO_ROUTE_DESTINATION" 
								or session:getVariable("originate_disposition") == "USER_BUSY"
								or session:getVariable("originate_disposition") == "failure") then
									session:execute(ring_group_timeout_app, ring_group_timeout_data);
							end
						else
							if (ring_group_timeout_app ~= nil) then
								session:execute(ring_group_timeout_app, ring_group_timeout_data);
							else
								sql = "SELECT ring_group_timeout_app, ring_group_timeout_data FROM v_ring_groups ";
								sql = sql .. "where ring_group_uuid = '"..ring_group_uuid.."' ";
								--freeswitch.consoleLog("notice", "[ring group] SQL:" .. sql .. "\n");
								dbh:query(sql, function(row)
									session:execute(row.ring_group_timeout_app, row.ring_group_timeout_data);
								end);
							end
						end
				end
		end

--actions
	--ACTIONS = {}
	--table.insert(ACTIONS, {"set", "hangup_after_bridge=true"});
	--table.insert(ACTIONS, {"set", "continue_on_fail=true"});
	--table.insert(ACTIONS, {"bridge", app_data});
	--table.insert(ACTIONS, {ring_group_timeout_app, ring_group_timeout_data});