Asterisk - The Open Source Telephony Project  18.5.0
Functions | Variables
func_groupcount.c File Reference
Module: Dial plan functions

Channel group related dialplan functions. More...

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

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_module * AST_MODULE_SELF_SYM (void)
 
static int group_count_function_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int group_function_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int group_function_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
 
static int group_list_function_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 
static int group_match_count_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 = "Channel group dialplan 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 = "30ef0c93b36035ec78c9cfd712d36d9b" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
 
static const struct ast_module_info * ast_module_info = &__mod_info
 
static struct ast_custom_function group_count_function
 
static struct ast_custom_function group_function
 
static struct ast_custom_function group_list_function
 
static struct ast_custom_function group_match_count_function
 

Detailed Description

Channel group related dialplan functions.

Definition in file func_groupcount.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 306 of file func_groupcount.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 306 of file func_groupcount.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 306 of file func_groupcount.c.

◆ group_count_function_read()

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

Definition at line 98 of file func_groupcount.c.

References ast_app_group_get_count(), ast_app_group_list_head(), ast_app_group_list_rdlock(), ast_app_group_list_unlock(), ast_app_group_split_group(), ast_channel_name(), ast_copy_string(), AST_LIST_NEXT, ast_log, ast_strlen_zero, ast_group_info::category, ast_group_info::chan, ast_group_info::group, ast_group_info::group_list, LOG_NOTICE, LOG_WARNING, and NULL.

100 {
101  int ret = -1;
102  int count = -1;
103  char group[80] = "", category[80] = "";
104 
105  if (!chan) {
106  ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
107  return -1;
108  }
109 
110  ast_app_group_split_group(data, group, sizeof(group), category,
111  sizeof(category));
112 
113  /* If no group has been provided let's find one */
114  if (ast_strlen_zero(group)) {
115  struct ast_group_info *gi = NULL;
116 
117  ast_app_group_list_rdlock();
118  for (gi = ast_app_group_list_head(); gi; gi = AST_LIST_NEXT(gi, group_list)) {
119  if (gi->chan != chan)
120  continue;
121  if (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))
122  break;
123  }
124  if (gi) {
125  ast_copy_string(group, gi->group, sizeof(group));
126  if (!ast_strlen_zero(gi->category))
127  ast_copy_string(category, gi->category, sizeof(category));
128  }
129  ast_app_group_list_unlock();
130  }
131 
132  if ((count = ast_app_group_get_count(group, category)) == -1) {
133  ast_log(LOG_NOTICE, "No group could be found for channel '%s'\n", ast_channel_name(chan));
134  } else {
135  snprintf(buf, len, "%d", count);
136  ret = 0;
137  }
138 
139  return ret;
140 }
ast_group_info
channel group info
Definition: channel.h:2938
ast_app_group_list_head
struct ast_group_info * ast_app_group_list_head(void)
Get the head of the group count list.
Definition: main/app.c:2189
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
LOG_WARNING
#define LOG_WARNING
Definition: logger.h:274
AST_LIST_NEXT
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
NULL
#define NULL
Definition: resample.c:96
ast_channel::data
const char * data
Definition: channel_internal_api.c:83
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
ast_log
#define ast_log
Definition: astobj2.c:42
ast_group_info::group
char * group
Definition: channel.h:2941
ast_group_info::chan
struct ast_channel * chan
Definition: channel.h:2939
len
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition: func_strings.c:1344
LOG_NOTICE
#define LOG_NOTICE
Definition: logger.h:263
ast_app_group_list_unlock
int ast_app_group_list_unlock(void)
Unlock the group count list.
Definition: main/app.c:2194
ast_app_group_split_group
int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
Split a group string into group and category, returning a default category if none is provided...
Definition: main/app.c:2009
ast_group_info::category
char * category
Definition: channel.h:2940
ast_app_group_list_rdlock
int ast_app_group_list_rdlock(void)
Read Lock the group count list.
Definition: main/app.c:2184
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
ast_channel_name
const char * ast_channel_name(const struct ast_channel *chan)
ast_group_info::group_list
struct ast_group_info::@248 group_list
ast_app_group_get_count
int ast_app_group_get_count(const char *group, const char *category)
Get the current channel count of the specified group and category.
Definition: main/app.c:2083

◆ group_function_read()

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

Definition at line 175 of file func_groupcount.c.

References ast_app_group_list_head(), ast_app_group_list_rdlock(), ast_app_group_list_unlock(), ast_copy_string(), AST_LIST_NEXT, ast_log, ast_strlen_zero, ast_group_info::category, ast_group_info::chan, ast_group_info::group, ast_group_info::group_list, LOG_WARNING, and NULL.

