sr-dev January 2013

sr-dev@lists.kamailio.org

46 participants
325 discussions

git:master: siptrace(k) Add RPC command for turning on/off

by Olle E. Johansson

Module: sip-router Branch: master Commit: 9b1c23481551ef74b6efeb0118c1119470a08826 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9b1c234… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 20:09:39 2013 +0100 siptrace(k) Add RPC command for turning on/off Copying the functionality of the existing MI command. Also, setting the value of the trace_flag to 0 by default, as documented in the documentation. --- modules_k/siptrace/README | 59 ++++++++++++++++++-------- modules_k/siptrace/doc/siptrace_admin.xml | 44 ++++++++++++++++---- modules_k/siptrace/siptrace.c | 64 ++++++++++++++++++++++++++++- 3 files changed, 139 insertions(+), 28 deletions(-) diff --git a/modules_k/siptrace/README b/modules_k/siptrace/README index a35a9ce..910ced7 100644 --- a/modules_k/siptrace/README +++ b/modules_k/siptrace/README @@ -23,7 +23,7 @@ Daniel-Constantin Mierla Table of Contents - 1. Admin Guide + 1. SIPtrace Admin Guide 1. Overview 2. Dependencies @@ -58,8 +58,12 @@ Daniel-Constantin Mierla 5.1. sip_trace - 6. Database setup - 7. Known issues + 6. RPC Commands + + 6.1. siptrace.status param + + 7. Database setup + 8. Known issues List of Examples @@ -81,7 +85,7 @@ Daniel-Constantin Mierla 1.16. Set trace_delayed parameter 1.17. sip_trace() usage -Chapter 1. Admin Guide +Chapter 1. SIPtrace Admin Guide Table of Contents @@ -118,25 +122,29 @@ Chapter 1. Admin Guide 5.1. sip_trace - 6. Database setup - 7. Known issues + 6. RPC Commands + + 6.1. siptrace.status param + + 7. Database setup + 8. Known issues 1. Overview - Offer a possibility to store incoming/outgoing SIP messages in database - and/or duplicate to the capturing server (homer encapsulation protocol - or plain sip mode) + Offer a possibility to store incoming and outgoing SIP messages in a + database and/or duplicate to the capturing server (using the Homer + encapsulation protocol or plain SIP mode) There are two ways of storing information. * by calling explicitely the sip_trace() method in Kamailio configuration file. In this case the original message is processed. * by setting the flag equal with the value of 'trace_flag' (e.g., - setflag(__trace_flag__)) parameter of the module. In this case, - the\ message sent forward is processed. The logging mechanism is - based on TM/SL callbacks, so only messages processed with TM/SL are + setflag(__trace_flag__)) parameter of the module. In this case, the + message sent forward is processed. The logging mechanism is based + on TM/SL callbacks, so only messages processed with TM/SL are logged. - The tracing can be turned on/off using fifo commad. + The tracing can be turned on/off using Kamailio mi or RPC commands. kamctl fifo sip_trace on @@ -150,7 +158,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules The following modules must be loaded before this module: - * database module - mysql, postrgress, dbtext, unixodbc... + * database module - Mysql, Postgres, dbtext, unixODBC... * tm and sl modules - optional, only if you want to trace messages forwarded by these modules. @@ -400,7 +408,7 @@ modparam("siptrace", "trace_delayed", 1) 4.1. sip_trace() -4.1. sip_trace() +4.1. sip_trace() Store current processed SIP message in database. It is stored in the form prior applying chages made to it. @@ -417,7 +425,7 @@ sip_trace(); 5.1. sip_trace -5.1. sip_trace +5.1. sip_trace Name: sip_trace @@ -434,7 +442,22 @@ sip_trace(); trace_mode _empty_line_ -6. Database setup +6. RPC Commands + + 6.1. siptrace.status param + +6.1. siptrace.status param + + Name: siptrace.status + + Parameters: + * on or off: turns on/off SIP message tracing.. Possible values are: + + on + + off + * "check" does not change siptrace status, just reports the current + status. + +7. Database setup Before running Kamailio with siptrace, you have to setup the database tables where the module will store the data. For that, if the table @@ -444,7 +467,7 @@ sip_trace(); You can also find the complete database documentation on the project webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html. -7. Known issues +8. Known issues Stateless forwarded messages (forward()) are not logged if you set the flag, use sip_trace(). diff --git a/modules_k/siptrace/doc/siptrace_admin.xml b/modules_k/siptrace/doc/siptrace_admin.xml index 0d1e064..df22003 100644 --- a/modules_k/siptrace/doc/siptrace_admin.xml +++ b/modules_k/siptrace/doc/siptrace_admin.xml @@ -11,14 +11,14 @@ <chapter> - <title>&adminguide;</title> + <title>SIPtrace &adminguide;</title> <section> <title>Overview</title> <para> - Offer a possibility to store incoming/outgoing SIP messages in database - and/or duplicate to the capturing server (homer encapsulation protocol - or plain sip mode) + Offer a possibility to store incoming and outgoing SIP messages in a database + and/or duplicate to the capturing server (using the Homer encapsulation protocol + or plain SIP mode) </para> <para> There are two ways of storing information. @@ -32,7 +32,7 @@ <listitem> <para> by setting the flag equal with the value of 'trace_flag' (e.g., - setflag(__trace_flag__)) parameter of the module. In this case, the\ + setflag(__trace_flag__)) parameter of the module. In this case, the message sent forward is processed. The logging mechanism is based on TM/SL callbacks, so only messages processed with TM/SL are logged. </para> @@ -41,7 +41,7 @@ </para> <para> - The tracing can be turned on/off using fifo commad. + The tracing can be turned on/off using Kamailio mi or RPC commands. </para> <para> &ctltool; fifo sip_trace on @@ -59,8 +59,8 @@ <itemizedlist> <listitem> <para> - <emphasis>database module</emphasis> - mysql, postrgress, - dbtext, unixodbc... + <emphasis>database module</emphasis> - Mysql, Postgres, + dbtext, unixODBC... </para> </listitem> <listitem> @@ -515,7 +515,35 @@ sip_trace(); _empty_line_ </programlisting> </section> + </section> + <section> + <title>RPC Commands</title> + <section> + <title> + <function moreinfo="none">siptrace.status param</function> + </title> + <para> + + </para> + <para> + Name: <emphasis>siptrace.status</emphasis> + </para> + <para>Parameters: </para> + <itemizedlist> + <listitem><para>on or off: turns on/off SIP message tracing.. + Possible values are:</para> + <itemizedlist> + <listitem><para>on</para></listitem> + <listitem><para>off</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><quote>check</quote> does not change + siptrace status, just reports the current status.</para> + </listitem> + </itemizedlist> + </section> + </section> <section> <title>Database setup</title> diff --git a/modules_k/siptrace/siptrace.c b/modules_k/siptrace/siptrace.c index 0d36ba1..6785655 100644 --- a/modules_k/siptrace/siptrace.c +++ b/modules_k/siptrace/siptrace.c @@ -41,6 +41,8 @@ #include "../../mem/mem.h" #include "../../mem/shm_mem.h" #include "../../lib/kmi/mi.h" +#include "../../rpc.h" +#include "../../rpc_lookup.h" #include "../../lib/srdb1/db.h" #include "../../parser/parse_content.h" #include "../../parser/parse_from.h" @@ -86,6 +88,7 @@ sl_api_t slb; /* module function prototypes */ static int mod_init(void); +static int siptrace_init_rpc(void); static int child_init(int rank); static void destroy(void); static int sip_trace(struct sip_msg*, char*, char*); @@ -124,8 +127,8 @@ static str time_us_column = str_init("time_us"); /* 10 */ #define XHEADERS_BUFSIZE 512 -int trace_flag = -1; -int trace_on = 0; +int trace_flag = 0; +=nt trace_on = 0; int trace_sl_acks = 1; int trace_to_database = 1; @@ -265,6 +268,11 @@ static int mod_init(void) LM_ERR("failed to register MI commands\n"); return -1; } + if(siptrace_init_rpc() != 0) + { + LM_ERR("failed to register RPC commands\n"); + return -1; + } db_url.len = strlen(db_url.s); siptrace_table.len = strlen(siptrace_table.s); @@ -1765,3 +1773,55 @@ static int pipport2su (char *pipport, union sockaddr_union *tmp_su, unsigned int error: return -1; } + +static void siptrace_rpc_status (rpc_t* rpc, void* c) { + str status = {0, 0}; + + if (rpc->scan(c, "S", &status) < 1) { + rpc->fault(c, 500, "Not enough parameters (on, off or check)"); + return; + } + + if(trace_on_flag==NULL) { + rpc->fault(c, 500, "Internal error"); + return; + } + + if (strncasecmp(status.s, "on", strlen("on")) == 0) { + *trace_on_flag = 1; + rpc->printf(c, "Enabled"); + return; + } + if (strncasecmp(status.s, "off", strlen("off")) == 0) { + *trace_on_flag = 0; + rpc->printf(c, "Disabled"); + return; + } + if (strncasecmp(status.s, "check", strlen("check")) == 0) { + rpc->printf(c, *trace_on_flag ? "Enabled" : "Disabled"); + return; + } + rpc->fault(c, 500, "Bad parameter (on, off or check)"); + return; +} + +static const char* siptrace_status_doc[2] = { + "Get status or turn on/off siptrace. Parameters: on, off or check.", + 0 +}; + +rpc_export_t siptrace_rpc[] = { + {"siptrace.status", siptrace_rpc_status, siptrace_status_doc, 0}, + {0, 0, 0, 0} +}; + +static int siptrace_init_rpc(void) +{ + if (rpc_register_array(siptrace_rpc)!=0) + { + LM_ERR("failed to register RPC commands\n"); + return -1; + } + return 0; +} +

