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