sr-dev

sr-dev@lists.kamailio.org

15 participants
44239 discussions

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: cf593d2fd64bcc6a04526beaa228b028e065d304 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=cf593d2… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Sep 24 18:20:54 2009 +0200 mi_rpc: doc update - async mi commands supported - added the list of the various rpc mi commands versions (mi, mi_dg, mi_xmlrpc and mi_fifo). --- modules/mi_rpc/README | 73 ++++++++++++++++++++++++----------- modules/mi_rpc/doc/mi_rpc_admin.xml | 37 ++++++++++++++--- 2 files changed, 80 insertions(+), 30 deletions(-) diff --git a/modules/mi_rpc/README b/modules/mi_rpc/README index d2d0fff..5739c28 100644 --- a/modules/mi_rpc/README +++ b/modules/mi_rpc/README @@ -18,55 +18,84 @@ Daniel-Constantin Mierla 1. Admin Guide - 1.1. Overview - 1.2. Dependencies + 1. Overview + 2. Dependencies - 1.2.1. Kamailio Modules - 1.2.2. External Libraries or Applications + 2.1. Kamailio Modules + 2.2. External Libraries or Applications - 1.3. Exported Parameters - 1.4. Exported Functions - 1.5. Exported RPC commands + 3. Exported Parameters + 4. Exported Functions + 5. Exported RPC commands - 1.5.1. mi + 5.1. mi mi_dg mi_fifo mi_xmlrpc Chapter 1. Admin Guide -1.1. Overview + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Exported Parameters + 4. Exported Functions + 5. Exported RPC commands + + 5.1. mi mi_dg mi_fifo mi_xmlrpc + +1. Overview The module exports a RPC command to execute MI commands. The other way around not implemented (MI command to execute RPC) -- to - be investigated if worth the effort. Also, execution of asynchronous MI - command is not yet supported. + be investigated if worth the effort. + +2. Dependencies -1.2. Dependencies + 2.1. Kamailio Modules + 2.2. External Libraries or Applications -1.2.1. Kamailio Modules +2.1. Kamailio Modules The following modules must be loaded before this module: * No dependencies on other Kamailio modules. -1.2.2. External Libraries or Applications +2.2. External Libraries or Applications The following libraries or applications must be installed before running Kamailio with this module loaded: * None. -1.3. Exported Parameters +3. Exported Parameters none -1.4. Exported Functions +4. Exported Functions none -1.5. Exported RPC commands +5. Exported RPC commands + + 5.1. mi mi_dg mi_fifo mi_xmlrpc -1.5.1. mi +5.1. mi mi_dg mi_fifo mi_xmlrpc Execute a MI command. + Depending on the version (e.g. mi, mi_dg) it formats the output in a + similar way to the corresponding kamailio mi module: + * mi - uses a special, "pretty" format which generates nicer (more + readable) output when used with sercmd. + * mi_dg - uses an output format similar to the kamailio mi_datagram + module. + * mi_fifo - uses an output format similar to the kamailio mi_fifo + module. + * mi_xmlrpc - uses an output format similar to the kamailio mi_xmlrpc + module. + Name: mi Parameters: @@ -77,8 +106,6 @@ Chapter 1. Admin Guide Example using 'sercmd': sercmd> mi uptime -200 OK - -+ Now:: Sun Jun 28 12:45:37 2009 -+ Up since:: Sun Jun 28 12:24:27 2009 -+ Up time:: 1270 [sec] +Now:: Thu Sep 24 18:17:15 2009 +Up since:: Thu Sep 24 17:35:45 2009 +Up time:: 2490 [sec] diff --git a/modules/mi_rpc/doc/mi_rpc_admin.xml b/modules/mi_rpc/doc/mi_rpc_admin.xml index 98b7987..514ddd6 100644 --- a/modules/mi_rpc/doc/mi_rpc_admin.xml +++ b/modules/mi_rpc/doc/mi_rpc_admin.xml @@ -20,8 +20,7 @@ </para> <para> The other way around not implemented (MI command to execute RPC) - -- to be investigated if worth the effort. Also, execution of - asynchronous MI command is not yet supported. + -- to be investigated if worth the effort. </para> </section> @@ -69,11 +68,37 @@ <section> <title> <function moreinfo="none">mi</function> + <function moreinfo="none">mi_dg</function> + <function moreinfo="none">mi_fifo</function> + <function moreinfo="none">mi_xmlrpc</function> </title> <para> Execute a MI command. </para> <para> + Depending on the version (e.g. mi, mi_dg) it formats the output in a + similar way to the corresponding kamailio mi module: + <itemizedlist> + <listitem> + <function>mi</function> - uses a special, "pretty" format + which generates nicer (more readable) output when used with + sercmd. + </listitem> + <listitem> + <function>mi_dg</function> - uses an output format similar to + the kamailio mi_datagram module. + </listitem> + <listitem> + <function>mi_fifo</function> - uses an output format similar + to the kamailio mi_fifo module. + </listitem> + <listitem> + <function>mi_xmlrpc</function> - uses an output format similar + to the kamailio mi_xmlrpc module. + </listitem> + </itemizedlist> + </para> + <para> Name: <emphasis>mi</emphasis> </para> <para>Parameters:</para> @@ -90,11 +115,9 @@ </para> <programlisting format="linespecific"> sercmd> mi uptime -200 OK - -+ Now:: Sun Jun 28 12:45:37 2009 -+ Up since:: Sun Jun 28 12:24:27 2009 -+ Up time:: 1270 [sec] +Now:: Thu Sep 24 18:17:15 2009 +Up since:: Thu Sep 24 17:35:45 2009 +Up time:: 2490 [sec] </programlisting> </section> </section>

