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_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	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	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, 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, 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...
	AST_TEST_DEFINE (resource_tree)
	AST_TEST_DEFINE (complex_resource_tree)
	AST_TEST_DEFINE (bad_resource)
	AST_TEST_DEFINE (bad_branch)
	AST_TEST_DEFINE (duplicate_resource)
	AST_TEST_DEFINE (loop)
	AST_TEST_DEFINE (bad_event)
	AST_VECTOR (resources, const char *)
	A vector of strings commonly used throughout this module. More...
	AST_VECTOR (body_part_list, struct body_part *)
	Type declaration for container of body part structures. 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)
	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)
	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 int	check_node (struct ast_test *test, struct tree_node *node, const char **resources, size_t num_resources)
	Check the integrity of a tree node against a set of resources. More...
static void	cleanup_resource_list (struct resource_list *list)
	RAII callback to destroy a resource list. 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 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 resource_list *	create_resource_list (struct ast_test *test, const char *list_name, const char *event, const char **resources, size_t num_resources)
	allocate a resource list, store it in sorcery, and set its details 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 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	ineligible_configuration (void)
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	populate_list (struct resource_list *list, const char *event, const char **resources, size_t num_resources)
	Set properties on an allocated resource list. More...
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)
	Callback sequence for subscription terminate: 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 int	test_new_subscribe (struct ast_sip_endpoint *endpoint, const char *resource)
	new_subscribe callback for unit tests More...
static void	test_resource_tree_destroy (struct resource_tree *tree)
	RAII_VAR callback to destroy an allocated resource tree. More...
static struct tree_node *	tree_node_alloc (const char *resource, struct resources *visited, unsigned int full_state)
	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 = "30ef0c93b36035ec78c9cfd712d36d9b" , .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
const char *	bad_resources []
	"bad" resources More...
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} } , }
struct ast_sip_subscription_handler	test_handler
	Subscription handler for unit tests. More...
struct ast_sip_notifier	test_notifier
	Subscription notifier for unit tests. More...

Macro Definition Documentation

AMI_SHOW_SUBSCRIPTIONS_INBOUND

#define AMI_SHOW_SUBSCRIPTIONS_INBOUND   "PJSIPShowSubscriptionsInbound"

Definition at line 4135 of file res_pjsip_pubsub.c.

Referenced by load_module(), and unload_module().

AMI_SHOW_SUBSCRIPTIONS_OUTBOUND

#define AMI_SHOW_SUBSCRIPTIONS_OUTBOUND   "PJSIPShowSubscriptionsOutbound"

Definition at line 4136 of file res_pjsip_pubsub.c.

Referenced by load_module(), and unload_module().

CLI_LIST_SUB_FORMAT_ENTRY

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

Definition at line 4522 of file res_pjsip_pubsub.c.

Referenced by cli_list_subscriptions_detail().

CLI_LIST_SUB_FORMAT_HEADER

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

Definition at line 4521 of file res_pjsip_pubsub.c.

Referenced by cli_list_subscriptions_inout().

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 4379 of file res_pjsip_pubsub.c.

Referenced by cli_show_subscriptions_detail().

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 4374 of file res_pjsip_pubsub.c.

Referenced by cli_show_subscriptions_inout().

DATASTORE_BUCKETS

#define DATASTORE_BUCKETS   53

Number of buckets for subscription datastore.

Definition at line 250 of file res_pjsip_pubsub.c.

DEFAULT_EXPIRES

#define DEFAULT_EXPIRES   3600

Default expiration for subscriptions.

Definition at line 253 of file res_pjsip_pubsub.c.

Referenced by ast_sip_register_subscription_handler().

DEFAULT_PUBLISH_EXPIRES

#define DEFAULT_PUBLISH_EXPIRES   3600

Default expiration time for PUBLISH if one is not specified.

Definition at line 247 of file res_pjsip_pubsub.c.

Referenced by determine_sip_publish_type(), sip_create_publication(), and subscription_persistence_update().

MAX_REGEX_ERROR_LEN

#define MAX_REGEX_ERROR_LEN   128

Definition at line 4138 of file res_pjsip_pubsub.c.

Referenced by cli_list_subscriptions_inout(), and cli_show_subscriptions_inout().

MOD_DATA_MSG

#define MOD_DATA_MSG   "sub_msg"

Definition at line 236 of file res_pjsip_pubsub.c.

Referenced by ast_sip_subscription_get_header(), and create_subscription_tree().

MOD_DATA_PERSISTENCE

#define MOD_DATA_PERSISTENCE   "sub_persistence"

Definition at line 235 of file res_pjsip_pubsub.c.

Referenced by create_subscription_tree(), sip_subscription_accept(), and sub_persistence_recreate().

PUBLICATIONS_BUCKETS

#define PUBLICATIONS_BUCKETS   37

Number of buckets for publications (on a per handler)

Definition at line 244 of file res_pjsip_pubsub.c.

Referenced by ast_sip_register_publish_handler().

RESOURCE_LIST_INIT_SIZE

#define RESOURCE_LIST_INIT_SIZE   4

Definition at line 4750 of file res_pjsip_pubsub.c.

Referenced by resource_list_alloc().

Typedef Documentation

on_subscription_t

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

Definition at line 1798 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 523 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.
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 265 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 404 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 5714 of file res_pjsip_pubsub.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 5714 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
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 2029 of file res_pjsip_pubsub.c.

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

Referenced by build_rlmi_body().

{
   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];

   /* 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);

   pj_strdup2(pool, &name->content, resource_name);

   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);
}

add_subscription()

static void add_subscription ( struct sip_subscription_tree *  obj )

static

Definition at line 1175 of file res_pjsip_pubsub.c.

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by ast_sip_create_subscription(), and create_subscription_tree().

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

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 2233 of file res_pjsip_pubsub.c.

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

Referenced by build_body_part().

{
   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;

   return bp;
}

allocate_subscription()

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

static

Definition at line 1233 of file res_pjsip_pubsub.c.

References ao2_bump, ast_calloc, ast_datastores_alloc(), ast_json_object_get(), ast_json_ref(), ast_str_create, ast_sip_subscription::datastores, destroy_subscription(), sip_subscription_tree::dlg, subscription_persistence::generator_data, handler(), ast_sip_subscription::handler, NULL, sip_subscription_tree::persistence, sub, and ast_sip_subscription::tree.

Referenced by ast_sip_create_subscription(), and create_virtual_subscriptions().

{
   struct ast_sip_subscription *sub;
   pjsip_sip_uri *contact_uri;

   sub = ast_calloc(1, sizeof(*sub) + strlen(resource) + 1);
   if (!sub) {
      return NULL;
   }
   strcpy(sub->resource, resource); /* Safe */

   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);
   contact_uri = pjsip_uri_get_uri(tree->dlg->local.contact->uri);
   pjsip_sip_uri_assign(tree->dlg->pool, sub->uri, contact_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;
}

allocate_subscription_tree()

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

static

Definition at line 1405 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 1967 of file res_pjsip_pubsub.c.

References buf.

Referenced by sip_subscription_send_request().

{
   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;
}

ami_show_resource_lists()

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

static

Definition at line 4112 of file res_pjsip_pubsub.c.

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().

{
   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;
}

ami_show_subscriptions_inbound()

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

static

Definition at line 4062 of file res_pjsip_pubsub.c.

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().

{
   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;
}

ami_show_subscriptions_outbound()

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

static

Definition at line 4076 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 4031 of file res_pjsip_pubsub.c.

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().

{
   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;
}

ami_subscription_detail_inbound()

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

static

Definition at line 4050 of file res_pjsip_pubsub.c.

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

Referenced by ami_show_subscriptions_inbound().

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

ami_subscription_detail_outbound()

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

static

Definition at line 4056 of file res_pjsip_pubsub.c.

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

Referenced by ami_show_subscriptions_outbound().

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

apply_list_configuration()

static int apply_list_configuration ( struct ast_sorcery *  sorcery )

static

Definition at line 4857 of file res_pjsip_pubsub.c.

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_alloc(), and resource_list_apply_handler().

Referenced by load_module().

{
   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_reload_object(sorcery, "resource_list");

   return 0;
}

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 5714 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

subscriber	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 1868 of file res_pjsip_pubsub.c.

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, resource_list::event, ast_sip_subscription_handler::event_name, sip_subscription_tree::evsub, LOG_WARNING, NULL, pubsub_cb, sub, subscription_setup_dialog(), and ast_sip_contact::uri.

{
   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, 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;
}

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 2649 of file res_pjsip_pubsub.c.

References ast_datastores_add(), and ast_sip_publication::datastores.

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

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 2654 of file res_pjsip_pubsub.c.

References ast_datastores_find(), and ast_sip_publication::datastores.

{
   return ast_datastores_find(publication->datastores, 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 2664 of file res_pjsip_pubsub.c.

References ast_sip_publication::datastores.

{
   return 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 3420 of file res_pjsip_pubsub.c.

References ast_sip_publication::endpoint.

{
   return pub->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 3430 of file res_pjsip_pubsub.c.

References ast_sip_publication::event_configuration_name.

Referenced by asterisk_publication_devicestate_state_change(), and asterisk_publication_mwi_state_change().

{
   return pub->event_configuration_name;
}

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 3425 of file res_pjsip_pubsub.c.

References ast_sip_publication::resource.

{
   return pub->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 2659 of file res_pjsip_pubsub.c.

References ast_datastores_remove(), and ast_sip_publication::datastores.

{
   ast_datastores_remove(publication->datastores, 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 3519 of file res_pjsip_pubsub.c.

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, generator, ast_sip_pubsub_body_generator::list, LOG_WARNING, 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, 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().

{
   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;
}

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 866 of file res_pjsip_pubsub.c.

References while().

Referenced by pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

{
   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;
}

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 3435 of file res_pjsip_pubsub.c.

References find_body_generator_type_subtype().

Referenced by publisher_start().

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

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 3440 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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

generator

Body generator to register

Return values

0	Success
-1	Failure

Definition at line 3485 of file res_pjsip_pubsub.c.

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

Referenced by load_module().

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

   return 0;
}

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 3470 of file res_pjsip_pubsub.c.

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().

{
   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);
}

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

generator

Body generator to unregister

Definition at line 3494 of file res_pjsip_pubsub.c.

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().

{
   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);
}

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 2718 of file res_pjsip_pubsub.c.

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ast_log, ast_strlen_zero, ast_sip_publish_handler::event_name, LOG_ERROR, NULL, publication_cmp_fn(), publication_hash_fn(), ast_sip_publish_handler::publications, PUBLICATIONS_BUCKETS, and publish_add_handler().

Referenced by load_module().

{
   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;
}

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 2777 of file res_pjsip_pubsub.c.

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

Referenced by load_module().

{
   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;
}

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 2629 of file res_pjsip_pubsub.c.

References ast_datastores_add(), and ast_sip_subscription::datastores.

Referenced by add_datastore(), and add_mwi_datastore().

{
   return ast_datastores_add(subscription->datastores, 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 2624 of file res_pjsip_pubsub.c.

References ast_datastores_alloc_datastore().

Referenced by add_datastore(), and add_mwi_datastore().

{
   return ast_datastores_alloc_datastore(info, uid);
}

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

Returns

Nothing

Definition at line 1389 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, ast_sorcery_object_get_id(), sip_subscription_tree::endpoint, and ast_sip_subscription::tree.

Referenced by exten_state_subscription_destructor(), and mwi_subscription_destructor().

{
   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);
}

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 3514 of file res_pjsip_pubsub.c.

References ast_sip_subscription::body_generator, and ast_sip_pubsub_body_generator::subtype.

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

{
   return sub->body_generator->subtype;
}

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 3509 of file res_pjsip_pubsub.c.

References ast_sip_subscription::body_generator, and ast_sip_pubsub_body_generator::type.

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

{
   return sub->body_generator->type;
}

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 2634 of file res_pjsip_pubsub.c.

References ast_datastores_find(), and ast_sip_subscription::datastores.

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

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

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 2644 of file res_pjsip_pubsub.c.

References ast_sip_subscription::datastores.

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

{
   return subscription->datastores;
}

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 1930 of file res_pjsip_pubsub.c.

References ast_assert, sip_subscription_tree::dlg, NULL, and ast_sip_subscription::tree.

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

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

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 1936 of file res_pjsip_pubsub.c.

References ao2_bump, ast_assert, sip_subscription_tree::endpoint, NULL, and ast_sip_subscription::tree.

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

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

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 1854 of file res_pjsip_pubsub.c.

References ast_sip_mod_data_get, sip_subscription_tree::dlg, MOD_DATA_MSG, name, NULL, pubsub_module, and ast_sip_subscription::tree.

Referenced by get_user_agent().

{
   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);
}

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 2578 of file res_pjsip_pubsub.c.

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

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

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 2686 of file res_pjsip_pubsub.c.

Referenced by dialog_info_generate_body_content().

{
   return subscription->persistence_data;
}

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 2583 of file res_pjsip_pubsub.c.

References sip_subscription_tree::dlg, and ast_sip_subscription::tree.

Referenced by exten_state_data_alloc(), and notify_task().

{
   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';
   }
}

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 2596 of file res_pjsip_pubsub.c.

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

{
   return sub->resource;
}

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 1942 of file res_pjsip_pubsub.c.

References ast_assert, NULL, sip_subscription_tree::serializer, and ast_sip_subscription::tree.

Referenced by exten_state_subscription_alloc(), and send_notify().

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

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 2573 of file res_pjsip_pubsub.c.

Referenced by mwi_get_notify_data(), and send_mwi_notify().

{
   return sub->uri;
}

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 2601 of file res_pjsip_pubsub.c.

Referenced by notify_task().

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

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 2529 of file res_pjsip_pubsub.c.

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, sip_subscription_tree::notification_batch_interval, sip_subscription_tree::root, schedule_notification(), send_notify(), SIP_SUB_TREE_NORMAL, SIP_SUB_TREE_TERMINATE_IN_PROGRESS, SIP_SUB_TREE_TERMINATE_PENDING, sip_subscription_tree::state, and ast_sip_subscription::tree.

Referenced by notify_task(), and send_mwi_notify().

{
   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;
}

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 2639 of file res_pjsip_pubsub.c.

References ast_datastores_remove(), and ast_sip_subscription::datastores.

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

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

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 2669 of file res_pjsip_pubsub.c.

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

Referenced by dialog_info_generate_body_content().

{
   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));
   }
}

ast_sip_unregister_publish_handler()

void ast_sip_unregister_publish_handler

(

struct ast_sip_publish_handler *

handler

)

Unregister a publish handler.

Definition at line 2738 of file res_pjsip_pubsub.c.

References ao2_cleanup, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sip_publish_handler::next, and ast_sip_publish_handler::publications.

Referenced by load_module(), and unload_module().

{
   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);
}

ast_sip_unregister_subscription_handler()

void ast_sip_unregister_subscription_handler

(

struct ast_sip_subscription_handler *

handler

)

Unregister a subscription handler.

Definition at line 2810 of file res_pjsip_pubsub.c.

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

Referenced by unload_module().

{
   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);
}

AST_TEST_DEFINE() [1/7]

AST_TEST_DEFINE

(

resource_tree

)

