Asterisk - The Open Source Telephony Project GIT-master-8f1982c
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Modules Pages
Data Structures | Macros | Typedefs | Functions | Variables
cel.c File Reference

Channel Event Logging API. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/cel.h"
#include "asterisk/logger.h"
#include "asterisk/linkedlists.h"
#include "asterisk/utils.h"
#include "asterisk/config.h"
#include "asterisk/config_options.h"
#include "asterisk/cli.h"
#include "asterisk/astobj2.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_bridges.h"
#include "asterisk/bridge.h"
#include "asterisk/parking.h"
#include "asterisk/pickup.h"
#include "asterisk/core_local.h"
#include "asterisk/taskprocessor.h"
Include dependency graph for cel.c:

Go to the source code of this file.

Data Structures

struct  cel_backend
 
struct  cel_config
 A container that holds all config-related information. More...
 
struct  cel_dialstatus
 
struct  cel_linkedid
 

Macros

#define BACKEND_BUCKETS   13
 
#define CEL_MAX_EVENT_IDS   64
 Maximum possible CEL event IDs. More...
 
#define NUM_APP_BUCKETS   97
 Number of buckets for the appset container. More...
 
#define NUM_DIALSTATUS_BUCKETS   251
 Number of buckets for the dialstatus container. More...
 

Typedefs

