Merge pull request #78 from ffontaine/master
[olsrd.git] / lib / txtinfo / src / olsrd_plugin.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 /*
47  * Dynamic linked library for the olsr.org olsr daemon
48  */
49
50 #include "olsrd_txtinfo.h"
51 #include "olsrd_plugin.h"
52 #include "info/olsrd_info.h"
53 #include "olsr.h"
54 #include "builddata.h"
55
56 #define PLUGIN_NAME              "TXTINFO"
57 #define PLUGIN_TITLE             "OLSRD txtinfo plugin"
58 #define PLUGIN_INTERFACE_VERSION 5
59
60 info_plugin_functions_t functions;
61 info_plugin_config_t config;
62 bool vtime;
63
64 static void my_init(void) __attribute__ ((constructor));
65 static void my_fini(void) __attribute__ ((destructor));
66
67 /**
68  *Constructor
69  */
70 static void my_init(void) {
71   /* Print plugin info to stdout */
72   olsr_printf(0, "%s (%s)\n", PLUGIN_TITLE, git_descriptor);
73
74   info_plugin_config_init(&config, 2006);
75   config.http_headers = false;
76   vtime = false;
77 }
78
79 /**
80  *Destructor
81  */
82 static void my_fini(void) {
83   /* Calls the destruction function
84    * olsr_plugin_exit()
85    * This function should be present in your
86    * sourcefile and all data destruction
87    * should happen there - NOT HERE!
88    */
89   olsr_plugin_exit();
90 }
91
92 /**
93  *Do initialization here
94  *
95  *This function is called by the my_init
96  *function in uolsrd_plugin.c
97  */
98 int olsrd_plugin_init(void) {
99   memset(&functions, 0, sizeof(functions));
100
101   functions.supportsCompositeCommands = true;
102   functions.supported_commands_mask = get_supported_commands_mask;
103   functions.is_command = isCommand;
104   functions.cache_timeout = cache_timeout_generic;
105   functions.output_error = output_error;
106
107   functions.neighbors = ipc_print_neighbors;
108   functions.links = ipc_print_links;
109   functions.routes = ipc_print_routes;
110   functions.topology = ipc_print_topology;
111   functions.hna = ipc_print_hna;
112   functions.mid = ipc_print_mid;
113   functions.gateways = ipc_print_gateways;
114   functions.sgw = ipc_print_sgw;
115   functions.version = ipc_print_version;
116   functions.olsrd_conf = ipc_print_olsrd_conf;
117   functions.interfaces = ipc_print_interfaces;
118   functions.twohop = ipc_print_twohop;
119
120   return info_plugin_init(PLUGIN_NAME, &functions, &config);
121 }
122
123 /**
124  * destructor - called at unload
125  */
126 void olsr_plugin_exit(void) {
127   info_plugin_exit();
128 }
129
130 int olsrd_plugin_interface_version(void) {
131   return PLUGIN_INTERFACE_VERSION;
132 }
133
134 static const struct olsrd_plugin_parameters plugin_parameters[] = { //
135     //
136         INFO_PLUGIN_CONFIG_PLUGIN_PARAMETERS(config), //
137         { .name = "vtime", .set_plugin_parameter = &set_plugin_boolean, .data = &vtime } //
138     };
139
140 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size) {
141   *params = plugin_parameters;
142   *size = sizeof(plugin_parameters) / sizeof(*plugin_parameters);
143 }
144
145 /*
146  * Local Variables:
147  * mode: c
148  * style: linux
149  * c-basic-offset: 2
150  * indent-tabs-mode: nil
151  * End:
152  */