Doxygen documentation update from oej (issue #5505)
[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  */
24
25 #include <string.h>
26 #include <stdlib.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/lock.h"
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/options.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/astdb.h"
43
44 static char *tdesc = "Look up CallerID Name from local database";
45
46 static char *app = "LookupCIDName";
47
48 static char *synopsis = "Look up CallerID Name from local database";
49
50 static char *descrip =
51   "  LookupCIDName: Looks up the Caller*ID number on the active\n"
52   "channel in the Asterisk database (family 'cidname') and sets the\n"
53   "Caller*ID name.  Does nothing if no Caller*ID was received on the\n"
54   "channel.  This is useful if you do not subscribe to Caller*ID\n"
55   "name delivery, or if you want to change the names on some incoming\n"
56   "calls.  Always returns 0.\n";
57
58 STANDARD_LOCAL_USER;
59
60 LOCAL_USER_DECL;
61
62 static int
63 lookupcidname_exec (struct ast_channel *chan, void *data)
64 {
65   char dbname[64];
66   struct localuser *u;
67
68   LOCAL_USER_ADD (u);
69   if (chan->cid.cid_num) {
70         if (!ast_db_get ("cidname", chan->cid.cid_num, dbname, sizeof (dbname))) {
71                 ast_set_callerid (chan, NULL, dbname, NULL);
72                   if (option_verbose > 2)
73                     ast_verbose (VERBOSE_PREFIX_3 "Changed Caller*ID name to %s\n",
74                                  dbname);
75         }
76   }
77   LOCAL_USER_REMOVE (u);
78   return 0;
79 }
80
81 int
82 unload_module (void)
83 {
84         int res;
85
86         res = ast_unregister_application (app);
87
88         STANDARD_HANGUP_LOCALUSERS;
89
90         return res;
91 }
92
93 int
94 load_module (void)
95 {
96   return ast_register_application (app, lookupcidname_exec, synopsis,
97                                    descrip);
98 }
99
100 char *
101 description (void)
102 {
103   return tdesc;
104 }
105
106 int
107 usecount (void)
108 {
109   int res;
110   STANDARD_USECOUNT (res);
111   return res;
112 }
113
114 char *
115 key ()
116 {
117   return ASTERISK_GPL_KEY;
118 }