location.c File Reference

#include "asterisk.h"
#include <pjsip.h>
#include <pjlib.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/logger.h"
#include "asterisk/astobj2.h"
#include "asterisk/paths.h"
#include "asterisk/sorcery.h"
#include "asterisk/taskprocessor.h"
#include "include/res_pjsip_private.h"
#include "asterisk/res_pjsip_cli.h"
#include "asterisk/statsd.h"
#include "asterisk/named_locks.h"
#include "asterisk/res_pjproject.h"

Include dependency graph for location.c:

Go to the source code of this file.

Functions
static int	ami_show_aors (struct mansession *s, const struct message *m)
static void *	aor_alloc (const char *name)
	Allocator for AOR. More...
static int	aor_apply_handler (const struct ast_sorcery *sorcery, void *object)
static int	aor_apply_outbound_proxy (void *obj, void *arg, int flags)
static void	aor_deleted_observer (const void *object)
static void	aor_destroy (void *obj)
	Destructor for AOR. More...
int	ast_sip_contact_to_str (void *object, void *arg, int flags)
	Handler used to convert a contact to a string. More...
int	ast_sip_destroy_sorcery_location (void)
int	ast_sip_for_each_aor (const char *aors, ao2_callback_fn on_aor, void *arg)
	For every aor in the comma separated aors string call the given 'on_aor' handler. More...
int	ast_sip_for_each_contact (const struct ast_sip_aor *aor, ao2_callback_fn on_contact, void *arg)
	For every contact on an AOR call the given 'on_contact' handler. More...
int	ast_sip_initialize_sorcery_location (void)
	Initialize sorcery with location support. More...
int	ast_sip_location_add_contact (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, struct ast_sip_endpoint *endpoint)
	Add a new contact to an AOR. More...
int	ast_sip_location_add_contact_nolock (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, struct ast_sip_endpoint *endpoint)
	Add a new contact to an AOR without locking the AOR. More...
struct ast_sip_contact *	ast_sip_location_create_contact (struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info, const char *user_agent, const char *via_addr, int via_port, const char *call_id, int prune_on_boot, struct ast_sip_endpoint *endpoint)
	Create a new contact for an AOR without locking the AOR. More...
int	ast_sip_location_delete_contact (struct ast_sip_contact *contact)
	Delete a contact. More...
void	ast_sip_location_prune_boot_contacts (void)
	Prune the prune_on_boot contacts. More...
struct ast_sip_aor *	ast_sip_location_retrieve_aor (const char *aor_name)
	Retrieve a named AOR. More...
struct ao2_container *	ast_sip_location_retrieve_aor_contacts (const struct ast_sip_aor *aor)
	Retrieve all contacts currently available for an AOR. More...
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve all contacts currently available for an AOR and filter based on flags. More...
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_nolock (const struct ast_sip_aor *aor)
	Retrieve all contacts currently available for an AOR without locking the AOR. More...
struct ao2_container *	ast_sip_location_retrieve_aor_contacts_nolock_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags. More...
struct ast_sip_contact *	ast_sip_location_retrieve_contact (const char *contact_name)
	Retrieve a named contact. More...
void	ast_sip_location_retrieve_contact_and_aor_from_list (const char *aor_list, struct ast_sip_aor **aor, struct ast_sip_contact **contact)
	Retrieve the first bound contact AND the AOR chosen from a list of AORs. More...
void	ast_sip_location_retrieve_contact_and_aor_from_list_filtered (const char *aor_list, unsigned int flags, struct ast_sip_aor **aor, struct ast_sip_contact **contact)
	Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags. More...
struct ast_sip_contact *	ast_sip_location_retrieve_contact_from_aor_list (const char *aor_list)
	Retrieve the first bound contact from a list of AORs. More...
struct ao2_container *	ast_sip_location_retrieve_contacts_from_aor_list (const char *aor_list)
	Retrieve all contacts from a list of AORs. More...
struct ast_sip_contact *	ast_sip_location_retrieve_first_aor_contact (const struct ast_sip_aor *aor)
	Retrieve the first bound contact for an AOR. More...
struct ast_sip_contact *	ast_sip_location_retrieve_first_aor_contact_filtered (const struct ast_sip_aor *aor, unsigned int flags)
	Retrieve the first bound contact for an AOR and filter based on flags. More...
int	ast_sip_location_update_contact (struct ast_sip_contact *contact)
	Update a contact. More...
int	ast_sip_validate_uri_length (const char *contact_uri)
static int	cli_aor_gather_contacts (void *obj, void *arg, int flags)
static struct ao2_container *	cli_aor_get_container (const char *regex)
static const char *	cli_aor_get_id (const void *obj)
static int	cli_aor_iterate (void *container, ao2_callback_fn callback, void *args)
static int	cli_aor_print_body (void *obj, void *arg, int flags)
static int	cli_aor_print_header (void *obj, void *arg, int flags)
static void *	cli_aor_retrieve_by_id (const char *id)
static int	cli_contact_compare (void *obj, void *arg, int flags)
static struct ao2_container *	cli_contact_get_container (const char *regex)
static const char *	cli_contact_get_id (const void *obj)
static int	cli_contact_iterate (void *container, ao2_callback_fn callback, void *args)
static int	cli_contact_populate_container (void *obj, void *arg, int flags)
static int	cli_contact_print_body (void *obj, void *arg, int flags)
static int	cli_contact_print_header (void *obj, void *arg, int flags)
static void *	cli_contact_retrieve_by_id (const char *id)
static int	cli_contact_sort (const void *obj, const void *arg, int flags)
static int	cli_filter_contacts (void *obj, void *arg, int flags)
static int	cli_gather_contact (void *obj, void *arg, int flags)
static struct ao2_container *	cli_get_aors (void)
static void *	contact_alloc (const char *name)
	Allocator for contact. More...
static int	contact_apply_handler (const struct ast_sorcery *sorcery, void *object)
	Always create a contact_status for each contact. More...
static void	contact_destroy (void *obj)
	Destructor for contact. More...
static int	contact_expire (void *obj, void *arg, int flags)
	Internal callback function which deletes and unlinks any expired contacts. More...
static int	contact_link_static (void *obj, void *arg, int flags)
	Internal callback function which links static contacts into another container. More...
static int	contact_remove_unreachable (void *obj, void *arg, int flags)
	Internal callback function which removes any contact which is unreachable. More...
static int	contact_to_var_list (void *object, void *arg, int flags)
static void	contact_wrapper_destroy (void *obj)
static int	contacts_to_str (const void *obj, const intptr_t *args, char **buf)
static int	contacts_to_var_list (const void *obj, struct ast_variable **fields)
static int	destroy_contact (void *obj, void *arg, int flags)
	Internal callback function which destroys the specified contact. More...
static int	expiration_str2struct (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Custom handler for translating from a string timeval to actual structure. More...
static int	expiration_struct2str (const void *obj, const intptr_t *args, char **buf)
	Custom handler for translating from an actual structure timeval to string. More...
static int	format_ami_aor_handler (void *obj, void *arg, int flags)
static int	format_ami_aorlist_handler (void *obj, void *arg, int flags)
static int	format_ami_endpoint_aor (const struct ast_sip_endpoint *endpoint, struct ast_sip_ami *ami)
static int	gather_contacts_for_aor (void *obj, void *arg, int flags)
static int	permanent_uri_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Custom handler for permanent URIs. More...
static int	permanent_uri_sort_fn (const void *obj_left, const void *obj_right, int flags)
static int	prune_boot_contacts_cb (void *obj, void *arg, int flags)
static int	sip_aor_to_ami (const struct ast_sip_aor *aor, struct ast_str **buf)
static int	voicemail_extension_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
static int	voicemail_extension_to_str (const void *obj, const intptr_t *args, char **buf)

Variables
struct ast_sip_cli_formatter_entry *	aor_formatter
static const struct ast_sorcery_observer	aor_observer
	Observer for contacts so state can be updated on respective endpoints. More...
static struct ast_cli_entry	cli_commands []
struct ast_sip_cli_formatter_entry *	contact_formatter
struct ast_sip_endpoint_formatter	endpoint_aor_formatter
static int	pj_max_hostname = PJ_MAX_HOSTNAME
static int	pjsip_max_url_size = PJSIP_MAX_URL_SIZE

Function Documentation

ami_show_aors()

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

static

Definition at line 1260 of file location.c.

References ao2_callback, ao2_container_count(), ao2_ref, astman_get_header(), astman_send_error(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), cli_get_aors(), ast_sip_ami::count, format_ami_aorlist_handler(), ast_sip_ami::m, OBJ_NODATA, and ast_sip_ami::s.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
   struct ao2_container *aors;

   aors = cli_get_aors();
   if (!aors) {
      astman_send_error(s, m, "Could not get AORs\n");
      return 0;
   }

   if (!ao2_container_count(aors)) {
      astman_send_error(s, m, "No AORs found\n");
      ao2_ref(aors, -1);
      return 0;
   }

   astman_send_listack(s, m, "A listing of AORs follows, presented as AorList events",
         "start");

   ao2_callback(aors, OBJ_NODATA, format_ami_aorlist_handler, &ami);

   astman_send_list_complete_start(s, m, "AorListComplete", ami.count);
   astman_send_list_complete_end(s);

   ao2_ref(aors, -1);

   return 0;
}

aor_alloc()

static void* aor_alloc ( const char *  name )

static

Allocator for AOR.

Definition at line 50 of file location.c.

References ao2_ref, aor_destroy(), ast_named_lock_get, AST_NAMED_LOCK_TYPE_MUTEX, ast_sorcery_lockable_alloc(), ast_string_field_init, lock, and NULL.

