2cb5896a0d0f63d7d09064dd7512839674c599d7
[asterisk/asterisk.git] / apps / app_setcidname.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  * \ingroup applications
24  */
25  
26 #include <string.h>
27 #include <stdlib.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/lock.h"
34 #include "asterisk/file.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/translate.h"
40 #include "asterisk/image.h"
41 #include "asterisk/callerid.h"
42 #include "asterisk/utils.h"
43
44 static char *tdesc = "Set CallerID Name";
45
46 static char *app = "SetCIDName";
47
48 static char *synopsis = "Set CallerID Name";
49
50 static char *descrip = 
51 "  SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new\n"
52 "value, while preserving the original Caller*ID number.  This is\n"
53 "useful for providing additional information to the called\n"
54 "party. \n"
55 "SetCIDName has been deprecated in favor of the function\n"
56 "CALLERID(name)\n";
57
58 STANDARD_LOCAL_USER;
59
60 LOCAL_USER_DECL;
61
62 static int setcallerid_exec(struct ast_channel *chan, void *data)
63 {
64         char *tmp = NULL;       
65         struct localuser *u;
66         char *opt;
67         static int deprecation_warning = 0;
68
69         if (!deprecation_warning) {
70                 ast_log(LOG_WARNING, "SetCIDName is deprecated, please use Set(CALLERID(name)=value) instead.\n");
71                 deprecation_warning = 1;
72         }
73
74         if (ast_strlen_zero(data)) {
75                 ast_log(LOG_ERROR, "SetCIDName requires an argument!\n");
76                 return 0;       
77         }
78
79         LOCAL_USER_ADD(u);
80
81         tmp = ast_strdupa(data);
82         if (!tmp) {
83                 ast_log(LOG_ERROR, "Out of memory\n");
84                 LOCAL_USER_REMOVE(u);
85                 return -1;
86         }
87         
88         opt = strchr(tmp, '|');
89         if (opt) {
90                 *opt = '\0';
91         }
92         
93         ast_set_callerid(chan, NULL, tmp, NULL);
94
95         LOCAL_USER_REMOVE(u);
96         
97         return 0;
98 }
99
100 int unload_module(void)
101 {
102         int res;
103
104         res = ast_unregister_application(app);
105         
106         STANDARD_HANGUP_LOCALUSERS;
107
108         return res;     
109 }
110
111 int load_module(void)
112 {
113         return ast_register_application(app, setcallerid_exec, synopsis, descrip);
114 }
115
116 char *description(void)
117 {
118         return tdesc;
119 }
120
121 int usecount(void)
122 {
123         int res;
124         STANDARD_USECOUNT(res);
125         return res;
126 }
127
128 char *key()
129 {
130         return ASTERISK_GPL_KEY;
131 }