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) {
632 case GROUP_INCREMENTAL_SUM:
633 return "incremental-sum";
636 return "unknown-group-method";
640 int web_client_api_request_v1_data_group(char *name, int def)
642 if(!strcmp(name, "average"))
643 return GROUP_AVERAGE;
645 else if(!strcmp(name, "min"))
648 else if(!strcmp(name, "max"))
651 else if(!strcmp(name, "sum"))
654 else if(!strcmp(name, "incremental-sum"))
655 return GROUP_INCREMENTAL_SUM;
660 int web_client_api_request_v1_charts(struct web_client *w, char *url)
664 buffer_flush(w->response.data);
665 w->response.data->contenttype = CT_APPLICATION_JSON;
666 rrd_stats_api_v1_charts(w->response.data);
670 int web_client_api_request_v1_chart(struct web_client *w, char *url)
675 buffer_flush(w->response.data);
678 char *value = mystrsep(&url, "?&[]");
679 if(!value || !*value) continue;
681 char *name = mystrsep(&value, "=");
682 if(!name || !*name) continue;
683 if(!value || !*value) continue;
685 // name and value are now the parameters
686 // they are not null and not empty
688 if(!strcmp(name, "chart")) chart = value;
690 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
695 if(!chart || !*chart) {
696 buffer_sprintf(w->response.data, "No chart id is given at the request.");
700 RRDSET *st = rrdset_find(chart);
701 if(!st) st = rrdset_find_byname(chart);
703 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
708 w->response.data->contenttype = CT_APPLICATION_JSON;
709 rrd_stats_api_v1_chart(st, w->response.data);
716 int web_client_api_v1_badge(struct web_client *w, char *url) {
718 buffer_flush(w->response.data);
720 BUFFER *dimensions = NULL;
722 const char *chart = NULL
726 , *multiply_str = NULL
730 , *label_color = NULL
731 , *value_color = NULL
732 , *refresh_str = NULL
733 , *precision_str = NULL
736 int group = GROUP_AVERAGE;
737 uint32_t options = 0x00000000;
740 char *value = mystrsep(&url, "/?&[]");
741 if(!value || !*value) continue;
743 char *name = mystrsep(&value, "=");
744 if(!name || !*name) continue;
745 if(!value || !*value) continue;
747 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
749 // name and value are now the parameters
750 // they are not null and not empty
752 if(!strcmp(name, "chart")) chart = value;
753 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
755 dimensions = buffer_create(100);
757 buffer_strcat(dimensions, "|");
758 buffer_strcat(dimensions, value);
760 else if(!strcmp(name, "after")) after_str = value;
761 else if(!strcmp(name, "before")) before_str = value;
762 else if(!strcmp(name, "points")) points_str = value;
763 else if(!strcmp(name, "group")) {
764 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
766 else if(!strcmp(name, "options")) {
767 options |= web_client_api_request_v1_data_options(value);
769 else if(!strcmp(name, "label")) label = value;
770 else if(!strcmp(name, "units")) units = value;
771 else if(!strcmp(name, "label_color")) label_color = value;
772 else if(!strcmp(name, "value_color")) value_color = value;
773 else if(!strcmp(name, "multiply")) multiply_str = value;
774 else if(!strcmp(name, "divide")) divide_str = value;
775 else if(!strcmp(name, "refresh")) refresh_str = value;
776 else if(!strcmp(name, "precision")) precision_str = value;
777 else if(!strcmp(name, "alarm")) alarm = value;
780 if(!chart || !*chart) {
781 buffer_sprintf(w->response.data, "No chart id is given at the request.");
785 RRDSET *st = rrdset_find(chart);
786 if(!st) st = rrdset_find_byname(chart);
788 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
795 rc = rrdcalc_find(st, alarm);
797 buffer_svg(w->response.data, "alarm not found", 0, "", NULL, NULL, 1, -1);
803 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
804 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
805 long long before = (before_str && *before_str )?atol(before_str):0;
806 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
807 int points = (points_str && *points_str )?atoi(points_str):1;
808 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
810 if(!multiply) multiply = 1;
811 if(!divide) divide = 1;
814 if(refresh_str && *refresh_str) {
815 if(!strcmp(refresh_str, "auto")) {
816 if(rc) refresh = rc->update_every;
817 else if(options & RRDR_OPTION_NOT_ALIGNED)
818 refresh = st->update_every;
820 refresh = (before - after);
821 if(refresh < 0) refresh = -refresh;
825 refresh = atoi(refresh_str);
826 if(refresh < 0) refresh = -refresh;
833 else if(dimensions) {
834 const char *dim = buffer_tostring(dimensions);
835 if(*dim == '|') dim++;
842 if(options & RRDR_OPTION_PERCENTAGE)
848 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'"
852 , (dimensions)?buffer_tostring(dimensions):""
861 calculated_number n = rc->value;
862 if(isnan(n) || isinf(n)) n = 0;
865 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
869 case RRDCALC_STATUS_CRITICAL:
873 case RRDCALC_STATUS_WARNING:
874 value_color = "orange";
877 case RRDCALC_STATUS_CLEAR:
878 value_color = "brightgreen";
881 case RRDCALC_STATUS_UNDEFINED:
882 value_color = "lightgrey";
885 case RRDCALC_STATUS_UNINITIALIZED:
886 value_color = "#000";
890 value_color = "grey";
895 buffer_svg(w->response.data, label, rc->value * multiply / divide, units, label_color, value_color, 0, precision);
899 time_t latest_timestamp = 0;
900 int value_is_null = 1;
901 calculated_number n = 0;
904 // if the collected value is too old, don't calculate its value
905 if (rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
906 ret = rrd2value(st, w->response.data, &n, (dimensions) ? buffer_tostring(dimensions) : NULL, points, after,
907 before, group, options, NULL, &latest_timestamp, &value_is_null);
909 // if the value cannot be calculated, show empty badge
915 else if (refresh > 0)
916 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
919 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null,
925 buffer_free(dimensions);
929 // returns the HTTP code
930 int web_client_api_request_v1_data(struct web_client *w, char *url)
932 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
935 BUFFER *dimensions = NULL;
937 buffer_flush(w->response.data);
939 char *google_version = "0.6",
942 *google_out = "json",
943 *responseHandler = NULL,
946 time_t last_timestamp_in_data = 0, google_timestamp = 0;
951 , *points_str = NULL;
953 int group = GROUP_AVERAGE;
954 uint32_t format = DATASOURCE_JSON;
955 uint32_t options = 0x00000000;
958 char *value = mystrsep(&url, "?&[]");
959 if(!value || !*value) continue;
961 char *name = mystrsep(&value, "=");
962 if(!name || !*name) continue;
963 if(!value || !*value) continue;
965 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
967 // name and value are now the parameters
968 // they are not null and not empty
970 if(!strcmp(name, "chart")) chart = value;
971 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
972 if(!dimensions) dimensions = buffer_create(100);
973 buffer_strcat(dimensions, "|");
974 buffer_strcat(dimensions, value);
976 else if(!strcmp(name, "after")) after_str = value;
977 else if(!strcmp(name, "before")) before_str = value;
978 else if(!strcmp(name, "points")) points_str = value;
979 else if(!strcmp(name, "group")) {
980 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
982 else if(!strcmp(name, "format")) {
983 format = web_client_api_request_v1_data_format(value);
985 else if(!strcmp(name, "options")) {
986 options |= web_client_api_request_v1_data_options(value);
988 else if(!strcmp(name, "callback")) {
989 responseHandler = value;
991 else if(!strcmp(name, "filename")) {
994 else if(!strcmp(name, "tqx")) {
995 // parse Google Visualization API options
996 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
997 char *tqx_name, *tqx_value;
1000 tqx_value = mystrsep(&value, ";");
1001 if(!tqx_value || !*tqx_value) continue;
1003 tqx_name = mystrsep(&tqx_value, ":");
1004 if(!tqx_name || !*tqx_name) continue;
1005 if(!tqx_value || !*tqx_value) continue;
1007 if(!strcmp(tqx_name, "version"))
1008 google_version = tqx_value;
1009 else if(!strcmp(tqx_name, "reqId"))
1010 google_reqId = tqx_value;
1011 else if(!strcmp(tqx_name, "sig")) {
1012 google_sig = tqx_value;
1013 google_timestamp = strtoul(google_sig, NULL, 0);
1015 else if(!strcmp(tqx_name, "out")) {
1016 google_out = tqx_value;
1017 format = web_client_api_request_v1_data_google_format(google_out);
1019 else if(!strcmp(tqx_name, "responseHandler"))
1020 responseHandler = tqx_value;
1021 else if(!strcmp(tqx_name, "outFileName"))
1022 outFileName = tqx_value;
1027 if(!chart || !*chart) {
1028 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1032 RRDSET *st = rrdset_find(chart);
1033 if(!st) st = rrdset_find_byname(chart);
1035 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
1040 long long before = (before_str && *before_str)?atol(before_str):0;
1041 long long after = (after_str && *after_str) ?atol(after_str):0;
1042 int points = (points_str && *points_str)?atoi(points_str):0;
1044 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'"
1047 , (dimensions)?buffer_tostring(dimensions):""
1056 if(outFileName && *outFileName) {
1057 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1058 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1061 if(format == DATASOURCE_DATATABLE_JSONP) {
1062 if(responseHandler == NULL)
1063 responseHandler = "google.visualization.Query.setResponse";
1065 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1066 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1069 buffer_sprintf(w->response.data,
1070 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1071 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1073 else if(format == DATASOURCE_JSONP) {
1074 if(responseHandler == NULL)
1075 responseHandler = "callback";
1077 buffer_strcat(w->response.data, responseHandler);
1078 buffer_strcat(w->response.data, "(");
1081 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1083 if(format == DATASOURCE_DATATABLE_JSONP) {
1084 if(google_timestamp < last_timestamp_in_data)
1085 buffer_strcat(w->response.data, "});");
1088 // the client already has the latest data
1089 buffer_flush(w->response.data);
1090 buffer_sprintf(w->response.data,
1091 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1092 responseHandler, google_version, google_reqId);
1095 else if(format == DATASOURCE_JSONP)
1096 buffer_strcat(w->response.data, ");");
1099 if(dimensions) buffer_free(dimensions);
1103 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1105 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1106 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1107 hash_to = 0 /*, hash_redirects = 0 */;
1109 if(unlikely(!hash_action)) {
1110 hash_action = simple_hash("action");
1111 hash_access = simple_hash("access");
1112 hash_hello = simple_hash("hello");
1113 hash_delete = simple_hash("delete");
1114 hash_search = simple_hash("search");
1115 hash_switch = simple_hash("switch");
1116 hash_machine = simple_hash("machine");
1117 hash_url = simple_hash("url");
1118 hash_name = simple_hash("name");
1119 hash_delete_url = simple_hash("delete_url");
1120 hash_for = simple_hash("for");
1121 hash_to = simple_hash("to");
1123 hash_redirects = simple_hash("redirects");
1127 char person_guid[36 + 1] = "";
1129 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1132 // The browser may send multiple cookies with our id
1134 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1136 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1139 char *machine_guid = NULL,
1140 *machine_url = NULL,
1142 *search_machine_guid = NULL,
1144 *to_person_guid = NULL;
1150 char *value = mystrsep(&url, "?&[]");
1151 if (!value || !*value) continue;
1153 char *name = mystrsep(&value, "=");
1154 if (!name || !*name) continue;
1155 if (!value || !*value) continue;
1157 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1159 uint32_t hash = simple_hash(name);
1161 if(hash == hash_action && !strcmp(name, "action")) {
1162 uint32_t vhash = simple_hash(value);
1164 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1165 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1166 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1167 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1168 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1169 #ifdef NETDATA_INTERNAL_CHECKS
1170 else error("unknown registry action '%s'", value);
1171 #endif /* NETDATA_INTERNAL_CHECKS */
1174 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1175 redirects = atoi(value);
1177 else if(hash == hash_machine && !strcmp(name, "machine"))
1178 machine_guid = value;
1180 else if(hash == hash_url && !strcmp(name, "url"))
1181 machine_url = value;
1183 else if(action == 'A') {
1184 if(hash == hash_name && !strcmp(name, "name"))
1187 else if(action == 'D') {
1188 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1191 else if(action == 'S') {
1192 if(hash == hash_for && !strcmp(name, "for"))
1193 search_machine_guid = value;
1195 else if(action == 'W') {
1196 if(hash == hash_to && !strcmp(name, "to"))
1197 to_person_guid = value;
1199 #ifdef NETDATA_INTERNAL_CHECKS
1200 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1201 #endif /* NETDATA_INTERNAL_CHECKS */
1204 if(web_donotrack_comply && w->donottrack) {
1205 buffer_flush(w->response.data);
1206 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.");
1210 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1211 buffer_flush(w->response.data);
1212 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1213 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1216 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1217 buffer_flush(w->response.data);
1218 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1219 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1222 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1223 buffer_flush(w->response.data);
1224 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1225 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1228 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1229 buffer_flush(w->response.data);
1230 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1231 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1237 w->tracking_required = 1;
1238 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1239 buffer_flush(w->response.data);
1241 registry_set_cookie(w, "give-me-back-this-cookie-please");
1242 w->response.data->contenttype = CT_APPLICATION_JSON;
1243 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1247 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1248 * under certain conditions, when using CORS
1249 * so this is commented and we use application level redirects instead
1253 if(redirects > registry_verify_cookies_redirects()) {
1254 buffer_flush(w->response.data);
1255 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1259 char *encoded_url = url_encode(machine_url);
1261 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1265 char *encoded_name = url_encode(url_name);
1268 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1272 char *encoded_guid = url_encode(machine_guid);
1276 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1280 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1281 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1289 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1292 w->tracking_required = 1;
1293 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1296 w->tracking_required = 1;
1297 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1300 w->tracking_required = 1;
1301 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1304 return registry_request_hello_json(w);
1307 buffer_flush(w->response.data);
1308 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1313 int web_client_api_request_v1(struct web_client *w, char *url) {
1314 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1316 if(unlikely(hash_data == 0)) {
1317 hash_data = simple_hash("data");
1318 hash_chart = simple_hash("chart");
1319 hash_charts = simple_hash("charts");
1320 hash_registry = simple_hash("registry");
1321 hash_badge = simple_hash("badge.svg");
1325 char *tok = mystrsep(&url, "/?&");
1327 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1328 uint32_t hash = simple_hash(tok);
1330 if(hash == hash_data && !strcmp(tok, "data"))
1331 return web_client_api_request_v1_data(w, url);
1333 else if(hash == hash_chart && !strcmp(tok, "chart"))
1334 return web_client_api_request_v1_chart(w, url);
1336 else if(hash == hash_charts && !strcmp(tok, "charts"))
1337 return web_client_api_request_v1_charts(w, url);
1339 else if(hash == hash_registry && !strcmp(tok, "registry"))
1340 return web_client_api_request_v1_registry(w, url);
1342 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1343 return web_client_api_v1_badge(w, url);
1346 buffer_flush(w->response.data);
1347 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1352 buffer_flush(w->response.data);
1353 buffer_sprintf(w->response.data, "API v1 command?");
1358 int web_client_api_request(struct web_client *w, char *url)
1360 // get the api version
1361 char *tok = mystrsep(&url, "/?&");
1363 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1364 if(strcmp(tok, "v1") == 0)
1365 return web_client_api_request_v1(w, url);
1367 buffer_flush(w->response.data);
1368 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1373 buffer_flush(w->response.data);
1374 buffer_sprintf(w->response.data, "Which API version?");
1379 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1383 char *args = strchr(url, '?');
1389 // get the name of the data to show
1390 char *tok = mystrsep(&url, "/");
1393 // do we have such a data set?
1395 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1396 st = rrdset_find_byname(tok);
1397 if(!st) st = rrdset_find(tok);
1402 // try to send a file with that name
1403 buffer_flush(w->response.data);
1404 return(mysendfile(w, tok));
1408 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1410 // how many entries does the client want?
1411 int lines = rrd_default_history_entries;
1412 int group_count = 1;
1413 time_t after = 0, before = 0;
1414 int group_method = GROUP_AVERAGE;
1418 // parse the lines required
1419 tok = mystrsep(&url, "/");
1420 if(tok) lines = atoi(tok);
1421 if(lines < 1) lines = 1;
1424 // parse the group count required
1425 tok = mystrsep(&url, "/");
1426 if(tok && *tok) group_count = atoi(tok);
1427 if(group_count < 1) group_count = 1;
1428 //if(group_count > save_history / 20) group_count = save_history / 20;
1431 // parse the grouping method required
1432 tok = mystrsep(&url, "/");
1434 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1435 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1436 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1437 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1442 tok = mystrsep(&url, "/");
1443 if(tok && *tok) after = strtoul(tok, NULL, 10);
1444 if(after < 0) after = 0;
1447 // parse before time
1448 tok = mystrsep(&url, "/");
1449 if(tok && *tok) before = strtoul(tok, NULL, 10);
1450 if(before < 0) before = 0;
1454 tok = mystrsep(&url, "/");
1455 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1458 w->response.data->contenttype = CT_APPLICATION_JSON;
1459 buffer_flush(w->response.data);
1461 char *google_version = "0.6";
1462 char *google_reqId = "0";
1463 char *google_sig = "0";
1464 char *google_out = "json";
1465 char *google_responseHandler = "google.visualization.Query.setResponse";
1466 char *google_outFileName = NULL;
1467 time_t last_timestamp_in_data = 0;
1468 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1470 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1473 tok = mystrsep(&args, "&");
1475 char *name = mystrsep(&tok, "=");
1476 if(name && *name && strcmp(name, "tqx") == 0) {
1477 char *key = mystrsep(&tok, ":");
1478 char *value = mystrsep(&tok, ";");
1479 if(key && value && *key && *value) {
1480 if(strcmp(key, "version") == 0)
1481 google_version = value;
1483 else if(strcmp(key, "reqId") == 0)
1484 google_reqId = value;
1486 else if(strcmp(key, "sig") == 0)
1489 else if(strcmp(key, "out") == 0)
1492 else if(strcmp(key, "responseHandler") == 0)
1493 google_responseHandler = value;
1495 else if(strcmp(key, "outFileName") == 0)
1496 google_outFileName = value;
1502 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1503 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1506 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1507 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1509 // check the client wants json
1510 if(strcmp(google_out, "json") != 0) {
1511 buffer_sprintf(w->response.data,
1512 "%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.'}]});",
1513 google_responseHandler, google_version, google_reqId, google_out);
1519 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1520 buffer_sprintf(w->response.data,
1521 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1522 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1525 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1526 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1528 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);
1530 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1531 if(timestamp_in_data > last_timestamp_in_data)
1532 buffer_strcat(w->response.data, "});");
1535 // the client already has the latest data
1536 buffer_flush(w->response.data);
1537 buffer_sprintf(w->response.data,
1538 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1539 google_responseHandler, google_version, google_reqId);
1546 const char *web_content_type_to_string(uint8_t contenttype) {
1547 switch(contenttype) {
1549 return "text/html; charset=utf-8";
1551 case CT_APPLICATION_XML:
1552 return "application/xml; charset=utf-8";
1554 case CT_APPLICATION_JSON:
1555 return "application/json; charset=utf-8";
1557 case CT_APPLICATION_X_JAVASCRIPT:
1558 return "application/x-javascript; charset=utf-8";
1561 return "text/css; charset=utf-8";
1564 return "text/xml; charset=utf-8";
1567 return "text/xsl; charset=utf-8";
1569 case CT_APPLICATION_OCTET_STREAM:
1570 return "application/octet-stream";
1572 case CT_IMAGE_SVG_XML:
1573 return "image/svg+xml";
1575 case CT_APPLICATION_X_FONT_TRUETYPE:
1576 return "application/x-font-truetype";
1578 case CT_APPLICATION_X_FONT_OPENTYPE:
1579 return "application/x-font-opentype";
1581 case CT_APPLICATION_FONT_WOFF:
1582 return "application/font-woff";
1584 case CT_APPLICATION_FONT_WOFF2:
1585 return "application/font-woff2";
1587 case CT_APPLICATION_VND_MS_FONTOBJ:
1588 return "application/vnd.ms-fontobject";
1594 return "image/jpeg";
1599 case CT_IMAGE_XICON:
1600 return "image/x-icon";
1606 return "image/icns";
1610 return "text/plain; charset=utf-8";
1615 const char *web_response_code_to_string(int code) {
1621 return "Temporary Redirect";
1624 return "Bad Request";
1633 return "Preconditions Failed";
1636 if(code >= 100 && code < 200)
1637 return "Informational";
1639 if(code >= 200 && code < 300)
1640 return "Successful";
1642 if(code >= 300 && code < 400)
1643 return "Redirection";
1645 if(code >= 400 && code < 500)
1646 return "Bad Request";
1648 if(code >= 500 && code < 600)
1649 return "Server Error";
1651 return "Undefined Error";
1655 static inline char *http_header_parse(struct web_client *w, char *s) {
1656 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1658 if(unlikely(!hash_origin)) {
1659 hash_origin = simple_uhash("Origin");
1660 hash_connection = simple_uhash("Connection");
1661 hash_accept_encoding = simple_uhash("Accept-Encoding");
1662 hash_donottrack = simple_uhash("DNT");
1668 while(*e && *e != ':') e++;
1675 char *v = e + 1, *ve;
1677 // skip leading spaces from value
1678 while(*v == ' ') v++;
1682 while(*ve && *ve != '\r') ve++;
1683 if(!*ve || ve[1] != '\n') {
1688 // terminate the value
1691 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1692 uint32_t hash = simple_uhash(s);
1694 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1695 strncpyz(w->origin, v, ORIGIN_MAX);
1697 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1698 if(strcasestr(v, "keep-alive"))
1701 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1702 if(*v == '0') w->donottrack = 0;
1703 else if(*v == '1') w->donottrack = 1;
1705 #ifdef NETDATA_WITH_ZLIB
1706 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1707 if(web_enable_gzip) {
1708 if(strcasestr(v, "gzip"))
1709 web_client_enable_deflate(w, 1);
1711 // does not seem to work
1712 // else if(strcasestr(v, "deflate"))
1713 // web_client_enable_deflate(w, 0);
1716 #endif /* NETDATA_WITH_ZLIB */
1723 // http_request_validate()
1725 // = 0 : all good, process the request
1726 // > 0 : request is not supported
1727 // < 0 : request is incomplete - wait for more data
1729 static inline int http_request_validate(struct web_client *w) {
1730 char *s = w->response.data->buffer, *encoded_url = NULL;
1732 // is is a valid request?
1733 if(!strncmp(s, "GET ", 4)) {
1734 encoded_url = s = &s[4];
1735 w->mode = WEB_CLIENT_MODE_NORMAL;
1737 else if(!strncmp(s, "OPTIONS ", 8)) {
1738 encoded_url = s = &s[8];
1739 w->mode = WEB_CLIENT_MODE_OPTIONS;
1742 w->wait_receive = 0;
1746 // find the SPACE + "HTTP/"
1748 // find the next space
1749 while (*s && *s != ' ') s++;
1751 // is it SPACE + "HTTP/" ?
1752 if(*s && !strncmp(s, " HTTP/", 6)) break;
1756 // incomplete requests
1758 w->wait_receive = 1;
1762 // we have the end of encoded_url - remember it
1765 // make sure we have complete request
1766 // complete requests contain: \r\n\r\n
1769 while(*s && *s++ != '\r');
1771 // did we reach the end?
1772 if(unlikely(!*s)) break;
1775 if(likely(*s++ == '\n')) {
1777 // is it again \r\n ? (header end)
1778 if(unlikely(*s == '\r' && s[1] == '\n')) {
1779 // a valid complete HTTP request found
1782 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1785 // copy the URL - we are going to overwrite parts of it
1786 // FIXME -- we should avoid it
1787 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1789 w->wait_receive = 0;
1793 // another header line
1794 s = http_header_parse(w, s);
1798 // incomplete request
1799 w->wait_receive = 1;
1803 void web_client_process(struct web_client *w) {
1804 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1805 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1808 gettimeofday(&w->tv_in, NULL);
1810 if(unlikely(!hash_api)) {
1811 hash_api = simple_hash("api");
1812 hash_netdata_conf = simple_hash("netdata.conf");
1813 hash_data = simple_hash(WEB_PATH_DATA);
1814 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1815 hash_graph = simple_hash(WEB_PATH_GRAPH);
1816 hash_list = simple_hash("list");
1817 hash_all_json = simple_hash("all.json");
1818 hash_exit = simple_hash("exit");
1819 hash_debug = simple_hash("debug");
1820 hash_mirror = simple_hash("mirror");
1826 int what_to_do = http_request_validate(w);
1828 // wait for more data
1829 if(what_to_do < 0) {
1830 if(w->response.data->len > TOO_BIG_REQUEST) {
1831 strcpy(w->last_url, "too big request");
1833 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1836 buffer_flush(w->response.data);
1837 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1840 // wait for more data
1844 else if(what_to_do > 0) {
1845 // strcpy(w->last_url, "not a valid request");
1847 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1850 buffer_flush(w->response.data);
1851 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1853 else { // what_to_do == 0
1854 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1856 w->response.data->contenttype = CT_TEXT_PLAIN;
1857 buffer_flush(w->response.data);
1858 buffer_strcat(w->response.data, "OK");
1861 char *url = w->decoded_url;
1862 char *tok = mystrsep(&url, "/?");
1864 uint32_t hash = simple_hash(tok);
1865 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1867 if(hash == hash_api && strcmp(tok, "api") == 0) {
1868 // the client is requesting api access
1869 code = web_client_api_request(w, url);
1871 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1873 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1875 w->response.data->contenttype = CT_TEXT_PLAIN;
1876 buffer_flush(w->response.data);
1877 generate_config(w->response.data, 0);
1879 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1880 // the client is requesting rrd data -- OLD API
1881 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1883 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1884 // the client is requesting google datasource -- OLD API
1885 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1887 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1888 // the client is requesting an rrd graph -- OLD API
1890 // get the name of the data to show
1891 tok = mystrsep(&url, "/?&");
1893 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1895 // do we have such a data set?
1896 RRDSET *st = rrdset_find_byname(tok);
1897 if(!st) st = rrdset_find(tok);
1900 // try to send a file with that name
1901 buffer_flush(w->response.data);
1902 code = mysendfile(w, tok);
1906 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1907 w->response.data->contenttype = CT_APPLICATION_JSON;
1908 buffer_flush(w->response.data);
1909 rrd_stats_graph_json(st, url, w->response.data);
1914 buffer_flush(w->response.data);
1915 buffer_strcat(w->response.data, "Graph name?\r\n");
1918 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1922 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1924 buffer_flush(w->response.data);
1925 RRDSET *st = localhost.rrdset_root;
1927 for ( ; st ; st = st->next )
1928 buffer_sprintf(w->response.data, "%s\n", st->name);
1930 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1933 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1935 w->response.data->contenttype = CT_APPLICATION_JSON;
1936 buffer_flush(w->response.data);
1937 rrd_stats_all_json(w->response.data);
1939 #ifdef NETDATA_INTERNAL_CHECKS
1940 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1942 w->response.data->contenttype = CT_TEXT_PLAIN;
1943 buffer_flush(w->response.data);
1946 buffer_strcat(w->response.data, "ok, will do...");
1948 buffer_strcat(w->response.data, "I am doing it already");
1950 error("web request to exit received.");
1951 netdata_cleanup_and_exit(0);
1954 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1955 buffer_flush(w->response.data);
1957 // get the name of the data to show
1958 tok = mystrsep(&url, "/?&");
1960 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1962 // do we have such a data set?
1963 RRDSET *st = rrdset_find_byname(tok);
1964 if(!st) st = rrdset_find(tok);
1967 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1968 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1972 debug_flags |= D_RRD_STATS;
1973 st->debug = !st->debug;
1974 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1975 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1980 buffer_flush(w->response.data);
1981 buffer_strcat(w->response.data, "debug which chart?\r\n");
1984 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1987 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1989 // replace the zero bytes with spaces
1990 buffer_char_replace(w->response.data, '\0', ' ');
1992 // just leave the buffer as is
1993 // it will be copied back to the client
1995 #endif /* NETDATA_INTERNAL_CHECKS */
1997 char filename[FILENAME_MAX+1];
1999 strncpyz(filename, w->last_url, FILENAME_MAX);
2000 tok = mystrsep(&url, "?");
2001 buffer_flush(w->response.data);
2002 code = mysendfile(w, (tok && *tok)?tok:"/");
2006 char filename[FILENAME_MAX+1];
2008 strncpyz(filename, w->last_url, FILENAME_MAX);
2009 tok = mystrsep(&url, "?");
2010 buffer_flush(w->response.data);
2011 code = mysendfile(w, (tok && *tok)?tok:"/");
2016 gettimeofday(&w->tv_ready, NULL);
2017 w->response.data->date = time(NULL);
2018 w->response.sent = 0;
2019 w->response.code = code;
2021 // prepare the HTTP response header
2022 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2024 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2025 const char *code_msg = web_response_code_to_string(code);
2028 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
2029 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2031 buffer_sprintf(w->response.header_output,
2032 "HTTP/1.1 %d %s\r\n"
2033 "Connection: %s\r\n"
2034 "Server: NetData Embedded HTTP Server\r\n"
2035 "Access-Control-Allow-Origin: %s\r\n"
2036 "Access-Control-Allow-Credentials: true\r\n"
2037 "Content-Type: %s\r\n"
2040 , w->keepalive?"keep-alive":"close"
2042 , content_type_string
2046 if(w->cookie1[0] || w->cookie2[0]) {
2048 buffer_sprintf(w->response.header_output,
2049 "Set-Cookie: %s\r\n",
2054 buffer_sprintf(w->response.header_output,
2055 "Set-Cookie: %s\r\n",
2059 if(web_donotrack_comply)
2060 buffer_sprintf(w->response.header_output,
2061 "Tk: T;cookies\r\n");
2064 if(web_donotrack_comply) {
2065 if(w->tracking_required)
2066 buffer_sprintf(w->response.header_output,
2067 "Tk: T;cookies\r\n");
2069 buffer_sprintf(w->response.header_output,
2074 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2075 buffer_strcat(w->response.header_output,
2076 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2077 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
2078 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2082 if(buffer_strlen(w->response.header))
2083 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2085 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
2086 buffer_sprintf(w->response.header_output,
2088 "Cache-Control: no-cache\r\n"
2091 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
2093 time_t et = w->response.data->date + (86400 * 14);
2094 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
2095 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
2097 buffer_sprintf(w->response.header_output,
2099 "Cache-Control: public\r\n"
2103 // if we know the content length, put it
2104 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
2105 buffer_sprintf(w->response.header_output,
2106 "Content-Length: %zu\r\n"
2107 , w->response.data->len? w->response.data->len: w->response.rlen
2109 else if(!w->response.zoutput)
2110 w->keepalive = 0; // content-length is required for keep-alive
2112 if(w->response.zoutput) {
2113 buffer_strcat(w->response.header_output,
2114 "Content-Encoding: gzip\r\n"
2115 "Transfer-Encoding: chunked\r\n"
2119 buffer_strcat(w->response.header_output, "\r\n");
2121 // sent the HTTP header
2122 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2124 , buffer_strlen(w->response.header_output)
2125 , buffer_tostring(w->response.header_output)
2128 web_client_crock_socket(w);
2130 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2131 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2133 w->stats_sent_bytes += bytes;
2135 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2137 , buffer_strlen(w->response.header_output)
2140 WEB_CLIENT_IS_DEAD(w);
2144 w->stats_sent_bytes += bytes;
2146 // enable sending immediately if we have data
2147 if(w->response.data->len) w->wait_send = 1;
2148 else w->wait_send = 0;
2152 case WEB_CLIENT_MODE_OPTIONS:
2153 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2156 case WEB_CLIENT_MODE_NORMAL:
2157 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2160 case WEB_CLIENT_MODE_FILECOPY:
2161 if(w->response.rlen) {
2162 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2163 w->wait_receive = 1;
2166 // utilize the kernel sendfile() for copying the file to the socket.
2167 // this block of code can be commented, without anything missing.
2168 // when it is commented, the program will copy the data using async I/O.
2170 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2171 if(len != w->response.data->rbytes)
2172 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2174 web_client_reset(w);
2179 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2183 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2188 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2190 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2192 sprintf(buf, "%zX\r\n", len);
2194 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2196 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2197 w->stats_sent_bytes += bytes;
2200 else if(bytes == 0) {
2201 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2202 WEB_CLIENT_IS_DEAD(w);
2205 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2206 WEB_CLIENT_IS_DEAD(w);
2212 ssize_t web_client_send_chunk_close(struct web_client *w)
2214 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2216 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2218 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2219 w->stats_sent_bytes += bytes;
2222 else if(bytes == 0) {
2223 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2224 WEB_CLIENT_IS_DEAD(w);
2227 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2228 WEB_CLIENT_IS_DEAD(w);
2234 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2236 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2238 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2240 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2241 w->stats_sent_bytes += bytes;
2244 else if(bytes == 0) {
2245 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2246 WEB_CLIENT_IS_DEAD(w);
2249 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2250 WEB_CLIENT_IS_DEAD(w);
2256 #ifdef NETDATA_WITH_ZLIB
2257 ssize_t web_client_send_deflate(struct web_client *w)
2259 ssize_t len = 0, t = 0;
2261 // when using compression,
2262 // w->response.sent is the amount of bytes passed through compression
2264 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.",
2265 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);
2267 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) {
2268 // there is nothing to send
2270 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2272 // finalize the chunk
2273 if(w->response.sent != 0) {
2274 t = web_client_send_chunk_finalize(w);
2278 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2279 // we have to wait, more data will come
2280 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2285 if(unlikely(!w->keepalive)) {
2286 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2287 WEB_CLIENT_IS_DEAD(w);
2292 web_client_reset(w);
2293 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2297 if(w->response.zhave == w->response.zsent) {
2298 // compress more input data
2300 // close the previous open chunk
2301 if(w->response.sent != 0) {
2302 t = web_client_send_chunk_close(w);
2306 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);
2308 // give the compressor all the data not passed through the compressor yet
2309 if(w->response.data->len > w->response.sent) {
2310 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2311 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2314 // reset the compressor output buffer
2315 w->response.zstream.next_out = w->response.zbuffer;
2316 w->response.zstream.avail_out = ZLIB_CHUNK;
2318 // ask for FINISH if we have all the input
2319 int flush = Z_SYNC_FLUSH;
2320 if(w->mode == WEB_CLIENT_MODE_NORMAL
2321 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2323 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2326 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2330 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2331 error("%llu: Compression failed. Closing down client.", w->id);
2332 web_client_reset(w);
2336 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2337 w->response.zsent = 0;
2339 // keep track of the bytes passed through the compressor
2340 w->response.sent = w->response.data->len;
2342 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2345 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2346 if(t2 < 0) return t2;
2350 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2352 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2354 w->stats_sent_bytes += len;
2355 w->response.zsent += len;
2357 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2360 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2361 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2363 WEB_CLIENT_IS_DEAD(w);
2366 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2367 WEB_CLIENT_IS_DEAD(w);
2372 #endif // NETDATA_WITH_ZLIB
2374 ssize_t web_client_send(struct web_client *w) {
2375 #ifdef NETDATA_WITH_ZLIB
2376 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2377 #endif // NETDATA_WITH_ZLIB
2381 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2382 // there is nothing to send
2384 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2386 // there can be two cases for this
2387 // A. we have done everything
2388 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2390 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2391 // we have to wait, more data will come
2392 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2397 if(unlikely(!w->keepalive)) {
2398 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2399 WEB_CLIENT_IS_DEAD(w);
2403 web_client_reset(w);
2404 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2408 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2409 if(likely(bytes > 0)) {
2410 w->stats_sent_bytes += bytes;
2411 w->response.sent += bytes;
2412 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2414 else if(likely(bytes == 0)) {
2415 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2416 WEB_CLIENT_IS_DEAD(w);
2419 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2420 WEB_CLIENT_IS_DEAD(w);
2426 ssize_t web_client_receive(struct web_client *w)
2428 // do we have any space for more data?
2429 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2431 ssize_t left = w->response.data->size - w->response.data->len;
2434 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2435 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2437 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2439 if(likely(bytes > 0)) {
2440 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2441 w->stats_received_bytes += bytes;
2443 size_t old = w->response.data->len;
2444 w->response.data->len += bytes;
2445 w->response.data->buffer[w->response.data->len] = '\0';
2447 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2448 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2450 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2453 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2454 w->wait_receive = 0;
2457 else if(likely(bytes == 0)) {
2458 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2460 // if we cannot read, it means we have an error on input.
2461 // if however, we are copying a file from ifd to ofd, we should not return an error.
2462 // in this case, the error should be generated when the file has been sent to the client.
2464 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2465 // we are copying data from ifd to ofd
2466 // let it finish copying...
2467 w->wait_receive = 0;
2469 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2470 if(w->ifd != w->ofd) close(w->ifd);
2474 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2475 WEB_CLIENT_IS_DEAD(w);
2479 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2480 WEB_CLIENT_IS_DEAD(w);
2487 // --------------------------------------------------------------------------------------
2488 // the thread of a single client
2490 // 1. waits for input and output, using async I/O
2491 // 2. it processes HTTP requests
2492 // 3. it generates HTTP responses
2493 // 4. it copies data from input to output if mode is FILECOPY
2495 void *web_client_main(void *ptr)
2497 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2498 error("Cannot set pthread cancel type to DEFERRED.");
2500 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2501 error("Cannot set pthread cancel state to ENABLE.");
2503 struct web_client *w = ptr;
2504 struct pollfd fds[2], *ifd, *ofd;
2505 int retval, fdmax = 0, timeout;
2507 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2510 if(unlikely(w->dead)) {
2511 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2514 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2515 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2519 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2520 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2524 if(w->ifd == w->ofd) {
2529 if(w->wait_receive) fds[0].events |= POLLIN;
2530 if(w->wait_send) fds[0].events |= POLLOUT;
2536 ifd = ofd = &fds[0];
2544 if(w->wait_receive) fds[0].events |= POLLIN;
2550 if(w->wait_send) fds[1].events |= POLLOUT;
2556 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2558 timeout = web_client_timeout * 1000;
2559 retval = poll(fds, fdmax, timeout);
2561 if(unlikely(retval == -1)) {
2562 if(errno == EAGAIN || errno == EINTR) {
2563 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2567 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2570 else if(unlikely(!retval)) {
2571 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":"");
2576 if(w->wait_send && ofd->revents & POLLOUT) {
2578 if(web_client_send(w) < 0) {
2579 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2584 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2586 if(web_client_receive(w) < 0) {
2587 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2591 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2592 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2593 web_client_process(w);
2597 if(unlikely(!used)) {
2598 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2603 web_client_reset(w);
2605 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2606 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2608 // close the sockets/files now
2609 // to free file descriptors
2610 if(w->ifd == w->ofd) {
2611 if(w->ifd != -1) close(w->ifd);
2614 if(w->ifd != -1) close(w->ifd);
2615 if(w->ofd != -1) close(w->ofd);