typedef void(* cel_channel_snapshot_monitor) (struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
 Typedef for callbacks that get called on channel snapshot updates. More...
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static AO2_GLOBAL_OBJ_STATIC (cel_backends)
 
static AO2_GLOBAL_OBJ_STATIC (cel_configs)
 
static AO2_GLOBAL_OBJ_STATIC (cel_dialstatus_store)
 
static AO2_GLOBAL_OBJ_STATIC (cel_linkedids)
 
static int apps_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
 
int ast_cel_backend_register (const char *name, ast_cel_backend_cb backend_callback)
 Register a CEL backend. More...
 
int ast_cel_backend_unregister (const char *name)
 Unregister a CEL backend. More...
 
unsigned int ast_cel_check_enabled (void)
 Hashing function for cel_backend. More...
 
struct ast_eventast_cel_create_event (struct ast_channel_snapshot *snapshot, enum ast_cel_event_type event_type, const char *userdefevname, struct ast_json *extra, const char *peer)
 Allocate and populate a CEL event structure. More...
 
struct ast_eventast_cel_create_event_with_time (struct ast_channel_snapshot *snapshot, enum ast_cel_event_type event_type, const struct timeval *event_time, const char *userdefevname, struct ast_json *extra, const char *peer)
 Allocate and populate a CEL event structure. More...
 
struct ast_channelast_cel_fabricate_channel_from_event (const struct ast_event *event)
 Create a fake channel from data in a CEL event. More...
 
int ast_cel_fill_record (const struct ast_event *e, struct ast_cel_event_record *r)
 Fill in an ast_cel_event_record from a CEL event. More...
 
void * ast_cel_general_config_alloc (void)
 Allocate a CEL configuration object. More...
 
struct ast_cel_general_configast_cel_get_config (void)
 Obtain the current CEL configuration. More...
 
const char * ast_cel_get_type_name (enum ast_cel_event_type type)
 Get the name of a CEL event type. More...
 
void ast_cel_publish_event (struct ast_channel *chan, enum ast_cel_event_type event_type, struct ast_json *blob)
 Publish a CEL event. More...
 
void ast_cel_publish_user_event (struct ast_channel *chan, const char *event, const char *extra)
 Publish a CEL user event. More...
 
void ast_cel_set_config (struct ast_cel_general_config *config)
 Set the current CEL configuration. More...
 
enum ast_cel_event_type ast_cel_str_to_event_type (const char *name)
 Get the event type from a string. More...
 
struct stasis_topicast_cel_topic (void)
 Get the CEL topic. More...
 
static int ast_cel_track_event (enum ast_cel_event_type et)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static void cel_attended_transfer_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int cel_backend_send_cb (void *obj, void *arg, int flags)
 
static void cel_blind_transfer_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_bridge_enter_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_bridge_leave_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_channel_app_change (struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
 
static void cel_channel_linkedid_change (struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
 
static void cel_channel_state_change (struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
 Handle channel state changes. More...
 
static void * cel_config_alloc (void)
 
static void cel_config_dtor (void *obj)
 Destructor for cel_config. More...
 
static void cel_dial_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int cel_filter_channel_snapshot (struct ast_channel_snapshot *snapshot)
 
static void cel_general_config_dtor (void *obj)
 Destructor for cel_config. More...
 
static struct ast_strcel_generate_peer_str (struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *chan)
 
static void cel_generic_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
struct stasis_message_typecel_generic_type (void)
 
static int cel_linkedid_ref (const char *linkedid)
 
static void cel_local_optimization_begin_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_local_optimization_cb_helper (void *data, struct stasis_subscription *sub, struct stasis_message *message, enum ast_cel_event_type event_type)
 
static void cel_local_optimization_end_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_parking_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void cel_pickup_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int cel_pre_apply_config (void)
 
static int cel_report_event (struct ast_channel_snapshot *snapshot, enum ast_cel_event_type event_type, const struct timeval *event_time, const char *userdefevname, struct ast_json *extra, const char *peer_str)
 
static void cel_snapshot_update_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int cel_track_app (const char *const_app)
 
static void check_retire_linkedid (struct ast_channel_snapshot *snapshot, const struct timeval *event_time)
 
 CONFIG_INFO_CORE ("cel", cel_cfg_info, cel_configs, cel_config_alloc,.files=ACO_FILES(&cel_conf),.pre_apply_config=cel_pre_apply_config,)
 
static int create_routes (void)
 Create the Stasis message router and routes for CEL. More...
 
static int create_subscriptions (void)
 Create the Stasis subscriptions for CEL. More...
 
static void destroy_routes (void)
 
static void destroy_subscriptions (void)
 
static int events_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
 
static const char * get_blob_variable (struct ast_multi_channel_blob *blob, const char *varname)
 
static struct cel_dialstatusget_dialstatus (const char *uniqueid)
 
static char * handle_cli_status (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static int is_valid_dialstatus (struct ast_multi_channel_blob *blob)
 
static int load_module (void)
 
static int reload_module (void)
 
static void save_dialstatus (struct ast_multi_channel_blob *blob, struct ast_channel_snapshot *snapshot)
 
 STASIS_MESSAGE_TYPE_DEFN (cel_generic_type)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "CEL Engine" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CORE, .requires = "extconfig", }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct stasis_topiccel_aggregation_topic
 
static struct stasis_forwardcel_bridge_forwarder
 
static struct stasis_forwardcel_cel_forwarder
 
static struct stasis_forwardcel_channel_forwarder
 
cel_channel_snapshot_monitor cel_channel_monitors []
 Handlers for channel snapshot changes. More...
 
static struct aco_file cel_conf
 The config file to be processed for the module. More...
 
static const char *const cel_event_types [CEL_MAX_EVENT_IDS]
 Map of ast_cel_event_type to strings. More...
 
static struct stasis_forwardcel_parking_forwarder
 
static struct stasis_message_routercel_state_router
 
static struct stasis_topiccel_topic
 
static struct ast_cli_entry cli_status = { .handler = handle_cli_status , .summary = "Display the CEL status" ,}
 
static const struct ast_datastore_info fabricated_channel_datastore
 
static struct aco_type general_option
 An aco_type structure to link the "general" category to the ast_cel_general_config type. More...
 
static struct aco_typegeneral_options [] = ACO_TYPES(&general_option)
 
static const char * ignore_categories []
 
static struct aco_type ignore_option
 

Detailed Description

Channel Event Logging API.

Author
Steve Murphy murf@.nosp@m.digi.nosp@m.um.co.nosp@m.m
Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

Definition in file cel.c.

Macro Definition Documentation

◆ BACKEND_BUCKETS

#define BACKEND_BUCKETS   13

The number of buckets into which backend names will be hashed

Definition at line 157 of file cel.c.

◆ CEL_MAX_EVENT_IDS

#define CEL_MAX_EVENT_IDS   64

Maximum possible CEL event IDs.

Note
This limit is currently imposed by the eventset definition

Definition at line 166 of file cel.c.

◆ NUM_APP_BUCKETS

#define NUM_APP_BUCKETS   97

Number of buckets for the appset container.

Definition at line 171 of file cel.c.

◆ NUM_DIALSTATUS_BUCKETS

#define NUM_DIALSTATUS_BUCKETS   251

Number of buckets for the dialstatus container.

Definition at line 176 of file cel.c.

Typedef Documentation

◆ cel_channel_snapshot_monitor

typedef void(* cel_channel_snapshot_monitor) (struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)

Typedef for callbacks that get called on channel snapshot updates.

Definition at line 882 of file cel.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 1828 of file cel.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 1828 of file cel.c.

◆ AO2_GLOBAL_OBJ_STATIC() [1/4]

static AO2_GLOBAL_OBJ_STATIC ( cel_backends  )
static

Container for CEL backend information

◆ AO2_GLOBAL_OBJ_STATIC() [2/4]

static AO2_GLOBAL_OBJ_STATIC ( cel_configs  )
static

◆ AO2_GLOBAL_OBJ_STATIC() [3/4]

static AO2_GLOBAL_OBJ_STATIC ( cel_dialstatus_store  )
static

Container for dial end multichannel blobs for holding on to dial statuses

◆ AO2_GLOBAL_OBJ_STATIC() [4/4]

static AO2_GLOBAL_OBJ_STATIC ( cel_linkedids  )
static

Container of channel references to a linkedid for CEL purposes.

◆ apps_handler()

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

Definition at line 489 of file cel.c.

490{
491 struct ast_cel_general_config *cfg = obj;
492 char *apps = ast_strdupa(var->value);
493 char *cur_app;
494
495 while ((cur_app = strsep(&apps, ","))) {
496 cur_app = ast_strip(cur_app);
497 if (ast_strlen_zero(cur_app)) {
498 continue;
499 }
500
501 cur_app = ast_str_to_lower(cur_app);
502 ast_str_container_add(cfg->apps, cur_app);
503 }
504
505 return 0;
506}
#define var
Definition: ast_expr2f.c:605
char * strsep(char **str, const char *delims)
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
static force_inline char * ast_str_to_lower(char *str)
Convert a string to all lower-case.
Definition: strings.h:1321
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition: strings.h:223
int ast_str_container_add(struct ao2_container *str_container, const char *add)
Adds a string to a string container allocated by ast_str_container_alloc.
Definition: strings.c:205
Registered applications container.
Definition: pbx_app.c:68
A structure to hold CEL global configuration options.
Definition: cel.h:224
struct ao2_container * apps
Definition: cel.h:233

References ast_cel_general_config::apps, ast_str_container_add(), ast_str_to_lower(), ast_strdupa, ast_strip(), ast_strlen_zero(), strsep(), and var.

Referenced by load_module().

◆ ast_cel_backend_register()

int ast_cel_backend_register ( const char *  name,
ast_cel_backend_cb  backend_callback 
)

Register a CEL backend.

Parameters
nameName of backend to register
backend_callbackCallback to register
Return values
zeroon success
non-zeroon failure
Since
12

Definition at line 1798 of file cel.c.

1799{
1801 struct cel_backend *backend;
1802
1803 if (!backends || ast_strlen_zero(name) || !backend_callback) {
1804 return -1;
1805 }
1806
1807 /* The backend object is immutable so it doesn't need a lock of its own. */
1808 backend = ao2_alloc_options(sizeof(*backend) + 1 + strlen(name), NULL,
1810 if (!backend) {
1811 return -1;
1812 }
1813 strcpy(backend->name, name);/* Safe */
1814 backend->callback = backend_callback;
1815
1816 ao2_link(backends, backend);
1817 ao2_ref(backend, -1);
1818 return 0;
1819}
#define ao2_link(container, obj)
Add an object to a container.
Definition: astobj2.h:1532
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition: astobj2.h:367
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_global_obj_ref(holder)
Get a reference to the object stored in the global holder.
Definition: astobj2.h:918
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition: astobj2.h:404
static const char name[]
Definition: format_mp3.c:68
#define NULL
Definition: resample.c:96
Generic container type.
the list of registered channel types
Definition: channel.c:123
ast_cel_backend_cb callback
Definition: cel.c:344
char name[0]
Definition: cel.c:345
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_cleanup, ao2_global_obj_ref, ao2_link, ao2_ref, ast_strlen_zero(), cel_backend::callback, cel_backend::name, name, NULL, and RAII_VAR.

Referenced by load_config(), load_module(), my_load_module(), and test_cel_init_cb().

◆ ast_cel_backend_unregister()

int ast_cel_backend_unregister ( const char *  name)

Unregister a CEL backend.

Parameters
nameName of backend to unregister
Return values
zeroon success
non-zeroon failure
Since
12

Definition at line 1786 of file cel.c.

1787{
1788 struct ao2_container *backends = ao2_global_obj_ref(cel_backends);
1789
1790 if (backends) {
1792 ao2_ref(backends, -1);
1793 }
1794
1795 return 0;
1796}
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1736
@ OBJ_NODATA
Definition: astobj2.h:1044
@ OBJ_UNLINK
Definition: astobj2.h:1039
@ OBJ_SEARCH_KEY
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101

References ao2_find, ao2_global_obj_ref, ao2_ref, name, OBJ_NODATA, OBJ_SEARCH_KEY, and OBJ_UNLINK.

Referenced by cel_verify_and_cleanup_cb(), load_config(), my_unload_module(), tds_unload_module(), and unload_module().

◆ ast_cel_check_enabled()

unsigned int ast_cel_check_enabled ( void  )

Hashing function for cel_backend.

Check to see if CEL is enabled.

Comparator function for cel_backend

Hashing function for dialstatus container

Comparator function for dialstatus container

Definition at line 360 of file cel.c.

361{
362 unsigned int enabled;
363 struct cel_config *cfg = ao2_global_obj_ref(cel_configs);
364
365 enabled = (!cfg || !cfg->general) ? 0 : cfg->general->enable;
366 ao2_cleanup(cfg);
367 return enabled;
368}
static int enabled
Definition: dnsmgr.c:91
A container that holds all config-related information.
Definition: cel_custom.c:52
struct ast_cel_general_config * general
Definition: cel.c:226

References ao2_cleanup, ao2_global_obj_ref, ast_cel_general_config::enable, enabled, and cel_config::general.

Referenced by ast_cel_set_config(), handle_cli_status(), load_module(), and reload_module().

◆ ast_cel_create_event()

struct ast_event * ast_cel_create_event ( struct ast_channel_snapshot snapshot,
enum ast_cel_event_type  event_type,
const char *  userdefevname,
struct ast_json extra,
const char *  peer_str 
)

Allocate and populate a CEL event structure.

Parameters
snapshotAn ast_channel_snapshot of the primary channel associated with this channel event.
event_typeThe type of call event being reported.
userdefevnameCustom name for the call event. (optional)
extraAn event-specific opaque JSON blob to be rendered and placed in the "CEL_EXTRA" information element of the call event. (optional)
peer_strA list of comma-separated peer channel names. (optional)
Since
12
Return values
Thecreated ast_event structure
NULLon failure

Definition at line 534 of file cel.c.

537{
538 struct timeval eventtime = ast_tvnow();
539
540 return ast_cel_create_event_with_time(snapshot, event_type, &eventtime,
541 userdefevname, extra, peer);
542}
struct ast_event * ast_cel_create_event_with_time(struct ast_channel_snapshot *snapshot, enum ast_cel_event_type event_type, const struct timeval *event_time, const char *userdefevname, struct ast_json *extra, const char *peer)
Allocate and populate a CEL event structure.
Definition: cel.c:544
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159

References ast_cel_create_event_with_time(), and ast_tvnow().

Referenced by append_expected_event_snapshot().

◆ ast_cel_create_event_with_time()

struct ast_event * ast_cel_create_event_with_time ( struct ast_channel_snapshot snapshot,
enum ast_cel_event_type  event_type,
const struct timeval *  event_time,
const char *  userdefevname,
struct ast_json extra,
const char *  peer_str 
)

Allocate and populate a CEL event structure.

Parameters
snapshotAn ast_channel_snapshot of the primary channel associated with this channel event.
event_typeThe type of call event being reported.
event_timeThe time at which the event occurred.
userdefevnameCustom name for the call event. (optional)
extraAn event-specific opaque JSON blob to be rendered and placed in the "CEL_EXTRA" information element of the call event. (optional)
peer_strA list of comma-separated peer channel names. (optional)
Since
13.29.0
16.6.0
Return values
Thecreated ast_event structure
NULLon failure

Definition at line 544 of file cel.c.

547{
548 RAII_VAR(char *, extra_txt, NULL, ast_json_free);
549 if (extra) {
550 extra_txt = ast_json_dump_string(extra);
551 }
577}
struct ast_event * ast_event_new(enum ast_event_type event_type,...)
Create a new event.
Definition: event.c:403
@ AST_EVENT_IE_CEL_ACCTCODE
Channel Event AccountCode Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:205
@ AST_EVENT_IE_END
Definition: event_defs.h:70
@ AST_EVENT_IE_CEL_EXTRA
Channel Event extra data Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:259
@ AST_EVENT_IE_CEL_CONTEXT
Channel Event context name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:175
@ AST_EVENT_IE_CEL_PEERACCT
Channel Event peeraccount Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:253
@ AST_EVENT_IE_CEL_CIDRDNIS
Channel Event CID RDNIS field Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:229
@ AST_EVENT_IE_CEL_EVENT_TIME
Channel Event Time (seconds) Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:139
@ AST_EVENT_IE_CEL_CHANNAME
Channel Event channel name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:181
@ AST_EVENT_IE_CEL_CIDANI
Channel Event CID ANI field Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:223
@ AST_EVENT_IE_CEL_CIDDNID
Channel Event CID dnid Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:235
@ AST_EVENT_IE_CEL_EXTEN
Channel Event extension name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:169
@ AST_EVENT_IE_CEL_CIDNAME
Channel Event CID name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:157
@ AST_EVENT_IE_CEL_AMAFLAGS
Channel Event AMA flags Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:199
@ AST_EVENT_IE_CEL_USEREVENT_NAME
Channel Event User Event Name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:151
@ AST_EVENT_IE_CEL_TENANTID
Channel Event TenantID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:320
@ AST_EVENT_IE_CEL_LINKEDID
Channel Event LinkedID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:247
@ AST_EVENT_IE_CEL_EVENT_TIME_USEC
Channel Event Time (micro-seconds) Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:145
@ AST_EVENT_IE_CEL_EVENT_TYPE
Channel Event Type Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:133
@ AST_EVENT_IE_CEL_UNIQUEID
Channel Event UniqueID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:211
@ AST_EVENT_IE_CEL_APPNAME
Channel Event app name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:187
@ AST_EVENT_IE_CEL_APPDATA
Channel Event app args/data Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:193
@ AST_EVENT_IE_CEL_PEER
Channel Event Peer – for Things involving multiple channels, like BRIDGE Used by: AST_EVENT_CEL Paylo...
Definition: event_defs.h:241
@ AST_EVENT_IE_CEL_CIDNUM
Channel Event CID num Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:163
@ AST_EVENT_IE_CEL_USERFIELD
Channel Event Userfield Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:217
@ AST_EVENT_CEL
Definition: event_defs.h:50
@ AST_EVENT_IE_PLTYPE_UINT
Definition: event_defs.h:333
@ AST_EVENT_IE_PLTYPE_STR
Definition: event_defs.h:335
void ast_json_free(void *p)
Asterisk's custom JSON allocator. Exposed for use by unit tests.
Definition: json.c:52
#define ast_json_dump_string(root)
Encode a JSON value to a compact string.
Definition: json.h:810
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
const ast_string_field tenantid
const ast_string_field accountcode
const ast_string_field userfield
const ast_string_field uniqueid
const ast_string_field name
const ast_string_field number
const ast_string_field rdnis
const ast_string_field ani
const ast_string_field name
const ast_string_field dnid
const ast_string_field data
const ast_string_field context
const ast_string_field exten
const ast_string_field appl
struct ast_channel_snapshot_dialplan * dialplan
struct ast_channel_snapshot_peer * peer
struct ast_channel_snapshot_base * base
struct ast_channel_snapshot_caller * caller

References ast_channel_snapshot_peer::account, ast_channel_snapshot_base::accountcode, ast_channel_snapshot::amaflags, ast_channel_snapshot_caller::ani, ast_channel_snapshot_dialplan::appl, AST_EVENT_CEL, AST_EVENT_IE_CEL_ACCTCODE, AST_EVENT_IE_CEL_AMAFLAGS, AST_EVENT_IE_CEL_APPDATA, AST_EVENT_IE_CEL_APPNAME, AST_EVENT_IE_CEL_CHANNAME, AST_EVENT_IE_CEL_CIDANI, AST_EVENT_IE_CEL_CIDDNID, AST_EVENT_IE_CEL_CIDNAME, AST_EVENT_IE_CEL_CIDNUM, AST_EVENT_IE_CEL_CIDRDNIS, AST_EVENT_IE_CEL_CONTEXT, AST_EVENT_IE_CEL_EVENT_TIME, AST_EVENT_IE_CEL_EVENT_TIME_USEC, AST_EVENT_IE_CEL_EVENT_TYPE, AST_EVENT_IE_CEL_EXTEN, AST_EVENT_IE_CEL_EXTRA, AST_EVENT_IE_CEL_LINKEDID, AST_EVENT_IE_CEL_PEER, AST_EVENT_IE_CEL_PEERACCT, AST_EVENT_IE_CEL_TENANTID, AST_EVENT_IE_CEL_UNIQUEID, AST_EVENT_IE_CEL_USEREVENT_NAME, AST_EVENT_IE_CEL_USERFIELD, AST_EVENT_IE_END, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, ast_event_new(), ast_json_dump_string, ast_json_free(), ast_channel_snapshot::base, ast_channel_snapshot::caller, ast_channel_snapshot_dialplan::context, ast_channel_snapshot_dialplan::data, ast_channel_snapshot::dialplan, ast_channel_snapshot_caller::dnid, ast_channel_snapshot_dialplan::exten, ast_channel_snapshot_peer::linkedid, ast_channel_snapshot_caller::name, ast_channel_snapshot_base::name, NULL, ast_channel_snapshot_caller::number, ast_channel_snapshot::peer, RAII_VAR, ast_channel_snapshot_caller::rdnis, S_OR, ast_channel_snapshot_base::tenantid, ast_channel_snapshot_base::uniqueid, and ast_channel_snapshot_base::userfield.

Referenced by ast_cel_create_event(), and cel_report_event().

◆ ast_cel_fabricate_channel_from_event()

struct ast_channel * ast_cel_fabricate_channel_from_event ( const struct ast_event event)

Create a fake channel from data in a CEL event.

Note
This function creates a fake channel containing the serialized channel data in the given cel event. It should be released with ast_channel_unref() but could be released with ast_channel_release().
Parameters
eventthe CEL event
Since
1.8
Returns
a channel with the data filled in, or NULL on error
Todo:
This function is very expensive, especially given that some CEL backends use it on every CEL event. This function really needs to go away at some point.

Definition at line 678 of file cel.c.

679{
680 struct varshead *headp;
681 struct ast_var_t *newvariable;
682 const char *mixed_name;
683 char timebuf[30];
684 struct ast_channel *tchan;
685 struct ast_cel_event_record record = {
687 };
688 struct ast_datastore *datastore;
689 char *app_data;
690 RAII_VAR(struct cel_config *, cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
691
692 if (!cfg || !cfg->general) {
693 return NULL;
694 }
695
696 /* do not call ast_channel_alloc because this is not really a real channel */
697 if (!(tchan = ast_dummy_channel_alloc())) {
698 return NULL;
699 }
700
701 headp = ast_channel_varshead(tchan);
702
703 /* first, get the variables from the event */
704 if (ast_cel_fill_record(event, &record)) {
705 ast_channel_unref(tchan);
706 return NULL;
707 }
708
709 /* next, fill the channel with their data */
710 mixed_name = (record.event_type == AST_CEL_USER_DEFINED)
711 ? record.user_defined_name : record.event_name;
712 if ((newvariable = ast_var_assign("eventtype", mixed_name))) {
713 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
714 }
715
716 if (ast_strlen_zero(cfg->general->date_format)) {
717 snprintf(timebuf, sizeof(timebuf), "%ld.%06ld", (long) record.event_time.tv_sec,
718 (long) record.event_time.tv_usec);
719 } else {
720 struct ast_tm tm;
721 ast_localtime(&record.event_time, &tm, NULL);
722 ast_strftime(timebuf, sizeof(timebuf), cfg->general->date_format, &tm);
723 }
724
725 if ((newvariable = ast_var_assign("eventtime", timebuf))) {
726 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
727 }
728
729 if ((newvariable = ast_var_assign("eventenum", record.event_name))) {
730 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
731 }
732 if ((newvariable = ast_var_assign("userdeftype", record.user_defined_name))) {
733 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
734 }
735 if ((newvariable = ast_var_assign("eventextra", record.extra))) {
736 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
737 }
738
739 ast_channel_caller(tchan)->id.name.valid = 1;
741 ast_channel_caller(tchan)->id.number.valid = 1;
748
749 ast_channel_exten_set(tchan, record.extension);
750 ast_channel_context_set(tchan, record.context);
751 ast_channel_name_set(tchan, record.channel_name);
753 ast_channel_accountcode_set(tchan, record.account_code);
754 ast_channel_peeraccount_set(tchan, record.peer_account);
755 ast_channel_userfield_set(tchan, record.user_field);
756
757 if ((newvariable = ast_var_assign("BRIDGEPEER", record.peer))) {
758 AST_LIST_INSERT_HEAD(headp, newvariable, entries);
759 }
760
761 ast_channel_amaflags_set(tchan, record.amaflag);
762
763 /* We need to store an 'application name' and 'application
764 * data' on the channel for logging purposes, but the channel
765 * structure only provides a place to store pointers, and it
766 * expects these pointers to be pointing to data that does not
767 * need to be freed. This means that the channel's destructor
768 * does not attempt to free any storage that these pointers
769 * point to. However, we can't provide data in that form directly for
770 * these structure members. In order to ensure that these data
771 * elements have a lifetime that matches the channel's
772 * lifetime, we'll put them in a datastore attached to the
773 * channel, and set's the channel's pointers to point into the
774 * datastore. The datastore will then be automatically destroyed
775 * when the channel is destroyed.
776 */
777
779 ast_channel_unref(tchan);
780 return NULL;
781 }
782
783 if (!(app_data = ast_malloc(strlen(record.application_name) + strlen(record.application_data) + 2))) {
784 ast_datastore_free(datastore);
785 ast_channel_unref(tchan);
786 return NULL;
787 }
788
789 ast_channel_appl_set(tchan, strcpy(app_data, record.application_name));
790 ast_channel_data_set(tchan, strcpy(app_data + strlen(record.application_name) + 1,
791 record.application_data));
792
793 datastore->data = app_data;
794 ast_channel_datastore_add(tchan, datastore);
795
796 return tchan;
797}
if(!yyg->yy_init)
Definition: ast_expr2f.c:854
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
int ast_cel_fill_record(const struct ast_event *e, struct ast_cel_event_record *r)
Fill in an ast_cel_event_record from a CEL event.
Definition: cel.c:837
static const struct ast_datastore_info fabricated_channel_datastore
Definition: cel.c:673
@ AST_CEL_USER_DEFINED
a user-defined event, the event name field should be set
Definition: cel.h:69
#define AST_CEL_EVENT_RECORD_VERSION
struct ABI version
Definition: cel.h:143
void ast_channel_exten_set(struct ast_channel *chan, const char *value)
void ast_channel_appl_set(struct ast_channel *chan, const char *value)
void ast_channel_internal_set_fake_ids(struct ast_channel *chan, const char *uniqueid, const char *linkedid)
Set uniqueid and linkedid string value only (not time)
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2354
struct varshead * ast_channel_varshead(struct ast_channel *chan)
void ast_channel_data_set(struct ast_channel *chan, const char *value)
struct ast_party_redirecting * ast_channel_redirecting(struct ast_channel *chan)
struct ast_party_dialed * ast_channel_dialed(struct ast_channel *chan)
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:3008
void ast_channel_amaflags_set(struct ast_channel *chan, enum ama_flags value)
void ast_channel_context_set(struct ast_channel *chan, const char *value)
#define ast_dummy_channel_alloc()
Create a fake channel structure.
Definition: channel.h:1328
struct ast_party_caller * ast_channel_caller(struct ast_channel *chan)
void ast_channel_name_set(struct ast_channel *chan, const char *value)
#define ast_var_assign(name, value)
Definition: chanvars.h:40
#define ast_datastore_alloc(info, uid)
Definition: datastore.h:85
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:68
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
Definition: linkedlists.h:711
struct ast_tm * ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone)
Timezone-independent version of localtime_r(3).
Definition: localtime.c:1739
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm)
Special version of strftime(3) that handles fractions of a second. Takes the same arguments as strfti...
Definition: localtime.c:2524
Helper struct for getting the fields out of a CEL event.
Definition: cel.h:138
const char * caller_id_dnid
Definition: cel.h:157
const char * application_data
Definition: cel.h:162
const char * account_code
Definition: cel.h:163
const char * caller_id_rdnis
Definition: cel.h:156
const char * extra
Definition: cel.h:171
const char * extension
Definition: cel.h:158
const char * caller_id_num
Definition: cel.h:154
const char * channel_name
Definition: cel.h:160
const char * linked_id
Definition: cel.h:166
const char * peer_account
Definition: cel.h:164
const char * peer
Definition: cel.h:170
enum ast_cel_event_type event_type
Definition: cel.h:149
const char * unique_id
Definition: cel.h:165
const char * user_defined_name
Definition: cel.h:152
const char * context
Definition: cel.h:159
const char * application_name
Definition: cel.h:161
struct timeval event_time
Definition: cel.h:150
uint32_t version
struct ABI version
Definition: cel.h:148
const char * user_field
Definition: cel.h:169
const char * caller_id_ani
Definition: cel.h:155
const char * caller_id_name
Definition: cel.h:153
const char * event_name
Definition: cel.h:151
Main Channel structure associated with a channel.
Structure for a data store object.
Definition: datastore.h:64
void * data
Definition: datastore.h:66
struct ast_party_id id
Caller party ID.
Definition: channel.h:422
struct ast_party_id ani
Automatic Number Identification (ANI)
Definition: channel.h:429
struct ast_party_dialed::@210 number
Dialed/Called number.
char * str
Subscriber phone number (Malloced)
Definition: channel.h:388
struct ast_party_name name
Subscriber name.
Definition: channel.h:342
struct ast_party_number number
Subscriber phone number.
Definition: channel.h:344
unsigned char valid
TRUE if the name information is valid/present.
Definition: channel.h:281
char * str
Subscriber name (Malloced)
Definition: channel.h:266
unsigned char valid
TRUE if the number information is valid/present.
Definition: channel.h:299
char * str
Subscriber phone number (Malloced)
Definition: channel.h:293
struct ast_party_id from
Who is redirecting the call (Sent to the party the call is redirected toward)
Definition: channel.h:529
Definition: astman.c:222

References ast_cel_event_record::account_code, ast_cel_event_record::amaflag, ast_party_caller::ani, ao2_cleanup, ao2_global_obj_ref, ast_cel_event_record::application_data, ast_cel_event_record::application_name, AST_CEL_EVENT_RECORD_VERSION, ast_cel_fill_record(), AST_CEL_USER_DEFINED, ast_channel_amaflags_set(), ast_channel_appl_set(), ast_channel_caller(), ast_channel_context_set(), ast_channel_data_set(), ast_channel_datastore_add(), ast_channel_dialed(), ast_channel_exten_set(), ast_channel_internal_set_fake_ids(), ast_channel_name_set(), ast_channel_redirecting(), ast_channel_unref, ast_channel_varshead(), ast_datastore_alloc, ast_datastore_free(), ast_dummy_channel_alloc, AST_LIST_INSERT_HEAD, ast_localtime(), ast_malloc, ast_strdup, ast_strftime(), ast_strlen_zero(), ast_var_assign, ast_cel_event_record::caller_id_ani, ast_cel_event_record::caller_id_dnid, ast_cel_event_record::caller_id_name, ast_cel_event_record::caller_id_num, ast_cel_event_record::caller_id_rdnis, ast_cel_event_record::channel_name, ast_cel_event_record::context, ast_datastore::data, ast_cel_event_record::event_name, ast_cel_event_record::event_time, ast_cel_event_record::event_type, ast_cel_event_record::extension, ast_cel_event_record::extra, fabricated_channel_datastore, ast_party_redirecting::from, ast_party_caller::id, if(), ast_cel_event_record::linked_id, ast_party_id::name, NULL, ast_party_id::number, ast_party_dialed::number, ast_cel_event_record::peer, ast_cel_event_record::peer_account, RAII_VAR, ast_party_name::str, ast_party_number::str, ast_party_dialed::str, ast_cel_event_record::unique_id, ast_cel_event_record::user_defined_name, ast_cel_event_record::user_field, ast_party_name::valid, ast_party_number::valid, and ast_cel_event_record::version.

Referenced by custom_log(), and write_cel().

◆ ast_cel_fill_record()

int ast_cel_fill_record ( const struct ast_event event,
struct ast_cel_event_record r 
)

Fill in an ast_cel_event_record from a CEL event.

Parameters
[in]eventthe CEL event
[out]rthe ast_cel_event_record to fill in
Since
1.8
Return values
0success
non-zerofailure

Definition at line 837 of file cel.c.

838{
840 ast_log(LOG_ERROR, "Module ABI mismatch for ast_cel_event_record. "
841 "Please ensure all modules were compiled for "
842 "this version of Asterisk.\n");
843 return -1;
844 }
845
847
850
854 } else {
855 r->user_defined_name = "";
856 }
857
877
878 return 0;
879}
#define ast_log
Definition: astobj2.c:42
const char * ast_cel_get_type_name(enum ast_cel_event_type type)
Get the name of a CEL event type.
Definition: cel.c:508
uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
Get the value of an information element that has an integer payload.
Definition: event.c:294
const char * ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
Get the value of an information element that has a string payload.
Definition: event.c:303
#define LOG_ERROR
const char * tenant_id
Definition: cel.h:167

References ast_cel_event_record::account_code, ast_cel_event_record::amaflag, ast_cel_event_record::application_data, ast_cel_event_record::application_name, AST_CEL_EVENT_RECORD_VERSION, ast_cel_get_type_name(), AST_CEL_USER_DEFINED, ast_event_get_ie_str(), ast_event_get_ie_uint(), AST_EVENT_IE_CEL_ACCTCODE, AST_EVENT_IE_CEL_AMAFLAGS, AST_EVENT_IE_CEL_APPDATA, AST_EVENT_IE_CEL_APPNAME, AST_EVENT_IE_CEL_CHANNAME, AST_EVENT_IE_CEL_CIDANI, AST_EVENT_IE_CEL_CIDDNID, AST_EVENT_IE_CEL_CIDNAME, AST_EVENT_IE_CEL_CIDNUM, AST_EVENT_IE_CEL_CIDRDNIS, AST_EVENT_IE_CEL_CONTEXT, AST_EVENT_IE_CEL_EVENT_TIME, AST_EVENT_IE_CEL_EVENT_TIME_USEC, AST_EVENT_IE_CEL_EVENT_TYPE, AST_EVENT_IE_CEL_EXTEN, AST_EVENT_IE_CEL_EXTRA, AST_EVENT_IE_CEL_LINKEDID, AST_EVENT_IE_CEL_PEER, AST_EVENT_IE_CEL_PEERACCT, AST_EVENT_IE_CEL_TENANTID, AST_EVENT_IE_CEL_UNIQUEID, AST_EVENT_IE_CEL_USEREVENT_NAME, AST_EVENT_IE_CEL_USERFIELD, ast_log, ast_cel_event_record::caller_id_ani, ast_cel_event_record::caller_id_dnid, ast_cel_event_record::caller_id_name, ast_cel_event_record::caller_id_num, ast_cel_event_record::caller_id_rdnis, ast_cel_event_record::channel_name, ast_cel_event_record::context, ast_cel_event_record::event_name, ast_cel_event_record::event_time, ast_cel_event_record::event_type, ast_cel_event_record::extension, ast_cel_event_record::extra, ast_cel_event_record::linked_id, LOG_ERROR, ast_cel_event_record::peer, ast_cel_event_record::peer_account, S_OR, ast_cel_event_record::tenant_id, ast_cel_event_record::unique_id, ast_cel_event_record::user_defined_name, ast_cel_event_record::user_field, and ast_cel_event_record::version.

Referenced by ast_cel_fabricate_channel_from_event(), cel_bs_put(), manager_log(), odbc_log(), pgsql_log(), radius_log(), and tds_log().

◆ ast_cel_general_config_alloc()

void * ast_cel_general_config_alloc ( void  )

Allocate a CEL configuration object.

Return values
NULLon error
Thenew CEL configuration object

Definition at line 204 of file cel.c.

205{
207
208 if (!(cfg = ao2_alloc(sizeof(*cfg), cel_general_config_dtor))) {
209 return NULL;
210 }
211
212 if (ast_string_field_init(cfg, 64)) {
213 return NULL;
214 }
215
216 if (!(cfg->apps = ast_str_container_alloc(NUM_APP_BUCKETS))) {
217 return NULL;
218 }
219
220 ao2_ref(cfg, +1);
221 return cfg;
222}
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:409
static void cel_general_config_dtor(void *obj)
Destructor for cel_config.
Definition: cel.c:196
#define NUM_APP_BUCKETS
Number of buckets for the appset container.
Definition: cel.c:171
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:359
#define ast_str_container_alloc(buckets)
Allocates a hash container for bare strings.
Definition: strings.h:1365

References ao2_alloc, ao2_cleanup, ao2_ref, ast_str_container_alloc, ast_string_field_init, cel_general_config_dtor(), NULL, NUM_APP_BUCKETS, and RAII_VAR.

Referenced by cel_config_alloc(), and load_module().

◆ ast_cel_get_config()

struct ast_cel_general_config * ast_cel_get_config ( void  )

Obtain the current CEL configuration.

Since
12

The configuration is a ref counted object. The caller of this function must decrement the ref count when finished with the configuration.

Return values
NULLon error
Thecurrent CEL configuration

Definition at line 1748 of file cel.c.

1749{
1750 RAII_VAR(struct cel_config *, mod_cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
1751
1752 if (!mod_cfg || !mod_cfg->general) {
1753 return NULL;
1754 }
1755
1756 ao2_ref(mod_cfg->general, +1);
1757 return mod_cfg->general;
1758}

References ao2_cleanup, ao2_global_obj_ref, ao2_ref, NULL, and RAII_VAR.

Referenced by test_cel_init_cb().

◆ ast_cel_get_type_name()

const char * ast_cel_get_type_name ( enum ast_cel_event_type  type)

Get the name of a CEL event type.

Parameters
typethe type to get the name of
Since
1.8
Returns
the string representation of the type

Definition at line 508 of file cel.c.

509{
510 return S_OR(cel_event_types[type], "Unknown");
511}
static const char *const cel_event_types[CEL_MAX_EVENT_IDS]
Map of ast_cel_event_type to strings.
Definition: cel.c:321
static const char type[]
Definition: chan_ooh323.c:109

References cel_event_types, S_OR, and type.

Referenced by ast_cel_fill_record(), cel_generic_cb(), dump_event(), and handle_cli_status().

◆ ast_cel_publish_event()

void ast_cel_publish_event ( struct ast_channel chan,
enum ast_cel_event_type  event_type,
struct ast_json blob 
)

Publish a CEL event.

Since
12
Parameters
chanThis is the primary channel associated with this channel event.
event_typeThis is the type of call event being reported.
blobThis contains any additional parameters that need to be conveyed for this event.

Definition at line 1724 of file cel.c.

1727{
1728 struct ast_json *cel_blob;
1729 struct stasis_message *message;
1730
1731 cel_blob = ast_json_pack("{s: i, s: o}",
1732 "event_type", event_type,
1733 "event_details", ast_json_ref(blob));
1734
1736 if (message) {
1738 }
1740 ast_json_unref(cel_blob);
1741}
struct stasis_topic * ast_cel_topic(void)
Get the CEL topic.
Definition: cel.c:1743
struct stasis_message_type * cel_generic_type(void)
const char * ast_channel_uniqueid(const struct ast_channel *chan)
struct stasis_message * ast_channel_blob_create_from_cache(const char *uniqueid, struct stasis_message_type *type, struct ast_json *blob)
Create a ast_channel_blob message, pulling channel state from the cache.
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition: json.c:612
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition: json.c:67
void stasis_publish(struct stasis_topic *topic, struct stasis_message *message)
Publish a message to a topic's subscribers.
Definition: stasis.c:1538
Abstract JSON element (object, array, string, int, ...).

References ao2_cleanup, ast_cel_topic(), ast_channel_blob_create_from_cache(), ast_channel_uniqueid(), ast_json_pack(), ast_json_ref(), ast_json_unref(), cel_generic_type(), and stasis_publish().

Referenced by ast_cel_publish_user_event(), and celgenuserevent_exec().

◆ ast_cel_publish_user_event()

void ast_cel_publish_user_event ( struct ast_channel chan,
const char *  event,
const char *  extra 
)

Publish a CEL user event.

Since
18
Note
This serves as a wrapper function around ast_cel_publish_event() to help pack the extra details before publishing.
Parameters
chanThis is the primary channel associated with this channel event.
eventThis is the user event being reported.
extraThis contains any extra parameters that need to be conveyed for this event.

Definition at line 1709 of file cel.c.

1712{
1713 RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1714
1715 blob = ast_json_pack("{s: s, s: {s: s}}",
1716 "event", event,
1717 "extra", "extra", S_OR(extra, ""));
1718 if (!blob) {
1719 return;
1720 }
1722}
void ast_cel_publish_event(struct ast_channel *chan, enum ast_cel_event_type event_type, struct ast_json *blob)
Publish a CEL event.
Definition: cel.c:1724

References ast_cel_publish_event(), AST_CEL_USER_DEFINED, ast_json_pack(), ast_json_unref(), NULL, RAII_VAR, and S_OR.

◆ ast_cel_set_config()

void ast_cel_set_config ( struct ast_cel_general_config config)

Set the current CEL configuration.

Since
12
Parameters
configThe new CEL configuration

Definition at line 1760 of file cel.c.

1761{
1762 int was_enabled;
1763 int is_enabled;
1764 struct ast_cel_general_config *cleanup_config;
1765 struct cel_config *mod_cfg = ao2_global_obj_ref(cel_configs);
1766
1767 if (mod_cfg) {
1768 was_enabled = ast_cel_check_enabled();
1769
1770 cleanup_config = mod_cfg->general;
1772 mod_cfg->general = config;
1773 ao2_cleanup(cleanup_config);
1774
1776 if (!was_enabled && is_enabled) {
1777 create_routes();
1778 } else if (was_enabled && !is_enabled) {
1780 }
1781
1782 ao2_ref(mod_cfg, -1);
1783 }
1784}
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
static void destroy_routes(void)
Definition: cel.c:1454
static int create_routes(void)
Create the Stasis message router and routes for CEL.
Definition: cel.c:1538
unsigned int ast_cel_check_enabled(void)
Hashing function for cel_backend.
Definition: cel.c:360
static const char config[]
Definition: chan_ooh323.c:111
static int is_enabled(void)
Helper function to check if module is enabled.
Definition: res_ari.c:203

References ao2_bump, ao2_cleanup, ao2_global_obj_ref, ao2_ref, ast_cel_check_enabled(), config, create_routes(), destroy_routes(), cel_config::general, and is_enabled().

Referenced by cel_verify_and_cleanup_cb(), and test_cel_init_cb().

◆ ast_cel_str_to_event_type()

enum ast_cel_event_type ast_cel_str_to_event_type ( const char *  name)

Get the event type from a string.

Parameters
namethe event type name as a string
Since
1.8
Returns
the ast_cel_event_type given by the string

Definition at line 435 of file cel.c.

436{
437 unsigned int i;
438
439 for (i = 0; i < ARRAY_LEN(cel_event_types); i++) {
440 if (cel_event_types[i] && !strcasecmp(name, cel_event_types[i])) {
441 return i;
442 }
443 }
444
445 ast_log(LOG_ERROR, "Unknown event name '%s'\n", name);
447}
@ AST_CEL_INVALID_VALUE
Definition: cel.h:42
#define ARRAY_LEN(a)
Definition: utils.h:666

References ARRAY_LEN, AST_CEL_INVALID_VALUE, ast_log, cel_event_types, LOG_ERROR, and name.

Referenced by events_handler().

◆ ast_cel_topic()

struct stasis_topic * ast_cel_topic ( void  )

Get the CEL topic.

Return values
TheCEL topic
NULLif not allocated

Definition at line 1743 of file cel.c.

1744{
1745 return cel_topic;
1746}
static struct stasis_topic * cel_topic
Definition: cel.c:133

References cel_topic.

Referenced by ast_cel_publish_event(), and create_subscriptions().

◆ ast_cel_track_event()

static int ast_cel_track_event ( enum ast_cel_event_type  et)
static

Definition at line 449 of file cel.c.

450{
451 RAII_VAR(struct cel_config *, cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
452
453 if (!cfg || !cfg->general) {
454 return 0;
455 }
456
457 return (cfg->general->events & ((int64_t) 1 << et)) ? 1 : 0;
458}

References ao2_cleanup, ao2_global_obj_ref, and RAII_VAR.

Referenced by cel_channel_linkedid_change(), cel_channel_state_change(), and cel_report_event().

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 1828 of file cel.c.

◆ cel_attended_transfer_cb()

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

Definition at line 1324 of file cel.c.

1327{
1329 struct ast_json *extra = NULL;
1330 struct ast_bridge_snapshot *bridge1, *bridge2;
1331 struct ast_channel_snapshot *channel1, *channel2;
1332
1333 /* Make sure bridge1 is always non-NULL */
1334 if (!xfer->to_transferee.bridge_snapshot) {
1335 bridge1 = xfer->to_transfer_target.bridge_snapshot;
1336 bridge2 = xfer->to_transferee.bridge_snapshot;
1337 channel1 = xfer->to_transfer_target.channel_snapshot;
1338 channel2 = xfer->to_transferee.channel_snapshot;
1339 } else {
1340 bridge1 = xfer->to_transferee.bridge_snapshot;
1341 bridge2 = xfer->to_transfer_target.bridge_snapshot;
1342 channel1 = xfer->to_transferee.channel_snapshot;
1343 channel2 = xfer->to_transfer_target.channel_snapshot;
1344 }
1345
1346 switch (xfer->dest_type) {
1348 return;
1349 /* handle these three the same */
1353 extra = ast_json_pack("{s: s, s: s, s: s, s: s, s: s, s: s, s: s, s: s}",
1354 "bridge1_id", bridge1->uniqueid,
1355 "channel2_name", channel2->base->name,
1356 "channel2_uniqueid", channel2->base->uniqueid,
1357 "bridge2_id", bridge2->uniqueid,
1358 "transferee_channel_name", xfer->transferee ? xfer->transferee->base->name : "N/A",
1359 "transferee_channel_uniqueid", xfer->transferee ? xfer->transferee->base->uniqueid : "N/A",
1360 "transfer_target_channel_name", xfer->target ? xfer->target->base->name : "N/A",
1361 "transfer_target_channel_uniqueid", xfer->target ? xfer->target->base->uniqueid : "N/A");
1362 if (!extra) {
1363 return;
1364 }
1365 break;
1368 extra = ast_json_pack("{s: s, s: s, s: s, s: s, s: s, s: s, s: s, s: s}",
1369 "bridge1_id", bridge1->uniqueid,
1370 "channel2_name", channel2->base->name,
1371 "channel2_uniqueid", channel2->base->uniqueid,
1372 "app", xfer->dest.app,
1373 "transferee_channel_name", xfer->transferee ? xfer->transferee->base->name : "N/A",
1374 "transferee_channel_uniqueid", xfer->transferee ? xfer->transferee->base->uniqueid : "N/A",
1375 "transfer_target_channel_name", xfer->target ? xfer->target->base->name : "N/A",
1376 "transfer_target_channel_uniqueid", xfer->target ? xfer->target->base->uniqueid : "N/A");
1377 if (!extra) {
1378 return;
1379 }
1380 break;
1381 }
1383 NULL, extra, NULL);
1384 ast_json_unref(extra);
1385}
static int cel_report_event(struct ast_channel_snapshot *snapshot, enum ast_cel_event_type event_type, const struct timeval *event_time, const char *userdefevname, struct ast_json *extra, const char *peer_str)
Definition: cel.c:587
@ AST_CEL_ATTENDEDTRANSFER
a transfer occurs
Definition: cel.h:67
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
const struct timeval * stasis_message_timestamp(const struct stasis_message *msg)
Get the time when a message was created.
@ AST_ATTENDED_TRANSFER_DEST_FAIL
@ AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE
@ AST_ATTENDED_TRANSFER_DEST_LOCAL_APP
@ AST_ATTENDED_TRANSFER_DEST_LINK
@ AST_ATTENDED_TRANSFER_DEST_APP
@ AST_ATTENDED_TRANSFER_DEST_THREEWAY
Message representing attended transfer.
enum ast_attended_transfer_dest_type dest_type
union ast_attended_transfer_message::@286 dest
struct ast_bridge_channel_snapshot_pair to_transfer_target
struct ast_channel_snapshot * transferee
struct ast_bridge_channel_snapshot_pair to_transferee
struct ast_channel_snapshot * target
struct ast_bridge_snapshot * bridge_snapshot
struct ast_channel_snapshot * channel_snapshot
Structure that contains a snapshot of information about a bridge.
Definition: bridge.h:318
const ast_string_field uniqueid
Definition: bridge.h:332
Structure representing a snapshot of channel state.

References ast_attended_transfer_message::app, AST_ATTENDED_TRANSFER_DEST_APP, AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE, AST_ATTENDED_TRANSFER_DEST_FAIL, AST_ATTENDED_TRANSFER_DEST_LINK, AST_ATTENDED_TRANSFER_DEST_LOCAL_APP, AST_ATTENDED_TRANSFER_DEST_THREEWAY, AST_CEL_ATTENDEDTRANSFER, ast_json_pack(), ast_json_unref(), ast_channel_snapshot::base, ast_bridge_channel_snapshot_pair::bridge_snapshot, cel_report_event(), ast_bridge_channel_snapshot_pair::channel_snapshot, ast_attended_transfer_message::dest, ast_attended_transfer_message::dest_type, ast_channel_snapshot_base::name, NULL, stasis_message_data(), stasis_message_timestamp(), ast_attended_transfer_message::target, ast_attended_transfer_message::to_transfer_target, ast_attended_transfer_message::to_transferee, ast_attended_transfer_message::transferee, ast_bridge_snapshot::uniqueid, and ast_channel_snapshot_base::uniqueid.

Referenced by create_routes().

◆ cel_backend_send_cb()

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

Definition at line 579 of file cel.c.

580{
581 struct cel_backend *backend = obj;
582
583 backend->callback(arg);
584 return 0;
585}

References cel_backend::callback.

Referenced by cel_report_event().

◆ cel_blind_transfer_cb()

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

Definition at line 1298 of file cel.c.

1301{
1303 struct ast_channel_snapshot *chan_snapshot = transfer_msg->transferer;
1304 struct ast_bridge_snapshot *bridge_snapshot = transfer_msg->bridge;
1305 struct ast_json *extra;
1306
1307 if (transfer_msg->result != AST_BRIDGE_TRANSFER_SUCCESS) {
1308 return;
1309 }
1310
1311 extra = ast_json_pack("{s: s, s: s, s: s, s: s, s: s}",
1312 "extension", transfer_msg->exten,
1313 "context", transfer_msg->context,
1314 "bridge_id", bridge_snapshot->uniqueid,
1315 "transferee_channel_name", transfer_msg->transferee ? transfer_msg->transferee->base->name : "N/A",
1316 "transferee_channel_uniqueid", transfer_msg->transferee ? transfer_msg->transferee->base->uniqueid : "N/A");
1317 if (extra) {
1319 NULL, extra, NULL);
1320 ast_json_unref(extra);
1321 }
1322}
@ AST_BRIDGE_TRANSFER_SUCCESS
Definition: bridge.h:1104
@ AST_CEL_BLINDTRANSFER
a transfer occurs
Definition: cel.h:65
Message published during a blind transfer.
char exten[AST_MAX_EXTENSION]
struct ast_bridge_snapshot * bridge
struct ast_channel_snapshot * transferer
struct ast_channel_snapshot * transferee
enum ast_transfer_result result
char context[AST_MAX_CONTEXT]

References AST_BRIDGE_TRANSFER_SUCCESS, AST_CEL_BLINDTRANSFER, ast_json_pack(), ast_json_unref(), ast_channel_snapshot::base, ast_blind_transfer_message::bridge, cel_report_event(), ast_blind_transfer_message::context, ast_blind_transfer_message::exten, ast_channel_snapshot_base::name, NULL, ast_blind_transfer_message::result, stasis_message_data(), stasis_message_timestamp(), ast_blind_transfer_message::transferee, ast_blind_transfer_message::transferer, ast_bridge_snapshot::uniqueid, and ast_channel_snapshot_base::uniqueid.

Referenced by create_routes().

◆ cel_bridge_enter_cb()

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

Definition at line 1066 of file cel.c.

1069{
1071 struct ast_bridge_snapshot *snapshot = blob->bridge;
1072 struct ast_channel_snapshot *chan_snapshot = blob->channel;
1073 RAII_VAR(struct ast_json *, extra, NULL, ast_json_unref);
1074 RAII_VAR(struct ast_str *, peer_str, NULL, ast_free);
1075
1076 if (cel_filter_channel_snapshot(chan_snapshot)) {
1077 return;
1078 }
1079
1080 extra = ast_json_pack("{s: s, s: s}",
1081 "bridge_id", snapshot->uniqueid,
1082 "bridge_technology", snapshot->technology);
1083 if (!extra) {
1084 return;
1085 }
1086
1087 peer_str = cel_generate_peer_str(snapshot, chan_snapshot);
1088 if (!peer_str) {
1089 return;
1090 }
1091
1093 NULL, extra, ast_str_buffer(peer_str));
1094}
#define ast_free(a)
Definition: astmm.h:180
static int cel_filter_channel_snapshot(struct ast_channel_snapshot *snapshot)
Definition: cel.c:1005
static struct ast_str * cel_generate_peer_str(struct ast_bridge_snapshot *bridge, struct ast_channel_snapshot *chan)
Definition: cel.c:1028
@ AST_CEL_BRIDGE_ENTER
channel enters a bridge
Definition: cel.h:57
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
Blob of data associated with a bridge.
struct ast_bridge_snapshot * bridge
struct ast_channel_snapshot * channel
struct ast_json * blob
const ast_string_field technology
Definition: bridge.h:332
Support for dynamic strings.
Definition: strings.h:623

