7 #include <sys/socket.h>
8 #include <netinet/in.h>
21 #include <netinet/tcp.h>
26 #include "appconfig.h"
28 #include "web_buffer.h"
29 #include "web_server.h"
30 #include "global_statistics.h"
34 #include "web_buffer_svg.h"
35 #include "web_client.h"
37 #define INITIAL_WEB_DATA_LENGTH 16384
38 #define WEB_REQUEST_LENGTH 16384
39 #define TOO_BIG_REQUEST 16384
41 int web_client_timeout = DEFAULT_DISCONNECT_IDLE_WEB_CLIENTS_AFTER_SECONDS;
42 int web_donotrack_comply = 0;
44 #ifdef NETDATA_WITH_ZLIB
45 int web_enable_gzip = 1, web_gzip_level = 3, web_gzip_strategy = Z_DEFAULT_STRATEGY;
46 #endif /* NETDATA_WITH_ZLIB */
48 struct web_client *web_clients = NULL;
49 unsigned long long web_clients_count = 0;
51 inline int web_client_crock_socket(struct web_client *w) {
53 if(likely(!w->tcp_cork && w->ofd != -1)) {
55 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
56 error("%llu: failed to enable TCP_CORK on socket.", w->id);
66 inline int web_client_uncrock_socket(struct web_client *w) {
68 if(likely(w->tcp_cork && w->ofd != -1)) {
70 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
71 error("%llu: failed to disable TCP_CORK on socket.", w->id);
81 struct web_client *web_client_create(int listener)
85 w = calloc(1, sizeof(struct web_client));
87 error("Cannot allocate new web_client memory.");
91 w->id = ++web_clients_count;
92 w->mode = WEB_CLIENT_MODE_NORMAL;
95 struct sockaddr *sadr;
98 sadr = (struct sockaddr*) &w->clientaddr;
99 addrlen = sizeof(w->clientaddr);
101 w->ifd = accept4(listener, sadr, &addrlen, SOCK_NONBLOCK);
103 error("%llu: Cannot accept new incoming connection.", w->id);
109 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
110 error("Cannot getnameinfo() on received client connection.");
111 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
112 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
114 w->client_ip[NI_MAXHOST] = '\0';
115 w->client_port[NI_MAXSERV] = '\0';
117 switch(sadr->sa_family) {
119 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);
123 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
124 strcpy(w->client_ip, &w->client_ip[7]);
125 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);
128 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);
132 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);
137 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
138 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
141 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
142 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
145 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
146 if(unlikely(!w->response.data)) {
147 // no need for error log - web_buffer_create already logged the error
153 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
154 if(unlikely(!w->response.header)) {
155 // no need for error log - web_buffer_create already logged the error
156 buffer_free(w->response.data);
162 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
163 if(unlikely(!w->response.header_output)) {
164 // no need for error log - web_buffer_create already logged the error
165 buffer_free(w->response.header);
166 buffer_free(w->response.data);
175 if(web_clients) web_clients->prev = w;
176 w->next = web_clients;
179 global_statistics.connected_clients++;
184 void web_client_reset(struct web_client *w) {
185 web_client_uncrock_socket(w);
187 debug(D_WEB_CLIENT, "%llu: Reseting client.", w->id);
189 if(likely(w->last_url[0])) {
191 gettimeofday(&tv, NULL);
193 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
195 #ifdef NETDATA_WITH_ZLIB
196 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
199 // --------------------------------------------------------------------
202 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
203 global_statistics_lock();
205 global_statistics.web_requests++;
206 global_statistics.web_usec += usecdiff(&tv, &w->tv_in);
207 global_statistics.bytes_received += w->stats_received_bytes;
208 global_statistics.bytes_sent += w->stats_sent_bytes;
209 global_statistics.content_size += size;
210 global_statistics.compressed_content_size += sent;
212 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
213 global_statistics_unlock();
215 w->stats_received_bytes = 0;
216 w->stats_sent_bytes = 0;
219 // --------------------------------------------------------------------
222 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
224 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
225 usecdiff(&w->tv_ready, &w->tv_in) / 1000.0,
226 usecdiff(&tv, &w->tv_ready) / 1000.0,
227 usecdiff(&tv, &w->tv_in) / 1000.0,
228 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
229 ? "options" : "data"),
235 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
236 if(w->ifd != w->ofd) {
237 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
238 if(w->ifd != -1) close(w->ifd);
243 w->last_url[0] = '\0';
244 w->cookie1[0] = '\0';
245 w->cookie2[0] = '\0';
249 w->mode = WEB_CLIENT_MODE_NORMAL;
253 w->tracking_required = 0;
255 w->decoded_url[0] = '\0';
257 buffer_reset(w->response.header_output);
258 buffer_reset(w->response.header);
259 buffer_reset(w->response.data);
260 w->response.rlen = 0;
261 w->response.sent = 0;
262 w->response.code = 0;
267 w->response.zoutput = 0;
269 // if we had enabled compression, release it
270 #ifdef NETDATA_WITH_ZLIB
271 if(w->response.zinitialized) {
272 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
273 deflateEnd(&w->response.zstream);
274 w->response.zsent = 0;
275 w->response.zhave = 0;
276 w->response.zstream.avail_in = 0;
277 w->response.zstream.avail_out = 0;
278 w->response.zstream.total_in = 0;
279 w->response.zstream.total_out = 0;
280 w->response.zinitialized = 0;
282 #endif // NETDATA_WITH_ZLIB
285 struct web_client *web_client_free(struct web_client *w) {
288 struct web_client *n = w->next;
289 if(w == web_clients) web_clients = n;
291 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
293 if(w->prev) w->prev->next = w->next;
294 if(w->next) w->next->prev = w->prev;
295 if(w->response.header_output) buffer_free(w->response.header_output);
296 if(w->response.header) buffer_free(w->response.header);
297 if(w->response.data) buffer_free(w->response.data);
298 if(w->ifd != -1) close(w->ifd);
299 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
302 global_statistics.connected_clients--;
307 uid_t web_files_uid(void) {
308 static char *web_owner = NULL;
309 static uid_t owner_uid = 0;
311 if(unlikely(!web_owner)) {
312 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
313 if(!web_owner || !*web_owner)
314 owner_uid = geteuid();
316 // getpwnam() is not thread safe,
317 // but we have called this function once
318 // while single threaded
319 struct passwd *pw = getpwnam(web_owner);
321 error("User '%s' is not present. Ignoring option.", web_owner);
322 owner_uid = geteuid();
325 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
326 owner_uid = pw->pw_uid;
334 gid_t web_files_gid(void) {
335 static char *web_group = NULL;
336 static gid_t owner_gid = 0;
338 if(unlikely(!web_group)) {
339 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
340 if(!web_group || !*web_group)
341 owner_gid = getegid();
343 // getgrnam() is not thread safe,
344 // but we have called this function once
345 // while single threaded
346 struct group *gr = getgrnam(web_group);
348 error("Group '%s' is not present. Ignoring option.", web_group);
349 owner_gid = getegid();
352 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
353 owner_gid = gr->gr_gid;
361 int mysendfile(struct web_client *w, char *filename)
363 static char *web_dir = NULL;
365 // initialize our static data
366 if(unlikely(!web_dir)) web_dir = config_get("global", "web files directory", WEB_DIR);
368 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, web_dir, filename);
370 // skip leading slashes
371 while (*filename == '/') filename++;
373 // if the filename contain known paths, skip them
374 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
375 filename = &filename[strlen(WEB_PATH_FILE) + 1];
378 for(s = filename; *s ;s++) {
379 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
380 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
381 buffer_sprintf(w->response.data, "File '%s' cannot be served. Filename contains invalid character '%c'", filename, *s);
386 // if the filename contains a .. refuse to serve it
387 if(strstr(filename, "..") != 0) {
388 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
389 buffer_sprintf(w->response.data, "File '%s' cannot be served. Relative filenames with '..' in them are not supported.", filename);
394 char webfilename[FILENAME_MAX + 1];
395 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
397 // check if the file exists
399 if(lstat(webfilename, &stat) != 0) {
400 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
401 buffer_sprintf(w->response.data, "File '%s' does not exist, or is not accessible.", webfilename);
405 // check if the file is owned by expected user
406 if(stat.st_uid != web_files_uid()) {
407 error("%llu: File '%s' is owned by user %d (expected user %d). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
408 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
412 // check if the file is owned by expected group
413 if(stat.st_gid != web_files_gid()) {
414 error("%llu: File '%s' is owned by group %d (expected group %d). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
415 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
419 if((stat.st_mode & S_IFMT) == S_IFDIR) {
420 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
421 return mysendfile(w, webfilename);
424 if((stat.st_mode & S_IFMT) != S_IFREG) {
425 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
426 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
431 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
435 if(errno == EBUSY || errno == EAGAIN) {
436 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
437 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
438 buffer_sprintf(w->response.data, "The file '%s' is currently busy. Please try again later.", webfilename);
442 error("%llu: Cannot open file '%s'.", w->id, webfilename);
443 buffer_sprintf(w->response.data, "Cannot open file '%s'.", webfilename);
447 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
448 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, 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
720 , *precision_str = NULL;
722 int group = GROUP_AVERAGE;
723 uint32_t options = 0x00000000;
726 char *value = mystrsep(&url, "/?&[]");
727 if(!value || !*value) continue;
729 char *name = mystrsep(&value, "=");
730 if(!name || !*name) continue;
731 if(!value || !*value) continue;
733 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
735 // name and value are now the parameters
736 // they are not null and not empty
738 if(!strcmp(name, "chart")) chart = value;
739 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
741 dimensions = buffer_create(strlen(value));
744 buffer_strcat(dimensions, "|");
745 buffer_strcat(dimensions, value);
748 else if(!strcmp(name, "after")) after_str = value;
749 else if(!strcmp(name, "before")) before_str = value;
750 else if(!strcmp(name, "points")) points_str = value;
751 else if(!strcmp(name, "group")) {
752 group = web_client_api_request_v1_data_group(value);
754 else if(!strcmp(name, "options")) {
755 options |= web_client_api_request_v1_data_options(value);
757 else if(!strcmp(name, "label")) label = value;
758 else if(!strcmp(name, "units")) units = value;
759 else if(!strcmp(name, "label_color")) label_color = value;
760 else if(!strcmp(name, "value_color")) value_color = value;
761 else if(!strcmp(name, "multiply")) multiply_str = value;
762 else if(!strcmp(name, "divide")) divide_str = value;
763 else if(!strcmp(name, "refresh")) refresh_str = value;
764 else if(!strcmp(name, "precision")) precision_str = value;
767 if(!chart || !*chart) {
768 buffer_sprintf(w->response.data, "No chart id is given at the request.");
772 RRDSET *st = rrdset_find(chart);
773 if(!st) st = rrdset_find_byname(chart);
775 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
780 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
781 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
782 long long before = (before_str && *before_str )?atol(before_str):0;
783 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
784 int points = (points_str && *points_str )?atoi(points_str):1;
785 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
788 if(refresh_str && *refresh_str) {
789 if(!strcmp(refresh_str, "auto")) {
790 if(options & RRDR_OPTION_NOT_ALIGNED)
791 refresh = st->update_every;
793 refresh = (before - after);
794 if(refresh < 0) refresh = -refresh;
798 refresh = atoi(refresh_str);
799 if(refresh < 0) refresh = -refresh;
805 const char *dim = buffer_tostring(dimensions);
806 if(*dim == '|') dim++;
813 if(options & RRDR_OPTION_PERCENTAGE)
819 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'"
822 , (dimensions)?buffer_tostring(dimensions):""
830 time_t latest_timestamp = 0;
831 int value_is_null = 1;
832 calculated_number n = 0;
835 // if the collected value is too old, don't calculate its value
836 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
837 ret = rrd2value(st, w->response.data, &n, dimensions, points, after, before, group, options, &latest_timestamp, &value_is_null);
839 // if the value cannot be calculated, show empty badge
846 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
849 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null, precision);
853 buffer_free(dimensions);
857 // returns the HTTP code
858 int web_client_api_request_v1_data(struct web_client *w, char *url)
860 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
863 BUFFER *dimensions = NULL;
865 buffer_flush(w->response.data);
867 char *google_version = "0.6",
870 *google_out = "json",
871 *responseHandler = NULL,
874 time_t last_timestamp_in_data = 0, google_timestamp = 0;
879 , *points_str = NULL;
881 int group = GROUP_AVERAGE;
882 uint32_t format = DATASOURCE_JSON;
883 uint32_t options = 0x00000000;
886 char *value = mystrsep(&url, "?&[]");
887 if(!value || !*value) continue;
889 char *name = mystrsep(&value, "=");
890 if(!name || !*name) continue;
891 if(!value || !*value) continue;
893 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
895 // name and value are now the parameters
896 // they are not null and not empty
898 if(!strcmp(name, "chart")) chart = value;
899 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
900 if(!dimensions) dimensions = buffer_create(strlen(value));
902 buffer_strcat(dimensions, "|");
903 buffer_strcat(dimensions, value);
906 else if(!strcmp(name, "after")) after_str = value;
907 else if(!strcmp(name, "before")) before_str = value;
908 else if(!strcmp(name, "points")) points_str = value;
909 else if(!strcmp(name, "group")) {
910 group = web_client_api_request_v1_data_group(value);
912 else if(!strcmp(name, "format")) {
913 format = web_client_api_request_v1_data_format(value);
915 else if(!strcmp(name, "options")) {
916 options |= web_client_api_request_v1_data_options(value);
918 else if(!strcmp(name, "callback")) {
919 responseHandler = value;
921 else if(!strcmp(name, "filename")) {
924 else if(!strcmp(name, "tqx")) {
925 // parse Google Visualization API options
926 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
927 char *tqx_name, *tqx_value;
930 tqx_value = mystrsep(&value, ";");
931 if(!tqx_value || !*tqx_value) continue;
933 tqx_name = mystrsep(&tqx_value, ":");
934 if(!tqx_name || !*tqx_name) continue;
935 if(!tqx_value || !*tqx_value) continue;
937 if(!strcmp(tqx_name, "version"))
938 google_version = tqx_value;
939 else if(!strcmp(tqx_name, "reqId"))
940 google_reqId = tqx_value;
941 else if(!strcmp(tqx_name, "sig")) {
942 google_sig = tqx_value;
943 google_timestamp = strtoul(google_sig, NULL, 0);
945 else if(!strcmp(tqx_name, "out")) {
946 google_out = tqx_value;
947 format = web_client_api_request_v1_data_google_format(google_out);
949 else if(!strcmp(tqx_name, "responseHandler"))
950 responseHandler = tqx_value;
951 else if(!strcmp(tqx_name, "outFileName"))
952 outFileName = tqx_value;
957 if(!chart || !*chart) {
958 buffer_sprintf(w->response.data, "No chart id is given at the request.");
962 RRDSET *st = rrdset_find(chart);
963 if(!st) st = rrdset_find_byname(chart);
965 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
970 long long before = (before_str && *before_str)?atol(before_str):0;
971 long long after = (after_str && *after_str) ?atol(after_str):0;
972 int points = (points_str && *points_str)?atoi(points_str):0;
974 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'"
977 , (dimensions)?buffer_tostring(dimensions):""
986 if(outFileName && *outFileName) {
987 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
988 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
991 if(format == DATASOURCE_DATATABLE_JSONP) {
992 if(responseHandler == NULL)
993 responseHandler = "google.visualization.Query.setResponse";
995 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
996 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
999 buffer_sprintf(w->response.data,
1000 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
1001 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1003 else if(format == DATASOURCE_JSONP) {
1004 if(responseHandler == NULL)
1005 responseHandler = "callback";
1007 buffer_strcat(w->response.data, responseHandler);
1008 buffer_strcat(w->response.data, "(");
1011 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1013 if(format == DATASOURCE_DATATABLE_JSONP) {
1014 if(google_timestamp < last_timestamp_in_data)
1015 buffer_strcat(w->response.data, "});");
1018 // the client already has the latest data
1019 buffer_flush(w->response.data);
1020 buffer_sprintf(w->response.data,
1021 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1022 responseHandler, google_version, google_reqId);
1025 else if(format == DATASOURCE_JSONP)
1026 buffer_strcat(w->response.data, ");");
1029 if(dimensions) buffer_free(dimensions);
1033 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1035 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1036 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1037 hash_to = 0 /*, hash_redirects = 0 */;
1039 if(unlikely(!hash_action)) {
1040 hash_action = simple_hash("action");
1041 hash_access = simple_hash("access");
1042 hash_hello = simple_hash("hello");
1043 hash_delete = simple_hash("delete");
1044 hash_search = simple_hash("search");
1045 hash_switch = simple_hash("switch");
1046 hash_machine = simple_hash("machine");
1047 hash_url = simple_hash("url");
1048 hash_name = simple_hash("name");
1049 hash_delete_url = simple_hash("delete_url");
1050 hash_for = simple_hash("for");
1051 hash_to = simple_hash("to");
1053 hash_redirects = simple_hash("redirects");
1057 char person_guid[36 + 1] = "";
1059 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1062 // The browser may send multiple cookies with our id
1064 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1066 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1069 char *machine_guid = NULL,
1070 *machine_url = NULL,
1072 *search_machine_guid = NULL,
1074 *to_person_guid = NULL;
1080 char *value = mystrsep(&url, "?&[]");
1081 if (!value || !*value) continue;
1083 char *name = mystrsep(&value, "=");
1084 if (!name || !*name) continue;
1085 if (!value || !*value) continue;
1087 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1089 uint32_t hash = simple_hash(name);
1091 if(hash == hash_action && !strcmp(name, "action")) {
1092 uint32_t vhash = simple_hash(value);
1094 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1095 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1096 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1097 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1098 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1099 #ifdef NETDATA_INTERNAL_CHECKS
1100 else error("unknown registry action '%s'", value);
1101 #endif /* NETDATA_INTERNAL_CHECKS */
1104 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1105 redirects = atoi(value);
1107 else if(hash == hash_machine && !strcmp(name, "machine"))
1108 machine_guid = value;
1110 else if(hash == hash_url && !strcmp(name, "url"))
1111 machine_url = value;
1113 else if(action == 'A') {
1114 if(hash == hash_name && !strcmp(name, "name"))
1117 else if(action == 'D') {
1118 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1121 else if(action == 'S') {
1122 if(hash == hash_for && !strcmp(name, "for"))
1123 search_machine_guid = value;
1125 else if(action == 'W') {
1126 if(hash == hash_to && !strcmp(name, "to"))
1127 to_person_guid = value;
1129 #ifdef NETDATA_INTERNAL_CHECKS
1130 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1131 #endif /* NETDATA_INTERNAL_CHECKS */
1134 if(web_donotrack_comply && w->donottrack) {
1135 buffer_flush(w->response.data);
1136 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.");
1140 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1141 buffer_flush(w->response.data);
1142 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1143 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1146 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1147 buffer_flush(w->response.data);
1148 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1149 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1152 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1153 buffer_flush(w->response.data);
1154 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1155 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1158 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1159 buffer_flush(w->response.data);
1160 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1161 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1167 w->tracking_required = 1;
1168 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1169 buffer_flush(w->response.data);
1171 registry_set_cookie(w, "give-me-back-this-cookie-please");
1172 w->response.data->contenttype = CT_APPLICATION_JSON;
1173 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1177 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1178 * under certain conditions, when using CORS
1179 * so this is commented and we use application level redirects instead
1183 if(redirects > registry_verify_cookies_redirects()) {
1184 buffer_flush(w->response.data);
1185 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1189 char *encoded_url = url_encode(machine_url);
1191 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1195 char *encoded_name = url_encode(url_name);
1198 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1202 char *encoded_guid = url_encode(machine_guid);
1206 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1210 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1211 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1219 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1222 w->tracking_required = 1;
1223 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1226 w->tracking_required = 1;
1227 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1230 w->tracking_required = 1;
1231 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1234 return registry_request_hello_json(w);
1237 buffer_flush(w->response.data);
1238 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1242 buffer_flush(w->response.data);
1243 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1247 int web_client_api_request_v1(struct web_client *w, char *url) {
1248 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1250 if(unlikely(hash_data == 0)) {
1251 hash_data = simple_hash("data");
1252 hash_chart = simple_hash("chart");
1253 hash_charts = simple_hash("charts");
1254 hash_registry = simple_hash("registry");
1255 hash_badge = simple_hash("badge.svg");
1259 char *tok = mystrsep(&url, "/?&");
1261 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1262 uint32_t hash = simple_hash(tok);
1264 if(hash == hash_data && !strcmp(tok, "data"))
1265 return web_client_api_request_v1_data(w, url);
1267 else if(hash == hash_chart && !strcmp(tok, "chart"))
1268 return web_client_api_request_v1_chart(w, url);
1270 else if(hash == hash_charts && !strcmp(tok, "charts"))
1271 return web_client_api_request_v1_charts(w, url);
1273 else if(hash == hash_registry && !strcmp(tok, "registry"))
1274 return web_client_api_request_v1_registry(w, url);
1276 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1277 return web_client_api_v1_badge(w, url);
1280 buffer_flush(w->response.data);
1281 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1286 buffer_flush(w->response.data);
1287 buffer_sprintf(w->response.data, "API v1 command?");
1292 int web_client_api_request(struct web_client *w, char *url)
1294 // get the api version
1295 char *tok = mystrsep(&url, "/?&");
1297 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1298 if(strcmp(tok, "v1") == 0)
1299 return web_client_api_request_v1(w, url);
1301 buffer_flush(w->response.data);
1302 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1307 buffer_flush(w->response.data);
1308 buffer_sprintf(w->response.data, "Which API version?");
1313 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1317 char *args = strchr(url, '?');
1323 // get the name of the data to show
1324 char *tok = mystrsep(&url, "/");
1326 // do we have such a data set?
1328 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1329 st = rrdset_find_byname(tok);
1330 if(!st) st = rrdset_find(tok);
1335 // try to send a file with that name
1336 buffer_flush(w->response.data);
1337 return(mysendfile(w, tok));
1341 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1343 // how many entries does the client want?
1344 int lines = rrd_default_history_entries;
1345 int group_count = 1;
1346 time_t after = 0, before = 0;
1347 int group_method = GROUP_AVERAGE;
1351 // parse the lines required
1352 tok = mystrsep(&url, "/");
1353 if(tok) lines = atoi(tok);
1354 if(lines < 1) lines = 1;
1357 // parse the group count required
1358 tok = mystrsep(&url, "/");
1359 if(tok && *tok) group_count = atoi(tok);
1360 if(group_count < 1) group_count = 1;
1361 //if(group_count > save_history / 20) group_count = save_history / 20;
1364 // parse the grouping method required
1365 tok = mystrsep(&url, "/");
1367 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1368 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1369 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1370 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1375 tok = mystrsep(&url, "/");
1376 if(tok && *tok) after = strtoul(tok, NULL, 10);
1377 if(after < 0) after = 0;
1380 // parse before time
1381 tok = mystrsep(&url, "/");
1382 if(tok && *tok) before = strtoul(tok, NULL, 10);
1383 if(before < 0) before = 0;
1387 tok = mystrsep(&url, "/");
1388 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1391 w->response.data->contenttype = CT_APPLICATION_JSON;
1392 buffer_flush(w->response.data);
1394 char *google_version = "0.6";
1395 char *google_reqId = "0";
1396 char *google_sig = "0";
1397 char *google_out = "json";
1398 char *google_responseHandler = "google.visualization.Query.setResponse";
1399 char *google_outFileName = NULL;
1400 time_t last_timestamp_in_data = 0;
1401 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1403 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1406 tok = mystrsep(&args, "&");
1408 char *name = mystrsep(&tok, "=");
1409 if(name && *name && strcmp(name, "tqx") == 0) {
1410 char *key = mystrsep(&tok, ":");
1411 char *value = mystrsep(&tok, ";");
1412 if(key && value && *key && *value) {
1413 if(strcmp(key, "version") == 0)
1414 google_version = value;
1416 else if(strcmp(key, "reqId") == 0)
1417 google_reqId = value;
1419 else if(strcmp(key, "sig") == 0)
1422 else if(strcmp(key, "out") == 0)
1425 else if(strcmp(key, "responseHandler") == 0)
1426 google_responseHandler = value;
1428 else if(strcmp(key, "outFileName") == 0)
1429 google_outFileName = value;
1435 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1436 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1439 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1440 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1442 // check the client wants json
1443 if(strcmp(google_out, "json") != 0) {
1444 buffer_sprintf(w->response.data,
1445 "%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.'}]});",
1446 google_responseHandler, google_version, google_reqId, google_out);
1452 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1453 buffer_sprintf(w->response.data,
1454 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
1455 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1458 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %lu after, %lu before).",
1459 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1461 time_t timestamp_in_data = rrd_stats_json(datasource_type, st, w->response.data, lines, group_count, group_method, (unsigned long)after, (unsigned long)before, nonzero);
1463 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1464 if(timestamp_in_data > last_timestamp_in_data)
1465 buffer_strcat(w->response.data, "});");
1468 // the client already has the latest data
1469 buffer_flush(w->response.data);
1470 buffer_sprintf(w->response.data,
1471 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1472 google_responseHandler, google_version, google_reqId);
1479 const char *web_content_type_to_string(uint8_t contenttype) {
1480 switch(contenttype) {
1482 return "text/html; charset=utf-8";
1484 case CT_APPLICATION_XML:
1485 return "application/xml; charset=utf-8";
1487 case CT_APPLICATION_JSON:
1488 return "application/json; charset=utf-8";
1490 case CT_APPLICATION_X_JAVASCRIPT:
1491 return "application/x-javascript; charset=utf-8";
1494 return "text/css; charset=utf-8";
1497 return "text/xml; charset=utf-8";
1500 return "text/xsl; charset=utf-8";
1502 case CT_APPLICATION_OCTET_STREAM:
1503 return "application/octet-stream";
1505 case CT_IMAGE_SVG_XML:
1506 return "image/svg+xml";
1508 case CT_APPLICATION_X_FONT_TRUETYPE:
1509 return "application/x-font-truetype";
1511 case CT_APPLICATION_X_FONT_OPENTYPE:
1512 return "application/x-font-opentype";
1514 case CT_APPLICATION_FONT_WOFF:
1515 return "application/font-woff";
1517 case CT_APPLICATION_FONT_WOFF2:
1518 return "application/font-woff2";
1520 case CT_APPLICATION_VND_MS_FONTOBJ:
1521 return "application/vnd.ms-fontobject";
1527 return "image/jpeg";
1532 case CT_IMAGE_XICON:
1533 return "image/x-icon";
1539 return "image/icns";
1543 return "text/plain; charset=utf-8";
1548 const char *web_response_code_to_string(int code) {
1554 return "Temporary Redirect";
1557 return "Bad Request";
1566 return "Preconditions Failed";
1569 if(code >= 100 && code < 200)
1570 return "Informational";
1572 if(code >= 200 && code < 300)
1573 return "Successful";
1575 if(code >= 300 && code < 400)
1576 return "Redirection";
1578 if(code >= 400 && code < 500)
1579 return "Bad Request";
1581 if(code >= 500 && code < 600)
1582 return "Server Error";
1584 return "Undefined Error";
1588 static inline char *http_header_parse(struct web_client *w, char *s) {
1589 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1591 if(unlikely(!hash_origin)) {
1592 hash_origin = simple_uhash("Origin");
1593 hash_connection = simple_uhash("Connection");
1594 hash_accept_encoding = simple_uhash("Accept-Encoding");
1595 hash_donottrack = simple_uhash("DNT");
1601 while(*e && *e != ':') e++;
1608 char *v = e + 1, *ve;
1610 // skip leading spaces from value
1611 while(*v == ' ') v++;
1615 while(*ve && *ve != '\r') ve++;
1616 if(!*ve || ve[1] != '\n') {
1621 // terminate the value
1624 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1625 uint32_t hash = simple_uhash(s);
1627 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1628 strncpyz(w->origin, v, ORIGIN_MAX);
1630 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1631 if(strcasestr(v, "keep-alive"))
1634 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1635 if(*v == '0') w->donottrack = 0;
1636 else if(*v == '1') w->donottrack = 1;
1638 #ifdef NETDATA_WITH_ZLIB
1639 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1640 if(web_enable_gzip) {
1641 if(strcasestr(v, "gzip"))
1642 web_client_enable_deflate(w, 1);
1644 // does not seem to work
1645 // else if(strcasestr(v, "deflate"))
1646 // web_client_enable_deflate(w, 0);
1649 #endif /* NETDATA_WITH_ZLIB */
1656 // http_request_validate()
1658 // = 0 : all good, process the request
1659 // > 0 : request is not supported
1660 // < 0 : request is incomplete - wait for more data
1662 static inline int http_request_validate(struct web_client *w) {
1663 char *s = w->response.data->buffer, *encoded_url = NULL;
1665 // is is a valid request?
1666 if(!strncmp(s, "GET ", 4)) {
1667 encoded_url = s = &s[4];
1668 w->mode = WEB_CLIENT_MODE_NORMAL;
1670 else if(!strncmp(s, "OPTIONS ", 8)) {
1671 encoded_url = s = &s[8];
1672 w->mode = WEB_CLIENT_MODE_OPTIONS;
1675 w->wait_receive = 0;
1679 // find the SPACE + "HTTP/"
1681 // find the next space
1682 while (*s && *s != ' ') s++;
1684 // is it SPACE + "HTTP/" ?
1685 if(*s && !strncmp(s, " HTTP/", 6)) break;
1689 // incomplete requests
1691 w->wait_receive = 1;
1695 // we have the end of encoded_url - remember it
1698 // make sure we have complete request
1699 // complete requests contain: \r\n\r\n
1702 while(*s && *s++ != '\r');
1704 // did we reach the end?
1705 if(unlikely(!*s)) break;
1708 if(likely(*s++ == '\n')) {
1710 // is it again \r\n ? (header end)
1711 if(unlikely(*s == '\r' && s[1] == '\n')) {
1712 // a valid complete HTTP request found
1715 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1718 // copy the URL - we are going to overwrite parts of it
1719 // FIXME -- we should avoid it
1720 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1722 w->wait_receive = 0;
1726 // another header line
1727 s = http_header_parse(w, s);
1731 // incomplete request
1732 w->wait_receive = 1;
1736 void web_client_process(struct web_client *w) {
1737 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1738 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1740 if(unlikely(!hash_api)) {
1741 hash_api = simple_hash("api");
1742 hash_netdata_conf = simple_hash("netdata.conf");
1743 hash_data = simple_hash(WEB_PATH_DATA);
1744 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1745 hash_graph = simple_hash(WEB_PATH_GRAPH);
1746 hash_list = simple_hash("list");
1747 hash_all_json = simple_hash("all.json");
1748 hash_exit = simple_hash("exit");
1749 hash_debug = simple_hash("debug");
1750 hash_mirror = simple_hash("mirror");
1756 int what_to_do = http_request_validate(w);
1758 // wait for more data
1759 if(what_to_do < 0) {
1760 if(w->response.data->len > TOO_BIG_REQUEST) {
1761 strcpy(w->last_url, "too big request");
1763 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zd bytes).", w->id, w->response.data->len);
1766 buffer_flush(w->response.data);
1767 buffer_sprintf(w->response.data, "Received request is too big (%zd bytes).\r\n", w->response.data->len);
1770 // wait for more data
1774 else if(what_to_do > 0) {
1775 strcpy(w->last_url, "not a valid request");
1777 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1780 buffer_flush(w->response.data);
1781 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1783 else { // what_to_do == 0
1784 gettimeofday(&w->tv_in, NULL);
1786 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1788 w->response.data->contenttype = CT_TEXT_PLAIN;
1789 buffer_flush(w->response.data);
1790 buffer_strcat(w->response.data, "OK");
1793 char *url = w->decoded_url;
1794 char *tok = mystrsep(&url, "/?");
1796 uint32_t hash = simple_hash(tok);
1797 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1799 if(hash == hash_api && strcmp(tok, "api") == 0) {
1800 // the client is requesting api access
1801 code = web_client_api_request(w, url);
1803 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1805 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1807 w->response.data->contenttype = CT_TEXT_PLAIN;
1808 buffer_flush(w->response.data);
1809 generate_config(w->response.data, 0);
1811 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1812 // the client is requesting rrd data -- OLD API
1813 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1815 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1816 // the client is requesting google datasource -- OLD API
1817 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1819 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1820 // the client is requesting an rrd graph -- OLD API
1822 // get the name of the data to show
1823 tok = mystrsep(&url, "/?&");
1825 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1827 // do we have such a data set?
1828 RRDSET *st = rrdset_find_byname(tok);
1829 if(!st) st = rrdset_find(tok);
1832 // try to send a file with that name
1833 buffer_flush(w->response.data);
1834 code = mysendfile(w, tok);
1838 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1839 w->response.data->contenttype = CT_APPLICATION_JSON;
1840 buffer_flush(w->response.data);
1841 rrd_stats_graph_json(st, url, w->response.data);
1846 buffer_flush(w->response.data);
1847 buffer_strcat(w->response.data, "Graph name?\r\n");
1850 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1854 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1856 buffer_flush(w->response.data);
1857 RRDSET *st = rrdset_root;
1859 for ( ; st ; st = st->next )
1860 buffer_sprintf(w->response.data, "%s\n", st->name);
1862 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1865 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1867 w->response.data->contenttype = CT_APPLICATION_JSON;
1868 buffer_flush(w->response.data);
1869 rrd_stats_all_json(w->response.data);
1871 #ifdef NETDATA_INTERNAL_CHECKS
1872 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1874 w->response.data->contenttype = CT_TEXT_PLAIN;
1875 buffer_flush(w->response.data);
1878 buffer_strcat(w->response.data, "ok, will do...");
1880 buffer_strcat(w->response.data, "I am doing it already");
1882 error("web request to exit received.");
1885 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1886 buffer_flush(w->response.data);
1888 // get the name of the data to show
1889 tok = mystrsep(&url, "/?&");
1891 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1893 // do we have such a data set?
1894 RRDSET *st = rrdset_find_byname(tok);
1895 if(!st) st = rrdset_find(tok);
1898 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1899 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1903 debug_flags |= D_RRD_STATS;
1904 st->debug = !st->debug;
1905 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1906 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1911 buffer_flush(w->response.data);
1912 buffer_strcat(w->response.data, "debug which chart?\r\n");
1915 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1918 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1920 // replace the zero bytes with spaces
1921 buffer_char_replace(w->response.data, '\0', ' ');
1923 // just leave the buffer as is
1924 // it will be copied back to the client
1926 #endif /* NETDATA_INTERNAL_CHECKS */
1928 char filename[FILENAME_MAX+1];
1930 strncpyz(filename, w->last_url, FILENAME_MAX);
1931 tok = mystrsep(&url, "?");
1932 buffer_flush(w->response.data);
1933 code = mysendfile(w, (tok && *tok)?tok:"/");
1937 char filename[FILENAME_MAX+1];
1939 strncpyz(filename, w->last_url, FILENAME_MAX);
1940 tok = mystrsep(&url, "?");
1941 buffer_flush(w->response.data);
1942 code = mysendfile(w, (tok && *tok)?tok:"/");
1947 gettimeofday(&w->tv_ready, NULL);
1948 w->response.data->date = time(NULL);
1949 w->response.sent = 0;
1950 w->response.code = code;
1952 // prepare the HTTP response header
1953 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1955 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1956 const char *code_msg = web_response_code_to_string(code);
1959 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1960 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1962 buffer_sprintf(w->response.header_output,
1963 "HTTP/1.1 %d %s\r\n"
1964 "Connection: %s\r\n"
1965 "Server: NetData Embedded HTTP Server\r\n"
1966 "Access-Control-Allow-Origin: %s\r\n"
1967 "Access-Control-Allow-Credentials: true\r\n"
1968 "Content-Type: %s\r\n"
1971 , w->keepalive?"keep-alive":"close"
1973 , content_type_string
1977 if(w->cookie1[0] || w->cookie2[0]) {
1979 buffer_sprintf(w->response.header_output,
1980 "Set-Cookie: %s\r\n",
1985 buffer_sprintf(w->response.header_output,
1986 "Set-Cookie: %s\r\n",
1990 if(web_donotrack_comply)
1991 buffer_sprintf(w->response.header_output,
1992 "Tk: T;cookies\r\n");
1995 if(web_donotrack_comply) {
1996 if(w->tracking_required)
1997 buffer_sprintf(w->response.header_output,
1998 "Tk: T;cookies\r\n");
2000 buffer_sprintf(w->response.header_output,
2005 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2006 buffer_strcat(w->response.header_output,
2007 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2008 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
2009 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2013 if(buffer_strlen(w->response.header))
2014 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2016 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
2017 buffer_sprintf(w->response.header_output,
2019 "Cache-Control: no-cache\r\n"
2022 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
2024 time_t et = w->response.data->date + (86400 * 14);
2025 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
2026 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
2028 buffer_sprintf(w->response.header_output,
2030 "Cache-Control: public\r\n"
2034 // if we know the content length, put it
2035 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
2036 buffer_sprintf(w->response.header_output,
2037 "Content-Length: %ld\r\n"
2038 , w->response.data->len? w->response.data->len: w->response.rlen
2040 else if(!w->response.zoutput)
2041 w->keepalive = 0; // content-length is required for keep-alive
2043 if(w->response.zoutput) {
2044 buffer_strcat(w->response.header_output,
2045 "Content-Encoding: gzip\r\n"
2046 "Transfer-Encoding: chunked\r\n"
2050 buffer_strcat(w->response.header_output, "\r\n");
2052 // sent the HTTP header
2053 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %d: '%s'"
2055 , buffer_strlen(w->response.header_output)
2056 , buffer_tostring(w->response.header_output)
2059 web_client_crock_socket(w);
2061 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2062 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2064 w->stats_sent_bytes += bytes;
2066 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,
2067 buffer_strlen(w->response.header_output), bytes);
2069 WEB_CLIENT_IS_DEAD(w);
2073 w->stats_sent_bytes += bytes;
2075 // enable sending immediately if we have data
2076 if(w->response.data->len) w->wait_send = 1;
2077 else w->wait_send = 0;
2081 case WEB_CLIENT_MODE_OPTIONS:
2082 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%d bytes) to client.", w->id, w->response.data->len);
2085 case WEB_CLIENT_MODE_NORMAL:
2086 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%d bytes) to client.", w->id, w->response.data->len);
2089 case WEB_CLIENT_MODE_FILECOPY:
2090 if(w->response.rlen) {
2091 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %d bytes to client.", w->id, w->response.rlen);
2092 w->wait_receive = 1;
2095 // utilize the kernel sendfile() for copying the file to the socket.
2096 // this block of code can be commented, without anything missing.
2097 // when it is commented, the program will copy the data using async I/O.
2099 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2100 if(len != w->response.data->rbytes)
2101 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2103 web_client_reset(w);
2108 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2112 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2117 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2119 debug(D_DEFLATE, "%llu: OPEN CHUNK of %d bytes (hex: %x).", w->id, len, len);
2121 sprintf(buf, "%zX\r\n", len);
2123 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2125 debug(D_DEFLATE, "%llu: Sent chunk header %d bytes.", w->id, bytes);
2126 w->stats_sent_bytes += bytes;
2129 else if(bytes == 0) {
2130 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2131 WEB_CLIENT_IS_DEAD(w);
2134 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2135 WEB_CLIENT_IS_DEAD(w);
2141 ssize_t web_client_send_chunk_close(struct web_client *w)
2143 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2145 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2147 debug(D_DEFLATE, "%llu: Sent chunk suffix %d bytes.", w->id, bytes);
2148 w->stats_sent_bytes += bytes;
2151 else if(bytes == 0) {
2152 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2153 WEB_CLIENT_IS_DEAD(w);
2156 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2157 WEB_CLIENT_IS_DEAD(w);
2163 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2165 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2167 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2169 debug(D_DEFLATE, "%llu: Sent chunk suffix %d bytes.", w->id, bytes);
2170 w->stats_sent_bytes += bytes;
2173 else if(bytes == 0) {
2174 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2175 WEB_CLIENT_IS_DEAD(w);
2178 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2179 WEB_CLIENT_IS_DEAD(w);
2185 #ifdef NETDATA_WITH_ZLIB
2186 ssize_t web_client_send_deflate(struct web_client *w)
2188 ssize_t len = 0, t = 0;
2190 // when using compression,
2191 // w->response.sent is the amount of bytes passed through compression
2193 debug(D_DEFLATE, "%llu: web_client_send_deflate(): w->response.data->len = %d, w->response.sent = %d, w->response.zhave = %zu, w->response.zsent = %zu, w->response.zstream.avail_in = %d, w->response.zstream.avail_out = %d, w->response.zstream.total_in = %d, w->response.zstream.total_out = %d.",
2194 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);
2196 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) {
2197 // there is nothing to send
2199 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2201 // finalize the chunk
2202 if(w->response.sent != 0) {
2203 t = web_client_send_chunk_finalize(w);
2207 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2208 // we have to wait, more data will come
2209 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2214 if(unlikely(!w->keepalive)) {
2215 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2216 WEB_CLIENT_IS_DEAD(w);
2221 web_client_reset(w);
2222 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2226 if(w->response.zhave == w->response.zsent) {
2227 // compress more input data
2229 // close the previous open chunk
2230 if(w->response.sent != 0) {
2231 t = web_client_send_chunk_close(w);
2235 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);
2237 // give the compressor all the data not passed through the compressor yet
2238 if(w->response.data->len > w->response.sent) {
2239 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2240 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2243 // reset the compressor output buffer
2244 w->response.zstream.next_out = w->response.zbuffer;
2245 w->response.zstream.avail_out = ZLIB_CHUNK;
2247 // ask for FINISH if we have all the input
2248 int flush = Z_SYNC_FLUSH;
2249 if(w->mode == WEB_CLIENT_MODE_NORMAL
2250 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2252 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2255 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2259 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2260 error("%llu: Compression failed. Closing down client.", w->id);
2261 web_client_reset(w);
2265 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2266 w->response.zsent = 0;
2268 // keep track of the bytes passed through the compressor
2269 w->response.sent = w->response.data->len;
2271 debug(D_DEFLATE, "%llu: Compression produced %d bytes.", w->id, w->response.zhave);
2274 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2275 if(t2 < 0) return t2;
2279 debug(D_WEB_CLIENT, "%llu: Sending %d bytes of data (+%d of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2281 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2283 w->stats_sent_bytes += len;
2284 w->response.zsent += len;
2286 debug(D_WEB_CLIENT, "%llu: Sent %d bytes.", w->id, len);
2289 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2290 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2292 WEB_CLIENT_IS_DEAD(w);
2295 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2296 WEB_CLIENT_IS_DEAD(w);
2301 #endif // NETDATA_WITH_ZLIB
2303 ssize_t web_client_send(struct web_client *w) {
2304 #ifdef NETDATA_WITH_ZLIB
2305 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2306 #endif // NETDATA_WITH_ZLIB
2310 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2311 // there is nothing to send
2313 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2315 // there can be two cases for this
2316 // A. we have done everything
2317 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2319 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2320 // we have to wait, more data will come
2321 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2326 if(unlikely(!w->keepalive)) {
2327 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2328 WEB_CLIENT_IS_DEAD(w);
2332 web_client_reset(w);
2333 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2337 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2338 if(likely(bytes > 0)) {
2339 w->stats_sent_bytes += bytes;
2340 w->response.sent += bytes;
2341 debug(D_WEB_CLIENT, "%llu: Sent %d bytes.", w->id, bytes);
2343 else if(likely(bytes == 0)) {
2344 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2345 WEB_CLIENT_IS_DEAD(w);
2348 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2349 WEB_CLIENT_IS_DEAD(w);
2355 ssize_t web_client_receive(struct web_client *w)
2357 // do we have any space for more data?
2358 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2360 ssize_t left = w->response.data->size - w->response.data->len;
2363 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2364 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2366 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2368 if(likely(bytes > 0)) {
2369 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2370 w->stats_received_bytes += bytes;
2372 size_t old = w->response.data->len;
2373 w->response.data->len += bytes;
2374 w->response.data->buffer[w->response.data->len] = '\0';
2376 debug(D_WEB_CLIENT, "%llu: Received %d bytes.", w->id, bytes);
2377 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2379 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2382 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2383 w->wait_receive = 0;
2386 else if(likely(bytes == 0)) {
2387 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2389 // if we cannot read, it means we have an error on input.
2390 // if however, we are copying a file from ifd to ofd, we should not return an error.
2391 // in this case, the error should be generated when the file has been sent to the client.
2393 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2394 // we are copying data from ifd to ofd
2395 // let it finish copying...
2396 w->wait_receive = 0;
2398 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2399 if(w->ifd != w->ofd) close(w->ifd);
2403 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2404 WEB_CLIENT_IS_DEAD(w);
2408 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2409 WEB_CLIENT_IS_DEAD(w);
2416 // --------------------------------------------------------------------------------------
2417 // the thread of a single client
2419 // 1. waits for input and output, using async I/O
2420 // 2. it processes HTTP requests
2421 // 3. it generates HTTP responses
2422 // 4. it copies data from input to output if mode is FILECOPY
2424 void *web_client_main(void *ptr)
2426 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2427 error("Cannot set pthread cancel type to DEFERRED.");
2429 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2430 error("Cannot set pthread cancel state to ENABLE.");
2432 struct web_client *w = ptr;
2433 struct pollfd fds[2], *ifd, *ofd;
2434 int retval, fdmax = 0, timeout;
2436 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2439 if(unlikely(w->dead)) {
2440 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2443 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2444 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.");
2448 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2449 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2453 if(w->ifd == w->ofd) {
2458 if(w->wait_receive) fds[0].events |= POLLIN;
2459 if(w->wait_send) fds[0].events |= POLLOUT;
2465 ifd = ofd = &fds[0];
2473 if(w->wait_receive) fds[0].events |= POLLIN;
2479 if(w->wait_send) fds[1].events |= POLLOUT;
2485 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2487 timeout = web_client_timeout * 1000;
2488 retval = poll(fds, fdmax, timeout);
2490 if(unlikely(retval == -1)) {
2491 if(errno == EAGAIN || errno == EINTR) {
2492 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2496 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2499 else if(unlikely(!retval)) {
2500 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":"");
2505 if(w->wait_send && ofd->revents & POLLOUT) {
2507 if(web_client_send(w) < 0) {
2508 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2513 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2515 if(web_client_receive(w) < 0) {
2516 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2520 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2521 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2522 web_client_process(w);
2526 if(unlikely(!used)) {
2527 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2532 web_client_reset(w);
2534 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2535 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2537 // close the sockets/files now
2538 // to free file descriptors
2539 if(w->ifd == w->ofd) {
2540 if(w->ifd != -1) close(w->ifd);
2543 if(w->ifd != -1) close(w->ifd);
2544 if(w->ofd != -1) close(w->ofd);