res_pjsip_pubsub.c File Reference

#include "asterisk.h"
#include <pjsip.h>
#include <pjsip_simple.h>
#include <pjlib.h>
#include "asterisk/mwi.h"
#include "asterisk/res_pjsip_pubsub.h"
#include "asterisk/module.h"
#include "asterisk/linkedlists.h"
#include "asterisk/astobj2.h"
#include "asterisk/datastore.h"
#include "asterisk/uuid.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/sched.h"
#include "asterisk/res_pjsip.h"
#include "asterisk/callerid.h"
#include "asterisk/manager.h"
#include "asterisk/cli.h"
#include "asterisk/test.h"
#include "res_pjsip/include/res_pjsip_private.h"
#include "asterisk/res_pjsip_presence_xml.h"

Include dependency graph for res_pjsip_pubsub.c:

Go to the source code of this file.

Data Structures
struct	ast_sip_publication
	Structure representing a SIP publication. More...
struct	ast_sip_publication_resource
	Structure representing a publication resource. More...
struct	ast_sip_subscription
	Structure representing a "virtual" SIP subscription. More...
struct	body_generators
struct	body_part
	A multipart body part and meta-information. More...
struct	body_part_list
	Type declaration for container of body part structures. More...
struct	body_supplements
struct	cli_sub_complete_parms
struct	cli_sub_parms
struct	initial_notify_data
struct	persistence_recreate_data
struct	publish_handlers
struct	resource_list
	Resource list configuration item. More...
struct	resource_tree
	A resource tree. More...
struct	resources
	A vector of strings commonly used throughout this module. More...
struct	simple_message_summary
struct	sip_subscription_tree
	A tree of SIP subscriptions. More...
struct	subscription_handlers
struct	subscription_persistence
	Structure used for persisting an inbound subscription. More...
struct	subscriptions
struct	tree_node
	A node for a resource tree. More...

Macros
#define	AMI_SHOW_SUBSCRIPTIONS_INBOUND   "PJSIPShowSubscriptionsInbound"
#define	AMI_SHOW_SUBSCRIPTIONS_OUTBOUND   "PJSIPShowSubscriptionsOutbound"
#define	CLI_LIST_SUB_FORMAT_ENTRY   "%-30.30s %-30.30s %6d %s\n"
#define	CLI_LIST_SUB_FORMAT_HEADER   "%-30.30s %-30.30s %6.6s %s\n"
#define	CLI_SHOW_SUB_FORMAT_ENTRY
#define	CLI_SHOW_SUB_FORMAT_HEADER
#define	DATASTORE_BUCKETS   53
	Number of buckets for subscription datastore. More...
#define	DEFAULT_EXPIRES   3600
	Default expiration for subscriptions. More...
#define	DEFAULT_PUBLISH_EXPIRES   3600
	Default expiration time for PUBLISH if one is not specified. More...
#define	MAX_REGEX_ERROR_LEN   128
#define	MOD_DATA_MSG   "sub_msg"
#define	MOD_DATA_PERSISTENCE   "sub_persistence"
#define	NEW_SUBSCRIBE(notifier, endpoint, resource, rdata)   notifier->new_subscribe_with_rdata ? notifier->new_subscribe_with_rdata(endpoint, resource, rdata) : notifier->new_subscribe(endpoint, resource)
#define	PUBLICATIONS_BUCKETS   37
	Number of buckets for publications (on a per handler) More...
#define	RESOURCE_LIST_INIT_SIZE   4

Typedefs
typedef int(*	on_subscription_t) (struct sip_subscription_tree *sub, void *arg)

Enumerations
enum	sip_persistence_update_type { SUBSCRIPTION_PERSISTENCE_SEND_REQUEST = 0 , SUBSCRIPTION_PERSISTENCE_CREATED , SUBSCRIPTION_PERSISTENCE_RECREATED , SUBSCRIPTION_PERSISTENCE_REFRESHED }
enum	sip_publish_type {   SIP_PUBLISH_UNKNOWN , SIP_PUBLISH_INITIAL , SIP_PUBLISH_REFRESH , SIP_PUBLISH_MODIFY ,   SIP_PUBLISH_REMOVE }
	The types of PUBLISH messages defined in RFC 3903. More...
enum	sip_subscription_tree_state { SIP_SUB_TREE_NORMAL = 0 , SIP_SUB_TREE_TERMINATE_PENDING , SIP_SUB_TREE_TERMINATE_IN_PROGRESS , SIP_SUB_TREE_TERMINATED }
	The state of the subscription tree. More...

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	add_rlmi_resource (pj_pool_t *pool, pj_xml_node *rlmi, const pjsip_generic_string_hdr *cid, const char *resource_name, const pjsip_sip_uri *resource_uri, pjsip_evsub_state state)
	Add a resource XML element to an RLMI body. More...
static void	add_subscription (struct sip_subscription_tree *obj)
static struct body_part *	allocate_body_part (pj_pool_t *pool, const struct ast_sip_subscription *sub)
	Allocate and initialize a body part structure. More...