References AST_CEL_BRIDGE_ENTER, ast_free, ast_json_pack(), ast_json_unref(), ast_str_buffer(), ast_bridge_blob::blob, ast_bridge_blob::bridge, cel_filter_channel_snapshot(), cel_generate_peer_str(), cel_report_event(), ast_bridge_blob::channel, NULL, RAII_VAR, stasis_message_data(), stasis_message_timestamp(), ast_bridge_snapshot::technology, and ast_bridge_snapshot::uniqueid.

Referenced by create_routes().

◆ cel_bridge_leave_cb()

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

Definition at line 1096 of file cel.c.

1099{
1101 struct ast_bridge_snapshot *snapshot = blob->bridge;
1102 struct ast_channel_snapshot *chan_snapshot = blob->channel;
1103 RAII_VAR(struct ast_json *, extra, NULL, ast_json_unref);
1104 RAII_VAR(struct ast_str *, peer_str, NULL, ast_free);
1105
1106 if (cel_filter_channel_snapshot(chan_snapshot)) {
1107 return;
1108 }
1109
1110 extra = ast_json_pack("{s: s, s: s}",
1111 "bridge_id", snapshot->uniqueid,
1112 "bridge_technology", snapshot->technology);
1113 if (!extra) {
1114 return;
1115 }
1116
1117 peer_str = cel_generate_peer_str(snapshot, chan_snapshot);
1118 if (!peer_str) {
1119 return;
1120 }
1121
1123 NULL, extra, ast_str_buffer(peer_str));
1124}
@ AST_CEL_BRIDGE_EXIT
channel exits a bridge
Definition: cel.h:59

