#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_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 = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, } |
static 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 269 of file func_audiohookinherit.c.
static void __unreg_module | ( | void | ) | [static] |
Definition at line 269 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 85 of file func_audiohookinherit.c.
References audiohook_inheritance_datastore::allowed_list, ast_free, AST_LIST_REMOVE_HEAD, and inheritable_audiohook::list.
00086 { 00087 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = data; 00088 struct inheritable_audiohook *inheritable_audiohook = NULL; 00089 00090 while ((inheritable_audiohook = AST_LIST_REMOVE_HEAD(&audiohook_inheritance_datastore->allowed_list, list))) { 00091 ast_free(inheritable_audiohook); 00092 } 00093 }
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 65 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.
00066 { 00067 struct inheritable_audiohook *audiohook = NULL; 00068 struct audiohook_inheritance_datastore *datastore = data; 00069 00070 ast_debug(2, "inheritance fixup occurring for channels %s(%p) and %s(%p)", old_chan->name, old_chan, new_chan->name, new_chan); 00071 00072 AST_LIST_TRAVERSE(&datastore->allowed_list, audiohook, list) { 00073 ast_audiohook_move_by_source(old_chan, new_chan, audiohook->source); 00074 ast_debug(3, "Moved audiohook %s from %s(%p) to %s(%p)\n", 00075 audiohook->source, old_chan->name, old_chan, new_chan->name, new_chan); 00076 } 00077 return; 00078 }
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 153 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.
00154 { 00155 int allow; 00156 struct ast_datastore *datastore = NULL; 00157 struct audiohook_inheritance_datastore *inheritance_datastore = NULL; 00158 struct inheritable_audiohook *inheritable_audiohook; 00159 00160 /* Step 1: Get data from function call */ 00161 if (ast_strlen_zero(data)) { 00162 ast_log(LOG_WARNING, "No argument provided to INHERITANCE function.\n"); 00163 return -1; 00164 } 00165 00166 if (ast_strlen_zero(value)) { 00167 ast_log(LOG_WARNING, "No value provided to INHERITANCE function.\n"); 00168 return -1; 00169 } 00170 00171 allow = ast_true(value); 00172 00173 /* Step 2: retrieve or set up datastore */ 00174 ast_channel_lock(chan); 00175 if (!(datastore = ast_channel_datastore_find(chan, &audiohook_inheritance_info, NULL))) { 00176 ast_channel_unlock(chan); 00177 /* In the case where we cannot find the datastore, we can take a few shortcuts */ 00178 if (!allow) { 00179 ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00180 return 0; 00181 } else if (!(inheritance_datastore = setup_inheritance_datastore(chan))) { 00182 ast_log(LOG_WARNING, "Unable to set up audiohook inheritance datastore on channel %s\n", chan->name); 00183 return -1; 00184 } else { 00185 return setup_inheritable_audiohook(inheritance_datastore, data); 00186 } 00187 } else { 00188 inheritance_datastore = datastore->data; 00189 } 00190 ast_channel_unlock(chan); 00191 00192 /* Step 3: Traverse the list to see if we're trying something redundant */ 00193 00194 AST_LIST_TRAVERSE_SAFE_BEGIN(&inheritance_datastore->allowed_list, inheritable_audiohook, list) { 00195 if (!strcasecmp(inheritable_audiohook->source, data)) { 00196 if (allow) { 00197 ast_debug(2, "Audiohook source %s is already set up to be inherited from channel %s\n", data, chan->name); 00198 return 0; 00199 } else { 00200 ast_debug(2, "Removing inheritability of audiohook %s from channel %s\n", data, chan->name); 00201 AST_LIST_REMOVE_CURRENT(list); 00202 ast_free(inheritable_audiohook); 00203 return 0; 00204 } 00205 } 00206 } 00207 AST_LIST_TRAVERSE_SAFE_END; 00208 00209 /* Step 4: There is no step 4 */ 00210 00211 /* Step 5: This means we are addressing an audiohook source which we have not encountered yet for the channel. Create a new inheritable 00212 * audiohook structure if we're allowing inheritance, or just return if not 00213 */ 00214 00215 if (allow) { 00216 return setup_inheritable_audiohook(inheritance_datastore, data); 00217 } else { 00218 ast_debug(1, "Audiohook %s is already set to not be inheritable on channel %s\n", data, chan->name); 00219 return 0; 00220 } 00221 }
static int load_module | ( | void | ) | [static] |
Definition at line 261 of file func_audiohookinherit.c.
References ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and inheritance_function.
00262 { 00263 if (ast_custom_function_register(&inheritance_function)) { 00264 return AST_MODULE_LOAD_DECLINE; 00265 } else { 00266 return AST_MODULE_LOAD_SUCCESS; 00267 } 00268 }
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 128 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().
00129 { 00130 struct inheritable_audiohook *inheritable_audiohook = NULL; 00131 00132 inheritable_audiohook = ast_calloc(1, sizeof(*inheritable_audiohook) + strlen(source)); 00133 00134 if (!inheritable_audiohook) { 00135 return -1; 00136 } 00137 00138 strcpy(inheritable_audiohook->source, source); 00139 AST_LIST_INSERT_TAIL(&audiohook_inheritance_datastore->allowed_list, inheritable_audiohook, list); 00140 ast_debug(3, "Set audiohook %s to be inheritable\n", source); 00141 return 0; 00142 }
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 100 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, chan, and ast_datastore::data.
Referenced by func_inheritance_write().
00101 { 00102 struct ast_datastore *datastore = NULL; 00103 struct audiohook_inheritance_datastore *audiohook_inheritance_datastore = NULL; 00104 00105 if (!(datastore = ast_datastore_alloc(&audiohook_inheritance_info, NULL))) { 00106 return NULL; 00107 } 00108 00109 if (!(audiohook_inheritance_datastore = ast_calloc(1, sizeof(*audiohook_inheritance_datastore)))) { 00110 ast_datastore_free(datastore); 00111 return NULL; 00112 } 00113 00114 datastore->data = audiohook_inheritance_datastore; 00115 ast_channel_lock(chan); 00116 ast_channel_datastore_add(chan, datastore); 00117 ast_channel_unlock(chan); 00118 return audiohook_inheritance_datastore; 00119 }
static int unload_module | ( | void | ) | [static] |
Definition at line 256 of file func_audiohookinherit.c.
References ast_custom_function_unregister(), and inheritance_function.
00257 { 00258 return ast_custom_function_unregister(&inheritance_function); 00259 }
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 = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, } [static] |
Definition at line 269 of file func_audiohookinherit.c.
struct ast_module_info* ast_module_info = &__mod_info [static] |
Definition at line 269 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 50 of file func_audiohookinherit.c.
Referenced by func_inheritance_write(), and setup_inheritance_datastore().
struct ast_custom_function inheritance_function [static] |
Definition at line 223 of file func_audiohookinherit.c.
Referenced by load_module(), and unload_module().