static struct ast_sip_subscription *	allocate_subscription (const struct ast_sip_subscription_handler *handler, const char *resource, const char *display_name, struct sip_subscription_tree *tree)
static struct sip_subscription_tree *	allocate_subscription_tree (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
static int	allocate_tdata_buffer (pjsip_tx_data *tdata)
	Pre-allocate a buffer for the transmission. More...
static int	ami_show_resource_lists (struct mansession *s, const struct message *m)
static int	ami_show_subscriptions_inbound (struct mansession *s, const struct message *m)
static int	ami_show_subscriptions_outbound (struct mansession *s, const struct message *m)
static int	ami_subscription_detail (struct sip_subscription_tree *sub_tree, struct ast_sip_ami *ami, const char *event)
static int	ami_subscription_detail_inbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	ami_subscription_detail_outbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	apply_list_configuration (struct ast_sorcery *sorcery)
struct ast_module *	AST_MODULE_SELF_SYM (void)
struct ast_sip_subscription *	ast_sip_create_subscription (const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, const char *resource)
	Create a new ast_sip_subscription structure. More...
int	ast_sip_publication_add_datastore (struct ast_sip_publication *publication, struct ast_datastore *datastore)
	Add a datastore to a SIP publication. More...
struct ast_datastore *	ast_sip_publication_get_datastore (struct ast_sip_publication *publication, const char *name)
	Retrieve a publication datastore. More...
struct ao2_container *	ast_sip_publication_get_datastores (const struct ast_sip_publication *publication)
	Get the datastores container for a publication. More...
struct ast_sip_endpoint *	ast_sip_publication_get_endpoint (struct ast_sip_publication *pub)
	Given a publication, get the associated endpoint. More...
const char *	ast_sip_publication_get_event_configuration (const struct ast_sip_publication *pub)
	Given a publication, get the configuration name for the event type in use. More...
const char *	ast_sip_publication_get_resource (const struct ast_sip_publication *pub)
	Given a publication, get the resource the publication is to. More...
void	ast_sip_publication_remove_datastore (struct ast_sip_publication *publication, const char *name)
	Remove a publication datastore from the publication. More...
int	ast_sip_pubsub_generate_body_content (const char *type, const char *subtype, struct ast_sip_body_data *data, struct ast_str **str)
	Generate body content for a PUBLISH or NOTIFY. More...
static int	ast_sip_pubsub_has_eventlist_support (pjsip_rx_data *rdata)
	Check if the rdata has a Supported header containing 'eventlist'. More...
int	ast_sip_pubsub_is_body_generator_registered (const char *type, const char *subtype)
	Is a body generator registered for the given type/subtype. More...
int	ast_sip_pubsub_register_body_generator (struct ast_sip_pubsub_body_generator *generator)
	Register a body generator with the pubsub core. More...
int	ast_sip_pubsub_register_body_supplement (struct ast_sip_pubsub_body_supplement *supplement)
	Register a body generator with the pubsub core. More...
void	ast_sip_pubsub_unregister_body_generator (struct ast_sip_pubsub_body_generator *generator)
	Unregister a body generator with the pubsub core. More...
void	ast_sip_pubsub_unregister_body_supplement (struct ast_sip_pubsub_body_supplement *supplement)
	Unregister a body generator with the pubsub core. More...
int	ast_sip_register_publish_handler (struct ast_sip_publish_handler *handler)
	Register a publish handler. More...
int	ast_sip_register_subscription_handler (struct ast_sip_subscription_handler *handler)
	Register a subscription handler. More...
int	ast_sip_subscription_add_datastore (struct ast_sip_subscription *subscription, struct ast_datastore *datastore)
	Add a datastore to a SIP subscription. More...
struct ast_datastore *	ast_sip_subscription_alloc_datastore (const struct ast_datastore_info *info, const char *uid)
	Alternative for ast_datastore_alloc() More...
void	ast_sip_subscription_destroy (struct ast_sip_subscription *sub)
	Alert the pubsub core that the subscription is ready for destruction. More...
const char *	ast_sip_subscription_get_body_subtype (struct ast_sip_subscription *sub)
	Get the body subtype used for this subscription. More...
const char *	ast_sip_subscription_get_body_type (struct ast_sip_subscription *sub)
	Get the body type used for this subscription. More...
struct ast_datastore *	ast_sip_subscription_get_datastore (struct ast_sip_subscription *subscription, const char *name)
	Retrieve a subscription datastore. More...
struct ao2_container *	ast_sip_subscription_get_datastores (const struct ast_sip_subscription *subscription)
	Get the datastores container for a subscription. More...
pjsip_dialog *	ast_sip_subscription_get_dialog (struct ast_sip_subscription *sub)
	Get the pjsip dialog that is associated with this subscription. More...
struct ast_sip_endpoint *	ast_sip_subscription_get_endpoint (struct ast_sip_subscription *sub)
	Get the endpoint that is associated with this subscription. More...
void *	ast_sip_subscription_get_header (const struct ast_sip_subscription *sub, const char *header)
	Get a header value for a subscription. More...
void	ast_sip_subscription_get_local_uri (struct ast_sip_subscription *sub, char *buf, size_t size)
	Retrieve the local URI for this subscription. More...
const struct ast_json *	ast_sip_subscription_get_persistence_data (const struct ast_sip_subscription *subscription)
	Retrieve persistence data for a subscription. More...
void	ast_sip_subscription_get_remote_uri (struct ast_sip_subscription *sub, char *buf, size_t size)
	Retrive the remote URI for this subscription. More...
const char *	ast_sip_subscription_get_resource_name (struct ast_sip_subscription *sub)
	Get the name of the subscribed resource. More...
struct ast_taskprocessor *	ast_sip_subscription_get_serializer (struct ast_sip_subscription *sub)
	Get the serializer for the subscription. More...
pjsip_sip_uri *	ast_sip_subscription_get_sip_uri (struct ast_sip_subscription *sub)
	Retrieve the local sip uri for this subscription. More...
int	ast_sip_subscription_is_terminated (const struct ast_sip_subscription *sub)
	Get whether the subscription has been terminated or not. More...
int	ast_sip_subscription_notify (struct ast_sip_subscription *sub, struct ast_sip_body_data *notify_data, int terminate)
	Notify a SIP subscription of a state change. More...
void	ast_sip_subscription_remove_datastore (struct ast_sip_subscription *subscription, const char *name)
	Remove a subscription datastore from the subscription. More...
void	ast_sip_subscription_set_persistence_data (struct ast_sip_subscription *subscription, struct ast_json *persistence_data)
	Set persistence data for a subscription. More...
void	ast_sip_unregister_publish_handler (struct ast_sip_publish_handler *handler)
	Unregister a publish handler. More...
void	ast_sip_unregister_subscription_handler (struct ast_sip_subscription_handler *handler)
	Unregister a subscription handler. More...
static void	build_body_part (pj_pool_t *pool, struct ast_sip_subscription *sub, struct body_part_list *parts, unsigned int use_full_state)
	Create a multipart body part for a subscribed resource. More...
static void	build_node_children (struct ast_sip_endpoint *endpoint, const struct ast_sip_subscription_handler *handler, struct resource_list *list, struct tree_node *parent, struct resources *visited, pjsip_rx_data *rdata)
	Build child nodes for a given parent. More...
static int	build_resource_tree (struct ast_sip_endpoint *endpoint, const struct ast_sip_subscription_handler *handler, const char *resource, struct resource_tree *tree, int has_eventlist_support, pjsip_rx_data *rdata)
	Build a resource tree. More...
static pjsip_multipart_part *	build_rlmi_body (pj_pool_t *pool, struct ast_sip_subscription *sub, struct body_part_list *body_parts, unsigned int full_state)
	Create an RLMI body part for a multipart resource list body. More...
static void	clean_sub_tree (pjsip_evsub *evsub)
	Callback sequence for subscription terminate: More...
static char *	cli_complete_subscription_callid (struct ast_cli_args *a)
static int	cli_complete_subscription_common (struct sip_subscription_tree *sub_tree, struct cli_sub_complete_parms *cli)
static int	cli_complete_subscription_inbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	cli_complete_subscription_outbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	cli_list_subscriptions_detail (struct sip_subscription_tree *sub_tree, struct cli_sub_parms *cli)
static int	cli_list_subscriptions_inbound (struct sip_subscription_tree *sub_tree, void *arg)
static char *	cli_list_subscriptions_inout (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	cli_list_subscriptions_outbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	cli_show_subscription_common (struct sip_subscription_tree *sub_tree, struct cli_sub_parms *cli)
static int	cli_show_subscription_inbound (struct sip_subscription_tree *sub_tree, void *arg)
static char *	cli_show_subscription_inout (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	cli_show_subscription_outbound (struct sip_subscription_tree *sub_tree, void *arg)
static int	cli_show_subscriptions_detail (struct sip_subscription_tree *sub_tree, struct cli_sub_parms *cli)
static int	cli_show_subscriptions_inbound (struct sip_subscription_tree *sub_tree, void *arg)
static char *	cli_show_subscriptions_inout (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	cli_show_subscriptions_outbound (struct sip_subscription_tree *sub_tree, void *arg)
static unsigned int	cli_subscription_expiry (struct sip_subscription_tree *sub_tree)
static int	cmp_strings (char *s1, char *s2)
	Compare strings for equality checking for NULL. More...
static int	cmp_subscription_childrens (struct ast_sip_subscription *s1, struct ast_sip_subscription *s2)
	compares the childrens of two ast_sip_subscription s1 and s2 More...
static pjsip_msg_body *	create_multipart_body (pj_pool_t *pool)
	Create and initialize the PJSIP multipart body structure for a resource list subscription. More...
static pjsip_require_hdr *	create_require_eventlist (pj_pool_t *pool)
	Shortcut method to create a Require: eventlist header. More...
static struct sip_subscription_tree *	create_subscription_tree (const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *resource, struct ast_sip_pubsub_body_generator *generator, struct resource_tree *tree, pj_status_t *dlg_status, struct subscription_persistence *persistence)
	Create a subscription tree based on a resource tree. More...
static struct ast_sip_subscription *	create_virtual_subscriptions (const struct ast_sip_subscription_handler *handler, const char *resource, struct ast_sip_pubsub_body_generator *generator, struct sip_subscription_tree *tree, struct tree_node *current)
	Create a tree of virtual subscriptions based on a resource tree node. More...
static void	destroy_subscription (struct ast_sip_subscription *sub)
static void	destroy_subscriptions (struct ast_sip_subscription *root)
static int	destroy_subscriptions_task (void *obj)
static enum sip_publish_type	determine_sip_publish_type (pjsip_rx_data *rdata, pjsip_generic_string_hdr *etag_hdr, unsigned int *expires, int *entity_id)
static int	exceptional_accept (const pj_str_t *accept)
	Is the Accept header from the SUBSCRIBE in the list of exceptions? More...
static struct ast_sip_pubsub_body_generator *	find_body_generator (char accept[AST_SIP_MAX_ACCEPT][64], size_t num_accept, const char *body_type)
static struct ast_sip_pubsub_body_generator *	find_body_generator_accept (const char *accept)
static struct ast_sip_pubsub_body_generator *	find_body_generator_type_subtype (const char *type, const char *subtype)
static struct ast_sip_pubsub_body_generator *	find_body_generator_type_subtype_nolock (const char *type, const char *subtype)
static struct ast_sip_publish_handler *	find_pub_handler (const char *event)
static struct ast_sip_subscription_handler *	find_sub_handler_for_event_name (const char *event_name)
static int	for_each_subscription (on_subscription_t on_subscription, void *arg)
static int	format_ami_resource_lists (void *obj, void *arg, int flags)
static void	free_body_parts (struct body_part_list *parts)
	Destroy a list of body parts. More...
static pjsip_generic_string_hdr *	generate_content_id_hdr (pj_pool_t *pool, const struct ast_sip_subscription *sub)
	Create a Content-ID header. More...
static int	generate_initial_notify (struct ast_sip_subscription *sub)
static pjsip_msg_body *	generate_list_body (pj_pool_t *pool, struct ast_sip_subscription *sub, unsigned int force_full_state)
	Create a resource list body for NOTIFY requests. More...
static pjsip_msg_body *	generate_notify_body (pj_pool_t *pool, struct ast_sip_subscription *root, unsigned int force_full_state)
	Create the body for a NOTIFY request. More...
static int	have_visited (const char *resource, struct resources *visited)
	Determine if this resource has been visited already. More...
static int	initial_notify_task (void *obj)
static int	item_in_vector (const struct resource_list *list, const char *item)
static int	list_item_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	list_item_to_str (const void *obj, const intptr_t *args, char **buf)
static int	load_module (void)
static int	parse_simple_message_summary (char *body, struct simple_message_summary *summary)
static int	persistence_endpoint_str2struct (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	persistence_endpoint_struct2str (const void *obj, const intptr_t *args, char **buf)
static int	persistence_expires_str2struct (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	persistence_expires_struct2str (const void *obj, const intptr_t *args, char **buf)
static int	persistence_generator_data_str2struct (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	persistence_generator_data_struct2str (const void *obj, const intptr_t *args, char **buf)
static int	persistence_tag_str2struct (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	persistence_tag_struct2str (const void *obj, const intptr_t *args, char **buf)
static int	publication_cmp_fn (void *obj, void *arg, int flags)
static void	publication_destroy_fn (void *obj)
	Internal destructor for publications. More...
static int	publication_hash_fn (const void *obj, const int flags)
static void *	publication_resource_alloc (const char *name)
	Allocator for publication resource. More...
static void	publication_resource_destroy (void *obj)
	Destructor for publication resource. More...
static void	publish_add_handler (struct ast_sip_publish_handler *handler)
static int	publish_expire (const void *data)
static int	publish_expire_callback (void *data)
static struct ast_sip_publication *	publish_request_initial (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, struct ast_sip_publish_handler *handler)
static void	pubsub_on_client_refresh (pjsip_evsub *sub)
static void	pubsub_on_evsub_state (pjsip_evsub *evsub, pjsip_event *event)
	PJSIP callback when underlying SIP subscription changes state. More...
static int	pubsub_on_refresh_timeout (void *userdata)
static pj_bool_t	pubsub_on_rx_mwi_notify_request (pjsip_rx_data *rdata)
static void	pubsub_on_rx_notify (pjsip_evsub *sub, pjsip_rx_data *rdata, int *p_st_code, pj_str_t **p_st_text, pjsip_hdr *res_hdr, pjsip_msg_body **p_body)
static pj_bool_t	pubsub_on_rx_notify_request (pjsip_rx_data *rdata)
static pj_bool_t	pubsub_on_rx_publish_request (pjsip_rx_data *rdata)
static void	pubsub_on_rx_refresh (pjsip_evsub *evsub, pjsip_rx_data *rdata, int *p_st_code, pj_str_t **p_st_text, pjsip_hdr *res_hdr, pjsip_msg_body **p_body)
	Called whenever an in-dialog SUBSCRIBE is received. More...
static pj_bool_t	pubsub_on_rx_request (pjsip_rx_data *rdata)
	Opaque structure representing an RFC 3265 SIP subscription. More...
static pj_bool_t	pubsub_on_rx_subscribe_request (pjsip_rx_data *rdata)
static void	pubsub_on_server_timeout (pjsip_evsub *sub)
static void	remove_subscription (struct sip_subscription_tree *obj)
static int	resource_endpoint_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	resource_event_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
static void *	resource_list_alloc (const char *name)
static int	resource_list_apply_handler (const struct ast_sorcery *sorcery, void *obj)
static void	resource_list_destructor (void *obj)
static void	resource_tree_destroy (struct resource_tree *tree)
	Destroy a resource tree. More...
static struct resource_list *	retrieve_resource_list (const char *resource, const char *event)
	Helper function for retrieving a resource list for a given event. More...
static void *	rlmi_clone_data (pj_pool_t *pool, const void *data, unsigned len)
static int	rlmi_print_body (struct pjsip_msg_body *msg_body, char *buf, pj_size_t size)
static int	sched_cb (const void *data)
static int	schedule_notification (struct sip_subscription_tree *sub_tree)
static int	send_notify (struct sip_subscription_tree *sub_tree, unsigned int force_full_state)
	Send a NOTIFY request to a subscriber. More...
static int	serialized_pubsub_on_client_refresh (void *userdata)
static int	serialized_pubsub_on_refresh_timeout (void *userdata)
static int	serialized_send_notify (void *userdata)
static void	set_state_terminated (struct ast_sip_subscription *sub)
static void	shutdown_subscriptions (struct ast_sip_subscription *sub)
static struct ast_sip_publication *	sip_create_publication (struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *resource, const char *event_configuration_name)
static int	sip_publication_respond (struct ast_sip_publication *pub, int status_code, pjsip_rx_data *rdata)
static int	sip_subscription_accept (struct sip_subscription_tree *sub_tree, pjsip_rx_data *rdata, int response)
static int	sip_subscription_send_request (struct sip_subscription_tree *sub_tree, pjsip_tx_data *tdata)
static void	sip_subscription_to_ami (struct sip_subscription_tree *sub_tree, struct ast_str **buf)
static void	sub_add_handler (struct ast_sip_subscription_handler *handler)
static int	sub_persistence_recreate (void *obj)
static int	sub_tree_subscription_terminate_cb (void *data)
static void	sub_tree_transport_cb (void *data)
static struct ast_sip_pubsub_body_generator *	subscription_get_generator_from_rdata (pjsip_rx_data *rdata, const struct ast_sip_subscription_handler *handler)
	Retrieve a body generator using the Accept header of an rdata message. More...
static struct ast_sip_subscription_handler *	subscription_get_handler_from_rdata (pjsip_rx_data *rdata, const char *endpoint)
	Retrieve a handler using the Event header of an rdata message. More...
static void *	subscription_persistence_alloc (const char *name)
	Allocator for subscription persistence. More...
static struct subscription_persistence *	subscription_persistence_create (struct sip_subscription_tree *sub_tree)
	Function which creates initial persistence information of a subscription in sorcery. More...
static void	subscription_persistence_destroy (void *obj)
	Destructor for subscription persistence. More...
static void	subscription_persistence_event_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
	Event callback which fires subscription persistence recreation when the system is fully booted. More...
static int	subscription_persistence_load (void *data)
	Function which loads and recreates persisted subscriptions upon startup when the system is fully booted. More...
static int	subscription_persistence_recreate (void *obj, void *arg, int flags)
	Callback function to perform the actual recreation of a subscription. More...
static void	subscription_persistence_remove (struct sip_subscription_tree *sub_tree)
	Function which removes persistence of a subscription from sorcery. More...
static void	subscription_persistence_update (struct sip_subscription_tree *sub_tree, pjsip_rx_data *rdata, enum sip_persistence_update_type type)
	Function which updates persistence information of a subscription in sorcery. More...
static void	subscription_setup_dialog (struct sip_subscription_tree *sub_tree, pjsip_dialog *dlg)
static void	subscription_tree_destructor (void *obj)
static int	subscription_unreference_dialog (void *obj)
static struct tree_node *	tree_node_alloc (const char *resource, struct resources *visited, unsigned int full_state, const char *display_name)
	Allocate a tree node. More...
static void	tree_node_destroy (struct tree_node *node)
	Destructor for a tree node. More...
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "PJSIP event resource" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_pjsip", }
const char *	accept_exceptions []
	Accept headers that are exceptions to the rule. More...
static const struct ast_module_info *	ast_module_info = &__mod_info
struct body_generators	body_generators = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
struct body_supplements	body_supplements = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static struct ast_cli_entry	cli_commands []
static int	esc_etag_counter
const pjsip_method	pjsip_publish_method
	Defined method for PUBLISH. More...
struct publish_handlers	publish_handlers = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static pjsip_evsub_user	pubsub_cb
static struct pjsip_module	pubsub_module
static pjsip_media_type	rlmi_media_type
static struct ast_sched_context *	sched
	Scheduler used for automatically expiring publications. More...
static const char *	sip_subscription_roles_map []
static const pj_str_t	str_event_name = { "Event", 5 }
static char *	sub_tree_state_description []
struct subscription_handlers	subscription_handlers = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
struct subscriptions	subscriptions = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

Macro Definition Documentation

AMI_SHOW_SUBSCRIPTIONS_INBOUND

#define AMI_SHOW_SUBSCRIPTIONS_INBOUND   "PJSIPShowSubscriptionsInbound"

Definition at line 4374 of file res_pjsip_pubsub.c.

AMI_SHOW_SUBSCRIPTIONS_OUTBOUND

#define AMI_SHOW_SUBSCRIPTIONS_OUTBOUND   "PJSIPShowSubscriptionsOutbound"

Definition at line 4375 of file res_pjsip_pubsub.c.

CLI_LIST_SUB_FORMAT_ENTRY

#define CLI_LIST_SUB_FORMAT_ENTRY   "%-30.30s %-30.30s %6d %s\n"

Definition at line 4761 of file res_pjsip_pubsub.c.

CLI_LIST_SUB_FORMAT_HEADER

#define CLI_LIST_SUB_FORMAT_HEADER   "%-30.30s %-30.30s %6.6s %s\n"

Definition at line 4760 of file res_pjsip_pubsub.c.

CLI_SHOW_SUB_FORMAT_ENTRY

#define CLI_SHOW_SUB_FORMAT_ENTRY

Value:

    "Endpoint: %s/%s\n" \
    "Resource: %s/%s\n" \
    "  Expiry: %8d  %s\n\n"

Definition at line 4618 of file res_pjsip_pubsub.c.

CLI_SHOW_SUB_FORMAT_HEADER

#define CLI_SHOW_SUB_FORMAT_HEADER

Value:

    "Endpoint: <Endpoint/Caller-ID.............................................>\n" \
    "Resource: <Resource/Event.................................................>\n" \
    "  Expiry: <Expiry>  <Call-id..............................................>\n" \
    "===========================================================================\n\n"

Definition at line 4613 of file res_pjsip_pubsub.c.

DATASTORE_BUCKETS

#define DATASTORE_BUCKETS   53

Number of buckets for subscription datastore.

Definition at line 259 of file res_pjsip_pubsub.c.

DEFAULT_EXPIRES

#define DEFAULT_EXPIRES   3600

Default expiration for subscriptions.

Definition at line 262 of file res_pjsip_pubsub.c.

DEFAULT_PUBLISH_EXPIRES

#define DEFAULT_PUBLISH_EXPIRES   3600

Default expiration time for PUBLISH if one is not specified.

Definition at line 256 of file res_pjsip_pubsub.c.

MAX_REGEX_ERROR_LEN

#define MAX_REGEX_ERROR_LEN   128

Definition at line 4377 of file res_pjsip_pubsub.c.

MOD_DATA_MSG

#define MOD_DATA_MSG   "sub_msg"

Definition at line 245 of file res_pjsip_pubsub.c.

MOD_DATA_PERSISTENCE

#define MOD_DATA_PERSISTENCE   "sub_persistence"

Definition at line 244 of file res_pjsip_pubsub.c.

NEW_SUBSCRIBE

#define NEW_SUBSCRIBE	(		notifier,
			endpoint,
			resource,
			rdata
	)		notifier->new_subscribe_with_rdata ? notifier->new_subscribe_with_rdata(endpoint, resource, rdata) : notifier->new_subscribe(endpoint, resource)

Definition at line 1021 of file res_pjsip_pubsub.c.

PUBLICATIONS_BUCKETS

#define PUBLICATIONS_BUCKETS   37

Number of buckets for publications (on a per handler)

Definition at line 253 of file res_pjsip_pubsub.c.

RESOURCE_LIST_INIT_SIZE

#define RESOURCE_LIST_INIT_SIZE   4

Definition at line 4993 of file res_pjsip_pubsub.c.

Typedef Documentation

on_subscription_t

typedef int(* on_subscription_t) (struct sip_subscription_tree *sub, void *arg)

Definition at line 1839 of file res_pjsip_pubsub.c.

Enumeration Type Documentation

sip_persistence_update_type

enum sip_persistence_update_type

Enumerator
SUBSCRIPTION_PERSISTENCE_SEND_REQUEST	Called from send request
SUBSCRIPTION_PERSISTENCE_CREATED	Subscription created from initial client request
SUBSCRIPTION_PERSISTENCE_RECREATED	Subscription recreated by asterisk on startup
SUBSCRIPTION_PERSISTENCE_REFRESHED	Subscription created from client refresh

Definition at line 540 of file res_pjsip_pubsub.c.

                                 {
    /*! Called from send request */
    SUBSCRIPTION_PERSISTENCE_SEND_REQUEST = 0,
    /*! Subscription created from initial client request */
    SUBSCRIPTION_PERSISTENCE_CREATED,
    /*! Subscription recreated by asterisk on startup */
    SUBSCRIPTION_PERSISTENCE_RECREATED,
    /*! Subscription created from client refresh */
    SUBSCRIPTION_PERSISTENCE_REFRESHED,
};

sip_publish_type

enum sip_publish_type

The types of PUBLISH messages defined in RFC 3903.

Enumerator
SIP_PUBLISH_UNKNOWN	Unknown. This actually is not defined in RFC 3903. We use this as a constant to indicate that an incoming PUBLISH does not fit into any of the other categories and is thus invalid.
SIP_PUBLISH_INITIAL	Initial. The first PUBLISH sent. This will contain a non-zero Expires header as well as a body that indicates the current state of the endpoint that has sent the message. The initial PUBLISH is the only type of PUBLISH to not contain a Sip-If-Match header in it.
SIP_PUBLISH_REFRESH	Refresh. Used to keep a published state from expiring. This will contain a non-zero Expires header but no body since its purpose is not to update state.
SIP_PUBLISH_MODIFY	Modify. Used to change state from its previous value. This will contain a body updating the published state. May or may not contain an Expires header.
SIP_PUBLISH_REMOVE	Remove. Used to remove published state from an ESC. This will contain an Expires header set to 0 and likely no body.

Definition at line 274 of file res_pjsip_pubsub.c.

                      {
    /*!
     * \brief Unknown
     *
     * \details
     * This actually is not defined in RFC 3903. We use this as a constant
     * to indicate that an incoming PUBLISH does not fit into any of the
     * other categories and is thus invalid.
     */
    SIP_PUBLISH_UNKNOWN,
 
    /*!
     * \brief Initial
     *
     * \details
     * The first PUBLISH sent. This will contain a non-zero Expires header
     * as well as a body that indicates the current state of the endpoint
     * that has sent the message. The initial PUBLISH is the only type
     * of PUBLISH to not contain a Sip-If-Match header in it.
     */
    SIP_PUBLISH_INITIAL,
 
    /*!
     * \brief Refresh
     *
     * \details
     * Used to keep a published state from expiring. This will contain a
     * non-zero Expires header but no body since its purpose is not to
     * update state.
     */
    SIP_PUBLISH_REFRESH,
 
    /*!
     * \brief Modify
     *
     * \details
     * Used to change state from its previous value. This will contain
     * a body updating the published state. May or may not contain an
     * Expires header.
     */
    SIP_PUBLISH_MODIFY,
 
    /*!
     * \brief Remove
     *
     * \details
     * Used to remove published state from an ESC. This will contain
     * an Expires header set to 0 and likely no body.
     */
    SIP_PUBLISH_REMOVE,
};

sip_subscription_tree_state

enum sip_subscription_tree_state

The state of the subscription tree.

Enumerator
SIP_SUB_TREE_NORMAL	Normal operation
SIP_SUB_TREE_TERMINATE_PENDING	A terminate has been requested by Asterisk, the client, or pjproject
SIP_SUB_TREE_TERMINATE_IN_PROGRESS	The terminate is in progress
SIP_SUB_TREE_TERMINATED	The terminate process has finished and the subscription tree is no longer valid

Definition at line 415 of file res_pjsip_pubsub.c.

                                 {
    /*! Normal operation */
    SIP_SUB_TREE_NORMAL = 0,
    /*! A terminate has been requested by Asterisk, the client, or pjproject */
    SIP_SUB_TREE_TERMINATE_PENDING,
    /*! The terminate is in progress */
    SIP_SUB_TREE_TERMINATE_IN_PROGRESS,
    /*! The terminate process has finished and the subscription tree is no longer valid */
    SIP_SUB_TREE_TERMINATED,
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 5960 of file res_pjsip_pubsub.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 5960 of file res_pjsip_pubsub.c.

add_rlmi_resource()

static void add_rlmi_resource ( pj_pool_t *  pool, pj_xml_node *  rlmi, const pjsip_generic_string_hdr *  cid, const char *  resource_name, const pjsip_sip_uri *  resource_uri, pjsip_evsub_state  state  )

static

Add a resource XML element to an RLMI body.

Each resource element represents a subscribed resource in the list. This function currently will unconditionally add an instance element to each created resource element. Instance elements refer to later parts in the multipart body.

Parameters

pool	PJLIB allocation pool
rlmi
cid	Content-ID header of the resource
resource_name	Name of the resource
resource_uri	URI of the resource
state	State of the subscribed resource

Definition at line 2071 of file res_pjsip_pubsub.c.

{
    static pj_str_t cid_name = { "cid", 3 };
    pj_xml_node *resource;
    pj_xml_node *name;
    pj_xml_node *instance;
    pj_xml_attr *cid_attr;
    char id[6];
    char uri[PJSIP_MAX_URL_SIZE];
    char name_sanitized[PJSIP_MAX_URL_SIZE];
 
    /* This creates a string representing the Content-ID without the enclosing < > */
    const pj_str_t cid_stripped = {
        .ptr = cid->hvalue.ptr + 1,
        .slen = cid->hvalue.slen - 2,
    };
 
    resource = ast_sip_presence_xml_create_node(pool, rlmi, "resource");
    name = ast_sip_presence_xml_create_node(pool, resource, "name");
    instance = ast_sip_presence_xml_create_node(pool, resource, "instance");
 
    pjsip_uri_print(PJSIP_URI_IN_CONTACT_HDR, resource_uri, uri, sizeof(uri));
    ast_sip_presence_xml_create_attr(pool, resource, "uri", uri);
 
    ast_sip_sanitize_xml(resource_name, name_sanitized, sizeof(name_sanitized));
    pj_strdup2(pool, &name->content, name_sanitized);
 
    ast_generate_random_string(id, sizeof(id));
 
    ast_sip_presence_xml_create_attr(pool, instance, "id", id);
    ast_sip_presence_xml_create_attr(pool, instance, "state",
            state == PJSIP_EVSUB_STATE_TERMINATED ? "terminated" : "active");
 
    /* Use the PJLIB-util XML library directly here since we are using a
     * pj_str_t
     */
 
    cid_attr = pj_xml_attr_new(pool, &cid_name, &cid_stripped);
    pj_xml_add_attr(instance, cid_attr);
}

References ast_generate_random_string(), ast_sip_presence_xml_create_attr(), ast_sip_presence_xml_create_node(), ast_sip_sanitize_xml(), and name.

Referenced by build_rlmi_body().

add_subscription()

static void add_subscription ( struct sip_subscription_tree *  obj )

static

Definition at line 1204 of file res_pjsip_pubsub.c.

{
    AST_RWLIST_WRLOCK(&subscriptions);
    AST_RWLIST_INSERT_TAIL(&subscriptions, obj, next);
    AST_RWLIST_UNLOCK(&subscriptions);
}

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by ast_sip_create_subscription(), and create_subscription_tree().

allocate_body_part()

static struct body_part * allocate_body_part ( pj_pool_t *  pool, const struct ast_sip_subscription *  sub  )

static

Allocate and initialize a body part structure.

Parameters

pool	PJLIB allocation pool
sub	Subscription representing a subscribed resource

Definition at line 2279 of file res_pjsip_pubsub.c.

{
    struct body_part *bp;
 
    bp = ast_calloc(1, sizeof(*bp));
    if (!bp) {
        return NULL;
    }
 
    bp->cid = generate_content_id_hdr(pool, sub);
    bp->resource = sub->resource;
    bp->state = sub->subscription_state;
    bp->uri = sub->uri;
    bp->display_name = sub->display_name;
 
    return bp;
}

References ast_calloc, body_part::cid, body_part::display_name, generate_content_id_hdr(), NULL, body_part::resource, body_part::state, sub, and body_part::uri.

Referenced by build_body_part().

allocate_subscription()

static struct ast_sip_subscription * allocate_subscription ( const struct ast_sip_subscription_handler *  handler, const char *  resource, const char *  display_name, struct sip_subscription_tree *  tree  )

static

Definition at line 1263 of file res_pjsip_pubsub.c.

{
    struct ast_sip_subscription *sub;
    pjsip_msg *msg;
    pjsip_sip_uri *request_uri;
 
    msg = ast_sip_mod_data_get(tree->dlg->mod_data, pubsub_module.id, MOD_DATA_MSG);
    if (!msg) {
        ast_log(LOG_ERROR, "No dialog message saved for SIP subscription. Cannot allocate subscription for resource %s\n", resource);
        return NULL;
    }
 
    sub = ast_calloc(1, sizeof(*sub) + strlen(resource) + 1);
    if (!sub) {
        return NULL;
    }
    strcpy(sub->resource, resource); /* Safe */
 
    sub->display_name = ast_strdup(display_name);
 
    sub->datastores = ast_datastores_alloc();
    if (!sub->datastores) {
        destroy_subscription(sub);
        return NULL;
    }
 
    sub->body_text = ast_str_create(128);
    if (!sub->body_text) {
        destroy_subscription(sub);
        return NULL;
    }
 
    sub->uri = pjsip_sip_uri_create(tree->dlg->pool, PJ_FALSE);
    request_uri = pjsip_uri_get_uri(msg->line.req.uri);
    pjsip_sip_uri_assign(tree->dlg->pool, sub->uri, request_uri);
    pj_strdup2(tree->dlg->pool, &sub->uri->user, resource);
 
    /* If there is any persistence information available for this subscription that was persisted
     * then make it available so that the NOTIFY has the correct state.
     */
 
    if (tree->persistence && tree->persistence->generator_data) {
        sub->persistence_data = ast_json_ref(ast_json_object_get(tree->persistence->generator_data, resource));
    }
 
    sub->handler = handler;
    sub->subscription_state = PJSIP_EVSUB_STATE_ACTIVE;
    sub->tree = ao2_bump(tree);
 
    return sub;
}

References ao2_bump, ast_calloc, ast_datastores_alloc(), ast_json_object_get(), ast_json_ref(), ast_log, ast_sip_mod_data_get, ast_str_create, ast_strdup, destroy_subscription(), ast_sip_subscription::display_name, sip_subscription_tree::dlg, subscription_persistence::generator_data, handler(), LOG_ERROR, MOD_DATA_MSG, NULL, sip_subscription_tree::persistence, pubsub_module, ast_sip_subscription::resource, sub, and ast_sip_subscription::tree.

Referenced by ast_sip_create_subscription(), and create_virtual_subscriptions().

allocate_subscription_tree()

static struct sip_subscription_tree * allocate_subscription_tree ( struct ast_sip_endpoint *  endpoint, pjsip_rx_data *  rdata  )

static

Definition at line 1445 of file res_pjsip_pubsub.c.

{
    struct sip_subscription_tree *sub_tree;
 
    sub_tree = ao2_alloc(sizeof *sub_tree, subscription_tree_destructor);
    if (!sub_tree) {
        return NULL;
    }
 
    ast_module_ref(ast_module_info->self);
 
    if (rdata) {
        /*
         * We must continue using the serializer that the original
         * SUBSCRIBE came in on for the dialog.  There may be
         * retransmissions already enqueued in the original
         * serializer that can result in reentrancy and message
         * sequencing problems.
         */
        sub_tree->serializer = ast_sip_get_distributor_serializer(rdata);
    } else {
        char tps_name[AST_TASKPROCESSOR_MAX_NAME + 1];
 
        /* Create name with seq number appended. */
        ast_taskprocessor_build_name(tps_name, sizeof(tps_name), "pjsip/pubsub/%s",
            ast_sorcery_object_get_id(endpoint));
 
        sub_tree->serializer = ast_sip_create_serializer(tps_name);
    }
    if (!sub_tree->serializer) {
        ao2_ref(sub_tree, -1);
        return NULL;
    }
 
    sub_tree->endpoint = ao2_bump(endpoint);
    sub_tree->notify_sched_id = -1;
 
    return sub_tree;
}

References ao2_alloc, ao2_bump, ao2_ref, ast_module_ref, ast_sip_create_serializer(), ast_sip_get_distributor_serializer(), ast_sorcery_object_get_id(), ast_taskprocessor_build_name(), AST_TASKPROCESSOR_MAX_NAME, sip_subscription_tree::endpoint, sip_subscription_tree::notify_sched_id, NULL, ast_module_info::self, sip_subscription_tree::serializer, and subscription_tree_destructor().

Referenced by ast_sip_create_subscription(), and create_subscription_tree().

allocate_tdata_buffer()

static int allocate_tdata_buffer ( pjsip_tx_data *  tdata )

static

Pre-allocate a buffer for the transmission.

Typically, we let PJSIP do this step for us when we send a request. PJSIP's buffer allocation algorithm is to allocate a buffer of PJSIP_MAX_PKT_LEN bytes and attempt to write the packet to the allocated buffer. If the buffer is too small to hold the packet, then we get told the message is too long to be sent.

When dealing with SIP NOTIFY, especially with RLS, it is possible to exceed PJSIP_MAX_PKT_LEN. Rather than accepting the limitation imposed on us by default, we instead take the strategy of pre-allocating the buffer, testing for ourselves if the message will fit, and resizing the buffer as required.

The limit we impose is double that of the maximum packet length.

Parameters

tdata

The tdata onto which to allocate a buffer

Return values

0	Success
-1	The message is too large

Definition at line 2008 of file res_pjsip_pubsub.c.

{
    int buf_size;
    int size = -1;
    char *buf;
 
    for (buf_size = PJSIP_MAX_PKT_LEN; size == -1 && buf_size < (PJSIP_MAX_PKT_LEN * 2); buf_size *= 2) {
        buf = pj_pool_alloc(tdata->pool, buf_size);
        size = pjsip_msg_print(tdata->msg, buf, buf_size);
    }
 
    if (size == -1) {
        return -1;
    }
 
    tdata->buf.start = buf;
    tdata->buf.cur = tdata->buf.start;
    tdata->buf.end = tdata->buf.start + buf_size;
 
    return 0;
}

References buf.

Referenced by sip_subscription_send_request().

ami_show_resource_lists()

static int ami_show_resource_lists ( struct mansession *  s, const struct message *  m  )

static

Definition at line 4351 of file res_pjsip_pubsub.c.

{
    struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
    struct ao2_container *lists;
 
    lists = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "resource_list",
            AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
 
    if (!lists || !ao2_container_count(lists)) {
        astman_send_error(s, m, "No resource lists found\n");
        return 0;
    }
 
    astman_send_listack(s, m, "A listing of resource lists follows, presented as ResourceListDetail events",
        "start");
 
    ao2_callback(lists, OBJ_NODATA, format_ami_resource_lists, &ami);
 
    astman_send_list_complete_start(s, m, "ResourceListDetailComplete", ami.count);
    astman_send_list_complete_end(s);
    return 0;
}

References ao2_callback, ao2_container_count(), AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), astman_get_header(), astman_send_error(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), ast_sip_ami::count, format_ami_resource_lists(), ast_sip_ami::m, NULL, OBJ_NODATA, and ast_sip_ami::s.

Referenced by load_module().

ami_show_subscriptions_inbound()

static int ami_show_subscriptions_inbound ( struct mansession *  s, const struct message *  m  )

static

Definition at line 4301 of file res_pjsip_pubsub.c.

{
    struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
 
    astman_send_listack(s, m, "Following are Events for each inbound Subscription",
        "start");
 
    for_each_subscription(ami_subscription_detail_inbound, &ami);
 
    astman_send_list_complete_start(s, m, "InboundSubscriptionDetailComplete", ami.count);
    astman_send_list_complete_end(s);
    return 0;
}

References ami_subscription_detail_inbound(), astman_get_header(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), ast_sip_ami::count, for_each_subscription(), ast_sip_ami::m, and ast_sip_ami::s.

Referenced by load_module().

ami_show_subscriptions_outbound()

static int ami_show_subscriptions_outbound ( struct mansession *  s, const struct message *  m  )

static

Definition at line 4315 of file res_pjsip_pubsub.c.

{
    struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
 
    astman_send_listack(s, m, "Following are Events for each outbound Subscription",
        "start");
 
    for_each_subscription(ami_subscription_detail_outbound, &ami);
 
    astman_send_list_complete_start(s, m, "OutboundSubscriptionDetailComplete", ami.count);
    astman_send_list_complete_end(s);
    return 0;
}

References ami_subscription_detail_outbound(), astman_get_header(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), ast_sip_ami::count, for_each_subscription(), ast_sip_ami::m, and ast_sip_ami::s.

Referenced by load_module().

ami_subscription_detail()

static int ami_subscription_detail ( struct sip_subscription_tree *  sub_tree, struct ast_sip_ami *  ami, const char *  event  )

static

Definition at line 4270 of file res_pjsip_pubsub.c.

{
    struct ast_str *buf;
 
    buf = ast_sip_create_ami_event(event, ami);
    if (!buf) {
        return -1;
    }
 
    sip_subscription_to_ami(sub_tree, &buf);
    astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
    ast_free(buf);
 
    ++ami->count;
    return 0;
}

References ast_free, ast_sip_create_ami_event(), ast_str_buffer(), astman_append(), buf, ast_sip_ami::count, ast_sip_ami::s, and sip_subscription_to_ami().

Referenced by ami_subscription_detail_inbound(), and ami_subscription_detail_outbound().

ami_subscription_detail_inbound()

static int ami_subscription_detail_inbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4289 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_NOTIFIER ? ami_subscription_detail(
        sub_tree, arg, "InboundSubscriptionDetail") : 0;
}

References ami_subscription_detail(), AST_SIP_NOTIFIER, and sip_subscription_tree::role.

Referenced by ami_show_subscriptions_inbound().

ami_subscription_detail_outbound()

static int ami_subscription_detail_outbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4295 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_SUBSCRIBER ? ami_subscription_detail(
        sub_tree, arg, "OutboundSubscriptionDetail") : 0;
}

References ami_subscription_detail(), AST_SIP_SUBSCRIBER, and sip_subscription_tree::role.

Referenced by ami_show_subscriptions_outbound().

apply_list_configuration()

static int apply_list_configuration ( struct ast_sorcery *  sorcery )

static

Definition at line 5100 of file res_pjsip_pubsub.c.

{
    ast_sorcery_apply_default(sorcery, "resource_list", "config",
            "pjsip.conf,criteria=type=resource_list");
    if (ast_sorcery_object_register(sorcery, "resource_list", resource_list_alloc,
                NULL, resource_list_apply_handler)) {
        return -1;
    }
 
    ast_sorcery_object_field_register(sorcery, "resource_list", "type", "",
            OPT_NOOP_T, 0, 0);
    ast_sorcery_object_field_register(sorcery, "resource_list", "event", "",
            OPT_CHAR_ARRAY_T, 1, CHARFLDSET(struct resource_list, event));
    ast_sorcery_object_field_register(sorcery, "resource_list", "full_state", "no",
            OPT_BOOL_T, 1, FLDSET(struct resource_list, full_state));
    ast_sorcery_object_field_register(sorcery, "resource_list", "notification_batch_interval",
            "0", OPT_UINT_T, 0, FLDSET(struct resource_list, notification_batch_interval));
    ast_sorcery_object_field_register_custom(sorcery, "resource_list", "list_item",
            "", list_item_handler, list_item_to_str, NULL, 0, 0);
    ast_sorcery_object_field_register(sorcery, "resource_list", "resource_display_name", "no",
            OPT_BOOL_T, 1, FLDSET(struct resource_list, resource_display_name));
 
    ast_sorcery_reload_object(sorcery, "resource_list");
 
    return 0;
}

References ast_sorcery_apply_default, ast_sorcery_object_field_register, ast_sorcery_object_field_register_custom, ast_sorcery_object_register, ast_sorcery_reload_object(), CHARFLDSET, FLDSET, resource_list::full_state, list_item_handler(), list_item_to_str(), resource_list::notification_batch_interval, NULL, OPT_BOOL_T, OPT_CHAR_ARRAY_T, OPT_NOOP_T, OPT_UINT_T, resource_list::resource_display_name, resource_list_alloc(), resource_list_apply_handler(), and sorcery.

Referenced by load_module().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 5960 of file res_pjsip_pubsub.c.

ast_sip_create_subscription()

struct ast_sip_subscription * ast_sip_create_subscription	(	const struct ast_sip_subscription_handler *	handler,
		struct ast_sip_endpoint *	endpoint,
		const char *	resource
	)

Create a new ast_sip_subscription structure.

When a subscriber wishes to create a subscription, it may call this function to allocate resources and to send the initial SUBSCRIBE out.

Parameters

handler	The subscriber that is making the request.
endpoint	The endpoint to whome the SUBSCRIBE will be sent.
resource	The resource to place in the SUBSCRIBE's Request-URI.

Definition at line 1909 of file res_pjsip_pubsub.c.

{
    struct ast_sip_subscription *sub;
    pjsip_dialog *dlg;
    struct ast_sip_contact *contact;
    pj_str_t event;
    pjsip_tx_data *tdata;
    pjsip_evsub *evsub;
    struct sip_subscription_tree *sub_tree = NULL;
 
    sub_tree = allocate_subscription_tree(endpoint, NULL);
    if (!sub_tree) {
        return NULL;
    }
 
    sub = allocate_subscription(handler, resource, NULL, sub_tree);
    if (!sub) {
        ao2_cleanup(sub_tree);
        return NULL;
    }
 
    contact = ast_sip_location_retrieve_contact_from_aor_list(endpoint->aors);
    if (!contact || ast_strlen_zero(contact->uri)) {
        ast_log(LOG_WARNING, "No contacts configured for endpoint %s. Unable to create SIP subsription\n",
                ast_sorcery_object_get_id(endpoint));
        ao2_ref(sub_tree, -1);
        ao2_cleanup(contact);
        return NULL;
    }
 
    dlg = ast_sip_create_dialog_uac(endpoint, contact->uri, NULL);
    ao2_cleanup(contact);
    if (!dlg) {
        ast_log(LOG_WARNING, "Unable to create dialog for SIP subscription\n");
        ao2_ref(sub_tree, -1);
        return NULL;
    }
 
    pj_cstr(&event, handler->event_name);
    pjsip_evsub_create_uac(dlg, &pubsub_cb, &event, 0, &sub_tree->evsub);
    subscription_setup_dialog(sub_tree, dlg);
 
    evsub = sub_tree->evsub;
 
    if (pjsip_evsub_initiate(evsub, NULL, -1, &tdata) == PJ_SUCCESS) {
        pjsip_evsub_send_request(sub_tree->evsub, tdata);
    } else {
        /* pjsip_evsub_terminate will result in pubsub_on_evsub_state,
         * being called and terminating the subscription. Therefore, we don't
         * need to decrease the reference count of sub here.
         */
        pjsip_evsub_terminate(evsub, PJ_TRUE);
        ao2_ref(sub_tree, -1);
        return NULL;
    }
 
    add_subscription(sub_tree);
 
    return sub;
}

References add_subscription(), allocate_subscription(), allocate_subscription_tree(), ao2_cleanup, ao2_ref, ast_sip_endpoint::aors, ast_log, ast_sip_create_dialog_uac(), ast_sip_location_retrieve_contact_from_aor_list(), ast_sorcery_object_get_id(), ast_strlen_zero(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, sip_subscription_tree::evsub, handler(), LOG_WARNING, NULL, pubsub_cb, sub, subscription_setup_dialog(), and ast_sip_contact::uri.

ast_sip_publication_add_datastore()

int ast_sip_publication_add_datastore	(	struct ast_sip_publication *	publication,
		struct ast_datastore *	datastore
	)

Add a datastore to a SIP publication.

Note that SIP uses reference counted datastores. The datastore passed into this function must have been allocated using ao2_alloc() or there will be serious problems.

Parameters

publication	The publication to add the datastore to
datastore	The datastore to be added to the subscription

Return values

0	Success
-1	Failure

Definition at line 2713 of file res_pjsip_pubsub.c.

{
    return ast_datastores_add(publication->datastores, datastore);
}

References ast_datastores_add(), and ast_sip_publication::datastores.

ast_sip_publication_get_datastore()

struct ast_datastore * ast_sip_publication_get_datastore	(	struct ast_sip_publication *	publication,
		const char *	name
	)

Retrieve a publication datastore.

The datastore retrieved will have its reference count incremented. When the caller is done with the datastore, the reference counted needs to be decremented using ao2_ref().

Parameters

publication	The publication from which to retrieve the datastore
name	The name of the datastore to retrieve

Return values

NULL	Failed to find the specified datastore
non-NULL	The specified datastore

Definition at line 2718 of file res_pjsip_pubsub.c.

{
    return ast_datastores_find(publication->datastores, name);
}

References ast_datastores_find(), ast_sip_publication::datastores, and name.

ast_sip_publication_get_datastores()

struct ao2_container * ast_sip_publication_get_datastores

(

const struct ast_sip_publication *

publication

)

Get the datastores container for a publication.

Parameters

publication

The publication to get the datastores container from

Return values

NULL	datastores container not present
non-NULL	datastores container

Note

The container is NOT returned with reference count bumped

Since

14.0.0

Definition at line 2728 of file res_pjsip_pubsub.c.

{
    return publication->datastores;
}

References ast_sip_publication::datastores.

ast_sip_publication_get_endpoint()

struct ast_sip_endpoint * ast_sip_publication_get_endpoint

(

struct ast_sip_publication *

pub

)

Given a publication, get the associated endpoint.

Parameters

pub	The publication

Return values

NULL	Failure
non-NULL	The associated endpoint

Definition at line 3487 of file res_pjsip_pubsub.c.

{
    return pub->endpoint;
}

References ast_sip_publication::endpoint.

ast_sip_publication_get_event_configuration()

const char * ast_sip_publication_get_event_configuration

(

const struct ast_sip_publication *

pub

)

Given a publication, get the configuration name for the event type in use.

Parameters

pub	The publication

Returns

The configuration name

Definition at line 3497 of file res_pjsip_pubsub.c.

{
    return pub->event_configuration_name;
}

References ast_sip_publication::event_configuration_name.

Referenced by asterisk_publication_devicestate_state_change(), and asterisk_publication_mwi_state_change().

ast_sip_publication_get_resource()

const char * ast_sip_publication_get_resource

(

const struct ast_sip_publication *

pub

)

Given a publication, get the resource the publication is to.

Parameters

pub	The publication

Returns

The resource

Definition at line 3492 of file res_pjsip_pubsub.c.

{
    return pub->resource;
}

References ast_sip_publication::resource.

ast_sip_publication_remove_datastore()

void ast_sip_publication_remove_datastore	(	struct ast_sip_publication *	publication,
		const char *	name
	)

Remove a publication datastore from the publication.

This operation may cause the datastore's free() callback to be called if the reference count reaches zero.

Parameters

publication	The publication to remove the datastore from
name	The name of the datastore to remove

Definition at line 2723 of file res_pjsip_pubsub.c.

{
    ast_datastores_remove(publication->datastores, name);
}

References ast_datastores_remove(), ast_sip_publication::datastores, and name.

ast_sip_pubsub_generate_body_content()

int ast_sip_pubsub_generate_body_content	(	const char *	content_type,
		const char *	content_subtype,
		struct ast_sip_body_data *	data,
		struct ast_str **	str
	)

Generate body content for a PUBLISH or NOTIFY.

Since

13.0.0

This function takes a pre-allocated body and calls into registered body generators in order to fill in the body with appropriate details. The primary body generator will be called first, followed by the supplementary body generators

Parameters

	content_type	The content type of the body
	content_subtype	The content subtype of the body
	data	The data associated with body generation.
[out]	str	The string representation of the generated body

Return values

0	Success
non-zero	Failure

Definition at line 3586 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_supplement *supplement;
    struct ast_sip_pubsub_body_generator *generator;
    int res = 0;
    void *body;
 
    generator = find_body_generator_type_subtype(type, subtype);
    if (!generator) {
        ast_log(LOG_WARNING, "Unable to find a body generator for %s/%s\n",
                type, subtype);
        return -1;
    }
 
    if (strcmp(data->body_type, generator->body_type)) {
        ast_log(LOG_WARNING, "%s/%s body generator does not accept the type of data provided\n",
            type, subtype);
        return -1;
    }
 
    body = generator->allocate_body(data->body_data);
    if (!body) {
        ast_log(LOG_WARNING, "%s/%s body generator could not to allocate a body\n",
            type, subtype);
        return -1;
    }
 
    if (generator->generate_body_content(body, data->body_data)) {
        res = -1;
        goto end;
    }
 
    AST_RWLIST_RDLOCK(&body_supplements);
    AST_RWLIST_TRAVERSE(&body_supplements, supplement, list) {
        if (!strcmp(generator->type, supplement->type) &&
                !strcmp(generator->subtype, supplement->subtype)) {
            res = supplement->supplement_body(body, data->body_data);
            if (res) {
                break;
            }
        }
    }
    AST_RWLIST_UNLOCK(&body_supplements);
 
    if (!res) {
        generator->to_string(body, str);
    }
 
end:
    if (generator->destroy_body) {
        generator->destroy_body(body);
    }
 
    return res;
}

References ast_sip_pubsub_body_generator::allocate_body, ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sip_body_data::body_data, ast_sip_body_data::body_type, ast_sip_pubsub_body_generator::body_type, ast_sip_pubsub_body_generator::destroy_body, end, find_body_generator_type_subtype(), ast_sip_pubsub_body_generator::generate_body_content, ast_sip_pubsub_body_generator::list, LOG_WARNING, str, ast_sip_pubsub_body_generator::subtype, ast_sip_pubsub_body_supplement::subtype, ast_sip_pubsub_body_supplement::supplement_body, ast_sip_pubsub_body_generator::to_string, type, ast_sip_pubsub_body_generator::type, and ast_sip_pubsub_body_supplement::type.

Referenced by ast_sip_subscription_notify(), exten_state_publisher_cb(), generate_initial_notify(), and send_unsolicited_mwi_notify_to_contact().

ast_sip_pubsub_has_eventlist_support()

static int ast_sip_pubsub_has_eventlist_support ( pjsip_rx_data *  rdata )

static

Check if the rdata has a Supported header containing 'eventlist'.

Return values

1	rdata has an eventlist containing supported header
0	rdata doesn't have an eventlist containing supported header

Definition at line 882 of file res_pjsip_pubsub.c.

{
    pjsip_supported_hdr *supported_header = (pjsip_supported_hdr *) &rdata->msg_info.msg->hdr;
 
    while ((supported_header = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_SUPPORTED, supported_header->next))) {
        int i;
 
        for (i = 0; i < supported_header->count; i++) {
            if (!pj_stricmp2(&supported_header->values[i], "eventlist")) {
                return 1;
            }
        }
    }
 
    return 0;
}

References while().

Referenced by pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

ast_sip_pubsub_is_body_generator_registered()

int ast_sip_pubsub_is_body_generator_registered	(	const char *	type,
		const char *	subtype
	)

Is a body generator registered for the given type/subtype.

Since

14.0.0

Parameters

type	The content type of the body
subtype	The content subtype of the body

Note

In "plain/text", "plain" is the type and "text" is the subtype.

Return values

non-zero

if a generator is registered.

Definition at line 3502 of file res_pjsip_pubsub.c.

{
    return !!find_body_generator_type_subtype(type, subtype);
}

References find_body_generator_type_subtype(), and type.

Referenced by publisher_start().

ast_sip_pubsub_register_body_generator()

int ast_sip_pubsub_register_body_generator

(

struct ast_sip_pubsub_body_generator *

generator

)

Register a body generator with the pubsub core.

Since

13.0.0

This may fail if an attempt is made to register a primary body supplement for a given content type if a primary body supplement for that content type has already been registered.

Parameters

generator

Body generator to register

Return values

0	Success
-1	Failure

Definition at line 3507 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_generator *existing;
    pj_str_t accept;
    pj_size_t accept_len;
 
    AST_RWLIST_WRLOCK(&body_generators);
    existing = find_body_generator_type_subtype_nolock(generator->type, generator->subtype);
    if (existing) {
        AST_RWLIST_UNLOCK(&body_generators);
        ast_log(LOG_WARNING, "A body generator for %s/%s is already registered.\n",
            generator->type, generator->subtype);
        return -1;
    }
    AST_LIST_INSERT_HEAD(&body_generators, generator, list);
    AST_RWLIST_UNLOCK(&body_generators);
 
    /* Lengths of type and subtype plus a slash. */
    accept_len = strlen(generator->type) + strlen(generator->subtype) + 1;
 
    /* Add room for null terminator that sprintf() will set. */
    pj_strset(&accept, ast_alloca(accept_len + 1), accept_len);
    sprintf((char *) pj_strbuf(&accept), "%s/%s", generator->type, generator->subtype);/* Safe */
 
    pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), &pubsub_module,
            PJSIP_H_ACCEPT, NULL, 1, &accept);
 
    return 0;
}

References ast_alloca, AST_LIST_INSERT_HEAD, ast_log, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sip_get_pjsip_endpoint(), find_body_generator_type_subtype_nolock(), ast_sip_pubsub_body_generator::list, LOG_WARNING, NULL, pubsub_module, ast_sip_pubsub_body_generator::subtype, and ast_sip_pubsub_body_generator::type.

Referenced by load_module().

ast_sip_pubsub_register_body_supplement()

int ast_sip_pubsub_register_body_supplement

(

struct ast_sip_pubsub_body_supplement *

supplement

)

Register a body generator with the pubsub core.

Since

13.0.0

This may fail if an attempt is made to register a primary body supplement for a given content type if a primary body supplement for that content type has already been registered.

Parameters

supplement

Body generator to register

Return values

0	Success
-1	Failure

Definition at line 3552 of file res_pjsip_pubsub.c.

{
    AST_RWLIST_WRLOCK(&body_supplements);
    AST_RWLIST_INSERT_TAIL(&body_supplements, supplement, list);
    AST_RWLIST_UNLOCK(&body_supplements);
 
    return 0;
}

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_sip_pubsub_body_generator::list.

Referenced by load_module().

ast_sip_pubsub_unregister_body_generator()

void ast_sip_pubsub_unregister_body_generator

(

struct ast_sip_pubsub_body_generator *

generator

)

Unregister a body generator with the pubsub core.

Since

13.0.0

Parameters

generator

Body generator to unregister

Definition at line 3537 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_generator *iter;
 
    AST_RWLIST_WRLOCK(&body_generators);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&body_generators, iter, list) {
        if (iter == generator) {
            AST_LIST_REMOVE_CURRENT(list);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
    AST_RWLIST_UNLOCK(&body_generators);
}

References AST_LIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_sip_pubsub_body_generator::list.

Referenced by unload_module(), and unregister_all().

ast_sip_pubsub_unregister_body_supplement()

void ast_sip_pubsub_unregister_body_supplement

(

struct ast_sip_pubsub_body_supplement *

supplement

)

Unregister a body generator with the pubsub core.

Since

13.0.0

Parameters

supplement

Body generator to unregister

Definition at line 3561 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_supplement *iter;
 
    AST_RWLIST_WRLOCK(&body_supplements);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&body_supplements, iter, list) {
        if (iter == supplement) {
            AST_LIST_REMOVE_CURRENT(list);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
    AST_RWLIST_UNLOCK(&body_supplements);
}

References AST_LIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_sip_pubsub_body_supplement::list.

Referenced by unload_module().

ast_sip_register_publish_handler()

int ast_sip_register_publish_handler

(

struct ast_sip_publish_handler *

handler

)

Register a publish handler.

Return values

0	Handler was registered successfully
non-zero	Handler was not registered successfully

Definition at line 2782 of file res_pjsip_pubsub.c.

{
    if (ast_strlen_zero(handler->event_name)) {
        ast_log(LOG_ERROR, "No event package specified for publish handler. Cannot register\n");
        return -1;
    }
 
    handler->publications = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
        PUBLICATIONS_BUCKETS, publication_hash_fn, NULL, publication_cmp_fn);
    if (!handler->publications) {
        ast_log(LOG_ERROR, "Could not allocate publications container for event '%s'\n",
            handler->event_name);
        return -1;
    }
 
    publish_add_handler(handler);
 
    return 0;
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ast_log, ast_strlen_zero(), handler(), LOG_ERROR, NULL, publication_cmp_fn(), publication_hash_fn(), PUBLICATIONS_BUCKETS, and publish_add_handler().

Referenced by load_module().

ast_sip_register_subscription_handler()

int ast_sip_register_subscription_handler

(

struct ast_sip_subscription_handler *

handler

)

Register a subscription handler.

Return values

0	Handler was registered successfully
non-zero	Handler was not registered successfully

Definition at line 2841 of file res_pjsip_pubsub.c.

{
    pj_str_t event;
    pj_str_t accept[AST_SIP_MAX_ACCEPT] = { {0, }, };
    struct ast_sip_subscription_handler *existing;
    int i = 0;
 
    if (ast_strlen_zero(handler->event_name)) {
        ast_log(LOG_ERROR, "No event package specified for subscription handler. Cannot register\n");
        return -1;
    }
 
    existing = find_sub_handler_for_event_name(handler->event_name);
    if (existing) {
        ast_log(LOG_ERROR,
            "Unable to register subscription handler for event %s.  A handler is already registered\n",
            handler->event_name);
        return -1;
    }
 
    for (i = 0; i < AST_SIP_MAX_ACCEPT && !ast_strlen_zero(handler->accept[i]); ++i) {
        pj_cstr(&accept[i], handler->accept[i]);
    }
 
    pj_cstr(&event, handler->event_name);
 
    pjsip_evsub_register_pkg(&pubsub_module, &event, DEFAULT_EXPIRES, i, accept);
 
    sub_add_handler(handler);
 
    return 0;
}

References ast_sip_subscription_handler::accept, ast_log, AST_SIP_MAX_ACCEPT, ast_strlen_zero(), DEFAULT_EXPIRES, find_sub_handler_for_event_name(), handler(), LOG_ERROR, pubsub_module, and sub_add_handler().

Referenced by load_module().

ast_sip_subscription_add_datastore()

int ast_sip_subscription_add_datastore	(	struct ast_sip_subscription *	subscription,
		struct ast_datastore *	datastore
	)

Add a datastore to a SIP subscription.

Note that SIP uses reference counted datastores. The datastore passed into this function must have been allocated using ao2_alloc() or there will be serious problems.

Parameters

subscription	The ssubscription to add the datastore to
datastore	The datastore to be added to the subscription

Return values

0	Success
-1	Failure

Definition at line 2693 of file res_pjsip_pubsub.c.

{
    return ast_datastores_add(subscription->datastores, datastore);
}

References ast_datastores_add(), and ast_sip_subscription::datastores.

Referenced by add_datastore(), and add_mwi_datastore().

ast_sip_subscription_alloc_datastore()

struct ast_datastore * ast_sip_subscription_alloc_datastore	(	const struct ast_datastore_info *	info,
		const char *	uid
	)

Alternative for ast_datastore_alloc()

There are two major differences between this and ast_datastore_alloc() 1) This allocates a refcounted object 2) This will fill in a uid if one is not provided

