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