Mon Oct 8 12:39:22 2012

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 = "ac1f6a56484a8820659555499174e588" , .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 299 of file func_audiohookinherit.c.

static void __unreg_module ( void   )  [static]

Definition at line 299 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 141 of file func_audiohookinherit.c.

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

00142 {
00143    struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = data;
00144    struct inheritable_audiohook *inheritable_audiohook = NULL;
00145 
00146    while ((inheritable_audiohook = AST_LIST_REMOVE_HEAD(&audiohook_inheritance_datastore->allowed_list, list))) {
00147       ast_free(inheritable_audiohook);
00148    }
00149 
00150    ast_free(audiohook_inheritance_datastore);
00151 }

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 121 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.

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

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 211 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.

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

static int load_module ( void   )  [static]

Definition at line 291 of file func_audiohookinherit.c.

References ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and inheritance_function.

00292 {
00293    if (ast_custom_function_register(&inheritance_function)) {
00294       return AST_MODULE_LOAD_DECLINE;
00295    } else {
00296       return AST_MODULE_LOAD_SUCCESS;
00297    }
00298 }

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

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

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

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

static int unload_module ( void   )  [static]

Definition at line 286 of file func_audiohookinherit.c.

References ast_custom_function_unregister(), and inheritance_function.

00287 {
00288    return ast_custom_function_unregister(&inheritance_function);
00289 }


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 = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static]

Definition at line 299 of file func_audiohookinherit.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 299 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 106 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 281 of file func_audiohookinherit.c.

Referenced by load_module(), and unload_module().


Generated on Mon Oct 8 12:39:22 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7