Wed Apr 6 11:30:04 2011

Asterisk developer's documentation


func_audiohookinherit.c File Reference

Audiohook inheritance function. More...

#include "asterisk.h"
#include "asterisk/datastore.h"
#include "asterisk/channel.h"
#include "asterisk/logger.h"
#include "asterisk/audiohook.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"

Go to the source code of this file.

Data Structures

struct  audiohook_inheritance_datastore
struct  inheritable_audiohook

Functions

static void __reg_module (void)
static void __unreg_module (void)
static void audiohook_inheritance_destroy (void *data)
 Destroy dynamically allocated data on an audiohook_inheritance_datastore.
static void audiohook_inheritance_fixup (void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
 Move audiohooks as defined by previous calls to the AUDIOHOOK_INHERIT function.
static int func_inheritance_write (struct ast_channel *chan, const char *function, char *data, const char *value)
 Set the permissibility of inheritance for a particular audiohook source on a channel.
static int load_module (void)
static int setup_inheritable_audiohook (struct audiohook_inheritance_datastore *audiohook_inheritance_datastore, const char *source)
 Create a new inheritable_audiohook structure and add it to an audiohook_inheritance_datastore.
static struct audiohook_inheritance_datastoresetup_inheritance_datastore (struct ast_channel *chan)
 create an audiohook_inheritance_datastore and attach it to a channel
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Audiohook inheritance function" , .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 = "8586c2a7d357cb591cc3a6607a8f62d1" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static struct ast_module_infoast_module_info = &__mod_info
static struct ast_datastore_info audiohook_inheritance_info
static struct ast_custom_function inheritance_function


Detailed Description

Audiohook inheritance function.

Author:
Mark Michelson <mmichelson@digium.com>

Definition in file func_audiohookinherit.c.


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 295 of file func_audiohookinherit.c.

static void __unreg_module ( void   )  [static]

Definition at line 295 of file func_audiohookinherit.c.

static void audiohook_inheritance_destroy ( void *  data  )  [static]

Destroy dynamically allocated data on an audiohook_inheritance_datastore.

Parameters:
data Pointer to the audiohook_inheritance_datastore in question.
Returns:
Void

Definition at line 137 of file func_audiohookinherit.c.

References audiohook_inheritance_datastore::allowed_list, ast_free, AST_LIST_REMOVE_HEAD, and inheritable_audiohook::list.

00138 {
00139    struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = data;
00140    struct inheritable_audiohook *inheritable_audiohook = NULL;
00141 
00142    while ((inheritable_audiohook = AST_LIST_REMOVE_HEAD(&audiohook_inheritance_datastore->allowed_list, list))) {
00143       ast_free(inheritable_audiohook);
00144    }
00145 
00146    ast_free(audiohook_inheritance_datastore);
00147 }

static void audiohook_inheritance_fixup ( void *  data,
struct ast_channel old_chan,
struct ast_channel new_chan 
) [static]

Move audiohooks as defined by previous calls to the AUDIOHOOK_INHERIT function.

Move allowed audiohooks from the old channel to the new channel.

Parameters:
data The ast_datastore containing audiohook inheritance information that will be moved
old_chan The "clone" channel from a masquerade. We are moving the audiohook in question off of this channel
new_chan The "original" channel from a masquerade. We are moving the audiohook in question to this channel
Returns:
Void

Definition at line 117 of file func_audiohookinherit.c.

References audiohook_inheritance_datastore::allowed_list, ast_audiohook_move_by_source(), ast_debug, AST_LIST_TRAVERSE, inheritable_audiohook::list, ast_channel::name, and inheritable_audiohook::source.

00118 {
00119    struct inheritable_audiohook *audiohook = NULL;
00120    struct audiohook_inheritance_datastore *datastore = data;
00121 
00122    ast_debug(2, "inheritance fixup occurring for channels %s(%p) and %s(%p)", old_chan->name, old_chan, new_chan->name, new_chan);
00123 
00124    AST_LIST_TRAVERSE(&datastore->allowed_list, audiohook, list) {
00125       ast_audiohook_move_by_source(old_chan, new_chan, audiohook->source);
00126       ast_debug(3, "Moved audiohook %s from %s(%p) to %s(%p)\n",
00127          audiohook->source, old_chan->name, old_chan, new_chan->name, new_chan);
00128    }
00129    return;
00130 }

static int func_inheritance_write ( struct ast_channel chan,
const char *  function,
char *  data,
const char *  value 
) [static]

Set the permissibility of inheritance for a particular audiohook source on a channel.

For details regarding what happens in the function, see the inline comments

Parameters:
chan The channel we are operating on
function The name of the dialplan function (AUDIOHOOK_INHERIT)
data The audiohook source for which we are setting inheritance permissions
value The value indicating the permission for audiohook inheritance

Definition at line 207 of file func_audiohookinherit.c.

References audiohook_inheritance_datastore::allowed_list, ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_debug, ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), ast_strlen_zero(), ast_true(), audiohook_inheritance_info, ast_datastore::data, inheritable_audiohook::list, LOG_WARNING, ast_channel::name, setup_inheritable_audiohook(), setup_inheritance_datastore(), and inheritable_audiohook::source.

