txtinfo: convert INFO_ALLOW_LOCALHOST define into a plugin parameter
[olsrd.git] / lib / txtinfo / src / olsrd_txtinfo.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004
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 /*
43  * Dynamic linked library for the olsr.org olsr daemon
44  */
45
46 #include <arpa/inet.h>
47 #include <string.h>
48 #include <unistd.h>
49
50 #include "ipcalc.h"
51 #include "olsr.h"
52 #include "scheduler.h"
53 #include "../../info/http_headers.h"
54 #include "../../info/info_types.h"
55 #include "txtinfo_printers.h"
56
57 #include "olsrd_txtinfo.h"
58
59 #ifdef _WIN32
60 #define close(x) closesocket(x)
61 #endif /* _WIN32 */
62
63 /* defines to make txtinfo and jsoninfo look alike */
64 #define PLUGIN_NAME "TXTINFO"
65 #define info_accept_ip txtinfo_accept_ip
66 #define info_listen_ip txtinfo_listen_ip
67 #define info_ipv6_only txtinfo_ipv6_only
68
69 static int ipc_socket;
70
71 /* IPC initialization function */
72 static int plugin_ipc_init(void);
73
74 static void send_info(unsigned int /*send_what*/, int /*socket*/);
75
76 static void ipc_action(int, void *, unsigned int);
77
78 #define TXT_IPC_BUFSIZE 256
79
80 static outbuffer_t outbuffer;
81
82 static struct timer_entry *writetimer_entry;
83
84 static printer_functions_t printer_functions = { //
85     //
86         .init = NULL, //
87         .is_command = &isCommand, //
88         .determine_mime_type = NULL, //
89         .output_start = NULL, //
90         .output_end = NULL, //
91         .neighbors = &ipc_print_neighbors, //
92         .links = &ipc_print_links, //
93         .routes = &ipc_print_routes, //
94         .topology = &ipc_print_topology, //
95         .hna = &ipc_print_hna, //
96         .mid = &ipc_print_mid, //
97         .gateways = &ipc_print_gateways, //
98         .sgw = &ipc_print_sgw, //
99         .version = &ipc_print_version, //
100         .olsrd_conf = &ipc_print_olsrd_conf, //
101         .interfaces = &ipc_print_interfaces, //
102         .config = NULL, //
103         .plugins = NULL //
104     };
105
106 static void determine_action(unsigned int *send_what, char *requ) {
107   if (!printer_functions.is_command)
108     *send_what = 0;
109   else if ((*printer_functions.is_command)(requ, SIW_OLSRD_CONF))
110     *send_what |= SIW_OLSRD_CONF;
111   else if ((*printer_functions.is_command)(requ, SIW_ALL))
112     *send_what = SIW_ALL;
113   else {
114     // these are the two overarching categories
115     if ((*printer_functions.is_command)(requ, SIW_RUNTIME_ALL))
116       *send_what |= SIW_RUNTIME_ALL;
117     if ((*printer_functions.is_command)(requ, SIW_STARTUP_ALL))
118       *send_what |= SIW_STARTUP_ALL;
119
120     // these are the individual sections
121     if ((*printer_functions.is_command)(requ, SIW_NEIGHBORS))
122       *send_what |= SIW_NEIGHBORS;
123     if ((*printer_functions.is_command)(requ, SIW_LINKS))
124       *send_what |= SIW_LINKS;
125     if ((*printer_functions.is_command)(requ, SIW_ROUTES))
126       *send_what |= SIW_ROUTES;
127     if ((*printer_functions.is_command)(requ, SIW_HNA))
128       *send_what |= SIW_HNA;
129     if ((*printer_functions.is_command)(requ, SIW_MID))
130       *send_what |= SIW_MID;
131     if ((*printer_functions.is_command)(requ, SIW_TOPOLOGY))
132       *send_what |= SIW_TOPOLOGY;
133     if ((*printer_functions.is_command)(requ, SIW_GATEWAYS))
134       *send_what |= SIW_GATEWAYS;
135     if ((*printer_functions.is_command)(requ, SIW_INTERFACES))
136       *send_what |= SIW_INTERFACES;
137     if ((*printer_functions.is_command)(requ, SIW_2HOP))
138       *send_what |= SIW_2HOP;
139     if ((*printer_functions.is_command)(requ, SIW_SGW))
140       *send_what |= SIW_SGW;
141
142     // specials
143     if ((*printer_functions.is_command)(requ, SIW_VERSION))
144       *send_what |= SIW_VERSION;
145     if ((*printer_functions.is_command)(requ, SIW_CONFIG))
146       *send_what |= SIW_CONFIG;
147     if ((*printer_functions.is_command)(requ, SIW_PLUGINS))
148       *send_what |= SIW_PLUGINS;
149
150     /* To print out neighbours only on the Freifunk Status
151      * page the normal output is somewhat lengthy. The
152      * header parsing is sufficient for standard wget.
153      */
154     if ((*printer_functions.is_command)(requ, SIW_NEIGHBORS_FREIFUNK))
155       *send_what = SIW_NEIGHBORS_FREIFUNK;
156   }
157 }
158
159 /**
160  *Do initialization here
161  *
162  *This function is called by the my_init
163  *function in uolsrd_plugin.c
164  */
165 int olsrd_plugin_init(void) {
166   /* Initial IPC value */
167   ipc_socket = -1;
168   memset(&outbuffer, 0, sizeof(outbuffer));
169
170   if (printer_functions.init) {
171     (*printer_functions.init)(PLUGIN_NAME);
172   }
173
174   plugin_ipc_init();
175   return 1;
176 }
177
178 /**
179  * destructor - called at unload
180  */
181 void olsr_plugin_exit(void) {
182   if (ipc_socket != -1)
183     close(ipc_socket);
184 }
185
186 static int plugin_ipc_init(void) {
187   union olsr_sockaddr sst;
188   uint32_t yes = 1;
189   socklen_t addrlen;
190
191   /* Init ipc socket */
192   if ((ipc_socket = socket(olsr_cnf->ip_version, SOCK_STREAM, 0)) == -1) {
193 #ifndef NODEBUG
194     olsr_printf(1, "("PLUGIN_NAME") socket()=%s\n", strerror(errno));
195 #endif /* NODEBUG */
196     return 0;
197   } else {
198     if (setsockopt(ipc_socket, SOL_SOCKET, SO_REUSEADDR, (char *) &yes, sizeof(yes)) < 0) {
199 #ifndef NODEBUG
200       olsr_printf(1, "("PLUGIN_NAME") setsockopt()=%s\n", strerror(errno));
201 #endif /* NODEBUG */
202       return 0;
203     }
204 #if (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE
205     if (setsockopt(ipc_socket, SOL_SOCKET, SO_NOSIGPIPE, (char *) &yes, sizeof(yes)) < 0) {
206       perror("SO_REUSEADDR failed");
207       return 0;
208     }
209 #endif /* (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE */
210 #if defined linux && defined IPV6_V6ONLY
211     if (info_ipv6_only && olsr_cnf->ip_version == AF_INET6) {
212       if (setsockopt(ipc_socket, IPPROTO_IPV6, IPV6_V6ONLY, (char *) &yes, sizeof(yes)) < 0) {
213         perror("IPV6_V6ONLY failed");
214         return 0;
215       }
216     }
217 #endif /* defined linux && defined IPV6_V6ONLY */
218     /* Bind the socket */
219
220     /* complete the socket structure */
221     memset(&sst, 0, sizeof(sst));
222     if (olsr_cnf->ip_version == AF_INET) {
223       sst.in4.sin_family = AF_INET;
224       addrlen = sizeof(struct sockaddr_in);
225 #ifdef SIN6_LEN
226       sst.in4.sin_len = addrlen;
227 #endif /* SIN6_LEN */
228       sst.in4.sin_addr.s_addr = info_listen_ip.v4.s_addr;
229       sst.in4.sin_port = htons(ipc_port);
230     } else {
231       sst.in6.sin6_family = AF_INET6;
232       addrlen = sizeof(struct sockaddr_in6);
233 #ifdef SIN6_LEN
234       sst.in6.sin6_len = addrlen;
235 #endif /* SIN6_LEN */
236       sst.in6.sin6_addr = info_listen_ip.v6;
237       sst.in6.sin6_port = htons(ipc_port);
238     }
239
240     /* bind the socket to the port number */
241     if (bind(ipc_socket, &sst.in, addrlen) == -1) {
242 #ifndef NODEBUG
243       olsr_printf(1, "("PLUGIN_NAME") bind()=%s\n", strerror(errno));
244 #endif /* NODEBUG */
245       return 0;
246     }
247
248     /* show that we are willing to listen */
249     if (listen(ipc_socket, 1) == -1) {
250 #ifndef NODEBUG
251       olsr_printf(1, "("PLUGIN_NAME") listen()=%s\n", strerror(errno));
252 #endif /* NODEBUG */
253       return 0;
254     }
255
256     /* Register with olsrd */
257     add_olsr_socket(ipc_socket, &ipc_action, NULL, NULL, SP_PR_READ);
258
259 #ifndef NODEBUG
260     olsr_printf(2, "("PLUGIN_NAME") listening on port %d\n", ipc_port);
261 #endif /* NODEBUG */
262   }
263   return 1;
264 }
265
266 static void ipc_action(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused))) {
267   union olsr_sockaddr pin;
268
269   char addr[INET6_ADDRSTRLEN];
270   fd_set rfds;
271   struct timeval tv;
272   unsigned int send_what = 0;
273   int ipc_connection;
274
275   socklen_t addrlen = sizeof(pin);
276
277   if (outbuffer.count >= MAX_CLIENTS) {
278     return;
279   }
280
281   if ((ipc_connection = accept(fd, &pin.in, &addrlen)) == -1) {
282 #ifndef NODEBUG
283     olsr_printf(1, "("PLUGIN_NAME") accept()=%s\n", strerror(errno));
284 #endif /* NODEBUG */
285     return;
286   }
287
288   tv.tv_sec = tv.tv_usec = 0;
289   if (olsr_cnf->ip_version == AF_INET) {
290     if (inet_ntop(olsr_cnf->ip_version, &pin.in4.sin_addr, addr, INET6_ADDRSTRLEN) == NULL)
291       addr[0] = '\0';
292     if (!ip4equal(&pin.in4.sin_addr, &info_accept_ip.v4) && info_accept_ip.v4.s_addr != INADDR_ANY) {
293       if (!allow_localhost || ntohl(pin.in4.sin_addr.s_addr) != INADDR_LOOPBACK) {
294         olsr_printf(1, "("PLUGIN_NAME") From host(%s) not allowed!\n", addr);
295         close(ipc_connection);
296         return;
297       }
298     }
299   } else {
300     if (inet_ntop(olsr_cnf->ip_version, &pin.in6.sin6_addr, addr, INET6_ADDRSTRLEN) == NULL)
301       addr[0] = '\0';
302     /* Use in6addr_any (::) in olsr.conf to allow anybody. */
303     if (!ip6equal(&in6addr_any, &info_accept_ip.v6) && !ip6equal(&pin.in6.sin6_addr, &info_accept_ip.v6)) {
304       olsr_printf(1, "("PLUGIN_NAME") From host(%s) not allowed!\n", addr);
305       close(ipc_connection);
306       return;
307     }
308   }
309
310 #ifndef NODEBUG
311   olsr_printf(2, "("PLUGIN_NAME") Connect from %s\n", addr);
312 #endif /* NODEBUG */
313
314   /* purge read buffer to prevent blocking on linux */
315   FD_ZERO(&rfds);
316   FD_SET((unsigned int )ipc_connection, &rfds); /* Win32 needs the cast here */
317   if (0 <= select(ipc_connection + 1, &rfds, NULL, NULL, &tv)) {
318     char requ[1024];
319     ssize_t s = recv(ipc_connection, (void *) &requ, sizeof(requ) - 1, 0); /* Win32 needs the cast here */
320
321     if (s == sizeof(requ) - 1) {
322       /* input was much too long, just skip the rest */
323       char dummy[1024];
324
325       while (recv(ipc_connection, (void *) &dummy, sizeof(dummy), 0) == sizeof(dummy))
326         ;
327     }
328
329     if (0 < s) {
330       requ[s] = 0;
331       determine_action(&send_what, requ);
332     }
333
334     if (!send_what)
335       send_what = SIW_ALL;
336   }
337
338   send_info(send_what, ipc_connection);
339 }
340
341 static void info_write_data(void *foo __attribute__ ((unused))) {
342   fd_set set;
343   int result, i, j, max;
344   struct timeval tv;
345
346   FD_ZERO(&set);
347   max = 0;
348   for (i = 0; i < outbuffer.count; i++) {
349     /* And we cast here since we get a warning on Win32 */
350     FD_SET((unsigned int )(outbuffer.socket[i]), &set);
351
352     if (outbuffer.socket[i] > max) {
353       max = outbuffer.socket[i];
354     }
355   }
356
357   tv.tv_sec = 0;
358   tv.tv_usec = 0;
359
360   result = select(max + 1, NULL, &set, NULL, &tv);
361   if (result <= 0) {
362     return;
363   }
364
365   for (i = 0; i < outbuffer.count; i++) {
366     if (FD_ISSET(outbuffer.socket[i], &set)) {
367       result = send(outbuffer.socket[i], outbuffer.buffer[i] + outbuffer.written[i], outbuffer.size[i] - outbuffer.written[i], 0);
368       if (result > 0) {
369         outbuffer.written[i] += result;
370       }
371
372       if (result <= 0 || outbuffer.written[i] == outbuffer.size[i]) {
373         /* close this socket and cleanup*/
374         close(outbuffer.socket[i]);
375         free(outbuffer.buffer[i]);
376         outbuffer.buffer[i] = NULL;
377
378         for (j = i + 1; j < outbuffer.count; j++) {
379           outbuffer.buffer[j - 1] = outbuffer.buffer[j];
380           outbuffer.size[j - 1] = outbuffer.size[j];
381           outbuffer.socket[j - 1] = outbuffer.socket[j];
382           outbuffer.written[j - 1] = outbuffer.written[j];
383         }
384         outbuffer.count--;
385       }
386     }
387   }
388   if (!outbuffer.count) {
389     olsr_stop_timer(writetimer_entry);
390   }
391 }
392
393 static void send_info(unsigned int send_what, int the_socket) {
394   struct autobuf abuf;
395
396   const char *content_type = (printer_functions.determine_mime_type) ? (*printer_functions.determine_mime_type)(send_what) : "text/plain; charset=utf-8";
397   int contentLengthPlaceholderStart = 0;
398   int headerLength = 0;
399
400   abuf_init(&abuf, 2 * 4096);
401
402   if (http_headers) {
403     build_http_header(PLUGIN_NAME, HTTP_200, content_type, &abuf, &contentLengthPlaceholderStart);
404     headerLength = abuf.len;
405   }
406
407   // only add if normal format
408   if (send_what & SIW_ALL) {
409     if (printer_functions.output_start)
410       (*printer_functions.output_start)(&abuf);
411
412     if ((send_what & SIW_LINKS) && printer_functions.links)
413       (*printer_functions.links)(&abuf);
414     if ((send_what & SIW_NEIGHBORS) && printer_functions.neighbors)
415       (*printer_functions.neighbors)(&abuf, false);
416     if ((send_what & SIW_TOPOLOGY) && printer_functions.topology)
417       (*printer_functions.topology)(&abuf);
418     if ((send_what & SIW_HNA) && printer_functions.hna)
419       (*printer_functions.hna)(&abuf);
420     if ((send_what & SIW_SGW) && printer_functions.sgw)
421       (*printer_functions.sgw)(&abuf);
422     if ((send_what & SIW_MID) && printer_functions.mid)
423       (*printer_functions.mid)(&abuf);
424     if ((send_what & SIW_ROUTES) && printer_functions.routes)
425       (*printer_functions.routes)(&abuf);
426     if ((send_what & SIW_GATEWAYS) && printer_functions.gateways)
427       (*printer_functions.gateways)(&abuf);
428     if ((send_what & SIW_CONFIG) && printer_functions.config)
429       (*printer_functions.config)(&abuf);
430     if ((send_what & SIW_INTERFACES) && printer_functions.interfaces)
431       (*printer_functions.interfaces)(&abuf);
432     if ((send_what & SIW_2HOP) && printer_functions.neighbors)
433       (*printer_functions.neighbors)(&abuf, true);
434     if ((send_what & SIW_VERSION) && printer_functions.version)
435       (*printer_functions.version)(&abuf);
436     if ((send_what & SIW_PLUGINS) && printer_functions.plugins)
437       (*printer_functions.plugins)(&abuf);
438
439     if (printer_functions.output_end)
440       (*printer_functions.output_end)(&abuf);
441   } else if ((send_what & SIW_OLSRD_CONF) && printer_functions.olsrd_conf) {
442     /* this outputs the olsrd.conf text directly, not normal format */
443     (*printer_functions.olsrd_conf)(&abuf);
444   }
445
446   if (http_headers) {
447     http_header_adjust_content_length(&abuf, contentLengthPlaceholderStart, abuf.len - headerLength);
448   }
449
450   /* avoid a memcpy: just move the abuf.buf pointer and clear abuf */
451   outbuffer.buffer[outbuffer.count] = abuf.buf;
452   outbuffer.size[outbuffer.count] = abuf.len;
453   outbuffer.written[outbuffer.count] = 0;
454   outbuffer.socket[outbuffer.count] = the_socket;
455   abuf.buf = NULL;
456   abuf.len = 0;
457   abuf.size = 0;
458
459   outbuffer.count++;
460
461   if (outbuffer.count == 1) {
462     writetimer_entry = olsr_start_timer(100, 0, OLSR_TIMER_PERIODIC, &info_write_data, NULL, 0);
463   }
464
465   abuf_free(&abuf);
466 }
467
468 /*
469  * Local Variables:
470  * mode: c
471  * style: linux
472  * c-basic-offset: 2
473  * indent-tabs-mode: nil
474  * End:
475  */