#include "asterisk.h"
#include "asterisk/channel.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_datastore * | setup_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_DEFAULT , .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 = "068e67f60f50dd9ee86464c05884a49d" , .load = load_module, .unload = unload_module, } |
static const struct ast_module_info * | ast_module_info = &__mod_info |
static struct ast_datastore_info | audiohook_inheritance_info |
static struct ast_custom_function | inheritance_function |
Definition in file func_audiohookinherit.c.
static void __reg_module | ( | void | ) | [static] |
Definition at line 267 of file func_audiohookinherit.c.
static void __unreg_module | ( | void | ) | [static] |
Definition at line 267 of file func_audiohookinherit.c.
static void audiohook_inheritance_destroy | ( | void * | data | ) | [static] |
Destroy dynamically allocated data on an audiohook_inheritance_datastore.
data | Pointer to the audiohook_inheritance_datastore in question. |
Definition at line 83 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_free, AST_LIST_REMOVE_HEAD, and inheritable_audiohook::list.
00084 { 00085 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = data; 00086 struct inheritable_audiohook *inheritable_audiohook = NULL; 00087 00088 while ((inheritable_audiohook = AST_LIST_REMOVE_HEAD(&audiohook_inheritance_datastore->allowed_list, list))) { 00089 ast_free(inheritable_audiohook); 00090 } 00091 }
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.
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 |
Definition at line 63 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.
00064 { 00065 struct inheritable_audiohook *audiohook = NULL; 00066 struct audiohook_inheritance_datastore *datastore = data; 00067 00068 ast_debug(2, "inheritance fixup occurring for channels %s(%p) and %s(%p)", old_chan->name, old_chan, new_chan->name, new_chan); 00069 00070 AST_LIST_TRAVERSE(&datastore->allowed_list, audiohook, list) { 00071 ast_audiohook_move_by_source(old_chan, new_chan, audiohook->source); 00072 ast_debug(3, "Moved audiohook %s from %s(%p) to %s(%p)\n", 00073 audiohook->source, old_chan->name, old_chan, new_chan->name, new_chan); 00074 } 00075 return; 00076 }
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
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 151 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, chan, ast_datastore::data, inheritable_audiohook::list, LOG_WARNING, ast_channel::name, setup_inheritable_audiohook(), setup_inheritance_datastore(), and inheritable_audiohook::source.
00152 { 00153 int allow; 00154 struct ast_datastore *datastore = NULL; 00155 struct audiohook_inheritance_datastore *inheritance_datastore = NULL; 00156 struct inheritable_audiohook *inheritable_audiohook; 00157 00158 /* Step 1: Get data from function call */ 00159 if (ast_strlen_zero(data)) { 00160 ast_log(LOG_WARNING, "No argument provided to INHERITANCE function.\n"); 00161 return -1; 00162 } 00163 00164 if (ast_strlen_zero(value)) { 00165 ast_log(LOG_WARNING, "No value provided to INHERITANCE function.\n"); 00166 return -1; 00167 } 00168 00169 allow = ast_true(value); 00170 00171 /* Step 2: retrieve or set up datastore */ 00172 ast_channel_lock(chan); 00173 if (!(datastore = ast_channel_datastore_find(chan, &audiohook_inheritance_info, NULL))) { 00174 ast_channel_unlock(chan); 00175 /* In the case where we cannot find the datastore, we can take a few shortcuts */ 00176 if (!allow) { 00177 ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00178 return 0; 00179 } else if (!(inheritance_datastore = setup_inheritance_datastore(chan))) { 00180 ast_log(LOG_WARNING, "Unable to set up audiohook inheritance datastore on channel %s\n", chan->name); 00181 return -1; 00182 } else { 00183 return setup_inheritable_audiohook(inheritance_datastore, data); 00184 } 00185 } else { 00186 inheritance_datastore = datastore->data; 00187 } 00188 ast_channel_unlock(chan); 00189 00190 /* Step 3: Traverse the list to see if we're trying something redundant */ 00191 00192 AST_LIST_TRAVERSE_SAFE_BEGIN(&inheritance_datastore->allowed_list, inheritable_audiohook, list) { 00193 if (!strcasecmp(inheritable_audiohook->source, data)) { 00194 if (allow) { 00195 ast_debug(2, "Audiohook source %s is already set up to be inherited from channel %s\n", data, chan->name); 00196 return 0; 00197 } else { 00198 ast_debug(2, "Removing inheritability of audiohook %s from channel %s\n", data, chan->name); 00199 AST_LIST_REMOVE_CURRENT(list); 00200 ast_free(inheritable_audiohook); 00201 return 0; 00202 } 00203 } 00204 } 00205 AST_LIST_TRAVERSE_SAFE_END; 00206 00207 /* Step 4: There is no step 4 */ 00208 00209 /* Step 5: This means we are addressing an audiohook source which we have not encountered yet for the channel. Create a new inheritable 00210 * audiohook structure if we're allowing inheritance, or just return if not 00211 */ 00212 00213 if (allow) { 00214 return setup_inheritable_audiohook(inheritance_datastore, data); 00215 } else { 00216 ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00217 return 0; 00218 } 00219 }
static int load_module | ( | void | ) | [static] |
Definition at line 259 of file func_audiohookinherit.c.
References ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and inheritance_function.
00260 { 00261 if (ast_custom_function_register(&inheritance_function)) { 00262 return AST_MODULE_LOAD_DECLINE; 00263 } else { 00264 return AST_MODULE_LOAD_SUCCESS; 00265 } 00266 }
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.
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 |
0 | Success | |
non-zero | Failure |
Definition at line 126 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().
00127 { 00128 struct inheritable_audiohook *inheritable_audiohook = NULL; 00129 00130 inheritable_audiohook = ast_calloc(1, sizeof(*inheritable_audiohook) + strlen(source)); 00131 00132 if (!inheritable_audiohook) { 00133 return -1; 00134 } 00135 00136 strcpy(inheritable_audiohook->source, source); 00137 AST_LIST_INSERT_TAIL(&audiohook_inheritance_datastore->allowed_list, inheritable_audiohook, list); 00138 ast_debug(3, "Set audiohook %s to be inheritable\n", source); 00139 return 0; 00140 }
static struct audiohook_inheritance_datastore* setup_inheritance_datastore | ( | struct ast_channel * | chan | ) | [static] |
create an audiohook_inheritance_datastore and attach it to a channel
chan | The channel to which we wish to attach the new datastore |
Definition at line 98 of file func_audiohookinherit.c.
References ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_alloc(), ast_channel_datastore_free(), ast_channel_lock, ast_channel_unlock, audiohook_inheritance_info, chan, and ast_datastore::data.
Referenced by func_inheritance_write().
00099 { 00100 struct ast_datastore *datastore = NULL; 00101 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = NULL; 00102 00103 if (!(datastore = ast_channel_datastore_alloc(&audiohook_inheritance_info, NULL))) { 00104 return NULL; 00105 } 00106 00107 if (!(audiohook_inheritance_datastore = ast_calloc(1, sizeof(*audiohook_inheritance_datastore)))) { 00108 ast_channel_datastore_free(datastore); 00109 return NULL; 00110 } 00111 00112 datastore->data = audiohook_inheritance_datastore; 00113 ast_channel_lock(chan); 00114 ast_channel_datastore_add(chan, datastore); 00115 ast_channel_unlock(chan); 00116 return audiohook_inheritance_datastore; 00117 }
static int unload_module | ( | void | ) | [static] |
Definition at line 254 of file func_audiohookinherit.c.
References ast_custom_function_unregister(), and inheritance_function.
00255 { 00256 return ast_custom_function_unregister(&inheritance_function); 00257 }
struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .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 = "068e67f60f50dd9ee86464c05884a49d" , .load = load_module, .unload = unload_module, } [static] |
Definition at line 267 of file func_audiohookinherit.c.
const struct ast_module_info* ast_module_info = &__mod_info [static] |
Definition at line 267 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 48 of file func_audiohookinherit.c.
Referenced by func_inheritance_write(), and setup_inheritance_datastore().
struct ast_custom_function inheritance_function [static] |
Definition at line 221 of file func_audiohookinherit.c.
Referenced by load_module(), and unload_module().