Doxygen Cleanup
[asterisk/asterisk.git] / res / res_snmp.c
1 /*
2  * Copyright (C) 2006 Voop as
3  * Thorsten Lockert <tholo@voop.as>
4  *
5  * This program is free software, distributed under the terms of
6  * the GNU General Public License Version 2. See the LICENSE file
7  * at the top of the source tree.
8  */
9
10 /*! \file
11  *
12  * \brief SNMP Agent / SubAgent support for Asterisk
13  *
14  * \author Thorsten Lockert <tholo@voop.as>
15  *
16  * Uses the Net-SNMP libraries available at
17  *       http://net-snmp.sourceforge.net/
18  */
19
20 /*!
21  * \li The resource res_snmp uses the configuration file \ref res_snmp.conf
22  * \addtogroup configuration_file Configuration Files
23  */
24
25 /*!
26  * \page res_snmp.conf res_snmp.conf
27  * \verbinclude res_snmp.conf.sample
28  */
29
30 /*** MODULEINFO
31         <depend>netsnmp</depend>
32         <support_level>extended</support_level>
33  ***/
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/channel.h"
40 #include "asterisk/module.h"
41
42 #include "snmp/agent.h"
43
44 #define MODULE_DESCRIPTION      "SNMP [Sub]Agent for Asterisk"
45
46 int res_snmp_agentx_subagent;
47 int res_snmp_dont_stop;
48 static int res_snmp_enabled;
49
50 static pthread_t thread = AST_PTHREADT_NULL;
51
52 /*!
53  * \brief Load res_snmp.conf config file
54  * \return 1 on load, 0 file does not exist
55 */
56 static int load_config(void)
57 {
58         struct ast_variable *var;
59         struct ast_config *cfg;
60         struct ast_flags config_flags = { 0 };
61         char *cat;
62
63         res_snmp_enabled = 0;
64         res_snmp_agentx_subagent = 1;
65         cfg = ast_config_load("res_snmp.conf", config_flags);
66         if (cfg == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEINVALID) {
67                 ast_log(LOG_WARNING, "Could not load res_snmp.conf\n");
68                 return 0;
69         }
70         cat = ast_category_browse(cfg, NULL);
71         while (cat) {
72                 var = ast_variable_browse(cfg, cat);
73
74                 if (strcasecmp(cat, "general") == 0) {
75                         while (var) {
76                                 if (strcasecmp(var->name, "subagent") == 0) {
77                                         if (ast_true(var->value))
78                                                 res_snmp_agentx_subagent = 1;
79                                         else if (ast_false(var->value))
80                                                 res_snmp_agentx_subagent = 0;
81                                         else {
82                                                 ast_log(LOG_ERROR, "Value '%s' does not evaluate to true or false.\n", var->value);
83                                                 ast_config_destroy(cfg);
84                                                 return 1;
85                                         }
86                                 } else if (strcasecmp(var->name, "enabled") == 0) {
87                                         res_snmp_enabled = ast_true(var->value);
88                                 } else {
89                                         ast_log(LOG_ERROR, "Unrecognized variable '%s' in category '%s'\n", var->name, cat);
90                                         ast_config_destroy(cfg);
91                                         return 1;
92                                 }
93                                 var = var->next;
94                         }
95                 } else {
96                         ast_log(LOG_ERROR, "Unrecognized category '%s'\n", cat);
97                         ast_config_destroy(cfg);
98                         return 1;
99                 }
100
101                 cat = ast_category_browse(cfg, cat);
102         }
103         ast_config_destroy(cfg);
104         return 1;
105 }
106
107 /*!
108  * \brief Load the module
109  *
110  * Module loading including tests for configuration or dependencies.
111  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
112  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
113  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
114  * configuration file or other non-critical problem return 
115  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
116  */
117 static int load_module(void)
118 {
119         if(!load_config())
120                 return AST_MODULE_LOAD_DECLINE;
121
122         ast_verb(1, "Loading [Sub]Agent Module\n");
123
124         res_snmp_dont_stop = 1;
125         if (res_snmp_enabled)
126                 return ast_pthread_create_background(&thread, NULL, agent_thread, NULL);
127         else
128                 return 0;
129 }
130
131 static int unload_module(void)
132 {
133         ast_verb(1, "Unloading [Sub]Agent Module\n");
134
135         res_snmp_dont_stop = 0;
136         return ((thread != AST_PTHREADT_NULL) ? pthread_join(thread, NULL) : 0);
137 }
138
139 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "SNMP [Sub]Agent for Asterisk",
140                 .load = load_module,
141                 .unload = unload_module,
142                 );