mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-10-31 10:47:18 +00:00 
			
		
		
		
	Update groupcount / db documentation (bug #4200, etc)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@5606 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
		
							
								
								
									
										21
									
								
								UPGRADE.txt
									
									
									
									
									
								
							
							
						
						
									
										21
									
								
								UPGRADE.txt
									
									
									
									
									
								
							| @@ -38,6 +38,27 @@ Applications: | ||||
| * The CallerPres application has been removed.  Use SetCallerPres  | ||||
|   instead.  It accepts both numeric and symbolic names. | ||||
|  | ||||
| * The applications GetGroupCount, GetGroupMatchCount, SetGroup, and | ||||
|   CheckGroup have been deprecated in favor of functions.  Here is a | ||||
|   table of their replacements: | ||||
|  | ||||
|   GetGroupCount([groupname][@category]	       GROUP_COUNT([groupname][@category])	SetVar(GROUPCOUNT=${GROUP_COUNT()}) | ||||
|   GroupMatchCount(groupmatch[@category])       GROUP_MATCH_COUNT(groupmatch[@category])	SetVar(GROUPCOUNT=${GROUP_MATCH_COUNT(SIP/.*)}) | ||||
|   SetGroup(groupname[@category])	       GROUP([category])=groupname		SetVar(GROUP()=test) | ||||
|   CheckGroup(max[@category])		       N/A					GotoIf($[ ${GROUP_COUNT()} > 5 ]?103) | ||||
|  | ||||
|   Note that CheckGroup does not have a direct replacement.  There is | ||||
|   also a new function called GROUP_LIST() which will return a space | ||||
|   separated list of all of the groups set on a channel.  The GROUP() | ||||
|   function can also return the name of the group set on a channel when | ||||
|   used in a read environment. | ||||
|  | ||||
| * The applications DBGet and DBPut have been deprecated in favor of | ||||
|   functions.  Here is a table of their replacements: | ||||
|  | ||||
|   DBGet(foo=family/key)        SetVar(foo=${DB(family/key)}) | ||||
|   DBPut(family/key=${foo})     SetVar(${DB(family/key)}=${foo}) | ||||
|  | ||||
| Queues: | ||||
|  | ||||
| * A queue is now considered empty not only if there are no members but if | ||||
|   | ||||
| @@ -32,8 +32,6 @@ STANDARD_LOCAL_USER; | ||||
|  | ||||
| LOCAL_USER_DECL; | ||||
|  | ||||
| static int deprecation_warning = 0; | ||||
|  | ||||
| static int group_count_exec(struct ast_channel *chan, void *data) | ||||
| { | ||||
| 	int res = 0; | ||||
| @@ -43,11 +41,12 @@ static int group_count_exec(struct ast_channel *chan, void *data) | ||||
| 	char category[80] = ""; | ||||
| 	char ret[80] = ""; | ||||
| 	char *grp; | ||||
| 	static int deprecation_warning = 0; | ||||
|  | ||||
| 	LOCAL_USER_ADD(u); | ||||
|  | ||||
| 	if (!deprecation_warning) { | ||||
| 	        ast_log(LOG_WARNING, "The GetGroupCount and GetGroupMatchCount applications have been deprecated, please use the GROUP_COUNT and GROUP_MATCH_COUNT functions.\n"); | ||||
| 	        ast_log(LOG_WARNING, "The GetGroupCount application has been deprecated, please use the GROUP_COUNT function.\n"); | ||||
| 		deprecation_warning = 1; | ||||
| 	} | ||||
|  | ||||
| @@ -75,11 +74,12 @@ static int group_match_count_exec(struct ast_channel *chan, void *data) | ||||
| 	char group[80] = ""; | ||||
| 	char category[80] = ""; | ||||
| 	char ret[80] = ""; | ||||
| 	static int deprecation_warning = 0; | ||||
|  | ||||
| 	LOCAL_USER_ADD(u); | ||||
|  | ||||
| 	if (!deprecation_warning) { | ||||
| 	        ast_log(LOG_WARNING, "The GetGroupCount and GetGroupMatchCount applications have been deprecated, please use the GROUP_COUNT and GROUP_MATCH_COUNT functions.\n"); | ||||
| 	        ast_log(LOG_WARNING, "The GetGroupMatchCount application has been deprecated, please use the GROUP_MATCH_COUNT function.\n"); | ||||
| 		deprecation_warning = 1; | ||||
| 	} | ||||
|  | ||||
| @@ -100,6 +100,12 @@ static int group_set_exec(struct ast_channel *chan, void *data) | ||||
| { | ||||
| 	int res = 0; | ||||
| 	struct localuser *u; | ||||
| 	static int deprecation_warning = 0; | ||||
|  | ||||
| 	if (!deprecation_warning) { | ||||
| 	        ast_log(LOG_WARNING, "The SetGroup application has been deprecated, please use the GROUP() function.\n"); | ||||
| 		deprecation_warning = 1; | ||||
| 	} | ||||
|  | ||||
| 	LOCAL_USER_ADD(u); | ||||
|  | ||||
| @@ -117,9 +123,15 @@ static int group_check_exec(struct ast_channel *chan, void *data) | ||||
| 	struct localuser *u; | ||||
| 	char limit[80]=""; | ||||
| 	char category[80]=""; | ||||
| 	static int deprecation_warning = 0; | ||||
|  | ||||
| 	LOCAL_USER_ADD(u); | ||||
|  | ||||
| 	if (!deprecation_warning) { | ||||
| 	        ast_log(LOG_WARNING, "The CheckGroup application has been deprecated, please use a combination of the GotoIf application and the GROUP_COUNT() function.\n"); | ||||
| 		deprecation_warning = 1; | ||||
| 	} | ||||
|  | ||||
| 	if (!data || ast_strlen_zero(data)) { | ||||
| 		ast_log(LOG_WARNING, "CheckGroup requires an argument(max[@category])\n"); | ||||
| 		return res; | ||||
|   | ||||
| @@ -30,7 +30,7 @@ static char *group_count_function_read(struct ast_channel *chan, char *cmd, char | ||||
|  | ||||
| 	if (ast_strlen_zero(group)) { | ||||
| 		grp = pbx_builtin_getvar_helper(chan, category); | ||||
| 		strncpy(group, grp, sizeof(group) - 1); | ||||
| 		ast_copy_string(group, grp, sizeof(group)); | ||||
| 	} | ||||
|  | ||||
| 	count = ast_app_group_get_count(group, category); | ||||
| @@ -79,3 +79,89 @@ struct ast_custom_function group_match_count_function = { | ||||
| 	.read = group_match_count_function_read, | ||||
| 	.write = NULL, | ||||
| }; | ||||
|  | ||||
| static char *group_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) | ||||
| { | ||||
| 	char varname[256]; | ||||
| 	char *group; | ||||
|  | ||||
| 	if (data && !ast_strlen_zero(data)) { | ||||
| 		snprintf(varname, sizeof(varname), "%s_%s", GROUP_CATEGORY_PREFIX, data); | ||||
| 	} else { | ||||
| 		ast_copy_string(varname, GROUP_CATEGORY_PREFIX, sizeof(varname)); | ||||
| 	} | ||||
|  | ||||
| 	group = pbx_builtin_getvar_helper(chan, varname); | ||||
| 	if (group) | ||||
| 		ast_copy_string(buf, group, len); | ||||
|  | ||||
| 	return buf; | ||||
| } | ||||
|  | ||||
| static void group_function_write(struct ast_channel *chan, char *cmd, char *data, const char *value) | ||||
| { | ||||
| 	char grpcat[256]; | ||||
|  | ||||
| 	if (data && !ast_strlen_zero(data)) { | ||||
| 		snprintf(grpcat, sizeof(grpcat), "%s@%s", data, value); | ||||
| 	} else { | ||||
| 		ast_copy_string(grpcat, value, sizeof(grpcat)); | ||||
| 	} | ||||
|  | ||||
|         if (ast_app_group_set_channel(chan, grpcat)) | ||||
|                 ast_log(LOG_WARNING, "Setting a group requires an argument (group name)\n"); | ||||
| } | ||||
|  | ||||
| #ifndef BUILTIN_FUNC | ||||
| static | ||||
| #endif | ||||
| struct ast_custom_function group_function = { | ||||
| 	.name = "GROUP", | ||||
| 	.syntax = "GROUP([category])", | ||||
| 	.synopsis = "Gets or sets the channel group.", | ||||
| 	.desc = "Gets or sets the channel group.\n", | ||||
| 	.read = group_function_read, | ||||
| 	.write = group_function_write, | ||||
| }; | ||||
|  | ||||
| static char *group_list_function_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) | ||||
| { | ||||
| 	struct ast_var_t *current; | ||||
| 	struct varshead *headp; | ||||
| 	char tmp1[1024] = ""; | ||||
| 	char tmp2[1024] = ""; | ||||
|  | ||||
| 	headp=&chan->varshead; | ||||
| 	AST_LIST_TRAVERSE(headp,current,entries) { | ||||
| 		if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) { | ||||
| 			if (!ast_strlen_zero(tmp1)) { | ||||
| 				ast_copy_string(tmp2, tmp1, sizeof(tmp2)); | ||||
| 				snprintf(tmp1, sizeof(tmp1), "%s %s@%s", tmp2, ast_var_value(current), (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1)); | ||||
| 			} else { | ||||
| 				snprintf(tmp1, sizeof(tmp1), "%s@%s", ast_var_value(current), (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1)); | ||||
| 			} | ||||
| 		} else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) { | ||||
| 			if (!ast_strlen_zero(tmp1)) { | ||||
| 				ast_copy_string(tmp2, tmp1, sizeof(tmp2)); | ||||
| 				snprintf(tmp1, sizeof(tmp1), "%s %s", tmp2, ast_var_value(current)); | ||||
| 			} else { | ||||
| 				snprintf(tmp1, sizeof(tmp1), "%s", ast_var_value(current)); | ||||
| 			} | ||||
| 		} | ||||
| 	} | ||||
| 	ast_copy_string(buf, tmp1, len); | ||||
| 	return buf; | ||||
| } | ||||
|  | ||||
| #ifndef BUILTIN_FUNC | ||||
| static | ||||
| #endif | ||||
| struct ast_custom_function group_list_function = { | ||||
| 	.name = "GROUP_LIST", | ||||
| 	.syntax = "GROUP_LIST()", | ||||
| 	.synopsis = "Gets a list of the groups set on a channel.", | ||||
| 	.desc = "Gets a list of the groups set on a channel.\n", | ||||
| 	.read = group_list_function_read, | ||||
| 	.write = NULL, | ||||
| }; | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user