Referenced by ast_sip_initialize_sorcery_location().

{
   void *lock;
   struct ast_sip_aor *aor;

   lock = ast_named_lock_get(AST_NAMED_LOCK_TYPE_MUTEX, "aor", name);
   if (!lock) {
      return NULL;
   }

   aor = ast_sorcery_lockable_alloc(sizeof(struct ast_sip_aor), aor_destroy, lock);
   ao2_ref(lock, -1);

   if (!aor) {
      return NULL;
   }
   ast_string_field_init(aor, 128);

   return aor;
}

aor_apply_handler()

static int aor_apply_handler ( const struct ast_sorcery *  sorcery, void *  object  )

static

Definition at line 1352 of file location.c.

References ao2_callback, aor_apply_outbound_proxy(), ast_strlen_zero, OBJ_MULTIPLE, OBJ_NODATA, ast_sip_aor::outbound_proxy, and ast_sip_aor::permanent_contacts.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_aor *aor = object;

   if (!aor->permanent_contacts || ast_strlen_zero(aor->outbound_proxy)) {
      return 0;
   }

   ao2_callback(aor->permanent_contacts, OBJ_NODATA | OBJ_MULTIPLE, aor_apply_outbound_proxy, aor);

   return 0;
}

aor_apply_outbound_proxy()

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

static

Definition at line 1342 of file location.c.

References ast_string_field_set, and ast_sip_aor::outbound_proxy.

Referenced by aor_apply_handler().

{
   struct ast_sip_contact *contact = obj;
   struct ast_sip_aor *aor = arg;

   ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);

   return 0;
}

aor_deleted_observer()

static void aor_deleted_observer ( const void *  object )

static

Definition at line 81 of file location.c.

References ao2_callback, ao2_ref, ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_prefix(), destroy_contact(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, ast_sip_aor::permanent_contacts, and prefix.

{
   const struct ast_sip_aor *aor = object;
   const char *aor_id = ast_sorcery_object_get_id(object);
   /* Give enough space for ;@ at the end, since that is our object naming scheme */
   size_t prefix_len = strlen(aor_id) + sizeof(";@") - 1;
   char prefix[prefix_len + 1];
   struct ao2_container *contacts;

   if (aor->permanent_contacts) {
      ao2_callback(aor->permanent_contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, destroy_contact, NULL);
   }

   sprintf(prefix, "%s;@", aor_id); /* Safe */
   if (!(contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact", prefix, prefix_len))) {
      return;
   }
   /* Destroy any contacts that may still exist that were made for this AoR */
   ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, destroy_contact, NULL);

   ao2_ref(contacts, -1);
}

aor_destroy()

static void aor_destroy ( void *  obj )

static

Destructor for AOR.

Definition at line 40 of file location.c.

References ao2_cleanup, ast_free, ast_string_field_free_memory, ast_sip_aor::permanent_contacts, and ast_sip_aor::voicemail_extension.

Referenced by aor_alloc().

{
   struct ast_sip_aor *aor = obj;

   ao2_cleanup(aor->permanent_contacts);
   ast_string_field_free_memory(aor);
   ast_free(aor->voicemail_extension);
}

ast_sip_contact_to_str()

int ast_sip_contact_to_str	(	void *	object,
		void *	arg,
		int	flags
	)

Handler used to convert a contact to a string.

Parameters

object	the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
arg	user data passed to handler
flags

Return values

0	Success, non-zero on failure

Definition at line 767 of file location.c.

References ast_str_append(), buf, and ast_sip_contact_wrapper::contact_id.

Referenced by contacts_to_str(), sip_contact_to_str(), and sip_endpoints_aors_ami().

{
   struct ast_sip_contact_wrapper *wrapper = object;
   struct ast_str **buf = arg;

   ast_str_append(buf, 0, "%s,", wrapper->contact_id);

   return 0;
}

ast_sip_destroy_sorcery_location()

int ast_sip_destroy_sorcery_location

(

void

)

Definition at line 1467 of file location.c.

References ARRAY_LEN, ast_cli_unregister_multiple(), ast_manager_unregister(), ast_sip_get_sorcery(), ast_sip_unregister_cli_formatter(), ast_sip_unregister_endpoint_formatter(), and ast_sorcery_observer_remove().

Referenced by ast_res_pjsip_destroy_configuration().

{
   ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor", &aor_observer);
   ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
   ast_sip_unregister_cli_formatter(contact_formatter);
   ast_sip_unregister_cli_formatter(aor_formatter);
   ast_manager_unregister("PJSIPShowAors");

   ast_sip_unregister_endpoint_formatter(&endpoint_aor_formatter);

   return 0;
}

ast_sip_for_each_aor()

int ast_sip_for_each_aor	(	const char *	aors,
		ao2_callback_fn	on_aor,
		void *	arg
	)

For every aor in the comma separated aors string call the given 'on_aor' handler.

Parameters

aors	a comma separated list of aors
on_aor	callback for each aor
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 684 of file location.c.

References ao2_ref, ast_sip_location_retrieve_aor(), ast_strdupa, ast_strip(), ast_strlen_zero, copy(), name, and strsep().

Referenced by ami_registrations_endpoint(), ast_sip_location_retrieve_contacts_from_aor_list(), cli_aor_iterate(), format_ami_contact_status(), format_ami_endpoint_aor(), format_ami_endpoints(), mwi_new_subscribe(), and mwi_subscribe_all().

{
   char *copy;
   char *name;
   int res;

   if (!on_aor || ast_strlen_zero(aors)) {
      return 0;
   }

   copy = ast_strdupa(aors);
   while ((name = ast_strip(strsep(&copy, ",")))) {
      struct ast_sip_aor *aor;

      aor = ast_sip_location_retrieve_aor(name);
      if (aor) {
         res = on_aor(aor, arg, 0);
         ao2_ref(aor, -1);
         if (res) {
            return -1;
         }
      }
   }
   return 0;
}

ast_sip_for_each_contact()

int ast_sip_for_each_contact	(	const struct ast_sip_aor *	aor,
		ao2_callback_fn	on_contact,
		void *	arg
	)

For every contact on an AOR call the given 'on_contact' handler.

Parameters

aor	the aor containing a list of contacts to iterate
on_contact	callback on each contact on an AOR. The object received by the callback will be a ast_sip_contact_wrapper structure.
arg	user data passed to handler

Return values

0	Success, non-zero on failure

Definition at line 719 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_bump, ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_malloc, ast_sip_location_retrieve_aor_contacts(), ast_sorcery_object_get_id(), ast_strdup, contact_wrapper_destroy(), NULL, and RAII_VAR.

Referenced by ami_registrations_aor(), cli_aor_gather_contacts(), cli_contact_iterate(), contacts_to_str(), contacts_to_var_list(), format_contact_status_for_aor(), and sip_endpoints_aors_ami().

{
   struct ao2_container *contacts;
   struct ao2_iterator i;
   int res = 0;
   void *object = NULL;

   if (!on_contact ||
       !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
      return 0;
   }

   i = ao2_iterator_init(contacts, 0);
   while ((object = ao2_iterator_next(&i))) {
      RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
      RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
      const char *aor_id = ast_sorcery_object_get_id(aor);

      wrapper = ao2_alloc_options(sizeof(struct ast_sip_contact_wrapper),
         contact_wrapper_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
      if (!wrapper) {
         res = -1;
         break;
      }
      wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
      if (!wrapper->contact_id) {
         res = -1;
         break;
      }
      sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
      wrapper->aor_id = ast_strdup(aor_id);
      if (!wrapper->aor_id) {
         res = -1;
         break;
      }
      wrapper->contact = contact;
      ao2_bump(wrapper->contact);

      if ((res = on_contact(wrapper, arg, 0))) {
         break;
      }
   }
   ao2_iterator_destroy(&i);
   ao2_ref(contacts, -1);
   return res;
}

ast_sip_initialize_sorcery_location()

int ast_sip_initialize_sorcery_location

(

void

)

Initialize sorcery with location support.

Definition at line 1366 of file location.c.

References ami_show_aors(), ao2_alloc, aor_alloc(), aor_apply_handler(), ARRAY_LEN, ast_cli_register_multiple, ast_log, ast_manager_register_xml, ast_pjproject_get_buildopt(), ast_sip_get_contact_status_label(), ast_sip_get_sorcery(), ast_sip_register_cli_formatter(), ast_sip_register_endpoint_formatter(), ast_sorcery_apply_default, ast_sorcery_object_field_register, ast_sorcery_object_field_register_custom, ast_sorcery_object_register, ast_sorcery_object_set_congestion_levels(), ast_sorcery_observer_add(), AST_STATSD_GAUGE, ast_statsd_log_full_va(), AST_TASKPROCESSOR_HIGH_WATER_LEVEL, cli_aor_get_container(), cli_aor_get_id(), cli_aor_iterate(), cli_aor_print_body(), cli_aor_print_header(), cli_aor_retrieve_by_id(), cli_contact_get_container(), cli_contact_get_id(), cli_contact_iterate(), cli_contact_print_body(), cli_contact_print_header(), cli_contact_retrieve_by_id(), contact_alloc(), contact_apply_handler(), contacts_to_str(), contacts_to_var_list(), default_expiration, EVENT_FLAG_SYSTEM, expiration_str2struct(), expiration_struct2str(), FLDSET, ast_sip_cli_formatter_entry::get_container, ast_sip_cli_formatter_entry::get_id, ast_sip_cli_formatter_entry::iterate, LOG_ERROR, mailboxes, ast_sip_cli_formatter_entry::name, NULL, OPT_BOOL_T, OPT_DOUBLE_T, OPT_NOOP_T, OPT_STRINGFIELD_T, OPT_UINT_T, OPT_YESNO_T, PARSE_IN_RANGE, permanent_uri_handler(), pj_max_hostname, pjsip_max_url_size, ast_sip_cli_formatter_entry::print_body, ast_sip_cli_formatter_entry::print_header, REMOVED, ast_sip_cli_formatter_entry::retrieve_by_id, sorcery, STRFLDSET, voicemail_extension_handler(), and voicemail_extension_to_str().

Referenced by ast_res_pjsip_initialize_configuration().

{
   struct ast_sorcery *sorcery = ast_sip_get_sorcery();
   int i;

   ast_pjproject_get_buildopt("PJ_MAX_HOSTNAME", "%d", &pj_max_hostname);
   /* As of pjproject 2.4.5, PJSIP_MAX_URL_SIZE isn't exposed yet but we try anyway. */
   ast_pjproject_get_buildopt("PJSIP_MAX_URL_SIZE", "%d", &pjsip_max_url_size);

   ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
   ast_sorcery_object_set_congestion_levels(sorcery, "contact", -1,
      3 * AST_TASKPROCESSOR_HIGH_WATER_LEVEL);
   ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");

   if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, contact_apply_handler) ||
      ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, aor_apply_handler)) {
      return -1;
   }

   ast_sorcery_observer_add(sorcery, "aor", &aor_observer);

   ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
   ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
   ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
   ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, NULL, 0, 0);
   ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
      PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
   ast_sorcery_object_field_register(sorcery, "contact", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_contact, qualify_timeout));
   ast_sorcery_object_field_register(sorcery, "contact", "authenticate_qualify", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, authenticate_qualify));
   ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
   ast_sorcery_object_field_register(sorcery, "contact", "user_agent", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, user_agent));
   ast_sorcery_object_field_register(sorcery, "contact", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, endpoint_name));
   ast_sorcery_object_field_register(sorcery, "contact", "reg_server", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, reg_server));
   ast_sorcery_object_field_register(sorcery, "contact", "via_addr", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, via_addr));
   ast_sorcery_object_field_register(sorcery, "contact", "via_port", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_contact, via_port));
   ast_sorcery_object_field_register(sorcery, "contact", "call_id", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, call_id));
   ast_sorcery_object_field_register(sorcery, "contact", "prune_on_boot", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, prune_on_boot));

   ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
   ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
   ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
   ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
   ast_sorcery_object_field_register(sorcery, "aor", "qualify_frequency", 0, OPT_UINT_T, PARSE_IN_RANGE, FLDSET(struct ast_sip_aor, qualify_frequency), 0, 86400);
   ast_sorcery_object_field_register(sorcery, "aor", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_aor, qualify_timeout));
   ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
   ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
   ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
   ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, contacts_to_str, contacts_to_var_list, 0, 0);
   ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
   ast_sorcery_object_field_register_custom(sorcery, "aor", "voicemail_extension", "", voicemail_extension_handler, voicemail_extension_to_str, NULL, 0, 0);
   ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
   ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));

   ast_sip_register_endpoint_formatter(&endpoint_aor_formatter);

   contact_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
   if (!contact_formatter) {
      ast_log(LOG_ERROR, "Unable to allocate memory for contact_formatter\n");
      return -1;
   }
   contact_formatter->name = "contact";
   contact_formatter->print_header = cli_contact_print_header;
   contact_formatter->print_body = cli_contact_print_body;
   contact_formatter->get_container = cli_contact_get_container;
   contact_formatter->iterate = cli_contact_iterate;
   contact_formatter->get_id = cli_contact_get_id;
   contact_formatter->retrieve_by_id = cli_contact_retrieve_by_id;

   aor_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
   if (!aor_formatter) {
      ast_log(LOG_ERROR, "Unable to allocate memory for aor_formatter\n");
      return -1;
   }
   aor_formatter->name = "aor";
   aor_formatter->print_header = cli_aor_print_header;
   aor_formatter->print_body = cli_aor_print_body;
   aor_formatter->get_container = cli_aor_get_container;
   aor_formatter->iterate = cli_aor_iterate;
   aor_formatter->get_id = cli_aor_get_id;
   aor_formatter->retrieve_by_id = cli_aor_retrieve_by_id;

   ast_sip_register_cli_formatter(contact_formatter);
   ast_sip_register_cli_formatter(aor_formatter);
   ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));

   if (ast_manager_register_xml("PJSIPShowAors", EVENT_FLAG_SYSTEM, ami_show_aors)) {
      return -1;
   }

   /*
    * Reset StatsD gauges in case we didn't shut down cleanly.
    * Note that this must done here, as contacts will create the contact_status
    * object before PJSIP options handling is initialized.
    */
   for (i = 0; i <= REMOVED; i++) {
      ast_statsd_log_full_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE, 0, 1.0, ast_sip_get_contact_status_label(i));
   }

   return 0;
}

