info: use a define for the info_plugin_config_t plugin parameters
[olsrd.git] / lib / info / info_types.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2015
4  *
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _OLSRD_LIB_INFO_INFO_TYPES_H_
43 #define _OLSRD_LIB_INFO_INFO_TYPES_H_
44
45 #include <stdbool.h>
46
47 #include "common/autobuf.h"
48
49 /* these provide all of the runtime status info */
50 #define SIW_NEIGHBORS 0x0001
51 #define SIW_LINKS 0x0002
52 #define SIW_ROUTES 0x0004
53 #define SIW_HNA 0x0008
54 #define SIW_MID 0x0010
55 #define SIW_TOPOLOGY 0x0020
56 #define SIW_GATEWAYS 0x0040
57 #define SIW_INTERFACES 0x0080
58 #define SIW_2HOP 0x0100
59 #define SIW_SGW 0x0200
60 #define SIW_RUNTIME_ALL (SIW_NEIGHBORS | SIW_LINKS | SIW_ROUTES | SIW_HNA | SIW_MID | SIW_TOPOLOGY | SIW_GATEWAYS | SIW_INTERFACES | SIW_2HOP | SIW_SGW)
61 #define SIW_NEIGHBORS_FREIFUNK (SIW_NEIGHBORS | SIW_LINKS) /* special */
62
63 /* these only change at olsrd startup */
64 #define SIW_VERSION 0x0400
65 #define SIW_CONFIG 0x0800
66 #define SIW_PLUGINS 0x1000
67 #define SIW_STARTUP_ALL (SIW_VERSION | SIW_CONFIG | SIW_PLUGINS)
68
69 /* this is everything in normal format */
70 #define SIW_ALL (SIW_RUNTIME_ALL | SIW_STARTUP_ALL)
71
72 /* this data is not normal format but olsrd.conf format */
73 #define SIW_OLSRD_CONF 0x2000
74
75 typedef void (*init_plugin)(const char *plugin_name);
76 typedef bool (*determine_command)(const char *str, unsigned int siw);
77 typedef const char * (*mime_type)(unsigned int send_what);
78 typedef void (*output_start_end)(struct autobuf *abuf);
79 typedef void (*printer_neighbors)(struct autobuf *abuf, bool list_2hop);
80 typedef void (*printer_generic)(struct autobuf *abuf);
81
82 typedef struct {
83     init_plugin init;
84     determine_command is_command;
85     mime_type determine_mime_type;
86     output_start_end output_start;
87     output_start_end output_end;
88     printer_neighbors neighbors;
89     printer_generic links;
90     printer_generic routes;
91     printer_generic topology;
92     printer_generic hna;
93     printer_generic mid;
94     printer_generic gateways;
95     printer_generic sgw;
96     printer_generic version;
97     printer_generic olsrd_conf;
98     printer_generic interfaces;
99     printer_generic config;
100     printer_generic plugins;
101 } info_plugin_functions_t;
102
103 typedef struct {
104     union olsr_ip_addr accept_ip;
105     union olsr_ip_addr listen_ip;
106     int ipc_port;
107     int nompr;
108     bool http_headers;
109     bool allow_localhost;
110     int ipv6_only;
111 } info_plugin_config_t;
112
113 #define INFO_PLUGIN_CONFIG_PLUGIN_PARAMETERS \
114   { .name = "port", .set_plugin_parameter = &set_plugin_port, .data = &config.ipc_port }, \
115   { .name = "accept", .set_plugin_parameter = &set_plugin_ipaddress, .data = &config.accept_ip }, \
116   { .name = "listen", .set_plugin_parameter = &set_plugin_ipaddress, .data = &config.listen_ip }, \
117   { .name = "httpheaders", .set_plugin_parameter = &set_plugin_boolean, .data = &config.http_headers }, \
118   { .name = "allowlocalhost", .set_plugin_parameter = &set_plugin_boolean, .data = &config.allow_localhost }, \
119   { .name = "ipv6only", .set_plugin_parameter = &set_plugin_boolean, .data = &config.ipv6_only }
120
121   #endif /* _OLSRD_LIB_INFO_INFO_TYPES_H_ */