#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/audiohook.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/options.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, 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 | AST_MODFLAG_BUILDSUM, .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 = "361d7bb937402d51e4658efb5b4d76e4" , .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 |
Mark Michelson <mmichelson@digium.com>
Definition in file func_audiohookinherit.c.
static void __reg_module | ( | void | ) | [static] |
Definition at line 284 of file func_audiohookinherit.c.
static void __unreg_module | ( | void | ) | [static] |
Definition at line 284 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 88 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_free, AST_LIST_REMOVE_HEAD, and inheritable_audiohook::list.
00089 { 00090 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = data; 00091 struct inheritable_audiohook *inheritable_audiohook = NULL; 00092 00093 while ((inheritable_audiohook = AST_LIST_REMOVE_HEAD(&audiohook_inheritance_datastore->allowed_list, list))) { 00094 ast_free(inheritable_audiohook); 00095 } 00096 00097 ast_free(audiohook_inheritance_datastore); 00098 }
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 64 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_audiohook_move_by_source(), AST_LIST_TRAVERSE, ast_log(), inheritable_audiohook::list, LOG_DEBUG, ast_channel::name, option_debug, and inheritable_audiohook::source.
00065 { 00066 struct inheritable_audiohook *audiohook = NULL; 00067 struct audiohook_inheritance_datastore *datastore = data; 00068 00069 if (option_debug > 1) { 00070 ast_log(LOG_DEBUG, "inheritance fixup occurring for channels %s(%p) and %s(%p)", old_chan->name, old_chan, new_chan->name, new_chan); 00071 } 00072 00073 AST_LIST_TRAVERSE(&datastore->allowed_list, audiohook, list) { 00074 ast_audiohook_move_by_source(old_chan, new_chan, audiohook->source); 00075 if (option_debug > 2) { 00076 ast_log(LOG_DEBUG, "Moved audiohook %s from %s(%p) to %s(%p)\n", 00077 audiohook->source, old_chan->name, old_chan, new_chan->name, new_chan); 00078 } 00079 } 00080 return; 00081 }
static int func_inheritance_write | ( | struct ast_channel * | chan, | |
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 160 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, 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_DEBUG, LOG_WARNING, ast_channel::name, option_debug, setup_inheritable_audiohook(), setup_inheritance_datastore(), and inheritable_audiohook::source.
00161 { 00162 int allow; 00163 struct ast_datastore *datastore = NULL; 00164 struct audiohook_inheritance_datastore *inheritance_datastore = NULL; 00165 struct inheritable_audiohook *inheritable_audiohook; 00166 00167 /* Step 1: Get data from function call */ 00168 if (ast_strlen_zero(data)) { 00169 ast_log(LOG_WARNING, "No argument provided to INHERITANCE function.\n"); 00170 return -1; 00171 } 00172 00173 if (ast_strlen_zero(value)) { 00174 ast_log(LOG_WARNING, "No value provided to INHERITANCE function.\n"); 00175 return -1; 00176 } 00177 00178 allow = ast_true(value); 00179 00180 /* Step 2: retrieve or set up datastore */ 00181 ast_channel_lock(chan); 00182 if (!(datastore = ast_channel_datastore_find(chan, &audiohook_inheritance_info, NULL))) { 00183 ast_channel_unlock(chan); 00184 /* In the case where we cannot find the datastore, we can take a few shortcuts */ 00185 if (!allow) { 00186 if (option_debug) { 00187 ast_log(LOG_DEBUG, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00188 } 00189 return 0; 00190 } else if (!(inheritance_datastore = setup_inheritance_datastore(chan))) { 00191 ast_log(LOG_WARNING, "Unable to set up audiohook inheritance datastore on channel %s\n", chan->name); 00192 return -1; 00193 } else { 00194 return setup_inheritable_audiohook(inheritance_datastore, data); 00195 } 00196 } else { 00197 inheritance_datastore = datastore->data; 00198 } 00199 ast_channel_unlock(chan); 00200 00201 /* Step 3: Traverse the list to see if we're trying something redundant */ 00202 00203 AST_LIST_TRAVERSE_SAFE_BEGIN(&inheritance_datastore->allowed_list, inheritable_audiohook, list) { 00204 if (!strcasecmp(inheritable_audiohook->source, data)) { 00205 if (allow) { 00206 if (option_debug > 1) { 00207 ast_log(LOG_DEBUG, "Audiohook source %s is already set up to be inherited from channel %s\n", data, chan->name); 00208 } 00209 return 0; 00210 } else { 00211 if (option_debug > 1) { 00212 ast_log(LOG_DEBUG, "Removing inheritability of audiohook %s from channel %s\n", data, chan->name); 00213 } 00214 AST_LIST_REMOVE_CURRENT(&inheritance_datastore->allowed_list, list); 00215 ast_free(inheritable_audiohook); 00216 return 0; 00217 } 00218 } 00219 } 00220 AST_LIST_TRAVERSE_SAFE_END; 00221 00222 /* Step 4: There is no step 4 */ 00223 00224 /* Step 5: This means we are addressing an audiohook source which we have not encountered yet for the channel. Create a new inheritable 00225 * audiohook structure if we're allowing inheritance, or just return if not 00226 */ 00227 00228 if (allow) { 00229 return setup_inheritable_audiohook(inheritance_datastore, data); 00230 } else { 00231 if (option_debug) { 00232 ast_log(LOG_DEBUG, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00233 } 00234 return 0; 00235 } 00236 }
static int load_module | ( | void | ) | [static] |
Definition at line 276 of file func_audiohookinherit.c.
References ast_custom_function_register(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and inheritance_function.
00277 { 00278 if (ast_custom_function_register(&inheritance_function)) { 00279 return AST_MODULE_LOAD_DECLINE; 00280 } else { 00281 return AST_MODULE_LOAD_SUCCESS; 00282 } 00283 }
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 133 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_calloc, AST_LIST_INSERT_TAIL, ast_log(), inheritable_audiohook::list, LOG_DEBUG, and option_debug.
Referenced by func_inheritance_write().
00134 { 00135 struct inheritable_audiohook *inheritable_audiohook = NULL; 00136 00137 inheritable_audiohook = ast_calloc(1, sizeof(*inheritable_audiohook) + strlen(source)); 00138 00139 if (!inheritable_audiohook) { 00140 return -1; 00141 } 00142 00143 strcpy(inheritable_audiohook->source, source); 00144 AST_LIST_INSERT_TAIL(&audiohook_inheritance_datastore->allowed_list, inheritable_audiohook, list); 00145 if (option_debug > 2) { 00146 ast_log(LOG_DEBUG, "Set audiohook %s to be inheritable\n", source); 00147 } 00148 return 0; 00149 }
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 105 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, and ast_datastore::data.
Referenced by func_inheritance_write().
00106 { 00107 struct ast_datastore *datastore = NULL; 00108 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = NULL; 00109 00110 if (!(datastore = ast_channel_datastore_alloc(&audiohook_inheritance_info, NULL))) { 00111 return NULL; 00112 } 00113 00114 if (!(audiohook_inheritance_datastore = ast_calloc(1, sizeof(*audiohook_inheritance_datastore)))) { 00115 ast_channel_datastore_free(datastore); 00116 return NULL; 00117 } 00118 00119 datastore->data = audiohook_inheritance_datastore; 00120 ast_channel_lock(chan); 00121 ast_channel_datastore_add(chan, datastore); 00122 ast_channel_unlock(chan); 00123 return audiohook_inheritance_datastore; 00124 }
static int unload_module | ( | void | ) | [static] |
Definition at line 271 of file func_audiohookinherit.c.
References ast_custom_function_unregister(), and inheritance_function.
00272 { 00273 return ast_custom_function_unregister(&inheritance_function); 00274 }
struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT | AST_MODFLAG_BUILDSUM, .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 = "361d7bb937402d51e4658efb5b4d76e4" , .load = load_module, .unload = unload_module, } [static] |
Definition at line 284 of file func_audiohookinherit.c.
const struct ast_module_info* ast_module_info = &__mod_info [static] |
Definition at line 284 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 49 of file func_audiohookinherit.c.
Referenced by func_inheritance_write(), and setup_inheritance_datastore().
struct ast_custom_function inheritance_function [static] |
Definition at line 238 of file func_audiohookinherit.c.
Referenced by load_module(), and unload_module().