Merge rgagnon's pedantic string changes (apps n-z) (bug #2038)
[asterisk/asterisk.git] / apps / app_substring.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Skeleton application
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <sys/types.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/channel.h>
18 #include <asterisk/pbx.h>
19 #include <asterisk/module.h>
20 #include <asterisk/pbx.h>
21 #include <asterisk/lock.h>
22 #include <stdlib.h>
23 #include <unistd.h>
24 #include <string.h>
25 #include <stdlib.h>
26
27 static char *tdesc = "(Deprecated) Save substring digits in a given variable";
28
29 static char *descrip =
30 "  (Deprecated, use ${variable:a:b} instead)\n"
31 "\n"
32 "  SubString(variable=string_of_digits|count1|count2): Assigns the substring\n"
33 "of string_of_digits to a given variable. Parameter count1 may be positive\n"
34 "or negative. If it's positive then we skip the first count1 digits from the\n"
35 "left. If it's negative, we move count1 digits counting from the end of\n"
36 "the string to the left. Parameter count2 implies how many digits we are\n"
37 "taking from the point that count1 placed us. If count2 is negative, then\n"
38 "that many digits are omitted from the end.\n"
39 "For example:\n"
40 "exten => _NXXXXXX,1,SubString,test=2564286161|0|3\n"
41 "assigns the area code (3 first digits) to variable test.\n"
42 "exten => _NXXXXXX,1,SubString,test=2564286161|-7|7\n"
43 "assigns the last 7 digits to variable test.\n"
44 "exten => _NXXXXXX,1,SubString,test=2564286161|0|-4\n" 
45 "assigns all but the last 4 digits to variable test.\n" 
46 "If there are no parameters it'll return with -1.\n"
47 "If there wrong parameters it go on and return with 0\n";
48
49 static char *app = "SubString";
50
51 static char *synopsis = "(Deprecated) Save substring digits in a given variable";
52
53 STANDARD_LOCAL_USER;
54
55 LOCAL_USER_DECL;
56
57 static int substring_exec(struct ast_channel *chan, void *data)
58 {
59   char newexten[AST_MAX_EXTENSION] = "";
60   char *count1, *count2;
61   char *first, *second, *stringp;
62
63   stringp=alloca(strlen(data)+1);
64   ast_log(LOG_WARNING, "The use of Substring application is deprecated. Please use ${variable:a:b} instead\n");
65   strncpy(stringp,data,strlen(data));
66   if (strchr(stringp,'|')&&strchr(stringp,'=')) {
67     int icount1,icount2;
68     first=strsep(&stringp,"=");
69     second=strsep(&stringp,"|");
70     count1=strsep(&stringp,"|");
71     count2=strsep(&stringp,"\0");
72     if (!first || !second || !count1 || !count2) {
73       ast_log(LOG_DEBUG, "Ignoring, since there is no argument: variable or string or count1 or count2\n");
74       return 0;
75     }
76     icount1=atoi(count1);
77     icount2=atoi(count2);
78         if (icount2<0) {
79           icount2 = icount2 + strlen(second);
80     }
81     if (abs(icount1)>strlen(second)) {
82       ast_log(LOG_WARNING, "Limiting count1 parameter because it exceeds the length of the string\n");
83       if (icount1>=0)
84         icount1=strlen(second);
85       else
86         icount1=0;
87     }
88     if ((icount1<0 && icount2>-icount1) || (icount1>=0 && icount1+icount2>strlen(second))) {
89       ast_log(LOG_WARNING, "Limiting count2 parameter because it exceeds the length of the string\n");
90       if (icount1>=0)
91         icount2=strlen(second)-icount1;
92       else
93         icount2=strlen(second)+icount1;
94     }
95     if (first&&second) {
96       if (icount1>=0)
97         strncpy(newexten,second+icount1,icount2);
98       else
99         strncpy(newexten,second+strlen(second)+icount1,icount2);
100       pbx_builtin_setvar_helper(chan,first,newexten);
101     }
102   } else {
103     ast_log(LOG_DEBUG, "Ignoring, no parameters\n");
104   }
105   return 0;
106 }
107
108 int unload_module(void)
109 {
110         STANDARD_HANGUP_LOCALUSERS;
111         return ast_unregister_application(app);
112 }
113
114 int load_module(void)
115 {
116         return ast_register_application(app, substring_exec, synopsis, descrip);
117 }
118
119 char *description(void)
120 {
121         return tdesc;
122 }
123
124 int usecount(void)
125 {
126         int res;
127         STANDARD_USECOUNT(res);
128         return res;
129 }
130
131 char *key()
132 {
133         return ASTERISK_GPL_KEY;
134 }