DO NOT call ast_datastore_free() on a datastore allocated in this way since that function will attempt to free the datastore rather than play nicely with its refcount.

Parameters

info	Callbacks for datastore
uid	Identifier for datastore

Return values

NULL	Failed to allocate datastore
non-NULL	Newly allocated datastore

Definition at line 2688 of file res_pjsip_pubsub.c.

{
    return ast_datastores_alloc_datastore(info, uid);
}

References ast_datastores_alloc_datastore(), sip_to_pjsip::info(), and ast_datastore::uid.

Referenced by add_datastore(), and add_mwi_datastore().

ast_sip_subscription_destroy()

void ast_sip_subscription_destroy

(

struct ast_sip_subscription *

sub

)

Alert the pubsub core that the subscription is ready for destruction.

Since

13.6.0

Parameters

sub	The subscription that is complete

Definition at line 1429 of file res_pjsip_pubsub.c.

{
    ast_debug(3, "Removing subscription %p '%s->%s' reference to subscription tree %p\n",
        sub, ast_sorcery_object_get_id(sub->tree->endpoint), sub->resource, sub->tree);
    ao2_cleanup(sub->tree);
}

References ao2_cleanup, ast_debug, ast_sorcery_object_get_id(), and sub.

Referenced by exten_state_subscription_destructor(), and mwi_subscription_destructor().