177 {
178  int ret = -1;
179  struct ast_group_info *gi = NULL;
180 
181  if (!chan) {
182  ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
183  return -1;
184  }
185 
186  ast_app_group_list_rdlock();
187 
188  for (gi = ast_app_group_list_head(); gi; gi = AST_LIST_NEXT(gi, group_list)) {
189  if (gi->chan != chan)
190  continue;
191  if (ast_strlen_zero(data))
192  break;
193  if (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, data))
194  break;
195  }
196 
197  if (gi) {
198  ast_copy_string(buf, gi->group, len);
199  ret = 0;
200  }
201 
202  ast_app_group_list_unlock();
203 
204  return ret;
205 }
ast_group_info
channel group info
Definition: channel.h:2938
ast_app_group_list_head
struct ast_group_info * ast_app_group_list_head(void)
Get the head of the group count list.
Definition: main/app.c:2189
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
LOG_WARNING
#define LOG_WARNING
Definition: logger.h:274
AST_LIST_NEXT
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
NULL
#define NULL
Definition: resample.c:96
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
ast_log
#define ast_log
Definition: astobj2.c:42
ast_group_info::group
char * group
Definition: channel.h:2941
ast_group_info::chan
struct ast_channel * chan
Definition: channel.h:2939
len
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition: func_strings.c:1344
ast_app_group_list_unlock
int ast_app_group_list_unlock(void)
Unlock the group count list.
Definition: main/app.c:2194
ast_group_info::category
char * category
Definition: channel.h:2940
ast_app_group_list_rdlock
int ast_app_group_list_rdlock(void)
Read Lock the group count list.
Definition: main/app.c:2184
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
ast_group_info::group_list
struct ast_group_info::@248 group_list

◆ group_function_write()

static int group_function_write ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
const char *  value 
)
static

Definition at line 207 of file func_groupcount.c.

References ast_app_group_set_channel(), ast_copy_string(), ast_log, ast_strlen_zero, and LOG_WARNING.

209 {
210  char grpcat[256];
211 
212  if (!chan) {
213  ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
214  return -1;
215  }
216 
217  if (!value) {
218  return -1;
219  }
220 
221  if (!ast_strlen_zero(data)) {
222  snprintf(grpcat, sizeof(grpcat), "%s@%s", value, data);
223  } else {
224  ast_copy_string(grpcat, value, sizeof(grpcat));
225  }
226 
227  if (ast_app_group_set_channel(chan, grpcat))
228  ast_log(LOG_WARNING,
229  "Setting a group requires an argument (group name)\n");
230 
231  return 0;
232 }
LOG_WARNING
#define LOG_WARNING
Definition: logger.h:274
value
int value
Definition: syslog.c:37
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
ast_log
#define ast_log
Definition: astobj2.c:42
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
ast_app_group_set_channel
int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
Set the group for a channel, splitting the provided data into group and category, if specified...
Definition: main/app.c:2036

◆ group_list_function_read()

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

Definition at line 240 of file func_groupcount.c.

References ast_app_group_list_head(), ast_app_group_list_rdlock(), ast_app_group_list_unlock(), ast_copy_string(), AST_LIST_NEXT, ast_strlen_zero, ast_group_info::category, ast_group_info::chan, ast_group_info::group, ast_group_info::group_list, and NULL.

242 {
243  struct ast_group_info *gi = NULL;
244  char tmp1[1024] = "";
245  char tmp2[1024] = "";
246 
247  if (!chan)
248  return -1;
249 
250  ast_app_group_list_rdlock();
251 
252  for (gi = ast_app_group_list_head(); gi; gi = AST_LIST_NEXT(gi, group_list)) {
253  if (gi->chan != chan)
254  continue;
255  if (!ast_strlen_zero(tmp1)) {
256  ast_copy_string(tmp2, tmp1, sizeof(tmp2));
257  if (!ast_strlen_zero(gi->category))
258  snprintf(tmp1, sizeof(tmp1), "%s %s@%s", tmp2, gi->group, gi->category);
259  else
260  snprintf(tmp1, sizeof(tmp1), "%s %s", tmp2, gi->group);
261  } else {
262  if (!ast_strlen_zero(gi->category))
263  snprintf(tmp1, sizeof(tmp1), "%s@%s", gi->group, gi->category);
264  else
265  snprintf(tmp1, sizeof(tmp1), "%s", gi->group);
266  }
267  }
268 
269  ast_app_group_list_unlock();
270 
271  ast_copy_string(buf, tmp1, len);
272 
273  return 0;
274 }
ast_group_info
channel group info
Definition: channel.h:2938
ast_app_group_list_head
struct ast_group_info * ast_app_group_list_head(void)
Get the head of the group count list.
Definition: main/app.c:2189
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
AST_LIST_NEXT
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
NULL
#define NULL
Definition: resample.c:96
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
ast_group_info::group
char * group
Definition: channel.h:2941
ast_group_info::chan
struct ast_channel * chan
Definition: channel.h:2939
len
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition: func_strings.c:1344
ast_app_group_list_unlock
int ast_app_group_list_unlock(void)
Unlock the group count list.
Definition: main/app.c:2194
ast_group_info::category
char * category
Definition: channel.h:2940
ast_app_group_list_rdlock
int ast_app_group_list_rdlock(void)
Read Lock the group count list.
Definition: main/app.c:2184
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
ast_group_info::group_list
struct ast_group_info::@248 group_list