Definition at line 5078 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, build_resource_tree(), check_node(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources[] = {
      "huey",
      "dewey",
      "louie",
   };
   int resp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "resource_tree";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Basic resource tree integrity check";
      info->description =
         "Create a resource list and ensure that our attempt to build a tree works as expected.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list = create_resource_list(test, "foo", "test", resources, ARRAY_LEN(resources));
   if (!list) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   if (check_node(test, tree->root, resources, ARRAY_LEN(resources))) {
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [2/7]

AST_TEST_DEFINE

(

complex_resource_tree

)

Definition at line 5131 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, AST_VECTOR_GET, build_resource_tree(), check_node(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list_1, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_list *, list_2, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources_1[] = {
      "huey",
      "dewey",
      "louie",
      "dwarves",
   };
   const char *resources_2[] = {
      "happy",
      "grumpy",
      "doc",
      "bashful",
      "dopey",
      "sneezy",
      "sleepy",
   };
   int resp;
   struct tree_node *node;

   switch (cmd) {
   case TEST_INIT:
      info->name = "complex_resource_tree";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Complex resource tree integrity check";
      info->description =
         "Create a complex resource list and ensure that our attempt to build a tree works as expected.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list_1 = create_resource_list(test, "foo", "test", resources_1, ARRAY_LEN(resources_1));
   if (!list_1) {
      return AST_TEST_FAIL;
   }

   list_2 = create_resource_list(test, "dwarves", "test", resources_2, ARRAY_LEN(resources_2));
   if (!list_2) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   node = tree->root;
   if (check_node(test, node, resources_1, ARRAY_LEN(resources_1))) {
      return AST_TEST_FAIL;
   }

   /* The embedded list is at index 3 in the root node's children */
   node = AST_VECTOR_GET(&node->children, 3);
   if (check_node(test, node, resources_2, ARRAY_LEN(resources_2))) {
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [3/7]

AST_TEST_DEFINE

(

bad_resource

)

Definition at line 5208 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, build_resource_tree(), check_node(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources[] = {
      "huey",
      "dewey",
      "louie",
      "coconut", /* A "bad" resource */
   };
   int resp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "bad_resource";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Ensure bad resources do not end up in the tree";
      info->description =
         "Create a resource list with a single bad resource. Ensure the bad resource does not end up in the tree.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list = create_resource_list(test, "foo", "test", resources, ARRAY_LEN(resources));
   if (!list) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   /* We check against all but the final resource since we expect it not to be in the tree */
   if (check_node(test, tree->root, resources, ARRAY_LEN(resources) - 1)) {
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;

}

AST_TEST_DEFINE() [4/7]

AST_TEST_DEFINE

(

bad_branch

)

Definition at line 5264 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, build_resource_tree(), check_node(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list_1, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_list *, list_2, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources_1[] = {
      "huey",
      "dewey",
      "louie",
      "gross",
   };
   /* This list has nothing but bad resources */
   const char *resources_2[] = {
      "coconut",
      "cilantro",
      "olive",
      "cheese",
   };
   int resp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "bad_branch";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Ensure bad branches are pruned from the tree";
      info->description =
         "Create a resource list that makes a tree with an entire branch of bad resources.\n"
         "Ensure the bad branch is pruned from the tree.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list_1 = create_resource_list(test, "foo", "test", resources_1, ARRAY_LEN(resources_1));
   if (!list_1) {
      return AST_TEST_FAIL;
   }
   list_2 = create_resource_list(test, "gross", "test", resources_2, ARRAY_LEN(resources_2));
   if (!list_2) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   /* We check against all but the final resource of the list since the entire branch should
    * be pruned from the tree
    */
   if (check_node(test, tree->root, resources_1, ARRAY_LEN(resources_1) - 1)) {
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;

}

AST_TEST_DEFINE() [5/7]

AST_TEST_DEFINE

(

duplicate_resource

)

Definition at line 5335 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, AST_VECTOR_GET, build_resource_tree(), check_node(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list_1, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_list *, list_2, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources_1[] = {
      "huey",
      "ducks",
      "dewey",
      "louie",
   };
   const char *resources_2[] = {
      "donald",
      "daisy",
      "scrooge",
      "dewey",
      "louie",
      "huey",
   };
   int resp;
   struct tree_node *node;

   switch (cmd) {
   case TEST_INIT:
      info->name = "duplicate_resource";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Ensure duplicated resources do not end up in the tree";
      info->description =
         "Create a resource list with a single duplicated resource. Ensure the duplicated resource does not end up in the tree.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list_1 = create_resource_list(test, "foo", "test", resources_1, ARRAY_LEN(resources_1));
   if (!list_1) {
      return AST_TEST_FAIL;
   }

   list_2 = create_resource_list(test, "ducks", "test", resources_2, ARRAY_LEN(resources_2));
   if (!list_2) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   node = tree->root;
   /* This node should have "huey" and "ducks". "dewey" and "louie" should not
    * be present since they were found in the "ducks" list.
    */
   if (check_node(test, node, resources_1, ARRAY_LEN(resources_1) - 2)) {
      return AST_TEST_FAIL;
   }

   /* This node should have "donald", "daisy", "scrooge", "dewey", and "louie".
    * "huey" is not here since that was already encountered in the parent list
    */
   node = AST_VECTOR_GET(&node->children, 1);
   if (check_node(test, node, resources_2, ARRAY_LEN(resources_2) - 1)) {
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [6/7]

AST_TEST_DEFINE

(

loop

)

Definition at line 5416 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, build_resource_tree(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list_1, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_list *, list_2, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources_1[] = {
      "derp",
   };
   const char *resources_2[] = {
      "herp",
   };
   int resp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "loop";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Test that loops are properly detected.";
      info->description =
         "Create two resource lists that refer to each other. Ensure that attempting to build a tree\n"
         "results in an empty tree.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list_1 = create_resource_list(test, "herp", "test", resources_1, ARRAY_LEN(resources_1));
   if (!list_1) {
      return AST_TEST_FAIL;
   }
   list_2 = create_resource_list(test, "derp", "test", resources_2, ARRAY_LEN(resources_2));
   if (!list_2) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   resp = build_resource_tree(NULL, &test_handler, "herp", tree, 1);
   if (resp == 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_TEST_DEFINE() [7/7]

AST_TEST_DEFINE

(

bad_event

)

Definition at line 5467 of file res_pjsip_pubsub.c.

References ARRAY_LEN, ast_calloc, AST_TEST_FAIL, AST_TEST_NOT_RUN, AST_TEST_PASS, ast_test_status_update, build_resource_tree(), cleanup_resource_list(), create_resource_list(), ineligible_configuration(), sip_to_pjsip::info(), NULL, RAII_VAR, TEST_EXECUTE, TEST_INIT, and test_resource_tree_destroy().

{
   RAII_VAR(struct resource_list *, list, NULL, cleanup_resource_list);
   RAII_VAR(struct resource_tree *, tree, NULL, test_resource_tree_destroy);
   const char *resources[] = {
      "huey",
      "dewey",
      "louie",
   };
   int resp;

   switch (cmd) {
   case TEST_INIT:
      info->name = "bad_event";
      info->category = "/res/res_pjsip_pubsub/";
      info->summary = "Ensure that list with wrong event specified is not retrieved";
      info->description =
         "Create a simple resource list for event 'tsetse'. Ensure that trying to retrieve the list for event 'test' fails.";
      return AST_TEST_NOT_RUN;
   case TEST_EXECUTE:
      break;
   }

   if (ineligible_configuration()) {
      ast_test_status_update(test, "Ineligible configuration for this test. Please add a "
            "'res_pjsip_pubsub' section to sorcery.conf, and set 'resource_list=memory'\n");
      return AST_TEST_NOT_RUN;
   }

   list = create_resource_list(test, "foo", "tsetse", resources, ARRAY_LEN(resources));
   if (!list) {
      return AST_TEST_FAIL;
   }

   tree = ast_calloc(1, sizeof(*tree));
   /* Since the test_handler is for event "test", this should not build a list, but
    * instead result in a single resource being created, called "foo"
    */
   resp = build_resource_tree(NULL, &test_handler, "foo", tree, 1);
   if (resp != 200) {
      ast_test_status_update(test, "Unexpected response %d when building resource tree\n", resp);
      return AST_TEST_FAIL;
   }

   if (!tree->root) {
      ast_test_status_update(test, "Resource tree has no root\n");
      return AST_TEST_FAIL;
   }

   if (strcmp(tree->root->resource, "foo")) {
      ast_test_status_update(test, "Unexpected resource %s found in tree\n", tree->root->resource);
      return AST_TEST_FAIL;
   }

   return AST_TEST_PASS;
}

AST_VECTOR() [1/2]

AST_VECTOR	(	resources	,
		const char *
	)

A vector of strings commonly used throughout this module.

AST_VECTOR() [2/2]

AST_VECTOR	(	body_part_list	,
		struct body_part *
	)

Type declaration for container of body part structures.

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 2258 of file res_pjsip_pubsub.c.

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

Referenced by generate_list_body().

{
   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);
   }
}

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  )

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 1021 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, resource_list::event, resource_list::full_state, have_visited(), resource_list::items, ast_sip_notifier::new_subscribe, ast_sip_subscription_handler::notifier, retrieve_resource_list(), tree_node_alloc(), and tree_node_destroy().

Referenced by build_resource_tree().

{
   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 = handler->notifier->new_subscribe(endpoint, resource);
         if (PJSIP_IS_STATUS_IN_CLASS(resp, 200)) {
            current = tree_node_alloc(resource, visited, 0);
            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);
         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);
         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);
      }
   }
}

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  )

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 1135 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, ast_sorcery_object_get_id(), AST_VECTOR_FREE, AST_VECTOR_INIT, AST_VECTOR_SIZE, build_node_children(), ast_sip_subscription_handler::event_name, ast_sip_notifier::new_subscribe, resource_tree::notification_batch_interval, ast_sip_subscription_handler::notifier, NULL, RAII_VAR, retrieve_resource_list(), resource_tree::root, and tree_node_alloc().

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

{
   RAII_VAR(struct resource_list *, list, NULL, ao2_cleanup);
   struct resources visited;

   if (!has_eventlist_support || !(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);
      if (!tree->root) {
         return 500;
      }
      return handler->notifier->new_subscribe(endpoint, resource);
   }

   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);
   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);
   AST_VECTOR_FREE(&visited);

   if (AST_VECTOR_SIZE(&tree->root->children) > 0) {
      return 200;
   } else {
      return 500;
   }
}

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 2162 of file res_pjsip_pubsub.c.

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(), generate_notify_body(), name, NULL, body_part::part, pool, body_part::resource, rlmi_clone_data(), rlmi_media_type, rlmi_print_body(), body_part::state, and body_part::uri.

Referenced by generate_list_body().

{
   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, 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;
}

check_node()

static int check_node ( struct ast_test *  test, struct tree_node *  node, const char **  resources, size_t  num_resources  )

static

Check the integrity of a tree node against a set of resources.

The tree node's resources must be in the same order as the resources in the supplied resources array. Because of this constraint, tests can misrepresent the size of the resources array as being smaller than it really is if resources at the end of the array should not be present in the tree node.

Parameters

test	The unit test. Used for printing status messages.
node	The constructed tree node whose integrity is under question.
resources	Array of expected resource values
num_resources	The number of resources to check in the array.

Definition at line 5022 of file res_pjsip_pubsub.c.

References ast_test_status_update, AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by AST_TEST_DEFINE().

{
   int i;

   if (AST_VECTOR_SIZE(&node->children) != num_resources) {
      ast_test_status_update(test, "Unexpected number of resources in tree. Expected %zu, got %zu\n",
            num_resources, AST_VECTOR_SIZE(&node->children));
      return -1;
   }

   for (i = 0; i < num_resources; ++i) {
      if (strcmp(resources[i], AST_VECTOR_GET(&node->children, i)->resource)) {
         ast_test_status_update(test, "Mismatched resources. Expected '%s' but got '%s'\n",
               resources[i], AST_VECTOR_GET(&node->children, i)->resource);
         return -1;
      }
   }

   return 0;
}

cleanup_resource_list()

static void cleanup_resource_list ( struct resource_list *  list )

static

RAII callback to destroy a resource list.

Definition at line 4962 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_sip_get_sorcery(), and ast_sorcery_delete().

Referenced by AST_TEST_DEFINE(), and create_resource_list().

{
   if (!list) {
      return;
   }

   ast_sorcery_delete(ast_sip_get_sorcery(), list);
   ao2_cleanup(list);
}

cli_complete_subscription_callid()

static char* cli_complete_subscription_callid ( struct ast_cli_args *  a )

static

Definition at line 4193 of file res_pjsip_pubsub.c.

References a, cli_sub_complete_parms::a, ast_cli_args::argv, ast_assert, cli_sub_complete_parms::callid, cli_complete_subscription_inbound(), cli_complete_subscription_outbound(), for_each_subscription(), NULL, ast_cli_args::pos, cli_sub_complete_parms::which, ast_cli_args::word, and cli_sub_complete_parms::wordlen.

Referenced by cli_show_subscription_inout().

{
   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;
}

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 4160 of file res_pjsip_pubsub.c.

References cli_sub_complete_parms::a, ast_copy_pj_str(), ast_malloc, cli_sub_complete_parms::callid, sip_subscription_tree::dlg, ast_cli_args::n, cli_sub_complete_parms::which, ast_cli_args::word, and cli_sub_complete_parms::wordlen.

Referenced by cli_complete_subscription_inbound(), and cli_complete_subscription_outbound().

{
   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;
}

cli_complete_subscription_inbound()

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

static

Definition at line 4181 of file res_pjsip_pubsub.c.

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

Referenced by cli_complete_subscription_callid().

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

cli_complete_subscription_outbound()

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

static

Definition at line 4187 of file res_pjsip_pubsub.c.

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

Referenced by cli_complete_subscription_callid().

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

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 4524 of file res_pjsip_pubsub.c.

References cli_sub_parms::a, ast_cli(), ast_copy_pj_str(), ast_copy_string(), ast_sorcery_object_get_id(), ast_str_buffer(), ast_str_set(), cli_sub_parms::buf, CLI_LIST_SUB_FORMAT_ENTRY, cli_subscription_expiry(), cli_sub_parms::count, sip_subscription_tree::dlg, sip_subscription_tree::endpoint, ast_sip_subscription_handler::event_name, ast_cli_args::fd, ast_sip_subscription::handler, ast_sip_endpoint::id, cli_sub_parms::like, ast_party_id::name, NULL, ast_party_id::number, 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().

{
   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;
}

cli_list_subscriptions_inbound()

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

static

Definition at line 4568 of file res_pjsip_pubsub.c.

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

Referenced by cli_list_subscriptions_inout().

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

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 4580 of file res_pjsip_pubsub.c.

References a, cli_sub_parms::a, ast_cli_args::argc, ast_cli_args::argv, ast_alloca, ast_assert, ast_cli(), ast_free, ast_str_create, cli_sub_parms::buf, 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::count, cli_sub_parms::e, ast_cli_args::fd, for_each_subscription(), cli_sub_parms::like, MAX_REGEX_ERROR_LEN, NULL, regex(), and ast_cli_entry::usage.

{
   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;
}

cli_list_subscriptions_outbound()

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

static

Definition at line 4574 of file res_pjsip_pubsub.c.

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

Referenced by cli_list_subscriptions_inout().

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

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 4235 of file res_pjsip_pubsub.c.

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

Referenced by cli_show_subscription_inbound(), and cli_show_subscription_outbound().

{
   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;
}

cli_show_subscription_inbound()

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

static

Definition at line 4322 of file res_pjsip_pubsub.c.

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

Referenced by cli_show_subscription_inout().

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

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 4334 of file res_pjsip_pubsub.c.

References a, cli_sub_parms::a, ast_cli_args::argc, ast_cli_args::argv, ast_assert, cli_sub_parms::buf, 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.

{
   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;
}

cli_show_subscription_outbound()

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

static

Definition at line 4328 of file res_pjsip_pubsub.c.

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

Referenced by cli_show_subscription_inout().

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

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 4384 of file res_pjsip_pubsub.c.

References cli_sub_parms::a, ast_callerid_merge(), ast_cli(), ast_copy_pj_str(), ast_copy_string(), ast_sorcery_object_get_id(), ast_str_buffer(), ast_str_set(), cli_sub_parms::buf, CLI_SHOW_SUB_FORMAT_ENTRY, cli_subscription_expiry(), cli_sub_parms::count, sip_subscription_tree::dlg, sip_subscription_tree::endpoint, ast_sip_subscription_handler::event_name, ast_cli_args::fd, ast_sip_subscription::handler, ast_sip_endpoint::id, cli_sub_parms::like, ast_party_id::name, NULL, ast_party_id::number, 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().

{
   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;
}

cli_show_subscriptions_inbound()

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

static

Definition at line 4421 of file res_pjsip_pubsub.c.

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

Referenced by cli_show_subscriptions_inout().

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

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 4433 of file res_pjsip_pubsub.c.

References a, cli_sub_parms::a, ast_cli_args::argc, ast_cli_args::argv, ast_alloca, ast_assert, ast_cli(), ast_free, ast_str_create, cli_sub_parms::buf, 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::count, cli_sub_parms::e, ast_cli_args::fd, for_each_subscription(), cli_sub_parms::like, MAX_REGEX_ERROR_LEN, NULL, regex(), and ast_cli_entry::usage.

{
   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;
}

cli_show_subscriptions_outbound()

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

static

Definition at line 4427 of file res_pjsip_pubsub.c.

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

Referenced by cli_show_subscriptions_inout().

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

cli_subscription_expiry()

static unsigned int cli_subscription_expiry ( struct sip_subscription_tree *  sub_tree )

static

Definition at line 4221 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 2291 of file res_pjsip_pubsub.c.

References ast_generate_random_string().

Referenced by generate_list_body().

{
   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);
}

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 2404 of file res_pjsip_pubsub.c.

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

{
   pjsip_require_hdr *require;

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

   return require;
}

create_resource_list()

static struct resource_list* create_resource_list ( struct ast_test *  test, const char *  list_name, const char *  event, const char **  resources, size_t  num_resources  )

static

allocate a resource list, store it in sorcery, and set its details

Parameters

test	The unit test. Used for logging status messages.
list_name	The name of the list to create.
event	The event the list services
resources	Array of resources to apply to the list
num_resources	The number of resources in the array

Return values

NULL	Failed to allocate or populate list
non-NULL	The created list

Definition at line 4983 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_sip_get_sorcery(), ast_sorcery_alloc(), ast_sorcery_create(), ast_test_status_update, cleanup_resource_list(), NULL, and populate_list().

Referenced by AST_TEST_DEFINE().

{
   struct resource_list *list;

   list = ast_sorcery_alloc(ast_sip_get_sorcery(), "resource_list", list_name);
   if (!list) {
      ast_test_status_update(test, "Could not allocate resource list in sorcery\n");
      return NULL;
   }

   if (ast_sorcery_create(ast_sip_get_sorcery(), list)) {
      ast_test_status_update(test, "Could not store the resource list in sorcery\n");
      ao2_cleanup(list);
      return NULL;
   }

   if (populate_list(list, event, resources, num_resources)) {
      ast_test_status_update(test, "Could not add resources to the resource list\n");
      cleanup_resource_list(list);
      return NULL;
   }

   return list;
}

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
dlg_status[out]	The result of attempting to create a dialog.

Return values

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

Definition at line 1465 of file res_pjsip_pubsub.c.

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, create_virtual_subscriptions(), subscription_persistence::cseq, sip_subscription_tree::dlg, sip_subscription_tree::evsub, 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().

{
   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;
}

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 1286 of file res_pjsip_pubsub.c.

References allocate_subscription(), ao2_cleanup, ast_debug, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, ast_sip_subscription::body_generator, destroy_subscription(), generator, NULL, and sub.

Referenced by create_subscription_tree().

{
   int i;
   struct ast_sip_subscription *sub;

   sub = allocate_subscription(handler, resource, 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;
}

destroy_subscription()

static void destroy_subscription ( struct ast_sip_subscription *  sub )

static

Definition at line 1201 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, ast_free, ast_json_unref(), ast_sorcery_object_get_id(), AST_VECTOR_FREE, ast_sip_subscription::datastores, sip_subscription_tree::endpoint, and ast_sip_subscription::tree.

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

{
   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);
}

destroy_subscriptions()

static void destroy_subscriptions ( struct ast_sip_subscription *  root )

static

Definition at line 1215 of file res_pjsip_pubsub.c.

References AST_VECTOR_GET, AST_VECTOR_SIZE, and destroy_subscription().

Referenced by subscription_tree_destructor().

{
   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);
}

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 3102 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 817 of file res_pjsip_pubsub.c.

References accept_exceptions, and ARRAY_LEN.

Referenced by subscription_get_generator_from_rdata().

{
   int i;

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

   return 0;
}

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 2862 of file res_pjsip_pubsub.c.

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

