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: 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;
410 buffer_cacheable(w->response.data);
416 #ifdef NETDATA_WITH_ZLIB
417 void web_client_enable_deflate(struct web_client *w, int gzip) {
418 if(unlikely(w->response.zinitialized)) {
419 error("%llu: Compression has already be initialized for this client.", w->id);
423 if(unlikely(w->response.sent)) {
424 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
428 w->response.zstream.zalloc = Z_NULL;
429 w->response.zstream.zfree = Z_NULL;
430 w->response.zstream.opaque = Z_NULL;
432 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
433 w->response.zstream.avail_in = 0;
434 w->response.zstream.total_in = 0;
436 w->response.zstream.next_out = w->response.zbuffer;
437 w->response.zstream.avail_out = 0;
438 w->response.zstream.total_out = 0;
440 w->response.zstream.zalloc = Z_NULL;
441 w->response.zstream.zfree = Z_NULL;
442 w->response.zstream.opaque = Z_NULL;
444 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
445 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
449 // Select GZIP compression: windowbits = 15 + 16 = 31
450 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
451 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
455 w->response.zsent = 0;
456 w->response.zoutput = 1;
457 w->response.zinitialized = 1;
459 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
461 #endif // NETDATA_WITH_ZLIB
463 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
466 if(options & RRDR_OPTION_NONZERO) {
467 if(count++) buffer_strcat(wb, " ");
468 buffer_strcat(wb, "nonzero");
471 if(options & RRDR_OPTION_REVERSED) {
472 if(count++) buffer_strcat(wb, " ");
473 buffer_strcat(wb, "flip");
476 if(options & RRDR_OPTION_JSON_WRAP) {
477 if(count++) buffer_strcat(wb, " ");
478 buffer_strcat(wb, "jsonwrap");
481 if(options & RRDR_OPTION_MIN2MAX) {
482 if(count++) buffer_strcat(wb, " ");
483 buffer_strcat(wb, "min2max");
486 if(options & RRDR_OPTION_MILLISECONDS) {
487 if(count++) buffer_strcat(wb, " ");
488 buffer_strcat(wb, "ms");
491 if(options & RRDR_OPTION_ABSOLUTE) {
492 if(count++) buffer_strcat(wb, " ");
493 buffer_strcat(wb, "absolute");
496 if(options & RRDR_OPTION_SECONDS) {
497 if(count++) buffer_strcat(wb, " ");
498 buffer_strcat(wb, "seconds");
501 if(options & RRDR_OPTION_NULL2ZERO) {
502 if(count++) buffer_strcat(wb, " ");
503 buffer_strcat(wb, "null2zero");
506 if(options & RRDR_OPTION_OBJECTSROWS) {
507 if(count++) buffer_strcat(wb, " ");
508 buffer_strcat(wb, "objectrows");
511 if(options & RRDR_OPTION_GOOGLE_JSON) {
512 if(count++) buffer_strcat(wb, " ");
513 buffer_strcat(wb, "google_json");
516 if(options & RRDR_OPTION_PERCENTAGE) {
517 if(count++) buffer_strcat(wb, " ");
518 buffer_strcat(wb, "percentage");
521 if(options & RRDR_OPTION_NOT_ALIGNED) {
522 if(count++) buffer_strcat(wb, " ");
523 buffer_strcat(wb, "unaligned");
527 uint32_t web_client_api_request_v1_data_options(char *o)
529 uint32_t ret = 0x00000000;
532 while(o && *o && (tok = mystrsep(&o, ", |"))) {
535 if(!strcmp(tok, "nonzero"))
536 ret |= RRDR_OPTION_NONZERO;
537 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
538 ret |= RRDR_OPTION_REVERSED;
539 else if(!strcmp(tok, "jsonwrap"))
540 ret |= RRDR_OPTION_JSON_WRAP;
541 else if(!strcmp(tok, "min2max"))
542 ret |= RRDR_OPTION_MIN2MAX;
543 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
544 ret |= RRDR_OPTION_MILLISECONDS;
545 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
546 ret |= RRDR_OPTION_ABSOLUTE;
547 else if(!strcmp(tok, "seconds"))
548 ret |= RRDR_OPTION_SECONDS;
549 else if(!strcmp(tok, "null2zero"))
550 ret |= RRDR_OPTION_NULL2ZERO;
551 else if(!strcmp(tok, "objectrows"))
552 ret |= RRDR_OPTION_OBJECTSROWS;
553 else if(!strcmp(tok, "google_json"))
554 ret |= RRDR_OPTION_GOOGLE_JSON;
555 else if(!strcmp(tok, "percentage"))
556 ret |= RRDR_OPTION_PERCENTAGE;
557 else if(!strcmp(tok, "unaligned"))
558 ret |= RRDR_OPTION_NOT_ALIGNED;
564 uint32_t web_client_api_request_v1_data_format(char *name)
566 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
567 return DATASOURCE_DATATABLE_JSON;
569 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
570 return DATASOURCE_DATATABLE_JSONP;
572 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
573 return DATASOURCE_JSON;
575 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
576 return DATASOURCE_JSONP;
578 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
579 return DATASOURCE_SSV;
581 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
582 return DATASOURCE_CSV;
584 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
585 return DATASOURCE_TSV;
587 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
588 return DATASOURCE_HTML;
590 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
591 return DATASOURCE_JS_ARRAY;
593 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
594 return DATASOURCE_SSV_COMMA;
596 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
597 return DATASOURCE_CSV_JSON_ARRAY;
599 return DATASOURCE_JSON;
602 uint32_t web_client_api_request_v1_data_google_format(char *name)
604 if(!strcmp(name, "json"))
605 return DATASOURCE_DATATABLE_JSONP;
607 else if(!strcmp(name, "html"))
608 return DATASOURCE_HTML;
610 else if(!strcmp(name, "csv"))
611 return DATASOURCE_CSV;
613 else if(!strcmp(name, "tsv-excel"))
614 return DATASOURCE_TSV;
616 return DATASOURCE_JSON;
619 const char *group_method2string(int group) {
621 case GROUP_UNDEFINED:
636 case GROUP_INCREMENTAL_SUM:
637 return "incremental-sum";
640 return "unknown-group-method";
644 int web_client_api_request_v1_data_group(char *name, int def)
646 if(!strcmp(name, "average"))
647 return GROUP_AVERAGE;
649 else if(!strcmp(name, "min"))
652 else if(!strcmp(name, "max"))
655 else if(!strcmp(name, "sum"))
658 else if(!strcmp(name, "incremental-sum"))
659 return GROUP_INCREMENTAL_SUM;
664 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
669 char *value = mystrsep(&url, "?&");
670 if (!value || !*value) continue;
672 if(!strcmp(value, "all")) all = 1;
673 else if(!strcmp(value, "active")) all = 0;
676 buffer_flush(w->response.data);
677 w->response.data->contenttype = CT_APPLICATION_JSON;
678 health_alarms2json(&localhost, w->response.data, all);
682 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
687 char *value = mystrsep(&url, "?&");
688 if (!value || !*value) continue;
690 char *name = mystrsep(&value, "=");
691 if(!name || !*name) continue;
692 if(!value || !*value) continue;
694 if(!strcmp(name, "after")) after = strtoul(value, NULL, 0);
697 buffer_flush(w->response.data);
698 w->response.data->contenttype = CT_APPLICATION_JSON;
699 health_alarm_log2json(&localhost, w->response.data, after);
703 int web_client_api_request_single_chart(struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
708 buffer_flush(w->response.data);
711 char *value = mystrsep(&url, "?&");
712 if(!value || !*value) continue;
714 char *name = mystrsep(&value, "=");
715 if(!name || !*name) continue;
716 if(!value || !*value) continue;
718 // name and value are now the parameters
719 // they are not null and not empty
721 if(!strcmp(name, "chart")) chart = value;
723 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
728 if(!chart || !*chart) {
729 buffer_sprintf(w->response.data, "No chart id is given at the request.");
733 RRDSET *st = rrdset_find(chart);
734 if(!st) st = rrdset_find_byname(chart);
736 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
741 w->response.data->contenttype = CT_APPLICATION_JSON;
742 callback(st, w->response.data);
749 int web_client_api_request_v1_alarm_variables(struct web_client *w, char *url)
751 return web_client_api_request_single_chart(w, url, health_api_v1_chart_variables2json);
754 int web_client_api_request_v1_charts(struct web_client *w, char *url)
758 buffer_flush(w->response.data);
759 w->response.data->contenttype = CT_APPLICATION_JSON;
760 rrd_stats_api_v1_charts(w->response.data);
764 int web_client_api_request_v1_chart(struct web_client *w, char *url)
766 return web_client_api_request_single_chart(w, url, rrd_stats_api_v1_chart);
769 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
771 buffer_flush(w->response.data);
773 BUFFER *dimensions = NULL;
775 const char *chart = NULL
779 , *multiply_str = NULL
783 , *label_color = NULL
784 , *value_color = NULL
785 , *refresh_str = NULL
786 , *precision_str = NULL
789 int group = GROUP_AVERAGE;
790 uint32_t options = 0x00000000;
793 char *value = mystrsep(&url, "/?&");
794 if(!value || !*value) continue;
796 char *name = mystrsep(&value, "=");
797 if(!name || !*name) continue;
798 if(!value || !*value) continue;
800 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
802 // name and value are now the parameters
803 // they are not null and not empty
805 if(!strcmp(name, "chart")) chart = value;
806 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
808 dimensions = buffer_create(100);
810 buffer_strcat(dimensions, "|");
811 buffer_strcat(dimensions, value);
813 else if(!strcmp(name, "after")) after_str = value;
814 else if(!strcmp(name, "before")) before_str = value;
815 else if(!strcmp(name, "points")) points_str = value;
816 else if(!strcmp(name, "group")) {
817 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
819 else if(!strcmp(name, "options")) {
820 options |= web_client_api_request_v1_data_options(value);
822 else if(!strcmp(name, "label")) label = value;
823 else if(!strcmp(name, "units")) units = value;
824 else if(!strcmp(name, "label_color")) label_color = value;
825 else if(!strcmp(name, "value_color")) value_color = value;
826 else if(!strcmp(name, "multiply")) multiply_str = value;
827 else if(!strcmp(name, "divide")) divide_str = value;
828 else if(!strcmp(name, "refresh")) refresh_str = value;
829 else if(!strcmp(name, "precision")) precision_str = value;
830 else if(!strcmp(name, "alarm")) alarm = value;
833 if(!chart || !*chart) {
834 buffer_no_cacheable(w->response.data);
835 buffer_sprintf(w->response.data, "No chart id is given at the request.");
839 RRDSET *st = rrdset_find(chart);
840 if(!st) st = rrdset_find_byname(chart);
842 buffer_no_cacheable(w->response.data);
843 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
850 rc = rrdcalc_find(st, alarm);
852 buffer_no_cacheable(w->response.data);
853 buffer_svg(w->response.data, "alarm not found", 0, "", NULL, NULL, 1, -1);
859 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
860 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
861 long long before = (before_str && *before_str )?atol(before_str):0;
862 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
863 int points = (points_str && *points_str )?atoi(points_str):1;
864 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
866 if(!multiply) multiply = 1;
867 if(!divide) divide = 1;
870 if(refresh_str && *refresh_str) {
871 if(!strcmp(refresh_str, "auto")) {
872 if(rc) refresh = rc->update_every;
873 else if(options & RRDR_OPTION_NOT_ALIGNED)
874 refresh = st->update_every;
876 refresh = (int)(before - after);
877 if(refresh < 0) refresh = -refresh;
881 refresh = atoi(refresh_str);
882 if(refresh < 0) refresh = -refresh;
888 char *s = (char *)alarm;
890 if(*s == '_') *s = ' ';
895 else if(dimensions) {
896 const char *dim = buffer_tostring(dimensions);
897 if(*dim == '|') dim++;
910 else if(options & RRDR_OPTION_PERCENTAGE)
916 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'"
920 , (dimensions)?buffer_tostring(dimensions):""
929 calculated_number n = rc->value;
930 if(isnan(n) || isinf(n)) n = 0;
933 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
934 w->response.data->expires = time(NULL) + refresh;
936 else buffer_no_cacheable(w->response.data);
940 case RRDCALC_STATUS_CRITICAL:
944 case RRDCALC_STATUS_WARNING:
945 value_color = "orange";
948 case RRDCALC_STATUS_CLEAR:
949 value_color = "brightgreen";
952 case RRDCALC_STATUS_UNDEFINED:
953 value_color = "lightgrey";
956 case RRDCALC_STATUS_UNINITIALIZED:
957 value_color = "#000";
961 value_color = "grey";
966 buffer_svg(w->response.data,
968 rc->value * multiply / divide,
977 time_t latest_timestamp = 0;
978 int value_is_null = 1;
979 calculated_number n = 0;
982 // if the collected value is too old, don't calculate its value
983 if (rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
987 (dimensions) ? buffer_tostring(dimensions) : NULL,
997 // if the value cannot be calculated, show empty badge
999 buffer_no_cacheable(w->response.data);
1004 else if (refresh > 0) {
1005 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1006 w->response.data->expires = time(NULL) + refresh;
1008 else buffer_no_cacheable(w->response.data);
1011 buffer_svg(w->response.data,
1013 n * multiply / divide,
1023 buffer_free(dimensions);
1027 // returns the HTTP code
1028 int web_client_api_request_v1_data(struct web_client *w, char *url)
1030 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1033 BUFFER *dimensions = NULL;
1035 buffer_flush(w->response.data);
1037 char *google_version = "0.6",
1038 *google_reqId = "0",
1040 *google_out = "json",
1041 *responseHandler = NULL,
1042 *outFileName = NULL;
1044 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1047 , *before_str = NULL
1049 , *points_str = NULL;
1051 int group = GROUP_AVERAGE;
1052 uint32_t format = DATASOURCE_JSON;
1053 uint32_t options = 0x00000000;
1056 char *value = mystrsep(&url, "?&");
1057 if(!value || !*value) continue;
1059 char *name = mystrsep(&value, "=");
1060 if(!name || !*name) continue;
1061 if(!value || !*value) continue;
1063 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1065 // name and value are now the parameters
1066 // they are not null and not empty
1068 if(!strcmp(name, "chart")) chart = value;
1069 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1070 if(!dimensions) dimensions = buffer_create(100);
1071 buffer_strcat(dimensions, "|");
1072 buffer_strcat(dimensions, value);
1074 else if(!strcmp(name, "after")) after_str = value;
1075 else if(!strcmp(name, "before")) before_str = value;
1076 else if(!strcmp(name, "points")) points_str = value;
1077 else if(!strcmp(name, "group")) {
1078 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1080 else if(!strcmp(name, "format")) {
1081 format = web_client_api_request_v1_data_format(value);
1083 else if(!strcmp(name, "options")) {
1084 options |= web_client_api_request_v1_data_options(value);
1086 else if(!strcmp(name, "callback")) {
1087 responseHandler = value;
1089 else if(!strcmp(name, "filename")) {
1090 outFileName = value;
1092 else if(!strcmp(name, "tqx")) {
1093 // parse Google Visualization API options
1094 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1095 char *tqx_name, *tqx_value;
1098 tqx_value = mystrsep(&value, ";");
1099 if(!tqx_value || !*tqx_value) continue;
1101 tqx_name = mystrsep(&tqx_value, ":");
1102 if(!tqx_name || !*tqx_name) continue;
1103 if(!tqx_value || !*tqx_value) continue;
1105 if(!strcmp(tqx_name, "version"))
1106 google_version = tqx_value;
1107 else if(!strcmp(tqx_name, "reqId"))
1108 google_reqId = tqx_value;
1109 else if(!strcmp(tqx_name, "sig")) {
1110 google_sig = tqx_value;
1111 google_timestamp = strtoul(google_sig, NULL, 0);
1113 else if(!strcmp(tqx_name, "out")) {
1114 google_out = tqx_value;
1115 format = web_client_api_request_v1_data_google_format(google_out);
1117 else if(!strcmp(tqx_name, "responseHandler"))
1118 responseHandler = tqx_value;
1119 else if(!strcmp(tqx_name, "outFileName"))
1120 outFileName = tqx_value;
1125 if(!chart || !*chart) {
1126 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1130 RRDSET *st = rrdset_find(chart);
1131 if(!st) st = rrdset_find_byname(chart);
1133 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
1138 long long before = (before_str && *before_str)?atol(before_str):0;
1139 long long after = (after_str && *after_str) ?atol(after_str):0;
1140 int points = (points_str && *points_str)?atoi(points_str):0;
1142 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'"
1145 , (dimensions)?buffer_tostring(dimensions):""
1154 if(outFileName && *outFileName) {
1155 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1156 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1159 if(format == DATASOURCE_DATATABLE_JSONP) {
1160 if(responseHandler == NULL)
1161 responseHandler = "google.visualization.Query.setResponse";
1163 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1164 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1167 buffer_sprintf(w->response.data,
1168 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1169 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1171 else if(format == DATASOURCE_JSONP) {
1172 if(responseHandler == NULL)
1173 responseHandler = "callback";
1175 buffer_strcat(w->response.data, responseHandler);
1176 buffer_strcat(w->response.data, "(");
1179 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1181 if(format == DATASOURCE_DATATABLE_JSONP) {
1182 if(google_timestamp < last_timestamp_in_data)
1183 buffer_strcat(w->response.data, "});");
1186 // the client already has the latest data
1187 buffer_flush(w->response.data);
1188 buffer_sprintf(w->response.data,
1189 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1190 responseHandler, google_version, google_reqId);
1193 else if(format == DATASOURCE_JSONP)
1194 buffer_strcat(w->response.data, ");");
1197 if(dimensions) buffer_free(dimensions);
1202 #define REGISTRY_VERIFY_COOKIES_GUID "give-me-back-this-cookie-now--please"
1204 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1206 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1207 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1208 hash_to = 0 /*, hash_redirects = 0 */;
1210 if(unlikely(!hash_action)) {
1211 hash_action = simple_hash("action");
1212 hash_access = simple_hash("access");
1213 hash_hello = simple_hash("hello");
1214 hash_delete = simple_hash("delete");
1215 hash_search = simple_hash("search");
1216 hash_switch = simple_hash("switch");
1217 hash_machine = simple_hash("machine");
1218 hash_url = simple_hash("url");
1219 hash_name = simple_hash("name");
1220 hash_delete_url = simple_hash("delete_url");
1221 hash_for = simple_hash("for");
1222 hash_to = simple_hash("to");
1224 hash_redirects = simple_hash("redirects");
1228 char person_guid[36 + 1] = "";
1230 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1233 // The browser may send multiple cookies with our id
1235 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1237 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1240 char *machine_guid = NULL,
1241 *machine_url = NULL,
1243 *search_machine_guid = NULL,
1245 *to_person_guid = NULL;
1251 char *value = mystrsep(&url, "?&");
1252 if (!value || !*value) continue;
1254 char *name = mystrsep(&value, "=");
1255 if (!name || !*name) continue;
1256 if (!value || !*value) continue;
1258 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1260 uint32_t hash = simple_hash(name);
1262 if(hash == hash_action && !strcmp(name, "action")) {
1263 uint32_t vhash = simple_hash(value);
1265 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1266 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1267 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1268 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1269 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1270 #ifdef NETDATA_INTERNAL_CHECKS
1271 else error("unknown registry action '%s'", value);
1272 #endif /* NETDATA_INTERNAL_CHECKS */
1275 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1276 redirects = atoi(value);
1278 else if(hash == hash_machine && !strcmp(name, "machine"))
1279 machine_guid = value;
1281 else if(hash == hash_url && !strcmp(name, "url"))
1282 machine_url = value;
1284 else if(action == 'A') {
1285 if(hash == hash_name && !strcmp(name, "name"))
1288 else if(action == 'D') {
1289 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1292 else if(action == 'S') {
1293 if(hash == hash_for && !strcmp(name, "for"))
1294 search_machine_guid = value;
1296 else if(action == 'W') {
1297 if(hash == hash_to && !strcmp(name, "to"))
1298 to_person_guid = value;
1300 #ifdef NETDATA_INTERNAL_CHECKS
1301 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1302 #endif /* NETDATA_INTERNAL_CHECKS */
1305 if(web_donotrack_comply && w->donottrack) {
1306 buffer_flush(w->response.data);
1307 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.");
1311 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1312 buffer_flush(w->response.data);
1313 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1314 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1317 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1318 buffer_flush(w->response.data);
1319 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1320 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1323 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1324 buffer_flush(w->response.data);
1325 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1326 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1329 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1330 buffer_flush(w->response.data);
1331 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1332 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1338 w->tracking_required = 1;
1339 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1340 buffer_flush(w->response.data);
1341 registry_set_cookie(w, REGISTRY_VERIFY_COOKIES_GUID);
1342 w->response.data->contenttype = CT_APPLICATION_JSON;
1343 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1347 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1348 * under certain conditions, when using CORS
1349 * so this is commented and we use application level redirects instead
1353 if(redirects > registry_verify_cookies_redirects()) {
1354 buffer_flush(w->response.data);
1355 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1359 char *encoded_url = url_encode(machine_url);
1361 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1365 char *encoded_name = url_encode(url_name);
1368 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1372 char *encoded_guid = url_encode(machine_guid);
1376 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1380 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1381 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1390 if(unlikely(cookie && person_guid[0] && !strcmp(person_guid, REGISTRY_VERIFY_COOKIES_GUID)))
1391 person_guid[0] = '\0';
1393 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1396 w->tracking_required = 1;
1397 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1400 w->tracking_required = 1;
1401 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1404 w->tracking_required = 1;
1405 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1408 return registry_request_hello_json(w);
1411 buffer_flush(w->response.data);
1412 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1417 int web_client_api_request_v1(struct web_client *w, char *url) {
1418 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;
1420 if(unlikely(hash_data == 0)) {
1421 hash_data = simple_hash("data");
1422 hash_chart = simple_hash("chart");
1423 hash_charts = simple_hash("charts");
1424 hash_registry = simple_hash("registry");
1425 hash_badge = simple_hash("badge.svg");
1426 hash_alarms = simple_hash("alarms");
1427 hash_alarm_log = simple_hash("alarm_log");
1428 hash_alarm_variables = simple_hash("alarm_variables");
1432 char *tok = mystrsep(&url, "/?&");
1434 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1435 uint32_t hash = simple_hash(tok);
1437 if(hash == hash_data && !strcmp(tok, "data"))
1438 return web_client_api_request_v1_data(w, url);
1440 else if(hash == hash_chart && !strcmp(tok, "chart"))
1441 return web_client_api_request_v1_chart(w, url);
1443 else if(hash == hash_charts && !strcmp(tok, "charts"))
1444 return web_client_api_request_v1_charts(w, url);
1446 else if(hash == hash_registry && !strcmp(tok, "registry"))
1447 return web_client_api_request_v1_registry(w, url);
1449 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1450 return web_client_api_request_v1_badge(w, url);
1452 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1453 return web_client_api_request_v1_alarms(w, url);
1455 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1456 return web_client_api_request_v1_alarm_log(w, url);
1458 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1459 return web_client_api_request_v1_alarm_variables(w, url);
1462 buffer_flush(w->response.data);
1463 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1468 buffer_flush(w->response.data);
1469 buffer_sprintf(w->response.data, "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_sprintf(w->response.data, "Unsupported API version: %s", tok);
1489 buffer_flush(w->response.data);
1490 buffer_sprintf(w->response.data, "Which API version?");
1495 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1499 char *args = strchr(url, '?');
1505 // get the name of the data to show
1506 char *tok = mystrsep(&url, "/");
1509 // do we have such a data set?
1511 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1512 st = rrdset_find_byname(tok);
1513 if(!st) st = rrdset_find(tok);
1518 // try to send a file with that name
1519 buffer_flush(w->response.data);
1520 return(mysendfile(w, tok));
1524 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1526 // how many entries does the client want?
1527 int lines = rrd_default_history_entries;
1528 int group_count = 1;
1529 time_t after = 0, before = 0;
1530 int group_method = GROUP_AVERAGE;
1534 // parse the lines required
1535 tok = mystrsep(&url, "/");
1536 if(tok) lines = atoi(tok);
1537 if(lines < 1) lines = 1;
1540 // parse the group count required
1541 tok = mystrsep(&url, "/");
1542 if(tok && *tok) group_count = atoi(tok);
1543 if(group_count < 1) group_count = 1;
1544 //if(group_count > save_history / 20) group_count = save_history / 20;
1547 // parse the grouping method required
1548 tok = mystrsep(&url, "/");
1550 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1551 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1552 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1553 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1558 tok = mystrsep(&url, "/");
1559 if(tok && *tok) after = strtoul(tok, NULL, 10);
1560 if(after < 0) after = 0;
1563 // parse before time
1564 tok = mystrsep(&url, "/");
1565 if(tok && *tok) before = strtoul(tok, NULL, 10);
1566 if(before < 0) before = 0;
1570 tok = mystrsep(&url, "/");
1571 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1574 w->response.data->contenttype = CT_APPLICATION_JSON;
1575 buffer_flush(w->response.data);
1577 char *google_version = "0.6";
1578 char *google_reqId = "0";
1579 char *google_sig = "0";
1580 char *google_out = "json";
1581 char *google_responseHandler = "google.visualization.Query.setResponse";
1582 char *google_outFileName = NULL;
1583 time_t last_timestamp_in_data = 0;
1584 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1586 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1589 tok = mystrsep(&args, "&");
1591 char *name = mystrsep(&tok, "=");
1592 if(name && *name && strcmp(name, "tqx") == 0) {
1593 char *key = mystrsep(&tok, ":");
1594 char *value = mystrsep(&tok, ";");
1595 if(key && value && *key && *value) {
1596 if(strcmp(key, "version") == 0)
1597 google_version = value;
1599 else if(strcmp(key, "reqId") == 0)
1600 google_reqId = value;
1602 else if(strcmp(key, "sig") == 0)
1605 else if(strcmp(key, "out") == 0)
1608 else if(strcmp(key, "responseHandler") == 0)
1609 google_responseHandler = value;
1611 else if(strcmp(key, "outFileName") == 0)
1612 google_outFileName = value;
1618 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1619 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1622 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1623 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1625 // check the client wants json
1626 if(strcmp(google_out, "json") != 0) {
1627 buffer_sprintf(w->response.data,
1628 "%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.'}]});",
1629 google_responseHandler, google_version, google_reqId, google_out);
1635 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1636 buffer_sprintf(w->response.data,
1637 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1638 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1641 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1642 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1644 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);
1646 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1647 if(timestamp_in_data > last_timestamp_in_data)
1648 buffer_strcat(w->response.data, "});");
1651 // the client already has the latest data
1652 buffer_flush(w->response.data);
1653 buffer_sprintf(w->response.data,
1654 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1655 google_responseHandler, google_version, google_reqId);
1662 const char *web_content_type_to_string(uint8_t contenttype) {
1663 switch(contenttype) {
1665 return "text/html; charset=utf-8";
1667 case CT_APPLICATION_XML:
1668 return "application/xml; charset=utf-8";
1670 case CT_APPLICATION_JSON:
1671 return "application/json; charset=utf-8";
1673 case CT_APPLICATION_X_JAVASCRIPT:
1674 return "application/x-javascript; charset=utf-8";
1677 return "text/css; charset=utf-8";
1680 return "text/xml; charset=utf-8";
1683 return "text/xsl; charset=utf-8";
1685 case CT_APPLICATION_OCTET_STREAM:
1686 return "application/octet-stream";
1688 case CT_IMAGE_SVG_XML:
1689 return "image/svg+xml";
1691 case CT_APPLICATION_X_FONT_TRUETYPE:
1692 return "application/x-font-truetype";
1694 case CT_APPLICATION_X_FONT_OPENTYPE:
1695 return "application/x-font-opentype";
1697 case CT_APPLICATION_FONT_WOFF:
1698 return "application/font-woff";
1700 case CT_APPLICATION_FONT_WOFF2:
1701 return "application/font-woff2";
1703 case CT_APPLICATION_VND_MS_FONTOBJ:
1704 return "application/vnd.ms-fontobject";
1710 return "image/jpeg";
1715 case CT_IMAGE_XICON:
1716 return "image/x-icon";
1722 return "image/icns";
1726 return "text/plain; charset=utf-8";
1731 const char *web_response_code_to_string(int code) {
1737 return "Temporary Redirect";
1740 return "Bad Request";
1749 return "Preconditions Failed";
1752 if(code >= 100 && code < 200)
1753 return "Informational";
1755 if(code >= 200 && code < 300)
1756 return "Successful";
1758 if(code >= 300 && code < 400)
1759 return "Redirection";
1761 if(code >= 400 && code < 500)
1762 return "Bad Request";
1764 if(code >= 500 && code < 600)
1765 return "Server Error";
1767 return "Undefined Error";
1771 static inline char *http_header_parse(struct web_client *w, char *s) {
1772 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1774 if(unlikely(!hash_origin)) {
1775 hash_origin = simple_uhash("Origin");
1776 hash_connection = simple_uhash("Connection");
1777 hash_accept_encoding = simple_uhash("Accept-Encoding");
1778 hash_donottrack = simple_uhash("DNT");
1784 while(*e && *e != ':') e++;
1791 char *v = e + 1, *ve;
1793 // skip leading spaces from value
1794 while(*v == ' ') v++;
1798 while(*ve && *ve != '\r') ve++;
1799 if(!*ve || ve[1] != '\n') {
1804 // terminate the value
1807 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1808 uint32_t hash = simple_uhash(s);
1810 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1811 strncpyz(w->origin, v, ORIGIN_MAX);
1813 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1814 if(strcasestr(v, "keep-alive"))
1817 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1818 if(*v == '0') w->donottrack = 0;
1819 else if(*v == '1') w->donottrack = 1;
1821 #ifdef NETDATA_WITH_ZLIB
1822 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1823 if(web_enable_gzip) {
1824 if(strcasestr(v, "gzip"))
1825 web_client_enable_deflate(w, 1);
1827 // does not seem to work
1828 // else if(strcasestr(v, "deflate"))
1829 // web_client_enable_deflate(w, 0);
1832 #endif /* NETDATA_WITH_ZLIB */
1839 // http_request_validate()
1841 // = 0 : all good, process the request
1842 // > 0 : request is not supported
1843 // < 0 : request is incomplete - wait for more data
1845 static inline int http_request_validate(struct web_client *w) {
1846 char *s = w->response.data->buffer, *encoded_url = NULL;
1848 // is is a valid request?
1849 if(!strncmp(s, "GET ", 4)) {
1850 encoded_url = s = &s[4];
1851 w->mode = WEB_CLIENT_MODE_NORMAL;
1853 else if(!strncmp(s, "OPTIONS ", 8)) {
1854 encoded_url = s = &s[8];
1855 w->mode = WEB_CLIENT_MODE_OPTIONS;
1858 w->wait_receive = 0;
1862 // find the SPACE + "HTTP/"
1864 // find the next space
1865 while (*s && *s != ' ') s++;
1867 // is it SPACE + "HTTP/" ?
1868 if(*s && !strncmp(s, " HTTP/", 6)) break;
1872 // incomplete requests
1874 w->wait_receive = 1;
1878 // we have the end of encoded_url - remember it
1881 // make sure we have complete request
1882 // complete requests contain: \r\n\r\n
1885 while(*s && *s++ != '\r');
1887 // did we reach the end?
1888 if(unlikely(!*s)) break;
1891 if(likely(*s++ == '\n')) {
1893 // is it again \r\n ? (header end)
1894 if(unlikely(*s == '\r' && s[1] == '\n')) {
1895 // a valid complete HTTP request found
1898 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1901 // copy the URL - we are going to overwrite parts of it
1902 // FIXME -- we should avoid it
1903 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1905 w->wait_receive = 0;
1909 // another header line
1910 s = http_header_parse(w, s);
1914 // incomplete request
1915 w->wait_receive = 1;
1919 void web_client_process(struct web_client *w) {
1922 hash_netdata_conf = 0,
1924 hash_datasource = 0,
1929 #ifdef NETDATA_INTERNAL_CHECKS
1930 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1934 gettimeofday(&w->tv_in, NULL);
1936 if(unlikely(!hash_api)) {
1937 hash_api = simple_hash("api");
1938 hash_netdata_conf = simple_hash("netdata.conf");
1939 hash_data = simple_hash(WEB_PATH_DATA);
1940 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1941 hash_graph = simple_hash(WEB_PATH_GRAPH);
1942 hash_list = simple_hash("list");
1943 hash_all_json = simple_hash("all.json");
1944 #ifdef NETDATA_INTERNAL_CHECKS
1945 hash_exit = simple_hash("exit");
1946 hash_debug = simple_hash("debug");
1947 hash_mirror = simple_hash("mirror");
1954 int what_to_do = http_request_validate(w);
1956 // wait for more data
1957 if(what_to_do < 0) {
1958 if(w->response.data->len > TOO_BIG_REQUEST) {
1959 strcpy(w->last_url, "too big request");
1961 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1964 buffer_flush(w->response.data);
1965 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1968 // wait for more data
1972 else if(what_to_do > 0) {
1973 // strcpy(w->last_url, "not a valid request");
1975 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1978 buffer_flush(w->response.data);
1979 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1981 else { // what_to_do == 0
1982 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1984 w->response.data->contenttype = CT_TEXT_PLAIN;
1985 buffer_flush(w->response.data);
1986 buffer_strcat(w->response.data, "OK");
1989 char *url = w->decoded_url;
1990 char *tok = mystrsep(&url, "/?");
1992 uint32_t hash = simple_hash(tok);
1993 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1995 if(hash == hash_api && strcmp(tok, "api") == 0) {
1996 // the client is requesting api access
1997 code = web_client_api_request(w, url);
1999 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
2001 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2003 w->response.data->contenttype = CT_TEXT_PLAIN;
2004 buffer_flush(w->response.data);
2005 generate_config(w->response.data, 0);
2007 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
2008 // the client is requesting rrd data -- OLD API
2009 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
2011 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
2012 // the client is requesting google datasource -- OLD API
2013 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
2015 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
2016 // the client is requesting an rrd graph -- OLD API
2018 // get the name of the data to show
2019 tok = mystrsep(&url, "/?&");
2021 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2023 // do we have such a data set?
2024 RRDSET *st = rrdset_find_byname(tok);
2025 if(!st) st = rrdset_find(tok);
2028 // try to send a file with that name
2029 buffer_flush(w->response.data);
2030 code = mysendfile(w, tok);
2034 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2035 w->response.data->contenttype = CT_APPLICATION_JSON;
2036 buffer_flush(w->response.data);
2037 rrd_stats_graph_json(st, url, w->response.data);
2042 buffer_flush(w->response.data);
2043 buffer_strcat(w->response.data, "Graph name?\r\n");
2046 else if(hash == hash_list && strcmp(tok, "list") == 0) {
2050 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2052 buffer_flush(w->response.data);
2053 RRDSET *st = localhost.rrdset_root;
2055 for ( ; st ; st = st->next )
2056 buffer_sprintf(w->response.data, "%s\n", st->name);
2058 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
2061 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2063 w->response.data->contenttype = CT_APPLICATION_JSON;
2064 buffer_flush(w->response.data);
2065 rrd_stats_all_json(w->response.data);
2067 #ifdef NETDATA_INTERNAL_CHECKS
2068 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
2070 w->response.data->contenttype = CT_TEXT_PLAIN;
2071 buffer_flush(w->response.data);
2074 buffer_strcat(w->response.data, "ok, will do...");
2076 buffer_strcat(w->response.data, "I am doing it already");
2078 error("web request to exit received.");
2079 netdata_cleanup_and_exit(0);
2082 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2083 buffer_flush(w->response.data);
2085 // get the name of the data to show
2086 tok = mystrsep(&url, "/?&");
2088 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2090 // do we have such a data set?
2091 RRDSET *st = rrdset_find_byname(tok);
2092 if(!st) st = rrdset_find(tok);
2095 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
2096 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2100 debug_flags |= D_RRD_STATS;
2101 st->debug = !st->debug;
2102 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
2103 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2108 buffer_flush(w->response.data);
2109 buffer_strcat(w->response.data, "debug which chart?\r\n");
2112 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2115 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2117 // replace the zero bytes with spaces
2118 buffer_char_replace(w->response.data, '\0', ' ');
2120 // just leave the buffer as is
2121 // it will be copied back to the client
2123 #endif /* NETDATA_INTERNAL_CHECKS */
2125 char filename[FILENAME_MAX+1];
2127 strncpyz(filename, w->last_url, FILENAME_MAX);
2128 tok = mystrsep(&url, "?");
2129 buffer_flush(w->response.data);
2130 code = mysendfile(w, (tok && *tok)?tok:"/");
2134 char filename[FILENAME_MAX+1];
2136 strncpyz(filename, w->last_url, FILENAME_MAX);
2137 tok = mystrsep(&url, "?");
2138 buffer_flush(w->response.data);
2139 code = mysendfile(w, (tok && *tok)?tok:"/");
2144 gettimeofday(&w->tv_ready, NULL);
2145 w->response.sent = 0;
2146 w->response.code = code;
2148 // set a proper last modified date
2149 if(unlikely(!w->response.data->date))
2150 w->response.data->date = w->tv_ready.tv_sec;
2152 if(unlikely(code != 200))
2153 buffer_no_cacheable(w->response.data);
2155 // set a proper expiration date, if not already set
2156 if(unlikely(!w->response.data->expires)) {
2157 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
2158 w->response.data->expires = w->tv_ready.tv_sec + rrd_update_every;
2160 w->response.data->expires = w->tv_ready.tv_sec + 86400;
2163 // prepare the HTTP response header
2164 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2166 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2167 const char *code_msg = web_response_code_to_string(code);
2169 // prepare the last modified and expiration dates
2170 char date[32], edate[32];
2172 struct tm tmbuf, *tm;
2174 tm = gmtime_r(&w->response.data->date, &tmbuf);
2175 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2177 tm = gmtime_r(&w->response.data->expires, &tmbuf);
2178 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
2181 buffer_sprintf(w->response.header_output,
2182 "HTTP/1.1 %d %s\r\n"
2183 "Connection: %s\r\n"
2184 "Server: NetData Embedded HTTP Server\r\n"
2185 "Access-Control-Allow-Origin: %s\r\n"
2186 "Access-Control-Allow-Credentials: true\r\n"
2187 "Content-Type: %s\r\n"
2190 , w->keepalive?"keep-alive":"close"
2192 , content_type_string
2196 if(w->cookie1[0] || w->cookie2[0]) {
2198 buffer_sprintf(w->response.header_output,
2199 "Set-Cookie: %s\r\n",
2204 buffer_sprintf(w->response.header_output,
2205 "Set-Cookie: %s\r\n",
2209 if(web_donotrack_comply)
2210 buffer_sprintf(w->response.header_output,
2211 "Tk: T;cookies\r\n");
2214 if(web_donotrack_comply) {
2215 if(w->tracking_required)
2216 buffer_sprintf(w->response.header_output,
2217 "Tk: T;cookies\r\n");
2219 buffer_sprintf(w->response.header_output,
2224 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2225 buffer_strcat(w->response.header_output,
2226 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2227 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2228 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2232 buffer_sprintf(w->response.header_output,
2233 "Cache-Control: %s\r\n"
2235 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2239 // copy a possibly available custom header
2240 if(unlikely(buffer_strlen(w->response.header)))
2241 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2243 // headers related to the transfer method
2244 if(likely(w->response.zoutput)) {
2245 buffer_strcat(w->response.header_output,
2246 "Content-Encoding: gzip\r\n"
2247 "Transfer-Encoding: chunked\r\n"
2251 if(likely((w->response.data->len || w->response.rlen))) {
2252 // we know the content length, put it
2253 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2256 // we don't know the content length, disable keep-alive
2261 // end of HTTP header
2262 buffer_strcat(w->response.header_output, "\r\n");
2264 // sent the HTTP header
2265 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2267 , buffer_strlen(w->response.header_output)
2268 , buffer_tostring(w->response.header_output)
2271 web_client_crock_socket(w);
2273 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2274 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2276 w->stats_sent_bytes += bytes;
2278 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2280 , buffer_strlen(w->response.header_output)
2283 WEB_CLIENT_IS_DEAD(w);
2287 w->stats_sent_bytes += bytes;
2289 // enable sending immediately if we have data
2290 if(w->response.data->len) w->wait_send = 1;
2291 else w->wait_send = 0;
2295 case WEB_CLIENT_MODE_OPTIONS:
2296 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2299 case WEB_CLIENT_MODE_NORMAL:
2300 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2303 case WEB_CLIENT_MODE_FILECOPY:
2304 if(w->response.rlen) {
2305 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2306 w->wait_receive = 1;
2309 // utilize the kernel sendfile() for copying the file to the socket.
2310 // this block of code can be commented, without anything missing.
2311 // when it is commented, the program will copy the data using async I/O.
2313 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2314 if(len != w->response.data->rbytes)
2315 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2317 web_client_reset(w);
2322 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2326 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2331 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2333 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2335 sprintf(buf, "%zX\r\n", len);
2337 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2339 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2340 w->stats_sent_bytes += bytes;
2343 else if(bytes == 0) {
2344 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2345 WEB_CLIENT_IS_DEAD(w);
2348 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2349 WEB_CLIENT_IS_DEAD(w);
2355 ssize_t web_client_send_chunk_close(struct web_client *w)
2357 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2359 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2361 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2362 w->stats_sent_bytes += bytes;
2365 else if(bytes == 0) {
2366 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2367 WEB_CLIENT_IS_DEAD(w);
2370 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2371 WEB_CLIENT_IS_DEAD(w);
2377 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2379 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2381 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2383 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2384 w->stats_sent_bytes += bytes;
2387 else if(bytes == 0) {
2388 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2389 WEB_CLIENT_IS_DEAD(w);
2392 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2393 WEB_CLIENT_IS_DEAD(w);
2399 #ifdef NETDATA_WITH_ZLIB
2400 ssize_t web_client_send_deflate(struct web_client *w)
2402 ssize_t len = 0, t = 0;
2404 // when using compression,
2405 // w->response.sent is the amount of bytes passed through compression
2407 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.",
2408 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);
2410 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) {
2411 // there is nothing to send
2413 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2415 // finalize the chunk
2416 if(w->response.sent != 0) {
2417 t = web_client_send_chunk_finalize(w);
2421 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2422 // we have to wait, more data will come
2423 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2428 if(unlikely(!w->keepalive)) {
2429 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2430 WEB_CLIENT_IS_DEAD(w);
2435 web_client_reset(w);
2436 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2440 if(w->response.zhave == w->response.zsent) {
2441 // compress more input data
2443 // close the previous open chunk
2444 if(w->response.sent != 0) {
2445 t = web_client_send_chunk_close(w);
2449 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);
2451 // give the compressor all the data not passed through the compressor yet
2452 if(w->response.data->len > w->response.sent) {
2453 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2454 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2457 // reset the compressor output buffer
2458 w->response.zstream.next_out = w->response.zbuffer;
2459 w->response.zstream.avail_out = ZLIB_CHUNK;
2461 // ask for FINISH if we have all the input
2462 int flush = Z_SYNC_FLUSH;
2463 if(w->mode == WEB_CLIENT_MODE_NORMAL
2464 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2466 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2469 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2473 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2474 error("%llu: Compression failed. Closing down client.", w->id);
2475 web_client_reset(w);
2479 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2480 w->response.zsent = 0;
2482 // keep track of the bytes passed through the compressor
2483 w->response.sent = w->response.data->len;
2485 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2488 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2489 if(t2 < 0) return t2;
2493 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2495 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2497 w->stats_sent_bytes += len;
2498 w->response.zsent += len;
2500 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2503 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2504 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2506 WEB_CLIENT_IS_DEAD(w);
2509 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2510 WEB_CLIENT_IS_DEAD(w);
2515 #endif // NETDATA_WITH_ZLIB
2517 ssize_t web_client_send(struct web_client *w) {
2518 #ifdef NETDATA_WITH_ZLIB
2519 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2520 #endif // NETDATA_WITH_ZLIB
2524 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2525 // there is nothing to send
2527 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2529 // there can be two cases for this
2530 // A. we have done everything
2531 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2533 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2534 // we have to wait, more data will come
2535 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2540 if(unlikely(!w->keepalive)) {
2541 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2542 WEB_CLIENT_IS_DEAD(w);
2546 web_client_reset(w);
2547 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2551 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2552 if(likely(bytes > 0)) {
2553 w->stats_sent_bytes += bytes;
2554 w->response.sent += bytes;
2555 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2557 else if(likely(bytes == 0)) {
2558 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2559 WEB_CLIENT_IS_DEAD(w);
2562 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2563 WEB_CLIENT_IS_DEAD(w);
2569 ssize_t web_client_receive(struct web_client *w)
2571 // do we have any space for more data?
2572 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2574 ssize_t left = w->response.data->size - w->response.data->len;
2577 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2578 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2580 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2582 if(likely(bytes > 0)) {
2583 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2584 w->stats_received_bytes += bytes;
2586 size_t old = w->response.data->len;
2587 w->response.data->len += bytes;
2588 w->response.data->buffer[w->response.data->len] = '\0';
2590 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2591 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2593 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2596 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2597 w->wait_receive = 0;
2600 else if(likely(bytes == 0)) {
2601 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2603 // if we cannot read, it means we have an error on input.
2604 // if however, we are copying a file from ifd to ofd, we should not return an error.
2605 // in this case, the error should be generated when the file has been sent to the client.
2607 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2608 // we are copying data from ifd to ofd
2609 // let it finish copying...
2610 w->wait_receive = 0;
2612 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2613 if(w->ifd != w->ofd) close(w->ifd);
2617 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2618 WEB_CLIENT_IS_DEAD(w);
2622 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2623 WEB_CLIENT_IS_DEAD(w);
2630 // --------------------------------------------------------------------------------------
2631 // the thread of a single client
2633 // 1. waits for input and output, using async I/O
2634 // 2. it processes HTTP requests
2635 // 3. it generates HTTP responses
2636 // 4. it copies data from input to output if mode is FILECOPY
2638 void *web_client_main(void *ptr)
2640 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2641 error("Cannot set pthread cancel type to DEFERRED.");
2643 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2644 error("Cannot set pthread cancel state to ENABLE.");
2646 struct web_client *w = ptr;
2647 struct pollfd fds[2], *ifd, *ofd;
2648 int retval, fdmax = 0, timeout;
2650 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2653 if(unlikely(w->dead)) {
2654 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2657 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2658 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2662 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2663 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2667 if(w->ifd == w->ofd) {
2672 if(w->wait_receive) fds[0].events |= POLLIN;
2673 if(w->wait_send) fds[0].events |= POLLOUT;
2679 ifd = ofd = &fds[0];
2687 if(w->wait_receive) fds[0].events |= POLLIN;
2693 if(w->wait_send) fds[1].events |= POLLOUT;
2699 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2701 timeout = web_client_timeout * 1000;
2702 retval = poll(fds, fdmax, timeout);
2704 if(unlikely(retval == -1)) {
2705 if(errno == EAGAIN || errno == EINTR) {
2706 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2710 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2713 else if(unlikely(!retval)) {
2714 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":"");
2719 if(w->wait_send && ofd->revents & POLLOUT) {
2721 if(web_client_send(w) < 0) {
2722 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2727 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2729 if(web_client_receive(w) < 0) {
2730 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2734 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2735 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2736 web_client_process(w);
2740 if(unlikely(!used)) {
2741 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2746 web_client_reset(w);
2748 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2749 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2751 // close the sockets/files now
2752 // to free file descriptors
2753 if(w->ifd == w->ofd) {
2754 if(w->ifd != -1) close(w->ifd);
2757 if(w->ifd != -1) close(w->ifd);
2758 if(w->ofd != -1) close(w->ofd);