![Kamailio SIP Lua
SIPWEET
Config
# Twitter routing
route[SIPWEET] {
# consume tweeties
while(mq_fetch("sipweet"))
{
xlog("Tweeting to $mqk(sipweet) [[$mqv(sipweet)]]n");
# get twitter user
sql_query("ca",
"select twuser from sipweetusers where sipuser='$mqk(sipweet)'",
"ra");
if($dbr(ra=>rows)>0)
{
$var(twuser) = $dbr(ra=>[0,0]);
$var(twuser) = $mqv(sipweet);
if(!lua_runstring("sipweetdm([[$var(twuser)]], [[$var(twmsg)]])"))
{
xdbg("failed to send dm to: $mqk(sipweet) - $var(twuser)!n");
}
}
}
}
www.kamailio.org 16](https://image.slidesharecdn.com/dcm-sip-routing-lua-141101121206-conversion-gate02/85/Kamailio-SIP-Routing-in-Lua-17-320.jpg)
![Kamailio SIP Lua
SIPWEET
Config
# Twitees queuing
route[TWQUEUE] {
if(!is_method("INVITE"))
return;
mq_add("sipweet", "$rU", "Missed call from $fU [$Tf]");
}
route {
...
if(!lookup(“location”)) {
route(TWQUEUE);
t_newtran();
t_reply("404", "Not Found");
exit;
}
...
}
www.kamailio.org 17](https://image.slidesharecdn.com/dcm-sip-routing-lua-141101121206-conversion-gate02/85/Kamailio-SIP-Routing-in-Lua-18-320.jpg)
Kamailio - SIP Routing in Lua
- 2. Kamailio SIP LUA Amoocon 2010 Rostock, Germany Do Your SIP Routing In Lua! Daniel-Constantin Mierla Co-Founder Kamailio (OpenSER) www.asipto.com
- 3. Kamailio SIP Lua It is all about love www.kamailio.org 2 Wine, moon ... and you ... hacking SIP
- 4. Kamailio SIP Lua Instead of introduction • if you missed my previous presentation • “The SIP Router Project - Asynchronous SIP Routing” Links: • http://www.kamailio.org • http://sip-router.org • http://www.lua.org www.kamailio.org 3
- 5. Kamailio SIP Lua Lua What is Lua? • Lua is a powerful, fast, lightweight, embeddable scripting language. • Lua combines simple procedural syntax with powerful data description constructs based on associative arrays and extensible semantics. Lua is dynamically typed, runs by interpreting bytecode for a register-based virtual machine, and has automatic memory management with incremental garbage collection, making it ideal for configuration, scripting, and rapid prototyping. • http://www.lua.org www.kamailio.org 4
- 6. Kamailio SIP Lua Lua Why choose Lua? • Lua has been used in many industrial applications (e.g., Adobe's Photoshop Lightroom), with an emphasis on embedded systems (e.g., the Ginga middleware for digital TV in Brazil) and games (e.g., World of Warcraft). Lua is currently the leading scripting language in games.. • Lua is supported by other telephony engines, e.g., Asterisk and FreeSWITCH • http://www.lua.org www.kamailio.org 5
- 7. Kamailio SIP Lua Lua More about Lua? • is fast • is portable • is embeddable • is powerful (but simple) • is small • is free • http://www.lua.org www.kamailio.org 6
- 8. Kamailio SIP Lua Kamailio and SIP routing Where we stand today? • flexible configuration language, still limited pretty much to SIP only • the power is in hands (and brain) of administrator • SIP specific extensions added mainly by writing C modules • for the rest: Lua, Perl, Python and Java www.kamailio.org 7
- 9. Kamailio SIP Lua Kamailio and Lua Why together? • need to integrate with other communication platforms • it is about realtime communication, so being fast is important • routing logic may require non-SIP related operations • all characteristics of Lua indicates it a very good candidate www.kamailio.org 8
- 10. Kamailio SIP Lua Kamailio and Lua How does it work? • load module: app_lua • Lua scripts can be loaded at startup or on-the-fly at runtime • entire Lua scripts can be executed or just functions from the scripts • Lua scripts have access to SIP messages and config variables • Lua scripts can return back config variables • Lua scripts can execute functions from config file http://kamailio.org/docs/modules/devel/modules/app_lua.html www.kamailio.org 9
- 11. Kamailio SIP Lua Kamailio Lua API Lua packages • package sr • access to Kamailio core functions • method to execute functions exported by modules • container for other sub-packages • package sr.hdr • header manipulation • get, add, remove • package sr.pv • pseudo-variables manipulation • access to all pseudo-variables - hundreds of them • package sr.sl • exports internal sl module API (stateless reply) http://sip-router.org/wiki/api/lua/devel www.kamailio.org 10
- 12. sr.hdr.append_to_reply("X-Src: " .. sr.pv.get("$si") .. ":" .. sr.pv.get("$sp") .. "rn"); Kamailio SIP Lua Kamailio Lua API Basic example Lua script: function sr_append_srcaddr_to_reply() end Kamailio config: modparam("app_lua", "load", "/path/to/myscript.lua") ... route { ... if(!lua_run("sr_append_srcaddr_to_reply")) { xdbg("SCRIPT: failed to execute lua function!n"); } ... } www.kamailio.org 11
- 13. Kamailio SIP Lua SIPWEET www.kamailio.org 12
- 14. Kamailio SIP Lua SIPWEET Send tweets on SIP events • missed call notification • instant messaging • reminders Monitor tweets for SIP services • tweet-to-dial • reminder setup • scheduled calls • profile update www.kamailio.org 13
- 15. Kamailio SIP Lua SIPWEET Design • Lua twitter library • Twitter operation is an HTTP request • can take some time to be processed • we cannot afford that when processing SIP signaling • solution: use asynchronous processing • config file message queue • dedicated process for twitter operations • Kamailio modules • app_lua • mqueue • rtimer • sqlops • Sample implementation • notification of a missed call • use of Twitter direct message www.kamailio.org 14
- 16. Kamailio SIP Lua SIPWEET Config loadmodule "app_lua.so" loadmodule "rtimer.so" loadmodule "sqlops.so" loadmodule “mqueue.so” # ----- app_lua ----- modparam("app_lua", "load", "usr/local/etc/kamailio/lua/sipweet.lua") # ----- rtimer ----- modparam("rtimer", "timer", "name=sipweet;interval=60;mode=1;") modparam("rtimer", "exec", "timer=sipweet;route=SIPWEET;") # ----- sqlops ----- modparam("sqlops","sqlcon", "ca=>mysql://openser:openserrw@localhost/openser") # ----- mqueue ----- modparam("mqueue", "mqueue", "name=sipweet") www.kamailio.org 15
- 17. Kamailio SIP Lua SIPWEET Config # Twitter routing route[SIPWEET] { # consume tweeties while(mq_fetch("sipweet")) { xlog("Tweeting to $mqk(sipweet) [[$mqv(sipweet)]]n"); # get twitter user sql_query("ca", "select twuser from sipweetusers where sipuser='$mqk(sipweet)'", "ra"); if($dbr(ra=>rows)>0) { $var(twuser) = $dbr(ra=>[0,0]); $var(twuser) = $mqv(sipweet); if(!lua_runstring("sipweetdm([[$var(twuser)]], [[$var(twmsg)]])")) { xdbg("failed to send dm to: $mqk(sipweet) - $var(twuser)!n"); } } } } www.kamailio.org 16
- 18. Kamailio SIP Lua SIPWEET Config # Twitees queuing route[TWQUEUE] { if(!is_method("INVITE")) return; mq_add("sipweet", "$rU", "Missed call from $fU [$Tf]"); } route { ... if(!lookup(“location”)) { route(TWQUEUE); t_newtran(); t_reply("404", "Not Found"); exit; } ... } www.kamailio.org 17
- 19. Kamailio SIP Lua SIPWEET Database table CREATE TABLE `sipweetusers` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `twuser` varchar(64) NOT NULL, `sipuser` varchar(64) NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`twuser`), UNIQUE KEY (`sipuser`) ); www.kamailio.org 18
- 20. Kamailio SIP Lua SIPWEET Lua script -- SIPweet -- loading module local twitter = require("twitter") local initialized = 0 local me function sipweetinit() if initialized == 0 then me = twitter.Client( "TWUSER", "TWPASSWD" ) tret = me:VerifyCredentials() initialized = 1 end end function sipweetdm(user, txt) sipweetinit() tret = me:NewDirectMessage(user, txt) end www.kamailio.org 19
- 21. Kamailio SIP Lua SIPWEET And the messages goes ... • nice and quick to your twitter client www.kamailio.org 20
- 22. Meet us next week in Berlin • Developer Meeting, Tue, Jun 8 • LinuxTag Booth, Jun 9-12 Kamailio SIP Lua SIPWEET Concluding • This was a proof of concept to do easy twitter integration • Kamailio Lua API • Asynchronous Twitter Notification System by Config Only • Improvements and new services at your imagination • or mine - prepare the credit card or a good bottle of wine • follow us - cool stuff ahead Contact •Daniel-Constantin Mierla •twitter: miconda •daniel@asipto.com •http://www.asipto.com •http://www.kamailio.org Questions? www.kamailio.org 21