95ea2c0ebe0c16cc6d91f6273ecd914f85fee985
[asterisk/asterisk.git] / apps / app_setcidnum.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  * Oliver Daudey <traveler@xs4all.nl>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief App to set callerid number
23  * 
24  * \ingroup applications
25  */
26  
27 #include <string.h>
28 #include <stdlib.h>
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/lock.h"
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/translate.h"
41 #include "asterisk/image.h"
42 #include "asterisk/callerid.h"
43 #include "asterisk/utils.h"
44
45 static char *tdesc = "Set CallerID Number";
46
47 static char *app = "SetCIDNum";
48
49 static char *synopsis = "Set CallerID Number";
50
51 static char *descrip = 
52 "  SetCIDNum(cnum[|a]): Set Caller*ID Number on a call to a new\n"
53 "value, while preserving the original Caller*ID name.  This is\n"
54 "useful for providing additional information to the called\n"
55 "party. Sets ANI as well if a flag is used.\n"
56 "SetCIDNum has been deprecated in favor of the function\n"
57 "CALLERID(number)\n";
58
59 STANDARD_LOCAL_USER;
60
61 LOCAL_USER_DECL;
62
63 static int setcallerid_exec(struct ast_channel *chan, void *data)
64 {
65         int res = 0;
66         struct localuser *u;
67         char *opt;
68         int anitoo = 0;
69         char *tmp = NULL;
70         static int deprecation_warning = 0;
71
72         LOCAL_USER_ADD(u);
73         
74         if (!deprecation_warning) {
75                 ast_log(LOG_WARNING, "SetCIDNum is deprecated, please use Set(CALLERID(number)=value) instead.\n");
76                 deprecation_warning = 1;
77         }
78
79         if (data)
80                 tmp = ast_strdupa(data);
81         else
82                 tmp = "";
83         
84         opt = strchr(tmp, '|');
85         if (opt) {
86                 *opt = '\0';
87                 opt++;
88                 if (*opt == 'a')
89                         anitoo = 1;
90         }
91         
92         ast_set_callerid(chan, tmp, NULL, anitoo ? tmp : NULL);
93
94         LOCAL_USER_REMOVE(u);
95         
96         return res;
97 }
98
99 int unload_module(void)
100 {
101         int res;
102         
103         res = ast_unregister_application(app);
104         
105         STANDARD_HANGUP_LOCALUSERS;
106
107         return res;     
108 }
109
110 int load_module(void)
111 {
112         return ast_register_application(app, setcallerid_exec, synopsis, descrip);
113 }
114
115 char *description(void)
116 {
117         return tdesc;
118 }
119
120 int usecount(void)
121 {
122         int res;
123         STANDARD_USECOUNT(res);
124         return res;
125 }
126
127 char *key()
128 {
129         return ASTERISK_GPL_KEY;
130 }