Referenced by subscription_get_generator_from_rdata(), and subscription_persistence_remove().

{
   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;
}

find_body_generator_accept()

static struct ast_sip_pubsub_body_generator* find_body_generator_accept ( const char *  accept )

static

Definition at line 2849 of file res_pjsip_pubsub.c.

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().

{
   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);
}

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 2839 of file res_pjsip_pubsub.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, find_body_generator_type_subtype_nolock(), and gen.

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

{
   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;
}

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 2825 of file res_pjsip_pubsub.c.

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

Referenced by ast_sip_pubsub_register_body_generator(), and find_body_generator_type_subtype().

{
   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;
}

find_pub_handler()

static struct ast_sip_publish_handler* find_pub_handler ( const char *  event )

static

Definition at line 3084 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 2763 of file res_pjsip_pubsub.c.

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(), subscription_get_handler_from_rdata(), and subscription_persistence_remove().

{
   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;
}

for_each_subscription()

static int for_each_subscription ( on_subscription_t  on_subscription, void *  arg  )

static

Definition at line 1800 of file res_pjsip_pubsub.c.

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().

{
   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;
}

format_ami_resource_lists()

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

static

Definition at line 4090 of file res_pjsip_pubsub.c.

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().

{
   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;
}

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 2215 of file res_pjsip_pubsub.c.

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

Referenced by generate_list_body().

{
   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);
}

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 2107 of file res_pjsip_pubsub.c.

References ast_generate_random_string(), cid_name, and id.

Referenced by allocate_body_part(), and build_rlmi_body().

{
   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;
}

generate_initial_notify()

static int generate_initial_notify ( struct ast_sip_subscription *  sub )

static

Definition at line 2887 of file res_pjsip_pubsub.c.

References ao2_cleanup, 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, ast_sip_subscription_handler::body_type, ast_sip_notifier::get_notify_data, ast_sip_subscription::handler, ast_sip_subscription_handler::notifier, pubsub_on_refresh_timeout(), and ast_sip_notifier::subscription_established.

Referenced by initial_notify_task().

{
   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) {
      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;
}

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 2324 of file res_pjsip_pubsub.c.

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

Referenced by generate_notify_body().

{
   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;
}

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 2371 of file res_pjsip_pubsub.c.

References ast_sip_subscription_get_body_subtype(), ast_sip_subscription_get_body_type(), ast_str_buffer(), AST_VECTOR_SIZE, generate_list_body(), NULL, text, and type.

Referenced by build_body_part(), build_rlmi_body(), and send_notify().

{
   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;
}

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 987 of file res_pjsip_pubsub.c.

References AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by build_node_children().

{
   int i;

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

   return 0;
}

ineligible_configuration()

static int ineligible_configuration ( void  )

static

Definition at line 5053 of file res_pjsip_pubsub.c.

References ast_config_destroy(), ast_config_load, ast_strlen_zero, ast_variable_retrieve(), config, and value.

Referenced by AST_TEST_DEFINE().

{
   struct ast_config *config;
   struct ast_flags flags = {0,};
   const char *value;

   config = ast_config_load("sorcery.conf", flags);
   if (!config) {
      return 1;
   }

   value = ast_variable_retrieve(config, "res_pjsip_pubsub", "resource_list");
   if (ast_strlen_zero(value)) {
      ast_config_destroy(config);
      return 1;
   }

   if (strcasecmp(value, "memory") && strcasecmp(value, "astdb")) {
      ast_config_destroy(config);
      return 1;
   }

   return 0;
}

initial_notify_task()

static int initial_notify_task ( void *  obj )

static

Definition at line 2929 of file res_pjsip_pubsub.c.

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(), 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().

{
   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;
}

item_in_vector()

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

static

Definition at line 4781 of file res_pjsip_pubsub.c.

References AST_VECTOR_GET, AST_VECTOR_SIZE, and resource_list::items.

Referenced by list_item_handler().

{
   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;
}

list_item_handler()

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

static

Definition at line 4794 of file res_pjsip_pubsub.c.

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 ast_variable::value.

Referenced by apply_list_configuration().

{
   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;
}

list_item_to_str()

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

static

Definition at line 4821 of file res_pjsip_pubsub.c.

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

Referenced by apply_list_configuration().

{
   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;
}

load_module()

static int load_module ( void  )

static

Definition at line 5560 of file res_pjsip_pubsub.c.

References ami_show_resource_lists(), ami_show_subscriptions_inbound(), AMI_SHOW_SUBSCRIPTIONS_INBOUND, ami_show_subscriptions_outbound(), AMI_SHOW_SUBSCRIPTIONS_OUTBOUND, apply_list_configuration(), ARRAY_LEN, ast_cli_register_multiple, ast_log, ast_manager_get_generic_type(), ast_manager_get_topic(), ast_manager_register_xml, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_module_shutdown_ref, AST_OPT_FLAG_FULLY_BOOTED, ast_options, ast_sched_context_create(), ast_sched_context_destroy(), ast_sched_start_thread(), ast_sip_get_pjsip_endpoint(), ast_sip_get_sorcery(), ast_sip_push_task(), ast_sip_register_service(), ast_sip_unregister_service(), ast_sorcery_apply_config, ast_sorcery_apply_default, ast_sorcery_object_field_register, ast_sorcery_object_field_register_custom, ast_sorcery_object_fields_register(), ast_sorcery_object_register, ast_sorcery_reload_object(), ast_test_flag, AST_TEST_REGISTER, CHARFLDSET, EVENT_FLAG_SYSTEM, FLDSET, LOG_ERROR, NULL, OPT_CHAR_ARRAY_T, OPT_NOOP_T, OPT_UINT_T, OPT_YESNO_T, persistence_endpoint_str2struct(), persistence_endpoint_struct2str(), persistence_expires_str2struct(), persistence_expires_struct2str(), persistence_generator_data_str2struct(), persistence_generator_data_struct2str(), persistence_tag_str2struct(), persistence_tag_struct2str(), publication_resource_alloc(), pubsub_module, resource_endpoint_handler(), resource_event_handler(), rlmi_media_type, ast_module_info::self, sorcery, stasis_subscribe_pool, stasis_subscription_accept_message_type(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, stasis_subscription_set_filter(), sub, subscription_persistence_alloc(), subscription_persistence_event_cb(), and subscription_persistence_load().

Referenced by unload_module().

{
   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_key));
   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", "", OPT_NOOP_T, 0, 0);
   ast_sorcery_object_field_register_custom(sorcery, "inbound-publication", "endpoint", "",
      resource_endpoint_handler, NULL, NULL, 0, 0);
   ast_sorcery_object_fields_register(sorcery, "inbound-publication", "^event_", resource_event_handler, NULL);
   ast_sorcery_reload_object(sorcery, "inbound-publication");

   if (ast_sip_register_service(&pubsub_module)) {
      ast_log(LOG_ERROR, "Could not register pubsub service\n");
      ast_sched_context_destroy(sched);
      return AST_MODULE_LOAD_DECLINE;
   }

   if (pjsip_evsub_init_module(ast_sip_get_pjsip_endpoint()) != PJ_SUCCESS) {
      ast_log(LOG_ERROR, "Could not initialize pjsip evsub module.\n");
      ast_sip_unregister_service(&pubsub_module);
      ast_sched_context_destroy(sched);
      return AST_MODULE_LOAD_DECLINE;
   }

   /* Once pjsip_evsub_init_module succeeds we cannot unload.
    * Keep all module_load errors above this point. */
   ast_module_shutdown_ref(ast_module_info->self);

   pjsip_media_type_init2(&rlmi_media_type, "application", "rlmi+xml");

   pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), NULL, PJSIP_H_ALLOW, NULL, 1, &str_PUBLISH);

   if (ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
      ast_sip_push_task(NULL, subscription_persistence_load, NULL);
   } else {
      struct stasis_subscription *sub;

      sub = stasis_subscribe_pool(ast_manager_get_topic(), subscription_persistence_event_cb, NULL);
      stasis_subscription_accept_message_type(sub, ast_manager_get_generic_type());
      stasis_subscription_set_filter(sub, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
   }

   ast_manager_register_xml(AMI_SHOW_SUBSCRIPTIONS_INBOUND, EVENT_FLAG_SYSTEM,
             ami_show_subscriptions_inbound);
   ast_manager_register_xml(AMI_SHOW_SUBSCRIPTIONS_OUTBOUND, EVENT_FLAG_SYSTEM,
             ami_show_subscriptions_outbound);
   ast_manager_register_xml("PJSIPShowResourceLists", EVENT_FLAG_SYSTEM,
         ami_show_resource_lists);

   ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));

   AST_TEST_REGISTER(resource_tree);
   AST_TEST_REGISTER(complex_resource_tree);
   AST_TEST_REGISTER(bad_resource);
   AST_TEST_REGISTER(bad_branch);
   AST_TEST_REGISTER(duplicate_resource);
   AST_TEST_REGISTER(loop);
   AST_TEST_REGISTER(bad_event);

   return AST_MODULE_LOAD_SUCCESS;
}

parse_simple_message_summary()

static int parse_simple_message_summary ( char *  body, struct simple_message_summary *  summary  )

static

Definition at line 3585 of file res_pjsip_pubsub.c.

References ast_read_line_from_buffer(), ast_str_to_lower(), ast_strdupa, ast_strlen_zero, simple_message_summary::message_account, simple_message_summary::voice_messages_new, simple_message_summary::voice_messages_old, simple_message_summary::voice_messages_urgent_new, and simple_message_summary::voice_messages_urgent_old.

Referenced by pubsub_on_rx_mwi_notify_request().

{
   char *line;
   char *buffer;
   int found_counts = 0;

   if (ast_strlen_zero(body) || !summary) {
      return -1;
   }

   buffer = ast_strdupa(body);
   memset(summary, 0, sizeof(*summary));

   while ((line = ast_read_line_from_buffer(&buffer))) {
      line = ast_str_to_lower(line);

      if (sscanf(line, "voice-message: %d/%d (%d/%d)",
         &summary->voice_messages_new, &summary->voice_messages_old,
         &summary->voice_messages_urgent_new, &summary->voice_messages_urgent_old)) {
         found_counts = 1;
      } else {
         sscanf(line, "message-account: %s", summary->message_account);
      }
   }

   return !found_counts;
}

persistence_endpoint_str2struct()

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

static

Definition at line 4673 of file res_pjsip_pubsub.c.

References ast_strdup, subscription_persistence::endpoint, and ast_variable::value.

Referenced by load_module().

{
   struct subscription_persistence *persistence = obj;

   persistence->endpoint = ast_strdup(var->value);
   return 0;
}

persistence_endpoint_struct2str()

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

static

Definition at line 4681 of file res_pjsip_pubsub.c.

References ast_strdup, and subscription_persistence::endpoint.

Referenced by load_module().

{
   const struct subscription_persistence *persistence = obj;

   *buf = ast_strdup(persistence->endpoint);
   return 0;
}

persistence_expires_str2struct()

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

static

Definition at line 4738 of file res_pjsip_pubsub.c.

References ast_get_timeval(), ast_tv(), subscription_persistence::expires, NULL, and ast_variable::value.

Referenced by load_module().

{
   struct subscription_persistence *persistence = obj;
   return ast_get_timeval(var->value, &persistence->expires, ast_tv(0, 0), NULL);
}

persistence_expires_struct2str()

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

static

Definition at line 4744 of file res_pjsip_pubsub.c.

References ast_asprintf, and subscription_persistence::expires.

Referenced by load_module().

{
   const struct subscription_persistence *persistence = obj;
   return (ast_asprintf(buf, "%ld", persistence->expires.tv_sec) < 0) ? -1 : 0;
}

persistence_generator_data_str2struct()

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

static

Definition at line 4705 of file res_pjsip_pubsub.c.

References ast_json_load_string(), subscription_persistence::generator_data, and ast_variable::value.

Referenced by load_module().

{
   struct subscription_persistence *persistence = obj;
   struct ast_json_error error;

   /* We tolerate a failure of the JSON to load and instead start fresh, since this field
    * originates from the persistence code and not a user.
    */
   persistence->generator_data = ast_json_load_string(var->value, &error);

   return 0;
}

persistence_generator_data_struct2str()

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

static

Definition at line 4718 of file res_pjsip_pubsub.c.

References ast_json_dump_string, ast_json_free(), ast_strdup, subscription_persistence::generator_data, and value.

Referenced by load_module().

{
   const struct subscription_persistence *persistence = obj;
   char *value;

   if (!persistence->generator_data) {
      return 0;
   }

   value = ast_json_dump_string(persistence->generator_data);
   if (!value) {
      return -1;
   }

   *buf = ast_strdup(value);
   ast_json_free(value);

   return 0;
}

persistence_tag_str2struct()

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

static

Definition at line 4689 of file res_pjsip_pubsub.c.

References ast_strdup, subscription_persistence::tag, and ast_variable::value.

Referenced by load_module().

{
   struct subscription_persistence *persistence = obj;

   persistence->tag = ast_strdup(var->value);
   return 0;
}

persistence_tag_struct2str()

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

static

Definition at line 4697 of file res_pjsip_pubsub.c.

References ast_strdup, and subscription_persistence::tag.

Referenced by load_module().

{
   const struct subscription_persistence *persistence = obj;

   *buf = ast_strdup(persistence->tag);
   return 0;
}

populate_list()

static int populate_list ( struct resource_list *  list, const char *  event, const char **  resources, size_t  num_resources  )

static

Set properties on an allocated resource list.

Parameters

list	The list to set details on.
event	The list's event.
resources	Array of resources to add to the list.
num_resources	Number of resources in the array.

Return values

0	Success
non-zero	Failure

Definition at line 4942 of file res_pjsip_pubsub.c.

References ast_copy_string(), ast_free, ast_strdup, AST_VECTOR_APPEND, resource_list::event, and resource_list::items.

Referenced by create_resource_list().

{
   int i;

   ast_copy_string(list->event, event, sizeof(list->event));

   for (i = 0; i < num_resources; ++i) {
      char *resource = ast_strdup(resources[i]);

      if (!resource || AST_VECTOR_APPEND(&list->items, resource)) {
         ast_free(resource);
         return -1;
      }
   }
   return 0;
}

publication_cmp_fn()

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

static

Definition at line 2701 of file res_pjsip_pubsub.c.

References CMP_MATCH, CMP_STOP, ast_sip_publication::entity_tag, and OBJ_KEY.

Referenced by ast_sip_register_publish_handler().

{
   const struct ast_sip_publication *publication1 = obj;
   const struct ast_sip_publication *publication2 = arg;
   const int *entity_tag = arg;

   return (publication1->entity_tag == (flags & OBJ_KEY ? *entity_tag : publication2->entity_tag) ?
      CMP_MATCH | CMP_STOP : 0);
}

publication_destroy_fn()

static void publication_destroy_fn ( void *  obj )

static

Internal destructor for publications.

Definition at line 3133 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, ast_module_unref, ast_sip_publication::datastores, ast_sip_publication::endpoint, and ast_module_info::self.

Referenced by sip_create_publication().

{
   struct ast_sip_publication *publication = obj;

   ast_debug(3, "Destroying SIP publication\n");

   ao2_cleanup(publication->datastores);
   ao2_cleanup(publication->endpoint);

   ast_module_unref(ast_module_info->self);
}

publication_hash_fn()

static int publication_hash_fn ( const void *  obj, const int  flags  )

static

Definition at line 2693 of file res_pjsip_pubsub.c.

References ast_sip_publication::entity_tag, and OBJ_KEY.

Referenced by ast_sip_register_publish_handler().

{
   const struct ast_sip_publication *publication = obj;
   const int *entity_tag = obj;

   return flags & OBJ_KEY ? *entity_tag : publication->entity_tag;
}

publication_resource_alloc()

static void* publication_resource_alloc ( const char *  name )

static

Allocator for publication resource.

Definition at line 567 of file res_pjsip_pubsub.c.

References ast_sorcery_generic_alloc(), and publication_resource_destroy().

Referenced by load_module().

{
   return ast_sorcery_generic_alloc(sizeof(struct ast_sip_publication_resource), publication_resource_destroy);
}

publication_resource_destroy()

static void publication_resource_destroy ( void *  obj )

static

Destructor for publication resource.

Definition at line 558 of file res_pjsip_pubsub.c.

References ast_free, ast_variables_destroy(), ast_sip_publication_resource::endpoint, and ast_sip_publication_resource::events.

Referenced by publication_resource_alloc().

{
   struct ast_sip_publication_resource *resource = obj;

   ast_free(resource->endpoint);
   ast_variables_destroy(resource->events);
}

publish_add_handler()

static void publish_add_handler ( struct ast_sip_publish_handler *  handler )

static

Definition at line 2711 of file res_pjsip_pubsub.c.

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by ast_sip_register_publish_handler().

{
   AST_RWLIST_WRLOCK(&publish_handlers);
   AST_RWLIST_INSERT_TAIL(&publish_handlers, handler, next);
   AST_RWLIST_UNLOCK(&publish_handlers);
}

publish_expire()

static int publish_expire ( const void *  data )

static

Definition at line 3312 of file res_pjsip_pubsub.c.

References ao2_cleanup, ao2_unlink, ast_sip_push_task(), ast_sip_publication::handler, NULL, ast_sip_publish_handler::publications, publish_expire_callback(), and ast_sip_publication::sched_id.

Referenced by pubsub_on_rx_publish_request().

{
   struct ast_sip_publication *publication = (struct ast_sip_publication*)data;

   ao2_unlink(publication->handler->publications, publication);
   publication->sched_id = -1;

   if (ast_sip_push_task(NULL, publish_expire_callback, publication)) {
      ao2_cleanup(publication);
   }

   return 0;
}

publish_expire_callback()

static int publish_expire_callback ( void *  data )

static

Definition at line 3301 of file res_pjsip_pubsub.c.

References ao2_cleanup, and RAII_VAR.

Referenced by publish_expire().