References AST_CEL_BRIDGE_EXIT, ast_free, ast_json_pack(), ast_json_unref(), ast_str_buffer(), ast_bridge_blob::blob, ast_bridge_blob::bridge, cel_filter_channel_snapshot(), cel_generate_peer_str(), cel_report_event(), ast_bridge_blob::channel, NULL, RAII_VAR, stasis_message_data(), stasis_message_timestamp(), ast_bridge_snapshot::technology, and ast_bridge_snapshot::uniqueid.

Referenced by create_routes().

◆ cel_channel_app_change()

static void cel_channel_app_change ( struct ast_channel_snapshot old_snapshot,
struct ast_channel_snapshot new_snapshot,
const struct timeval *  event_time 
)
static

Definition at line 974 of file cel.c.

978{
979 if (old_snapshot && !strcmp(old_snapshot->dialplan->appl, new_snapshot->dialplan->appl)) {
980 return;
981 }
982
983 /* old snapshot has an application, end it */
984 if (old_snapshot && !ast_strlen_zero(old_snapshot->dialplan->appl)) {
985 cel_report_event(old_snapshot, AST_CEL_APP_END, event_time, NULL, NULL, NULL);
986 }
987
988 /* new snapshot has an application, start it */
989 if (!ast_strlen_zero(new_snapshot->dialplan->appl)) {
990 cel_report_event(new_snapshot, AST_CEL_APP_START, event_time, NULL, NULL, NULL);
991 }
992}
@ AST_CEL_APP_END
an app ends
Definition: cel.h:55
@ AST_CEL_APP_START
an app starts
Definition: cel.h:53