ast_sip_location_add_contact()

int ast_sip_location_add_contact	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		struct ast_sip_endpoint *	endpoint
	)

Add a new contact to an AOR.

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
endpoint	The endpoint that resulted in the contact being added

Return values

-1	failure
0	success

Warning

This function holds a named write lock on the aor. If you already hold the lock you should call ast_sip_location_add_contact_nolock instead.

Definition at line 429 of file location.c.

References ao2_lock, ao2_unlock, and ast_sip_location_add_contact_nolock().

{
   int res;

   ao2_lock(aor);
   res = ast_sip_location_add_contact_nolock(aor, uri, expiration_time, path_info, user_agent,
      via_addr, via_port, call_id,
      endpoint);
   ao2_unlock(aor);

   return res;
}

ast_sip_location_add_contact_nolock()

int ast_sip_location_add_contact_nolock	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		struct ast_sip_endpoint *	endpoint
	)

Add a new contact to an AOR without locking the AOR.

Since

13.9.0

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
endpoint	The endpoint that resulted in the contact being added

Return values

-1	failure
0	success

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 416 of file location.c.

References ao2_cleanup, and ast_sip_location_create_contact().

Referenced by ast_sip_location_add_contact().

{
   struct ast_sip_contact *contact;

   contact = ast_sip_location_create_contact(aor, uri, expiration_time, path_info,
      user_agent, via_addr, via_port, call_id, 0, endpoint);
   ao2_cleanup(contact);
   return contact ? 0 : -1;
}

ast_sip_location_create_contact()

struct ast_sip_contact* ast_sip_location_create_contact	(	struct ast_sip_aor *	aor,
		const char *	uri,
		struct timeval	expiration_time,
		const char *	path_info,
		const char *	user_agent,
		const char *	via_addr,
		int	via_port,
		const char *	call_id,
		int	prune_on_boot,
		struct ast_sip_endpoint *	endpoint
	)

Create a new contact for an AOR without locking the AOR.

Since

13.18.0

Parameters

aor	Pointer to the AOR
uri	Full contact URI
expiration_time	Optional expiration time of the contact
path_info	Path information
user_agent	User-Agent header from REGISTER request
via_addr
via_port
call_id
prune_on_boot	Non-zero if the contact cannot survive a restart/boot.
endpoint	The endpoint that resulted in the contact being added

Returns

The created contact or NULL on failure.

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 355 of file location.c.

References ao2_bump, ao2_ref, ast_config_AST_SYSTEM_NAME, ast_md5_hash(), ast_sip_get_sorcery(), ast_sorcery_alloc(), ast_sorcery_create(), ast_sorcery_object_get_id(), ast_string_field_set, ast_strlen_zero, ast_sip_contact::authenticate_qualify, ast_sip_aor::authenticate_qualify, ast_sip_contact::endpoint, ast_sip_contact::endpoint_name, ast_sip_contact::expiration_time, MAX_OBJECT_FIELD, name, NULL, ast_sip_contact::outbound_proxy, ast_sip_aor::outbound_proxy, ast_sip_contact::path, ast_sip_contact::prune_on_boot, ast_sip_contact::qualify_frequency, ast_sip_aor::qualify_frequency, ast_sip_contact::qualify_timeout, ast_sip_aor::qualify_timeout, ast_sip_contact::reg_server, ast_sip_aor::support_path, and ast_sip_contact::via_port.

Referenced by ast_sip_location_add_contact_nolock(), and register_aor_core().

{
   struct ast_sip_contact *contact;
   char name[MAX_OBJECT_FIELD * 2 + 3];
   char hash[33];

   ast_md5_hash(hash, uri);
   snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), hash);

   contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name);
   if (!contact) {
      return NULL;
   }

   ast_string_field_set(contact, uri, uri);
   contact->expiration_time = expiration_time;
   contact->qualify_frequency = aor->qualify_frequency;
   contact->qualify_timeout = aor->qualify_timeout;
   contact->authenticate_qualify = aor->authenticate_qualify;
   if (path_info && aor->support_path) {
      ast_string_field_set(contact, path, path_info);
   }

   if (!ast_strlen_zero(aor->outbound_proxy)) {
      ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
   }

   if (!ast_strlen_zero(user_agent)) {
      ast_string_field_set(contact, user_agent, user_agent);
   }

   if (!ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
      ast_string_field_set(contact, reg_server, ast_config_AST_SYSTEM_NAME);
   }

   if (!ast_strlen_zero(via_addr)) {
      ast_string_field_set(contact, via_addr, via_addr);
   }
   contact->via_port = via_port;

   if (!ast_strlen_zero(call_id)) {
      ast_string_field_set(contact, call_id, call_id);
   }

   contact->endpoint = ao2_bump(endpoint);
   if (endpoint) {
      ast_string_field_set(contact, endpoint_name, ast_sorcery_object_get_id(endpoint));
   }

   contact->prune_on_boot = prune_on_boot;

   if (ast_sorcery_create(ast_sip_get_sorcery(), contact)) {
      ao2_ref(contact, -1);
      return NULL;
   }
   return contact;
}

ast_sip_location_delete_contact()

int ast_sip_location_delete_contact

(

struct ast_sip_contact *

contact

)

Delete a contact.

Parameters

contact

Contact object to delete

Return values

-1	failure
0	success

Definition at line 450 of file location.c.

References ast_sip_get_sorcery(), and ast_sorcery_delete().

Referenced by contact_expire(), destroy_contact(), prune_boot_contacts_cb(), and registrar_contact_delete().

{
   return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
}

ast_sip_location_prune_boot_contacts()

void ast_sip_location_prune_boot_contacts

(

void

)

Prune the prune_on_boot contacts.

Since

13.18.0

Definition at line 469 of file location.c.

References ao2_callback, ao2_ref, AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), NULL, and prune_boot_contacts_cb().

Referenced by ast_res_pjsip_initialize_configuration().

{
   struct ao2_container *contacts;

   contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact",
      AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
   if (contacts) {
      ao2_callback(contacts, 0, prune_boot_contacts_cb, NULL);
      ao2_ref(contacts, -1);
   }
}

ast_sip_location_retrieve_aor()

struct ast_sip_aor* ast_sip_location_retrieve_aor

(

const char *

aor_name

)

Retrieve a named AOR.

Parameters

aor_name

Name of the AOR

Return values

NULL	if not found
non-NULL	if found

Definition at line 147 of file location.c.

References ast_sip_get_sorcery(), and ast_sorcery_retrieve_by_id().

Referenced by ast_sip_for_each_aor(), ast_sip_location_retrieve_contact_and_aor_from_list_filtered(), find_aor(), find_aor_for_resource(), find_registrar_aor(), handle_slash(), notify_endpoint(), pjsip_acf_dial_contacts_read(), register_contact_transport_remove_cb(), and send_unsolicited_mwi_notify().

{
   return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
}

ast_sip_location_retrieve_aor_contacts()

struct ao2_container* ast_sip_location_retrieve_aor_contacts

(

const struct ast_sip_aor *

aor

)

Retrieve all contacts currently available for an AOR.

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

Since this function prunes expired contacts before returning, it holds a named write lock on the aor. If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.

Definition at line 247 of file location.c.

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_aor_contacts_filtered().

Referenced by ast_sip_for_each_contact(), format_ami_aor_handler(), gather_contacts_for_aor(), notify_endpoint(), pjsip_aor_function_read(), and send_unsolicited_mwi_notify().

{
   return ast_sip_location_retrieve_aor_contacts_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

ast_sip_location_retrieve_aor_contacts_filtered()

struct ao2_container* ast_sip_location_retrieve_aor_contacts_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve all contacts currently available for an AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

Since this function prunes expired contacts before returning, it holds a named write lock on the aor. If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.

Definition at line 252 of file location.c.

References ao2_lock, ao2_unlock, and ast_sip_location_retrieve_aor_contacts_nolock_filtered().

Referenced by ast_sip_location_retrieve_aor_contacts(), ast_sip_location_retrieve_first_aor_contact_filtered(), and pjsip_acf_dial_contacts_read().

{
   struct ao2_container *contacts;

   /* ao2_lock / ao2_unlock do not actually write aor since it has an ao2 lockobj. */
   ao2_lock((void*)aor);
   contacts = ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, flags);
   ao2_unlock((void*)aor);

   return contacts;
}

ast_sip_location_retrieve_aor_contacts_nolock()

struct ao2_container* ast_sip_location_retrieve_aor_contacts_nolock

(

const struct ast_sip_aor *

aor

)

Retrieve all contacts currently available for an AOR without locking the AOR.

Since

13.9.0

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 214 of file location.c.

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_aor_contacts_nolock_filtered().

Referenced by register_aor().

{
   return ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

ast_sip_location_retrieve_aor_contacts_nolock_filtered()

struct ao2_container* ast_sip_location_retrieve_aor_contacts_nolock_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Warning

This function should only be called if you already hold a named write lock on the aor.

Definition at line 219 of file location.c.

References ao2_callback, AST_SIP_CONTACT_FILTER_REACHABLE, ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_prefix(), contact_expire(), contact_link_static(), contact_remove_unreachable(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, ast_sip_aor::permanent_contacts, and prefix.

Referenced by ast_sip_location_retrieve_aor_contacts_filtered(), and ast_sip_location_retrieve_aor_contacts_nolock().

{
   /* Give enough space for ;@ at the end, since that is our object naming scheme */
   size_t prefix_len = strlen(ast_sorcery_object_get_id(aor)) + sizeof(";@") - 1;
   char prefix[prefix_len + 1];
   struct ao2_container *contacts;

   sprintf(prefix, "%s;@", ast_sorcery_object_get_id(aor)); /* Safe */
   if (!(contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact", prefix, prefix_len))) {
      return NULL;
   }

   /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
   ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);

   /* Add any permanent contacts from the AOR */
   if (aor->permanent_contacts) {
      ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);
   }

   if (flags & AST_SIP_CONTACT_FILTER_REACHABLE) {
      ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_remove_unreachable, NULL);
   }

   return contacts;
}

ast_sip_location_retrieve_contact()

struct ast_sip_contact* ast_sip_location_retrieve_contact

(

const char *

contact_name

)

Retrieve a named contact.

Parameters

contact_name

Name of the contact

Return values

NULL	if not found
non-NULL	if found

Definition at line 350 of file location.c.

References ast_sip_get_sorcery(), and ast_sorcery_retrieve_by_id().

Referenced by register_contact_transport_remove_cb().

{
   return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
}

ast_sip_location_retrieve_contact_and_aor_from_list()

void ast_sip_location_retrieve_contact_and_aor_from_list	(	const char *	aor_list,
		struct ast_sip_aor **	aor,
		struct ast_sip_contact **	contact
	)

Retrieve the first bound contact AND the AOR chosen from a list of AORs.

Parameters

aor_list	A comma-separated list of AOR names
aor	The chosen AOR
contact	The chosen contact

Definition at line 266 of file location.c.

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_contact_and_aor_from_list_filtered().

Referenced by ast_sip_location_retrieve_contact_from_aor_list().

{
   ast_sip_location_retrieve_contact_and_aor_from_list_filtered(aor_list, AST_SIP_CONTACT_FILTER_DEFAULT, aor, contact);
}

ast_sip_location_retrieve_contact_and_aor_from_list_filtered()

void ast_sip_location_retrieve_contact_and_aor_from_list_filtered	(	const char *	aor_list,
		unsigned int	flags,
		struct ast_sip_aor **	aor,
		struct ast_sip_contact **	contact
	)

Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags.

Since

13.16.0

Parameters

aor_list	A comma-separated list of AOR names
flags	Filtering flags
aor	The chosen AOR
contact	The chosen contact

Definition at line 272 of file location.c.

References ao2_ref, ast_log, ast_sip_location_retrieve_aor(), ast_sip_location_retrieve_first_aor_contact_filtered(), ast_strdupa, ast_strip(), ast_strlen_zero, LOG_WARNING, NULL, and strsep().

Referenced by ast_sip_location_retrieve_contact_and_aor_from_list(), and ast_sip_session_create_outgoing().

{
   char *aor_name;
   char *rest;

   /* If the location is still empty we have nowhere to go */
   if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
      ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
      return;
   }

   *aor = NULL;
   *contact = NULL;

   while ((aor_name = ast_strip(strsep(&rest, ",")))) {
      *aor = ast_sip_location_retrieve_aor(aor_name);

      if (!(*aor)) {
         continue;
      }
      *contact = ast_sip_location_retrieve_first_aor_contact_filtered(*aor, flags);
      /* If a valid contact is available use its URI for dialing */
      if (*contact) {
         break;
      }

      ao2_ref(*aor, -1);
      *aor = NULL;
   }
}

ast_sip_location_retrieve_contact_from_aor_list()

struct ast_sip_contact* ast_sip_location_retrieve_contact_from_aor_list

(

const char *

aor_list

)

Retrieve the first bound contact from a list of AORs.

Parameters

aor_list

A comma-separated list of AOR names

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 304 of file location.c.

References ao2_cleanup, ast_sip_location_retrieve_contact_and_aor_from_list(), cli_contact_populate_container(), and permanent_uri_sort_fn().

Referenced by ast_sip_create_subscription(), create_out_of_dialog_request(), handle_atsign(), handle_single_token(), insert_user_in_contact_uri(), mwi_contact_deleted(), and transfer().

{
   struct ast_sip_aor *aor;
   struct ast_sip_contact *contact;

   ast_sip_location_retrieve_contact_and_aor_from_list(aor_list, &aor, &contact);

   ao2_cleanup(aor);

   return contact;
}

ast_sip_location_retrieve_contacts_from_aor_list()

struct ao2_container* ast_sip_location_retrieve_contacts_from_aor_list

(

const char *

aor_list

)

Retrieve all contacts from a list of AORs.

Parameters

aor_list

A comma-separated list of AOR names

Return values

NULL	if no contacts available
non-NULL	container (which must be freed) if contacts available

Definition at line 335 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_list, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, ast_sip_for_each_aor(), gather_contacts_for_aor(), NULL, and permanent_uri_sort_fn().

