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