make app_queue 1.2 jump compliant (issue #5580)
[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 <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/lock.h"
36 #include "asterisk/file.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/module.h"
41 #include "asterisk/translate.h"
42 #include "asterisk/image.h"
43 #include "asterisk/callerid.h"
44 #include "asterisk/utils.h"
45
46 static char *tdesc = "Set CallerID Number";
47
48 static char *app = "SetCIDNum";
49
50 static char *synopsis = "Set CallerID Number";
51
52 static char *descrip = 
53 "  SetCIDNum(cnum[|a]): Set Caller*ID Number on a call to a new\n"
54 "value, while preserving the original Caller*ID name.  This is\n"
55 "useful for providing additional information to the called\n"
56 "party. Sets ANI as well if a flag is used.\n"
57 "SetCIDNum has been deprecated in favor of the function\n"
58 "CALLERID(number)\n";
59
60 STANDARD_LOCAL_USER;
61
62 LOCAL_USER_DECL;
63
64 static int setcallerid_exec(struct ast_channel *chan, void *data)
65 {
66         int res = 0;
67         struct localuser *u;
68         char *opt;
69         int anitoo = 0;
70         char *tmp = NULL;
71         static int deprecation_warning = 0;
72
73         LOCAL_USER_ADD(u);
74         
75         if (!deprecation_warning) {
76                 ast_log(LOG_WARNING, "SetCIDNum is deprecated, please use Set(CALLERID(number)=value) instead.\n");
77                 deprecation_warning = 1;
78         }
79
80         if (data)
81                 tmp = ast_strdupa(data);
82         else
83                 tmp = "";
84         
85         opt = strchr(tmp, '|');
86         if (opt) {
87                 *opt = '\0';
88                 opt++;
89                 if (*opt == 'a')
90                         anitoo = 1;
91         }
92         
93         ast_set_callerid(chan, tmp, NULL, anitoo ? tmp : NULL);
94
95         LOCAL_USER_REMOVE(u);
96         
97         return res;
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 }