{
   RAII_VAR(struct ast_sip_publication *, publication, data, ao2_cleanup);

   if (publication->handler->publish_expire) {
      publication->handler->publish_expire(publication);
   }

   return 0;
}

publish_request_initial()

static struct ast_sip_publication* publish_request_initial ( struct ast_sip_endpoint *  endpoint, pjsip_rx_data *  rdata, struct ast_sip_publish_handler *  handler  )

static

Definition at line 3214 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_alloca, ast_copy_pj_str(), ast_debug, ast_log, ast_sip_get_pjsip_endpoint(), ast_sip_get_sorcery(), AST_SIP_PUBLISH_STATE_INITIALIZED, AST_SIP_USER_OPTIONS_TRUNCATE_CHECK, ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_strlen_zero, ast_sip_publish_handler::event_name, handler(), ast_sip_publication::handler, LOG_WARNING, ast_variable::name, ast_sip_publish_handler::new_publication, ast_variable::next, NULL, ast_sip_publish_handler::publication_state_change, RAII_VAR, ast_sip_publication::resource, S_OR, sip_create_publication(), sip_publication_respond(), and ast_variable::value.

Referenced by pubsub_on_rx_publish_request().

{
   struct ast_sip_publication *publication;
   char *resource_name;
   size_t resource_size;
   RAII_VAR(struct ast_sip_publication_resource *, resource, NULL, ao2_cleanup);
   struct ast_variable *event_configuration_name = NULL;
   pjsip_uri *request_uri;
   pjsip_sip_uri *request_uri_sip;
   int resp;

   request_uri = rdata->msg_info.msg->line.req.uri;

   if (!PJSIP_URI_SCHEME_IS_SIP(request_uri) && !PJSIP_URI_SCHEME_IS_SIPS(request_uri)) {
      char uri_str[PJSIP_MAX_URL_SIZE];

      pjsip_uri_print(PJSIP_URI_IN_REQ_URI, request_uri, uri_str, sizeof(uri_str));
      ast_log(LOG_WARNING, "Request URI '%s' is not a sip: or sips: URI.\n", uri_str);
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 416, NULL, NULL, NULL);
      return NULL;
   }

   request_uri_sip = pjsip_uri_get_uri(request_uri);
   resource_size = pj_strlen(&request_uri_sip->user) + 1;
   resource_name = ast_alloca(resource_size);
   ast_copy_pj_str(resource_name, &request_uri_sip->user, resource_size);

   /*
    * We may want to match without any user options getting
    * in the way.
    */
   AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(resource_name);

   resource = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "inbound-publication", resource_name);
   if (!resource) {
      ast_debug(1, "No 'inbound-publication' defined for resource '%s'\n", resource_name);
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 404, NULL, NULL, NULL);
      return NULL;
   }

   if (!ast_strlen_zero(resource->endpoint) && strcmp(resource->endpoint, ast_sorcery_object_get_id(endpoint))) {
      ast_debug(1, "Resource %s has a defined endpoint '%s', but does not match endpoint '%s' that received the request\n",
         resource_name, resource->endpoint, ast_sorcery_object_get_id(endpoint));
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 403, NULL, NULL, NULL);
      return NULL;
   }

   for (event_configuration_name = resource->events; event_configuration_name; event_configuration_name = event_configuration_name->next) {
      if (!strcmp(event_configuration_name->name, handler->event_name)) {
         break;
      }
   }

   if (!event_configuration_name) {
      ast_debug(1, "Event '%s' is not configured for '%s'\n", handler->event_name, resource_name);
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 404, NULL, NULL, NULL);
      return NULL;
   }

   resp = handler->new_publication(endpoint, resource_name, event_configuration_name->value);

   if (!PJSIP_IS_STATUS_IN_CLASS(resp, 200)) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, resp, NULL, NULL, NULL);
      return NULL;
   }

   publication = sip_create_publication(endpoint, rdata, S_OR(resource_name, ""), event_configuration_name->value);

   if (!publication) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 503, NULL, NULL, NULL);
      return NULL;
   }

   publication->handler = handler;
   if (publication->handler->publication_state_change(publication, rdata->msg_info.msg->body,
         AST_SIP_PUBLISH_STATE_INITIALIZED)) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
      ao2_cleanup(publication);
      return NULL;
   }

   sip_publication_respond(publication, resp, rdata);

   return publication;
}

pubsub_on_client_refresh()

static void pubsub_on_client_refresh ( pjsip_evsub *  sub )

static

Definition at line 3989 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_cleanup, ast_sip_push_task(), pubsub_module, serialized_pubsub_on_client_refresh(), and sip_subscription_tree::serializer.

{
   struct sip_subscription_tree *sub_tree;

   if (!(sub_tree = pjsip_evsub_get_mod_data(evsub, pubsub_module.id))) {
      return;
   }

   if (ast_sip_push_task(sub_tree->serializer, serialized_pubsub_on_client_refresh, ao2_bump(sub_tree))) {
      ao2_cleanup(sub_tree);
   }
}

pubsub_on_evsub_state()

static void pubsub_on_evsub_state ( pjsip_evsub *  evsub, pjsip_event *  event  )

static

Callback sequence for subscription terminate:

• Client initiated: pjproject receives SUBSCRIBE on the subscription's serializer thread calls pubsub_on_rx_refresh with dialog locked pubsub_on_rx_refresh sets TERMINATE_PENDING pushes serialized_pubsub_on_refresh_timeout returns to pjproject pjproject calls pubsub_on_evsub_state pubsub_evsub_set_state checks state == TERMINATE_IN_PROGRESS (no) ignore and return 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 removes the subscriptions cleans up references to evsub sets state = TERMINATED serialized_pubsub_on_refresh_timeout 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 See (1) Above
• 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

PJSIP callback when underlying SIP subscription changes state

Although this function is called for every state change, we only care about the TERMINATED state, and only when we're actually processing the final notify (SIP_SUB_TREE_TERMINATE_IN_PROGRESS) OR when a transmission failure occurs (PJSIP_EVENT_TSX_STATE). In this case, we do all the subscription tree cleanup tasks and decrement the evsub reference.

Definition at line 3807 of file res_pjsip_pubsub.c.

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_NORMAL, SIP_SUB_TREE_TERMINATE_IN_PROGRESS, SIP_SUB_TREE_TERMINATED, sip_subscription_tree::state, sub_tree_state_description, and subscription_persistence_remove().

{
   struct sip_subscription_tree *sub_tree =
      pjsip_evsub_get_mod_data(evsub, pubsub_module.id);

   ast_debug(3, "evsub %p state %s event %s sub_tree %p sub_tree state %s\n", evsub,
      pjsip_evsub_get_state_name(evsub), pjsip_event_str(event->type), sub_tree,
      (sub_tree ? sub_tree_state_description[sub_tree->state] : "UNKNOWN"));

   if (!sub_tree || pjsip_evsub_get_state(evsub) != PJSIP_EVSUB_STATE_TERMINATED) {
      return;
   }

   /* It's easier to write this as what we WANT to process, then negate it. */
   if (!(sub_tree->state == SIP_SUB_TREE_TERMINATE_IN_PROGRESS
      || (event->type == PJSIP_EVENT_TSX_STATE && sub_tree->state == SIP_SUB_TREE_NORMAL)
      )) {
      ast_debug(3, "Do nothing.\n");
      return;
   }

   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);
}

pubsub_on_refresh_timeout()

static int pubsub_on_refresh_timeout ( void *  userdata )

static

Definition at line 3859 of file res_pjsip_pubsub.c.

References ast_debug, ast_test_suite_event_notify, sip_subscription_tree::dlg, sip_subscription_tree::root, send_notify(), set_state_terminated(), SIP_SUB_TREE_TERMINATE_IN_PROGRESS, SIP_SUB_TREE_TERMINATE_PENDING, sip_subscription_tree::state, and sub_tree_state_description.

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

{
   struct sip_subscription_tree *sub_tree = userdata;
   pjsip_dialog *dlg = sub_tree->dlg;

   ast_debug(3, "sub_tree %p sub_tree state %s\n", sub_tree,
      (sub_tree ? sub_tree_state_description[sub_tree->state] : "UNKNOWN"));

   pjsip_dlg_inc_lock(dlg);
   if (sub_tree->state >= SIP_SUB_TREE_TERMINATE_IN_PROGRESS) {
      pjsip_dlg_dec_lock(dlg);
      return 0;
   }

   if (sub_tree->state == SIP_SUB_TREE_TERMINATE_PENDING) {
      sub_tree->state = SIP_SUB_TREE_TERMINATE_IN_PROGRESS;
      set_state_terminated(sub_tree->root);
   }

   send_notify(sub_tree, 1);

   ast_test_suite_event_notify(sub_tree->root->subscription_state == PJSIP_EVSUB_STATE_TERMINATED ?
            "SUBSCRIPTION_TERMINATED" : "SUBSCRIPTION_REFRESHED",
            "Resource: %s", sub_tree->root->resource);

   pjsip_dlg_dec_lock(dlg);

   return 0;
}

pubsub_on_rx_mwi_notify_request()

static pj_bool_t pubsub_on_rx_mwi_notify_request ( pjsip_rx_data *  rdata )

static

Definition at line 3614 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_alloca, ast_debug, ast_log, ast_pjsip_rdata_get_endpoint(), ast_publish_mwi_state, ast_sip_get_pjsip_endpoint(), ast_sorcery_object_get_id(), ast_strdupa, ast_strlen_zero, ast_test_suite_event_notify, context, error(), LOG_ERROR, mailbox, simple_message_summary::message_account, NULL, parse_simple_message_summary(), RAII_VAR, simple_message_summary::voice_messages_new, simple_message_summary::voice_messages_old, simple_message_summary::voice_messages_urgent_new, and simple_message_summary::voice_messages_urgent_old.

Referenced by pubsub_on_rx_notify_request().

{
   RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
   struct simple_message_summary summary;
   const char *endpoint_name;
   char *atsign;
   char *context;
   char *body;
   char *mailbox;
   int rc;

   endpoint = ast_pjsip_rdata_get_endpoint(rdata);
   if (!endpoint) {
      ast_debug(1, "Incoming MWI: Endpoint not found in rdata (%p)\n", rdata);
      rc = 404;
      goto error;
   }

   endpoint_name = ast_sorcery_object_get_id(endpoint);
   ast_debug(1, "Incoming MWI: Found endpoint: %s\n", endpoint_name);
   if (ast_strlen_zero(endpoint->incoming_mwi_mailbox)) {
      ast_debug(1, "Incoming MWI: No incoming mailbox specified for endpoint '%s'\n", endpoint_name);
      ast_test_suite_event_notify("PUBSUB_NO_INCOMING_MWI_MAILBOX",
         "Endpoint: %s", endpoint_name);
      rc = 404;
      goto error;
   }

   mailbox = ast_strdupa(endpoint->incoming_mwi_mailbox);
   atsign = strchr(mailbox, '@');
   if (!atsign) {
      ast_debug(1, "Incoming MWI: No '@' found in endpoint %s's incoming mailbox '%s'.  Can't parse context\n",
         endpoint_name, endpoint->incoming_mwi_mailbox);
      rc = 404;
      goto error;
   }

   *atsign = '\0';
   context = atsign + 1;

   body = ast_alloca(rdata->msg_info.msg->body->len + 1);
   rdata->msg_info.msg->body->print_body(rdata->msg_info.msg->body, body,
      rdata->msg_info.msg->body->len + 1);

   if (parse_simple_message_summary(body, &summary) != 0) {
      ast_debug(1, "Incoming MWI: Endpoint: '%s' There was an issue getting message info from body '%s'\n",
         ast_sorcery_object_get_id(endpoint), body);
      rc = 404;
      goto error;
   }

   if (ast_publish_mwi_state(mailbox, context,
      summary.voice_messages_new, summary.voice_messages_old)) {
      ast_log(LOG_ERROR, "Incoming MWI: Endpoint: '%s' Could not publish MWI to stasis.  "
         "Mailbox: %s Message-Account: %s Voice-Messages: %d/%d (%d/%d)\n",
         endpoint_name, endpoint->incoming_mwi_mailbox, summary.message_account,
         summary.voice_messages_new, summary.voice_messages_old,
         summary.voice_messages_urgent_new, summary.voice_messages_urgent_old);
      rc = 404;
   } else {
      ast_debug(1, "Incoming MWI: Endpoint: '%s' Mailbox: %s Message-Account: %s Voice-Messages: %d/%d (%d/%d)\n",
         endpoint_name, endpoint->incoming_mwi_mailbox, summary.message_account,
         summary.voice_messages_new, summary.voice_messages_old,
         summary.voice_messages_urgent_new, summary.voice_messages_urgent_old);
      ast_test_suite_event_notify("PUBSUB_INCOMING_MWI_PUBLISH",
         "Endpoint: %s\r\n"
         "Mailbox: %s\r\n"
         "MessageAccount: %s\r\n"
         "VoiceMessagesNew: %d\r\n"
         "VoiceMessagesOld: %d\r\n"
         "VoiceMessagesUrgentNew: %d\r\n"
         "VoiceMessagesUrgentOld: %d",
            endpoint_name, endpoint->incoming_mwi_mailbox, summary.message_account,
            summary.voice_messages_new, summary.voice_messages_old,
            summary.voice_messages_urgent_new, summary.voice_messages_urgent_old);
      rc = 200;
   }

error:
   pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, rc, NULL, NULL, NULL);
   return PJ_TRUE;
}

pubsub_on_rx_notify()

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

Definition at line 3956 of file res_pjsip_pubsub.c.

References ast_sip_subscription::handler, pubsub_module, ast_sip_subscriber::state_change, sub, and ast_sip_subscription_handler::subscriber.

{
   struct ast_sip_subscription *sub;

   if (!(sub = pjsip_evsub_get_mod_data(evsub, pubsub_module.id))) {
      return;
   }

   sub->handler->subscriber->state_change(sub, rdata->msg_info.msg->body,
         pjsip_evsub_get_state(evsub));
}

pubsub_on_rx_notify_request()

static pj_bool_t pubsub_on_rx_notify_request ( pjsip_rx_data *  rdata )

static

Definition at line 3697 of file res_pjsip_pubsub.c.

References ast_sip_is_content_type(), and pubsub_on_rx_mwi_notify_request().

Referenced by pubsub_on_rx_request().

{
   if (rdata->msg_info.msg->body &&
      ast_sip_is_content_type(&rdata->msg_info.msg->body->content_type,
                        "application", "simple-message-summary")) {
      return pubsub_on_rx_mwi_notify_request(rdata);
   }
   return PJ_FALSE;
}

pubsub_on_rx_publish_request()

static pj_bool_t pubsub_on_rx_publish_request ( pjsip_rx_data *  rdata )

static

Definition at line 3326 of file res_pjsip_pubsub.c.

References ao2_cleanup, ao2_find, ao2_link, ao2_ref, ast_assert, ast_atomic_fetchadd_int(), ast_copy_pj_str(), ast_log, ast_pjsip_rdata_get_endpoint(), AST_SCHED_DEL_UNREF, AST_SCHED_REPLACE_UNREF, ast_sip_get_pjsip_endpoint(), AST_SIP_PUBLISH_STATE_ACTIVE, AST_SIP_PUBLISH_STATE_TERMINATED, ast_sorcery_object_get_id(), determine_sip_publish_type(), esc_etag_counter, find_pub_handler(), handler(), LOG_WARNING, NULL, OBJ_KEY, OBJ_UNLINK, ast_sip_publish_handler::publication_state_change, ast_sip_publish_handler::publications, publish_expire(), publish_request_initial(), RAII_VAR, sip_publication_respond(), SIP_PUBLISH_INITIAL, SIP_PUBLISH_MODIFY, SIP_PUBLISH_REFRESH, SIP_PUBLISH_REMOVE, SIP_PUBLISH_UNKNOWN, and str_event_name.

Referenced by pubsub_on_rx_request().

{
   pjsip_event_hdr *event_header;
   struct ast_sip_publish_handler *handler;
   RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
   char event[32];
   static const pj_str_t str_sip_if_match = { "SIP-If-Match", 12 };
   pjsip_generic_string_hdr *etag_hdr = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str_sip_if_match, NULL);
   enum sip_publish_type publish_type;
   RAII_VAR(struct ast_sip_publication *, publication, NULL, ao2_cleanup);
   unsigned int expires = 0;
   int entity_id, response = 0;

   endpoint = ast_pjsip_rdata_get_endpoint(rdata);
   ast_assert(endpoint != NULL);

   event_header = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str_event_name, rdata->msg_info.msg->hdr.next);
   if (!event_header) {
      ast_log(LOG_WARNING, "Incoming PUBLISH request from %s with no Event header\n",
         ast_sorcery_object_get_id(endpoint));
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 489, NULL, NULL, NULL);
      return PJ_TRUE;
   }
   ast_copy_pj_str(event, &event_header->event_type, sizeof(event));

   handler = find_pub_handler(event);
   if (!handler) {
      ast_log(LOG_WARNING, "No registered publish handler for event %s from %s\n", event,
         ast_sorcery_object_get_id(endpoint));
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 489, NULL, NULL, NULL);
      return PJ_TRUE;
   }

   publish_type = determine_sip_publish_type(rdata, etag_hdr, &expires, &entity_id);

   /* If this is not an initial publish ensure that a publication is present */
   if ((publish_type != SIP_PUBLISH_INITIAL) && (publish_type != SIP_PUBLISH_UNKNOWN)) {
      if (!(publication = ao2_find(handler->publications, &entity_id, OBJ_KEY | OBJ_UNLINK))) {
         static const pj_str_t str_conditional_request_failed = { "Conditional Request Failed", 26 };

         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 412, &str_conditional_request_failed,
            NULL, NULL);
         return PJ_TRUE;
      }

      /* Per the RFC every response has to have a new entity tag */
      publication->entity_tag = ast_atomic_fetchadd_int(&esc_etag_counter, +1);

      /* Update the expires here so that the created responses will contain the correct value */
      publication->expires = expires;
   }

   switch (publish_type) {
      case SIP_PUBLISH_INITIAL:
         publication = publish_request_initial(endpoint, rdata, handler);
         break;
      case SIP_PUBLISH_REFRESH:
      case SIP_PUBLISH_MODIFY:
         if (handler->publication_state_change(publication, rdata->msg_info.msg->body,
                  AST_SIP_PUBLISH_STATE_ACTIVE)) {
            /* If an error occurs we want to terminate the publication */
            expires = 0;
         }
         response = 200;
         break;
      case SIP_PUBLISH_REMOVE:
         handler->publication_state_change(publication, rdata->msg_info.msg->body,
               AST_SIP_PUBLISH_STATE_TERMINATED);
         response = 200;
         break;
      case SIP_PUBLISH_UNKNOWN:
      default:
         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 400, NULL, NULL, NULL);
         break;
   }

   if (publication) {
      if (expires) {
         ao2_link(handler->publications, publication);

         AST_SCHED_REPLACE_UNREF(publication->sched_id, sched, expires * 1000, publish_expire, publication,
                  ao2_ref(_data, -1), ao2_ref(publication, -1), ao2_ref(publication, +1));
      } else {
         AST_SCHED_DEL_UNREF(sched, publication->sched_id, ao2_ref(publication, -1));
      }
   }

   if (response) {
      sip_publication_respond(publication, response, rdata);
   }

   return PJ_TRUE;
}