ast_sip_subscription_get_body_subtype()

const char * ast_sip_subscription_get_body_subtype

(

struct ast_sip_subscription *

sub

)

Get the body subtype used for this subscription.

Since

13.0.0

Definition at line 3581 of file res_pjsip_pubsub.c.

{
    return sub->body_generator->subtype;
}

References sub.

Referenced by ast_sip_subscription_notify(), generate_initial_notify(), and generate_notify_body().

ast_sip_subscription_get_body_type()

const char * ast_sip_subscription_get_body_type

(

struct ast_sip_subscription *

sub

)

Get the body type used for this subscription.

Since

13.0.0

Definition at line 3576 of file res_pjsip_pubsub.c.

{
    return sub->body_generator->type;
}

References sub.

Referenced by ast_sip_subscription_notify(), generate_initial_notify(), and generate_notify_body().

ast_sip_subscription_get_datastore()

struct ast_datastore * ast_sip_subscription_get_datastore	(	struct ast_sip_subscription *	subscription,
		const char *	name
	)

Retrieve a subscription datastore.

The datastore retrieved will have its reference count incremented. When the caller is done with the datastore, the reference counted needs to be decremented using ao2_ref().

Parameters

subscription	The subscription from which to retrieve the datastore
name	The name of the datastore to retrieve

Return values

NULL	Failed to find the specified datastore
non-NULL	The specified datastore

Definition at line 2698 of file res_pjsip_pubsub.c.

{
    return ast_datastores_find(subscription->datastores, name);
}

References ast_datastores_find(), ast_sip_subscription::datastores, and name.

Referenced by get_exten_state_sub(), mwi_get_notify_data(), mwi_subscription_shutdown(), and mwi_to_ami().

ast_sip_subscription_get_datastores()

struct ao2_container * ast_sip_subscription_get_datastores

(

const struct ast_sip_subscription *

subscription

)

Get the datastores container for a subscription.

Parameters

subscription

The subscription to get the datastores container from

Return values

NULL	datastores container not present
non-NULL	datastores container

Note

The container is NOT returned with reference count bumped

Since

14.0.0

Definition at line 2708 of file res_pjsip_pubsub.c.

{
    return subscription->datastores;
}

References ast_sip_subscription::datastores.

Referenced by alloc_notify_task_data(), exten_state_data_alloc(), and notify_task().

ast_sip_subscription_get_dialog()

pjsip_dialog * ast_sip_subscription_get_dialog

(

struct ast_sip_subscription *

sub

)

Get the pjsip dialog that is associated with this subscription.

Since

13.9.0

Return values

NULL	Could not get dialog
non-NULL	The dialog

Definition at line 1971 of file res_pjsip_pubsub.c.

{
    ast_assert(sub->tree->dlg != NULL);
    return sub->tree->dlg;
}

References ast_assert, NULL, and sub.

Referenced by dialog_info_generate_body_content(), mwi_get_notify_data(), and send_mwi_notify().

ast_sip_subscription_get_endpoint()

struct ast_sip_endpoint * ast_sip_subscription_get_endpoint

(

struct ast_sip_subscription *

sub

)

Get the endpoint that is associated with this subscription.

This function will increase the reference count of the endpoint. Be sure to release the reference to it when you are finished with the endpoint.

Return values

NULL	Could not get endpoint
non-NULL	The endpoint

Definition at line 1977 of file res_pjsip_pubsub.c.

{
    ast_assert(sub->tree->endpoint != NULL);
    return ao2_bump(sub->tree->endpoint);
}

References ao2_bump, ast_assert, NULL, and sub.

Referenced by dialog_info_generate_body_content(), mwi_get_notify_data(), mwi_subscription_established(), send_mwi_notify(), and subscription_established().

ast_sip_subscription_get_header()

void * ast_sip_subscription_get_header	(	const struct ast_sip_subscription *	sub,
		const char *	header
	)

Get a header value for a subscription.

For notifiers, the headers of the inbound SUBSCRIBE that started the dialog are stored on the subscription. This method allows access to the header. The return is the same as pjsip_msg_find_hdr_by_name(), meaning that it is dependent on the header being searched for.

Parameters

sub	The subscription to search in.
header	The name of the header to search for.

Returns

The discovered header, or NULL if the header cannot be found.

Definition at line 1895 of file res_pjsip_pubsub.c.

{
    pjsip_dialog *dlg;
    pjsip_msg *msg;
    pj_str_t name;
 
    dlg = sub->tree->dlg;
    msg = ast_sip_mod_data_get(dlg->mod_data, pubsub_module.id, MOD_DATA_MSG);
    pj_cstr(&name, header);
 
    return pjsip_msg_find_hdr_by_name(msg, &name, NULL);
}

References ast_sip_mod_data_get, MOD_DATA_MSG, name, NULL, pubsub_module, and sub.

Referenced by get_user_agent().

ast_sip_subscription_get_local_uri()

void ast_sip_subscription_get_local_uri	(	struct ast_sip_subscription *	sub,
		char *	buf,
		size_t	size
	)

Retrieve the local URI for this subscription.

This is the local URI of the subscribed resource.

Parameters

	sub	The subscription
[out]	buf	The buffer into which to store the URI.
	size	The size of the buffer.

Definition at line 2642 of file res_pjsip_pubsub.c.

{
    pjsip_uri_print(PJSIP_URI_IN_CONTACT_HDR, sub->uri, buf, size);
}

References buf, and sub.

Referenced by build_rlmi_body(), exten_state_data_alloc(), and notify_task().

ast_sip_subscription_get_persistence_data()

const struct ast_json * ast_sip_subscription_get_persistence_data

(

const struct ast_sip_subscription *

subscription

)

Retrieve persistence data for a subscription.

Since

13.31.0

16.8.0

17.2.0

Parameters

subscription

The subscription to retrieve persistence data from

Definition at line 2750 of file res_pjsip_pubsub.c.

{
    return subscription->persistence_data;
}

References ast_sip_subscription::persistence_data.

Referenced by dialog_info_generate_body_content().

ast_sip_subscription_get_remote_uri()

void ast_sip_subscription_get_remote_uri	(	struct ast_sip_subscription *	sub,
		char *	buf,
		size_t	size
	)

Retrive the remote URI for this subscription.

This is the remote URI as determined by the underlying SIP dialog.

Parameters

	sub	The subscription
[out]	buf	The buffer into which to store the URI.
	size	The size of the buffer.

Definition at line 2647 of file res_pjsip_pubsub.c.

{
    pjsip_dialog *dlg;
    pjsip_sip_uri *uri;
 
    dlg = sub->tree->dlg;
    uri = pjsip_uri_get_uri(dlg->remote.info->uri);
 
    if (pjsip_uri_print(PJSIP_URI_IN_FROMTO_HDR, uri, buf, size) < 0) {
        *buf = '\0';
    }
}

References buf, sip_subscription_tree::dlg, and sub.

Referenced by exten_state_data_alloc(), and notify_task().

ast_sip_subscription_get_resource_name()

const char * ast_sip_subscription_get_resource_name

(

struct ast_sip_subscription *

sub

)

Get the name of the subscribed resource.

Definition at line 2660 of file res_pjsip_pubsub.c.

{
    return sub->resource;
}

References sub.

Referenced by build_rlmi_body(), mwi_get_notify_data(), mwi_subscription_established(), remove_subscription(), send_mwi_notify(), and subscription_established().

ast_sip_subscription_get_serializer()

struct ast_taskprocessor * ast_sip_subscription_get_serializer

(

struct ast_sip_subscription *

sub

)

Get the serializer for the subscription.

Tasks that originate outside of a SIP servant thread should get the serializer and push the task to the serializer.

Parameters

sub	The subscription

Return values

NULL	Failure
non-NULL	The subscription's serializer

Definition at line 1983 of file res_pjsip_pubsub.c.

{
    ast_assert(sub->tree->serializer != NULL);
    return sub->tree->serializer;
}

References ast_assert, NULL, and sub.

Referenced by exten_state_subscription_alloc(), and send_notify().

ast_sip_subscription_get_sip_uri()

pjsip_sip_uri * ast_sip_subscription_get_sip_uri

(

struct ast_sip_subscription *

sub

)

Retrieve the local sip uri for this subscription.

Since

13.9.0

This is the local sip URI of the subscribed resource.

Parameters

sub	The subscription

Return values

NULL	Could not get uri
non-NULL	The local pjsip_sip_uri

Definition at line 2637 of file res_pjsip_pubsub.c.

{
    return sub->uri;
}

References sub.

Referenced by mwi_get_notify_data(), and send_mwi_notify().

ast_sip_subscription_is_terminated()

int ast_sip_subscription_is_terminated

(

const struct ast_sip_subscription *

sub

)

Get whether the subscription has been terminated or not.

Parameters

sub	The subscription.

Return values

0	not terminated.
1	terminated.

Since

13.4.0

Definition at line 2665 of file res_pjsip_pubsub.c.

{
    return sub->subscription_state == PJSIP_EVSUB_STATE_TERMINATED ? 1 : 0;
}

References sub.

Referenced by notify_task(), and state_changed().

ast_sip_subscription_notify()

int ast_sip_subscription_notify	(	struct ast_sip_subscription *	sub,
		struct ast_sip_body_data *	notify_data,
		int	terminate
	)

Notify a SIP subscription of a state change.

This tells the pubsub core that the state of a subscribed resource has changed. The pubsub core will generate an appropriate NOTIFY request to send to the subscriber.

Parameters

sub	The subscription on which a state change is occurring.
notify_data	Event package-specific data used to create the NOTIFY body.
terminate	True if this NOTIFY is intended to terminate the subscription.

