rename SetVar application to Set, deprecate SetVar
[asterisk/asterisk.git] / apps / app_setcidnum.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * App to set callerid
5  * 
6  * Copyright (C) 1999 - 2005, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  * Oliver Daudey <traveler@xs4all.nl>
10  *
11  * This program is free software, distributed under the terms of
12  * the GNU General Public License
13  */
14  
15 #include "asterisk/lock.h"
16 #include "asterisk/file.h"
17 #include "asterisk/logger.h"
18 #include "asterisk/channel.h"
19 #include "asterisk/pbx.h"
20 #include "asterisk/module.h"
21 #include "asterisk/translate.h"
22 #include "asterisk/image.h"
23 #include "asterisk/callerid.h"
24 #include "asterisk/utils.h"
25 #include <string.h>
26 #include <stdlib.h>
27
28 static char *tdesc = "Set CallerID Number";
29
30 static char *app = "SetCIDNum";
31
32 static char *synopsis = "Set CallerID Number";
33
34 static char *descrip = 
35 "  SetCIDNum(cnum[|a]): Set Caller*ID Number on a call to a new\n"
36 "value, while preserving the original Caller*ID name.  This is\n"
37 "useful for providing additional information to the called\n"
38 "party. Sets ANI as well if a flag is used.  Always returns 0\n"
39 "SetCIDNum has been deprecated in favor of the function\n"
40 "CALLERID(number)\n";
41
42 STANDARD_LOCAL_USER;
43
44 LOCAL_USER_DECL;
45
46 static int setcallerid_exec(struct ast_channel *chan, void *data)
47 {
48         int res = 0;
49         struct localuser *u;
50         char *opt;
51         int anitoo = 0;
52         char tmp[256];
53         static int deprecation_warning = 0;
54
55         if (!deprecation_warning) {
56                 ast_log(LOG_WARNING, "SetCIDNum is deprecated, please use Set(CALLERID(number)=value) instead.\n");
57                 deprecation_warning = 1;
58         }
59
60         if (data)
61                 strncpy(tmp, (char *)data, sizeof(tmp) - 1);
62         opt = strchr(tmp, '|');
63         if (opt) {
64                 *opt = '\0';
65                 opt++;
66                 if (*opt == 'a')
67                         anitoo = 1;
68         }
69         LOCAL_USER_ADD(u);
70         ast_set_callerid(chan, tmp, NULL, anitoo ? tmp : NULL);
71         LOCAL_USER_REMOVE(u);
72         return res;
73 }
74
75 int unload_module(void)
76 {
77         STANDARD_HANGUP_LOCALUSERS;
78         return ast_unregister_application(app);
79 }
80
81 int load_module(void)
82 {
83         return ast_register_application(app, setcallerid_exec, synopsis, descrip);
84 }
85
86 char *description(void)
87 {
88         return tdesc;
89 }
90
91 int usecount(void)
92 {
93         int res;
94         STANDARD_USECOUNT(res);
95         return res;
96 }
97
98 char *key()
99 {
100         return ASTERISK_GPL_KEY;
101 }