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) {
699 buffer_flush(w->response.data);
701 BUFFER *dimensions = NULL;
703 const char *chart = NULL
707 , *multiply_str = NULL
711 , *label_color = NULL
712 , *value_color = NULL
713 , *refresh_str = NULL
714 , *precision_str = NULL;
716 int group = GROUP_AVERAGE;
717 uint32_t options = 0x00000000;
720 char *value = mystrsep(&url, "/?&[]");
721 if(!value || !*value) continue;
723 char *name = mystrsep(&value, "=");
724 if(!name || !*name) continue;
725 if(!value || !*value) continue;
727 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
729 // name and value are now the parameters
730 // they are not null and not empty
732 if(!strcmp(name, "chart")) chart = value;
733 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
735 dimensions = buffer_create(strlen(value));
738 buffer_strcat(dimensions, "|");
739 buffer_strcat(dimensions, value);
742 else if(!strcmp(name, "after")) after_str = value;
743 else if(!strcmp(name, "before")) before_str = value;
744 else if(!strcmp(name, "points")) points_str = value;
745 else if(!strcmp(name, "group")) {
746 group = web_client_api_request_v1_data_group(value);
748 else if(!strcmp(name, "options")) {
749 options |= web_client_api_request_v1_data_options(value);
751 else if(!strcmp(name, "label")) label = value;
752 else if(!strcmp(name, "units")) units = value;
753 else if(!strcmp(name, "label_color")) label_color = value;
754 else if(!strcmp(name, "value_color")) value_color = value;
755 else if(!strcmp(name, "multiply")) multiply_str = value;
756 else if(!strcmp(name, "divide")) divide_str = value;
757 else if(!strcmp(name, "refresh")) refresh_str = value;
758 else if(!strcmp(name, "precision")) precision_str = value;
761 if(!chart || !*chart) {
762 buffer_sprintf(w->response.data, "No chart id is given at the request.");
766 RRDSET *st = rrdset_find(chart);
767 if(!st) st = rrdset_find_byname(chart);
769 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
774 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
775 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
776 long long before = (before_str && *before_str )?atol(before_str):0;
777 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
778 int points = (points_str && *points_str )?atoi(points_str):1;
779 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
782 if(refresh_str && *refresh_str) {
783 if(!strcmp(refresh_str, "auto")) {
784 if(options & RRDR_OPTION_NOT_ALIGNED)
785 refresh = st->update_every;
787 refresh = (before - after);
788 if(refresh < 0) refresh = -refresh;
792 refresh = atoi(refresh_str);
793 if(refresh < 0) refresh = -refresh;
799 const char *dim = buffer_tostring(dimensions);
800 if(*dim == '|') dim++;
807 if(options & RRDR_OPTION_PERCENTAGE)
813 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'"
816 , (dimensions)?buffer_tostring(dimensions):""
824 time_t latest_timestamp = 0;
825 int value_is_null = 1;
826 calculated_number n = 0;
829 // if the collected value is too old, don't calculate its value
830 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
831 ret = rrd2value(st, w->response.data, &n, dimensions, points, after, before, group, options, &latest_timestamp, &value_is_null);
833 // if the value cannot be calculated, show empty badge
840 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
843 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null, precision);
847 buffer_free(dimensions);
851 // returns the HTTP code
852 int web_client_api_request_v1_data(struct web_client *w, char *url)
854 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
857 BUFFER *dimensions = NULL;
859 buffer_flush(w->response.data);
861 char *google_version = "0.6",
864 *google_out = "json",
865 *responseHandler = NULL,
868 time_t last_timestamp_in_data = 0, google_timestamp = 0;
873 , *points_str = NULL;
875 int group = GROUP_AVERAGE;
876 uint32_t format = DATASOURCE_JSON;
877 uint32_t options = 0x00000000;
880 char *value = mystrsep(&url, "?&[]");
881 if(!value || !*value) continue;
883 char *name = mystrsep(&value, "=");
884 if(!name || !*name) continue;
885 if(!value || !*value) continue;
887 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
889 // name and value are now the parameters
890 // they are not null and not empty
892 if(!strcmp(name, "chart")) chart = value;
893 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
894 if(!dimensions) dimensions = buffer_create(strlen(value));
896 buffer_strcat(dimensions, "|");
897 buffer_strcat(dimensions, value);
900 else if(!strcmp(name, "after")) after_str = value;
901 else if(!strcmp(name, "before")) before_str = value;
902 else if(!strcmp(name, "points")) points_str = value;
903 else if(!strcmp(name, "group")) {
904 group = web_client_api_request_v1_data_group(value);
906 else if(!strcmp(name, "format")) {
907 format = web_client_api_request_v1_data_format(value);
909 else if(!strcmp(name, "options")) {
910 options |= web_client_api_request_v1_data_options(value);
912 else if(!strcmp(name, "callback")) {
913 responseHandler = value;
915 else if(!strcmp(name, "filename")) {
918 else if(!strcmp(name, "tqx")) {
919 // parse Google Visualization API options
920 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
921 char *tqx_name, *tqx_value;
924 tqx_value = mystrsep(&value, ";");
925 if(!tqx_value || !*tqx_value) continue;
927 tqx_name = mystrsep(&tqx_value, ":");
928 if(!tqx_name || !*tqx_name) continue;
929 if(!tqx_value || !*tqx_value) continue;
931 if(!strcmp(tqx_name, "version"))
932 google_version = tqx_value;
933 else if(!strcmp(tqx_name, "reqId"))
934 google_reqId = tqx_value;
935 else if(!strcmp(tqx_name, "sig")) {
936 google_sig = tqx_value;
937 google_timestamp = strtoul(google_sig, NULL, 0);
939 else if(!strcmp(tqx_name, "out")) {
940 google_out = tqx_value;
941 format = web_client_api_request_v1_data_google_format(google_out);
943 else if(!strcmp(tqx_name, "responseHandler"))
944 responseHandler = tqx_value;
945 else if(!strcmp(tqx_name, "outFileName"))
946 outFileName = tqx_value;
951 if(!chart || !*chart) {
952 buffer_sprintf(w->response.data, "No chart id is given at the request.");
956 RRDSET *st = rrdset_find(chart);
957 if(!st) st = rrdset_find_byname(chart);
959 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
964 long long before = (before_str && *before_str)?atol(before_str):0;
965 long long after = (after_str && *after_str) ?atol(after_str):0;
966 int points = (points_str && *points_str)?atoi(points_str):0;
968 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'"
971 , (dimensions)?buffer_tostring(dimensions):""
980 if(outFileName && *outFileName) {
981 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
982 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
985 if(format == DATASOURCE_DATATABLE_JSONP) {
986 if(responseHandler == NULL)
987 responseHandler = "google.visualization.Query.setResponse";
989 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
990 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
993 buffer_sprintf(w->response.data,
994 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
995 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
997 else if(format == DATASOURCE_JSONP) {
998 if(responseHandler == NULL)
999 responseHandler = "callback";
1001 buffer_strcat(w->response.data, responseHandler);
1002 buffer_strcat(w->response.data, "(");
1005 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1007 if(format == DATASOURCE_DATATABLE_JSONP) {
1008 if(google_timestamp < last_timestamp_in_data)
1009 buffer_strcat(w->response.data, "});");
1012 // the client already has the latest data
1013 buffer_flush(w->response.data);
1014 buffer_sprintf(w->response.data,
1015 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1016 responseHandler, google_version, google_reqId);
1019 else if(format == DATASOURCE_JSONP)
1020 buffer_strcat(w->response.data, ");");
1023 if(dimensions) buffer_free(dimensions);
1027 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1029 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1030 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1031 hash_to = 0 /*, hash_redirects = 0 */;
1033 if(unlikely(!hash_action)) {
1034 hash_action = simple_hash("action");
1035 hash_access = simple_hash("access");
1036 hash_hello = simple_hash("hello");
1037 hash_delete = simple_hash("delete");
1038 hash_search = simple_hash("search");
1039 hash_switch = simple_hash("switch");
1040 hash_machine = simple_hash("machine");
1041 hash_url = simple_hash("url");
1042 hash_name = simple_hash("name");
1043 hash_delete_url = simple_hash("delete_url");
1044 hash_for = simple_hash("for");
1045 hash_to = simple_hash("to");
1047 hash_redirects = simple_hash("redirects");
1051 char person_guid[36 + 1] = "";
1053 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1056 // The browser may send multiple cookies with our id
1058 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1060 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1063 char *machine_guid = NULL,
1064 *machine_url = NULL,
1066 *search_machine_guid = NULL,
1068 *to_person_guid = NULL;
1074 char *value = mystrsep(&url, "?&[]");
1075 if (!value || !*value) continue;
1077 char *name = mystrsep(&value, "=");
1078 if (!name || !*name) continue;
1079 if (!value || !*value) continue;
1081 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1083 uint32_t hash = simple_hash(name);
1085 if(hash == hash_action && !strcmp(name, "action")) {
1086 uint32_t vhash = simple_hash(value);
1088 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1089 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1090 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1091 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1092 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1093 #ifdef NETDATA_INTERNAL_CHECKS
1094 else error("unknown registry action '%s'", value);
1095 #endif /* NETDATA_INTERNAL_CHECKS */
1098 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1099 redirects = atoi(value);
1101 else if(hash == hash_machine && !strcmp(name, "machine"))
1102 machine_guid = value;
1104 else if(hash == hash_url && !strcmp(name, "url"))
1105 machine_url = value;
1107 else if(action == 'A') {
1108 if(hash == hash_name && !strcmp(name, "name"))
1111 else if(action == 'D') {
1112 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1115 else if(action == 'S') {
1116 if(hash == hash_for && !strcmp(name, "for"))
1117 search_machine_guid = value;
1119 else if(action == 'W') {
1120 if(hash == hash_to && !strcmp(name, "to"))
1121 to_person_guid = value;
1123 #ifdef NETDATA_INTERNAL_CHECKS
1124 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1125 #endif /* NETDATA_INTERNAL_CHECKS */
1128 if(web_donotrack_comply && w->donottrack) {
1129 buffer_flush(w->response.data);
1130 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.");
1134 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1135 buffer_flush(w->response.data);
1136 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1137 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1140 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1141 buffer_flush(w->response.data);
1142 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1143 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1146 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1147 buffer_flush(w->response.data);
1148 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1149 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1152 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1153 buffer_flush(w->response.data);
1154 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1155 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1161 w->tracking_required = 1;
1162 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1163 buffer_flush(w->response.data);
1165 registry_set_cookie(w, "give-me-back-this-cookie-please");
1166 w->response.data->contenttype = CT_APPLICATION_JSON;
1167 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1171 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1172 * under certain conditions, when using CORS
1173 * so this is commented and we use application level redirects instead
1177 if(redirects > registry_verify_cookies_redirects()) {
1178 buffer_flush(w->response.data);
1179 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1183 char *encoded_url = url_encode(machine_url);
1185 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1189 char *encoded_name = url_encode(url_name);
1192 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1196 char *encoded_guid = url_encode(machine_guid);
1200 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1204 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1205 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1213 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1216 w->tracking_required = 1;
1217 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1220 w->tracking_required = 1;
1221 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1224 w->tracking_required = 1;
1225 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1228 return registry_request_hello_json(w);
1231 buffer_flush(w->response.data);
1232 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1236 buffer_flush(w->response.data);
1237 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1241 int web_client_api_request_v1(struct web_client *w, char *url) {
1242 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1244 if(unlikely(hash_data == 0)) {
1245 hash_data = simple_hash("data");
1246 hash_chart = simple_hash("chart");
1247 hash_charts = simple_hash("charts");
1248 hash_registry = simple_hash("registry");
1249 hash_badge = simple_hash("badge.svg");
1253 char *tok = mystrsep(&url, "/?&");
1255 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1256 uint32_t hash = simple_hash(tok);
1258 if(hash == hash_data && !strcmp(tok, "data"))
1259 return web_client_api_request_v1_data(w, url);
1261 else if(hash == hash_chart && !strcmp(tok, "chart"))
1262 return web_client_api_request_v1_chart(w, url);
1264 else if(hash == hash_charts && !strcmp(tok, "charts"))
1265 return web_client_api_request_v1_charts(w, url);
1267 else if(hash == hash_registry && !strcmp(tok, "registry"))
1268 return web_client_api_request_v1_registry(w, url);
1270 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1271 return web_client_api_v1_badge(w, url);
1274 buffer_flush(w->response.data);
1275 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1280 buffer_flush(w->response.data);
1281 buffer_sprintf(w->response.data, "API v1 command?");
1286 int web_client_api_request(struct web_client *w, char *url)
1288 // get the api version
1289 char *tok = mystrsep(&url, "/?&");
1291 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1292 if(strcmp(tok, "v1") == 0)
1293 return web_client_api_request_v1(w, url);
1295 buffer_flush(w->response.data);
1296 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1301 buffer_flush(w->response.data);
1302 buffer_sprintf(w->response.data, "Which API version?");
1307 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1311 char *args = strchr(url, '?');
1317 // get the name of the data to show
1318 char *tok = mystrsep(&url, "/");
1320 // do we have such a data set?
1322 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1323 st = rrdset_find_byname(tok);
1324 if(!st) st = rrdset_find(tok);
1329 // try to send a file with that name
1330 buffer_flush(w->response.data);
1331 return(mysendfile(w, tok));
1335 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1337 // how many entries does the client want?
1338 int lines = rrd_default_history_entries;
1339 int group_count = 1;
1340 time_t after = 0, before = 0;
1341 int group_method = GROUP_AVERAGE;
1345 // parse the lines required
1346 tok = mystrsep(&url, "/");
1347 if(tok) lines = atoi(tok);
1348 if(lines < 1) lines = 1;
1351 // parse the group count required
1352 tok = mystrsep(&url, "/");
1353 if(tok && *tok) group_count = atoi(tok);
1354 if(group_count < 1) group_count = 1;
1355 //if(group_count > save_history / 20) group_count = save_history / 20;
1358 // parse the grouping method required
1359 tok = mystrsep(&url, "/");
1361 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1362 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1363 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1364 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1369 tok = mystrsep(&url, "/");
1370 if(tok && *tok) after = strtoul(tok, NULL, 10);
1371 if(after < 0) after = 0;
1374 // parse before time
1375 tok = mystrsep(&url, "/");
1376 if(tok && *tok) before = strtoul(tok, NULL, 10);
1377 if(before < 0) before = 0;
1381 tok = mystrsep(&url, "/");
1382 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1385 w->response.data->contenttype = CT_APPLICATION_JSON;
1386 buffer_flush(w->response.data);
1388 char *google_version = "0.6";
1389 char *google_reqId = "0";
1390 char *google_sig = "0";
1391 char *google_out = "json";
1392 char *google_responseHandler = "google.visualization.Query.setResponse";
1393 char *google_outFileName = NULL;
1394 time_t last_timestamp_in_data = 0;
1395 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1397 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1400 tok = mystrsep(&args, "&");
1402 char *name = mystrsep(&tok, "=");
1403 if(name && *name && strcmp(name, "tqx") == 0) {
1404 char *key = mystrsep(&tok, ":");
1405 char *value = mystrsep(&tok, ";");
1406 if(key && value && *key && *value) {
1407 if(strcmp(key, "version") == 0)
1408 google_version = value;
1410 else if(strcmp(key, "reqId") == 0)
1411 google_reqId = value;
1413 else if(strcmp(key, "sig") == 0)
1416 else if(strcmp(key, "out") == 0)
1419 else if(strcmp(key, "responseHandler") == 0)
1420 google_responseHandler = value;
1422 else if(strcmp(key, "outFileName") == 0)
1423 google_outFileName = value;
1429 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1430 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1433 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1434 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1436 // check the client wants json
1437 if(strcmp(google_out, "json") != 0) {
1438 buffer_sprintf(w->response.data,
1439 "%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.'}]});",
1440 google_responseHandler, google_version, google_reqId, google_out);
1446 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1447 buffer_sprintf(w->response.data,
1448 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%lu',table:",
1449 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1452 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %lu after, %lu before).",
1453 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1455 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);
1457 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1458 if(timestamp_in_data > last_timestamp_in_data)
1459 buffer_strcat(w->response.data, "});");
1462 // the client already has the latest data
1463 buffer_flush(w->response.data);
1464 buffer_sprintf(w->response.data,
1465 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1466 google_responseHandler, google_version, google_reqId);
1473 const char *web_content_type_to_string(uint8_t contenttype) {
1474 switch(contenttype) {
1476 return "text/html; charset=utf-8";
1478 case CT_APPLICATION_XML:
1479 return "application/xml; charset=utf-8";
1481 case CT_APPLICATION_JSON:
1482 return "application/json; charset=utf-8";
1484 case CT_APPLICATION_X_JAVASCRIPT:
1485 return "application/x-javascript; charset=utf-8";
1488 return "text/css; charset=utf-8";
1491 return "text/xml; charset=utf-8";
1494 return "text/xsl; charset=utf-8";
1496 case CT_APPLICATION_OCTET_STREAM:
1497 return "application/octet-stream";
1499 case CT_IMAGE_SVG_XML:
1500 return "image/svg+xml";
1502 case CT_APPLICATION_X_FONT_TRUETYPE:
1503 return "application/x-font-truetype";
1505 case CT_APPLICATION_X_FONT_OPENTYPE:
1506 return "application/x-font-opentype";
1508 case CT_APPLICATION_FONT_WOFF:
1509 return "application/font-woff";
1511 case CT_APPLICATION_FONT_WOFF2:
1512 return "application/font-woff2";
1514 case CT_APPLICATION_VND_MS_FONTOBJ:
1515 return "application/vnd.ms-fontobject";
1521 return "image/jpeg";
1526 case CT_IMAGE_XICON:
1527 return "image/x-icon";
1533 return "image/icns";
1537 return "text/plain; charset=utf-8";
1542 const char *web_response_code_to_string(int code) {
1548 return "Temporary Redirect";
1551 return "Bad Request";
1560 return "Preconditions Failed";
1563 if(code >= 100 && code < 200)
1564 return "Informational";
1566 if(code >= 200 && code < 300)
1567 return "Successful";
1569 if(code >= 300 && code < 400)
1570 return "Redirection";
1572 if(code >= 400 && code < 500)
1573 return "Bad Request";
1575 if(code >= 500 && code < 600)
1576 return "Server Error";
1578 return "Undefined Error";
1582 static inline char *http_header_parse(struct web_client *w, char *s) {
1583 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1585 if(unlikely(!hash_origin)) {
1586 hash_origin = simple_uhash("Origin");
1587 hash_connection = simple_uhash("Connection");
1588 hash_accept_encoding = simple_uhash("Accept-Encoding");
1589 hash_donottrack = simple_uhash("DNT");
1595 while(*e && *e != ':') e++;
1602 char *v = e + 1, *ve;
1604 // skip leading spaces from value
1605 while(*v == ' ') v++;
1609 while(*ve && *ve != '\r') ve++;
1610 if(!*ve || ve[1] != '\n') {
1615 // terminate the value
1618 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1619 uint32_t hash = simple_uhash(s);
1621 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1622 strncpyz(w->origin, v, ORIGIN_MAX);
1624 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1625 if(strcasestr(v, "keep-alive"))
1628 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1629 if(*v == '0') w->donottrack = 0;
1630 else if(*v == '1') w->donottrack = 1;
1632 #ifdef NETDATA_WITH_ZLIB
1633 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1634 if(web_enable_gzip) {
1635 if(strcasestr(v, "gzip"))
1636 web_client_enable_deflate(w, 1);
1638 // does not seem to work
1639 // else if(strcasestr(v, "deflate"))
1640 // web_client_enable_deflate(w, 0);
1643 #endif /* NETDATA_WITH_ZLIB */
1650 // http_request_validate()
1652 // = 0 : all good, process the request
1653 // > 0 : request is not supported
1654 // < 0 : request is incomplete - wait for more data
1656 static inline int http_request_validate(struct web_client *w) {
1657 char *s = w->response.data->buffer, *encoded_url = NULL;
1659 // is is a valid request?
1660 if(!strncmp(s, "GET ", 4)) {
1661 encoded_url = s = &s[4];
1662 w->mode = WEB_CLIENT_MODE_NORMAL;
1664 else if(!strncmp(s, "OPTIONS ", 8)) {
1665 encoded_url = s = &s[8];
1666 w->mode = WEB_CLIENT_MODE_OPTIONS;
1669 w->wait_receive = 0;
1673 // find the SPACE + "HTTP/"
1675 // find the next space
1676 while (*s && *s != ' ') s++;
1678 // is it SPACE + "HTTP/" ?
1679 if(*s && !strncmp(s, " HTTP/", 6)) break;
1683 // incomplete requests
1685 w->wait_receive = 1;
1689 // we have the end of encoded_url - remember it
1692 // make sure we have complete request
1693 // complete requests contain: \r\n\r\n
1696 while(*s && *s++ != '\r');
1698 // did we reach the end?
1699 if(unlikely(!*s)) break;
1702 if(likely(*s++ == '\n')) {
1704 // is it again \r\n ? (header end)
1705 if(unlikely(*s == '\r' && s[1] == '\n')) {
1706 // a valid complete HTTP request found
1709 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1712 // copy the URL - we are going to overwrite parts of it
1713 // FIXME -- we should avoid it
1714 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1716 w->wait_receive = 0;
1720 // another header line
1721 s = http_header_parse(w, s);
1725 // incomplete request
1726 w->wait_receive = 1;
1730 void web_client_process(struct web_client *w) {
1731 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1732 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1734 if(unlikely(!hash_api)) {
1735 hash_api = simple_hash("api");
1736 hash_netdata_conf = simple_hash("netdata.conf");
1737 hash_data = simple_hash(WEB_PATH_DATA);
1738 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1739 hash_graph = simple_hash(WEB_PATH_GRAPH);
1740 hash_list = simple_hash("list");
1741 hash_all_json = simple_hash("all.json");
1742 hash_exit = simple_hash("exit");
1743 hash_debug = simple_hash("debug");
1744 hash_mirror = simple_hash("mirror");
1750 int what_to_do = http_request_validate(w);
1752 // wait for more data
1753 if(what_to_do < 0) {
1754 if(w->response.data->len > TOO_BIG_REQUEST) {
1755 strcpy(w->last_url, "too big request");
1757 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zd bytes).", w->id, w->response.data->len);
1760 buffer_flush(w->response.data);
1761 buffer_sprintf(w->response.data, "Received request is too big (%zd bytes).\r\n", w->response.data->len);
1764 // wait for more data
1768 else if(what_to_do > 0) {
1769 strcpy(w->last_url, "not a valid request");
1771 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1774 buffer_flush(w->response.data);
1775 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1777 else { // what_to_do == 0
1778 gettimeofday(&w->tv_in, NULL);
1780 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1782 w->response.data->contenttype = CT_TEXT_PLAIN;
1783 buffer_flush(w->response.data);
1784 buffer_strcat(w->response.data, "OK");
1787 char *url = w->decoded_url;
1788 char *tok = mystrsep(&url, "/?");
1790 uint32_t hash = simple_hash(tok);
1791 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1793 if(hash == hash_api && strcmp(tok, "api") == 0) {
1794 // the client is requesting api access
1795 code = web_client_api_request(w, url);
1797 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1799 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1801 w->response.data->contenttype = CT_TEXT_PLAIN;
1802 buffer_flush(w->response.data);
1803 generate_config(w->response.data, 0);
1805 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1806 // the client is requesting rrd data -- OLD API
1807 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1809 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1810 // the client is requesting google datasource -- OLD API
1811 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1813 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1814 // the client is requesting an rrd graph -- OLD API
1816 // get the name of the data to show
1817 tok = mystrsep(&url, "/?&");
1819 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1821 // do we have such a data set?
1822 RRDSET *st = rrdset_find_byname(tok);
1823 if(!st) st = rrdset_find(tok);
1826 // try to send a file with that name
1827 buffer_flush(w->response.data);
1828 code = mysendfile(w, tok);
1832 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1833 w->response.data->contenttype = CT_APPLICATION_JSON;
1834 buffer_flush(w->response.data);
1835 rrd_stats_graph_json(st, url, w->response.data);
1840 buffer_flush(w->response.data);
1841 buffer_strcat(w->response.data, "Graph name?\r\n");
1844 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1848 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1850 buffer_flush(w->response.data);
1851 RRDSET *st = rrdset_root;
1853 for ( ; st ; st = st->next )
1854 buffer_sprintf(w->response.data, "%s\n", st->name);
1856 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1859 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1861 w->response.data->contenttype = CT_APPLICATION_JSON;
1862 buffer_flush(w->response.data);
1863 rrd_stats_all_json(w->response.data);
1865 #ifdef NETDATA_INTERNAL_CHECKS
1866 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1868 w->response.data->contenttype = CT_TEXT_PLAIN;
1869 buffer_flush(w->response.data);
1872 buffer_strcat(w->response.data, "ok, will do...");
1874 buffer_strcat(w->response.data, "I am doing it already");
1876 error("web request to exit received.");
1879 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1880 buffer_flush(w->response.data);
1882 // get the name of the data to show
1883 tok = mystrsep(&url, "/?&");
1885 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1887 // do we have such a data set?
1888 RRDSET *st = rrdset_find_byname(tok);
1889 if(!st) st = rrdset_find(tok);
1892 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1893 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1897 debug_flags |= D_RRD_STATS;
1898 st->debug = !st->debug;
1899 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1900 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1905 buffer_flush(w->response.data);
1906 buffer_strcat(w->response.data, "debug which chart?\r\n");
1909 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1912 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1914 // replace the zero bytes with spaces
1915 buffer_char_replace(w->response.data, '\0', ' ');
1917 // just leave the buffer as is
1918 // it will be copied back to the client
1920 #endif /* NETDATA_INTERNAL_CHECKS */
1922 char filename[FILENAME_MAX+1];
1924 strncpyz(filename, w->last_url, FILENAME_MAX);
1925 tok = mystrsep(&url, "?");
1926 buffer_flush(w->response.data);
1927 code = mysendfile(w, (tok && *tok)?tok:"/");
1931 char filename[FILENAME_MAX+1];
1933 strncpyz(filename, w->last_url, FILENAME_MAX);
1934 tok = mystrsep(&url, "?");
1935 buffer_flush(w->response.data);
1936 code = mysendfile(w, (tok && *tok)?tok:"/");
1941 gettimeofday(&w->tv_ready, NULL);
1942 w->response.data->date = time(NULL);
1943 w->response.sent = 0;
1944 w->response.code = code;
1946 // prepare the HTTP response header
1947 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1949 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1950 const char *code_msg = web_response_code_to_string(code);
1953 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1954 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1956 buffer_sprintf(w->response.header_output,
1957 "HTTP/1.1 %d %s\r\n"
1958 "Connection: %s\r\n"
1959 "Server: NetData Embedded HTTP Server\r\n"
1960 "Access-Control-Allow-Origin: %s\r\n"
1961 "Access-Control-Allow-Credentials: true\r\n"
1962 "Content-Type: %s\r\n"
1965 , w->keepalive?"keep-alive":"close"
1967 , content_type_string
1971 if(w->cookie1[0] || w->cookie2[0]) {
1973 buffer_sprintf(w->response.header_output,
1974 "Set-Cookie: %s\r\n",
1979 buffer_sprintf(w->response.header_output,
1980 "Set-Cookie: %s\r\n",
1984 if(web_donotrack_comply)
1985 buffer_sprintf(w->response.header_output,
1986 "Tk: T;cookies\r\n");
1989 if(web_donotrack_comply) {
1990 if(w->tracking_required)
1991 buffer_sprintf(w->response.header_output,
1992 "Tk: T;cookies\r\n");
1994 buffer_sprintf(w->response.header_output,
1999 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2000 buffer_strcat(w->response.header_output,
2001 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2002 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
2003 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2007 if(buffer_strlen(w->response.header))
2008 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2010 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
2011 buffer_sprintf(w->response.header_output,
2013 "Cache-Control: no-cache\r\n"
2016 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
2018 time_t et = w->response.data->date + (86400 * 14);
2019 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
2020 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
2022 buffer_sprintf(w->response.header_output,
2024 "Cache-Control: public\r\n"
2028 // if we know the content length, put it
2029 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
2030 buffer_sprintf(w->response.header_output,
2031 "Content-Length: %ld\r\n"
2032 , w->response.data->len? w->response.data->len: w->response.rlen
2034 else if(!w->response.zoutput)
2035 w->keepalive = 0; // content-length is required for keep-alive
2037 if(w->response.zoutput) {
2038 buffer_strcat(w->response.header_output,
2039 "Content-Encoding: gzip\r\n"
2040 "Transfer-Encoding: chunked\r\n"
2044 buffer_strcat(w->response.header_output, "\r\n");
2046 // sent the HTTP header
2047 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2049 , buffer_strlen(w->response.header_output)
2050 , buffer_tostring(w->response.header_output)
2053 web_client_crock_socket(w);
2055 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2056 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2058 w->stats_sent_bytes += bytes;
2060 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2062 , buffer_strlen(w->response.header_output)
2065 WEB_CLIENT_IS_DEAD(w);
2069 w->stats_sent_bytes += bytes;
2071 // enable sending immediately if we have data
2072 if(w->response.data->len) w->wait_send = 1;
2073 else w->wait_send = 0;
2077 case WEB_CLIENT_MODE_OPTIONS:
2078 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2081 case WEB_CLIENT_MODE_NORMAL:
2082 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2085 case WEB_CLIENT_MODE_FILECOPY:
2086 if(w->response.rlen) {
2087 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2088 w->wait_receive = 1;
2091 // utilize the kernel sendfile() for copying the file to the socket.
2092 // this block of code can be commented, without anything missing.
2093 // when it is commented, the program will copy the data using async I/O.
2095 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2096 if(len != w->response.data->rbytes)
2097 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2099 web_client_reset(w);
2104 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2108 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2113 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2115 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2117 sprintf(buf, "%zX\r\n", len);
2119 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2121 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2122 w->stats_sent_bytes += bytes;
2125 else if(bytes == 0) {
2126 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2127 WEB_CLIENT_IS_DEAD(w);
2130 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2131 WEB_CLIENT_IS_DEAD(w);
2137 ssize_t web_client_send_chunk_close(struct web_client *w)
2139 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2141 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2143 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2144 w->stats_sent_bytes += bytes;
2147 else if(bytes == 0) {
2148 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2149 WEB_CLIENT_IS_DEAD(w);
2152 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2153 WEB_CLIENT_IS_DEAD(w);
2159 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2161 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2163 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2165 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2166 w->stats_sent_bytes += bytes;
2169 else if(bytes == 0) {
2170 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2171 WEB_CLIENT_IS_DEAD(w);
2174 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2175 WEB_CLIENT_IS_DEAD(w);
2181 #ifdef NETDATA_WITH_ZLIB
2182 ssize_t web_client_send_deflate(struct web_client *w)
2184 ssize_t len = 0, t = 0;
2186 // when using compression,
2187 // w->response.sent is the amount of bytes passed through compression
2189 debug(D_DEFLATE, "%llu: web_client_send_deflate(): w->response.data->len = %zu, w->response.sent = %zu, 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 = %lu, w->response.zstream.total_out = %lu.",
2190 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);
2192 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) {
2193 // there is nothing to send
2195 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2197 // finalize the chunk
2198 if(w->response.sent != 0) {
2199 t = web_client_send_chunk_finalize(w);
2203 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2204 // we have to wait, more data will come
2205 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2210 if(unlikely(!w->keepalive)) {
2211 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2212 WEB_CLIENT_IS_DEAD(w);
2217 web_client_reset(w);
2218 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2222 if(w->response.zhave == w->response.zsent) {
2223 // compress more input data
2225 // close the previous open chunk
2226 if(w->response.sent != 0) {
2227 t = web_client_send_chunk_close(w);
2231 debug(D_DEFLATE, "%llu: Compressing %zu new bytes starting from %zu (and %u left behind).", w->id, (w->response.data->len - w->response.sent), w->response.sent, w->response.zstream.avail_in);
2233 // give the compressor all the data not passed through the compressor yet
2234 if(w->response.data->len > w->response.sent) {
2235 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2236 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2239 // reset the compressor output buffer
2240 w->response.zstream.next_out = w->response.zbuffer;
2241 w->response.zstream.avail_out = ZLIB_CHUNK;
2243 // ask for FINISH if we have all the input
2244 int flush = Z_SYNC_FLUSH;
2245 if(w->mode == WEB_CLIENT_MODE_NORMAL
2246 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2248 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2251 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2255 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2256 error("%llu: Compression failed. Closing down client.", w->id);
2257 web_client_reset(w);
2261 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2262 w->response.zsent = 0;
2264 // keep track of the bytes passed through the compressor
2265 w->response.sent = w->response.data->len;
2267 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2270 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2271 if(t2 < 0) return t2;
2275 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2277 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2279 w->stats_sent_bytes += len;
2280 w->response.zsent += len;
2282 debug(D_WEB_CLIENT, "%llu: Sent %zu bytes.", w->id, len);
2285 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2286 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2288 WEB_CLIENT_IS_DEAD(w);
2291 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2292 WEB_CLIENT_IS_DEAD(w);
2297 #endif // NETDATA_WITH_ZLIB
2299 ssize_t web_client_send(struct web_client *w) {
2300 #ifdef NETDATA_WITH_ZLIB
2301 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2302 #endif // NETDATA_WITH_ZLIB
2306 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2307 // there is nothing to send
2309 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2311 // there can be two cases for this
2312 // A. we have done everything
2313 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2315 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2316 // we have to wait, more data will come
2317 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2322 if(unlikely(!w->keepalive)) {
2323 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %ld bytes sent.", w->id, w->response.sent);
2324 WEB_CLIENT_IS_DEAD(w);
2328 web_client_reset(w);
2329 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2333 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2334 if(likely(bytes > 0)) {
2335 w->stats_sent_bytes += bytes;
2336 w->response.sent += bytes;
2337 debug(D_WEB_CLIENT, "%llu: Sent %zu bytes.", w->id, bytes);
2339 else if(likely(bytes == 0)) {
2340 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2341 WEB_CLIENT_IS_DEAD(w);
2344 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2345 WEB_CLIENT_IS_DEAD(w);
2351 ssize_t web_client_receive(struct web_client *w)
2353 // do we have any space for more data?
2354 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2356 ssize_t left = w->response.data->size - w->response.data->len;
2359 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2360 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2362 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2364 if(likely(bytes > 0)) {
2365 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2366 w->stats_received_bytes += bytes;
2368 size_t old = w->response.data->len;
2369 w->response.data->len += bytes;
2370 w->response.data->buffer[w->response.data->len] = '\0';
2372 debug(D_WEB_CLIENT, "%llu: Received %zu bytes.", w->id, bytes);
2373 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2375 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2378 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2379 w->wait_receive = 0;
2382 else if(likely(bytes == 0)) {
2383 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2385 // if we cannot read, it means we have an error on input.
2386 // if however, we are copying a file from ifd to ofd, we should not return an error.
2387 // in this case, the error should be generated when the file has been sent to the client.
2389 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2390 // we are copying data from ifd to ofd
2391 // let it finish copying...
2392 w->wait_receive = 0;
2394 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2395 if(w->ifd != w->ofd) close(w->ifd);
2399 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2400 WEB_CLIENT_IS_DEAD(w);
2404 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2405 WEB_CLIENT_IS_DEAD(w);
2412 // --------------------------------------------------------------------------------------
2413 // the thread of a single client
2415 // 1. waits for input and output, using async I/O
2416 // 2. it processes HTTP requests
2417 // 3. it generates HTTP responses
2418 // 4. it copies data from input to output if mode is FILECOPY
2420 void *web_client_main(void *ptr)
2422 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2423 error("Cannot set pthread cancel type to DEFERRED.");
2425 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2426 error("Cannot set pthread cancel state to ENABLE.");
2428 struct web_client *w = ptr;
2429 struct pollfd fds[2], *ifd, *ofd;
2430 int retval, fdmax = 0, timeout;
2432 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2435 if(unlikely(w->dead)) {
2436 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2439 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2440 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2444 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2445 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2449 if(w->ifd == w->ofd) {
2454 if(w->wait_receive) fds[0].events |= POLLIN;
2455 if(w->wait_send) fds[0].events |= POLLOUT;
2461 ifd = ofd = &fds[0];
2469 if(w->wait_receive) fds[0].events |= POLLIN;
2475 if(w->wait_send) fds[1].events |= POLLOUT;
2481 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2483 timeout = web_client_timeout * 1000;
2484 retval = poll(fds, fdmax, timeout);
2486 if(unlikely(retval == -1)) {
2487 if(errno == EAGAIN || errno == EINTR) {
2488 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2492 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2495 else if(unlikely(!retval)) {
2496 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":"");
2501 if(w->wait_send && ofd->revents & POLLOUT) {
2503 if(web_client_send(w) < 0) {
2504 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2509 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2511 if(web_client_receive(w) < 0) {
2512 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2516 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2517 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2518 web_client_process(w);
2522 if(unlikely(!used)) {
2523 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2528 web_client_reset(w);
2530 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2531 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2533 // close the sockets/files now
2534 // to free file descriptors
2535 if(w->ifd == w->ofd) {
2536 if(w->ifd != -1) close(w->ifd);
2539 if(w->ifd != -1) close(w->ifd);
2540 if(w->ofd != -1) close(w->ofd);