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