info: fix detection of whether the reply was fully sent
[olsrd.git] / lib / info / olsrd_info.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #include <arpa/inet.h>
47 #include <unistd.h>
48 #include <assert.h>
49 #include <ctype.h>
50 #include <stdbool.h>
51
52 #include "olsrd_info.h"
53 #include "olsr.h"
54 #include "scheduler.h"
55 #include "ipcalc.h"
56 #include "http_headers.h"
57
58 #ifdef _WIN32
59 #define close(x) closesocket(x)
60 #endif /* _WIN32 */
61
62 #define MAX_CLIENTS 8
63
64 /*
65  * There is the problem that writing to a network socket can block,
66  * and the olsrd scheduler does not care about write events.
67  *
68  * There was a case that olsrd just froze for minutes when people used
69  * jsoninfo/txtinfo with large topologies over bad WiFi.
70  *
71  * This is the solution that was chosen at that time, unwilling to
72  * rewrite the whole scheduler:
73  * A timer was added and each time it expires each non-empty buffer
74  * in this structure will try to write data into a "non-blocking"
75  * socket until all data is sent, so that no blocking occurs.
76  */
77 typedef struct {
78   int socket[MAX_CLIENTS];
79   char *buffer[MAX_CLIENTS];
80   size_t size[MAX_CLIENTS];
81   size_t written[MAX_CLIENTS];
82   int count;
83 } info_plugin_outbuffer_t;
84
85 static const char * name = NULL;
86
87 static info_plugin_functions_t *functions = NULL;
88
89 static info_plugin_config_t *config = NULL;
90
91 static int ipc_socket = -1;
92
93 static info_plugin_outbuffer_t outbuffer;
94
95 static struct timer_entry *writetimer_entry = NULL;
96
97 static struct info_cache_t info_cache;
98
99 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
100
101 static char * skipMultipleSlashes(char * requ, size_t* len) {
102   char * r = requ;
103
104   if ((r[0] == '\0') // zero length
105       || (r[0] != '/') // does not start with a slash
106       || (r[1] != '/')) // does not have another slash
107   {
108     return r;
109   }
110
111   while (r[1] == '/') {
112     r++;
113     if (len) {
114       *len = *len - 1;
115     }
116   }
117   return r;
118 }
119
120 static unsigned long long SIW_ENTRIES_ALL[] = {
121 //
122     SIW_NEIGHBORS,//
123     SIW_LINKS, //
124     SIW_ROUTES, //
125     SIW_HNA, //
126     SIW_MID, //
127     SIW_TOPOLOGY, //
128     SIW_GATEWAYS, //
129     SIW_INTERFACES, //
130     SIW_2HOP, //
131     SIW_SGW, //
132     SIW_RUNTIME_ALL,//
133     SIW_NEIGHBORS_FREIFUNK, //
134     //
135     SIW_VERSION,//
136     SIW_CONFIG, //
137     SIW_PLUGINS, //
138     SIW_STARTUP_ALL, //
139     //
140     SIW_ALL, //
141     //
142     SIW_OLSRD_CONF, //
143     //
144     SIW_NETJSON_NETWORK_ROUTES,
145     SIW_NETJSON_NETWORK_GRAPH,
146     SIW_NETJSON_DEVICE_CONFIGURATION,
147     SIW_NETJSON_DEVICE_MONITORING,
148     SIW_NETJSON_NETWORK_COLLECTION
149     };
150
151 long cache_timeout_generic(info_plugin_config_t *plugin_config, unsigned long long siw) {
152   long timeout = plugin_config->cache_timeout;
153   if (timeout <= 0) {
154     return timeout;
155   }
156
157   switch (siw) {
158     case SIW_NEIGHBORS:
159     case SIW_LINKS:
160     case SIW_ROUTES:
161     case SIW_HNA:
162     case SIW_MID:
163     case SIW_TOPOLOGY:
164     case SIW_GATEWAYS:
165     case SIW_INTERFACES:
166     case SIW_2HOP:
167     case SIW_SGW:
168
169     case SIW_NETJSON_NETWORK_ROUTES:
170     case SIW_NETJSON_NETWORK_GRAPH:
171     case SIW_NETJSON_DEVICE_CONFIGURATION:
172     case SIW_NETJSON_DEVICE_MONITORING:
173     case SIW_NETJSON_NETWORK_COLLECTION:
174       return timeout;
175
176     case SIW_VERSION:
177     case SIW_CONFIG:
178     case SIW_PLUGINS:
179       return LONG_MAX;
180
181     default:
182       /* not cached */
183       return false;
184   }
185 }
186
187 static void info_plugin_cache_init(bool init) {
188   unsigned int i;
189
190   if (!functions->cache_timeout) {
191     return;
192   }
193
194   for (i = 0; i < ARRAY_SIZE(SIW_ENTRIES_ALL); ++i) {
195     unsigned long long siw = SIW_ENTRIES_ALL[i];
196     struct info_cache_entry_t * entry;
197
198     if (functions->cache_timeout(config, siw) <= 0) {
199       continue;
200     }
201
202     entry = info_cache_get_entry(&info_cache, siw);
203     if (!entry) {
204       continue;
205     }
206
207     if (init) {
208       entry->initialised = false;
209     } else {
210       if (entry->initialised) {
211         abuf_free(&entry->buf);
212         entry->initialised = false;
213       }
214       entry->timestamp = 0;
215     }
216   }
217 }
218
219 static INLINE void info_plugin_cache_init_entry(struct info_cache_entry_t * entry) {
220   if (!entry->initialised) {
221     entry->timestamp = 0;
222     abuf_init(&entry->buf, AUTOBUFCHUNK);
223     entry->initialised = true;
224   }
225 }
226
227 static unsigned int determine_single_action(char *requ) {
228   unsigned int i;
229   unsigned long long siw_mask = !functions->supported_commands_mask ? SIW_EVERYTHING : functions->supported_commands_mask();
230
231   if (!functions->is_command || !siw_mask)
232     return 0;
233
234   for (i = 0; i < ARRAY_SIZE(SIW_ENTRIES_ALL); ++i) {
235     unsigned long long siw = SIW_ENTRIES_ALL[i];
236     if ((siw & siw_mask) && functions->is_command(requ, siw))
237       return siw;
238   }
239
240   return 0;
241 }
242
243 static unsigned int determine_action(char *requ) {
244   if (!functions->is_command) {
245     return 0;
246   }
247
248   if (!requ || (requ[0] == '\0')) {
249     /* no more text */
250     return 0;
251   }
252
253   /* requ is guaranteed to be at least 1 character long */
254
255   if (!functions->supportsCompositeCommands) {
256     /* no support for composite commands */
257     return determine_single_action(requ);
258   }
259
260   /* composite commands */
261
262   {
263     unsigned int action = 0;
264
265     char * requestSegment = requ;
266     while (requestSegment) {
267       requestSegment = skipMultipleSlashes(requestSegment, NULL);
268       if (requestSegment[0] == '\0') {
269         /* there is no more text */
270         requestSegment = NULL;
271         continue;
272       }
273
274       /* there is more text */
275
276       {
277         unsigned int r = 0;
278         char * requestSegmentTail = strchr(&requestSegment[1], '/');
279
280         if (!requestSegmentTail) {
281           /* there isn't another slash, process everything that is left */
282           r = determine_single_action(requestSegment);
283         } else {
284           /* there is another slash, process everything before the slash */
285           char savedCharacter = *requestSegmentTail;
286           *requestSegmentTail = '\0';
287           r = determine_single_action(requestSegment);
288           *requestSegmentTail = savedCharacter;
289         }
290
291         if (!r) {
292           /* not found */
293           return 0;
294         }
295
296         action |= r;
297
298         /* process everything that is left in the next iteration */
299         requestSegment = requestSegmentTail;
300       }
301     }
302
303     return action;
304   }
305 }
306
307 static void write_data(void *unused __attribute__((unused))) {
308   fd_set set;
309   int result, i, max;
310   struct timeval tv;
311
312   if (outbuffer.count <= 0) {
313     /* exit early if there is nothing to send */
314     return;
315   }
316
317   FD_ZERO(&set);
318   max = 0;
319   for (i = 0; i < outbuffer.count; i++) {
320     if (outbuffer.socket[i] < 0) {
321       continue;
322     }
323
324     /* And we cast here since we get a warning on Win32 */
325     FD_SET((unsigned int ) (outbuffer.socket[i]), &set);
326
327     if (outbuffer.socket[i] > max) {
328       max = outbuffer.socket[i];
329     }
330   }
331
332   tv.tv_sec = 0;
333   tv.tv_usec = 0;
334
335   result = select(max + 1, NULL, &set, NULL, &tv);
336   if (result <= 0) {
337     /* exit early if any of the sockets is not ready for writing */
338     return;
339   }
340
341   for (i = 0; i < MAX_CLIENTS; i++) {
342     if (outbuffer.socket[i] < 0) {
343       continue;
344     }
345
346     result = send(outbuffer.socket[i], outbuffer.buffer[i] + outbuffer.written[i], outbuffer.size[i] - outbuffer.written[i], 0);
347     if (result > 0) {
348       outbuffer.written[i] += result;
349     }
350
351     if ((result < 0) && ((errno == EWOULDBLOCK) || (errno == EAGAIN))) {
352       continue;
353     }
354
355     if ((result < 0) || (outbuffer.written[i] >= outbuffer.size[i])) {
356       /* close this socket and cleanup*/
357       close(outbuffer.socket[i]);
358       outbuffer.socket[i] = -1;
359       free(outbuffer.buffer[i]);
360       outbuffer.buffer[i] = NULL;
361       outbuffer.size[i] = 0;
362       outbuffer.written[i] = 0;
363
364       outbuffer.count--;
365     }
366   }
367
368   if (!outbuffer.count) {
369     olsr_stop_timer(writetimer_entry);
370   }
371 }
372
373 typedef struct {
374   unsigned long long siw;
375   printer_generic func;
376 } SiwLookupTableEntry;
377
378 static void send_info_from_table(struct autobuf *abuf, unsigned int send_what, SiwLookupTableEntry *funcs, unsigned int funcsSize, unsigned int *outputLength) {
379   unsigned int i;
380   unsigned int preLength;
381   unsigned int what = send_what;
382   cache_timeout_func cache_timeout_f = functions->cache_timeout;
383
384   if (functions->output_start) {
385     functions->output_start(abuf);
386   }
387
388   preLength = abuf->len;
389
390   for (i = 0; (i < funcsSize) && what; i++) {
391     unsigned long long siw = funcs[i].siw;
392     if (what & siw) {
393       printer_generic func = funcs[i].func;
394       if (func) {
395         long cache_timeout = 0;
396         struct info_cache_entry_t *cache_entry = NULL;
397
398         if (cache_timeout_f) {
399           cache_timeout = cache_timeout_f(config, siw);
400           cache_entry = (cache_timeout <= 0) ? NULL : info_cache_get_entry(&info_cache, siw);
401         }
402
403         if (!cache_entry) {
404             func(abuf);
405         } else {
406           long long now = olsr_times();
407           long long age = abs(now - cache_entry->timestamp);
408           info_plugin_cache_init_entry(cache_entry);
409           if (!cache_entry->timestamp || (age >= cache_timeout)) {
410             /* cache is never used before or cache is too old */
411             cache_entry->buf.buf[0] = '\0';
412             cache_entry->buf.len = 0;
413             cache_entry->timestamp = now;
414             func(&cache_entry->buf);
415           }
416
417           abuf_concat(abuf, &cache_entry->buf);
418         }
419       }
420     }
421     what &= ~siw;
422   }
423
424   *outputLength = abuf->len - preLength;
425
426   if (functions->output_end) {
427     functions->output_end(abuf);
428   }
429 }
430
431 static void send_info(const char * req, unsigned int send_what, int the_socket, unsigned int status) {
432   struct autobuf abuf;
433   unsigned int outputLength = 0;
434   unsigned int send_index = 0;
435   unsigned int saved_count = 0;
436
437   const char *content_type = functions->determine_mime_type ? functions->determine_mime_type(send_what) : "text/plain; charset=utf-8";
438   int contentLengthIndex = 0;
439   int headerLength = 0;
440
441   abuf_init(&abuf, AUTOBUFCHUNK);
442
443   if (config->http_headers) {
444     http_header_build(name, status, content_type, &abuf, &contentLengthIndex);
445     headerLength = abuf.len;
446   }
447
448   if (status == INFO_HTTP_OK) {
449     /* OK */
450
451     // only add if normal format
452     if (send_what & SIW_ALL) {
453       SiwLookupTableEntry funcs[] = {
454         { SIW_NEIGHBORS , functions->neighbors  }, //
455         { SIW_LINKS     , functions->links      }, //
456         { SIW_ROUTES    , functions->routes     }, //
457         { SIW_HNA       , functions->hna        }, //
458         { SIW_MID       , functions->mid        }, //
459         { SIW_TOPOLOGY  , functions->topology   }, //
460         { SIW_GATEWAYS  , functions->gateways   }, //
461         { SIW_INTERFACES, functions->interfaces }, //
462         { SIW_2HOP      , functions->twohop     }, //
463         { SIW_SGW       , functions->sgw        }, //
464         //
465         { SIW_VERSION   , functions->version    }, //
466         { SIW_CONFIG    , functions->config     }, //
467         { SIW_PLUGINS   , functions->plugins    } //
468       };
469
470       send_info_from_table(&abuf, send_what, funcs, ARRAY_SIZE(funcs), &outputLength);
471     } else if (send_what & SIW_NETJSON) {
472       SiwLookupTableEntry funcs[] = {
473         { SIW_NETJSON_NETWORK_ROUTES      , functions->networkRoutes      }, //
474         { SIW_NETJSON_NETWORK_GRAPH       , functions->networkGraph       }, //
475         { SIW_NETJSON_DEVICE_CONFIGURATION, functions->deviceConfiguration}, //
476         { SIW_NETJSON_DEVICE_MONITORING   , functions->deviceMonitoring   }, //
477         { SIW_NETJSON_NETWORK_COLLECTION  , functions->networkCollection  } //
478       };
479
480       send_info_from_table(&abuf, send_what, funcs, ARRAY_SIZE(funcs), &outputLength);
481     } else if ((send_what & SIW_OLSRD_CONF) && functions->olsrd_conf) {
482       /* this outputs the olsrd.conf text directly, not normal format */
483       unsigned int preLength = abuf.len;
484       functions->olsrd_conf(&abuf);
485       outputLength = abuf.len - preLength;
486     }
487
488     if (!abuf.len || !outputLength) {
489       status = INFO_HTTP_NOCONTENT;
490       abuf.buf[0] = '\0';
491       abuf.len = 0;
492       if (config->http_headers) {
493         http_header_build(name, status, content_type, &abuf, &contentLengthIndex);
494         headerLength = abuf.len;
495       }
496     }
497   }
498
499   if (status != INFO_HTTP_OK) {
500     if (functions->output_error) {
501       functions->output_error(&abuf, status, req, config->http_headers);
502     } else if (status == INFO_HTTP_NOCONTENT) {
503       /* wget can't handle output of zero length */
504       abuf_puts(&abuf, "\n");
505     }
506   }
507
508   if (config->http_headers) {
509     http_header_adjust_content_length(&abuf, contentLengthIndex, abuf.len - headerLength);
510   }
511
512   send_index = outbuffer.count;
513
514   /* avoid a memcpy: just move the abuf.buf pointer and clear abuf */
515   outbuffer.buffer[send_index] = abuf.buf;
516   outbuffer.size[send_index] = abuf.len;
517   outbuffer.written[send_index] = 0;
518   outbuffer.socket[send_index] = the_socket;
519   abuf.buf = NULL;
520   abuf.len = 0;
521   abuf.size = 0;
522
523   outbuffer.count++;
524
525   saved_count = outbuffer.count;
526
527   write_data(NULL);
528
529   if (outbuffer.buffer[send_index] && (saved_count == 1)) {
530     writetimer_entry = olsr_start_timer(10, 0, OLSR_TIMER_PERIODIC, &write_data, NULL, 0);
531   }
532 }
533
534 static char * skipLeadingWhitespace(char * requ, size_t *len) {
535   while (isspace(*requ) && (*requ != '\0')) {
536     *len = *len - 1;
537     requ++;
538   }
539   return requ;
540 }
541
542 static char * stripEOLs(char * requ, size_t *len) {
543   while (isspace(requ[*len - 1]) && (requ[*len - 1] != '\0')) {
544     *len = *len - 1;
545     requ[*len] = '\0';
546   }
547   return requ;
548 }
549
550 static char * stripTrailingSlashes(char * requ, size_t *len) {
551   while ((requ[*len - 1] == '/') && (requ[*len - 1] != '\0')) {
552     *len = *len - 1;
553     requ[*len] = '\0';
554   }
555   return requ;
556 }
557
558 static char * cutAtFirstEOL(char * requ, size_t *len) {
559   char * s = requ;
560   size_t l = 0;
561   while (!((*s == '\n') || (*s == '\r')) && (*s != '\0')) {
562     s++;
563     l++;
564   }
565   if ((*s == '\n') || (*s == '\r')) {
566     *s = '\0';
567   }
568   *len = l;
569   return requ;
570 }
571
572 static char * parseRequest(char * requ, size_t *len) {
573   char * req = requ;
574
575   if (!req || !*len) {
576     return requ;
577   }
578
579   req = skipLeadingWhitespace(req, len);
580   req = stripEOLs(req, len);
581
582   /* HTTP request: GET whitespace URI whitespace HTTP/1.1 */
583   if (*len < (3 + 1 + 1 + 1 + 8)) {
584     return req;
585   }
586
587   if (strncasecmp(req, "GET", 3) || !isspace(req[3])) {
588     /* does not start with 'GET ' */
589     return req;
590   }
591
592   /* skip 'GET ' and further leading whitespace */
593   req = skipLeadingWhitespace(&req[4], len);
594   if (!*len) return req;
595
596   /* cut req at the first '\n' */
597   req = cutAtFirstEOL(req, len);
598   if (!*len) return req;
599
600   /* strip req of trailing EOL and whitespace */
601   req = stripEOLs(req, len);
602   if (*len < 9) return req;
603
604   if (!isspace(req[*len - 9]) //
605       || strncasecmp(&req[*len - 8], "HTTP/1.", 7) //
606       || ((req[*len - 1] != '1') && (req[*len - 1] != '0'))) {
607     return req;
608   }
609   *len = *len - 8;
610   req[*len] = '\0';
611   if (!*len) return req;
612
613   /* strip req of trailing EOL and whitespace */
614   req = stripEOLs(req, len);
615   req = stripTrailingSlashes(req, len);
616
617   return req;
618 }
619
620 static void drain_request(int ipc_connection) {
621   static char drain_buffer[AUTOBUFCHUNK];
622
623   /* input was much too long: read until the end for graceful connection termination
624    * because wget can't handle the premature connection termination that is allowed
625    * by the INFO_HTTP_REQUEST_ENTITY_TOO_LARGE HTTP status code
626    */
627   while (recv(ipc_connection, (void *) &drain_buffer, sizeof(drain_buffer), 0) == sizeof(drain_buffer)) {}
628 }
629
630 static void ipc_action(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused))) {
631 #ifndef NODEBUG
632   char addr[INET6_ADDRSTRLEN];
633 #endif /* NODEBUG */
634
635   int ipc_connection = -1;
636   union olsr_sockaddr sock_addr;
637   socklen_t sock_addr_len = sizeof(sock_addr);
638   bool hostDenied = false;
639   struct timeval timeout;
640   fd_set read_fds;
641   char req_buffer[1024];
642   char * req = req_buffer;
643   ssize_t rx_count = 0;
644   unsigned int send_what = 0;
645   unsigned int http_status = INFO_HTTP_OK;
646
647   if ((ipc_connection = accept(fd, &sock_addr.in, &sock_addr_len)) < 0) {
648 #ifndef NODEBUG
649     olsr_printf(1, "(%s) accept()=%s\n", name, strerror(errno));
650 #endif /* NODEBUG */
651     /* the caller will retry later */
652     return;
653   }
654
655   if (outbuffer.count >= MAX_CLIENTS) {
656     /* limit the number of replies that are in-flight */
657     close(ipc_connection);
658     return;
659   }
660
661   if (olsr_cnf->ip_version == AF_INET) {
662     hostDenied = //
663         (ntohl(config->accept_ip.v4.s_addr) != INADDR_ANY) //
664         && !ip4equal(&sock_addr.in4.sin_addr, &config->accept_ip.v4) //
665         && (!config->allow_localhost //
666             || (ntohl(sock_addr.in4.sin_addr.s_addr) != INADDR_LOOPBACK));
667   } else {
668     hostDenied = //
669         !ip6equal(&config->accept_ip.v6, &in6addr_any) //
670         && !ip6equal(&sock_addr.in6.sin6_addr, &config->accept_ip.v6) //
671         && (!config->allow_localhost //
672             || !ip6equal(&config->accept_ip.v6, &in6addr_loopback));
673   }
674
675 #ifndef NODEBUG
676   if (!inet_ntop( //
677       olsr_cnf->ip_version, //
678       (olsr_cnf->ip_version == AF_INET) ? (void *) &sock_addr.in4.sin_addr : (void *) &sock_addr.in6.sin6_addr, //
679       addr, //
680       sizeof(addr))) {
681     addr[0] = '\0';
682   }
683 #endif /* NODEBUG */
684
685   if (hostDenied) {
686 #ifndef NODEBUG
687     olsr_printf(1, "(%s) Connect from host %s is not allowed!\n", name, addr);
688 #endif /* NODEBUG */
689     drain_request(ipc_connection);
690     send_info(req, send_what, ipc_connection, INFO_HTTP_FORBIDDEN);
691     return;
692   }
693
694 #ifndef NODEBUG
695   olsr_printf(2, "(%s) Connect from host %s is allowed\n", name, addr);
696 #endif /* NODEBUG */
697
698   timeout.tv_sec = timeout.tv_usec = 0;
699
700   FD_ZERO(&read_fds);
701 #ifndef _WIN32
702   FD_SET(ipc_connection, &read_fds);
703 #else
704   FD_SET((unsigned int ) ipc_connection, &read_fds);
705 #endif
706
707   /* On success, select() and pselect() return the number of file descriptors
708    * contained in the three returned descriptor sets (that is, the total number
709    * of bits that are set in readfds, writefds, exceptfds) which may be zero if
710    * the timeout expires before anything interesting happens. On error, -1 is
711    * returned, and errno is set to indicate the error; the file descriptor sets
712    * are unmodified, and timeout becomes undefined.
713    */
714
715   if (select(ipc_connection + 1, &read_fds, NULL, NULL, &timeout) < 0) {
716 #ifndef NODEBUG
717     olsr_printf(1, "(%s) select()=%s\n", name, strerror(errno));
718 #endif /* NODEBUG */
719     drain_request(ipc_connection);
720     send_info(req, send_what, ipc_connection, INFO_HTTP_INTERNAL_SERVER_ERROR);
721     return;
722   }
723
724   *req = '\0';
725   rx_count = recv(ipc_connection, req, sizeof(req_buffer), 0); /* Win32 needs the cast here */
726
727   /* Upon successful completion, recv() shall return the length of the message
728    * in bytes. If no messages are available to be received and the peer has
729    * performed an orderly shutdown, recv() shall return 0. Otherwise, −1 shall
730    * be returned and errno set to indicate the error.
731    */
732
733   if (rx_count < 0) {
734 #ifndef NODEBUG
735     olsr_printf(1, "(%s) s < 0\n", name);
736 #endif /* NODEBUG */
737     *req = '\0';
738     drain_request(ipc_connection);
739     send_info(req, send_what, ipc_connection, INFO_HTTP_INTERNAL_SERVER_ERROR);
740     return;
741   }
742
743   /* rx_count >= 0 */
744
745   if (!rx_count) {
746 #ifndef NODEBUG
747     olsr_printf(1, "(%s) s == 0\n", name);
748 #endif /* NODEBUG */
749     *req = '\0';
750     drain_request(ipc_connection);
751     send_info(req, send_what, ipc_connection, INFO_HTTP_NOCONTENT);
752     return;
753   }
754
755   /* rx_count > 0 */
756
757   if (rx_count >= (ssize_t) sizeof(req_buffer)) {
758 #ifndef NODEBUG
759     olsr_printf(1, "(%s) s > %ld\n", name, (long int) sizeof(req_buffer));
760 #endif /* NODEBUG */
761     req[sizeof(req_buffer) - 1] = '\0';
762     drain_request(ipc_connection);
763     send_info(req, send_what, ipc_connection, INFO_HTTP_REQUEST_ENTITY_TOO_LARGE);
764     return;
765   }
766
767   /* 0 < rx_count < sizeof(requ) */
768
769   req[rx_count] = '\0';
770   req = parseRequest(req, (size_t*) &rx_count);
771   req = skipMultipleSlashes(req, (size_t*) &rx_count);
772   if ((req[0] == '\0') //
773       || ((req[0] == '/') && (req[1] == '\0'))) {
774     /* empty or '/' */
775     send_what = SIW_EVERYTHING;
776   } else {
777     send_what = determine_action(req);
778   }
779
780   if (!send_what) {
781     http_status = INFO_HTTP_NOTFOUND;
782   }
783
784   send_info(req, send_what, ipc_connection, http_status);
785 }
786
787 static int plugin_ipc_init(void) {
788   union olsr_sockaddr sock_addr;
789   uint32_t yes = 1;
790   socklen_t sock_addr_len;
791
792   /* Init ipc socket */
793   if ((ipc_socket = socket(olsr_cnf->ip_version, SOCK_STREAM, 0)) == -1) {
794 #ifndef NODEBUG
795     olsr_printf(1, "(%s) socket()=%s\n", name, strerror(errno));
796 #endif /* NODEBUG */
797     goto error_out;
798   }
799
800   if (setsockopt(ipc_socket, SOL_SOCKET, SO_REUSEADDR, (char *) &yes, sizeof(yes)) < 0) {
801 #ifndef NODEBUG
802     olsr_printf(1, "(%s) setsockopt()=%s\n", name, strerror(errno));
803 #endif /* NODEBUG */
804     goto error_out;
805   }
806
807 #if (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE
808   if (setsockopt(ipc_socket, SOL_SOCKET, SO_NOSIGPIPE, (char *) &yes, sizeof(yes)) < 0) {
809     perror("SO_NOSIGPIPE failed");
810     goto error_out;
811   }
812 #endif /* (defined __FreeBSD__ || defined __FreeBSD_kernel__) && defined SO_NOSIGPIPE */
813
814 #if defined __linux__ && defined IPV6_V6ONLY
815   if (config->ipv6_only && (olsr_cnf->ip_version == AF_INET6) //
816       && (setsockopt(ipc_socket, IPPROTO_IPV6, IPV6_V6ONLY, (char *) &yes, sizeof(yes)) < 0)) {
817     perror("IPV6_V6ONLY failed");
818     goto error_out;
819   }
820 #endif /* defined __linux__ && defined IPV6_V6ONLY */
821
822   /* complete the socket structure */
823   memset(&sock_addr, 0, sizeof(sock_addr));
824   if (olsr_cnf->ip_version == AF_INET) {
825     sock_addr.in4.sin_family = AF_INET;
826     sock_addr_len = sizeof(struct sockaddr_in);
827 #ifdef SIN6_LEN
828     sock_addr.in4.sin_len = sock_addr_len;
829 #endif /* SIN6_LEN */
830     sock_addr.in4.sin_addr.s_addr = config->listen_ip.v4.s_addr;
831     sock_addr.in4.sin_port = htons(config->ipc_port);
832   } else {
833     sock_addr.in6.sin6_family = AF_INET6;
834     sock_addr_len = sizeof(struct sockaddr_in6);
835 #ifdef SIN6_LEN
836     sock_addr.in6.sin6_len = sock_addr_len;
837 #endif /* SIN6_LEN */
838     sock_addr.in6.sin6_addr = config->listen_ip.v6;
839     sock_addr.in6.sin6_port = htons(config->ipc_port);
840   }
841
842   /* bind the socket to the port number */
843   if (bind(ipc_socket, &sock_addr.in, sock_addr_len) == -1) {
844 #ifndef NODEBUG
845     olsr_printf(1, "(%s) bind()=%s\n", name, strerror(errno));
846 #endif /* NODEBUG */
847     goto error_out;
848   }
849
850   /* show that we are willing to listen */
851   if (listen(ipc_socket, 1) == -1) {
852 #ifndef NODEBUG
853     olsr_printf(1, "(%s) listen()=%s\n", name, strerror(errno));
854 #endif /* NODEBUG */
855     goto error_out;
856   }
857
858   /* Register with olsrd */
859   add_olsr_socket(ipc_socket, &ipc_action, NULL, NULL, SP_PR_READ);
860
861 #ifndef NODEBUG
862   olsr_printf(2, "(%s) listening on port %d\n", name, config->ipc_port);
863 #endif /* NODEBUG */
864
865   return 1;
866
867   error_out: //
868   if (ipc_socket >= 0) {
869     close(ipc_socket);
870     ipc_socket = -1;
871   }
872   return 0;
873 }
874
875 int info_plugin_init(const char * plugin_name, info_plugin_functions_t *plugin_functions, info_plugin_config_t *plugin_config) {
876   int i;
877
878   assert(plugin_name);
879   assert(plugin_functions);
880   assert(plugin_config);
881
882   name = plugin_name;
883   functions = plugin_functions;
884   config = plugin_config;
885
886   memset(&outbuffer, 0, sizeof(outbuffer));
887   for (i = 0; i < MAX_CLIENTS; ++i) {
888     outbuffer.socket[i] = -1;
889   }
890
891   ipc_socket = -1;
892
893   if (functions->init) {
894     functions->init(name);
895   }
896
897   info_plugin_cache_init(true);
898
899   return plugin_ipc_init();
900 }
901
902 void info_plugin_exit(void) {
903   int i;
904
905   if (ipc_socket != -1) {
906     close(ipc_socket);
907     ipc_socket = -1;
908   }
909   for (i = 0; i < MAX_CLIENTS; ++i) {
910     if (outbuffer.buffer[i]) {
911       free(outbuffer.buffer[i]);
912       outbuffer.buffer[i] = NULL;
913     }
914     outbuffer.size[i] = 0;
915     outbuffer.written[i] = 0;
916     if (outbuffer.socket[i]) {
917       close(outbuffer.socket[i]);
918       outbuffer.socket[i] = -1;
919     }
920   }
921   outbuffer.count = 0;
922
923   info_plugin_cache_init(false);
924 }