Asterisk - The Open Source Telephony Project GIT-master-754dea3
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Modules Pages
Functions | Variables
func_dialplan.c File Reference
Module: Dial plan functions

Dialplan group functions check if a dialplan entry exists. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/app.h"
Include dependency graph for func_dialplan.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int acf_isexten_exec (struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
 
struct ast_module * AST_MODULE_SELF_SYM (void)
 
static int isexten_function_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int load_module (void)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Dialplan Context/Extension/Priority Checking Functions" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, }
 
static struct ast_custom_function acf_isexten
 
static const struct ast_module_info * ast_module_info = &__mod_info
 
static struct ast_custom_function isexten_function
 

Detailed Description

Dialplan group functions check if a dialplan entry exists.

Author
Gregory Nietsky AKA irroot grego.nosp@m.ry@n.nosp@m.etwor.nosp@m.ksen.nosp@m.try.c.nosp@m.o.za
Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

Definition in file func_dialplan.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 205 of file func_dialplan.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 205 of file func_dialplan.c.

◆ acf_isexten_exec()

static int acf_isexten_exec ( struct ast_channel *  chan,
const char *  cmd,
char *  parse,
char *  buffer,
size_t  buflen 
)
static

Definition at line 134 of file func_dialplan.c.

135{
136 int priority_int;
137 AST_DECLARE_APP_ARGS(args,
138 AST_APP_ARG(context);
139 AST_APP_ARG(extension);
140 AST_APP_ARG(priority);
141 );
142
143 if (!chan) {
144 ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
145 return -1;
146 }
147
148 AST_STANDARD_APP_ARGS(args, parse);
149
150 if (ast_strlen_zero(args.context)) {
151 args.context = ast_strdupa(ast_channel_context(chan));
152 }
153
154 if (ast_strlen_zero(args.extension)) {
155 ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
156 return -1;
157 }
158
159 if (ast_strlen_zero(args.priority)) {
160 priority_int = 1;
161 } else {
162 priority_int = atoi(args.priority);
163 }
164
165 if (ast_exists_extension(chan, args.context, args.extension, priority_int,
166 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
167 ast_copy_string(buffer, "1", buflen);
168 } else {
169 ast_copy_string(buffer, "0", buflen);
170 }
171
172 return 0;
173}
ast_strdupa
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
ast_log
#define ast_log
Definition: astobj2.c:42
priority
static int priority
Definition: cdr_beanstalkd.c:76
ast_channel_context
const char * ast_channel_context(const struct ast_channel *chan)
Definition: channel_internal_api.c:358
ast_channel_caller
struct ast_party_caller * ast_channel_caller(struct ast_channel *chan)
Definition: channel_internal_api.c:889
AST_APP_ARG
#define AST_APP_ARG(name)
Define an application argument.
Definition: include/asterisk/app.h:1230
AST_DECLARE_APP_ARGS
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
Definition: include/asterisk/app.h:1247
AST_STANDARD_APP_ARGS
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
Definition: include/asterisk/app.h:1283
LOG_WARNING
#define LOG_WARNING
Definition: include/asterisk/logger.h:278
ast_exists_extension
int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
Determine whether an extension exists.
Definition: pbx.c:4190
NULL
#define NULL
Definition: resample.c:96
S_COR
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition: strings.h:87
ast_strlen_zero
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
extension
structure to hold extensions
Definition: res_phoneprov.c:293
number
Number structure.
Definition: app_followme.c:157
args
const char * args
Definition: test_func_file.c:46

References args, AST_APP_ARG, ast_channel_caller(), ast_channel_context(), ast_copy_string(), AST_DECLARE_APP_ARGS, ast_exists_extension(), ast_log, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), voicemailpwcheck::context, LOG_WARNING, NULL, priority, and S_COR.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 205 of file func_dialplan.c.

◆ isexten_function_read()

static int isexten_function_read ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

Definition at line 79 of file func_dialplan.c.

81{
82 char *parse;
83 AST_DECLARE_APP_ARGS(args,
84 AST_APP_ARG(context);
85 AST_APP_ARG(exten);
86 AST_APP_ARG(priority);
87 );
88
89 strcpy(buf, "0");
90
91 if (ast_strlen_zero(data)) {
92 ast_log(LOG_ERROR, "DIALPLAN_EXISTS() requires an argument\n");
93 return -1;
94 }
95
96 parse = ast_strdupa(data);
97 AST_STANDARD_APP_ARGS(args, parse);
98
99 if (!ast_strlen_zero(args.priority)) {
100 int priority_num;
101 if (sscanf(args.priority, "%30d", &priority_num) == 1 && priority_num > 0) {
102 int res;
103 res = ast_exists_extension(chan, args.context, args.exten, priority_num,
104 !chan ? NULL :
105 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL));
106 if (res)
107 strcpy(buf, "1");
108 } else {
109 int res;
110 res = ast_findlabel_extension(chan, args.context, args.exten, args.priority,
111 !chan ? NULL :
112 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL));
113 if (res > 0)
114 strcpy(buf, "1");
115 }
116 } else if (!ast_strlen_zero(args.exten)) {
117 int res;
118 res = ast_exists_extension(chan, args.context, args.exten, 1,
119 !chan ? NULL :
120 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL));
121 if (res)
122 strcpy(buf, "1");
123 } else if (!ast_strlen_zero(args.context)) {
124 if (ast_context_find(args.context))
125 strcpy(buf, "1");
126 } else {
127 ast_log(LOG_ERROR, "Invalid arguments provided to DIALPLAN_EXISTS\n");
128 return -1;
129 }
130
131 return 0;
132}
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
LOG_ERROR
#define LOG_ERROR
Definition: include/asterisk/logger.h:289
ast_findlabel_extension
int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
Find the priority of an extension that has the specified label.
Definition: pbx.c:4195
ast_context_find
struct ast_context * ast_context_find(const char *name)
Find a context.
Definition: extconf.c:4172

