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