References ast_channel_snapshot_dialplan::appl, AST_CEL_APP_END, AST_CEL_APP_START, ast_strlen_zero(), cel_report_event(), ast_channel_snapshot::dialplan, and NULL.

◆ cel_channel_linkedid_change()

static void cel_channel_linkedid_change ( struct ast_channel_snapshot old_snapshot,
struct ast_channel_snapshot new_snapshot,
const struct timeval *  event_time 
)
static

Definition at line 955 of file cel.c.

959{
960 if (!old_snapshot) {
961 return;
962 }
963
964 ast_assert(!ast_strlen_zero(new_snapshot->peer->linkedid));
965 ast_assert(!ast_strlen_zero(old_snapshot->peer->linkedid));
966
968 && strcmp(old_snapshot->peer->linkedid, new_snapshot->peer->linkedid)) {
969 cel_linkedid_ref(new_snapshot->peer->linkedid);
970 check_retire_linkedid(old_snapshot, event_time);
971 }
972}
static int cel_linkedid_ref(const char *linkedid)
Definition: cel.c:799
static int ast_cel_track_event(enum ast_cel_event_type et)
Definition: cel.c:449
static void check_retire_linkedid(struct ast_channel_snapshot *snapshot, const struct timeval *event_time)
Definition: cel.c:632
@ AST_CEL_LINKEDID_END
the last channel with the given linkedid is retired
Definition: cel.h:71
#define ast_assert(a)
Definition: utils.h:739

References ast_assert, AST_CEL_LINKEDID_END, ast_cel_track_event(), ast_strlen_zero(), cel_linkedid_ref(), check_retire_linkedid(), ast_channel_snapshot_peer::linkedid, and ast_channel_snapshot::peer.

◆ cel_channel_state_change()

static void cel_channel_state_change ( struct ast_channel_snapshot old_snapshot,
struct ast_channel_snapshot new_snapshot,
const struct timeval *  event_time 
)
static

Handle channel state changes.

Definition at line 915 of file cel.c.

919{
920 int is_hungup, was_hungup;
921
922 if (!old_snapshot) {
923 cel_report_event(new_snapshot, AST_CEL_CHANNEL_START, event_time, NULL, NULL, NULL);
924 return;
925 }
926
927 was_hungup = ast_test_flag(&old_snapshot->flags, AST_FLAG_DEAD) ? 1 : 0;
928 is_hungup = ast_test_flag(&new_snapshot->flags, AST_FLAG_DEAD) ? 1 : 0;
929
930 if (!was_hungup && is_hungup) {
931 struct ast_json *extra;
932 struct cel_dialstatus *dialstatus = get_dialstatus(new_snapshot->base->uniqueid);
933
934 extra = ast_json_pack("{s: i, s: s, s: s}",
935 "hangupcause", new_snapshot->hangup->cause,
936 "hangupsource", new_snapshot->hangup->source,
937 "dialstatus", dialstatus ? dialstatus->dialstatus : "");
938 cel_report_event(new_snapshot, AST_CEL_HANGUP, event_time, NULL, extra, NULL);
939 ast_json_unref(extra);
941
942 cel_report_event(new_snapshot, AST_CEL_CHANNEL_END, event_time, NULL, NULL, NULL);
944 check_retire_linkedid(new_snapshot, event_time);
945 }
946 return;
947 }
948
949 if (old_snapshot->state != new_snapshot->state && new_snapshot->state == AST_STATE_UP) {
950 cel_report_event(new_snapshot, AST_CEL_ANSWER, event_time, NULL, NULL, NULL);
951 return;
952 }
953}
static struct cel_dialstatus * get_dialstatus(const char *uniqueid)
Definition: cel.c:887
@ AST_CEL_CHANNEL_END
channel end
Definition: cel.h:47
@ AST_CEL_ANSWER
A ringing phone is answered.
Definition: cel.h:51
@ AST_CEL_HANGUP
hangup terminates connection
Definition: cel.h:49
@ AST_CEL_CHANNEL_START
channel birth
Definition: cel.h:45
@ AST_FLAG_DEAD
Definition: channel.h:1065
@ AST_STATE_UP
Definition: channelstate.h:42
enum ast_channel_state state
struct ast_flags flags
struct ast_channel_snapshot_hangup * hangup
char dialstatus[0]
Definition: cel.c:192
#define ast_test_flag(p, flag)
Definition: utils.h:63

References ao2_cleanup, AST_CEL_ANSWER, AST_CEL_CHANNEL_END, AST_CEL_CHANNEL_START, AST_CEL_HANGUP, AST_CEL_LINKEDID_END, ast_cel_track_event(), AST_FLAG_DEAD, ast_json_pack(), ast_json_unref(), AST_STATE_UP, ast_test_flag, ast_channel_snapshot::base, ast_channel_snapshot_hangup::cause, cel_report_event(), check_retire_linkedid(), cel_dialstatus::dialstatus, ast_channel_snapshot::flags, get_dialstatus(), ast_channel_snapshot::hangup, NULL, ast_channel_snapshot_hangup::source, ast_channel_snapshot::state, and ast_channel_snapshot_base::uniqueid.

◆ cel_config_alloc()

static void * cel_config_alloc ( void  )
static

Definition at line 240 of file cel.c.

241{
242 RAII_VAR(struct cel_config *, cfg, NULL, ao2_cleanup);
243
244 if (!(cfg = ao2_alloc(sizeof(*cfg), cel_config_dtor))) {
245 return NULL;
246 }
247
248 if (!(cfg->general = ast_cel_general_config_alloc())) {
249 return NULL;
250 }
251
252 ao2_ref(cfg, +1);
253 return cfg;
254}
void * ast_cel_general_config_alloc(void)
Allocate a CEL configuration object.
Definition: cel.c:204
static void cel_config_dtor(void *obj)
Destructor for cel_config.
Definition: cel.c:233

References ao2_alloc, ao2_cleanup, ao2_ref, ast_cel_general_config_alloc(), cel_config_dtor(), NULL, and RAII_VAR.

Referenced by load_module().

◆ cel_config_dtor()

static void cel_config_dtor ( void *  obj)
static

Destructor for cel_config.

Definition at line 233 of file cel.c.

234{
235 struct cel_config *cfg = obj;
236 ao2_cleanup(cfg->general);
237 cfg->general = NULL;
238}

References ao2_cleanup, cel_config::general, and NULL.

Referenced by cel_config_alloc().

◆ cel_dial_cb()

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

Definition at line 1248 of file cel.c.

1250{
1252 struct ast_channel_snapshot *snapshot;
1253
1254 snapshot = ast_multi_channel_blob_get_channel(blob, "caller");
1255 if (!snapshot || cel_filter_channel_snapshot(snapshot)) {
1256 return;
1257 }
1258
1259 if (!ast_strlen_zero(get_blob_variable(blob, "forward"))) {
1260 struct ast_json *extra;
1261
1262 extra = ast_json_pack("{s: s}", "forward", get_blob_variable(blob, "forward"));
1263 if (extra) {
1265 NULL, extra, NULL);
1266 ast_json_unref(extra);
1267 }
1268 }
1269
1270 if (is_valid_dialstatus(blob)) {
1271 save_dialstatus(blob, snapshot);
1272 }
1273}
static int is_valid_dialstatus(struct ast_multi_channel_blob *blob)
Definition: cel.c:1219
static void save_dialstatus(struct ast_multi_channel_blob *blob, struct ast_channel_snapshot *snapshot)
Definition: cel.c:1175
static const char * get_blob_variable(struct ast_multi_channel_blob *blob, const char *varname)
Definition: cel.c:899
@ AST_CEL_FORWARD
this call was forwarded somewhere else
Definition: cel.h:75
struct ast_channel_snapshot * ast_multi_channel_blob_get_channel(struct ast_multi_channel_blob *obj, const char *role)
Retrieve a channel snapshot associated with a specific role from a ast_multi_channel_blob.
A multi channel blob data structure for multi_channel_blob stasis messages.
struct ast_json * blob

References AST_CEL_FORWARD, ast_json_pack(), ast_json_unref(), ast_multi_channel_blob_get_channel(), ast_strlen_zero(), ast_multi_channel_blob::blob, cel_filter_channel_snapshot(), cel_report_event(), get_blob_variable(), is_valid_dialstatus(), NULL, save_dialstatus(), stasis_message_data(), and stasis_message_timestamp().

Referenced by create_routes().

◆ cel_filter_channel_snapshot()

static int cel_filter_channel_snapshot ( struct ast_channel_snapshot snapshot)
static

Definition at line 1005 of file cel.c.

1006{
1007 if (!snapshot) {
1008 return 0;
1009 }
1010 return snapshot->base->tech_properties & AST_CHAN_TP_INTERNAL;
1011}
@ AST_CHAN_TP_INTERNAL
Channels with this particular technology are an implementation detail of Asterisk and should generall...
Definition: channel.h:991

References AST_CHAN_TP_INTERNAL, ast_channel_snapshot::base, and ast_channel_snapshot_base::tech_properties.

Referenced by cel_bridge_enter_cb(), cel_bridge_leave_cb(), cel_dial_cb(), and cel_snapshot_update_cb().

◆ cel_general_config_dtor()

static void cel_general_config_dtor ( void *  obj)
static

Destructor for cel_config.

Definition at line 196 of file cel.c.

197{
198 struct ast_cel_general_config *cfg = obj;
200 ao2_cleanup(cfg->apps);
201 cfg->apps = NULL;
202}
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:374

References ao2_cleanup, ast_cel_general_config::apps, ast_string_field_free_memory, and NULL.

Referenced by ast_cel_general_config_alloc().

◆ cel_generate_peer_str()

static struct ast_str * cel_generate_peer_str ( struct ast_bridge_snapshot bridge,
struct ast_channel_snapshot chan 
)
static

Definition at line 1028 of file cel.c.

1031{
1032 struct ast_str *peer_str = ast_str_create(32);
1033 struct ao2_iterator i;
1034 char *current_chan = NULL;
1035
1036 if (!peer_str) {
1037 return NULL;
1038 }
1039
1040 for (i = ao2_iterator_init(bridge->channels, 0);
1041 (current_chan = ao2_iterator_next(&i));
1042 ao2_cleanup(current_chan)) {
1043 struct ast_channel_snapshot *current_snapshot;
1044
1045 /* Don't add the channel for which this message is being generated */
1046 if (!strcmp(current_chan, chan->base->uniqueid)) {
1047 continue;
1048 }
1049
1050 current_snapshot = ast_channel_snapshot_get_latest(current_chan);
1051 if (!current_snapshot) {
1052 continue;
1053 }
1054
1055 ast_str_append(&peer_str, 0, "%s,", current_snapshot->base->name);
1056 ao2_cleanup(current_snapshot);
1057 }
1059
1060 /* Rip off the trailing comma */
1061 ast_str_truncate(peer_str, -1);
1062
1063 return peer_str;
1064}
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object,...
char * ast_str_truncate(struct ast_str *buf, ssize_t len)
Truncates the enclosed string to the given length.
Definition: strings.h:786
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
struct ao2_container * channels
Definition: bridge.h:335

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ast_channel_snapshot_get_latest(), ast_str_append(), ast_str_create, ast_str_truncate(), ast_channel_snapshot::base, ast_bridge_snapshot::channels, ast_channel_snapshot_base::name, NULL, and ast_channel_snapshot_base::uniqueid.

Referenced by cel_bridge_enter_cb(), and cel_bridge_leave_cb().

◆ cel_generic_cb()

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

Definition at line 1275 of file cel.c.

1278{
1280 int event_type = ast_json_integer_get(ast_json_object_get(obj->blob, "event_type"));
1281 struct ast_json *event_details = ast_json_object_get(obj->blob, "event_details");
1282
1283 switch (event_type) {
1285 {
1286 const char *event = ast_json_string_get(ast_json_object_get(event_details, "event"));
1287 struct ast_json *extra = ast_json_object_get(event_details, "extra");
1289 event, extra, NULL);
1290 break;
1291 }
1292 default:
1293 ast_log(LOG_ERROR, "Unhandled %s event blob\n", ast_cel_get_type_name(event_type));
1294 break;
1295 }
1296}
const char * ast_json_string_get(const struct ast_json *string)
Get the value of a JSON string.
Definition: json.c:283
struct ast_json * ast_json_object_get(struct ast_json *object, const char *key)
Get a field from a JSON object.
Definition: json.c:407
intmax_t ast_json_integer_get(const struct ast_json *integer)
Get the value from a JSON integer.
Definition: json.c:332
Blob of data associated with a channel.
struct ast_channel_snapshot * snapshot
struct ast_json * blob

References ast_cel_get_type_name(), AST_CEL_USER_DEFINED, ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_log, ast_channel_blob::blob, cel_report_event(), LOG_ERROR, NULL, ast_channel_blob::snapshot, stasis_message_data(), and stasis_message_timestamp().

Referenced by create_routes().

◆ cel_generic_type()

struct stasis_message_type * cel_generic_type ( void  )

◆ cel_linkedid_ref()

static int cel_linkedid_ref ( const char *  linkedid)
static

Definition at line 799 of file cel.c.

