geoloc_datastore.c File Reference

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/datastore.h"
#include "asterisk/channel.h"
#include "asterisk/res_geolocation.h"
#include "asterisk/vector.h"
#include "geoloc_private.h"

Include dependency graph for geoloc_datastore.c:

Go to the source code of this file.

Data Structures
struct	eprofiles_datastore
struct	eprofiles_datastore::geoloc_eprofiles

Macros
#define	GEOLOC_DS_TYPE   "geoloc_eprofiles"
#define	IS_GEOLOC_DS(_ds)   (_ds && _ds->data && ast_strings_equal(_ds->info->type, GEOLOC_DS_TYPE))

Functions
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.
int	geoloc_channel_load (void)
int	geoloc_channel_reload (void)
int	geoloc_channel_unload (void)
static void *	geoloc_datastore_duplicate (void *obj)
static void	geoloc_datastore_free (void *obj)

Variables
static const struct ast_datastore_info	geoloc_datastore_info
struct ast_sorcery *	geoloc_sorcery

Macro Definition Documentation

GEOLOC_DS_TYPE

#define GEOLOC_DS_TYPE   "geoloc_eprofiles"

Definition at line 27 of file geoloc_datastore.c.

IS_GEOLOC_DS

#define IS_GEOLOC_DS

(

_ds

)

(_ds && _ds->data && ast_strings_equal(_ds->info->type, GEOLOC_DS_TYPE))

Definition at line 84 of file geoloc_datastore.c.

Function Documentation

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

geoloc_channel_load()

int geoloc_channel_load

(

void

)

Definition at line 316 of file geoloc_datastore.c.

{
    geoloc_sorcery = geoloc_get_sorcery();
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, geoloc_get_sorcery(), and geoloc_sorcery.

Referenced by load_module().

geoloc_channel_reload()

int geoloc_channel_reload

(

void

)

Definition at line 322 of file geoloc_datastore.c.

{
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS.

Referenced by reload_module().

geoloc_channel_unload()

int geoloc_channel_unload

(

void

)

Definition at line 308 of file geoloc_datastore.c.

{
    if (geoloc_sorcery) {
        ast_sorcery_unref(geoloc_sorcery);
    }
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_MODULE_LOAD_SUCCESS, ast_sorcery_unref, and geoloc_sorcery.

Referenced by unload_module().

geoloc_datastore_duplicate()

static void * geoloc_datastore_duplicate ( void *  obj )

static

Definition at line 45 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *in_eds = obj;
    struct eprofiles_datastore *out_eds;
    int rc = 0;
    int i = 0;
    int eprofile_count = 0;
 
    out_eds = ast_calloc(1, sizeof(*out_eds));
    if (!out_eds) {
        return NULL;
    }
 
    rc = AST_VECTOR_INIT(&out_eds->eprofiles, 2);
    if (rc != 0) {
        ast_free(out_eds);
        return NULL;
    }
 
    eprofile_count = AST_VECTOR_SIZE(&in_eds->eprofiles);
    for (i = 0; i < eprofile_count; i++) {
        struct ast_geoloc_eprofile *ep = AST_VECTOR_GET(&in_eds->eprofiles, i);
        rc = AST_VECTOR_APPEND(&out_eds->eprofiles, ao2_bump(ep));
        if (rc != 0) {
            /* This will clean up the bumped reference to the eprofile */
            geoloc_datastore_free(out_eds);
            return NULL;
        }
    }
 
    return out_eds;
}

References ao2_bump, ast_calloc, ast_free, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, eprofiles_datastore::eprofiles, geoloc_datastore_free(), and NULL.

geoloc_datastore_free()

static void geoloc_datastore_free ( void *  obj )

static

Definition at line 36 of file geoloc_datastore.c.

{
    struct eprofiles_datastore *eds = obj;
 
    AST_VECTOR_RESET(&eds->eprofiles, ao2_cleanup);
    AST_VECTOR_FREE(&eds->eprofiles);
    ast_free(eds);
}

References ao2_cleanup, ast_free, AST_VECTOR_FREE, AST_VECTOR_RESET, and eprofiles_datastore::eprofiles.

Referenced by geoloc_datastore_duplicate().

Variable Documentation

geoloc_datastore_info

const struct ast_datastore_info geoloc_datastore_info

static

Initial value:

= {
    .type = GEOLOC_DS_TYPE,
    .destroy = geoloc_datastore_free,
    .duplicate = geoloc_datastore_duplicate,
}

Definition at line 78 of file geoloc_datastore.c.

                                                               {
    .type = GEOLOC_DS_TYPE,
    .destroy = geoloc_datastore_free,
    .duplicate = geoloc_datastore_duplicate,
};

Referenced by ast_geoloc_datastore_create(), and ast_geoloc_datastore_find().

geoloc_sorcery

struct ast_sorcery* geoloc_sorcery

Definition at line 29 of file geoloc_datastore.c.

Referenced by ast_geoloc_datastore_create_from_profile_name(), geoloc_channel_load(), and geoloc_channel_unload().