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