800{
801 RAII_VAR(struct ao2_container *, linkedids, ao2_global_obj_ref(cel_linkedids), ao2_cleanup);
802 struct cel_linkedid *lid;
803
804 if (ast_strlen_zero(linkedid)) {
805 ast_log(LOG_ERROR, "The linkedid should never be empty\n");
806 return -1;
807 }
808 if (!linkedids) {
809 /* The CEL module is shutdown. Abort. */
810 return -1;
811 }
812
813 ao2_lock(linkedids);
814 lid = ao2_find(linkedids, (void *) linkedid, OBJ_SEARCH_KEY);
815 if (!lid) {
816 /*
817 * Changes to the lid->count member are protected by the
818 * container lock so the lid object does not need its own lock.
819 */
820 lid = ao2_alloc_options(sizeof(*lid) + strlen(linkedid) + 1, NULL,
822 if (!lid) {
823 ao2_unlock(linkedids);
824 return -1;
825 }
826 strcpy(lid->id, linkedid);/* Safe */
827
828 ao2_link(linkedids, lid);
829 }
830 ++lid->count;
831 ao2_unlock(linkedids);
832 ao2_ref(lid, -1);
833
834 return 0;
835}
#define ao2_unlock(a)
Definition: astobj2.h:729
#define ao2_lock(a)
Definition: astobj2.h:717
unsigned int count
Definition: cel.c:180
char id[0]
Definition: cel.c:182

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_link, ao2_lock, ao2_ref, ao2_unlock, ast_log, ast_strlen_zero(), cel_linkedid::count, cel_linkedid::id, LOG_ERROR, NULL, OBJ_SEARCH_KEY, and RAII_VAR.

Referenced by cel_channel_linkedid_change(), and cel_report_event().

◆ cel_local_optimization_begin_cb()

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

Definition at line 1447 of file cel.c.

1450{
1452}
static void cel_local_optimization_cb_helper(void *data, struct stasis_subscription *sub, struct stasis_message *message, enum ast_cel_event_type event_type)
Definition: cel.c:1412
@ AST_CEL_LOCAL_OPTIMIZE_BEGIN
A local channel optimization has begun.
Definition: cel.h:79
struct stasis_forward * sub
Definition: res_corosync.c:240

References AST_CEL_LOCAL_OPTIMIZE_BEGIN, cel_local_optimization_cb_helper(), and sub.

Referenced by create_routes().

◆ cel_local_optimization_cb_helper()

static void cel_local_optimization_cb_helper ( void *  data,
struct stasis_subscription sub,
struct stasis_message message,
enum ast_cel_event_type  event_type 
)
static

Definition at line 1412 of file cel.c.

1416{
1418 struct ast_channel_snapshot *localone = ast_multi_channel_blob_get_channel(obj, "1");
1419 struct ast_channel_snapshot *localtwo = ast_multi_channel_blob_get_channel(obj, "2");
1420 struct ast_json *extra;
1421
1422 if (!localone || !localtwo) {
1423 return;
1424 }
1425
1426 extra = ast_json_pack("{s: s, s: s}",
1427 "local_two", localtwo->base->name,
1428 "local_two_uniqueid", localtwo->base->uniqueid);
1429 if (!extra) {
1430 return;
1431 }
1432
1433 cel_report_event(localone, event_type, stasis_message_timestamp(message), NULL, extra, NULL);
1434 ast_json_unref(extra);
1435}

References ast_json_pack(), ast_json_unref(), ast_multi_channel_blob_get_channel(), ast_channel_snapshot::base, cel_report_event(), ast_channel_snapshot_base::name, NULL, stasis_message_data(), stasis_message_timestamp(), and ast_channel_snapshot_base::uniqueid.

Referenced by cel_local_optimization_begin_cb(), and cel_local_optimization_end_cb().

◆ cel_local_optimization_end_cb()

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

Definition at line 1437 of file cel.c.

1440{
1441 /* The AST_CEL_LOCAL_OPTIMIZE event has always been triggered by the end of optimization.
1442 This can either be used as an indication that the call was locally optimized, or as
1443 the END event in combination with the subsequently added BEGIN event. */
1445}
@ AST_CEL_LOCAL_OPTIMIZE
A local channel optimization occurred, this marks the end.
Definition: cel.h:77

References AST_CEL_LOCAL_OPTIMIZE, cel_local_optimization_cb_helper(), and sub.

Referenced by create_routes().

◆ cel_parking_cb()

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

Definition at line 1126 of file cel.c.

1129{
1130 struct ast_parked_call_payload *parked_payload = stasis_message_data(message);
1131 RAII_VAR(struct ast_json *, extra, NULL, ast_json_unref);
1132 const char *reason = NULL;
1133
1134 switch (parked_payload->event_type) {
1135 case PARKED_CALL:
1136 extra = ast_json_pack("{s: s, s: s}",
1137 "parker_dial_string", parked_payload->parker_dial_string,
1138 "parking_lot", parked_payload->parkinglot);
1139 if (extra) {
1141 NULL, extra, NULL);
1142 }
1143 return;
1145 reason = "ParkedCallTimeOut";
1146 break;
1147 case PARKED_CALL_GIVEUP:
1148 reason = "ParkedCallGiveUp";
1149 break;
1151 reason = "ParkedCallUnparked";
1152 break;
1153 case PARKED_CALL_FAILED:
1154 reason = "ParkedCallFailed";
1155 break;
1156 case PARKED_CALL_SWAP:
1157 reason = "ParkedCallSwap";
1158 break;
1159 }
1160
1161 if (parked_payload->retriever) {
1162 extra = ast_json_pack("{s: s, s: s}",
1163 "reason", reason ?: "",
1164 "retriever", parked_payload->retriever->base->name);
1165 } else {
1166 extra = ast_json_pack("{s: s}", "reason", reason ?: "");
1167 }
1168
1169 if (extra) {
1171 NULL, extra, NULL);
1172 }
1173}
@ AST_CEL_PARK_START
a channel is parked
Definition: cel.h:61
@ AST_CEL_PARK_END
channel out of the park
Definition: cel.h:63
@ PARKED_CALL
Definition: parking.h:47
@ PARKED_CALL_TIMEOUT
Definition: parking.h:48
@ PARKED_CALL_UNPARKED
Definition: parking.h:50
@ PARKED_CALL_FAILED
Definition: parking.h:51
@ PARKED_CALL_GIVEUP
Definition: parking.h:49
@ PARKED_CALL_SWAP
Definition: parking.h:52
A parked call message payload.
Definition: parking.h:59
const ast_string_field parkinglot
Definition: parking.h:69
struct ast_channel_snapshot * retriever
Definition: parking.h:61
struct ast_channel_snapshot * parkee
Definition: parking.h:60
enum ast_parked_call_event_type event_type
Definition: parking.h:62
const ast_string_field parker_dial_string
Definition: parking.h:69

References AST_CEL_PARK_END, AST_CEL_PARK_START, ast_json_pack(), ast_json_unref(), ast_channel_snapshot::base, cel_report_event(), ast_parked_call_payload::event_type, ast_channel_snapshot_base::name, NULL, PARKED_CALL, PARKED_CALL_FAILED, PARKED_CALL_GIVEUP, PARKED_CALL_SWAP, PARKED_CALL_TIMEOUT, PARKED_CALL_UNPARKED, ast_parked_call_payload::parkee, ast_parked_call_payload::parker_dial_string, ast_parked_call_payload::parkinglot, RAII_VAR, ast_parked_call_payload::retriever, stasis_message_data(), and stasis_message_timestamp().

Referenced by create_routes().

◆ cel_pickup_cb()

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

Definition at line 1387 of file cel.c.

1390{
1392 struct ast_channel_snapshot *channel = ast_multi_channel_blob_get_channel(obj, "channel");
1393 struct ast_channel_snapshot *target = ast_multi_channel_blob_get_channel(obj, "target");
1394 struct ast_json *extra;
1395
1396 if (!channel || !target) {
1397 return;
1398 }
1399
1400 extra = ast_json_pack("{s: s, s: s}",
1401 "pickup_channel", channel->base->name,
1402 "pickup_channel_uniqueid", channel->base->uniqueid);
1403 if (!extra) {
1404 return;
1405 }
1406
1408 ast_json_unref(extra);
1409}
@ AST_CEL_PICKUP
a directed pickup was performed on this channel
Definition: cel.h:73

References AST_CEL_PICKUP, ast_json_pack(), ast_json_unref(), ast_multi_channel_blob_get_channel(), ast_channel_snapshot::base, cel_report_event(), ast_channel_snapshot_base::name, NULL, stasis_message_data(), stasis_message_timestamp(), and ast_channel_snapshot_base::uniqueid.

Referenced by create_routes().

◆ cel_pre_apply_config()

static int cel_pre_apply_config ( void  )
static

Definition at line 292 of file cel.c.

293{
294 struct cel_config *cfg = aco_pending_config(&cel_cfg_info);
295
296 if (!cfg->general) {
297 return -1;
298 }
299
300 if (!ao2_container_count(cfg->general->apps)) {
301 return 0;
302 }
303
304 if (cfg->general->events & ((int64_t) 1 << AST_CEL_APP_START)) {
305 return 0;
306 }
307
308 if (cfg->general->events & ((int64_t) 1 << AST_CEL_APP_END)) {
309 return 0;
310 }
311
312 ast_log(LOG_ERROR, "Applications are listed to be tracked, but APP events are not tracked\n");
313 return -1;
314}
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
void * aco_pending_config(struct aco_info *info)
Get pending config changes.
int64_t events
Definition: cel.h:229

References aco_pending_config(), ao2_container_count(), ast_cel_general_config::apps, AST_CEL_APP_END, AST_CEL_APP_START, ast_log, ast_cel_general_config::events, cel_config::general, and LOG_ERROR.

◆ cel_report_event()

static int cel_report_event ( struct ast_channel_snapshot snapshot,
enum ast_cel_event_type  event_type,
const struct timeval *  event_time,
const char *  userdefevname,
struct ast_json extra,
const char *  peer_str 
)
static

Definition at line 587 of file cel.c.

591{
592 struct ast_event *ev;
593 RAII_VAR(struct cel_config *, cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
595
596 if (!cfg || !cfg->general || !cfg->general->enable || !backends) {
597 return 0;
598 }
599
600 /* Record the linkedid of new channels if we are tracking LINKEDID_END even if we aren't
601 * reporting on CHANNEL_START so we can track when to send LINKEDID_END */
602 if (event_type == AST_CEL_CHANNEL_START
604 if (cel_linkedid_ref(snapshot->peer->linkedid)) {
605 return -1;
606 }
607 }
608
609 if (!ast_cel_track_event(event_type)) {
610 return 0;
611 }
612
613 if ((event_type == AST_CEL_APP_START || event_type == AST_CEL_APP_END)
614 && !cel_track_app(snapshot->dialplan->appl)) {
615 return 0;
616 }
617
618 ev = ast_cel_create_event_with_time(snapshot, event_type, event_time, userdefevname, extra, peer_str);
619 if (!ev) {
620 return -1;
621 }
622
623 /* Distribute event to backends */
626
627 return 0;
628}
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
@ OBJ_MULTIPLE
Definition: astobj2.h:1049
static int cel_track_app(const char *const_app)
Definition: cel.c:513
static int cel_backend_send_cb(void *obj, void *arg, int flags)
Definition: cel.c:579
void ast_event_destroy(struct ast_event *event)
Destroy an event.
Definition: event.c:525
An event.
Definition: event.c:81

References ao2_callback, ao2_cleanup, ao2_global_obj_ref, ast_channel_snapshot_dialplan::appl, AST_CEL_APP_END, AST_CEL_APP_START, AST_CEL_CHANNEL_START, ast_cel_create_event_with_time(), AST_CEL_LINKEDID_END, ast_cel_track_event(), ast_event_destroy(), cel_backend_send_cb(), cel_linkedid_ref(), cel_track_app(), ast_channel_snapshot::dialplan, ast_channel_snapshot_peer::linkedid, OBJ_MULTIPLE, OBJ_NODATA, ast_channel_snapshot::peer, and RAII_VAR.

Referenced by cel_attended_transfer_cb(), cel_blind_transfer_cb(), cel_bridge_enter_cb(), cel_bridge_leave_cb(), cel_channel_app_change(), cel_channel_state_change(), cel_dial_cb(), cel_generic_cb(), cel_local_optimization_cb_helper(), cel_parking_cb(), cel_pickup_cb(), and check_retire_linkedid().

◆ cel_snapshot_update_cb()

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

Definition at line 1013 of file cel.c.

1015{
1017 size_t i;
1018
1019 if (cel_filter_channel_snapshot(update->old_snapshot) || cel_filter_channel_snapshot(update->new_snapshot)) {
1020 return;
1021 }
1022
1023 for (i = 0; i < ARRAY_LEN(cel_channel_monitors); ++i) {
1024 cel_channel_monitors[i](update->old_snapshot, update->new_snapshot, stasis_message_timestamp(message));
1025 }
1026}
cel_channel_snapshot_monitor cel_channel_monitors[]
Handlers for channel snapshot changes.
Definition: cel.c:999
static void update(int code_size, int y, int wi, int fi, int dq, int sr, int dqsez, struct g726_state *state_ptr)
Definition: codec_g726.c:367
Structure representing a change of snapshot of channel state.

References ARRAY_LEN, cel_channel_monitors, cel_filter_channel_snapshot(), stasis_message_data(), stasis_message_timestamp(), and update().

Referenced by create_routes().

◆ cel_track_app()

static int cel_track_app ( const char *  const_app)
static

Definition at line 513 of file cel.c.

514{
515 RAII_VAR(struct cel_config *, cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
516 RAII_VAR(char *, app, NULL, ao2_cleanup);
517 char *app_lower;
518
519 if (!cfg || !cfg->general) {
520 return 0;
521 }
522
523 app_lower = ast_str_to_lower(ast_strdupa(const_app));
524 app = ao2_find(cfg->general->apps, app_lower, OBJ_SEARCH_KEY);
525 if (!app) {
526 return 0;
527 }
528
529 return 1;
530}
static const char app[]
Definition: app_adsiprog.c:56

References ao2_cleanup, ao2_find, ao2_global_obj_ref, app, ast_str_to_lower(), ast_strdupa, NULL, OBJ_SEARCH_KEY, and RAII_VAR.

Referenced by cel_report_event().

◆ check_retire_linkedid()

static void check_retire_linkedid ( struct ast_channel_snapshot snapshot,
const struct timeval *  event_time 
)
static

Definition at line 632 of file cel.c.

633{
634 RAII_VAR(struct ao2_container *, linkedids, ao2_global_obj_ref(cel_linkedids), ao2_cleanup);
635 struct cel_linkedid *lid;
636
637 if (!linkedids || ast_strlen_zero(snapshot->peer->linkedid)) {
638 /* The CEL module is shutdown. Abort. */
639 return;
640 }
641
642 ao2_lock(linkedids);
643
644 lid = ao2_find(linkedids, (void *) snapshot->peer->linkedid, OBJ_SEARCH_KEY);
645 if (!lid) {
646 ao2_unlock(linkedids);
647
648 /*
649 * The user may have done a reload to start tracking linkedids
650 * when a call was already in progress. This is an unusual kind
651 * of change to make after starting Asterisk.
652 */
653 ast_log(LOG_ERROR, "Something weird happened, couldn't find linkedid %s\n",
654 snapshot->peer->linkedid);
655 return;
656 }
657
658 if (!--lid->count) {
659 /* No channels use this linkedid anymore. */
660 ao2_unlink(linkedids, lid);
661 ao2_unlock(linkedids);
662
663 cel_report_event(snapshot, AST_CEL_LINKEDID_END, event_time, NULL, NULL, NULL);
664 } else {
665 ao2_unlock(linkedids);
666 }
667 ao2_ref(lid, -1);
668}
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition: astobj2.h:1578

References ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_lock, ao2_ref, ao2_unlink, ao2_unlock, AST_CEL_LINKEDID_END, ast_log, ast_strlen_zero(), cel_report_event(), cel_linkedid::count, ast_channel_snapshot_peer::linkedid, LOG_ERROR, NULL, OBJ_SEARCH_KEY, ast_channel_snapshot::peer, and RAII_VAR.

Referenced by cel_channel_linkedid_change(), and cel_channel_state_change().

◆ CONFIG_INFO_CORE()

CONFIG_INFO_CORE ( "cel"  ,
cel_cfg_info  ,
cel_configs  ,
cel_config_alloc  ,
files = ACO_FILES(&cel_conf),
pre_apply_config = cel_pre_apply_config 
)

◆ create_routes()

static int create_routes ( void  )
static

Create the Stasis message router and routes for CEL.

Definition at line 1538 of file cel.c.

1539{
1540 int ret = 0;
1541
1543 if (!cel_state_router) {
1544 return -1;
1545 }
1548
1552 NULL);
1553
1557 NULL);
1558
1562 NULL);
1563
1567 NULL);
1568
1572 NULL);
1573
1577 NULL);
1578
1582 NULL);
1583
1587 NULL);
1588
1592 NULL);
1593
1597 NULL);
1598
1602 NULL);
1603
1604 if (ret) {
1605 ast_log(AST_LOG_ERROR, "Failed to register for Stasis messages\n");
1606 }
1607
1608 return ret;
1609}
static void cel_local_optimization_end_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1437
static void cel_bridge_leave_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1096
static void cel_dial_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1248
static void cel_snapshot_update_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1013
static void cel_pickup_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1387
static void cel_blind_transfer_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1298
static void cel_attended_transfer_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1324
static void cel_generic_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1275
static void cel_parking_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1126
static struct stasis_message_router * cel_state_router
Definition: cel.c:130
static void cel_local_optimization_begin_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1447
static void cel_bridge_enter_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: cel.c:1066
static struct stasis_topic * cel_aggregation_topic
Definition: cel.c:136
struct stasis_message_type * ast_local_optimization_end_type(void)
Message type for when a local channel optimization completes.
struct stasis_message_type * ast_local_optimization_begin_type(void)
Message type for when a local channel optimization begins.
struct stasis_message_type * ast_parked_call_type(void)
accessor for the parked call stasis message type
struct stasis_message_type * ast_channel_dial_type(void)
Message type for when a channel dials another channel.
struct stasis_message_type * ast_channel_snapshot_type(void)
Message type for ast_channel_snapshot_update.
#define AST_LOG_ERROR
struct stasis_message_type * ast_call_pickup_type(void)
accessor for call pickup message type
struct stasis_message_type * ast_channel_entered_bridge_type(void)
Message type for ast_channel enter bridge blob messages.
struct stasis_message_type * ast_blind_transfer_type(void)
Message type for ast_blind_transfer_message.
struct stasis_message_type * ast_attended_transfer_type(void)
Message type for ast_attended_transfer_message.
struct stasis_message_type * ast_channel_left_bridge_type(void)
Message type for ast_channel leave bridge blob messages.
int stasis_message_router_set_congestion_limits(struct stasis_message_router *router, long low_water, long high_water)
Set the high and low alert water marks of the stasis message router.
#define stasis_message_router_create(topic)
Create a new message router object.
int stasis_message_router_add(struct stasis_message_router *router, struct stasis_message_type *message_type, stasis_subscription_cb callback, void *data)
Add a route to a message router.
#define AST_TASKPROCESSOR_HIGH_WATER_LEVEL
Definition: taskprocessor.h:64