11 years, 10 months

git:master: sipcapture: Fix typo in XML markup

by Olle E. Johansson

Module: sip-router Branch: master Commit: fd77c500050073e019b0366fdcd3a6c125a20cb9 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=fd77c50… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 20:04:29 2013 +0100 sipcapture: Fix typo in XML markup --- modules/sipcapture/doc/sipcapture_admin.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml index ba64f1c..052ce00 100644 --- a/modules/sipcapture/doc/sipcapture_admin.xml +++ b/modules/sipcapture/doc/sipcapture_admin.xml @@ -453,7 +453,7 @@ modparam("sipcapture", "capture_node", "homer03") </itemizedlist> </section> - </section> + </section> <section> <title>Database setup</title>

11 years, 10 months

git:master: sipcapture Small cleanup in docs

by Olle E. Johansson

Module: sip-router Branch: master Commit: 9af31f9c44cc35a4cbe74accf79513c7272ec93c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9af31f9… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 19:50:12 2013 +0100 sipcapture Small cleanup in docs --- modules/sipcapture/README | 28 +++++++++++++------------- modules/sipcapture/doc/sipcapture_admin.xml | 14 +++++++----- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/modules/sipcapture/README b/modules/sipcapture/README index d83d88d..024466f 100644 --- a/modules/sipcapture/README +++ b/modules/sipcapture/README @@ -52,7 +52,7 @@ Alexandr Dubovikov 5.1. sipcapture.status param 6. Database setup - 7. Limitation + 7. Limitations List of Examples @@ -109,7 +109,7 @@ Chapter 1. Admin Guide 5.1. sipcapture.status param 6. Database setup - 7. Limitation + 7. Limitations 1. Overview @@ -394,18 +394,18 @@ modparam("sipcapture", "capture_node", "homer03") 6. Database setup - Before running Kamailio with sipcapture, you have to setup the database - tables where the module will store the data. For that, if the table - were not created by the installation script or you choose to install - everything by yourself you can use the sipcapture_create.sql, SQL - script in the sql folder of sipcapture module as template. You can also - find the complete database documentation on the project webpage, + Before running Kamailio with the sipcapture module, you have to setup + the database tables where the module will store the data. For that, if + the table were not created by the installation script or you choose to + install everything by yourself you can use the sipcapture_create.sql, + SQL script in the sql folder of sipcapture module as template. You can + also find the complete database documentation on the project webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html. -7. Limitation +7. Limitations - 1. Only one capturing mode on RAW socket is supported: IPIP or - monitoring/mirroring port. Don't activate both at the same time. 2. By - default MySQL doesn't support INSERT DELAYED for partitioning table. - You can patch MySQL (http://bugs.mysql.com/bug.php?id=50393) 3. - Mirroring port capturing works only on Linux. + * 1. Only one capturing mode on RAW socket is supported: IPIP or + monitoring/mirroring port. Don't activate both at the same time. + * 2. By default MySQL doesn't support INSERT DELAYED for partitioning + table. You can patch MySQL (http://bugs.mysql.com/bug.php?id=50393) + * 3. Mirroring port capturing works only on Linux. diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml index e1be9b7..ba64f1c 100644 --- a/modules/sipcapture/doc/sipcapture_admin.xml +++ b/modules/sipcapture/doc/sipcapture_admin.xml @@ -458,7 +458,7 @@ modparam("sipcapture", "capture_node", "homer03") <section> <title>Database setup</title> <para> - Before running &kamailio; with sipcapture, you have to setup the database + Before running &kamailio; with the sipcapture module, you have to setup the database tables where the module will store the data. For that, if the table were not created by the installation script or you choose to install everything by yourself you can use the sipcapture_create.sql, <acronym>SQL</acronym> script @@ -467,16 +467,18 @@ modparam("sipcapture", "capture_node", "homer03") </para> </section> <section> - <title>Limitation</title> - <para> - + <title>Limitations</title> + <itemizedlist> + <listitem> 1. Only one capturing mode on RAW socket is supported: IPIP or monitoring/mirroring port. Don't activate both at the same time. + </listitem><listitem> 2. By default MySQL doesn't support INSERT DELAYED for partitioning table. You can patch MySQL (http://bugs.mysql.com/bug.php?id=50393) + </listitem><listitem> 3. Mirroring port capturing works only on Linux. - - </para> + </listitem> + </itemizedlist> </section> </chapter>

11 years, 10 months

RPC syntax

by Olle E. Johansson

While learning how to create RPC commands in Kamailio, I've came up with a few generic syntax questions that I would like YOUR input on. When listing an object and reaching a value that's not set, should we print a string saying [NOT DEFINED] or something like that - or just nothing. Noticed that usrloc prints a message while I did not in htable, just the header and no value. In most cases we deliver a response in a data structure, but in some cases we just print a one-line message as a response, like "on" or "denied". I am beginning to think that's not a good solution, but have used it in permissions and now in sipcapture. As I'm a copycat I must have gotten it from some other module, but can't remember which one. So the questions are: - when a data field in an object is empty - should we print a message or simply just leave it empty? - should all answers be contained in a structure or is one-line text messages ok? It is irritating developing clients where the server has variations in the syntax, so we want to define a policy here - or just refer me to an existing policy document that I have failed to find, remember or parse :-) And no, it's not to late to change these bugs - if they are bugs - in git HEAD. /O

11 years, 10 months

git:master: sipcapture Add RPC command to turn on/off or check status

by Olle E. Johansson

Module: sip-router Branch: master Commit: 8ebf2dbe6cc0e51b47c423227f5dcff14c7af4c3 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8ebf2db… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 18:37:43 2013 +0100 sipcapture Add RPC command to turn on/off or check status Kamailio RPC rocks - much more than IMS ;-) --- modules/sipcapture/README | 43 +++++++++++++++----- modules/sipcapture/doc/sipcapture_admin.xml | 30 +++++++++++++- modules/sipcapture/sipcapture.c | 58 +++++++++++++++++++++++++++ 3 files changed, 120 insertions(+), 11 deletions(-) diff --git a/modules/sipcapture/README b/modules/sipcapture/README index 872d477..d83d88d 100644 --- a/modules/sipcapture/README +++ b/modules/sipcapture/README @@ -10,9 +10,9 @@ Alexandr Dubovikov <alexandr.dubovikov(a)gmail.com> - Copyright © 2011 QSC AG + Copyright � 2011 QSC AG - Copyright © 2011 http://www.qsc.de + Copyright � 2011 http://www.qsc.de __________________________________________________________________ Table of Contents @@ -47,8 +47,12 @@ Alexandr Dubovikov 4.1. sip_capture - 5. Database setup - 6. Limitation + 5. RPC Commands + + 5.1. sipcapture.status param + + 6. Database setup + 7. Limitation List of Examples @@ -100,8 +104,12 @@ Chapter 1. Admin Guide 4.1. sip_capture - 5. Database setup - 6. Limitation + 5. RPC Commands + + 5.1. sipcapture.status param + + 6. Database setup + 7. Limitation 1. Overview @@ -113,7 +121,7 @@ Chapter 1. Admin Guide * Monitoring/mirroring port. * Homer encapsulation protocol mode (HEP v1, v2, v3). - The capturing can be turned on/off using fifo commad. + The capturing can be turned on/off using mi or rpc commands. Example: kamctl fifo sip_capture on @@ -361,7 +369,7 @@ modparam("sipcapture", "capture_node", "homer03") + on + off The parameter is optional - if missing, the command will return the - status of the SIP message capturing (as string “on” or “off” ) + status of the SIP message capturing (as string "on" or "off" ) without changing anything. MI FIFO Command Format: @@ -369,7 +377,22 @@ modparam("sipcapture", "capture_node", "homer03") capture_mode _empty_line_ -5. Database setup +5. RPC Commands + + 5.1. sipcapture.status param + +5.1. sipcapture.status param + + Name: sipcapture.status + + Parameters: + * on or off: turns on/off SIP message capturing. Possible values are: + + on + + off + * "check" does not change sipcapture status, just reports the current + status. + +6. Database setup Before running Kamailio with sipcapture, you have to setup the database tables where the module will store the data. For that, if the table @@ -379,7 +402,7 @@ modparam("sipcapture", "capture_node", "homer03") find the complete database documentation on the project webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html. -6. Limitation +7. Limitation 1. Only one capturing mode on RAW socket is supported: IPIP or monitoring/mirroring port. Don't activate both at the same time. 2. By diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml index b81fa52..0504a1e 100644 --- a/modules/sipcapture/doc/sipcapture_admin.xml +++ b/modules/sipcapture/doc/sipcapture_admin.xml @@ -40,7 +40,7 @@ </para> <para> - The capturing can be turned on/off using fifo commad. + The capturing can be turned on/off using mi or rpc commands. Example: </para> <para> &ctltool; fifo sip_capture on @@ -425,7 +425,35 @@ modparam("sipcapture", "capture_node", "homer03") _empty_line_ </programlisting> </section> + </section> + <section> + <title>RPC Commands</title> + <section> + <title> + <function moreinfo="none">sipcapture.status param</function> + </title> + <para> + + </para> + <para> + Name: <emphasis>sipcapture.status</emphasis> + </para> + <para>Parameters: </para> + <itemizedlist> + <listitem><para>on or off: turns on/off SIP message capturing. + Possible values are:</para> + <itemizedlist> + <listitem><para>on</para></listitem> + <listitem><para>off</para></listitem> + </itemizedlist> + </listitem> + <listitem><quote>check</quote> does not change + sipcapture status, just reports the current status.</para> + </listitem> + </itemizedlist> + </section> + </section> <section> <title>Database setup</title> diff --git a/modules/sipcapture/sipcapture.c b/modules/sipcapture/sipcapture.c index 7ae94b9..dc74a3b 100644 --- a/modules/sipcapture/sipcapture.c +++ b/modules/sipcapture/sipcapture.c @@ -60,6 +60,8 @@ #include "../../mem/mem.h" #include "../../mem/shm_mem.h" #include "../../lib/kmi/mi.h" +#include "../../rpc.h" +#include "../../rpc_lookup.h" #include "../../lib/srdb1/db.h" #include "../../parser/contact/parse_contact.h" #include "../../parser/parse_content.h" @@ -95,6 +97,7 @@ MODULE_VERSION /* module function prototypes */ static int mod_init(void); +static int sipcapture_init_rpc(void); static int child_init(int rank); static void destroy(void); static int sip_capture(struct sip_msg *msg, char *s1, char *s2); @@ -409,6 +412,11 @@ static int mod_init(void) { LM_ERR("failed to register MI commands\n"); return -1; } + if(sipcapture_init_rpc()!=0) + { + LM_ERR("failed to register RPC commands\n"); + return -1; + } db_url.len = strlen(db_url.s); table_name.len = strlen(table_name.s); @@ -1564,4 +1572,54 @@ int raw_capture_rcv_loop(int rsock, int port1, int port2, int ipip) { return 0; } +static void sipcapture_rpc_status (rpc_t* rpc, void* c) { + str status = {0, 0}; + + if (rpc->scan(c, "S", &status) < 1) { + rpc->fault(c, 500, "Not enough parameters (on, off or check)"); + return; + } + + if(capture_on_flag==NULL) { + rpc->fault(c, 500, "Internal error"); + return; + } + + if (strncasecmp(status.s, "on", strlen("on")) == 0) { + *capture_on_flag = 1; + rpc->printf(c, "Enabled"); + return; + } + if (strncasecmp(status.s, "off", strlen("off")) == 0) { + *capture_on_flag = 0; + rpc->printf(c, "Disabled"); + return; + } + if (strncasecmp(status.s, "check", strlen("check")) == 0) { + rpc->printf(c, *capture_on_flag ? "Enabled" : "Disabled"); + return; + } + rpc->fault(c, 500, "Bad parameter (on, off or check)"); + return; +} + +static const char* sipcapture_status_doc[2] = { + "Get status or turn on/off sipcapture.", + 0 +}; + +rpc_export_t sipcapture_rpc[] = { + {"sipcapture.status", sipcapture_rpc_status, sipcapture_status_doc, 0}, + {0, 0, 0, 0} +}; + +static int sipcapture_init_rpc(void) +{ + if (rpc_register_array(sipcapture_rpc)!=0) + { + LM_ERR("failed to register RPC commands\n"); + return -1; + } + return 0; +}