15 years, 3 months

git:master: mi_rpc: support for async mi commands

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 244d4d4729b295be999acb3a4ca4cf156a9bfbbf URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=244d4d4… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Sep 24 18:06:22 2009 +0200 mi_rpc: support for async mi commands async mi commands can now be executed, if the underlying rpc transport module supports it (e.g. xmlrpc). --- modules/mi_rpc/mi_rpc_mod.c | 135 ++++++++++++++++++++++++++++++++++++++----- 1 files changed, 120 insertions(+), 15 deletions(-) diff --git a/modules/mi_rpc/mi_rpc_mod.c b/modules/mi_rpc/mi_rpc_mod.c index 9c68839..b678f25 100644 --- a/modules/mi_rpc/mi_rpc_mod.c +++ b/modules/mi_rpc/mi_rpc_mod.c @@ -93,7 +93,7 @@ struct mi_root *mi_rpc_read_params(rpc_t *rpc, void *ctx) { name.s = 0; name.len = 0; - + if(value.len>=2 && value.s[0]=='-' && value.s[1]=='-') { /* name */ @@ -256,12 +256,66 @@ static int mi_rpc_print_tree(rpc_t* rpc, void* ctx, struct mi_root *tree, return 0; } + + +/* structure used to pack the rpc dyn. ctx and the print mode */ +struct mi_rpc_handler_param{ + rpc_delayed_ctx_t* dctx; + enum mi_rpc_print_mode mode; +}; + +/* send reply and close async context */ +static void mi_rpc_async_close(struct mi_root* mi_rpl, + struct mi_handler* mi_h, + int done) +{ + rpc_delayed_ctx_t* dctx; + rpc_t* rpc; + void* c; + enum mi_rpc_print_mode mode; + + dctx=0; + if (done){ + if (mi_h->param==0){ + BUG("null param\n"); + shm_free(mi_h); + goto error; + } + dctx=((struct mi_rpc_handler_param*)mi_h->param)->dctx; + if (dctx==0){ + BUG("null dctx\n"); + shm_free(mi_h->param); + shm_free(mi_h); + mi_h->param=0; + goto error; + } + mode=((struct mi_rpc_handler_param*)mi_h->param)->mode; + rpc=&dctx->rpc; + c=dctx->reply_ctx; + + mi_rpc_print_tree(rpc, c, mi_rpl, mode); + + rpc->delayed_ctx_close(dctx); + shm_free(mi_h->param); + mi_h->param=0; + shm_free(mi_h); + } /* else: no provisional support => do nothing */ +error: + if (mi_rpl) + free_mi_tree(mi_rpl); + return; +} + + + static void rpc_mi_exec(rpc_t *rpc, void *ctx, enum mi_rpc_print_mode mode) { str cmd; struct mi_cmd *mic; struct mi_root *mi_req; struct mi_root *mi_rpl; + struct mi_handler* mi_async_h; + struct mi_rpc_handler_param* mi_handler_param; if (rpc->scan(ctx, "S", &cmd) < 1) { @@ -269,7 +323,11 @@ static void rpc_mi_exec(rpc_t *rpc, void *ctx, enum mi_rpc_print_mode mode) rpc->fault(ctx, 500, "command parameter missing"); return; } - + + mi_async_h=0; + mi_req = 0; + mi_rpl=0; + mic = lookup_mi_cmd(cmd.s, cmd.len); if(mic==0) { @@ -280,12 +338,15 @@ static void rpc_mi_exec(rpc_t *rpc, void *ctx, enum mi_rpc_print_mode mode) if (mic->flags&MI_ASYNC_RPL_FLAG) { - LM_ERR("async mi cmd support not implemented yet\n"); - rpc->fault(ctx, 500, "async my cmd not implemented yet"); - return; + if (rpc->capabilities==0 || + !(rpc->capabilities(ctx) & RPC_DELAYED_REPLY)) + { + rpc->fault(ctx, 500, + "this rpc transport does not support async mode"); + return; + } } - mi_req = 0; if(!(mic->flags&MI_NO_INPUT_FLAG)) { mi_req = mi_rpc_read_params(rpc, ctx); @@ -293,29 +354,73 @@ static void rpc_mi_exec(rpc_t *rpc, void *ctx, enum mi_rpc_print_mode mode) { LM_ERR("cannot parse parameters\n"); rpc->fault(ctx, 500, "cannot parse parameters"); - return; + goto error; } + if (mic->flags&MI_ASYNC_RPL_FLAG) + { + /* build mi async handler */ + mi_handler_param=shm_malloc(sizeof(*mi_handler_param)); + if (mi_handler_param==0){ + rpc->fault(ctx, 500, "out of memory"); + return; + } + mi_async_h=shm_malloc(sizeof(*mi_async_h)); + if (mi_async_h==0){ + shm_free(mi_handler_param); + mi_handler_param=0; + rpc->fault(ctx, 500, "out of memory"); + return; + } + memset(mi_async_h, 0, sizeof(*mi_async_h)); + mi_async_h->handler_f=mi_rpc_async_close; + mi_handler_param->mode=mode; + mi_handler_param->dctx=rpc->delayed_ctx_new(ctx); + if (mi_handler_param->dctx==0){ + rpc->fault(ctx, 500, "internal error: async ctx" + " creation failed"); + goto error; + } + /* switch context, since replies are not allowed anymore on the + original one */ + rpc=&mi_handler_param->dctx->rpc; + ctx=mi_handler_param->dctx->reply_ctx; + mi_async_h->param=mi_handler_param; + } + mi_req->async_hdl=mi_async_h; } mi_rpl=run_mi_cmd(mic, mi_req); if(mi_rpl == 0) { rpc->fault(ctx, 500, "execution failed"); - if (mi_req) free_mi_tree(mi_req); - return; + goto error; } if (mi_rpl!=MI_ROOT_ASYNC_RPL) { mi_rpc_print_tree(rpc, ctx, mi_rpl, mode); + goto end; + }else if (mi_async_h==0){ + /* async reply, but command not listed as async */ + rpc->fault(ctx, 500, "bad mi command: unexpected async reply"); + goto error; + } + mi_async_h=0; /* don't delete it */ +end: +error: + if (mi_req) + free_mi_tree(mi_req); + if (mi_rpl && mi_rpl!=MI_ROOT_ASYNC_RPL) free_mi_tree(mi_rpl); - if (mi_req) free_mi_tree(mi_req); - return; + if (mi_async_h){ + if (mi_async_h->param){ + if (((struct mi_rpc_handler_param*)mi_async_h->param)->dctx) + rpc->delayed_ctx_close(((struct mi_rpc_handler_param*) + mi_async_h->param)->dctx); + shm_free(mi_async_h->param); + } + shm_free(mi_async_h); } - - /* async cmd -- not yet */ - rpc->fault(ctx, 500, "no async handling yet"); - if (mi_req) free_mi_tree(mi_req); return; }

15 years, 3 months

Standalone Configuration File Parser

by Jan Janak

Hello, I am not sure if everybody is aware of that, but the sip-router core has inherited a standalone configuration file parser from SER. The parser lives in files cfg_parser.[ch] and can be used to parse configuration files of form: # comment... [section] name1 = value1 name2 = value2 ... The format of section identifiers as well as the format of configuration values are extensible it can be anything from booleans, integers, strings, and even more complicated compound formats of your own. Two SER modules currently use the parser. The tls module uses it to parse standalone configuration files with TLS related configuration. The ldap SER module uses the parser to parse a configuration file that maps LDAP objects to tables and columns for the database API. Here is an example of a non-trivial configuration file the parse can parse: http://git.sip-router.org/cgi-bin/gitweb.cgi?p=sip-router;a=blob_plain;f=mo… Some documentation can be found in file sip_router/cfg_parser.c. For examples how to use it have a look at the following files: http://git.sip-router.org/cgi-bin/gitweb.cgi?p=sip-router;a=blob;f=modules_… http://git.sip-router.org/cgi-bin/gitweb.cgi?p=sip-router;a=blob;f=modules/… Jan.

15 years, 3 months

F_TCPCONN connection marked as bad

by jh＠tutpro.com

with latest additions that andrei made to s xmlrpc module, i now managed to get click-to-dial to work using tm.t_uac_wait. however, one new issue appeared. each time i call t_uac_wait over xmlrpc, i get to syslog: Sep 23 18:06:37 localhost /usr/sbin/sip-proxy[18399]: INFO: Handling XMLRPC POST from <127.0.0.1> Sep 23 18:06:37 localhost /usr/sbin/sip-proxy[18399]: WARNING: <core> [tcp_read. c:969]: WARNING: tcp_receive: handle_io: F_TCPCONN connection marked as bad: 0xb 3399dc8 id 51 refcnt 1 it does not seem to have any effect in operation of t_uac_wait. any idea why that comes and how to get rid of it? my xmlrpc_requests route looks like this: route [xmlrpc_requests] { # Handle XMLRPC requests xlog("L_INFO", "Handling XMLRPC $rm from <$si>\n"); set_reply_no_connect(); # optional set_reply_close(); dispatch_rpc(); return; } -- juha

15 years, 3 months

git:master: tcp: killed warning

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 33c8757246f5a775f6b918f4e629e3c645ad1345 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=33c8757… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Sep 23 21:48:32 2009 +0200 tcp: killed warning Killed warning for the case when a connection is force closed on purpose (via set_reply_close()). --- tcp_read.c | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-) diff --git a/tcp_read.c b/tcp_read.c index b79e2e2..d201765 100644 --- a/tcp_read.c +++ b/tcp_read.c @@ -964,7 +964,8 @@ again: con=(struct tcp_connection*)fm->data; if (unlikely(con->state==S_CONN_BAD)){ resp=CONN_ERROR; - LOG(L_WARN, "WARNING: tcp_receive: handle_io: F_TCPCONN" + if (!(con->send_flags & SND_F_CON_CLOSE)) + LOG(L_WARN, "WARNING: tcp_receive: handle_io: F_TCPCONN" " connection marked as bad: %p id %d refcnt %d\n", con, con->id, atomic_get(&con->refcnt)); goto read_error;

15 years, 3 months

git:master: tm: fixed empty sl reply warning

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 0d6fcb8e786c89e25ac0ac11eab59ab108b97ab6 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0d6fcb8… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Sep 23 22:21:07 2009 +0200 tm: fixed empty sl reply warning --- modules/tm/tm.c | 6 ++++-- 1 files changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/tm/tm.c b/modules/tm/tm.c index 22d7da1..df7874c 100644 --- a/modules/tm/tm.c +++ b/modules/tm/tm.c @@ -504,7 +504,7 @@ static int fixup_routes(char* r_type, struct route_list* rt, void** param) LOG(L_ERR, "ERROR: tm: fixup_routes: route_get failed\n"); return E_UNSPEC; } - if (rt->rlist[i]==0){ + if (r_type && rt->rlist[i]==0){ LOG(L_WARN, "WARNING: %s(\"%s\"): empty/non existing route\n", r_type, (char*)*param); } @@ -557,7 +557,7 @@ static int fixup_on_sl_reply(modparam_t type, void* val) return -1; } - if (fixup_routes("on_sl_reply", &onreply_rt, &val)) + if (fixup_routes(0, &onreply_rt, &val)) return -1; goto_on_sl_reply = (int)(long)val; @@ -779,6 +779,8 @@ static int mod_init(void) if (goto_on_local_req>=0 && event_rt.rlist[goto_on_local_req]==0) goto_on_local_req=-1; /* disable */ #endif /* WITH_EVENT_LOCAL_REQUEST */ + if (goto_on_sl_reply && onreply_rt.rlist[goto_on_sl_reply]==0) + WARN("empty/non existing on_sl_reply route\n"); tm_init = 1; return 0; }

15 years, 3 months

current problem summary

by jh＠tutpro.com

here is my current list of open problems: - this warning needs to go away: Sep 2 21:00:18 localhost sip-router: WARNING: tm [tm.c:502]: WARNING: on_sl_reply("stateless_reply"): empty/non existing route when onreply_route [stateless_reply] exist. - tm.t_uac_wait over xmlrpc generates warning: Sep 23 18:06:37 localhost /usr/sbin/sip-proxy[18399]: WARNING: <core> [tcp_read. c:969]: WARNING: tcp_receive: handle_io: F_TCPCONN connection marked as bad: 0xb 3399dc8 id 51 refcnt 1 - not all processes die on sr restart (waiting it to happen again to get more info). -- juha ps. i hope that i'm not the only user currently testing sr, because i haven't seen many problems reports from other people? if i am, i need a plan b.

15 years, 3 months

local_route block ?

by jh＠tutpro.com

in k or openser there used to be a local_route block that was executed for locally generated requests, such as those triggered by t_uac_dlg mi command. the question is, what is the equivalent in sr? when issuing, for example, invite using tm.t_uac_wait, i need to be able to set invite timeout using t_set_fr() call. there exists onsend_route, but according to wiki, it does not apply: This route is executed only when forwarding requests - it is not executed for replies, retransmissions, or locally generated messages (e.g. via fifo uac). -- juha

15 years, 3 months

git:master: tm: set T before entering local-request route

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 3cf20fed4d75797eec1ae820da8d8ab9abcdc668 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3cf20fe… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Sep 23 20:59:40 2009 +0200 tm: set T before entering local-request route --- modules/tm/uac.c | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-) diff --git a/modules/tm/uac.c b/modules/tm/uac.c index cd3e1e9..7565763 100644 --- a/modules/tm/uac.c +++ b/modules/tm/uac.c @@ -86,6 +86,7 @@ #include "../../receive.h" #include "../../route.h" #include "../../action.h" +#include "t_lookup.h" #endif #define FROM_TAG_LEN (MD5_LEN + 1 /* - */ + CRC16_LEN) /* length of FROM tags */ @@ -205,6 +206,9 @@ static inline int t_uac_prepare(uac_req_t *uac_r, #endif long nhtype; #ifdef WITH_EVENT_LOCAL_REQUEST + struct cell *backup_t; + int backup_branch; + unsigned int backup_msgid; static struct sip_msg lreq; char *buf1; int buf_len1; @@ -353,7 +357,17 @@ static inline int t_uac_prepare(uac_req_t *uac_r, /* run the route */ backup_route_type = get_route_type(); set_route_type(LOCAL_ROUTE); + /* set T to the current transaction */ + backup_t=get_t(); + backup_branch=get_t_branch(); + backup_msgid=global_msg_id; + /* fake transaction and message id */ + global_msg_id=lreq.id; + set_t(new_cell, T_BR_UNDEFINED); run_top_route(event_rt.rlist[goto_on_local_req], &lreq, 0); + /* restore original environment */ + set_t(backup_t, backup_branch); + global_msg_id=backup_msgid; set_route_type( backup_route_type ); /* restore original environment */

15 years, 3 months

git:master: xmlrpc(s): doc updated

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 07599b8befbc37f37372c64b83e84bbc1164e1cd URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=07599b8… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Sep 23 16:19:11 2009 +0200 xmlrpc(s): doc updated - escape_cr and double_lf_to_crlf documented --- modules_s/xmlrpc/README | 45 ++++++++++++++++++++++++++++++++++- modules_s/xmlrpc/doc/params.xml | 49 +++++++++++++++++++++++++++++++++++++++ modules_s/xmlrpc/doc/xmlrpc.xml | 10 ++++++++ 3 files changed, 102 insertions(+), 2 deletions(-) diff --git a/modules_s/xmlrpc/README b/modules_s/xmlrpc/README index d1abb54..fed4a70 100644 --- a/modules_s/xmlrpc/README +++ b/modules_s/xmlrpc/README @@ -22,6 +22,8 @@ Jan Janak 1.5.1. route (string) 1.5.2. autoconversion (string) + 1.5.3. escape_cr (integer) + 1.5.4. double_lf_to_crlf (integer) 1.6. Functions @@ -473,6 +475,14 @@ route[XMLRPC]{ dispatch_rpc(); } + Another common problem is CRLF handling. According to the xml spec CR + ('\r') must be escaped (to ) or they will be "normalized" when + parsing the xml document. However some xmlrpc clients do not follow + this rule (e.g. clients based on the python or php xmlrpclib) and send + CRLF unescaped. A possible workaround is to enable automatic LFLF to + CRLF conversion (using the double_lf_to_crlf modules parameter) and + replace CRLF with LFLF in the client queries. + 1.4. Client Examples * examples/xmlrpc_test.pl (basic perl application that builds and @@ -524,6 +534,37 @@ modparam("xmlrpc", "route", "route_for_xmlrpcs") Example 3. Set the autoconversion parameter modparam("xmlrpc", "autoconversion", 1) +1.5.3. escape_cr (integer) + + Enable CR ('\r') escaping in replies. If enabled each '\r' in the + xmlrpc reply will be replaced with "", according to the xml spec. + + It should be turned off only if you suspect interoperability problems + with older clients. + + Default: on. + + Example 4. Set the escape_cr parameter +modparam("xmlrpc", "escape_cr", 1) + +1.5.4. double_lf_to_crlf (integer) + + When enabled double LFs ('\n\n') in the input xmlrpc strings will be + replaced with CR LF ('\r\n'). This makes LF LF behave like an escape + character for CR LF and is needed for compatibility with kamailio tools + and to work around buggy xmlrpc clients that don't escape the CR in CR + LF ('\r' should be escaped to "" otherwise according to the xml + spec "\r\n" will be transformed to '\n'), but need to send CR LF in the + strings (e.g. they use tm.t_uac_wait). + + Note: when this option is turned on, there is no way to send a double + LF ('\n\n'), it will always be transformed in CR LF ('\r\n'). + + Default: off. + + Example 5. Set the double_lf_to_crlf parameter +modparam("xmlrpc", "double_lf_to_crlf", 1) + 1.6. Functions Revision History @@ -545,7 +586,7 @@ modparam("xmlrpc", "autoconversion", 1) function with matching name. If such a function is found then dispatch_rpc() will pass control to the function to handle the request. - Example 4. dispatch_rpc usage + Example 6. dispatch_rpc usage #... modparam("xmlrpc", "route", "XMLRPC"); #... @@ -561,7 +602,7 @@ route[XMLRPC]{ This function can be called from the config script to directly generate an XML-RPC reply. - Example 5. xmlrpc_reply usage + Example 7. xmlrpc_reply usage #... modparam("xmlrpc", "route", "XMLRPC"); #... diff --git a/modules_s/xmlrpc/doc/params.xml b/modules_s/xmlrpc/doc/params.xml index be7fd63..f200b55 100644 --- a/modules_s/xmlrpc/doc/params.xml +++ b/modules_s/xmlrpc/doc/params.xml @@ -67,6 +67,55 @@ modparam("xmlrpc", "autoconversion", 1) </example> </section> + <section id="escape_cr"> + <title><varname>escape_cr</varname> (integer)</title> + <para> + Enable CR ('\r') escaping in replies. If enabled each '\r' in the + xmlrpc reply will be replaced with "&#xD;", according to the + xml spec. + </para> + <para> + It should be turned off only if you suspect interoperability problems + with older clients. + </para> + <para> + Default: on. + </para> + <example> + <title>Set the <varname>escape_cr</varname> parameter</title> + <programlisting> +modparam("xmlrpc", "escape_cr", 1) + </programlisting> + </example> + </section> + + <section id="double_lf_to_crlf"> + <title><varname>double_lf_to_crlf</varname> (integer)</title> + <para> + When enabled double LFs ('\n\n') in the input xmlrpc strings + will be replaced with CR LF ('\r\n'). This makes LF LF behave like + an escape character for CR LF and is needed for compatibility with + kamailio tools and to work around buggy xmlrpc clients that don't + escape the CR in CR LF ('\r' should be escaped to "&#xD;" + otherwise according to the xml spec "\r\n" will be transformed to + '\n'), but need to send CR LF in the strings (e.g. they use + <function>tm.t_uac_wait</function>). + </para> + <para> + Note: when this option is turned on, there is no way to send a double + LF ('\n\n'), it will always be transformed in CR LF ('\r\n'). + </para> + <para> + Default: off. + </para> + <example> + <title>Set the <varname>double_lf_to_crlf</varname> parameter</title> + <programlisting> +modparam("xmlrpc", "double_lf_to_crlf", 1) + </programlisting> + </example> + </section> + <!-- Obsolete (hardwired on in the rpc core functions, cannot be turned off) -andrei diff --git a/modules_s/xmlrpc/doc/xmlrpc.xml b/modules_s/xmlrpc/doc/xmlrpc.xml index 2cdf422..81cf02a 100644 --- a/modules_s/xmlrpc/doc/xmlrpc.xml +++ b/modules_s/xmlrpc/doc/xmlrpc.xml @@ -699,6 +699,16 @@ route[XMLRPC]{ </programlisting> </example> </para> + <para> + Another common problem is CRLF handling. According to the xml spec + CR ('\r') must be escaped (to &#xD;) or they will be "normalized" + when parsing the xml document. However some xmlrpc clients do not + follow this rule (e.g. clients based on the python or php xmlrpclib) + and send CRLF unescaped. A possible workaround is to enable + automatic LFLF to CRLF conversion (using the + <varname>double_lf_to_crlf</varname> modules parameter) and replace + CRLF with LFLF in the client queries. + </para> </section> </section>

15 years, 3 months

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev