res_geolocation.h File Reference

#include "asterisk/channel.h"
#include "asterisk/config.h"
#include "asterisk/sorcery.h"
#include "asterisk/xml.h"
#include "asterisk/optional_api.h"

Include dependency graph for res_geolocation.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_geoloc_eprofile
struct	ast_geoloc_location
struct	ast_geoloc_profile

Macros
#define	AST_GEOLOC_INVALID_VALUE   -1
#define	CONFIG_STR_TO_ENUM_DECL(_stem)   int ast_geoloc_ ## _stem ## _str_to_enum(const char *str);
#define	GEOLOC_ENUM_TO_NAME_DECL(_stem)   const char * ast_geoloc_ ## _stem ## _to_name(int ix);

Enumerations
enum	ast_geoloc_format {   AST_GEOLOC_FORMAT_NONE = 0 , AST_GEOLOC_FORMAT_CIVIC_ADDRESS , AST_GEOLOC_FORMAT_GML , AST_GEOLOC_FORMAT_URI ,   AST_GEOLOC_FORMAT_LAST }
enum	ast_geoloc_pidf_element {   AST_PIDF_ELEMENT_NONE = 0 , AST_PIDF_ELEMENT_DEVICE , AST_PIDF_ELEMENT_TUPLE , AST_PIDF_ELEMENT_PERSON ,   AST_PIDF_ELEMENT_LAST }
enum	ast_geoloc_precedence { AST_GEOLOC_PRECED_PREFER_INCOMING = 0 , AST_GEOLOC_PRECED_PREFER_CONFIG , AST_GEOLOC_PRECED_DISCARD_INCOMING , AST_GEOLOC_PRECED_DISCARD_CONFIG }
enum	ast_geoloc_validate_result {   AST_GEOLOC_VALIDATE_SUCCESS = 0 , AST_GEOLOC_VALIDATE_MISSING_SHAPE , AST_GEOLOC_VALIDATE_INVALID_SHAPE , AST_GEOLOC_VALIDATE_INVALID_VARNAME ,   AST_GEOLOC_VALIDATE_NOT_ENOUGH_VARNAMES , AST_GEOLOC_VALIDATE_TOO_MANY_VARNAMES , AST_GEOLOC_VALIDATE_INVALID_CRS , AST_GEOLOC_VALIDATE_INVALID_CRS_FOR_SHAPE ,   AST_GEOLOC_VALIDATE_INVALID_VALUE }

Functions
int	ast_geoloc_civicaddr_is_code_valid (const char *code)
	Given a civicAddress code, check whether it's valid.
enum ast_geoloc_validate_result	ast_geoloc_civicaddr_validate_varlist (const struct ast_variable *varlist, char **result)
	Validate that the names of the variables in the list are valid codes or synonyms.
struct ast_geoloc_location *AST_OPTIONAL_API_NAME()	ast_geoloc_get_location (const char *id)
	Retrieve a geolocation location object by id.
struct ast_geoloc_profile *AST_OPTIONAL_API_NAME()	ast_geoloc_get_profile (const char *id)
	Retrieve a geolocation profile by id.
enum ast_geoloc_validate_result	ast_geoloc_gml_validate_varlist (struct ast_variable *varlist, char **result)
	Validate that the variables in the list represent a valid GML shape.
int AST_OPTIONAL_API_NAME()	ast_geoloc_is_loaded (void)
	Check if res_geolocation is available.
const char *	ast_geoloc_validate_result_to_str (enum ast_geoloc_validate_result result)
	CONFIG_STR_TO_ENUM_DECL (format)
	CONFIG_STR_TO_ENUM_DECL (precedence)
	GEOLOC_ENUM_TO_NAME_DECL (format)
	GEOLOC_ENUM_TO_NAME_DECL (precedence)
int	ast_geoloc_datastore_add_eprofile (struct ast_datastore *ds, struct ast_geoloc_eprofile *eprofile)
	Add an eprofile to a datastore.
struct ast_datastore *	ast_geoloc_datastore_create (const char *id)
	Create an empty geoloc datastore.
struct ast_datastore *	ast_geoloc_datastore_create_from_eprofile (struct ast_geoloc_eprofile *eprofile)
	Create a geoloc datastore from an effective profile.
struct ast_datastore *	ast_geoloc_datastore_create_from_profile_name (const char *profile_name)
	Geolocation datastore Functions.
int	ast_geoloc_datastore_delete_eprofile (struct ast_datastore *ds, int ix)
	Delete a specific eprofile from a datastore by index.
struct ast_datastore *	ast_geoloc_datastore_find (struct ast_channel *chan)
	Retrieves the geoloc datastore from a channel, if any.
struct ast_geoloc_eprofile *	ast_geoloc_datastore_get_eprofile (struct ast_datastore *ds, int ix)
	Retrieve a specific eprofile from a datastore by index.
const char *	ast_geoloc_datastore_get_id (struct ast_datastore *ds)
	Retrieve a geoloc datastore's id.
int	ast_geoloc_datastore_insert_eprofile (struct ast_datastore *ds, struct ast_geoloc_eprofile *eprofile, int index)
	Insert an eprofile to a datastore at the specified position.
int	ast_geoloc_datastore_set_inheritance (struct ast_datastore *ds, int inherit)
	Sets the inheritance flag on the datastore.
int	ast_geoloc_datastore_size (struct ast_datastore *ds)
	Retrieves the number of eprofiles in the datastore.
struct ast_geoloc_eprofile *	ast_geoloc_eprofile_alloc (const char *name)
	Geolocation Effective Profile Functions.
struct ast_geoloc_eprofile *	ast_geoloc_eprofile_create_from_pidf (struct ast_xml_doc *pidf_xmldoc, const char *geoloc_uri, const char *reference_string)
	Allocate a new effective profile from an XML PIDF-LO document.
struct ast_geoloc_eprofile *	ast_geoloc_eprofile_create_from_profile (struct ast_geoloc_profile *profile)
	Allocate a new effective profile from an existing profile.
struct ast_geoloc_eprofile *	ast_geoloc_eprofile_create_from_uri (const char *uri, const char *reference_string)
	Allocate a new effective profile from a URI.
struct ast_geoloc_eprofile *	ast_geoloc_eprofile_dup (struct ast_geoloc_eprofile *src)
	Duplicate an effective profile.
int	ast_geoloc_eprofile_refresh_location (struct ast_geoloc_eprofile *eprofile)
	Refresh the effective profile with any changed info.
const char *	ast_geoloc_eprofile_to_pidf (struct ast_geoloc_eprofile *eprofile, struct ast_channel *chan, struct ast_str **buf, const char *ref_string)
	Convert a single eprofile to a PIDF-LO document.
const char *	ast_geoloc_eprofile_to_uri (struct ast_geoloc_eprofile *eprofile, struct ast_channel *chan, struct ast_str **buf, const char *ref_string)
	Convert a URI eprofile to a URI string.
const char *	ast_geoloc_eprofiles_to_pidf (struct ast_datastore *ds, struct ast_channel *chan, struct ast_str **buf, const char *ref_string)
	Convert a datastore containing eprofiles to a PIDF-LO document.

Macro Definition Documentation

AST_GEOLOC_INVALID_VALUE

#define AST_GEOLOC_INVALID_VALUE   -1

Definition at line 28 of file res_geolocation.h.

CONFIG_STR_TO_ENUM_DECL

#define CONFIG_STR_TO_ENUM_DECL

(

_stem

)

int ast_geoloc_ ## _stem ## _str_to_enum(const char *str);

Definition at line 53 of file res_geolocation.h.

GEOLOC_ENUM_TO_NAME_DECL

#define GEOLOC_ENUM_TO_NAME_DECL

(

_stem

)

const char * ast_geoloc_ ## _stem ## _to_name(int ix);

Definition at line 57 of file res_geolocation.h.

Enumeration Type Documentation

ast_geoloc_format

enum ast_geoloc_format

Enumerator
AST_GEOLOC_FORMAT_NONE
AST_GEOLOC_FORMAT_CIVIC_ADDRESS
AST_GEOLOC_FORMAT_GML
AST_GEOLOC_FORMAT_URI
AST_GEOLOC_FORMAT_LAST

Definition at line 38 of file res_geolocation.h.

                       {
    AST_GEOLOC_FORMAT_NONE = 0,
    AST_GEOLOC_FORMAT_CIVIC_ADDRESS,
    AST_GEOLOC_FORMAT_GML,
    AST_GEOLOC_FORMAT_URI,
    AST_GEOLOC_FORMAT_LAST,
};

ast_geoloc_pidf_element

enum ast_geoloc_pidf_element

Enumerator
AST_PIDF_ELEMENT_NONE
AST_PIDF_ELEMENT_DEVICE
AST_PIDF_ELEMENT_TUPLE
AST_PIDF_ELEMENT_PERSON
AST_PIDF_ELEMENT_LAST

Definition at line 30 of file res_geolocation.h.

                             {
    AST_PIDF_ELEMENT_NONE = 0,
    AST_PIDF_ELEMENT_DEVICE,
    AST_PIDF_ELEMENT_TUPLE,
    AST_PIDF_ELEMENT_PERSON,
    AST_PIDF_ELEMENT_LAST,
};

ast_geoloc_precedence

enum ast_geoloc_precedence

Enumerator
AST_GEOLOC_PRECED_PREFER_INCOMING
AST_GEOLOC_PRECED_PREFER_CONFIG
AST_GEOLOC_PRECED_DISCARD_INCOMING
AST_GEOLOC_PRECED_DISCARD_CONFIG

Definition at line 46 of file res_geolocation.h.

                           {
    AST_GEOLOC_PRECED_PREFER_INCOMING = 0,
    AST_GEOLOC_PRECED_PREFER_CONFIG,
    AST_GEOLOC_PRECED_DISCARD_INCOMING,
    AST_GEOLOC_PRECED_DISCARD_CONFIG,
};

ast_geoloc_validate_result

enum ast_geoloc_validate_result

Enumerator
AST_GEOLOC_VALIDATE_SUCCESS
AST_GEOLOC_VALIDATE_MISSING_SHAPE
AST_GEOLOC_VALIDATE_INVALID_SHAPE
AST_GEOLOC_VALIDATE_INVALID_VARNAME
AST_GEOLOC_VALIDATE_NOT_ENOUGH_VARNAMES
AST_GEOLOC_VALIDATE_TOO_MANY_VARNAMES
AST_GEOLOC_VALIDATE_INVALID_CRS
AST_GEOLOC_VALIDATE_INVALID_CRS_FOR_SHAPE
AST_GEOLOC_VALIDATE_INVALID_VALUE

Definition at line 156 of file res_geolocation.h.

                                {
    AST_GEOLOC_VALIDATE_SUCCESS = 0,
    AST_GEOLOC_VALIDATE_MISSING_SHAPE,
    AST_GEOLOC_VALIDATE_INVALID_SHAPE,
    AST_GEOLOC_VALIDATE_INVALID_VARNAME,
    AST_GEOLOC_VALIDATE_NOT_ENOUGH_VARNAMES,
    AST_GEOLOC_VALIDATE_TOO_MANY_VARNAMES,
    AST_GEOLOC_VALIDATE_INVALID_CRS,
    AST_GEOLOC_VALIDATE_INVALID_CRS_FOR_SHAPE,
    AST_GEOLOC_VALIDATE_INVALID_VALUE,
};

Function Documentation

ast_geoloc_civicaddr_is_code_valid()

int ast_geoloc_civicaddr_is_code_valid

(

const char *

code

)

Given a civicAddress code, check whether it's valid.

Parameters

code	Pointer to the code to check

Returns

1 if valid, 0 otherwise.

Definition at line 68 of file geoloc_civicaddr.c.

{
    const char **entry = bsearch(&code, addr_code_name_entries, ARRAY_LEN(addr_code_name_entries),
        sizeof(const char *), compare_civicaddr_codes);
    return (entry != NULL);
}

References addr_code_name_entries, ARRAY_LEN, compare_civicaddr_codes(), and NULL.

Referenced by ast_geoloc_civicaddr_validate_varlist().

ast_geoloc_civicaddr_validate_varlist()

enum ast_geoloc_validate_result ast_geoloc_civicaddr_validate_varlist	(	const struct ast_variable *	varlist,
		char **	result
	)

Validate that the names of the variables in the list are valid codes or synonyms.

Parameters

	varlist	Variable list to check.
[out]	result	Pointer to char * to receive failing item.

Returns

result code.

Definition at line 75 of file geoloc_civicaddr.c.

{
    const struct ast_variable *var = varlist;
    for (; var; var = var->next) {
        int valid = ast_geoloc_civicaddr_is_code_valid(var->name);
        if (!valid) {
            *result = ast_strdup(var->name);
            return AST_GEOLOC_VALIDATE_INVALID_VARNAME;
        }
    }
    return AST_GEOLOC_VALIDATE_SUCCESS;
}

References ast_geoloc_civicaddr_is_code_valid(), AST_GEOLOC_VALIDATE_INVALID_VARNAME, AST_GEOLOC_VALIDATE_SUCCESS, ast_strdup, result, and var.

Referenced by validate_location_info().

ast_geoloc_datastore_add_eprofile()

int ast_geoloc_datastore_add_eprofile	(	struct ast_datastore *	ds,
		struct ast_geoloc_eprofile *	eprofile
	)

Add an eprofile to a datastore.

Parameters

ds	The datastore
eprofile	The eprofile to add.

Returns

The new number of eprofiles or -1 to indicate a failure.

Definition at line 135 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
    int rc = 0;
 
    if (!IS_GEOLOC_DS(ds) || !eprofile) {
        return -1;
    }
 
    eds = ds->data;
    rc = AST_VECTOR_APPEND(&eds->eprofiles, ao2_bump(eprofile));
    if (rc != 0) {
        ao2_ref(eprofile, -1);
        ast_log(LOG_ERROR, "Couldn't add eprofile '%s' to geoloc datastore '%s'\n", eprofile->id, eds->id);
        return -1;
    }
 
    return AST_VECTOR_SIZE(&eds->eprofiles);
}

References ao2_bump, ao2_ref, ast_log, AST_VECTOR_APPEND, AST_VECTOR_SIZE, ast_datastore::data, eprofiles_datastore::eprofiles, ast_geoloc_eprofile::id, eprofiles_datastore::id, IS_GEOLOC_DS, LOG_ERROR, and NULL.

Referenced by add_eprofile_to_channel(), ast_geoloc_datastore_create_from_eprofile(), ast_geoloc_datastore_create_from_profile_name(), and geoloc_profile_write().

ast_geoloc_datastore_create()

struct ast_datastore * ast_geoloc_datastore_create

(

const char *

id

)

Create an empty geoloc datastore.

Parameters

id	An id to use for the datastore.

Returns

The datastore.

Definition at line 99 of file geoloc_datastore.c.

{
    struct ast_datastore *ds = NULL;
    struct eprofiles_datastore *eds = NULL;
    int rc = 0;
 
    if (ast_strlen_zero(id)) {
        ast_log(LOG_ERROR, "A geoloc datastore can't be allocated with a NULL or empty id\n");
        return NULL;
    }
 
    ds = ast_datastore_alloc(&geoloc_datastore_info, NULL);
    if (!ds) {
        ast_log(LOG_ERROR, "Geoloc datastore '%s' couldn't be allocated\n", id);
        return NULL;
    }
 
    eds = ast_calloc(1, sizeof(*eds));
    if (!eds) {
        ast_datastore_free(ds);
        ast_log(LOG_ERROR, "Private structure for geoloc datastore '%s' couldn't be allocated\n", id);
        return NULL;
    }
    ds->data = eds;
 
 
    rc = AST_VECTOR_INIT(&eds->eprofiles, 2);
    if (rc != 0) {
        ast_datastore_free(ds);
        ast_log(LOG_ERROR, "Vector for geoloc datastore '%s' couldn't be initialized\n", id);
        return NULL;
    }
 
    return ds;
}

References ast_calloc, ast_datastore_alloc, ast_datastore_free(), ast_log, ast_strlen_zero(), AST_VECTOR_INIT, ast_datastore::data, eprofiles_datastore::eprofiles, geoloc_datastore_info, LOG_ERROR, and NULL.

Referenced by add_eprofile_to_channel(), ast_geoloc_datastore_create_from_eprofile(), ast_geoloc_datastore_create_from_profile_name(), and geoloc_profile_write().

ast_geoloc_datastore_create_from_eprofile()

struct ast_datastore * ast_geoloc_datastore_create_from_eprofile

(

struct ast_geoloc_eprofile *

eprofile

)

Create a geoloc datastore from an effective profile.

Parameters

eprofile

The effective profile to use.

Returns

The datastore.

Definition at line 242 of file geoloc_datastore.c.

{
    struct ast_datastore *ds;
    int rc = 0;
 
    if (!eprofile) {
        return NULL;
    }
 
    ds = ast_geoloc_datastore_create(eprofile->id);
    if (!ds) {
        return NULL;
    }
 
    rc = ast_geoloc_datastore_add_eprofile(ds, eprofile);
    if (rc <= 0) {
        ast_datastore_free(ds);
        ds = NULL;
    }
 
    return ds;
}

References ast_datastore_free(), ast_geoloc_datastore_add_eprofile(), ast_geoloc_datastore_create(), ast_geoloc_eprofile::id, and NULL.

ast_geoloc_datastore_create_from_profile_name()

struct ast_datastore * ast_geoloc_datastore_create_from_profile_name

(

const char *

profile_name

)

Geolocation datastore Functions.

Create a geoloc datastore from a profile name

Parameters

profile_name

The name of the profile to use.

Returns

The datastore.

Definition at line 266 of file geoloc_datastore.c.

{
    struct ast_datastore *ds = NULL;
    struct ast_geoloc_eprofile *eprofile = NULL;
    struct ast_geoloc_profile *profile = NULL;
    int rc = 0;
 
    if (ast_strlen_zero(profile_name)) {
        return NULL;
    }
 
    profile = ast_sorcery_retrieve_by_id(geoloc_sorcery, "profile", profile_name);
    if (!profile) {
        ast_log(LOG_ERROR, "A profile with the name '%s' was not found\n", profile_name);
        return NULL;
    }
 
    ds = ast_geoloc_datastore_create(profile_name);
    if (!ds) {
        ast_log(LOG_ERROR, "A datastore couldn't be allocated for profile '%s'\n", profile_name);
        ao2_ref(profile, -1);
        return NULL;
    }
 
    eprofile = ast_geoloc_eprofile_create_from_profile(profile);
    ao2_ref(profile, -1);
    if (!eprofile) {
        ast_datastore_free(ds);
        ast_log(LOG_ERROR, "An effective profile with the name '%s' couldn't be allocated\n", profile_name);
        return NULL;
    }
 
    rc = ast_geoloc_datastore_add_eprofile(ds, eprofile);
    ao2_ref(eprofile, -1);
    if (rc <= 0) {
        ast_datastore_free(ds);
        ds = NULL;
    }
 
    return ds;
}

References ao2_ref, ast_datastore_free(), ast_geoloc_datastore_add_eprofile(), ast_geoloc_datastore_create(), ast_geoloc_eprofile_create_from_profile(), ast_log, ast_sorcery_retrieve_by_id(), ast_strlen_zero(), geoloc_sorcery, LOG_ERROR, and NULL.

ast_geoloc_datastore_delete_eprofile()

int ast_geoloc_datastore_delete_eprofile	(	struct ast_datastore *	ds,
		int	ix
	)

Delete a specific eprofile from a datastore by index.

Parameters

ds	The datastore
ix	The index

Returns

0 if succesful, -1 otherwise.

Definition at line 224 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
 
    if (!IS_GEOLOC_DS(ds)) {
        return -1;
    }
 
    eds = ds->data;
 
    if (ix >= AST_VECTOR_SIZE(&eds->eprofiles)) {
        return -1;
    }
 
    ao2_ref(AST_VECTOR_REMOVE(&eds->eprofiles, ix, 1), -1);
    return 0;
}

References ao2_ref, AST_VECTOR_REMOVE, AST_VECTOR_SIZE, ast_datastore::data, eprofiles_datastore::eprofiles, IS_GEOLOC_DS, and NULL.

ast_geoloc_datastore_find()

struct ast_datastore * ast_geoloc_datastore_find

(

struct ast_channel *

chan

)

Retrieves the geoloc datastore from a channel, if any.

Parameters

chan

Channel

Returns

datastore if found, NULL otherwise.

Definition at line 219 of file geoloc_datastore.c.

{
    return ast_channel_datastore_find(chan, &geoloc_datastore_info, NULL);
}

References ast_channel_datastore_find(), geoloc_datastore_info, and NULL.

Referenced by geoloc_profile_read(), geoloc_profile_write(), and handle_outgoing_request().

ast_geoloc_datastore_get_eprofile()

struct ast_geoloc_eprofile * ast_geoloc_datastore_get_eprofile	(	struct ast_datastore *	ds,
		int	ix
	)

Retrieve a specific eprofile from a datastore by index.

Parameters

ds	The datastore
ix	The index

Returns

The effective profile ao2 object with its reference count bumped.

Definition at line 200 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
    struct ast_geoloc_eprofile *eprofile;
 
    if (!IS_GEOLOC_DS(ds)) {
        return NULL;
    }
 
    eds = ds->data;
 
    if (ix >= AST_VECTOR_SIZE(&eds->eprofiles)) {
        return NULL;
    }
 
    eprofile  = AST_VECTOR_GET(&eds->eprofiles, ix);
    return ao2_bump(eprofile);
}

References ao2_bump, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_datastore::data, eprofiles_datastore::eprofiles, IS_GEOLOC_DS, and NULL.

Referenced by ast_geoloc_eprofiles_to_pidf(), geoloc_profile_read(), geoloc_profile_write(), and handle_outgoing_request().

ast_geoloc_datastore_get_id()

const char * ast_geoloc_datastore_get_id

(

struct ast_datastore *

ds

)

Retrieve a geoloc datastore's id.

Parameters

ds	The datastore

Returns

The datastore's id.

Definition at line 86 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
 
    if (!IS_GEOLOC_DS(ds)) {
        return NULL;
    }
 
    eds = (struct eprofiles_datastore *)ds->data;
 
    return eds->id;
}

References ast_datastore::data, eprofiles_datastore::id, IS_GEOLOC_DS, and NULL.

ast_geoloc_datastore_insert_eprofile()

int ast_geoloc_datastore_insert_eprofile	(	struct ast_datastore *	ds,
		struct ast_geoloc_eprofile *	eprofile,
		int	index
	)

Insert an eprofile to a datastore at the specified position.

Parameters

ds	The datastore
eprofile	The eprofile to add.
index	The position to insert at. Existing eprofiles will be moved up to make room.

Returns

The new number of eprofiles or -1 to indicate a failure.

Definition at line 156 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
    int rc = 0;
 
    if (!IS_GEOLOC_DS(ds) || !eprofile) {
        return -1;
    }
 
    eds = ds->data;
    rc = AST_VECTOR_INSERT_AT(&eds->eprofiles, index, ao2_bump(eprofile));
    if (rc != 0) {
        ao2_ref(eprofile, -1);
        ast_log(LOG_ERROR, "Couldn't add eprofile '%s' to geoloc datastore '%s' in position '%d'\n",
            eprofile->id, eds->id, index);
        return -1;
    }
 
    return AST_VECTOR_SIZE(&eds->eprofiles);
}

References ao2_bump, ao2_ref, ast_log, AST_VECTOR_INSERT_AT, AST_VECTOR_SIZE, ast_datastore::data, eprofiles_datastore::eprofiles, ast_geoloc_eprofile::id, eprofiles_datastore::id, IS_GEOLOC_DS, LOG_ERROR, and NULL.

ast_geoloc_datastore_set_inheritance()

int ast_geoloc_datastore_set_inheritance	(	struct ast_datastore *	ds,
		int	inherit
	)

Sets the inheritance flag on the datastore.

Parameters

ds	The datastore
inherit	1 to allow the datastore to be inherited by other channels 0 to prevent the datastore to be inherited by other channels

Returns

0 if successful, -1 otherwise.

Definition at line 191 of file geoloc_datastore.c.

{
    if (!IS_GEOLOC_DS(ds)) {
        return -1;
    }
    ds->inheritance = inherit ? DATASTORE_INHERIT_FOREVER : 0;
    return 0;
}

References DATASTORE_INHERIT_FOREVER, ast_datastore::inheritance, and IS_GEOLOC_DS.

Referenced by add_eprofile_to_channel(), and geoloc_profile_write().

ast_geoloc_datastore_size()

int ast_geoloc_datastore_size

(

struct ast_datastore *

ds

)

Retrieves the number of eprofiles in the datastore.

Parameters

ds	The datastore

Returns

The number of eprofiles.

Definition at line 178 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = NULL;
 
    if (!IS_GEOLOC_DS(ds)) {
        return -1;
    }
 
    eds = ds->data;
 
    return AST_VECTOR_SIZE(&eds->eprofiles);
}

References AST_VECTOR_SIZE, ast_datastore::data, eprofiles_datastore::eprofiles, IS_GEOLOC_DS, and NULL.

Referenced by ast_geoloc_eprofiles_to_pidf(), and handle_outgoing_request().

ast_geoloc_eprofile_alloc()

struct ast_geoloc_eprofile * ast_geoloc_eprofile_alloc

(

const char *

name

)

Geolocation Effective Profile Functions.

Allocate a new, empty effective profile.

Parameters

name	The profile's name

Returns

The effective profile ao2 object.

Definition at line 69 of file geoloc_eprofile.c.

{
    struct ast_geoloc_eprofile *eprofile = ao2_alloc_options(sizeof(*eprofile),
        geoloc_eprofile_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
 
    ast_string_field_init(eprofile, 256);
    ast_string_field_set(eprofile, id, name); /* SAFE string fields handle NULL */
 
    return eprofile;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ast_string_field_init, ast_string_field_set, geoloc_eprofile_destructor(), and name.

Referenced by ast_geoloc_eprofile_create_from_profile(), ast_geoloc_eprofile_create_from_uri(), ast_geoloc_eprofile_dup(), geoloc_eprofile_create_from_xslt_result(), and geoloc_profile_write().

ast_geoloc_eprofile_create_from_pidf()

struct ast_geoloc_eprofile * ast_geoloc_eprofile_create_from_pidf	(	struct ast_xml_doc *	pidf_xmldoc,
		const char *	geoloc_uri,
		const char *	reference_string
	)

Allocate a new effective profile from an XML PIDF-LO document.

Parameters

pidf_xmldoc	The ast_xml_doc to use.
geoloc_uri	The URI that referenced this document.
reference_string	An identifying string to use in error messages.

Returns

The effective profile ao2 object.

Definition at line 805 of file geoloc_eprofile.c.

{
    struct ast_xml_doc *result_doc = NULL;
    struct ast_geoloc_eprofile *eprofile = NULL;
 
    SCOPE_ENTER(3, "%s\n", ref_str);
 
    result_doc = ast_xslt_apply(pidf_to_eprofile_xslt, pidf_xmldoc, NULL);
    if (!is_pidf_lo(result_doc)) {
        SCOPE_EXIT_RTN_VALUE(NULL, "%s: Not a PIDF-LO.  Skipping.\n", ref_str);
    }
 
    /*
     * The document returned from the stylesheet application looks like this...
     * <presence id="presence-entity">
     *     <tuple id="element-id">
     *         <location-info format="gml">shape="Ellipsoid", crs="3d", ...</location-info>
     *         <usage-rules>retransmission-allowed="no", retention-expiry="2010-11-14T20:00:00Z"</usage-rules>
     *         <method>Hybrid_A-GPS</method>
     *     </tuple>
     *  </presence>
     *
     * Regardless of whether the pidf-element was tuple, device or person and whether
     * the format is gml or civicAddress, the presence, pidf-element and location-info
     * elements should be there.
     *
     * The confidence, usage-rules and note-well elements are optional.
     */
 
    if (TRACE_ATLEAST(5)) {
        char *doc_str = NULL;
        int doc_len = 0;
 
        ast_xml_doc_dump_memory(result_doc, &doc_str, &doc_len);
        ast_trace(5, "Intermediate doc len: %d\n%s\n", doc_len, doc_len ? doc_str : "<empty>");
        ast_xml_free_text(doc_str);
        doc_str = NULL;
        doc_len = 0;
    }
 
    eprofile = geoloc_eprofile_create_from_xslt_result(result_doc, ref_str);
    ast_xml_close(result_doc);
 
    if (eprofile && geoloc_uri) {
        set_loc_src(eprofile, geoloc_uri, ref_str);
    }
 
    SCOPE_EXIT_RTN_VALUE(eprofile, "%s: Done.\n", ref_str);
}

References ast_trace, ast_xml_close(), ast_xml_doc_dump_memory(), ast_xml_free_text(), geoloc_eprofile_create_from_xslt_result(), is_pidf_lo(), NULL, pidf_to_eprofile_xslt, SCOPE_ENTER, SCOPE_EXIT_RTN_VALUE, set_loc_src(), and TRACE_ATLEAST.

Referenced by handle_incoming_request().

ast_geoloc_eprofile_create_from_profile()

struct ast_geoloc_eprofile * ast_geoloc_eprofile_create_from_profile

(

struct ast_geoloc_profile *

profile

)

Allocate a new effective profile from an existing profile.

Parameters

profile

The profile to use.

Returns

The effective profile ao2 object.

Definition at line 226 of file geoloc_eprofile.c.

{
    struct ast_geoloc_eprofile *eprofile;
    const char *profile_id;
    int rc = 0;
 
    if (!profile) {
        return NULL;
    }
 
    profile_id = ast_sorcery_object_get_id(profile);
 
    eprofile = ast_geoloc_eprofile_alloc(profile_id);
    if (!eprofile) {
        return NULL;
    }
 
    ao2_lock(profile);
    eprofile->allow_routing_use = profile->allow_routing_use;
    eprofile->pidf_element = profile->pidf_element;
    eprofile->suppress_empty_ca_elements = profile->suppress_empty_ca_elements;
    eprofile->format = profile->format;
 
    rc = ast_string_field_set(eprofile, location_reference, profile->location_reference);
    if (rc == 0) {
        rc = ast_string_field_set(eprofile, pidf_element_id, profile->pidf_element_id);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, notes, profile->notes);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, method, profile->method);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, location_source, profile->location_source);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_info, profile->location_info);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_refinement, profile->location_refinement);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_variables, profile->location_variables);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->usage_rules, profile->usage_rules);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->confidence, profile->confidence);
    }
    if (rc == 0) {
        rc = ast_string_field_set(eprofile, device_id, profile->device_id);
    }
    if (rc != 0) {
        ao2_unlock(profile);
        ao2_ref(eprofile, -1);
        return NULL;
    }
 
    eprofile->precedence = profile->precedence;
    ao2_unlock(profile);
 
    if (ast_geoloc_eprofile_refresh_location(eprofile) != 0) {
        ao2_ref(eprofile, -1);
        return NULL;
    }
 
    return eprofile;
}

References ast_geoloc_profile::allow_routing_use, ast_geoloc_eprofile::allow_routing_use, ao2_lock, ao2_ref, ao2_unlock, ast_geoloc_eprofile_alloc(), ast_geoloc_eprofile_refresh_location(), ast_sorcery_object_get_id(), ast_string_field_set, ast_geoloc_profile::confidence, ast_geoloc_eprofile::confidence, ast_geoloc_profile::device_id, ast_geoloc_eprofile::device_id, DUP_VARS, ast_geoloc_profile::format, ast_geoloc_eprofile::format, ast_geoloc_profile::location_info, ast_geoloc_eprofile::location_info, ast_geoloc_profile::location_reference, ast_geoloc_eprofile::location_reference, ast_geoloc_profile::location_refinement, ast_geoloc_eprofile::location_refinement, ast_geoloc_profile::location_source, ast_geoloc_eprofile::location_source, ast_geoloc_profile::location_variables, ast_geoloc_eprofile::location_variables, ast_geoloc_profile::method, method, ast_geoloc_profile::notes, notes, NULL, ast_geoloc_profile::pidf_element, ast_geoloc_eprofile::pidf_element, ast_geoloc_profile::pidf_element_id, ast_geoloc_eprofile::pidf_element_id, ast_geoloc_profile::precedence, ast_geoloc_eprofile::precedence, ast_geoloc_profile::suppress_empty_ca_elements, ast_geoloc_eprofile::suppress_empty_ca_elements, ast_geoloc_profile::usage_rules, and ast_geoloc_eprofile::usage_rules.

Referenced by ast_geoloc_datastore_create_from_profile_name(), geoloc_config_show_profiles(), handle_incoming_request(), and handle_outgoing_request().

ast_geoloc_eprofile_create_from_uri()

struct ast_geoloc_eprofile * ast_geoloc_eprofile_create_from_uri	(	const char *	uri,
		const char *	reference_string
	)

Allocate a new effective profile from a URI.

Parameters

uri	The URI to use.
reference_string	An identifying string to use in error messages.

Returns

The effective profile ao2 object.

Definition at line 327 of file geoloc_eprofile.c.

{
    struct ast_geoloc_eprofile *eprofile = NULL;
    char *ra = NULL;
    char *local_uri;
 
    if (ast_strlen_zero(uri)) {
        return NULL;
    }
    local_uri = ast_strdupa(uri);
 
    if (local_uri[0] == '<') {
        local_uri++;
    }
    ra = strchr(local_uri, '>');
    if (ra) {
        *ra = '\0';
    }
 
    ast_strip(local_uri);
 
    eprofile = ast_geoloc_eprofile_alloc(local_uri);
    if (!eprofile) {
        return NULL;
    }
 
    set_loc_src(eprofile, uri, ref_str);
 
    eprofile->format = AST_GEOLOC_FORMAT_URI;
    eprofile->location_info = ast_variable_new("URI", local_uri, "");
 
    return eprofile;
}

References ast_geoloc_eprofile_alloc(), AST_GEOLOC_FORMAT_URI, ast_strdupa, ast_strip(), ast_strlen_zero(), ast_variable_new, ast_geoloc_eprofile::format, ast_geoloc_eprofile::location_info, NULL, and set_loc_src().

Referenced by handle_incoming_request().

ast_geoloc_eprofile_dup()

struct ast_geoloc_eprofile * ast_geoloc_eprofile_dup

(

struct ast_geoloc_eprofile *

src

)

Duplicate an effective profile.

Parameters

src	The eprofile to duplicate.

Returns

The duplicated effective profile ao2 object.

Definition at line 159 of file geoloc_eprofile.c.

{
    struct ast_geoloc_eprofile *eprofile;
    const char *profile_id;
    int rc = 0;
 
    if (!src) {
        return NULL;
    }
 
    profile_id = ast_strdupa(src->id);
 
    eprofile = ast_geoloc_eprofile_alloc(profile_id);
    if (!eprofile) {
        return NULL;
    }
 
    eprofile->allow_routing_use = src->allow_routing_use;
    eprofile->pidf_element = src->pidf_element;
    eprofile->suppress_empty_ca_elements = src->suppress_empty_ca_elements;
    eprofile->format = src->format;
    eprofile->precedence = src->precedence;
 
 
    rc = ast_string_field_set(eprofile, location_reference, src->location_reference);
    if (rc == 0) {
        rc = ast_string_field_set(eprofile, pidf_element_id, src->pidf_element_id);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, notes, src->notes);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, method, src->method);
    }
    if (rc == 0) {
        ast_string_field_set(eprofile, location_source, src->location_source);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_info, src->location_info);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->effective_location, src->effective_location);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_refinement, src->location_refinement);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->location_variables, src->location_variables);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->usage_rules, src->usage_rules);
    }
    if (rc == 0) {
        rc = DUP_VARS(eprofile->confidence, src->confidence);
    }
    if (rc == 0) {
        rc = ast_string_field_set(eprofile, device_id, src->device_id);
    }
    if (rc != 0) {
        ao2_ref(eprofile, -1);
        return NULL;
    }
 
 
    return eprofile;
}

References ast_geoloc_eprofile::allow_routing_use, ao2_ref, ast_geoloc_eprofile_alloc(), ast_strdupa, ast_string_field_set, ast_geoloc_eprofile::confidence, ast_geoloc_eprofile::device_id, DUP_VARS, ast_geoloc_eprofile::effective_location, ast_geoloc_eprofile::format, ast_geoloc_eprofile::id, ast_geoloc_eprofile::location_info, ast_geoloc_eprofile::location_reference, ast_geoloc_eprofile::location_refinement, ast_geoloc_eprofile::location_source, ast_geoloc_eprofile::location_variables, ast_geoloc_eprofile::method, method, ast_geoloc_eprofile::notes, notes, NULL, ast_geoloc_eprofile::pidf_element, ast_geoloc_eprofile::pidf_element_id, ast_geoloc_eprofile::precedence, ast_geoloc_eprofile::suppress_empty_ca_elements, and ast_geoloc_eprofile::usage_rules.

Referenced by geoloc_profile_read().

ast_geoloc_eprofile_refresh_location()

int ast_geoloc_eprofile_refresh_location

(

struct ast_geoloc_eprofile *

eprofile

)

Refresh the effective profile with any changed info.

Parameters

eprofile

The eprofile to refresh.

Returns

0 on success, any other value on error.

Definition at line 80 of file geoloc_eprofile.c.

{
    struct ast_geoloc_location *loc = NULL;
    RAII_VAR(struct ast_variable *, temp_locinfo, NULL, ast_variables_destroy);
    RAII_VAR(struct ast_variable *, temp_effloc, NULL, ast_variables_destroy);
    RAII_VAR(struct ast_variable *, temp_confidence, NULL, ast_variables_destroy);
    const char *method = NULL;
    const char *location_source = NULL;
    enum ast_geoloc_format format;
    struct ast_variable *var;
    int rc = 0;
 
    if (!eprofile) {
        return -1;
    }
 
    if (!ast_strlen_zero(eprofile->location_reference)) {
        loc = ast_sorcery_retrieve_by_id(geoloc_sorcery, "location", eprofile->location_reference);
        if (!loc) {
            ast_log(LOG_ERROR, "Profile '%s' referenced location '%s' does not exist!", eprofile->id,
                eprofile->location_reference);
            return -1;
        }
 
        format = loc->format;
        method = loc->method;
        location_source = loc->location_source;
        rc = DUP_VARS(temp_locinfo, loc->location_info);
        if (rc == 0) {
            rc = DUP_VARS(temp_confidence, loc->confidence);
        }
        ao2_ref(loc, -1);
        if (rc != 0) {
            return -1;
        }
    } else {
        format = eprofile->format;
        method = eprofile->method;
        location_source = eprofile->location_source;
        rc = DUP_VARS(temp_locinfo, eprofile->location_info);
        if (rc == 0) {
            rc = DUP_VARS(temp_confidence, eprofile->confidence);
        }
        if (rc != 0) {
            return -1;
        }
    }
 
    rc = DUP_VARS(temp_effloc, temp_locinfo);
    if (rc != 0) {
        return -1;
    }
 
    if (eprofile->location_refinement) {
        for (var = eprofile->location_refinement; var; var = var->next) {
            struct ast_variable *newvar = ast_variable_new(var->name, var->value, "");
            if (!newvar) {
                return -1;
            }
            if (ast_variable_list_replace(&temp_effloc, newvar)) {
                ast_variable_list_append(&temp_effloc, newvar);
            }
        }
    }
 
    eprofile->format = format;
    ast_string_field_set(eprofile, method, method);
    ast_string_field_set(eprofile, location_source, location_source);
 
    ast_variables_destroy(eprofile->location_info);
    eprofile->location_info = temp_locinfo;
    temp_locinfo = NULL;
    ast_variables_destroy(eprofile->effective_location);
    eprofile->effective_location = temp_effloc;
    temp_effloc = NULL;
 
    return 0;
}

References ao2_ref, ast_log, ast_sorcery_retrieve_by_id(), ast_string_field_set, ast_strlen_zero(), ast_variable_list_append, ast_variable_list_replace(), ast_variable_new, ast_variables_destroy(), ast_geoloc_location::confidence, ast_geoloc_eprofile::confidence, DUP_VARS, ast_geoloc_eprofile::effective_location, ast_geoloc_location::format, ast_geoloc_eprofile::format, geoloc_sorcery, ast_geoloc_eprofile::id, ast_geoloc_location::location_info, ast_geoloc_eprofile::location_info, ast_geoloc_eprofile::location_reference, ast_geoloc_eprofile::location_refinement, ast_geoloc_location::location_source, ast_geoloc_eprofile::location_source, LOG_ERROR, ast_geoloc_location::method, ast_geoloc_eprofile::method, method, NULL, RAII_VAR, and var.

Referenced by ast_geoloc_eprofile_create_from_profile(), geoloc_profile_read(), geoloc_profile_write(), and handle_outgoing_request().

ast_geoloc_eprofile_to_pidf()

const char * ast_geoloc_eprofile_to_pidf	(	struct ast_geoloc_eprofile *	eprofile,
		struct ast_channel *	chan,
		struct ast_str **	buf,
		const char *	ref_string
	)

Convert a single eprofile to a PIDF-LO document.

Parameters

eprofile	Effective profile to convert
chan	Channel to use to resolve variables
buf	Pointer to ast_str pointer to use for work
ref_string	An identifying string to use in error messages.

Returns

String representation PIDF-LO allocated from buf or NULL on failure.

Definition at line 1215 of file geoloc_eprofile.c.

{
 
    RAII_VAR(struct ast_xml_doc *, pidf_doc, NULL, ast_xml_close);
    char *doc_str = NULL;
    int doc_len = 0;
    int rc = 0;
    SCOPE_ENTER(3, "%s\n", ref_string);
 
    pidf_doc = geoloc_eprofile_to_xmldoc(eprofile, chan, buf, ref_string);
    if (!pidf_doc) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to create final PIDF-LO doc from intermediate doc\n",
            ref_string);
    }
 
    ast_xml_doc_dump_memory(pidf_doc, &doc_str, &doc_len);
    if (doc_len == 0 || !doc_str) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to dump final PIDF-LO doc to string\n",
            ref_string);
    }
 
    rc = ast_str_set(buf, 0, "%s", doc_str);
    ast_xml_free_text(doc_str);
    if (rc <= 0) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to extend buffer (%d)\n",
            ref_string, rc);
    }
 
    ast_trace(5, "Final doc:\n%s\n", ast_str_buffer(*buf));
 
    SCOPE_EXIT_RTN_VALUE(ast_str_buffer(*buf), "%s: Done\n", ref_string);
 
}

References ast_str_buffer(), ast_str_set(), ast_trace, ast_xml_close(), ast_xml_doc_dump_memory(), ast_xml_free_text(), buf, geoloc_eprofile_to_xmldoc(), LOG_ERROR, NULL, RAII_VAR, SCOPE_ENTER, SCOPE_EXIT_LOG_RTN_VALUE, and SCOPE_EXIT_RTN_VALUE.

Referenced by add_eprofile_to_tdata().

ast_geoloc_eprofile_to_uri()

const char * ast_geoloc_eprofile_to_uri	(	struct ast_geoloc_eprofile *	eprofile,
		struct ast_channel *	chan,
		struct ast_str **	buf,
		const char *	ref_string
	)

Convert a URI eprofile to a URI string.

Parameters

eprofile	Effective profile to convert
chan	Channel to use to resolve variables
buf	Pointer to ast_str pointer to use for work
ref_string	An identifying string to use in error messages.

Returns

String representation of URI allocated from buf or NULL on failure

Definition at line 444 of file geoloc_eprofile.c.

{
    const char *uri = NULL;
    struct ast_variable *resolved = NULL;
    char *result;
    int we_created_buf = 0;
 
    if (!eprofile || !buf || !chan) {
        return NULL;
    }
 
    if (eprofile->format != AST_GEOLOC_FORMAT_URI) {
        ast_log(LOG_ERROR, "%s: '%s' is not a URI profile.  It's '%s'\n",
            ref_str, eprofile->id, ast_geoloc_format_to_name(eprofile->format));
        return NULL;
    }
 
    resolved = geoloc_eprofile_resolve_varlist(eprofile->effective_location,
        eprofile->location_variables, chan);
    if (!resolved) {
        return NULL;
    }
 
    uri = ast_variable_find_in_list(resolved, "URI");
    result = uri ? ast_strdupa(uri) : NULL;
    ast_variables_destroy(resolved);
 
    if (ast_strlen_zero(result)) {
        ast_log(LOG_ERROR, "%s: '%s' is a URI profile but had no, or an empty, 'URI' entry in location_info\n",
            ref_str, eprofile->id);
        return NULL;
    }
 
    if (!*buf) {
        *buf = ast_str_create(256);
        if (!*buf) {
            return NULL;
        }
        we_created_buf = 1;
    }
 
    if (ast_str_append(buf, 0, "%s", result) <= 0) {
        if (we_created_buf) {
            ast_free(*buf);
            *buf = NULL;
            return NULL;
        }
    }
 
    return ast_str_buffer(*buf);
}

References ast_free, AST_GEOLOC_FORMAT_URI, ast_log, ast_str_append(), ast_str_buffer(), ast_str_create, ast_strdupa, ast_strlen_zero(), ast_variable_find_in_list(), ast_variables_destroy(), buf, ast_geoloc_eprofile::effective_location, ast_geoloc_eprofile::format, geoloc_eprofile_resolve_varlist(), ast_geoloc_eprofile::id, ast_geoloc_eprofile::location_variables, LOG_ERROR, NULL, and result.

Referenced by handle_outgoing_request().

ast_geoloc_eprofiles_to_pidf()

const char * ast_geoloc_eprofiles_to_pidf	(	struct ast_datastore *	ds,
		struct ast_channel *	chan,
		struct ast_str **	buf,
		const char *	ref_string
	)

Convert a datastore containing eprofiles to a PIDF-LO document.

Parameters

ds	Datastore containing effective profiles to convert
chan	Channel to use to resolve variables
buf	Pointer to ast_str pointer to use for work
ref_string	An identifying string to use in error messages.

Returns

String representation PIDF-LO allocated from buf or NULL on failure.

Definition at line 1033 of file geoloc_eprofile.c.

{
    RAII_VAR(struct ast_xml_doc *, intermediate, NULL, ast_xml_close);
    RAII_VAR(struct ast_xml_doc *, pidf_doc, NULL, ast_xml_close);
    struct ast_xml_node *root_node;
    struct ast_xml_node *pidfs[AST_PIDF_ELEMENT_LAST] = {NULL, };
    struct ast_geoloc_eprofile *eprofile;
    int eprofile_count = 0;
    int i;
    char *doc_str = NULL;
    int doc_len = 0;
    int rc = 0;
    SCOPE_ENTER(3, "%s\n", ref_string);
 
    if (!ds || !chan || !buf || !*buf || ast_strlen_zero(ref_string)) {
        SCOPE_EXIT_RTN_VALUE(NULL, "%s: Either or both datastore or chan were NULL\n",
            ref_string);
    }
 
    intermediate = ast_xml_new();
    if (!intermediate) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to create XML document\n", ref_string);
    }
    root_node = ast_xml_new_node("presence");
    if (!root_node) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to create root XML node\n", ref_string);
    }
    ast_xml_set_root(intermediate, root_node);
 
    eprofile_count = ast_geoloc_datastore_size(ds);
    for (i = 0; i < eprofile_count; i++) {
        struct ast_xml_node *temp_node = NULL;
        struct ast_xml_node *curr_loc = NULL;
        struct ast_xml_node *new_loc = NULL;
        struct ast_xml_node *new_loc_child = NULL;
        struct ast_xml_node *new_loc_child_dup = NULL;
        const char *entity = NULL;
        int has_no_entity = 0;
        eprofile = ast_geoloc_datastore_get_eprofile(ds, i);
        if (eprofile->format == AST_GEOLOC_FORMAT_URI) {
            continue;
        }
 
        entity = ast_xml_get_attribute(root_node, "entity");
        has_no_entity = ast_strlen_zero(entity);
        ast_xml_free_attr(entity);
        if (has_no_entity) {
            rc = ast_xml_set_attribute(root_node, "entity", eprofile->id);
            if (rc != 0) {
                SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to set 'entity' XML attribute\n", ref_string);
            }
        }
 
        temp_node = geoloc_eprofile_to_intermediate(ast_geoloc_pidf_element_to_name(eprofile->pidf_element),
            eprofile, chan, ref_string);
        if (!temp_node) {
            SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to create temp_node\n", ref_string);
        }
 
        if (!pidfs[eprofile->pidf_element]) {
            pidfs[eprofile->pidf_element] = temp_node;
            ast_xml_add_child(root_node, temp_node);
            continue;
        }
 
        curr_loc = ast_xml_find_child_element(pidfs[eprofile->pidf_element], "location-info", NULL, NULL);
        new_loc = ast_xml_find_child_element(temp_node, "location-info", NULL, NULL);
        new_loc_child = ast_xml_node_get_children(new_loc);
        new_loc_child_dup = ast_xml_copy_node_list(new_loc_child);
        ast_xml_add_child_list(curr_loc, new_loc_child_dup);
 
        ast_xml_free_node(temp_node);
    }
 
    if (TRACE_ATLEAST(5)) {
        ast_xml_doc_dump_memory(intermediate, &doc_str, &doc_len);
        ast_trace(5, "Intermediate doc len: %d\n%s\n", doc_len, doc_len ? doc_str : "<empty>");
        ast_xml_free_text(doc_str);
        doc_str = NULL;
        doc_len = 0;
    }
 
    pidf_doc = ast_xslt_apply(eprofile_to_pidf_xslt, intermediate, NULL);
    if (!pidf_doc) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to create final PIDF-LO doc from intermediate docs\n",
            ref_string);
    }
 
    ast_xml_doc_dump_memory(pidf_doc, &doc_str, &doc_len);
    if (doc_len == 0 || !doc_str) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to dump final PIDF-LO doc to string\n",
            ref_string);
    }
 
    rc = ast_str_set(buf, 0, "%s", doc_str);
    ast_xml_free_text(doc_str);
    if (rc <= 0) {
        SCOPE_EXIT_LOG_RTN_VALUE(NULL, LOG_ERROR, "%s: Unable to extend buffer (%d)\n",
            ref_string, rc);
    }
 
    ast_trace(5, "Final doc:\n%s\n", ast_str_buffer(*buf));
 
    SCOPE_EXIT_RTN_VALUE(ast_str_buffer(*buf), "%s: Done\n", ref_string);
}

