7 #include <sys/socket.h>
8 #include <netinet/in.h>
21 #include <netinet/tcp.h>
25 #include "appconfig.h"
27 #include "web_buffer.h"
28 #include "web_server.h"
29 #include "global_statistics.h"
33 #include "web_buffer_svg.h"
34 #include "web_client.h"
36 #define INITIAL_WEB_DATA_LENGTH 16384
37 #define WEB_REQUEST_LENGTH 16384
38 #define TOO_BIG_REQUEST 16384
40 int web_client_timeout = DEFAULT_DISCONNECT_IDLE_WEB_CLIENTS_AFTER_SECONDS;
41 int web_donotrack_comply = 0;
43 #ifdef NETDATA_WITH_ZLIB
44 int web_enable_gzip = 1, web_gzip_level = 3, web_gzip_strategy = Z_DEFAULT_STRATEGY;
45 #endif /* NETDATA_WITH_ZLIB */
47 extern int netdata_exit;
49 struct web_client *web_clients = NULL;
50 unsigned long long web_clients_count = 0;
52 inline int web_client_crock_socket(struct web_client *w) {
54 if(likely(!w->tcp_cork && w->ofd != -1)) {
56 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
57 error("%llu: failed to enable TCP_CORK on socket.", w->id);
67 inline int web_client_uncrock_socket(struct web_client *w) {
69 if(likely(w->tcp_cork && w->ofd != -1)) {
71 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
72 error("%llu: failed to disable TCP_CORK on socket.", w->id);
82 struct web_client *web_client_create(int listener)
86 w = calloc(1, sizeof(struct web_client));
88 error("Cannot allocate new web_client memory.");
92 w->id = ++web_clients_count;
93 w->mode = WEB_CLIENT_MODE_NORMAL;
96 struct sockaddr *sadr;
99 sadr = (struct sockaddr*) &w->clientaddr;
100 addrlen = sizeof(w->clientaddr);
102 w->ifd = accept(listener, sadr, &addrlen);
104 error("%llu: Cannot accept new incoming connection.", w->id);
110 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
111 error("Cannot getnameinfo() on received client connection.");
112 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
113 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
115 w->client_ip[NI_MAXHOST] = '\0';
116 w->client_port[NI_MAXSERV] = '\0';
118 switch(sadr->sa_family) {
120 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
124 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
125 strcpy(w->client_ip, &w->client_ip[7]);
126 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
129 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv6 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
133 debug(D_WEB_CLIENT_ACCESS, "%llu: New UNKNOWN web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
138 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
139 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
142 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
143 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
148 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
149 if(unlikely(!w->response.data)) {
150 // no need for error log - web_buffer_create already logged the error
156 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
157 if(unlikely(!w->response.header)) {
158 // no need for error log - web_buffer_create already logged the error
159 buffer_free(w->response.data);
165 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
166 if(unlikely(!w->response.header_output)) {
167 // no need for error log - web_buffer_create already logged the error
168 buffer_free(w->response.header);
169 buffer_free(w->response.data);
178 if(web_clients) web_clients->prev = w;
179 w->next = web_clients;
182 global_statistics.connected_clients++;
187 void web_client_reset(struct web_client *w) {
188 web_client_uncrock_socket(w);
190 debug(D_WEB_CLIENT, "%llu: Reseting client.", w->id);
192 if(likely(w->last_url[0])) {
194 gettimeofday(&tv, NULL);
196 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
198 #ifdef NETDATA_WITH_ZLIB
199 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
202 // --------------------------------------------------------------------
205 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
206 global_statistics_lock();
208 global_statistics.web_requests++;
209 global_statistics.web_usec += usecdiff(&tv, &w->tv_in);
210 global_statistics.bytes_received += w->stats_received_bytes;
211 global_statistics.bytes_sent += w->stats_sent_bytes;
212 global_statistics.content_size += size;
213 global_statistics.compressed_content_size += sent;
215 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
216 global_statistics_unlock();
218 w->stats_received_bytes = 0;
219 w->stats_sent_bytes = 0;
222 // --------------------------------------------------------------------
225 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
227 sent, size, -((size > 0) ? ((float) (size - sent) / (float) size * 100.0) : 0.0),
228 (float) usecdiff(&w->tv_ready, &w->tv_in) / 1000.0,
229 (float) usecdiff(&tv, &w->tv_ready) / 1000.0,
230 (float) usecdiff(&tv, &w->tv_in) / 1000.0,
231 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
232 ? "options" : "data"),
238 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
239 if(w->ifd != w->ofd) {
240 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
241 if(w->ifd != -1) close(w->ifd);
246 w->last_url[0] = '\0';
247 w->cookie1[0] = '\0';
248 w->cookie2[0] = '\0';
252 w->mode = WEB_CLIENT_MODE_NORMAL;
256 w->tracking_required = 0;
258 w->decoded_url[0] = '\0';
260 buffer_reset(w->response.header_output);
261 buffer_reset(w->response.header);
262 buffer_reset(w->response.data);
263 w->response.rlen = 0;
264 w->response.sent = 0;
265 w->response.code = 0;
270 w->response.zoutput = 0;
272 // if we had enabled compression, release it
273 #ifdef NETDATA_WITH_ZLIB
274 if(w->response.zinitialized) {
275 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
276 deflateEnd(&w->response.zstream);
277 w->response.zsent = 0;
278 w->response.zhave = 0;
279 w->response.zstream.avail_in = 0;
280 w->response.zstream.avail_out = 0;
281 w->response.zstream.total_in = 0;
282 w->response.zstream.total_out = 0;
283 w->response.zinitialized = 0;
285 #endif // NETDATA_WITH_ZLIB
288 struct web_client *web_client_free(struct web_client *w) {
291 struct web_client *n = w->next;
292 if(w == web_clients) web_clients = n;
294 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
296 if(w->prev) w->prev->next = w->next;
297 if(w->next) w->next->prev = w->prev;
298 if(w->response.header_output) buffer_free(w->response.header_output);
299 if(w->response.header) buffer_free(w->response.header);
300 if(w->response.data) buffer_free(w->response.data);
301 if(w->ifd != -1) close(w->ifd);
302 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
305 global_statistics.connected_clients--;
310 uid_t web_files_uid(void) {
311 static char *web_owner = NULL;
312 static uid_t owner_uid = 0;
314 if(unlikely(!web_owner)) {
315 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
316 if(!web_owner || !*web_owner)
317 owner_uid = geteuid();
319 // getpwnam() is not thread safe,
320 // but we have called this function once
321 // while single threaded
322 struct passwd *pw = getpwnam(web_owner);
324 error("User '%s' is not present. Ignoring option.", web_owner);
325 owner_uid = geteuid();
328 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
329 owner_uid = pw->pw_uid;
337 gid_t web_files_gid(void) {
338 static char *web_group = NULL;
339 static gid_t owner_gid = 0;
341 if(unlikely(!web_group)) {
342 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
343 if(!web_group || !*web_group)
344 owner_gid = getegid();
346 // getgrnam() is not thread safe,
347 // but we have called this function once
348 // while single threaded
349 struct group *gr = getgrnam(web_group);
351 error("Group '%s' is not present. Ignoring option.", web_group);
352 owner_gid = getegid();
355 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
356 owner_gid = gr->gr_gid;
364 int mysendfile(struct web_client *w, char *filename)
366 static char *web_dir = NULL;
368 // initialize our static data
369 if(unlikely(!web_dir)) web_dir = config_get("global", "web files directory", WEB_DIR);
371 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, web_dir, filename);
373 // skip leading slashes
374 while (*filename == '/') filename++;
376 // if the filename contain known paths, skip them
377 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0) filename = &filename[strlen(WEB_PATH_FILE) + 1];
380 for(s = filename; *s ;s++) {
381 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
382 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
383 buffer_sprintf(w->response.data, "File '%s' cannot be served. Filename contains invalid character '%c'", filename, *s);
388 // if the filename contains a .. refuse to serve it
389 if(strstr(filename, "..") != 0) {
390 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
391 buffer_sprintf(w->response.data, "File '%s' cannot be served. Relative filenames with '..' in them are not supported.", filename);
396 char webfilename[FILENAME_MAX + 1];
397 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
399 // check if the file exists
401 if(lstat(webfilename, &stat) != 0) {
402 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
403 buffer_sprintf(w->response.data, "File '%s' does not exist, or is not accessible.", webfilename);
407 // check if the file is owned by expected user
408 if(stat.st_uid != web_files_uid()) {
409 error("%llu: File '%s' is owned by user %d (expected user %d). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
410 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
414 // check if the file is owned by expected group
415 if(stat.st_gid != web_files_gid()) {
416 error("%llu: File '%s' is owned by group %d (expected group %d). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
417 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
421 if((stat.st_mode & S_IFMT) == S_IFDIR) {
422 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
423 return mysendfile(w, webfilename);
426 if((stat.st_mode & S_IFMT) != S_IFREG) {
427 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
428 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
433 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
437 if(errno == EBUSY || errno == EAGAIN) {
438 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
439 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
440 buffer_sprintf(w->response.data, "The file '%s' is currently busy. Please try again later.", webfilename);
444 error("%llu: Cannot open file '%s'.", w->id, webfilename);
445 buffer_sprintf(w->response.data, "Cannot open file '%s'.", webfilename);
450 // pick a Content-Type for the file
451 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
452 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
453 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
454 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
455 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
456 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
457 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
458 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
459 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
460 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
461 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
462 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
463 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
464 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
465 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
466 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
467 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
468 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
469 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
470 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
472 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending file '%s' (%ld bytes, ifd %d, ofd %d).", w->id, webfilename, stat.st_size, w->ifd, w->ofd);
474 w->mode = WEB_CLIENT_MODE_FILECOPY;
477 buffer_flush(w->response.data);
478 w->response.rlen = stat.st_size;
479 w->response.data->date = stat.st_mtim.tv_sec;
485 #ifdef NETDATA_WITH_ZLIB
486 void web_client_enable_deflate(struct web_client *w, int gzip) {
487 if(unlikely(w->response.zinitialized)) {
488 error("%llu: Compression has already be initialized for this client.", w->id);
492 if(unlikely(w->response.sent)) {
493 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
497 w->response.zstream.zalloc = Z_NULL;
498 w->response.zstream.zfree = Z_NULL;
499 w->response.zstream.opaque = Z_NULL;
501 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
502 w->response.zstream.avail_in = 0;
503 w->response.zstream.total_in = 0;
505 w->response.zstream.next_out = w->response.zbuffer;
506 w->response.zstream.avail_out = 0;
507 w->response.zstream.total_out = 0;
509 w->response.zstream.zalloc = Z_NULL;
510 w->response.zstream.zfree = Z_NULL;
511 w->response.zstream.opaque = Z_NULL;
513 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
514 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
518 // Select GZIP compression: windowbits = 15 + 16 = 31
519 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
520 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
524 w->response.zsent = 0;
525 w->response.zoutput = 1;
526 w->response.zinitialized = 1;
528 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
530 #endif // NETDATA_WITH_ZLIB
532 uint32_t web_client_api_request_v1_data_options(char *o)
534 uint32_t ret = 0x00000000;
537 while(o && *o && (tok = mystrsep(&o, ", |"))) {
540 if(!strcmp(tok, "nonzero"))
541 ret |= RRDR_OPTION_NONZERO;
542 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
543 ret |= RRDR_OPTION_REVERSED;
544 else if(!strcmp(tok, "jsonwrap"))
545 ret |= RRDR_OPTION_JSON_WRAP;
546 else if(!strcmp(tok, "min2max"))
547 ret |= RRDR_OPTION_MIN2MAX;
548 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
549 ret |= RRDR_OPTION_MILLISECONDS;
550 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
551 ret |= RRDR_OPTION_ABSOLUTE;
552 else if(!strcmp(tok, "seconds"))
553 ret |= RRDR_OPTION_SECONDS;
554 else if(!strcmp(tok, "null2zero"))
555 ret |= RRDR_OPTION_NULL2ZERO;
556 else if(!strcmp(tok, "objectrows"))
557 ret |= RRDR_OPTION_OBJECTSROWS;
558 else if(!strcmp(tok, "google_json"))
559 ret |= RRDR_OPTION_GOOGLE_JSON;
560 else if(!strcmp(tok, "percentage"))
561 ret |= RRDR_OPTION_PERCENTAGE;
562 else if(!strcmp(tok, "unaligned"))
563 ret |= RRDR_OPTION_NOT_ALIGNED;
569 uint32_t web_client_api_request_v1_data_format(char *name)
571 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
572 return DATASOURCE_DATATABLE_JSON;
574 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
575 return DATASOURCE_DATATABLE_JSONP;
577 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
578 return DATASOURCE_JSON;
580 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
581 return DATASOURCE_JSONP;
583 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
584 return DATASOURCE_SSV;
586 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
587 return DATASOURCE_CSV;
589 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
590 return DATASOURCE_TSV;
592 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
593 return DATASOURCE_HTML;
595 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
596 return DATASOURCE_JS_ARRAY;
598 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
599 return DATASOURCE_SSV_COMMA;
601 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
602 return DATASOURCE_CSV_JSON_ARRAY;
604 return DATASOURCE_JSON;
607 uint32_t web_client_api_request_v1_data_google_format(char *name)
609 if(!strcmp(name, "json"))
610 return DATASOURCE_DATATABLE_JSONP;
612 else if(!strcmp(name, "html"))
613 return DATASOURCE_HTML;
615 else if(!strcmp(name, "csv"))
616 return DATASOURCE_CSV;
618 else if(!strcmp(name, "tsv-excel"))
619 return DATASOURCE_TSV;
621 return DATASOURCE_JSON;
624 int web_client_api_request_v1_data_group(char *name)
626 if(!strcmp(name, "max"))
629 else if(!strcmp(name, "average"))
630 return GROUP_AVERAGE;
632 else if(!strcmp(name, "sum"))
635 else if(!strcmp(name, "incremental-sum"))
636 return GROUP_INCREMENTAL_SUM;
638 return GROUP_AVERAGE;
641 int web_client_api_request_v1_charts(struct web_client *w, char *url)
645 buffer_flush(w->response.data);
646 w->response.data->contenttype = CT_APPLICATION_JSON;
647 rrd_stats_api_v1_charts(w->response.data);
651 int web_client_api_request_v1_chart(struct web_client *w, char *url)
656 buffer_flush(w->response.data);
659 char *value = mystrsep(&url, "?&[]");
660 if(!value || !*value) continue;
662 char *name = mystrsep(&value, "=");
663 if(!name || !*name) continue;
664 if(!value || !*value) continue;
666 // name and value are now the parameters
667 // they are not null and not empty
669 if(!strcmp(name, "chart")) chart = value;
671 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
676 if(!chart || !*chart) {
677 buffer_sprintf(w->response.data, "No chart id is given at the request.");
681 RRDSET *st = rrdset_find(chart);
682 if(!st) st = rrdset_find_byname(chart);
684 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
689 w->response.data->contenttype = CT_APPLICATION_JSON;
690 rrd_stats_api_v1_chart(st, w->response.data);
697 int web_client_api_v1_badge(struct web_client *w, char *url) {
705 buffer_flush(w->response.data);
707 BUFFER *dimensions = NULL;
709 const char *chart = NULL
713 , *multiply_str = NULL
717 , *label_color = NULL
718 , *value_color = NULL
719 , *refresh_str = NULL;
721 int group = GROUP_AVERAGE;
722 uint32_t options = 0x00000000;
725 char *value = mystrsep(&url, "/?&[]");
726 if(!value || !*value) continue;
728 char *name = mystrsep(&value, "=");
729 if(!name || !*name) continue;
730 if(!value || !*value) continue;
732 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
734 // name and value are now the parameters
735 // they are not null and not empty
737 if(!strcmp(name, "chart")) chart = value;
738 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
739 if(!dimensions) dimensions = buffer_create(strlen(value));
741 buffer_strcat(dimensions, "|");
742 buffer_strcat(dimensions, value);
745 else if(!strcmp(name, "after")) after_str = value;
746 else if(!strcmp(name, "before")) before_str = value;
747 else if(!strcmp(name, "points")) points_str = value;
748 else if(!strcmp(name, "group")) {
749 group = web_client_api_request_v1_data_group(value);
751 else if(!strcmp(name, "options")) {
752 options |= web_client_api_request_v1_data_options(value);
754 else if(!strcmp(name, "label")) label = value;
755 else if(!strcmp(name, "units")) units = value;
756 else if(!strcmp(name, "label_color")) label_color = value;
757 else if(!strcmp(name, "value_color")) value_color = value;
758 else if(!strcmp(name, "multiply")) multiply_str = value;
759 else if(!strcmp(name, "divide")) divide_str = value;
760 else if(!strcmp(name, "refresh")) refresh_str = value;
763 if(!chart || !*chart) {
764 buffer_sprintf(w->response.data, "No chart id is given at the request.");
768 RRDSET *st = rrdset_find(chart);
769 if(!st) st = rrdset_find_byname(chart);
771 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1);
776 long long multiply = (multiply_str && *multiply_str)?atol(multiply_str):1;
777 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
778 long long before = (before_str && *before_str )?atol(before_str):0;
779 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
780 int points = (points_str && *points_str )?atoi(points_str):1;
783 if(refresh_str && *refresh_str) {
784 if(!strcmp(refresh_str, "auto")) {
785 if(options & RRDR_OPTION_NOT_ALIGNED)
786 refresh = st->update_every;
788 refresh = (before - after);
789 if(refresh < 0) refresh = -refresh;
793 refresh = atoi(refresh_str);
794 if(refresh < 0) refresh = -refresh;
800 const char *dim = buffer_tostring(dimensions);
801 if(*dim == '|') dim++;
808 if(options & RRDR_OPTION_PERCENTAGE)
814 debug(D_WEB_CLIENT, "%llu: API command 'badge.svg' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%u', options '0x%08x'"
817 , (dimensions)?buffer_tostring(dimensions):""
825 time_t latest_timestamp = 0;
826 int value_is_null = 1;
827 calculated_number n = 0;
830 // if the collected value is too old, don't calculate its value
831 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
832 ret = rrd2value(st, w->response.data, &n, dimensions, points, after, before, group, options, &latest_timestamp, &value_is_null);
834 // if the value cannot be calculated, show empty badge
841 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
844 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null);
848 if(dimensions) buffer_free(dimensions);
852 // returns the HTTP code
853 int web_client_api_request_v1_data(struct web_client *w, char *url)
855 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
858 BUFFER *dimensions = NULL;
860 buffer_flush(w->response.data);
862 char *google_version = "0.6",
865 *google_out = "json",
866 *responseHandler = NULL,
869 time_t last_timestamp_in_data = 0, google_timestamp = 0;
874 , *points_str = NULL;
876 int group = GROUP_AVERAGE;
877 uint32_t format = DATASOURCE_JSON;
878 uint32_t options = 0x00000000;
881 char *value = mystrsep(&url, "?&[]");
882 if(!value || !*value) continue;
884 char *name = mystrsep(&value, "=");
885 if(!name || !*name) continue;
886 if(!value || !*value) continue;
888 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
890 // name and value are now the parameters
891 // they are not null and not empty
893 if(!strcmp(name, "chart")) chart = value;
894 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
895 if(!dimensions) dimensions = buffer_create(strlen(value));
897 buffer_strcat(dimensions, "|");
898 buffer_strcat(dimensions, value);
901 else if(!strcmp(name, "after")) after_str = value;
902 else if(!strcmp(name, "before")) before_str = value;
903 else if(!strcmp(name, "points")) points_str = value;
904 else if(!strcmp(name, "group")) {
905 group = web_client_api_request_v1_data_group(value);
907 else if(!strcmp(name, "format")) {
908 format = web_client_api_request_v1_data_format(value);
910 else if(!strcmp(name, "options")) {
911 options |= web_client_api_request_v1_data_options(value);
913 else if(!strcmp(name, "callback")) {
914 responseHandler = value;
916 else if(!strcmp(name, "filename")) {
919 else if(!strcmp(name, "tqx")) {
920 // parse Google Visualization API options
921 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
922 char *tqx_name, *tqx_value;
925 tqx_value = mystrsep(&value, ";");
926 if(!tqx_value || !*tqx_value) continue;
928 tqx_name = mystrsep(&tqx_value, ":");
929 if(!tqx_name || !*tqx_name) continue;
930 if(!tqx_value || !*tqx_value) continue;
932 if(!strcmp(tqx_name, "version"))
933 google_version = tqx_value;
934 else if(!strcmp(tqx_name, "reqId"))
935 google_reqId = tqx_value;
936 else if(!strcmp(tqx_name, "sig")) {
937 google_sig = tqx_value;
938 google_timestamp = strtoul(google_sig, NULL, 0);
940 else if(!strcmp(tqx_name, "out")) {
941 google_out = tqx_value;
942 format = web_client_api_request_v1_data_google_format(google_out);
944 else if(!strcmp(tqx_name, "responseHandler"))
945 responseHandler = tqx_value;
946 else if(!strcmp(tqx_name, "outFileName"))
947 outFileName = tqx_value;
952 if(!chart || !*chart) {
953 buffer_sprintf(w->response.data, "No chart id is given at the request.");
957 RRDSET *st = rrdset_find(chart);
958 if(!st) st = rrdset_find_byname(chart);
960 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
965 long long before = (before_str && *before_str)?atol(before_str):0;
966 long long after = (after_str && *after_str) ?atol(after_str):0;
967 int points = (points_str && *points_str)?atoi(points_str):0;
969 debug(D_WEB_CLIENT, "%llu: API command 'data' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%u', format '%u', options '0x%08x'"
972 , (dimensions)?buffer_tostring(dimensions):""
981 if(outFileName && *outFileName) {
982 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
983 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
986 if(format == DATASOURCE_DATATABLE_JSONP) {
987 if(responseHandler == NULL)
988 responseHandler = "google.visualization.Query.setResponse";
990 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
991 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
994 buffer_sprintf(w->response.data,
995 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
996 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
998 else if(format == DATASOURCE_JSONP) {
999 if(responseHandler == NULL)
1000 responseHandler = "callback";
1002 buffer_strcat(w->response.data, responseHandler);
1003 buffer_strcat(w->response.data, "(");
1006 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1008 if(format == DATASOURCE_DATATABLE_JSONP) {
1009 if(google_timestamp < last_timestamp_in_data)
1010 buffer_strcat(w->response.data, "});");
1013 // the client already has the latest data
1014 buffer_flush(w->response.data);
1015 buffer_sprintf(w->response.data,
1016 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1017 responseHandler, google_version, google_reqId);
1020 else if(format == DATASOURCE_JSONP)
1021 buffer_strcat(w->response.data, ");");
1024 if(dimensions) buffer_free(dimensions);
1028 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1030 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1031 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1032 hash_to = 0 /*, hash_redirects = 0 */;
1034 if(unlikely(!hash_action)) {
1035 hash_action = simple_hash("action");
1036 hash_access = simple_hash("access");
1037 hash_hello = simple_hash("hello");
1038 hash_delete = simple_hash("delete");
1039 hash_search = simple_hash("search");
1040 hash_switch = simple_hash("switch");
1041 hash_machine = simple_hash("machine");
1042 hash_url = simple_hash("url");
1043 hash_name = simple_hash("name");
1044 hash_delete_url = simple_hash("delete_url");
1045 hash_for = simple_hash("for");
1046 hash_to = simple_hash("to");
1048 hash_redirects = simple_hash("redirects");
1052 char person_guid[36 + 1] = "";
1054 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1057 // The browser may send multiple cookies with our id
1059 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1061 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1064 char *machine_guid = NULL,
1065 *machine_url = NULL,
1067 *search_machine_guid = NULL,
1069 *to_person_guid = NULL;
1075 char *value = mystrsep(&url, "?&[]");
1076 if (!value || !*value) continue;
1078 char *name = mystrsep(&value, "=");
1079 if (!name || !*name) continue;
1080 if (!value || !*value) continue;
1082 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1084 uint32_t hash = simple_hash(name);
1086 if(hash == hash_action && !strcmp(name, "action")) {
1087 uint32_t vhash = simple_hash(value);
1089 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1090 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1091 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1092 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1093 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1094 #ifdef NETDATA_INTERNAL_CHECKS
1095 else error("unknown registry action '%s'", value);
1096 #endif /* NETDATA_INTERNAL_CHECKS */
1099 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1100 redirects = atoi(value);
1102 else if(hash == hash_machine && !strcmp(name, "machine"))
1103 machine_guid = value;
1105 else if(hash == hash_url && !strcmp(name, "url"))
1106 machine_url = value;
1108 else if(action == 'A') {
1109 if(hash == hash_name && !strcmp(name, "name"))
1112 else if(action == 'D') {
1113 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1116 else if(action == 'S') {
1117 if(hash == hash_for && !strcmp(name, "for"))
1118 search_machine_guid = value;
1120 else if(action == 'W') {
1121 if(hash == hash_to && !strcmp(name, "to"))
1122 to_person_guid = value;
1124 #ifdef NETDATA_INTERNAL_CHECKS
1125 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1126 #endif /* NETDATA_INTERNAL_CHECKS */
1129 if(web_donotrack_comply && w->donottrack) {
1130 buffer_flush(w->response.data);
1131 buffer_sprintf(w->response.data, "Your web browser is sending 'DNT: 1' (Do Not Track). The registry requires persistent cookies on your browser to work.");
1135 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1136 buffer_flush(w->response.data);
1137 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1138 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1141 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1142 buffer_flush(w->response.data);
1143 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1144 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1147 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1148 buffer_flush(w->response.data);
1149 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1150 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1153 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1154 buffer_flush(w->response.data);
1155 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1156 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1162 w->tracking_required = 1;
1163 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1164 buffer_flush(w->response.data);
1166 registry_set_cookie(w, "give-me-back-this-cookie-please");
1167 w->response.data->contenttype = CT_APPLICATION_JSON;
1168 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1172 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1173 * under certain conditions, when using CORS
1174 * so this is commented and we use application level redirects instead
1178 if(redirects > registry_verify_cookies_redirects()) {
1179 buffer_flush(w->response.data);
1180 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1184 char *encoded_url = url_encode(machine_url);
1186 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1190 char *encoded_name = url_encode(url_name);
1193 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1197 char *encoded_guid = url_encode(machine_guid);
1201 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1205 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1206 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1214 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1217 w->tracking_required = 1;
1218 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1221 w->tracking_required = 1;
1222 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1225 w->tracking_required = 1;
1226 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1229 return registry_request_hello_json(w);
1232 buffer_flush(w->response.data);
1233 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1237 buffer_flush(w->response.data);
1238 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1242 int web_client_api_request_v1(struct web_client *w, char *url) {
1243 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1245 if(unlikely(hash_data == 0)) {
1246 hash_data = simple_hash("data");
1247 hash_chart = simple_hash("chart");
1248 hash_charts = simple_hash("charts");
1249 hash_registry = simple_hash("registry");
1250 hash_badge = simple_hash("badge.svg");
1254 char *tok = mystrsep(&url, "/?&");
1256 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1257 uint32_t hash = simple_hash(tok);
1259 if(hash == hash_data && !strcmp(tok, "data"))
1260 return web_client_api_request_v1_data(w, url);
1262 else if(hash == hash_chart && !strcmp(tok, "chart"))
1263 return web_client_api_request_v1_chart(w, url);
1265 else if(hash == hash_charts && !strcmp(tok, "charts"))
1266 return web_client_api_request_v1_charts(w, url);
1268 else if(hash == hash_registry && !strcmp(tok, "registry"))
1269 return web_client_api_request_v1_registry(w, url);
1271 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1272 return web_client_api_v1_badge(w, url);
1275 buffer_flush(w->response.data);
1276 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1281 buffer_flush(w->response.data);
1282 buffer_sprintf(w->response.data, "API v1 command?");
1287 int web_client_api_request(struct web_client *w, char *url)
1289 // get the api version
1290 char *tok = mystrsep(&url, "/?&");
1292 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1293 if(strcmp(tok, "v1") == 0)
1294 return web_client_api_request_v1(w, url);
1296 buffer_flush(w->response.data);
1297 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1302 buffer_flush(w->response.data);
1303 buffer_sprintf(w->response.data, "Which API version?");
1308 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1312 char *args = strchr(url, '?');
1318 // get the name of the data to show
1319 char *tok = mystrsep(&url, "/");
1321 // do we have such a data set?
1323 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1324 st = rrdset_find_byname(tok);
1325 if(!st) st = rrdset_find(tok);
1330 // try to send a file with that name
1331 buffer_flush(w->response.data);
1332 return(mysendfile(w, tok));
1336 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1338 // how many entries does the client want?
1339 long lines = rrd_default_history_entries;
1340 long group_count = 1;
1341 time_t after = 0, before = 0;
1342 int group_method = GROUP_AVERAGE;
1346 // parse the lines required
1347 tok = mystrsep(&url, "/");
1348 if(tok) lines = atoi(tok);
1349 if(lines < 1) lines = 1;
1352 // parse the group count required
1353 tok = mystrsep(&url, "/");
1354 if(tok && *tok) group_count = atoi(tok);
1355 if(group_count < 1) group_count = 1;
1356 //if(group_count > save_history / 20) group_count = save_history / 20;
1359 // parse the grouping method required
1360 tok = mystrsep(&url, "/");
1362 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1363 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1364 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1365 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1370 tok = mystrsep(&url, "/");
1371 if(tok && *tok) after = strtoul(tok, NULL, 10);
1372 if(after < 0) after = 0;
1375 // parse before time
1376 tok = mystrsep(&url, "/");
1377 if(tok && *tok) before = strtoul(tok, NULL, 10);
1378 if(before < 0) before = 0;
1382 tok = mystrsep(&url, "/");
1383 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1386 w->response.data->contenttype = CT_APPLICATION_JSON;
1387 buffer_flush(w->response.data);
1389 char *google_version = "0.6";
1390 char *google_reqId = "0";
1391 char *google_sig = "0";
1392 char *google_out = "json";
1393 char *google_responseHandler = "google.visualization.Query.setResponse";
1394 char *google_outFileName = NULL;
1395 time_t last_timestamp_in_data = 0;
1396 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1398 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1401 tok = mystrsep(&args, "&");
1403 char *name = mystrsep(&tok, "=");
1404 if(name && *name && strcmp(name, "tqx") == 0) {
1405 char *key = mystrsep(&tok, ":");
1406 char *value = mystrsep(&tok, ";");
1407 if(key && value && *key && *value) {
1408 if(strcmp(key, "version") == 0)
1409 google_version = value;
1411 else if(strcmp(key, "reqId") == 0)
1412 google_reqId = value;
1414 else if(strcmp(key, "sig") == 0)
1417 else if(strcmp(key, "out") == 0)
1420 else if(strcmp(key, "responseHandler") == 0)
1421 google_responseHandler = value;
1423 else if(strcmp(key, "outFileName") == 0)
1424 google_outFileName = value;
1430 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1431 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1434 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1435 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1437 // check the client wants json
1438 if(strcmp(google_out, "json") != 0) {
1439 buffer_sprintf(w->response.data,
1440 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'invalid_query',message:'output format is not supported',detailed_message:'the format %s requested is not supported by netdata.'}]});",
1441 google_responseHandler, google_version, google_reqId, google_out);
1447 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1448 buffer_sprintf(w->response.data,
1449 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
1450 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1453 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %lu after, %lu before).", w->id, st->name, st->id, lines, group_count, group_method, after, before);
1454 time_t timestamp_in_data = rrd_stats_json(datasource_type, st, w->response.data, lines, group_count, group_method, after, before, nonzero);
1456 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1457 if(timestamp_in_data > last_timestamp_in_data)
1458 buffer_strcat(w->response.data, "});");
1461 // the client already has the latest data
1462 buffer_flush(w->response.data);
1463 buffer_sprintf(w->response.data,
1464 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1465 google_responseHandler, google_version, google_reqId);
1472 const char *web_content_type_to_string(uint8_t contenttype) {
1473 switch(contenttype) {
1475 return "text/html; charset=utf-8";
1477 case CT_APPLICATION_XML:
1478 return "application/xml; charset=utf-8";
1480 case CT_APPLICATION_JSON:
1481 return "application/json; charset=utf-8";
1483 case CT_APPLICATION_X_JAVASCRIPT:
1484 return "application/x-javascript; charset=utf-8";
1487 return "text/css; charset=utf-8";
1490 return "text/xml; charset=utf-8";
1493 return "text/xsl; charset=utf-8";
1495 case CT_APPLICATION_OCTET_STREAM:
1496 return "application/octet-stream";
1498 case CT_IMAGE_SVG_XML:
1499 return "image/svg+xml";
1501 case CT_APPLICATION_X_FONT_TRUETYPE:
1502 return "application/x-font-truetype";
1504 case CT_APPLICATION_X_FONT_OPENTYPE:
1505 return "application/x-font-opentype";
1507 case CT_APPLICATION_FONT_WOFF:
1508 return "application/font-woff";
1510 case CT_APPLICATION_FONT_WOFF2:
1511 return "application/font-woff2";
1513 case CT_APPLICATION_VND_MS_FONTOBJ:
1514 return "application/vnd.ms-fontobject";
1520 return "image/jpeg";
1525 case CT_IMAGE_XICON:
1526 return "image/x-icon";
1532 return "image/icns";
1536 return "text/plain; charset=utf-8";
1541 const char *web_response_code_to_string(int code) {
1547 return "Temporary Redirect";
1550 return "Bad Request";
1559 return "Preconditions Failed";
1562 if(code >= 100 && code < 200)
1563 return "Informational";
1565 if(code >= 200 && code < 300)
1566 return "Successful";
1568 if(code >= 300 && code < 400)
1569 return "Redirection";
1571 if(code >= 400 && code < 500)
1572 return "Bad Request";
1574 if(code >= 500 && code < 600)
1575 return "Server Error";
1577 return "Undefined Error";
1581 static inline char *http_header_parse(struct web_client *w, char *s) {
1582 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1584 if(unlikely(!hash_origin)) {
1585 hash_origin = simple_uhash("Origin");
1586 hash_connection = simple_uhash("Connection");
1587 hash_accept_encoding = simple_uhash("Accept-Encoding");
1588 hash_donottrack = simple_uhash("DNT");
1594 while(*e && *e != ':') e++;
1601 char *v = e + 1, *ve;
1603 // skip leading spaces from value
1604 while(*v == ' ') v++;
1608 while(*ve && *ve != '\r') ve++;
1609 if(!*ve || ve[1] != '\n') {
1614 // terminate the value
1617 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1618 uint32_t hash = simple_uhash(s);
1620 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1621 strncpyz(w->origin, v, ORIGIN_MAX);
1623 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1624 if(strcasestr(v, "keep-alive"))
1627 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1628 if(*v == '0') w->donottrack = 0;
1629 else if(*v == '1') w->donottrack = 1;
1631 #ifdef NETDATA_WITH_ZLIB
1632 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1633 if(web_enable_gzip) {
1634 if(strcasestr(v, "gzip"))
1635 web_client_enable_deflate(w, 1);
1637 // does not seem to work
1638 // else if(strcasestr(v, "deflate"))
1639 // web_client_enable_deflate(w, 0);
1642 #endif /* NETDATA_WITH_ZLIB */
1649 // http_request_validate()
1651 // = 0 : all good, process the request
1652 // > 0 : request is not supported
1653 // < 0 : request is incomplete - wait for more data
1655 static inline int http_request_validate(struct web_client *w) {
1656 char *s = w->response.data->buffer, *encoded_url = NULL;
1658 // is is a valid request?
1659 if(!strncmp(s, "GET ", 4)) {
1660 encoded_url = s = &s[4];
1661 w->mode = WEB_CLIENT_MODE_NORMAL;
1663 else if(!strncmp(s, "OPTIONS ", 8)) {
1664 encoded_url = s = &s[8];
1665 w->mode = WEB_CLIENT_MODE_OPTIONS;
1668 w->wait_receive = 0;
1672 // find the SPACE + "HTTP/"
1674 // find the next space
1675 while (*s && *s != ' ') s++;
1677 // is it SPACE + "HTTP/" ?
1678 if(*s && !strncmp(s, " HTTP/", 6)) break;
1682 // incomplete requests
1684 w->wait_receive = 1;
1688 // we have the end of encoded_url - remember it
1691 // make sure we have complete request
1692 // complete requests contain: \r\n\r\n
1695 while(*s && *s++ != '\r');
1697 // did we reach the end?
1698 if(unlikely(!*s)) break;
1701 if(likely(*s++ == '\n')) {
1703 // is it again \r\n ? (header end)
1704 if(unlikely(*s == '\r' && s[1] == '\n')) {
1705 // a valid complete HTTP request found
1708 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1711 // copy the URL - we are going to overwrite parts of it
1712 // FIXME -- we should avoid it
1713 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1715 w->wait_receive = 0;
1719 // another header line
1720 s = http_header_parse(w, s);
1724 // incomplete request
1725 w->wait_receive = 1;
1729 void web_client_process(struct web_client *w) {
1730 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1731 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1733 if(unlikely(!hash_api)) {
1734 hash_api = simple_hash("api");
1735 hash_netdata_conf = simple_hash("netdata.conf");
1736 hash_data = simple_hash(WEB_PATH_DATA);
1737 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1738 hash_graph = simple_hash(WEB_PATH_GRAPH);
1739 hash_list = simple_hash("list");
1740 hash_all_json = simple_hash("all.json");
1741 hash_exit = simple_hash("exit");
1742 hash_debug = simple_hash("debug");
1743 hash_mirror = simple_hash("mirror");
1749 int what_to_do = http_request_validate(w);
1751 // wait for more data
1752 if(what_to_do < 0) {
1753 if(w->response.data->len > TOO_BIG_REQUEST) {
1754 strcpy(w->last_url, "too big request");
1756 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zd bytes).", w->id, w->response.data->len);
1759 buffer_flush(w->response.data);
1760 buffer_sprintf(w->response.data, "Received request is too big (%zd bytes).\r\n", w->response.data->len);
1763 // wait for more data
1767 else if(what_to_do > 0) {
1768 strcpy(w->last_url, "not a valid request");
1770 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1773 buffer_flush(w->response.data);
1774 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1776 else { // what_to_do == 0
1777 gettimeofday(&w->tv_in, NULL);
1779 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1781 w->response.data->contenttype = CT_TEXT_PLAIN;
1782 buffer_flush(w->response.data);
1783 buffer_strcat(w->response.data, "OK");
1786 char *url = w->decoded_url;
1787 char *tok = mystrsep(&url, "/?");
1789 uint32_t hash = simple_hash(tok);
1790 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1792 if(hash == hash_api && strcmp(tok, "api") == 0) {
1793 // the client is requesting api access
1794 code = web_client_api_request(w, url);
1796 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1798 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1800 w->response.data->contenttype = CT_TEXT_PLAIN;
1801 buffer_flush(w->response.data);
1802 generate_config(w->response.data, 0);
1804 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1805 // the client is requesting rrd data -- OLD API
1806 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1808 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1809 // the client is requesting google datasource -- OLD API
1810 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1812 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1813 // the client is requesting an rrd graph -- OLD API
1815 // get the name of the data to show
1816 tok = mystrsep(&url, "/?&");
1818 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1820 // do we have such a data set?
1821 RRDSET *st = rrdset_find_byname(tok);
1822 if(!st) st = rrdset_find(tok);
1825 // try to send a file with that name
1826 buffer_flush(w->response.data);
1827 code = mysendfile(w, tok);
1831 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1832 w->response.data->contenttype = CT_APPLICATION_JSON;
1833 buffer_flush(w->response.data);
1834 rrd_stats_graph_json(st, url, w->response.data);
1839 buffer_flush(w->response.data);
1840 buffer_strcat(w->response.data, "Graph name?\r\n");
1843 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1847 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1849 buffer_flush(w->response.data);
1850 RRDSET *st = rrdset_root;
1852 for ( ; st ; st = st->next )
1853 buffer_sprintf(w->response.data, "%s\n", st->name);
1855 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1858 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1860 w->response.data->contenttype = CT_APPLICATION_JSON;
1861 buffer_flush(w->response.data);
1862 rrd_stats_all_json(w->response.data);
1864 #ifdef NETDATA_INTERNAL_CHECKS
1865 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1867 w->response.data->contenttype = CT_TEXT_PLAIN;
1868 buffer_flush(w->response.data);
1871 buffer_strcat(w->response.data, "ok, will do...");
1873 buffer_strcat(w->response.data, "I am doing it already");
1877 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1878 buffer_flush(w->response.data);
1880 // get the name of the data to show
1881 tok = mystrsep(&url, "/?&");
1883 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1885 // do we have such a data set?
1886 RRDSET *st = rrdset_find_byname(tok);
1887 if(!st) st = rrdset_find(tok);
1890 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1891 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1895 debug_flags |= D_RRD_STATS;
1896 st->debug = !st->debug;
1897 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1898 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1903 buffer_flush(w->response.data);
1904 buffer_strcat(w->response.data, "debug which chart?\r\n");
1907 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1910 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1912 // replace the zero bytes with spaces
1913 buffer_char_replace(w->response.data, '\0', ' ');
1915 // just leave the buffer as is
1916 // it will be copied back to the client
1918 #endif /* NETDATA_INTERNAL_CHECKS */
1920 char filename[FILENAME_MAX+1];
1922 strncpyz(filename, w->last_url, FILENAME_MAX);
1923 tok = mystrsep(&url, "?");
1924 buffer_flush(w->response.data);
1925 code = mysendfile(w, (tok && *tok)?tok:"/");
1929 char filename[FILENAME_MAX+1];
1931 strncpyz(filename, w->last_url, FILENAME_MAX);
1932 tok = mystrsep(&url, "?");
1933 buffer_flush(w->response.data);
1934 code = mysendfile(w, (tok && *tok)?tok:"/");
1939 gettimeofday(&w->tv_ready, NULL);
1940 w->response.data->date = time(NULL);
1941 w->response.sent = 0;
1942 w->response.code = code;
1944 // prepare the HTTP response header
1945 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1947 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1948 const char *code_msg = web_response_code_to_string(code);
1951 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1952 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1954 buffer_sprintf(w->response.header_output,
1955 "HTTP/1.1 %d %s\r\n"
1956 "Connection: %s\r\n"
1957 "Server: NetData Embedded HTTP Server\r\n"
1958 "Access-Control-Allow-Origin: %s\r\n"
1959 "Access-Control-Allow-Credentials: true\r\n"
1960 "Content-Type: %s\r\n"
1963 , w->keepalive?"keep-alive":"close"
1965 , content_type_string
1969 if(w->cookie1[0] || w->cookie2[0]) {
1971 buffer_sprintf(w->response.header_output,
1972 "Set-Cookie: %s\r\n",
1977 buffer_sprintf(w->response.header_output,
1978 "Set-Cookie: %s\r\n",
1982 if(web_donotrack_comply)
1983 buffer_sprintf(w->response.header_output,
1984 "Tk: T;cookies\r\n");
1987 if(web_donotrack_comply) {
1988 if(w->tracking_required)
1989 buffer_sprintf(w->response.header_output,
1990 "Tk: T;cookies\r\n");
1992 buffer_sprintf(w->response.header_output,
1997 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1998 buffer_strcat(w->response.header_output,
1999 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2000 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
2001 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2005 if(buffer_strlen(w->response.header))
2006 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2008 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
2009 buffer_sprintf(w->response.header_output,
2011 "Cache-Control: no-cache\r\n"
2014 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
2016 time_t et = w->response.data->date + (86400 * 14);
2017 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
2018 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
2020 buffer_sprintf(w->response.header_output,
2022 "Cache-Control: public\r\n"
2026 // if we know the content length, put it
2027 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
2028 buffer_sprintf(w->response.header_output,
2029 "Content-Length: %ld\r\n"
2030 , w->response.data->len? w->response.data->len: w->response.rlen
2032 else if(!w->response.zoutput)
2033 w->keepalive = 0; // content-length is required for keep-alive
2035 if(w->response.zoutput) {
2036 buffer_strcat(w->response.header_output,
2037 "Content-Encoding: gzip\r\n"
2038 "Transfer-Encoding: chunked\r\n"
2042 buffer_strcat(w->response.header_output, "\r\n");
2044 // sent the HTTP header
2045 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %d: '%s'"
2047 , buffer_strlen(w->response.header_output)
2048 , buffer_tostring(w->response.header_output)
2051 web_client_crock_socket(w);
2053 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2054 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2056 w->stats_sent_bytes += bytes;
2058 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %d bytes but the system sent %d bytes). Closing web client.", w->id,
2059 buffer_strlen(w->response.header_output), bytes);
2061 WEB_CLIENT_IS_DEAD(w);
2065 w->stats_sent_bytes += bytes;
2067 // enable sending immediately if we have data
2068 if(w->response.data->len) w->wait_send = 1;
2069 else w->wait_send = 0;
2073 case WEB_CLIENT_MODE_OPTIONS:
2074 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%d bytes) to client.", w->id, w->response.data->len);
2077 case WEB_CLIENT_MODE_NORMAL:
2078 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%d bytes) to client.", w->id, w->response.data->len);
2081 case WEB_CLIENT_MODE_FILECOPY:
2082 if(w->response.rlen) {
2083 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %d bytes to client.", w->id, w->response.rlen);
2084 w->wait_receive = 1;
2087 // utilize the kernel sendfile() for copying the file to the socket.
2088 // this block of code can be commented, without anything missing.
2089 // when it is commented, the program will copy the data using async I/O.
2091 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2092 if(len != w->response.data->rbytes)
2093 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2095 web_client_reset(w);
2100 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2104 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2109 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2111 debug(D_DEFLATE, "%llu: OPEN CHUNK of %d bytes (hex: %x).", w->id, len, len);
2113 sprintf(buf, "%zX\r\n", len);
2115 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2117 debug(D_DEFLATE, "%llu: Sent chunk header %d bytes.", w->id, bytes);
2118 w->stats_sent_bytes += bytes;
2121 else if(bytes == 0) {
2122 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2123 WEB_CLIENT_IS_DEAD(w);
2126 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2127 WEB_CLIENT_IS_DEAD(w);
2133 ssize_t web_client_send_chunk_close(struct web_client *w)
2135 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2137 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2139 debug(D_DEFLATE, "%llu: Sent chunk suffix %d bytes.", w->id, bytes);
2140 w->stats_sent_bytes += bytes;
2143 else if(bytes == 0) {
2144 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2145 WEB_CLIENT_IS_DEAD(w);
2148 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2149 WEB_CLIENT_IS_DEAD(w);
2155 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2157 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2159 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2161 debug(D_DEFLATE, "%llu: Sent chunk suffix %d bytes.", w->id, bytes);
2162 w->stats_sent_bytes += bytes;
2165 else if(bytes == 0) {
2166 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2167 WEB_CLIENT_IS_DEAD(w);
2170 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2171 WEB_CLIENT_IS_DEAD(w);
2177 #ifdef NETDATA_WITH_ZLIB
2178 ssize_t web_client_send_deflate(struct web_client *w)
2180 ssize_t len = 0, t = 0;
2182 // when using compression,
2183 // w->response.sent is the amount of bytes passed through compression
2185 debug(D_DEFLATE, "%llu: web_client_send_deflate(): w->response.data->len = %d, w->response.sent = %d, w->response.zhave = %d, w->response.zsent = %d, w->response.zstream.avail_in = %d, w->response.zstream.avail_out = %d, w->response.zstream.total_in = %d, w->response.zstream.total_out = %d.", w->id, w->response.data->len, w->response.sent, w->response.zhave, w->response.zsent, w->response.zstream.avail_in, w->response.zstream.avail_out, w->response.zstream.total_in, w->response.zstream.total_out);
2187 if(w->response.data->len - w->response.sent == 0 && w->response.zstream.avail_in == 0 && w->response.zhave == w->response.zsent && w->response.zstream.avail_out != 0) {
2188 // there is nothing to send
2190 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2192 // finalize the chunk
2193 if(w->response.sent != 0) {
2194 t = web_client_send_chunk_finalize(w);
2198 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2199 // we have to wait, more data will come
2200 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2205 if(unlikely(!w->keepalive)) {
2206 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2207 WEB_CLIENT_IS_DEAD(w);
2212 web_client_reset(w);
2213 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2217 if(w->response.zhave == w->response.zsent) {
2218 // compress more input data
2220 // close the previous open chunk
2221 if(w->response.sent != 0) {
2222 t = web_client_send_chunk_close(w);
2226 debug(D_DEFLATE, "%llu: Compressing %d new bytes starting from %d (and %d left behind).", w->id, (w->response.data->len - w->response.sent), w->response.sent, w->response.zstream.avail_in);
2228 // give the compressor all the data not passed through the compressor yet
2229 if(w->response.data->len > w->response.sent) {
2230 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2231 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2234 // reset the compressor output buffer
2235 w->response.zstream.next_out = w->response.zbuffer;
2236 w->response.zstream.avail_out = ZLIB_CHUNK;
2238 // ask for FINISH if we have all the input
2239 int flush = Z_SYNC_FLUSH;
2240 if(w->mode == WEB_CLIENT_MODE_NORMAL
2241 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2243 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2246 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2250 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2251 error("%llu: Compression failed. Closing down client.", w->id);
2252 web_client_reset(w);
2256 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2257 w->response.zsent = 0;
2259 // keep track of the bytes passed through the compressor
2260 w->response.sent = w->response.data->len;
2262 debug(D_DEFLATE, "%llu: Compression produced %d bytes.", w->id, w->response.zhave);
2265 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2266 if(t2 < 0) return t2;
2270 debug(D_WEB_CLIENT, "%llu: Sending %d bytes of data (+%d of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2272 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2274 w->stats_sent_bytes += len;
2275 w->response.zsent += len;
2277 debug(D_WEB_CLIENT, "%llu: Sent %d bytes.", w->id, len);
2280 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %ld, zsent = %ld, need to send = %ld).", w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2281 WEB_CLIENT_IS_DEAD(w);
2284 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2285 WEB_CLIENT_IS_DEAD(w);
2290 #endif // NETDATA_WITH_ZLIB
2292 ssize_t web_client_send(struct web_client *w) {
2293 #ifdef NETDATA_WITH_ZLIB
2294 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2295 #endif // NETDATA_WITH_ZLIB
2299 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2300 // there is nothing to send
2302 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2304 // there can be two cases for this
2305 // A. we have done everything
2306 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2308 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2309 // we have to wait, more data will come
2310 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2315 if(unlikely(!w->keepalive)) {
2316 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2317 WEB_CLIENT_IS_DEAD(w);
2321 web_client_reset(w);
2322 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2326 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2327 if(likely(bytes > 0)) {
2328 w->stats_sent_bytes += bytes;
2329 w->response.sent += bytes;
2330 debug(D_WEB_CLIENT, "%llu: Sent %d bytes.", w->id, bytes);
2332 else if(likely(bytes == 0)) {
2333 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2334 WEB_CLIENT_IS_DEAD(w);
2337 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2338 WEB_CLIENT_IS_DEAD(w);
2344 ssize_t web_client_receive(struct web_client *w)
2346 // do we have any space for more data?
2347 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2349 ssize_t left = w->response.data->size - w->response.data->len;
2352 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2353 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2355 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2357 if(likely(bytes > 0)) {
2358 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2359 w->stats_received_bytes += bytes;
2361 size_t old = w->response.data->len;
2362 w->response.data->len += bytes;
2363 w->response.data->buffer[w->response.data->len] = '\0';
2365 debug(D_WEB_CLIENT, "%llu: Received %d bytes.", w->id, bytes);
2366 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2368 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2371 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2372 w->wait_receive = 0;
2375 else if(likely(bytes == 0)) {
2376 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2378 // if we cannot read, it means we have an error on input.
2379 // if however, we are copying a file from ifd to ofd, we should not return an error.
2380 // in this case, the error should be generated when the file has been sent to the client.
2382 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2383 // we are copying data from ifd to ofd
2384 // let it finish copying...
2385 w->wait_receive = 0;
2387 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2388 if(w->ifd != w->ofd) close(w->ifd);
2392 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2393 WEB_CLIENT_IS_DEAD(w);
2397 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2398 WEB_CLIENT_IS_DEAD(w);
2405 // --------------------------------------------------------------------------------------
2406 // the thread of a single client
2408 // 1. waits for input and output, using async I/O
2409 // 2. it processes HTTP requests
2410 // 3. it generates HTTP responses
2411 // 4. it copies data from input to output if mode is FILECOPY
2413 void *web_client_main(void *ptr)
2415 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2416 error("Cannot set pthread cancel type to DEFERRED.");
2418 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2419 error("Cannot set pthread cancel state to ENABLE.");
2421 struct web_client *w = ptr;
2422 struct pollfd fds[2], *ifd, *ofd;
2423 int retval, fdmax = 0, timeout;
2425 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2428 if(unlikely(w->dead)) {
2429 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2432 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2433 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.");
2437 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2438 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2442 if(w->ifd == w->ofd) {
2447 if(w->wait_receive) fds[0].events |= POLLIN;
2448 if(w->wait_send) fds[0].events |= POLLOUT;
2454 ifd = ofd = &fds[0];
2462 if(w->wait_receive) fds[0].events |= POLLIN;
2468 if(w->wait_send) fds[1].events |= POLLOUT;
2474 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2476 timeout = web_client_timeout * 1000;
2477 retval = poll(fds, fdmax, timeout);
2479 if(unlikely(retval == -1)) {
2480 if(errno == EAGAIN || errno == EINTR) {
2481 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2485 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2488 else if(unlikely(!retval)) {
2489 debug(D_WEB_CLIENT, "%llu: Timeout while waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2494 if(w->wait_send && ofd->revents & POLLOUT) {
2496 if(web_client_send(w) < 0) {
2497 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2502 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2504 if(web_client_receive(w) < 0) {
2505 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2509 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2510 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2511 web_client_process(w);
2515 if(unlikely(!used)) {
2516 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2521 web_client_reset(w);
2523 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2524 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2526 // close the sockets/files now
2527 // to free file descriptors
2528 if(w->ifd == w->ofd) {
2529 if(w->ifd != -1) close(w->ifd);
2532 if(w->ifd != -1) close(w->ifd);
2533 if(w->ofd != -1) close(w->ofd);