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 respect_web_browser_do_not_track_policy = 0;
9 char *web_x_frame_options = NULL;
11 #ifdef NETDATA_WITH_ZLIB
12 int web_enable_gzip = 1, web_gzip_level = 3, web_gzip_strategy = Z_DEFAULT_STRATEGY;
13 #endif /* NETDATA_WITH_ZLIB */
15 struct web_client *web_clients = NULL;
16 unsigned long long web_clients_count = 0;
18 static inline int web_client_crock_socket(struct web_client *w) {
20 if(likely(!w->tcp_cork && w->ofd != -1)) {
22 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
23 error("%llu: failed to enable TCP_CORK on socket.", w->id);
33 static inline int web_client_uncrock_socket(struct web_client *w) {
35 if(likely(w->tcp_cork && w->ofd != -1)) {
37 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
38 error("%llu: failed to disable TCP_CORK on socket.", w->id);
48 struct web_client *web_client_create(int listener)
52 w = callocz(1, sizeof(struct web_client));
53 w->id = ++web_clients_count;
54 w->mode = WEB_CLIENT_MODE_NORMAL;
57 struct sockaddr *sadr;
60 sadr = (struct sockaddr*) &w->clientaddr;
61 addrlen = sizeof(w->clientaddr);
63 w->ifd = accept4(listener, sadr, &addrlen, SOCK_NONBLOCK);
65 error("%llu: Cannot accept new incoming connection.", w->id);
71 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
72 error("Cannot getnameinfo() on received client connection.");
73 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
74 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
76 w->client_ip[NI_MAXHOST] = '\0';
77 w->client_port[NI_MAXSERV] = '\0';
79 switch(sadr->sa_family) {
81 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);
85 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
86 memmove(w->client_ip, &w->client_ip[7], strlen(&w->client_ip[7]) + 1);
87 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);
90 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);
94 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);
99 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
100 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
103 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
104 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
107 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
108 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
109 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
113 if(web_clients) web_clients->prev = w;
114 w->next = web_clients;
117 web_client_connected();
122 void web_client_reset(struct web_client *w) {
123 web_client_uncrock_socket(w);
125 debug(D_WEB_CLIENT, "%llu: Resetting client.", w->id);
127 if(likely(w->last_url[0])) {
129 now_realtime_timeval(&tv);
131 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
133 #ifdef NETDATA_WITH_ZLIB
134 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
137 // --------------------------------------------------------------------
140 finished_web_request_statistics(dt_usec(&tv, &w->tv_in),
141 w->stats_received_bytes,
146 w->stats_received_bytes = 0;
147 w->stats_sent_bytes = 0;
150 // --------------------------------------------------------------------
153 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
155 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
156 dt_usec(&w->tv_ready, &w->tv_in) / 1000.0,
157 dt_usec(&tv, &w->tv_ready) / 1000.0,
158 dt_usec(&tv, &w->tv_in) / 1000.0,
159 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
160 ? "options" : "data"),
166 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
167 if(w->ifd != w->ofd) {
168 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
169 if(w->ifd != -1) close(w->ifd);
174 w->last_url[0] = '\0';
175 w->cookie1[0] = '\0';
176 w->cookie2[0] = '\0';
180 w->mode = WEB_CLIENT_MODE_NORMAL;
184 w->tracking_required = 0;
186 w->decoded_url[0] = '\0';
188 buffer_reset(w->response.header_output);
189 buffer_reset(w->response.header);
190 buffer_reset(w->response.data);
191 w->response.rlen = 0;
192 w->response.sent = 0;
193 w->response.code = 0;
198 w->response.zoutput = 0;
200 // if we had enabled compression, release it
201 #ifdef NETDATA_WITH_ZLIB
202 if(w->response.zinitialized) {
203 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
204 deflateEnd(&w->response.zstream);
205 w->response.zsent = 0;
206 w->response.zhave = 0;
207 w->response.zstream.avail_in = 0;
208 w->response.zstream.avail_out = 0;
209 w->response.zstream.total_in = 0;
210 w->response.zstream.total_out = 0;
211 w->response.zinitialized = 0;
213 #endif // NETDATA_WITH_ZLIB
216 struct web_client *web_client_free(struct web_client *w) {
219 struct web_client *n = w->next;
220 if(w == web_clients) web_clients = n;
222 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
224 if(w->prev) w->prev->next = w->next;
225 if(w->next) w->next->prev = w->prev;
226 if(w->response.header_output) buffer_free(w->response.header_output);
227 if(w->response.header) buffer_free(w->response.header);
228 if(w->response.data) buffer_free(w->response.data);
229 if(w->ifd != -1) close(w->ifd);
230 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
233 web_client_disconnected();
238 uid_t web_files_uid(void) {
239 static char *web_owner = NULL;
240 static uid_t owner_uid = 0;
242 if(unlikely(!web_owner)) {
243 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
244 if(!web_owner || !*web_owner)
245 owner_uid = geteuid();
247 // getpwnam() is not thread safe,
248 // but we have called this function once
249 // while single threaded
250 struct passwd *pw = getpwnam(web_owner);
252 error("User '%s' is not present. Ignoring option.", web_owner);
253 owner_uid = geteuid();
256 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
257 owner_uid = pw->pw_uid;
265 gid_t web_files_gid(void) {
266 static char *web_group = NULL;
267 static gid_t owner_gid = 0;
269 if(unlikely(!web_group)) {
270 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
271 if(!web_group || !*web_group)
272 owner_gid = getegid();
274 // getgrnam() is not thread safe,
275 // but we have called this function once
276 // while single threaded
277 struct group *gr = getgrnam(web_group);
279 error("Group '%s' is not present. Ignoring option.", web_group);
280 owner_gid = getegid();
283 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
284 owner_gid = gr->gr_gid;
292 int mysendfile(struct web_client *w, char *filename)
294 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, netdata_configured_web_dir, filename);
296 // skip leading slashes
297 while (*filename == '/') filename++;
299 // if the filename contain known paths, skip them
300 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
301 filename = &filename[strlen(WEB_PATH_FILE) + 1];
304 for(s = filename; *s ;s++) {
305 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
306 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
307 buffer_sprintf(w->response.data, "Filename contains invalid characters: ");
308 buffer_strcat_htmlescape(w->response.data, filename);
313 // if the filename contains a .. refuse to serve it
314 if(strstr(filename, "..") != 0) {
315 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
316 buffer_strcat(w->response.data, "Relative filenames are not supported: ");
317 buffer_strcat_htmlescape(w->response.data, filename);
322 char webfilename[FILENAME_MAX + 1];
323 snprintfz(webfilename, FILENAME_MAX, "%s/%s", netdata_configured_web_dir, filename);
325 // check if the file exists
327 if(lstat(webfilename, &stat) != 0) {
328 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
329 buffer_strcat(w->response.data, "File does not exist, or is not accessible: ");
330 buffer_strcat_htmlescape(w->response.data, webfilename);
334 // check if the file is owned by expected user
335 if(stat.st_uid != web_files_uid()) {
336 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
337 buffer_strcat(w->response.data, "Access to file is not permitted: ");
338 buffer_strcat_htmlescape(w->response.data, 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_strcat(w->response.data, "Access to file is not permitted: ");
346 buffer_strcat_htmlescape(w->response.data, webfilename);
350 if((stat.st_mode & S_IFMT) == S_IFDIR) {
351 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
352 return mysendfile(w, webfilename);
355 if((stat.st_mode & S_IFMT) != S_IFREG) {
356 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
357 buffer_strcat(w->response.data, "Access to file is not permitted: ");
358 buffer_strcat_htmlescape(w->response.data, webfilename);
363 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
367 if(errno == EBUSY || errno == EAGAIN) {
368 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
369 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
370 buffer_strcat(w->response.data, "File is currently busy, please try again later: ");
371 buffer_strcat_htmlescape(w->response.data, webfilename);
375 error("%llu: Cannot open file '%s'.", w->id, webfilename);
376 buffer_strcat(w->response.data, "Cannot open file: ");
377 buffer_strcat_htmlescape(w->response.data, webfilename);
381 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
382 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
384 // pick a Content-Type for the file
385 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
386 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
387 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
388 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
389 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
390 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
391 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
392 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
393 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
394 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
395 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
396 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
397 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
398 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
399 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
400 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
401 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
402 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
403 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
404 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
406 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);
408 w->mode = WEB_CLIENT_MODE_FILECOPY;
411 buffer_flush(w->response.data);
412 w->response.rlen = stat.st_size;
414 w->response.data->date = stat.st_mtimespec.tv_sec;
416 w->response.data->date = stat.st_mtim.tv_sec;
417 #endif /* __APPLE__ */
418 buffer_cacheable(w->response.data);
424 #ifdef NETDATA_WITH_ZLIB
425 void web_client_enable_deflate(struct web_client *w, int gzip) {
426 if(unlikely(w->response.zinitialized)) {
427 debug(D_DEFLATE, "%llu: Compression has already be initialized for this client.", w->id);
431 if(unlikely(w->response.sent)) {
432 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
436 w->response.zstream.zalloc = Z_NULL;
437 w->response.zstream.zfree = Z_NULL;
438 w->response.zstream.opaque = Z_NULL;
440 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
441 w->response.zstream.avail_in = 0;
442 w->response.zstream.total_in = 0;
444 w->response.zstream.next_out = w->response.zbuffer;
445 w->response.zstream.avail_out = 0;
446 w->response.zstream.total_out = 0;
448 w->response.zstream.zalloc = Z_NULL;
449 w->response.zstream.zfree = Z_NULL;
450 w->response.zstream.opaque = Z_NULL;
452 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
453 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
457 // Select GZIP compression: windowbits = 15 + 16 = 31
458 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
459 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
463 w->response.zsent = 0;
464 w->response.zoutput = 1;
465 w->response.zinitialized = 1;
467 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
469 #endif // NETDATA_WITH_ZLIB
471 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
474 if(options & RRDR_OPTION_NONZERO) {
475 if(count++) buffer_strcat(wb, " ");
476 buffer_strcat(wb, "nonzero");
479 if(options & RRDR_OPTION_REVERSED) {
480 if(count++) buffer_strcat(wb, " ");
481 buffer_strcat(wb, "flip");
484 if(options & RRDR_OPTION_JSON_WRAP) {
485 if(count++) buffer_strcat(wb, " ");
486 buffer_strcat(wb, "jsonwrap");
489 if(options & RRDR_OPTION_MIN2MAX) {
490 if(count++) buffer_strcat(wb, " ");
491 buffer_strcat(wb, "min2max");
494 if(options & RRDR_OPTION_MILLISECONDS) {
495 if(count++) buffer_strcat(wb, " ");
496 buffer_strcat(wb, "ms");
499 if(options & RRDR_OPTION_ABSOLUTE) {
500 if(count++) buffer_strcat(wb, " ");
501 buffer_strcat(wb, "absolute");
504 if(options & RRDR_OPTION_SECONDS) {
505 if(count++) buffer_strcat(wb, " ");
506 buffer_strcat(wb, "seconds");
509 if(options & RRDR_OPTION_NULL2ZERO) {
510 if(count++) buffer_strcat(wb, " ");
511 buffer_strcat(wb, "null2zero");
514 if(options & RRDR_OPTION_OBJECTSROWS) {
515 if(count++) buffer_strcat(wb, " ");
516 buffer_strcat(wb, "objectrows");
519 if(options & RRDR_OPTION_GOOGLE_JSON) {
520 if(count++) buffer_strcat(wb, " ");
521 buffer_strcat(wb, "google_json");
524 if(options & RRDR_OPTION_PERCENTAGE) {
525 if(count++) buffer_strcat(wb, " ");
526 buffer_strcat(wb, "percentage");
529 if(options & RRDR_OPTION_NOT_ALIGNED) {
530 if(count++) buffer_strcat(wb, " ");
531 buffer_strcat(wb, "unaligned");
535 uint32_t web_client_api_request_v1_data_options(char *o)
537 uint32_t ret = 0x00000000;
540 while(o && *o && (tok = mystrsep(&o, ", |"))) {
543 if(!strcmp(tok, "nonzero"))
544 ret |= RRDR_OPTION_NONZERO;
545 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
546 ret |= RRDR_OPTION_REVERSED;
547 else if(!strcmp(tok, "jsonwrap"))
548 ret |= RRDR_OPTION_JSON_WRAP;
549 else if(!strcmp(tok, "min2max"))
550 ret |= RRDR_OPTION_MIN2MAX;
551 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
552 ret |= RRDR_OPTION_MILLISECONDS;
553 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
554 ret |= RRDR_OPTION_ABSOLUTE;
555 else if(!strcmp(tok, "seconds"))
556 ret |= RRDR_OPTION_SECONDS;
557 else if(!strcmp(tok, "null2zero"))
558 ret |= RRDR_OPTION_NULL2ZERO;
559 else if(!strcmp(tok, "objectrows"))
560 ret |= RRDR_OPTION_OBJECTSROWS;
561 else if(!strcmp(tok, "google_json"))
562 ret |= RRDR_OPTION_GOOGLE_JSON;
563 else if(!strcmp(tok, "percentage"))
564 ret |= RRDR_OPTION_PERCENTAGE;
565 else if(!strcmp(tok, "unaligned"))
566 ret |= RRDR_OPTION_NOT_ALIGNED;
572 uint32_t web_client_api_request_v1_data_format(char *name)
574 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
575 return DATASOURCE_DATATABLE_JSON;
577 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
578 return DATASOURCE_DATATABLE_JSONP;
580 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
581 return DATASOURCE_JSON;
583 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
584 return DATASOURCE_JSONP;
586 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
587 return DATASOURCE_SSV;
589 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
590 return DATASOURCE_CSV;
592 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
593 return DATASOURCE_TSV;
595 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
596 return DATASOURCE_HTML;
598 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
599 return DATASOURCE_JS_ARRAY;
601 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
602 return DATASOURCE_SSV_COMMA;
604 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
605 return DATASOURCE_CSV_JSON_ARRAY;
607 return DATASOURCE_JSON;
610 uint32_t web_client_api_request_v1_data_google_format(char *name)
612 if(!strcmp(name, "json"))
613 return DATASOURCE_DATATABLE_JSONP;
615 else if(!strcmp(name, "html"))
616 return DATASOURCE_HTML;
618 else if(!strcmp(name, "csv"))
619 return DATASOURCE_CSV;
621 else if(!strcmp(name, "tsv-excel"))
622 return DATASOURCE_TSV;
624 return DATASOURCE_JSON;
627 const char *group_method2string(int group) {
629 case GROUP_UNDEFINED:
644 case GROUP_INCREMENTAL_SUM:
645 return "incremental-sum";
648 return "unknown-group-method";
652 int web_client_api_request_v1_data_group(char *name, int def)
654 if(!strcmp(name, "average"))
655 return GROUP_AVERAGE;
657 else if(!strcmp(name, "min"))
660 else if(!strcmp(name, "max"))
663 else if(!strcmp(name, "sum"))
666 else if(!strcmp(name, "incremental-sum"))
667 return GROUP_INCREMENTAL_SUM;
672 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
677 char *value = mystrsep(&url, "?&");
678 if (!value || !*value) continue;
680 if(!strcmp(value, "all")) all = 1;
681 else if(!strcmp(value, "active")) all = 0;
684 buffer_flush(w->response.data);
685 w->response.data->contenttype = CT_APPLICATION_JSON;
686 health_alarms2json(localhost, w->response.data, all);
690 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
695 char *value = mystrsep(&url, "?&");
696 if (!value || !*value) continue;
698 char *name = mystrsep(&value, "=");
699 if(!name || !*name) continue;
700 if(!value || !*value) continue;
702 if(!strcmp(name, "after")) after = strtoul(value, NULL, 0);
705 buffer_flush(w->response.data);
706 w->response.data->contenttype = CT_APPLICATION_JSON;
707 health_alarm_log2json(localhost, w->response.data, after);
711 int web_client_api_request_single_chart(struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
716 buffer_flush(w->response.data);
719 char *value = mystrsep(&url, "?&");
720 if(!value || !*value) continue;
722 char *name = mystrsep(&value, "=");
723 if(!name || !*name) continue;
724 if(!value || !*value) continue;
726 // name and value are now the parameters
727 // they are not null and not empty
729 if(!strcmp(name, "chart")) chart = value;
731 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
736 if(!chart || !*chart) {
737 buffer_sprintf(w->response.data, "No chart id is given at the request.");
741 RRDSET *st = rrdset_find_localhost(chart);
742 if(!st) st = rrdset_find_byname_localhost(chart);
744 buffer_strcat(w->response.data, "Chart is not found: ");
745 buffer_strcat_htmlescape(w->response.data, chart);
750 w->response.data->contenttype = CT_APPLICATION_JSON;
751 callback(st, w->response.data);
758 int web_client_api_request_v1_alarm_variables(struct web_client *w, char *url)
760 return web_client_api_request_single_chart(w, url, health_api_v1_chart_variables2json);
763 int web_client_api_request_v1_charts(struct web_client *w, char *url)
767 buffer_flush(w->response.data);
768 w->response.data->contenttype = CT_APPLICATION_JSON;
769 rrd_stats_api_v1_charts(w->response.data);
773 int web_client_api_request_v1_allmetrics(struct web_client *w, char *url)
775 int format = ALLMETRICS_SHELL;
778 char *value = mystrsep(&url, "?&");
779 if (!value || !*value) continue;
781 char *name = mystrsep(&value, "=");
782 if(!name || !*name) continue;
783 if(!value || !*value) continue;
785 if(!strcmp(name, "format")) {
786 if(!strcmp(value, ALLMETRICS_FORMAT_SHELL))
787 format = ALLMETRICS_SHELL;
788 else if(!strcmp(value, ALLMETRICS_FORMAT_PROMETHEUS))
789 format = ALLMETRICS_PROMETHEUS;
795 buffer_flush(w->response.data);
796 buffer_no_cacheable(w->response.data);
799 case ALLMETRICS_SHELL:
800 w->response.data->contenttype = CT_TEXT_PLAIN;
801 rrd_stats_api_v1_charts_allmetrics_shell(w->response.data);
804 case ALLMETRICS_PROMETHEUS:
805 w->response.data->contenttype = CT_PROMETHEUS;
806 rrd_stats_api_v1_charts_allmetrics_prometheus(w->response.data);
810 w->response.data->contenttype = CT_TEXT_PLAIN;
811 buffer_strcat(w->response.data, "Which format? Only '" ALLMETRICS_FORMAT_SHELL "' and '" ALLMETRICS_FORMAT_PROMETHEUS "' is currently supported.");
816 int web_client_api_request_v1_chart(struct web_client *w, char *url)
818 return web_client_api_request_single_chart(w, url, rrd_stats_api_v1_chart);
821 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
823 buffer_flush(w->response.data);
825 BUFFER *dimensions = NULL;
827 const char *chart = NULL
831 , *multiply_str = NULL
835 , *label_color = NULL
836 , *value_color = NULL
837 , *refresh_str = NULL
838 , *precision_str = NULL
841 int group = GROUP_AVERAGE;
842 uint32_t options = 0x00000000;
845 char *value = mystrsep(&url, "/?&");
846 if(!value || !*value) continue;
848 char *name = mystrsep(&value, "=");
849 if(!name || !*name) continue;
850 if(!value || !*value) continue;
852 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
854 // name and value are now the parameters
855 // they are not null and not empty
857 if(!strcmp(name, "chart")) chart = value;
858 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
860 dimensions = buffer_create(100);
862 buffer_strcat(dimensions, "|");
863 buffer_strcat(dimensions, value);
865 else if(!strcmp(name, "after")) after_str = value;
866 else if(!strcmp(name, "before")) before_str = value;
867 else if(!strcmp(name, "points")) points_str = value;
868 else if(!strcmp(name, "group")) {
869 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
871 else if(!strcmp(name, "options")) {
872 options |= web_client_api_request_v1_data_options(value);
874 else if(!strcmp(name, "label")) label = value;
875 else if(!strcmp(name, "units")) units = value;
876 else if(!strcmp(name, "label_color")) label_color = value;
877 else if(!strcmp(name, "value_color")) value_color = value;
878 else if(!strcmp(name, "multiply")) multiply_str = value;
879 else if(!strcmp(name, "divide")) divide_str = value;
880 else if(!strcmp(name, "refresh")) refresh_str = value;
881 else if(!strcmp(name, "precision")) precision_str = value;
882 else if(!strcmp(name, "alarm")) alarm = value;
885 if(!chart || !*chart) {
886 buffer_no_cacheable(w->response.data);
887 buffer_sprintf(w->response.data, "No chart id is given at the request.");
891 RRDSET *st = rrdset_find_localhost(chart);
892 if(!st) st = rrdset_find_byname_localhost(chart);
894 buffer_no_cacheable(w->response.data);
895 buffer_svg(w->response.data, "chart not found", NAN, "", NULL, NULL, -1);
902 rc = rrdcalc_find(st, alarm);
904 buffer_no_cacheable(w->response.data);
905 buffer_svg(w->response.data, "alarm not found", NAN, "", NULL, NULL, -1);
911 long long multiply = (multiply_str && *multiply_str )?str2l(multiply_str):1;
912 long long divide = (divide_str && *divide_str )?str2l(divide_str):1;
913 long long before = (before_str && *before_str )?str2l(before_str):0;
914 long long after = (after_str && *after_str )?str2l(after_str):-st->update_every;
915 int points = (points_str && *points_str )?str2i(points_str):1;
916 int precision = (precision_str && *precision_str)?str2i(precision_str):-1;
918 if(!multiply) multiply = 1;
919 if(!divide) divide = 1;
922 if(refresh_str && *refresh_str) {
923 if(!strcmp(refresh_str, "auto")) {
924 if(rc) refresh = rc->update_every;
925 else if(options & RRDR_OPTION_NOT_ALIGNED)
926 refresh = st->update_every;
928 refresh = (int)(before - after);
929 if(refresh < 0) refresh = -refresh;
933 refresh = str2i(refresh_str);
934 if(refresh < 0) refresh = -refresh;
940 char *s = (char *)alarm;
942 if(*s == '_') *s = ' ';
947 else if(dimensions) {
948 const char *dim = buffer_tostring(dimensions);
949 if(*dim == '|') dim++;
962 else if(options & RRDR_OPTION_PERCENTAGE)
968 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'"
972 , (dimensions)?buffer_tostring(dimensions):""
982 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
983 w->response.data->expires = now_realtime_sec() + refresh;
985 else buffer_no_cacheable(w->response.data);
989 case RRDCALC_STATUS_CRITICAL:
993 case RRDCALC_STATUS_WARNING:
994 value_color = "orange";
997 case RRDCALC_STATUS_CLEAR:
998 value_color = "brightgreen";
1001 case RRDCALC_STATUS_UNDEFINED:
1002 value_color = "lightgrey";
1005 case RRDCALC_STATUS_UNINITIALIZED:
1006 value_color = "#000";
1010 value_color = "grey";
1015 buffer_svg(w->response.data,
1017 (isnan(rc->value)||isinf(rc->value)) ? rc->value : rc->value * multiply / divide,
1025 time_t latest_timestamp = 0;
1026 int value_is_null = 1;
1027 calculated_number n = NAN;
1030 // if the collected value is too old, don't calculate its value
1031 if (rrdset_last_entry_t(st) >= (now_realtime_sec() - (st->update_every * st->gap_when_lost_iterations_above)))
1035 (dimensions) ? buffer_tostring(dimensions) : NULL,
1045 // if the value cannot be calculated, show empty badge
1047 buffer_no_cacheable(w->response.data);
1052 else if (refresh > 0) {
1053 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1054 w->response.data->expires = now_realtime_sec() + refresh;
1056 else buffer_no_cacheable(w->response.data);
1059 buffer_svg(w->response.data,
1061 (value_is_null)?NAN:(n * multiply / divide),
1070 buffer_free(dimensions);
1074 // returns the HTTP code
1075 int web_client_api_request_v1_data(struct web_client *w, char *url)
1077 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1080 BUFFER *dimensions = NULL;
1082 buffer_flush(w->response.data);
1084 char *google_version = "0.6",
1085 *google_reqId = "0",
1087 *google_out = "json",
1088 *responseHandler = NULL,
1089 *outFileName = NULL;
1091 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1094 , *before_str = NULL
1096 , *points_str = NULL;
1098 int group = GROUP_AVERAGE;
1099 uint32_t format = DATASOURCE_JSON;
1100 uint32_t options = 0x00000000;
1103 char *value = mystrsep(&url, "?&");
1104 if(!value || !*value) continue;
1106 char *name = mystrsep(&value, "=");
1107 if(!name || !*name) continue;
1108 if(!value || !*value) continue;
1110 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1112 // name and value are now the parameters
1113 // they are not null and not empty
1115 if(!strcmp(name, "chart")) chart = value;
1116 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1117 if(!dimensions) dimensions = buffer_create(100);
1118 buffer_strcat(dimensions, "|");
1119 buffer_strcat(dimensions, value);
1121 else if(!strcmp(name, "after")) after_str = value;
1122 else if(!strcmp(name, "before")) before_str = value;
1123 else if(!strcmp(name, "points")) points_str = value;
1124 else if(!strcmp(name, "group")) {
1125 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1127 else if(!strcmp(name, "format")) {
1128 format = web_client_api_request_v1_data_format(value);
1130 else if(!strcmp(name, "options")) {
1131 options |= web_client_api_request_v1_data_options(value);
1133 else if(!strcmp(name, "callback")) {
1134 responseHandler = value;
1136 else if(!strcmp(name, "filename")) {
1137 outFileName = value;
1139 else if(!strcmp(name, "tqx")) {
1140 // parse Google Visualization API options
1141 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1142 char *tqx_name, *tqx_value;
1145 tqx_value = mystrsep(&value, ";");
1146 if(!tqx_value || !*tqx_value) continue;
1148 tqx_name = mystrsep(&tqx_value, ":");
1149 if(!tqx_name || !*tqx_name) continue;
1150 if(!tqx_value || !*tqx_value) continue;
1152 if(!strcmp(tqx_name, "version"))
1153 google_version = tqx_value;
1154 else if(!strcmp(tqx_name, "reqId"))
1155 google_reqId = tqx_value;
1156 else if(!strcmp(tqx_name, "sig")) {
1157 google_sig = tqx_value;
1158 google_timestamp = strtoul(google_sig, NULL, 0);
1160 else if(!strcmp(tqx_name, "out")) {
1161 google_out = tqx_value;
1162 format = web_client_api_request_v1_data_google_format(google_out);
1164 else if(!strcmp(tqx_name, "responseHandler"))
1165 responseHandler = tqx_value;
1166 else if(!strcmp(tqx_name, "outFileName"))
1167 outFileName = tqx_value;
1172 if(!chart || !*chart) {
1173 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1177 RRDSET *st = rrdset_find_localhost(chart);
1178 if(!st) st = rrdset_find_byname_localhost(chart);
1180 buffer_strcat(w->response.data, "Chart is not found: ");
1181 buffer_strcat_htmlescape(w->response.data, chart);
1186 long long before = (before_str && *before_str)?str2l(before_str):0;
1187 long long after = (after_str && *after_str) ?str2l(after_str):0;
1188 int points = (points_str && *points_str)?str2i(points_str):0;
1190 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'"
1193 , (dimensions)?buffer_tostring(dimensions):""
1202 if(outFileName && *outFileName) {
1203 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1204 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1207 if(format == DATASOURCE_DATATABLE_JSONP) {
1208 if(responseHandler == NULL)
1209 responseHandler = "google.visualization.Query.setResponse";
1211 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1212 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1215 buffer_sprintf(w->response.data,
1216 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1217 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1219 else if(format == DATASOURCE_JSONP) {
1220 if(responseHandler == NULL)
1221 responseHandler = "callback";
1223 buffer_strcat(w->response.data, responseHandler);
1224 buffer_strcat(w->response.data, "(");
1227 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1229 if(format == DATASOURCE_DATATABLE_JSONP) {
1230 if(google_timestamp < last_timestamp_in_data)
1231 buffer_strcat(w->response.data, "});");
1234 // the client already has the latest data
1235 buffer_flush(w->response.data);
1236 buffer_sprintf(w->response.data,
1237 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1238 responseHandler, google_version, google_reqId);
1241 else if(format == DATASOURCE_JSONP)
1242 buffer_strcat(w->response.data, ");");
1245 if(dimensions) buffer_free(dimensions);
1250 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1252 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1253 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1254 hash_to = 0 /*, hash_redirects = 0 */;
1256 if(unlikely(!hash_action)) {
1257 hash_action = simple_hash("action");
1258 hash_access = simple_hash("access");
1259 hash_hello = simple_hash("hello");
1260 hash_delete = simple_hash("delete");
1261 hash_search = simple_hash("search");
1262 hash_switch = simple_hash("switch");
1263 hash_machine = simple_hash("machine");
1264 hash_url = simple_hash("url");
1265 hash_name = simple_hash("name");
1266 hash_delete_url = simple_hash("delete_url");
1267 hash_for = simple_hash("for");
1268 hash_to = simple_hash("to");
1270 hash_redirects = simple_hash("redirects");
1274 char person_guid[GUID_LEN + 1] = "";
1276 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1279 // The browser may send multiple cookies with our id
1281 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1283 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1286 char *machine_guid = NULL,
1287 *machine_url = NULL,
1289 *search_machine_guid = NULL,
1291 *to_person_guid = NULL;
1297 char *value = mystrsep(&url, "?&");
1298 if (!value || !*value) continue;
1300 char *name = mystrsep(&value, "=");
1301 if (!name || !*name) continue;
1302 if (!value || !*value) continue;
1304 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1306 uint32_t hash = simple_hash(name);
1308 if(hash == hash_action && !strcmp(name, "action")) {
1309 uint32_t vhash = simple_hash(value);
1311 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1312 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1313 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1314 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1315 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1316 #ifdef NETDATA_INTERNAL_CHECKS
1317 else error("unknown registry action '%s'", value);
1318 #endif /* NETDATA_INTERNAL_CHECKS */
1321 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1322 redirects = atoi(value);
1324 else if(hash == hash_machine && !strcmp(name, "machine"))
1325 machine_guid = value;
1327 else if(hash == hash_url && !strcmp(name, "url"))
1328 machine_url = value;
1330 else if(action == 'A') {
1331 if(hash == hash_name && !strcmp(name, "name"))
1334 else if(action == 'D') {
1335 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1338 else if(action == 'S') {
1339 if(hash == hash_for && !strcmp(name, "for"))
1340 search_machine_guid = value;
1342 else if(action == 'W') {
1343 if(hash == hash_to && !strcmp(name, "to"))
1344 to_person_guid = value;
1346 #ifdef NETDATA_INTERNAL_CHECKS
1347 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1348 #endif /* NETDATA_INTERNAL_CHECKS */
1351 if(respect_web_browser_do_not_track_policy && w->donottrack) {
1352 buffer_flush(w->response.data);
1353 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.");
1357 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1358 error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1359 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1360 buffer_flush(w->response.data);
1361 buffer_strcat(w->response.data, "Invalid registry Access request.");
1364 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1365 error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1366 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1367 buffer_flush(w->response.data);
1368 buffer_strcat(w->response.data, "Invalid registry Delete request.");
1371 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1372 error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1373 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1374 buffer_flush(w->response.data);
1375 buffer_strcat(w->response.data, "Invalid registry Search request.");
1378 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1379 error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1380 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1381 buffer_flush(w->response.data);
1382 buffer_strcat(w->response.data, "Invalid registry Switch request.");
1388 w->tracking_required = 1;
1389 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
1392 w->tracking_required = 1;
1393 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
1396 w->tracking_required = 1;
1397 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
1400 w->tracking_required = 1;
1401 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
1404 return registry_request_hello_json(w);
1407 buffer_flush(w->response.data);
1408 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1413 int web_client_api_request_v1(struct web_client *w, char *url) {
1414 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;
1416 if(unlikely(hash_data == 0)) {
1417 hash_data = simple_hash("data");
1418 hash_chart = simple_hash("chart");
1419 hash_charts = simple_hash("charts");
1420 hash_registry = simple_hash("registry");
1421 hash_badge = simple_hash("badge.svg");
1422 hash_alarms = simple_hash("alarms");
1423 hash_alarm_log = simple_hash("alarm_log");
1424 hash_alarm_variables = simple_hash("alarm_variables");
1425 hash_raw = simple_hash("allmetrics");
1429 char *tok = mystrsep(&url, "/?&");
1431 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1432 uint32_t hash = simple_hash(tok);
1434 if(hash == hash_data && !strcmp(tok, "data"))
1435 return web_client_api_request_v1_data(w, url);
1437 else if(hash == hash_chart && !strcmp(tok, "chart"))
1438 return web_client_api_request_v1_chart(w, url);
1440 else if(hash == hash_charts && !strcmp(tok, "charts"))
1441 return web_client_api_request_v1_charts(w, url);
1443 else if(hash == hash_registry && !strcmp(tok, "registry"))
1444 return web_client_api_request_v1_registry(w, url);
1446 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1447 return web_client_api_request_v1_badge(w, url);
1449 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1450 return web_client_api_request_v1_alarms(w, url);
1452 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1453 return web_client_api_request_v1_alarm_log(w, url);
1455 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1456 return web_client_api_request_v1_alarm_variables(w, url);
1458 else if(hash == hash_raw && !strcmp(tok, "allmetrics"))
1459 return web_client_api_request_v1_allmetrics(w, url);
1462 buffer_flush(w->response.data);
1463 buffer_strcat(w->response.data, "Unsupported v1 API command: ");
1464 buffer_strcat_htmlescape(w->response.data, tok);
1469 buffer_flush(w->response.data);
1470 buffer_sprintf(w->response.data, "Which API v1 command?");
1475 int web_client_api_request(struct web_client *w, char *url)
1477 // get the api version
1478 char *tok = mystrsep(&url, "/?&");
1480 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1481 if(strcmp(tok, "v1") == 0)
1482 return web_client_api_request_v1(w, url);
1484 buffer_flush(w->response.data);
1485 buffer_strcat(w->response.data, "Unsupported API version: ");
1486 buffer_strcat_htmlescape(w->response.data, tok);
1491 buffer_flush(w->response.data);
1492 buffer_sprintf(w->response.data, "Which API version?");
1497 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1500 buffer_flush(w->response.data);
1501 buffer_sprintf(w->response.data, "Incomplete request.");
1507 char *args = strchr(url, '?');
1513 // get the name of the data to show
1514 char *tok = mystrsep(&url, "/");
1517 // do we have such a data set?
1519 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1520 st = rrdset_find_byname_localhost(tok);
1521 if(!st) st = rrdset_find_localhost(tok);
1526 // try to send a file with that name
1527 buffer_flush(w->response.data);
1528 return(mysendfile(w, tok));
1532 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1534 // how many entries does the client want?
1535 int lines = rrd_default_history_entries;
1536 int group_count = 1;
1537 time_t after = 0, before = 0;
1538 int group_method = GROUP_AVERAGE;
1542 // parse the lines required
1543 tok = mystrsep(&url, "/");
1544 if(tok) lines = str2i(tok);
1545 if(lines < 1) lines = 1;
1548 // parse the group count required
1549 tok = mystrsep(&url, "/");
1550 if(tok && *tok) group_count = str2i(tok);
1551 if(group_count < 1) group_count = 1;
1552 //if(group_count > save_history / 20) group_count = save_history / 20;
1555 // parse the grouping method required
1556 tok = mystrsep(&url, "/");
1558 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1559 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1560 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1561 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1566 tok = mystrsep(&url, "/");
1567 if(tok && *tok) after = str2ul(tok);
1568 if(after < 0) after = 0;
1571 // parse before time
1572 tok = mystrsep(&url, "/");
1573 if(tok && *tok) before = str2ul(tok);
1574 if(before < 0) before = 0;
1578 tok = mystrsep(&url, "/");
1579 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1582 w->response.data->contenttype = CT_APPLICATION_JSON;
1583 buffer_flush(w->response.data);
1585 char *google_version = "0.6";
1586 char *google_reqId = "0";
1587 char *google_sig = "0";
1588 char *google_out = "json";
1589 char *google_responseHandler = "google.visualization.Query.setResponse";
1590 char *google_outFileName = NULL;
1591 time_t last_timestamp_in_data = 0;
1592 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1594 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1597 tok = mystrsep(&args, "&");
1599 char *name = mystrsep(&tok, "=");
1600 if(name && *name && strcmp(name, "tqx") == 0) {
1601 char *key = mystrsep(&tok, ":");
1602 char *value = mystrsep(&tok, ";");
1603 if(key && value && *key && *value) {
1604 if(strcmp(key, "version") == 0)
1605 google_version = value;
1607 else if(strcmp(key, "reqId") == 0)
1608 google_reqId = value;
1610 else if(strcmp(key, "sig") == 0)
1613 else if(strcmp(key, "out") == 0)
1616 else if(strcmp(key, "responseHandler") == 0)
1617 google_responseHandler = value;
1619 else if(strcmp(key, "outFileName") == 0)
1620 google_outFileName = value;
1626 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1627 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1630 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1631 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1633 // check the client wants json
1634 if(strcmp(google_out, "json") != 0) {
1635 buffer_sprintf(w->response.data,
1636 "%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.'}]});",
1637 google_responseHandler, google_version, google_reqId, google_out);
1643 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1644 buffer_sprintf(w->response.data,
1645 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1646 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1649 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1650 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1652 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);
1654 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1655 if(timestamp_in_data > last_timestamp_in_data)
1656 buffer_strcat(w->response.data, "});");
1659 // the client already has the latest data
1660 buffer_flush(w->response.data);
1661 buffer_sprintf(w->response.data,
1662 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1663 google_responseHandler, google_version, google_reqId);
1670 const char *web_content_type_to_string(uint8_t contenttype) {
1671 switch(contenttype) {
1673 return "text/html; charset=utf-8";
1675 case CT_APPLICATION_XML:
1676 return "application/xml; charset=utf-8";
1678 case CT_APPLICATION_JSON:
1679 return "application/json; charset=utf-8";
1681 case CT_APPLICATION_X_JAVASCRIPT:
1682 return "application/x-javascript; charset=utf-8";
1685 return "text/css; charset=utf-8";
1688 return "text/xml; charset=utf-8";
1691 return "text/xsl; charset=utf-8";
1693 case CT_APPLICATION_OCTET_STREAM:
1694 return "application/octet-stream";
1696 case CT_IMAGE_SVG_XML:
1697 return "image/svg+xml";
1699 case CT_APPLICATION_X_FONT_TRUETYPE:
1700 return "application/x-font-truetype";
1702 case CT_APPLICATION_X_FONT_OPENTYPE:
1703 return "application/x-font-opentype";
1705 case CT_APPLICATION_FONT_WOFF:
1706 return "application/font-woff";
1708 case CT_APPLICATION_FONT_WOFF2:
1709 return "application/font-woff2";
1711 case CT_APPLICATION_VND_MS_FONTOBJ:
1712 return "application/vnd.ms-fontobject";
1718 return "image/jpeg";
1723 case CT_IMAGE_XICON:
1724 return "image/x-icon";
1730 return "image/icns";
1733 return "text/plain; version=0.0.4";
1737 return "text/plain; charset=utf-8";
1742 const char *web_response_code_to_string(int code) {
1748 return "Temporary Redirect";
1751 return "Bad Request";
1760 return "Preconditions Failed";
1763 if(code >= 100 && code < 200)
1764 return "Informational";
1766 if(code >= 200 && code < 300)
1767 return "Successful";
1769 if(code >= 300 && code < 400)
1770 return "Redirection";
1772 if(code >= 400 && code < 500)
1773 return "Bad Request";
1775 if(code >= 500 && code < 600)
1776 return "Server Error";
1778 return "Undefined Error";
1782 static inline char *http_header_parse(struct web_client *w, char *s) {
1783 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1785 if(unlikely(!hash_origin)) {
1786 hash_origin = simple_uhash("Origin");
1787 hash_connection = simple_uhash("Connection");
1788 hash_accept_encoding = simple_uhash("Accept-Encoding");
1789 hash_donottrack = simple_uhash("DNT");
1795 while(*e && *e != ':') e++;
1802 char *v = e + 1, *ve;
1804 // skip leading spaces from value
1805 while(*v == ' ') v++;
1809 while(*ve && *ve != '\r') ve++;
1810 if(!*ve || ve[1] != '\n') {
1815 // terminate the value
1818 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1819 uint32_t hash = simple_uhash(s);
1821 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1822 strncpyz(w->origin, v, ORIGIN_MAX);
1824 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1825 if(strcasestr(v, "keep-alive"))
1828 else if(respect_web_browser_do_not_track_policy && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1829 if(*v == '0') w->donottrack = 0;
1830 else if(*v == '1') w->donottrack = 1;
1832 #ifdef NETDATA_WITH_ZLIB
1833 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1834 if(web_enable_gzip) {
1835 if(strcasestr(v, "gzip"))
1836 web_client_enable_deflate(w, 1);
1838 // does not seem to work
1839 // else if(strcasestr(v, "deflate"))
1840 // web_client_enable_deflate(w, 0);
1843 #endif /* NETDATA_WITH_ZLIB */
1850 // http_request_validate()
1852 // = 0 : all good, process the request
1853 // > 0 : request is not supported
1854 // < 0 : request is incomplete - wait for more data
1856 static inline int http_request_validate(struct web_client *w) {
1857 char *s = w->response.data->buffer, *encoded_url = NULL;
1859 // is is a valid request?
1860 if(!strncmp(s, "GET ", 4)) {
1861 encoded_url = s = &s[4];
1862 w->mode = WEB_CLIENT_MODE_NORMAL;
1864 else if(!strncmp(s, "OPTIONS ", 8)) {
1865 encoded_url = s = &s[8];
1866 w->mode = WEB_CLIENT_MODE_OPTIONS;
1869 w->wait_receive = 0;
1873 // find the SPACE + "HTTP/"
1875 // find the next space
1876 while (*s && *s != ' ') s++;
1878 // is it SPACE + "HTTP/" ?
1879 if(*s && !strncmp(s, " HTTP/", 6)) break;
1883 // incomplete requests
1885 w->wait_receive = 1;
1889 // we have the end of encoded_url - remember it
1892 // make sure we have complete request
1893 // complete requests contain: \r\n\r\n
1896 while(*s && *s++ != '\r');
1898 // did we reach the end?
1899 if(unlikely(!*s)) break;
1902 if(likely(*s++ == '\n')) {
1904 // is it again \r\n ? (header end)
1905 if(unlikely(*s == '\r' && s[1] == '\n')) {
1906 // a valid complete HTTP request found
1909 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1912 // copy the URL - we are going to overwrite parts of it
1913 // FIXME -- we should avoid it
1914 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1916 w->wait_receive = 0;
1920 // another header line
1921 s = http_header_parse(w, s);
1925 // incomplete request
1926 w->wait_receive = 1;
1930 static inline void web_client_send_http_header(struct web_client *w) {
1931 if(unlikely(w->response.code != 200))
1932 buffer_no_cacheable(w->response.data);
1934 // set a proper expiration date, if not already set
1935 if(unlikely(!w->response.data->expires)) {
1936 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
1937 w->response.data->expires = w->tv_ready.tv_sec + rrd_update_every;
1939 w->response.data->expires = w->tv_ready.tv_sec + 86400;
1942 // prepare the HTTP response header
1943 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, w->response.code);
1945 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1946 const char *code_msg = web_response_code_to_string(w->response.code);
1948 // prepare the last modified and expiration dates
1949 char date[32], edate[32];
1951 struct tm tmbuf, *tm;
1953 tm = gmtime_r(&w->response.data->date, &tmbuf);
1954 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1956 tm = gmtime_r(&w->response.data->expires, &tmbuf);
1957 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
1960 buffer_sprintf(w->response.header_output,
1961 "HTTP/1.1 %d %s\r\n"
1962 "Connection: %s\r\n"
1963 "Server: NetData Embedded HTTP Server\r\n"
1964 "Access-Control-Allow-Origin: %s\r\n"
1965 "Access-Control-Allow-Credentials: true\r\n"
1966 "Content-Type: %s\r\n"
1968 , w->response.code, code_msg
1969 , w->keepalive?"keep-alive":"close"
1971 , content_type_string
1975 if(unlikely(web_x_frame_options))
1976 buffer_sprintf(w->response.header_output, "X-Frame-Options: %s\r\n", web_x_frame_options);
1978 if(w->cookie1[0] || w->cookie2[0]) {
1980 buffer_sprintf(w->response.header_output,
1981 "Set-Cookie: %s\r\n",
1986 buffer_sprintf(w->response.header_output,
1987 "Set-Cookie: %s\r\n",
1991 if(respect_web_browser_do_not_track_policy)
1992 buffer_sprintf(w->response.header_output,
1993 "Tk: T;cookies\r\n");
1996 if(respect_web_browser_do_not_track_policy) {
1997 if(w->tracking_required)
1998 buffer_sprintf(w->response.header_output,
1999 "Tk: T;cookies\r\n");
2001 buffer_sprintf(w->response.header_output,
2006 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2007 buffer_strcat(w->response.header_output,
2008 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2009 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2010 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2014 buffer_sprintf(w->response.header_output,
2015 "Cache-Control: %s\r\n"
2017 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2021 // copy a possibly available custom header
2022 if(unlikely(buffer_strlen(w->response.header)))
2023 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2025 // headers related to the transfer method
2026 if(likely(w->response.zoutput)) {
2027 buffer_strcat(w->response.header_output,
2028 "Content-Encoding: gzip\r\n"
2029 "Transfer-Encoding: chunked\r\n"
2033 if(likely((w->response.data->len || w->response.rlen))) {
2034 // we know the content length, put it
2035 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2038 // we don't know the content length, disable keep-alive
2043 // end of HTTP header
2044 buffer_strcat(w->response.header_output, "\r\n");
2046 // sent the HTTP header
2047 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2049 , buffer_strlen(w->response.header_output)
2050 , buffer_tostring(w->response.header_output)
2053 web_client_crock_socket(w);
2055 ssize_t bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2056 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2058 w->stats_sent_bytes += bytes;
2060 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2062 , buffer_strlen(w->response.header_output)
2065 WEB_CLIENT_IS_DEAD(w);
2069 w->stats_sent_bytes += bytes;
2072 void web_client_process(struct web_client *w) {
2075 hash_netdata_conf = 0,
2077 hash_datasource = 0,
2082 #ifdef NETDATA_INTERNAL_CHECKS
2083 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
2087 now_realtime_timeval(&w->tv_in);
2089 if(unlikely(!hash_api)) {
2090 hash_api = simple_hash("api");
2091 hash_netdata_conf = simple_hash("netdata.conf");
2092 hash_data = simple_hash(WEB_PATH_DATA);
2093 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
2094 hash_graph = simple_hash(WEB_PATH_GRAPH);
2095 hash_list = simple_hash("list");
2096 hash_all_json = simple_hash("all.json");
2097 #ifdef NETDATA_INTERNAL_CHECKS
2098 hash_exit = simple_hash("exit");
2099 hash_debug = simple_hash("debug");
2100 hash_mirror = simple_hash("mirror");
2106 int what_to_do = http_request_validate(w);
2108 // wait for more data
2109 if(what_to_do < 0) {
2110 if(w->response.data->len > TOO_BIG_REQUEST) {
2111 strcpy(w->last_url, "too big request");
2113 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
2116 buffer_flush(w->response.data);
2117 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
2120 // wait for more data
2124 else if(what_to_do > 0) {
2125 // strcpy(w->last_url, "not a valid request");
2127 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
2130 buffer_flush(w->response.data);
2131 buffer_strcat(w->response.data, "I don't understand you...\r\n");
2133 else { // what_to_do == 0
2134 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2136 w->response.data->contenttype = CT_TEXT_PLAIN;
2137 buffer_flush(w->response.data);
2138 buffer_strcat(w->response.data, "OK");
2141 char *url = w->decoded_url;
2142 char *tok = mystrsep(&url, "/?");
2144 uint32_t hash = simple_hash(tok);
2145 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
2147 if(hash == hash_api && strcmp(tok, "api") == 0) {
2148 // the client is requesting api access
2149 code = web_client_api_request(w, url);
2151 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
2153 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2155 w->response.data->contenttype = CT_TEXT_PLAIN;
2156 buffer_flush(w->response.data);
2157 generate_config(w->response.data, 0);
2159 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
2160 // the client is requesting rrd data -- OLD API
2161 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
2163 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
2164 // the client is requesting google datasource -- OLD API
2165 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
2167 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
2168 // the client is requesting an rrd graph -- OLD API
2170 // get the name of the data to show
2171 tok = mystrsep(&url, "/?&");
2173 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2175 // do we have such a data set?
2176 RRDSET *st = rrdset_find_byname_localhost(tok);
2177 if(!st) st = rrdset_find_localhost(tok);
2180 // try to send a file with that name
2181 buffer_flush(w->response.data);
2182 code = mysendfile(w, tok);
2186 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2187 w->response.data->contenttype = CT_APPLICATION_JSON;
2188 buffer_flush(w->response.data);
2189 rrd_stats_graph_json(st, url, w->response.data);
2194 buffer_flush(w->response.data);
2195 buffer_strcat(w->response.data, "Graph name?\r\n");
2198 else if(hash == hash_list && strcmp(tok, "list") == 0) {
2202 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2204 buffer_flush(w->response.data);
2205 RRDSET *st = localhost->rrdset_root;
2207 for ( ; st ; st = st->next )
2208 buffer_sprintf(w->response.data, "%s\n", st->name);
2210 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
2213 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2215 w->response.data->contenttype = CT_APPLICATION_JSON;
2216 buffer_flush(w->response.data);
2217 rrd_stats_all_json(w->response.data);
2219 #ifdef NETDATA_INTERNAL_CHECKS
2220 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
2222 w->response.data->contenttype = CT_TEXT_PLAIN;
2223 buffer_flush(w->response.data);
2226 buffer_strcat(w->response.data, "ok, will do...");
2228 buffer_strcat(w->response.data, "I am doing it already");
2230 error("web request to exit received.");
2231 netdata_cleanup_and_exit(0);
2233 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2234 buffer_flush(w->response.data);
2236 // get the name of the data to show
2237 tok = mystrsep(&url, "/?&");
2239 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2241 // do we have such a data set?
2242 RRDSET *st = rrdset_find_byname_localhost(tok);
2243 if(!st) st = rrdset_find_localhost(tok);
2246 buffer_strcat(w->response.data, "Chart is not found: ");
2247 buffer_strcat_htmlescape(w->response.data, tok);
2248 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2252 debug_flags |= D_RRD_STATS;
2253 st->debug = !st->debug;
2254 buffer_sprintf(w->response.data, "Chart has now debug %s: ", st->debug?"enabled":"disabled");
2255 buffer_strcat_htmlescape(w->response.data, tok);
2256 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2261 buffer_flush(w->response.data);
2262 buffer_strcat(w->response.data, "debug which chart?\r\n");
2265 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2268 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2270 // replace the zero bytes with spaces
2271 buffer_char_replace(w->response.data, '\0', ' ');
2273 // just leave the buffer as is
2274 // it will be copied back to the client
2276 #endif /* NETDATA_INTERNAL_CHECKS */
2278 char filename[FILENAME_MAX+1];
2280 strncpyz(filename, w->last_url, FILENAME_MAX);
2281 tok = mystrsep(&url, "?");
2282 buffer_flush(w->response.data);
2283 code = mysendfile(w, (tok && *tok)?tok:"/");
2287 char filename[FILENAME_MAX+1];
2289 strncpyz(filename, w->last_url, FILENAME_MAX);
2290 tok = mystrsep(&url, "?");
2291 buffer_flush(w->response.data);
2292 code = mysendfile(w, (tok && *tok)?tok:"/");
2297 now_realtime_timeval(&w->tv_ready);
2298 w->response.sent = 0;
2299 w->response.code = code;
2301 // set a proper last modified date
2302 if(unlikely(!w->response.data->date))
2303 w->response.data->date = w->tv_ready.tv_sec;
2305 web_client_send_http_header(w);
2307 // enable sending immediately if we have data
2308 if(w->response.data->len) w->wait_send = 1;
2309 else w->wait_send = 0;
2313 case WEB_CLIENT_MODE_OPTIONS:
2314 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2317 case WEB_CLIENT_MODE_NORMAL:
2318 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2321 case WEB_CLIENT_MODE_FILECOPY:
2322 if(w->response.rlen) {
2323 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2324 w->wait_receive = 1;
2327 // utilize the kernel sendfile() for copying the file to the socket.
2328 // this block of code can be commented, without anything missing.
2329 // when it is commented, the program will copy the data using async I/O.
2331 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2332 if(len != w->response.data->rbytes)
2333 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2335 web_client_reset(w);
2340 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2344 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2349 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2351 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2353 sprintf(buf, "%zX\r\n", len);
2355 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2357 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2358 w->stats_sent_bytes += bytes;
2361 else if(bytes == 0) {
2362 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2363 WEB_CLIENT_IS_DEAD(w);
2366 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2367 WEB_CLIENT_IS_DEAD(w);
2373 ssize_t web_client_send_chunk_close(struct web_client *w)
2375 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2377 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2379 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2380 w->stats_sent_bytes += bytes;
2383 else if(bytes == 0) {
2384 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2385 WEB_CLIENT_IS_DEAD(w);
2388 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2389 WEB_CLIENT_IS_DEAD(w);
2395 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2397 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2399 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2401 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2402 w->stats_sent_bytes += bytes;
2405 else if(bytes == 0) {
2406 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2407 WEB_CLIENT_IS_DEAD(w);
2410 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2411 WEB_CLIENT_IS_DEAD(w);
2417 #ifdef NETDATA_WITH_ZLIB
2418 ssize_t web_client_send_deflate(struct web_client *w)
2420 ssize_t len = 0, t = 0;
2422 // when using compression,
2423 // w->response.sent is the amount of bytes passed through compression
2425 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.",
2426 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);
2428 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) {
2429 // there is nothing to send
2431 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2433 // finalize the chunk
2434 if(w->response.sent != 0) {
2435 t = web_client_send_chunk_finalize(w);
2439 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2440 // we have to wait, more data will come
2441 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2446 if(unlikely(!w->keepalive)) {
2447 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2448 WEB_CLIENT_IS_DEAD(w);
2453 web_client_reset(w);
2454 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2458 if(w->response.zhave == w->response.zsent) {
2459 // compress more input data
2461 // close the previous open chunk
2462 if(w->response.sent != 0) {
2463 t = web_client_send_chunk_close(w);
2467 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);
2469 // give the compressor all the data not passed through the compressor yet
2470 if(w->response.data->len > w->response.sent) {
2471 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2472 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2475 // reset the compressor output buffer
2476 w->response.zstream.next_out = w->response.zbuffer;
2477 w->response.zstream.avail_out = ZLIB_CHUNK;
2479 // ask for FINISH if we have all the input
2480 int flush = Z_SYNC_FLUSH;
2481 if(w->mode == WEB_CLIENT_MODE_NORMAL
2482 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2484 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2487 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2491 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2492 error("%llu: Compression failed. Closing down client.", w->id);
2493 web_client_reset(w);
2497 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2498 w->response.zsent = 0;
2500 // keep track of the bytes passed through the compressor
2501 w->response.sent = w->response.data->len;
2503 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2506 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2507 if(t2 < 0) return t2;
2511 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2513 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2515 w->stats_sent_bytes += len;
2516 w->response.zsent += len;
2518 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2521 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2522 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2524 WEB_CLIENT_IS_DEAD(w);
2527 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2528 WEB_CLIENT_IS_DEAD(w);
2533 #endif // NETDATA_WITH_ZLIB
2535 ssize_t web_client_send(struct web_client *w) {
2536 #ifdef NETDATA_WITH_ZLIB
2537 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2538 #endif // NETDATA_WITH_ZLIB
2542 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2543 // there is nothing to send
2545 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2547 // there can be two cases for this
2548 // A. we have done everything
2549 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2551 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2552 // we have to wait, more data will come
2553 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2558 if(unlikely(!w->keepalive)) {
2559 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2560 WEB_CLIENT_IS_DEAD(w);
2564 web_client_reset(w);
2565 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2569 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2570 if(likely(bytes > 0)) {
2571 w->stats_sent_bytes += bytes;
2572 w->response.sent += bytes;
2573 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2575 else if(likely(bytes == 0)) {
2576 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2577 WEB_CLIENT_IS_DEAD(w);
2580 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2581 WEB_CLIENT_IS_DEAD(w);
2587 ssize_t web_client_receive(struct web_client *w)
2589 // do we have any space for more data?
2590 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2592 ssize_t left = w->response.data->size - w->response.data->len;
2595 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2596 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2598 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2600 if(likely(bytes > 0)) {
2601 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2602 w->stats_received_bytes += bytes;
2604 size_t old = w->response.data->len;
2605 w->response.data->len += bytes;
2606 w->response.data->buffer[w->response.data->len] = '\0';
2608 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2609 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2611 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2614 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2615 w->wait_receive = 0;
2618 else if(likely(bytes == 0)) {
2619 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2621 // if we cannot read, it means we have an error on input.
2622 // if however, we are copying a file from ifd to ofd, we should not return an error.
2623 // in this case, the error should be generated when the file has been sent to the client.
2625 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2626 // we are copying data from ifd to ofd
2627 // let it finish copying...
2628 w->wait_receive = 0;
2630 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2631 if(w->ifd != w->ofd) close(w->ifd);
2635 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2636 WEB_CLIENT_IS_DEAD(w);
2640 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2641 WEB_CLIENT_IS_DEAD(w);
2648 // --------------------------------------------------------------------------------------
2649 // the thread of a single client
2651 // 1. waits for input and output, using async I/O
2652 // 2. it processes HTTP requests
2653 // 3. it generates HTTP responses
2654 // 4. it copies data from input to output if mode is FILECOPY
2656 void *web_client_main(void *ptr)
2658 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2659 error("Cannot set pthread cancel type to DEFERRED.");
2661 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2662 error("Cannot set pthread cancel state to ENABLE.");
2664 struct web_client *w = ptr;
2665 struct pollfd fds[2], *ifd, *ofd;
2666 int retval, fdmax = 0, timeout;
2668 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2671 if(unlikely(w->dead)) {
2672 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2675 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2676 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2680 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2681 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2685 if(w->ifd == w->ofd) {
2690 if(w->wait_receive) fds[0].events |= POLLIN;
2691 if(w->wait_send) fds[0].events |= POLLOUT;
2697 ifd = ofd = &fds[0];
2705 if(w->wait_receive) fds[0].events |= POLLIN;
2711 if(w->wait_send) fds[1].events |= POLLOUT;
2717 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2719 timeout = web_client_timeout * 1000;
2720 retval = poll(fds, fdmax, timeout);
2722 if(unlikely(retval == -1)) {
2723 if(errno == EAGAIN || errno == EINTR) {
2724 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2728 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2731 else if(unlikely(!retval)) {
2732 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":"");
2737 if(w->wait_send && ofd->revents & POLLOUT) {
2739 if(web_client_send(w) < 0) {
2740 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2745 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2747 if(web_client_receive(w) < 0) {
2748 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2752 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2753 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2754 web_client_process(w);
2758 if(unlikely(!used)) {
2759 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2764 web_client_reset(w);
2766 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2767 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2769 // close the sockets/files now
2770 // to free file descriptors
2771 if(w->ifd == w->ofd) {
2772 if(w->ifd != -1) close(w->ifd);
2775 if(w->ifd != -1) close(w->ifd);
2776 if(w->ofd != -1) close(w->ofd);