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