pubsub_on_rx_refresh()

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  )

static

Called whenever an in-dialog SUBSCRIBE is received.

This includes both SUBSCRIBE requests that actually refresh the subscription as well as SUBSCRIBE requests that end the subscription.

In either case we push serialized_pubsub_on_refresh_timeout to send an appropriate NOTIFY request.

Definition at line 3911 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_cleanup, ao2_ref, ast_debug, ast_log, ast_sip_push_task(), ast_sip_sched_task_cancel(), ast_sip_sched_task_get_name(), create_require_eventlist(), sip_subscription_tree::evsub, sip_subscription_tree::expiration_task, sip_subscription_tree::is_list, LOG_ERROR, NULL, pubsub_module, serialized_pubsub_on_refresh_timeout(), sip_subscription_tree::serializer, SIP_SUB_TREE_NORMAL, SIP_SUB_TREE_TERMINATE_PENDING, sip_subscription_tree::state, sub_tree_state_description, SUBSCRIPTION_PERSISTENCE_REFRESHED, and subscription_persistence_update().

{
   struct sip_subscription_tree *sub_tree;

   sub_tree = pjsip_evsub_get_mod_data(evsub, pubsub_module.id);
   ast_debug(3, "evsub %p sub_tree %p sub_tree state %s\n", evsub, sub_tree,
      (sub_tree ? sub_tree_state_description[sub_tree->state] : "UNKNOWN"));

   if (!sub_tree || sub_tree->state != SIP_SUB_TREE_NORMAL) {
      return;
   }

   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;
   }

   /* PJSIP will set the evsub's state to terminated before calling into this function
    * if the Expires value of the incoming SUBSCRIBE is 0.
    */

   if (pjsip_evsub_get_state(sub_tree->evsub) == PJSIP_EVSUB_STATE_TERMINATED) {
      sub_tree->state = SIP_SUB_TREE_TERMINATE_PENDING;
   }

   subscription_persistence_update(sub_tree, rdata, SUBSCRIPTION_PERSISTENCE_REFRESHED);

   if (ast_sip_push_task(sub_tree->serializer, serialized_pubsub_on_refresh_timeout, ao2_bump(sub_tree))) {
      /* If we can't push the NOTIFY refreshing task...we'll just go with it. */
      ast_log(LOG_ERROR, "Failed to push task to send NOTIFY.\n");
      sub_tree->state = SIP_SUB_TREE_NORMAL;
      ao2_ref(sub_tree, -1);
   }

   if (sub_tree->is_list) {
      pj_list_insert_before(res_hdr, create_require_eventlist(rdata->tp_info.pool));
   }
}

pubsub_on_rx_request()

static pj_bool_t pubsub_on_rx_request ( pjsip_rx_data *  rdata )

static

Opaque structure representing an RFC 3265 SIP subscription.

Definition at line 3707 of file res_pjsip_pubsub.c.

References pjsip_publish_method, pubsub_on_rx_notify_request(), pubsub_on_rx_publish_request(), and pubsub_on_rx_subscribe_request().

{
   if (!pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, pjsip_get_subscribe_method())) {
      return pubsub_on_rx_subscribe_request(rdata);
   } else if (!pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_publish_method)) {
      return pubsub_on_rx_publish_request(rdata);
   } else if (!pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_notify_method)) {
      return pubsub_on_rx_notify_request(rdata);
   }

   return PJ_FALSE;
}

pubsub_on_rx_subscribe_request()

static pj_bool_t pubsub_on_rx_subscribe_request ( pjsip_rx_data *  rdata )

static

Definition at line 2969 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_cleanup, ao2_ref, ast_alloca, ast_assert, ast_copy_pj_str(), ast_debug, ast_free, ast_log, ast_malloc, ast_pjsip_rdata_get_endpoint(), ast_sip_get_pjsip_endpoint(), ast_sip_pubsub_has_eventlist_support(), ast_sip_push_task(), AST_SIP_USER_OPTIONS_TRUNCATE_CHECK, ast_sorcery_object_get_id(), build_resource_tree(), create_subscription_tree(), sip_subscription_tree::evsub, initial_notify_data::expires, generator, handler(), initial_notify_task(), LOG_WARNING, NULL, sip_subscription_tree::persistence, PJSIP_EXPIRES_NOT_SPECIFIED, RAII_VAR, resource_tree_destroy(), sip_subscription_tree::serializer, sip_subscription_accept(), initial_notify_data::sub_tree, subscription_get_generator_from_rdata(), subscription_get_handler_from_rdata(), subscription_persistence_create(), SUBSCRIPTION_PERSISTENCE_CREATED, and subscription_persistence_update().

Referenced by pubsub_on_rx_request().

{
   pjsip_expires_hdr *expires_header;
   struct ast_sip_subscription_handler *handler;
   RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
   struct sip_subscription_tree *sub_tree;
   struct ast_sip_pubsub_body_generator *generator;
   char *resource;
   pjsip_uri *request_uri;
   pjsip_sip_uri *request_uri_sip;
   size_t resource_size;
   int resp;
   struct resource_tree tree;
   pj_status_t dlg_status;

   endpoint = ast_pjsip_rdata_get_endpoint(rdata);
   ast_assert(endpoint != NULL);

   if (!endpoint->subscription.allow) {
      ast_log(LOG_WARNING, "Subscriptions not permitted for endpoint %s.\n", ast_sorcery_object_get_id(endpoint));
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 603, NULL, NULL, NULL);
      return PJ_TRUE;
   }

   request_uri = rdata->msg_info.msg->line.req.uri;

   if (!PJSIP_URI_SCHEME_IS_SIP(request_uri) && !PJSIP_URI_SCHEME_IS_SIPS(request_uri)) {
      char uri_str[PJSIP_MAX_URL_SIZE];

      pjsip_uri_print(PJSIP_URI_IN_REQ_URI, request_uri, uri_str, sizeof(uri_str));
      ast_log(LOG_WARNING, "Request URI '%s' is not a sip: or sips: URI.\n", uri_str);
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 416, NULL, NULL, NULL);
      return PJ_TRUE;
   }

   request_uri_sip = pjsip_uri_get_uri(request_uri);
   resource_size = pj_strlen(&request_uri_sip->user) + 1;
   resource = ast_alloca(resource_size);
   ast_copy_pj_str(resource, &request_uri_sip->user, resource_size);

   /*
    * We may want to match without any user options getting
    * in the way.
    */
   AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(resource);

   expires_header = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES, rdata->msg_info.msg->hdr.next);
   if (expires_header) {
      if (expires_header->ivalue == 0) {
         ast_debug(1, "Subscription request from endpoint %s rejected. Expiration of 0 is invalid\n",
            ast_sorcery_object_get_id(endpoint));
         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 400, NULL, NULL, NULL);
            return PJ_TRUE;
      }
      if (expires_header->ivalue < endpoint->subscription.minexpiry) {
         ast_log(LOG_WARNING, "Subscription expiration %d is too brief for endpoint %s. Minimum is %u\n",
            expires_header->ivalue, ast_sorcery_object_get_id(endpoint), endpoint->subscription.minexpiry);
         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 423, NULL, NULL, NULL);
         return PJ_TRUE;
      }
   }

   handler = subscription_get_handler_from_rdata(rdata, ast_sorcery_object_get_id(endpoint));
   if (!handler) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 489, NULL, NULL, NULL);
      return PJ_TRUE;
   }

   generator = subscription_get_generator_from_rdata(rdata, handler);
   if (!generator) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 489, NULL, NULL, NULL);
      return PJ_TRUE;
   }

   memset(&tree, 0, sizeof(tree));
   resp = build_resource_tree(endpoint, handler, resource, &tree,
      ast_sip_pubsub_has_eventlist_support(rdata));
   if (!PJSIP_IS_STATUS_IN_CLASS(resp, 200)) {
      pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, resp, NULL, NULL, NULL);
      resource_tree_destroy(&tree);
      return PJ_TRUE;
   }

   sub_tree = create_subscription_tree(handler, endpoint, rdata, resource, generator, &tree, &dlg_status, NULL);
   if (!sub_tree) {
      if (dlg_status != PJ_EEXISTS) {
         pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 500, NULL, NULL, NULL);
      }
   } else {
      struct initial_notify_data *ind = ast_malloc(sizeof(*ind));

      if (!ind) {
         pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);
         resource_tree_destroy(&tree);
         return PJ_TRUE;
      }

      ind->sub_tree = ao2_bump(sub_tree);
      /* Since this is a normal subscribe, pjproject takes care of the timer */
      ind->expires = PJSIP_EXPIRES_NOT_SPECIFIED;

      sub_tree->persistence = subscription_persistence_create(sub_tree);
      subscription_persistence_update(sub_tree, rdata, SUBSCRIPTION_PERSISTENCE_CREATED);
      sip_subscription_accept(sub_tree, rdata, resp);
      if (ast_sip_push_task(sub_tree->serializer, initial_notify_task, ind)) {
         pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);
         ao2_ref(sub_tree, -1);
         ast_free(ind);
      }
   }

   resource_tree_destroy(&tree);
   return PJ_TRUE;
}

pubsub_on_server_timeout()

static void pubsub_on_server_timeout ( pjsip_evsub *  sub )

static

Definition at line 4002 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_cleanup, ast_sip_push_task(), pubsub_module, serialized_pubsub_on_refresh_timeout(), sip_subscription_tree::serializer, SIP_SUB_TREE_NORMAL, SIP_SUB_TREE_TERMINATE_PENDING, and sip_subscription_tree::state.

{
   struct sip_subscription_tree *sub_tree;

   /* PJSIP does not terminate the server timeout timer when a SUBSCRIBE
    * with Expires: 0 arrives to end a subscription, nor does it terminate
    * this timer when we send a NOTIFY request in response to receiving such
    * a SUBSCRIBE. PJSIP does not stop the server timeout timer until the
    * NOTIFY transaction has finished (either through receiving a response
    * or through a transaction timeout).
    *
    * Therefore, it is possible that we can be told that a server timeout
    * occurred after we already thought that the subscription had been
    * terminated. In such a case, we will have already removed the sub_tree
    * from the evsub's mod_data array.
    */

   sub_tree = pjsip_evsub_get_mod_data(evsub, pubsub_module.id);
   if (!sub_tree || sub_tree->state != SIP_SUB_TREE_NORMAL) {
        return;
   }

   sub_tree->state = SIP_SUB_TREE_TERMINATE_PENDING;
   if (ast_sip_push_task(sub_tree->serializer, serialized_pubsub_on_refresh_timeout, ao2_bump(sub_tree))) {
      sub_tree->state = SIP_SUB_TREE_NORMAL;
      ao2_cleanup(sub_tree);
   }
}

remove_subscription()

static void remove_subscription ( struct sip_subscription_tree *  obj )

static

Definition at line 1182 of file res_pjsip_pubsub.c.

References ast_debug, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sip_subscription_get_resource_name(), ast_sorcery_object_get_id(), sip_subscription_tree::endpoint, sip_subscription_tree::next, and sip_subscription_tree::root.

Referenced by pubsub_on_evsub_state().

{
   struct sip_subscription_tree *i;

   AST_RWLIST_WRLOCK(&subscriptions);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&subscriptions, i, next) {
      if (i == obj) {
         AST_RWLIST_REMOVE_CURRENT(next);
         if (i->root) {
            ast_debug(2, "Removing subscription '%s->%s' from list of subscriptions\n",
               ast_sorcery_object_get_id(i->endpoint), ast_sip_subscription_get_resource_name(i->root));
         }
         break;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   AST_RWLIST_UNLOCK(&subscriptions);
}

resource_endpoint_handler()

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

static

Definition at line 5526 of file res_pjsip_pubsub.c.

References ast_free, ast_strdup, ast_sip_publication_resource::endpoint, and ast_variable::value.

Referenced by load_module().

{
   struct ast_sip_publication_resource *resource = obj;

   ast_free(resource->endpoint);
   resource->endpoint = ast_strdup(var->value);

   return 0;
}

resource_event_handler()

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

static

Definition at line 5536 of file res_pjsip_pubsub.c.

References ast_strlen_zero, ast_variable_new, ast_sip_publication_resource::events, item, ast_variable::name, ast_variable::next, and ast_variable::value.

Referenced by load_module().

{
   struct ast_sip_publication_resource *resource = obj;
   /* The event configuration name starts with 'event_' so skip past it to get the real name */
   const char *event = var->name + 6;
   struct ast_variable *item;

   if (ast_strlen_zero(event) || ast_strlen_zero(var->value)) {
      return -1;
   }

   item = ast_variable_new(event, var->value, "");
   if (!item) {
      return -1;
   }

   if (resource->events) {
      item->next = resource->events;
   }
   resource->events = item;

   return 0;
}

resource_list_alloc()

static void* resource_list_alloc ( const char *  name )

static

Definition at line 4764 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_sorcery_generic_alloc(), AST_VECTOR_INIT, resource_list::items, NULL, resource_list_destructor(), and RESOURCE_LIST_INIT_SIZE.

Referenced by apply_list_configuration().

{
   struct resource_list *list;

   list = ast_sorcery_generic_alloc(sizeof(*list), resource_list_destructor);
   if (!list) {
      return NULL;
   }

   if (AST_VECTOR_INIT(&list->items, RESOURCE_LIST_INIT_SIZE)) {
      ao2_cleanup(list);
      return NULL;
   }

   return list;
}

resource_list_apply_handler()

static int resource_list_apply_handler ( const struct ast_sorcery *  sorcery, void *  obj  )

static

Definition at line 4838 of file res_pjsip_pubsub.c.

References ast_log, ast_sorcery_object_get_id(), ast_strlen_zero, AST_VECTOR_SIZE, resource_list::event, resource_list::items, and LOG_WARNING.

Referenced by apply_list_configuration().

{
   struct resource_list *list = obj;

   if (ast_strlen_zero(list->event)) {
      ast_log(LOG_WARNING, "Resource list '%s' has no event set\n",
            ast_sorcery_object_get_id(list));
      return -1;
   }

   if (AST_VECTOR_SIZE(&list->items) == 0) {
      ast_log(LOG_WARNING, "Resource list '%s' has no list items\n",
            ast_sorcery_object_get_id(list));
      return -1;
   }

   return 0;
}

resource_list_destructor()

static void resource_list_destructor ( void *  obj )

static

Definition at line 4752 of file res_pjsip_pubsub.c.

References ast_free, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, and resource_list::items.

Referenced by resource_list_alloc().

{
   struct resource_list *list = obj;
   int i;

   for (i = 0; i < AST_VECTOR_SIZE(&list->items); ++i) {
      ast_free((char *) AST_VECTOR_GET(&list->items, i));
   }

   AST_VECTOR_FREE(&list->items);
}

resource_tree_destroy()

static void resource_tree_destroy ( struct resource_tree *  tree )

static

Destroy a resource tree.

This function makes no assumptions about how the tree itself was allocated and does not attempt to free the tree itself. Callers of this function are responsible for freeing the tree.

Parameters

tree	The tree to destroy.

Definition at line 1109 of file res_pjsip_pubsub.c.

References resource_tree::root, and tree_node_destroy().

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

{
   if (tree) {
      tree_node_destroy(tree->root);
   }
}

retrieve_resource_list()

static struct resource_list* retrieve_resource_list ( const char *  resource, const char *  event  )

static

Helper function for retrieving a resource list for a given event.

This will retrieve a resource list that corresponds to the resource and event provided.

Parameters

resource	The name of the resource list to retrieve
event	The expected event name on the resource list

Definition at line 902 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_log, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_id(), resource_list::event, LOG_WARNING, and NULL.

Referenced by build_node_children(), and build_resource_tree().

{
   struct resource_list *list;

   list = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "resource_list", resource);
   if (!list) {
      return NULL;
   }

   if (strcmp(list->event, event)) {
      ast_log(LOG_WARNING, "Found resource list %s, but its event type (%s) does not match SUBSCRIBE's (%s)\n",
            resource, list->event, event);
      ao2_cleanup(list);
      return NULL;
   }

   return list;
}

rlmi_clone_data()

static void* rlmi_clone_data ( pj_pool_t *  pool, const void *  data, unsigned  len  )

static

Definition at line 2140 of file res_pjsip_pubsub.c.

Referenced by build_rlmi_body().

{
   const pj_xml_node *rlmi = data;

   return pj_xml_clone(pool, rlmi);
}

rlmi_print_body()

static int rlmi_print_body ( struct pjsip_msg_body *  msg_body, char *  buf, pj_size_t  size  )

static

Definition at line 2127 of file res_pjsip_pubsub.c.

References AST_PJSIP_XML_PROLOG_LEN.

Referenced by build_rlmi_body().

{
   int num_printed;
   pj_xml_node *rlmi = msg_body->data;

   num_printed = pj_xml_print(rlmi, buf, size, PJ_TRUE);
   if (num_printed <= AST_PJSIP_XML_PROLOG_LEN) {
      return -1;
   }

   return num_printed;
}