{
   struct ao2_container *contacts;

   contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
      AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
   if (!contacts) {
      return NULL;
   }

   ast_sip_for_each_aor(aor_list, gather_contacts_for_aor, contacts);

   return contacts;
}

ast_sip_location_retrieve_first_aor_contact()

struct ast_sip_contact* ast_sip_location_retrieve_first_aor_contact

(

const struct ast_sip_aor *

aor

)

Retrieve the first bound contact for an AOR.

Parameters

aor	Pointer to the AOR

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 194 of file location.c.

References AST_SIP_CONTACT_FILTER_DEFAULT, and ast_sip_location_retrieve_first_aor_contact_filtered().

Referenced by handle_slash().

{
   return ast_sip_location_retrieve_first_aor_contact_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
}

ast_sip_location_retrieve_first_aor_contact_filtered()

struct ast_sip_contact* ast_sip_location_retrieve_first_aor_contact_filtered	(	const struct ast_sip_aor *	aor,
		unsigned int	flags
	)

Retrieve the first bound contact for an AOR and filter based on flags.

Since

13.16.0

Parameters

aor	Pointer to the AOR
flags	Filtering flags

Return values

NULL	if no contacts available
non-NULL	if contacts available

Definition at line 199 of file location.c.

References ao2_callback, ao2_cleanup, ao2_container_count(), ast_sip_location_retrieve_aor_contacts_filtered(), and NULL.

Referenced by ast_sip_location_retrieve_contact_and_aor_from_list_filtered(), and ast_sip_location_retrieve_first_aor_contact().

{
   struct ao2_container *contacts;
   struct ast_sip_contact *contact = NULL;

   contacts = ast_sip_location_retrieve_aor_contacts_filtered(aor, flags);
   if (contacts && ao2_container_count(contacts)) {
      /* Get the first AOR contact in the container. */
      contact = ao2_callback(contacts, 0, NULL, NULL);
   }
   ao2_cleanup(contacts);
   return contact;
}

ast_sip_location_update_contact()

int ast_sip_location_update_contact

(

struct ast_sip_contact *

contact

)

Update a contact.

Parameters

contact

New contact object with details

Return values

-1	failure
0	success

Definition at line 445 of file location.c.

References ast_sip_get_sorcery(), and ast_sorcery_update().

Referenced by register_aor_core().

{
   return ast_sorcery_update(ast_sip_get_sorcery(), contact);
}

ast_sip_validate_uri_length()

int ast_sip_validate_uri_length

(

const char *

contact_uri

)

Definition at line 525 of file location.c.

References ast_strdupa, ast_strip_quoted(), host, pj_max_hostname, pjsip_max_url_size, and strsep().

Referenced by permanent_uri_handler(), sip_outbound_registration_apply(), and validate_publish_config().

{
   int max_length = pj_max_hostname - 1;
   char *contact = ast_strdupa(contact_uri);
   char *host;
   char *at;
   int theres_a_port = 0;

   if (strlen(contact_uri) > pjsip_max_url_size - 1) {
      return -1;
   }

   contact = ast_strip_quoted(contact, "<", ">");

   if (!strncasecmp(contact, "sip:", 4)) {
      host = contact + 4;
   } else if (!strncasecmp(contact, "sips:", 5)) {
      host = contact + 5;
   } else {
      /* Not a SIP URI */
      return -1;
   }

   at = strchr(contact, '@');
   if (at) {
      /* sip[s]:user@host */
      host = at + 1;
   }

   if (host[0] == '[') {
      /* Host is an IPv6 address. Just get up to the matching bracket */
      char *close_bracket;

      close_bracket = strchr(host, ']');
      if (!close_bracket) {
         return -1;
      }
      close_bracket++;
      if (*close_bracket == ':') {
         theres_a_port = 1;
      }
      *close_bracket = '\0';
   } else {
      /* uri parameters could contain ';' so trim them off first */
      host = strsep(&host, ";?");
      /* Host is FQDN or IPv4 address. Need to find closing delimiter */
      if (strchr(host, ':')) {
         theres_a_port = 1;
         host = strsep(&host, ":");
      }
   }

   if (!theres_a_port) {
      max_length -= strlen("_sips.tcp.");
   }

   if (strlen(host) > max_length) {
      return -1;
   }

   return 0;
}

cli_aor_gather_contacts()

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

static

Definition at line 909 of file location.c.

References ast_sip_for_each_contact(), and cli_contact_populate_container().

Referenced by cli_contact_get_container().

{
   struct ast_sip_aor *aor = obj;

   return ast_sip_for_each_contact(aor, cli_contact_populate_container, arg);
}

cli_aor_get_container()

static struct ao2_container* cli_aor_get_container ( const char *  regex )

static

Definition at line 879 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_list, ao2_container_dup(), ao2_ref, ast_sip_get_sorcery(), ast_sorcery_object_id_compare(), ast_sorcery_object_id_sort(), ast_sorcery_retrieve_by_regex(), container, and NULL.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ao2_container *container;
   struct ao2_container *s_container;

   container = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "aor", regex);
   if (!container) {
      return NULL;
   }

   /* Create a sorted container of aors. */
   s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
      ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
   if (s_container
      && ao2_container_dup(s_container, container, 0)) {
      ao2_ref(s_container, -1);
      s_container = NULL;
   }
   ao2_ref(container, -1);

   return s_container;
}

cli_aor_get_id()

static const char* cli_aor_get_id ( const void *  obj )

static

Definition at line 1151 of file location.c.

References ast_sorcery_object_get_id().

Referenced by ast_sip_initialize_sorcery_location().

{
   return ast_sorcery_object_get_id(obj);
}

cli_aor_iterate()

static int cli_aor_iterate ( void *  container, ao2_callback_fn  callback, void *  args  )

static

Definition at line 1139 of file location.c.

References ast_sip_for_each_aor(), and container.

Referenced by ast_sip_initialize_sorcery_location().

{
   const char *aor_list = container;

   return ast_sip_for_each_aor(aor_list, callback, args);
}

cli_aor_print_body()

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

static

Definition at line 1183 of file location.c.

References ao2_ref, ast_assert, ast_sip_cli_print_sorcery_objectset(), ast_sip_lookup_cli_formatter(), ast_sorcery_object_get_id(), ast_str_append(), CLI_INDENT_TO_SPACES, CLI_LAST_TABSTOP, context, ast_sip_cli_context::indent_level, ast_sip_cli_formatter_entry::iterate, ast_sip_aor::max_contacts, NULL, ast_sip_cli_context::output_buffer, ast_sip_cli_formatter_entry::print_body, ast_sip_cli_context::recurse, ast_sip_cli_context::show_details, and ast_sip_cli_context::show_details_only_level_0.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_aor *aor = obj;
   struct ast_sip_cli_context *context = arg;
   int indent;
   int flexwidth;

   ast_assert(context->output_buffer != NULL);

// context->current_aor = aor;

   indent = CLI_INDENT_TO_SPACES(context->indent_level);
   flexwidth = CLI_LAST_TABSTOP - indent - 12;

   ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12u\n",
      indent,
      "Aor",
      flexwidth, flexwidth,
      ast_sorcery_object_get_id(aor), aor->max_contacts);

   if (context->recurse) {
      struct ast_sip_cli_formatter_entry *formatter_entry;

      context->indent_level++;

      formatter_entry = ast_sip_lookup_cli_formatter("contact");
      if (formatter_entry) {
         formatter_entry->iterate(aor, formatter_entry->print_body, context);
         ao2_ref(formatter_entry, -1);
      }

      context->indent_level--;

      if (context->indent_level == 0) {
         ast_str_append(&context->output_buffer, 0, "\n");
      }
   }

   if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
      ast_str_append(&context->output_buffer, 0, "\n");
      ast_sip_cli_print_sorcery_objectset(aor, context, 0);
   }

   return 0;
}

cli_aor_print_header()

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

static

Definition at line 1156 of file location.c.

References ao2_ref, ast_assert, ast_sip_lookup_cli_formatter(), ast_str_append(), CLI_HEADER_FILLER, CLI_INDENT_TO_SPACES, CLI_LAST_TABSTOP, context, ast_sip_cli_context::indent_level, NULL, ast_sip_cli_context::output_buffer, ast_sip_cli_formatter_entry::print_header, and ast_sip_cli_context::recurse.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_cli_context *context = arg;
   int indent = CLI_INDENT_TO_SPACES(context->indent_level);
   int filler = CLI_LAST_TABSTOP - indent - 7;

   ast_assert(context->output_buffer != NULL);

   ast_str_append(&context->output_buffer, 0,
      "%*s:  <Aor%*.*s>  <MaxContact>\n",
      indent, "Aor", filler, filler, CLI_HEADER_FILLER);

   if (context->recurse) {
      struct ast_sip_cli_formatter_entry *formatter_entry;

      context->indent_level++;
      formatter_entry = ast_sip_lookup_cli_formatter("contact");
      if (formatter_entry) {
         formatter_entry->print_header(NULL, context, 0);
         ao2_ref(formatter_entry, -1);
      }
      context->indent_level--;
   }

   return 0;
}

cli_aor_retrieve_by_id()

static void* cli_aor_retrieve_by_id ( const char *  id )

static

Definition at line 1146 of file location.c.

References ast_sip_get_sorcery(), and ast_sorcery_retrieve_by_id().

Referenced by ast_sip_initialize_sorcery_location().

{
   return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", id);
}

cli_contact_compare()

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

static

Definition at line 947 of file location.c.

References CMP_MATCH, CMP_STOP, ast_sip_contact_wrapper::contact_id, OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, OBJ_SEARCH_OBJECT, and OBJ_SEARCH_PARTIAL_KEY.

