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 static 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 static 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: Resetting client.", w->id);
126 if(likely(w->last_url[0])) {
128 now_realtime_timeval(&tv);
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(dt_usec(&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 dt_usec(&w->tv_ready, &w->tv_in) / 1000.0,
156 dt_usec(&tv, &w->tv_ready) / 1000.0,
157 dt_usec(&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 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, netdata_configured_web_dir, filename);
295 // skip leading slashes
296 while (*filename == '/') filename++;
298 // if the filename contain known paths, skip them
299 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
300 filename = &filename[strlen(WEB_PATH_FILE) + 1];
303 for(s = filename; *s ;s++) {
304 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
305 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
306 buffer_sprintf(w->response.data, "Filename contains invalid characters: ");
307 buffer_strcat_htmlescape(w->response.data, filename);
312 // if the filename contains a .. refuse to serve it
313 if(strstr(filename, "..") != 0) {
314 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
315 buffer_strcat(w->response.data, "Relative filenames are not supported: ");
316 buffer_strcat_htmlescape(w->response.data, filename);
321 char webfilename[FILENAME_MAX + 1];
322 snprintfz(webfilename, FILENAME_MAX, "%s/%s", netdata_configured_web_dir, filename);
324 // check if the file exists
326 if(lstat(webfilename, &stat) != 0) {
327 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
328 buffer_strcat(w->response.data, "File does not exist, or is not accessible: ");
329 buffer_strcat_htmlescape(w->response.data, webfilename);
333 // check if the file is owned by expected user
334 if(stat.st_uid != web_files_uid()) {
335 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
336 buffer_strcat(w->response.data, "Access to file is not permitted: ");
337 buffer_strcat_htmlescape(w->response.data, webfilename);
341 // check if the file is owned by expected group
342 if(stat.st_gid != web_files_gid()) {
343 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
344 buffer_strcat(w->response.data, "Access to file is not permitted: ");
345 buffer_strcat_htmlescape(w->response.data, 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_strcat(w->response.data, "Access to file is not permitted: ");
357 buffer_strcat_htmlescape(w->response.data, webfilename);
362 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
366 if(errno == EBUSY || errno == EAGAIN) {
367 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
368 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
369 buffer_strcat(w->response.data, "File is currently busy, please try again later: ");
370 buffer_strcat_htmlescape(w->response.data, webfilename);
374 error("%llu: Cannot open file '%s'.", w->id, webfilename);
375 buffer_strcat(w->response.data, "Cannot open file: ");
376 buffer_strcat_htmlescape(w->response.data, webfilename);
380 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
381 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
383 // pick a Content-Type for the file
384 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
385 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
386 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
387 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
388 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
389 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
390 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
391 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
392 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
393 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
394 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
395 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
396 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
397 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
398 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
399 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
400 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
401 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
402 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
403 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
405 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);
407 w->mode = WEB_CLIENT_MODE_FILECOPY;
410 buffer_flush(w->response.data);
411 w->response.rlen = stat.st_size;
413 w->response.data->date = stat.st_mtimespec.tv_sec;
415 w->response.data->date = stat.st_mtim.tv_sec;
416 #endif /* __APPLE__ */
417 buffer_cacheable(w->response.data);
423 #ifdef NETDATA_WITH_ZLIB
424 void web_client_enable_deflate(struct web_client *w, int gzip) {
425 if(unlikely(w->response.zinitialized)) {
426 debug(D_DEFLATE, "%llu: Compression has already be initialized for this client.", w->id);
430 if(unlikely(w->response.sent)) {
431 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
435 w->response.zstream.zalloc = Z_NULL;
436 w->response.zstream.zfree = Z_NULL;
437 w->response.zstream.opaque = Z_NULL;
439 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
440 w->response.zstream.avail_in = 0;
441 w->response.zstream.total_in = 0;
443 w->response.zstream.next_out = w->response.zbuffer;
444 w->response.zstream.avail_out = 0;
445 w->response.zstream.total_out = 0;
447 w->response.zstream.zalloc = Z_NULL;
448 w->response.zstream.zfree = Z_NULL;
449 w->response.zstream.opaque = Z_NULL;
451 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
452 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
456 // Select GZIP compression: windowbits = 15 + 16 = 31
457 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
458 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
462 w->response.zsent = 0;
463 w->response.zoutput = 1;
464 w->response.zinitialized = 1;
466 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
468 #endif // NETDATA_WITH_ZLIB
470 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
473 if(options & RRDR_OPTION_NONZERO) {
474 if(count++) buffer_strcat(wb, " ");
475 buffer_strcat(wb, "nonzero");
478 if(options & RRDR_OPTION_REVERSED) {
479 if(count++) buffer_strcat(wb, " ");
480 buffer_strcat(wb, "flip");
483 if(options & RRDR_OPTION_JSON_WRAP) {
484 if(count++) buffer_strcat(wb, " ");
485 buffer_strcat(wb, "jsonwrap");
488 if(options & RRDR_OPTION_MIN2MAX) {
489 if(count++) buffer_strcat(wb, " ");
490 buffer_strcat(wb, "min2max");
493 if(options & RRDR_OPTION_MILLISECONDS) {
494 if(count++) buffer_strcat(wb, " ");
495 buffer_strcat(wb, "ms");
498 if(options & RRDR_OPTION_ABSOLUTE) {
499 if(count++) buffer_strcat(wb, " ");
500 buffer_strcat(wb, "absolute");
503 if(options & RRDR_OPTION_SECONDS) {
504 if(count++) buffer_strcat(wb, " ");
505 buffer_strcat(wb, "seconds");
508 if(options & RRDR_OPTION_NULL2ZERO) {
509 if(count++) buffer_strcat(wb, " ");
510 buffer_strcat(wb, "null2zero");
513 if(options & RRDR_OPTION_OBJECTSROWS) {
514 if(count++) buffer_strcat(wb, " ");
515 buffer_strcat(wb, "objectrows");
518 if(options & RRDR_OPTION_GOOGLE_JSON) {
519 if(count++) buffer_strcat(wb, " ");
520 buffer_strcat(wb, "google_json");
523 if(options & RRDR_OPTION_PERCENTAGE) {
524 if(count++) buffer_strcat(wb, " ");
525 buffer_strcat(wb, "percentage");
528 if(options & RRDR_OPTION_NOT_ALIGNED) {
529 if(count++) buffer_strcat(wb, " ");
530 buffer_strcat(wb, "unaligned");
534 uint32_t web_client_api_request_v1_data_options(char *o)
536 uint32_t ret = 0x00000000;
539 while(o && *o && (tok = mystrsep(&o, ", |"))) {
542 if(!strcmp(tok, "nonzero"))
543 ret |= RRDR_OPTION_NONZERO;
544 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
545 ret |= RRDR_OPTION_REVERSED;
546 else if(!strcmp(tok, "jsonwrap"))
547 ret |= RRDR_OPTION_JSON_WRAP;
548 else if(!strcmp(tok, "min2max"))
549 ret |= RRDR_OPTION_MIN2MAX;
550 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
551 ret |= RRDR_OPTION_MILLISECONDS;
552 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
553 ret |= RRDR_OPTION_ABSOLUTE;
554 else if(!strcmp(tok, "seconds"))
555 ret |= RRDR_OPTION_SECONDS;
556 else if(!strcmp(tok, "null2zero"))
557 ret |= RRDR_OPTION_NULL2ZERO;
558 else if(!strcmp(tok, "objectrows"))
559 ret |= RRDR_OPTION_OBJECTSROWS;
560 else if(!strcmp(tok, "google_json"))
561 ret |= RRDR_OPTION_GOOGLE_JSON;
562 else if(!strcmp(tok, "percentage"))
563 ret |= RRDR_OPTION_PERCENTAGE;
564 else if(!strcmp(tok, "unaligned"))
565 ret |= RRDR_OPTION_NOT_ALIGNED;
571 uint32_t web_client_api_request_v1_data_format(char *name)
573 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
574 return DATASOURCE_DATATABLE_JSON;
576 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
577 return DATASOURCE_DATATABLE_JSONP;
579 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
580 return DATASOURCE_JSON;
582 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
583 return DATASOURCE_JSONP;
585 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
586 return DATASOURCE_SSV;
588 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
589 return DATASOURCE_CSV;
591 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
592 return DATASOURCE_TSV;
594 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
595 return DATASOURCE_HTML;
597 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
598 return DATASOURCE_JS_ARRAY;
600 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
601 return DATASOURCE_SSV_COMMA;
603 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
604 return DATASOURCE_CSV_JSON_ARRAY;
606 return DATASOURCE_JSON;
609 uint32_t web_client_api_request_v1_data_google_format(char *name)
611 if(!strcmp(name, "json"))
612 return DATASOURCE_DATATABLE_JSONP;
614 else if(!strcmp(name, "html"))
615 return DATASOURCE_HTML;
617 else if(!strcmp(name, "csv"))
618 return DATASOURCE_CSV;
620 else if(!strcmp(name, "tsv-excel"))
621 return DATASOURCE_TSV;
623 return DATASOURCE_JSON;
626 const char *group_method2string(int group) {
628 case GROUP_UNDEFINED:
643 case GROUP_INCREMENTAL_SUM:
644 return "incremental-sum";
647 return "unknown-group-method";
651 int web_client_api_request_v1_data_group(char *name, int def)
653 if(!strcmp(name, "average"))
654 return GROUP_AVERAGE;
656 else if(!strcmp(name, "min"))
659 else if(!strcmp(name, "max"))
662 else if(!strcmp(name, "sum"))
665 else if(!strcmp(name, "incremental-sum"))
666 return GROUP_INCREMENTAL_SUM;
671 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
676 char *value = mystrsep(&url, "?&");
677 if (!value || !*value) continue;
679 if(!strcmp(value, "all")) all = 1;
680 else if(!strcmp(value, "active")) all = 0;
683 buffer_flush(w->response.data);
684 w->response.data->contenttype = CT_APPLICATION_JSON;
685 health_alarms2json(&localhost, w->response.data, all);
689 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
694 char *value = mystrsep(&url, "?&");
695 if (!value || !*value) continue;
697 char *name = mystrsep(&value, "=");
698 if(!name || !*name) continue;
699 if(!value || !*value) continue;
701 if(!strcmp(name, "after")) after = strtoul(value, NULL, 0);
704 buffer_flush(w->response.data);
705 w->response.data->contenttype = CT_APPLICATION_JSON;
706 health_alarm_log2json(&localhost, w->response.data, after);
710 int web_client_api_request_single_chart(struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
715 buffer_flush(w->response.data);
718 char *value = mystrsep(&url, "?&");
719 if(!value || !*value) continue;
721 char *name = mystrsep(&value, "=");
722 if(!name || !*name) continue;
723 if(!value || !*value) continue;
725 // name and value are now the parameters
726 // they are not null and not empty
728 if(!strcmp(name, "chart")) chart = value;
730 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
735 if(!chart || !*chart) {
736 buffer_sprintf(w->response.data, "No chart id is given at the request.");
740 RRDSET *st = rrdset_find(chart);
741 if(!st) st = rrdset_find_byname(chart);
743 buffer_strcat(w->response.data, "Chart is not found: ");
744 buffer_strcat_htmlescape(w->response.data, chart);
749 w->response.data->contenttype = CT_APPLICATION_JSON;
750 callback(st, w->response.data);
757 int web_client_api_request_v1_alarm_variables(struct web_client *w, char *url)
759 return web_client_api_request_single_chart(w, url, health_api_v1_chart_variables2json);
762 int web_client_api_request_v1_charts(struct web_client *w, char *url)
766 buffer_flush(w->response.data);
767 w->response.data->contenttype = CT_APPLICATION_JSON;
768 rrd_stats_api_v1_charts(w->response.data);
772 int web_client_api_request_v1_allmetrics(struct web_client *w, char *url)
774 int format = ALLMETRICS_SHELL;
777 char *value = mystrsep(&url, "?&");
778 if (!value || !*value) continue;
780 char *name = mystrsep(&value, "=");
781 if(!name || !*name) continue;
782 if(!value || !*value) continue;
784 if(!strcmp(name, "format")) {
785 if(!strcmp(value, ALLMETRICS_FORMAT_SHELL))
786 format = ALLMETRICS_SHELL;
787 else if(!strcmp(value, ALLMETRICS_FORMAT_PROMETHEUS))
788 format = ALLMETRICS_PROMETHEUS;
794 buffer_flush(w->response.data);
795 buffer_no_cacheable(w->response.data);
798 case ALLMETRICS_SHELL:
799 w->response.data->contenttype = CT_TEXT_PLAIN;
800 rrd_stats_api_v1_charts_allmetrics_shell(w->response.data);
803 case ALLMETRICS_PROMETHEUS:
804 w->response.data->contenttype = CT_PROMETHEUS;
805 rrd_stats_api_v1_charts_allmetrics_prometheus(w->response.data);
809 w->response.data->contenttype = CT_TEXT_PLAIN;
810 buffer_strcat(w->response.data, "Which format? Only '" ALLMETRICS_FORMAT_SHELL "' and '" ALLMETRICS_FORMAT_PROMETHEUS "' is currently supported.");
815 int web_client_api_request_v1_chart(struct web_client *w, char *url)
817 return web_client_api_request_single_chart(w, url, rrd_stats_api_v1_chart);
820 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
822 buffer_flush(w->response.data);
824 BUFFER *dimensions = NULL;
826 const char *chart = NULL
830 , *multiply_str = NULL
834 , *label_color = NULL
835 , *value_color = NULL
836 , *refresh_str = NULL
837 , *precision_str = NULL
840 int group = GROUP_AVERAGE;
841 uint32_t options = 0x00000000;
844 char *value = mystrsep(&url, "/?&");
845 if(!value || !*value) continue;
847 char *name = mystrsep(&value, "=");
848 if(!name || !*name) continue;
849 if(!value || !*value) continue;
851 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
853 // name and value are now the parameters
854 // they are not null and not empty
856 if(!strcmp(name, "chart")) chart = value;
857 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
859 dimensions = buffer_create(100);
861 buffer_strcat(dimensions, "|");
862 buffer_strcat(dimensions, value);
864 else if(!strcmp(name, "after")) after_str = value;
865 else if(!strcmp(name, "before")) before_str = value;
866 else if(!strcmp(name, "points")) points_str = value;
867 else if(!strcmp(name, "group")) {
868 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
870 else if(!strcmp(name, "options")) {
871 options |= web_client_api_request_v1_data_options(value);
873 else if(!strcmp(name, "label")) label = value;
874 else if(!strcmp(name, "units")) units = value;
875 else if(!strcmp(name, "label_color")) label_color = value;
876 else if(!strcmp(name, "value_color")) value_color = value;
877 else if(!strcmp(name, "multiply")) multiply_str = value;
878 else if(!strcmp(name, "divide")) divide_str = value;
879 else if(!strcmp(name, "refresh")) refresh_str = value;
880 else if(!strcmp(name, "precision")) precision_str = value;
881 else if(!strcmp(name, "alarm")) alarm = value;
884 if(!chart || !*chart) {
885 buffer_no_cacheable(w->response.data);
886 buffer_sprintf(w->response.data, "No chart id is given at the request.");
890 RRDSET *st = rrdset_find(chart);
891 if(!st) st = rrdset_find_byname(chart);
893 buffer_no_cacheable(w->response.data);
894 buffer_svg(w->response.data, "chart not found", NAN, "", NULL, NULL, -1);
901 rc = rrdcalc_find(st, alarm);
903 buffer_no_cacheable(w->response.data);
904 buffer_svg(w->response.data, "alarm not found", NAN, "", NULL, NULL, -1);
910 long long multiply = (multiply_str && *multiply_str )?str2l(multiply_str):1;
911 long long divide = (divide_str && *divide_str )?str2l(divide_str):1;
912 long long before = (before_str && *before_str )?str2l(before_str):0;
913 long long after = (after_str && *after_str )?str2l(after_str):-st->update_every;
914 int points = (points_str && *points_str )?str2i(points_str):1;
915 int precision = (precision_str && *precision_str)?str2i(precision_str):-1;
917 if(!multiply) multiply = 1;
918 if(!divide) divide = 1;
921 if(refresh_str && *refresh_str) {
922 if(!strcmp(refresh_str, "auto")) {
923 if(rc) refresh = rc->update_every;
924 else if(options & RRDR_OPTION_NOT_ALIGNED)
925 refresh = st->update_every;
927 refresh = (int)(before - after);
928 if(refresh < 0) refresh = -refresh;
932 refresh = str2i(refresh_str);
933 if(refresh < 0) refresh = -refresh;
939 char *s = (char *)alarm;
941 if(*s == '_') *s = ' ';
946 else if(dimensions) {
947 const char *dim = buffer_tostring(dimensions);
948 if(*dim == '|') dim++;
961 else if(options & RRDR_OPTION_PERCENTAGE)
967 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'"
971 , (dimensions)?buffer_tostring(dimensions):""
981 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
982 w->response.data->expires = now_realtime_sec() + refresh;
984 else buffer_no_cacheable(w->response.data);
988 case RRDCALC_STATUS_CRITICAL:
992 case RRDCALC_STATUS_WARNING:
993 value_color = "orange";
996 case RRDCALC_STATUS_CLEAR:
997 value_color = "brightgreen";
1000 case RRDCALC_STATUS_UNDEFINED:
1001 value_color = "lightgrey";
1004 case RRDCALC_STATUS_UNINITIALIZED:
1005 value_color = "#000";
1009 value_color = "grey";
1014 buffer_svg(w->response.data,
1016 (isnan(rc->value)||isinf(rc->value)) ? rc->value : rc->value * multiply / divide,
1024 time_t latest_timestamp = 0;
1025 int value_is_null = 1;
1026 calculated_number n = NAN;
1029 // if the collected value is too old, don't calculate its value
1030 if (rrdset_last_entry_t(st) >= (now_realtime_sec() - (st->update_every * st->gap_when_lost_iterations_above)))
1034 (dimensions) ? buffer_tostring(dimensions) : NULL,
1044 // if the value cannot be calculated, show empty badge
1046 buffer_no_cacheable(w->response.data);
1051 else if (refresh > 0) {
1052 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1053 w->response.data->expires = now_realtime_sec() + refresh;
1055 else buffer_no_cacheable(w->response.data);
1058 buffer_svg(w->response.data,
1060 (value_is_null)?NAN:(n * multiply / divide),
1069 buffer_free(dimensions);
1073 // returns the HTTP code
1074 int web_client_api_request_v1_data(struct web_client *w, char *url)
1076 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1079 BUFFER *dimensions = NULL;
1081 buffer_flush(w->response.data);
1083 char *google_version = "0.6",
1084 *google_reqId = "0",
1086 *google_out = "json",
1087 *responseHandler = NULL,
1088 *outFileName = NULL;
1090 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1093 , *before_str = NULL
1095 , *points_str = NULL;
1097 int group = GROUP_AVERAGE;
1098 uint32_t format = DATASOURCE_JSON;
1099 uint32_t options = 0x00000000;
1102 char *value = mystrsep(&url, "?&");
1103 if(!value || !*value) continue;
1105 char *name = mystrsep(&value, "=");
1106 if(!name || !*name) continue;
1107 if(!value || !*value) continue;
1109 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1111 // name and value are now the parameters
1112 // they are not null and not empty
1114 if(!strcmp(name, "chart")) chart = value;
1115 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1116 if(!dimensions) dimensions = buffer_create(100);
1117 buffer_strcat(dimensions, "|");
1118 buffer_strcat(dimensions, value);
1120 else if(!strcmp(name, "after")) after_str = value;
1121 else if(!strcmp(name, "before")) before_str = value;
1122 else if(!strcmp(name, "points")) points_str = value;
1123 else if(!strcmp(name, "group")) {
1124 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1126 else if(!strcmp(name, "format")) {
1127 format = web_client_api_request_v1_data_format(value);
1129 else if(!strcmp(name, "options")) {
1130 options |= web_client_api_request_v1_data_options(value);
1132 else if(!strcmp(name, "callback")) {
1133 responseHandler = value;
1135 else if(!strcmp(name, "filename")) {
1136 outFileName = value;
1138 else if(!strcmp(name, "tqx")) {
1139 // parse Google Visualization API options
1140 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1141 char *tqx_name, *tqx_value;
1144 tqx_value = mystrsep(&value, ";");
1145 if(!tqx_value || !*tqx_value) continue;
1147 tqx_name = mystrsep(&tqx_value, ":");
1148 if(!tqx_name || !*tqx_name) continue;
1149 if(!tqx_value || !*tqx_value) continue;
1151 if(!strcmp(tqx_name, "version"))
1152 google_version = tqx_value;
1153 else if(!strcmp(tqx_name, "reqId"))
1154 google_reqId = tqx_value;
1155 else if(!strcmp(tqx_name, "sig")) {
1156 google_sig = tqx_value;
1157 google_timestamp = strtoul(google_sig, NULL, 0);
1159 else if(!strcmp(tqx_name, "out")) {
1160 google_out = tqx_value;
1161 format = web_client_api_request_v1_data_google_format(google_out);
1163 else if(!strcmp(tqx_name, "responseHandler"))
1164 responseHandler = tqx_value;
1165 else if(!strcmp(tqx_name, "outFileName"))
1166 outFileName = tqx_value;
1171 if(!chart || !*chart) {
1172 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1176 RRDSET *st = rrdset_find(chart);
1177 if(!st) st = rrdset_find_byname(chart);
1179 buffer_strcat(w->response.data, "Chart is not found: ");
1180 buffer_strcat_htmlescape(w->response.data, chart);
1185 long long before = (before_str && *before_str)?str2l(before_str):0;
1186 long long after = (after_str && *after_str) ?str2l(after_str):0;
1187 int points = (points_str && *points_str)?str2i(points_str):0;
1189 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'"
1192 , (dimensions)?buffer_tostring(dimensions):""
1201 if(outFileName && *outFileName) {
1202 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1203 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1206 if(format == DATASOURCE_DATATABLE_JSONP) {
1207 if(responseHandler == NULL)
1208 responseHandler = "google.visualization.Query.setResponse";
1210 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1211 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1214 buffer_sprintf(w->response.data,
1215 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1216 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1218 else if(format == DATASOURCE_JSONP) {
1219 if(responseHandler == NULL)
1220 responseHandler = "callback";
1222 buffer_strcat(w->response.data, responseHandler);
1223 buffer_strcat(w->response.data, "(");
1226 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1228 if(format == DATASOURCE_DATATABLE_JSONP) {
1229 if(google_timestamp < last_timestamp_in_data)
1230 buffer_strcat(w->response.data, "});");
1233 // the client already has the latest data
1234 buffer_flush(w->response.data);
1235 buffer_sprintf(w->response.data,
1236 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1237 responseHandler, google_version, google_reqId);
1240 else if(format == DATASOURCE_JSONP)
1241 buffer_strcat(w->response.data, ");");
1244 if(dimensions) buffer_free(dimensions);
1249 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1251 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1252 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1253 hash_to = 0 /*, hash_redirects = 0 */;
1255 if(unlikely(!hash_action)) {
1256 hash_action = simple_hash("action");
1257 hash_access = simple_hash("access");
1258 hash_hello = simple_hash("hello");
1259 hash_delete = simple_hash("delete");
1260 hash_search = simple_hash("search");
1261 hash_switch = simple_hash("switch");
1262 hash_machine = simple_hash("machine");
1263 hash_url = simple_hash("url");
1264 hash_name = simple_hash("name");
1265 hash_delete_url = simple_hash("delete_url");
1266 hash_for = simple_hash("for");
1267 hash_to = simple_hash("to");
1269 hash_redirects = simple_hash("redirects");
1273 char person_guid[GUID_LEN + 1] = "";
1275 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1278 // The browser may send multiple cookies with our id
1280 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1282 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1285 char *machine_guid = NULL,
1286 *machine_url = NULL,
1288 *search_machine_guid = NULL,
1290 *to_person_guid = NULL;
1296 char *value = mystrsep(&url, "?&");
1297 if (!value || !*value) continue;
1299 char *name = mystrsep(&value, "=");
1300 if (!name || !*name) continue;
1301 if (!value || !*value) continue;
1303 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1305 uint32_t hash = simple_hash(name);
1307 if(hash == hash_action && !strcmp(name, "action")) {
1308 uint32_t vhash = simple_hash(value);
1310 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1311 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1312 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1313 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1314 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1315 #ifdef NETDATA_INTERNAL_CHECKS
1316 else error("unknown registry action '%s'", value);
1317 #endif /* NETDATA_INTERNAL_CHECKS */
1320 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1321 redirects = atoi(value);
1323 else if(hash == hash_machine && !strcmp(name, "machine"))
1324 machine_guid = value;
1326 else if(hash == hash_url && !strcmp(name, "url"))
1327 machine_url = value;
1329 else if(action == 'A') {
1330 if(hash == hash_name && !strcmp(name, "name"))
1333 else if(action == 'D') {
1334 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1337 else if(action == 'S') {
1338 if(hash == hash_for && !strcmp(name, "for"))
1339 search_machine_guid = value;
1341 else if(action == 'W') {
1342 if(hash == hash_to && !strcmp(name, "to"))
1343 to_person_guid = value;
1345 #ifdef NETDATA_INTERNAL_CHECKS
1346 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1347 #endif /* NETDATA_INTERNAL_CHECKS */
1350 if(web_donotrack_comply && w->donottrack) {
1351 buffer_flush(w->response.data);
1352 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.");
1356 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1357 error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1358 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1359 buffer_flush(w->response.data);
1360 buffer_strcat(w->response.data, "Invalid registry Access request.");
1363 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1364 error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1365 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1366 buffer_flush(w->response.data);
1367 buffer_strcat(w->response.data, "Invalid registry Delete request.");
1370 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1371 error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1372 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1373 buffer_flush(w->response.data);
1374 buffer_strcat(w->response.data, "Invalid registry Search request.");
1377 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1378 error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1379 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1380 buffer_flush(w->response.data);
1381 buffer_strcat(w->response.data, "Invalid registry Switch request.");
1387 w->tracking_required = 1;
1388 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
1391 w->tracking_required = 1;
1392 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
1395 w->tracking_required = 1;
1396 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
1399 w->tracking_required = 1;
1400 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
1403 return registry_request_hello_json(w);
1406 buffer_flush(w->response.data);
1407 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1412 int web_client_api_request_v1(struct web_client *w, char *url) {
1413 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, hash_alarm_variables = 0, hash_raw = 0;
1415 if(unlikely(hash_data == 0)) {
1416 hash_data = simple_hash("data");
1417 hash_chart = simple_hash("chart");
1418 hash_charts = simple_hash("charts");
1419 hash_registry = simple_hash("registry");
1420 hash_badge = simple_hash("badge.svg");
1421 hash_alarms = simple_hash("alarms");
1422 hash_alarm_log = simple_hash("alarm_log");
1423 hash_alarm_variables = simple_hash("alarm_variables");
1424 hash_raw = simple_hash("allmetrics");
1428 char *tok = mystrsep(&url, "/?&");
1430 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1431 uint32_t hash = simple_hash(tok);
1433 if(hash == hash_data && !strcmp(tok, "data"))
1434 return web_client_api_request_v1_data(w, url);
1436 else if(hash == hash_chart && !strcmp(tok, "chart"))
1437 return web_client_api_request_v1_chart(w, url);
1439 else if(hash == hash_charts && !strcmp(tok, "charts"))
1440 return web_client_api_request_v1_charts(w, url);
1442 else if(hash == hash_registry && !strcmp(tok, "registry"))
1443 return web_client_api_request_v1_registry(w, url);
1445 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1446 return web_client_api_request_v1_badge(w, url);
1448 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1449 return web_client_api_request_v1_alarms(w, url);
1451 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1452 return web_client_api_request_v1_alarm_log(w, url);
1454 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1455 return web_client_api_request_v1_alarm_variables(w, url);
1457 else if(hash == hash_raw && !strcmp(tok, "allmetrics"))
1458 return web_client_api_request_v1_allmetrics(w, url);
1461 buffer_flush(w->response.data);
1462 buffer_strcat(w->response.data, "Unsupported v1 API command: ");
1463 buffer_strcat_htmlescape(w->response.data, tok);
1468 buffer_flush(w->response.data);
1469 buffer_sprintf(w->response.data, "Which API v1 command?");
1474 int web_client_api_request(struct web_client *w, char *url)
1476 // get the api version
1477 char *tok = mystrsep(&url, "/?&");
1479 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1480 if(strcmp(tok, "v1") == 0)
1481 return web_client_api_request_v1(w, url);
1483 buffer_flush(w->response.data);
1484 buffer_strcat(w->response.data, "Unsupported API version: ");
1485 buffer_strcat_htmlescape(w->response.data, tok);
1490 buffer_flush(w->response.data);
1491 buffer_sprintf(w->response.data, "Which API version?");
1496 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1499 buffer_flush(w->response.data);
1500 buffer_sprintf(w->response.data, "Incomplete request.");
1506 char *args = strchr(url, '?');
1512 // get the name of the data to show
1513 char *tok = mystrsep(&url, "/");
1516 // do we have such a data set?
1518 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1519 st = rrdset_find_byname(tok);
1520 if(!st) st = rrdset_find(tok);
1525 // try to send a file with that name
1526 buffer_flush(w->response.data);
1527 return(mysendfile(w, tok));
1531 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1533 // how many entries does the client want?
1534 int lines = rrd_default_history_entries;
1535 int group_count = 1;
1536 time_t after = 0, before = 0;
1537 int group_method = GROUP_AVERAGE;
1541 // parse the lines required
1542 tok = mystrsep(&url, "/");
1543 if(tok) lines = str2i(tok);
1544 if(lines < 1) lines = 1;
1547 // parse the group count required
1548 tok = mystrsep(&url, "/");
1549 if(tok && *tok) group_count = str2i(tok);
1550 if(group_count < 1) group_count = 1;
1551 //if(group_count > save_history / 20) group_count = save_history / 20;
1554 // parse the grouping method required
1555 tok = mystrsep(&url, "/");
1557 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1558 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1559 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1560 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1565 tok = mystrsep(&url, "/");
1566 if(tok && *tok) after = str2ul(tok);
1567 if(after < 0) after = 0;
1570 // parse before time
1571 tok = mystrsep(&url, "/");
1572 if(tok && *tok) before = str2ul(tok);
1573 if(before < 0) before = 0;
1577 tok = mystrsep(&url, "/");
1578 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1581 w->response.data->contenttype = CT_APPLICATION_JSON;
1582 buffer_flush(w->response.data);
1584 char *google_version = "0.6";
1585 char *google_reqId = "0";
1586 char *google_sig = "0";
1587 char *google_out = "json";
1588 char *google_responseHandler = "google.visualization.Query.setResponse";
1589 char *google_outFileName = NULL;
1590 time_t last_timestamp_in_data = 0;
1591 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1593 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1596 tok = mystrsep(&args, "&");
1598 char *name = mystrsep(&tok, "=");
1599 if(name && *name && strcmp(name, "tqx") == 0) {
1600 char *key = mystrsep(&tok, ":");
1601 char *value = mystrsep(&tok, ";");
1602 if(key && value && *key && *value) {
1603 if(strcmp(key, "version") == 0)
1604 google_version = value;
1606 else if(strcmp(key, "reqId") == 0)
1607 google_reqId = value;
1609 else if(strcmp(key, "sig") == 0)
1612 else if(strcmp(key, "out") == 0)
1615 else if(strcmp(key, "responseHandler") == 0)
1616 google_responseHandler = value;
1618 else if(strcmp(key, "outFileName") == 0)
1619 google_outFileName = value;
1625 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1626 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1629 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1630 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1632 // check the client wants json
1633 if(strcmp(google_out, "json") != 0) {
1634 buffer_sprintf(w->response.data,
1635 "%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.'}]});",
1636 google_responseHandler, google_version, google_reqId, google_out);
1642 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1643 buffer_sprintf(w->response.data,
1644 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1645 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1648 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1649 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1651 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);
1653 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1654 if(timestamp_in_data > last_timestamp_in_data)
1655 buffer_strcat(w->response.data, "});");
1658 // the client already has the latest data
1659 buffer_flush(w->response.data);
1660 buffer_sprintf(w->response.data,
1661 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1662 google_responseHandler, google_version, google_reqId);
1669 const char *web_content_type_to_string(uint8_t contenttype) {
1670 switch(contenttype) {
1672 return "text/html; charset=utf-8";
1674 case CT_APPLICATION_XML:
1675 return "application/xml; charset=utf-8";
1677 case CT_APPLICATION_JSON:
1678 return "application/json; charset=utf-8";
1680 case CT_APPLICATION_X_JAVASCRIPT:
1681 return "application/x-javascript; charset=utf-8";
1684 return "text/css; charset=utf-8";
1687 return "text/xml; charset=utf-8";
1690 return "text/xsl; charset=utf-8";
1692 case CT_APPLICATION_OCTET_STREAM:
1693 return "application/octet-stream";
1695 case CT_IMAGE_SVG_XML:
1696 return "image/svg+xml";
1698 case CT_APPLICATION_X_FONT_TRUETYPE:
1699 return "application/x-font-truetype";
1701 case CT_APPLICATION_X_FONT_OPENTYPE:
1702 return "application/x-font-opentype";
1704 case CT_APPLICATION_FONT_WOFF:
1705 return "application/font-woff";
1707 case CT_APPLICATION_FONT_WOFF2:
1708 return "application/font-woff2";
1710 case CT_APPLICATION_VND_MS_FONTOBJ:
1711 return "application/vnd.ms-fontobject";
1717 return "image/jpeg";
1722 case CT_IMAGE_XICON:
1723 return "image/x-icon";
1729 return "image/icns";
1732 return "text/plain; version=0.0.4";
1736 return "text/plain; charset=utf-8";
1741 const char *web_response_code_to_string(int code) {
1747 return "Temporary Redirect";
1750 return "Bad Request";
1759 return "Preconditions Failed";
1762 if(code >= 100 && code < 200)
1763 return "Informational";
1765 if(code >= 200 && code < 300)
1766 return "Successful";
1768 if(code >= 300 && code < 400)
1769 return "Redirection";
1771 if(code >= 400 && code < 500)
1772 return "Bad Request";
1774 if(code >= 500 && code < 600)
1775 return "Server Error";
1777 return "Undefined Error";
1781 static inline char *http_header_parse(struct web_client *w, char *s) {
1782 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1784 if(unlikely(!hash_origin)) {
1785 hash_origin = simple_uhash("Origin");
1786 hash_connection = simple_uhash("Connection");
1787 hash_accept_encoding = simple_uhash("Accept-Encoding");
1788 hash_donottrack = simple_uhash("DNT");
1794 while(*e && *e != ':') e++;
1801 char *v = e + 1, *ve;
1803 // skip leading spaces from value
1804 while(*v == ' ') v++;
1808 while(*ve && *ve != '\r') ve++;
1809 if(!*ve || ve[1] != '\n') {
1814 // terminate the value
1817 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1818 uint32_t hash = simple_uhash(s);
1820 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1821 strncpyz(w->origin, v, ORIGIN_MAX);
1823 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1824 if(strcasestr(v, "keep-alive"))
1827 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1828 if(*v == '0') w->donottrack = 0;
1829 else if(*v == '1') w->donottrack = 1;
1831 #ifdef NETDATA_WITH_ZLIB
1832 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1833 if(web_enable_gzip) {
1834 if(strcasestr(v, "gzip"))
1835 web_client_enable_deflate(w, 1);
1837 // does not seem to work
1838 // else if(strcasestr(v, "deflate"))
1839 // web_client_enable_deflate(w, 0);
1842 #endif /* NETDATA_WITH_ZLIB */
1849 // http_request_validate()
1851 // = 0 : all good, process the request
1852 // > 0 : request is not supported
1853 // < 0 : request is incomplete - wait for more data
1855 static inline int http_request_validate(struct web_client *w) {
1856 char *s = w->response.data->buffer, *encoded_url = NULL;
1858 // is is a valid request?
1859 if(!strncmp(s, "GET ", 4)) {
1860 encoded_url = s = &s[4];
1861 w->mode = WEB_CLIENT_MODE_NORMAL;
1863 else if(!strncmp(s, "OPTIONS ", 8)) {
1864 encoded_url = s = &s[8];
1865 w->mode = WEB_CLIENT_MODE_OPTIONS;
1868 w->wait_receive = 0;
1872 // find the SPACE + "HTTP/"
1874 // find the next space
1875 while (*s && *s != ' ') s++;
1877 // is it SPACE + "HTTP/" ?
1878 if(*s && !strncmp(s, " HTTP/", 6)) break;
1882 // incomplete requests
1884 w->wait_receive = 1;
1888 // we have the end of encoded_url - remember it
1891 // make sure we have complete request
1892 // complete requests contain: \r\n\r\n
1895 while(*s && *s++ != '\r');
1897 // did we reach the end?
1898 if(unlikely(!*s)) break;
1901 if(likely(*s++ == '\n')) {
1903 // is it again \r\n ? (header end)
1904 if(unlikely(*s == '\r' && s[1] == '\n')) {
1905 // a valid complete HTTP request found
1908 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1911 // copy the URL - we are going to overwrite parts of it
1912 // FIXME -- we should avoid it
1913 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1915 w->wait_receive = 0;
1919 // another header line
1920 s = http_header_parse(w, s);
1924 // incomplete request
1925 w->wait_receive = 1;
1929 void web_client_process(struct web_client *w) {
1932 hash_netdata_conf = 0,
1934 hash_datasource = 0,
1939 #ifdef NETDATA_INTERNAL_CHECKS
1940 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1944 now_realtime_timeval(&w->tv_in);
1946 if(unlikely(!hash_api)) {
1947 hash_api = simple_hash("api");
1948 hash_netdata_conf = simple_hash("netdata.conf");
1949 hash_data = simple_hash(WEB_PATH_DATA);
1950 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1951 hash_graph = simple_hash(WEB_PATH_GRAPH);
1952 hash_list = simple_hash("list");
1953 hash_all_json = simple_hash("all.json");
1954 #ifdef NETDATA_INTERNAL_CHECKS
1955 hash_exit = simple_hash("exit");
1956 hash_debug = simple_hash("debug");
1957 hash_mirror = simple_hash("mirror");
1964 int what_to_do = http_request_validate(w);
1966 // wait for more data
1967 if(what_to_do < 0) {
1968 if(w->response.data->len > TOO_BIG_REQUEST) {
1969 strcpy(w->last_url, "too big request");
1971 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1974 buffer_flush(w->response.data);
1975 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1978 // wait for more data
1982 else if(what_to_do > 0) {
1983 // strcpy(w->last_url, "not a valid request");
1985 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1988 buffer_flush(w->response.data);
1989 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1991 else { // what_to_do == 0
1992 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1994 w->response.data->contenttype = CT_TEXT_PLAIN;
1995 buffer_flush(w->response.data);
1996 buffer_strcat(w->response.data, "OK");
1999 char *url = w->decoded_url;
2000 char *tok = mystrsep(&url, "/?");
2002 uint32_t hash = simple_hash(tok);
2003 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
2005 if(hash == hash_api && strcmp(tok, "api") == 0) {
2006 // the client is requesting api access
2007 code = web_client_api_request(w, url);
2009 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
2011 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2013 w->response.data->contenttype = CT_TEXT_PLAIN;
2014 buffer_flush(w->response.data);
2015 generate_config(w->response.data, 0);
2017 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
2018 // the client is requesting rrd data -- OLD API
2019 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
2021 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
2022 // the client is requesting google datasource -- OLD API
2023 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
2025 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
2026 // the client is requesting an rrd graph -- OLD API
2028 // get the name of the data to show
2029 tok = mystrsep(&url, "/?&");
2031 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2033 // do we have such a data set?
2034 RRDSET *st = rrdset_find_byname(tok);
2035 if(!st) st = rrdset_find(tok);
2038 // try to send a file with that name
2039 buffer_flush(w->response.data);
2040 code = mysendfile(w, tok);
2044 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2045 w->response.data->contenttype = CT_APPLICATION_JSON;
2046 buffer_flush(w->response.data);
2047 rrd_stats_graph_json(st, url, w->response.data);
2052 buffer_flush(w->response.data);
2053 buffer_strcat(w->response.data, "Graph name?\r\n");
2056 else if(hash == hash_list && strcmp(tok, "list") == 0) {
2060 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2062 buffer_flush(w->response.data);
2063 RRDSET *st = localhost.rrdset_root;
2065 for ( ; st ; st = st->next )
2066 buffer_sprintf(w->response.data, "%s\n", st->name);
2068 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
2071 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2073 w->response.data->contenttype = CT_APPLICATION_JSON;
2074 buffer_flush(w->response.data);
2075 rrd_stats_all_json(w->response.data);
2077 #ifdef NETDATA_INTERNAL_CHECKS
2078 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
2080 w->response.data->contenttype = CT_TEXT_PLAIN;
2081 buffer_flush(w->response.data);
2084 buffer_strcat(w->response.data, "ok, will do...");
2086 buffer_strcat(w->response.data, "I am doing it already");
2088 error("web request to exit received.");
2089 netdata_cleanup_and_exit(0);
2091 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2092 buffer_flush(w->response.data);
2094 // get the name of the data to show
2095 tok = mystrsep(&url, "/?&");
2097 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2099 // do we have such a data set?
2100 RRDSET *st = rrdset_find_byname(tok);
2101 if(!st) st = rrdset_find(tok);
2104 buffer_strcat(w->response.data, "Chart is not found: ");
2105 buffer_strcat_htmlescape(w->response.data, tok);
2106 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2110 debug_flags |= D_RRD_STATS;
2111 st->debug = !st->debug;
2112 buffer_sprintf(w->response.data, "Chart has now debug %s: ", st->debug?"enabled":"disabled");
2113 buffer_strcat_htmlescape(w->response.data, tok);
2114 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2119 buffer_flush(w->response.data);
2120 buffer_strcat(w->response.data, "debug which chart?\r\n");
2123 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2126 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2128 // replace the zero bytes with spaces
2129 buffer_char_replace(w->response.data, '\0', ' ');
2131 // just leave the buffer as is
2132 // it will be copied back to the client
2134 #endif /* NETDATA_INTERNAL_CHECKS */
2136 char filename[FILENAME_MAX+1];
2138 strncpyz(filename, w->last_url, FILENAME_MAX);
2139 tok = mystrsep(&url, "?");
2140 buffer_flush(w->response.data);
2141 code = mysendfile(w, (tok && *tok)?tok:"/");
2145 char filename[FILENAME_MAX+1];
2147 strncpyz(filename, w->last_url, FILENAME_MAX);
2148 tok = mystrsep(&url, "?");
2149 buffer_flush(w->response.data);
2150 code = mysendfile(w, (tok && *tok)?tok:"/");
2155 now_realtime_timeval(&w->tv_ready);
2156 w->response.sent = 0;
2157 w->response.code = code;
2159 // set a proper last modified date
2160 if(unlikely(!w->response.data->date))
2161 w->response.data->date = w->tv_ready.tv_sec;
2163 if(unlikely(code != 200))
2164 buffer_no_cacheable(w->response.data);
2166 // set a proper expiration date, if not already set
2167 if(unlikely(!w->response.data->expires)) {
2168 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
2169 w->response.data->expires = w->tv_ready.tv_sec + rrd_update_every;
2171 w->response.data->expires = w->tv_ready.tv_sec + 86400;
2174 // prepare the HTTP response header
2175 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2177 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2178 const char *code_msg = web_response_code_to_string(code);
2180 // prepare the last modified and expiration dates
2181 char date[32], edate[32];
2183 struct tm tmbuf, *tm;
2185 tm = gmtime_r(&w->response.data->date, &tmbuf);
2186 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2188 tm = gmtime_r(&w->response.data->expires, &tmbuf);
2189 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
2192 buffer_sprintf(w->response.header_output,
2193 "HTTP/1.1 %d %s\r\n"
2194 "Connection: %s\r\n"
2195 "Server: NetData Embedded HTTP Server\r\n"
2196 "Access-Control-Allow-Origin: %s\r\n"
2197 "Access-Control-Allow-Credentials: true\r\n"
2198 "Content-Type: %s\r\n"
2201 , w->keepalive?"keep-alive":"close"
2203 , content_type_string
2207 if(w->cookie1[0] || w->cookie2[0]) {
2209 buffer_sprintf(w->response.header_output,
2210 "Set-Cookie: %s\r\n",
2215 buffer_sprintf(w->response.header_output,
2216 "Set-Cookie: %s\r\n",
2220 if(web_donotrack_comply)
2221 buffer_sprintf(w->response.header_output,
2222 "Tk: T;cookies\r\n");
2225 if(web_donotrack_comply) {
2226 if(w->tracking_required)
2227 buffer_sprintf(w->response.header_output,
2228 "Tk: T;cookies\r\n");
2230 buffer_sprintf(w->response.header_output,
2235 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2236 buffer_strcat(w->response.header_output,
2237 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2238 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2239 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2243 buffer_sprintf(w->response.header_output,
2244 "Cache-Control: %s\r\n"
2246 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2250 // copy a possibly available custom header
2251 if(unlikely(buffer_strlen(w->response.header)))
2252 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2254 // headers related to the transfer method
2255 if(likely(w->response.zoutput)) {
2256 buffer_strcat(w->response.header_output,
2257 "Content-Encoding: gzip\r\n"
2258 "Transfer-Encoding: chunked\r\n"
2262 if(likely((w->response.data->len || w->response.rlen))) {
2263 // we know the content length, put it
2264 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2267 // we don't know the content length, disable keep-alive
2272 // end of HTTP header
2273 buffer_strcat(w->response.header_output, "\r\n");
2275 // sent the HTTP header
2276 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2278 , buffer_strlen(w->response.header_output)
2279 , buffer_tostring(w->response.header_output)
2282 web_client_crock_socket(w);
2284 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2285 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2287 w->stats_sent_bytes += bytes;
2289 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2291 , buffer_strlen(w->response.header_output)
2294 WEB_CLIENT_IS_DEAD(w);
2298 w->stats_sent_bytes += bytes;
2300 // enable sending immediately if we have data
2301 if(w->response.data->len) w->wait_send = 1;
2302 else w->wait_send = 0;
2306 case WEB_CLIENT_MODE_OPTIONS:
2307 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2310 case WEB_CLIENT_MODE_NORMAL:
2311 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2314 case WEB_CLIENT_MODE_FILECOPY:
2315 if(w->response.rlen) {
2316 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2317 w->wait_receive = 1;
2320 // utilize the kernel sendfile() for copying the file to the socket.
2321 // this block of code can be commented, without anything missing.
2322 // when it is commented, the program will copy the data using async I/O.
2324 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2325 if(len != w->response.data->rbytes)
2326 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2328 web_client_reset(w);
2333 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2337 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2342 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2344 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2346 sprintf(buf, "%zX\r\n", len);
2348 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2350 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2351 w->stats_sent_bytes += bytes;
2354 else if(bytes == 0) {
2355 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2356 WEB_CLIENT_IS_DEAD(w);
2359 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2360 WEB_CLIENT_IS_DEAD(w);
2366 ssize_t web_client_send_chunk_close(struct web_client *w)
2368 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2370 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2372 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2373 w->stats_sent_bytes += bytes;
2376 else if(bytes == 0) {
2377 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2378 WEB_CLIENT_IS_DEAD(w);
2381 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2382 WEB_CLIENT_IS_DEAD(w);
2388 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2390 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2392 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2394 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2395 w->stats_sent_bytes += bytes;
2398 else if(bytes == 0) {
2399 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2400 WEB_CLIENT_IS_DEAD(w);
2403 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2404 WEB_CLIENT_IS_DEAD(w);
2410 #ifdef NETDATA_WITH_ZLIB
2411 ssize_t web_client_send_deflate(struct web_client *w)
2413 ssize_t len = 0, t = 0;
2415 // when using compression,
2416 // w->response.sent is the amount of bytes passed through compression
2418 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.",
2419 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);
2421 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) {
2422 // there is nothing to send
2424 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2426 // finalize the chunk
2427 if(w->response.sent != 0) {
2428 t = web_client_send_chunk_finalize(w);
2432 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2433 // we have to wait, more data will come
2434 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2439 if(unlikely(!w->keepalive)) {
2440 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2441 WEB_CLIENT_IS_DEAD(w);
2446 web_client_reset(w);
2447 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2451 if(w->response.zhave == w->response.zsent) {
2452 // compress more input data
2454 // close the previous open chunk
2455 if(w->response.sent != 0) {
2456 t = web_client_send_chunk_close(w);
2460 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);
2462 // give the compressor all the data not passed through the compressor yet
2463 if(w->response.data->len > w->response.sent) {
2464 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2465 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2468 // reset the compressor output buffer
2469 w->response.zstream.next_out = w->response.zbuffer;
2470 w->response.zstream.avail_out = ZLIB_CHUNK;
2472 // ask for FINISH if we have all the input
2473 int flush = Z_SYNC_FLUSH;
2474 if(w->mode == WEB_CLIENT_MODE_NORMAL
2475 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2477 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2480 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2484 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2485 error("%llu: Compression failed. Closing down client.", w->id);
2486 web_client_reset(w);
2490 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2491 w->response.zsent = 0;
2493 // keep track of the bytes passed through the compressor
2494 w->response.sent = w->response.data->len;
2496 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2499 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2500 if(t2 < 0) return t2;
2504 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2506 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2508 w->stats_sent_bytes += len;
2509 w->response.zsent += len;
2511 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2514 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2515 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2517 WEB_CLIENT_IS_DEAD(w);
2520 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2521 WEB_CLIENT_IS_DEAD(w);
2526 #endif // NETDATA_WITH_ZLIB
2528 ssize_t web_client_send(struct web_client *w) {
2529 #ifdef NETDATA_WITH_ZLIB
2530 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2531 #endif // NETDATA_WITH_ZLIB
2535 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2536 // there is nothing to send
2538 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2540 // there can be two cases for this
2541 // A. we have done everything
2542 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2544 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2545 // we have to wait, more data will come
2546 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2551 if(unlikely(!w->keepalive)) {
2552 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2553 WEB_CLIENT_IS_DEAD(w);
2557 web_client_reset(w);
2558 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2562 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2563 if(likely(bytes > 0)) {
2564 w->stats_sent_bytes += bytes;
2565 w->response.sent += bytes;
2566 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2568 else if(likely(bytes == 0)) {
2569 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2570 WEB_CLIENT_IS_DEAD(w);
2573 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2574 WEB_CLIENT_IS_DEAD(w);
2580 ssize_t web_client_receive(struct web_client *w)
2582 // do we have any space for more data?
2583 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2585 ssize_t left = w->response.data->size - w->response.data->len;
2588 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2589 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2591 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2593 if(likely(bytes > 0)) {
2594 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2595 w->stats_received_bytes += bytes;
2597 size_t old = w->response.data->len;
2598 w->response.data->len += bytes;
2599 w->response.data->buffer[w->response.data->len] = '\0';
2601 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2602 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2604 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2607 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2608 w->wait_receive = 0;
2611 else if(likely(bytes == 0)) {
2612 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2614 // if we cannot read, it means we have an error on input.
2615 // if however, we are copying a file from ifd to ofd, we should not return an error.
2616 // in this case, the error should be generated when the file has been sent to the client.
2618 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2619 // we are copying data from ifd to ofd
2620 // let it finish copying...
2621 w->wait_receive = 0;
2623 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2624 if(w->ifd != w->ofd) close(w->ifd);
2628 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2629 WEB_CLIENT_IS_DEAD(w);
2633 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2634 WEB_CLIENT_IS_DEAD(w);
2641 // --------------------------------------------------------------------------------------
2642 // the thread of a single client
2644 // 1. waits for input and output, using async I/O
2645 // 2. it processes HTTP requests
2646 // 3. it generates HTTP responses
2647 // 4. it copies data from input to output if mode is FILECOPY
2649 void *web_client_main(void *ptr)
2651 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2652 error("Cannot set pthread cancel type to DEFERRED.");
2654 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2655 error("Cannot set pthread cancel state to ENABLE.");
2657 struct web_client *w = ptr;
2658 struct pollfd fds[2], *ifd, *ofd;
2659 int retval, fdmax = 0, timeout;
2661 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2664 if(unlikely(w->dead)) {
2665 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2668 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2669 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2673 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2674 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2678 if(w->ifd == w->ofd) {
2683 if(w->wait_receive) fds[0].events |= POLLIN;
2684 if(w->wait_send) fds[0].events |= POLLOUT;
2690 ifd = ofd = &fds[0];
2698 if(w->wait_receive) fds[0].events |= POLLIN;
2704 if(w->wait_send) fds[1].events |= POLLOUT;
2710 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2712 timeout = web_client_timeout * 1000;
2713 retval = poll(fds, fdmax, timeout);
2715 if(unlikely(retval == -1)) {
2716 if(errno == EAGAIN || errno == EINTR) {
2717 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2721 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2724 else if(unlikely(!retval)) {
2725 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":"");
2730 if(w->wait_send && ofd->revents & POLLOUT) {
2732 if(web_client_send(w) < 0) {
2733 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2738 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2740 if(web_client_receive(w) < 0) {
2741 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2745 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2746 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2747 web_client_process(w);
2751 if(unlikely(!used)) {
2752 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2757 web_client_reset(w);
2759 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2760 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2762 // close the sockets/files now
2763 // to free file descriptors
2764 if(w->ifd == w->ofd) {
2765 if(w->ifd != -1) close(w->ifd);
2768 if(w->ifd != -1) close(w->ifd);
2769 if(w->ofd != -1) close(w->ofd);