sched_cb()

static int sched_cb ( const void *  data )

static

Definition at line 2500 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_sip_push_task(), serialized_send_notify(), and sip_subscription_tree::serializer.

Referenced by schedule_notification().

{
   struct sip_subscription_tree *sub_tree = (struct sip_subscription_tree *) data;

   /* We don't need to bump the refcount of sub_tree since we bumped it when scheduling this task */
   if (ast_sip_push_task(sub_tree->serializer, serialized_send_notify, sub_tree)) {
      ao2_cleanup(sub_tree);
   }

   return 0;
}

schedule_notification()

static int schedule_notification ( struct sip_subscription_tree *  sub_tree )

static

Definition at line 2512 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_cleanup, ast_sched_add(), sip_subscription_tree::notification_batch_interval, sip_subscription_tree::notify_sched_id, sched_cb(), and sip_subscription_tree::send_scheduled_notify.

Referenced by ast_sip_subscription_notify().

{
   /* There's already a notification scheduled */
   if (sub_tree->notify_sched_id > -1) {
      return 0;
   }

   sub_tree->send_scheduled_notify = 1;
   sub_tree->notify_sched_id = ast_sched_add(sched, sub_tree->notification_batch_interval, sched_cb, ao2_bump(sub_tree));
   if (sub_tree->notify_sched_id < 0) {
      ao2_cleanup(sub_tree);
      return -1;
   }

   return 0;
}

send_notify()

static int send_notify ( struct sip_subscription_tree *  sub_tree, unsigned int  force_full_state  )

static

Send a NOTIFY request to a subscriber.

Precondition

sub_tree->dlg is locked

Parameters

sub_tree	The subscription tree representing the subscription
force_full_state	If true, ignore resource list settings and send full resource list state.

Return values

0	Success
non-zero	Failure

Definition at line 2425 of file res_pjsip_pubsub.c.

References ast_shutdown_final(), create_require_eventlist(), sip_subscription_tree::evsub, generate_notify_body(), sip_subscription_tree::is_list, NULL, sip_subscription_tree::persistence, sip_subscription_tree::root, sip_subscription_tree::send_scheduled_notify, and sip_subscription_send_request().

Referenced by ast_sip_subscription_notify(), initial_notify_task(), pubsub_on_refresh_timeout(), and serialized_send_notify().

{
   pjsip_evsub *evsub = sub_tree->evsub;
   pjsip_tx_data *tdata;

   if (ast_shutdown_final()
      && sub_tree->root->subscription_state == PJSIP_EVSUB_STATE_TERMINATED
      && sub_tree->persistence) {
      return 0;
   }

   if (pjsip_evsub_notify(evsub, sub_tree->root->subscription_state,
            NULL, NULL, &tdata) != PJ_SUCCESS) {
      return -1;
   }

   tdata->msg->body = generate_notify_body(tdata->pool, sub_tree->root, force_full_state);
   if (!tdata->msg->body) {
      pjsip_tx_data_dec_ref(tdata);
      return -1;
   }

   if (sub_tree->is_list) {
      pjsip_require_hdr *require = create_require_eventlist(tdata->pool);
      pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) require);
   }

   if (sip_subscription_send_request(sub_tree, tdata)) {
      /* do not call pjsip_tx_data_dec_ref(tdata). The pjsip_dlg_send_request deletes the message on error */
      return -1;
   }

   sub_tree->send_scheduled_notify = 0;

   return 0;
}

serialized_pubsub_on_client_refresh()

static int serialized_pubsub_on_client_refresh ( void *  userdata )

static

Definition at line 3969 of file res_pjsip_pubsub.c.

References ao2_cleanup, sip_subscription_tree::evsub, and NULL.

Referenced by pubsub_on_client_refresh().

{
   struct sip_subscription_tree *sub_tree = userdata;
   pjsip_tx_data *tdata;

   if (!sub_tree->evsub) {
      ao2_cleanup(sub_tree);
      return 0;
   }

   if (pjsip_evsub_initiate(sub_tree->evsub, NULL, -1, &tdata) == PJ_SUCCESS) {
      pjsip_evsub_send_request(sub_tree->evsub, tdata);
   } else {
      pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);
   }

   ao2_cleanup(sub_tree);
   return 0;
}

serialized_pubsub_on_refresh_timeout()

static int serialized_pubsub_on_refresh_timeout ( void *  userdata )

static

Definition at line 3889 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, pubsub_on_refresh_timeout(), sip_subscription_tree::state, and sub_tree_state_description.

Referenced by pubsub_on_rx_refresh(), and pubsub_on_server_timeout().

{
   struct sip_subscription_tree *sub_tree = userdata;

   ast_debug(3, "sub_tree %p sub_tree state %s\n", sub_tree,
      (sub_tree ? sub_tree_state_description[sub_tree->state] : "UNKNOWN"));

   pubsub_on_refresh_timeout(userdata);
   ao2_cleanup(sub_tree);

   return 0;
}

serialized_send_notify()

static int serialized_send_notify ( void *  userdata )

static

Definition at line 2462 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_test_suite_event_notify, sip_subscription_tree::dlg, sip_subscription_tree::notify_sched_id, sip_subscription_tree::root, send_notify(), sip_subscription_tree::send_scheduled_notify, SIP_SUB_TREE_TERMINATE_IN_PROGRESS, SIP_SUB_TREE_TERMINATED, and sip_subscription_tree::state.

Referenced by sched_cb().

{
   struct sip_subscription_tree *sub_tree = userdata;
   pjsip_dialog *dlg = sub_tree->dlg;

   pjsip_dlg_inc_lock(dlg);

   /* It's possible that between when the notification was scheduled
    * and now a new SUBSCRIBE arrived requiring full state to be
    * sent out in an immediate NOTIFY. It's also possible that we're
    * already processing a terminate.  If that has happened, we need to
    * bail out here instead of sending the batched NOTIFY.
    */

   if (sub_tree->state >= SIP_SUB_TREE_TERMINATE_IN_PROGRESS
      || !sub_tree->send_scheduled_notify) {
      pjsip_dlg_dec_lock(dlg);
      ao2_cleanup(sub_tree);
      return 0;
   }

   if (sub_tree->root->subscription_state == PJSIP_EVSUB_STATE_TERMINATED) {
      sub_tree->state = SIP_SUB_TREE_TERMINATE_IN_PROGRESS;
   }

   send_notify(sub_tree, 0);

   ast_test_suite_event_notify(
      sub_tree->state == SIP_SUB_TREE_TERMINATED
         ? "SUBSCRIPTION_TERMINATED" : "SUBSCRIPTION_STATE_CHANGED",
      "Resource: %s", sub_tree->root->resource);

   sub_tree->notify_sched_id = -1;
   pjsip_dlg_dec_lock(dlg);
   ao2_cleanup(sub_tree);
   return 0;
}

set_state_terminated()

static void set_state_terminated ( struct ast_sip_subscription *  sub )

static

Definition at line 3720 of file res_pjsip_pubsub.c.

References AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by pubsub_on_refresh_timeout().

{
   int i;

   sub->subscription_state = PJSIP_EVSUB_STATE_TERMINATED;
   for (i = 0; i < AST_VECTOR_SIZE(&sub->children); ++i) {
      set_state_terminated(AST_VECTOR_GET(&sub->children, i));
   }
}

shutdown_subscriptions()

static void shutdown_subscriptions ( struct ast_sip_subscription *  sub )

static

Definition at line 1328 of file res_pjsip_pubsub.c.

References AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sip_subscription::handler, and ast_sip_subscription_handler::subscription_shutdown.

Referenced by pubsub_on_evsub_state().

{
   int i;

   if (!sub) {
      return;
   }

   if (AST_VECTOR_SIZE(&sub->children) > 0) {
      for (i = 0; i < AST_VECTOR_SIZE(&sub->children); ++i) {
         shutdown_subscriptions(AST_VECTOR_GET(&sub->children, i));
      }
      return;
   }

   /* We notify subscription shutdown only on the tree leaves. */
   if (sub->handler->subscription_shutdown) {
      sub->handler->subscription_shutdown(sub);
   }
}

sip_create_publication()

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

Definition at line 3145 of file res_pjsip_pubsub.c.

References ao2_alloc, ao2_ref, ast_assert, ast_atomic_fetchadd_int(), ast_datastores_alloc(), ast_module_ref, ast_sip_publication::data, ast_sip_publication::datastores, DEFAULT_PUBLISH_EXPIRES, ast_sip_publication::endpoint, ast_sip_publication::entity_tag, esc_etag_counter, ast_sip_publication::event_configuration_name, ast_sip_publication::expires, NULL, publication_destroy_fn(), ast_sip_publication::resource, ast_sip_publication::sched_id, and ast_module_info::self.

Referenced by publish_request_initial().

{
   struct ast_sip_publication *publication;
   pjsip_expires_hdr *expires_hdr = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES, NULL);
   size_t resource_len = strlen(resource) + 1, event_configuration_name_len = strlen(event_configuration_name) + 1;
   char *dst;

   ast_assert(endpoint != NULL);

   if (!(publication = ao2_alloc(sizeof(*publication) + resource_len + event_configuration_name_len, publication_destroy_fn))) {
      return NULL;
   }

   ast_module_ref(ast_module_info->self);

   if (!(publication->datastores = ast_datastores_alloc())) {
      ao2_ref(publication, -1);
      return NULL;
   }

   publication->entity_tag = ast_atomic_fetchadd_int(&esc_etag_counter, +1);
   ao2_ref(endpoint, +1);
   publication->endpoint = endpoint;
   publication->expires = expires_hdr ? expires_hdr->ivalue : DEFAULT_PUBLISH_EXPIRES;
   publication->sched_id = -1;
   dst = publication->data;
   publication->resource = strcpy(dst, resource);
   dst += resource_len;
   publication->event_configuration_name = strcpy(dst, event_configuration_name);

   return publication;
}

sip_publication_respond()

static int sip_publication_respond ( struct ast_sip_publication *  pub, int  status_code, pjsip_rx_data *  rdata  )

static

Definition at line 3179 of file res_pjsip_pubsub.c.

References ast_sip_add_header(), ast_sip_get_pjsip_endpoint(), buf, ast_sip_publication::entity_tag, ast_sip_publication::expires, NULL, and pubsub_module.

Referenced by publish_request_initial(), and pubsub_on_rx_publish_request().

{
   pjsip_tx_data *tdata;
   pjsip_transaction *tsx;

   if (pjsip_endpt_create_response(ast_sip_get_pjsip_endpoint(), rdata, status_code, NULL, &tdata) != PJ_SUCCESS) {
      return -1;
   }

   if (PJSIP_IS_STATUS_IN_CLASS(status_code, 200)) {
      char buf[30];

      snprintf(buf, sizeof(buf), "%d", pub->entity_tag);
      ast_sip_add_header(tdata, "SIP-ETag", buf);

      snprintf(buf, sizeof(buf), "%d", pub->expires);
      ast_sip_add_header(tdata, "Expires", buf);
   }

   if (pjsip_tsx_create_uas(&pubsub_module, rdata, &tsx) != PJ_SUCCESS) {
      pjsip_tx_data_dec_ref(tdata);
      return -1;
   }

   pjsip_tsx_recv_msg(tsx, rdata);

   if (pjsip_tsx_send_msg(tsx, tdata) != PJ_SUCCESS) {
      pjsip_tx_data_dec_ref(tdata);
      return -1;
   }

   return 0;
}

sip_subscription_accept()

static int sip_subscription_accept ( struct sip_subscription_tree *  sub_tree, pjsip_rx_data *  rdata, int  response  )

static

Definition at line 2606 of file res_pjsip_pubsub.c.

References ast_sip_mod_data_get, create_require_eventlist(), sip_subscription_tree::evsub, sip_subscription_tree::is_list, MOD_DATA_PERSISTENCE, and pubsub_module.

Referenced by pubsub_on_rx_subscribe_request().

{
   pjsip_hdr res_hdr;

   /* If this is a persistence recreation the subscription has already been accepted */
   if (ast_sip_mod_data_get(rdata->endpt_info.mod_data, pubsub_module.id, MOD_DATA_PERSISTENCE)) {
      return 0;
   }

   pj_list_init(&res_hdr);
   if (sub_tree->is_list) {
      /* If subscribing to a list, our response has to have a Require: eventlist header in it */
      pj_list_insert_before(&res_hdr, create_require_eventlist(rdata->tp_info.pool));
   }

   return pjsip_evsub_accept(sub_tree->evsub, rdata, response, &res_hdr) == PJ_SUCCESS ? 0 : -1;
}

sip_subscription_send_request()

static int sip_subscription_send_request ( struct sip_subscription_tree *  sub_tree, pjsip_tx_data *  tdata  )

static

Definition at line 1989 of file res_pjsip_pubsub.c.

References allocate_tdata_buffer(), ast_log, ast_sorcery_object_get_id(), ast_test_suite_event_notify, sip_subscription_tree::endpoint, sip_subscription_tree::evsub, LOG_ERROR, NULL, SUBSCRIPTION_PERSISTENCE_SEND_REQUEST, and subscription_persistence_update().

Referenced by send_notify().

{
#ifdef TEST_FRAMEWORK
   struct ast_sip_endpoint *endpoint = sub_tree->endpoint;
   pjsip_evsub *evsub = sub_tree->evsub;
#endif
   int res;

   if (allocate_tdata_buffer(tdata)) {
      ast_log(LOG_ERROR, "SIP request %s is too large to send.\n", tdata->info);
      pjsip_tx_data_dec_ref(tdata);
      return -1;
   }

   res = pjsip_evsub_send_request(sub_tree->evsub, tdata);

   subscription_persistence_update(sub_tree, NULL, SUBSCRIPTION_PERSISTENCE_SEND_REQUEST);

   ast_test_suite_event_notify("SUBSCRIPTION_STATE_SET",
      "StateText: %s\r\n"
      "Endpoint: %s\r\n",
      pjsip_evsub_get_state_name(evsub),
      ast_sorcery_object_get_id(endpoint));

   return (res == PJ_SUCCESS ? 0 : -1);
}

sip_subscription_to_ami()

static void sip_subscription_to_ami ( struct sip_subscription_tree *  sub_tree, struct ast_str **  buf  )

static

Definition at line 1820 of file res_pjsip_pubsub.c.

