res_resolver_unbound: Fix config documentation.
[asterisk/asterisk.git] / res / res_curl.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2008, Digium, Inc.
5  *
6  * Tilghman Lesher <res_curl_v1@the-tilghman.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 curl resource engine
22  *
23  * \author Tilghman Lesher <res_curl_v1@the-tilghman.com>
24  *
25  * Depends on the CURL library  - http://curl.haxx.se/
26  * 
27  */
28
29 /*! \li \ref res_curl.c uses the configuration file \ref res_curl.conf
30  * \addtogroup configuration_file Configuration Files
31  */
32
33 /*! 
34  * \page res_curl.conf res_curl.conf
35  * \verbinclude res_curl.conf.sample
36  */
37
38 /*** MODULEINFO
39         <depend>curl</depend>
40         <support_level>core</support_level>
41  ***/
42
43 #include "asterisk.h"
44
45 ASTERISK_REGISTER_FILE()
46
47 #include <curl/curl.h>
48
49 #include "asterisk/module.h"
50
51 static const char *dependents[] = {
52         "func_curl.so",
53         "res_config_curl.so",
54         "res_http_media_cache.so",
55 };
56
57 static int unload_module(void)
58 {
59         int res = 0;
60         size_t i;
61
62         /* If the dependent modules are still in memory, forbid unload */
63         for (i = 0; i < ARRAY_LEN(dependents); i++) {
64                 if (ast_module_check(dependents[i])) {
65                         ast_log(LOG_ERROR, "%s (dependent module) is still loaded.  Cannot unload res_curl.so\n", dependents[i]);
66                         res = -1;
67                 }
68         }
69
70         if (res)
71                 return -1;
72
73         curl_global_cleanup();
74
75         return res;
76 }
77
78 /*!
79  * \brief Load the module
80  *
81  * Module loading including tests for configuration or dependencies.
82  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
83  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
84  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
85  * configuration file or other non-critical problem return 
86  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
87  */
88 static int load_module(void)
89 {
90         int res = 0;
91
92         if (curl_global_init(CURL_GLOBAL_ALL)) {
93                 ast_log(LOG_ERROR, "Unable to initialize the cURL library. Cannot load res_curl.so\n");
94                 return AST_MODULE_LOAD_DECLINE;
95         }
96
97         return res;
98 }
99
100 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "cURL Resource Module",
101         .support_level = AST_MODULE_SUPPORT_CORE,
102         .load = load_module,
103         .unload = unload_module,
104         .load_pri = AST_MODPRI_REALTIME_DEPEND,
105 );