Return values

0	Success
non-zero	Failure

Definition at line 2593 of file res_pjsip_pubsub.c.

{
    int res;
    pjsip_dialog *dlg = sub->tree->dlg;
 
    pjsip_dlg_inc_lock(dlg);
 
    if (sub->tree->state != SIP_SUB_TREE_NORMAL) {
        pjsip_dlg_dec_lock(dlg);
        return 0;
    }
 
    if (ast_sip_pubsub_generate_body_content(ast_sip_subscription_get_body_type(sub),
                ast_sip_subscription_get_body_subtype(sub), notify_data, &sub->body_text)) {
        pjsip_dlg_dec_lock(dlg);
        return -1;
    }
 
    sub->body_changed = 1;
    if (terminate) {
        sub->subscription_state = PJSIP_EVSUB_STATE_TERMINATED;
        sub->tree->state = SIP_SUB_TREE_TERMINATE_PENDING;
    }
 
    if (sub->tree->notification_batch_interval) {
        res = schedule_notification(sub->tree);
    } else {
        /* See the note in pubsub_on_rx_refresh() for why sub->tree is refbumped here */
        ao2_ref(sub->tree, +1);
        if (terminate) {
            sub->tree->state = SIP_SUB_TREE_TERMINATE_IN_PROGRESS;
        }
        res = send_notify(sub->tree, 0);
        ast_test_suite_event_notify(terminate ? "SUBSCRIPTION_TERMINATED" : "SUBSCRIPTION_STATE_CHANGED",
                "Resource: %s",
                sub->tree->root->resource);
        ao2_ref(sub->tree, -1);
    }
 
    pjsip_dlg_dec_lock(dlg);
    return res;
}

References ao2_ref, ast_sip_pubsub_generate_body_content(), ast_sip_subscription_get_body_subtype(), ast_sip_subscription_get_body_type(), ast_test_suite_event_notify, sip_subscription_tree::dlg, schedule_notification(), send_notify(), SIP_SUB_TREE_NORMAL, SIP_SUB_TREE_TERMINATE_IN_PROGRESS, SIP_SUB_TREE_TERMINATE_PENDING, and sub.

Referenced by notify_task(), and send_mwi_notify().

ast_sip_subscription_remove_datastore()

void ast_sip_subscription_remove_datastore	(	struct ast_sip_subscription *	subscription,
		const char *	name
	)

Remove a subscription datastore from the subscription.

This operation may cause the datastore's free() callback to be called if the reference count reaches zero.

Parameters

subscription	The subscription to remove the datastore from
name	The name of the datastore to remove

Definition at line 2703 of file res_pjsip_pubsub.c.

{
    ast_datastores_remove(subscription->datastores, name);
}

References ast_datastores_remove(), ast_sip_subscription::datastores, and name.

Referenced by mwi_subscription_established(), mwi_subscription_shutdown(), and subscription_shutdown().

ast_sip_subscription_set_persistence_data()

void ast_sip_subscription_set_persistence_data	(	struct ast_sip_subscription *	subscription,
		struct ast_json *	persistence_data
	)

Set persistence data for a subscription.

Since

13.31.0

16.8.0

17.2.0

Parameters

subscription	The subscription to set persistence data on
persistence_data	The persistence data to set

Note

This steals the reference to persistence_data

Definition at line 2733 of file res_pjsip_pubsub.c.

{
    ast_json_unref(subscription->persistence_data);
    subscription->persistence_data = persistence_data;
 
    if (subscription->tree->persistence) {
        if (!subscription->tree->persistence->generator_data) {
            subscription->tree->persistence->generator_data = ast_json_object_create();
            if (!subscription->tree->persistence->generator_data) {
                return;
            }
        }
        ast_json_object_set(subscription->tree->persistence->generator_data, subscription->resource,
            ast_json_ref(persistence_data));
    }
}

References ast_json_object_create(), ast_json_object_set(), ast_json_ref(), ast_json_unref(), subscription_persistence::generator_data, sip_subscription_tree::persistence, ast_sip_subscription::persistence_data, ast_sip_subscription::resource, and ast_sip_subscription::tree.

Referenced by dialog_info_generate_body_content().

ast_sip_unregister_publish_handler()

void ast_sip_unregister_publish_handler

(

struct ast_sip_publish_handler *

handler

)

Unregister a publish handler.

Definition at line 2802 of file res_pjsip_pubsub.c.

{
    struct ast_sip_publish_handler *iter;
 
    AST_RWLIST_WRLOCK(&publish_handlers);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&publish_handlers, iter, next) {
        if (handler == iter) {
            AST_RWLIST_REMOVE_CURRENT(next);
            ao2_cleanup(handler->publications);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
    AST_RWLIST_UNLOCK(&publish_handlers);
}

References ao2_cleanup, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, handler(), and ast_sip_publish_handler::next.

Referenced by load_module(), and unload_module().

ast_sip_unregister_subscription_handler()

void ast_sip_unregister_subscription_handler

(

struct ast_sip_subscription_handler *

handler

)

Unregister a subscription handler.

Definition at line 2874 of file res_pjsip_pubsub.c.

{
    struct ast_sip_subscription_handler *iter;
 
    AST_RWLIST_WRLOCK(&subscription_handlers);
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&subscription_handlers, iter, next) {
        if (handler == iter) {
            AST_RWLIST_REMOVE_CURRENT(next);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
    AST_RWLIST_UNLOCK(&subscription_handlers);
}

References AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, handler(), and ast_sip_subscription_handler::next.

Referenced by unload_module().

build_body_part()

static void build_body_part ( pj_pool_t *  pool, struct ast_sip_subscription *  sub, struct body_part_list *  parts, unsigned int  use_full_state  )

static

Create a multipart body part for a subscribed resource.

Parameters

pool	PJLIB allocation pool
sub	The subscription representing a subscribed resource
parts	A vector of parts to append the created part to.
use_full_state	Unused locally, but may be passed to other functions

Definition at line 2305 of file res_pjsip_pubsub.c.

{
    struct body_part *bp;
    pjsip_msg_body *body;
 
    bp = allocate_body_part(pool, sub);
    if (!bp) {
        return;
    }
 
    body = generate_notify_body(pool, sub, use_full_state);
    if (!body) {
        /* Partial state was requested and the resource has not changed state */
        ast_free(bp);
        return;
    }
 
    bp->part = pjsip_multipart_create_part(pool);
    bp->part->body = body;
    pj_list_insert_before(&bp->part->hdr, bp->cid);
 
    if (AST_VECTOR_APPEND(parts, bp)) {
        ast_free(bp);
    }
}

References allocate_body_part(), ast_free, AST_VECTOR_APPEND, body_part::cid, generate_notify_body(), body_part::part, and sub.

Referenced by generate_list_body().

build_node_children()

static void build_node_children ( struct ast_sip_endpoint *  endpoint, const struct ast_sip_subscription_handler *  handler, struct resource_list *  list, struct tree_node *  parent, struct resources *  visited, pjsip_rx_data *  rdata  )

static

Build child nodes for a given parent.

This iterates through the items on a resource list and creates tree nodes for each one. The tree nodes created are children of the supplied parent node. If an item in the resource list is itself a list, then this function is called recursively to provide children for the new node.

If an item in a resource list is not a list, then the supplied subscription handler is called into as if a new SUBSCRIBE for the list item were presented. The handler's response is used to determine if the node can be added to the tree or not.

If a parent node ends up having no child nodes added under it, then the parent node is pruned from the tree.

Parameters

endpoint	The endpoint that sent the inbound SUBSCRIBE.
handler	The subscription handler for leaf nodes in the tree.
list	The configured resource list from which the child node is being built.
parent	The parent node for these children.
visited	The resources that have already been visited.

Definition at line 1044 of file res_pjsip_pubsub.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(&list->items); ++i) {
        struct tree_node *current;
        struct resource_list *child_list;
        const char *resource = AST_VECTOR_GET(&list->items, i);
 
        if (have_visited(resource, visited)) {
            ast_debug(1, "Already visited resource %s. Avoiding duplicate resource or potential loop.\n", resource);
            continue;
        }
 
        child_list = retrieve_resource_list(resource, list->event);
        if (!child_list) {
            int resp = NEW_SUBSCRIBE(handler->notifier, endpoint, resource, rdata);
            if (PJSIP_IS_STATUS_IN_CLASS(resp, 200)) {
                char display_name[AST_MAX_EXTENSION] = "";
                if (list->resource_display_name && handler->notifier->get_resource_display_name) {
                    handler->notifier->get_resource_display_name(endpoint, resource, display_name, sizeof(display_name));
                }
                current = tree_node_alloc(resource, visited, 0, ast_strlen_zero(display_name) ? NULL : display_name);
                if (!current) {
                    ast_debug(1,
                        "Subscription to leaf resource %s was successful, but encountered allocation error afterwards\n",
                        resource);
                    continue;
                }
                ast_debug(2, "Subscription to leaf resource %s resulted in success. Adding to parent %s\n",
                        resource, parent->resource);
                if (AST_VECTOR_APPEND(&parent->children, current)) {
                    tree_node_destroy(current);
                }
            } else {
                ast_debug(2, "Subscription to leaf resource %s resulted in error response %d\n",
                        resource, resp);
            }
        } else {
            ast_debug(2, "Resource %s (child of %s) is a list\n", resource, parent->resource);
            current = tree_node_alloc(resource, visited, child_list->full_state, NULL);
            if (!current) {
                ast_debug(1, "Cannot build children of resource %s due to allocation failure\n", resource);
                continue;
            }
            build_node_children(endpoint, handler, child_list, current, visited, rdata);
            if (AST_VECTOR_SIZE(&current->children) > 0) {
                ast_debug(1, "List %s had no successful children.\n", resource);
                if (AST_VECTOR_APPEND(&parent->children, current)) {
                    tree_node_destroy(current);
                }
            } else {
                ast_debug(2, "List %s had successful children. Adding to parent %s\n",
                        resource, parent->resource);
                tree_node_destroy(current);
            }
            ao2_cleanup(child_list);
        }
    }
}

References ao2_cleanup, ast_debug, AST_MAX_EXTENSION, ast_strlen_zero(), AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, build_node_children(), tree_node::children, current, resource_list::event, resource_list::full_state, handler(), have_visited(), resource_list::items, NEW_SUBSCRIBE, NULL, tree_node::resource, resource_list::resource_display_name, retrieve_resource_list(), tree_node_alloc(), and tree_node_destroy().

Referenced by build_node_children(), and build_resource_tree().

build_resource_tree()

static int build_resource_tree ( struct ast_sip_endpoint *  endpoint, const struct ast_sip_subscription_handler *  handler, const char *  resource, struct resource_tree *  tree, int  has_eventlist_support, pjsip_rx_data *  rdata  )

static

Build a resource tree.

This function builds a resource tree based on the requested resource in a SUBSCRIBE request.

This function also creates a container that has all resources that have been visited during creation of the tree, whether those resources resulted in a tree node being created or not. Keeping this container of visited resources allows for misconfigurations such as loops in the tree or duplicated resources to be detected.

Parameters

endpoint	The endpoint that sent the SUBSCRIBE request.
handler	The subscription handler for leaf nodes in the tree.
resource	The resource requested in the SUBSCRIBE request.
tree	The tree that is to be built.
has_eventlist_support

Return values

200-299	Successfully subscribed to at least one resource.
300-699	Failure to subscribe to requested resource.

Definition at line 1162 of file res_pjsip_pubsub.c.

{
    RAII_VAR(struct resource_list *, list, NULL, ao2_cleanup);
    struct resources visited;
 
    int not_eventlist_but_needs_children = !strcmp(handler->body_type, AST_SIP_DEVICE_FEATURE_SYNC_DATA);
 
    if ((!has_eventlist_support && !not_eventlist_but_needs_children) || !(list = retrieve_resource_list(resource, handler->event_name))) {
        ast_debug(2, "Subscription '%s->%s' is not to a list\n",
            ast_sorcery_object_get_id(endpoint), resource);
        tree->root = tree_node_alloc(resource, NULL, 0, NULL);
        if (!tree->root) {
            return 500;
        }
        return NEW_SUBSCRIBE(handler->notifier, endpoint, resource, rdata);
    }
 
    ast_debug(2, "Subscription '%s->%s' is a list\n",
        ast_sorcery_object_get_id(endpoint), resource);
    if (AST_VECTOR_INIT(&visited, AST_VECTOR_SIZE(&list->items))) {
        return 500;
    }
 
    tree->root = tree_node_alloc(resource, &visited, list->full_state, NULL);
    if (!tree->root) {
        AST_VECTOR_FREE(&visited);
        return 500;
    }
 
    tree->notification_batch_interval = list->notification_batch_interval;
 
    build_node_children(endpoint, handler, list, tree->root, &visited, rdata);
    AST_VECTOR_FREE(&visited);
 
    if (AST_VECTOR_SIZE(&tree->root->children) > 0) {
        return 200;
    } else {
        return 500;
    }
}

References ao2_cleanup, ast_debug, AST_SIP_DEVICE_FEATURE_SYNC_DATA, ast_sorcery_object_get_id(), AST_VECTOR_FREE, AST_VECTOR_INIT, AST_VECTOR_SIZE, build_node_children(), tree_node::children, handler(), NEW_SUBSCRIBE, resource_tree::notification_batch_interval, NULL, RAII_VAR, retrieve_resource_list(), resource_tree::root, and tree_node_alloc().

Referenced by pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

build_rlmi_body()

static pjsip_multipart_part * build_rlmi_body ( pj_pool_t *  pool, struct ast_sip_subscription *  sub, struct body_part_list *  body_parts, unsigned int  full_state  )

static

Create an RLMI body part for a multipart resource list body.

RLMI (Resource list meta information) is a special body type that lists the subscribed resources and tells subscribers the number of subscribed resources and what other body parts are in the multipart body. The RLMI body also has a version number that a subscriber can use to ensure that the locally-stored state corresponds to server state.

Parameters

pool	The allocation pool
sub	The subscription representing the subscribed resource list
body_parts	A container of body parts that RLMI will refer to
full_state	Indicates whether this is a full or partial state notification

Returns

The multipart part representing the RLMI body

Definition at line 2208 of file res_pjsip_pubsub.c.

{
    pj_xml_node *rlmi;
    pj_xml_node *name;
    pjsip_multipart_part *rlmi_part;
    char version_str[32];
    char uri[PJSIP_MAX_URL_SIZE];
    pjsip_generic_string_hdr *cid;
    int i;
 
    rlmi = ast_sip_presence_xml_create_node(pool, NULL, "list");
    ast_sip_presence_xml_create_attr(pool, rlmi, "xmlns", "urn:ietf:params:xml:ns:rlmi");
 
    ast_sip_subscription_get_local_uri(sub, uri, sizeof(uri));
    ast_sip_presence_xml_create_attr(pool, rlmi, "uri", uri);
 
    snprintf(version_str, sizeof(version_str), "%u", sub->version++);
    ast_sip_presence_xml_create_attr(pool, rlmi, "version", version_str);
    ast_sip_presence_xml_create_attr(pool, rlmi, "fullState", full_state ? "true" : "false");
 
    name = ast_sip_presence_xml_create_node(pool, rlmi, "name");
    pj_strdup2(pool, &name->content, ast_sip_subscription_get_resource_name(sub));
 
    for (i = 0; i < AST_VECTOR_SIZE(body_parts); ++i) {
        const struct body_part *part = AST_VECTOR_GET(body_parts, i);
 
        add_rlmi_resource(pool, rlmi, part->cid, S_OR(part->display_name, part->resource), part->uri, part->state);
    }
 
    rlmi_part = pjsip_multipart_create_part(pool);
 
    rlmi_part->body = PJ_POOL_ZALLOC_T(pool, pjsip_msg_body);
    pjsip_media_type_cp(pool, &rlmi_part->body->content_type, &rlmi_media_type);
 
    rlmi_part->body->data = pj_xml_clone(pool, rlmi);
    rlmi_part->body->clone_data = rlmi_clone_data;
    rlmi_part->body->print_body = rlmi_print_body;
 
    cid = generate_content_id_hdr(pool, sub);
    pj_list_insert_before(&rlmi_part->hdr, cid);
 
    return rlmi_part;
}

References add_rlmi_resource(), ast_sip_presence_xml_create_attr(), ast_sip_presence_xml_create_node(), ast_sip_subscription_get_local_uri(), ast_sip_subscription_get_resource_name(), AST_VECTOR_GET, AST_VECTOR_SIZE, body_part::cid, generate_content_id_hdr(), name, NULL, body_part::part, rlmi_clone_data(), rlmi_media_type, rlmi_print_body(), S_OR, and sub.

Referenced by generate_list_body().

clean_sub_tree()

static void clean_sub_tree ( pjsip_evsub *  evsub )

static

Callback sequence for subscription terminate:

• Please note that the descriptions below represent pjproject behavior on versions >= 2.13.
• Client initiated: pjproject receives SUBSCRIBE on the subscription's serializer thread calls pubsub_evsub_set_state with state = TERMINATED pubsub_on_evsub_state checks the event and finds it is due to a received SUBSCRIBE with an expires of 0 and so does nothing. calls pubsub_on_rx_refresh with dialog locked pubsub_on_rx_refresh sets TERMINATE_PENDING calls pubsub_on_refresh_timeout to push final NOTIFY to pjproject checks state == TERMINATE_PENDING sets TERMINATE_IN_PROGRESS calls send_notify (2) send_notify ultimately calls pjsip_evsub_send_request pjsip_evsub_send_request calls evsub's set_state set_state calls pubsub_evsub_set_state pubsub_on_evsub_state checks state == TERMINATE_IN_PROGRESS removes the subscriptions cleans up references to evsub sets state = TERMINATED pubsub_on_refresh_timeout unlocks dialog returns to pjproject pjproject unlocks dialog
• Subscription timer expires: pjproject timer expires locks dialog calls pubsub_on_server_timeout pubsub_on_server_timeout checks state == NORMAL sets TERMINATE_PENDING pushes serialized_pubsub_on_refresh_timeout returns to pjproject pjproject unlocks dialog serialized_pubsub_on_refresh_timeout starts (1) locks dialog checks state == TERMINATE_PENDING sets TERMINATE_IN_PROGRESS calls send_notify (2) send_notify ultimately calls pjsip_evsub_send_request pjsip_evsub_send_request calls evsub's set_state set_state calls pubsub_evsub_set_state pubsub_on_evsub_state checks state == TERMINATE_IN_PROGRESS checks that the event is not due to un-SUBSCRIBE removes the subscriptions cleans up references to evsub sets state = TERMINATED serialized_pubsub_on_refresh_timeout unlocks dialog
• Transmission failure sending NOTIFY or error response from client pjproject transaction timer expires or non OK response pjproject locks dialog calls pubsub_on_evsub_state with event TSX_STATE pubsub_on_evsub_state checks event == TSX_STATE removes the subscriptions cleans up references to evsub sets state = TERMINATED pjproject unlocks dialog
• ast_sip_subscription_notify is called checks state == NORMAL if not batched... sets TERMINATE_IN_PROGRESS (if terminate is requested) calls send_notify See (2) Above if batched... sets TERMINATE_PENDING schedules task scheduler runs sched_task sched_task pushes serialized_send_notify serialized_send_notify starts checks state <= TERMINATE_PENDING if state == TERMINATE_PENDING set state = TERMINATE_IN_PROGRESS call send_notify See (2) Above

Definition at line 3869 of file res_pjsip_pubsub.c.

