3 #define INITIAL_WEB_DATA_LENGTH 16384
4 #define WEB_REQUEST_LENGTH 16384
5 #define TOO_BIG_REQUEST 16384
7 int web_client_timeout = DEFAULT_DISCONNECT_IDLE_WEB_CLIENTS_AFTER_SECONDS;
8 int web_donotrack_comply = 0;
10 #ifdef NETDATA_WITH_ZLIB
11 int web_enable_gzip = 1, web_gzip_level = 3, web_gzip_strategy = Z_DEFAULT_STRATEGY;
12 #endif /* NETDATA_WITH_ZLIB */
14 struct web_client *web_clients = NULL;
15 unsigned long long web_clients_count = 0;
17 inline int web_client_crock_socket(struct web_client *w) {
19 if(likely(!w->tcp_cork && w->ofd != -1)) {
21 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
22 error("%llu: failed to enable TCP_CORK on socket.", w->id);
32 inline int web_client_uncrock_socket(struct web_client *w) {
34 if(likely(w->tcp_cork && w->ofd != -1)) {
36 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
37 error("%llu: failed to disable TCP_CORK on socket.", w->id);
47 struct web_client *web_client_create(int listener)
51 w = callocz(1, sizeof(struct web_client));
52 w->id = ++web_clients_count;
53 w->mode = WEB_CLIENT_MODE_NORMAL;
56 struct sockaddr *sadr;
59 sadr = (struct sockaddr*) &w->clientaddr;
60 addrlen = sizeof(w->clientaddr);
62 w->ifd = accept4(listener, sadr, &addrlen, SOCK_NONBLOCK);
64 error("%llu: Cannot accept new incoming connection.", w->id);
70 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
71 error("Cannot getnameinfo() on received client connection.");
72 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
73 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
75 w->client_ip[NI_MAXHOST] = '\0';
76 w->client_port[NI_MAXSERV] = '\0';
78 switch(sadr->sa_family) {
80 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);
84 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
85 memmove(w->client_ip, &w->client_ip[7], strlen(&w->client_ip[7]) + 1);
86 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);
89 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);
93 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);
98 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
99 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
102 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
103 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
106 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
107 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
108 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
112 if(web_clients) web_clients->prev = w;
113 w->next = web_clients;
116 web_client_connected();
121 void web_client_reset(struct web_client *w) {
122 web_client_uncrock_socket(w);
124 debug(D_WEB_CLIENT, "%llu: Reseting client.", w->id);
126 if(likely(w->last_url[0])) {
128 gettimeofday(&tv, NULL);
130 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
132 #ifdef NETDATA_WITH_ZLIB
133 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
136 // --------------------------------------------------------------------
139 finished_web_request_statistics(usec_dt(&tv, &w->tv_in),
140 w->stats_received_bytes,
145 w->stats_received_bytes = 0;
146 w->stats_sent_bytes = 0;
149 // --------------------------------------------------------------------
152 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
154 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
155 usec_dt(&w->tv_ready, &w->tv_in) / 1000.0,
156 usec_dt(&tv, &w->tv_ready) / 1000.0,
157 usec_dt(&tv, &w->tv_in) / 1000.0,
158 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
159 ? "options" : "data"),
165 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
166 if(w->ifd != w->ofd) {
167 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
168 if(w->ifd != -1) close(w->ifd);
173 w->last_url[0] = '\0';
174 w->cookie1[0] = '\0';
175 w->cookie2[0] = '\0';
179 w->mode = WEB_CLIENT_MODE_NORMAL;
183 w->tracking_required = 0;
185 w->decoded_url[0] = '\0';
187 buffer_reset(w->response.header_output);
188 buffer_reset(w->response.header);
189 buffer_reset(w->response.data);
190 w->response.rlen = 0;
191 w->response.sent = 0;
192 w->response.code = 0;
197 w->response.zoutput = 0;
199 // if we had enabled compression, release it
200 #ifdef NETDATA_WITH_ZLIB
201 if(w->response.zinitialized) {
202 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
203 deflateEnd(&w->response.zstream);
204 w->response.zsent = 0;
205 w->response.zhave = 0;
206 w->response.zstream.avail_in = 0;
207 w->response.zstream.avail_out = 0;
208 w->response.zstream.total_in = 0;
209 w->response.zstream.total_out = 0;
210 w->response.zinitialized = 0;
212 #endif // NETDATA_WITH_ZLIB
215 struct web_client *web_client_free(struct web_client *w) {
218 struct web_client *n = w->next;
219 if(w == web_clients) web_clients = n;
221 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
223 if(w->prev) w->prev->next = w->next;
224 if(w->next) w->next->prev = w->prev;
225 if(w->response.header_output) buffer_free(w->response.header_output);
226 if(w->response.header) buffer_free(w->response.header);
227 if(w->response.data) buffer_free(w->response.data);
228 if(w->ifd != -1) close(w->ifd);
229 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
232 web_client_disconnected();
237 uid_t web_files_uid(void) {
238 static char *web_owner = NULL;
239 static uid_t owner_uid = 0;
241 if(unlikely(!web_owner)) {
242 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
243 if(!web_owner || !*web_owner)
244 owner_uid = geteuid();
246 // getpwnam() is not thread safe,
247 // but we have called this function once
248 // while single threaded
249 struct passwd *pw = getpwnam(web_owner);
251 error("User '%s' is not present. Ignoring option.", web_owner);
252 owner_uid = geteuid();
255 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
256 owner_uid = pw->pw_uid;
264 gid_t web_files_gid(void) {
265 static char *web_group = NULL;
266 static gid_t owner_gid = 0;
268 if(unlikely(!web_group)) {
269 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
270 if(!web_group || !*web_group)
271 owner_gid = getegid();
273 // getgrnam() is not thread safe,
274 // but we have called this function once
275 // while single threaded
276 struct group *gr = getgrnam(web_group);
278 error("Group '%s' is not present. Ignoring option.", web_group);
279 owner_gid = getegid();
282 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
283 owner_gid = gr->gr_gid;
291 int mysendfile(struct web_client *w, char *filename)
293 static char *web_dir = NULL;
295 // initialize our static data
296 if(unlikely(!web_dir)) web_dir = config_get("global", "web files directory", WEB_DIR);
298 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, web_dir, filename);
300 // skip leading slashes
301 while (*filename == '/') filename++;
303 // if the filename contain known paths, skip them
304 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
305 filename = &filename[strlen(WEB_PATH_FILE) + 1];
308 for(s = filename; *s ;s++) {
309 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
310 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
311 buffer_sprintf(w->response.data, "File '%s' cannot be served. Filename contains invalid character '%c'", filename, *s);
316 // if the filename contains a .. refuse to serve it
317 if(strstr(filename, "..") != 0) {
318 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
319 buffer_sprintf(w->response.data, "File '%s' cannot be served. Relative filenames with '..' in them are not supported.", filename);
324 char webfilename[FILENAME_MAX + 1];
325 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
327 // check if the file exists
329 if(lstat(webfilename, &stat) != 0) {
330 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
331 buffer_sprintf(w->response.data, "File '%s' does not exist, or is not accessible.", webfilename);
335 // check if the file is owned by expected user
336 if(stat.st_uid != web_files_uid()) {
337 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
338 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
342 // check if the file is owned by expected group
343 if(stat.st_gid != web_files_gid()) {
344 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
345 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
349 if((stat.st_mode & S_IFMT) == S_IFDIR) {
350 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
351 return mysendfile(w, webfilename);
354 if((stat.st_mode & S_IFMT) != S_IFREG) {
355 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
356 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
361 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
365 if(errno == EBUSY || errno == EAGAIN) {
366 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
367 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
368 buffer_sprintf(w->response.data, "The file '%s' is currently busy. Please try again later.", webfilename);
372 error("%llu: Cannot open file '%s'.", w->id, webfilename);
373 buffer_sprintf(w->response.data, "Cannot open file '%s'.", webfilename);
377 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
378 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
380 // pick a Content-Type for the file
381 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
382 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
383 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
384 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
385 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
386 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
387 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
388 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
389 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
390 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
391 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
392 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
393 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
394 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
395 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
396 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
397 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
398 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
399 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
400 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
402 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);
404 w->mode = WEB_CLIENT_MODE_FILECOPY;
407 buffer_flush(w->response.data);
408 w->response.rlen = stat.st_size;
409 w->response.data->date = stat.st_mtim.tv_sec;
415 #ifdef NETDATA_WITH_ZLIB
416 void web_client_enable_deflate(struct web_client *w, int gzip) {
417 if(unlikely(w->response.zinitialized)) {
418 error("%llu: Compression has already be initialized for this client.", w->id);
422 if(unlikely(w->response.sent)) {
423 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
427 w->response.zstream.zalloc = Z_NULL;
428 w->response.zstream.zfree = Z_NULL;
429 w->response.zstream.opaque = Z_NULL;
431 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
432 w->response.zstream.avail_in = 0;
433 w->response.zstream.total_in = 0;
435 w->response.zstream.next_out = w->response.zbuffer;
436 w->response.zstream.avail_out = 0;
437 w->response.zstream.total_out = 0;
439 w->response.zstream.zalloc = Z_NULL;
440 w->response.zstream.zfree = Z_NULL;
441 w->response.zstream.opaque = Z_NULL;
443 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
444 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
448 // Select GZIP compression: windowbits = 15 + 16 = 31
449 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
450 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
454 w->response.zsent = 0;
455 w->response.zoutput = 1;
456 w->response.zinitialized = 1;
458 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
460 #endif // NETDATA_WITH_ZLIB
462 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
465 if(options & RRDR_OPTION_NONZERO) {
466 if(count++) buffer_strcat(wb, " ");
467 buffer_strcat(wb, "nonzero");
470 if(options & RRDR_OPTION_REVERSED) {
471 if(count++) buffer_strcat(wb, " ");
472 buffer_strcat(wb, "flip");
475 if(options & RRDR_OPTION_JSON_WRAP) {
476 if(count++) buffer_strcat(wb, " ");
477 buffer_strcat(wb, "jsonwrap");
480 if(options & RRDR_OPTION_MIN2MAX) {
481 if(count++) buffer_strcat(wb, " ");
482 buffer_strcat(wb, "min2max");
485 if(options & RRDR_OPTION_MILLISECONDS) {
486 if(count++) buffer_strcat(wb, " ");
487 buffer_strcat(wb, "ms");
490 if(options & RRDR_OPTION_ABSOLUTE) {
491 if(count++) buffer_strcat(wb, " ");
492 buffer_strcat(wb, "abs");
495 if(options & RRDR_OPTION_SECONDS) {
496 if(count++) buffer_strcat(wb, " ");
497 buffer_strcat(wb, "seconds");
500 if(options & RRDR_OPTION_NULL2ZERO) {
501 if(count++) buffer_strcat(wb, " ");
502 buffer_strcat(wb, "null2zero");
505 if(options & RRDR_OPTION_OBJECTSROWS) {
506 if(count++) buffer_strcat(wb, " ");
507 buffer_strcat(wb, "objectrows");
510 if(options & RRDR_OPTION_GOOGLE_JSON) {
511 if(count++) buffer_strcat(wb, " ");
512 buffer_strcat(wb, "google_json");
515 if(options & RRDR_OPTION_PERCENTAGE) {
516 if(count++) buffer_strcat(wb, " ");
517 buffer_strcat(wb, "percentage");
520 if(options & RRDR_OPTION_NOT_ALIGNED) {
521 if(count++) buffer_strcat(wb, " ");
522 buffer_strcat(wb, "unaligned");
526 uint32_t web_client_api_request_v1_data_options(char *o)
528 uint32_t ret = 0x00000000;
531 while(o && *o && (tok = mystrsep(&o, ", |"))) {
534 if(!strcmp(tok, "nonzero"))
535 ret |= RRDR_OPTION_NONZERO;
536 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
537 ret |= RRDR_OPTION_REVERSED;
538 else if(!strcmp(tok, "jsonwrap"))
539 ret |= RRDR_OPTION_JSON_WRAP;
540 else if(!strcmp(tok, "min2max"))
541 ret |= RRDR_OPTION_MIN2MAX;
542 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
543 ret |= RRDR_OPTION_MILLISECONDS;
544 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
545 ret |= RRDR_OPTION_ABSOLUTE;
546 else if(!strcmp(tok, "seconds"))
547 ret |= RRDR_OPTION_SECONDS;
548 else if(!strcmp(tok, "null2zero"))
549 ret |= RRDR_OPTION_NULL2ZERO;
550 else if(!strcmp(tok, "objectrows"))
551 ret |= RRDR_OPTION_OBJECTSROWS;
552 else if(!strcmp(tok, "google_json"))
553 ret |= RRDR_OPTION_GOOGLE_JSON;
554 else if(!strcmp(tok, "percentage"))
555 ret |= RRDR_OPTION_PERCENTAGE;
556 else if(!strcmp(tok, "unaligned"))
557 ret |= RRDR_OPTION_NOT_ALIGNED;
563 uint32_t web_client_api_request_v1_data_format(char *name)
565 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
566 return DATASOURCE_DATATABLE_JSON;
568 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
569 return DATASOURCE_DATATABLE_JSONP;
571 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
572 return DATASOURCE_JSON;
574 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
575 return DATASOURCE_JSONP;
577 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
578 return DATASOURCE_SSV;
580 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
581 return DATASOURCE_CSV;
583 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
584 return DATASOURCE_TSV;
586 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
587 return DATASOURCE_HTML;
589 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
590 return DATASOURCE_JS_ARRAY;
592 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
593 return DATASOURCE_SSV_COMMA;
595 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
596 return DATASOURCE_CSV_JSON_ARRAY;
598 return DATASOURCE_JSON;
601 uint32_t web_client_api_request_v1_data_google_format(char *name)
603 if(!strcmp(name, "json"))
604 return DATASOURCE_DATATABLE_JSONP;
606 else if(!strcmp(name, "html"))
607 return DATASOURCE_HTML;
609 else if(!strcmp(name, "csv"))
610 return DATASOURCE_CSV;
612 else if(!strcmp(name, "tsv-excel"))
613 return DATASOURCE_TSV;
615 return DATASOURCE_JSON;
618 const char *group_method2string(int group) {
620 case GROUP_UNDEFINED:
635 case GROUP_INCREMENTAL_SUM:
636 return "incremental-sum";
639 return "unknown-group-method";
643 int web_client_api_request_v1_data_group(char *name, int def)
645 if(!strcmp(name, "average"))
646 return GROUP_AVERAGE;
648 else if(!strcmp(name, "min"))
651 else if(!strcmp(name, "max"))
654 else if(!strcmp(name, "sum"))
657 else if(!strcmp(name, "incremental-sum"))
658 return GROUP_INCREMENTAL_SUM;
663 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
668 char *value = mystrsep(&url, "?&[]");
669 if (!value || !*value) continue;
671 if(!strcmp(value, "all")) all = 1;
672 else if(!strcmp(value, "active")) all = 0;
675 buffer_flush(w->response.data);
676 w->response.data->contenttype = CT_APPLICATION_JSON;
677 health_alarms2json(&localhost, w->response.data, all);
681 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
685 buffer_flush(w->response.data);
686 w->response.data->contenttype = CT_APPLICATION_JSON;
687 health_alarm_log2json(&localhost, w->response.data);
691 int web_client_api_request_v1_charts(struct web_client *w, char *url)
695 buffer_flush(w->response.data);
696 w->response.data->contenttype = CT_APPLICATION_JSON;
697 rrd_stats_api_v1_charts(w->response.data);
701 int web_client_api_request_v1_chart(struct web_client *w, char *url)
706 buffer_flush(w->response.data);
709 char *value = mystrsep(&url, "?&[]");
710 if(!value || !*value) continue;
712 char *name = mystrsep(&value, "=");
713 if(!name || !*name) continue;
714 if(!value || !*value) continue;
716 // name and value are now the parameters
717 // they are not null and not empty
719 if(!strcmp(name, "chart")) chart = value;
721 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
726 if(!chart || !*chart) {
727 buffer_sprintf(w->response.data, "No chart id is given at the request.");
731 RRDSET *st = rrdset_find(chart);
732 if(!st) st = rrdset_find_byname(chart);
734 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
739 w->response.data->contenttype = CT_APPLICATION_JSON;
740 rrd_stats_api_v1_chart(st, w->response.data);
747 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
751 buffer_flush(w->response.data);
753 BUFFER *dimensions = NULL;
755 const char *chart = NULL
759 , *multiply_str = NULL
763 , *label_color = NULL
764 , *value_color = NULL
765 , *refresh_str = NULL
766 , *precision_str = NULL
769 int group = GROUP_AVERAGE;
770 uint32_t options = 0x00000000;
773 char *value = mystrsep(&url, "/?&[]");
774 if(!value || !*value) continue;
776 char *name = mystrsep(&value, "=");
777 if(!name || !*name) continue;
778 if(!value || !*value) continue;
780 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
782 // name and value are now the parameters
783 // they are not null and not empty
785 if(!strcmp(name, "chart")) chart = value;
786 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
788 dimensions = buffer_create(100);
790 buffer_strcat(dimensions, "|");
791 buffer_strcat(dimensions, value);
793 else if(!strcmp(name, "after")) after_str = value;
794 else if(!strcmp(name, "before")) before_str = value;
795 else if(!strcmp(name, "points")) points_str = value;
796 else if(!strcmp(name, "group")) {
797 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
799 else if(!strcmp(name, "options")) {
800 options |= web_client_api_request_v1_data_options(value);
802 else if(!strcmp(name, "label")) label = value;
803 else if(!strcmp(name, "units")) units = value;
804 else if(!strcmp(name, "label_color")) label_color = value;
805 else if(!strcmp(name, "value_color")) value_color = value;
806 else if(!strcmp(name, "multiply")) multiply_str = value;
807 else if(!strcmp(name, "divide")) divide_str = value;
808 else if(!strcmp(name, "refresh")) refresh_str = value;
809 else if(!strcmp(name, "precision")) precision_str = value;
810 else if(!strcmp(name, "alarm")) alarm = value;
813 if(!chart || !*chart) {
814 buffer_sprintf(w->response.data, "No chart id is given at the request.");
818 RRDSET *st = rrdset_find(chart);
819 if(!st) st = rrdset_find_byname(chart);
821 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
828 rc = rrdcalc_find(st, alarm);
830 buffer_svg(w->response.data, "alarm not found", 0, "", NULL, NULL, 1, -1);
836 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
837 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
838 long long before = (before_str && *before_str )?atol(before_str):0;
839 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
840 int points = (points_str && *points_str )?atoi(points_str):1;
841 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
843 if(!multiply) multiply = 1;
844 if(!divide) divide = 1;
847 if(refresh_str && *refresh_str) {
848 if(!strcmp(refresh_str, "auto")) {
849 if(rc) refresh = rc->update_every;
850 else if(options & RRDR_OPTION_NOT_ALIGNED)
851 refresh = st->update_every;
853 refresh = (before - after);
854 if(refresh < 0) refresh = -refresh;
858 refresh = atoi(refresh_str);
859 if(refresh < 0) refresh = -refresh;
865 snprintfz(buf, 100, "%s%s%s", (rc->rrdset)?rc->rrdset->family:"", (rc->rrdset)?": ":"", rc->name);
868 if(*s == '_') *s = ' ';
873 else if(dimensions) {
874 const char *dim = buffer_tostring(dimensions);
875 if(*dim == '|') dim++;
882 if(options & RRDR_OPTION_PERCENTAGE)
884 else if(alarm && rc && rc->calculation)
890 debug(D_WEB_CLIENT, "%llu: API command 'badge.svg' for chart '%s', alarm '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', options '0x%08x'"
894 , (dimensions)?buffer_tostring(dimensions):""
903 calculated_number n = rc->value;
904 if(isnan(n) || isinf(n)) n = 0;
907 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
911 case RRDCALC_STATUS_CRITICAL:
915 case RRDCALC_STATUS_WARNING:
916 value_color = "orange";
919 case RRDCALC_STATUS_CLEAR:
920 value_color = "brightgreen";
923 case RRDCALC_STATUS_UNDEFINED:
924 value_color = "lightgrey";
927 case RRDCALC_STATUS_UNINITIALIZED:
928 value_color = "#000";
932 value_color = "grey";
937 buffer_svg(w->response.data, label, rc->value * multiply / divide, units, label_color, value_color, 0, precision);
941 time_t latest_timestamp = 0;
942 int value_is_null = 1;
943 calculated_number n = 0;
946 // if the collected value is too old, don't calculate its value
947 if (rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
948 ret = rrd2value(st, w->response.data, &n, (dimensions) ? buffer_tostring(dimensions) : NULL, points, after,
949 before, group, options, NULL, &latest_timestamp, &value_is_null);
951 // if the value cannot be calculated, show empty badge
957 else if (refresh > 0)
958 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
961 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null,
967 buffer_free(dimensions);
971 // returns the HTTP code
972 int web_client_api_request_v1_data(struct web_client *w, char *url)
974 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
977 BUFFER *dimensions = NULL;
979 buffer_flush(w->response.data);
981 char *google_version = "0.6",
984 *google_out = "json",
985 *responseHandler = NULL,
988 time_t last_timestamp_in_data = 0, google_timestamp = 0;
993 , *points_str = NULL;
995 int group = GROUP_AVERAGE;
996 uint32_t format = DATASOURCE_JSON;
997 uint32_t options = 0x00000000;
1000 char *value = mystrsep(&url, "?&[]");
1001 if(!value || !*value) continue;
1003 char *name = mystrsep(&value, "=");
1004 if(!name || !*name) continue;
1005 if(!value || !*value) continue;
1007 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1009 // name and value are now the parameters
1010 // they are not null and not empty
1012 if(!strcmp(name, "chart")) chart = value;
1013 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1014 if(!dimensions) dimensions = buffer_create(100);
1015 buffer_strcat(dimensions, "|");
1016 buffer_strcat(dimensions, value);
1018 else if(!strcmp(name, "after")) after_str = value;
1019 else if(!strcmp(name, "before")) before_str = value;
1020 else if(!strcmp(name, "points")) points_str = value;
1021 else if(!strcmp(name, "group")) {
1022 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1024 else if(!strcmp(name, "format")) {
1025 format = web_client_api_request_v1_data_format(value);
1027 else if(!strcmp(name, "options")) {
1028 options |= web_client_api_request_v1_data_options(value);
1030 else if(!strcmp(name, "callback")) {
1031 responseHandler = value;
1033 else if(!strcmp(name, "filename")) {
1034 outFileName = value;
1036 else if(!strcmp(name, "tqx")) {
1037 // parse Google Visualization API options
1038 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1039 char *tqx_name, *tqx_value;
1042 tqx_value = mystrsep(&value, ";");
1043 if(!tqx_value || !*tqx_value) continue;
1045 tqx_name = mystrsep(&tqx_value, ":");
1046 if(!tqx_name || !*tqx_name) continue;
1047 if(!tqx_value || !*tqx_value) continue;
1049 if(!strcmp(tqx_name, "version"))
1050 google_version = tqx_value;
1051 else if(!strcmp(tqx_name, "reqId"))
1052 google_reqId = tqx_value;
1053 else if(!strcmp(tqx_name, "sig")) {
1054 google_sig = tqx_value;
1055 google_timestamp = strtoul(google_sig, NULL, 0);
1057 else if(!strcmp(tqx_name, "out")) {
1058 google_out = tqx_value;
1059 format = web_client_api_request_v1_data_google_format(google_out);
1061 else if(!strcmp(tqx_name, "responseHandler"))
1062 responseHandler = tqx_value;
1063 else if(!strcmp(tqx_name, "outFileName"))
1064 outFileName = tqx_value;
1069 if(!chart || !*chart) {
1070 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1074 RRDSET *st = rrdset_find(chart);
1075 if(!st) st = rrdset_find_byname(chart);
1077 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
1082 long long before = (before_str && *before_str)?atol(before_str):0;
1083 long long after = (after_str && *after_str) ?atol(after_str):0;
1084 int points = (points_str && *points_str)?atoi(points_str):0;
1086 debug(D_WEB_CLIENT, "%llu: API command 'data' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', format '%u', options '0x%08x'"
1089 , (dimensions)?buffer_tostring(dimensions):""
1098 if(outFileName && *outFileName) {
1099 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1100 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1103 if(format == DATASOURCE_DATATABLE_JSONP) {
1104 if(responseHandler == NULL)
1105 responseHandler = "google.visualization.Query.setResponse";
1107 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1108 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1111 buffer_sprintf(w->response.data,
1112 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1113 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1115 else if(format == DATASOURCE_JSONP) {
1116 if(responseHandler == NULL)
1117 responseHandler = "callback";
1119 buffer_strcat(w->response.data, responseHandler);
1120 buffer_strcat(w->response.data, "(");
1123 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1125 if(format == DATASOURCE_DATATABLE_JSONP) {
1126 if(google_timestamp < last_timestamp_in_data)
1127 buffer_strcat(w->response.data, "});");
1130 // the client already has the latest data
1131 buffer_flush(w->response.data);
1132 buffer_sprintf(w->response.data,
1133 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1134 responseHandler, google_version, google_reqId);
1137 else if(format == DATASOURCE_JSONP)
1138 buffer_strcat(w->response.data, ");");
1141 if(dimensions) buffer_free(dimensions);
1145 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1147 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1148 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1149 hash_to = 0 /*, hash_redirects = 0 */;
1151 if(unlikely(!hash_action)) {
1152 hash_action = simple_hash("action");
1153 hash_access = simple_hash("access");
1154 hash_hello = simple_hash("hello");
1155 hash_delete = simple_hash("delete");
1156 hash_search = simple_hash("search");
1157 hash_switch = simple_hash("switch");
1158 hash_machine = simple_hash("machine");
1159 hash_url = simple_hash("url");
1160 hash_name = simple_hash("name");
1161 hash_delete_url = simple_hash("delete_url");
1162 hash_for = simple_hash("for");
1163 hash_to = simple_hash("to");
1165 hash_redirects = simple_hash("redirects");
1169 char person_guid[36 + 1] = "";
1171 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1174 // The browser may send multiple cookies with our id
1176 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1178 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1181 char *machine_guid = NULL,
1182 *machine_url = NULL,
1184 *search_machine_guid = NULL,
1186 *to_person_guid = NULL;
1192 char *value = mystrsep(&url, "?&[]");
1193 if (!value || !*value) continue;
1195 char *name = mystrsep(&value, "=");
1196 if (!name || !*name) continue;
1197 if (!value || !*value) continue;
1199 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1201 uint32_t hash = simple_hash(name);
1203 if(hash == hash_action && !strcmp(name, "action")) {
1204 uint32_t vhash = simple_hash(value);
1206 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1207 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1208 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1209 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1210 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1211 #ifdef NETDATA_INTERNAL_CHECKS
1212 else error("unknown registry action '%s'", value);
1213 #endif /* NETDATA_INTERNAL_CHECKS */
1216 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1217 redirects = atoi(value);
1219 else if(hash == hash_machine && !strcmp(name, "machine"))
1220 machine_guid = value;
1222 else if(hash == hash_url && !strcmp(name, "url"))
1223 machine_url = value;
1225 else if(action == 'A') {
1226 if(hash == hash_name && !strcmp(name, "name"))
1229 else if(action == 'D') {
1230 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1233 else if(action == 'S') {
1234 if(hash == hash_for && !strcmp(name, "for"))
1235 search_machine_guid = value;
1237 else if(action == 'W') {
1238 if(hash == hash_to && !strcmp(name, "to"))
1239 to_person_guid = value;
1241 #ifdef NETDATA_INTERNAL_CHECKS
1242 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1243 #endif /* NETDATA_INTERNAL_CHECKS */
1246 if(web_donotrack_comply && w->donottrack) {
1247 buffer_flush(w->response.data);
1248 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.");
1252 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1253 buffer_flush(w->response.data);
1254 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1255 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1258 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1259 buffer_flush(w->response.data);
1260 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1261 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1264 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1265 buffer_flush(w->response.data);
1266 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1267 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1270 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1271 buffer_flush(w->response.data);
1272 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1273 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1279 w->tracking_required = 1;
1280 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1281 buffer_flush(w->response.data);
1283 registry_set_cookie(w, "give-me-back-this-cookie-please");
1284 w->response.data->contenttype = CT_APPLICATION_JSON;
1285 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1289 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1290 * under certain conditions, when using CORS
1291 * so this is commented and we use application level redirects instead
1295 if(redirects > registry_verify_cookies_redirects()) {
1296 buffer_flush(w->response.data);
1297 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1301 char *encoded_url = url_encode(machine_url);
1303 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1307 char *encoded_name = url_encode(url_name);
1310 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1314 char *encoded_guid = url_encode(machine_guid);
1318 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1322 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1323 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1331 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1334 w->tracking_required = 1;
1335 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1338 w->tracking_required = 1;
1339 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1342 w->tracking_required = 1;
1343 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1346 return registry_request_hello_json(w);
1349 buffer_flush(w->response.data);
1350 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1355 int web_client_api_request_v1(struct web_client *w, char *url) {
1356 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0, hash_alarms = 0, hash_alarm_log = 0;
1358 if(unlikely(hash_data == 0)) {
1359 hash_data = simple_hash("data");
1360 hash_chart = simple_hash("chart");
1361 hash_charts = simple_hash("charts");
1362 hash_registry = simple_hash("registry");
1363 hash_badge = simple_hash("badge.svg");
1364 hash_alarms = simple_hash("alarms");
1365 hash_alarm_log = simple_hash("alarm_log");
1369 char *tok = mystrsep(&url, "/?&");
1371 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1372 uint32_t hash = simple_hash(tok);
1374 if(hash == hash_data && !strcmp(tok, "data"))
1375 return web_client_api_request_v1_data(w, url);
1377 else if(hash == hash_chart && !strcmp(tok, "chart"))
1378 return web_client_api_request_v1_chart(w, url);
1380 else if(hash == hash_charts && !strcmp(tok, "charts"))
1381 return web_client_api_request_v1_charts(w, url);
1383 else if(hash == hash_registry && !strcmp(tok, "registry"))
1384 return web_client_api_request_v1_registry(w, url);
1386 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1387 return web_client_api_request_v1_badge(w, url);
1389 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1390 return web_client_api_request_v1_alarms(w, url);
1392 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1393 return web_client_api_request_v1_alarm_log(w, url);
1396 buffer_flush(w->response.data);
1397 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1402 buffer_flush(w->response.data);
1403 buffer_sprintf(w->response.data, "API v1 command?");
1408 int web_client_api_request(struct web_client *w, char *url)
1410 // get the api version
1411 char *tok = mystrsep(&url, "/?&");
1413 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1414 if(strcmp(tok, "v1") == 0)
1415 return web_client_api_request_v1(w, url);
1417 buffer_flush(w->response.data);
1418 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1423 buffer_flush(w->response.data);
1424 buffer_sprintf(w->response.data, "Which API version?");
1429 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1433 char *args = strchr(url, '?');
1439 // get the name of the data to show
1440 char *tok = mystrsep(&url, "/");
1443 // do we have such a data set?
1445 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1446 st = rrdset_find_byname(tok);
1447 if(!st) st = rrdset_find(tok);
1452 // try to send a file with that name
1453 buffer_flush(w->response.data);
1454 return(mysendfile(w, tok));
1458 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1460 // how many entries does the client want?
1461 int lines = rrd_default_history_entries;
1462 int group_count = 1;
1463 time_t after = 0, before = 0;
1464 int group_method = GROUP_AVERAGE;
1468 // parse the lines required
1469 tok = mystrsep(&url, "/");
1470 if(tok) lines = atoi(tok);
1471 if(lines < 1) lines = 1;
1474 // parse the group count required
1475 tok = mystrsep(&url, "/");
1476 if(tok && *tok) group_count = atoi(tok);
1477 if(group_count < 1) group_count = 1;
1478 //if(group_count > save_history / 20) group_count = save_history / 20;
1481 // parse the grouping method required
1482 tok = mystrsep(&url, "/");
1484 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1485 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1486 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1487 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1492 tok = mystrsep(&url, "/");
1493 if(tok && *tok) after = strtoul(tok, NULL, 10);
1494 if(after < 0) after = 0;
1497 // parse before time
1498 tok = mystrsep(&url, "/");
1499 if(tok && *tok) before = strtoul(tok, NULL, 10);
1500 if(before < 0) before = 0;
1504 tok = mystrsep(&url, "/");
1505 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1508 w->response.data->contenttype = CT_APPLICATION_JSON;
1509 buffer_flush(w->response.data);
1511 char *google_version = "0.6";
1512 char *google_reqId = "0";
1513 char *google_sig = "0";
1514 char *google_out = "json";
1515 char *google_responseHandler = "google.visualization.Query.setResponse";
1516 char *google_outFileName = NULL;
1517 time_t last_timestamp_in_data = 0;
1518 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1520 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1523 tok = mystrsep(&args, "&");
1525 char *name = mystrsep(&tok, "=");
1526 if(name && *name && strcmp(name, "tqx") == 0) {
1527 char *key = mystrsep(&tok, ":");
1528 char *value = mystrsep(&tok, ";");
1529 if(key && value && *key && *value) {
1530 if(strcmp(key, "version") == 0)
1531 google_version = value;
1533 else if(strcmp(key, "reqId") == 0)
1534 google_reqId = value;
1536 else if(strcmp(key, "sig") == 0)
1539 else if(strcmp(key, "out") == 0)
1542 else if(strcmp(key, "responseHandler") == 0)
1543 google_responseHandler = value;
1545 else if(strcmp(key, "outFileName") == 0)
1546 google_outFileName = value;
1552 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1553 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1556 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1557 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1559 // check the client wants json
1560 if(strcmp(google_out, "json") != 0) {
1561 buffer_sprintf(w->response.data,
1562 "%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.'}]});",
1563 google_responseHandler, google_version, google_reqId, google_out);
1569 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1570 buffer_sprintf(w->response.data,
1571 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1572 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1575 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1576 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1578 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);
1580 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1581 if(timestamp_in_data > last_timestamp_in_data)
1582 buffer_strcat(w->response.data, "});");
1585 // the client already has the latest data
1586 buffer_flush(w->response.data);
1587 buffer_sprintf(w->response.data,
1588 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1589 google_responseHandler, google_version, google_reqId);
1596 const char *web_content_type_to_string(uint8_t contenttype) {
1597 switch(contenttype) {
1599 return "text/html; charset=utf-8";
1601 case CT_APPLICATION_XML:
1602 return "application/xml; charset=utf-8";
1604 case CT_APPLICATION_JSON:
1605 return "application/json; charset=utf-8";
1607 case CT_APPLICATION_X_JAVASCRIPT:
1608 return "application/x-javascript; charset=utf-8";
1611 return "text/css; charset=utf-8";
1614 return "text/xml; charset=utf-8";
1617 return "text/xsl; charset=utf-8";
1619 case CT_APPLICATION_OCTET_STREAM:
1620 return "application/octet-stream";
1622 case CT_IMAGE_SVG_XML:
1623 return "image/svg+xml";
1625 case CT_APPLICATION_X_FONT_TRUETYPE:
1626 return "application/x-font-truetype";
1628 case CT_APPLICATION_X_FONT_OPENTYPE:
1629 return "application/x-font-opentype";
1631 case CT_APPLICATION_FONT_WOFF:
1632 return "application/font-woff";
1634 case CT_APPLICATION_FONT_WOFF2:
1635 return "application/font-woff2";
1637 case CT_APPLICATION_VND_MS_FONTOBJ:
1638 return "application/vnd.ms-fontobject";
1644 return "image/jpeg";
1649 case CT_IMAGE_XICON:
1650 return "image/x-icon";
1656 return "image/icns";
1660 return "text/plain; charset=utf-8";
1665 const char *web_response_code_to_string(int code) {
1671 return "Temporary Redirect";
1674 return "Bad Request";
1683 return "Preconditions Failed";
1686 if(code >= 100 && code < 200)
1687 return "Informational";
1689 if(code >= 200 && code < 300)
1690 return "Successful";
1692 if(code >= 300 && code < 400)
1693 return "Redirection";
1695 if(code >= 400 && code < 500)
1696 return "Bad Request";
1698 if(code >= 500 && code < 600)
1699 return "Server Error";
1701 return "Undefined Error";
1705 static inline char *http_header_parse(struct web_client *w, char *s) {
1706 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1708 if(unlikely(!hash_origin)) {
1709 hash_origin = simple_uhash("Origin");
1710 hash_connection = simple_uhash("Connection");
1711 hash_accept_encoding = simple_uhash("Accept-Encoding");
1712 hash_donottrack = simple_uhash("DNT");
1718 while(*e && *e != ':') e++;
1725 char *v = e + 1, *ve;
1727 // skip leading spaces from value
1728 while(*v == ' ') v++;
1732 while(*ve && *ve != '\r') ve++;
1733 if(!*ve || ve[1] != '\n') {
1738 // terminate the value
1741 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1742 uint32_t hash = simple_uhash(s);
1744 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1745 strncpyz(w->origin, v, ORIGIN_MAX);
1747 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1748 if(strcasestr(v, "keep-alive"))
1751 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1752 if(*v == '0') w->donottrack = 0;
1753 else if(*v == '1') w->donottrack = 1;
1755 #ifdef NETDATA_WITH_ZLIB
1756 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1757 if(web_enable_gzip) {
1758 if(strcasestr(v, "gzip"))
1759 web_client_enable_deflate(w, 1);
1761 // does not seem to work
1762 // else if(strcasestr(v, "deflate"))
1763 // web_client_enable_deflate(w, 0);
1766 #endif /* NETDATA_WITH_ZLIB */
1773 // http_request_validate()
1775 // = 0 : all good, process the request
1776 // > 0 : request is not supported
1777 // < 0 : request is incomplete - wait for more data
1779 static inline int http_request_validate(struct web_client *w) {
1780 char *s = w->response.data->buffer, *encoded_url = NULL;
1782 // is is a valid request?
1783 if(!strncmp(s, "GET ", 4)) {
1784 encoded_url = s = &s[4];
1785 w->mode = WEB_CLIENT_MODE_NORMAL;
1787 else if(!strncmp(s, "OPTIONS ", 8)) {
1788 encoded_url = s = &s[8];
1789 w->mode = WEB_CLIENT_MODE_OPTIONS;
1792 w->wait_receive = 0;
1796 // find the SPACE + "HTTP/"
1798 // find the next space
1799 while (*s && *s != ' ') s++;
1801 // is it SPACE + "HTTP/" ?
1802 if(*s && !strncmp(s, " HTTP/", 6)) break;
1806 // incomplete requests
1808 w->wait_receive = 1;
1812 // we have the end of encoded_url - remember it
1815 // make sure we have complete request
1816 // complete requests contain: \r\n\r\n
1819 while(*s && *s++ != '\r');
1821 // did we reach the end?
1822 if(unlikely(!*s)) break;
1825 if(likely(*s++ == '\n')) {
1827 // is it again \r\n ? (header end)
1828 if(unlikely(*s == '\r' && s[1] == '\n')) {
1829 // a valid complete HTTP request found
1832 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1835 // copy the URL - we are going to overwrite parts of it
1836 // FIXME -- we should avoid it
1837 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1839 w->wait_receive = 0;
1843 // another header line
1844 s = http_header_parse(w, s);
1848 // incomplete request
1849 w->wait_receive = 1;
1853 void web_client_process(struct web_client *w) {
1854 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1855 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1858 gettimeofday(&w->tv_in, NULL);
1860 if(unlikely(!hash_api)) {
1861 hash_api = simple_hash("api");
1862 hash_netdata_conf = simple_hash("netdata.conf");
1863 hash_data = simple_hash(WEB_PATH_DATA);
1864 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1865 hash_graph = simple_hash(WEB_PATH_GRAPH);
1866 hash_list = simple_hash("list");
1867 hash_all_json = simple_hash("all.json");
1868 hash_exit = simple_hash("exit");
1869 hash_debug = simple_hash("debug");
1870 hash_mirror = simple_hash("mirror");
1876 int what_to_do = http_request_validate(w);
1878 // wait for more data
1879 if(what_to_do < 0) {
1880 if(w->response.data->len > TOO_BIG_REQUEST) {
1881 strcpy(w->last_url, "too big request");
1883 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1886 buffer_flush(w->response.data);
1887 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1890 // wait for more data
1894 else if(what_to_do > 0) {
1895 // strcpy(w->last_url, "not a valid request");
1897 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1900 buffer_flush(w->response.data);
1901 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1903 else { // what_to_do == 0
1904 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1906 w->response.data->contenttype = CT_TEXT_PLAIN;
1907 buffer_flush(w->response.data);
1908 buffer_strcat(w->response.data, "OK");
1911 char *url = w->decoded_url;
1912 char *tok = mystrsep(&url, "/?");
1914 uint32_t hash = simple_hash(tok);
1915 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1917 if(hash == hash_api && strcmp(tok, "api") == 0) {
1918 // the client is requesting api access
1919 code = web_client_api_request(w, url);
1921 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1923 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1925 w->response.data->contenttype = CT_TEXT_PLAIN;
1926 buffer_flush(w->response.data);
1927 generate_config(w->response.data, 0);
1929 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1930 // the client is requesting rrd data -- OLD API
1931 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1933 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1934 // the client is requesting google datasource -- OLD API
1935 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1937 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1938 // the client is requesting an rrd graph -- OLD API
1940 // get the name of the data to show
1941 tok = mystrsep(&url, "/?&");
1943 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1945 // do we have such a data set?
1946 RRDSET *st = rrdset_find_byname(tok);
1947 if(!st) st = rrdset_find(tok);
1950 // try to send a file with that name
1951 buffer_flush(w->response.data);
1952 code = mysendfile(w, tok);
1956 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1957 w->response.data->contenttype = CT_APPLICATION_JSON;
1958 buffer_flush(w->response.data);
1959 rrd_stats_graph_json(st, url, w->response.data);
1964 buffer_flush(w->response.data);
1965 buffer_strcat(w->response.data, "Graph name?\r\n");
1968 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1972 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1974 buffer_flush(w->response.data);
1975 RRDSET *st = localhost.rrdset_root;
1977 for ( ; st ; st = st->next )
1978 buffer_sprintf(w->response.data, "%s\n", st->name);
1980 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1983 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1985 w->response.data->contenttype = CT_APPLICATION_JSON;
1986 buffer_flush(w->response.data);
1987 rrd_stats_all_json(w->response.data);
1989 #ifdef NETDATA_INTERNAL_CHECKS
1990 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1992 w->response.data->contenttype = CT_TEXT_PLAIN;
1993 buffer_flush(w->response.data);
1996 buffer_strcat(w->response.data, "ok, will do...");
1998 buffer_strcat(w->response.data, "I am doing it already");
2000 error("web request to exit received.");
2001 netdata_cleanup_and_exit(0);
2004 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2005 buffer_flush(w->response.data);
2007 // get the name of the data to show
2008 tok = mystrsep(&url, "/?&");
2010 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2012 // do we have such a data set?
2013 RRDSET *st = rrdset_find_byname(tok);
2014 if(!st) st = rrdset_find(tok);
2017 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
2018 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2022 debug_flags |= D_RRD_STATS;
2023 st->debug = !st->debug;
2024 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
2025 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2030 buffer_flush(w->response.data);
2031 buffer_strcat(w->response.data, "debug which chart?\r\n");
2034 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2037 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2039 // replace the zero bytes with spaces
2040 buffer_char_replace(w->response.data, '\0', ' ');
2042 // just leave the buffer as is
2043 // it will be copied back to the client
2045 #endif /* NETDATA_INTERNAL_CHECKS */
2047 char filename[FILENAME_MAX+1];
2049 strncpyz(filename, w->last_url, FILENAME_MAX);
2050 tok = mystrsep(&url, "?");
2051 buffer_flush(w->response.data);
2052 code = mysendfile(w, (tok && *tok)?tok:"/");
2056 char filename[FILENAME_MAX+1];
2058 strncpyz(filename, w->last_url, FILENAME_MAX);
2059 tok = mystrsep(&url, "?");
2060 buffer_flush(w->response.data);
2061 code = mysendfile(w, (tok && *tok)?tok:"/");
2066 gettimeofday(&w->tv_ready, NULL);
2067 w->response.data->date = time(NULL);
2068 w->response.sent = 0;
2069 w->response.code = code;
2071 // prepare the HTTP response header
2072 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2074 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2075 const char *code_msg = web_response_code_to_string(code);
2078 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
2079 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2081 buffer_sprintf(w->response.header_output,
2082 "HTTP/1.1 %d %s\r\n"
2083 "Connection: %s\r\n"
2084 "Server: NetData Embedded HTTP Server\r\n"
2085 "Access-Control-Allow-Origin: %s\r\n"
2086 "Access-Control-Allow-Credentials: true\r\n"
2087 "Content-Type: %s\r\n"
2090 , w->keepalive?"keep-alive":"close"
2092 , content_type_string
2096 if(w->cookie1[0] || w->cookie2[0]) {
2098 buffer_sprintf(w->response.header_output,
2099 "Set-Cookie: %s\r\n",
2104 buffer_sprintf(w->response.header_output,
2105 "Set-Cookie: %s\r\n",
2109 if(web_donotrack_comply)
2110 buffer_sprintf(w->response.header_output,
2111 "Tk: T;cookies\r\n");
2114 if(web_donotrack_comply) {
2115 if(w->tracking_required)
2116 buffer_sprintf(w->response.header_output,
2117 "Tk: T;cookies\r\n");
2119 buffer_sprintf(w->response.header_output,
2124 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2125 buffer_strcat(w->response.header_output,
2126 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2127 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
2128 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2132 if(buffer_strlen(w->response.header))
2133 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2135 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
2136 buffer_sprintf(w->response.header_output,
2138 "Cache-Control: no-cache\r\n"
2141 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
2143 time_t et = w->response.data->date + (86400 * 14);
2144 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
2145 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
2147 buffer_sprintf(w->response.header_output,
2149 "Cache-Control: public\r\n"
2153 // if we know the content length, put it
2154 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
2155 buffer_sprintf(w->response.header_output,
2156 "Content-Length: %zu\r\n"
2157 , w->response.data->len? w->response.data->len: w->response.rlen
2159 else if(!w->response.zoutput)
2160 w->keepalive = 0; // content-length is required for keep-alive
2162 if(w->response.zoutput) {
2163 buffer_strcat(w->response.header_output,
2164 "Content-Encoding: gzip\r\n"
2165 "Transfer-Encoding: chunked\r\n"
2169 buffer_strcat(w->response.header_output, "\r\n");
2171 // sent the HTTP header
2172 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2174 , buffer_strlen(w->response.header_output)
2175 , buffer_tostring(w->response.header_output)
2178 web_client_crock_socket(w);
2180 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2181 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2183 w->stats_sent_bytes += bytes;
2185 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2187 , buffer_strlen(w->response.header_output)
2190 WEB_CLIENT_IS_DEAD(w);
2194 w->stats_sent_bytes += bytes;
2196 // enable sending immediately if we have data
2197 if(w->response.data->len) w->wait_send = 1;
2198 else w->wait_send = 0;
2202 case WEB_CLIENT_MODE_OPTIONS:
2203 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2206 case WEB_CLIENT_MODE_NORMAL:
2207 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2210 case WEB_CLIENT_MODE_FILECOPY:
2211 if(w->response.rlen) {
2212 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2213 w->wait_receive = 1;
2216 // utilize the kernel sendfile() for copying the file to the socket.
2217 // this block of code can be commented, without anything missing.
2218 // when it is commented, the program will copy the data using async I/O.
2220 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2221 if(len != w->response.data->rbytes)
2222 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2224 web_client_reset(w);
2229 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2233 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2238 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2240 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2242 sprintf(buf, "%zX\r\n", len);
2244 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2246 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2247 w->stats_sent_bytes += bytes;
2250 else if(bytes == 0) {
2251 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2252 WEB_CLIENT_IS_DEAD(w);
2255 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2256 WEB_CLIENT_IS_DEAD(w);
2262 ssize_t web_client_send_chunk_close(struct web_client *w)
2264 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2266 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2268 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2269 w->stats_sent_bytes += bytes;
2272 else if(bytes == 0) {
2273 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2274 WEB_CLIENT_IS_DEAD(w);
2277 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2278 WEB_CLIENT_IS_DEAD(w);
2284 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2286 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2288 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2290 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2291 w->stats_sent_bytes += bytes;
2294 else if(bytes == 0) {
2295 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2296 WEB_CLIENT_IS_DEAD(w);
2299 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2300 WEB_CLIENT_IS_DEAD(w);
2306 #ifdef NETDATA_WITH_ZLIB
2307 ssize_t web_client_send_deflate(struct web_client *w)
2309 ssize_t len = 0, t = 0;
2311 // when using compression,
2312 // w->response.sent is the amount of bytes passed through compression
2314 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 = %u, w->response.zstream.avail_out = %u, w->response.zstream.total_in = %lu, w->response.zstream.total_out = %lu.",
2315 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);
2317 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) {
2318 // there is nothing to send
2320 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2322 // finalize the chunk
2323 if(w->response.sent != 0) {
2324 t = web_client_send_chunk_finalize(w);
2328 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2329 // we have to wait, more data will come
2330 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2335 if(unlikely(!w->keepalive)) {
2336 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2337 WEB_CLIENT_IS_DEAD(w);
2342 web_client_reset(w);
2343 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2347 if(w->response.zhave == w->response.zsent) {
2348 // compress more input data
2350 // close the previous open chunk
2351 if(w->response.sent != 0) {
2352 t = web_client_send_chunk_close(w);
2356 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);
2358 // give the compressor all the data not passed through the compressor yet
2359 if(w->response.data->len > w->response.sent) {
2360 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2361 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2364 // reset the compressor output buffer
2365 w->response.zstream.next_out = w->response.zbuffer;
2366 w->response.zstream.avail_out = ZLIB_CHUNK;
2368 // ask for FINISH if we have all the input
2369 int flush = Z_SYNC_FLUSH;
2370 if(w->mode == WEB_CLIENT_MODE_NORMAL
2371 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2373 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2376 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2380 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2381 error("%llu: Compression failed. Closing down client.", w->id);
2382 web_client_reset(w);
2386 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2387 w->response.zsent = 0;
2389 // keep track of the bytes passed through the compressor
2390 w->response.sent = w->response.data->len;
2392 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2395 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2396 if(t2 < 0) return t2;
2400 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2402 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2404 w->stats_sent_bytes += len;
2405 w->response.zsent += len;
2407 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2410 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2411 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2413 WEB_CLIENT_IS_DEAD(w);
2416 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2417 WEB_CLIENT_IS_DEAD(w);
2422 #endif // NETDATA_WITH_ZLIB
2424 ssize_t web_client_send(struct web_client *w) {
2425 #ifdef NETDATA_WITH_ZLIB
2426 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2427 #endif // NETDATA_WITH_ZLIB
2431 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2432 // there is nothing to send
2434 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2436 // there can be two cases for this
2437 // A. we have done everything
2438 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2440 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2441 // we have to wait, more data will come
2442 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2447 if(unlikely(!w->keepalive)) {
2448 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2449 WEB_CLIENT_IS_DEAD(w);
2453 web_client_reset(w);
2454 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2458 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2459 if(likely(bytes > 0)) {
2460 w->stats_sent_bytes += bytes;
2461 w->response.sent += bytes;
2462 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2464 else if(likely(bytes == 0)) {
2465 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2466 WEB_CLIENT_IS_DEAD(w);
2469 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2470 WEB_CLIENT_IS_DEAD(w);
2476 ssize_t web_client_receive(struct web_client *w)
2478 // do we have any space for more data?
2479 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2481 ssize_t left = w->response.data->size - w->response.data->len;
2484 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2485 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2487 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2489 if(likely(bytes > 0)) {
2490 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2491 w->stats_received_bytes += bytes;
2493 size_t old = w->response.data->len;
2494 w->response.data->len += bytes;
2495 w->response.data->buffer[w->response.data->len] = '\0';
2497 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2498 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2500 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2503 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2504 w->wait_receive = 0;
2507 else if(likely(bytes == 0)) {
2508 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2510 // if we cannot read, it means we have an error on input.
2511 // if however, we are copying a file from ifd to ofd, we should not return an error.
2512 // in this case, the error should be generated when the file has been sent to the client.
2514 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2515 // we are copying data from ifd to ofd
2516 // let it finish copying...
2517 w->wait_receive = 0;
2519 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2520 if(w->ifd != w->ofd) close(w->ifd);
2524 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2525 WEB_CLIENT_IS_DEAD(w);
2529 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2530 WEB_CLIENT_IS_DEAD(w);
2537 // --------------------------------------------------------------------------------------
2538 // the thread of a single client
2540 // 1. waits for input and output, using async I/O
2541 // 2. it processes HTTP requests
2542 // 3. it generates HTTP responses
2543 // 4. it copies data from input to output if mode is FILECOPY
2545 void *web_client_main(void *ptr)
2547 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2548 error("Cannot set pthread cancel type to DEFERRED.");
2550 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2551 error("Cannot set pthread cancel state to ENABLE.");
2553 struct web_client *w = ptr;
2554 struct pollfd fds[2], *ifd, *ofd;
2555 int retval, fdmax = 0, timeout;
2557 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2560 if(unlikely(w->dead)) {
2561 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2564 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2565 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2569 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2570 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2574 if(w->ifd == w->ofd) {
2579 if(w->wait_receive) fds[0].events |= POLLIN;
2580 if(w->wait_send) fds[0].events |= POLLOUT;
2586 ifd = ofd = &fds[0];
2594 if(w->wait_receive) fds[0].events |= POLLIN;
2600 if(w->wait_send) fds[1].events |= POLLOUT;
2606 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2608 timeout = web_client_timeout * 1000;
2609 retval = poll(fds, fdmax, timeout);
2611 if(unlikely(retval == -1)) {
2612 if(errno == EAGAIN || errno == EINTR) {
2613 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2617 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2620 else if(unlikely(!retval)) {
2621 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":"");
2626 if(w->wait_send && ofd->revents & POLLOUT) {
2628 if(web_client_send(w) < 0) {
2629 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2634 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2636 if(web_client_receive(w) < 0) {
2637 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2641 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2642 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2643 web_client_process(w);
2647 if(unlikely(!used)) {
2648 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2653 web_client_reset(w);
2655 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2656 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2658 // close the sockets/files now
2659 // to free file descriptors
2660 if(w->ifd == w->ofd) {
2661 if(w->ifd != -1) close(w->ifd);
2664 if(w->ifd != -1) close(w->ifd);
2665 if(w->ofd != -1) close(w->ofd);