References ast_callerid_merge(), ast_copy_pj_str(), ast_copy_string(), ast_sorcery_object_get_id(), ast_str_append(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, sip_subscription_tree::evsub, ast_sip_subscription::handler, ast_sip_endpoint::id, ast_party_id::name, NULL, ast_party_id::number, sip_subscription_tree::role, sip_subscription_tree::root, S_COR, ast_sip_endpoint_id_configuration::self, sip_subscription_roles_map, str, ast_party_name::str, ast_party_number::str, ast_sip_subscription_handler::to_ami, ast_party_name::valid, and ast_party_number::valid.

Referenced by ami_subscription_detail(), and cli_show_subscription_common().

{
   char str[256];
   struct ast_sip_endpoint_id_configuration *id = &sub_tree->endpoint->id;

   ast_str_append(buf, 0, "Role: %s\r\n",
             sip_subscription_roles_map[sub_tree->role]);
   ast_str_append(buf, 0, "Endpoint: %s\r\n",
             ast_sorcery_object_get_id(sub_tree->endpoint));

   if (sub_tree->dlg) {
      ast_copy_pj_str(str, &sub_tree->dlg->call_id->id, sizeof(str));
   } else {
      ast_copy_string(str, "<unknown>", sizeof(str));
   }
   ast_str_append(buf, 0, "Callid: %s\r\n", str);

   ast_str_append(buf, 0, "State: %s\r\n", pjsip_evsub_get_state_name(sub_tree->evsub));

   ast_callerid_merge(str, sizeof(str),
            S_COR(id->self.name.valid, id->self.name.str, NULL),
            S_COR(id->self.number.valid, id->self.number.str, NULL),
            "Unknown");

   ast_str_append(buf, 0, "Callerid: %s\r\n", str);

   /* XXX This needs to be done recursively for lists */
   if (sub_tree->root->handler->to_ami) {
      sub_tree->root->handler->to_ami(sub_tree->root, buf);
   }
}

sub_add_handler()

static void sub_add_handler ( struct ast_sip_subscription_handler *  handler )

static

Definition at line 2756 of file res_pjsip_pubsub.c.

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_sip_publish_handler::next.

Referenced by ast_sip_register_subscription_handler().

{
   AST_RWLIST_WRLOCK(&subscription_handlers);
   AST_RWLIST_INSERT_TAIL(&subscription_handlers, handler, next);
   AST_RWLIST_UNLOCK(&subscription_handlers);
}

sub_persistence_recreate()

static int sub_persistence_recreate ( void *  obj )

static

Definition at line 1556 of file res_pjsip_pubsub.c.

References ao2_bump, ao2_ref, ast_alloca, ast_copy_pj_str(), ast_debug, ast_free, ast_log, ast_malloc, ast_sip_get_sorcery(), ast_sip_mod_data_set, ast_sip_pubsub_has_eventlist_support(), ast_sip_push_task(), AST_SIP_USER_OPTIONS_TRUNCATE_CHECK, ast_sorcery_delete(), ast_sorcery_retrieve_by_id(), ast_tvdiff_ms(), ast_tvnow(), build_resource_tree(), create_subscription_tree(), subscription_persistence::endpoint, error(), sip_subscription_tree::evsub, subscription_persistence::expires, initial_notify_data::expires, generator, handler(), initial_notify_task(), LOG_WARNING, MOD_DATA_PERSISTENCE, ast_sip_subscription_handler::notifier, persistence_recreate_data::persistence, pubsub_module, persistence_recreate_data::rdata, resource_tree_destroy(), sip_subscription_tree::serializer, initial_notify_data::sub_tree, subscription_get_generator_from_rdata(), subscription_get_handler_from_rdata(), SUBSCRIPTION_PERSISTENCE_RECREATED, subscription_persistence_update(), and subscription_persistence::tag.

Referenced by subscription_persistence_recreate().

{
   struct persistence_recreate_data *recreate_data = obj;
   struct subscription_persistence *persistence = recreate_data->persistence;
   pjsip_rx_data *rdata = recreate_data->rdata;
   struct ast_sip_endpoint *endpoint;
   struct sip_subscription_tree *sub_tree;
   struct ast_sip_pubsub_body_generator *generator;
   struct ast_sip_subscription_handler *handler;
   char *resource;
   pjsip_sip_uri *request_uri;
   size_t resource_size;
   int resp;
   struct resource_tree tree;
   pjsip_expires_hdr *expires_header;
   int64_t expires;

   request_uri = pjsip_uri_get_uri(rdata->msg_info.msg->line.req.uri);
   resource_size = pj_strlen(&request_uri->user) + 1;
   resource = ast_alloca(resource_size);
   ast_copy_pj_str(resource, &request_uri->user, resource_size);

   /*
    * We may want to match without any user options getting
    * in the way.
    */
   AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(resource);

   handler = subscription_get_handler_from_rdata(rdata, persistence->endpoint);
   if (!handler || !handler->notifier) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Could not get subscription handler.\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   generator = subscription_get_generator_from_rdata(rdata, handler);
   if (!generator) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Body generator not available.\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   ast_sip_mod_data_set(rdata->tp_info.pool, rdata->endpt_info.mod_data,
      pubsub_module.id, MOD_DATA_PERSISTENCE, persistence);

   /* Getting the endpoint may take some time that can affect the expiration. */
   endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
      persistence->endpoint);
   if (!endpoint) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: The endpoint was not found\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   /* Update the expiration header with the new expiration */
   expires_header = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES,
      rdata->msg_info.msg->hdr.next);
   if (!expires_header) {
      expires_header = pjsip_expires_hdr_create(rdata->tp_info.pool, 0);
      if (!expires_header) {
         ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Could not update expires header.\n",
            persistence->endpoint);
         ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
         ao2_ref(endpoint, -1);
         return 0;
      }
      pjsip_msg_add_hdr(rdata->msg_info.msg, (pjsip_hdr *) expires_header);
   }

   expires = (ast_tvdiff_ms(persistence->expires, ast_tvnow()) / 1000);
   if (expires <= 0) {
      /* The subscription expired since we started recreating the subscription. */
      ast_debug(3, "Expired subscription retrived from persistent store '%s' %s\n",
         persistence->endpoint, persistence->tag);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      ao2_ref(endpoint, -1);
      return 0;
   }
   expires_header->ivalue = expires;

   memset(&tree, 0, sizeof(tree));
   resp = build_resource_tree(endpoint, handler, resource, &tree,
      ast_sip_pubsub_has_eventlist_support(rdata));
   if (PJSIP_IS_STATUS_IN_CLASS(resp, 200)) {
      pj_status_t dlg_status;

      sub_tree = create_subscription_tree(handler, endpoint, rdata, resource, generator,
         &tree, &dlg_status, persistence);
      if (!sub_tree) {
         if (dlg_status != PJ_EEXISTS) {
            ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Could not create subscription tree.\n",
               persistence->endpoint);
            ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
         }
      } else {
         struct initial_notify_data *ind = ast_malloc(sizeof(*ind));

         if (!ind) {
            pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);
            goto error;
         }

         ind->sub_tree = ao2_bump(sub_tree);
         ind->expires = expires_header->ivalue;

         subscription_persistence_update(sub_tree, rdata, SUBSCRIPTION_PERSISTENCE_RECREATED);
         if (ast_sip_push_task(sub_tree->serializer, initial_notify_task, ind)) {
            /* Could not send initial subscribe NOTIFY */
            pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);
            ao2_ref(sub_tree, -1);
            ast_free(ind);
         }
      }
   } else {
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
   }

error:
   resource_tree_destroy(&tree);
   ao2_ref(endpoint, -1);

   return 0;
}

sub_tree_subscription_terminate_cb()

static int sub_tree_subscription_terminate_cb ( void *  data )

static

Definition at line 572 of file res_pjsip_pubsub.c.

References ao2_ref, ast_debug, subscription_persistence::endpoint, sip_subscription_tree::evsub, sip_subscription_tree::persistence, subscription_persistence::prune_on_boot, sip_subscription_tree::root, SIP_SUB_TREE_TERMINATE_IN_PROGRESS, and sip_subscription_tree::state.

Referenced by sub_tree_transport_cb().

{
   struct sip_subscription_tree *sub_tree = data;

   if (!sub_tree->evsub) {
      /* Something else already terminated the subscription. */
      ao2_ref(sub_tree, -1);
      return 0;
   }

   ast_debug(3, "Transport destroyed.  Removing subscription '%s->%s'  prune on boot: %d\n",
      sub_tree->persistence->endpoint, sub_tree->root->resource,
      sub_tree->persistence->prune_on_boot);

   sub_tree->state = SIP_SUB_TREE_TERMINATE_IN_PROGRESS;
   pjsip_evsub_terminate(sub_tree->evsub, PJ_TRUE);

   ao2_ref(sub_tree, -1);
   return 0;
}

sub_tree_transport_cb()

static void sub_tree_transport_cb ( void *  data )

static

Definition at line 603 of file res_pjsip_pubsub.c.

References ao2_ref, ast_sip_push_task(), sip_subscription_tree::serializer, and sub_tree_subscription_terminate_cb().

Referenced by subscription_persistence_remove(), subscription_persistence_update(), and unload_module().

{
   struct sip_subscription_tree *sub_tree = data;

   /*
    * Push off the subscription termination to the serializer to
    * avoid deadlock.  Another thread could be trying to send a
    * message on the subscription that can deadlock with this
    * thread.
    */
   ao2_ref(sub_tree, +1);
   if (ast_sip_push_task(sub_tree->serializer, sub_tree_subscription_terminate_cb,
      sub_tree)) {
      ao2_ref(sub_tree, -1);
   }
}

subscription_get_generator_from_rdata()

static struct ast_sip_pubsub_body_generator* subscription_get_generator_from_rdata ( pjsip_rx_data *  rdata, const struct ast_sip_subscription_handler *  handler  )

static

Retrieve a body generator using the Accept header of an rdata message.

Definition at line 831 of file res_pjsip_pubsub.c.

References ast_copy_pj_str(), ast_copy_string(), AST_SIP_MAX_ACCEPT, ast_sip_subscription_handler::body_type, ast_sip_notifier::default_accept, exceptional_accept(), find_body_generator(), ast_sip_subscription_handler::notifier, and while().

Referenced by pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

{
   pjsip_accept_hdr *accept_header = (pjsip_accept_hdr *) &rdata->msg_info.msg->hdr;
   char accept[AST_SIP_MAX_ACCEPT][64];
   size_t num_accept_headers = 0;

   while ((accept_header = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_ACCEPT, accept_header->next)) &&
      (num_accept_headers < AST_SIP_MAX_ACCEPT)) {
      int i;

      for (i = 0; i < accept_header->count && num_accept_headers < AST_SIP_MAX_ACCEPT; ++i) {
         if (!exceptional_accept(&accept_header->values[i])) {
            ast_copy_pj_str(accept[num_accept_headers], &accept_header->values[i], sizeof(accept[num_accept_headers]));
            ++num_accept_headers;
         }
      }
   }

   if (num_accept_headers == 0) {
      /* If a SUBSCRIBE contains no Accept headers, then we must assume that
       * the default accept type for the event package is to be used.
       */
      ast_copy_string(accept[0], handler->notifier->default_accept, sizeof(accept[0]));
      num_accept_headers = 1;
   }

   return find_body_generator(accept, num_accept_headers, handler->body_type);
}

subscription_get_handler_from_rdata()

static struct ast_sip_subscription_handler* subscription_get_handler_from_rdata ( pjsip_rx_data *  rdata, const char *  endpoint  )

static

Retrieve a handler using the Event header of an rdata message.

Definition at line 771 of file res_pjsip_pubsub.c.

References ast_copy_pj_str(), ast_log, find_sub_handler_for_event_name(), handler(), LOG_WARNING, NULL, and str_event_name.

Referenced by pubsub_on_rx_subscribe_request(), and sub_persistence_recreate().

{
   pjsip_event_hdr *event_header;
   char event[32];
   struct ast_sip_subscription_handler *handler;

   event_header = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &str_event_name, rdata->msg_info.msg->hdr.next);
   if (!event_header) {
      ast_log(LOG_WARNING, "Incoming SUBSCRIBE request from %s with no Event header\n",
         endpoint ? endpoint : "Unknown");
      return NULL;
   }
   ast_copy_pj_str(event, &event_header->event_type, sizeof(event));

   handler = find_sub_handler_for_event_name(event);
   if (!handler) {
      ast_log(LOG_WARNING, "No registered subscribe handler for event %s from %s\n", event,
         endpoint ? endpoint : "Unknown");
   }

   return handler;
}

subscription_persistence_alloc()

static void* subscription_persistence_alloc ( const char *  name )

static

Allocator for subscription persistence.

Definition at line 631 of file res_pjsip_pubsub.c.

References ast_sorcery_generic_alloc(), and subscription_persistence_destroy().

Referenced by load_module().

{
   return ast_sorcery_generic_alloc(sizeof(struct subscription_persistence), subscription_persistence_destroy);
}

subscription_persistence_create()

static struct subscription_persistence* subscription_persistence_create ( struct sip_subscription_tree *  sub_tree )

static

Function which creates initial persistence information of a subscription in sorcery.

Definition at line 637 of file res_pjsip_pubsub.c.

References ast_copy_pj_str(), ast_sip_get_sorcery(), ast_sorcery_alloc(), ast_sorcery_create(), ast_sorcery_object_get_id(), ast_strdup, sip_subscription_tree::dlg, subscription_persistence::endpoint, sip_subscription_tree::endpoint, NULL, and subscription_persistence::tag.

Referenced by pubsub_on_rx_subscribe_request().

{
   char tag[PJ_GUID_STRING_LENGTH + 1];

   /* The id of this persistence object doesn't matter as we keep it on the subscription and don't need to
    * look it up by id at all.
    */
   struct subscription_persistence *persistence = ast_sorcery_alloc(ast_sip_get_sorcery(),
      "subscription_persistence", NULL);

   pjsip_dialog *dlg = sub_tree->dlg;

   if (!persistence) {
      return NULL;
   }

   persistence->endpoint = ast_strdup(ast_sorcery_object_get_id(sub_tree->endpoint));
   ast_copy_pj_str(tag, &dlg->local.info->tag, sizeof(tag));
   persistence->tag = ast_strdup(tag);

   ast_sorcery_create(ast_sip_get_sorcery(), persistence);
   return persistence;
}

subscription_persistence_destroy()

static void subscription_persistence_destroy ( void *  obj )

static

Destructor for subscription persistence.

Definition at line 621 of file res_pjsip_pubsub.c.

References ast_free, ast_json_unref(), subscription_persistence::endpoint, subscription_persistence::generator_data, and subscription_persistence::tag.

Referenced by subscription_persistence_alloc().

{
   struct subscription_persistence *persistence = obj;

   ast_free(persistence->endpoint);
   ast_free(persistence->tag);
   ast_json_unref(persistence->generator_data);
}

subscription_persistence_event_cb()

static void subscription_persistence_event_cb ( void *  data, struct stasis_subscription *  sub, struct stasis_message *  message  )

static

Event callback which fires subscription persistence recreation when the system is fully booted.

Definition at line 1772 of file res_pjsip_pubsub.c.

References ast_json_object_get(), ast_json_string_get(), ast_manager_get_generic_type(), ast_sip_push_task(), ast_json_payload::json, NULL, stasis_message_data(), stasis_message_type(), stasis_unsubscribe(), subscription_persistence_load(), and type.

Referenced by load_module().

{
   struct ast_json_payload *payload;
   const char *type;

   if (stasis_message_type(message) != ast_manager_get_generic_type()) {
      return;
   }

   payload = stasis_message_data(message);
   type = ast_json_string_get(ast_json_object_get(payload->json, "type"));

   /* This subscription only responds to the FullyBooted event so that all modules have been loaded when we
    * recreate SIP subscriptions.
    */
   if (strcmp(type, "FullyBooted")) {
      return;
   }

   /* This has to be here so the subscription is recreated when the body generator is available */
   ast_sip_push_task(NULL, subscription_persistence_load, NULL);

   /* Once the system is fully booted we don't care anymore */
   stasis_unsubscribe(sub);
}

subscription_persistence_load()

static int subscription_persistence_load ( void *  data )

static

Function which loads and recreates persisted subscriptions upon startup when the system is fully booted.

Definition at line 1750 of file res_pjsip_pubsub.c.

References ao2_callback, ao2_ref, ast_log, AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_pjsip_endpoint(), ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), LOG_WARNING, NULL, OBJ_NODATA, pool, and subscription_persistence_recreate().

Referenced by load_module(), and subscription_persistence_event_cb().

{
   struct ao2_container *persisted_subscriptions = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
      "subscription_persistence", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
   pj_pool_t *pool;

   pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "rtd%p", PJSIP_POOL_RDATA_LEN,
      PJSIP_POOL_RDATA_INC);
   if (!pool) {
      ast_log(LOG_WARNING, "Could not create a memory pool for recreating SIP subscriptions\n");
      return 0;
   }

   ao2_callback(persisted_subscriptions, OBJ_NODATA, subscription_persistence_recreate, pool);

   pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);

   ao2_ref(persisted_subscriptions, -1);
   return 0;
}

subscription_persistence_recreate()

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

static

Callback function to perform the actual recreation of a subscription.

Definition at line 1684 of file res_pjsip_pubsub.c.

References ast_debug, ast_log, ast_sip_create_rdata_with_contact(), ast_sip_get_distributor_serializer(), ast_sip_get_sorcery(), ast_sip_push_task_wait_serializer(), ast_sorcery_delete(), ast_taskprocessor_unreference(), ast_tvdiff_ms(), ast_tvnow(), subscription_persistence::contact_uri, subscription_persistence::endpoint, subscription_persistence::expires, subscription_persistence::local_name, subscription_persistence::local_port, LOG_NOTICE, LOG_WARNING, subscription_persistence::packet, persistence_recreate_data::persistence, pool, subscription_persistence::prune_on_boot, persistence_recreate_data::rdata, subscription_persistence::src_name, subscription_persistence::src_port, sub_persistence_recreate(), subscription_persistence::tag, and subscription_persistence::transport_key.

Referenced by subscription_persistence_load().

