From 534ffd8481341da6c7539163d7f575e98173cae0 Mon Sep 17 00:00:00 2001 From: Joshua Colp Date: Mon, 7 Jul 2014 16:08:47 +0000 Subject: res_pjsip_dialog_info_body_generator: Add dialog-info+xml support for presence. This module implements dialog-info+xml for the purposes of presence. This means that phones such as Grandstreams can now subscribe to receive presence information for an extension. ASTERISK-21443 #close Reported by: Matt Jordan Review: https://reviewboard.asterisk.org/r/3705/ ........ Merged revisions 418116 from http://svn.asterisk.org/svn/asterisk/branches/12 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@418117 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/res_pjsip_body_generator_types.h | 3 + include/asterisk/res_pjsip_presence_xml.h | 2 +- res/res_pjsip/presence_xml.c | 5 +- res/res_pjsip_dialog_info_body_generator.c | 215 ++++++++++++++++++++++ res/res_pjsip_exten_state.c | 21 +++ 5 files changed, 244 insertions(+), 2 deletions(-) create mode 100644 res/res_pjsip_dialog_info_body_generator.c diff --git a/include/asterisk/res_pjsip_body_generator_types.h b/include/asterisk/res_pjsip_body_generator_types.h index 09f234a03..a2cc04313 100644 --- a/include/asterisk/res_pjsip_body_generator_types.h +++ b/include/asterisk/res_pjsip_body_generator_types.h @@ -28,6 +28,7 @@ * \li application/pidf+xml * \li application/xpidf+xml * \li application/cpim-pidf+xml + * \li application/dialog-info+xml */ struct ast_sip_exten_state_data { /*! The extension of the current state change */ @@ -48,6 +49,8 @@ struct ast_sip_exten_state_data { char local[PJSIP_MAX_URL_SIZE]; /*! Remote dialog URI */ char remote[PJSIP_MAX_URL_SIZE]; + /*! Optional subscription */ + struct ast_sip_subscription *sub; /*! Allocation pool */ pj_pool_t *pool; }; diff --git a/include/asterisk/res_pjsip_presence_xml.h b/include/asterisk/res_pjsip_presence_xml.h index a10d5016d..8318067ad 100644 --- a/include/asterisk/res_pjsip_presence_xml.h +++ b/include/asterisk/res_pjsip_presence_xml.h @@ -72,7 +72,7 @@ pj_xml_attr *ast_sip_presence_xml_create_attr(pj_pool_t *pool, * \brief Create XML node * * \param pool Allocation pool - * \param parent Node that will be parent to the created node + * \param parent Optional node that will be parent to the created node * \param name The name for the new node * \return The created node */ diff --git a/res/res_pjsip/presence_xml.c b/res/res_pjsip/presence_xml.c index 9ed07caa1..2fe6bdc00 100644 --- a/res/res_pjsip/presence_xml.c +++ b/res/res_pjsip/presence_xml.c @@ -152,7 +152,10 @@ pj_xml_node *ast_sip_presence_xml_create_node(pj_pool_t *pool, node->content.ptr = NULL; node->content.slen = 0; - pj_xml_add_node(parent, node); + if (parent) { + pj_xml_add_node(parent, node); + } + return node; } diff --git a/res/res_pjsip_dialog_info_body_generator.c b/res/res_pjsip_dialog_info_body_generator.c new file mode 100644 index 000000000..c6d53dc7b --- /dev/null +++ b/res/res_pjsip_dialog_info_body_generator.c @@ -0,0 +1,215 @@ +/* + * asterisk -- An open source telephony toolkit. + * + * Copyright (C) 2014, Digium, Inc. + * + * Joshua Colp + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +/*** MODULEINFO + pjproject + res_pjsip + res_pjsip_pubsub + res_pjsip_exten_state + core + ***/ + +#include "asterisk.h" + +#include +#include +#include + +#include "asterisk/module.h" +#include "asterisk/res_pjsip.h" +#include "asterisk/res_pjsip_pubsub.h" +#include "asterisk/res_pjsip_presence_xml.h" +#include "asterisk/res_pjsip_body_generator_types.h" + +/*! \brief Structure which contains dialog-info+xml state information */ +struct dialog_info_xml_state { + /*! \brief Version to place into the next NOTIFY */ + unsigned int version; +}; + +/*! \brief Destructor for dialog-info+xml information */ +static void dialog_info_xml_state_destroy(void *obj) +{ + ast_free(obj); +} + +/*! \brief Datastore for attaching dialog-info+xml state information */ +static const struct ast_datastore_info dialog_info_xml_datastore = { + .type = "dialog-info+xml", + .destroy = dialog_info_xml_state_destroy, +}; + +static void *dialog_info_allocate_body(void *data) +{ + struct ast_sip_exten_state_data *state_data = data; + + return ast_sip_presence_xml_create_node(state_data->pool, NULL, "dialog-info"); +} + +static struct ast_datastore *dialog_info_xml_state_find_or_create(struct ast_sip_subscription *sub) +{ + struct ast_datastore *datastore = ast_sip_subscription_get_datastore(sub, "dialog-info+xml"); + + if (datastore) { + return datastore; + } + + datastore = ast_sip_subscription_alloc_datastore(&dialog_info_xml_datastore, "dialog-info+xml"); + if (!datastore) { + return NULL; + } + datastore->data = ast_calloc(1, sizeof(struct dialog_info_xml_state)); + if (!datastore->data || ast_sip_subscription_add_datastore(sub, datastore)) { + ao2_ref(datastore, -1); + return NULL; + } + + return datastore; +} + +static unsigned int dialog_info_xml_get_version(struct ast_sip_subscription *sub, unsigned int *version) +{ + struct ast_datastore *datastore = dialog_info_xml_state_find_or_create(sub); + struct dialog_info_xml_state *state; + + if (!datastore) { + return -1; + } + + state = datastore->data; + *version = state->version++; + ao2_ref(datastore, -1); + + return 0; +} + +static int dialog_info_generate_body_content(void *body, void *data) +{ + pj_xml_node *dialog_info = body, *dialog, *state; + struct ast_sip_exten_state_data *state_data = data; + char *local = ast_strdupa(state_data->local), *stripped, *statestring = NULL; + char *pidfstate = NULL, *pidfnote = NULL; + enum ast_sip_pidf_state local_state; + unsigned int version; + char version_str[32], sanitized[PJSIP_MAX_URL_SIZE]; + + if (!local || !state_data->sub) { + return -1; + } + + if (dialog_info_xml_get_version(state_data->sub, &version)) { + ast_log(LOG_WARNING, "dialog-info+xml version could not be retrieved from datastore\n"); + return -1; + } + + stripped = ast_strip_quoted(local, "<", ">"); + ast_sip_sanitize_xml(stripped, sanitized, sizeof(sanitized)); + + ast_sip_presence_exten_state_to_str(state_data->exten_state, &statestring, + &pidfstate, &pidfnote, &local_state); + + ast_sip_presence_xml_create_attr(state_data->pool, dialog_info, "xmlns", "urn:ietf:params:xml:ns:dialog-info"); + + snprintf(version_str, sizeof(version_str), "%u", version); + ast_sip_presence_xml_create_attr(state_data->pool, dialog_info, "version", version_str); + + ast_sip_presence_xml_create_attr(state_data->pool, dialog_info, "state", "full"); + ast_sip_presence_xml_create_attr(state_data->pool, dialog_info, "entity", sanitized); + + dialog = ast_sip_presence_xml_create_node(state_data->pool, dialog_info, "dialog"); + ast_sip_presence_xml_create_attr(state_data->pool, dialog, "id", state_data->exten); + + state = ast_sip_presence_xml_create_node(state_data->pool, dialog, "state"); + pj_strdup2(state_data->pool, &state->content, statestring); + + if (state_data->exten_state == AST_EXTENSION_ONHOLD) { + pj_xml_node *local_node, *target, *param; + + local_node = ast_sip_presence_xml_create_node(state_data->pool, dialog, "local"); + target = ast_sip_presence_xml_create_node(state_data->pool, local_node, "target"); + ast_sip_presence_xml_create_attr(state_data->pool, target, "uri", sanitized); + param = ast_sip_presence_xml_create_node(state_data->pool, target, "param"); + ast_sip_presence_xml_create_attr(state_data->pool, param, "pname", "+sip.rendering"); + ast_sip_presence_xml_create_attr(state_data->pool, param, "pvalue", "no"); + } + + return 0; +} + +/* The maximum number of times the ast_str() for the body text can grow before we declare an XML body + * too large to send. + */ +#define MAX_STRING_GROWTHS 3 + +/* When having pj_xml_print add the XML prolog to the output body the function will return 39 + * instead of -1 if the rest of the document can not be printed into the body. + */ +#define XML_PROLOG 39 + +static void dialog_info_to_string(void *body, struct ast_str **str) +{ + pj_xml_node *dialog_info = body; + int growths = 0; + int size; + + do { + size = pj_xml_print(dialog_info, ast_str_buffer(*str), ast_str_size(*str), PJ_TRUE); + if (size == XML_PROLOG) { + ast_str_make_space(str, ast_str_size(*str) * 2); + ++growths; + } + } while (size == XML_PROLOG && growths < MAX_STRING_GROWTHS); + + if (size == XML_PROLOG) { + ast_log(LOG_WARNING, "dialog-info+xml body text too large\n"); + return; + } + + *(ast_str_buffer(*str) + size) = '\0'; + ast_str_update(*str); +} + +static struct ast_sip_pubsub_body_generator dialog_info_body_generator = { + .type = "application", + .subtype = "dialog-info+xml", + .allocate_body = dialog_info_allocate_body, + .generate_body_content = dialog_info_generate_body_content, + .to_string = dialog_info_to_string, + /* No need for a destroy_body callback since we use a pool */ +}; + +static int load_module(void) +{ + if (ast_sip_pubsub_register_body_generator(&dialog_info_body_generator)) { + return AST_MODULE_LOAD_DECLINE; + } + + return AST_MODULE_LOAD_SUCCESS; +} + +static int unload_module(void) +{ + ast_sip_pubsub_unregister_body_generator(&dialog_info_body_generator); + return 0; +} + +AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Extension State Dialog Info+XML Provider", + .load = load_module, + .unload = unload_module, + .load_pri = AST_MODPRI_CHANNEL_DEPEND, +); diff --git a/res/res_pjsip_exten_state.c b/res/res_pjsip_exten_state.c index cb39026ca..55bd90ee0 100644 --- a/res/res_pjsip_exten_state.c +++ b/res/res_pjsip_exten_state.c @@ -66,6 +66,7 @@ struct exten_state_subscription { }; #define DEFAULT_PRESENCE_BODY "application/pidf+xml" +#define DEFAULT_DIALOG_BODY "application/dialog-info+xml" static void subscription_shutdown(struct ast_sip_subscription *sub); static int new_subscribe(struct ast_sip_endpoint *endpoint, const char *resource); @@ -88,6 +89,14 @@ struct ast_sip_subscription_handler presence_handler = { .notifier = &presence_notifier, }; +struct ast_sip_subscription_handler dialog_handler = { + .event_name = "dialog", + .accept = { DEFAULT_DIALOG_BODY, }, + .subscription_shutdown = subscription_shutdown, + .to_ami = to_ami, + .notifier = &presence_notifier, +}; + static void exten_state_subscription_destructor(void *obj) { struct exten_state_subscription *sub = obj; @@ -158,6 +167,7 @@ static void send_notify(struct exten_state_subscription *exten_state_sub) exten_state_sub->exten, &subtype, &message), .presence_subtype = subtype, .presence_message = message, + .sub = exten_state_sub->sip_sub, .user_agent = exten_state_sub->user_agent }; @@ -250,6 +260,8 @@ static int notify_task(void *obj) task_data->exten_state_data.pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "exten_state", 1024, 1024); + task_data->exten_state_data.sub = task_data->exten_state_sub->sip_sub; + ast_sip_subscription_notify(task_data->exten_state_sub->sip_sub, &task_data->exten_state_data, task_data->terminate); @@ -439,11 +451,20 @@ static int load_module(void) presence_handler.event_name); return AST_MODULE_LOAD_DECLINE; } + + if (ast_sip_register_subscription_handler(&dialog_handler)) { + ast_log(LOG_WARNING, "Unable to register subscription handler %s\n", + dialog_handler.event_name); + ast_sip_unregister_subscription_handler(&presence_handler); + return AST_MODULE_LOAD_DECLINE; + } + return AST_MODULE_LOAD_SUCCESS; } static int unload_module(void) { + ast_sip_unregister_subscription_handler(&dialog_handler); ast_sip_unregister_subscription_handler(&presence_handler); return 0; } -- cgit v1.2.3