9c9a1e183f6a5cc39def5f5f1d35f381e83324ff
[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         .determine_mime_type = &determine_mime_type, //
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 = &ipc_print_config, //
103         .plugins = &ipc_print_plugins //
104     };
105
106 static void determine_action(unsigned int *send_what, char *requ) {
107   if (strstr(requ, "/olsrd.conf"))
108     *send_what |= SIW_OLSRD_CONF;
109   else if (strstr(requ, "/all"))
110     *send_what = SIW_ALL;
111   else {
112     // these are the two overarching categories
113     if (strstr(requ, "/runtime"))
114       *send_what |= SIW_RUNTIME_ALL;
115     if (strstr(requ, "/startup"))
116       *send_what |= SIW_STARTUP_ALL;
117
118     // these are the individual sections
119     if (strstr(requ, "/neighbors"))
120       *send_what |= SIW_NEIGHBORS;
121     if (strstr(requ, "/links"))
122       *send_what |= SIW_LINKS;
123     if (strstr(requ, "/routes"))
124       *send_what |= SIW_ROUTES;
125     if (strstr(requ, "/hna"))
126       *send_what |= SIW_HNA;
127     if (strstr(requ, "/mid"))
128       *send_what |= SIW_MID;
129     if (strstr(requ, "/topology"))
130       *send_what |= SIW_TOPOLOGY;
131     if (strstr(requ, "/gateways"))
132       *send_what |= SIW_GATEWAYS;
133     if (strstr(requ, "/interfaces"))
134       *send_what |= SIW_INTERFACES;
135     if (strstr(requ, "/2hop"))
136       *send_what |= SIW_2HOP;
137     if (strstr(requ, "/sgw"))
138       *send_what |= SIW_SGW;
139
140     // specials
141     if (strstr(requ, "/version"))
142       *send_what |= SIW_VERSION;
143     if (strstr(requ, "/config"))
144       *send_what |= SIW_CONFIG;
145     if (strstr(requ, "/plugins"))
146       *send_what |= SIW_PLUGINS;
147
148     /* To print out neighbours only on the Freifunk Status
149      * page the normal output is somewhat lengthy. The
150      * header parsing is sufficient for standard wget.
151      */
152     if (strstr(requ, "/neighbours"))
153       *send_what = SIW_NEIGHBORS | SIW_LINKS;
154   }
155 }
156
157 /**
158  *Do initialization here
159  *
160  *This function is called by the my_init
161  *function in uolsrd_plugin.c
162  */
163 int olsrd_plugin_init(void) {
164   /* Initial IPC value */
165   ipc_socket = -1;
166   memset(&outbuffer, 0, sizeof(outbuffer));
167
168   plugin_init(PLUGIN_NAME);
169
170   plugin_ipc_init();
171   return 1;
172 }
173
174 /**
175  * destructor - called at unload
176  */
177 void olsr_plugin_exit(void) {
178   if (ipc_socket != -1)
179     close(ipc_socket);
180 }
181
182 static int plugin_ipc_init(void) {
183   union olsr_sockaddr sst;
184   uint32_t yes = 1;
185   socklen_t addrlen;
186
187   /* Init ipc socket */
188   if ((ipc_socket = socket(olsr_cnf->ip_version, SOCK_STREAM, 0)) == -1) {
189 #ifndef NODEBUG
190     olsr_printf(1, "("PLUGIN_NAME") socket()=%s\n", strerror(errno));
191 #endif /* NODEBUG */
192     return 0;
193   } else {
194     if (setsockopt(ipc_socket, SOL_SOCKET, SO_REUSEADDR, (char *) &yes, sizeof(yes)) < 0) {
195 #ifndef NODEBUG
196       olsr_printf(1, "("PLUGIN_NAME") setsockopt()=%s\n", strerror(errno));
197 #endif /* NODEBUG */
198       return 0;
199     }
200 #if (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE
201     if (setsockopt(ipc_socket, SOL_SOCKET, SO_NOSIGPIPE, (char *) &yes, sizeof(yes)) < 0) {
202       perror("SO_REUSEADDR failed");
203       return 0;
204     }
205 #endif /* (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE */
206 #if defined linux && defined IPV6_V6ONLY
207     if (info_ipv6_only && olsr_cnf->ip_version == AF_INET6) {
208       if (setsockopt(ipc_socket, IPPROTO_IPV6, IPV6_V6ONLY, (char *) &yes, sizeof(yes)) < 0) {
209         perror("IPV6_V6ONLY failed");
210         return 0;
211       }
212     }
213 #endif /* defined linux && defined IPV6_V6ONLY */
214     /* Bind the socket */
215
216     /* complete the socket structure */
217     memset(&sst, 0, sizeof(sst));
218     if (olsr_cnf->ip_version == AF_INET) {
219       sst.in4.sin_family = AF_INET;
220       addrlen = sizeof(struct sockaddr_in);
221 #ifdef SIN6_LEN
222       sst.in4.sin_len = addrlen;
223 #endif /* SIN6_LEN */
224       sst.in4.sin_addr.s_addr = info_listen_ip.v4.s_addr;
225       sst.in4.sin_port = htons(ipc_port);
226     } else {
227       sst.in6.sin6_family = AF_INET6;
228       addrlen = sizeof(struct sockaddr_in6);
229 #ifdef SIN6_LEN
230       sst.in6.sin6_len = addrlen;
231 #endif /* SIN6_LEN */
232       sst.in6.sin6_addr = info_listen_ip.v6;
233       sst.in6.sin6_port = htons(ipc_port);
234     }
235
236     /* bind the socket to the port number */
237     if (bind(ipc_socket, &sst.in, addrlen) == -1) {
238 #ifndef NODEBUG
239       olsr_printf(1, "("PLUGIN_NAME") bind()=%s\n", strerror(errno));
240 #endif /* NODEBUG */
241       return 0;
242     }
243
244     /* show that we are willing to listen */
245     if (listen(ipc_socket, 1) == -1) {
246 #ifndef NODEBUG
247       olsr_printf(1, "("PLUGIN_NAME") listen()=%s\n", strerror(errno));
248 #endif /* NODEBUG */
249       return 0;
250     }
251
252     /* Register with olsrd */
253     add_olsr_socket(ipc_socket, &ipc_action, NULL, NULL, SP_PR_READ);
254
255 #ifndef NODEBUG
256     olsr_printf(2, "("PLUGIN_NAME") listening on port %d\n", ipc_port);
257 #endif /* NODEBUG */
258   }
259   return 1;
260 }
261
262 static void ipc_action(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused))) {
263   union olsr_sockaddr pin;
264
265   char addr[INET6_ADDRSTRLEN];
266   fd_set rfds;
267   struct timeval tv;
268   unsigned int send_what = 0;
269   int ipc_connection;
270
271   socklen_t addrlen = sizeof(pin);
272
273   if (outbuffer.count >= MAX_CLIENTS) {
274     return;
275   }
276
277   if ((ipc_connection = accept(fd, &pin.in, &addrlen)) == -1) {
278 #ifndef NODEBUG
279     olsr_printf(1, "("PLUGIN_NAME") accept()=%s\n", strerror(errno));
280 #endif /* NODEBUG */
281     return;
282   }
283
284   tv.tv_sec = tv.tv_usec = 0;
285   if (olsr_cnf->ip_version == AF_INET) {
286     if (inet_ntop(olsr_cnf->ip_version, &pin.in4.sin_addr, addr, INET6_ADDRSTRLEN) == NULL)
287       addr[0] = '\0';
288     if (!ip4equal(&pin.in4.sin_addr, &info_accept_ip.v4) && info_accept_ip.v4.s_addr != INADDR_ANY) {
289 #ifdef INFO_ALLOW_LOCALHOST
290       if (ntohl(pin.in4.sin_addr.s_addr) != INADDR_LOOPBACK) {
291 #endif /* INFO_ALLOW_LOCALHOST */
292         olsr_printf(1, "("PLUGIN_NAME") From host(%s) not allowed!\n", addr);
293         close(ipc_connection);
294         return;
295 #ifdef INFO_ALLOW_LOCALHOST
296       }
297 #endif /* INFO_ALLOW_LOCALHOST */
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     /* global variables for tracking when to put a comma in for JSON */
410     abuf_json_reset_entry_number_and_depth();
411     abuf_json_mark_output(true, &abuf);
412
413     abuf_json_int(&abuf, "systemTime", time(NULL));
414     abuf_json_int(&abuf, "timeSinceStartup", now_times);
415     if (*uuid)
416       abuf_json_string(&abuf, "uuid", uuid);
417
418     if ((send_what & SIW_LINKS) && printer_functions.links)
419       (*printer_functions.links)(&abuf);
420     if ((send_what & SIW_NEIGHBORS) && printer_functions.neighbors)
421       (*printer_functions.neighbors)(&abuf, false);
422     if ((send_what & SIW_TOPOLOGY) && printer_functions.topology)
423       (*printer_functions.topology)(&abuf);
424     if ((send_what & SIW_HNA) && printer_functions.hna)
425       (*printer_functions.hna)(&abuf);
426     if ((send_what & SIW_SGW) && printer_functions.sgw)
427       (*printer_functions.sgw)(&abuf);
428     if ((send_what & SIW_MID) && printer_functions.mid)
429       (*printer_functions.mid)(&abuf);
430     if ((send_what & SIW_ROUTES) && printer_functions.routes)
431       (*printer_functions.routes)(&abuf);
432     if ((send_what & SIW_GATEWAYS) && printer_functions.gateways)
433       (*printer_functions.gateways)(&abuf);
434     if ((send_what & SIW_CONFIG) && printer_functions.config)
435       (*printer_functions.config)(&abuf);
436     if ((send_what & SIW_INTERFACES) && printer_functions.interfaces)
437       (*printer_functions.interfaces)(&abuf);
438     if ((send_what & SIW_2HOP) && printer_functions.neighbors)
439       (*printer_functions.neighbors)(&abuf, true);
440     if ((send_what & SIW_VERSION) && printer_functions.version)
441       (*printer_functions.version)(&abuf);
442     if ((send_what & SIW_PLUGINS) && printer_functions.plugins)
443       (*printer_functions.plugins)(&abuf);
444
445     abuf_json_mark_output(false, &abuf);
446     abuf_puts(&abuf, "\n");
447   } else if ((send_what & SIW_OLSRD_CONF) && printer_functions.olsrd_conf) {
448     /* this outputs the olsrd.conf text directly, not normal format */
449     (*printer_functions.olsrd_conf)(&abuf);
450   }
451
452   if (http_headers) {
453     http_header_adjust_content_length(&abuf, contentLengthPlaceholderStart, abuf.len - headerLength);
454   }
455
456   /* avoid a memcpy: just move the abuf.buf pointer and clear abuf */
457   outbuffer.buffer[outbuffer.count] = abuf.buf;
458   outbuffer.size[outbuffer.count] = abuf.len;
459   outbuffer.written[outbuffer.count] = 0;
460   outbuffer.socket[outbuffer.count] = the_socket;
461   abuf.buf = NULL;
462   abuf.len = 0;
463   abuf.size = 0;
464
465   outbuffer.count++;
466
467   if (outbuffer.count == 1) {
468     writetimer_entry = olsr_start_timer(100, 0, OLSR_TIMER_PERIODIC, &info_write_data, NULL, 0);
469   }
470
471   abuf_free(&abuf);
472 }
473
474 /*
475  * Local Variables:
476  * mode: c
477  * style: linux
478  * c-basic-offset: 2
479  * indent-tabs-mode: nil
480  * End:
481  */