Skip to content
Snippets Groups Projects
func_cut.c 7.83 KiB
Newer Older
  • Learn to ignore specific revisions
  • Mark Spencer's avatar
    Mark Spencer committed
    /*
    
     * Asterisk -- An open source telephony toolkit.
    
    Mark Spencer's avatar
    Mark Spencer committed
     *
    
     * Copyright (c) 2003-2006 Tilghman Lesher.  All rights reserved.
    
    Mark Spencer's avatar
    Mark Spencer committed
     *
    
     * Tilghman Lesher <app_cut__v003@the-tilghman.com>
    
    Mark Spencer's avatar
    Mark Spencer committed
     *
     * This code is released by the author with no restrictions on usage.
     *
    
     * See http://www.asterisk.org for more information about
     * the Asterisk project. Please do not directly contact
     * any of the maintainers of this project for assistance;
     * the project provides a web site, mailing lists and IRC
     * channels for your use.
     *
     */
    
    
     * \author Tilghman Lesher <app_cut__v003@the-tilghman.com>
     *
    
    #include "asterisk.h"
    
    ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
    
    
    #include "asterisk/file.h"
    #include "asterisk/channel.h"
    #include "asterisk/pbx.h"
    #include "asterisk/module.h"
    
    Kevin P. Fleming's avatar
    Kevin P. Fleming committed
    #include "asterisk/app.h"
    
    /*** DOCUMENTATION
    	<function name="SORT" language="en_US">
    		<synopsis>
    			Sorts a list of key/vals into a list of keys, based upon the vals.	
    		</synopsis>
    		<syntax>
    			<parameter name="keyval" required="true" argsep=":">
    				<argument name="key1" required="true" />
    				<argument name="val1" required="true" />
    			</parameter>
    			<parameter name="keyvaln" multiple="true" argsep=":">
    				<argument name="key2" required="true" />
    				<argument name="val2" required="true" />
    			</parameter>
    		</syntax>
    		<description>
    			<para>Takes a comma-separated list of keys and values, each separated by a colon, and returns a
    			comma-separated list of the keys, sorted by their values.  Values will be evaluated as
    			floating-point numbers.</para>
    		</description>
    	</function>
    	<function name="CUT" language="en_US">
    		<synopsis>
    			Slices and dices strings, based upon a named delimiter.		
    		</synopsis>
    		<syntax>
    			<parameter name="varname" required="true">
    				<para>Variable you want cut</para>
    			</parameter>
    			<parameter name="char-delim" required="true">
    				<para>Delimiter, defaults to <literal>-</literal></para>
    			</parameter>
    			<parameter name="range-spec" required="true">
    				<para>Number of the field you want (1-based offset), may also be specified as a range (with <literal>-</literal>)
    				or group of ranges and fields (with <literal>&amp;</literal>)</para>
    			</parameter>
    		</syntax>
    		<description>
    			<para>Cut out information from a string (<replaceable>varname</replaceable>), based upon a named delimiter.</para>
    		</description>	
    	</function>
     ***/
    
    
    Mark Spencer's avatar
    Mark Spencer committed
    /* Maximum length of any variable */
    #define MAXRESULT	1024
    
    
    struct sortable_keys {
    	char *key;
    	float value;
    };
    
    static int sort_subroutine(const void *arg1, const void *arg2)
    
    Mark Spencer's avatar
    Mark Spencer committed
    {
    
    	const struct sortable_keys *one=arg1, *two=arg2;
    
    	if (one->value < two->value)
    
    	else if (one->value == two->value)
    
    		return 1;
    }
    
    #define ERROR_NOARG	(-1)
    #define ERROR_NOMEM	(-2)
    #define ERROR_USAGE	(-3)
    
    static int sort_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
    {
    	char *strings, *ptrkey, *ptrvalue;
    
    	int count=1, count2, element_count=0;
    
    	struct sortable_keys *sortable_keys;
    
    
    	*buffer = '\0';
    
    	if (!data)
    
    
    	for (ptrkey = strings; *ptrkey; ptrkey++) {
    
    			count++;
    	}
    
    	sortable_keys = alloca(count * sizeof(struct sortable_keys));
    
    	memset(sortable_keys, 0, count * sizeof(struct sortable_keys));
    
    	/* Parse each into a struct */
    	count2 = 0;
    
    Steve Murphy's avatar
    Steve Murphy committed
    		ptrvalue = strchr(ptrkey, ':');
    
    		if (!ptrvalue) {
    			count--;
    			continue;
    		}
    
    		*ptrvalue++ = '\0';
    
    		sortable_keys[count2].key = ptrkey;
    		sscanf(ptrvalue, "%f", &sortable_keys[count2].value);
    		count2++;
    	}
    
    	/* Sort the structs */
    	qsort(sortable_keys, count, sizeof(struct sortable_keys), sort_subroutine);
    
    	for (count2 = 0; count2 < count; count2++) {
    
    		int blen = strlen(buffer);
    		if (element_count++) {
    			strncat(buffer + blen, ",", buflen - blen - 1);
    
    			blen++;
    
    		strncat(buffer + blen, sortable_keys[count2].key, buflen - blen - 1);
    
    	}
    
    	return 0;
    }
    
    static int cut_internal(struct ast_channel *chan, char *data, char *buffer, size_t buflen)
    {
    
    	AST_DECLARE_APP_ARGS(args,
    		AST_APP_ARG(varname);
    		AST_APP_ARG(delimiter);
    		AST_APP_ARG(field);
    	);
    
    
    	*buffer = '\0';
    
    	AST_STANDARD_APP_ARGS(args, parse);
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    	/* Check and parse arguments */
    
    		return ERROR_NOARG;
    	} else {
    
    		char *tmp = alloca(strlen(args.varname) + 4);
    
    		char varvalue[MAXRESULT], *tmp2=varvalue;
    
    		if (tmp) {
    
    			snprintf(tmp, strlen(args.varname) + 4, "${%s}", args.varname);
    
    Mark Spencer's avatar
    Mark Spencer committed
    		} else {
    
    		if (ast_get_encoded_char(args.delimiter, ds, &delim_consumed))
    
    			ast_copy_string(ds, "-", sizeof(ds));
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    		/* String form of the delimiter, for use with strsep(3) */
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    		pbx_substitute_variables_helper(chan, tmp, tmp2, MAXRESULT - 1);
    
    		if (tmp2) {
    			int curfieldnum = 1;
    
    			while (tmp2 != NULL && args.field != NULL) {
    
    				char *nextgroup = strsep(&(args.field), "&");
    
    Mark Spencer's avatar
    Mark Spencer committed
    				int num1 = 0, num2 = MAXRESULT;
    				char trashchar;
    
    				if (sscanf(nextgroup, "%d-%d", &num1, &num2) == 2) {
    					/* range with both start and end */
    				} else if (sscanf(nextgroup, "-%d", &num2) == 1) {
    					/* range with end */
    					num1 = 0;
    				} else if ((sscanf(nextgroup, "%d%c", &num1, &trashchar) == 2) && (trashchar == '-')) {
    					/* range with start */
    					num2 = MAXRESULT;
    				} else if (sscanf(nextgroup, "%d", &num1) == 1) {
    					/* single number */
    					num2 = num1;
    				} else {
    
    Mark Spencer's avatar
    Mark Spencer committed
    				}
    
    				/* Get to start, if any */
    				if (num1 > 0) {
    
    					while (tmp2 != (char *)NULL + 1 && curfieldnum < num1) {
    
    Steve Murphy's avatar
    Steve Murphy committed
    						tmp2 = strchr(tmp2, d) + 1;
    
    Mark Spencer's avatar
    Mark Spencer committed
    						curfieldnum++;
    					}
    				}
    
    				/* Most frequent problem is the expectation of reordering fields */
    
    				if ((num1 > 0) && (curfieldnum > num1))
    
    					ast_log(LOG_WARNING, "We're already past the field you wanted?\n");
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    				/* Re-null tmp2 if we added 1 to NULL */
    
    				if (tmp2 == (char *)NULL + 1)
    
    Mark Spencer's avatar
    Mark Spencer committed
    					tmp2 = NULL;
    
    				/* Output fields until we either run out of fields or num2 is reached */
    
    				while (tmp2 != NULL && curfieldnum <= num2) {
    
    Mark Spencer's avatar
    Mark Spencer committed
    					char *tmp3 = strsep(&tmp2, ds);
    
    					int curlen = strlen(buffer);
    
    					if (curlen)
    
    						snprintf(buffer + curlen, buflen - curlen, "%c%s", d, tmp3);
    
    						snprintf(buffer, buflen, "%s", tmp3);
    
    Mark Spencer's avatar
    Mark Spencer committed
    
    					curfieldnum++;
    				}
    			}
    		}
    
    static int acf_sort_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
    
    	int ret = -1;
    
    
    	switch (sort_internal(chan, data, buf, len)) {
    	case ERROR_NOARG:
    		ast_log(LOG_ERROR, "SORT() requires an argument\n");
    		break;
    	case ERROR_NOMEM:
    		ast_log(LOG_ERROR, "Out of memory\n");
    		break;
    	case 0:
    
    		break;
    	default:
    		ast_log(LOG_ERROR, "Unknown internal error\n");
    	}
    
    	return ret;
    
    static int acf_cut_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
    
    	int ret = -1;
    
    
    	switch (cut_internal(chan, data, buf, len)) {
    	case ERROR_NOARG:
    
    		ast_log(LOG_ERROR, "Syntax: CUT(<varname>,<char-delim>,<range-spec>) - missing argument!\n");
    
    		break;
    	case ERROR_NOMEM:
    		ast_log(LOG_ERROR, "Out of memory\n");
    		break;
    	case ERROR_USAGE:
    
    		ast_log(LOG_ERROR, "Usage: CUT(<varname>,<char-delim>,<range-spec>)\n");
    
    		break;
    	default:
    		ast_log(LOG_ERROR, "Unknown internal error\n");
    	}
    
    	return ret;
    
    }
    
    struct ast_custom_function acf_sort = {
    	.name = "SORT",
    	.read = acf_sort_exec,
    };
    
    struct ast_custom_function acf_cut = {
    	.name = "CUT",
    	.read = acf_cut_exec,
    };
    
    
    static int unload_module(void)
    
    Mark Spencer's avatar
    Mark Spencer committed
    {
    
    	res |= ast_custom_function_unregister(&acf_cut);
    
    	res |= ast_custom_function_unregister(&acf_sort);
    
    	return res;
    
    static int load_module(void)
    
    Mark Spencer's avatar
    Mark Spencer committed
    {
    
    	res |= ast_custom_function_register(&acf_cut);
    
    	res |= ast_custom_function_register(&acf_sort);
    
    	return res;
    
    AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Cut out information from a string");