11 years, 10 months

git:master: sipcapture Small typo

by Olle E. Johansson

Module: sip-router Branch: master Commit: ba12e3893787a8340d21aa18ab6faa81e825713f URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ba12e38… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 18:38:54 2013 +0100 sipcapture Small typo --- modules/sipcapture/doc/sipcapture_admin.xml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml index 0504a1e..e1be9b7 100644 --- a/modules/sipcapture/doc/sipcapture_admin.xml +++ b/modules/sipcapture/doc/sipcapture_admin.xml @@ -447,7 +447,7 @@ modparam("sipcapture", "capture_node", "homer03") <listitem><para>off</para></listitem> </itemizedlist> </listitem> - <listitem><quote>check</quote> does not change + <listitem><para><quote>check</quote> does not change sipcapture status, just reports the current status.</para> </listitem> </itemizedlist>

11 years, 10 months

git:master: pv(k): Remove read-only empty strings that might be attempted to be written to

by Richard Fuchs

Module: sip-router Branch: master Commit: 70ca23583a136f2a401ce57d4b9f110e2f4db1fe URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=70ca235… Author: Richard Fuchs <rfuchs(a)sipwise.com> Committer: Richard Fuchs <rfuchs(a)sipwise.com> Date: Wed Jan 9 12:34:27 2013 -0500 pv(k): Remove read-only empty strings that might be attempted to be written to --- modules_k/pv/pv_core.c | 5 +++-- modules_k/pv/pv_trans.c | 17 ++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules_k/pv/pv_core.c b/modules_k/pv/pv_core.c index d67278f..c4eba97 100644 --- a/modules_k/pv/pv_core.c +++ b/modules_k/pv/pv_core.c @@ -59,6 +59,7 @@ static str pv_uri_scheme[] = { { "urn", 3 }, { 0, 0 } }; +static char _empty_str[] = ""; static str pv_af_list[] = { { "IPv4", 4 }, @@ -1872,7 +1873,7 @@ int pv_set_ruri_user(struct sip_msg* msg, pv_param_t *param, memset(&act, 0, sizeof(act)); act.type = SET_USER_T; act.val[0].type = STRING_ST; - act.val[0].u.string = ""; + act.val[0].u.string = _empty_str; init_run_actions_ctx(&h); if (do_action(&h, &act, msg)<0) { @@ -1965,7 +1966,7 @@ int pv_set_ruri_port(struct sip_msg* msg, pv_param_t *param, memset(&act, 0, sizeof(act)); act.type = SET_PORT_T; act.val[0].type = STRING_ST; - act.val[0].u.string = ""; + act.val[0].u.string = _empty_str; init_run_actions_ctx(&h); if (do_action(&h, &act, msg)<0) { diff --git a/modules_k/pv/pv_trans.c b/modules_k/pv/pv_trans.c index 995d25a..fc9597b 100644 --- a/modules_k/pv/pv_trans.c +++ b/modules_k/pv/pv_trans.c @@ -49,6 +49,12 @@ #include "pv_trans.h" +static char _empty_str[] = ""; +static str _tr_empty = { _empty_str, 0 }; +static str _tr_uri = {0, 0}; +static struct sip_uri _tr_parsed_uri; +static param_t* _tr_uri_params = NULL; + /*! transformation buffer size */ #define TR_BUFFER_SIZE 65536 #define TR_BUFFER_SLOTS 4 @@ -384,8 +390,7 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, val->rs.s = p+1; val->rs.len = s-p; } else { - val->rs.s = ""; - val->rs.len = 0; + val->rs = _tr_empty; } } else { s = val->rs.s; @@ -406,8 +411,7 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, val->rs.s = s; val->rs.len = p-s; } else { - val->rs.s = ""; - val->rs.len = 0; + val->rs = _tr_empty; } } break; @@ -789,11 +793,6 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, return 0; } -static str _tr_empty = { "", 0 }; -static str _tr_uri = {0, 0}; -static struct sip_uri _tr_parsed_uri; -static param_t* _tr_uri_params = NULL; - /*! * \brief Evaluate URI transformations

11 years, 10 months

git:3.3: pv(k): Remove read-only empty strings that might be attempted to be written to

by Richard Fuchs

Module: sip-router Branch: 3.3 Commit: a650507c5e9c7abb1ebdf8f60768a9fbdd23c189 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a650507… Author: Richard Fuchs <rfuchs(a)sipwise.com> Committer: Richard Fuchs <rfuchs(a)sipwise.com> Date: Wed Jan 9 12:34:27 2013 -0500 pv(k): Remove read-only empty strings that might be attempted to be written to --- modules_k/pv/pv_core.c | 5 +++-- modules_k/pv/pv_trans.c | 17 ++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules_k/pv/pv_core.c b/modules_k/pv/pv_core.c index 370ec1a..9a98608 100644 --- a/modules_k/pv/pv_core.c +++ b/modules_k/pv/pv_core.c @@ -59,6 +59,7 @@ static str pv_uri_scheme[] = { { "urn", 3 }, { 0, 0 } }; +static char _empty_str[] = ""; int _pv_pid = 0; @@ -1779,7 +1780,7 @@ int pv_set_ruri_user(struct sip_msg* msg, pv_param_t *param, memset(&act, 0, sizeof(act)); act.type = SET_USER_T; act.val[0].type = STRING_ST; - act.val[0].u.string = ""; + act.val[0].u.string = _empty_str; init_run_actions_ctx(&h); if (do_action(&h, &act, msg)<0) { @@ -1872,7 +1873,7 @@ int pv_set_ruri_port(struct sip_msg* msg, pv_param_t *param, memset(&act, 0, sizeof(act)); act.type = SET_PORT_T; act.val[0].type = STRING_ST; - act.val[0].u.string = ""; + act.val[0].u.string = _empty_str; init_run_actions_ctx(&h); if (do_action(&h, &act, msg)<0) { diff --git a/modules_k/pv/pv_trans.c b/modules_k/pv/pv_trans.c index d127e76..af455eb 100644 --- a/modules_k/pv/pv_trans.c +++ b/modules_k/pv/pv_trans.c @@ -49,6 +49,12 @@ #include "pv_trans.h" +static char _empty_str[] = ""; +static str _tr_empty = { _empty_str, 0 }; +static str _tr_uri = {0, 0}; +static struct sip_uri _tr_parsed_uri; +static param_t* _tr_uri_params = NULL; + /*! transformation buffer size */ #define TR_BUFFER_SIZE 65536 #define TR_BUFFER_SLOTS 4 @@ -384,8 +390,7 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, val->rs.s = p+1; val->rs.len = s-p; } else { - val->rs.s = ""; - val->rs.len = 0; + val->rs = _tr_empty; } } else { s = val->rs.s; @@ -406,8 +411,7 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, val->rs.s = s; val->rs.len = p-s; } else { - val->rs.s = ""; - val->rs.len = 0; + val->rs = _tr_empty; } } break; @@ -748,11 +752,6 @@ int tr_eval_string(struct sip_msg *msg, tr_param_t *tp, int subtype, return 0; } -static str _tr_empty = { "", 0 }; -static str _tr_uri = {0, 0}; -static struct sip_uri _tr_parsed_uri; -static param_t* _tr_uri_params = NULL; - /*! * \brief Evaluate URI transformations

11 years, 10 months

git:master: usrloc(k) Reveal existing rpc command in README

by Olle E. Johansson

Module: sip-router Branch: master Commit: 875c5e71cf1ac077f17eb15030ce8cfb0d299e89 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=875c5e7… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 15:29:48 2013 +0100 usrloc(k) Reveal existing rpc command in README --- modules_k/usrloc/README | 99 +++++++++++++++++++------------- modules_k/usrloc/doc/usrloc_admin.xml | 18 ++++++ 2 files changed, 77 insertions(+), 40 deletions(-) diff --git a/modules_k/usrloc/README b/modules_k/usrloc/README index 77d1f83..b764fe1 100644 --- a/modules_k/usrloc/README +++ b/modules_k/usrloc/README @@ -78,12 +78,16 @@ Bogdan-Andrei Iancu 5.5. ul_add 5.6. ul_show_contact - 6. Statistics + 6. RPC Commands - 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 6.1. ul.dump + + 7. Statistics + + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users 2. Developer Guide @@ -200,12 +204,16 @@ Chapter 1. Admin Guide 5.5. ul_add 5.6. ul_show_contact - 6. Statistics + 6. RPC Commands + + 6.1. ul.dump - 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 7. Statistics + + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users 1. Overview @@ -730,7 +738,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") 5.5. ul_add 5.6. ul_show_contact -5.1. ul_rm +5.1. ul_rm Deletes an entire AOR record (including its contacts). @@ -739,7 +747,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on). -5.2. ul_rm_contact +5.2. ul_rm_contact Deletes a contact from an AOR record. @@ -749,7 +757,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") only if use_domain option is on). * contact - exact contact to be removed -5.3. ul_dump +5.3. ul_dump Dumps the entire content of the USRLOC in memory cache @@ -758,11 +766,11 @@ modparam("usrloc", "xavp_contact", "ulattrs") "brief", a brief dump will be done (only AOR and contacts, with no other details) -5.4. ul_flush +5.4. ul_flush Triggers the flush of USRLOC memory cache into DB. -5.5. ul_add +5.5. ul_add Adds a new contact for an user AOR. @@ -778,7 +786,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * cflags - per branch flags of the contact * methods - mask with supported requests of the contact -5.6. ul_show_contact +5.6. ul_show_contact Dumps the contacts of an user AOR. @@ -787,33 +795,44 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on). -6. Statistics +6. RPC Commands + + 6.1. ul.dump + +6.1. ul.dump + + Dumps the content of the location table + + Parameters: + * None. + +7. Statistics - 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users Exported statistics are listed in the next sections. -6.1. users +7.1. users Number of AOR existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location). -6.2. contacts +7.2. contacts Number of contacts existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location). -6.3. expires +7.3. expires Total number of expired contacts for that domain - can be resetted; this statistic will be register for each used domain (Ex: location). -6.4. registered_users +7.4. registered_users Total number of AOR existing in the USRLOC memory cache for all domains - can not be resetted. @@ -866,7 +885,7 @@ Chapter 2. Developer Guide 1.14. ul_register_ulcb(type ,callback, param) 1.15. ul_get_num_users() -1.1. ul_register_domain(name) +1.1. ul_register_domain(name) The function registers a new domain. Domain is just another name for table used in registrar. The function is called from fixups in @@ -881,7 +900,7 @@ Chapter 2. Developer Guide * const char* name - Name of the domain (also called table) to be registered. -1.2. ul_insert_urecord(domain, aor, rec) +1.2. ul_insert_urecord(domain, aor, rec) The function creates a new record structure and inserts it in the specified domain. The record is structure that contains all the @@ -896,7 +915,7 @@ Chapter 2. Developer Guide * urecord_t** rec - The newly created record structure. -1.3. ul_delete_urecord(domain, aor) +1.3. ul_delete_urecord(domain, aor) The function deletes all the contacts bound with the given Address Of Record. @@ -908,7 +927,7 @@ Chapter 2. Developer Guide * str* aor - Address of record (aka username) of the record, that should be deleted. -1.4. ul_get_urecord(domain, aor) +1.4. ul_get_urecord(domain, aor) The function returns pointer to record with given Address of Record. @@ -918,7 +937,7 @@ Chapter 2. Developer Guide * str* aor - Address of Record of request record. -1.5. ul_lock_udomain(domain) +1.5. ul_lock_udomain(domain) The function lock the specified domain, it means, that no other processes will be able to access during the time. This prevents race @@ -929,14 +948,14 @@ Chapter 2. Developer Guide Meaning of the parameters is as follows: * udomain_t* domain - Domain to be locked. -1.6. ul_unlock_udomain(domain) +1.6. ul_unlock_udomain(domain) Unlock the specified domain previously locked by ul_lock_udomain. Meaning of the parameters is as follows: * udomain_t* domain - Domain to be unlocked. -1.7. ul_release_urecord(record) +1.7. ul_release_urecord(record) Do some sanity checks - if all contacts have been removed, delete the entire record structure. @@ -944,7 +963,7 @@ Chapter 2. Developer Guide Meaning of the parameters is as follows: * urecord_t* record - Record to be released. -1.8. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags, +1.8. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags, cont, ua, sock) The function inserts a new contact in the given record with specified @@ -965,7 +984,7 @@ cont, ua, sock) * struct socket_info *sock - socket on which the REGISTER message was received on. -1.9. ul_delete_ucontact (record, contact) +1.9. ul_delete_ucontact (record, contact) The function deletes given contact from record. @@ -975,7 +994,7 @@ cont, ua, sock) * ucontact_t* contact - Contact to be deleted. -1.10. ul_get_ucontact(record, contact) +1.10. ul_get_ucontact(record, contact) The function tries to find contact with given Contact URI and returns pointer to structure representing the contact. @@ -985,7 +1004,7 @@ cont, ua, sock) * str_t* contact - URI of the request contact. -1.11. ul_get_all_ucontacts (buf, len, flags) +1.11. ul_get_all_ucontacts (buf, len, flags) The function retrieves all contacts of all registered users and returns them in the caller-supplied buffer. If the buffer is too small, the @@ -1006,7 +1025,7 @@ cont, ua, sock) * unsigned int flags - Flags that must be set. -1.12. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua, +1.12. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua, sock) The function updates contact with new values. @@ -1025,7 +1044,7 @@ sock) * struct socket_info *sock - socket on which the REGISTER message was received on. -1.13. ul_bind_ursloc( api ) +1.13. ul_bind_ursloc( api ) The function imports all functions that are exported by the USRLOC module. Overs for other modules which want to user the internal USRLOC @@ -1034,7 +1053,7 @@ sock) Meaning of the parameters is as follows: * usrloc_api_t* api - USRLOC API -1.14. ul_register_ulcb(type ,callback, param) +1.14. ul_register_ulcb(type ,callback, param) The function register with USRLOC a callback function to be called when some event occures inside USRLOC. @@ -1047,6 +1066,6 @@ sock) * void *param - some parameter to be passed to the callback each time when it is called. -1.15. ul_get_num_users() +1.15. ul_get_num_users() The function loops through all domains summing up the number of users. diff --git a/modules_k/usrloc/doc/usrloc_admin.xml b/modules_k/usrloc/doc/usrloc_admin.xml index 86c25cc..6143ea6 100644 --- a/modules_k/usrloc/doc/usrloc_admin.xml +++ b/modules_k/usrloc/doc/usrloc_admin.xml @@ -994,7 +994,25 @@ modparam("usrloc", "xavp_contact", "ulattrs") </itemizedlist> </section> + </section> + <section> + <title>RPC Commands</title> + + <section> + <title> + <function moreinfo="none">ul.dump</function> + </title> + <para> + Dumps the content of the location table + </para> + <para>Parameters: </para> + <itemizedlist> + <listitem><para> + None. + </para></listitem> + </itemizedlist> </section> + </section> <section>