Referenced by cli_contact_get_container().

{
   const struct ast_sip_contact_wrapper *left_wrapper = obj;
   const struct ast_sip_contact_wrapper *right_wrapper = arg;
   const char *right_key = arg;
   int cmp = 0;

   switch (flags & OBJ_SEARCH_MASK) {
   case OBJ_SEARCH_OBJECT:
      right_key = right_wrapper->contact_id;
      /* Fall through */
   case OBJ_SEARCH_KEY:
      if (strcmp(left_wrapper->contact_id, right_key) == 0) {;
         cmp = CMP_MATCH | CMP_STOP;
      }
      break;
   case OBJ_SEARCH_PARTIAL_KEY:
      if (strncmp(left_wrapper->contact_id, right_key, strlen(right_key)) == 0) {
         cmp = CMP_MATCH;
      }
      break;
   default:
      cmp = 0;
      break;
   }

   return cmp;
}

cli_contact_get_container()

static struct ao2_container* cli_contact_get_container ( const char *  regex )

static

Definition at line 1026 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_callback, ao2_cleanup, ao2_container_alloc_list, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, ao2_ref, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_regex(), ast_strlen_zero, ast_variable_new, ast_variables_destroy(), cli_aor_gather_contacts(), cli_contact_compare(), cli_contact_sort(), cli_filter_contacts(), cli_gather_contact(), NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, and RAII_VAR.

Referenced by ast_sip_initialize_sorcery_location(), and cli_contact_retrieve_by_id().

{
   RAII_VAR(struct ao2_container *, aors, NULL, ao2_cleanup);
   RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
   RAII_VAR(struct ast_variable *, var_aor, NULL, ast_variables_destroy);
   struct ao2_container *contacts_container;
   regex_t regexbuf;

   if (!(var_aor = ast_variable_new("contact !=", "", ""))) {
      return NULL;
   }

   /* Retrieving all the contacts may result in finding the same contact multiple
    * times. So that they don't get displayed multiple times we only allow a
    * single one to be placed into the container.
    */
   contacts_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT,
      cli_contact_sort, cli_contact_compare);
   if (!contacts_container) {
      return NULL;
   }

   contacts = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "contact", regex);
   if (!contacts) {
      ao2_ref(contacts_container, -1);
      return NULL;
   }
   ao2_callback(contacts, OBJ_NODATA, cli_gather_contact, contacts_container);

   aors = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
      "aor", AST_RETRIEVE_FLAG_MULTIPLE, var_aor);
   if (!aors) {
      ao2_ref(contacts_container, -1);
      return NULL;
   }

   ao2_callback(aors, OBJ_NODATA, cli_aor_gather_contacts, contacts_container);

   if (!ast_strlen_zero(regex)) {
      if (regcomp(&regexbuf, regex, REG_EXTENDED | REG_NOSUB)) {
         ao2_ref(contacts_container, -1);
         return NULL;
      }
      ao2_callback(contacts_container, OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA, cli_filter_contacts, &regexbuf);
      regfree(&regexbuf);
   }

   return contacts_container;
}

cli_contact_get_id()

static const char* cli_contact_get_id ( const void *  obj )

static

Definition at line 916 of file location.c.

References ast_sip_contact_wrapper::contact_id.

Referenced by ast_sip_initialize_sorcery_location().

{
   const struct ast_sip_contact_wrapper *wrapper = obj;
   return wrapper->contact_id;
}

cli_contact_iterate()

static int cli_contact_iterate ( void *  container, ao2_callback_fn  callback, void *  args  )

static

Definition at line 976 of file location.c.

References ast_sip_for_each_contact().

Referenced by ast_sip_initialize_sorcery_location().

{
   return ast_sip_for_each_contact(container, callback, args);
}

cli_contact_populate_container()

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

static

Definition at line 902 of file location.c.

References ao2_link.

Referenced by ast_sip_location_retrieve_contact_from_aor_list(), cli_aor_gather_contacts(), and gather_contacts_for_aor().

{
   ao2_link(arg, obj);

   return 0;
}

cli_contact_print_body()

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

static

Definition at line 1106 of file location.c.

References ao2_cleanup, ast_sip_contact::aor, ast_assert, ast_sip_get_contact_short_status_label(), ast_sip_get_contact_status(), ast_sorcery_object_get_id(), ast_str_append(), AVAILABLE, CLI_INDENT_TO_SPACES, CLI_LAST_TABSTOP, ast_sip_contact_wrapper::contact, context, ast_sip_cli_context::indent_level, NAN, NULL, ast_sip_cli_context::output_buffer, ast_sip_contact_status::rtt, status, ast_sip_contact_status::status, UNKNOWN, and ast_sip_contact::uri.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_contact_wrapper *wrapper = obj;
   struct ast_sip_contact *contact = wrapper->contact;
   struct ast_sip_cli_context *context = arg;
   int indent;
   int flexwidth;
   const char *contact_id = ast_sorcery_object_get_id(contact);
   const char *hash_start = contact_id + strlen(contact->aor) + 2;
   struct ast_sip_contact_status *status;

   ast_assert(contact->uri != NULL);
   ast_assert(context->output_buffer != NULL);

   status = ast_sip_get_contact_status(contact);

   indent = CLI_INDENT_TO_SPACES(context->indent_level);
   flexwidth = CLI_LAST_TABSTOP - indent - 9 - strlen(contact->aor) + 1;

   ast_str_append(&context->output_buffer, 0, "%*s:  %s/%-*.*s %-10.10s %-7.7s %11.3f\n",
      indent,
      "Contact",
      contact->aor,
      flexwidth, flexwidth,
      contact->uri,
      hash_start,
      ast_sip_get_contact_short_status_label(status ? status->status : UNKNOWN),
      (status && (status->status == AVAILABLE)) ? ((long long) status->rtt) / 1000.0 : NAN);

   ao2_cleanup(status);
   return 0;
}

cli_contact_print_header()

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

static

Definition at line 1091 of file location.c.

References ast_assert, ast_str_append(), CLI_HEADER_FILLER, CLI_INDENT_TO_SPACES, CLI_LAST_TABSTOP, context, ast_sip_cli_context::indent_level, NULL, and ast_sip_cli_context::output_buffer.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_cli_context *context = arg;
   int indent = CLI_INDENT_TO_SPACES(context->indent_level);
   int filler = CLI_LAST_TABSTOP - indent - 23;

   ast_assert(context->output_buffer != NULL);

   ast_str_append(&context->output_buffer, 0,
      "%*s:  <Aor/ContactUri%*.*s> <Hash....> <Status> <RTT(ms)..>\n",
      indent, "Contact", filler, filler, CLI_HEADER_FILLER);

   return 0;
}

cli_contact_retrieve_by_id()

static void* cli_contact_retrieve_by_id ( const char *  id )

static

Definition at line 1076 of file location.c.

References ao2_find, ao2_ref, cli_contact_get_container(), container, NULL, and OBJ_SEARCH_KEY.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ao2_container *container;
   void *obj;

   container = cli_contact_get_container("");
   if (!container) {
      return NULL;
   }

   obj = ao2_find(container, id, OBJ_SEARCH_KEY);
   ao2_ref(container, -1);
   return obj;
}

cli_contact_sort()

static int cli_contact_sort ( const void *  obj, const void *  arg, int  flags  )

static

Definition at line 922 of file location.c.

References ast_sip_contact_wrapper::contact_id, OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, OBJ_SEARCH_OBJECT, and OBJ_SEARCH_PARTIAL_KEY.

Referenced by cli_contact_get_container().

{
   const struct ast_sip_contact_wrapper *left_wrapper = obj;
   const struct ast_sip_contact_wrapper *right_wrapper = arg;
   const char *right_key = arg;
   int cmp = 0;

   switch (flags & OBJ_SEARCH_MASK) {
   case OBJ_SEARCH_OBJECT:
      right_key = right_wrapper->contact_id;
      /* Fall through */
   case OBJ_SEARCH_KEY:
      cmp = strcmp(left_wrapper->contact_id, right_key);
      break;
   case OBJ_SEARCH_PARTIAL_KEY:
      cmp = strncmp(left_wrapper->contact_id, right_key, strlen(right_key));
      break;
   default:
      cmp = 0;
      break;
   }

   return cmp;
}

cli_filter_contacts()

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

static

Definition at line 981 of file location.c.

References CMP_MATCH, ast_sip_contact_wrapper::contact_id, and NULL.

Referenced by cli_contact_get_container().

{
   struct ast_sip_contact_wrapper *wrapper = obj;
   regex_t *regexbuf = arg;

   if (!regexec(regexbuf, wrapper->contact_id, 0, NULL, 0)) {
      return 0;
   }

   return CMP_MATCH;
}

cli_gather_contact()

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

static

Definition at line 993 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_bump, ao2_cleanup, ao2_link, ast_sip_contact::aor, ast_config_AST_SYSTEM_NAME, ast_malloc, ast_strdup, contact_wrapper_destroy(), NULL, RAII_VAR, ast_sip_contact::reg_server, and ast_sip_contact::uri.

Referenced by cli_contact_get_container().

