[sr-dev] git:master: presence(k): added pres_update_watchers(uri, event)

Module: sip-router Branch: master Commit: 373d3ee17acab0304d339b9bc17f8c14eeb5d348 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=373d3ee… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Sep 28 09:53:19 2010 +0200 presence(k): added pres_update_watchers(uri, event) - function needed to update status of watchers when xcap data changes (e.g., via xcap_server module) --- modules_k/presence/README | 22 +++++++ modules_k/presence/doc/presence_admin.xml | 32 +++++++++++ modules_k/presence/presence.c | 86 +++++++++++++++++++++++++++++ 3 files changed, 140 insertions(+), 0 deletions(-) diff --git a/modules_k/presence/README b/modules_k/presence/README index 6ddcc3e..83996b4 100644 --- a/modules_k/presence/README +++ b/modules_k/presence/README @@ -58,6 +58,7 @@ Juha Heinanen 4.2. handle_subscribe() 4.3. pres_auth_status(watcher_uri, presentity_uri) 4.4. pres_refresh_watchers(uri, event, type) + 4.5. pres_update_watchers(uri, event) 5. Exported MI Functions @@ -105,6 +106,7 @@ Juha Heinanen 1.17. handle_subscribe usage 1.18. pres_auth_status usage 1.19. pres_refresh_watchers usage + 1.20. pres_update_watchers usage 2.1. presence_api_t structure Chapter 1. Admin Guide @@ -141,6 +143,7 @@ Chapter 1. Admin Guide 4.2. handle_subscribe() 4.3. pres_auth_status(watcher_uri, presentity_uri) 4.4. pres_refresh_watchers(uri, event, type) + 4.5. pres_update_watchers(uri, event) 5. Exported MI Functions @@ -410,6 +413,7 @@ modparam("presence", "timeout_rm_subs", 0) 4.2. handle_subscribe() 4.3. pres_auth_status(watcher_uri, presentity_uri) 4.4. pres_refresh_watchers(uri, event, type) + 4.5. pres_update_watchers(uri, event) 4.1. handle_publish(char* sender_uri) @@ -510,6 +514,24 @@ if (method=="MESSAGE") { pres_refresh_watchers("sip:test@kamailio.org", "presence", 1); ... +4.5. pres_update_watchers(uri, event) + + The function can be used in configuration to triger updates to watchers + status if a change in watchers authorization state occurred (i.e., + updates of xcap documents change state from pending to active). + + Parameters: + * uri - the uri of the user who made the change and whose watchers + should be informed. Can be PV. + * event - the event package (e.g., presence). + + This function can be used from ANY_ROUTE. + + Example 1.20. pres_update_watchers usage +... +pres_update_watchers("sip:test@kamailio.org", "presence"); +... + 5. Exported MI Functions 5.1. refreshWatchers diff --git a/modules_k/presence/doc/presence_admin.xml b/modules_k/presence/doc/presence_admin.xml index f71b306..edc6176 100644 --- a/modules_k/presence/doc/presence_admin.xml +++ b/modules_k/presence/doc/presence_admin.xml @@ -568,6 +568,38 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1); </programlisting> </example> </section> + + <section> + <title> + <function moreinfo="none">pres_update_watchers(uri, event)</function> + </title> + <para> + The function can be used in configuration to triger updates to watchers + status if a change in watchers authorization state occurred + (i.e., updates of xcap documents change state from pending to active). + </para> + <para>Parameters:</para> + <itemizedlist> + <listitem> + <para>uri - the uri of the user who made the change + and whose watchers should be informed. Can be PV.</para> + </listitem> + <listitem> + <para>event - the event package (e.g., presence).</para> + </listitem> + </itemizedlist> + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>pres_update_watchers</function> usage</title> + <programlisting format="linespecific"> +... +pres_update_watchers("sip:test@kamailio.org", "presence"); +... +</programlisting> + </example> + </section> </section> <section> diff --git a/modules_k/presence/presence.c b/modules_k/presence/presence.c index cbb9f15..5b00ad3 100644 --- a/modules_k/presence/presence.c +++ b/modules_k/presence/presence.c @@ -122,7 +122,10 @@ static int mi_child_init(void); static int pres_auth_status(struct sip_msg* _msg, char* _sp1, char* _sp2); static int w_pres_refresh_watchers(struct sip_msg *msg, char *puri, char *pevent, char *ptype); +static int w_pres_update_watchers(struct sip_msg *msg, char *puri, + char *pevent); static int fixup_refresh_watchers(void** param, int param_no); +static int fixup_update_watchers(void** param, int param_no); int counter =0; int pid = 0; @@ -152,6 +155,8 @@ static cmd_export_t cmds[]= fixup_pvar_pvar, fixup_free_pvar_pvar, REQUEST_ROUTE}, {"pres_refresh_watchers", (cmd_function)w_pres_refresh_watchers, 3, fixup_refresh_watchers, 0, ANY_ROUTE}, + {"pres_update_watchers", (cmd_function)w_pres_update_watchers, 2, + fixup_update_watchers, 0, ANY_ROUTE}, {"bind_presence", (cmd_function)bind_presence, 1, 0, 0, 0}, { 0, 0, 0, 0, 0, 0} @@ -1252,3 +1257,84 @@ static int fixup_refresh_watchers(void** param, int param_no) } return 0; } + + +/** + * wrapper for update_watchers_status to use in config + */ +static int w_pres_update_watchers(struct sip_msg *msg, char *puri, + char *pevent) +{ + str pres_uri; + str event; + pres_ev_t* ev; + struct sip_uri uri; + str* rules_doc = NULL; + int ret; + + if(fixup_get_svalue(msg, (gparam_p)puri, &pres_uri)!=0) + { + LM_ERR("invalid uri parameter"); + return -1; + } + + if(fixup_get_svalue(msg, (gparam_p)pevent, &event)!=0) + { + LM_ERR("invalid uri parameter"); + return -1; + } + + ev = contains_event(&event, NULL); + if(ev==NULL) + { + LM_ERR("event %.*s is not registered\n", + event.len, event.s); + return -1; + } + if(ev->get_rules_doc==NULL) + { + LM_DBG("event %.*s does not provide rules doc API\n", + event.len, event.s); + return -1; + } + if(parse_uri(pres_uri.s, pres_uri.len, &uri)<0) + { + LM_ERR("failed to parse presentity uri [%.*s]\n", + pres_uri.len, pres_uri.s); + return -1; + } + ret = ev->get_rules_doc(&uri.user, &uri.host, &rules_doc); + if((ret < 0) || (rules_doc==NULL) || (rules_doc->s==NULL)) + { + LM_DBG("no xcap rules doc found for presentity uri [%.*s]\n", + pres_uri.len, pres_uri.s); + if(rules_doc != NULL) + pkg_free(rules_doc); + return -1; + } + ret = 1; + if(update_watchers_status(pres_uri, ev, rules_doc)<0) + { + LM_ERR("updating watchers in presence\n"); + ret = -1; + } + + pkg_free(rules_doc->s); + pkg_free(rules_doc); + + return ret; +} + +/** + * fixup for w_pres_update_watchers + */ +static int fixup_update_watchers(void** param, int param_no) +{ + if(param_no==1) + { + return fixup_spve_null(param, 1); + } else if(param_no==2) { + return fixup_spve_null(param, 1); + } + return 0; +}