11 years, 10 months

git:master: db_cassandra Minor edits and typo fixes to README

by Olle E. Johansson

Module: sip-router Branch: master Commit: e1306157b324d2ad21d97af0edf14072769787d7 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e130615… Author: Olle E. Johansson <oej(a)edvina.net> Committer: Olle E. Johansson <oej(a)edvina.net> Date: Wed Jan 9 14:00:32 2013 +0100 db_cassandra Minor edits and typo fixes to README --- modules/db_cassandra/README | 29 ++++++++++++----------- modules/db_cassandra/doc/db_cassandra_admin.xml | 18 +++++++------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/modules/db_cassandra/README b/modules/db_cassandra/README index 97df44e..f7806c8 100644 --- a/modules/db_cassandra/README +++ b/modules/db_cassandra/README @@ -14,7 +14,7 @@ Anca Vamanu <anca.vamanu(a)1and1.ro> - Copyright © 2012 1&1 Internet AG + Copyright � 2012 1&1 Internet AG __________________________________________________________________ Table of Contents @@ -61,9 +61,9 @@ Chapter 1. Admin Guide 1. Overview - Db_cassandra is one of the SIP Router database modules. It does not + Db_cassandra is one of the Kamailio database modules. It does not export any functions executable from the configuration scripts, but it - exports a subset of functions from the database API, and thus, other + exports a subset of functions using the database API, and thus, other modules can use it as a database driver, instead of, for example, the Mysql module. @@ -76,13 +76,14 @@ Chapter 1. Admin Guide two indexing levels. These issues will be explained in an example below. - Cassandra DB is especially suited for storing large data or data that - requires distribution, redundancy or replication. One usage example is - a distributed location system in a platform that has a cluster of SIP - Router servers, with more proxies and registration servers accessing - the same location database. This was actually the main use case we had - in mind when implementing this module. Please NOTE that it has only - been tested with the usrloc, auth_db and domain modules. + Cassandra DB is especially suited for storing large amounts of data or + data that requires distribution, redundancy or replication. One usage + example is a distributed location system in a platform that has a + cluster of SIP Router servers, with several proxies and registration + servers accessing the same location database. This was actually the + main use case we had in mind when implementing this module. Please NOTE + that it has only been tested with the usrloc, auth_db and domain + modules. You can find a configuration file example for this usage in the module - kamailio_cassa.cfg. @@ -157,14 +158,14 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; The directory where the files with the table schemas are located. This directory has to contain the subdirectories corresponding to the - databases' names (name of the directory = name of the database). These + database name (name of the directory = name of the database). These directories, in turn, contain the files with the table schemas. See the schemas in utils/kamctl/dbcassandra directory. Example 1.1. Set schema_path parameter ... modparam("db_cassandra", "schema_path", - "/usr/local/sip-router/etc/kamctl/dbcassandra") + "/usr/local/kamailio/etc/kamctl/dbcassandra") ... 4. Functions @@ -173,7 +174,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; 5. Installation - Because it dependes on an external library, the db_cassandra module is + Because the db_cassandra module dependes on an external library, it is not compiled and installed by default. You can use one of these options: * - edit the "Makefile" and remove "db_cassandra" from @@ -210,7 +211,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; * Third row: the columns that form the secondary key separated by space. - Bellow you can see the schema for the location table (when use_domain + Below you can see the schema for the location table (when use_domain not set): ... diff --git a/modules/db_cassandra/doc/db_cassandra_admin.xml b/modules/db_cassandra/doc/db_cassandra_admin.xml index d52c907..78c8c9b 100644 --- a/modules/db_cassandra/doc/db_cassandra_admin.xml +++ b/modules/db_cassandra/doc/db_cassandra_admin.xml @@ -17,9 +17,9 @@ <section> <title>Overview</title> <para> - Db_cassandra is one of the &siprouter; database modules. It does + Db_cassandra is one of the &kamailio; database modules. It does not export any functions executable from the configuration scripts, - but it exports a subset of functions from the database API, and thus, + but it exports a subset of functions using the database API, and thus, other modules can use it as a database driver, instead of, for example, the Mysql module. </para> @@ -34,10 +34,10 @@ below. </para> <para> - Cassandra DB is especially suited for storing large data or data that requires - distribution, redundancy or replication. One usage example is + Cassandra DB is especially suited for storing large amounts of data or data + that requires distribution, redundancy or replication. One usage example is a distributed location system in a platform that has a cluster of &siprouter; - servers, with more proxies and registration servers accessing the same location + servers, with several proxies and registration servers accessing the same location database. This was actually the main use case we had in mind when implementing this module. Please NOTE that it has only been tested with the <emphasis>usrloc</emphasis>, <emphasis>auth_db</emphasis> and <emphasis>domain</emphasis> modules. @@ -143,7 +143,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <para> The directory where the files with the table schemas are located. This directory has to contain the subdirectories corresponding to the - databases' names (name of the directory = name of the database). + database name (name of the directory = name of the database). These directories, in turn, contain the files with the table schemas. See the schemas in utils/kamctl/dbcassandra directory. </para> @@ -152,7 +152,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <programlisting format="linespecific"> ... modparam("db_cassandra", "schema_path", - "/usr/local/sip-router/etc/kamctl/dbcassandra") + "/usr/local/kamailio/etc/kamctl/dbcassandra") ... </programlisting> </example> @@ -169,7 +169,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; <section> <title>Installation</title> <para> - Because it dependes on an external library, the db_cassandra module is not + Because the db_cassandra module dependes on an external library, it is not compiled and installed by default. You can use one of these options: </para> <itemizedlist> @@ -232,7 +232,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; </itemizedlist> </para> <para> - Bellow you can see the schema for the <emphasis>location</emphasis> + Below you can see the schema for the <emphasis>location</emphasis> table (when use_domain not set): </para> <para>

11 years, 10 months

← Newer
1
...
18
19
20
21
22
23
24
...
33
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev January 2013