References ast_attended_transfer_type(), ast_blind_transfer_type(), ast_call_pickup_type(), ast_channel_dial_type(), ast_channel_entered_bridge_type(), ast_channel_left_bridge_type(), ast_channel_snapshot_type(), ast_local_optimization_begin_type(), ast_local_optimization_end_type(), ast_log, AST_LOG_ERROR, ast_parked_call_type(), AST_TASKPROCESSOR_HIGH_WATER_LEVEL, cel_aggregation_topic, cel_attended_transfer_cb(), cel_blind_transfer_cb(), cel_bridge_enter_cb(), cel_bridge_leave_cb(), cel_dial_cb(), cel_generic_cb(), cel_generic_type(), cel_local_optimization_begin_cb(), cel_local_optimization_end_cb(), cel_parking_cb(), cel_pickup_cb(), cel_snapshot_update_cb(), cel_state_router, NULL, stasis_message_router_add(), stasis_message_router_create, and stasis_message_router_set_congestion_limits().

Referenced by ast_cel_set_config(), load_module(), and reload_module().

◆ create_subscriptions()

static int create_subscriptions ( void  )
static

Create the Stasis subscriptions for CEL.

Definition at line 1492 of file cel.c.

1493{
1494 cel_aggregation_topic = stasis_topic_create("cel:aggregator");
1495 if (!cel_aggregation_topic) {
1496 return -1;
1497 }
1498
1499 cel_topic = stasis_topic_create("cel:misc");
1500 if (!cel_topic) {
1501 return -1;
1502 }
1503
1507 if (!cel_channel_forwarder) {
1508 return -1;
1509 }
1510
1514 if (!cel_bridge_forwarder) {
1515 return -1;
1516 }
1517
1521 if (!cel_parking_forwarder) {
1522 return -1;
1523 }
1524
1526 ast_cel_topic(),
1528 if (!cel_cel_forwarder) {
1529 return -1;
1530 }
1531
1532 return 0;
1533}
static struct stasis_forward * cel_cel_forwarder
Definition: cel.c:148
static struct stasis_forward * cel_channel_forwarder
Definition: cel.c:139
static struct stasis_forward * cel_bridge_forwarder
Definition: cel.c:142
static struct stasis_forward * cel_parking_forwarder
Definition: cel.c:145
struct stasis_topic * ast_parking_topic(void)
accessor for the parking stasis topic
Definition: parking.c:67
struct stasis_topic * ast_channel_topic_all(void)
A topic which publishes the events for all channels.
struct stasis_topic * stasis_topic_create(const char *name)
Create a new topic.
Definition: stasis.c:644
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition: stasis.c:1605
struct stasis_topic * ast_bridge_topic_all(void)
A topic which publishes the events for all bridges.

References ast_bridge_topic_all(), ast_cel_topic(), ast_channel_topic_all(), ast_parking_topic(), cel_aggregation_topic, cel_bridge_forwarder, cel_cel_forwarder, cel_channel_forwarder, cel_parking_forwarder, cel_topic, stasis_forward_all(), and stasis_topic_create().

Referenced by load_module().

◆ destroy_routes()

static void destroy_routes ( void  )
static

Definition at line 1454 of file cel.c.

1455{
1458}
void stasis_message_router_unsubscribe_and_join(struct stasis_message_router *router)
Unsubscribe the router from the upstream topic, blocking until the final message has been processed.

References cel_state_router, NULL, and stasis_message_router_unsubscribe_and_join().

Referenced by ast_cel_set_config(), reload_module(), and unload_module().

◆ destroy_subscriptions()

static void destroy_subscriptions ( void  )
static

◆ events_handler()

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

Definition at line 460 of file cel.c.

461{
462 struct ast_cel_general_config *cfg = obj;
463 char *events = ast_strdupa(var->value);
464 char *cur_event;
465
466 while ((cur_event = strsep(&events, ","))) {
467 enum ast_cel_event_type event_type;
468
469 cur_event = ast_strip(cur_event);
470 if (ast_strlen_zero(cur_event)) {
471 continue;
472 }
473
474 event_type = ast_cel_str_to_event_type(cur_event);
475
476 if (event_type == AST_CEL_ALL) {
477 /* All events */
478 cfg->events = (int64_t) -1;
479 } else if (event_type == AST_CEL_INVALID_VALUE) {
480 return -1;
481 } else {
482 cfg->events |= ((int64_t) 1 << event_type);
483 }
484 }
485
486 return 0;
487}
static const struct adsi_event events[]
Definition: app_adsiprog.c:88
enum ast_cel_event_type ast_cel_str_to_event_type(const char *name)
Get the event type from a string.
Definition: cel.c:435
ast_cel_event_type
CEL event types.
Definition: cel.h:41
@ AST_CEL_ALL
Definition: cel.h:43

References AST_CEL_ALL, AST_CEL_INVALID_VALUE, ast_cel_str_to_event_type(), ast_strdupa, ast_strip(), ast_strlen_zero(), events, ast_cel_general_config::events, strsep(), and var.

Referenced by load_module().

◆ get_blob_variable()

static const char * get_blob_variable ( struct ast_multi_channel_blob blob,
const char *  varname 
)
static

Definition at line 899 of file cel.c.

900{
901 struct ast_json *json = ast_multi_channel_blob_get_json(blob);
902 if (!json) {
903 return NULL;
904 }
905
906 json = ast_json_object_get(json, varname);
907 if (!json) {
908 return NULL;
909 }
910
911 return ast_json_string_get(json);
912}
struct ast_json * ast_multi_channel_blob_get_json(struct ast_multi_channel_blob *obj)
Retrieve the JSON blob from a ast_multi_channel_blob. Returned ast_json is still owned by obj.

References ast_json_object_get(), ast_json_string_get(), ast_multi_channel_blob_get_json(), and NULL.

Referenced by cel_dial_cb(), is_valid_dialstatus(), and save_dialstatus().

◆ get_dialstatus()

static struct cel_dialstatus * get_dialstatus ( const char *  uniqueid)
static

Definition at line 887 of file cel.c.

888{
889 struct ao2_container *dial_statuses = ao2_global_obj_ref(cel_dialstatus_store);
891
892 if (dial_statuses) {
894 ao2_ref(dial_statuses, -1);
895 }
896 return dialstatus;
897}
char uniqueid[AST_MAX_UNIQUEID]
Definition: cel.c:190

References ao2_find, ao2_global_obj_ref, ao2_ref, cel_dialstatus::dialstatus, NULL, OBJ_SEARCH_KEY, OBJ_UNLINK, and cel_dialstatus::uniqueid.

Referenced by cel_channel_state_change().

◆ handle_cli_status()

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

Definition at line 370 of file cel.c.

371{
372 unsigned int i;
373 RAII_VAR(struct cel_config *, cfg, ao2_global_obj_ref(cel_configs), ao2_cleanup);
375 struct ao2_iterator iter;
376 char *app;
377
378 switch (cmd) {
379 case CLI_INIT:
380 e->command = "cel show status";
381 e->usage =
382 "Usage: cel show status\n"
383 " Displays the Channel Event Logging system status.\n";
384 return NULL;
385 case CLI_GENERATE:
386 return NULL;
387 case CLI_HANDLER:
388 break;
389 }
390
391 if (a->argc > 3) {
392 return CLI_SHOWUSAGE;
393 }
394
395 ast_cli(a->fd, "CEL Logging: %s\n", ast_cel_check_enabled() ? "Enabled" : "Disabled");
396
397 if (!cfg || !cfg->general || !cfg->general->enable) {
398 return CLI_SUCCESS;
399 }
400
401 for (i = 0; i < (sizeof(cfg->general->events) * 8); i++) {
402 const char *name;
403
404 if (!(cfg->general->events & ((int64_t) 1 << i))) {
405 continue;
406 }
407
409 if (strcasecmp(name, "Unknown")) {
410 ast_cli(a->fd, "CEL Tracking Event: %s\n", name);
411 }
412 }
413
414 iter = ao2_iterator_init(cfg->general->apps, 0);
415 for (; (app = ao2_iterator_next(&iter)); ao2_ref(app, -1)) {
416 ast_cli(a->fd, "CEL Tracking Application: %s\n", app);
417 }
419
420 if (backends) {
421 struct cel_backend *backend;
422
423 iter = ao2_iterator_init(backends, 0);
424 for (; (backend = ao2_iterator_next(&iter)); ao2_ref(backend, -1)) {
425 ast_cli(a->fd, "CEL Event Subscriber: %s\n", backend->name);
426 }
428 }
429
430 return CLI_SUCCESS;
431}
#define CLI_SHOWUSAGE
Definition: cli.h:45
#define CLI_SUCCESS
Definition: cli.h:44
void ast_cli(int fd, const char *fmt,...)
Definition: clicompat.c:6
@ CLI_HANDLER
Definition: cli.h:154
@ CLI_INIT
Definition: cli.h:152
@ CLI_GENERATE
Definition: cli.h:153
char * command
Definition: cli.h:186
const char * usage
Definition: cli.h:177
static struct test_val a

References a, ao2_cleanup, ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, app, ast_cel_check_enabled(), ast_cel_get_type_name(), ast_cli(), CLI_GENERATE, CLI_HANDLER, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, cel_backend::name, name, NULL, RAII_VAR, and ast_cli_entry::usage.

◆ is_valid_dialstatus()

static int is_valid_dialstatus ( struct ast_multi_channel_blob blob)
static

Definition at line 1219 of file cel.c.

1220{
1221 const char *dialstatus = get_blob_variable(blob, "dialstatus");
1222 int res = 0;
1223
1224 if (ast_strlen_zero(dialstatus)) {
1225 res = 0;
1226 } else if (!strcasecmp(dialstatus, "CHANUNAVAIL")) {
1227 res = 1;
1228 } else if (!strcasecmp(dialstatus, "CONGESTION")) {
1229 res = 1;
1230 } else if (!strcasecmp(dialstatus, "NOANSWER")) {
1231 res = 1;
1232 } else if (!strcasecmp(dialstatus, "BUSY")) {
1233 res = 1;
1234 } else if (!strcasecmp(dialstatus, "ANSWER")) {
1235 res = 1;
1236 } else if (!strcasecmp(dialstatus, "CANCEL")) {
1237 res = 1;
1238 } else if (!strcasecmp(dialstatus, "DONTCALL")) {
1239 res = 1;
1240 } else if (!strcasecmp(dialstatus, "TORTURE")) {
1241 res = 1;
1242 } else if (!strcasecmp(dialstatus, "INVALIDARGS")) {
1243 res = 1;
1244 }
1245 return res;
1246}