References args, AST_APP_ARG, ast_channel_caller(), ast_context_find(), AST_DECLARE_APP_ARGS, ast_exists_extension(), ast_findlabel_extension(), ast_log, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), buf, voicemailpwcheck::context, LOG_ERROR, NULL, priority, and S_COR.

◆ load_module()

static int load_module ( void  )
static

Definition at line 193 of file func_dialplan.c.

194{
195 int res = ast_custom_function_register(&isexten_function);
196 res |= ast_custom_function_register(&acf_isexten);
197 return res;
198}
isexten_function
static struct ast_custom_function isexten_function
Definition: func_dialplan.c:175
acf_isexten
static struct ast_custom_function acf_isexten
Definition: func_dialplan.c:181
ast_custom_function_register
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1559

References acf_isexten, ast_custom_function_register, and isexten_function.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 186 of file func_dialplan.c.

187{
188 int res = ast_custom_function_unregister(&isexten_function);
189 res |= ast_custom_function_unregister(&acf_isexten);
190 return res;
191}
ast_custom_function_unregister
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx_functions.c:262

References acf_isexten, ast_custom_function_unregister(), and isexten_function.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Dialplan Context/Extension/Priority Checking Functions" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, }
static

Definition at line 205 of file func_dialplan.c.

◆ acf_isexten

struct ast_custom_function acf_isexten
static
Initial value:
= {
.name = "VALID_EXTEN",
.read = acf_isexten_exec,
}
acf_isexten_exec
static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
Definition: func_dialplan.c:134

Definition at line 181 of file func_dialplan.c.

Referenced by load_module(), and unload_module().

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 205 of file func_dialplan.c.

◆ isexten_function

struct ast_custom_function isexten_function
static
Initial value:
= {
.name = "DIALPLAN_EXISTS",
.read = isexten_function_read,
.read_max = 2,
}
isexten_function_read
static int isexten_function_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_dialplan.c:79

Definition at line 175 of file func_dialplan.c.

Referenced by load_module(), and unload_module().

Generated on Wed Apr 30 2025 20:04:31 for Asterisk - The Open Source Telephony Project by doxygen 1.9.4