rename SetVar application to Set, deprecate SetVar
[asterisk/asterisk.git] / apps / app_setcidname.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * App to set callerid
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13  
14 #include "asterisk/lock.h"
15 #include "asterisk/file.h"
16 #include "asterisk/logger.h"
17 #include "asterisk/channel.h"
18 #include "asterisk/pbx.h"
19 #include "asterisk/module.h"
20 #include "asterisk/translate.h"
21 #include "asterisk/image.h"
22 #include "asterisk/callerid.h"
23 #include "asterisk/utils.h"
24 #include <string.h>
25 #include <stdlib.h>
26
27 static char *tdesc = "Set CallerID Name";
28
29 static char *app = "SetCIDName";
30
31 static char *synopsis = "Set CallerID Name";
32
33 static char *descrip = 
34 "  SetCIDName(cname[|a]): Set Caller*ID Name on a call to a new\n"
35 "value, while preserving the original Caller*ID number.  This is\n"
36 "useful for providing additional information to the called\n"
37 "party. Always returns 0\n"
38 "SetCIDName has been deprecated in favor of the function\n"
39 "CALLERID(name)\n";
40
41 STANDARD_LOCAL_USER;
42
43 LOCAL_USER_DECL;
44
45 static int setcallerid_exec(struct ast_channel *chan, void *data)
46 {
47         int res = 0;
48         char tmp[256] = "";
49         struct localuser *u;
50         char *opt;
51         static int deprecation_warning = 0;
52
53         if (!deprecation_warning) {
54                 ast_log(LOG_WARNING, "SetCIDName is deprecated, please use Set(CALLERID(name)=value) instead.\n");
55                 deprecation_warning = 1;
56         }
57
58         if (data)
59                 strncpy(tmp, (char *)data, sizeof(tmp) - 1);
60         opt = strchr(tmp, '|');
61         if (opt) {
62                 *opt = '\0';
63         }
64         LOCAL_USER_ADD(u);
65         ast_set_callerid(chan, NULL, tmp, NULL);
66         LOCAL_USER_REMOVE(u);
67         return res;
68 }
69
70 int unload_module(void)
71 {
72         STANDARD_HANGUP_LOCALUSERS;
73         return ast_unregister_application(app);
74 }
75
76 int load_module(void)
77 {
78         return ast_register_application(app, setcallerid_exec, synopsis, descrip);
79 }
80
81 char *description(void)
82 {
83         return tdesc;
84 }
85
86 int usecount(void)
87 {
88         int res;
89         STANDARD_USECOUNT(res);
90         return res;
91 }
92
93 char *key()
94 {
95         return ASTERISK_GPL_KEY;
96 }