{
 
    struct sip_subscription_tree *sub_tree;
    sub_tree = pjsip_evsub_get_mod_data(evsub, pubsub_module.id);
 
    ast_debug(3, "Cleaning subscription %p\n", evsub);
 
    if (sub_tree->expiration_task) {
        char task_name[256];
 
        ast_sip_sched_task_get_name(sub_tree->expiration_task, task_name, sizeof(task_name));
        ast_debug(3, "Cancelling timer: %s\n", task_name);
        ast_sip_sched_task_cancel(sub_tree->expiration_task);
        ao2_cleanup(sub_tree->expiration_task);
        sub_tree->expiration_task = NULL;
    }
 
    remove_subscription(sub_tree);
 
    pjsip_evsub_set_mod_data(evsub, pubsub_module.id, NULL);
 
#ifdef HAVE_PJSIP_EVSUB_GRP_LOCK
    pjsip_evsub_dec_ref(sub_tree->evsub);
#endif
 
    sub_tree->evsub = NULL;
 
    ast_sip_dialog_set_serializer(sub_tree->dlg, NULL);
    ast_sip_dialog_set_endpoint(sub_tree->dlg, NULL);
 
    subscription_persistence_remove(sub_tree);
    shutdown_subscriptions(sub_tree->root);
 
    sub_tree->state = SIP_SUB_TREE_TERMINATED;
    /* Remove evsub's reference to the sub_tree */
    ao2_ref(sub_tree, -1);
}

References ao2_cleanup, ao2_ref, ast_debug, ast_sip_dialog_set_endpoint(), ast_sip_dialog_set_serializer(), ast_sip_sched_task_cancel(), ast_sip_sched_task_get_name(), sip_subscription_tree::dlg, sip_subscription_tree::evsub, sip_subscription_tree::expiration_task, NULL, pubsub_module, remove_subscription(), sip_subscription_tree::root, shutdown_subscriptions(), SIP_SUB_TREE_TERMINATED, sip_subscription_tree::state, and subscription_persistence_remove().

Referenced by pubsub_on_evsub_state().

cli_complete_subscription_callid()

static char * cli_complete_subscription_callid ( struct ast_cli_args *  a )

static

Definition at line 4432 of file res_pjsip_pubsub.c.

{
    struct cli_sub_complete_parms cli;
    on_subscription_t on_subscription;
 
    if (a->pos != 4) {
        return NULL;
    }
 
    if (!strcasecmp(a->argv[3], "inbound")) {
        on_subscription = cli_complete_subscription_inbound;
    } else if (!strcasecmp(a->argv[3], "outbound")) {
        on_subscription = cli_complete_subscription_outbound;
    } else {
        /* Should never get here */
        ast_assert(0);
        return NULL;
    }
 
    cli.a = a;
    cli.callid = NULL;
    cli.wordlen = strlen(a->word);
    cli.which = 0;
    for_each_subscription(on_subscription, &cli);
 
    return cli.callid;
}

References a, ast_assert, cli, cli_complete_subscription_inbound(), cli_complete_subscription_outbound(), for_each_subscription(), and NULL.

Referenced by cli_show_subscription_inout().

cli_complete_subscription_common()

static int cli_complete_subscription_common ( struct sip_subscription_tree *  sub_tree, struct cli_sub_complete_parms *  cli  )

static

Definition at line 4399 of file res_pjsip_pubsub.c.

{
    pj_str_t *callid;
 
    if (!sub_tree->dlg) {
        return 0;
    }
 
    callid = &sub_tree->dlg->call_id->id;
    if (cli->wordlen <= pj_strlen(callid)
        && !strncasecmp(cli->a->word, pj_strbuf(callid), cli->wordlen)
        && (++cli->which > cli->a->n)) {
        cli->callid = ast_malloc(pj_strlen(callid) + 1);
        if (cli->callid) {
            ast_copy_pj_str(cli->callid, callid, pj_strlen(callid) + 1);
        }
        return -1;
    }
    return 0;
}

References ast_copy_pj_str(), ast_malloc, cli, and sip_subscription_tree::dlg.

Referenced by cli_complete_subscription_inbound(), and cli_complete_subscription_outbound().

cli_complete_subscription_inbound()

static int cli_complete_subscription_inbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4420 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_NOTIFIER
        ? cli_complete_subscription_common(sub_tree, arg) : 0;
}

References AST_SIP_NOTIFIER, cli_complete_subscription_common(), and sip_subscription_tree::role.

Referenced by cli_complete_subscription_callid().

cli_complete_subscription_outbound()

static int cli_complete_subscription_outbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4426 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_SUBSCRIBER
        ? cli_complete_subscription_common(sub_tree, arg) : 0;
}

References AST_SIP_SUBSCRIBER, cli_complete_subscription_common(), and sip_subscription_tree::role.

Referenced by cli_complete_subscription_callid().

cli_list_subscriptions_detail()

static int cli_list_subscriptions_detail ( struct sip_subscription_tree *  sub_tree, struct cli_sub_parms *  cli  )

static

Definition at line 4763 of file res_pjsip_pubsub.c.

{
    char ep_cid_buf[50];
    char res_evt_buf[50];
    char callid[256];
 
    /* Endpoint/CID column */
    snprintf(ep_cid_buf, sizeof(ep_cid_buf), "%s/%s",
        ast_sorcery_object_get_id(sub_tree->endpoint),
        S_COR(sub_tree->endpoint->id.self.name.valid, sub_tree->endpoint->id.self.name.str,
            S_COR(sub_tree->endpoint->id.self.number.valid,
                sub_tree->endpoint->id.self.number.str, "<none>")));
 
    /* Resource/Event column */
    snprintf(res_evt_buf, sizeof(res_evt_buf), "%s/%s",
        sub_tree->root->resource,
        sub_tree->root->handler->event_name);
 
    /* Call-id column */
    if (sub_tree->dlg) {
        ast_copy_pj_str(callid, &sub_tree->dlg->call_id->id, sizeof(callid));
    } else {
        ast_copy_string(callid, "<unknown>", sizeof(callid));
    }
 
    ast_str_set(&cli->buf, 0, CLI_LIST_SUB_FORMAT_ENTRY,
        ep_cid_buf,
        res_evt_buf,
        cli_subscription_expiry(sub_tree),
        callid);
 
    if (cli->like) {
        if (regexec(cli->like, ast_str_buffer(cli->buf), 0, NULL, 0)) {
            /* Output line did not match the regex */
            return 0;
        }
    }
 
    ast_cli(cli->a->fd, "%s", ast_str_buffer(cli->buf));
    ++cli->count;
 
    return 0;
}

References ast_cli(), ast_copy_pj_str(), ast_copy_string(), ast_sorcery_object_get_id(), ast_str_buffer(), ast_str_set(), cli, CLI_LIST_SUB_FORMAT_ENTRY, cli_subscription_expiry(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, ast_sip_subscription_handler::event_name, ast_sip_subscription::handler, ast_sip_endpoint::id, ast_party_id::name, NULL, ast_party_id::number, ast_sip_subscription::resource, sip_subscription_tree::root, S_COR, ast_sip_endpoint_id_configuration::self, ast_party_name::str, ast_party_number::str, ast_party_name::valid, and ast_party_number::valid.

Referenced by cli_list_subscriptions_inbound(), and cli_list_subscriptions_outbound().

cli_list_subscriptions_inbound()

static int cli_list_subscriptions_inbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4807 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_NOTIFIER
        ? cli_list_subscriptions_detail(sub_tree, arg) : 0;
}

References AST_SIP_NOTIFIER, cli_list_subscriptions_detail(), and sip_subscription_tree::role.

Referenced by cli_list_subscriptions_inout().

cli_list_subscriptions_inout()

static char * cli_list_subscriptions_inout ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 4819 of file res_pjsip_pubsub.c.

{
    on_subscription_t on_subscription;
    struct cli_sub_parms cli;
    regex_t like;
    const char *regex;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip list subscriptions {inbound|outbound} [like]";
        e->usage = "Usage:\n"
                   "   pjsip list subscriptions inbound [like <regex>]\n"
                   "      List active inbound subscriptions\n"
                   "   pjsip list subscriptions outbound [like <regex>]\n"
                   "      List active outbound subscriptions\n"
                   "\n"
                   "   The regex selects output lines that match.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 4 && a->argc != 6) {
        return CLI_SHOWUSAGE;
    }
    if (!strcasecmp(a->argv[3], "inbound")) {
        on_subscription = cli_list_subscriptions_inbound;
    } else if (!strcasecmp(a->argv[3], "outbound")) {
        on_subscription = cli_list_subscriptions_outbound;
    } else {
        /* Should never get here */
        ast_assert(0);
        return CLI_SHOWUSAGE;
    }
    if (a->argc == 6) {
        int rc;
 
        if (strcasecmp(a->argv[4], "like")) {
            return CLI_SHOWUSAGE;
        }
 
        /* Setup regular expression */
        memset(&like, 0, sizeof(like));
        cli.like = &like;
        regex = a->argv[5];
        rc = regcomp(cli.like, regex, REG_EXTENDED | REG_NOSUB);
        if (rc) {
            char *regerr = ast_alloca(MAX_REGEX_ERROR_LEN);
 
            regerror(rc, cli.like, regerr, MAX_REGEX_ERROR_LEN);
            ast_cli(a->fd, "Regular expression '%s' failed to compile: %s\n",
                regex, regerr);
            return CLI_FAILURE;
        }
    } else {
        cli.like = NULL;
        regex = NULL;
    }
 
    cli.a = a;
    cli.e = e;
    cli.count = 0;
    cli.buf = ast_str_create(256);
    if (!cli.buf) {
        if (cli.like) {
            regfree(cli.like);
        }
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, CLI_LIST_SUB_FORMAT_HEADER,
        "Endpoint/CLI", "Resource/Event", "Expiry", "Call-id");
    for_each_subscription(on_subscription, &cli);
    ast_cli(a->fd, "\n%d active subscriptions%s%s%s\n",
        cli.count,
        regex ? " matched \"" : "",
        regex ?: "",
        regex ? "\"" : "");
 
    ast_free(cli.buf);
    if (cli.like) {
        regfree(cli.like);
    }
 
    return CLI_SUCCESS;
}

References a, ast_alloca, ast_assert, ast_cli(), ast_free, ast_str_create, cli, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_LIST_SUB_FORMAT_HEADER, cli_list_subscriptions_inbound(), cli_list_subscriptions_outbound(), CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, cli_sub_parms::e, for_each_subscription(), cli_sub_parms::like, MAX_REGEX_ERROR_LEN, NULL, regex(), and ast_cli_entry::usage.

cli_list_subscriptions_outbound()

static int cli_list_subscriptions_outbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4813 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_SUBSCRIBER
        ? cli_list_subscriptions_detail(sub_tree, arg) : 0;
}

References AST_SIP_SUBSCRIBER, cli_list_subscriptions_detail(), and sip_subscription_tree::role.

Referenced by cli_list_subscriptions_inout().

cli_show_subscription_common()

static int cli_show_subscription_common ( struct sip_subscription_tree *  sub_tree, struct cli_sub_parms *  cli  )

static

Definition at line 4474 of file res_pjsip_pubsub.c.

{
    const char *callid = (const char *) cli->buf;/* Member repurposed to pass in callid */
    pj_str_t *sub_callid;
    struct ast_str *buf;
    char *src;
    char *dest;
    char *key;
    char *value;
    char *value_end;
    int key_len;
    int key_filler_width;
    int value_len;
 
    if (!sub_tree->dlg) {
        return 0;
    }
    sub_callid = &sub_tree->dlg->call_id->id;
    if (pj_strcmp2(sub_callid, callid)) {
        return 0;
    }
 
    buf = ast_str_create(512);
    if (!buf) {
        return -1;
    }
 
    ast_cli(cli->a->fd,
        "%-20s: %s\n"
        "===========================================================================\n",
        "ParameterName", "ParameterValue");
 
    ast_str_append(&buf, 0, "Resource: %s\n", sub_tree->root->resource);
    ast_str_append(&buf, 0, "Event: %s\n", sub_tree->root->handler->event_name);
    ast_str_append(&buf, 0, "Expiry: %u\n", cli_subscription_expiry(sub_tree));
 
    sip_subscription_to_ami(sub_tree, &buf);
 
    /* Convert AMI \r\n to \n line terminators. */
    src = strchr(ast_str_buffer(buf), '\r');
    if (src) {
        dest = src;
        ++src;
        while (*src) {
            if (*src == '\r') {
                ++src;
                continue;
            }
            *dest++ = *src++;
        }
        *dest = '\0';
        ast_str_update(buf);
    }
 
    /* Reformat AMI key value pairs to pretty columns */
    key = ast_str_buffer(buf);
    do {
        value = strchr(key, ':');
        if (!value) {
            break;
        }
        value_end = strchr(value, '\n');
        if (!value_end) {
            break;
        }
 
        /* Calculate field lengths */
        key_len = value - key;
        key_filler_width = 20 - key_len;
        if (key_filler_width < 0) {
            key_filler_width = 0;
        }
        value_len = value_end - value;
 
        ast_cli(cli->a->fd, "%.*s%*s%.*s\n",
            key_len, key, key_filler_width, "",
            value_len, value);
 
        key = value_end + 1;
    } while (*key);
    ast_cli(cli->a->fd, "\n");
 
    ast_free(buf);
 
    return -1;
}

References ast_cli(), ast_free, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_update(), buf, cli_sub_complete_parms::callid, cli, cli_subscription_expiry(), sip_subscription_tree::dlg, ast_sip_subscription_handler::event_name, ast_sip_subscription::handler, if(), ast_sip_subscription::resource, sip_subscription_tree::root, sip_subscription_to_ami(), and value.

Referenced by cli_show_subscription_inbound(), and cli_show_subscription_outbound().

cli_show_subscription_inbound()

static int cli_show_subscription_inbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4561 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_NOTIFIER
        ? cli_show_subscription_common(sub_tree, arg) : 0;
}

References AST_SIP_NOTIFIER, cli_show_subscription_common(), and sip_subscription_tree::role.

Referenced by cli_show_subscription_inout().

cli_show_subscription_inout()

static char * cli_show_subscription_inout ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 4573 of file res_pjsip_pubsub.c.

{
    on_subscription_t on_subscription;
    struct cli_sub_parms cli;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip show subscription {inbound|outbound}";
        e->usage = "Usage:\n"
                   "   pjsip show subscription inbound <call-id>\n"
                   "   pjsip show subscription outbound <call-id>\n"
                   "      Show active subscription with the dialog call-id\n";
        return NULL;
    case CLI_GENERATE:
        return cli_complete_subscription_callid(a);
    }
 
    if (a->argc != 5) {
        return CLI_SHOWUSAGE;
    }
 
    if (!strcasecmp(a->argv[3], "inbound")) {
        on_subscription = cli_show_subscription_inbound;
    } else if (!strcasecmp(a->argv[3], "outbound")) {
        on_subscription = cli_show_subscription_outbound;
    } else {
        /* Should never get here */
        ast_assert(0);
        return NULL;
    }
 
    /* Find the subscription with the specified call-id */
    cli.a = a;
    cli.e = e;
    cli.buf = (void *) a->argv[4];/* Repurpose the buf member to pass in callid */
    for_each_subscription(on_subscription, &cli);
 
    return CLI_SUCCESS;
}

References a, ast_assert, cli, cli_complete_subscription_callid(), CLI_GENERATE, CLI_INIT, cli_show_subscription_inbound(), cli_show_subscription_outbound(), CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, cli_sub_parms::e, for_each_subscription(), NULL, and ast_cli_entry::usage.

cli_show_subscription_outbound()

static int cli_show_subscription_outbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4567 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_SUBSCRIBER
        ? cli_show_subscription_common(sub_tree, arg) : 0;
}

References AST_SIP_SUBSCRIBER, cli_show_subscription_common(), and sip_subscription_tree::role.

Referenced by cli_show_subscription_inout().

cli_show_subscriptions_detail()

static int cli_show_subscriptions_detail ( struct sip_subscription_tree *  sub_tree, struct cli_sub_parms *  cli  )

static

Definition at line 4623 of file res_pjsip_pubsub.c.

{
    char caller_id[256];
    char callid[256];
 
    ast_callerid_merge(caller_id, sizeof(caller_id),
        S_COR(sub_tree->endpoint->id.self.name.valid,
            sub_tree->endpoint->id.self.name.str, NULL),
        S_COR(sub_tree->endpoint->id.self.number.valid,
            sub_tree->endpoint->id.self.number.str, NULL),
        "<none>");
 
    /* Call-id */
    if (sub_tree->dlg) {
        ast_copy_pj_str(callid, &sub_tree->dlg->call_id->id, sizeof(callid));
    } else {
        ast_copy_string(callid, "<unknown>", sizeof(callid));
    }
 
    ast_str_set(&cli->buf, 0, CLI_SHOW_SUB_FORMAT_ENTRY,
        ast_sorcery_object_get_id(sub_tree->endpoint), caller_id,
        sub_tree->root->resource, sub_tree->root->handler->event_name,
        cli_subscription_expiry(sub_tree), callid);
 
    if (cli->like) {
        if (regexec(cli->like, ast_str_buffer(cli->buf), 0, NULL, 0)) {
            /* Output line did not match the regex */
            return 0;
        }
    }
 
    ast_cli(cli->a->fd, "%s", ast_str_buffer(cli->buf));
    ++cli->count;
 
    return 0;
}

References ast_callerid_merge(), ast_cli(), ast_copy_pj_str(), ast_copy_string(), ast_sorcery_object_get_id(), ast_str_buffer(), ast_str_set(), cli, CLI_SHOW_SUB_FORMAT_ENTRY, cli_subscription_expiry(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, ast_sip_subscription_handler::event_name, ast_sip_subscription::handler, ast_sip_endpoint::id, ast_party_id::name, NULL, ast_party_id::number, ast_sip_subscription::resource, sip_subscription_tree::root, S_COR, ast_sip_endpoint_id_configuration::self, ast_party_name::str, ast_party_number::str, ast_party_name::valid, and ast_party_number::valid.

Referenced by cli_show_subscriptions_inbound(), and cli_show_subscriptions_outbound().

cli_show_subscriptions_inbound()

static int cli_show_subscriptions_inbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4660 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_NOTIFIER
        ? cli_show_subscriptions_detail(sub_tree, arg) : 0;
}

References AST_SIP_NOTIFIER, cli_show_subscriptions_detail(), and sip_subscription_tree::role.

Referenced by cli_show_subscriptions_inout().

cli_show_subscriptions_inout()

static char * cli_show_subscriptions_inout ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 4672 of file res_pjsip_pubsub.c.

{
    on_subscription_t on_subscription;
    struct cli_sub_parms cli;
    regex_t like;
    const char *regex;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip show subscriptions {inbound|outbound} [like]";
        e->usage = "Usage:\n"
                   "   pjsip show subscriptions inbound [like <regex>]\n"
                   "      Show active inbound subscriptions\n"
                   "   pjsip show subscriptions outbound [like <regex>]\n"
                   "      Show active outbound subscriptions\n"
                   "\n"
                   "   The regex selects a subscriptions output that matches.\n"
                   "   i.e.,  All output lines for a subscription are checked\n"
                   "   as a block by the regex.\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 4 && a->argc != 6) {
        return CLI_SHOWUSAGE;
    }
    if (!strcasecmp(a->argv[3], "inbound")) {
        on_subscription = cli_show_subscriptions_inbound;
    } else if (!strcasecmp(a->argv[3], "outbound")) {
        on_subscription = cli_show_subscriptions_outbound;
    } else {
        /* Should never get here */
        ast_assert(0);
        return CLI_SHOWUSAGE;
    }
    if (a->argc == 6) {
        int rc;
 
        if (strcasecmp(a->argv[4], "like")) {
            return CLI_SHOWUSAGE;
        }
 
        /* Setup regular expression */
        memset(&like, 0, sizeof(like));
        cli.like = &like;
        regex = a->argv[5];
        rc = regcomp(cli.like, regex, REG_EXTENDED | REG_NOSUB);
        if (rc) {
            char *regerr = ast_alloca(MAX_REGEX_ERROR_LEN);
 
            regerror(rc, cli.like, regerr, MAX_REGEX_ERROR_LEN);
            ast_cli(a->fd, "Regular expression '%s' failed to compile: %s\n",
                regex, regerr);
            return CLI_FAILURE;
        }
    } else {
        cli.like = NULL;
        regex = NULL;
    }
 
    cli.a = a;
    cli.e = e;
    cli.count = 0;
    cli.buf = ast_str_create(256);
    if (!cli.buf) {
        if (cli.like) {
            regfree(cli.like);
        }
        return CLI_FAILURE;
    }
 
    ast_cli(a->fd, CLI_SHOW_SUB_FORMAT_HEADER);
    for_each_subscription(on_subscription, &cli);
    ast_cli(a->fd, "%d active subscriptions%s%s%s\n",
        cli.count,
        regex ? " matched \"" : "",
        regex ?: "",
        regex ? "\"" : "");
 
    ast_free(cli.buf);
    if (cli.like) {
        regfree(cli.like);
    }
 
    return CLI_SUCCESS;
}