{
   struct subscription_persistence *persistence = obj;
   pj_pool_t *pool = arg;
   struct ast_taskprocessor *serializer;
   pjsip_rx_data rdata;
   struct persistence_recreate_data recreate_data;

   /* If this subscription used a reliable transport it can't be reestablished so remove it */
   if (persistence->prune_on_boot) {
      ast_debug(3, "Deleting subscription marked as 'prune' from persistent store '%s' %s\n",
         persistence->endpoint, persistence->tag);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   /* If this subscription has already expired remove it */
   if (ast_tvdiff_ms(persistence->expires, ast_tvnow()) <= 0) {
      ast_debug(3, "Expired subscription retrived from persistent store '%s' %s\n",
         persistence->endpoint, persistence->tag);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   memset(&rdata, 0, sizeof(rdata));
   pj_pool_reset(pool);
   rdata.tp_info.pool = pool;

   if (ast_sip_create_rdata_with_contact(&rdata, persistence->packet, persistence->src_name,
      persistence->src_port, persistence->transport_key, persistence->local_name,
      persistence->local_port, persistence->contact_uri)) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: The message could not be parsed\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   if (rdata.msg_info.msg->type != PJSIP_REQUEST_MSG) {
      ast_log(LOG_NOTICE, "Failed recreating '%s' subscription: Stored a SIP response instead of a request.\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }

   /* Continue the remainder in the distributor serializer */
   serializer = ast_sip_get_distributor_serializer(&rdata);
   if (!serializer) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Could not get distributor serializer.\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
      return 0;
   }
   recreate_data.persistence = persistence;
   recreate_data.rdata = &rdata;
   if (ast_sip_push_task_wait_serializer(serializer, sub_persistence_recreate,
      &recreate_data)) {
      ast_log(LOG_WARNING, "Failed recreating '%s' subscription: Could not continue under distributor serializer.\n",
         persistence->endpoint);
      ast_sorcery_delete(ast_sip_get_sorcery(), persistence);
   }
   ast_taskprocessor_unreference(serializer);

   return 0;
}

subscription_persistence_remove()

static void subscription_persistence_remove ( struct sip_subscription_tree *  sub_tree )

static

Function which removes persistence of a subscription from sorcery.

Definition at line 745 of file res_pjsip_pubsub.c.

References ao2_ref, ast_debug, ast_sip_get_sorcery(), AST_SIP_MAX_ACCEPT, ast_sip_transport_monitor_unregister(), ast_sorcery_delete(), ast_sorcery_object_get_id(), ast_sip_pubsub_body_generator::body_type, sip_subscription_tree::endpoint, ast_sip_subscription_handler::event_name, find_body_generator(), find_sub_handler_for_event_name(), NULL, sip_subscription_tree::persistence, subscription_persistence::prune_on_boot, sip_subscription_tree::root, sub_tree_transport_cb(), and sip_subscription_tree::transport.

Referenced by pubsub_on_evsub_state().

{
   if (!sub_tree->persistence) {
      return;
   }

   if (sub_tree->persistence->prune_on_boot && sub_tree->transport) {
      ast_debug(3, "Unregistering transport monitor on %s '%s->%s'\n",
         sub_tree->transport->obj_name,
         sub_tree->endpoint ? ast_sorcery_object_get_id(sub_tree->endpoint) : "Unknown",
         sub_tree->root ? sub_tree->root->resource : "Unknown");
      ast_sip_transport_monitor_unregister(sub_tree->transport,
         sub_tree_transport_cb, sub_tree, NULL);
   }

   ast_sorcery_delete(ast_sip_get_sorcery(), sub_tree->persistence);
   ao2_ref(sub_tree->persistence, -1);
   sub_tree->persistence = NULL;
}

subscription_persistence_update()

static void subscription_persistence_update ( struct sip_subscription_tree *  sub_tree, pjsip_rx_data *  rdata, enum sip_persistence_update_type  type  )

static

Function which updates persistence information of a subscription in sorcery.

Definition at line 662 of file res_pjsip_pubsub.c.

References ast_copy_pj_str(), ast_copy_string(), ast_debug, ast_log, ast_samp2tv(), ast_sip_get_sorcery(), ast_sip_transport_monitor_register(), ast_sip_will_uri_survive_restart(), ast_sorcery_update(), ast_tvadd(), ast_tvnow(), subscription_persistence::contact_uri, subscription_persistence::cseq, DEFAULT_PUBLISH_EXPIRES, sip_subscription_tree::dlg, subscription_persistence::endpoint, sip_subscription_tree::endpoint, subscription_persistence::expires, subscription_persistence::local_name, subscription_persistence::local_port, LOG_WARNING, MIN, NULL, subscription_persistence::packet, sip_subscription_tree::persistence, subscription_persistence::prune_on_boot, sip_subscription_tree::root, subscription_persistence::src_name, subscription_persistence::src_port, sub_tree_transport_cb(), SUBSCRIPTION_PERSISTENCE_CREATED, SUBSCRIPTION_PERSISTENCE_RECREATED, sip_subscription_tree::transport, and subscription_persistence::transport_key.

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

{
   pjsip_dialog *dlg;

   if (!sub_tree->persistence) {
      return;
   }

   ast_debug(3, "Updating persistence for '%s->%s'  prune on boot: %s\n",
      sub_tree->persistence->endpoint, sub_tree->root->resource,
      sub_tree->persistence->prune_on_boot ? "yes" : "no");

   dlg = sub_tree->dlg;
   sub_tree->persistence->cseq = dlg->local.cseq;

   if (rdata) {
      unsigned int expires;
      pjsip_expires_hdr *expires_hdr = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_EXPIRES, NULL);
      pjsip_contact_hdr *contact_hdr = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_CONTACT, NULL);

      expires = expires_hdr ? expires_hdr->ivalue : DEFAULT_PUBLISH_EXPIRES;
      sub_tree->persistence->expires = ast_tvadd(ast_tvnow(), ast_samp2tv(expires, 1));

      if (contact_hdr) {
         if (contact_hdr) {
            if (type == SUBSCRIPTION_PERSISTENCE_CREATED) {
               sub_tree->persistence->prune_on_boot =
                  !ast_sip_will_uri_survive_restart(
                     (pjsip_sip_uri *)pjsip_uri_get_uri(contact_hdr->uri),
                     sub_tree->endpoint, rdata);

               if (sub_tree->persistence->prune_on_boot) {
                  ast_debug(3, "adding transport monitor on %s for '%s->%s'  prune on boot: %d\n",
                     rdata->tp_info.transport->obj_name,
                     sub_tree->persistence->endpoint, sub_tree->root->resource,
                     sub_tree->persistence->prune_on_boot);
                  sub_tree->transport = rdata->tp_info.transport;
                  ast_sip_transport_monitor_register(rdata->tp_info.transport,
                     sub_tree_transport_cb, sub_tree);
                  /*
                   * FYI: ast_sip_transport_monitor_register holds a reference to the sub_tree
                   */
               }
            }
         }

         pjsip_uri_print(PJSIP_URI_IN_CONTACT_HDR, contact_hdr->uri,
               sub_tree->persistence->contact_uri, sizeof(sub_tree->persistence->contact_uri));
      } else {
         ast_log(LOG_WARNING, "Contact not updated due to missing contact header\n");
      }

      /* When receiving a packet on an streaming transport, it's possible to receive more than one SIP
       * message at a time into the rdata->pkt_info.packet buffer. However, the rdata->msg_info.msg_buf
       * will always point to the proper SIP message that is to be processed. When updating subscription
       * persistence that is pulled from persistent storage, though, the rdata->pkt_info.packet will
       * only ever have a single SIP message on it, and so we base persistence on that.
       */
      if (type == SUBSCRIPTION_PERSISTENCE_CREATED
         || type == SUBSCRIPTION_PERSISTENCE_RECREATED) {
         if (rdata->msg_info.msg_buf) {
            ast_copy_string(sub_tree->persistence->packet, rdata->msg_info.msg_buf,
                  MIN(sizeof(sub_tree->persistence->packet), rdata->msg_info.len + 1));
         } else {
            ast_copy_string(sub_tree->persistence->packet, rdata->pkt_info.packet,
                  sizeof(sub_tree->persistence->packet));
         }
      }
      ast_copy_string(sub_tree->persistence->src_name, rdata->pkt_info.src_name,
            sizeof(sub_tree->persistence->src_name));
      sub_tree->persistence->src_port = rdata->pkt_info.src_port;
      ast_copy_string(sub_tree->persistence->transport_key, rdata->tp_info.transport->type_name,
         sizeof(sub_tree->persistence->transport_key));
      ast_copy_pj_str(sub_tree->persistence->local_name, &rdata->tp_info.transport->local_name.host,
         sizeof(sub_tree->persistence->local_name));
      sub_tree->persistence->local_port = rdata->tp_info.transport->local_name.port;
   }

   ast_sorcery_update(ast_sip_get_sorcery(), sub_tree->persistence);
}

subscription_setup_dialog()

static void subscription_setup_dialog ( struct sip_subscription_tree *  sub_tree, pjsip_dialog *  dlg  )

static

Definition at line 1396 of file res_pjsip_pubsub.c.

References ast_sip_dialog_set_endpoint(), ast_sip_dialog_set_serializer(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, sip_subscription_tree::evsub, pubsub_module, and sip_subscription_tree::serializer.

Referenced by ast_sip_create_subscription(), and create_subscription_tree().

{
   sub_tree->dlg = dlg;
   ast_sip_dialog_set_serializer(dlg, sub_tree->serializer);
   ast_sip_dialog_set_endpoint(dlg, sub_tree->endpoint);
   pjsip_evsub_set_mod_data(sub_tree->evsub, pubsub_module.id, sub_tree);
   pjsip_dlg_inc_session(dlg, &pubsub_module);
}

subscription_tree_destructor()

static void subscription_tree_destructor ( void *  obj )

static

Definition at line 1367 of file res_pjsip_pubsub.c.

References ao2_cleanup, ast_debug, ast_module_unref, ast_sip_push_task_wait_servant(), ast_sorcery_object_get_id(), ast_taskprocessor_unreference(), destroy_subscriptions(), sip_subscription_tree::dlg, sip_subscription_tree::endpoint, sip_subscription_tree::root, ast_module_info::self, sip_subscription_tree::serializer, and subscription_unreference_dialog().

Referenced by allocate_subscription_tree().

{
   struct sip_subscription_tree *sub_tree = obj;

   ast_debug(3, "Destroying subscription tree %p '%s->%s'\n",
      sub_tree,
      sub_tree->endpoint ? ast_sorcery_object_get_id(sub_tree->endpoint) : "Unknown",
      sub_tree->root ? sub_tree->root->resource : "Unknown");

   destroy_subscriptions(sub_tree->root);

   if (sub_tree->dlg) {
      ast_sip_push_task_wait_servant(sub_tree->serializer,
         subscription_unreference_dialog, sub_tree);
   }

   ao2_cleanup(sub_tree->endpoint);

   ast_taskprocessor_unreference(sub_tree->serializer);
   ast_module_unref(ast_module_info->self);
}

subscription_unreference_dialog()

static int subscription_unreference_dialog ( void *  obj )

static

Definition at line 1348 of file res_pjsip_pubsub.c.

References sip_subscription_tree::dlg, NULL, and pubsub_module.

Referenced by subscription_tree_destructor().

{
   struct sip_subscription_tree *sub_tree = obj;

   /* This is why we keep the dialog on the subscription. When the subscription
    * is destroyed, there is no guarantee that the underlying dialog is ready
    * to be destroyed. Furthermore, there's no guarantee in the opposite direction
    * either. The dialog could be destroyed before our subscription is. We fix
    * this problem by keeping a reference to the dialog until it is time to
    * destroy the subscription. We need to have the dialog available when the
    * subscription is destroyed so that we can guarantee that our attempt to
    * remove the serializer will be successful.
    */
   pjsip_dlg_dec_session(sub_tree->dlg, &pubsub_module);
   sub_tree->dlg = NULL;

   return 0;
}

test_new_subscribe()

static int test_new_subscribe ( struct ast_sip_endpoint *  endpoint, const char *  resource  )

static

new_subscribe callback for unit tests

Will give a 200 OK response to any resource except the "bad" ones.

Definition at line 4901 of file res_pjsip_pubsub.c.

References ARRAY_LEN, and bad_resources.

{
   int i;

   for (i = 0; i < ARRAY_LEN(bad_resources); ++i) {
      if (!strcmp(resource, bad_resources[i])) {
         return 400;
      }
   }

   return 200;
}

test_resource_tree_destroy()

static void test_resource_tree_destroy ( struct resource_tree *  tree )

static

RAII_VAR callback to destroy an allocated resource tree.

Definition at line 5047 of file res_pjsip_pubsub.c.

References ast_free, and resource_tree_destroy().

Referenced by AST_TEST_DEFINE().

{
   resource_tree_destroy(tree);
   ast_free(tree);
}

tree_node_alloc()

static struct tree_node* tree_node_alloc ( const char *  resource, struct resources *  visited, unsigned int  full_state  )

static

Allocate a tree node.

In addition to allocating and initializing the tree node, the node is also added to the vector of visited resources. See build_resource_tree for more information on the visited resources.

Parameters

resource	The name of the resource for this tree node.
visited	The vector of resources that have been visited.
if	allocating a list, indicate whether full state is requested in notifications.

Return values

NULL	Allocation failure.
non-NULL	The newly-allocated tree_node

Definition at line 934 of file res_pjsip_pubsub.c.

References ast_calloc, ast_free, AST_VECTOR_APPEND, AST_VECTOR_INIT, resource_list::full_state, and NULL.

Referenced by build_node_children(), and build_resource_tree().

{
   struct tree_node *node;

   node = ast_calloc(1, sizeof(*node) + strlen(resource) + 1);
   if (!node) {
      return NULL;
   }

   strcpy(node->resource, resource);
   if (AST_VECTOR_INIT(&node->children, 4)) {
      ast_free(node);
      return NULL;
   }
   node->full_state = full_state;

   if (visited) {
      AST_VECTOR_APPEND(visited, resource);
   }
   return node;
}

tree_node_destroy()

static void tree_node_destroy ( struct tree_node *  node )

static

Destructor for a tree node.

This function calls recursively in order to destroy all nodes lower in the tree from the given node in addition to the node itself.

Parameters

node	The node to destroy.

Definition at line 965 of file res_pjsip_pubsub.c.

References ast_free, AST_VECTOR_FREE, AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by build_node_children(), and resource_tree_destroy().

{
   int i;
   if (!node) {
      return;
   }

   for (i = 0; i < AST_VECTOR_SIZE(&node->children); ++i) {
      tree_node_destroy(AST_VECTOR_GET(&node->children, i));
   }
   AST_VECTOR_FREE(&node->children);
   ast_free(node);
}

unload_module()

static int unload_module ( void  )

static

Definition at line 5682 of file res_pjsip_pubsub.c.

References AMI_SHOW_SUBSCRIPTIONS_INBOUND, AMI_SHOW_SUBSCRIPTIONS_OUTBOUND, ARRAY_LEN, ast_cli_unregister_multiple(), ast_manager_unregister(), AST_MODFLAG_GLOBAL_SYMBOLS, AST_MODFLAG_LOAD_ORDER, AST_MODPRI_CHANNEL_DEPEND, AST_MODULE_INFO(), AST_MODULE_SUPPORT_CORE, ast_sched_context_destroy(), ast_sip_transport_monitor_unregister_all(), ast_sip_unregister_service(), AST_TEST_UNREGISTER, ASTERISK_GPL_KEY, load_module(), NULL, pubsub_module, and sub_tree_transport_cb().

{
   AST_TEST_UNREGISTER(resource_tree);
   AST_TEST_UNREGISTER(complex_resource_tree);
   AST_TEST_UNREGISTER(bad_resource);
   AST_TEST_UNREGISTER(bad_branch);
   AST_TEST_UNREGISTER(duplicate_resource);
   AST_TEST_UNREGISTER(loop);
   AST_TEST_UNREGISTER(bad_event);

   ast_sip_transport_monitor_unregister_all(sub_tree_transport_cb, NULL, NULL);

   ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));

   ast_manager_unregister(AMI_SHOW_SUBSCRIPTIONS_OUTBOUND);
   ast_manager_unregister(AMI_SHOW_SUBSCRIPTIONS_INBOUND);
   ast_manager_unregister("PJSIPShowResourceLists");

   ast_sip_unregister_service(&pubsub_module);
   if (sched) {
      ast_sched_context_destroy(sched);
   }

   return 0;
}

Variable Documentation

__mod_info

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 = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_pjsip", }

static

Definition at line 5714 of file res_pjsip_pubsub.c.

accept_exceptions

const char* accept_exceptions[]

Initial value:

=  {
   "multipart/related",
   "application/rlmi+xml",
}

Accept headers that are exceptions to the rule.

Typically, when a SUBSCRIBE arrives, we attempt to find a body generator that matches one of the Accept headers in the request. When subscribing to a single resource, this works great. However, when subscribing to a list, things work differently. Most Accept header values are fine, but there are a couple that are endemic to resource lists that need to be ignored when searching for a body generator to use for the individual resources of the subscription.

Definition at line 806 of file res_pjsip_pubsub.c.

Referenced by exceptional_accept().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 5714 of file res_pjsip_pubsub.c.

bad_resources

const char* bad_resources[]

"bad" resources

These are resources that the test handler will reject subscriptions to.

Definition at line 4889 of file res_pjsip_pubsub.c.

Referenced by test_new_subscribe().

body_generators

struct body_generators body_generators = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

body_supplements

struct body_supplements body_supplements = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

cli_commands

struct ast_cli_entry cli_commands[]

static

Initial value:

= {
   { .handler =  cli_list_subscriptions_inout , .summary =  "List active inbound/outbound subscriptions" ,},
   { .handler =  cli_show_subscription_inout , .summary =  "Show active subscription details" ,},
   { .handler =  cli_show_subscriptions_inout , .summary =  "Show active inbound/outbound subscriptions" ,},
}

Definition at line 4667 of file res_pjsip_pubsub.c.

esc_etag_counter

int esc_etag_counter

static

Used to create new entity IDs by ESCs.

Definition at line 340 of file res_pjsip_pubsub.c.

Referenced by pubsub_on_rx_publish_request(), and sip_create_publication().

pjsip_publish_method

const pjsip_method pjsip_publish_method

Initial value:

=
{
   PJSIP_OTHER_METHOD,
   { "PUBLISH", 7 }
}

Defined method for PUBLISH.

Definition at line 256 of file res_pjsip_pubsub.c.

Referenced by pubsub_on_rx_request().

publish_handlers

struct publish_handlers publish_handlers = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

pubsub_cb

pjsip_evsub_user pubsub_cb

static

Definition at line 549 of file res_pjsip_pubsub.c.

Referenced by ast_sip_create_subscription(), and create_subscription_tree().

pubsub_module

struct pjsip_module pubsub_module

static

Initial value:

= {
   .name = { "PubSub Module", 13 },
   .priority = PJSIP_MOD_PRIORITY_APPLICATION,
   .on_rx_request = pubsub_on_rx_request,
}

Definition at line 229 of file res_pjsip_pubsub.c.

Referenced by ast_sip_pubsub_register_body_generator(), ast_sip_register_subscription_handler(), ast_sip_subscription_get_header(), create_subscription_tree(), load_module(), pubsub_on_client_refresh(), pubsub_on_evsub_state(), pubsub_on_rx_notify(), pubsub_on_rx_refresh(), pubsub_on_server_timeout(), sip_publication_respond(), sip_subscription_accept(), sub_persistence_recreate(), subscription_setup_dialog(), subscription_unreference_dialog(), and unload_module().

rlmi_media_type

pjsip_media_type rlmi_media_type

static

Definition at line 539 of file res_pjsip_pubsub.c.

Referenced by build_rlmi_body(), and load_module().

sched

struct ast_sched_context* sched

static

Scheduler used for automatically expiring publications.

Definition at line 241 of file res_pjsip_pubsub.c.

sip_subscription_roles_map

const char* sip_subscription_roles_map[]

static

Initial value:

= {
   [AST_SIP_SUBSCRIBER] = "Subscriber",
   [AST_SIP_NOTIFIER] = "Notifier"
}

Definition at line 518 of file res_pjsip_pubsub.c.

Referenced by sip_subscription_to_ami().

str_event_name

const pj_str_t str_event_name = { "Event", 5 }

static

Definition at line 238 of file res_pjsip_pubsub.c.

Referenced by pubsub_on_rx_publish_request(), and subscription_get_handler_from_rdata().

sub_tree_state_description

char* sub_tree_state_description[]

static

Definition at line 415 of file res_pjsip_pubsub.c.

Referenced by pubsub_on_evsub_state(), pubsub_on_refresh_timeout(), pubsub_on_rx_refresh(), and serialized_pubsub_on_refresh_timeout().

subscription_handlers

struct subscription_handlers subscription_handlers = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

subscriptions

struct subscriptions subscriptions = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

test_handler

struct ast_sip_subscription_handler test_handler

Initial value:

= {
   .event_name = "test",
   .notifier = &test_notifier,
}

Subscription handler for unit tests.

Definition at line 4927 of file res_pjsip_pubsub.c.

test_notifier

struct ast_sip_notifier test_notifier

Initial value:

= {
   .new_subscribe = test_new_subscribe,
}

Subscription notifier for unit tests.

Since unit tests are only concerned with building a resource tree, only the new_subscribe callback needs to be defined.

Definition at line 4920 of file res_pjsip_pubsub.c.