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