References a, ast_alloca, ast_assert, ast_cli(), ast_free, ast_str_create, cli, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOW_SUB_FORMAT_HEADER, cli_show_subscriptions_inbound(), cli_show_subscriptions_outbound(), CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, cli_sub_parms::e, for_each_subscription(), cli_sub_parms::like, MAX_REGEX_ERROR_LEN, NULL, regex(), and ast_cli_entry::usage.

cli_show_subscriptions_outbound()

static int cli_show_subscriptions_outbound ( struct sip_subscription_tree *  sub_tree, void *  arg  )

static

Definition at line 4666 of file res_pjsip_pubsub.c.

{
    return sub_tree->role == AST_SIP_SUBSCRIBER
        ? cli_show_subscriptions_detail(sub_tree, arg) : 0;
}

References AST_SIP_SUBSCRIBER, cli_show_subscriptions_detail(), and sip_subscription_tree::role.

Referenced by cli_show_subscriptions_inout().

cli_subscription_expiry()

static unsigned int cli_subscription_expiry ( struct sip_subscription_tree *  sub_tree )

static

Definition at line 4460 of file res_pjsip_pubsub.c.

{
    int expiry;
 
    expiry = sub_tree->persistence
        ? ast_tvdiff_ms(sub_tree->persistence->expires, ast_tvnow()) / 1000
        : 0;
    if (expiry < 0) {
        /* Subscription expired */
        expiry = 0;
    }
    return expiry;
}

References ast_tvdiff_ms(), ast_tvnow(), subscription_persistence::expires, and sip_subscription_tree::persistence.

Referenced by cli_list_subscriptions_detail(), cli_show_subscription_common(), and cli_show_subscriptions_detail().

cmp_strings()

static int cmp_strings ( char *  s1, char *  s2  )

static

Compare strings for equality checking for NULL.

This function considers NULL values as empty strings. This means NULL or empty strings are equal.

Return values

0	The strings are equal
1	The strings are not equal

Definition at line 4021 of file res_pjsip_pubsub.c.

{
    if (!ast_strlen_zero(s1) && !ast_strlen_zero(s2)) {
        return strcmp(s1, s2);
    }
 
    return ast_strlen_zero(s1) == ast_strlen_zero(s2) ? 0 : 1;
}

References ast_strlen_zero().

Referenced by cmp_subscription_childrens().

cmp_subscription_childrens()

static int cmp_subscription_childrens ( struct ast_sip_subscription *  s1, struct ast_sip_subscription *  s2  )

static

compares the childrens of two ast_sip_subscription s1 and s2

Return values

0	The s1 childrens match the s2 childrens
1	The s1 childrens do not match the s2 childrens

Definition at line 4036 of file res_pjsip_pubsub.c.