{
   struct ast_sip_contact *contact = obj;
   RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);

   if (strcmp(contact->reg_server, ast_config_AST_SYSTEM_NAME ?: "")) {
      return 0;
   }

   wrapper = ao2_alloc_options(sizeof(struct ast_sip_contact_wrapper),
      contact_wrapper_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
   if (!wrapper) {
      return -1;
   }

   wrapper->contact_id = ast_malloc(strlen(contact->aor) + strlen(contact->uri) + 2);
   if (!wrapper->contact_id) {
      return -1;
   }
   sprintf(wrapper->contact_id, "%s/%s", contact->aor, contact->uri);

   wrapper->aor_id = ast_strdup(contact->aor);
   if (!wrapper->aor_id) {
      return -1;
   }

   wrapper->contact = ao2_bump(contact);

   ao2_link(arg, wrapper);

   return 0;
}

cli_get_aors()

static struct ao2_container* cli_get_aors ( void  )

static

Definition at line 1229 of file location.c.

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), and NULL.

Referenced by ami_show_aors().

{
   struct ao2_container *aors;

   aors = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
         AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);

   return aors;
}

contact_alloc()

static void* contact_alloc ( const char *  name )

static

Allocator for contact.

Definition at line 120 of file location.c.

References ao2_cleanup, ast_sip_contact::aor, ast_assert, ast_sorcery_generic_alloc(), ast_strdupa, ast_string_field_init, ast_string_field_set, contact_destroy(), id, and NULL.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_contact *contact = ast_sorcery_generic_alloc(sizeof(*contact), contact_destroy);
   char *id = ast_strdupa(name);
   char *aor = id;
   char *aor_separator = NULL;

   if (!contact) {
      return NULL;
   }

   if (ast_string_field_init(contact, 256)) {
      ao2_cleanup(contact);
      return NULL;
   }

   /* Dynamic contacts are delimited with ";@" and static ones with "@@" */
   if ((aor_separator = strstr(id, ";@")) || (aor_separator = strstr(id, "@@"))) {
      *aor_separator = '\0';
   }
   ast_assert(aor_separator != NULL);

   ast_string_field_set(contact, aor, aor);

   return contact;
}

contact_apply_handler()

static int contact_apply_handler ( const struct ast_sorcery *  sorcery, void *  object  )

static

Always create a contact_status for each contact.

Definition at line 1326 of file location.c.

References ao2_cleanup, ast_log, ast_res_pjsip_find_or_create_contact_status(), ast_sorcery_object_get_id(), ast_strlen_zero, LOG_ERROR, status, and ast_sip_contact::uri.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_contact_status *status;
   struct ast_sip_contact *contact = object;

   if (ast_strlen_zero(contact->uri)) {
      ast_log(LOG_ERROR, "A URI on dynamic contact '%s' is empty\n",
         ast_sorcery_object_get_id(contact));
      return -1;
   }
   status = ast_res_pjsip_find_or_create_contact_status(contact);
   ao2_cleanup(status);

   return status ? 0 : -1;
}

contact_destroy()

static void contact_destroy ( void *  obj )

static

Destructor for contact.

Definition at line 111 of file location.c.

References ao2_cleanup, ast_string_field_free_memory, and ast_sip_contact::endpoint.

Referenced by contact_alloc().

{
   struct ast_sip_contact *contact = obj;

   ast_string_field_free_memory(contact);
   ao2_cleanup(contact->endpoint);
}

contact_expire()

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

static

Internal callback function which deletes and unlinks any expired contacts.

Definition at line 153 of file location.c.

References ast_sip_location_delete_contact(), ast_tvdiff_ms(), ast_tvnow(), CMP_MATCH, and ast_sip_contact::expiration_time.

Referenced by ast_sip_location_retrieve_aor_contacts_nolock_filtered().

{
   struct ast_sip_contact *contact = obj;

   /* If the contact has not yet expired it is valid */
   if (ast_tvdiff_ms(contact->expiration_time, ast_tvnow()) > 0) {
      return 0;
   }

   ast_sip_location_delete_contact(contact);

   return CMP_MATCH;
}

contact_link_static()

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

static

Internal callback function which links static contacts into another container.

Definition at line 168 of file location.c.

References ao2_link.

Referenced by ast_sip_location_retrieve_aor_contacts_nolock_filtered().

{
   struct ao2_container *dest = arg;

   ao2_link(dest, obj);
   return 0;
}

contact_remove_unreachable()

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

static

Internal callback function which removes any contact which is unreachable.

Definition at line 177 of file location.c.

References ao2_ref, ast_sip_get_contact_status(), CMP_MATCH, status, ast_sip_contact_status::status, and UNAVAILABLE.

Referenced by ast_sip_location_retrieve_aor_contacts_nolock_filtered().

{
   struct ast_sip_contact *contact = obj;
   struct ast_sip_contact_status *status;
   int unreachable;

   status = ast_sip_get_contact_status(contact);
   if (!status) {
      return 0;
   }

   unreachable = (status->status == UNAVAILABLE);
   ao2_ref(status, -1);

   return unreachable ? CMP_MATCH : 0;
}

contact_to_var_list()

static int contact_to_var_list ( void *  object, void *  arg, int  flags  )

static

Definition at line 647 of file location.c.

References ast_variable_list_append, ast_variable_new, ast_sip_contact_wrapper::contact, ast_sip_contact::uri, and var.

Referenced by contacts_to_var_list().

{
   struct ast_sip_contact_wrapper *wrapper = object;
   struct ast_variable **var = arg;

   ast_variable_list_append(&*var, ast_variable_new("contact", wrapper->contact->uri, ""));

   return 0;
}

contact_wrapper_destroy()

static void contact_wrapper_destroy ( void *  obj )

static

Definition at line 710 of file location.c.

References ao2_cleanup, ast_sip_contact_wrapper::aor_id, ast_free, ast_sip_contact_wrapper::contact, and ast_sip_contact_wrapper::contact_id.

Referenced by ast_sip_for_each_contact(), and cli_gather_contact().

{
   struct ast_sip_contact_wrapper *wrapper = obj;

   ast_free(wrapper->aor_id);
   ast_free(wrapper->contact_id);
   ao2_cleanup(wrapper->contact);
}

contacts_to_str()

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

static

Definition at line 808 of file location.c.

References ast_free, ast_sip_contact_to_str(), ast_sip_for_each_contact(), ast_str_buffer(), ast_str_create, ast_str_truncate(), ast_strdup, MAX_OBJECT_FIELD, NULL, and str.

Referenced by ast_sip_initialize_sorcery_location().

{
   const struct ast_sip_aor *aor = obj;
   struct ast_str *str;

   str = ast_str_create(MAX_OBJECT_FIELD);
   if (!str) {
      *buf = NULL;
      return -1;
   }

   ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &str);
   ast_str_truncate(str, -1);

   *buf = ast_strdup(ast_str_buffer(str));
   ast_free(str);

   return *buf ? 0 : -1;
}

contacts_to_var_list()

static int contacts_to_var_list ( const void *  obj, struct ast_variable **  fields  )

static

Definition at line 657 of file location.c.

References ast_sip_for_each_contact(), and contact_to_var_list().

Referenced by ast_sip_initialize_sorcery_location().

{
   const struct ast_sip_aor *aor = obj;

   ast_sip_for_each_contact(aor, contact_to_var_list, fields);

   return 0;
}

destroy_contact()

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

static

Internal callback function which destroys the specified contact.

Definition at line 72 of file location.c.

References ast_sip_location_delete_contact(), and CMP_MATCH.

Referenced by aor_deleted_observer().

{
   struct ast_sip_contact *contact = obj;

   ast_sip_location_delete_contact(contact);

   return CMP_MATCH;
}

expiration_str2struct()

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

static

Custom handler for translating from a string timeval to actual structure.

Definition at line 482 of file location.c.

References ast_get_timeval(), ast_tv(), ast_sip_contact::expiration_time, NULL, and ast_variable::value.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_contact *contact = obj;
   return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
}

expiration_struct2str()

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

static

Custom handler for translating from an actual structure timeval to string.

Definition at line 489 of file location.c.

References ast_asprintf, and ast_sip_contact::expiration_time.

Referenced by ast_sip_initialize_sorcery_location().

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

format_ami_aor_handler()

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

static

Definition at line 828 of file location.c.

References ao2_container_count(), ao2_ref, ast_sip_ami::arg, ast_free, ast_sip_create_ami_event(), ast_sip_location_retrieve_aor_contacts(), ast_sorcery_object_get_id(), ast_str_append(), ast_str_buffer(), astman_append(), buf, ast_sip_ami::count, ast_sip_aor::permanent_contacts, ast_sip_ami::s, and sip_aor_to_ami().

Referenced by format_ami_endpoint_aor().

{
   struct ast_sip_aor *aor = obj;
   struct ast_sip_ami *ami = arg;
   const struct ast_sip_endpoint *endpoint = ami->arg;
   struct ast_str *buf;
   struct ao2_container *contacts;
   int total_contacts;
   int num_permanent;

   buf = ast_sip_create_ami_event("AorDetail", ami);
   if (!buf) {
      return -1;
   }
   contacts = ast_sip_location_retrieve_aor_contacts(aor);
   if (!contacts) {
      ast_free(buf);
      return -1;
   }

   sip_aor_to_ami(aor, &buf);
   total_contacts = ao2_container_count(contacts);
   num_permanent = aor->permanent_contacts ?
      ao2_container_count(aor->permanent_contacts) : 0;

   ast_str_append(&buf, 0, "TotalContacts: %d\r\n", total_contacts);
   ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
             total_contacts - num_permanent);
   ast_str_append(&buf, 0, "EndpointName: %s\r\n",
             ast_sorcery_object_get_id(endpoint));

   astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
   ami->count++;

   ast_free(buf);
   ao2_ref(contacts, -1);
   return 0;
}

format_ami_aorlist_handler()

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

static

Definition at line 1239 of file location.c.

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

