Deprecate SetCallerID (should have happened prior to release of 1.2)
[asterisk/asterisk.git] / apps / app_setcallerid.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 /*! \file
20  *
21  * \brief App to set callerid
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27  
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/translate.h"
43 #include "asterisk/image.h"
44 #include "asterisk/callerid.h"
45
46 static char *app2 = "SetCallerPres";
47
48 static char *synopsis2 = "Set CallerID Presentation";
49
50 LOCAL_USER_DECL;
51
52 static char *descrip2 = 
53 "  SetCallerPres(presentation): Set Caller*ID presentation on a call.\n"
54 "  Valid presentations are:\n"
55 "\n"
56 "      allowed_not_screened    : Presentation Allowed, Not Screened\n"
57 "      allowed_passed_screen   : Presentation Allowed, Passed Screen\n" 
58 "      allowed_failed_screen   : Presentation Allowed, Failed Screen\n" 
59 "      allowed                 : Presentation Allowed, Network Number\n"
60 "      prohib_not_screened     : Presentation Prohibited, Not Screened\n" 
61 "      prohib_passed_screen    : Presentation Prohibited, Passed Screen\n"
62 "      prohib_failed_screen    : Presentation Prohibited, Failed Screen\n"
63 "      prohib                  : Presentation Prohibited, Network Number\n"
64 "      unavailable             : Number Unavailable\n"
65 "\n"
66 ;
67
68 static int setcallerid_pres_exec(struct ast_channel *chan, void *data)
69 {
70         struct localuser *u;
71         int pres = -1;
72
73         LOCAL_USER_ADD(u);
74         
75         pres = ast_parse_caller_presentation(data);
76
77         if (pres < 0) {
78                 ast_log(LOG_WARNING, "'%s' is not a valid presentation (see 'show application SetCallerPres')\n",
79                         (char *) data);
80                 LOCAL_USER_REMOVE(u);
81                 return 0;
82         }
83         
84         chan->cid.cid_pres = pres;
85         LOCAL_USER_REMOVE(u);
86         return 0;
87 }
88
89
90
91 static char *tdesc = "Set CallerID Application";
92
93 static char *app = "SetCallerID";
94
95 static char *synopsis = "Set CallerID";
96
97 static char *descrip = 
98 "  SetCallerID(clid[|a]): Set Caller*ID on a call to a new\n"
99 "value.  Sets ANI as well if a flag is used. \n";
100
101 static int setcallerid_exec(struct ast_channel *chan, void *data)
102 {
103         int res = 0;
104         char *tmp = NULL;
105         char name[256];
106         char num[256];
107         struct localuser *u;
108         char *opt;
109         int anitoo = 0;
110         static int dep_warning = 0;
111
112         if (ast_strlen_zero(data)) {
113                 ast_log(LOG_WARNING, "SetCallerID requires an argument!\n");
114                 return 0;
115         }
116         
117         LOCAL_USER_ADD(u);
118
119         if (!dep_warning) {
120                 dep_warning = 1;
121                 ast_log(LOG_WARNING, "SetCallerID is deprecated.  Please use Set(CALLERID(all)=...) or Set(CALLERID(ani)=...) instead.\n");
122         }
123
124         tmp = ast_strdupa(data);
125         
126         opt = strchr(tmp, '|');
127         if (opt) {
128                 *opt = '\0';
129                 opt++;
130                 if (*opt == 'a')
131                         anitoo = 1;
132         }
133         
134         ast_callerid_split(tmp, name, sizeof(name), num, sizeof(num));
135         ast_set_callerid(chan, num, name, anitoo ? num : NULL);
136
137         LOCAL_USER_REMOVE(u);
138         
139         return res;
140 }
141
142 static int unload_module(void *mod)
143 {
144         int res;
145
146         res = ast_unregister_application(app2);
147         res |= ast_unregister_application(app);
148
149         STANDARD_HANGUP_LOCALUSERS;
150
151         return res;
152 }
153
154 static int load_module(void *mod)
155 {
156         int res;
157         
158         res = ast_register_application(app2, setcallerid_pres_exec, synopsis2, descrip2);
159         res |= ast_register_application(app, setcallerid_exec, synopsis, descrip);
160
161         return res;
162 }
163
164 static const char *description(void)
165 {
166         return tdesc;
167 }
168
169 static const char *key(void)
170 {
171         return ASTERISK_GPL_KEY;
172 }
173
174 STD_MOD1;