{
    int i;
 
    if (AST_VECTOR_SIZE(&s1->children) != AST_VECTOR_SIZE(&s2->children)) {
        return 1;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(&s1->children); ++i) {
        struct ast_sip_subscription *c1 = AST_VECTOR_GET(&s1->children, i);
        struct ast_sip_subscription *c2 = AST_VECTOR_GET(&s2->children, i);
 
        if (cmp_strings(c1->resource, c2->resource)
            || cmp_strings(c1->display_name, c2->display_name)) {
 
            return 1;
        }
    }
 
    return 0;
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_subscription::children, cmp_strings(), ast_sip_subscription::display_name, and ast_sip_subscription::resource.

Referenced by pubsub_on_rx_refresh().

create_multipart_body()

static pjsip_msg_body * create_multipart_body ( pj_pool_t *  pool )

static

Create and initialize the PJSIP multipart body structure for a resource list subscription.

Parameters

pool

Returns

The multipart message body

Definition at line 2338 of file res_pjsip_pubsub.c.

{
    pjsip_media_type media_type;
    pjsip_param *media_type_param;
    char boundary[6];
    pj_str_t pj_boundary;
 
    pjsip_media_type_init2(&media_type, "multipart", "related");
 
    media_type_param = pj_pool_alloc(pool, sizeof(*media_type_param));
    pj_list_init(media_type_param);
 
    pj_strdup2(pool, &media_type_param->name, "type");
    pj_strdup2(pool, &media_type_param->value, "\"application/rlmi+xml\"");
 
    pj_list_insert_before(&media_type.param, media_type_param);
 
    pj_cstr(&pj_boundary, ast_generate_random_string(boundary, sizeof(boundary)));
    return pjsip_multipart_create(pool, &media_type, &pj_boundary);
}

References ast_generate_random_string().

Referenced by generate_list_body().

create_require_eventlist()

static pjsip_require_hdr * create_require_eventlist ( pj_pool_t *  pool )

static

Shortcut method to create a Require: eventlist header.

Definition at line 2451 of file res_pjsip_pubsub.c.

{
    pjsip_require_hdr *require;
 
    require = pjsip_require_hdr_create(pool);
    pj_strdup2(pool, &require->values[0], "eventlist");
    require->count = 1;
 
    return require;
}

Referenced by pubsub_on_rx_refresh(), send_notify(), and sip_subscription_accept().

create_subscription_tree()

static struct sip_subscription_tree * create_subscription_tree ( const struct ast_sip_subscription_handler *  handler, struct ast_sip_endpoint *  endpoint, pjsip_rx_data *  rdata, const char *  resource, struct ast_sip_pubsub_body_generator *  generator, struct resource_tree *  tree, pj_status_t *  dlg_status, struct subscription_persistence *  persistence  )

static

Create a subscription tree based on a resource tree.

Using the previously-determined valid resources in the provided resource tree, a corresponding tree of ast_sip_subscriptions are created. The root of the subscription tree is a real subscription, and the rest in the tree are virtual subscriptions.

Parameters

	handler	The handler to use for leaf subscriptions
	endpoint	The endpoint that sent the SUBSCRIBE request
	rdata	The SUBSCRIBE content
	resource	The requested resource in the SUBSCRIBE request
	generator	The body generator to use in leaf subscriptions
	tree	The resource tree on which the subscription tree is based
[out]	dlg_status	The result of attempting to create a dialog
	persistence

Return values

NULL	Could not create the subscription tree
non-NULL	The root of the created subscription tree

Definition at line 1506 of file res_pjsip_pubsub.c.

{
    struct sip_subscription_tree *sub_tree;
    pjsip_dialog *dlg;
 
    sub_tree = allocate_subscription_tree(endpoint, rdata);
    if (!sub_tree) {
        *dlg_status = PJ_ENOMEM;
        return NULL;
    }
    sub_tree->role = AST_SIP_NOTIFIER;
 
    dlg = ast_sip_create_dialog_uas_locked(endpoint, rdata, dlg_status);
    if (!dlg) {
        if (*dlg_status != PJ_EEXISTS) {
            ast_log(LOG_WARNING, "Unable to create dialog for SIP subscription\n");
        }
        ao2_ref(sub_tree, -1);
        return NULL;
    }
 
    persistence = ast_sip_mod_data_get(rdata->endpt_info.mod_data,
            pubsub_module.id, MOD_DATA_PERSISTENCE);
    if (persistence) {
        /* Update the created dialog with the persisted information */
        pjsip_ua_unregister_dlg(pjsip_ua_instance(), dlg);
        pj_strdup2(dlg->pool, &dlg->local.info->tag, persistence->tag);
        dlg->local.tag_hval = pj_hash_calc_tolower(0, NULL, &dlg->local.info->tag);
        pjsip_ua_register_dlg(pjsip_ua_instance(), dlg);
        dlg->local.cseq = persistence->cseq;
    }
 
    pjsip_evsub_create_uas(dlg, &pubsub_cb, rdata, 0, &sub_tree->evsub);
 
    subscription_setup_dialog(sub_tree, dlg);
 
    /*
     * The evsub and subscription setup both add dialog refs, so the dialog ref that
     * was added when the dialog was created (see ast_sip_create_dialog_uas_lock) can
     * now be removed. The lock should no longer be needed so can be removed too.
     */
    pjsip_dlg_dec_lock(dlg);
 
#ifdef HAVE_PJSIP_EVSUB_GRP_LOCK
    pjsip_evsub_add_ref(sub_tree->evsub);
#endif
 
    ast_sip_mod_data_set(dlg->pool, dlg->mod_data, pubsub_module.id, MOD_DATA_MSG,
            pjsip_msg_clone(dlg->pool, rdata->msg_info.msg));
 
    sub_tree->notification_batch_interval = tree->notification_batch_interval;
 
    /* Persistence information needs to be available for all the subscriptions */
    sub_tree->persistence = ao2_bump(persistence);
 
    sub_tree->root = create_virtual_subscriptions(handler, resource, generator, sub_tree, tree->root);
    if (AST_VECTOR_SIZE(&sub_tree->root->children) > 0) {
        sub_tree->is_list = 1;
    }
 
    add_subscription(sub_tree);
 
    return sub_tree;
}

References add_subscription(), allocate_subscription_tree(), ao2_bump, ao2_ref, ast_log, ast_sip_create_dialog_uas_locked(), ast_sip_mod_data_get, ast_sip_mod_data_set, AST_SIP_NOTIFIER, AST_VECTOR_SIZE, ast_sip_subscription::children, create_virtual_subscriptions(), subscription_persistence::cseq, sip_subscription_tree::dlg, sip_subscription_tree::endpoint, sip_subscription_tree::evsub, handler(), sip_subscription_tree::is_list, LOG_WARNING, MOD_DATA_MSG, MOD_DATA_PERSISTENCE, sip_subscription_tree::notification_batch_interval, resource_tree::notification_batch_interval, NULL, sip_subscription_tree::persistence, pubsub_cb, pubsub_module, sip_subscription_tree::role, sip_subscription_tree::root, resource_tree::root, subscription_setup_dialog(), and subscription_persistence::tag.

Referenced by pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

create_virtual_subscriptions()

static struct ast_sip_subscription * create_virtual_subscriptions ( const struct ast_sip_subscription_handler *  handler, const char *  resource, struct ast_sip_pubsub_body_generator *  generator, struct sip_subscription_tree *  tree, struct tree_node *  current  )

static

Create a tree of virtual subscriptions based on a resource tree node.

Parameters

handler	The handler to supply to leaf subscriptions.
resource	The requested resource for this subscription.
generator	Body generator to use for leaf subscriptions.
tree	The root of the subscription tree.
current	The tree node that corresponds to the subscription being created.

Definition at line 1325 of file res_pjsip_pubsub.c.

{
    int i;
    struct ast_sip_subscription *sub;
 
    sub = allocate_subscription(handler, resource, current->display_name, tree);
    if (!sub) {
        return NULL;
    }
 
    sub->full_state = current->full_state;
    sub->body_generator = generator;
    AST_VECTOR_INIT(&sub->children, AST_VECTOR_SIZE(&current->children));
 
    for (i = 0; i < AST_VECTOR_SIZE(&current->children); ++i) {
        struct ast_sip_subscription *child;
        struct tree_node *child_node = AST_VECTOR_GET(&current->children, i);
 
        child = create_virtual_subscriptions(handler, child_node->resource, generator,
                tree, child_node);
 
        if (!child) {
            ast_debug(1, "Child subscription to resource %s could not be created\n",
                    child_node->resource);
            continue;
        }
 
        if (AST_VECTOR_APPEND(&sub->children, child)) {
            ast_debug(1, "Child subscription to resource %s could not be appended\n",
                    child_node->resource);
            destroy_subscription(child);
            /* Have to release tree here too because a ref was added
             * to child that destroy_subscription() doesn't release. */
            ao2_cleanup(tree);
        }
    }
 
    return sub;
}

References allocate_subscription(), ao2_cleanup, ast_debug, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, create_virtual_subscriptions(), current, destroy_subscription(), handler(), NULL, ast_sip_subscription::resource, tree_node::resource, sub, and ast_sip_subscription::tree.

Referenced by create_subscription_tree(), create_virtual_subscriptions(), and pubsub_on_rx_refresh().

destroy_subscription()

static void destroy_subscription ( struct ast_sip_subscription *  sub )

static

Definition at line 1230 of file res_pjsip_pubsub.c.

{
    ast_debug(3, "Destroying SIP subscription from '%s->%s'\n",
        sub->tree && sub->tree->endpoint ? ast_sorcery_object_get_id(sub->tree->endpoint) : "Unknown",
        sub->resource);
 
    ast_free(sub->body_text);
 
    AST_VECTOR_FREE(&sub->children);
    ao2_cleanup(sub->datastores);
    ast_json_unref(sub->persistence_data);
    ast_free(sub->display_name);
    ast_free(sub);
}

References ao2_cleanup, ast_debug, ast_free, ast_json_unref(), ast_sorcery_object_get_id(), AST_VECTOR_FREE, and sub.

Referenced by allocate_subscription(), create_virtual_subscriptions(), and destroy_subscriptions().

destroy_subscriptions()

static void destroy_subscriptions ( struct ast_sip_subscription *  root )

static

Definition at line 1245 of file res_pjsip_pubsub.c.

{
    int i;
 
    if (!root) {
        return;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(&root->children); ++i) {
        struct ast_sip_subscription *child;
 
        child = AST_VECTOR_GET(&root->children, i);
        destroy_subscriptions(child);
    }
 
    destroy_subscription(root);
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_subscription::children, destroy_subscription(), destroy_subscriptions(), and sip_subscription_tree::root.

Referenced by destroy_subscriptions(), destroy_subscriptions_task(), pubsub_on_rx_refresh(), and subscription_tree_destructor().

destroy_subscriptions_task()

static int destroy_subscriptions_task ( void *  obj )

static

Definition at line 4058 of file res_pjsip_pubsub.c.

{
    struct ast_sip_subscription *sub = (struct ast_sip_subscription *) obj;
 
    destroy_subscriptions(sub);
 
    return 0;
}

References destroy_subscriptions(), and sub.

Referenced by pubsub_on_rx_refresh().

determine_sip_publish_type()

static enum sip_publish_type determine_sip_publish_type ( pjsip_rx_data *  rdata, pjsip_generic_string_hdr *  etag_hdr, unsigned int *  expires, int *  entity_id  )

static

Definition at line 3168 of file res_pjsip_pubsub.c.

{
    pjsip_expires_hdr *expires_hdr = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES, NULL);
 
    if (etag_hdr) {
        char etag[pj_strlen(&etag_hdr->hvalue) + 1];
 
        ast_copy_pj_str(etag, &etag_hdr->hvalue, sizeof(etag));
 
        if (sscanf(etag, "%30d", entity_id) != 1) {
            return SIP_PUBLISH_UNKNOWN;
        }
    }
 
    *expires = expires_hdr ? expires_hdr->ivalue : DEFAULT_PUBLISH_EXPIRES;
 
    if (!(*expires)) {
        return SIP_PUBLISH_REMOVE;
    } else if (!etag_hdr && rdata->msg_info.msg->body) {
        return SIP_PUBLISH_INITIAL;
    } else if (etag_hdr && !rdata->msg_info.msg->body) {
        return SIP_PUBLISH_REFRESH;
    } else if (etag_hdr && rdata->msg_info.msg->body) {
        return SIP_PUBLISH_MODIFY;
    }
 
    return SIP_PUBLISH_UNKNOWN;
}

References ast_copy_pj_str(), DEFAULT_PUBLISH_EXPIRES, NULL, SIP_PUBLISH_INITIAL, SIP_PUBLISH_MODIFY, SIP_PUBLISH_REFRESH, SIP_PUBLISH_REMOVE, and SIP_PUBLISH_UNKNOWN.

Referenced by pubsub_on_rx_publish_request().

exceptional_accept()

static int exceptional_accept ( const pj_str_t *  accept )

static

Is the Accept header from the SUBSCRIBE in the list of exceptions?

Return values

1	This Accept header value is an exception to the rule.
0	This Accept header is not an exception to the rule.

Definition at line 833 of file res_pjsip_pubsub.c.

{
    int i;
 
    for (i = 0; i < ARRAY_LEN(accept_exceptions); ++i) {
        if (!pj_strcmp2(accept, accept_exceptions[i])) {
            return 1;
        }
    }
 
    return 0;
}

References ast_sip_subscription_handler::accept, accept_exceptions, and ARRAY_LEN.

Referenced by subscription_get_generator_from_rdata().

find_body_generator()

static struct ast_sip_pubsub_body_generator * find_body_generator ( char  accept[AST_SIP_MAX_ACCEPT][64], size_t  num_accept, const char *  body_type  )

static

Definition at line 2926 of file res_pjsip_pubsub.c.

{
    int i;
    struct ast_sip_pubsub_body_generator *generator = NULL;
 
    for (i = 0; i < num_accept; ++i) {
        generator = find_body_generator_accept(accept[i]);
        if (generator) {
            ast_debug(3, "Body generator %p found for accept type %s\n", generator, accept[i]);
            if (strcmp(generator->body_type, body_type)) {
                ast_log(LOG_WARNING, "Body generator '%s/%s'(%p) does not accept the type of data this event generates\n",
                        generator->type, generator->subtype, generator);
                generator = NULL;
                continue;
            }
            break;
        } else {
            ast_debug(3, "No body generator found for accept type %s\n", accept[i]);
        }
    }
 
    return generator;
}

References ast_debug, ast_log, ast_sip_pubsub_body_generator::body_type, find_body_generator_accept(), LOG_WARNING, NULL, ast_sip_pubsub_body_generator::subtype, and ast_sip_pubsub_body_generator::type.

Referenced by subscription_get_generator_from_rdata().

find_body_generator_accept()

static struct ast_sip_pubsub_body_generator * find_body_generator_accept ( const char *  accept )

static

Definition at line 2913 of file res_pjsip_pubsub.c.

{
    char *accept_copy = ast_strdupa(accept);
    char *subtype = accept_copy;
    char *type = strsep(&subtype, "/");
 
    if (ast_strlen_zero(type) || ast_strlen_zero(subtype)) {
        return NULL;
    }
 
    return find_body_generator_type_subtype(type, subtype);
}

References ast_strdupa, ast_strlen_zero(), find_body_generator_type_subtype(), NULL, strsep(), ast_sip_pubsub_body_generator::subtype, and type.

Referenced by find_body_generator().

find_body_generator_type_subtype()

static struct ast_sip_pubsub_body_generator * find_body_generator_type_subtype ( const char *  type, const char *  subtype  )

static

Definition at line 2903 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_generator *gen;
 
    AST_RWLIST_RDLOCK(&body_generators);
    gen = find_body_generator_type_subtype_nolock(type, subtype);
    AST_RWLIST_UNLOCK(&body_generators);
    return gen;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, find_body_generator_type_subtype_nolock(), gen, ast_sip_pubsub_body_generator::subtype, and type.

Referenced by ast_sip_pubsub_generate_body_content(), ast_sip_pubsub_is_body_generator_registered(), and find_body_generator_accept().

find_body_generator_type_subtype_nolock()

static struct ast_sip_pubsub_body_generator * find_body_generator_type_subtype_nolock ( const char *  type, const char *  subtype  )

static

Definition at line 2889 of file res_pjsip_pubsub.c.

{
    struct ast_sip_pubsub_body_generator *gen;
 
    AST_LIST_TRAVERSE(&body_generators, gen, list) {
        if (!strcmp(gen->type, type)
            && !strcmp(gen->subtype, subtype)) {
            break;
        }
    }
 
    return gen;
}

References AST_LIST_TRAVERSE, gen, ast_sip_pubsub_body_generator::list, ast_sip_pubsub_body_generator::subtype, and type.

Referenced by ast_sip_pubsub_register_body_generator(), and find_body_generator_type_subtype().

find_pub_handler()

static struct ast_sip_publish_handler * find_pub_handler ( const char *  event )

static

Definition at line 3150 of file res_pjsip_pubsub.c.

{
    struct ast_sip_publish_handler *iter = NULL;
 
    AST_RWLIST_RDLOCK(&publish_handlers);
    AST_RWLIST_TRAVERSE(&publish_handlers, iter, next) {
        if (strcmp(event, iter->event_name)) {
            ast_debug(3, "Event %s does not match %s\n", event, iter->event_name);
            continue;
        }
        ast_debug(3, "Event name match: %s = %s\n", event, iter->event_name);
        break;
    }
    AST_RWLIST_UNLOCK(&publish_handlers);
 
    return iter;
}

References ast_debug, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sip_publish_handler::event_name, ast_sip_publish_handler::next, and NULL.

Referenced by pubsub_on_rx_publish_request().

find_sub_handler_for_event_name()

static struct ast_sip_subscription_handler * find_sub_handler_for_event_name ( const char *  event_name )

static

Definition at line 2827 of file res_pjsip_pubsub.c.

{
    struct ast_sip_subscription_handler *iter;
 
    AST_RWLIST_RDLOCK(&subscription_handlers);
    AST_RWLIST_TRAVERSE(&subscription_handlers, iter, next) {
        if (!strcmp(iter->event_name, event_name)) {
            break;
        }
    }
    AST_RWLIST_UNLOCK(&subscription_handlers);
    return iter;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sip_subscription_handler::event_name, and ast_sip_subscription_handler::next.

Referenced by ast_sip_register_subscription_handler(), and subscription_get_handler_from_rdata().

for_each_subscription()

static int for_each_subscription ( on_subscription_t  on_subscription, void *  arg  )

static

Definition at line 1841 of file res_pjsip_pubsub.c.

{
    int num = 0;
    struct sip_subscription_tree *i;
 
    if (!on_subscription) {
        return num;
    }
 
    AST_RWLIST_RDLOCK(&subscriptions);
    AST_RWLIST_TRAVERSE(&subscriptions, i, next) {
        if (on_subscription(i, arg)) {
            break;
        }
        ++num;
    }
    AST_RWLIST_UNLOCK(&subscriptions);
    return num;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, and sip_subscription_tree::next.

Referenced by ami_show_subscriptions_inbound(), ami_show_subscriptions_outbound(), cli_complete_subscription_callid(), cli_list_subscriptions_inout(), cli_show_subscription_inout(), and cli_show_subscriptions_inout().

format_ami_resource_lists()

static int format_ami_resource_lists ( void *  obj, void *  arg, int  flags  )

static

Definition at line 4329 of file res_pjsip_pubsub.c.

{
    struct resource_list *list = obj;
    struct ast_sip_ami *ami = arg;
    struct ast_str *buf;
 
    buf = ast_sip_create_ami_event("ResourceListDetail", ami);
    if (!buf) {
        return CMP_STOP;
    }
 
    if (ast_sip_sorcery_object_to_ami(list, &buf)) {
        ast_free(buf);
        return CMP_STOP;
    }
    astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
    ast_free(buf);
 
    ++ami->count;
    return 0;
}

References ast_sip_ami::arg, ast_free, ast_sip_create_ami_event(), ast_sip_sorcery_object_to_ami(), ast_str_buffer(), astman_append(), buf, CMP_STOP, ast_sip_ami::count, and ast_sip_ami::s.

Referenced by ami_show_resource_lists().

free_body_parts()

static void free_body_parts ( struct body_part_list *  parts )

static

Destroy a list of body parts.

Parameters

parts

The container of parts to destroy

Definition at line 2261 of file res_pjsip_pubsub.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(parts); ++i) {
        struct body_part *part = AST_VECTOR_GET(parts, i);
        ast_free(part);
    }
 
    AST_VECTOR_FREE(parts);
}

References ast_free, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, and body_part::part.

Referenced by generate_list_body().

generate_content_id_hdr()

static pjsip_generic_string_hdr * generate_content_id_hdr ( pj_pool_t *  pool, const struct ast_sip_subscription *  sub  )

static

Create a Content-ID header.

Content-ID headers are required by RFC2387 for multipart/related bodies. They serve as identifiers for each part of the multipart body.

Parameters

pool	PJLIB allocation pool
sub	Subscription to a resource

Definition at line 2153 of file res_pjsip_pubsub.c.

{
    static const pj_str_t cid_name = { "Content-ID", 10 };
    pjsip_generic_string_hdr *cid;
    char id[6];
    size_t alloc_size;
    pj_str_t cid_value;
 
    /* '<' + '@' + '>' = 3. pj_str_t does not require a null-terminator */
    alloc_size = sizeof(id) + pj_strlen(&sub->uri->host) + 3;
    cid_value.ptr = pj_pool_alloc(pool, alloc_size);
    cid_value.slen = sprintf(cid_value.ptr, "<%s@%.*s>",
            ast_generate_random_string(id, sizeof(id)),
            (int) pj_strlen(&sub->uri->host), pj_strbuf(&sub->uri->host));
    cid = pjsip_generic_string_hdr_create(pool, &cid_name, &cid_value);
 
    return cid;
}

References ast_generate_random_string(), id, and sub.

Referenced by allocate_body_part(), and build_rlmi_body().

generate_initial_notify()

static int generate_initial_notify ( struct ast_sip_subscription *  sub )

static

Definition at line 2951 of file res_pjsip_pubsub.c.

{
    void *notify_data;
    int res;
    struct ast_sip_body_data data = {
        .body_type = sub->handler->body_type,
    };
 
    if (AST_VECTOR_SIZE(&sub->children) > 0) {
        int i;
 
        for (i = 0; i < AST_VECTOR_SIZE(&sub->children); ++i) {
            if (generate_initial_notify(AST_VECTOR_GET(&sub->children, i))) {
                return -1;
            }
        }
 
        return 0;
    }
 
    /* We notify subscription establishment only on the tree leaves. */
    if (sub->handler->notifier->subscription_established(sub)) {
        return -1;
    }
 
    notify_data = sub->handler->notifier->get_notify_data(sub);
    if (!notify_data) {
        ast_debug(3, "No notify data, not generating any body content\n");
        return -1;
    }
 
    data.body_data = notify_data;
 
    res = ast_sip_pubsub_generate_body_content(ast_sip_subscription_get_body_type(sub),
            ast_sip_subscription_get_body_subtype(sub), &data, &sub->body_text);
 
    ao2_cleanup(notify_data);
 
    return res;
}

References ao2_cleanup, ast_debug, ast_sip_pubsub_generate_body_content(), ast_sip_subscription_get_body_subtype(), ast_sip_subscription_get_body_type(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_body_data::body_data, ast_sip_body_data::body_type, generate_initial_notify(), and sub.

Referenced by generate_initial_notify(), initial_notify_task(), and pubsub_on_refresh_timeout().

generate_list_body()

static pjsip_msg_body * generate_list_body ( pj_pool_t *  pool, struct ast_sip_subscription *  sub, unsigned int  force_full_state  )

static

Create a resource list body for NOTIFY requests.

Resource list bodies are multipart/related bodies. The first part of the multipart body is an RLMI body that describes the rest of the parts to come. The other parts of the body convey state of individual subscribed resources.

Parameters

pool	PJLIB allocation pool
sub	Subscription details from which to generate body
force_full_state	If true, ignore resource list settings and send a full state notification

Returns

The generated multipart/related body

Definition at line 2371 of file res_pjsip_pubsub.c.

{
    int i;
    pjsip_multipart_part *rlmi_part;
    pjsip_msg_body *multipart;
    struct body_part_list body_parts;
    unsigned int use_full_state = force_full_state ? 1 : sub->full_state;
 
    if (AST_VECTOR_INIT(&body_parts, AST_VECTOR_SIZE(&sub->children))) {
        return NULL;
    }
 
    for (i = 0; i < AST_VECTOR_SIZE(&sub->children); ++i) {
        build_body_part(pool, AST_VECTOR_GET(&sub->children, i), &body_parts, use_full_state);
    }
 
    /* This can happen if issuing partial state and no children of the list have changed state */
    if (AST_VECTOR_SIZE(&body_parts) == 0) {
        free_body_parts(&body_parts);
        return NULL;
    }
 
    multipart = create_multipart_body(pool);
 
    rlmi_part = build_rlmi_body(pool, sub, &body_parts, use_full_state);
    if (!rlmi_part) {
        free_body_parts(&body_parts);
        return NULL;
    }
    pjsip_multipart_add_part(pool, multipart, rlmi_part);
 
    for (i = 0; i < AST_VECTOR_SIZE(&body_parts); ++i) {
        pjsip_multipart_add_part(pool, multipart, AST_VECTOR_GET(&body_parts, i)->part);
    }
 
    free_body_parts(&body_parts);
    return multipart;
}

References AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, build_body_part(), build_rlmi_body(), create_multipart_body(), free_body_parts(), NULL, and sub.

Referenced by generate_notify_body().

generate_notify_body()

static pjsip_msg_body * generate_notify_body ( pj_pool_t *  pool, struct ast_sip_subscription *  root, unsigned int  force_full_state  )

static

Create the body for a NOTIFY request.

Parameters

pool	The pool used for allocations
root	The root of the subscription tree
force_full_state	If true, ignore resource list settings and send a full state notification

Definition at line 2418 of file res_pjsip_pubsub.c.

{
    pjsip_msg_body *body;
 
    if (AST_VECTOR_SIZE(&root->children) == 0) {
        if (force_full_state || root->body_changed) {
            /* Not a list. We've already generated the body and saved it on the subscription.
             * Use that directly.
             */
            pj_str_t type;
            pj_str_t subtype;
            pj_str_t text;
 
            pj_cstr(&type, ast_sip_subscription_get_body_type(root));
            pj_cstr(&subtype, ast_sip_subscription_get_body_subtype(root));
            pj_cstr(&text, ast_str_buffer(root->body_text));
 
            body = pjsip_msg_body_create(pool, &type, &subtype, &text);
            root->body_changed = 0;
        } else {
            body = NULL;
        }
    } else {
        body = generate_list_body(pool, root, force_full_state);
    }
 
    return body;
}

References ast_sip_subscription_get_body_subtype(), ast_sip_subscription_get_body_type(), ast_str_buffer(), AST_VECTOR_SIZE, ast_sip_subscription::body_changed, ast_sip_subscription::body_text, ast_sip_subscription::children, generate_list_body(), NULL, text, and type.

Referenced by build_body_part(), and send_notify().

have_visited()

static int have_visited ( const char *  resource, struct resources *  visited  )

static

Determine if this resource has been visited already.

See build_resource_tree for more information

Parameters

resource	The resource currently being visited
visited	The resources that have previously been visited

Definition at line 1008 of file res_pjsip_pubsub.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(visited); ++i) {
        if (!strcmp(resource, AST_VECTOR_GET(visited, i))) {
            return 1;
        }
    }
 
    return 0;
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, and tree_node::resource.

Referenced by build_node_children().

initial_notify_task()

static int initial_notify_task ( void *  obj )

static

Definition at line 2994 of file res_pjsip_pubsub.c.

{
    struct initial_notify_data *ind = obj;
 
    if (generate_initial_notify(ind->sub_tree->root)) {
        pjsip_evsub_terminate(ind->sub_tree->evsub, PJ_TRUE);
    } else {
        send_notify(ind->sub_tree, 1);
        ast_test_suite_event_notify("SUBSCRIPTION_ESTABLISHED",
            "Resource: %s",
            ind->sub_tree->root->resource);
    }
 
    if (ind->expires != PJSIP_EXPIRES_NOT_SPECIFIED) {
        char *name = ast_alloca(strlen("->/ ") +
            strlen(ind->sub_tree->persistence->endpoint) +
            strlen(ind->sub_tree->root->resource) +
            strlen(ind->sub_tree->root->handler->event_name) +
            ind->sub_tree->dlg->call_id->id.slen + 1);
 
        sprintf(name, "%s->%s/%s %.*s", ind->sub_tree->persistence->endpoint,
            ind->sub_tree->root->resource, ind->sub_tree->root->handler->event_name,
            (int)ind->sub_tree->dlg->call_id->id.slen, ind->sub_tree->dlg->call_id->id.ptr);
 
        ast_debug(3, "Scheduling timer: %s\n", name);
        ind->sub_tree->expiration_task = ast_sip_schedule_task(ind->sub_tree->serializer,
            ind->expires * 1000, pubsub_on_refresh_timeout, name,
            ind->sub_tree, AST_SIP_SCHED_TASK_FIXED | AST_SIP_SCHED_TASK_DATA_AO2);
        if (!ind->sub_tree->expiration_task) {
            ast_log(LOG_ERROR, "Unable to create expiration timer of %d seconds for %s\n",
                ind->expires, name);
        }
    }
 
    ao2_ref(ind->sub_tree, -1);
    ast_free(ind);
 
    return 0;
}

References ao2_ref, ast_alloca, ast_debug, ast_free, ast_log, AST_SIP_SCHED_TASK_DATA_AO2, AST_SIP_SCHED_TASK_FIXED, ast_sip_schedule_task(), ast_test_suite_event_notify, sip_subscription_tree::dlg, subscription_persistence::endpoint, ast_sip_subscription_handler::event_name, sip_subscription_tree::evsub, sip_subscription_tree::expiration_task, initial_notify_data::expires, generate_initial_notify(), ast_sip_subscription::handler, LOG_ERROR, name, sip_subscription_tree::persistence, PJSIP_EXPIRES_NOT_SPECIFIED, pubsub_on_refresh_timeout(), ast_sip_subscription::resource, sip_subscription_tree::root, send_notify(), sip_subscription_tree::serializer, and initial_notify_data::sub_tree.

Referenced by pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

item_in_vector()

static int item_in_vector ( const struct resource_list *  list, const char *  item  )

static

Definition at line 5024 of file res_pjsip_pubsub.c.

{
    int i;
 
    for (i = 0; i < AST_VECTOR_SIZE(&list->items); ++i) {
        if (!strcmp(item, AST_VECTOR_GET(&list->items, i))) {
            return 1;
        }
    }
 
    return 0;
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, item, and resource_list::items.

Referenced by list_item_handler().

list_item_handler()

static int list_item_handler ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Definition at line 5037 of file res_pjsip_pubsub.c.

{
    struct resource_list *list = obj;
    char *items = ast_strdupa(var->value);
    char *item;
 
    while ((item = ast_strip(strsep(&items, ",")))) {
        if (ast_strlen_zero(item)) {
            continue;
        }
 
        if (item_in_vector(list, item)) {
            ast_log(LOG_WARNING, "Ignoring duplicated list item '%s'\n", item);
            continue;
        }
 
        item = ast_strdup(item);
        if (!item || AST_VECTOR_APPEND(&list->items, item)) {
            ast_free(item);
            return -1;
        }
    }
 
    return 0;
}

References ast_free, ast_log, ast_strdup, ast_strdupa, ast_strip(), ast_strlen_zero(), AST_VECTOR_APPEND, item, item_in_vector(), resource_list::items, LOG_WARNING, strsep(), and var.

Referenced by apply_list_configuration().

list_item_to_str()

static int list_item_to_str ( const void *  obj, const intptr_t *  args, char **  buf  )

static

Definition at line 5064 of file res_pjsip_pubsub.c.

{
    const struct resource_list *list = obj;
    int i;
    struct ast_str *str = ast_str_create(32);
 
    for (i = 0; i < AST_VECTOR_SIZE(&list->items); ++i) {
        ast_str_append(&str, 0, "%s,", AST_VECTOR_GET(&list->items, i));
    }
 
    /* Chop off trailing comma */
    ast_str_truncate(str, -1);
    *buf = ast_strdup(ast_str_buffer(str));
    ast_free(str);
    return 0;
}

References ast_free, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_truncate(), ast_strdup, AST_VECTOR_GET, AST_VECTOR_SIZE, buf, resource_list::items, and str.

Referenced by apply_list_configuration().

load_module()

static int load_module ( void  )

static

Definition at line 5806 of file res_pjsip_pubsub.c.

{
    static const pj_str_t str_PUBLISH = { "PUBLISH", 7 };
    struct ast_sorcery *sorcery;
 
    sorcery = ast_sip_get_sorcery();
 
    if (!(sched = ast_sched_context_create())) {
        ast_log(LOG_ERROR, "Could not create scheduler for publication expiration\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_sched_start_thread(sched)) {
        ast_log(LOG_ERROR, "Could not start scheduler thread for publication expiration\n");
        ast_sched_context_destroy(sched);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_apply_config(sorcery, "res_pjsip_pubsub");
    ast_sorcery_apply_default(sorcery, "subscription_persistence", "astdb", "subscription_persistence");
    if (ast_sorcery_object_register(sorcery, "subscription_persistence", subscription_persistence_alloc,
        NULL, NULL)) {
        ast_log(LOG_ERROR, "Could not register subscription persistence object support\n");
        ast_sched_context_destroy(sched);
        return AST_MODULE_LOAD_DECLINE;
    }
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "packet", "", OPT_CHAR_ARRAY_T, 0,
        CHARFLDSET(struct subscription_persistence, packet));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "src_name", "", OPT_CHAR_ARRAY_T, 0,
        CHARFLDSET(struct subscription_persistence, src_name));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "src_port", "0", OPT_UINT_T, 0,
        FLDSET(struct subscription_persistence, src_port));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "transport_key", "0", OPT_CHAR_ARRAY_T, 0,
        CHARFLDSET(struct subscription_persistence, transport_type));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "local_name", "", OPT_CHAR_ARRAY_T, 0,
        CHARFLDSET(struct subscription_persistence, local_name));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "local_port", "0", OPT_UINT_T, 0,
        FLDSET(struct subscription_persistence, local_port));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "cseq", "0", OPT_UINT_T, 0,
        FLDSET(struct subscription_persistence, cseq));
    ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "endpoint", "",
        persistence_endpoint_str2struct, persistence_endpoint_struct2str, NULL, 0, 0);
    ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "tag", "",
        persistence_tag_str2struct, persistence_tag_struct2str, NULL, 0, 0);
    ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "expires", "",
        persistence_expires_str2struct, persistence_expires_struct2str, NULL, 0, 0);
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "contact_uri", "", OPT_CHAR_ARRAY_T, 0,
        CHARFLDSET(struct subscription_persistence, contact_uri));
    ast_sorcery_object_field_register(sorcery, "subscription_persistence", "prune_on_boot", "no", OPT_YESNO_T, 1,
        FLDSET(struct subscription_persistence, prune_on_boot));
    ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "generator_data", "",
        persistence_generator_data_str2struct, persistence_generator_data_struct2str, NULL, 0, 0);
 
    if (apply_list_configuration(sorcery)) {
        ast_sched_context_destroy(sched);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_apply_default(sorcery, "inbound-publication", "config", "pjsip.conf,criteria=type=inbound-publication");
    if (ast_sorcery_object_register(sorcery, "inbound-publication", publication_resource_alloc,
        NULL, NULL)) {
        ast_log(LOG_ERROR, "Could not register subscription persistence object support\n");
        ast_sched_context_destroy(sched);
        return AST_MODULE_LOAD_DECLINE;
    }
    ast_sorcery_object_field_register(sorcery, "inbound-publication", "type", "",