◆ group_match_count_function_read()

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

Definition at line 148 of file func_groupcount.c.

References ast_app_group_match_get_count(), ast_app_group_split_group(), and ast_strlen_zero.

151 {
152  char group[80] = "";
153  char category[80] = "";
154 
155  ast_app_group_split_group(data, group, sizeof(group), category,
156  sizeof(category));
157 
158  if (!ast_strlen_zero(group)) {
159  int count;
160  count = ast_app_group_match_get_count(group, category);
161  snprintf(buf, len, "%d", count);
162  return 0;
163  }
164 
165  return -1;
166 }
buf
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
len
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition: func_strings.c:1344
ast_app_group_split_group
int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
Split a group string into group and category, returning a default category if none is provided...
Definition: main/app.c:2009
ast_app_group_match_get_count
int ast_app_group_match_get_count(const char *groupmatch, const char *category)
Get the current channel count of all groups that match the specified pattern and category.
Definition: main/app.c:2103
ast_group_info::category
char * category
Definition: channel.h:2940

◆ load_module()

static int load_module ( void  )
static

Definition at line 294 of file func_groupcount.c.

References ast_custom_function_register.

295 {
296  int res = 0;
297 
298  res |= ast_custom_function_register(&group_count_function);
299  res |= ast_custom_function_register(&group_match_count_function);
300  res |= ast_custom_function_register(&group_list_function);
301  res |= ast_custom_function_register(&group_function);
302 
303  return res;
304 }
group_count_function
static struct ast_custom_function group_count_function
Definition: func_groupcount.c:142
group_match_count_function
static struct ast_custom_function group_match_count_function
Definition: func_groupcount.c:168
group_function
static struct ast_custom_function group_function
Definition: func_groupcount.c:234
group_list_function
static struct ast_custom_function group_list_function
Definition: func_groupcount.c:276
ast_custom_function_register
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1508

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 282 of file func_groupcount.c.

References ast_custom_function_unregister().

283 {
284  int res = 0;
285 
286  res |= ast_custom_function_unregister(&group_count_function);
287  res |= ast_custom_function_unregister(&group_match_count_function);
288  res |= ast_custom_function_unregister(&group_list_function);
289  res |= ast_custom_function_unregister(&group_function);
290 
291  return res;
292 }
group_count_function
static struct ast_custom_function group_count_function
Definition: func_groupcount.c:142
group_match_count_function
static struct ast_custom_function group_match_count_function
Definition: func_groupcount.c:168
group_function
static struct ast_custom_function group_function
Definition: func_groupcount.c:234
ast_custom_function_unregister
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx_functions.c:273
group_list_function
static struct ast_custom_function group_list_function
Definition: func_groupcount.c:276

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Channel group dialplan 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 = "30ef0c93b36035ec78c9cfd712d36d9b" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static

Definition at line 306 of file func_groupcount.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 306 of file func_groupcount.c.

◆ group_count_function

struct ast_custom_function group_count_function
static
Initial value:
= {
.name = "GROUP_COUNT",
.read = group_count_function_read,
.read_max = 12,
}
group_count_function_read
static int group_count_function_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_groupcount.c:98

Definition at line 142 of file func_groupcount.c.

◆ group_function

struct ast_custom_function group_function
static
Initial value:
= {
.name = "GROUP",
.read = group_function_read,
.write = group_function_write,
}
group_function_read
static int group_function_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_groupcount.c:175
group_function_write
static int group_function_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
Definition: func_groupcount.c:207

Definition at line 234 of file func_groupcount.c.

◆ group_list_function

struct ast_custom_function group_list_function
static
Initial value:
= {
.name = "GROUP_LIST",
.read = group_list_function_read,
.write = NULL,
}
NULL
#define NULL
Definition: resample.c:96
group_list_function_read
static int group_list_function_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition: func_groupcount.c:240

Definition at line 276 of file func_groupcount.c.

◆ group_match_count_function

struct ast_custom_function group_match_count_function
static

Definition at line 168 of file func_groupcount.c.

Generated on Sun Aug 8 2021 19:45:56 for Asterisk - The Open Source Telephony Project by   doxygen 1.8.13