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