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) {
51 w = callocz(1, sizeof(struct web_client));
52 w->id = ++web_clients_count;
53 w->mode = WEB_CLIENT_MODE_NORMAL;
56 struct sockaddr *sadr;
59 sadr = (struct sockaddr*) &w->clientaddr;
60 addrlen = sizeof(w->clientaddr);
62 w->ifd = accept4(listener, sadr, &addrlen, SOCK_NONBLOCK);
64 error("%llu: Cannot accept new incoming connection.", w->id);
70 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
71 error("Cannot getnameinfo() on received client connection.");
72 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
73 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
75 w->client_ip[NI_MAXHOST] = '\0';
76 w->client_port[NI_MAXSERV] = '\0';
78 switch(sadr->sa_family) {
80 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
84 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
85 memmove(w->client_ip, &w->client_ip[7], strlen(&w->client_ip[7]) + 1);
86 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
89 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv6 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
93 debug(D_WEB_CLIENT_ACCESS, "%llu: New UNKNOWN web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
98 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
99 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
102 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
103 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
106 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
107 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
108 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
112 if(web_clients) web_clients->prev = w;
113 w->next = web_clients;
116 web_client_connected();
121 void web_client_reset(struct web_client *w) {
122 web_client_uncrock_socket(w);
124 debug(D_WEB_CLIENT, "%llu: Resetting client.", w->id);
126 if(likely(w->last_url[0])) {
128 now_realtime_timeval(&tv);
130 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
132 #ifdef NETDATA_WITH_ZLIB
133 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
136 // --------------------------------------------------------------------
139 finished_web_request_statistics(dt_usec(&tv, &w->tv_in),
140 w->stats_received_bytes,
145 w->stats_received_bytes = 0;
146 w->stats_sent_bytes = 0;
149 // --------------------------------------------------------------------
152 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
154 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
155 dt_usec(&w->tv_ready, &w->tv_in) / 1000.0,
156 dt_usec(&tv, &w->tv_ready) / 1000.0,
157 dt_usec(&tv, &w->tv_in) / 1000.0,
158 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
159 ? "options" : "data"),
165 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
166 if(w->ifd != w->ofd) {
167 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
168 if(w->ifd != -1) close(w->ifd);
173 w->last_url[0] = '\0';
174 w->cookie1[0] = '\0';
175 w->cookie2[0] = '\0';
179 w->mode = WEB_CLIENT_MODE_NORMAL;
183 w->tracking_required = 0;
185 w->decoded_url[0] = '\0';
187 buffer_reset(w->response.header_output);
188 buffer_reset(w->response.header);
189 buffer_reset(w->response.data);
190 w->response.rlen = 0;
191 w->response.sent = 0;
192 w->response.code = 0;
197 w->response.zoutput = 0;
199 // if we had enabled compression, release it
200 #ifdef NETDATA_WITH_ZLIB
201 if(w->response.zinitialized) {
202 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
203 deflateEnd(&w->response.zstream);
204 w->response.zsent = 0;
205 w->response.zhave = 0;
206 w->response.zstream.avail_in = 0;
207 w->response.zstream.avail_out = 0;
208 w->response.zstream.total_in = 0;
209 w->response.zstream.total_out = 0;
210 w->response.zinitialized = 0;
212 #endif // NETDATA_WITH_ZLIB
215 struct web_client *web_client_free(struct web_client *w) {
218 struct web_client *n = w->next;
219 if(w == web_clients) web_clients = n;
221 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
223 if(w->prev) w->prev->next = w->next;
224 if(w->next) w->next->prev = w->prev;
225 buffer_free(w->response.header_output);
226 buffer_free(w->response.header);
227 buffer_free(w->response.data);
228 if(w->ifd != -1) close(w->ifd);
229 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
232 web_client_disconnected();
237 uid_t web_files_uid(void) {
238 static char *web_owner = NULL;
239 static uid_t owner_uid = 0;
241 if(unlikely(!web_owner)) {
242 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
243 if(!web_owner || !*web_owner)
244 owner_uid = geteuid();
246 // getpwnam() is not thread safe,
247 // but we have called this function once
248 // while single threaded
249 struct passwd *pw = getpwnam(web_owner);
251 error("User '%s' is not present. Ignoring option.", web_owner);
252 owner_uid = geteuid();
255 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
256 owner_uid = pw->pw_uid;
264 gid_t web_files_gid(void) {
265 static char *web_group = NULL;
266 static gid_t owner_gid = 0;
268 if(unlikely(!web_group)) {
269 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
270 if(!web_group || !*web_group)
271 owner_gid = getegid();
273 // getgrnam() is not thread safe,
274 // but we have called this function once
275 // while single threaded
276 struct group *gr = getgrnam(web_group);
278 error("Group '%s' is not present. Ignoring option.", web_group);
279 owner_gid = getegid();
282 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
283 owner_gid = gr->gr_gid;
291 int mysendfile(struct web_client *w, char *filename)
293 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, netdata_configured_web_dir, filename);
295 // skip leading slashes
296 while (*filename == '/') filename++;
298 // if the filename contain known paths, skip them
299 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
300 filename = &filename[strlen(WEB_PATH_FILE) + 1];
303 for(s = filename; *s ;s++) {
304 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
305 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
306 buffer_sprintf(w->response.data, "Filename contains invalid characters: ");
307 buffer_strcat_htmlescape(w->response.data, filename);
312 // if the filename contains a .. refuse to serve it
313 if(strstr(filename, "..") != 0) {
314 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
315 buffer_strcat(w->response.data, "Relative filenames are not supported: ");
316 buffer_strcat_htmlescape(w->response.data, filename);
321 char webfilename[FILENAME_MAX + 1];
322 snprintfz(webfilename, FILENAME_MAX, "%s/%s", netdata_configured_web_dir, filename);
324 // check if the file exists
326 if(lstat(webfilename, &stat) != 0) {
327 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
328 buffer_strcat(w->response.data, "File does not exist, or is not accessible: ");
329 buffer_strcat_htmlescape(w->response.data, webfilename);
333 // check if the file is owned by expected user
334 if(stat.st_uid != web_files_uid()) {
335 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
336 buffer_strcat(w->response.data, "Access to file is not permitted: ");
337 buffer_strcat_htmlescape(w->response.data, webfilename);
341 // check if the file is owned by expected group
342 if(stat.st_gid != web_files_gid()) {
343 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
344 buffer_strcat(w->response.data, "Access to file is not permitted: ");
345 buffer_strcat_htmlescape(w->response.data, webfilename);
349 if((stat.st_mode & S_IFMT) == S_IFDIR) {
350 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
351 return mysendfile(w, webfilename);
354 if((stat.st_mode & S_IFMT) != S_IFREG) {
355 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
356 buffer_strcat(w->response.data, "Access to file is not permitted: ");
357 buffer_strcat_htmlescape(w->response.data, webfilename);
362 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
366 if(errno == EBUSY || errno == EAGAIN) {
367 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
368 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
369 buffer_strcat(w->response.data, "File is currently busy, please try again later: ");
370 buffer_strcat_htmlescape(w->response.data, webfilename);
374 error("%llu: Cannot open file '%s'.", w->id, webfilename);
375 buffer_strcat(w->response.data, "Cannot open file: ");
376 buffer_strcat_htmlescape(w->response.data, webfilename);
380 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
381 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
383 // pick a Content-Type for the file
384 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
385 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
386 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
387 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
388 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
389 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
390 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
391 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
392 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
393 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
394 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
395 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
396 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
397 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
398 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
399 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
400 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
401 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
402 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
403 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
405 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending file '%s' (%ld bytes, ifd %d, ofd %d).", w->id, webfilename, stat.st_size, w->ifd, w->ofd);
407 w->mode = WEB_CLIENT_MODE_FILECOPY;
410 buffer_flush(w->response.data);
411 w->response.rlen = stat.st_size;
413 w->response.data->date = stat.st_mtimespec.tv_sec;
415 w->response.data->date = stat.st_mtim.tv_sec;
416 #endif /* __APPLE__ */
417 buffer_cacheable(w->response.data);
423 #ifdef NETDATA_WITH_ZLIB
424 void web_client_enable_deflate(struct web_client *w, int gzip) {
425 if(unlikely(w->response.zinitialized)) {
426 debug(D_DEFLATE, "%llu: Compression has already be initialized for this client.", w->id);
430 if(unlikely(w->response.sent)) {
431 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
435 w->response.zstream.zalloc = Z_NULL;
436 w->response.zstream.zfree = Z_NULL;
437 w->response.zstream.opaque = Z_NULL;
439 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
440 w->response.zstream.avail_in = 0;
441 w->response.zstream.total_in = 0;
443 w->response.zstream.next_out = w->response.zbuffer;
444 w->response.zstream.avail_out = 0;
445 w->response.zstream.total_out = 0;
447 w->response.zstream.zalloc = Z_NULL;
448 w->response.zstream.zfree = Z_NULL;
449 w->response.zstream.opaque = Z_NULL;
451 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
452 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
456 // Select GZIP compression: windowbits = 15 + 16 = 31
457 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
458 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
462 w->response.zsent = 0;
463 w->response.zoutput = 1;
464 w->response.zinitialized = 1;
466 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
468 #endif // NETDATA_WITH_ZLIB
470 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
473 if(options & RRDR_OPTION_NONZERO) {
474 if(count++) buffer_strcat(wb, " ");
475 buffer_strcat(wb, "nonzero");
478 if(options & RRDR_OPTION_REVERSED) {
479 if(count++) buffer_strcat(wb, " ");
480 buffer_strcat(wb, "flip");
483 if(options & RRDR_OPTION_JSON_WRAP) {
484 if(count++) buffer_strcat(wb, " ");
485 buffer_strcat(wb, "jsonwrap");
488 if(options & RRDR_OPTION_MIN2MAX) {
489 if(count++) buffer_strcat(wb, " ");
490 buffer_strcat(wb, "min2max");
493 if(options & RRDR_OPTION_MILLISECONDS) {
494 if(count++) buffer_strcat(wb, " ");
495 buffer_strcat(wb, "ms");
498 if(options & RRDR_OPTION_ABSOLUTE) {
499 if(count++) buffer_strcat(wb, " ");
500 buffer_strcat(wb, "absolute");
503 if(options & RRDR_OPTION_SECONDS) {
504 if(count++) buffer_strcat(wb, " ");
505 buffer_strcat(wb, "seconds");
508 if(options & RRDR_OPTION_NULL2ZERO) {
509 if(count++) buffer_strcat(wb, " ");
510 buffer_strcat(wb, "null2zero");
513 if(options & RRDR_OPTION_OBJECTSROWS) {
514 if(count++) buffer_strcat(wb, " ");
515 buffer_strcat(wb, "objectrows");
518 if(options & RRDR_OPTION_GOOGLE_JSON) {
519 if(count++) buffer_strcat(wb, " ");
520 buffer_strcat(wb, "google_json");
523 if(options & RRDR_OPTION_PERCENTAGE) {
524 if(count++) buffer_strcat(wb, " ");
525 buffer_strcat(wb, "percentage");
528 if(options & RRDR_OPTION_NOT_ALIGNED) {
529 if(count++) buffer_strcat(wb, " ");
530 buffer_strcat(wb, "unaligned");
534 uint32_t web_client_api_request_v1_data_options(char *o)
536 uint32_t ret = 0x00000000;
539 while(o && *o && (tok = mystrsep(&o, ", |"))) {
542 if(!strcmp(tok, "nonzero"))
543 ret |= RRDR_OPTION_NONZERO;
544 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
545 ret |= RRDR_OPTION_REVERSED;
546 else if(!strcmp(tok, "jsonwrap"))
547 ret |= RRDR_OPTION_JSON_WRAP;
548 else if(!strcmp(tok, "min2max"))
549 ret |= RRDR_OPTION_MIN2MAX;
550 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
551 ret |= RRDR_OPTION_MILLISECONDS;
552 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
553 ret |= RRDR_OPTION_ABSOLUTE;
554 else if(!strcmp(tok, "seconds"))
555 ret |= RRDR_OPTION_SECONDS;
556 else if(!strcmp(tok, "null2zero"))
557 ret |= RRDR_OPTION_NULL2ZERO;
558 else if(!strcmp(tok, "objectrows"))
559 ret |= RRDR_OPTION_OBJECTSROWS;
560 else if(!strcmp(tok, "google_json"))
561 ret |= RRDR_OPTION_GOOGLE_JSON;
562 else if(!strcmp(tok, "percentage"))
563 ret |= RRDR_OPTION_PERCENTAGE;
564 else if(!strcmp(tok, "unaligned"))
565 ret |= RRDR_OPTION_NOT_ALIGNED;
571 uint32_t web_client_api_request_v1_data_format(char *name)
573 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
574 return DATASOURCE_DATATABLE_JSON;
576 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
577 return DATASOURCE_DATATABLE_JSONP;
579 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
580 return DATASOURCE_JSON;
582 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
583 return DATASOURCE_JSONP;
585 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
586 return DATASOURCE_SSV;
588 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
589 return DATASOURCE_CSV;
591 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
592 return DATASOURCE_TSV;
594 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
595 return DATASOURCE_HTML;
597 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
598 return DATASOURCE_JS_ARRAY;
600 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
601 return DATASOURCE_SSV_COMMA;
603 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
604 return DATASOURCE_CSV_JSON_ARRAY;
606 return DATASOURCE_JSON;
609 uint32_t web_client_api_request_v1_data_google_format(char *name)
611 if(!strcmp(name, "json"))
612 return DATASOURCE_DATATABLE_JSONP;
614 else if(!strcmp(name, "html"))
615 return DATASOURCE_HTML;
617 else if(!strcmp(name, "csv"))
618 return DATASOURCE_CSV;
620 else if(!strcmp(name, "tsv-excel"))
621 return DATASOURCE_TSV;
623 return DATASOURCE_JSON;
626 const char *group_method2string(int group) {
628 case GROUP_UNDEFINED:
643 case GROUP_INCREMENTAL_SUM:
644 return "incremental-sum";
647 return "unknown-group-method";
651 int web_client_api_request_v1_data_group(char *name, int def)
653 if(!strcmp(name, "average"))
654 return GROUP_AVERAGE;
656 else if(!strcmp(name, "min"))
659 else if(!strcmp(name, "max"))
662 else if(!strcmp(name, "sum"))
665 else if(!strcmp(name, "incremental-sum"))
666 return GROUP_INCREMENTAL_SUM;
671 int web_client_api_request_v1_alarms(RRDHOST *host, struct web_client *w, char *url)
676 char *value = mystrsep(&url, "?&");
677 if (!value || !*value) continue;
679 if(!strcmp(value, "all")) all = 1;
680 else if(!strcmp(value, "active")) all = 0;
683 buffer_flush(w->response.data);
684 w->response.data->contenttype = CT_APPLICATION_JSON;
685 health_alarms2json(host, w->response.data, all);
689 int web_client_api_request_v1_alarm_log(RRDHOST *host, struct web_client *w, char *url)
694 char *value = mystrsep(&url, "?&");
695 if (!value || !*value) continue;
697 char *name = mystrsep(&value, "=");
698 if(!name || !*name) continue;
699 if(!value || !*value) continue;
701 if(!strcmp(name, "after")) after = (uint32_t)strtoul(value, NULL, 0);
704 buffer_flush(w->response.data);
705 w->response.data->contenttype = CT_APPLICATION_JSON;
706 health_alarm_log2json(host, w->response.data, after);
710 int web_client_api_request_single_chart(RRDHOST *host, struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
715 buffer_flush(w->response.data);
718 char *value = mystrsep(&url, "?&");
719 if(!value || !*value) continue;
721 char *name = mystrsep(&value, "=");
722 if(!name || !*name) continue;
723 if(!value || !*value) continue;
725 // name and value are now the parameters
726 // they are not null and not empty
728 if(!strcmp(name, "chart")) chart = value;
730 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
735 if(!chart || !*chart) {
736 buffer_sprintf(w->response.data, "No chart id is given at the request.");
740 RRDSET *st = rrdset_find(host, chart);
741 if(!st) st = rrdset_find_byname(host, chart);
743 buffer_strcat(w->response.data, "Chart is not found: ");
744 buffer_strcat_htmlescape(w->response.data, chart);
749 w->response.data->contenttype = CT_APPLICATION_JSON;
750 callback(st, w->response.data);
757 int web_client_api_request_v1_alarm_variables(RRDHOST *host, struct web_client *w, char *url)
759 return web_client_api_request_single_chart(host, w, url, health_api_v1_chart_variables2json);
762 int web_client_api_request_v1_charts(RRDHOST *host, struct web_client *w, char *url)
766 buffer_flush(w->response.data);
767 w->response.data->contenttype = CT_APPLICATION_JSON;
768 rrd_stats_api_v1_charts(host, w->response.data);
772 int web_client_api_request_v1_allmetrics(RRDHOST *host, struct web_client *w, char *url)
774 int format = ALLMETRICS_SHELL;
777 char *value = mystrsep(&url, "?&");
778 if (!value || !*value) continue;
780 char *name = mystrsep(&value, "=");
781 if(!name || !*name) continue;
782 if(!value || !*value) continue;
784 if(!strcmp(name, "format")) {
785 if(!strcmp(value, ALLMETRICS_FORMAT_SHELL))
786 format = ALLMETRICS_SHELL;
787 else if(!strcmp(value, ALLMETRICS_FORMAT_PROMETHEUS))
788 format = ALLMETRICS_PROMETHEUS;
794 buffer_flush(w->response.data);
795 buffer_no_cacheable(w->response.data);
798 case ALLMETRICS_SHELL:
799 w->response.data->contenttype = CT_TEXT_PLAIN;
800 rrd_stats_api_v1_charts_allmetrics_shell(host, w->response.data);
803 case ALLMETRICS_PROMETHEUS:
804 w->response.data->contenttype = CT_PROMETHEUS;
805 rrd_stats_api_v1_charts_allmetrics_prometheus(host, w->response.data);
809 w->response.data->contenttype = CT_TEXT_PLAIN;
810 buffer_strcat(w->response.data, "Which format? Only '" ALLMETRICS_FORMAT_SHELL "' and '" ALLMETRICS_FORMAT_PROMETHEUS "' is currently supported.");
815 int web_client_api_request_v1_chart(RRDHOST *host, struct web_client *w, char *url)
817 return web_client_api_request_single_chart(host, w, url, rrd_stats_api_v1_chart);
820 int web_client_api_request_v1_badge(RRDHOST *host, struct web_client *w, char *url) {
822 buffer_flush(w->response.data);
824 BUFFER *dimensions = NULL;
826 const char *chart = NULL
830 , *multiply_str = NULL
834 , *label_color = NULL
835 , *value_color = NULL
836 , *refresh_str = NULL
837 , *precision_str = NULL
840 int group = GROUP_AVERAGE;
841 uint32_t options = 0x00000000;
844 char *value = mystrsep(&url, "/?&");
845 if(!value || !*value) continue;
847 char *name = mystrsep(&value, "=");
848 if(!name || !*name) continue;
849 if(!value || !*value) continue;
851 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
853 // name and value are now the parameters
854 // they are not null and not empty
856 if(!strcmp(name, "chart")) chart = value;
857 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
859 dimensions = buffer_create(100);
861 buffer_strcat(dimensions, "|");
862 buffer_strcat(dimensions, value);
864 else if(!strcmp(name, "after")) after_str = value;
865 else if(!strcmp(name, "before")) before_str = value;
866 else if(!strcmp(name, "points")) points_str = value;
867 else if(!strcmp(name, "group")) {
868 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
870 else if(!strcmp(name, "options")) {
871 options |= web_client_api_request_v1_data_options(value);
873 else if(!strcmp(name, "label")) label = value;
874 else if(!strcmp(name, "units")) units = value;
875 else if(!strcmp(name, "label_color")) label_color = value;
876 else if(!strcmp(name, "value_color")) value_color = value;
877 else if(!strcmp(name, "multiply")) multiply_str = value;
878 else if(!strcmp(name, "divide")) divide_str = value;
879 else if(!strcmp(name, "refresh")) refresh_str = value;
880 else if(!strcmp(name, "precision")) precision_str = value;
881 else if(!strcmp(name, "alarm")) alarm = value;
884 if(!chart || !*chart) {
885 buffer_no_cacheable(w->response.data);
886 buffer_sprintf(w->response.data, "No chart id is given at the request.");
890 RRDSET *st = rrdset_find(host, chart);
891 if(!st) st = rrdset_find_byname(host, chart);
893 buffer_no_cacheable(w->response.data);
894 buffer_svg(w->response.data, "chart not found", NAN, "", NULL, NULL, -1);
901 rc = rrdcalc_find(st, alarm);
903 buffer_no_cacheable(w->response.data);
904 buffer_svg(w->response.data, "alarm not found", NAN, "", NULL, NULL, -1);
910 long long multiply = (multiply_str && *multiply_str )?str2l(multiply_str):1;
911 long long divide = (divide_str && *divide_str )?str2l(divide_str):1;
912 long long before = (before_str && *before_str )?str2l(before_str):0;
913 long long after = (after_str && *after_str )?str2l(after_str):-st->update_every;
914 int points = (points_str && *points_str )?str2i(points_str):1;
915 int precision = (precision_str && *precision_str)?str2i(precision_str):-1;
917 if(!multiply) multiply = 1;
918 if(!divide) divide = 1;
921 if(refresh_str && *refresh_str) {
922 if(!strcmp(refresh_str, "auto")) {
923 if(rc) refresh = rc->update_every;
924 else if(options & RRDR_OPTION_NOT_ALIGNED)
925 refresh = st->update_every;
927 refresh = (int)(before - after);
928 if(refresh < 0) refresh = -refresh;
932 refresh = str2i(refresh_str);
933 if(refresh < 0) refresh = -refresh;
939 char *s = (char *)alarm;
941 if(*s == '_') *s = ' ';
946 else if(dimensions) {
947 const char *dim = buffer_tostring(dimensions);
948 if(*dim == '|') dim++;
961 else if(options & RRDR_OPTION_PERCENTAGE)
967 debug(D_WEB_CLIENT, "%llu: API command 'badge.svg' for chart '%s', alarm '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', options '0x%08x'"
971 , (dimensions)?buffer_tostring(dimensions):""
981 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
982 w->response.data->expires = now_realtime_sec() + refresh;
984 else buffer_no_cacheable(w->response.data);
988 case RRDCALC_STATUS_CRITICAL:
992 case RRDCALC_STATUS_WARNING:
993 value_color = "orange";
996 case RRDCALC_STATUS_CLEAR:
997 value_color = "brightgreen";
1000 case RRDCALC_STATUS_UNDEFINED:
1001 value_color = "lightgrey";
1004 case RRDCALC_STATUS_UNINITIALIZED:
1005 value_color = "#000";
1009 value_color = "grey";
1014 buffer_svg(w->response.data,
1016 (isnan(rc->value)||isinf(rc->value)) ? rc->value : rc->value * multiply / divide,
1024 time_t latest_timestamp = 0;
1025 int value_is_null = 1;
1026 calculated_number n = NAN;
1029 // if the collected value is too old, don't calculate its value
1030 if (rrdset_last_entry_t(st) >= (now_realtime_sec() - (st->update_every * st->gap_when_lost_iterations_above)))
1034 (dimensions) ? buffer_tostring(dimensions) : NULL,
1044 // if the value cannot be calculated, show empty badge
1046 buffer_no_cacheable(w->response.data);
1051 else if (refresh > 0) {
1052 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1053 w->response.data->expires = now_realtime_sec() + refresh;
1055 else buffer_no_cacheable(w->response.data);
1058 buffer_svg(w->response.data,
1060 (value_is_null)?NAN:(n * multiply / divide),
1068 buffer_free(dimensions);
1072 // returns the HTTP code
1073 int web_client_api_request_v1_data(RRDHOST *host, struct web_client *w, char *url)
1075 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1078 BUFFER *dimensions = NULL;
1080 buffer_flush(w->response.data);
1082 char *google_version = "0.6",
1083 *google_reqId = "0",
1085 *google_out = "json",
1086 *responseHandler = NULL,
1087 *outFileName = NULL;
1089 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1092 , *before_str = NULL
1094 , *points_str = NULL;
1096 int group = GROUP_AVERAGE;
1097 uint32_t format = DATASOURCE_JSON;
1098 uint32_t options = 0x00000000;
1101 char *value = mystrsep(&url, "?&");
1102 if(!value || !*value) continue;
1104 char *name = mystrsep(&value, "=");
1105 if(!name || !*name) continue;
1106 if(!value || !*value) continue;
1108 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1110 // name and value are now the parameters
1111 // they are not null and not empty
1113 if(!strcmp(name, "chart")) chart = value;
1114 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1115 if(!dimensions) dimensions = buffer_create(100);
1116 buffer_strcat(dimensions, "|");
1117 buffer_strcat(dimensions, value);
1119 else if(!strcmp(name, "after")) after_str = value;
1120 else if(!strcmp(name, "before")) before_str = value;
1121 else if(!strcmp(name, "points")) points_str = value;
1122 else if(!strcmp(name, "group")) {
1123 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1125 else if(!strcmp(name, "format")) {
1126 format = web_client_api_request_v1_data_format(value);
1128 else if(!strcmp(name, "options")) {
1129 options |= web_client_api_request_v1_data_options(value);
1131 else if(!strcmp(name, "callback")) {
1132 responseHandler = value;
1134 else if(!strcmp(name, "filename")) {
1135 outFileName = value;
1137 else if(!strcmp(name, "tqx")) {
1138 // parse Google Visualization API options
1139 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1140 char *tqx_name, *tqx_value;
1143 tqx_value = mystrsep(&value, ";");
1144 if(!tqx_value || !*tqx_value) continue;
1146 tqx_name = mystrsep(&tqx_value, ":");
1147 if(!tqx_name || !*tqx_name) continue;
1148 if(!tqx_value || !*tqx_value) continue;
1150 if(!strcmp(tqx_name, "version"))
1151 google_version = tqx_value;
1152 else if(!strcmp(tqx_name, "reqId"))
1153 google_reqId = tqx_value;
1154 else if(!strcmp(tqx_name, "sig")) {
1155 google_sig = tqx_value;
1156 google_timestamp = strtoul(google_sig, NULL, 0);
1158 else if(!strcmp(tqx_name, "out")) {
1159 google_out = tqx_value;
1160 format = web_client_api_request_v1_data_google_format(google_out);
1162 else if(!strcmp(tqx_name, "responseHandler"))
1163 responseHandler = tqx_value;
1164 else if(!strcmp(tqx_name, "outFileName"))
1165 outFileName = tqx_value;
1170 if(!chart || !*chart) {
1171 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1175 RRDSET *st = rrdset_find(host, chart);
1176 if(!st) st = rrdset_find_byname(host, chart);
1178 buffer_strcat(w->response.data, "Chart is not found: ");
1179 buffer_strcat_htmlescape(w->response.data, chart);
1184 long long before = (before_str && *before_str)?str2l(before_str):0;
1185 long long after = (after_str && *after_str) ?str2l(after_str):0;
1186 int points = (points_str && *points_str)?str2i(points_str):0;
1188 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'"
1191 , (dimensions)?buffer_tostring(dimensions):""
1200 if(outFileName && *outFileName) {
1201 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1202 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1205 if(format == DATASOURCE_DATATABLE_JSONP) {
1206 if(responseHandler == NULL)
1207 responseHandler = "google.visualization.Query.setResponse";
1209 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1210 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1213 buffer_sprintf(w->response.data,
1214 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1215 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1217 else if(format == DATASOURCE_JSONP) {
1218 if(responseHandler == NULL)
1219 responseHandler = "callback";
1221 buffer_strcat(w->response.data, responseHandler);
1222 buffer_strcat(w->response.data, "(");
1225 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1227 if(format == DATASOURCE_DATATABLE_JSONP) {
1228 if(google_timestamp < last_timestamp_in_data)
1229 buffer_strcat(w->response.data, "});");
1232 // the client already has the latest data
1233 buffer_flush(w->response.data);
1234 buffer_sprintf(w->response.data,
1235 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1236 responseHandler, google_version, google_reqId);
1239 else if(format == DATASOURCE_JSONP)
1240 buffer_strcat(w->response.data, ");");
1243 buffer_free(dimensions);
1248 int web_client_api_request_v1_registry(RRDHOST *host, struct web_client *w, char *url)
1250 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1251 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1252 hash_to = 0 /*, hash_redirects = 0 */;
1254 if(unlikely(!hash_action)) {
1255 hash_action = simple_hash("action");
1256 hash_access = simple_hash("access");
1257 hash_hello = simple_hash("hello");
1258 hash_delete = simple_hash("delete");
1259 hash_search = simple_hash("search");
1260 hash_switch = simple_hash("switch");
1261 hash_machine = simple_hash("machine");
1262 hash_url = simple_hash("url");
1263 hash_name = simple_hash("name");
1264 hash_delete_url = simple_hash("delete_url");
1265 hash_for = simple_hash("for");
1266 hash_to = simple_hash("to");
1268 hash_redirects = simple_hash("redirects");
1272 char person_guid[GUID_LEN + 1] = "";
1274 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1277 // The browser may send multiple cookies with our id
1279 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1281 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1284 char *machine_guid = NULL,
1285 *machine_url = NULL,
1287 *search_machine_guid = NULL,
1289 *to_person_guid = NULL;
1295 char *value = mystrsep(&url, "?&");
1296 if (!value || !*value) continue;
1298 char *name = mystrsep(&value, "=");
1299 if (!name || !*name) continue;
1300 if (!value || !*value) continue;
1302 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1304 uint32_t hash = simple_hash(name);
1306 if(hash == hash_action && !strcmp(name, "action")) {
1307 uint32_t vhash = simple_hash(value);
1309 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1310 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1311 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1312 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1313 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1314 #ifdef NETDATA_INTERNAL_CHECKS
1315 else error("unknown registry action '%s'", value);
1316 #endif /* NETDATA_INTERNAL_CHECKS */
1319 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1320 redirects = atoi(value);
1322 else if(hash == hash_machine && !strcmp(name, "machine"))
1323 machine_guid = value;
1325 else if(hash == hash_url && !strcmp(name, "url"))
1326 machine_url = value;
1328 else if(action == 'A') {
1329 if(hash == hash_name && !strcmp(name, "name"))
1332 else if(action == 'D') {
1333 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1336 else if(action == 'S') {
1337 if(hash == hash_for && !strcmp(name, "for"))
1338 search_machine_guid = value;
1340 else if(action == 'W') {
1341 if(hash == hash_to && !strcmp(name, "to"))
1342 to_person_guid = value;
1344 #ifdef NETDATA_INTERNAL_CHECKS
1345 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1346 #endif /* NETDATA_INTERNAL_CHECKS */
1349 if(respect_web_browser_do_not_track_policy && w->donottrack) {
1350 buffer_flush(w->response.data);
1351 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.");
1355 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1356 error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1357 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1358 buffer_flush(w->response.data);
1359 buffer_strcat(w->response.data, "Invalid registry Access request.");
1362 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1363 error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1364 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1365 buffer_flush(w->response.data);
1366 buffer_strcat(w->response.data, "Invalid registry Delete request.");
1369 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1370 error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1371 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1372 buffer_flush(w->response.data);
1373 buffer_strcat(w->response.data, "Invalid registry Search request.");
1376 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1377 error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1378 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1379 buffer_flush(w->response.data);
1380 buffer_strcat(w->response.data, "Invalid registry Switch request.");
1386 w->tracking_required = 1;
1387 return registry_request_access_json(host, w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
1390 w->tracking_required = 1;
1391 return registry_request_delete_json(host, w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
1394 w->tracking_required = 1;
1395 return registry_request_search_json(host, w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
1398 w->tracking_required = 1;
1399 return registry_request_switch_json(host, w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
1402 return registry_request_hello_json(host, w);
1405 buffer_flush(w->response.data);
1406 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1411 int web_client_api_request_v1(RRDHOST *host, struct web_client *w, char *url) {
1412 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;
1414 if(unlikely(hash_data == 0)) {
1415 hash_data = simple_hash("data");
1416 hash_chart = simple_hash("chart");
1417 hash_charts = simple_hash("charts");
1418 hash_registry = simple_hash("registry");
1419 hash_badge = simple_hash("badge.svg");
1420 hash_alarms = simple_hash("alarms");
1421 hash_alarm_log = simple_hash("alarm_log");
1422 hash_alarm_variables = simple_hash("alarm_variables");
1423 hash_raw = simple_hash("allmetrics");
1427 char *tok = mystrsep(&url, "/?&");
1429 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1430 uint32_t hash = simple_hash(tok);
1432 if(hash == hash_data && !strcmp(tok, "data"))
1433 return web_client_api_request_v1_data(host, w, url);
1435 else if(hash == hash_chart && !strcmp(tok, "chart"))
1436 return web_client_api_request_v1_chart(host, w, url);
1438 else if(hash == hash_charts && !strcmp(tok, "charts"))
1439 return web_client_api_request_v1_charts(host, w, url);
1441 else if(hash == hash_registry && !strcmp(tok, "registry"))
1442 return web_client_api_request_v1_registry(host, w, url);
1444 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1445 return web_client_api_request_v1_badge(host, w, url);
1447 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1448 return web_client_api_request_v1_alarms(host, w, url);
1450 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1451 return web_client_api_request_v1_alarm_log(host, w, url);
1453 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1454 return web_client_api_request_v1_alarm_variables(host, w, url);
1456 else if(hash == hash_raw && !strcmp(tok, "allmetrics"))
1457 return web_client_api_request_v1_allmetrics(host, w, url);
1460 buffer_flush(w->response.data);
1461 buffer_strcat(w->response.data, "Unsupported v1 API command: ");
1462 buffer_strcat_htmlescape(w->response.data, tok);
1467 buffer_flush(w->response.data);
1468 buffer_sprintf(w->response.data, "Which API v1 command?");
1473 int web_client_api_request(RRDHOST *host, struct web_client *w, char *url)
1475 // get the api version
1476 char *tok = mystrsep(&url, "/?&");
1478 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1479 if(strcmp(tok, "v1") == 0)
1480 return web_client_api_request_v1(host, w, url);
1482 buffer_flush(w->response.data);
1483 buffer_strcat(w->response.data, "Unsupported API version: ");
1484 buffer_strcat_htmlescape(w->response.data, tok);
1489 buffer_flush(w->response.data);
1490 buffer_sprintf(w->response.data, "Which API version?");
1495 int web_client_api_old_data_request(RRDHOST *host, struct web_client *w, char *url, int datasource_type)
1498 buffer_flush(w->response.data);
1499 buffer_sprintf(w->response.data, "Incomplete request.");
1505 char *args = strchr(url, '?');
1511 // get the name of the data to show
1512 char *tok = mystrsep(&url, "/");
1515 // do we have such a data set?
1517 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1518 st = rrdset_find_byname(host, tok);
1519 if(!st) st = rrdset_find(host, tok);
1524 // try to send a file with that name
1525 buffer_flush(w->response.data);
1526 return(mysendfile(w, tok));
1530 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1532 // how many entries does the client want?
1533 int lines = (int)st->entries;
1534 int group_count = 1;
1535 time_t after = 0, before = 0;
1536 int group_method = GROUP_AVERAGE;
1540 // parse the lines required
1541 tok = mystrsep(&url, "/");
1542 if(tok) lines = str2i(tok);
1543 if(lines < 1) lines = 1;
1546 // parse the group count required
1547 tok = mystrsep(&url, "/");
1548 if(tok && *tok) group_count = str2i(tok);
1549 if(group_count < 1) group_count = 1;
1550 //if(group_count > save_history / 20) group_count = save_history / 20;
1553 // parse the grouping method required
1554 tok = mystrsep(&url, "/");
1556 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1557 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1558 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1559 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1564 tok = mystrsep(&url, "/");
1565 if(tok && *tok) after = str2ul(tok);
1566 if(after < 0) after = 0;
1569 // parse before time
1570 tok = mystrsep(&url, "/");
1571 if(tok && *tok) before = str2ul(tok);
1572 if(before < 0) before = 0;
1576 tok = mystrsep(&url, "/");
1577 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1580 w->response.data->contenttype = CT_APPLICATION_JSON;
1581 buffer_flush(w->response.data);
1583 char *google_version = "0.6";
1584 char *google_reqId = "0";
1585 char *google_sig = "0";
1586 char *google_out = "json";
1587 char *google_responseHandler = "google.visualization.Query.setResponse";
1588 char *google_outFileName = NULL;
1589 time_t last_timestamp_in_data = 0;
1590 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1592 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1595 tok = mystrsep(&args, "&");
1597 char *name = mystrsep(&tok, "=");
1598 if(name && *name && strcmp(name, "tqx") == 0) {
1599 char *key = mystrsep(&tok, ":");
1600 char *value = mystrsep(&tok, ";");
1601 if(key && value && *key && *value) {
1602 if(strcmp(key, "version") == 0)
1603 google_version = value;
1605 else if(strcmp(key, "reqId") == 0)
1606 google_reqId = value;
1608 else if(strcmp(key, "sig") == 0)
1611 else if(strcmp(key, "out") == 0)
1614 else if(strcmp(key, "responseHandler") == 0)
1615 google_responseHandler = value;
1617 else if(strcmp(key, "outFileName") == 0)
1618 google_outFileName = value;
1624 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1625 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1628 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1629 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1631 // check the client wants json
1632 if(strcmp(google_out, "json") != 0) {
1633 buffer_sprintf(w->response.data,
1634 "%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.'}]});",
1635 google_responseHandler, google_version, google_reqId, google_out);
1641 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1642 buffer_sprintf(w->response.data,
1643 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1644 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1647 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1648 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1650 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);
1652 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1653 if(timestamp_in_data > last_timestamp_in_data)
1654 buffer_strcat(w->response.data, "});");
1657 // the client already has the latest data
1658 buffer_flush(w->response.data);
1659 buffer_sprintf(w->response.data,
1660 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1661 google_responseHandler, google_version, google_reqId);
1668 int validate_stream_api_key(const char *key) {
1669 if(appconfig_get_boolean(&stream_config, key, "enabled", 0))
1675 int web_client_stream_request(RRDHOST *host, struct web_client *w, char *url) {
1676 info("STREAM [%s]:%s: client connection.", w->client_ip, w->client_port);
1678 char *key = NULL, *hostname = NULL, *machine_guid = NULL, *os = NULL;
1679 int update_every = default_rrd_update_every;
1680 int history = default_rrd_history_entries;
1681 RRD_MEMORY_MODE mode = default_rrd_memory_mode;
1682 int health_enabled = default_health_enabled;
1685 char *value = mystrsep(&url, "?&");
1686 if(!value || !*value) continue;
1688 char *name = mystrsep(&value, "=");
1689 if(!name || !*name) continue;
1690 if(!value || !*value) continue;
1692 if(!strcmp(name, "key"))
1694 else if(!strcmp(name, "hostname"))
1696 else if(!strcmp(name, "machine_guid"))
1697 machine_guid = value;
1698 else if(!strcmp(name, "update_every"))
1699 update_every = (int)strtoul(value, NULL, 0);
1700 else if(!strcmp(name, "os"))
1705 error("STREAM [%s]:%s: request without an API key. Forbidding access.", w->client_ip, w->client_port);
1706 buffer_flush(w->response.data);
1707 buffer_sprintf(w->response.data, "You need an API key for this request.");
1711 if(!hostname || !*hostname) {
1712 error("STREAM [%s]:%s: request without a hostname. Forbidding access.", w->client_ip, w->client_port);
1713 buffer_flush(w->response.data);
1714 buffer_sprintf(w->response.data, "You need to send a hostname too.");
1718 if(!machine_guid || !*machine_guid) {
1719 error("STREAM [%s]:%s: request without a machine GUID. Forbidding access.", w->client_ip, w->client_port);
1720 buffer_flush(w->response.data);
1721 buffer_sprintf(w->response.data, "You need to send a machine GUID too.");
1725 if(!validate_stream_api_key(key)) {
1726 error("STREAM [%s]:%s: API key '%s' is not allowed. Forbidding access.", w->client_ip, w->client_port, key);
1727 buffer_flush(w->response.data);
1728 buffer_sprintf(w->response.data, "Your API key is not permitted access.");
1732 if(!appconfig_get_boolean(&stream_config, machine_guid, "enabled", 1)) {
1733 error("STREAM [%s]:%s: machine GUID '%s' is not allowed. Forbidding access.", w->client_ip, w->client_port, machine_guid);
1734 buffer_flush(w->response.data);
1735 buffer_sprintf(w->response.data, "Your machine guide is not permitted access.");
1739 update_every = (int)appconfig_get_number(&stream_config, machine_guid, "update every", update_every);
1740 if(update_every < 0) update_every = 1;
1742 history = (int)appconfig_get_number(&stream_config, key, "default history", history);
1743 history = (int)appconfig_get_number(&stream_config, machine_guid, "history", history);
1744 if(history < 5) history = 5;
1746 mode = rrd_memory_mode_id(appconfig_get(&stream_config, key, "default memory mode", rrd_memory_mode_name(mode)));
1747 mode = rrd_memory_mode_id(appconfig_get(&stream_config, machine_guid, "memory mode", rrd_memory_mode_name(mode)));
1749 health_enabled = appconfig_get_boolean_ondemand(&stream_config, key, "health enabled by default", health_enabled);
1750 health_enabled = appconfig_get_boolean_ondemand(&stream_config, machine_guid, "health enabled", health_enabled);
1752 if(!strcmp(machine_guid, "localhost"))
1755 host = rrdhost_find_or_create(hostname, machine_guid, os, update_every, history, mode, health_enabled?1:0);
1757 info("STREAM request from client '%s:%s' for host '%s' with machine_guid '%s': update every = %d, history = %d, memory mode = %s, health %s",
1758 w->client_ip, w->client_port,
1759 hostname, machine_guid,
1762 rrd_memory_mode_name(mode),
1763 (health_enabled == CONFIG_BOOLEAN_NO)?"disabled":((health_enabled == CONFIG_BOOLEAN_YES)?"enabled":"auto")
1766 struct plugind cd = {
1768 .update_every = default_rrd_update_every,
1770 .serial_failures = 0,
1771 .successful_collections = 0,
1773 .started_t = now_realtime_sec(),
1777 // put the client IP and port into the buffers used by plugins.d
1778 snprintfz(cd.id, CONFIG_MAX_NAME, "%s:%s", w->client_ip, w->client_port);
1779 snprintfz(cd.filename, FILENAME_MAX, "%s:%s", w->client_ip, w->client_port);
1780 snprintfz(cd.fullfilename, FILENAME_MAX, "%s:%s", w->client_ip, w->client_port);
1781 snprintfz(cd.cmd, PLUGINSD_CMD_MAX, "%s:%s", w->client_ip, w->client_port);
1783 info("STREAM [%s]:%s: sending STREAM to initiate streaming...", w->client_ip, w->client_port);
1784 if(send_timeout(w->ifd, "STREAM", 6, 0, 60) != 6) {
1785 error("STREAM [%s]:%s: cannot send STREAM.", w->client_ip, w->client_port);
1786 buffer_flush(w->response.data);
1787 buffer_sprintf(w->response.data, "Failed to reply back with STREAM");
1791 // remove the non-blocking flag from the socket
1792 if(fcntl(w->ifd, F_SETFL, fcntl(w->ifd, F_GETFL, 0) & ~O_NONBLOCK) == -1)
1793 error("STREAM [%s]:%s: cannot remove the non-blocking flag from socket %d", w->client_ip, w->client_port, w->ifd);
1796 char buffer[1000 + 1];
1798 while((len = read(w->ifd, buffer, 1000)) != -1) {
1800 fprintf(stderr, "BEGIN READ %zu bytes\n%s\nEND READ\n", (size_t)len, buffer);
1804 // convert the socket to a FILE *
1805 FILE *fp = fdopen(w->ifd, "r");
1807 error("STREAM [%s]:%s: failed to get a FILE for FD %d.", w->client_ip, w->client_port, w->ifd);
1808 buffer_flush(w->response.data);
1809 buffer_sprintf(w->response.data, "Failed to get a FILE for an FD.");
1813 rrdhost_wrlock(host);
1814 host->use_counter++;
1815 rrdhost_unlock(host);
1817 // call the plugins.d processor to receive the metrics
1818 info("STREAM [%s]:%s: connecting client to plugins.d on host '%s' with machine GUID '%s'.", w->client_ip, w->client_port, host->hostname, host->machine_guid);
1819 size_t count = pluginsd_process(host, &cd, fp, 1);
1820 error("STREAM [%s]:%s: client disconnected (host '%s', machine GUID '%s').", w->client_ip, w->client_port, host->hostname, host->machine_guid);
1822 rrdhost_wrlock(host);
1823 host->use_counter--;
1824 if(!host->use_counter && health_enabled == CONFIG_BOOLEAN_AUTO)
1825 host->health_enabled = 0;
1826 rrdhost_unlock(host);
1832 // this will not send anything
1833 // the socket is closed
1834 buffer_flush(w->response.data);
1835 if(count) return 200;
1839 const char *web_content_type_to_string(uint8_t contenttype) {
1840 switch(contenttype) {
1842 return "text/html; charset=utf-8";
1844 case CT_APPLICATION_XML:
1845 return "application/xml; charset=utf-8";
1847 case CT_APPLICATION_JSON:
1848 return "application/json; charset=utf-8";
1850 case CT_APPLICATION_X_JAVASCRIPT:
1851 return "application/x-javascript; charset=utf-8";
1854 return "text/css; charset=utf-8";
1857 return "text/xml; charset=utf-8";
1860 return "text/xsl; charset=utf-8";
1862 case CT_APPLICATION_OCTET_STREAM:
1863 return "application/octet-stream";
1865 case CT_IMAGE_SVG_XML:
1866 return "image/svg+xml";
1868 case CT_APPLICATION_X_FONT_TRUETYPE:
1869 return "application/x-font-truetype";
1871 case CT_APPLICATION_X_FONT_OPENTYPE:
1872 return "application/x-font-opentype";
1874 case CT_APPLICATION_FONT_WOFF:
1875 return "application/font-woff";
1877 case CT_APPLICATION_FONT_WOFF2:
1878 return "application/font-woff2";
1880 case CT_APPLICATION_VND_MS_FONTOBJ:
1881 return "application/vnd.ms-fontobject";
1887 return "image/jpeg";
1892 case CT_IMAGE_XICON:
1893 return "image/x-icon";
1899 return "image/icns";
1902 return "text/plain; version=0.0.4";
1906 return "text/plain; charset=utf-8";
1911 const char *web_response_code_to_string(int code) {
1917 return "Temporary Redirect";
1920 return "Bad Request";
1929 return "Preconditions Failed";
1932 if(code >= 100 && code < 200)
1933 return "Informational";
1935 if(code >= 200 && code < 300)
1936 return "Successful";
1938 if(code >= 300 && code < 400)
1939 return "Redirection";
1941 if(code >= 400 && code < 500)
1942 return "Bad Request";
1944 if(code >= 500 && code < 600)
1945 return "Server Error";
1947 return "Undefined Error";
1951 static inline char *http_header_parse(struct web_client *w, char *s) {
1952 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1954 if(unlikely(!hash_origin)) {
1955 hash_origin = simple_uhash("Origin");
1956 hash_connection = simple_uhash("Connection");
1957 hash_accept_encoding = simple_uhash("Accept-Encoding");
1958 hash_donottrack = simple_uhash("DNT");
1964 while(*e && *e != ':') e++;
1971 char *v = e + 1, *ve;
1973 // skip leading spaces from value
1974 while(*v == ' ') v++;
1978 while(*ve && *ve != '\r') ve++;
1979 if(!*ve || ve[1] != '\n') {
1984 // terminate the value
1987 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1988 uint32_t hash = simple_uhash(s);
1990 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1991 strncpyz(w->origin, v, ORIGIN_MAX);
1993 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1994 if(strcasestr(v, "keep-alive"))
1997 else if(respect_web_browser_do_not_track_policy && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1998 if(*v == '0') w->donottrack = 0;
1999 else if(*v == '1') w->donottrack = 1;
2001 #ifdef NETDATA_WITH_ZLIB
2002 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
2003 if(web_enable_gzip) {
2004 if(strcasestr(v, "gzip"))
2005 web_client_enable_deflate(w, 1);
2007 // does not seem to work
2008 // else if(strcasestr(v, "deflate"))
2009 // web_client_enable_deflate(w, 0);
2012 #endif /* NETDATA_WITH_ZLIB */
2019 // http_request_validate()
2021 // = 0 : all good, process the request
2022 // > 0 : request is not supported
2023 // < 0 : request is incomplete - wait for more data
2025 typedef enum http_validation {
2027 HTTP_VALIDATION_NOT_SUPPORTED,
2028 HTTP_VALIDATION_INCOMPLETE
2031 static inline HTTP_VALIDATION http_request_validate(struct web_client *w) {
2032 char *s = w->response.data->buffer, *encoded_url = NULL;
2034 // is is a valid request?
2035 if(!strncmp(s, "GET ", 4)) {
2036 encoded_url = s = &s[4];
2037 w->mode = WEB_CLIENT_MODE_NORMAL;
2039 else if(!strncmp(s, "OPTIONS ", 8)) {
2040 encoded_url = s = &s[8];
2041 w->mode = WEB_CLIENT_MODE_OPTIONS;
2043 else if(!strncmp(s, "STREAM ", 7)) {
2044 encoded_url = s = &s[7];
2045 w->mode = WEB_CLIENT_MODE_STREAM;
2048 w->wait_receive = 0;
2049 return HTTP_VALIDATION_NOT_SUPPORTED;
2052 // find the SPACE + "HTTP/"
2054 // find the next space
2055 while (*s && *s != ' ') s++;
2057 // is it SPACE + "HTTP/" ?
2058 if(*s && !strncmp(s, " HTTP/", 6)) break;
2062 // incomplete requests
2064 w->wait_receive = 1;
2065 return HTTP_VALIDATION_INCOMPLETE;
2068 // we have the end of encoded_url - remember it
2071 // make sure we have complete request
2072 // complete requests contain: \r\n\r\n
2075 while(*s && *s++ != '\r');
2077 // did we reach the end?
2078 if(unlikely(!*s)) break;
2081 if(likely(*s++ == '\n')) {
2083 // is it again \r\n ? (header end)
2084 if(unlikely(*s == '\r' && s[1] == '\n')) {
2085 // a valid complete HTTP request found
2088 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
2091 // copy the URL - we are going to overwrite parts of it
2092 // FIXME -- we should avoid it
2093 strncpyz(w->last_url, w->decoded_url, URL_MAX);
2095 w->wait_receive = 0;
2096 return HTTP_VALIDATION_OK;
2099 // another header line
2100 s = http_header_parse(w, s);
2104 // incomplete request
2105 w->wait_receive = 1;
2106 return HTTP_VALIDATION_INCOMPLETE;
2109 static inline void web_client_send_http_header(struct web_client *w) {
2110 if(unlikely(w->response.code != 200))
2111 buffer_no_cacheable(w->response.data);
2113 // set a proper expiration date, if not already set
2114 if(unlikely(!w->response.data->expires)) {
2115 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
2116 w->response.data->expires = w->tv_ready.tv_sec + localhost->rrd_update_every;
2118 w->response.data->expires = w->tv_ready.tv_sec + 86400;
2121 // prepare the HTTP response header
2122 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, w->response.code);
2124 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2125 const char *code_msg = web_response_code_to_string(w->response.code);
2127 // prepare the last modified and expiration dates
2128 char date[32], edate[32];
2130 struct tm tmbuf, *tm;
2132 tm = gmtime_r(&w->response.data->date, &tmbuf);
2133 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2135 tm = gmtime_r(&w->response.data->expires, &tmbuf);
2136 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
2139 buffer_sprintf(w->response.header_output,
2140 "HTTP/1.1 %d %s\r\n"
2141 "Connection: %s\r\n"
2142 "Server: NetData Embedded HTTP Server\r\n"
2143 "Access-Control-Allow-Origin: %s\r\n"
2144 "Access-Control-Allow-Credentials: true\r\n"
2145 "Content-Type: %s\r\n"
2147 , w->response.code, code_msg
2148 , w->keepalive?"keep-alive":"close"
2150 , content_type_string
2154 if(unlikely(web_x_frame_options))
2155 buffer_sprintf(w->response.header_output, "X-Frame-Options: %s\r\n", web_x_frame_options);
2157 if(w->cookie1[0] || w->cookie2[0]) {
2159 buffer_sprintf(w->response.header_output,
2160 "Set-Cookie: %s\r\n",
2165 buffer_sprintf(w->response.header_output,
2166 "Set-Cookie: %s\r\n",
2170 if(respect_web_browser_do_not_track_policy)
2171 buffer_sprintf(w->response.header_output,
2172 "Tk: T;cookies\r\n");
2175 if(respect_web_browser_do_not_track_policy) {
2176 if(w->tracking_required)
2177 buffer_sprintf(w->response.header_output,
2178 "Tk: T;cookies\r\n");
2180 buffer_sprintf(w->response.header_output,
2185 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2186 buffer_strcat(w->response.header_output,
2187 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2188 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2189 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2193 buffer_sprintf(w->response.header_output,
2194 "Cache-Control: %s\r\n"
2196 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2200 // copy a possibly available custom header
2201 if(unlikely(buffer_strlen(w->response.header)))
2202 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2204 // headers related to the transfer method
2205 if(likely(w->response.zoutput)) {
2206 buffer_strcat(w->response.header_output,
2207 "Content-Encoding: gzip\r\n"
2208 "Transfer-Encoding: chunked\r\n"
2212 if(likely((w->response.data->len || w->response.rlen))) {
2213 // we know the content length, put it
2214 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2217 // we don't know the content length, disable keep-alive
2222 // end of HTTP header
2223 buffer_strcat(w->response.header_output, "\r\n");
2225 // sent the HTTP header
2226 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2228 , buffer_strlen(w->response.header_output)
2229 , buffer_tostring(w->response.header_output)
2232 web_client_crock_socket(w);
2234 ssize_t bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2235 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2237 w->stats_sent_bytes += bytes;
2239 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2241 , buffer_strlen(w->response.header_output)
2244 WEB_CLIENT_IS_DEAD(w);
2248 w->stats_sent_bytes += bytes;
2251 static inline int web_client_process_url(RRDHOST *host, struct web_client *w, char *url);
2253 static inline int web_client_switch_host(RRDHOST *host, struct web_client *w, char *url) {
2254 static uint32_t hash_localhost = 0;
2256 if(unlikely(!hash_localhost)) {
2257 hash_localhost = simple_hash("localhost");
2260 if(host != localhost) {
2261 buffer_flush(w->response.data);
2262 buffer_strcat(w->response.data, "Nesting of hosts is not allowed.");
2266 char *tok = mystrsep(&url, "/?&");
2268 debug(D_WEB_CLIENT, "%llu: Searching for host with name '%s'.", w->id, tok);
2270 // copy the URL, we need it to serve files
2271 w->last_url[0] = '/';
2272 if(url && *url) strncpyz(&w->last_url[1], url, URL_MAX - 1);
2273 else w->last_url[1] = '\0';
2275 uint32_t hash = simple_hash(tok);
2277 if(unlikely(hash == hash_localhost && !strcmp(tok, "localhost")))
2278 return web_client_process_url(localhost, w, url);
2282 rrdhost_foreach_read(h) {
2283 if(unlikely((hash == h->hash_hostname && !strcmp(tok, h->hostname)) ||
2284 (hash == h->hash_machine_guid && !strcmp(tok, h->machine_guid)))) {
2286 return web_client_process_url(h, w, url);
2292 buffer_flush(w->response.data);
2293 buffer_strcat(w->response.data, "This netdata does not maintain a database for host: ");
2294 buffer_strcat_htmlescape(w->response.data, tok?tok:"");
2298 static inline int web_client_process_url(RRDHOST *host, struct web_client *w, char *url) {
2301 hash_netdata_conf = 0,
2303 hash_datasource = 0,
2309 #ifdef NETDATA_INTERNAL_CHECKS
2310 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
2313 if(unlikely(!hash_api)) {
2314 hash_api = simple_hash("api");
2315 hash_netdata_conf = simple_hash("netdata.conf");
2316 hash_data = simple_hash(WEB_PATH_DATA);
2317 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
2318 hash_graph = simple_hash(WEB_PATH_GRAPH);
2319 hash_list = simple_hash("list");
2320 hash_all_json = simple_hash("all.json");
2321 hash_host = simple_hash("host");
2322 #ifdef NETDATA_INTERNAL_CHECKS
2323 hash_exit = simple_hash("exit");
2324 hash_debug = simple_hash("debug");
2325 hash_mirror = simple_hash("mirror");
2329 char *tok = mystrsep(&url, "/?");
2330 if(likely(tok && *tok)) {
2331 uint32_t hash = simple_hash(tok);
2332 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
2334 if(unlikely(hash == hash_api && strcmp(tok, "api") == 0)) {
2335 debug(D_WEB_CLIENT_ACCESS, "%llu: API request ...", w->id);
2336 return web_client_api_request(host, w, url);
2338 else if(unlikely(hash == hash_host && strcmp(tok, "host") == 0)) {
2339 debug(D_WEB_CLIENT_ACCESS, "%llu: host switch request ...", w->id);
2340 return web_client_switch_host(host, w, url);
2342 else if(unlikely(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0)) {
2343 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2344 w->response.data->contenttype = CT_TEXT_PLAIN;
2345 buffer_flush(w->response.data);
2346 config_generate(w->response.data, 0);
2349 else if(unlikely(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0)) { // "data"
2350 // the client is requesting rrd data -- OLD API
2351 return web_client_api_old_data_request(host, w, url, DATASOURCE_JSON);
2353 else if(unlikely(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0)) { // "datasource"
2354 // the client is requesting google datasource -- OLD API
2355 return web_client_api_old_data_request(host, w, url, DATASOURCE_DATATABLE_JSONP);
2357 else if(unlikely(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0)) { // "graph"
2358 // the client is requesting an rrd graph -- OLD API
2360 // get the name of the data to show
2361 tok = mystrsep(&url, "/?&");
2363 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2365 // do we have such a data set?
2366 RRDSET *st = rrdset_find_byname(host, tok);
2367 if(!st) st = rrdset_find(host, tok);
2370 // try to send a file with that name
2371 buffer_flush(w->response.data);
2372 return mysendfile(w, tok);
2375 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2376 w->response.data->contenttype = CT_APPLICATION_JSON;
2377 buffer_flush(w->response.data);
2378 rrd_stats_graph_json(st, url, w->response.data);
2382 buffer_flush(w->response.data);
2383 buffer_strcat(w->response.data, "Graph name?\r\n");
2386 else if(unlikely(hash == hash_list && strcmp(tok, "list") == 0)) {
2388 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2390 buffer_flush(w->response.data);
2393 rrdhost_rdlock(host);
2394 rrdset_foreach_read(st, host) buffer_sprintf(w->response.data, "%s\n", st->name);
2395 rrdhost_unlock(host);
2399 else if(unlikely(hash == hash_all_json && strcmp(tok, "all.json") == 0)) {
2401 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2403 w->response.data->contenttype = CT_APPLICATION_JSON;
2404 buffer_flush(w->response.data);
2405 rrd_stats_all_json(host, w->response.data);
2408 #ifdef NETDATA_INTERNAL_CHECKS
2409 else if(unlikely(hash == hash_exit && strcmp(tok, "exit") == 0)) {
2410 w->response.data->contenttype = CT_TEXT_PLAIN;
2411 buffer_flush(w->response.data);
2414 buffer_strcat(w->response.data, "ok, will do...");
2416 buffer_strcat(w->response.data, "I am doing it already");
2418 error("web request to exit received.");
2419 netdata_cleanup_and_exit(0);
2422 else if(unlikely(hash == hash_debug && strcmp(tok, "debug") == 0)) {
2423 buffer_flush(w->response.data);
2425 // get the name of the data to show
2426 tok = mystrsep(&url, "/?&");
2428 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2430 // do we have such a data set?
2431 RRDSET *st = rrdset_find_byname(host, tok);
2432 if(!st) st = rrdset_find(host, tok);
2434 buffer_strcat(w->response.data, "Chart is not found: ");
2435 buffer_strcat_htmlescape(w->response.data, tok);
2436 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2440 debug_flags |= D_RRD_STATS;
2442 if(rrdset_flag_check(st, RRDSET_FLAG_DEBUG))
2443 rrdset_flag_clear(st, RRDSET_FLAG_DEBUG);
2445 rrdset_flag_set(st, RRDSET_FLAG_DEBUG);
2447 buffer_sprintf(w->response.data, "Chart has now debug %s: ", rrdset_flag_check(st, RRDSET_FLAG_DEBUG)?"enabled":"disabled");
2448 buffer_strcat_htmlescape(w->response.data, tok);
2449 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, rrdset_flag_check(st, RRDSET_FLAG_DEBUG)?"enabled":"disabled");
2453 buffer_flush(w->response.data);
2454 buffer_strcat(w->response.data, "debug which chart?\r\n");
2457 else if(unlikely(hash == hash_mirror && strcmp(tok, "mirror") == 0)) {
2458 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2460 // replace the zero bytes with spaces
2461 buffer_char_replace(w->response.data, '\0', ' ');
2463 // just leave the buffer as is
2464 // it will be copied back to the client
2468 #endif /* NETDATA_INTERNAL_CHECKS */
2471 char filename[FILENAME_MAX+1];
2473 strncpyz(filename, w->last_url, FILENAME_MAX);
2474 tok = mystrsep(&url, "?");
2475 buffer_flush(w->response.data);
2476 return mysendfile(w, (tok && *tok)?tok:"/");
2479 void web_client_process_request(struct web_client *w) {
2482 now_realtime_timeval(&w->tv_in);
2484 switch(http_request_validate(w)) {
2485 case HTTP_VALIDATION_OK:
2487 case WEB_CLIENT_MODE_STREAM:
2488 w->response.code = web_client_stream_request(localhost, w, w->decoded_url);
2491 case WEB_CLIENT_MODE_OPTIONS:
2492 w->response.data->contenttype = CT_TEXT_PLAIN;
2493 buffer_flush(w->response.data);
2494 buffer_strcat(w->response.data, "OK");
2495 w->response.code = 200;
2498 case WEB_CLIENT_MODE_FILECOPY:
2499 case WEB_CLIENT_MODE_NORMAL:
2500 w->response.code = web_client_process_url(localhost, w, w->decoded_url);
2505 case HTTP_VALIDATION_INCOMPLETE:
2506 if(w->response.data->len > TOO_BIG_REQUEST) {
2507 strcpy(w->last_url, "too big request");
2509 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
2511 buffer_flush(w->response.data);
2512 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
2513 w->response.code = 400;
2516 // wait for more data
2521 case HTTP_VALIDATION_NOT_SUPPORTED:
2522 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
2524 buffer_flush(w->response.data);
2525 buffer_strcat(w->response.data, "I don't understand you...\r\n");
2526 w->response.code = 400;
2530 // keep track of the time we done processing
2531 now_realtime_timeval(&w->tv_ready);
2533 w->response.sent = 0;
2535 // set a proper last modified date
2536 if(unlikely(!w->response.data->date))
2537 w->response.data->date = w->tv_ready.tv_sec;
2539 web_client_send_http_header(w);
2541 // enable sending immediately if we have data
2542 if(w->response.data->len) w->wait_send = 1;
2543 else w->wait_send = 0;
2546 case WEB_CLIENT_MODE_STREAM:
2547 debug(D_WEB_CLIENT, "%llu: STREAM done.", w->id);
2550 case WEB_CLIENT_MODE_OPTIONS:
2551 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2554 case WEB_CLIENT_MODE_NORMAL:
2555 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2558 case WEB_CLIENT_MODE_FILECOPY:
2559 if(w->response.rlen) {
2560 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2561 w->wait_receive = 1;
2564 // utilize the kernel sendfile() for copying the file to the socket.
2565 // this block of code can be commented, without anything missing.
2566 // when it is commented, the program will copy the data using async I/O.
2568 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2569 if(len != w->response.data->rbytes)
2570 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2572 web_client_reset(w);
2577 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2581 fatal("%llu: Unknown client mode %u.", w->id, w->mode);
2586 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2588 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2590 sprintf(buf, "%zX\r\n", len);
2592 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2594 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2595 w->stats_sent_bytes += bytes;
2598 else if(bytes == 0) {
2599 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2600 WEB_CLIENT_IS_DEAD(w);
2603 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2604 WEB_CLIENT_IS_DEAD(w);
2610 ssize_t web_client_send_chunk_close(struct web_client *w)
2612 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2614 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2616 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2617 w->stats_sent_bytes += bytes;
2620 else if(bytes == 0) {
2621 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2622 WEB_CLIENT_IS_DEAD(w);
2625 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2626 WEB_CLIENT_IS_DEAD(w);
2632 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2634 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2636 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2638 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2639 w->stats_sent_bytes += bytes;
2642 else if(bytes == 0) {
2643 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2644 WEB_CLIENT_IS_DEAD(w);
2647 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2648 WEB_CLIENT_IS_DEAD(w);
2654 #ifdef NETDATA_WITH_ZLIB
2655 ssize_t web_client_send_deflate(struct web_client *w)
2657 ssize_t len = 0, t = 0;
2659 // when using compression,
2660 // w->response.sent is the amount of bytes passed through compression
2662 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.",
2663 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);
2665 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) {
2666 // there is nothing to send
2668 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2670 // finalize the chunk
2671 if(w->response.sent != 0) {
2672 t = web_client_send_chunk_finalize(w);
2676 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2677 // we have to wait, more data will come
2678 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2683 if(unlikely(!w->keepalive)) {
2684 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2685 WEB_CLIENT_IS_DEAD(w);
2690 web_client_reset(w);
2691 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2695 if(w->response.zhave == w->response.zsent) {
2696 // compress more input data
2698 // close the previous open chunk
2699 if(w->response.sent != 0) {
2700 t = web_client_send_chunk_close(w);
2704 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);
2706 // give the compressor all the data not passed through the compressor yet
2707 if(w->response.data->len > w->response.sent) {
2708 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2709 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2712 // reset the compressor output buffer
2713 w->response.zstream.next_out = w->response.zbuffer;
2714 w->response.zstream.avail_out = ZLIB_CHUNK;
2716 // ask for FINISH if we have all the input
2717 int flush = Z_SYNC_FLUSH;
2718 if(w->mode == WEB_CLIENT_MODE_NORMAL
2719 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2721 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2724 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2728 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2729 error("%llu: Compression failed. Closing down client.", w->id);
2730 web_client_reset(w);
2734 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2735 w->response.zsent = 0;
2737 // keep track of the bytes passed through the compressor
2738 w->response.sent = w->response.data->len;
2740 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2743 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2744 if(t2 < 0) return t2;
2748 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2750 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2752 w->stats_sent_bytes += len;
2753 w->response.zsent += len;
2755 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2758 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2759 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2761 WEB_CLIENT_IS_DEAD(w);
2764 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2765 WEB_CLIENT_IS_DEAD(w);
2770 #endif // NETDATA_WITH_ZLIB
2772 ssize_t web_client_send(struct web_client *w) {
2773 #ifdef NETDATA_WITH_ZLIB
2774 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2775 #endif // NETDATA_WITH_ZLIB
2779 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2780 // there is nothing to send
2782 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2784 // there can be two cases for this
2785 // A. we have done everything
2786 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2788 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2789 // we have to wait, more data will come
2790 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2795 if(unlikely(!w->keepalive)) {
2796 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2797 WEB_CLIENT_IS_DEAD(w);
2801 web_client_reset(w);
2802 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2806 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2807 if(likely(bytes > 0)) {
2808 w->stats_sent_bytes += bytes;
2809 w->response.sent += bytes;
2810 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2812 else if(likely(bytes == 0)) {
2813 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2814 WEB_CLIENT_IS_DEAD(w);
2817 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2818 WEB_CLIENT_IS_DEAD(w);
2824 ssize_t web_client_receive(struct web_client *w)
2826 // do we have any space for more data?
2827 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2829 ssize_t left = w->response.data->size - w->response.data->len;
2832 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2833 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2835 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2837 if(likely(bytes > 0)) {
2838 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2839 w->stats_received_bytes += bytes;
2841 size_t old = w->response.data->len;
2842 w->response.data->len += bytes;
2843 w->response.data->buffer[w->response.data->len] = '\0';
2845 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2846 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2848 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2851 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2852 w->wait_receive = 0;
2855 else if(likely(bytes == 0)) {
2856 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2858 // if we cannot read, it means we have an error on input.
2859 // if however, we are copying a file from ifd to ofd, we should not return an error.
2860 // in this case, the error should be generated when the file has been sent to the client.
2862 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2863 // we are copying data from ifd to ofd
2864 // let it finish copying...
2865 w->wait_receive = 0;
2867 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2868 if(w->ifd != w->ofd) close(w->ifd);
2872 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2873 WEB_CLIENT_IS_DEAD(w);
2877 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2878 WEB_CLIENT_IS_DEAD(w);
2885 // --------------------------------------------------------------------------------------
2886 // the thread of a single client
2888 // 1. waits for input and output, using async I/O
2889 // 2. it processes HTTP requests
2890 // 3. it generates HTTP responses
2891 // 4. it copies data from input to output if mode is FILECOPY
2893 void *web_client_main(void *ptr)
2895 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2896 error("Cannot set pthread cancel type to DEFERRED.");
2898 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2899 error("Cannot set pthread cancel state to ENABLE.");
2901 struct web_client *w = ptr;
2902 struct pollfd fds[2], *ifd, *ofd;
2903 int retval, timeout;
2906 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2909 if(unlikely(netdata_exit)) break;
2911 if(unlikely(w->dead)) {
2912 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2915 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2916 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2920 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2921 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2925 if(w->ifd == w->ofd) {
2930 if(w->wait_receive) fds[0].events |= POLLIN;
2931 if(w->wait_send) fds[0].events |= POLLOUT;
2937 ifd = ofd = &fds[0];
2945 if(w->wait_receive) fds[0].events |= POLLIN;
2951 if(w->wait_send) fds[1].events |= POLLOUT;
2957 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2959 timeout = web_client_timeout * 1000;
2960 retval = poll(fds, fdmax, timeout);
2962 if(unlikely(netdata_exit)) break;
2964 if(unlikely(retval == -1)) {
2965 if(errno == EAGAIN || errno == EINTR) {
2966 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2970 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2973 else if(unlikely(!retval)) {
2974 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":"");
2978 if(unlikely(netdata_exit)) break;
2981 if(w->wait_send && ofd->revents & POLLOUT) {
2983 if(web_client_send(w) < 0) {
2984 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2989 if(unlikely(netdata_exit)) break;
2991 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2993 if(web_client_receive(w) < 0) {
2994 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2998 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2999 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
3000 web_client_process_request(w);
3002 // if the sockets are closed, may have transferred this client
3004 if(unlikely(w->mode == WEB_CLIENT_MODE_STREAM))
3009 if(unlikely(!used)) {
3010 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
3015 web_client_reset(w);
3017 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
3018 debug(D_WEB_CLIENT, "%llu: done...", w->id);
3020 // close the sockets/files now
3021 // to free file descriptors
3022 if(w->ifd == w->ofd) {
3023 if(w->ifd != -1) close(w->ifd);
3026 if(w->ifd != -1) close(w->ifd);
3027 if(w->ofd != -1) close(w->ofd);