References ast_strlen_zero(), cel_dialstatus::dialstatus, and get_blob_variable().

Referenced by cel_dial_cb().

◆ load_module()

static int load_module ( void  )
static

Definition at line 1614 of file cel.c.

1615{
1616 struct ao2_container *container;
1617
1619 NUM_APP_BUCKETS, cel_linkedid_hash_fn, NULL, cel_linkedid_cmp_fn);
1622 if (!container) {
1624 }
1625
1627 NUM_DIALSTATUS_BUCKETS, cel_dialstatus_hash_fn, NULL, cel_dialstatus_cmp_fn);
1628 ao2_global_obj_replace_unref(cel_dialstatus_store, container);
1630 if (!container) {
1632 }
1633
1636 }
1637
1640 }
1641
1643 cel_backend_hash_fn, NULL, cel_backend_cmp_fn);
1646 if (!container) {
1648 }
1649
1650 if (aco_info_init(&cel_cfg_info)) {
1652 }
1653
1654 aco_option_register(&cel_cfg_info, "enable", ACO_EXACT, general_options, "no", OPT_BOOL_T, 1, FLDSET(struct ast_cel_general_config, enable));
1655 aco_option_register(&cel_cfg_info, "dateformat", ACO_EXACT, general_options, "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_cel_general_config, date_format));
1656 aco_option_register_custom(&cel_cfg_info, "apps", ACO_EXACT, general_options, "", apps_handler, 0);
1657 aco_option_register_custom(&cel_cfg_info, "events", ACO_EXACT, general_options, "", events_handler, 0);
1658
1659 if (aco_process_config(&cel_cfg_info, 0)) {
1660 struct cel_config *cel_cfg = cel_config_alloc();
1661
1662 if (!cel_cfg) {
1664 }
1665
1666 /* We couldn't process the configuration so create a default config. */
1667 if (!aco_set_defaults(&general_option, "general", cel_cfg->general)) {
1668 ast_log(LOG_NOTICE, "Failed to process CEL configuration; using defaults\n");
1669 ao2_global_obj_replace_unref(cel_configs, cel_cfg);
1670 }
1671 ao2_ref(cel_cfg, -1);
1672 }
1673
1674 if (create_subscriptions()) {
1676 }
1677
1680 }
1681
1683}
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition: astobj2.h:363
#define ao2_global_obj_replace_unref(holder, obj)
Replace an ao2 object in the global holder, throwing away any old object.
Definition: astobj2.h:901
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition: astobj2.h:1303
#define BACKEND_BUCKETS
Definition: cel.c:157
static struct ast_cli_entry cli_status
Definition: cel.c:433
static int create_subscriptions(void)
Create the Stasis subscriptions for CEL.
Definition: cel.c:1492
static struct aco_type general_option
An aco_type structure to link the "general" category to the ast_cel_general_config type.
Definition: cel.c:257
static int events_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
Definition: cel.c:460
#define NUM_DIALSTATUS_BUCKETS
Number of buckets for the dialstatus container.
Definition: cel.c:176
static struct aco_type * general_options[]
Definition: cel.c:316
static int apps_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
Definition: cel.c:489
static void * cel_config_alloc(void)
Definition: cel.c:240
#define ast_cli_register(e)
Registers a command or an array of commands.
Definition: cli.h:256
@ ACO_EXACT
int aco_set_defaults(struct aco_type *type, const char *category, void *obj)
Set all default options of obj.
#define STRFLDSET(type,...)
Convert a struct and a list of stringfield fields to an argument list of field offsets.
int aco_info_init(struct aco_info *info)
Initialize an aco_info structure.
#define FLDSET(type,...)
Convert a struct and list of fields to an argument list of field offsets.
#define aco_option_register(info, name, matchtype, types, default_val, opt_type, flags,...)
Register a config option.
@ OPT_BOOL_T
Type for default option handler for bools (ast_true/ast_false)
@ OPT_STRINGFIELD_T
Type for default option handler for stringfields.
#define aco_option_register_custom(info, name, matchtype, types, default_val, handler, flags)
Register a config option.
enum aco_process_status aco_process_config(struct aco_info *info, int reload)
Process a config info via the options registered with an aco_info.
#define LOG_NOTICE
@ AST_MODULE_LOAD_FAILURE
Module could not be loaded properly.
Definition: module.h:102
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
struct ao2_container * container
Definition: res_fax.c:531
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1493

References ACO_EXACT, aco_info_init(), aco_option_register, aco_option_register_custom, aco_process_config(), aco_set_defaults(), AO2_ALLOC_OPT_LOCK_MUTEX, ao2_cleanup, ao2_container_alloc_hash, ao2_global_obj_replace_unref, ao2_ref, apps_handler(), ast_cel_check_enabled(), ast_cli_register, ast_log, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, BACKEND_BUCKETS, cel_config_alloc(), cel_generic_type(), cli_status, container, create_routes(), create_subscriptions(), events_handler(), FLDSET, cel_config::general, general_option, general_options, LOG_NOTICE, NULL, NUM_APP_BUCKETS, NUM_DIALSTATUS_BUCKETS, OPT_BOOL_T, OPT_STRINGFIELD_T, STASIS_MESSAGE_TYPE_INIT, and STRFLDSET.

◆ reload_module()

static int reload_module ( void  )
static

Definition at line 1685 of file cel.c.

1686{
1687 unsigned int was_enabled = ast_cel_check_enabled();
1688 unsigned int is_enabled;
1689
1690 if (aco_process_config(&cel_cfg_info, 1) == ACO_PROCESS_ERROR) {
1691 return -1;
1692 }
1693
1695
1696 if (!was_enabled && is_enabled) {
1697 if (create_routes()) {
1698 return -1;
1699 }
1700 } else if (was_enabled && !is_enabled) {
1702 }
1703
1704 ast_verb(3, "CEL logging %sabled.\n", is_enabled ? "en" : "dis");
1705
1706 return 0;
1707}
@ ACO_PROCESS_ERROR
Their was an error and no changes were applied.
#define ast_verb(level,...)

References aco_process_config(), ACO_PROCESS_ERROR, ast_cel_check_enabled(), ast_verb, create_routes(), destroy_routes(), and is_enabled().

◆ save_dialstatus()

static void save_dialstatus ( struct ast_multi_channel_blob blob,
struct ast_channel_snapshot snapshot 
)
static

Definition at line 1175 of file cel.c.

1176{
1177 struct ao2_container *dial_statuses = ao2_global_obj_ref(cel_dialstatus_store);
1178 const char *dialstatus_string = get_blob_variable(blob, "dialstatus");
1179 struct cel_dialstatus *dialstatus;
1180 size_t dialstatus_string_len;
1181
1182 if (!dial_statuses || ast_strlen_zero(dialstatus_string)) {
1183 ao2_cleanup(dial_statuses);
1184 return;
1185 }
1186
1187 dialstatus = ao2_find(dial_statuses, snapshot->base->uniqueid, OBJ_SEARCH_KEY);
1188 if (dialstatus) {
1189 if (!strcasecmp(dialstatus_string, "ANSWER") && strcasecmp(dialstatus->dialstatus, "ANSWER")) {
1190 /* In the case of an answer after we already have a dial status we give
1191 * priority to the answer since the call was, well, answered. In the case of
1192 * failure dial status results we simply let the first failure be the status.
1193 */
1194 ao2_unlink(dial_statuses, dialstatus);
1195 ao2_ref(dialstatus, -1);
1196 } else {
1197 ao2_ref(dialstatus, -1);
1198 ao2_ref(dial_statuses, -1);
1199 return;
1200 }
1201 }
1202
1203 dialstatus_string_len = strlen(dialstatus_string) + 1;
1204 dialstatus = ao2_alloc_options(sizeof(*dialstatus) + dialstatus_string_len, NULL,
1206 if (!dialstatus) {
1207 ao2_ref(dial_statuses, -1);
1208 return;
1209 }
1210
1211 ast_copy_string(dialstatus->uniqueid, snapshot->base->uniqueid, sizeof(dialstatus->uniqueid));
1212 ast_copy_string(dialstatus->dialstatus, dialstatus_string, dialstatus_string_len);
1213
1214 ao2_link(dial_statuses, dialstatus);
1215 ao2_ref(dialstatus, -1);
1216 ao2_ref(dial_statuses, -1);
1217}
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_link, ao2_ref, ao2_unlink, ast_copy_string(), ast_strlen_zero(), ast_channel_snapshot::base, cel_dialstatus::dialstatus, get_blob_variable(), NULL, OBJ_SEARCH_KEY, and ast_channel_snapshot_base::uniqueid.

Referenced by cel_dial_cb().

◆ STASIS_MESSAGE_TYPE_DEFN()

STASIS_MESSAGE_TYPE_DEFN ( cel_generic_type  )

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 1473 of file cel.c.

1474{
1478
1480 aco_info_destroy(&cel_cfg_info);
1481 ao2_global_obj_release(cel_configs);
1482 ao2_global_obj_release(cel_dialstatus_store);
1483 ao2_global_obj_release(cel_linkedids);
1484 ao2_global_obj_release(cel_backends);
1485
1486 return 0;
1487}
#define ao2_global_obj_release(holder)
Release the ao2 object held in the global holder.
Definition: astobj2.h:859
static void destroy_subscriptions(void)
Definition: cel.c:1460
int ast_cli_unregister(struct ast_cli_entry *e)
Unregisters a command or an array of commands.
Definition: main/cli.c:2439
void aco_info_destroy(struct aco_info *info)
Destroy an initialized aco_info struct.
#define STASIS_MESSAGE_TYPE_CLEANUP(name)
Boiler-plate messaging macro for cleaning up message types.
Definition: stasis.h:1515

References aco_info_destroy(), ao2_global_obj_release, ast_cli_unregister(), cel_generic_type(), cli_status, destroy_routes(), destroy_subscriptions(), and STASIS_MESSAGE_TYPE_CLEANUP.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "CEL Engine" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CORE, .requires = "extconfig", }
static

Definition at line 1828 of file cel.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 1828 of file cel.c.

◆ cel_aggregation_topic

struct stasis_topic* cel_aggregation_topic
static

Aggregation topic for all topics CEL needs to know about

Definition at line 136 of file cel.c.

Referenced by create_routes(), create_subscriptions(), and destroy_subscriptions().

◆ cel_bridge_forwarder

struct stasis_forward* cel_bridge_forwarder
static

Subscription for forwarding the channel caching topic

Definition at line 142 of file cel.c.

Referenced by create_subscriptions(), and destroy_subscriptions().

◆ cel_cel_forwarder

struct stasis_forward* cel_cel_forwarder
static

Subscription for forwarding the CEL-specific topic

Definition at line 148 of file cel.c.

Referenced by create_subscriptions(), and destroy_subscriptions().

◆ cel_channel_forwarder

struct stasis_forward* cel_channel_forwarder
static

Subscription for forwarding the channel caching topic

Definition at line 139 of file cel.c.

Referenced by create_subscriptions(), and destroy_subscriptions().

◆ cel_channel_monitors

cel_channel_snapshot_monitor cel_channel_monitors[]
Initial value:
= {
}
static void cel_channel_linkedid_change(struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
Definition: cel.c:955
static void cel_channel_state_change(struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
Handle channel state changes.
Definition: cel.c:915
static void cel_channel_app_change(struct ast_channel_snapshot *old_snapshot, struct ast_channel_snapshot *new_snapshot, const struct timeval *event_time)
Definition: cel.c:974

Handlers for channel snapshot changes.

Note
Order of the handlers matters. Application changes must come before state changes to ensure that hangup notifications occur after application changes. Linkedid checking should always come last.

Definition at line 999 of file cel.c.

Referenced by cel_snapshot_update_cb().

◆ cel_conf

struct aco_file cel_conf
static
Initial value:
= {
.filename = "cel.conf",
}
static struct aco_type ignore_option
Definition: cel.c:272
#define ACO_TYPES(...)
A helper macro to ensure that aco_info types always have a sentinel.

The config file to be processed for the module.

Definition at line 280 of file cel.c.

◆ cel_event_types

const char* const cel_event_types[CEL_MAX_EVENT_IDS]
static

Map of ast_cel_event_type to strings.

Definition at line 321 of file cel.c.

Referenced by ast_cel_get_type_name(), and ast_cel_str_to_event_type().

◆ cel_parking_forwarder

struct stasis_forward* cel_parking_forwarder
static

Subscription for forwarding the parking topic

Definition at line 145 of file cel.c.

Referenced by create_subscriptions(), and destroy_subscriptions().

◆ cel_state_router

struct stasis_message_router* cel_state_router
static

Message router for state that CEL needs to know about

Definition at line 130 of file cel.c.

Referenced by create_routes(), and destroy_routes().

◆ cel_topic

struct stasis_topic* cel_topic
static

Topic for CEL-specific messages

Definition at line 133 of file cel.c.

Referenced by ast_cel_topic(), create_subscriptions(), and destroy_subscriptions().

◆ cli_status

struct ast_cli_entry cli_status = { .handler = handle_cli_status , .summary = "Display the CEL status" ,}
static

Definition at line 433 of file cel.c.

Referenced by load_module(), and unload_module().

◆ fabricated_channel_datastore

const struct ast_datastore_info fabricated_channel_datastore
static
Initial value:
= {
.type = "CEL fabricated channel",
.destroy = ast_free_ptr,
}
void ast_free_ptr(void *ptr)
free() wrapper
Definition: astmm.c:1739

Definition at line 673 of file cel.c.

Referenced by ast_cel_fabricate_channel_from_event().

◆ general_option

struct aco_type general_option
static

An aco_type structure to link the "general" category to the ast_cel_general_config type.

Definition at line 257 of file cel.c.

Referenced by load_module().

◆ general_options

struct aco_type* general_options[] = ACO_TYPES(&general_option)
static

Definition at line 316 of file cel.c.

Referenced by load_module().

◆ ignore_categories

const char* ignore_categories[]
static
Initial value:
= {
"manager",
"radius",
}

Config sections used by existing modules. Do not add to this list.

Definition at line 266 of file cel.c.

◆ ignore_option

struct aco_type ignore_option
static

Definition at line 272 of file cel.c.