00208 {
00209    int allow;
00210    struct ast_datastore *datastore = NULL;
00211    struct audiohook_inheritance_datastore *inheritance_datastore = NULL;
00212    struct inheritable_audiohook *inheritable_audiohook;
00213 
00214    /* Step 1: Get data from function call */
00215    if (ast_strlen_zero(data)) {
00216       ast_log(LOG_WARNING, "No argument provided to INHERITANCE function.\n");
00217       return -1;
00218    }
00219 
00220    if (ast_strlen_zero(value)) {
00221       ast_log(LOG_WARNING, "No value provided to INHERITANCE function.\n");
00222       return -1;
00223    }
00224 
00225    allow = ast_true(value);
00226 
00227    /* Step 2: retrieve or set up datastore */
00228    ast_channel_lock(chan);
00229    if (!(datastore = ast_channel_datastore_find(chan, &audiohook_inheritance_info, NULL))) {
00230       ast_channel_unlock(chan);
00231       /* In the case where we cannot find the datastore, we can take a few shortcuts */
00232       if (!allow) {
00233          ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name);
00234          return 0;
00235       } else if (!(inheritance_datastore = setup_inheritance_datastore(chan))) {
00236          ast_log(LOG_WARNING, "Unable to set up audiohook inheritance datastore on channel %s\n", chan->name);
00237          return -1;
00238       } else {
00239          return setup_inheritable_audiohook(inheritance_datastore, data);
00240       }
00241    } else {
00242       inheritance_datastore = datastore->data;
00243    }
00244    ast_channel_unlock(chan);
00245 
00246    /* Step 3: Traverse the list to see if we're trying something redundant */
00247 
00248    AST_LIST_TRAVERSE_SAFE_BEGIN(&inheritance_datastore->allowed_list, inheritable_audiohook, list) {
00249       if (!strcasecmp(inheritable_audiohook->source, data)) {
00250          if (allow) {
00251             ast_debug(2, "Audiohook source %s is already set up to be inherited from channel %s\n", data, chan->name);
00252             return 0;
00253          } else {
00254             ast_debug(2, "Removing inheritability of audiohook %s from channel %s\n", data, chan->name);
00255             AST_LIST_REMOVE_CURRENT(list);
00256             ast_free(inheritable_audiohook);
00257             return 0;
00258          }
00259       }
00260    }
00261    AST_LIST_TRAVERSE_SAFE_END;
00262 
00263    /* Step 4: There is no step 4 */
00264 
00265    /* Step 5: This means we are addressing an audiohook source which we have not encountered yet for the channel. Create a new inheritable
00266     * audiohook structure if we're allowing inheritance, or just return if not
00267     */
00268 
00269    if (allow) {
00270       return setup_inheritable_audiohook(inheritance_datastore, data);
00271    } else {
00272       ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name);
00273       return 0;
00274    }
00275 }

static int load_module ( void   )  [static]

