FreeSWITCH 使用 lua 脚本 接管 分机注册,鉴权等

FreeSWITCH 使用 lua 脚本 接管 分机注册,鉴权等

1. 更改lua.conf.xml配置

<configuration name="lua.conf" description="LUA Configuration">
  <settings>

    <!--
    Specify local directories that will be searched for LUA modules
    These entries will be pre-pended to the LUA_CPATH environment variable
    -->
    <!-- <param name="module-directory" value="/usr/lib/lua/5.1/?.so"/> -->
    <!-- <param name="module-directory" value="/usr/local/lib/lua/5.1/?.so"/> -->

    <!--
    Specify local directories that will be searched for LUA scripts
    These entries will be pre-pended to the LUA_PATH environment variable
    -->
    <!-- <param name="script-directory" value="/usr/local/lua/?.lua"/> -->
    <!-- <param name="script-directory" value="$${script_dir}/?.lua"/> -->
    <param name="script-directory" value="$${script_dir}/"/>
    <param name="script-directory" value="$${script_dir}/?.lua"/>
<!-- 接管分机注册 -->
    <param name="xml-handler-script" value="user_auth_xml.lua" />
    <param name="xml-handler-bindings" value="directory" />

    <!--<param name="xml-handler-bindings" value="dialplan"/>-->
    <!--
    The following options identifies a lua script that is launched
    at startup and may live forever in the background.
    You can define multiple lines, one for each script you
    need to run.
    -->
    <!--<param name="startup-script" value="startup_script_1.lua"/>-->
    <!--<param name="startup-script" value="startup_script_2.lua"/>-->

    <!--<hook event="CUSTOM" subclass="conference::maintenance" script="catch-event.lua"/>-->
  </settings>
</configuration>

其中

<param name="xml-handler-script" value="user_auth_xml.lua" />
<param name="xml-handler-bindings" value="directory" />

 指定使用 user_auth_xml.lua 优先获取分机配置.

包括分机注册,拨打鉴权验证等获取分分机配置信息.

2. user_auth_xml.lua 脚本

-- user_auth_xml.lua
-- example script for generating user directory XML
-- comment the following line for production:
--freeswitch.consoleLog("notice", "Debug from user_auth_xml.lua, provided params:
" .. params:serialize() .. "
")
require ("config")

local req_domain = params:getHeader("domain")
local req_key    = params:getHeader("key")
local req_user   = params:getHeader("user")
local req_password   = nil -- params:getHeader("pass")
freeswitch.consoleLog("NOTICE","lua take the key="..req_key..", user="..req_user..", domain="..req_domain.."
");

--[[
local dbh = freeswitch.Dbh("freeswitch","dbuser","dbpswd");
local my_query = string.format("select password from userinfo where username='%s' limit 1", req_user)
--freeswitch.consoleLog("NOTICE","start connect DB...
");
assert(dbh:connected());
freeswitch.consoleLog("notice", "the query string is:"..my_query)
dbh:query(my_query,function(row)
  --freeswitch.consoleLog("NOTICE",string.format("%s
",row.password))
  req_password=string.format("%s",row.password)
end);
dbh:release();
freeswitch.consoleLog("NOTICE","info:"..req_domain.."--"..req_key.."--"..req_user.."--"..req_password.."
");
]]--
for line in io.lines("scripts/users.txt") do
  --print(line)
  if line~=nil then
    local arr=Split(line,' ')
    --print( arr[1].." "..arr[2])
    if arr[1] == req_user and arr[2]~=nil then
      req_password=arr[2]
      break
    end
  end
end
--assert (req_domain and req_key and req_user,
--"This example script only supports generating directory xml for a single user !
")
if req_domain ~= nil and req_key=="id" and req_user~=nil and req_password~=nil  then
    XML_STRING =
    [[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <document type="freeswitch/xml">
      <section name="directory">
        <domain name="]]..req_domain..[[">
          <params>
            <param name="dial-string" value="{^^:sip_invite_domain=${dialed_domain}:presence_id=${dialed_user}@${dialed_domain}}${sofia_contact(*/${dialed_user}@${dialed_domain})},${verto_contact(${dialed_user}@${dialed_domain})}"/>
            <!-- These are required for Verto to function properly -->
            <param name="jsonrpc-allowed-methods" value="verto"/>
            <param name="jsonrpc-allowed-event-channels" value="demo,conference,presence"/>
          </params>
          <groups>
            <group name="default">
              <users>
                <user id="]] ..req_user..[[">
                  <params>
                    <param name="password" value="]]..req_password..[["/>
                    <param name="vm-password" value="]]..req_password..[["/>
                  </params>
                  <variables>
                    <variable name="toll_allow" value="domestic,international,local"/>
                    <variable name="accountcode" value="]] ..req_user..[["/>
                    <variable name="user_context" value="default"/>
                    <variable name="directory-visible" value="true"/>
                    <variable name="directory-exten-visible" value="true"/>
                    <variable name="limit_max" value="15"/>
                    <variable name="effective_caller_id_name" value="Extension ]] ..req_user..[["/>
                    <variable name="effective_caller_id_number" value="]] ..req_user..[["/>
                    <variable name="callgroup" value="chezai"/>
                  </variables>
                </user>
              </users>
            </group>
          </groups>
        </domain>
      </section>
    </document>]]
else
    XML_STRING = nil
    --[[<?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <document type="freeswitch/xml">
      <section name="directory">
      </section>
    </document>]]
end

-- comment the following line for production:
-- freeswitch.consoleLog("notice", "Debug from gen_dir_user_xml.lua, generated XML:
" .. XML_STRING .. "
");

如果要使用数据库, 自行取消注释并修改.

当前使用的是 从 scripts/users.txt 文件中 读取 分机号码 和 密码(空格分隔,每行一个分机).

scripts/users.txt 文件中没有配置 分机号和密码时,将会自动到xml 配置中去查找.

即: 此 lua 脚本 优先于 xml 配置文件执行, XML_STRING 变量为 nil 时就去查找默认的xml配置.

 当前使用的是 1.10.3 版本测试的, 较低的版本可能要执行第三步,如下

3. 更改 conf/directory/default.xml 使 其配置的分机配置失效 

红色 框里的 注释或者删掉

我用 1.10.3 版本, 不删也可以, 其他版本未测试, 更高的版本 应该也不用删掉的

不删的话, lua 脚本中 XML_STRING 变量为 nil 时就去查找默认的xml配置