make app_queue 1.2 jump compliant (issue #5580)
[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 <stdlib.h>
27 #include <stdio.h>
28 #include <string.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 Name";
46
47 static char *app = "SetCIDName";
48
49 static char *synopsis = "Set CallerID Name";
50
51 static char *descrip = 
52 "  SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new\n"
53 "value, while preserving the original Caller*ID number.  This is\n"
54 "useful for providing additional information to the called\n"
55 "party. \n"
56 "SetCIDName has been deprecated in favor of the function\n"
57 "CALLERID(name)\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         char *tmp = NULL;       
66         struct localuser *u;
67         char *opt;
68         static int deprecation_warning = 0;
69
70         if (!deprecation_warning) {
71                 ast_log(LOG_WARNING, "SetCIDName is deprecated, please use Set(CALLERID(name)=value) instead.\n");
72                 deprecation_warning = 1;
73         }
74
75         if (ast_strlen_zero(data)) {
76                 ast_log(LOG_ERROR, "SetCIDName requires an argument!\n");
77                 return 0;       
78         }
79
80         LOCAL_USER_ADD(u);
81
82         tmp = ast_strdupa(data);
83         if (!tmp) {
84                 ast_log(LOG_ERROR, "Out of memory\n");
85                 LOCAL_USER_REMOVE(u);
86                 return -1;
87         }
88         
89         opt = strchr(tmp, '|');
90         if (opt) {
91                 *opt = '\0';
92         }
93         
94         ast_set_callerid(chan, NULL, tmp, NULL);
95
96         LOCAL_USER_REMOVE(u);
97         
98         return 0;
99 }
100
101 int unload_module(void)
102 {
103         int res;
104
105         res = ast_unregister_application(app);
106         
107         STANDARD_HANGUP_LOCALUSERS;
108
109         return res;     
110 }
111
112 int load_module(void)
113 {
114         return ast_register_application(app, setcallerid_exec, synopsis, descrip);
115 }
116
117 char *description(void)
118 {
119         return tdesc;
120 }
121
122 int usecount(void)
123 {
124         int res;
125         STANDARD_USECOUNT(res);
126         return res;
127 }
128
129 char *key()
130 {
131         return ASTERISK_GPL_KEY;
132 }