Definition at line 287 of file func_audiohookinherit.c.

References ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and inheritance_function.

00288 {
00289    if (ast_custom_function_register(&inheritance_function)) {
00290       return AST_MODULE_LOAD_DECLINE;
00291    } else {
00292       return AST_MODULE_LOAD_SUCCESS;
00293    }
00294 }

static int setup_inheritable_audiohook ( struct audiohook_inheritance_datastore audiohook_inheritance_datastore,
const char *  source 
) [static]

Create a new inheritable_audiohook structure and add it to an audiohook_inheritance_datastore.

Parameters:
audiohook_inheritance_datastore The audiohook_inheritance_datastore we want to add the new inheritable_audiohook to
source The audiohook source for the newly created inheritable_audiohook
Return values:
0 Success
non-zero Failure

Definition at line 182 of file func_audiohookinherit.c.

References audiohook_inheritance_datastore::allowed_list, ast_calloc, ast_debug, AST_LIST_INSERT_TAIL, and inheritable_audiohook::list.

Referenced by func_inheritance_write().

00183 {
00184    struct inheritable_audiohook *inheritable_audiohook = NULL;
00185 
00186    inheritable_audiohook = ast_calloc(1, sizeof(*inheritable_audiohook) + strlen(source));
00187 
00188    if (!inheritable_audiohook) {
00189       return -1;
00190    }
00191 
00192    strcpy(inheritable_audiohook->source, source);
00193    AST_LIST_INSERT_TAIL(&audiohook_inheritance_datastore->allowed_list, inheritable_audiohook, list);
00194    ast_debug(3, "Set audiohook %s to be inheritable\n", source);
00195    return 0;
00196 }

static struct audiohook_inheritance_datastore* setup_inheritance_datastore ( struct ast_channel chan  )  [static]

create an audiohook_inheritance_datastore and attach it to a channel

Parameters:
chan The channel to which we wish to attach the new datastore
Returns:
Returns the newly created audiohook_inheritance_datastore or NULL on error

Definition at line 154 of file func_audiohookinherit.c.

References ast_calloc, ast_channel_datastore_add(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), audiohook_inheritance_info, and ast_datastore::data.

Referenced by func_inheritance_write().

00155 {
00156    struct ast_datastore *datastore = NULL;
00157    struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = NULL;
00158 
00159    if (!(datastore = ast_datastore_alloc(&audiohook_inheritance_info, NULL))) {
00160       return NULL;
00161    }
00162 
00163    if (!(audiohook_inheritance_datastore = ast_calloc(1, sizeof(*audiohook_inheritance_datastore)))) {
00164       ast_datastore_free(datastore);
00165       return NULL;
00166    }
00167 
00168    datastore->data = audiohook_inheritance_datastore;
00169    ast_channel_lock(chan);
00170    ast_channel_datastore_add(chan, datastore);
00171    ast_channel_unlock(chan);
00172    return audiohook_inheritance_datastore;
00173 }

static int unload_module ( void   )  [static]

Definition at line 282 of file func_audiohookinherit.c.

References ast_custom_function_unregister(), and inheritance_function.

00283 {
00284    return ast_custom_function_unregister(&inheritance_function);
00285 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Audiohook inheritance function" , .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 = "8586c2a7d357cb591cc3a6607a8f62d1" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static]

Definition at line 295 of file func_audiohookinherit.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 295 of file func_audiohookinherit.c.

struct ast_datastore_info audiohook_inheritance_info [static]

Initial value:

 {
   .type = "audiohook inheritance",
   .destroy = audiohook_inheritance_destroy,
   .chan_fixup = audiohook_inheritance_fixup,
}

Definition at line 102 of file func_audiohookinherit.c.

Referenced by func_inheritance_write(), and setup_inheritance_datastore().

struct ast_custom_function inheritance_function [static]

Initial value:

 {
   .name = "AUDIOHOOK_INHERIT",
   .write = func_inheritance_write,
}

Definition at line 277 of file func_audiohookinherit.c.

Referenced by load_module(), and unload_module().


Generated on Wed Apr 6 11:30:04 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7