References ast_geoloc_datastore_get_eprofile(), ast_geoloc_datastore_size(), AST_GEOLOC_FORMAT_URI, AST_PIDF_ELEMENT_LAST, ast_str_buffer(), ast_str_set(), ast_strlen_zero(), ast_trace, ast_xml_add_child(), ast_xml_add_child_list(), ast_xml_close(), ast_xml_copy_node_list(), ast_xml_doc_dump_memory(), ast_xml_find_child_element, ast_xml_free_attr(), ast_xml_free_node(), ast_xml_free_text(), ast_xml_get_attribute(), ast_xml_new(), ast_xml_new_node(), ast_xml_node_get_children(), ast_xml_set_attribute(), ast_xml_set_root(), buf, eprofile_to_pidf_xslt, ast_geoloc_eprofile::format, geoloc_eprofile_to_intermediate(), ast_geoloc_eprofile::id, LOG_ERROR, NULL, ast_geoloc_eprofile::pidf_element, RAII_VAR, SCOPE_ENTER, SCOPE_EXIT_LOG_RTN_VALUE, SCOPE_EXIT_RTN_VALUE, and TRACE_ATLEAST.

ast_geoloc_get_location()

struct ast_geoloc_location *AST_OPTIONAL_API_NAME() ast_geoloc_get_location

(

const char *

id

)

Retrieve a geolocation location object by id.

Parameters

id	Location object id.

Returns

Location object or NULL if not found.

Definition at line 584 of file geoloc_config.c.

{
    if (ast_strlen_zero(id)) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(geoloc_sorcery, "location", id);
}

References ast_sorcery_retrieve_by_id(), ast_strlen_zero(), geoloc_sorcery, and NULL.

Referenced by geoloc_profile_write().

ast_geoloc_get_profile()

struct ast_geoloc_profile *AST_OPTIONAL_API_NAME() ast_geoloc_get_profile

(

const char *

id

)

Retrieve a geolocation profile by id.

Parameters

id	profile id.

Returns

Profile or NULL if not found.

Definition at line 593 of file geoloc_config.c.

{
    if (ast_strlen_zero(id)) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(geoloc_sorcery, "profile", id);
}

References ast_sorcery_retrieve_by_id(), ast_strlen_zero(), geoloc_sorcery, and NULL.

Referenced by handle_incoming_request(), handle_outgoing_request(), and sip_endpoint_apply_handler().

ast_geoloc_gml_validate_varlist()

enum ast_geoloc_validate_result ast_geoloc_gml_validate_varlist	(	struct ast_variable *	varlist,
		char **	result
	)

Validate that the variables in the list represent a valid GML shape.

Parameters

	varlist	Variable list to check.
[out]	result	Pointer to char * to receive failing item.

Returns

result code.

Definition at line 260 of file geoloc_gml.c.

{
    const char *shape_type = ast_variable_find_in_list(varlist, "shape");
    int shape_index = -1;
    const char *crs = ast_variable_find_in_list(varlist, "crs");
 
    if (!shape_type) {
        SET_RESULT(result, "Missing 'shape'");
        return AST_GEOLOC_VALIDATE_MISSING_SHAPE;
    }
 
    shape_index = find_shape_index(shape_type);
    if (shape_index < 0) {
        SET_RESULT(result, "Invalid shape '%s'", shape_type);
        return AST_GEOLOC_VALIDATE_INVALID_SHAPE;
    }
 
    if (ast_strlen_zero(crs)) {
        struct ast_variable *vcrs = NULL;
        if (ast_strings_equal("any", gml_shape_defs[shape_index].crs)) {
            crs = "2d";
        } else {
            crs = gml_shape_defs[shape_index].crs;
        }
 
        vcrs = ast_variable_new("crs", "2d", "");
        if (vcrs) {
            ast_variable_list_append(&varlist, vcrs);
        }
    }
    if (!crs_validator("crs", crs, varlist, result)) {
        return AST_GEOLOC_VALIDATE_INVALID_CRS;
    }
 
    if (!ast_strings_equal("any", gml_shape_defs[shape_index].crs)
        && !ast_strings_equal(crs, gml_shape_defs[shape_index].crs)) {
        SET_RESULT(result, "Invalid crs '%s' for shape '%s'", crs, shape_type);
        return AST_GEOLOC_VALIDATE_INVALID_CRS_FOR_SHAPE;
    }
 
    return validate_def_varlist(shape_index, varlist, result);
}

References AST_GEOLOC_VALIDATE_INVALID_CRS, AST_GEOLOC_VALIDATE_INVALID_CRS_FOR_SHAPE, AST_GEOLOC_VALIDATE_INVALID_SHAPE, AST_GEOLOC_VALIDATE_MISSING_SHAPE, ast_strings_equal(), ast_strlen_zero(), ast_variable_find_in_list(), ast_variable_list_append, ast_variable_new, geoloc_gml_shape_def::crs, crs_validator(), find_shape_index(), gml_shape_defs, NULL, result, SET_RESULT, and validate_def_varlist().

Referenced by geoloc_gml_list_to_xml(), and validate_location_info().

ast_geoloc_is_loaded()

int AST_OPTIONAL_API_NAME() ast_geoloc_is_loaded

(

void

)

Check if res_geolocation is available.

Returns

1 if available, 0 otherwise.

Definition at line 770 of file geoloc_config.c.

{
    return 1;
}

Referenced by sip_endpoint_apply_handler().

ast_geoloc_validate_result_to_str()

const char * ast_geoloc_validate_result_to_str

(

enum ast_geoloc_validate_result

result

)

Definition at line 34 of file geoloc_common.c.

{
    return result_names[result];
}

References result, and result_names.

CONFIG_STR_TO_ENUM_DECL() [1/2]

CONFIG_STR_TO_ENUM_DECL

(

format

)

CONFIG_STR_TO_ENUM_DECL() [2/2]

CONFIG_STR_TO_ENUM_DECL

(

precedence

)

GEOLOC_ENUM_TO_NAME_DECL() [1/2]

GEOLOC_ENUM_TO_NAME_DECL

(

format

)

GEOLOC_ENUM_TO_NAME_DECL() [2/2]

GEOLOC_ENUM_TO_NAME_DECL

(

precedence

)