- mark some applications deprecated that already have replacements
[asterisk/asterisk.git] / apps / app_lookupcidname.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 name from database, based on directory number
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/options.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/translate.h"
44 #include "asterisk/image.h"
45 #include "asterisk/callerid.h"
46 #include "asterisk/astdb.h"
47
48 static char *tdesc = "Look up CallerID Name from local database";
49
50 static char *app = "LookupCIDName";
51
52 static char *synopsis = "Look up CallerID Name from local database";
53
54 static char *descrip =
55   "  LookupCIDName: Looks up the Caller*ID number on the active\n"
56   "channel in the Asterisk database (family 'cidname') and sets the\n"
57   "Caller*ID name.  Does nothing if no Caller*ID was received on the\n"
58   "channel.  This is useful if you do not subscribe to Caller*ID\n"
59   "name delivery, or if you want to change the names on some incoming\n"
60   "calls.\n";
61
62 LOCAL_USER_DECL;
63
64 static int
65 lookupcidname_exec (struct ast_channel *chan, void *data)
66 {
67   char dbname[64];
68   struct localuser *u;
69         static int dep_warning = 0;
70
71   LOCAL_USER_ADD (u);
72         if (!dep_warning) {
73                 dep_warning = 1;
74                 ast_log(LOG_WARNING, "LookupCIDName is deprecated.  Please use ${DB(cidname/${CALLERID(num)})} instead.\n");
75         }
76   if (chan->cid.cid_num) {
77         if (!ast_db_get ("cidname", chan->cid.cid_num, dbname, sizeof (dbname))) {
78                 ast_set_callerid (chan, NULL, dbname, NULL);
79                   if (option_verbose > 2)
80                     ast_verbose (VERBOSE_PREFIX_3 "Changed Caller*ID name to %s\n",
81                                  dbname);
82         }
83   }
84   LOCAL_USER_REMOVE (u);
85   return 0;
86 }
87
88 static int unload_module(void *mod)
89 {
90         int res;
91
92         res = ast_unregister_application (app);
93
94         STANDARD_HANGUP_LOCALUSERS;
95
96         return res;
97 }
98
99 static int load_module(void *mod)
100 {
101         return ast_register_application (app, lookupcidname_exec, synopsis, descrip);
102 }
103
104 static const char *description(void)
105 {
106         return tdesc;
107 }
108
109 static const char *key(void)
110 {
111         return ASTERISK_GPL_KEY;
112 }
113
114 STD_MOD1;