Referenced by ami_show_aors().

{
   struct ast_sip_aor *aor = obj;
   struct ast_sip_ami *ami = arg;
   struct ast_str *buf;

   buf = ast_sip_create_ami_event("AorList", ami);
   if (!buf) {
      return -1;
   }

   sip_aor_to_ami(aor, &buf);

   astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
   ami->count++;

   ast_free(buf);

   return 0;
}

format_ami_endpoint_aor()

static int format_ami_endpoint_aor ( const struct ast_sip_endpoint *  endpoint, struct ast_sip_ami *  ami  )

static

Definition at line 867 of file location.c.

References ast_sip_endpoint::aors, ast_sip_ami::arg, ast_sip_for_each_aor(), and format_ami_aor_handler().

{
   ami->arg = (void *)endpoint;
   return ast_sip_for_each_aor(endpoint->aors,
                format_ami_aor_handler, ami);
}

gather_contacts_for_aor()

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

static

Definition at line 319 of file location.c.

References ao2_callback, ao2_ref, ast_sip_location_retrieve_aor_contacts(), cli_contact_populate_container(), CMP_MATCH, container, OBJ_MULTIPLE, and OBJ_NODATA.

Referenced by ast_sip_location_retrieve_contacts_from_aor_list().

{
   struct ao2_container *aor_contacts;
   struct ast_sip_aor *aor = obj;
   struct ao2_container *container = arg;

   aor_contacts = ast_sip_location_retrieve_aor_contacts(aor);
   if (!aor_contacts) {
      return 0;
   }
   ao2_callback(aor_contacts, OBJ_MULTIPLE | OBJ_NODATA, cli_contact_populate_container,
      container);
   ao2_ref(aor_contacts, -1);
   return CMP_MATCH;
}

permanent_uri_handler()

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

static

Custom handler for permanent URIs.

Definition at line 589 of file location.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_list, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, ao2_link, ao2_ref, ast_log, ast_md5_hash(), ast_res_pjsip_find_or_create_contact_status(), ast_sip_get_sorcery(), ast_sip_validate_uri_length(), ast_sorcery_alloc(), ast_sorcery_object_get_id(), ast_strdupa, ast_string_field_set, ast_strip(), ast_strlen_zero, LOG_ERROR, NULL, ast_sip_aor::permanent_contacts, permanent_uri_sort_fn(), status, strsep(), ast_sip_contact_status::uri, and ast_variable::value.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_aor *aor = obj;
   const char *aor_id = ast_sorcery_object_get_id(aor);
   char *contacts;
   char *contact_uri;

   if (ast_strlen_zero(var->value)) {
      return 0;
   }

   contacts = ast_strdupa(var->value);
   while ((contact_uri = ast_strip(strsep(&contacts, ",")))) {
      struct ast_sip_contact *contact;
      struct ast_sip_contact_status *status;
      char hash[33];
      char contact_id[strlen(aor_id) + sizeof(hash) + 2];

      if (ast_strlen_zero(contact_uri)) {
         continue;
      }

      if (ast_sip_validate_uri_length(contact_uri)) {
         ast_log(LOG_ERROR, "Contact uri or hostname length exceeds pjproject limit or is not a sip(s) uri: %s\n", contact_uri);
         return -1;
      }

      if (!aor->permanent_contacts) {
         aor->permanent_contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
            AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
         if (!aor->permanent_contacts) {
            return -1;
         }
      }

      ast_md5_hash(hash, contact_uri);
      snprintf(contact_id, sizeof(contact_id), "%s@@%s", aor_id, hash);
      contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", contact_id);
      if (!contact) {
         return -1;
      }

      ast_string_field_set(contact, uri, contact_uri);

      status = ast_res_pjsip_find_or_create_contact_status(contact);
      if (!status) {
         ao2_ref(contact, -1);
         return -1;
      }
      ao2_ref(status, -1);

      ao2_link(aor->permanent_contacts, contact);
      ao2_ref(contact, -1);
   }

   return 0;
}

permanent_uri_sort_fn()

static int permanent_uri_sort_fn ( const void *  obj_left, const void *  obj_right, int  flags  )

static

Definition at line 495 of file location.c.

References ast_assert, ast_sorcery_object_get_id(), OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, OBJ_SEARCH_OBJECT, and OBJ_SEARCH_PARTIAL_KEY.

Referenced by ast_sip_location_retrieve_contact_from_aor_list(), ast_sip_location_retrieve_contacts_from_aor_list(), and permanent_uri_handler().

{
   const struct ast_sip_contact *object_left = obj_left;
   const struct ast_sip_contact *object_right = obj_right;
   const char *right_key = obj_right;
   int cmp;

   switch (flags & OBJ_SEARCH_MASK) {
   case OBJ_SEARCH_OBJECT:
      right_key = ast_sorcery_object_get_id(object_right);
      /* Fall through */
   case OBJ_SEARCH_KEY:
      cmp = strcmp(ast_sorcery_object_get_id(object_left), right_key);
      break;
   case OBJ_SEARCH_PARTIAL_KEY:
      /*
       * We could also use a partial key struct containing a length
       * so strlen() does not get called for every comparison instead.
       */
      cmp = strncmp(ast_sorcery_object_get_id(object_left), right_key, strlen(right_key));
      break;
   default:
      /* Sort can only work on something with a full or partial key. */
      ast_assert(0);
      cmp = 0;
      break;
   }
   return cmp;
}

prune_boot_contacts_cb()

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

static

Definition at line 455 of file location.c.

References ast_sip_contact::aor, ast_config_AST_SYSTEM_NAME, ast_sip_location_delete_contact(), ast_verb, ast_sip_contact::prune_on_boot, ast_sip_contact::reg_server, and ast_sip_contact::uri.

Referenced by ast_sip_location_prune_boot_contacts().

{
   struct ast_sip_contact *contact = obj;

   if (contact->prune_on_boot
      && !strcmp(contact->reg_server, ast_config_AST_SYSTEM_NAME ?: "")) {
      ast_verb(3, "Removed contact '%s' from AOR '%s' due to system boot\n",
         contact->uri, contact->aor);
      ast_sip_location_delete_contact(contact);
   }

   return 0;
}

sip_aor_to_ami()

static int sip_aor_to_ami ( const struct ast_sip_aor *  aor, struct ast_str **  buf  )

static

Definition at line 777 of file location.c.

References ast_free, AST_HANDLER_ONLY_STRING, ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_object_get_type(), ast_sorcery_objectset_create2(), ast_str_append(), ast_to_camel_case, ast_variables_destroy(), ast_variable::name, ast_variable::next, NULL, S_OR, and ast_variable::value.

Referenced by format_ami_aor_handler(), and format_ami_aorlist_handler().

{
   struct ast_variable *objset;
   struct ast_variable *i;

   objset = ast_sorcery_objectset_create2(ast_sip_get_sorcery(), aor,
      AST_HANDLER_ONLY_STRING);
   if (!objset) {
      return -1;
   }

   ast_str_append(buf, 0, "ObjectType: %s\r\n",
             ast_sorcery_object_get_type(aor));
   ast_str_append(buf, 0, "ObjectName: %s\r\n",
             ast_sorcery_object_get_id(aor));

   for (i = objset; i; i = i->next) {
      char *camel = ast_to_camel_case(i->name);

      if (strcmp(camel, "Contact") == 0) {
         ast_free(camel);
         camel = NULL;
      }
      ast_str_append(buf, 0, "%s: %s\r\n", S_OR(camel, "Contacts"), i->value);
      ast_free(camel);
   }

   ast_variables_destroy(objset);
   return 0;
}

voicemail_extension_handler()

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

static

Definition at line 666 of file location.c.

References ast_strdup, ast_variable::value, and ast_sip_aor::voicemail_extension.

Referenced by ast_sip_initialize_sorcery_location().

{
   struct ast_sip_aor *aor = obj;

   aor->voicemail_extension = ast_strdup(var->value);

   return aor->voicemail_extension ? 0 : -1;
}

voicemail_extension_to_str()

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

static

Definition at line 675 of file location.c.

References ast_strdup, and ast_sip_aor::voicemail_extension.

Referenced by ast_sip_initialize_sorcery_location().

{
   const struct ast_sip_aor *aor = obj;

   *buf = ast_strdup(aor->voicemail_extension);

   return 0;
}

Variable Documentation

aor_formatter

struct ast_sip_cli_formatter_entry* aor_formatter

Definition at line 1323 of file location.c.

aor_observer

const struct ast_sorcery_observer aor_observer

static

Initial value:

= {
   .deleted = aor_deleted_observer,
}

Observer for contacts so state can be updated on respective endpoints.

Definition at line 105 of file location.c.

cli_commands

struct ast_cli_entry cli_commands[]

static

Definition at line 1290 of file location.c.

contact_formatter

struct ast_sip_cli_formatter_entry* contact_formatter

Definition at line 1322 of file location.c.

endpoint_aor_formatter

struct ast_sip_endpoint_formatter endpoint_aor_formatter

Initial value:

= {
   .format_ami = format_ami_endpoint_aor
}

Definition at line 875 of file location.c.

pj_max_hostname

int pj_max_hostname = PJ_MAX_HOSTNAME

static

Definition at line 36 of file location.c.

Referenced by ast_sip_initialize_sorcery_location(), and ast_sip_validate_uri_length().

pjsip_max_url_size

int pjsip_max_url_size = PJSIP_MAX_URL_SIZE

static

Definition at line 37 of file location.c.

Referenced by ast_sip_initialize_sorcery_location(), and ast_sip_validate_uri_length().